Developer Documentation
ADC NITRO APIs
Current Release 13.1 13

cloudtunnelvserver

May 23, 2024
Contributed by: 
C

Configuration for Cloud Tunnel virtual server resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
name Read-write Name for the Cloud Tunnel 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
servicetype Read-write ServiceType of Listener using which traffic will be tunneled through cloud tunnel server.

Possible values = TCP, UDP
listenpolicy Read-write String specifying the listen policy for the Cloud Tunnel virtual server. Can be either a named expression or an expression. The Cloud Tunnel 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
state 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
effectivestate Read-only .

Possible values = UP, DOWN, UNKNOWN, BUSY, OUT OF SERVICE, GOING OUT OF SERVICE, DOWN WHEN GOING OUT OF SERVICE, NS_EMPTY_STR, Unknown, DISABLED
type Read-only The type of virtual server; for example, CONTENT based or ADDRESS based.

Possible values = CONTENT, ADDRESS
ip Read-only The Virtual IP address of the Cloud Tunnel virtual server.
ipv46 Read-only IPv4 or IPv6 address of the Cloud Tunnel virtual server.

Minimum length = 1
ippattern Read-only The IP pattern of the virtual server.
port Read-only Port on which the virtual server listens.

Range 1 - 65535

* in CLI is represented as 65535 in NITRO API
range Read-only .

Default value: 1

Minimum value = 1

Maximum value = 254
cachetype Read-only Virtual server cache type. The options are: TRANSPARENT, REVERSE, and FORWARD.

Possible values = TRANSPARENT, REVERSE, FORWARD
__count Read-only count parameter

Operations

(click to see Properties )

  • ADD
  • DELETE
  • GET (ALL)
  • GET
  • COUNT
  • UPDATE

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/cloudtunnelvserver HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload: 

{"cloudtunnelvserver":{
<b>"name":<String_value>,
</b><b>"servicetype":<String_value>,
</b>"listenpolicy":<String_value>,
"listenpriority":<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 NetScaler-specific errors). The response payload provides details of the error

delete

URL: http:// <netscaler-ip-address> /nitro/v1/config/cloudtunnelvserver/ 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/cloudtunnelvserver HTTP Method: PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload: 

{"cloudtunnelvserver":{
<b>"name":<String_value>,
</b>"listenpolicy":<String_value>,
"listenpriority":<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 NetScaler-specific errors). The response payload provides details of the error

get (all)

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

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

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

Use this query-parameter to get the summary output of cloudtunnelvserver 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/cloudtunnelvserver? pagesize=#no;pageno=#no

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

{ "cloudtunnelvserver": [ {
"name":<String_value>,
"servicetype":<String_value>,
"state":<String_value>,
"effectivestate":<String_value>,
"type":<String_value>,
"ip":<String_value>,
"ipv46":<String_value>,
"ippattern":<String_value>,
"port":<Integer_value>,
"range":<Double_value>,
"cachetype":<String_value>,
"listenpolicy":<String_value>,
"listenpriority":<Double_value>
}]}

<!--NeedCopy-->

get

URL: http:// <netscaler-ip-address> /nitro/v1/config/cloudtunnelvserver/ name_value<String> Query-parameters: attrs http:// <netscaler-ip-address> /nitro/v1/config/cloudtunnelvserver/ 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/cloudtunnelvserver/ name_value<String> ? view=summary

Use this query-parameter to get the summary output of cloudtunnelvserver 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: 

{  "cloudtunnelvserver": [ {
"name":<String_value>,
"servicetype":<String_value>,
"state":<String_value>,
"effectivestate":<String_value>,
"type":<String_value>,
"ip":<String_value>,
"ipv46":<String_value>,
"ippattern":<String_value>,
"port":<Integer_value>,
"range":<Double_value>,
"cachetype":<String_value>,
"listenpolicy":<String_value>,
"listenpriority":<Double_value>
}]}

<!--NeedCopy-->

count

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

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

<!--NeedCopy-->
cloudtunnelvserver
May 23, 2024
Contributed by: 
C
May 23, 2024
Contributed by: 
C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.