system-group¶
The following operations can be performed on "system-group":
add| rm| bind| unbind| show| set| unset|
add system group¶
Creates a system-user group, to which you can bind individual users by using the bind system group command.
Synopsis¶
add system group <groupName> [-promptString <string>] [-timeout <secs>] [-allowedManagementInterface ( CLI | API ) ...]
Arguments¶
groupName
Name for the group. Must begin with a letter, number, hash(#) or the underscore (_) character, and must contain only alphanumeric, hyphen (-), period (.), hash (#), space ( ), at (@), equal (=), colon (:), and underscore characters. Cannot be changed after the group is created.
CLI Users: If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, "my group" or 'my group').
promptString
String to display at the command-line prompt. Can consist of letters, numbers, hyphen (-), period (.), hash (#), space ( ), at (@), equal (=), colon (:), underscore (_), and the following variables: * %u - Will be replaced by the user name. * %h - Will be replaced by the hostname of the Citrix ADC. * %t - Will be replaced by the current time in 12-hour format. * %T - Will be replaced by the current time in 24-hour format. * %d - Will be replaced by the current date. * %s - Will be replaced by the state of the Citrix ADC.
Note: The 63-character limit for the length of the string does not apply to the characters that replace the variables.
timeout
CLI session inactivity timeout, in seconds. If Restrictedtimeout argument of system parameter is enabled, Timeout can have values in the range [300-86400] seconds.If Restrictedtimeout argument of system parameter is disabled, Timeout can have values in the range [0, 10-100000000] seconds. Default value is 900 seconds.
allowedManagementInterface
Allowed Management interfaces of the system users in the group. By default allowed from both API and CLI interfaces. If management interface for a group is set to API, then all users under this group will not allowed to access NS through CLI. GUI interface will come under API interface Default value: NS_INTERFACE_ALL
rm system group¶
Removes a system group from the appliance.
Synopsis¶
rm system group <groupName>
Arguments¶
groupName
Name of the system group to remove.
bind system group¶
Binds a system user to a system group.
Synopsis¶
bind system group <groupName> (-userName <string> | (-policyName <string> <priority>) | -partitionName <string>)
Arguments¶
groupName
Name of the system group.
userName
Name of a system user to bind to the group.
policyName
Name of the command policy to be bind to the group.
priority
Integer specifying the priority of the command policy. A lower number specifies a higher priority. Policies are evaluated in the order of their priority numbers. Minimum value: 0
partitionName
Name of the Partition to bind to the system group.
unbind system group¶
Unbinds a system user from a group.
Synopsis¶
unbind system group <groupName> (-userName <string> | -policyName <string> | -partitionName <string>)
Arguments¶
groupName
Name of the system group from which to unbind the user.
userName
Name of the system user to unbind from the group.
policyName
Command policy to unbind from the group.
partitionName
Name of the Partition to bind to the system group.
show system group¶
Displays information about all system groups configured on the appliance, or about the specified group.
Synopsis¶
show system group [<groupName>]
Arguments¶
groupName
Name of the system group about which to display information.
Output¶
userName
The system user.
policyName
The name of command policy.
priority
The priority of the command policy.
promptString
String to display at the command-line prompt. Can consist of letters, numbers, hyphen (-), period (.), hash (#), space ( ), at (@), equal (=), colon (:), underscore (_), and the following variables: * %u - Will be replaced by the user name. * %h - Will be replaced by the hostname of the Citrix ADC. * %t - Will be replaced by the current time in 12-hour format. * %T - Will be replaced by the current time in 24-hour format. * %d - Will be replaced by the current date. * %s - Will be replaced by the state of the Citrix ADC.
Note: The 63-character limit for the length of the string does not apply to the characters that replace the variables.
timeout
CLI session inactivity timeout, in seconds. If Restrictedtimeout argument of system parameter is enabled, Timeout can have values in the range [300-86400] seconds.If Restrictedtimeout argument of system parameter is disabled, Timeout can have values in the range [0, 10-100000000] seconds. Default value is 900 seconds.
partitionName
Name of the Partition to bind to the system group.
allowedManagementInterface
Allowed Management interfaces of the system users in the group. By default allowed from both API and CLI interfaces. If management interface for a group is set to API, then all users under this group will not allowed to access NS through CLI. GUI interface will come under API interface
devno
count
stateflag
set system group¶
Modifies the specified parameters of a system group.
Synopsis¶
set system group <groupName> [-promptString <string>] [-timeout <secs>] [-allowedManagementInterface ( CLI | API ) ...]
Arguments¶
groupName
Name of system group to be modified.
promptString
String to display at the command-line prompt. Can consist of letters, numbers, hyphen (-), period (.), hash (#), space ( ), at (@), equal (=), colon (:), underscore (_), and the following variables: * %u - Will be replaced by the user name. * %h - Will be replaced by the hostname of the Citrix ADC. * %t - Will be replaced by the current time in 12-hour format. * %T - Will be replaced by the current time in 24-hour format. * %d - Will be replaced by the current date. * %s - Will be replaced by the state of the Citrix ADC.
Note: The 63-character limit for the length of the string does not apply to the characters that replace the variables.
timeout
CLI session inactivity timeout, in seconds. If Restrictedtimeout argument of system parameter is enabled, Timeout can have values in the range [300-86400] seconds.If Restrictedtimeout argument of system parameter is disabled, Timeout can have values in the range [0, 10-100000000] seconds. Default value is 900 seconds.
allowedManagementInterface
Allowed Management interfaces of the system users in the group. By default allowed from both API and CLI interfaces. If management interface for a group is set to API, then all users under this group will not allowed to access NS through CLI. GUI interface will come under API interface Default value: NS_INTERFACE_ALL
unset system group¶
Use this command to remove system group settings.Refer to the set system group command for meanings of the arguments.
Synopsis¶
unset system group <groupName> [-promptString] [-timeout] [-allowedManagementInterface]