netscaler.adc.icaaccessprofile module – Configuration for ica accessprofile resource.

Note

This module is part of the netscaler.adc collection (version 2.6.2).

It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install netscaler.adc.

To use it in a playbook, specify: netscaler.adc.icaaccessprofile.

New in netscaler.adc 2.0.0

Synopsis

  • Configuration for ica accessprofile resource.

Parameters

Parameter

Comments

api_path

string

Base NITRO API path.

Define only in case of an ADM service proxy call

Default: "nitro/v1/config"

clientaudioredirection

string

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

Choices:

  • "DEFAULT"

  • "DISABLED"

clientclipboardredirection

string

Allow Default access/Disable the clipboard on the client device to be mapped to the clipboard on the server

Choices:

  • "DEFAULT"

  • "DISABLED"

clientcomportredirection

string

Allow Default access/Disable COM port redirection to and from the client

Choices:

  • "DEFAULT"

  • "DISABLED"

clientdriveredirection

string

Allow Default access/Disables drive redirection to and from the client

Choices:

  • "DEFAULT"

  • "DISABLED"

clientprinterredirection

string

Allow Default access/Disable client printers to be mapped to a server when a user logs on to a session

Choices:

  • "DEFAULT"

  • "DISABLED"

clienttwaindeviceredirection

string

Allow default access or disable TWAIN devices, such as digital cameras or scanners, on the client device from published image processing applications

Choices:

  • "DEFAULT"

  • "DISABLED"

clientusbdriveredirection

string

Allow Default access/Disable the redirection of USB devices to and from the client

Choices:

  • "DEFAULT"

  • "DISABLED"

connectclientlptports

string

Allow Default access/Disable automatic connection of LPT ports from the client when the user logs on

Choices:

  • "DEFAULT"

  • "DISABLED"

draganddrop

string

Allow default access or disable drag and drop between client and remote applications and desktops

Choices:

  • "DEFAULT"

  • "DISABLED"

fido2redirection

string

Allow default access or disable FIDO2 redirection

Choices:

  • "DEFAULT"

  • "DISABLED"

localremotedatasharing

string

Allow Default access/Disable file/data sharing via the Receiver for HTML5

Choices:

  • "DEFAULT"

  • "DISABLED"

managed_netscaler_instance_id

string

added in netscaler.adc 2.6.0

The ID of the managed NetScaler instance to which NetScaler Console

has to configure as a proxy server.

Define only in case of an ADM service proxy call

managed_netscaler_instance_ip

string

added in netscaler.adc 2.6.0

The IP of the managed NetScaler instance to which NetScaler Console

has to configure as a proxy server.

Define only in case of an ADM service proxy call

managed_netscaler_instance_name

string

added in netscaler.adc 2.6.0

The name of the managed NetScaler instance to which NetScaler Console

has to configure as a proxy server.

Define only in case of an ADM service proxy call

managed_netscaler_instance_password

string

added in netscaler.adc 2.6.0

The password of the managed NetScaler instance.

Define only in case of an ADM service proxy call

In Settings > Administration > System Configurations > Basic Settings,

if you select Prompt Credentials for Instance Login,

ensure to configure username and password of a managed instance.

managed_netscaler_instance_username

string

added in netscaler.adc 2.6.0

The username of the managed NetScaler instance.

Define only in case of an ADM service proxy call

In Settings > Administration > System Configurations > Basic Settings,

if you select Prompt Credentials for Instance Login,

ensure to configure username and password of a managed instance.

multistream

string

Allow Default access/Disable the multistream feature for the specified users

Choices:

  • "DEFAULT"

  • "DISABLED"

name

string

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.

netscaler_console_as_proxy_server

boolean

added in netscaler.adc 2.6.0

The IP address of the NetScaler ADC appliance acting as a proxy server.

Define only in case of an ADM service proxy call

Choices:

  • false ← (default)

  • true

nitro_auth_token

string

The authentication token provided by a login operation.

nitro_pass

string

The password with which to authenticate to the NetScaler ADC node.

nitro_protocol

string

Which protocol to use when accessing the nitro API objects.

Choices:

  • "http"

  • "https" ← (default)

nitro_user

string

The username with which to authenticate to the NetScaler ADC node.

nsip

string / required

The ip address of the NetScaler ADC appliance where the nitro API calls will be made.

The port can be specified with the colon (:). E.g. 192.168.1.1:555.

save_config

boolean

If true the module will save the configuration on the NetScaler ADC node if it makes any changes.

The module will not save the configuration on the NetScaler ADC node if it made no changes.

Choices:

  • false ← (default)

  • true

smartcardredirection

string

Allow default access or disable smart card redirection. Smart card virtual channel is always allowed in CVAD

Choices:

  • "DEFAULT"

  • "DISABLED"

state

string

The state of the resource being configured by the module on the NetScaler ADC node.

When present, the resource will be added/updated configured according to the module’s parameters.

When absent, the resource will be deleted from the NetScaler ADC node.

When unset, the resource will be unset on the NetScaler ADC node.

Choices:

  • "present" ← (default)

  • "absent"

  • "unset"

validate_certs

boolean

If false, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.

Choices:

  • false

  • true ← (default)

wiaredirection

string

Allow default access or disable WIA scanner redirection

Choices:

  • "DEFAULT"

  • "DISABLED"

Notes

Note

Examples

---
- name: Sample icaaccessprofile playbook
  hosts: demo_netscalers
  gather_facts: false
  tasks:
    - name: Configure icaaccessprofile
      delegate_to: localhost
      netscaler.adc.icaaccessprofile:
        state: present
        name: ipr
        clientclipboardredirection: DEFAULT

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

changed

boolean

Indicates if any change is made by the module

Returned: always

Sample: true

diff

dictionary

Dictionary of before and after changes

Returned: always

Sample: {"after": {"key2": "pqr"}, "before": {"key1": "xyz"}, "prepared": "changes done"}

diff_list

list / elements=string

List of differences between the actual configured object and the configuration specified in the module

Returned: when changed

Sample: ["Attribute `key1` differs. Desired: (<class 'str'>) XYZ. Existing: (<class 'str'>) PQR"]

failed

boolean

Indicates if the module failed or not

Returned: always

Sample: false

loglines

list / elements=string

list of logged messages by the module

Returned: always

Sample: ["message 1", "message 2"]

Authors

  • Sumanth Lingappa (@sumanth-lingappa)

  • Shiva Shankar Vaddepally (@shivashankar-vaddepally)