Skip to content

ns-pbr6

The following operations can be performed on "ns-pbr6":

clear| apply| set| unset| stat| show| rm| renumber| enable| disable| add|

clear ns pbr6

Removes all PBR6s from the Citrix ADC. This operation does not require an explicit apply.

Synopsis

clear ns pbr6

Example

clear ns pbr6

apply ns pbr6

Updates the PBR6's memory tree (lookup table), adding any new PBR6 and applying any modifications to the existing PBR6s. The lookup table includes the configuration of all the extended PBR6s on the Citrix ADC. The Citrix ADC appliance uses the lookup table (not the configuration file) to filter the outgoing IPv6 packets.

Synopsis

apply ns pbr6

Arguments

Example

apply ns pbr6

set ns pbr6

Modifies the specified parameters of a PBR6.To commit this operation, you must apply the PBR6s.

Synopsis

set ns pbr6 [-action ( ALLOW | DENY )] [-srcIPv6 [] ] [-srcPort [] ] [-destIPv6 [] ] [-destPort [] ] [-srcMac [-srcMacMask ]] [-protocol | -protocolNumber ] [-vlan | -vxlan ] [-interface ] [-priority ] [-msr ( ENABLED | DISABLED ) [-monitor ]] [(-nextHop ) | (-ipTunnel [-vxlanVlanMap ])] [-nextHopVlan ]

Arguments

name Name of the PBR6 whose parameters you want to modify.

action Action to perform on the outgoing IPv6 packets that match the PBR6.

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.

Possible values: ALLOW, DENY

srcIPv6 IP address or range of IP addresses to match against the source IP address of an outgoing IPv6 packet. In the command line interface, separate the range with a hyphen.

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

Possible values: =, !=, EQ, NEQ

srcIPv6Val IP address or range of IP addresses to match against the source IP address of an outgoing IPv6 packet. In the command line interface, separate the range with a hyphen.

srcPort Source Port (range).

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

Possible values: =, !=, EQ, NEQ

srcPortVal Port number or range of port numbers to match against the source port number of an outgoing IPv6 packet. In the command line interface, separate the range with a hyphen. For example: 40-90. Maximum value: 65535

destIPv6 IP address or range of IP addresses to match against the destination IP address of an outgoing IPv6 packet. In the command line interface, separate the range with a hyphen.

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

Possible values: =, !=, EQ, NEQ

destIPv6Val IP address or range of IP addresses to match against the destination IP address of an outgoing IPv6 packet. In the command line interface, separate the range with a hyphen.

destPort Destination Port (range).

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

Possible values: =, !=, EQ, NEQ

destPortVal Port number or range of port numbers to match against the destination port number of an outgoing IPv6 packet. In the command 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. Maximum value: 65535

srcMac MAC address to match against the source MAC address of an outgoing IPv6 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 IPv6 packet.

Possible values: ICMPV6, TCP, UDP, ICMP, IGMP, EGP, IGP, ARGUS, RDP, RSVP, EIGRP, L2TP, ISIS, GGP, IPoverIP, ST, CBT, BBN-RCC-M, NVP-II, PUP, EMCON, XNET, CHAOS, MUX, DCN-MEAS, HMP, PRM, XNS-IDP, TRUNK-1, TRUNK-2, LEAF-1, LEAF-2, IRTP, ISO-TP4, NETBLT, MFE-NSP, MERIT-INP, SEP, 3PC, IDPR, XTP, DDP, IDPR-CMTP, TP++, IL, IPv6, SDRP, IPv6-Route, IPv6-Frag, IDRP, GRE, MHRP, BNA, ESP, AH, I-NLSP, SWIPE, NARP, MOBILE, TLSP, SKIP, IPv6-NoNx, IPv6-Opts, Any-Host-Internal-Protocol, CFTP, Any-Local-Network, SAT-EXPAK, KRYPTOLAN, RVD, IPPC, Any-Distributed-File-System, TFTP, VISA, IPCV, CPNX, CPHB, WSN, PVP, BR-SAT-MO, SUN-ND, WB-MON, WB-EXPAK, ISO-IP, VMTP, SECURE-VM, VINES, TTP, NSFNET-IG, DGP, TCF, OSPFIGP, Sprite-RP, LARP, MTP, AX.25, IPIP, MICP, SCC-SP, ETHERIP, Any-Private-Encryption-Scheme, GMTP, IFMP, PNNI, PIM, ARIS, SCPS, QNX, A/N, IPComp, SNP, Compaq-Pe, IPX-in-IP, VRRP, PGM, Any-0-Hop-Protocol, ENCAP, DDX, IATP, STP, SRP, UTI, SMP, SM, PTP, FIRE, CRTP, CRUDP, SSCOPMCE, IPLT, SPS, PIPE, SCTP, FC, RSVP-E2E-IGNORE, Mobility-Header, UDPLite

