Product Documentation

nspbr6

Sep 07, 2016

Configuration for PBR6 entry resource.

Properties (click to see Operations)

Name Data Type Permissions Description
name
<String>
Read-write
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.
Minimum length = 1
td
<Double>
Read-write
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
<String>
Read-write
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
<Boolean>
Read-write
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.
srcipop
<String>
Read-write
Either the equals (=) or does not equal (!=) logical operator.
Possible values = =, !=, EQ, NEQ
srcipv6val
<String>
Read-write
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
<Boolean>
Read-write
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].
srcportop
<String>
Read-write
Logical operator.
Possible values = =, !=, EQ, NEQ
srcportval
<String>
Read-write
Source port (range).
Maximum length = 65535
destipv6
<Boolean>
Read-write
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.
destipop
<String>
Read-write
Logical operator.
Possible values = =, !=, EQ, NEQ
destipv6val
<String>
Read-write
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
<Boolean>
Read-write
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.
destportop
<String>
Read-write
Logical operator.
Possible values = =, !=, EQ, NEQ
destportval
<String>
Read-write
Destination port (range).
Maximum length = 65535
srcmac
<String>
Read-write
MAC address to match against the source MAC address of an outgoing IPv6 packet.
srcmacmask
<String>
Read-write
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
<String>
Read-write
Protocol, identified by protocol name, to match against the protocol of an outgoing IPv6 packet.
Possible values = ICMPV6, TCP, UDP
protocolnumber
<Double>
Read-write
Protocol, identified by protocol number, to match against the protocol of an outgoing IPv6 packet.
Minimum value = 1
Maximum value = 255
vlan
<Double>
Read-write
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
<Double>
Read-write
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
<String>
Read-write
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
<Double>
Read-write
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
<String>
Read-write
Enable or disable the PBR6. After you apply the PBR6s, the NetScaler appliance compares outgoing packets to the enabled PBR6s.
Default value: ENABLED
Possible values = ENABLED, DISABLED
msr
<String>
Read-write
Monitor the route specified by the Next Hop parameter.
Default value: DISABLED
Possible values = ENABLED, DISABLED
monitor
<String>
Read-write
The name of the monitor.(Can be only of type ping or ARP ).
Minimum length = 1
nexthop
<Boolean>
Read-write
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
<String>
Read-write
The Next Hop IPv6 address.
iptunnel
<String>
Read-write
The iptunnel name where packets need to be forwarded upon.
vxlanvlanmap
<String>
Read-write
The vlan to vxlan mapping to be applied for incoming packets over this pbr tunnel.
nexthopvlan
<Double>
Read-write
VLAN number to be used for link local nexthop .
Minimum value = 1
Maximum value = 4094
ownergroup
<String>
Read-write
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
Minimum length = 1
detail
<Boolean>
Read-write
To get a detailed view.
kernelstate
<String>
Read-only
Commit status of the PBR6.
Default value: NOTAPPLIED
Possible values = APPLIED, NOTAPPLIED, RE-APPLY, SFAPPLIED, SFNOTAPPLIED
hits
<Double>
Read-only
Number of hits of this PBR6.
curstate
<Double>
Read-only
If this route is UP/DOWN.
totalprobes
<Double>
Read-only
The total number of probes sent.
totalfailedprobes
<Double>
Read-only
The total number of failed probes.
failedprobes
<Double>
Read-only
Number of the current failed monitoring probes.
monstatcode
<Integer>
Read-only
The code indicating the monitor response.
monstatparam1
<Integer>
Read-only
First parameter for use with message code.
monstatparam2
<Integer>
Read-only
Second parameter for use with message code.
monstatparam3
<Integer>
Read-only
Third parameter for use with message code.
data
<Boolean>
Read-only
Internal data of this route.
__count
<Double>
Read-only
count parameter

Operations (click to see Properties)

Some options that you can use for each operations:

  • Getting warnings in response: NITRO allows you to get warnings in an operation by specifying the "warning" query parameter as "yes". For example, to get warnings while connecting to the NetScaler appliance, the URL is as follows:

    http://<netscaler-ip-address>/nitro/v1/config/login?warning=yes

    If any, the warnings are displayed in the response payload with the HTTP code "209 X-NITRO-WARNING".

  • Authenticated access for individual NITRO operations: NITRO allows you to logon to the NetScaler appliance to perform individual operations. You can use this option instead of creating a NITRO session (using the login object) and then using that session to perform all operations,

    To do this, you must specify the username and password in the request header of the NITRO request as follows:

    X-NITRO-USER:<username>

    X-NITRO-PASS:<password>

    Note: In such cases, make sure that the request header DOES not include the following:

    Cookie:NITRO_AUTH_TOKEN=<tokenvalue>

메모

Mandatory parameters are marked in red and placeholder content is marked in <green>.

add

URL: http://<netscaler-ip-address>/nitro/v1/config/nspbr6

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue>
Content-Type:application/json

Request Payload:

