community.windows.win_rds_rap module – Manage Resource Authorization Policies (RAP) on a Remote Desktop Gateway server
Note
This module is part of the community.windows collection (version 2.3.0).
You might already have this collection installed if you are using the ansible
package.
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 community.windows
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: community.windows.win_rds_rap
.
Synopsis
Creates, removes and configures a Remote Desktop resource authorization policy (RD RAP).
A RD RAP allows you to specify the network resources (computers) that users can connect to remotely through 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 |
Comments |
---|---|
List of port numbers through which connections are allowed for this policy. To allow connections through any port, specify ‘any’. |
|
The computer group name that is associated with this resource authorization policy (RAP). This is required when computer_group_type is |
|
The computer group type:
Choices:
|
|
Optional description of the resource authorization policy. |
|
Name of the resource authorization policy. |
|
The state of resource authorization policy. If If If If Choices:
|
|
List of user groups that are associated with this resource authorization policy (RAP). A user must belong to one of these groups to access the RD Gateway server. Required when a new RAP is created. |
See Also
See also
- community.windows.win_rds_cap
Manage Connection Authorization Policies (CAP) on a Remote Desktop Gateway server.
- community.windows.win_rds_rap
Manage Resource Authorization Policies (RAP) on a Remote Desktop Gateway server.
- community.windows.win_rds_settings
Manage main settings of a Remote Desktop Gateway server.
Examples
- name: Create a new RDS RAP
community.windows.win_rds_rap:
name: My RAP
description: Allow all users to connect to any resource through ports 3389 and 3390
user_groups:
- BUILTIN\users
computer_group_type: allow_any
allowed_ports:
- 3389
- 3390
state: enabled
Authors
Kevin Subileau (@ksubileau)