community.windows.win_rds_cap 模块 – 管理远程桌面网关服务器上的连接授权策略 (CAP)

注意

此模块是 community.windows 集合（版本 2.3.0）的一部分。

如果您正在使用 ansible 包，您可能已经安装了这个集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install community.windows。您需要进一步的要求才能使用此模块，有关详细信息，请参阅 要求。

要在 playbook 中使用它，请指定：community.windows.win_rds_cap。

概要

  • 创建、删除和配置远程桌面连接授权策略 (RD CAP)。

  • RD CAP 允许您指定可以连接到远程桌面网关服务器的用户。

要求

在执行此模块的主机上需要以下要求。

  • Windows Server 2008R2 (6.1) 或更高版本。

  • 必须启用 Windows 功能“RDS-Gateway”。

参数

参数

注释

allow_only_sdrts_servers

布尔值

指定是否只允许连接到强制执行远程桌面网关重定向策略的远程桌面会话主机服务器。

选项

  • false

  • true

auth_method

字符串

指定 RD 网关服务器如何对用户进行身份验证。

创建新 CAP 时，默认值为 password。

选项

  • "both"

  • "none"

  • "password"

  • "smartcard"

computer_groups

列表 / 元素=字符串

允许连接到远程网关服务器的计算机组的列表。

idle_timeout

整数

指定空闲会话断开连接的时间间隔，以分钟为单位。

值为零表示禁用空闲超时。

name

字符串 / 必需

连接授权策略的名称。

order

整数

策略的评估顺序。

order 设置为值“1”的 CAP 首先进行评估。

默认情况下，新创建的 CAP 将占据第一个位置。

如果给定值超过现有策略的总数，则该策略将占据最后一个位置，但评估顺序将限制为该数字。

redirect_clipboard

布尔值

允许剪贴板重定向。

选项

  • false

  • true

redirect_drives

布尔值

允许磁盘驱动器重定向。

选项

  • false

  • true

redirect_pnp

布尔值

允许即插即用设备重定向。

选项

  • false

  • true

redirect_printers

布尔值

允许打印机重定向。

选项

  • false

  • true

redirect_serial

布尔值

允许串行端口重定向。

选项

  • false

  • true

session_timeout

整数

会话可以空闲的最长时间（以分钟为单位）。

值为零表示禁用会话超时。

session_timeout_action

字符串

会话超时时服务器采取的操作。

disconnect：断开会话连接。

reauth：静默地重新验证和重新授权会话。

选项

  • "disconnect" ←（默认）

  • "reauth"

state

字符串

连接授权策略的状态。

如果 absent 将确保删除策略。

如果 present 将确保策略已配置且存在。

如果 enabled 将确保策略已配置、存在并已启用。

如果 disabled 将确保策略已配置、存在但已禁用。

选项

  • "absent"

  • "enabled"

  • "disabled"

  • "present" ←（默认）

user_groups

列表 / 元素=字符串

允许连接到远程网关服务器的用户组列表。

创建新 CAP 时必需。

另请参阅

另请参阅

community.windows.win_rds_cap

管理远程桌面网关服务器上的连接授权策略 (CAP)。

community.windows.win_rds_rap

管理远程桌面网关服务器上的资源授权策略 (RAP)。

community.windows.win_rds_settings

管理远程桌面网关服务器的主要设置。

示例

- name: Create a new RDS CAP with a 30 minutes timeout and clipboard redirection enabled
  community.windows.win_rds_cap:
    name: My CAP
    user_groups:
      - BUILTIN\users
    session_timeout: 30
    session_timeout_action: disconnect
    allow_only_sdrts_servers: true
    redirect_clipboard: true
    redirect_drives: false
    redirect_printers: false
    redirect_serial: false
    redirect_pnp: false
    state: enabled

作者

  • Kevin Subileau (@ksubileau)