Developer Documentation
ADC NITRO APIs
Current Release 13.1 13

icaaccessprofile

August 17, 2023
Contributed by: 
C

Configuration for ica accessprofile resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
name <String> Read-write Name for the ICA accessprofile. Must begin with a letter, number, or the underscore character (_), and must contain only letters, numbers, and

the hyphen (-), period (.) pound (#), space ( ), at (@), equals (=), colon (:), and underscore characters. Cannot be changed after the ICA accessprofile is added.



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 ica accessprofile" or 'my ica accessprofile').



Each of the features can be configured as DEFAULT/DISABLED.

Here, DISABLED means that the policy settings on the backend XenApp/XenDesktop server are overridden and the Citrix ADC makes the decision to deny access. Whereas DEFAULT means that the Citrix ADC allows the request to reach the XenApp/XenDesktop that takes the decision to allow/deny access based on the policy configured on it. For example, if ClientAudioRedirection is enabled on the backend XenApp/XenDesktop server, and the configured profile has ClientAudioRedirection as DISABLED, the Citrix ADC makes the decision to deny the request irrespective of the configuration on the backend. If the configured profile has ClientAudioRedirection as DEFAULT, then the Citrix ADC forwards the requests to the backend XenApp/XenDesktop server.It then makes the decision to allow/deny access based on the policy configured on it.

Minimum length = 1
connectclientlptports <String> Read-write Allow Default access/Disable automatic connection of LPT ports from the client when the user logs on.

Default value: DISABLED

Possible values = DEFAULT, DISABLED
clientaudioredirection <String> Read-write Allow Default access/Disable applications hosted on the server to play sounds through a sound device installed on the client computer, also allows or prevents users to record audio input.

Default value: DISABLED

Possible values = DEFAULT, DISABLED
localremotedatasharing <String> Read-write Allow Default access/Disable file/data sharing via the Receiver for HTML5.

Default value: DISABLED

Possible values = DEFAULT, DISABLED
clientclipboardredirection <String> Read-write Allow Default access/Disable the clipboard on the client device to be mapped to the clipboard on the server.

Default value: DISABLED

Possible values = DEFAULT, DISABLED
clientcomportredirection <String> Read-write Allow Default access/Disable COM port redirection to and from the client.

Default value: DISABLED

Possible values = DEFAULT, DISABLED
clientdriveredirection <String> Read-write Allow Default access/Disables drive redirection to and from the client.

Default value: DISABLED

Possible values = DEFAULT, DISABLED
clientprinterredirection <String> Read-write Allow Default access/Disable client printers to be mapped to a server when a user logs on to a session.

Default value: DISABLED

Possible values = DEFAULT, DISABLED
multistream <String> Read-write Allow Default access/Disable the multistream feature for the specified users.

Default value: DISABLED

Possible values = DEFAULT, DISABLED
clientusbdriveredirection <String> Read-write Allow Default access/Disable the redirection of USB devices to and from the client.

Default value: DISABLED

Possible values = DEFAULT, DISABLED
refcnt <Double> Read-only Number of entities using this accessprofile.
builtin <String[]> Read-only Indicates that the ICA accessprofile is a built-in (SYSTEM INTERNAL) type.

Possible values = MODIFIABLE, DELETABLE, IMMUTABLE, PARTITION_ALL
feature <String> Read-only The feature to be checked while applying this config.
isdefault <Boolean> Read-only A value of true is returned if it is a default accessprofile.
__count <Double> Read-only count parameter

Operations

(click to see Properties )

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

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

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload: 


{"icaaccessprofile":{
<b>      "name":<String_value>,
</b>      "connectclientlptports":<String_value>,
      "clientaudioredirection":<String_value>,
      "localremotedatasharing":<String_value>,
      "clientclipboardredirection":<String_value>,
      "clientcomportredirection":<String_value>,
      "clientdriveredirection":<String_value>,
      "clientprinterredirection":<String_value>,
      "multistream":<String_value>,
      "clientusbdriveredirection":<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/icaaccessprofile/ 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/icaaccessprofile

HTTP Method: PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload: 


{"icaaccessprofile":{
<b>      "name":<String_value>,
</b>      "connectclientlptports":<String_value>,
      "clientaudioredirection":<String_value>,
      "localremotedatasharing":<String_value>,
      "clientclipboardredirection":<String_value>,
      "clientcomportredirection":<String_value>,
      "clientdriveredirection":<String_value>,
      "clientprinterredirection":<String_value>,
      "multistream":<String_value>,
      "clientusbdriveredirection":<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/icaaccessprofile? action=unset

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload: 


{"icaaccessprofile":{
<b>      "name":<String_value>,
</b>      "connectclientlptports":true,
      "clientaudioredirection":true,
      "localremotedatasharing":true,
      "clientclipboardredirection":true,
      "clientcomportredirection":true,
      "clientdriveredirection":true,
      "clientprinterredirection":true,
      "multistream":true,
      "clientusbdriveredirection":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

get (all)

URL: http:// <netscaler-ip-address> /nitro/v1/config/icaaccessprofile

Query-parameters:

attrs

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

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

view

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

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

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


{ "icaaccessprofile": [ {
      "name":<String_value>,
      "connectclientlptports":<String_value>,
      "clientaudioredirection":<String_value>,
      "localremotedatasharing":<String_value>,
      "clientclipboardredirection":<String_value>,
      "clientcomportredirection":<String_value>,
      "clientdriveredirection":<String_value>,
      "clientprinterredirection":<String_value>,
      "multistream":<String_value>,
      "clientusbdriveredirection":<String_value>,
      "refcnt":<Double_value>,
      "builtin":<String[]_value>,
      "feature":<String_value>,
      "isdefault":<Boolean_value>
}]}

<!--NeedCopy-->

get

URL: http:// <netscaler-ip-address> /nitro/v1/config/icaaccessprofile/ name_value<String>

Query-parameters:

attrs

http:// <netscaler-ip-address> /nitro/v1/config/icaaccessprofile/ 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/icaaccessprofile/ name_value<String> ? view=summary

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


{  "icaaccessprofile": [ {
      "name":<String_value>,
      "connectclientlptports":<String_value>,
      "clientaudioredirection":<String_value>,
      "localremotedatasharing":<String_value>,
      "clientclipboardredirection":<String_value>,
      "clientcomportredirection":<String_value>,
      "clientdriveredirection":<String_value>,
      "clientprinterredirection":<String_value>,
      "multistream":<String_value>,
      "clientusbdriveredirection":<String_value>,
      "refcnt":<Double_value>,
      "builtin":<String[]_value>,
      "feature":<String_value>,
      "isdefault":<Boolean_value>
}]}

<!--NeedCopy-->

count

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


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

<!--NeedCopy-->
icaaccessprofile
August 17, 2023
Contributed by: 
C
August 17, 2023
Contributed by: 
C

In this article

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