Developer Documentation
ADC NITRO APIs
Current Release 13.1 13

route6

August 17, 2023
Contributed by: 
C

Configuration for route 6 resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
network <String> Read-write IPv6 network address for which to add a route entry to the routing table of the Citrix ADC.
gateway <String> Read-write The gateway for this route. The value for this parameter is either an IPv6 address or null.

Default value: 0
vlan <Double> Read-write Integer value that uniquely identifies a VLAN through which the Citrix ADC forwards the packets for this route.

Default value: 0

Minimum value = 0

Maximum value = 4094
vxlan <Double> Read-write Integer value that uniquely identifies a VXLAN through which the Citrix ADC forwards the packets for this route.

Minimum value = 1

Maximum value = 16777215
weight <Double> 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
distance <Double> Read-write Administrative distance of this route from the appliance.

Default value: 1

Minimum value = 1

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

Default value: 1

Minimum value = 0

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

Possible values = DISABLED, ENABLED
msr <String> Read-write Monitor this route with a monitor of type ND6 or PING.

Default value: DISABLED

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

Minimum length = 1
td <Double> 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
ownergroup <String> Read-write The owner node group in a Cluster for this route6. If owner node group is not specified then the route is treated as Striped route.

Default value: DEFAULT_NG

Minimum length = 1
routetype <String> Read-write Type of IPv6 routes to remove from the routing table of the Citrix ADC.

Possible values = CONNECTED, STATIC, DYNAMIC, OSPF, ISIS, BGP, RIP, ND-RA-ROUTE, FIB6
detail <Boolean> Read-write To get a detailed view.
gatewayname <String> Read-only The name of the gateway for this route.
type <Boolean> Read-only State of the RNAT.
dynamic <Boolean> Read-only Whether this route is dynamically learned or not.
data <Boolean> Read-only Internal data of this route.
flags <Boolean> Read-only For a dynamic route, the routing protocol from which the route was learned.
state <Double> Read-only Whether this route is UP or DOWN.
totalprobes <Double> Read-only The total number of probes sent.
totalfailedprobes <Double> Read-only The total number of failed probes.
failedprobes <Double> Read-only Current number of failed monitoring probes.
monstatcode <Integer> Read-only The code indicating the monitor response.
monstatparam1 <Integer> Read-only First parameter for use with message code.
monstatparam2 <Integer> Read-only Second parameter for use with message code.
monstatparam3 <Integer> Read-only Third parameter for use with message code.
data1 <String> Read-only Internal data of this route.

Possible values = ENABLED, DISABLED
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 <Integer> Read-only .
Static <Boolean> Read-only Static route.
permanent <Boolean> Read-only Permanent Route.
connected <Boolean> Read-only Connected Route.
ospfv3 <Boolean> Read-only For a dynamic route, the routing protocol from which the route was learned.
isis <Boolean> Read-only If this route is dynamic then which routing protocol was it learnt from.
active <Boolean> Read-only For a dynamic route, the routing protocol from which the route was learned.
bgp <Boolean> Read-only For a dynamic route, the routing protocol from which the route was learned.
rip <Boolean> Read-only For a dynamic route, the routing protocol from which the route was learned.
raroute <Boolean> Read-only For a dynamic route, the routing protocol from which the route was learned.
__count <Double> 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/route6

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload: 


{"route6":{
<b>      "network":<String_value>,
</b>      "gateway":<String_value>,
      "vlan":<Double_value>,
      "vxlan":<Double_value>,
      "weight":<Double_value>,
      "distance":<Double_value>,
      "cost":<Double_value>,
      "advertise":<String_value>,
      "msr":<String_value>,
      "monitor":<String_value>,
      "td":<Double_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/route6? action=clear

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload: 


{"route6":{
<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/route6/ network_value<String>

Query-parameters:

args=gateway: <String_value> ,vlan: <Double_value> ,vxlan: <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/route6

HTTP Method: PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload: 


{"route6":{
<b>      "network":<String_value>,
</b>      "gateway":<String_value>,
      "vlan":<Double_value>,
      "vxlan":<Double_value>,
      "weight":<Double_value>,
      "distance":<Double_value>,
      "cost":<Double_value>,
      "advertise":<String_value>,
      "msr":<String_value>,
      "monitor":<String_value>,
      "td":<Double_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/route6? action=unset

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload: 


{"route6":{
<b>      "network":<String_value>,
</b>      "gateway":<String_value>,
      "vlan":<Double_value>,
      "vxlan":<Double_value>,
      "td":<Double_value>,
      "weight":true,
      "distance":true,
      "cost":true,
      "advertise":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/route6

Query-parameters:

args

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

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

attrs

http:// <netscaler-ip-address> /nitro/v1/config/route6? 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/route6? filter=property-name1:property-val1,property-name2:property-val2

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

view

http:// <netscaler-ip-address> /nitro/v1/config/route6? view=summary

Use this query-parameter to get the summary output of route6 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/route6? pagesize=#no;pageno=#no

Use this query-parameter to get the route6 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: 


{ "route6": [ {
network:<String_value>,gateway:<String_value>,vlan:<Double_value>,vxlan:<Double_value>,td:<Double_value>,routetype:<String_value>,detail:<Boolean_value>      "gatewayname":<String_value>,
      "advertise":<String_value>,
      "type":<Boolean_value>,
      "dynamic":<Boolean_value>,
      "weight":<Double_value>,
      "distance":<Double_value>,
      "cost":<Double_value>,
      "data":<Boolean_value>,
      "flags":<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>,
      "data1":<String_value>,
      "routeowners":<String[]_value>,
      "retain":<Integer_value>,
      "Static":<Boolean_value>,
      "permanent":<Boolean_value>,
      "connected":<Boolean_value>,
      "ospfv3":<Boolean_value>,
      "isis":<Boolean_value>,
      "active":<Boolean_value>,
      "bgp":<Boolean_value>,
      "rip":<Boolean_value>,
      "raroute":<Boolean_value>,
      "ownergroup":<String_value>
}]}

<!--NeedCopy-->

count

URL: http:// <netscaler-ip-address> /nitro/v1/config/route6? 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: 


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

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

In this article

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