ns pbr6¶
The following operations can be performed on "ns pbr6":
add | renumber | rm | set | unset | enable | disable | stat | show | clear | apply
add ns pbr6¶
Adds an IPv6 policy based route (PBR6) to the NetScaler appliance. 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 NetScaler appliance to route outgoing packets from a specific IP address or range to a particular next hop router.Note: The NetScaler appliance process PBR6s before processing the RNAT rules.
Synopsys¶
add ns pbr6 <name> [-td <positive_integer>] <action> [-srcIPv6 [<operator>] <srcIPv6Val>] [-srcPort [<operator>] <srcPortVal>] [-destIPv6 [<operator>] <destIPv6Val>] [-destPort [<operator>] <destPortVal>] [-srcMac <mac_addr> [-srcMacMask <string>]] [-protocol <protocol> | -protocolNumber <positive_integer>] [-vlan <positive_integer> | -vxlan <positive_integer>] [-interface <interface_name>] [-priority <positive_integer>] [-state ( ENABLED | DISABLED )] [-msr ( ENABLED | DISABLED ) [-monitor <string>]] [(-nextHop <nextHopVal>) | -ipTunnel <string>] [-nextHopVlan <positive_integer>]
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 NetScaler appliance sends the packet to the designated next-hop router.
-
DENY - The NetScaler appliance 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 and enclose within brackets.
operator
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 and enclose within brackets.
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 and enclose within brackets. For example: [40-90].
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 and enclose within brackets.
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 and enclose within brackets.
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 and enclose within brackets. For example: [40-90].
Note: The destination port can be specified only for TCP and UDP protocols.
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
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 NetScaler appliance 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 NetScaler appliance 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 NetScaler appliance 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: 80000
state
Enable or disable the PBR6. After you apply the PBR6s, the NetScaler appliance 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.
nextHopVlan
VLAN number to be used for link local nexthop .
Minimum value: 1
Maximum value: 4094
Example¶
add ns pbr6 rule1 ALLOW -srcport 45-1024 -destIPv6 2001::45 -nexthop 2001::49
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.
Synopsys¶
renumber ns pbr6
Example¶
renumber pbr6
rm ns pbr6¶
Removes a PBR6 from the NetScaler appliance. To commit this operation, you must apply the PBR6s.
Synopsys¶
rm ns pbr6 <name> ...
Arguments¶
name
Name of the PBR6 that you want to remove.
Example¶
rm ns pbr6 rule1
set ns pbr6¶
Modifies the specified parameters of a PBR6.To commit this operation, you must apply the PBR6s.
Synopsys¶
set ns pbr6 <name> [-action ( ALLOW | DENY )] [-srcIPv6 [<operator>] <srcIPv6Val>] [-srcPort [<operator>] <srcPortVal>] [-destIPv6 [<operator>] <destIPv6Val>] [-destPort [<operator>] <destPortVal>] [-srcMac <mac_addr> [-srcMacMask <string>]] [-protocol <protocol> | -protocolNumber <positive_integer>] [-vlan <positive_integer> | -vxlan <positive_integer>] [-interface <interface_name>] [-priority <positive_integer>] [-msr ( ENABLED | DISABLED ) [-monitor <string>]] [(-nextHop <nextHopVal>) | -ipTunnel <string>] [-nextHopVlan <positive_integer>]
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 NetScaler appliance sends the packet to the designated next-hop router.
-
DENY - The NetScaler appliance 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 and enclose within brackets.
operator
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 and enclose within brackets.
srcPort
Source Port (range).
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 and enclose within brackets. 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 and enclose within brackets.
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 and enclose within brackets.
destPort
Destination Port (range).
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 and enclose within brackets. 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
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 NetScaler appliance 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 NetScaler appliance 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 NetScaler appliance 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: 80000
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.
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.
Synopsys¶
unset ns pbr6 <name> [-srcIPv6] [-srcPort] [-destIPv6] [-destPort] [-srcMac] [-srcMacMask] [-protocol] [-interface] [-vlan] [-vxlan] [-msr] [-monitor] [-nextHop] [-ipTunnel] [-nextHopVlan]
Example¶
unset ns pbr6 rule1 -srcPort
enable ns pbr6¶
Enables a PBR6. To commit this operation, you must apply the PBR6s.After you apply the PBR6s, the NetScaler appliance compares outgoing packets to the enabled PBR6.
Synopsys¶
enable ns pbr6 <name> ...
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 NetScaler appliance does not compare outgoing packets to the disabled PBR6s.
Synopsys¶
disable ns pbr6 <name> ...
Arguments¶
name
Name of PBR6 that you want to disable.
Example¶
disable ns pbr6 rule1
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.
Synopsys¶
stat ns pbr6 [<name>] [-detail] [-fullValues] [-ntimes <positive_integer>] [-logFile <input_filename>] [-clearstats ( basic | full )]
Arguments¶
name
Name of the PBR6 whose statistics you want the NetScaler appliance 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
Outputs¶
count
devno
stateflag
Outputs¶
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
Hits for this PBR6 (PBR6Hits)
Number of times the pbr6 was hit
Example¶
stat pbr6
Related Commands¶
- stat ns
- stat ns limitIdentifier
- stat ns acl
- stat ns acl6
- stat ns simpleacl
- stat ns simpleacl6
- stat ns pbr
- stat ns memory
- stat ns trafficDomain
- stat ns partition
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.
Synopsys¶
show ns pbr6 [<name>] [-detail]
Arguments¶
name
Name of the PBR6 whose settings you want the NetScaler appliance to display.
detail
To get a detailed view.
Outputs¶
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 NetScaler appliance sends the packet to the designated next-hop router.
-
DENY - The NetScaler appliance 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 and enclose within brackets. For example: [40-90].
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 and enclose within brackets. For example: [40-90].
Note: The destination port can be specified only for TCP and UDP protocols.
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 and enclose within brackets.
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 and enclose within brackets.
vlan
ID of the VLAN. The NetScaler appliance 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 NetScaler appliance 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
If this route is UP/DOWN.
kernelstate
Commit status of the PBR6.
interface
ID of an interface. The NetScaler appliance 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.
operator
Logical operator.
msr
Whether Monitored Static Route(MSR) is enabled or disabled.
monitor
Name of the monitor, of type PING6 or ARP, configured on the NetScaler appliance to monitor the route specified by the Next Hop parameter. You must enable the MSR parameter before setting the Monitor parameter.
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.
nextHopVlan
VLAN number to be used for link local nexthop .
data
Internal data of this route.
devno
count
Example¶
show ns pbr6 rule11) Name: r1 Action: DENY srcIPv6 = 2001::1 destIPv6 srcMac: srcMacMask: Protocol: Vlan: Interface: Active Status: ENABLED Applied Status: NOTAPPLIED Priority: 10 Hits: 0 Nexthop:
clear ns pbr6¶
Removes all PBR6s from the NetScaler appliance. This operation does not require an explicit apply.
Synopsys¶
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 NetScaler appliance. The NetScaler appliance uses the lookup table (not the configuration file) to filter the outgoing IPv6 packets.
Synopsys¶
apply ns pbr6
Example¶
apply ns pbr6