Skip to content

system_settings

Configuration for System Settings resource.

(click to see Operations)

Properties

(click to see Operations)

NameData TypePermissionsDescription
svm_ns_comm<String>Read-writeCommunication with Instances.
Minimum length = 1
Maximum length = 10
session_timeout<Integer>Read-writeSession timeout for the system.
session_timeout_unit<String>Read-writeSession timeout unit for the system.
enable_nsrecover_login<Boolean>Read-writeThis setting enalbes nsrecover login for SVM.
enable_session_timeout<Boolean>Read-writeEnables session timeout feature.
id<String>Read-writeId is system generated key.
enable_certificate_download<Boolean>Read-writeEnable Certificate Download.
enable_apiproxy_credentials<Boolean>Read-writeEnable API Proxy Credentials.
enable_shell_access<Boolean>Read-writeEnable Shell access for non-nsroot User(s).
basicauth<Boolean>Read-writeAllow Basic Authentication Protocol.
secure_access_only<Boolean>Read-writeSecure Access only.
is_metering_enabled<Boolean>Read-writeEnable Metering for NS VPX's on SDX.
port_model<Integer>Read-onlyPort Model for BR instance.
act_id<String>Read-onlyActivity Id.

Operations

(click to see Properties)

GET| UPDATE

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

get

URL: https://<MGMT-IP>/nitro/v1/config/system_settings

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "system_settings":[{
"svm_ns_comm":<String_value>,
"session_timeout":<Integer_value>,
"session_timeout_unit":<String_value>,
"enable_nsrecover_login":<Boolean_value>,
"enable_session_timeout":<Boolean_value>,
"port_model":<Integer_value>,
"id":<String_value>,
"ns_br_interface":<String_value>,
"enable_certificate_download":<Boolean_value>,
"init_status":<Integer_value>,
"enable_apiproxy_credentials":<Boolean_value>,
"ns_br_interface_2":<String_value>,
"enable_shell_access":<Boolean_value>,
"basicauth":<Boolean_value>,
"secure_access_only":<Boolean_value>,
"vm_auto_poweron":<Boolean_value>,
"is_metering_enabled":<Boolean_value>,
"act_id":<String_value>,
"sync_operation":<Boolean_value>,
"reset":<Boolean_value>}]}

update

URL: https://<MGMT-IP>/nitro/v1/config/system_settings/id_value<String>

HTTP Method: null

Request Payload:

{system_settings:{
"session_timeout":<Integer_value>,
"session_timeout_unit":<String_value>,
"enable_session_timeout":<Boolean_value>,
"id":<String_value>,
"enable_shell_access":<Boolean_value>,
"basicauth":<Boolean_value>,
"secure_access_only":<Boolean_value>,
"svm_ns_comm":<String_value>,
"enable_nsrecover_login":<Boolean_value>,
"enable_certificate_download":<Boolean_value>,
"enable_apiproxy_credentials":<Boolean_value>,
"is_metering_enabled":<Boolean_value>}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "system_settings":[{
"svm_ns_comm":<String_value>,
"session_timeout":<Integer_value>,
"session_timeout_unit":<String_value>,
"enable_nsrecover_login":<Boolean_value>,
"enable_session_timeout":<Boolean_value>,
"port_model":<Integer_value>,
"id":<String_value>,
"ns_br_interface":<String_value>,
"enable_certificate_download":<Boolean_value>,
"init_status":<Integer_value>,
"enable_apiproxy_credentials":<Boolean_value>,
"ns_br_interface_2":<String_value>,
"enable_shell_access":<Boolean_value>,
"basicauth":<Boolean_value>,
"secure_access_only":<Boolean_value>,
"vm_auto_poweron":<Boolean_value>,
"is_metering_enabled":<Boolean_value>,
"act_id":<String_value>,
"sync_operation":<Boolean_value>,
"reset":<Boolean_value>}]}