ns_network_interface
Configuration for NS Network Interfaces resource.
Properties
(click to see Operations )
Name | Data Type | Permissions | Description |
---|---|---|---|
devicename |
|
Read-write | Device/Interface Name.
Minimum length = 1 Maximum length = 100 |
id |
|
Read-write | Id is system generated key. |
ns_ip_address |
|
Read-write | Citrix ADC IP Address.
Minimum length = 1 Maximum length = 64 |
nicerrifoutdiscards |
|
Read-write | Number of error free outgoing packets discarded. |
errifindiscards |
|
Read-write | Number of error free incoming packets discarded. |
display_name |
|
Read-write | Device Display Name.
Minimum length = 1 Maximum length = 64 |
partition_name |
|
Read-only | Partition Name. |
poll_time |
|
Read-only | Last Polling Time. |
state |
|
Read-only | State Enabled|Disabled. |
hostname |
|
Read-only | Assign hostname to managed device, if this is not provided, name will be set as host name . |
description |
|
Read-only | Interface description. |
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
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/ns_network_interface 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, "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>,
"nicerrifoutdiscards":<Double_value>,
"errifindiscards":<Double_value>,
"hostname":<String_value>,
"display_name":<String_value>,
"description":<String_value>}]}