Download full document:

nspbr6

Configuration for PBR6 entry resource.

Properties

(click to see Operations)

Name Data Type PermissionsDescription
name<String>Read-writeName 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.<br>Minimum length = 1
td<Double>Read-writeInteger 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.<br>Minimum value = 0<br>Maximum value = 4094
action<String>Read-writeAction 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.<br>Possible values = ALLOW, DENY
srcipv6<Boolean>Read-writeIP 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-writeEither the equals (=) or does not equal (!=) logical operator.<br>Possible values = =, !=, EQ, NEQ
srcipv6val<String>Read-writeIP 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-writePort 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-writeLogical operator.<br>Possible values = =, !=, EQ, NEQ
srcportval<String>Read-writeSource port (range).<br>Maximum length = 65535
destipv6<Boolean>Read-writeIP 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-writeLogical operator.<br>Possible values = =, !=, EQ, NEQ
destipv6val<String>Read-writeIP 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-writePort 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-writeLogical operator.<br>Possible values = =, !=, EQ, NEQ
destportval<String>Read-writeDestination port (range).<br>Maximum length = 65535
srcmac<String>Read-writeMAC address to match against the source MAC address of an outgoing IPv6 packet.
srcmacmask<String>Read-writeUsed 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". .<br>Default value: "000000000000"
protocol<String>Read-writeProtocol, identified by protocol name, to match against the protocol of an outgoing IPv6 packet.<br>Possible values = ICMPV6, TCP, UDP
protocolnumber<Double>Read-writeProtocol, identified by protocol number, to match against the protocol of an outgoing IPv6 packet.<br>Minimum value = 1<br>Maximum value = 255
vlan<Double>Read-writeID 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.<br>Minimum value = 1<br>Maximum value = 4094
vxlan<Double>Read-writeID 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.<br>Minimum value = 1<br>Maximum value = 16777215
Interface<String>Read-writeID 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-writePriority 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.<br>Minimum value = 1<br>Maximum value = 80000
state<String>Read-writeEnable or disable the PBR6. After you apply the PBR6s, the NetScaler appliance compares outgoing packets to the enabled PBR6s.<br>Default value: ENABLED<br>Possible values = ENABLED, DISABLED
msr<String>Read-writeMonitor the route specified by the Next Hop parameter.<br>Default value: DISABLED<br>Possible values = ENABLED, DISABLED
monitor<String>Read-writeThe name of the monitor.(Can be only of type ping or ARP ).<br>Minimum length = 1
nexthop<Boolean>Read-writeIP 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-writeThe Next Hop IPv6 address.
iptunnel<String>Read-writeThe iptunnel name where packets need to be forwarded upon.
nexthopvlan<Double>Read-writeVLAN number to be used for link local nexthop .<br>Minimum value = 1<br>Maximum value = 4094
detail<Boolean>Read-writeTo get a detailed view.
kernelstate<String>Read-onlyCommit status of the PBR6.<br>Default value: NOTAPPLIED<br>Possible values = APPLIED, NOTAPPLIED, RE-APPLY, SFAPPLIED, SFNOTAPPLIED
hits<Double>Read-onlyNumber of hits of this PBR6.
curstate<Double>Read-onlyIf this route is UP/DOWN.
totalprobes<Double>Read-onlyThe total number of probes sent.
totalfailedprobes<Double>Read-onlyThe total number of failed probes.
failedprobes<Double>Read-onlyNumber of the current failed monitoring probes.
monstatcode<Integer>Read-onlyThe code indicating the monitor response.
monstatparam1<Integer>Read-onlyFirst parameter for use with message code.
monstatparam2<Integer>Read-onlySecond parameter for use with message code.
monstatparam3<Integer>Read-onlyThird parameter for use with message code.
data<Boolean>Read-onlyInternal data of this route.
__count<Double>Read-onlycount parameter

Operations

(click to see Properties)

ADD | RENUMBER | DELETE | UPDATE | UNSET | ENABLE | DISABLE | CLEAR | APPLY | GET (ALL) | GET | COUNT

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>

Note:

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

add

URL: http://<NSIP>/nitro/v1/config/

HTTP Method: POST

Request Payload: 

