-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
vrid6
-
-
-
-
-
-
-
-
-
-
-
This content has been machine translated dynamically.
Dieser Inhalt ist eine maschinelle Übersetzung, die dynamisch erstellt wurde. (Haftungsausschluss)
Cet article a été traduit automatiquement de manière dynamique. (Clause de non responsabilité)
Este artículo lo ha traducido una máquina de forma dinámica. (Aviso legal)
此内容已经过机器动态翻译。 放弃
このコンテンツは動的に機械翻訳されています。免責事項
이 콘텐츠는 동적으로 기계 번역되었습니다. 책임 부인
Este texto foi traduzido automaticamente. (Aviso legal)
Questo contenuto è stato tradotto dinamicamente con traduzione automatica.(Esclusione di responsabilità))
This article has been machine translated.
Dieser Artikel wurde maschinell übersetzt. (Haftungsausschluss)
Ce article a été traduit automatiquement. (Clause de non responsabilité)
Este artículo ha sido traducido automáticamente. (Aviso legal)
この記事は機械翻訳されています.免責事項
이 기사는 기계 번역되었습니다.책임 부인
Este artigo foi traduzido automaticamente.(Aviso legal)
这篇文章已经过机器翻译.放弃
Questo articolo è stato tradotto automaticamente.(Esclusione di responsabilità))
Translation failed!
vrid6
Configuration for Virtual Router ID for IPv6 resource.
Properties
(click to see Operations)
Name | Data Type | Permissions | Description |
---|---|---|---|
id |
|
Read-write | Integer value that uniquely identifies a VMAC6 address. Minimum value = 1 Maximum value = 255 |
priority |
|
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 |
|
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 |
|
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 |
|
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 |
preemptiondelaytimer |
|
Read-write | Preemption delay time in seconds, in an active-active configuration. 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 |
trackifnumpriority |
|
Read-write | Priority by which the Effective priority will be reduced if any of the tracked interfaces goes down in an active-active configuration. Default value: 0 Minimum value = 1 Maximum value = 255 |
ownernode |
|
Read-write | In a cluster setup, assign a cluster node as the owner of this VMAC address for IP based VRRP configuration. If no owner is configured, ow ner node is displayed as ALL and one node is dynamically elected as the owner. Minimum value = 0 Maximum value = 31 |
all |
|
Read-write | Remove all configured VMAC6 addresses from the Citrix ADC. |
ifaces |
|
Read-only | Interfaces bound to this VRID. |
ifnum |
|
Read-only | Interfaces to bind to the VMAC6, specified in (slot/port) notation (for example, 1/2).Use spaces to separate multiple entries. |
type |
|
Read-only | Type (static or dynamic) of this VRID. Possible values = STATIC, DYNAMIC |
state |
|
Read-only | State of this VRID. |
flags |
|
Read-only | Flags. |
ipaddress |
|
Read-only | The IP address bound to the VRID6. |
effectivepriority |
|
Read-only | The effective priority of this VRID. |
operationalownernode |
|
Read-only | Run time owner node of the vrid. Minimum value = 0 Maximum value = 31 |
__count |
|
Read-only | count parameter |
Operations
(click to see Properties)
ADD | DELETE | UPDATE | UNSET | 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 Citrix ADC appliance, the URL is as follows:
http://<Citrix-ADC-IP-address(NSIP)>/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 Citrix ADC 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 redand placeholder content is marked in <green>.
add
URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/vrid6
HTTP Method:POST
Request Headers:
Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json
Request Payload:
{"vrid6":{
<b>"id":<Double_value>,
</b>"priority":<Double_value>,
"preemption":<String_value>,
"sharing":<String_value>,
"tracking":<String_value>,
"preemptiondelaytimer":<Double_value>,
"trackifnumpriority":<Double_value>,
"ownernode":<Double_value>
}}
<!--NeedCopy-->
Response:
HTTP Status Code on Success: 201 Created HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for Citrix ADC specific errors). The response payload provides details of the error
delete
URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/vrid6/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 Citrix ADC specific errors). The response payload provides details of the error
update
URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/vrid6
HTTP Method:PUT
Request Headers:
Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json
Request Payload:
{"vrid6":{
<b>"id":<Double_value>,
</b>"priority":<Double_value>,
"preemption":<String_value>,
"sharing":<String_value>,
"tracking":<String_value>,
"preemptiondelaytimer":<Double_value>,
"trackifnumpriority":<Double_value>,
"ownernode":<Double_value>
}}
<!--NeedCopy-->
Response:
HTTP Status Code on Success: 200 OK HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for Citrix ADC specific errors). The response payload provides details of the error
unset
URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/vrid6?action=unset
HTTP Method:POST
Request Headers:
Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json
Request Payload:
{"vrid6":{
<b>"id":<Double_value>,
</b>"priority":true,
"preemption":true,
"sharing":true,
"tracking":true,
"preemptiondelaytimer":true,
"trackifnumpriority":true,
"ownernode":true
}}
<!--NeedCopy-->
Response:
HTTP Status Code on Success: 200 OK HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for Citrix ADC specific errors). The response payload provides details of the error
get (all)
URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/vrid6
Query-parameters:
attrs
http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/vrid6?attrs=property-name1,property-name2
Use this query parameter to specify the resource details that you want to retrieve.
filter
http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/vrid6?filter=property-name1:property-val1,property-name2:property-val2
Use this query-parameter to get the filtered set of vrid6 resources configured on Citrix ADC. Filtering can be done on any of the properties of the resource.
view
http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/vrid6?view=summary
Note:By default, the retrieved results are displayed in detail view (?view=detail).
pagination
http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/vrid6?pagesize=#no;pageno=#no
Use this query-parameter to get the vrid6 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 Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:
Content-Type:application/json
Response Payload:
{ "vrid6": [ {
"id":<Double_value>,
"ifaces":<String_value>,
"ifnum":<String_value>,
"type":<String_value>,
"priority":<Double_value>,
"state":<Double_value>,
"flags":<Double_value>,
"ipaddress":<String_value>,
"preemption":<String_value>,
"sharing":<String_value>,
"preemptiondelaytimer":<Double_value>,
"trackifnumpriority":<Double_value>,
"effectivepriority":<Double_value>,
"tracking":<String_value>,
"operationalownernode":<Double_value>,
"ownernode":<Double_value>
}]}
<!--NeedCopy-->
get
URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/vrid6/id_value<Double>
Query-parameters:
attrs
http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/vrid6/id_value<Double>?attrs=property-name1,property-name2
Use this query parameter to specify the resource details that you want to retrieve.
view
http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/vrid6/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 Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:
Content-Type:application/json
Response Payload:
{ "vrid6": [ {
"id":<Double_value>,
"ifaces":<String_value>,
"ifnum":<String_value>,
"type":<String_value>,
"priority":<Double_value>,
"state":<Double_value>,
"flags":<Double_value>,
"ipaddress":<String_value>,
"preemption":<String_value>,
"sharing":<String_value>,
"preemptiondelaytimer":<Double_value>,
"trackifnumpriority":<Double_value>,
"effectivepriority":<Double_value>,
"tracking":<String_value>,
"operationalownernode":<Double_value>,
"ownernode":<Double_value>
}]}
<!--NeedCopy-->
count
URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/vrid6?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 Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:
Content-Type:application/json
Response Payload:
{ "vrid6": [ { "__count": "#no"} ] }
<!--NeedCopy-->
Share
Share
In this article
This Preview product documentation is Citrix Confidential.
You agree to hold this documentation confidential pursuant to the terms of your Citrix Beta/Tech Preview Agreement.
The development, release and timing of any features or functionality described in the Preview documentation remains at our sole discretion and are subject to change without notice or consultation.
The documentation is for informational purposes only and is not a commitment, promise or legal obligation to deliver any material, code or functionality and should not be relied upon in making Citrix product purchase decisions.
If you do not agree, select I DO NOT AGREE to exit.