Citrix NetScaler XML API User's Guide

addnspbr

Use this method to adds a policy based route (PBR) to the Citrix ADC. To commit this operation, you must apply the PBRs.
A PBR specifies criteria for selecting outgoing IPv4 packets and, typically, a next hop to which to send the selected packets. For example, you can configure the Citrix ADC to route outgoing packets from a specific IP address or range to a particular next hop router.

Note: The Citrix ADC process PBRs before processing the RNAT rules.

Syntax

Parameters

name

Name for the PBR. Must begin with an ASCII alphabetic or underscore \(_\) character, and must contain only ASCII alphanumeric, underscore, hash \(\#\), period \(.\), space, colon \(:\), at \(@\), equals \(=\), and hyphen \(-\) characters. Cannot be changed after the PBR is created.
This is mandatory parameter.

actioN

Action to perform on the outgoing IPv4 packets that match the PBR. Available settings function as follows: * ALLOW - The Citrix ADC sends the packet to the designated next-hop router. * DENY - The Citrix ADC applies the routing table for normal destination-based routing.
This is mandatory parameter.

srcip

IP address or range of IP addresses to match against the source IP address of an outgoing IPv4 packet. In the method line interface, separate the range with a hyphen. For example: 10.102.29.30-10.102.29.189.

operatoR

Either the equals (=) or does not equal (!=) logical operator.

srcipval

srcport

Port number or range of port numbers to match against the source port number of an outgoing IPv4 packet. In the method line interface, separate the range with a hyphen. For example: 40-90. Note: The destination port can be specified only for TCP and UDP protocols.

operatoR2

Either the equals (=) or does not equal (!=) logical operator.

srcportval

destip

IP address or range of IP addresses to match against the destination IP address of an outgoing IPv4 packet. In the method line interface, separate the range with a hyphen. For example: 10.102.29.30-10.102.29.189.

operatoR3

Either the equals (=) or does not equal (!=) logical operator.

destipval

destport

Port number or range of port numbers to match against the destination port number of an outgoing IPv4 packet. In the method line interface, separate the range with a hyphen. For example: 40-90. Note: The destination port can be specified only for TCP and UDP protocols.

operatoR4

Either the equals (=) or does not equal (!=) logical operator.

destportval

nexthop

IP address of the next hop router or the name of the link load balancing virtual server to which to send matching packets if action is set to ALLOW. If you specify a link load balancing (LLB) virtual server, which can provide a backup if a next hop link fails, first make sure that the next hops bound to the LLB virtual server are actually next hops that are directly connected to the Citrix ADC. Otherwise, the Citrix ADC throws an error when you attempt to create the PBR. The next hop can be null to represent null routes

nexthopval

The Next Hop IP address or gateway name.

iptunnel

The Tunnel name.

iptunnelname

The iptunnel name where packets need to be forwarded upon.

vxlanvlanmap

The vlan to vxlan mapping to be applied for incoming packets over this pbr tunnel

targettd

Integer value that uniquely identifies the traffic domain to which you want to send packet to.
Minimum value = 0.
Maximum value = 4094.

srcmac

MAC address to match against the source MAC address of an outgoing IPv4 packet.

srcmacmask

Used to define range of Source MAC address. It takes string of 0 and 1, 0s are for exact match and 1s for wildcard. For matching first 3 bytes of MAC address, srcMacMask value "000000111111".
Default value = "000000000000".

protocol

Protocol, identified by protocol name, to match against the protocol of an outgoing IPv4 packet.

protocolnumber

Protocol, identified by protocol number, to match against the protocol of an outgoing IPv4 packet.
Minimum value = 1.
Maximum value = NSACL_MAXPROTO.

vlan

ID of the VLAN. The Citrix ADC compares the PBR only to the outgoing packets on the specified VLAN. If you do not specify any interface ID, the appliance compares the PBR to the outgoing packets on all VLANs.
Minimum value = 1.
Maximum value = 4094.

interfacE

ID of an interface. The Citrix ADC compares the PBR only to the outgoing packets on the specified interface. If you do not specify any value, the appliance compares the PBR to the outgoing packets on all interfaces.

priority

Priority of the PBR, which determines the order in which it is evaluated relative to the other PBRs. If you do not specify priorities while creating PBRs, the PBRs are evaluated in the order in which they are created.
Minimum value = 1.
Maximum value = 81920.

msr

Monitor the route specified byte Next Hop parameter. This parameter is not applicable if you specify a link load balancing (LLB) virtual server name with the Next Hop parameter.
Default value = DISABLED.

monitor

The name of the monitor.(Can be only of type ping or ARP )

state

Enable or disable the PBR. After you apply the PBRs, the Citrix ADC compares outgoing packets to the enabled PBRs.
Default value = XACLENABLED.

ownergroup

The owner node group in a Cluster for this pbr rule. If ownernode is not specified then the pbr rule is treated as Striped pbr rule.
Default value = DEFAULT_NG.

Return Value

Returns simpleResult

See Also