Try SpotterConfiguration for RDP clientprofile resource.
| "added in version" 2.0.0 of netscaler.adc"
Authors: Sumanth Lingappa (@sumanth-lingappa)
preview | supported by community
Install with ansible-galaxy collection install netscaler.adc:==2.5.1
collections:
- name: netscaler.adc
version: 2.5.1Configuration for RDP clientprofile resource.
psk:
description:
- Pre shared key value
type: str
name:
description:
- The name of the rdp profile
type: str
nsip:
description:
- 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.
required: true
type: str
state:
choices:
- present
- absent
- unset
default: present
description:
- The state of the resource being configured by the module on the NetScaler ADC node.
- When C(present), the resource will be added/updated configured according to the
module's parameters.
- When C(absent), the resource will be deleted from the NetScaler ADC node.
- When C(unset), the resource will be unset on the NetScaler ADC node.
type: str
rdphost:
description:
- Fully-qualified domain name (FQDN) of the RDP Listener.
type: str
api_path:
default: nitro/v1/config
description:
- Base NITRO API path.
- Define only in case of an ADM service proxy call
type: str
nitro_pass:
description:
- The password with which to authenticate to the NetScaler ADC node.
required: false
type: str
nitro_user:
description:
- The username with which to authenticate to the NetScaler ADC node.
required: false
type: str
rdpfilename:
description:
- RDP file name to be sent to End User
type: str
rdplistener:
description:
- IP address (or) Fully-qualified domain name(FQDN) of the RDP Listener with the port
in the format IP:Port (or) FQDN:Port
type: str
save_config:
default: false
description:
- If C(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.
type: bool
keyboardhook:
choices:
- OnLocal
- OnRemote
- InFullScreenMode
description:
- This setting corresponds to the selection in the Keyboard drop-down list on the
Local Resources tab under Options in RDC.
type: str
nitro_protocol:
choices:
- http
- https
default: https
description:
- Which protocol to use when accessing the nitro API objects.
type: str
rdpurloverride:
choices:
- ENABLE
- DISABLE
description:
- This setting determines whether the RDP parameters supplied in the vpn url override
those specified in the RDP profile.
type: str
redirectdrives:
choices:
- ENABLE
- DISABLE
description:
- This setting corresponds to the selections for Drives under More on the Local Resources
tab under Options in RDC.
type: str
validate_certs:
default: true
description:
- If C(false), SSL certificates will not be validated. This should only be used on
personally controlled sites using self-signed certificates.
required: false
type: bool
rdpcustomparams:
description:
- Option for RDP custom parameters settings (if any). Custom params needs to be separated
by '&'
type: str
audiocapturemode:
choices:
- ENABLE
- DISABLE
description:
- This setting corresponds to the selections in the Remote audio area on the Local
Resources tab under Options in RDC.
type: str
nitro_auth_token:
description:
- The authentication token provided by a login operation.
type: str
version_added: 2.6.0
version_added_collection: netscaler.adc
rdplinkattribute:
description:
- '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.'
type: str
redirectcomports:
choices:
- ENABLE
- DISABLE
description:
- This setting corresponds to the selections for comports under More on the Local
Resources tab under Options in RDC.
type: str
redirectprinters:
choices:
- ENABLE
- DISABLE
description:
- This setting corresponds to the selection in the Printers check box on the Local
Resources tab under Options in RDC.
type: str
rdpcookievalidity:
description:
- 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.
type: float
redirectclipboard:
choices:
- ENABLE
- DISABLE
description:
- This setting corresponds to the Clipboard check box on the Local Resources tab under
Options in RDC.
type: str
videoplaybackmode:
choices:
- ENABLE
- DISABLE
description:
- This setting determines if Remote Desktop Connection (RDC) will use RDP efficient
multimedia streaming for video playback.
type: str
redirectpnpdevices:
choices:
- ENABLE
- DISABLE
description:
- This setting corresponds to the selections for pnpdevices under More on the Local
Resources tab under Options in RDC.
type: str
multimonitorsupport:
choices:
- ENABLE
- DISABLE
description:
- Enable/Disable Multiple Monitor Support for Remote Desktop Connection (RDC).
type: str
rdpvalidateclientip:
choices:
- ENABLE
- DISABLE
description:
- This setting determines whether RDC launch is initiated by the valid client IP
type: str
addusernameinrdpfile:
choices:
- 'YES'
- 'NO'
description:
- Add username in rdp file.
type: str
randomizerdpfilename:
choices:
- 'YES'
- 'NO'
description:
- 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.
type: str
changed:
description: Indicates if any change is made by the module
returned: always
sample: true
type: bool
diff:
description: Dictionary of before and after changes
returned: always
sample:
after:
key2: pqr
before:
key1: xyz
prepared: changes done
type: dict
diff_list:
description: 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'
type: list
failed:
description: Indicates if the module failed or not
returned: always
sample: false
type: bool
loglines:
description: list of logged messages by the module
returned: always
sample:
- message 1
- message 2
type: list