community.windows.win_domain_group_membership 模块 – 管理 Windows 域组成员关系

注意

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

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

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

要在剧本中使用它，请指定：community.windows.win_domain_group_membership。

已弃用

在以下版本中移除:

版本 3.0.0

原因:

此模块已移至 microsoft.ad 集合中。

替代方案:

请改用 microsoft.ad.group 模块。

概要

  • 允许从/向域组添加和删除域用户和域组。

参数

参数

注释

domain_password

字符串

username 的密码。

domain_server

字符串

指定要连接的 Active Directory 域服务实例。

可以是 FQDN 或 NetBIOS 名称的形式。

如果未指定，则该值基于运行 PowerShell 的计算机的域。

domain_username

字符串

与 AD 交互时使用的用户名。

如果未设置，则在使用 CredSSP 或 Kerberos 进行凭据委派时，将改为使用 Ansible 登录的用户。

members

list / elements=string / required

一个列表，其中包含要确保在组中存在/不存在的成员。

给定的名称必须是用户、组、服务帐户或计算机的 SamAccountName。

对于计算机，您必须在名称后添加“$”；例如，要将“Mycomputer”添加到组中，请使用“Mycomputer$”作为成员。

如果成员对象是多域林中另一个域的一部分，则必须在名称前面添加域和“\”。

name

string / required

要管理成员关系的域组的名称。

state

字符串

组中成员的所需状态。

当 state 为 pure 时，仅存在指定的成员，并且会删除所有其他未指定的现有成员。

选择

  • "absent"

  • "present" ← (默认)

  • "pure"

注释

注意

  • 这必须在安装了 ActiveDirectory powershell 模块的主机上运行。

另请参阅

另请参阅

community.windows.win_domain_user

管理 Windows Active Directory 用户帐户。

community.windows.win_domain_group

创建、修改或删除域组。

示例

- name: Add a domain user/group to a domain group
  community.windows.win_domain_group_membership:
    name: Foo
    members:
      - Bar
    state: present

- name: Remove a domain user/group from a domain group
  community.windows.win_domain_group_membership:
    name: Foo
    members:
      - Bar
    state: absent

- name: Ensure only a domain user/group exists in a domain group
  community.windows.win_domain_group_membership:
    name: Foo
    members:
      - Bar
    state: pure

- name: Add a computer to a domain group
  community.windows.win_domain_group_membership:
    name: Foo
    members:
      - DESKTOP$
    state: present

- name: Add a domain user/group from another Domain in the multi-domain forest to a domain group
  community.windows.win_domain_group_membership:
    domain_server: DomainAAA.cloud
    name: GroupinDomainAAA
    members:
      - DomainBBB.cloud\UserInDomainBBB
    state: Present

返回值

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

键

描述

added

list / elements=string

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

返回: 成功且 state 为 present 或 pure

示例: ["UserName", "GroupName"]

members

list / elements=string

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

返回: 成功

示例: ["UserName", "GroupName"]

name

字符串

目标域组的名称。

返回: 总是

示例: "Domain-Admins"

已删除

list / elements=string

当 state 为 absent 或 pure 时，已删除的成员列表；如果未删除任何成员，则此列表为空。

返回: 成功且 state 为 absent 或 pure

示例: ["UserName", "GroupName"]

状态

  • 此模块将在 3.0.0 版本中移除。 [已弃用]

  • 有关更多信息，请参阅 已弃用。

作者

  • Marius Rieder (@jiuka)