ansible.windows.win_group_membership 模块 – 管理 Windows 本地组成员

注意

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

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

要安装它，请使用： ansible-galaxy collection install ansible.windows。

要在 playbook 中使用它，请指定： ansible.windows.win_group_membership。

概要

  • 允许从本地组添加和删除本地用户、服务用户、域用户和域组。

参数

参数

注释

members

list / elements=string / required

一个成员列表，以确保它们存在/不存在于该组中。

接受本地用户，格式为 .\username 和 SERVERNAME\username。

接受域用户和组，格式为 DOMAIN\username 和 username@DOMAIN。

接受服务用户，格式为 NT AUTHORITY\username。

接受所有本地、域和服务用户类型，格式为 username，当在域中时，优先进行域查找。

name

string / required

要管理成员资格的本地组的名称。

state

string

组中成员的期望状态。

当 state 为 pure 时，只有指定的成员存在，所有其他未指定的现有成员都将被删除。

选择

  • "absent"

  • "present" ← (默认)

  • "pure"

另请参阅

另请参阅

community.windows.win_domain_group

创建、修改或删除域组。

ansible.windows.win_domain_membership

管理 Windows 主机的域/工作组成员身份。

ansible.windows.win_group

添加和删除本地组。

示例

- name: Add a local and domain user to a local group
  ansible.windows.win_group_membership:
    name: Remote Desktop Users
    members:
      - NewLocalAdmin
      - DOMAIN\TestUser
    state: present

- name: Remove a domain group and service user from a local group
  ansible.windows.win_group_membership:
    name: Backup Operators
    members:
      - DOMAIN\TestGroup
      - NT AUTHORITY\SYSTEM
    state: absent

- name: Ensure only a domain user exists in a local group
  ansible.windows.win_group_membership:
    name: Remote Desktop Users
    members:
      - DOMAIN\TestUser
    state: pure

返回值

常见的返回值已记录在此处，以下是此模块独有的字段

键

描述

added

list / elements=string

当 state 为 present 或 pure 时添加的成员列表；如果没有添加成员，则为空。

返回: 成功，并且 state 为 present

示例: ["SERVERNAME\\NewLocalAdmin", "DOMAIN\\TestUser"]

members

list / elements=string

完成时所有本地组成员的列表；如果该组不包含任何成员，则为空。

返回: 成功

示例: ["DOMAIN\\TestUser", "SERVERNAME\\NewLocalAdmin"]

name

string

目标本地组的名称。

返回: 始终

示例: "Administrators"

removed

list / elements=string

当 state 为 absent 或 pure 时删除的成员列表；如果没有删除成员，则为空。

返回: 成功，并且 state 为 absent

示例: ["DOMAIN\\TestGroup", "NT AUTHORITY\\SYSTEM"]

作者

  • Andrew Saraceni (@andrewsaraceni)