| addsystemuser |
Use this method to adds a new user to the system. Note: You must provide the password after the user name. |
Syntax |
Parameters |
username |
Name for a user. Must begin with a letter, number, or the underscore (_) character, and must contain only alphanumeric, hyphen (-), period (.), hash (#), space ( ), at (@), equal (=), colon (:), and underscore characters. Cannot be changed after the user is added.
CLI Users: If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, "my user" or 'my user'). This is mandatory parameter. |
password |
Password for the system user. Can include any ASCII character. This is mandatory parameter. Minimum value = 1. |
externalauth |
Whether to use external authentication servers for the system user authentication or not Default value = ENABLED. |
promptstring |
String to display at the method-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. |
logging |
Users logging privilege Default value = DISABLED. |
maxsession |
Maximum number of client connection allowed per user Minimum value = 1. Maximum value = 40. |
allowedmanagementinterface |
Allowed Management interfaces to the system user. By default user is allowed from both API and CLI interfaces. If management interface for a user is set to API, then user is not allowed to access NS through CLI. GUI interface will come under API interface Default value = NS_INTERFACE_ALL. |
Return Value |
Returns simpleResult |
See Also |