Developer Documentation
ADC NITRO APIs
Current Release 13.1 13

route

August 17, 2023
Contributed by: 
C

Configuration for route resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
network Read-write IPv4 network address for which to add a route entry in the routing table of the Citrix ADC.
netmask Read-write The subnet mask associated with the network address.
gateway Read-write IP address of the gateway for this route. Can be either the IP address of the gateway, or can be null to specify a null interface route.

Minimum length = 1
vlan Read-write VLAN as the gateway for this route.

Minimum value = 1

Maximum value = 4094
cost Read-write Positive integer used by the routing algorithms to determine preference for using this route. The lower the cost, the higher the preference.

Minimum value = 0

Maximum value = 65535
td Read-write Integer value that uniquely identifies the traffic domain in which you want to configure the entity. If you do not specify an ID, the entity becomes part of the default traffic domain, which has an ID of 0.

Minimum value = 0

Maximum value = 4094
distance Read-write Administrative distance of this route, which determines the preference of this route over other routes, with same destination, from different routing protocols. A lower value is preferred.

Default value: 1

Minimum value = 0

Maximum value = 255
cost1 Read-write The cost of a route is used to compare routes of the same type. The route having the lowest cost is the most preferred route. Possible values: 0 through 65535. Default: 0.

Minimum value = 0

Maximum value = 65535
weight Read-write Positive integer used by the routing algorithms to determine preference for this route over others of equal cost. The lower the weight, the higher the preference.

Default value: 1

Minimum value = 1

Maximum value = 65535
advertise Read-write Advertise this route.

Possible values = DISABLED, ENABLED
protocol <String[]> Read-write Routing protocol used for advertising this route.

Default value: ADV_ROUTE_FLAGS

Possible values = OSPF, ISIS, RIP, BGP
msr Read-write Monitor this route using a monitor of type ARP or PING.

Default value: DISABLED

Possible values = ENABLED, DISABLED
monitor Read-write Name of the monitor, of type ARP or PING, configured on the Citrix ADC to monitor this route.

Minimum length = 1
ownergroup Read-write The owner node group in a Cluster for this route. If owner node group is not specified then the route is treated as Striped route.

Default value: DEFAULT_NG

Minimum length = 1
routetype Read-write Protocol used by routes that you want to remove from the routing table of the Citrix ADC.

Possible values = CONNECTED, STATIC, DYNAMIC, OSPF, ISIS, RIP, BGP
detail Read-write Display a detailed view.
gatewayname Read-only The name of the gateway for this route. For a route other than a link load balancing (LLB) route, this value is null.
type Read-only State of the RNAT.
dynamic Read-only State of the route.
Static Read-only .
permanent Read-only .
direct Read-only .
nat Read-only .
lbroute Read-only .
adv Read-only .
tunnel Read-only Show whether it is a tunnel route or not.
data Read-only Internal data of this route.
data0 Read-only Internal route type is stored, used for get.
flags Read-only If this route is dynamic, the name of the routing protocol from which it was learned.
routeowners <String[]> Read-only Use this option with -dynamic and in a cluster only to specify the set of nodes from which this dynamic route has been learnt.

Possible values = 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31
retain Read-only .
ospf Read-only OSPF protocol.
isis Read-only ISIS protocol.
rip Read-only RIP protocol.
bgp Read-only BGP protocol.
dhcp Read-only .
advospf Read-only Advertised through OSPF protocol.
advisis Read-only Advertised through ISIS protocol.
advrip Read-only Advertised through RIP protocol.
advbgp Read-only Advertised through BGP protocol.
state Read-only The state of the static route. Possible values: UP, DOWN.
totalprobes Read-only The total number of probes sent.
totalfailedprobes Read-only The total number of failed probes.
failedprobes Read-only Number of the current failed monitoring probes.
monstatcode Read-only The code indicating the monitor response.
monstatparam1 Read-only First parameter used with the message code.
monstatparam2 Read-only Second parameter used with the message code.
monstatparam3 Read-only Third parameter used with the message code.
__count Read-only count parameter

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:// <netscaler-ip-address> /nitro/v1/config/route

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload: 


{"route":{
<b>      "network":<String_value>,
</b><b>      "netmask":<String_value>,
</b>      "gateway":<String_value>,
      "vlan":<Double_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>,
      "ownergroup":<String_value>
}}

<!--NeedCopy-->

Response:

HTTP Status Code on Success: 201 Created

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

clear

URL: http:// <netscaler-ip-address> /nitro/v1/config/route? action=clear

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload: 


{"route":{
<b>      "routetype":<String_value>
</b>}}

<!--NeedCopy-->

Response:

HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

delete

URL: http:// <netscaler-ip-address> /nitro/v1/config/route/ network_value<String>

Query-parameters:

args= netmask:<String_value>, gateway: <String_value> ,vlan: <Double_value> ,td: <Double_value> ,ownergroup: <String_value>

</b>

HTTP Method: DELETE

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Response:

HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

update

URL: http:// <netscaler-ip-address> /nitro/v1/config/route

HTTP Method: PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload: 


{"route":{
<b>      "network":<String_value>,
</b><b>      "netmask":<String_value>,
</b><b>      "gateway":<String_value>,
</b>      "td":<Double_value>,
      "distance":<Double_value>,
      "cost1":<Double_value>,
      "weight":<Double_value>,
      "advertise":<String_value>,
      "protocol":<String[]_value>,
      "msr":<String_value>,
      "monitor":<String_value>
}}

<!--NeedCopy-->

Response:

HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

unset

URL: http:// <netscaler-ip-address> /nitro/v1/config/route? action=unset

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload: 


{"route":{
<b>      "network":<String_value>,
</b><b>      "netmask":<String_value>,
</b><b>      "gateway":<String_value>,
</b>      "td":<Double_value>,
      "advertise":true,
      "distance":true,
      "cost1":true,
      "weight":true,
      "protocol":true,
      "msr":true,
      "monitor":true
}}

<!--NeedCopy-->

Response:

HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

get (all)

URL: http:// <netscaler-ip-address> /nitro/v1/config/route

Query-parameters:

args

http:// <netscaler-ip-address> /nitro/v1/config/route? args=network: <String_value> ,netmask: <String_value> ,gateway: <String_value> ,vlan: <Double_value> ,td: <Double_value> ,routetype: <String_value> ,detail: <Boolean_value>

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

attrs

http:// <netscaler-ip-address> /nitro/v1/config/route? attrs=property-name1,property-name2

Use this query parameter to specify the resource details that you want to retrieve.

filter

http:// <netscaler-ip-address> /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:// <netscaler-ip-address> /nitro/v1/config/route? view=summary

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

Note: By default, the retrieved results are displayed in detail view (?view=detail).

pagination

http:// <netscaler-ip-address> /nitro/v1/config/route? pagesize=#no;pageno=#no

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

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Accept:application/json

Response:

HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

Response Header:

Content-Type:application/json

Response Payload: 


{ "route": [ {
network:<String_value>,netmask:<String_value>,gateway:<String_value>,vlan:<Double_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>,
      "ownergroup":<String_value>
}]}

<!--NeedCopy-->

count

URL: http:// <netscaler-ip-address> /nitro/v1/config/route? count=yes

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Accept:application/json

Response:

HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

Response Header:

Content-Type:application/json

Response Payload: 


{ "route": [ { "__count": "#no"} ] }

<!--NeedCopy-->
route
August 17, 2023
Contributed by: 
C
August 17, 2023
Contributed by: 
C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.