getnspbr6Result Structure Definition

The getnspbr6Result structure defines the return type for getnspbr6 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.

nspbr6List

List of nspbr6s


nspbr6 Structure Definition

The nspbr6 structure defines the actual return type values for getnspbr6 API.

Syntax



Members

name

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

detail

To get a detailed view.

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

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

srcipv6val

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

operatoR3

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 method line interface, separate the range with a hyphen.

operatoR4

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.

state2

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.

_nextgenapiresource


See Also