protocolNumber Protocol, identified by protocol number, to match against the protocol of an outgoing IPv6 packet. Minimum value: 1 Maximum value: 255

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

vxlan ID of the VXLAN. The Citrix ADC compares the PBR6 only to the outgoing packets on the specified VXLAN. If you do not specify an interface ID, the appliance compares the PBR6 to the outgoing packets on all VXLANs. Minimum value: 1 Maximum value: 16777215

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

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

msr Monitor the route specified by the Next Hop parameter.

Possible values: ENABLED, DISABLED Default value: DISABLED

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

nextHop IP address of the next hop router to which to send matching packets if action is set to ALLOW. This next hop should be directly reachable from the appliance.

nextHopVal The Next Hop IPv6 address

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

nextHopVlan VLAN number to be used for link local nexthop . Minimum value: 1 Maximum value: 4094

Example

set ns pbr6 rule1 -srcPort 50

unset ns pbr6

Resets the attributes of the specified PBR6. Attributes for which a default value is available revert to their default values. Refer to the set ns pbr6 command for descriptions of the parameters..Refer to the set ns pbr6 command for meanings of the arguments.

Synopsis

unset ns pbr6 [-srcIPv6] [-srcPort] [-destIPv6] [-destPort] [-srcMac] [-srcMacMask] [-protocol] [-interface] [-vlan] [-vxlan] [-msr] [-monitor] [-nextHop] [-ipTunnel] [-nextHopVlan] [-vxlanVlanMap]

Example

unset ns pbr6 rule1 -srcPort

stat ns pbr6

Displays statistics related to the PBR6s. To display statistics of all the PBR6s, run the command without any parameters. To display statistics of a particular PBR6, specify the name of the PBR6.

Synopsis

stat ns pbr6 [] [-detail] [-fullValues] [-ntimes ] [-logFile ] [-clearstats ( basic | full )]

Arguments

name Name of the PBR6 whose statistics you want the Citrix ADC to display.

detail Specifies detailed output (including more statistics). The output can be quite voluminous. Without this argument, the output will show only a summary.

fullValues Specifies that numbers and strings should be displayed in their full form. Without this option, long strings are shortened and large numbers are abbreviated

ntimes The number of times, in intervals of seven seconds, the statistics should be displayed. Default value: 1 Minimum value: 0

logFile The name of the log file to be used as input.

clearstats Clear the statsistics / counters

Possible values: basic, full

Output

count devno stateflag

Counters

Allow PBR6 hits (PBR6Allow) Total packets that matched the PBR6 with action ALLOW

Deny PBR6 hits (PBR6Deny) Total packets that matched PBR6 with action DENY

PBR6 hits (PBR6TotHits) Total packets that matched one of the configured PBR6

PBR6 misses (PBR6Miss) Total packets that did not match any PBR6

PBR6 Null Drop (PBR6NullDrop) Total packets that are dropped due to null next hop

Hits for this PBR6 (PBR6Hits) Number of times the pbr6 was hit

Example

stat pbr6

show ns pbr6

Displays settings related to the PBR6s. To display settings of all the PBR6s, run the command without any parameters. To display settings of a particular PBR6, specify the name of the PBR6.

Synopsis

show ns pbr6 [] [-detail]

Arguments

name Name of the PBR6 whose settings you want the Citrix ADC to display.

detail To get a detailed view.

Output

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.

action Action to perform on the outgoing IPv6 packets that match the PBR6.

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.

srcMac MAC address to match against the source MAC address of an outgoing IPv6 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".

stateflag PBR6 state flag.

protocol Protocol number in IPv6 header or name.

protocolNumber Protocol number in IPv6 header or name.

srcPortVal Port number or range of port numbers to match against the source port number of an outgoing IPv6 packet. In the command line interface, separate the range with a hyphen. For example: 40-90.

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

destPortVal Port number or range of port numbers to match against the destination port number of an outgoing IPv6 packet. In the command 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.

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

srcIPv6Val IP address or range of IP addresses to match against the source IP address of an outgoing IPv6 packet. In the command line interface, separate the range with a hyphen.

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

destIPv6Val IP address or range of IP addresses to match against the destination IP address of an outgoing IPv6 packet. In the command line interface, separate the range with a hyphen.

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