object={
"params":{
      "warning":<String_value>,
      "onerror":<String_value>
},
"sessionid":"##sessionid",
"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>,
      "nexthopvlan":<Double_value>,
}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": }

renumber

URL: http://<NSIP>/nitro/v1/config/

HTTP Method: POST

Request Payload: 

object={
"params":{
      "warning":<String_value>,
      "onerror":<String_value>,
      "action":"renumber"
},
"sessionid":"##sessionid",
"nspbr6":{
}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": }

delete

URL: http://<NSIP>/nitro/v1/config/nspbr6/name_value<String>

Query-parameters:

warning

http://<NS_IP>/nitro/v1/config/nspbr6/name_value<String>?warning=yes

Use this query parameter to get warnings in nitro response. If this field is set to YES, warning message will be sent in 'message' field and 'WARNING' value is set in severity field of the response in case there is a

HTTP Method: DELETE

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": }

update

URL: http://<NSIP>/nitro/v1/config/

HTTP Method: PUT

Request Payload: 

{
"params": {
      "warning":<String_value>,
      "onerror":<String_value>"
},
sessionid":"##sessionid",
"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>,
      "nexthopvlan":<Double_value>,
}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": }

unset

URL: http://<NSIP>/nitro/v1/config/

HTTP Method: POST

Request Payload: 

object={
"params":{
      "warning":<String_value>,
      "onerror":<String_value>,
      "action":"unset"
},
"sessionid":"##sessionid",
"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,
}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": }

enable

URL: http://<NSIP>/nitro/v1/config/

HTTP Method: POST

Request Payload: 

object={
"params":{
      "warning":<String_value>,
      "onerror":<String_value>,
      "action":"enable"
},
"sessionid":"##sessionid",
"nspbr6":{
      "name":<String_value>,
}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": }

disable

URL: http://<NSIP>/nitro/v1/config/

HTTP Method: POST

Request Payload: 

object={
"params":{
      "warning":<String_value>,
      "onerror":<String_value>,
      "action":"disable"
},
"sessionid":"##sessionid",
"nspbr6":{
      "name":<String_value>,
}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": }

clear

URL: http://<NSIP>/nitro/v1/config/

HTTP Method: POST

Request Payload: 

object={
"params":{
      "warning":<String_value>,
      "onerror":<String_value>,
      "action":"clear"
},
"sessionid":"##sessionid",
"nspbr6":{
}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": }

apply

URL: http://<NSIP>/nitro/v1/config/

HTTP Method: POST

Request Payload: 

object={
"params":{
      "warning":<String_value>,
      "onerror":<String_value>,
      "action":"apply"
},
"sessionid":"##sessionid",
"nspbr6":{
}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": }

get (all)

URL: http://<NSIP>/nitro/v1/config/nspbr6

Query-parameters:

args

http://<NSIP>/nitro/v1/config/nspbr6?args= "name":<String_value>, "detail":<Boolean_value>,

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

filter

http://<NSIP>/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://<NS_IP>/nitro/v1/config/nspbr6?view=summary

Use this query-parameter to get the summary output of nspbr6 resources configured on NetScaler.

pagesize=#no;pageno=#no

http://<NS_IP>/nitro/v1/config/nspbr6?pagesize=#no;pageno=#no

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

warning

http://<NS_IP>/nitro/v1/config/nspbr6?warning=yes

Use this query parameter to get warnings in nitro response. If this field is set to YES, warning message will be sent in 'message' field and 'WARNING' value is set in severity field of the response in case there is a

HTTP Method: GET

Response Payload: 

{ "errorcode": 0, "message": "Done", "severity": <String_value>, "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>,
      "nexthopvlan":<Double_value>,
      "data":<Boolean_value>

}]}

get

URL: http://<NS_IP>/nitro/v1/config/nspbr6/name_value<String>

HTTP Method: GET

Response Payload: 

{ "errorcode": 0, "message": "Done", "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>,
      "nexthopvlan":<Double_value>,
      "data":<Boolean_value>

}]}

count

URL: http://<NS_IP>/nitro/v1/config/nspbr6?count=yes

HTTP Method: GET

Response Payload:

{ "errorcode": 0, "message": "Done",nspbr6: [ { "__count": "#no"} ] }