-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
videooptimizationdetectionpolicylabel_videooptimizationdetectionpolicy_binding
-
videooptimizationdetectionpolicy_videooptimizationglobaldetection_binding
-
videooptimizationglobaldetection_videooptimizationdetectionpolicy_binding
-
videooptimizationglobalpacing_videooptimizationpacingpolicy_binding
-
videooptimizationpacingpolicylabel_videooptimizationpacingpolicy_binding
-
videooptimizationpacingpolicy_videooptimizationglobalpacing_binding
-
-
vpnvserver
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!
vpnvserver
Configuration for VPN virtual server resource.
Properties
(click to see Operations )
| Name | Data Type | Permissions | Description |
|---|---|---|---|
| name |
|
Read-write | Name for the Citrix Gateway virtual server. 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. Can be changed after the virtual server is created. The following requirement applies only to the Citrix ADC CLI If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, “my server” or ‘my server’). Minimum length = 1 |
| servicetype |
|
Read-write | Protocol used by the Citrix Gateway virtual server.
Default value: SSL Possible values = SSL, DTLS |
| ipv46 |
|
Read-write | IPv4 or IPv6 address of the Citrix Gateway virtual server. Usually a public IP address. User devices send connection requests to this IP address.
Minimum length = 1 |
| range |
|
Read-write | Range of Citrix Gateway virtual server IP addresses. The consecutively numbered range of IP addresses begins with the address specified by the IP Address parameter.
In the configuration utility, select Network VServer to enter a range. Default value: 1 Minimum value = 1 |
| port |
|
Read-write | TCP port on which the virtual server listens.
Range 1 - 65535 * in CLI is represented as 65535 in NITRO API |
| ipset |
|
Read-write | The list of IPv4/IPv6 addresses bound to ipset would form a part of listening service on the current vpn vserver.
Minimum length = 1 |
| state |
|
Read-write | State of the virtual server. If the virtual server is disabled, requests are not processed.
Default value: ENABLED Possible values = ENABLED, DISABLED |
| authentication |
|
Read-write | Require authentication for users connecting to Citrix Gateway.
Default value: ON Possible values = ON, OFF |
| doublehop |
|
Read-write | Use the Citrix Gateway appliance in a double-hop configuration. A double-hop deployment provides an extra layer of security for the internal network by using three firewalls to divide the DMZ into two stages. Such a deployment can have one appliance in the DMZ and one appliance in the secure network.
Default value: DISABLED Possible values = ENABLED, DISABLED |
| maxaaausers |
|
Read-write | Maximum number of concurrent user sessions allowed on this virtual server. The actual number of users allowed to log on to this virtual server depends on the total number of user licenses. |
| icaonly |
|
Read-write |
|
| icaproxysessionmigration |
|
Read-write | This option determines if an existing ICA Proxy session is transferred when the user logs on from another device.
Default value: OFF Possible values = ON, OFF |
| dtls |
|
Read-write | This option starts/stops the turn service on the vserver.
Default value: ON Possible values = ON, OFF |
| loginonce |
|
Read-write | This option enables/disables seamless SSO for this Vserver.
Default value: OFF Possible values = ON, OFF |
| advancedepa |
|
Read-write | This option tells whether advanced EPA is enabled on this virtual server.
Default value: OFF Possible values = ON, OFF |
| devicecert |
|
Read-write | Indicates whether device certificate check as a part of EPA is on or off.
Default value: OFF Possible values = ON, OFF |
| certkeynames |
|
Read-write | Name of the certificate key that was bound to the corresponding SSL virtual server as the Certificate Authority for the device certificate.
Minimum length = 1 Maximum length = 127 |
| downstateflush |
|
Read-write | Close existing connections when the virtual server is marked DOWN, which means the server might have timed out. Disconnecting existing connections frees resources and in certain cases speeds recovery of overloaded load balancing setups. Enable this setting on servers in which the connections can safely be closed when they are marked DOWN. Do not enable DOWN state flush on servers that must complete their transactions.
Default value: ENABLED Possible values = ENABLED, DISABLED |
| listenpolicy |
|
Read-write | String specifying the listen policy for the Citrix Gateway virtual server. Can be either a named expression or an expression. The Citrix Gateway virtual server processes only the traffic for which the expression evaluates to true.
Default value: “none” |
| listenpriority |
|
Read-write | Integer specifying the priority of the listen policy. A higher number specifies a lower priority. If a request matches the listen policies of more than one virtual server, the virtual server whose listen policy has the highest priority (the lowest priority number) accepts the request.
Default value: 101 Minimum value = 0 Maximum value = 100 |
| tcpprofilename |
|
Read-write | Name of the TCP profile to assign to this virtual server.
Minimum length = 1 Maximum length = 127 |
| httpprofilename |
|
Read-write | Name of the HTTP profile to assign to this virtual server.
Default value: “nshttp_default_strict_validation” Minimum length = 1 Maximum length = 127 |
| comment |
|
Read-write | Any comments associated with the virtual server. |
| appflowlog |
|
Read-write | Log AppFlow records that contain standard NetFlow or IPFIX information, such as time stamps for the beginning and end of a flow, packet count, and byte count. Also log records that contain application-level information, such as HTTP web addresses, HTTP request methods and response status codes, server response time, and latency.
Default value: ENABLED Possible values = ENABLED, DISABLED |
| icmpvsrresponse |
|
Read-write | Criterion for responding to PING requests sent to this virtual server. If this parameter is set to ACTIVE, respond only if the virtual server is available. With the PASSIVE setting, respond even if the virtual server is not available.
Default value: PASSIVE Possible values = PASSIVE, ACTIVE |
| rhistate |
|
Read-write | A host route is injected according to the setting on the virtual servers.
* If set to PASSIVE on all the virtual servers that share the IP address, the appliance always injects the hostroute. * If set to ACTIVE on all the virtual servers that share the IP address, the appliance injects even if one virtual server is UP. * If set to ACTIVE on some virtual servers and PASSIVE on the others, the appliance injects even if one virtual server set to ACTIVE is UP. Default value: PASSIVE Possible values = PASSIVE, ACTIVE |
| netprofile |
|
Read-write | The name of the network profile.
Minimum length = 1 Maximum length = 127 |
| cginfrahomepageredirect |
|
Read-write | When client requests ShareFile resources and Citrix Gateway detects that the user is unauthenticated or the user session has expired, disabling this option takes the user to the originally requested ShareFile resource after authentication (instead of taking the user to the default VPN home page).
Default value: ENABLED Possible values = ENABLED, DISABLED |
| maxloginattempts |
|
Read-write | Maximum number of logon attempts.
Minimum value = 1 Maximum value = 255 |
| failedlogintimeout |
|
Read-write | Number of minutes an account will be locked if user exceeds maximum permissible attempts.
Minimum value = 1 |
| l2conn |
|
Read-write | Use Layer 2 parameters (channel number, MAC address, and VLAN ID) in addition to the 4-tuple ( Possible values = ON, OFF |
| deploymenttype |
|
Read-write | .
Default value: 5 Possible values = NONE, ICA_WEBINTERFACE, ICA_STOREFRONT, MOBILITY, WIONNS |
| rdpserverprofilename |
|
Read-write | Name of the RDP server profile associated with the vserver.
Minimum length = 1 Maximum length = 31 |
| windowsepapluginupgrade |
|
Read-write | Option to set plugin upgrade behaviour for Win.
Possible values = Always, Essential, Never |
| linuxepapluginupgrade |
|
Read-write | Option to set plugin upgrade behaviour for Linux.
Possible values = Always, Essential, Never |
| macepapluginupgrade |
|
Read-write | Option to set plugin upgrade behaviour for Mac.
Possible values = Always, Essential, Never |
| logoutonsmartcardremoval |
|
Read-write | Option to VPN plugin behavior when smartcard or its reader is removed.
Default value: OFF Possible values = ON, OFF |
| userdomains |
|
Read-write | List of user domains specified as comma seperated value. |
| authnprofile |
|
Read-write | Authentication Profile entity on virtual server. This entity can be used to offload authentication to AAA vserver for multi-factor(nFactor) authentication. |
| vserverfqdn |
|
Read-write | Fully qualified domain name for a VPN virtual server. This is used during StoreFront configuration generation. |
| pcoipvserverprofilename |
|
Read-write | Name of the PCoIP vserver profile associated with the vserver.
Minimum length = 1 Maximum length = 31 |
| samesite |
|
Read-write | SameSite attribute value for Cookies generated in VPN context. This attribute value will be appended only for the cookies which are specified in the builtin patset ns_cookies_samesite.
Possible values = None, LAX, STRICT |
| newname |
|
Read-write | New name for the Citrix Gateway virtual server. 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. The following requirement applies only to the Citrix ADC CLI If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, “my server” or ‘my server’). Minimum length = 1 |
| ip |
|
Read-only | The Virtual IP address of the VPN virtual server. |
| value |
|
Read-only | Indicates whether or not the certificate is bound or if SSL offload is disabled.
Possible values = Certkey not bound, SSL feature disabled |
| type |
|
Read-only | The type of virtual server; for example, CONTENT based or ADDRESS based.
Possible values = CONTENT, ADDRESS |
| curstate |
|
Read-only | The current state of the virtual server, as UP, DOWN, BUSY, and so on.
Possible values = UP, DOWN, UNKNOWN, BUSY, OUT OF SERVICE, GOING OUT OF SERVICE, DOWN WHEN GOING OUT OF SERVICE, NS_EMPTY_STR, Unknown, DISABLED |
| status |
|
Read-only | Whether or not this virtual server responds to ARPs and whether or not round-robin selection is temporarily in effect. |
| cachetype |
|
Read-only | Virtual server cache type. The options are: TRANSPARENT, REVERSE, and FORWARD.
Possible values = TRANSPARENT, REVERSE, FORWARD |
| redirect |
|
Read-only | The cache redirect policy.
The valid redirect policies are
l. CACHE - Directs all requests to the cache.
|
| precedence |
|
Read-only | This argument is used only when configuring content switching on the specified virtual server. This is applicable only
if both the URL and RULE-based policies have been configured on the same virtual server.
It specifies the type of policy (URL or RULE) that takes precedence on the content switching virtual server. The default setting is RULE.
l URL - In this case, the incoming request is matched against the URL-based policies before the rule-based policies.
l RULE - In this case, the incoming request is matched against the rule-based policies before the URL-based policies.
For all URL-based policies, the precedence hierarchy is
|
| redirecturl |
|
Read-only | The URL where traffic is redirected if the virtual server in system becomes unavailable. WARNING! Make sure that the domain you specify in the URL does not match the domain specified in the -d domainName argument of the ###add cs policy### command. If the same domain is specified in both arguments, the request will be continuously redirected to the same unavailable virtual server in the system. If so, the user may not get the requested content. |
| curaaausers |
|
Read-only | The number of current users logged on to this virtual server. |
| curtotalusers |
|
Read-only | The total number of current users connected through this virtual server. |
| domain |
|
Read-only | The domain name of the server for which a service needs to be added. If the IP address has been specified, the domain name does not need to be specified. |
| rule |
|
Read-only | The name of the rule, or expression, if any, that policy for the VPN server is to use. Rules are combinations of expressions. Expressions are simple conditions, such as a test for equality, applied to operands, such as a URL string or an IP address. Expression syntax is described in the Installation and Configuration Guide. The default rule is true.
Minimum length = 1 |
| servicename |
|
Read-only | The name of the service, if any, to which the virtual server policy is bound. |
| weight |
|
Read-only | Weight for this service, if any. This weight is used when the system performs load balancing, giving greater priority to a specific service. It is useful when the services bound to a virtual server are of different capacity. |
| cachevserver |
|
Read-only | The name of the default target cache virtual server, if any, to which requests are redirected. |
| backupvserver |
|
Read-only | The name of the backup VPN virtual server for this VPN virtual server. |
| clttimeout |
|
Read-only | The idle time, if any, in seconds after which the client connection is terminated. |
| somethod |
|
Read-only | VPN client applications are allocated from a block of intranet IP addresses.
That block may be exhausted after a certain number of connections. This switch specifies the method used to determine whether or not a new connection will spill over, or exhaust, the allocated block of intranet IP addresses for that application. Possible values are CONNECTION or DYNAMICCONNECTION. CONNECTION means that a static integer value is the hard limit for the spillover threshold. The spillover threshold is described below. DYNAMICCONNECTION means that the spillover threshold is set according to the maximum number of connections defined for the VPN virtual server. Possible values = CONNECTION, DYNAMICCONNECTION, BANDWIDTH, HEALTH, NONE |
| sothreshold |
|
Read-only | VPN client applications are allocated from a block of intranet IP addresses.
That block may be exhausted after a certain number of connections. The value of this option is the number of client connections after which the mapped IP address is used as the client source IP address instead of an address from the allocated block of intranet IP addresses. |
| sopersistence |
|
Read-only | Whether or not cookie-based site persistance is enabled for this VPN vserver. Possible values are ‘ConnectionProxy’, HTTPRedirect, or NONE.
Possible values = ENABLED, DISABLED |
| sopersistencetimeout |
|
Read-only | The timeout, if any, for cookie-based site persistance of this VPN vserver. |
| usemip |
|
Read-only | Deprecated. See ‘map’ below.
Possible values = ENABLED, DISABLED |
| map |
|
Read-only | Whether or not mapped IP addresses are ON or OFF. Mapped IP addresses are source IP addresses
for the virtual servers running on the Citrix ADC. Mapped IP addresses are used by the system to connect to the backend servers. Possible values = ON, OFF |
| bindpoint |
|
Read-only | Bindpoint to which the policy is bound.
Possible values = REQUEST, RESPONSE, ICA_REQUEST, OTHERTCP_REQUEST, AAA_REQUEST |
| disableprimaryondown |
|
Read-only | Tells whether traffic will continue reaching backup virtual servers even after the primary virtual server comes UP from DOWN state.
Possible values = ENABLED, DISABLED |
| secondary |
|
Read-only | Binds the authentication policy as the secondary policy to use in a two-factor configuration. A user must then authenticate not only via a primary authentication method but also via a secondary authentication method. User groups are aggregated across both. The user name must be exactly the same for both authentication methods, but they can require different passwords. |
| groupextraction |
|
Read-only | Binds the authentication policy to a tertiary chain which will be used only for group extraction. The user will not authenticate against this server, and this will only be called if primary and/or secondary authentication has succeeded. |
| epaprofileoptional |
|
Read-only | Mark the EPA profile optional for preauthentication EPA profile. User would be shown a logon page even if the EPA profile fails to evaluate. |
| ngname |
|
Read-only | Node group devno to which this authentication virtual sever belongs. |
| csvserver |
|
Read-only | Name of the CS vserver to which the VPN vserver is bound. |
| nodefaultbindings |
|
Read-only | to determine if the configuration will have default ssl CIPHER and ECC curve bindings.
Default value: NO Possible values = YES, NO |
| response |
|
Read-only | . |
| __count |
|
Read-only | count parameter |
Operations
(click to see Properties )
- ADD
- DELETE
- UPDATE
- UNSET
- ENABLE
- DISABLE
- GET (ALL)
- GET
- COUNT
- RENAME
- CHECK
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:// <netscaler-ip-address> /nitro/v1/config/vpnvserver
HTTP Method: POST
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Content-Type:application/json
Request Payload:
{"vpnvserver":{
<b> "name":<String_value>,
</b><b> "servicetype":<String_value>,
</b> "ipv46":<String_value>,
"range":<Double_value>,
"port":<Integer_value>,
"ipset":<String_value>,
"state":<String_value>,
"authentication":<String_value>,
"doublehop":<String_value>,
"maxaaausers":<Double_value>,
"icaonly":<String_value>,
"icaproxysessionmigration":<String_value>,
"dtls":<String_value>,
"loginonce":<String_value>,
"advancedepa":<String_value>,
"devicecert":<String_value>,
"certkeynames":<String_value>,
"downstateflush":<String_value>,
"listenpolicy":<String_value>,
"listenpriority":<Double_value>,
"tcpprofilename":<String_value>,
"httpprofilename":<String_value>,
"comment":<String_value>,
"appflowlog":<String_value>,
"icmpvsrresponse":<String_value>,
"rhistate":<String_value>,
"netprofile":<String_value>,
"cginfrahomepageredirect":<String_value>,
"maxloginattempts":<Double_value>,
"failedlogintimeout":<Double_value>,
"l2conn":<String_value>,
"deploymenttype":<String_value>,
"rdpserverprofilename":<String_value>,
"windowsepapluginupgrade":<String_value>,
"linuxepapluginupgrade":<String_value>,
"macepapluginupgrade":<String_value>,
"logoutonsmartcardremoval":<String_value>,
"userdomains":<String_value>,
"authnprofile":<String_value>,
"vserverfqdn":<String_value>,
"pcoipvserverprofilename":<String_value>,
"samesite":<String_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 NetScaler-specific errors). The response payload provides details of the error
delete
URL: http:// <netscaler-ip-address> /nitro/v1/config/vpnvserver/ 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/vpnvserver
HTTP Method: PUT
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Content-Type:application/json
Request Payload:
{"vpnvserver":{
<b> "name":<String_value>,
</b> "ipv46":<String_value>,
"ipset":<String_value>,
"authentication":<String_value>,
"doublehop":<String_value>,
"icaonly":<String_value>,
"icaproxysessionmigration":<String_value>,
"dtls":<String_value>,
"loginonce":<String_value>,
"advancedepa":<String_value>,
"devicecert":<String_value>,
"certkeynames":<String_value>,
"maxaaausers":<Double_value>,
"downstateflush":<String_value>,
"listenpolicy":<String_value>,
"listenpriority":<Double_value>,
"tcpprofilename":<String_value>,
"httpprofilename":<String_value>,
"comment":<String_value>,
"appflowlog":<String_value>,
"icmpvsrresponse":<String_value>,
"rhistate":<String_value>,
"netprofile":<String_value>,
"cginfrahomepageredirect":<String_value>,
"maxloginattempts":<Double_value>,
"rdpserverprofilename":<String_value>,
"failedlogintimeout":<Double_value>,
"l2conn":<String_value>,
"windowsepapluginupgrade":<String_value>,
"macepapluginupgrade":<String_value>,
"linuxepapluginupgrade":<String_value>,
"logoutonsmartcardremoval":<String_value>,
"userdomains":<String_value>,
"authnprofile":<String_value>,
"vserverfqdn":<String_value>,
"pcoipvserverprofilename":<String_value>,
"samesite":<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 NetScaler-specific errors). The response payload provides details of the error
unset
URL: http:// <netscaler-ip-address> /nitro/v1/config/vpnvserver? action=unset
HTTP Method: POST
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Content-Type:application/json
Request Payload:
{"vpnvserver":{
<b> "name":<String_value>,
</b> "ipset":true,
"authentication":true,
"doublehop":true,
"icaonly":true,
"icaproxysessionmigration":true,
"dtls":true,
"loginonce":true,
"advancedepa":true,
"devicecert":true,
"certkeynames":true,
"maxaaausers":true,
"downstateflush":true,
"listenpolicy":true,
"listenpriority":true,
"tcpprofilename":true,
"httpprofilename":true,
"comment":true,
"appflowlog":true,
"icmpvsrresponse":true,
"rhistate":true,
"netprofile":true,
"cginfrahomepageredirect":true,
"maxloginattempts":true,
"rdpserverprofilename":true,
"l2conn":true,
"windowsepapluginupgrade":true,
"macepapluginupgrade":true,
"linuxepapluginupgrade":true,
"logoutonsmartcardremoval":true,
"userdomains":true,
"authnprofile":true,
"vserverfqdn":true,
"pcoipvserverprofilename":true,
"samesite":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 NetScaler-specific errors). The response payload provides details of the error
enable
URL: http:// <netscaler-ip-address> /nitro/v1/config/vpnvserver? action=enable
HTTP Method: POST
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Content-Type:application/json
Request Payload:
{"vpnvserver":{
<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 NetScaler-specific errors). The response payload provides details of the error
disable
URL: http:// <netscaler-ip-address> /nitro/v1/config/vpnvserver? action=disable
HTTP Method: POST
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Content-Type:application/json
Request Payload:
{"vpnvserver":{
<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 NetScaler-specific errors). The response payload provides details of the error
rename
URL: http:// <netscaler-ip-address> /nitro/v1/config/vpnvserver? action=rename
HTTP Method: POST
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Content-Type:application/json
Request Payload:
{"vpnvserver":{
<b> "name":<String_value>,
</b><b> "newname":<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 NetScaler-specific errors). The response payload provides details of the error
check
URL: http:// <netscaler-ip-address> /nitro/v1/config/vpnvserver? action=check
HTTP Method: POST
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Content-Type:application/json
Request Payload:
{"vpnvserver":{
<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 NetScaler-specific errors). The response payload provides details of the error
Response Payload:
{ "vpnvserver": [ {
<b> "name":<String_value>,
</b> "response":<String_value>
}]}
<!--NeedCopy-->
get (all)
URL: http:// <netscaler-ip-address> /nitro/v1/config/vpnvserver
Query-parameters:
attrs
http:// <netscaler-ip-address> /nitro/v1/config/vpnvserver? 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/vpnvserver? filter=property-name1:property-val1,property-name2:property-val2
Use this query-parameter to get the filtered set of vpnvserver resources configured on NetScaler.Filtering can be done on any of the properties of the resource.
view
http:// <netscaler-ip-address> /nitro/v1/config/vpnvserver? view=summary
Use this query-parameter to get the summary output of vpnvserver resources configured on NetScaler.
Note: By default, the retrieved results are displayed in detail view (?view=detail).
pagination
http:// <netscaler-ip-address> /nitro/v1/config/vpnvserver? pagesize=#no;pageno=#no
Use this query-parameter to get the vpnvserver 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 Header:
Content-Type:application/json
Response Payload:
{ "vpnvserver": [ {
"name":<String_value>,
"ip":<String_value>,
"ipv46":<String_value>,
"value":<String_value>,
"port":<Integer_value>,
"range":<Double_value>,
"ipset":<String_value>,
"servicetype":<String_value>,
"type":<String_value>,
"curstate":<String_value>,
"status":<Integer_value>,
"cachetype":<String_value>,
"redirect":<String_value>,
"precedence":<String_value>,
"redirecturl":<String_value>,
"authentication":<String_value>,
"doublehop":<String_value>,
"icaonly":<String_value>,
"icaproxysessionmigration":<String_value>,
"dtls":<String_value>,
"loginonce":<String_value>,
"advancedepa":<String_value>,
"devicecert":<String_value>,
"certkeynames":<String_value>,
"maxaaausers":<Double_value>,
"curaaausers":<Double_value>,
"curtotalusers":<Double_value>,
"domain":<String_value>,
"rule":<String_value>,
"policyname":<String_value>,
"servicename":<String_value>,
"weight":<Double_value>,
"cachevserver":<String_value>,
"backupvserver":<String_value>,
"clttimeout":<Double_value>,
"somethod":<String_value>,
"sothreshold":<Double_value>,
"sopersistence":<String_value>,
"sopersistencetimeout":<Double_value>,
"usemip":<String_value>,
"map":<String_value>,
"downstateflush":<String_value>,
"bindpoint":<String_value>,
"disableprimaryondown":<String_value>,
"listenpolicy":<String_value>,
"listenpriority":<Double_value>,
"tcpprofilename":<String_value>,
"httpprofilename":<String_value>,
"comment":<String_value>,
"appflowlog":<String_value>,
"icmpvsrresponse":<String_value>,
"rhistate":<String_value>,
"netprofile":<String_value>,
"cginfrahomepageredirect":<String_value>,
"maxloginattempts":<Double_value>,
"failedlogintimeout":<Double_value>,
"secondary":<Boolean_value>,
"groupextraction":<Boolean_value>,
"deploymenttype":<String_value>,
"windowsepapluginupgrade":<String_value>,
"linuxepapluginupgrade":<String_value>,
"macepapluginupgrade":<String_value>,
"logoutonsmartcardremoval":<String_value>,
"epaprofileoptional":<Boolean_value>,
"rdpserverprofilename":<String_value>,
"ngname":<String_value>,
"state":<String_value>,
"l2conn":<String_value>,
"userdomains":<String_value>,
"csvserver":<String_value>,
"authnprofile":<String_value>,
"vserverfqdn":<String_value>,
"pcoipvserverprofilename":<String_value>,
"nodefaultbindings":<String_value>,
"samesite":<String_value>
}]}
<!--NeedCopy-->
get
URL: http:// <netscaler-ip-address> /nitro/v1/config/vpnvserver/ name_value<String>
Query-parameters:
attrs
http:// <netscaler-ip-address> /nitro/v1/config/vpnvserver/ 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/vpnvserver/ name_value<String> ? view=summary
Use this query-parameter to get the summary output of vpnvserver resources configured on NetScaler.
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 Header:
Content-Type:application/json
Response Payload:
{ "vpnvserver": [ {
"name":<String_value>,
"ip":<String_value>,
"ipv46":<String_value>,
"value":<String_value>,
"port":<Integer_value>,
"range":<Double_value>,
"ipset":<String_value>,
"servicetype":<String_value>,
"type":<String_value>,
"curstate":<String_value>,
"status":<Integer_value>,
"cachetype":<String_value>,
"redirect":<String_value>,
"precedence":<String_value>,
"redirecturl":<String_value>,
"authentication":<String_value>,
"doublehop":<String_value>,
"icaonly":<String_value>,
"icaproxysessionmigration":<String_value>,
"dtls":<String_value>,
"loginonce":<String_value>,
"advancedepa":<String_value>,
"devicecert":<String_value>,
"certkeynames":<String_value>,
"maxaaausers":<Double_value>,
"curaaausers":<Double_value>,
"curtotalusers":<Double_value>,
"domain":<String_value>,
"rule":<String_value>,
"policyname":<String_value>,
"servicename":<String_value>,
"weight":<Double_value>,
"cachevserver":<String_value>,
"backupvserver":<String_value>,
"clttimeout":<Double_value>,
"somethod":<String_value>,
"sothreshold":<Double_value>,
"sopersistence":<String_value>,
"sopersistencetimeout":<Double_value>,
"usemip":<String_value>,
"map":<String_value>,
"downstateflush":<String_value>,
"bindpoint":<String_value>,
"disableprimaryondown":<String_value>,
"listenpolicy":<String_value>,
"listenpriority":<Double_value>,
"tcpprofilename":<String_value>,
"httpprofilename":<String_value>,
"comment":<String_value>,
"appflowlog":<String_value>,
"icmpvsrresponse":<String_value>,
"rhistate":<String_value>,
"netprofile":<String_value>,
"cginfrahomepageredirect":<String_value>,
"maxloginattempts":<Double_value>,
"failedlogintimeout":<Double_value>,
"secondary":<Boolean_value>,
"groupextraction":<Boolean_value>,
"deploymenttype":<String_value>,
"windowsepapluginupgrade":<String_value>,
"linuxepapluginupgrade":<String_value>,
"macepapluginupgrade":<String_value>,
"logoutonsmartcardremoval":<String_value>,
"epaprofileoptional":<Boolean_value>,
"rdpserverprofilename":<String_value>,
"ngname":<String_value>,
"state":<String_value>,
"l2conn":<String_value>,
"userdomains":<String_value>,
"csvserver":<String_value>,
"authnprofile":<String_value>,
"vserverfqdn":<String_value>,
"pcoipvserverprofilename":<String_value>,
"nodefaultbindings":<String_value>,
"samesite":<String_value>
}]}
<!--NeedCopy-->
count
URL: http:// <netscaler-ip-address> /nitro/v1/config/vpnvserver? 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 Header:
Content-Type:application/json
Response Payload:
{ "vpnvserver": [ { "__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.