Product Documentation

vrid

Sep 07, 2016

Configuration for Virtual Router ID resource.

Properties (click to see Operations)

Name Data Type Permissions Description
id
<Double>
Read-write
Integer that uniquely identifies the VMAC address. The generic VMAC address is in the form of 00:00:5e:00:01:<VRID>. For example, if you add a VRID with a value of 60 and bind it to an interface, the resulting VMAC address is 00:00:5e:00:01:3c, where 3c is the hexadecimal representation of 60.
Minimum value = 1
Maximum value = 255
priority
<Double>
Read-write
Base priority (BP), in an active-active mode configuration, which ordinarily determines the master VIP address.
Default value: 255
Minimum value = 0
Maximum value = 255
preemption
<String>
Read-write
In an active-active mode configuration, make a backup VIP address the master if its priority becomes higher than that of a master VIP address bound to this VMAC address.
If you disable pre-emption while a backup VIP address is the master, the backup VIP address remains master until the original master VIP's priority becomes higher than that of the current master.
Default value: ENABLED
Possible values = ENABLED, DISABLED
sharing
<String>
Read-write
In an active-active mode configuration, enable the backup VIP address to process any traffic instead of dropping it.
Default value: DISABLED
Possible values = ENABLED, DISABLED
tracking
<String>
Read-write
The effective priority (EP) value, relative to the base priority (BP) value in an active-active mode configuration. When EP is set to a value other than None, it is EP, not BP, which determines the master VIP address.
Available settings function as follows:
* NONE - No tracking. EP = BP
* ALL - If the status of all virtual servers is UP, EP = BP. Otherwise, EP = 0.
* ONE - If the status of at least one virtual server is UP, EP = BP. Otherwise, EP = 0.
* PROGRESSIVE - If the status of all virtual servers is UP, EP = BP. If the status of all virtual servers is DOWN, EP = 0. Otherwise EP = BP (1 - K/N), where N is the total number of virtual servers associated with the VIP address and K is the number of virtual servers for which the status is DOWN.
Default: NONE.
Default value: NONE
Possible values = NONE, ONE, ALL, PROGRESSIVE
ownernode
<Double>
Read-write
Assign a cluster node as the owner of this VMAC address. If no owner is configured, owner node is displayed as ALL and one node is dynamically elected as the owner.
Minimum value = 0
Maximum value = 31
trackifnumpriority
<Double>
Read-write
Priority by which the Effective priority will be reduced if any of the tracked interfaces goes down.
Default value: 0
Minimum value = 1
Maximum value = 255
preemptiondelaytimer
<Double>
Read-write
Preemption delay time in seconds. If any high priority node will come in network, it will wait for these many seconds before becoming master.
Default value: 0
Minimum value = 1
Maximum value = 36000
all
<Boolean>
Read-write
Remove all the configured VMAC addresses from the NetScaler appliance.
ifaces
<String>
Read-only
Interfaces bound to this VRID.
type
<String>
Read-only
Indicates whether this VRID entry was added manually or dynamically. When you manually add a VRID entry, the value for this parameter is STATIC. Otherwise, it is DYNAMIC.
Possible values = STATIC, DYNAMIC
effectivepriority
<Double>
Read-only
The effective priority of this VRID.
flags
<Double>
Read-only
Flags.
ipaddress
<String>
Read-only
The IP address bound to the VRID.
state
<Double>
Read-only
State of this VRID.
operationalownernode
<Double>
Read-only
Run time owner node of the vrid.
Minimum value = 0
Maximum value = 31
__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/vrid

HTTP Method: POST

Request Headers:

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

Request Payload:

{"vrid":{
      "id":<Double_value>,
      "priority":<Double_value>,
      "preemption":<String_value>,
      "sharing":<String_value>,
      "tracking":<String_value>,
      "ownernode":<Double_value>,
      "trackifnumpriority":<Double_value>,
      "preemptiondelaytimer":<Double_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

delete

URL: http://<netscaler-ip-address>/nitro/v1/config/vrid/id_value<Double>

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/vrid

HTTP Method: PUT

Request Headers:

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

Request Payload:

{"vrid":{
      "id":<Double_value>,
      "priority":<Double_value>,
      "preemption":<String_value>,
      "sharing":<String_value>,
      "tracking":<String_value>,
      "ownernode":<Double_value>,
      "trackifnumpriority":<Double_value>,
      "preemptiondelaytimer":<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/vrid?action=unset

HTTP Method: POST

Request Headers:

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

Request Payload:

{"vrid":{
      "id":<Double_value>,
      "priority":true,
      "preemption":true,
      "sharing":true,
      "tracking":true,
      "ownernode":true,
      "trackifnumpriority":true,
      "preemptiondelaytimer":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

get (all)

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

Query-parameters:

attrs

http://<netscaler-ip-address>/nitro/v1/config/vrid?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/vrid?filter=property-name1:property-val1,property-name2:property-val2

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

view

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

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

pagination

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

Use this query-parameter to get the vrid 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:

{ "vrid": [ {
      "id":<Double_value>,
      "ifaces":<String_value>,
      "type":<String_value>,
      "priority":<Double_value>,
      "effectivepriority":<Double_value>,
      "preemption":<String_value>,
      "sharing":<String_value>,
      "tracking":<String_value>,
      "flags":<Double_value>,
      "ipaddress":<String_value>,
      "state":<Double_value>,
      "operationalownernode":<Double_value>,
      "ownernode":<Double_value>,
      "trackifnumpriority":<Double_value>,
      "preemptiondelaytimer":<Double_value>
}]}

get

URL: http://<netscaler-ip-address>/nitro/v1/config/vrid/id_value<Double>

Query-parameters:

attrs

http://<netscaler-ip-address>/nitro/v1/config/vrid/id_value<Double>?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/vrid/id_value<Double>?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:

{ "vrid": [ {
      "id":<Double_value>,
      "ifaces":<String_value>,
      "type":<String_value>,
      "priority":<Double_value>,
      "effectivepriority":<Double_value>,
      "preemption":<String_value>,
      "sharing":<String_value>,
      "tracking":<String_value>,
      "flags":<Double_value>,
      "ipaddress":<String_value>,
      "state":<Double_value>,
      "operationalownernode":<Double_value>,
      "ownernode":<Double_value>,
      "trackifnumpriority":<Double_value>,
      "preemptiondelaytimer":<Double_value>
}]}

count

URL: http://<netscaler-ip-address>/nitro/v1/config/vrid?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:

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