Skip to content
Was this article helpful?

route

The following operations can be performed on "route":

rm| clear| unset| add| set| show|

rm route

Removes a static route from the Citrix ADC. Note: You cannot use this command to remove routes that are part of a VLAN configuration. Use the rmvlan or clear vlan command instead.

Synopsis

rm route ( | -vlan ) [-td ] [-ownerGroup ]

Arguments

network Network address specified in the route entry that you want to remove from the routing table of the Citrix ADC.

netmask Subnet mask associated with the network address.

gateway IP address of the gateway for this route.

vlan Gateway vlan for this route. Minimum value: 1 Maximum value: 4094

td The Traffic Domain Id of the route to be removed. Minimum value: 0 Maximum value: 4094

ownerGroup 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

clear route

Removes routes of the specifiedtype(protocol) from the routing table of the Citrix ADC.

Synopsis

clear route

Arguments

routeType Protocol used by routes that you want to remove from the routing table of the Citrix ADC.

unset route

Unset the attributes of a route that were added by the add/set route command..Refer to the set route command for meanings of the arguments.

Synopsis

unset route [-td ] [-advertise] [-distance] [-cost] [-weight] [-protocol] [-msr] [-monitor]

Example

unset route 10.10.10.0 255.255.255.0 10.10.10.1 -advertise enable

add route

Adds an IPv4 static route to the routing table of the Citrix ADC.

Synopsis

add route ( | -vlan ) [-td ] [-distance ] [-cost ] [-weight ] [-advertise ( DISABLED | ENABLED )] [-protocol ...] [-msr ( ENABLED | DISABLED ) [-monitor ]] [-ownerGroup ]

Arguments

network IPv4 network address for which to add a route entry in the routing table of the Citrix ADC.

netmask The subnet mask associated with the network address.

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

vlan VLAN as the gateway for this route. Minimum value: 1 Maximum value: 4094

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

cost 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 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 Advertise this route.

Possible values: DISABLED, ENABLED

protocol Routing protocol used for advertising this route. Default value: ADV_ROUTE_FLAGS

msr Monitor this route using a monitor of type ARP or PING.

Possible values: ENABLED, DISABLED Default value: DISABLED

monitor Name of the monitor, of type ARP or PING, configured on the Citrix ADC to monitor this route.

ownerGroup 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

Example

add route 10.10.10.0 255.255.255.0 10.10.10.1

set route

Modifies parameters of an IPv4 static route.

Synopsis

set route [-td ] [-distance ] [-cost ] [-weight ] [-advertise ( DISABLED | ENABLED )] [-protocol ...] [-msr ( ENABLED | DISABLED ) [-monitor ]]

Arguments

network Network address in the route entry that you want to modify.

netmask Subnet mask associated with the network address.

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

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

cost 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 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 Advertise this route.

Possible values: DISABLED, ENABLED

protocol Routing protocol used for advertising this route. Default value: ADV_ROUTE_FLAGS

msr Monitor this route using a monitor of type ARP or PING.

Possible values: ENABLED, DISABLED Default value: DISABLED

monitor Name of the monitor, of type ARP or PING, configured on the Citrix ADC to monitor this route.

Example

set route 10.10.10.0 255.255.255.0 10.10.10.1 -advertise enable

show route

Display the configured routing information.

Synopsis

show route [ [] [-td ]] [-vlan ] [] [-detail]

Arguments

network The destination network or host.

netmask The subnet mask associated with the network address.

gateway The gateway for the route.

vlan The gateway vlan for the route. Minimum value: 1 Maximum value: 4094

td 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

routeType The type of routes to be shown.

detail Display a detailed view.

Output

gatewayName The name of the gateway for this route. For a route other than a link load balancing (LLB) route, this value is null.

advertise Enable advertisement.

type State of the RNAT.

stateflag dynamic State of the route.

STATIC PERMANENT DIRECT NAT LBROUTE ADV TUNNEL Show whether it is a tunnel route or not.

cost Cost of this route.

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

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

weight The weight of this route.

protocol Routing protocol used for advertising this route.

data Internal data of this route.

data0 Internal route type is stored, used for get.

flags If this route is dynamic, the name of the routing protocol from which it was learned.

routeOwners Use this option with -dynamic and in a cluster only to specify the set of nodes from which this dynamic route has been learnt.

retain OSPF OSPF protocol.

ISIS ISIS protocol.

RIP RIP protocol.

BGP BGP protocol.

DHCP advOSPF Advertised through OSPF protocol.

advISIS Advertised through ISIS protocol.

advRIP Advertised through RIP protocol.

advBGP Advertised through BGP protocol.

msr Whether MSR is enabled or disabled.

monitor Name of the monitor, of type ARP or PING, configured on the Citrix ADC to monitor this route.

state The state of the static route. Possible values: UP, DOWN.

peFlags PE flags.

totalprobes The total number of probes sent.

totalfailedprobes The total number of failed probes.

failedprobes Number of the current failed monitoring probes.

monStatCode The code indicating the monitor response.

monStatParam1 First parameter used with the message code.

monStatParam2 Second parameter used with the message code.

monStatParam3 Third parameter used with the message code.

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

clusterFlags Flags for cluster. Currently used to determine if it is a cluster system

devno count

Example

An example of the output of the show route command is as follows:

3 configured routes:

Network        Netmask        Gateway/OwnedIP     Type
-------        -------        ---------------     ----

1) 0.0.0.0 0.0.0.0 10.11.0.254 STATIC 2) 127.0.0.0 255.0.0.0 127.0.0.1 PERMANENT 3) 10.251.0.0 255.255.0.0 10.251.0.254 NAT

Was this article helpful?