Product Documentation

route

Sep 12, 2016

The following operations can be performed on "route":

add | clear | rm | set | unset | show

add route

Adds an IPv4 static route to the routing table of the NetScaler appliance.

Synopsys

add route <network> <netmask> <gateway> [-td <positive_integer>] [-distance <positive_integer>] [-cost <positive_integer>] [-weight <positive_integer>] [-advertise ( DISABLED | ENABLED )] [-protocol <protocol> ...] [-msr ( ENABLED | DISABLED ) [-monitor <string>]] [-ownerGroup <string>]

Arguments

network

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

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.

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 NetScaler appliance 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

clear route

Removes routes of the specifiedtype(protocol) from the routing table of the NetScaler appliance.

Synopsys

clear route <routeType>

Arguments

routeType

Protocol used by routes that you want to remove from the routing table of the NetScaler appliance.

rm route

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

Synopsys

rm route <network> <netmask> <gateway> [-td <positive_integer>] [-ownerGroup <string>]

Arguments

network

Network address specified in the route entry that you want to remove from the routing table of the NetScaler appliance.

netmask

Subnet mask associated with the network address.

gateway

IP address of the gateway for this route.

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

set route

Modifies parameters of an IPv4 static route.

Synopsys

set route <network> <netmask> <gateway> [-td <positive_integer>] [-distance <positive_integer>] [-cost <positive_integer>] [-weight <positive_integer>] [-advertise ( DISABLED | ENABLED )] [-protocol <protocol> ...] [-msr ( ENABLED | DISABLED ) [-monitor <string>]]

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 NetScaler appliance to monitor this route.

Example

set route 10.10.10.0 255.255.255.0 10.10.10.1 -advertise enable

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.

Synopsys

unset route <network> <netmask> <gateway> [-td <positive_integer>] [-advertise] [-distance] [-cost] [-weight] [-protocol] [-msr] [-monitor]

Example

unset route 10.10.10.0 255.255.255.0 10.10.10.1 -advertise enable

show route

Display the configured routing information.

Synopsys

show route [<network> <netmask> [<gateway>] [-td <positive_integer>]] [<routeType>] [-detail]

Arguments

network

The destination network or host.

netmask

The subnet mask associated with the network address.

gateway

The gateway for the 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

routeType

The type of routes to be shown.

detail

Display a detailed view.

Outputs

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

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.

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.

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 NetScaler appliance 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