Citrix ADC 12.1 NITRO API Reference

vpnicaconnection

Configuration for active ica connections resource.

Properties

(click to see Operations)

Name Data Type Permissions Description
username Read-write User name for which to display connections.
Minimum length = 1
transproto Read-write Transport type for the existing Existing ICA conenction.
Possible values = TCP, UDP
nodeid Read-write Unique number that identifies the cluster node.
Minimum value = 0
Maximum value = 31
all Read-write Terminate all active icaconnections.
domain Read-only The domain name.
srcip Read-only The client IP address.
srcport Read-only The client port.
Range 1 - 65535
* in CLI is represented as 65535 in NITRO API
destip Read-only The CPS server IP address.
destport Read-only The CPS server port.
Range 1 - 65535
* in CLI is represented as 65535 in NITRO API
peid Read-only Core id of the session owner.
__count Read-only count parameter

Operations

(click to see Properties)

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>.

kill

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/vpnicaconnection?action=kill

HTTP Method:POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json

Request Payload:

{"vpnicaconnection":{ "username":<String_value>, "transproto":<String_value>, "all":<Boolean_value> }}

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/vpnicaconnection

Query-parameters:

args

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/vpnicaconnection?args=username:<String_value>,transproto:<String_value>,nodeid:<Double_value>

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

attrs

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/vpnicaconnection?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/vpnicaconnection?filter=property-name1:property-val1,property-name2:property-val2

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

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

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

count

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/vpnicaconnection?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:

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