getrouteResult Structure Definition

The getrouteResult structure defines the return type for getroute API.

Syntax



Members

rc

If the method succeeds, rc is 0 else rc > 0. Values above 0x8000 indicate Warnings.

message

If the method succeeds, message is NULL else message contains Error/Warning message.

routeList

List of routes


route Structure Definition

The route structure defines the actual return type values for getroute API.

Syntax



Members

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.

routetype

The type of routes to be shown.

detail

Display a detailed view.

mgmt

Route in management plane.

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.

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.

cost2

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


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.

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.

_nextgenapiresource


See Also