-
-
-
-
-
-
-
-
vserver
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
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!
vserver
Configuration for virtual server resource.
Properties
(click to see Operations)
Name | Data Type | Permissions | Description |
---|---|---|---|
name |
|
Read-write | The name of the virtual server to be removed. Minimum length = 1 |
backupvserver |
|
Read-write | The name of the backup virtual server for this virtual server. Minimum length = 1 |
redirecturl |
|
Read-write | The URL where traffic is redirected if the virtual server in the system becomes unavailable. Minimum length = 1 |
cacheable |
|
Read-write | Use this option to specify whether a virtual server (used for load balancing or content switching) routes requests to the cache redirection virtual server before sending it to the configured servers. Possible values = YES, NO |
clttimeout |
|
Read-write | The timeout value in seconds for idle client connection. Minimum value = 0 Maximum value = 31536000 |
somethod |
|
Read-write | The spillover factor. The system will use this value to determine if it should send traffic to the backupvserver when the main virtual server reaches the spillover threshold. Possible values = CONNECTION, DYNAMICCONNECTION, BANDWIDTH, HEALTH, NONE |
sopersistence |
|
Read-write | The state of the spillover persistence. Default value: DISABLED Possible values = ENABLED, DISABLED |
sopersistencetimeout |
|
Read-write | The spillover persistence entry timeout. Default value: 2 Minimum value = 2 Maximum value = 1440 |
sothreshold |
|
Read-write | The spillver threshold value. Minimum value = 1 Maximum value = 4294967294 |
pushvserver |
|
Read-write | The lb vserver of type PUSH/SSL_PUSH to which server pushes the updates received on the client facing non-push lb vserver. Minimum length = 1 |
Operations
(click to see Properties)
DELETE | UPDATE | ENABLE | DISABLE |
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>.
delete
URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/vserver/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 Citrix ADC specific errors). The response payload provides details of the error
update
URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/vserver
HTTP Method:PUT
Request Headers:
Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json
Request Payload:
{"vserver":{
<b>"name":<String_value>,
</b>"backupvserver":<String_value>,
"redirecturl":<String_value>,
"cacheable":<String_value>,
"clttimeout":<Double_value>,
"somethod":<String_value>,
"sopersistence":<String_value>,
"sopersistencetimeout":<Double_value>,
"sothreshold":<Double_value>,
"pushvserver":<String_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
enable
URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/vserver?action=enable
HTTP Method:POST
Request Headers:
Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json
Request Payload:
{"vserver":{
<b>"name":<String_value>
</b>}}
<!--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
disable
URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/vserver?action=disable
HTTP Method:POST
Request Headers:
Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json
Request Payload:
{"vserver":{
<b>"name":<String_value>
</b>}}
<!--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
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.