netscaler.adc.rdpclientprofile module – Configuration for RDP clientprofile resource.

Note

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

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

New in netscaler.adc 2.0.0

Synopsis

  • Configuration for RDP clientprofile resource.

Parameters

Parameter

Comments

addusernameinrdpfile

any

Add username in rdp file.

Choices:

  • "YES"

  • "NO"

api_path

string

Base NITRO API path.

Define only in case of an ADM service proxy call

Default: "nitro/v1/config"

audiocapturemode

any

This setting corresponds to the selections in the Remote audio area on the Local Resources tab under Options in RDC.

Choices:

  • "ENABLE"

  • "DISABLE"

keyboardhook

any

This setting corresponds to the selection in the Keyboard drop-down list on the Local Resources tab under Options in RDC.

Choices:

  • "OnLocal"

  • "OnRemote"

  • "InFullScreenMode"

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.

multimonitorsupport

any

Enable/Disable Multiple Monitor Support for Remote Desktop Connection (RDC).

Choices:

  • "ENABLE"

  • "DISABLE"

name

any

The name of the rdp profile

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.

psk

any

Pre shared key value

randomizerdpfilename

any

Will generate unique filename everytime rdp file is downloaded by appending output of time() function in the format <rdpfileName>_<time>.rdp. This tries to avoid the pop-up for replacement of existing rdp file during each rdp connection launch, hence providing better end-user experience.

Choices:

  • "YES"

  • "NO"

rdpcookievalidity

any

RDP cookie validity period. RDP cookie validity time is applicable for new connection and also for any re-connection that might happen, mostly due to network disruption or during fail-over.

rdpcustomparams

any

Option for RDP custom parameters settings (if any). Custom params needs to be separated by ‘&’

rdpfilename

any

RDP file name to be sent to End User

rdphost

any

Fully-qualified domain name (FQDN) of the RDP Listener.

rdplinkattribute

any

Citrix Gateway allows the configuration of rdpLinkAttribute parameter which can be used to fetch a list of RDP servers(IP/FQDN) that a user can access, from an Authentication server attribute(Example: LDAP, SAML). Based on the list received, the RDP links will be generated and displayed to the user.

Note: The Attribute mentioned in the rdpLinkAttribute should be fetched through corresponding authentication method.

rdplistener

any

IP address (or) Fully-qualified domain name(FQDN) of the RDP Listener with the port in the format IP:Port (or) FQDN:Port

rdpurloverride

any

This setting determines whether the RDP parameters supplied in the vpn url override those specified in the RDP profile.

Choices:

  • "ENABLE"

  • "DISABLE"

rdpvalidateclientip

any

This setting determines whether RDC launch is initiated by the valid client IP

Choices:

  • "ENABLE"

  • "DISABLE"

redirectclipboard

any

This setting corresponds to the Clipboard check box on the Local Resources tab under Options in RDC.

Choices:

  • "ENABLE"

  • "DISABLE"

redirectcomports

any

This setting corresponds to the selections for comports under More on the Local Resources tab under Options in RDC.

Choices:

  • "ENABLE"

  • "DISABLE"

redirectdrives

any

This setting corresponds to the selections for Drives under More on the Local Resources tab under Options in RDC.

Choices:

  • "ENABLE"

  • "DISABLE"

redirectpnpdevices

any

This setting corresponds to the selections for pnpdevices under More on the Local Resources tab under Options in RDC.

Choices:

  • "ENABLE"

  • "DISABLE"

redirectprinters

any

This setting corresponds to the selection in the Printers check box on the Local Resources tab under Options in RDC.

Choices:

  • "ENABLE"

  • "DISABLE"

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

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)

videoplaybackmode

any

This setting determines if Remote Desktop Connection (RDC) will use RDP efficient multimedia streaming for video playback.

Choices:

  • "ENABLE"

  • "DISABLE"

Notes

Note

Examples

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)