Download full document:

systemuser

Configuration for system user resource.

Properties

(click to see Operations)

Name	Data Type	Permissions	Description
username	<String>	Read-write	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).<br>Minimum length = 1
password	<String>	Read-write	Password for the system user. Can include any ASCII character.<br>Minimum length = 1
externalauth	<String>	Read-write	Whether to use external authentication servers for the system user authentication or not.<br>Default value: ENABLED<br>Possible values = ENABLED, DISABLED
promptstring	<String>	Read-write	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 NetScaler appliance. * %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 NetScaler appliance. Note: The 63-character limit for the length of the string does not apply to the characters that replace the variables.<br>Minimum length = 1
timeout	<Double>	Read-write	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	<String>	Read-write	Users logging privilege.<br>Default value: DISABLED<br>Possible values = ENABLED, DISABLED
encrypted	<Boolean>	Read-only	.
promptinheritedfrom	<String>	Read-only	From where the prompt has been inherited.<br>Possible values = User, Group, Global, Climode
timeoutkind	<String>	Read-only	From where the timeout has been inherited.<br>Possible values = User, Group, Global, Climode
__count	<Double>	Read-only	count parameter

Operations

(click to see Properties)

Some options that you can use for each operations:

Getting warnings in response: NITRO allows you to get warnings in an operation by specifying the "warning" query parameter as "yes". For example, to get warnings while connecting to the NetScaler appliance, the URL is as follows:
http://<netscaler-ip-address>/nitro/v1/config/login?warning=yes
If any, the warnings are displayed in the response payload with the HTTP code "209 X-NITRO-WARNING".
Authenticated access for individual NITRO operations: NITRO allows you to logon to the NetScaler appliance to perform individual operations. You can use this option instead of creating a NITRO session (using the login object) and then using that session to perform all operations,
To do this, you must specify the username and password in the request header of the NITRO request as follows:
X-NITRO-USER:<username>
X-NITRO-PASS:<password>
Note: In such cases, make sure that the request header DOES not include the following:
Cookie:NITRO_AUTH_TOKEN=<tokenvalue>

Note:

Mandatory parameters are marked in red and placeholder content is marked in <green>.

add

URL: http://<NSIP>/nitro/v1/config/

HTTP Method: POST

Request Payload:

object={
"params":{
      "warning":<String_value>,
      "onerror":<String_value>
},
"sessionid":"##sessionid",
"systemuser":{
      "username":<String_value>,
      "password":<String_value>,
      "externalauth":<String_value>,
      "promptstring":<String_value>,
      "timeout":<Double_value>,
      "logging":<String_value>,
}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": }

delete

URL: http://<NSIP>/nitro/v1/config/systemuser/username_value<String>

Query-parameters:

warning

http://<NS_IP>/nitro/v1/config/systemuser/username_value<String>?warning=yes

Use this query parameter to get warnings in nitro response. If this field is set to YES, warning message will be sent in 'message' field and 'WARNING' value is set in severity field of the response in case there is a

HTTP Method: DELETE

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": }

update

URL: http://<NSIP>/nitro/v1/config/

HTTP Method: PUT

Request Payload:

{
"params": {
      "warning":<String_value>,
      "onerror":<String_value>"
},
sessionid":"##sessionid",
"systemuser":{
      "username":<String_value>,
      "password":<String_value>,
      "externalauth":<String_value>,
      "promptstring":<String_value>,
      "timeout":<Double_value>,
      "logging":<String_value>,
}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": }

unset

URL: http://<NSIP>/nitro/v1/config/

HTTP Method: POST

Request Payload:

object={
"params":{
      "warning":<String_value>,
      "onerror":<String_value>,
      "action":"unset"
},
"sessionid":"##sessionid",
"systemuser":{
      "username":<String_value>,
      "externalauth":true,
      "promptstring":true,
      "timeout":true,
      "logging":true,
}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": }

get (all)

URL: http://<NSIP>/nitro/v1/config/systemuser

Query-parameters:

filter

http://<NSIP>/nitro/v1/config/systemuser?filter=property-name1:property-val1,property-name2:property-val2

Use this query-parameter to get the filtered set of systemuser resources configured on NetScaler.Filtering can be done on any of the properties of the resource.

view

http://<NS_IP>/nitro/v1/config/systemuser?view=summary

Use this query-parameter to get the summary output of systemuser resources configured on NetScaler.

pagesize=#no;pageno=#no

http://<NS_IP>/nitro/v1/config/systemuser?pagesize=#no;pageno=#no

Use this query-parameter to get the systemuser resources in chunks.

warning

http://<NS_IP>/nitro/v1/config/systemuser?warning=yes

Use this query parameter to get warnings in nitro response. If this field is set to YES, warning message will be sent in 'message' field and 'WARNING' value is set in severity field of the response in case there is a

HTTP Method: GET

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": <String_value>, "systemuser": [ {
      "username":<String_value>,
      "password":<String_value>,
      "encrypted":<Boolean_value>,
      "externalauth":<String_value>,
      "promptstring":<String_value>,
      "promptinheritedfrom":<String_value>,
      "timeout":<Double_value>,
      "timeoutkind":<String_value>,
      "logging":<String_value>

}]}

get

URL: http://<NS_IP>/nitro/v1/config/systemuser/username_value<String>

HTTP Method: GET

Response Payload:

{ "errorcode": 0, "message": "Done", "systemuser": [ {
      "username":<String_value>,
      "password":<String_value>,
      "encrypted":<Boolean_value>,
      "externalauth":<String_value>,
      "promptstring":<String_value>,
      "promptinheritedfrom":<String_value>,
      "timeout":<Double_value>,
      "timeoutkind":<String_value>,
      "logging":<String_value>

}]}

count

URL: http://<NS_IP>/nitro/v1/config/systemuser?count=yes

HTTP Method: GET

Response Payload:

{ "errorcode": 0, "message": "Done",systemuser: [ { "__count": "#no"} ] }