Skip to content


Configuration for Enabled Virtual server on NetScaler resource.

(click to see Operations)


(click to see Operations)

NameData TypePermissionsDescription
ns_ip_address<String>Read-writeNetScaler IP Address.
Minimum length = 1
Maximum length = 64
agent_list<String[]>Read-writeAgent List, on which traffic will flow.
ip_address<String>Read-writeVirtual server IP Address.
Minimum length = 1
Maximum length = 64
icalog<String>Read-writeICA log.
export_option<String[]>Read-writeExport Options: TCP, ICA.
appflow_policy_rule<String>Read-writeAppflow policy rule.
appflowlog<String>Read-writeAppflow log.
es4nslog<String>Read-writeESNS enable.
name<String>Read-writeVirtual server name.
Maximum length = 255
export_list<String[]>Read-writeExport List: WebInsight, SecurityInsight.
transport_mode<String>Read-writeTransport Mode [ Logstream/Appflow ].
type<String>Read-writeTells whether virtual server type.
Minimum length = 2
Maximum length = 64
state<String>Read-onlyTells whether virtual server up/down.


(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:


    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:



    Note: In such cases, make sure that the request header DOES not include the following:



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


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

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value> }

get (all)

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

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "ns_vserver_info":[{