vlan ID of the VLAN. The Citrix ADC compares the PBR6 only to the outgoing packets on the specified VLAN. If you do not specify an interface ID, the appliance compares the PBR6 to the outgoing packets on all VLANs.

vxlan ID of the VXLAN. The Citrix ADC compares the PBR6 only to the outgoing packets on the specified VXLAN. If you do not specify an interface ID, the appliance compares the PBR6 to the outgoing packets on all VXLANs.

state Enable or disable the PBR6. After you apply the PBR6s, the Citrix ADC compares outgoing packets to the enabled PBR6s.

kernelstate Commit status of the PBR6.

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

hits Number of hits of this PBR6.

priority Priority of the PBR6, which determines the order in which it is evaluated relative to the other PBR6s. If you do not specify priorities while creating PBR6s, the PBR6s are evaluated in the order in which they are created.

msr Whether Monitored Static Route(MSR) is enabled or disabled.

monitor Name of the monitor, of type PING6 or ARP, configured on the Citrix ADC to monitor the route specified by the Next Hop parameter. You must enable the MSR parameter before setting the Monitor parameter.

state If this route is 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 for use with message code.

monStatParam2 Second parameter for use with message code.

monStatParam3 Third parameter for use with message code.

nextHopVal ID of the VLAN, if you have specified a link local address for the Next Hop parameter.

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

nextHopVlan VLAN number to be used for link local nexthop .

data Internal data of this route.

ownerGroup The owner node group in a Cluster for this pbr rule. If owner node group is not specified then the pbr rule is treated as Striped pbr rule.

devno count

Example

show ns pbr6 rule1 1) Name: r1 Action: DENY srcIPv6 = 2001::1 destIPv6 srcMac: srcMacMask: Protocol: Vlan: Interface: Active Status: ENABLED Applied Status: NOTAPPLIED Priority: 10 Hits: 0 Nexthop:

rm ns pbr6

Removes a PBR6 from the Citrix ADC. To commit this operation, you must apply the PBR6s.

Synopsis

rm ns pbr6 ...

Arguments

name Name of the PBR6 that you want to remove.

Example

rm ns pbr6 rule1

renumber ns pbr6

Renumbers the priorities of PBR6s to multiples of 10.To commit this operation, you must apply the PBR6s. Enables you to assign a new PBR6 a priority that is between two existing, consecutively numbered priorities. For example, if two PBR6s, PBR6-1 and PBR6-2, have priorities 2 and 3 renumbering changes those priorities to 20 and 30. You can then add PBR6-3 with priority 25.

Synopsis

renumber ns pbr6

Example

renumber pbr6

enable ns pbr6

Enables a PBR6. To commit this operation, you must apply the PBR6s.After you apply the PBR6s, the Citrix ADC compares outgoing packets to the enabled PBR6.

Synopsis

enable ns pbr6 ...

Arguments

name Name of PBR6 that you want to enable.

Example

enable ns pbr6 rule1

disable ns pbr6

Disables a PBR6. To commit this operation, you must apply the PBR6s.After you apply the PBR6s, the Citrix ADC does not compare outgoing packets to the disabled PBR6s.

Synopsis

disable ns pbr6 ...

Arguments

name Name of PBR6 that you want to disable.

Example

disable ns pbr6 rule1

add ns pbr6

Adds an IPv6 policy based route (PBR6) to the Citrix ADC. To commit this operation, you must apply the PBR6s. A PBR6 specifies criteria for selecting outgoing IPv6 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 PBR6s before processing the RNAT rules.

Synopsis

add ns pbr6 [-td ] [-srcIPv6 [] ] [-srcPort [] ] [-destIPv6 [] ] [-destPort [] ] [-srcMac [-srcMacMask ]] [-protocol | -protocolNumber ] [-vlan | -vxlan ] [-interface ] [-priority ] [-state ( ENABLED | DISABLED )] [-msr ( ENABLED | DISABLED ) [-monitor ]] [(-nextHop ) | (-ipTunnel [-vxlanVlanMap ])] [-nextHopVlan ] [-ownerGroup ]

Arguments

name Name for the PBR6. 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 PBR6 is created.

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

action Action to perform on the outgoing IPv6 packets that match the PBR6.

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.

Possible values: ALLOW, DENY

srcIPv6 IP address or range of IP addresses to match against the source IP address of an outgoing IPv6 packet. In the command line interface, separate the range with a hyphen.

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

Possible values: =, !=, EQ, NEQ

