Skip to content

ns_network_interface

Configuration for NS Network Interfaces resource.

(click to see Operations)

Properties

(click to see Operations)

NameData TypePermissionsDescription
devicename<String>Read-writeDevice/Interface Name.
Minimum length = 1
Maximum length = 100
id<String>Read-writeId is system generated key.
ns_ip_address<String>Read-writeNS IP Address.
Minimum length = 1
Maximum length = 64
partition_name<String>Read-onlyPartition Name.
poll_time<Integer>Read-onlyLast Polling Time.
state<String>Read-onlyState Enabled|Disabled.
hostname<String>Read-onlyAssign hostname to managed device, if this is not provided, name will be set as host name .

Operations

(click to see Properties)

GET

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/ns_network_interface

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "ns_network_interface":[{
"partition_name":<String_value>,
"devicename":<String_value>,
"poll_time":<Integer_value>,
"id":<String_value>,
"state":<String_value>,
"ns_ip_address":<String_value>,
"hostname":<String_value>}]}