route

Configuration for route resource.

Properties

(click to see Operations)

Operations

(click to see Properties)

ADD | CLEAR | DELETE | UPDATE | UNSET | GET (ALL) | COUNT

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

add

URL: http://<NSIP>/nitro/v1/config/

HTTP Method: POST

Request Payload:

object={
"params":{
      "warning":<String_value>,
      "onerror":<String_value>
},
"sessionid":"##sessionid",
"route":{
      "network":<String_value>,
      "netmask":<String_value>,
      "gateway":<String_value>,
      "cost":<Double_value>,
      "td":<Double_value>,
      "distance":<Double_value>,
      "cost1":<Double_value>,
      "weight":<Double_value>,
      "advertise":<String_value>,
      "protocol":<String[]_value>,
      "msr":<String_value>,
                  "monitor":<String_value>,
}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": }

clear

URL: http://<NSIP>/nitro/v1/config/

HTTP Method: POST

Request Payload:

object={
"params":{
      "warning":<String_value>,
      "onerror":<String_value>,
      "action":"clear"
},
"sessionid":"##sessionid",
"route":{
      "routetype":<String_value>,
}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": }

delete

URL: http://<NSIP>/nitro/v1/config/route/network_value<String>

Query-parameters:

warning

http://<NS_IP>/nitro/v1/config/route/network_value<String>?warning=yes

Use this query parameter to get warnings in nitro response. If this field is set to YES, warning message will be sent in 'message' field and 'WARNING' value is set in severity field of the response in case there is a

HTTP Method: DELETE

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": }

update

URL: http://<NSIP>/nitro/v1/config/

HTTP Method: PUT

Request Payload:

{
"params": {
      "warning":<String_value>,
      "onerror":<String_value>"
},
sessionid":"##sessionid",
"route":{
      "network":<String_value>,
      "netmask":<String_value>,
      "gateway":<String_value>,
      "td":<Double_value>,
      "distance":<Double_value>,
      "cost1":<Double_value>,
      "weight":<Double_value>,
      "advertise":<String_value>,
      "protocol":<String[]_value>,
      "msr":<String_value>,
                  "monitor":<String_value>,
}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": }

unset

URL: http://<NSIP>/nitro/v1/config/

HTTP Method: POST

Request Payload:

object={
"params":{
      "warning":<String_value>,
      "onerror":<String_value>,
      "action":"unset"
},
"sessionid":"##sessionid",
"route":{
      "network":<String_value>,
      "netmask":<String_value>,
      "gateway":<String_value>,
      "td":<Double_value>,
      "advertise":true,
      "distance":true,
      "cost1":true,
      "weight":true,
      "protocol":true,
      "msr":true,
      "monitor":true,
}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": }

get (all)

URL: http://<NSIP>/nitro/v1/config/route

Query-parameters:

args

http://<NSIP>/nitro/v1/config/route?args= "network":<String_value>, "netmask":<String_value>, "gateway":<String_value>, "td":<Double_value>, "routetype":<String_value>, "detail":<Boolean_value>,

Use this query-parameter to get route resources based on additional properties.

filter

http://<NSIP>/nitro/v1/config/route?filter=property-name1:property-val1,property-name2:property-val2

Use this query-parameter to get the filtered set of route resources configured on NetScaler.Filtering can be done on any of the properties of the resource.

view

http://<NS_IP>/nitro/v1/config/route?view=summary

Use this query-parameter to get the summary output of route resources configured on NetScaler.

pagesize=#no;pageno=#no

http://<NS_IP>/nitro/v1/config/route?pagesize=#no;pageno=#no

Use this query-parameter to get the route resources in chunks.

warning

http://<NS_IP>/nitro/v1/config/route?warning=yes

Use this query parameter to get warnings in nitro response. If this field is set to YES, warning message will be sent in 'message' field and 'WARNING' value is set in severity field of the response in case there is a

HTTP Method: GET

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": <String_value>, "route": [ {
      "network":<String_value>,
                  "netmask":<String_value>,
                  "gateway":<String_value>,
                  "td":<Double_value>,
      "routetype":<String_value>,
      "detail":<Boolean_value>,
      "gatewayname":<String_value>,
      "advertise":<String_value>,
      "type":<Boolean_value>,
      "dynamic":<Boolean_value>,
      "Static":<Boolean_value>,
      "permanent":<Boolean_value>,
      "direct":<Boolean_value>,
      "nat":<Boolean_value>,
      "lbroute":<Boolean_value>,
      "adv":<Boolean_value>,
      "tunnel":<Boolean_value>,
      "cost":<Double_value>,
      "distance":<Double_value>,
      "cost1":<Double_value>,
      "weight":<Double_value>,
      "protocol":<String[]_value>,
      "data":<Boolean_value>,
      "data0":<Boolean_value>,
      "flags":<Boolean_value>,
      "routeowners":<String[]_value>,
      "retain":<Integer_value>,
      "ospf":<Boolean_value>,
      "isis":<Boolean_value>,
      "rip":<Boolean_value>,
      "bgp":<Boolean_value>,
      "dhcp":<Boolean_value>,
      "advospf":<Boolean_value>,
      "advisis":<Boolean_value>,
      "advrip":<Boolean_value>,
      "advbgp":<Boolean_value>,
      "msr":<String_value>,
      "monitor":<String_value>,
      "state":<Double_value>,
      "totalprobes":<Double_value>,
      "totalfailedprobes":<Double_value>,
      "failedprobes":<Double_value>,
      "monstatcode":<Integer_value>,
      "monstatparam1":<Integer_value>,
      "monstatparam2":<Integer_value>,
      "monstatparam3":<Integer_value>

}]}

count

URL: http://<NS_IP>/nitro/v1/config/route?count=yes

HTTP Method: GET

Response Payload:

{ "errorcode": 0, "message": "Done",route: [ { "__count": "#no"} ] }