srcIPv6Val IP address or range of IP addresses to match against the source IP address of an outgoing IPv6 packet. In the command line interface, separate the range with a hyphen.

srcPort Port number or range of port numbers to match against the source port number of an outgoing IPv6 packet. In the command line interface, separate the range with a hyphen. For example: 40-90.

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

Possible values: =, !=, EQ, NEQ

srcPortVal Source port (range). Maximum value: 65535

destIPv6 IP address or range of IP addresses to match against the destination IP address of an outgoing IPv6 packet. In the command line interface, separate the range with a hyphen.

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

Possible values: =, !=, EQ, NEQ

destIPv6Val IP address or range of IP addresses to match against the destination IP address of an outgoing IPv6 packet. In the command line interface, separate the range with a hyphen.

destPort Port number or range of port numbers to match against the destination port number of an outgoing IPv6 packet. In the command 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.

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

Possible values: =, !=, EQ, NEQ

destPortVal Destination port (range). Maximum value: 65535

srcMac MAC address to match against the source MAC address of an outgoing IPv6 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 IPv6 packet.

Possible values: ICMPV6, TCP, UDP, ICMP, IGMP, EGP, IGP, ARGUS, RDP, RSVP, EIGRP, L2TP, ISIS, GGP, IPoverIP, ST, CBT, BBN-RCC-M, NVP-II, PUP, EMCON, XNET, CHAOS, MUX, DCN-MEAS, HMP, PRM, XNS-IDP, TRUNK-1, TRUNK-2, LEAF-1, LEAF-2, IRTP, ISO-TP4, NETBLT, MFE-NSP, MERIT-INP, SEP, 3PC, IDPR, XTP, DDP, IDPR-CMTP, TP++, IL, IPv6, SDRP, IPv6-Route, IPv6-Frag, IDRP, GRE, MHRP, BNA, ESP, AH, I-NLSP, SWIPE, NARP, MOBILE, TLSP, SKIP, IPv6-NoNx, IPv6-Opts, Any-Host-Internal-Protocol, CFTP, Any-Local-Network, SAT-EXPAK, KRYPTOLAN, RVD, IPPC, Any-Distributed-File-System, TFTP, VISA, IPCV, CPNX, CPHB, WSN, PVP, BR-SAT-MO, SUN-ND, WB-MON, WB-EXPAK, ISO-IP, VMTP, SECURE-VM, VINES, TTP, NSFNET-IG, DGP, TCF, OSPFIGP, Sprite-RP, LARP, MTP, AX.25, IPIP, MICP, SCC-SP, ETHERIP, Any-Private-Encryption-Scheme, GMTP, IFMP, PNNI, PIM, ARIS, SCPS, QNX, A/N, IPComp, SNP, Compaq-Pe, IPX-in-IP, VRRP, PGM, Any-0-Hop-Protocol, ENCAP, DDX, IATP, STP, SRP, UTI, SMP, SM, PTP, FIRE, CRTP, CRUDP, SSCOPMCE, IPLT, SPS, PIPE, SCTP, FC, RSVP-E2E-IGNORE, Mobility-Header, UDPLite

protocolNumber Protocol, identified by protocol number, to match against the protocol of an outgoing IPv6 packet. Minimum value: 1 Maximum value: 255

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

vxlan ID of the VXLAN. The Citrix ADC compares the PBR6 only to the outgoing packets on the specified VXLAN. If you do not specify an interface ID, the appliance compares the PBR6 to the outgoing packets on all VXLANs. Minimum value: 1 Maximum value: 16777215

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

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

state Enable or disable the PBR6. After you apply the PBR6s, the Citrix ADC compares outgoing packets to the enabled PBR6s.

Possible values: ENABLED, DISABLED Default value: ENABLED

msr Monitor the route specified by the Next Hop parameter.

Possible values: ENABLED, DISABLED Default value: DISABLED

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

nextHop IP address of the next hop router to which to send matching packets if action is set to ALLOW. This next hop should be directly reachable from the appliance.

nextHopVal The Next Hop IPv6 address.

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

nextHopVlan VLAN number to be used for link local nexthop . Minimum value: 1 Maximum value: 4094

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

Example

add ns pbr6 rule1 ALLOW -srcport 45-1024 -destIPv6 2001::45 -nexthop 2001::49 add ns pbr6 rule2 ALLOW -srcIPv6 200::1 -destIPv6 200::5 -priority 10 -ipTunnel t8 -vxlanVlanMap maptbl1

Was this article helpful?