nsconfig¶

Configuration for system config resource.

Properties¶

(click to see Operations)

Operations¶

(click to see Properties)

CLEAR | UPDATE | UNSET | SAVE | DIFF | GET (ALL)

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>.

clear¶

URL: http://<netscaler-ip-address>/nitro/v1/config/nsconfig?action=clear

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json

Request Payload:

{"nsconfig":{
      "force":<Boolean_value>,
      "level":<String_value>,
      "rbaconfig":<String_value>
}}

Response:

HTTP Status Code on Success: 200 OK HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

update¶

URL: http://<netscaler-ip-address>/nitro/v1/config/nsconfig

HTTP Method: PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json

Request Payload:

{"nsconfig":{
      "ipaddress":<String_value>,
      "netmask":<String_value>,
      "nsvlan":<Double_value>,
      "ifnum":<String[]_value>,
      "tagged":<String_value>,
      "httpport":<Integer[]_value>,
      "maxconn":<Double_value>,
      "maxreq":<Double_value>,
      "cip":<String_value>,
      "cipheader":<String_value>,
      "cookieversion":<String_value>,
      "securecookie":<String_value>,
      "pmtumin":<Double_value>,
      "pmtutimeout":<Double_value>,
      "ftpportrange":<String_value>,
      "crportrange":<String_value>,
      "timezone":<String_value>,
      "grantquotamaxclient":<Double_value>,
      "exclusivequotamaxclient":<Double_value>,
      "grantquotaspillover":<Double_value>,
      "exclusivequotaspillover":<Double_value>
}}

Response:

HTTP Status Code on Success: 200 OK HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

unset¶

URL: http://<netscaler-ip-address>/nitro/v1/config/nsconfig?action=unset

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json

Request Payload:

{"nsconfig":{
      "nsvlan":true,
      "ftpportrange":true,
      "crportrange":true,
      "timezone":true,
      "ipaddress":true,
      "netmask":true,
      "ifnum":true,
      "tagged":true,
      "httpport":true,
      "maxconn":true,
      "maxreq":true,
      "cip":true,
      "cipheader":true,
      "cookieversion":true,
      "securecookie":true,
      "pmtumin":true,
      "pmtutimeout":true,
      "grantquotamaxclient":true,
      "exclusivequotamaxclient":true,
      "grantquotaspillover":true,
      "exclusivequotaspillover":true
}}

Response:

HTTP Status Code on Success: 200 OK HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

save¶

URL: http://<netscaler-ip-address>/nitro/v1/config/nsconfig?action=save

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json

Request Payload:

{"nsconfig":{
}}

Response:

HTTP Status Code on Success: 200 OK HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

diff¶

URL: http://<netscaler-ip-address>/nitro/v1/config/nsconfig?action=diff

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json

Request Payload:

{"nsconfig":{
      "config1":<String_value>,
      "config2":<String_value>,
      "outtype":<String_value>,
      "template":<Boolean_value>,
      "ignoredevicespecific":<Boolean_value>
}}

Response:

HTTP Status Code on Success: 200 OK HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the errorResponse Payload:

{ "nsconfig": [ {
      "response":<String_value>

}]}

get (all)¶

URL: http://<netscaler-ip-address>/nitro/v1/config/nsconfig

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Accept:application/json

Response:

HTTP Status Code on Success: 200 OK HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the errorResponse Headers:

Content-Type:application/json

Response Payload:

{ "nsconfig": [ {
      "ipaddress":<String_value>,
      "netmask":<String_value>,
      "mappedip":<String_value>,
      "range":<Double_value>,
      "nsvlan":<Double_value>,
      "ifnum":<String[]_value>,
      "tagged":<String_value>,
      "httpport":<Integer[]_value>,
      "maxconn":<Double_value>,
      "maxreq":<Double_value>,
      "cip":<String_value>,
      "cipheader":<String_value>,
      "cookieversion":<String_value>,
      "securecookie":<String_value>,
      "failover":<String_value>,
      "systemtype":<String_value>,
      "primaryip":<String_value>,
      "pmtumin":<Double_value>,
      "pmtutimeout":<Double_value>,
      "ftpportrange":<String_value>,
      "crportrange":<String_value>,
      "flags":<Double_value>,
      "timezone":<String_value>,
      "lastconfigchangedtime":<String_value>,
      "lastconfigsavetime":<String_value>,
      "currentsytemtime":<String_value>,
      "systemtime":<Double_value>,
      "grantquotamaxclient":<Double_value>,
      "exclusivequotamaxclient":<Double_value>,
      "grantquotaspillover":<Double_value>,
      "exclusivequotaspillover":<Double_value>,
      "configchanged":<Boolean_value>
}]}