{"nspbr6":{
      "name":<String_value>,
      "td":<Double_value>,
      "action":<String_value>,
      "srcipv6":<Boolean_value>,
      "srcipop":<String_value>,
      "srcipv6val":<String_value>,
      "srcport":<Boolean_value>,
      "srcportop":<String_value>,
      "srcportval":<String_value>,
      "destipv6":<Boolean_value>,
      "destipop":<String_value>,
      "destipv6val":<String_value>,
      "destport":<Boolean_value>,
      "destportop":<String_value>,
      "destportval":<String_value>,
      "srcmac":<String_value>,
      "srcmacmask":<String_value>,
      "protocol":<String_value>,
      "protocolnumber":<Double_value>,
      "vlan":<Double_value>,
      "vxlan":<Double_value>,
      "Interface":<String_value>,
      "priority":<Double_value>,
      "state":<String_value>,
      "msr":<String_value>,
      "monitor":<String_value>,
      "nexthop":<Boolean_value>,
      "nexthopval":<String_value>,
      "iptunnel":<String_value>,
      "vxlanvlanmap":<String_value>,
      "nexthopvlan":<Double_value>,
      "ownergroup":<String_value>
}}

Response:

HTTP Status Code on Success: 201 Created
HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

renumber

URL: http://<netscaler-ip-address>/nitro/v1/config/nspbr6?action=renumber

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue>
Content-Type:application/json

Request Payload:

{"nspbr6":{
}}

Response:

HTTP Status Code on Success: 200 OK
HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

delete

URL: http://<netscaler-ip-address>/nitro/v1/config/nspbr6/name_value<String>

HTTP Method: DELETE

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue>

Response:

HTTP Status Code on Success: 200 OK
HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

update

URL: http://<netscaler-ip-address>/nitro/v1/config/nspbr6

HTTP Method: PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue>
Content-Type:application/json

Request Payload:

{"nspbr6":{
      "name":<String_value>,
      "action":<String_value>,
      "srcipv6":<Boolean_value>,
      "srcipop":<String_value>,
      "srcipv6val":<String_value>,
      "srcport":<Boolean_value>,
      "srcportop":<String_value>,
      "srcportval":<String_value>,
      "destipv6":<Boolean_value>,
      "destipop":<String_value>,
      "destipv6val":<String_value>,
      "destport":<Boolean_value>,
      "destportop":<String_value>,
      "destportval":<String_value>,
      "srcmac":<String_value>,
      "srcmacmask":<String_value>,
      "protocol":<String_value>,
      "protocolnumber":<Double_value>,
      "vlan":<Double_value>,
      "vxlan":<Double_value>,
      "Interface":<String_value>,
      "priority":<Double_value>,
      "msr":<String_value>,
      "monitor":<String_value>,
      "nexthop":<Boolean_value>,
      "nexthopval":<String_value>,
      "iptunnel":<String_value>,
      "vxlanvlanmap":<String_value>,
      "nexthopvlan":<Double_value>
}}

Response:

HTTP Status Code on Success: 200 OK
HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

unset

URL: http://<netscaler-ip-address>/nitro/v1/config/nspbr6?action=unset

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue>
Content-Type:application/json

Request Payload:

{"nspbr6":{
      "name":<String_value>,
      "srcipv6":true,
      "srcport":true,
      "destipv6":true,
      "destport":true,
      "srcmac":true,
      "srcmacmask":true,
      "protocol":true,
      "Interface":true,
      "vlan":true,
      "vxlan":true,
      "msr":true,
      "monitor":true,
      "nexthop":true,
      "iptunnel":true,
      "nexthopvlan":true,
      "vxlanvlanmap":true
}}

Response:

HTTP Status Code on Success: 200 OK
HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

enable

URL: http://<netscaler-ip-address>/nitro/v1/config/nspbr6?action=enable

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue>
Content-Type:application/json

Request Payload:

{"nspbr6":{
      "name":<String_value>
}}

Response:

HTTP Status Code on Success: 200 OK
HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

disable

URL: http://<netscaler-ip-address>/nitro/v1/config/nspbr6?action=disable

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue>
Content-Type:application/json

Request Payload:

{"nspbr6":{
      "name":<String_value>
}}

Response:

HTTP Status Code on Success: 200 OK
HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

clear

URL: http://<netscaler-ip-address>/nitro/v1/config/nspbr6?action=clear

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue>
Content-Type:application/json

Request Payload:

{"nspbr6":{
}}

Response:

HTTP Status Code on Success: 200 OK
HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

apply

URL: http://<netscaler-ip-address>/nitro/v1/config/nspbr6?action=apply

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue>
Content-Type:application/json

Request Payload:

{"nspbr6":{
}}

Response:

HTTP Status Code on Success: 200 OK
HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

get (all)

URL: http://<netscaler-ip-address>/nitro/v1/config/nspbr6

Query-parameters:

args

http://<netscaler-ip-address>/nitro/v1/config/nspbr6?args=name:<String_value>,detail:<Boolean_value>

