snmp-group¶
The following operations can be performed on "snmp-group":
add snmp group¶
Adds an SNMPv3 user group on the Citrix ADC. SNMPv3 groups are logical aggregations of SNMPv3 users. SNMPv3 groups are used to implement access control and define the security levels for the users. You can add a maximum of 1000 SNMPv3 groups to the Citrix ADC appliance.
Synopsis¶
add snmp group <name> <securityLevel> -readViewName <string>
Arguments¶
name
Name for the SNMPv3 group. Can consist of 1 to 31 characters that include uppercase and lowercase letters, numbers, and the hyphen (-), period (.) pound (#), space ( ), at sign (@), equals (=), colon (:), and underscore (_) characters. You should choose a name that helps identify the SNMPv3 group.
The following requirement applies only to the Citrix ADC CLI: If the name includes one or more spaces, enclose it in double or single quotation marks (for example, "my name" or 'my name').
securityLevel
Security level required for communication between the Citrix ADC and the SNMPv3 users who belong to the group. Specify one of the following options: noAuthNoPriv. Require neither authentication nor encryption. authNoPriv. Require authentication but no encryption. authPriv. Require authentication and encryption. Note: If you specify authentication, you must specify an encryption algorithm when you assign an SNMPv3 user to the group. If you also specify encryption, you must assign both an authentication and an encryption algorithm for each group member.
Possible values: noAuthNoPriv, authNoPriv, authPriv
readViewName
Name of the configured SNMPv3 view that you want to bind to this SNMPv3 group. An SNMPv3 user bound to this group can access the subtrees that are bound to this SNMPv3 view as type INCLUDED, but cannot access the ones that are type EXCLUDED. If the Citrix ADC has multiple SNMPv3 view entries with the same name, all such entries are associated with the SNMPv3 group.
rm snmp group¶
Removes an SNMPv3 group entry from the Citrix ADC. The appliance can have multiple SNMPv3 groups with the same name, differentiated by the securityLevel (Security level) parameter setting. Therefore, to identify an SNMPv3 group entry that you want to remove, you have to specify both the name and security level of the SNMPv3 group.
Synopsis¶
rm snmp group <name> <securityLevel>
Arguments¶
name
Name of the SNMPv3 group.
securityLevel
Security level of the SNMPv3 group.
Possible values: noAuthNoPriv, authNoPriv, authPriv
set snmp group¶
Modifies the specified parameters of an SNMPv3 group entry on the Citrix ADC.
Synopsis¶
set snmp group <name> <securityLevel> -readViewName <string>
Arguments¶
name
The name specified in the SNMPv3 group entry that you want to modify. This parameter cannot be modified.
securityLevel
Security level required for communication between the Citrix ADC and the SNMPv3 users who belong to the group. Specify one of the following options: noAuthNoPriv. Require neither authentication nor encryption. authNoPriv. Require authentication but no encryption. authPriv. Require authentication and encryption. Note: If you specify authentication, you must specify an encryption algorithm when you assign an SNMPv3 user to the group. If you also specify encryption, you must assign both an authentication and an encryption algorithm for each group member.
Possible values: noAuthNoPriv, authNoPriv, authPriv
readViewName
Name of the configured SNMPv3 view that you want to bind to this SNMPv3 group. An SNMPv3 user bound to this group can access the subtrees that are bound to this SNMPv3 view as type INCLUDED, but cannot access the ones that are type EXCLUDED. If the Citrix ADC has multiple SNMPv3 view entries with the same name, all such entries are associated with the SNMPv3 group.
show snmp group¶
Displays the settings of all SNMPv3 groups or of the specified SNMPv3 group. To display the settings of all SNMPv3 groups, run the command without any parameters. To display the settings of a particular SNMPv3 group, specify the name of the SNMPv3 group and securityLevel (Security level). The Citrix ADC can have multiple SNMPv3 groups with the same name, differentiated by the securityLevel (Security level) parameter setting.
Synopsis¶
show snmp group [<name> <securityLevel>]
Arguments¶
name
Name of the SNMPv3 group whose details you want the Citrix ADC to display.
securityLevel
Security level of the SNMPv3 group whose details you want the Citrix ADC to display.
Possible values: noAuthNoPriv, authNoPriv, authPriv
Output¶
readViewName
Name of the configured SNMPv3 view that you want to bind to this SNMPv3 group. An SNMPv3 user bound to this group can access the subtrees that are bound to this SNMPv3 view as type INCLUDED, but cannot access the ones that are type EXCLUDED. If the Citrix ADC has multiple SNMPv3 view entries with the same name, all such entries are associated with the SNMPv3 group.
storageType
The storage type for this group.
status
The status of this group.
devno
count
stateflag