ADC NITRO APIs

vpnpcoipconnection

Configuration for PCoIP connection resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
username <String> Read-write User name for the PCOIP connections.

Minimum length = 1
nodeid <Double> Read-write Unique number that identifies the cluster node.

Minimum value = 0

Maximum value = 31
all <Boolean> Read-write All active pcoip connections.
srcip <String> Read-only The client IP address.
srcport <Integer> Read-only The client port.

Range 1 - 65535

* in CLI is represented as 65535 in NITRO API
destip <String> Read-only The VDA IP address.
destport <Integer> Read-only The VDA server port.

Range 1 - 65535

* in CLI is represented as 65535 in NITRO API
peid <Double> Read-only Core id of the session owner.
__count <Double> Read-only count parameter

Operations

(click to see Properties )

  • GET (ALL)
  • COUNT
  • KILL

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

kill

URL: http:// <netscaler-ip-address> /nitro/v1/config/vpnpcoipconnection? action=kill HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"vpnpcoipconnection":{
"username":<String_value>,
"all":<Boolean_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/vpnpcoipconnection Query-parameters: args http:// <netscaler-ip-address> /nitro/v1/config/vpnpcoipconnection? args=username: <String_value> ,nodeid: <Double_value>

Use this query-parameter to get vpnpcoipconnection resources based on additional properties.

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

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

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

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

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

{ "vpnpcoipconnection": [ {
username:<String_value>,nodeid:<Double_value>"srcip":<String_value>,
"srcport":<Integer_value>,
"destip":<String_value>,
"destport":<Integer_value>,
"peid":<Double_value>
}]}

<!--NeedCopy-->

count

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

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

<!--NeedCopy-->
vpnpcoipconnection