Use this query-parameter to get nspbr6 resources based on additional properties.

attrs

http://<netscaler-ip-address>/nitro/v1/config/nspbr6?attrs=property-name1,property-name2

Use this query parameter to specify the resource details that you want to retrieve.

filter

http://<netscaler-ip-address>/nitro/v1/config/nspbr6?filter=property-name1:property-val1,property-name2:property-val2

Use this query-parameter to get the filtered set of nspbr6 resources configured on NetScaler.Filtering can be done on any of the properties of the resource.

view

http://<netscaler-ip-address>/nitro/v1/config/nspbr6?view=summary

Note: By default, the retrieved results are displayed in detail view (?view=detail).

pagination

http://<netscaler-ip-address>/nitro/v1/config/nspbr6?pagesize=#no&pageno=#no

Use this query-parameter to get the nspbr6 resources in chunks.

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue>
Accept:application/json

Response:

HTTP Status Code on Success: 200 OK
HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

Response Headers:

Content-Type:application/json

Response Payload:

{ "nspbr6": [ {
name:<String_value>,detail:<Boolean_value>      "td":<Double_value>,
      "action":<String_value>,
      "srcmac":<String_value>,
      "srcmacmask":<String_value>,
      "protocol":<String_value>,
      "protocolnumber":<Double_value>,
      "srcportval":<String_value>,
      "destportval":<String_value>,
      "srcipv6val":<String_value>,
      "destipv6val":<String_value>,
      "vlan":<Double_value>,
      "vxlan":<Double_value>,
      "state":<String_value>,
      "kernelstate":<String_value>,
      "Interface":<String_value>,
      "hits":<Double_value>,
      "priority":<Double_value>,
      "srcipop":<String_value>,
      "destipop":<String_value>,
      "srcportop":<String_value>,
      "destportop":<String_value>,
      "msr":<String_value>,
      "monitor":<String_value>,
      "curstate":<Double_value>,
      "totalprobes":<Double_value>,
      "totalfailedprobes":<Double_value>,
      "failedprobes":<Double_value>,
      "monstatcode":<Integer_value>,
      "monstatparam1":<Integer_value>,
      "monstatparam2":<Integer_value>,
      "monstatparam3":<Integer_value>,
      "nexthopval":<String_value>,
      "iptunnel":<String_value>,
      "vxlanvlanmap":<String_value>,
      "nexthopvlan":<Double_value>,
      "data":<Boolean_value>,
      "ownergroup":<String_value>
}]}

get

URL: http://<netscaler-ip-address>/nitro/v1/config/nspbr6/name_value<String>

Query-parameters:

attrs

http://<netscaler-ip-address>/nitro/v1/config/nspbr6/name_value<String>?attrs=property-name1,property-name2

Use this query parameter to specify the resource details that you want to retrieve.

view

http://<netscaler-ip-address>/nitro/v1/config/nspbr6/name_value<String>?view=summary

Note: By default, the retrieved results are displayed in detail view (?view=detail).

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue>
Accept:application/json

Response:

HTTP Status Code on Success: 200 OK
HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

Response Headers:

Content-Type:application/json

Response Payload:

{ "nspbr6": [ {
name:<String_value>,detail:<Boolean_value>      "td":<Double_value>,
      "action":<String_value>,
      "srcmac":<String_value>,
      "srcmacmask":<String_value>,
      "protocol":<String_value>,
      "protocolnumber":<Double_value>,
      "srcportval":<String_value>,
      "destportval":<String_value>,
      "srcipv6val":<String_value>,
      "destipv6val":<String_value>,
      "vlan":<Double_value>,
      "vxlan":<Double_value>,
      "state":<String_value>,
      "kernelstate":<String_value>,
      "Interface":<String_value>,
      "hits":<Double_value>,
      "priority":<Double_value>,
      "srcipop":<String_value>,
      "destipop":<String_value>,
      "srcportop":<String_value>,
      "destportop":<String_value>,
      "msr":<String_value>,
      "monitor":<String_value>,
      "curstate":<Double_value>,
      "totalprobes":<Double_value>,
      "totalfailedprobes":<Double_value>,
      "failedprobes":<Double_value>,
      "monstatcode":<Integer_value>,
      "monstatparam1":<Integer_value>,
      "monstatparam2":<Integer_value>,
      "monstatparam3":<Integer_value>,
      "nexthopval":<String_value>,
      "iptunnel":<String_value>,
      "vxlanvlanmap":<String_value>,
      "nexthopvlan":<Double_value>,
      "data":<Boolean_value>,
      "ownergroup":<String_value>
}]}

count

URL: http://<netscaler-ip-address>/nitro/v1/config/nspbr6?count=yes

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue>
Accept:application/json

Response:

HTTP Status Code on Success: 200 OK
HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

Response Headers:

Content-Type:application/json

Response Payload:

{ "nspbr6": [ { "__count": "#no"} ] }