community.windows.win_rds_settings – Manage main settings of a Remote Desktop Gateway server

Note

This plugin is part of the community.windows collection (version 1.6.0).

To install it use: ansible-galaxy collection install community.windows.

To use it in a playbook, specify: community.windows.win_rds_settings.

Synopsis

  • Configure general settings of a Remote Desktop Gateway server.

Requirements

The below requirements are needed on the host that executes this module.

  • Windows Server 2008R2 (6.1) or higher.

  • The Windows Feature “RDS-Gateway” must be enabled.

Parameters

Parameter Choices/Defaults Comments
certificate_hash
string
Certificate hash (thumbprint) for the Remote Desktop Gateway server. The certificate hash is the unique identifier for the certificate.
enable_only_messaging_capable_clients
boolean
    Choices:
  • no
  • yes
If enabled, only clients that support logon messages and administrator messages can connect.
max_connections
integer
The maximum number of connections allowed.
If set to 0, no new connections are allowed.
If set to -1, the number of connections is unlimited.
ssl_bridging
string
    Choices:
  • https_http
  • https_https
  • none
Specifies whether to use SSL Bridging.
none: no SSL bridging.
https_http: HTTPS-HTTP bridging.
https_https: HTTPS-HTTPS bridging.

See Also

See also

community.windows.win_rds_cap

The official documentation on the community.windows.win_rds_cap module.

community.windows.win_rds_rap

The official documentation on the community.windows.win_rds_rap module.

community.windows.win_rds_settings

The official documentation on the community.windows.win_rds_settings module.

Examples

- name: Configure the Remote Desktop Gateway
  community.windows.win_rds_settings:
    certificate_hash: B0D0FA8408FC67B230338FCA584D03792DA73F4C
    max_connections: 50
  notify:
    - Restart TSGateway service

Authors

  • Kevin Subileau (@ksubileau)