NetScaler SDX 14.1 NITRO API Reference

system_settings

Configuration for System Settings resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
svm_ns_comm Read-write Communication with Instances.

Minimum length = 1

Maximum length = 10
session_timeout Read-write Session timeout for the system.
session_timeout_unit Read-write Session timeout unit for the system.
enable_nsrecover_login Read-write This setting enalbes nsrecover login for SVM.
enable_session_timeout Read-write Enables session timeout feature.
id Read-write Id is system generated key.
enable_certificate_download Read-write Enable Certificate Download.
keep_alive_ping_interval Read-write Agent web socket keep alive ping interval for the system.
enable_apiproxy_credentials Read-write Enable API Proxy Credentials.
enable_shell_access Read-write Enable Shell access for non-nsroot User(s).
basicauth Read-write Allow Basic Authentication Protocol.
secure_access_only Read-write Secure Access only.
is_metering_enabled Read-write Enable Metering for Citrix ADC VPX on SDX.
enable_delete_interface_on_adc Read-write Flag to enable/disable deleting interface from ADCs on SDX.
port_model Read-only Port Model for BR instance.
act_id Read-only Activity 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

The following parameters can be used in the nitro request : onerror <String_value>

Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.

Default value: EXIT

Possible values = EXIT, CONTINUE

get

URL: https://<MGMT-IP>/nitro/v2/config/system_settings HTTPS Method: GET

Request Headers: Accept: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

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

Response Headers:

Content-Type:application/json

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "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>,
"keep_alive_ping_interval":<Integer_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>,
"enable_delete_interface_on_adc":<Boolean_value>,
"act_id":<String_value>,
"sync_operation":<Boolean_value>,
"reset":<Boolean_value>}]}

<!--NeedCopy-->

update

URL: https://<MGMT-IP>/nitro/v2/config/system_settings/id_value<String> HTTPS Method: PUT

Request Headers: Content-Type: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Request Payload:

{"system_settings":{
"session_timeout":<Integer_value>,
"session_timeout_unit":<String_value>,
"enable_session_timeout":<Boolean_value>,
"id":<String_value>,
"keep_alive_ping_interval":<Integer_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>,
"enable_delete_interface_on_adc":<Boolean_value>}}

<!--NeedCopy-->

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

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "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>,
"keep_alive_ping_interval":<Integer_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>,
"enable_delete_interface_on_adc":<Boolean_value>,
"act_id":<String_value>,
"sync_operation":<Boolean_value>,
"reset":<Boolean_value>}]}

<!--NeedCopy-->
system_settings