community.windows.win_domain_ou 模块 – 管理 Active Directory 组织单位

注意

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

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

要安装它，请使用：ansible-galaxy collection install community.windows。您需要其他需求才能使用此模块，详情请参见需求。

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

community.windows 1.8.0 中的新增功能

已弃用 

在以下版本中移除：: 版本 3.0.0
原因：: 此模块已移至 microsoft.ad 集合。
替代方案：: 请改用 microsoft.ad.ou 模块。

概要 

管理 Active Directory 组织单位
添加、删除和修改 Active Directory 组织单位
任务应委托给 Windows Active Directory 域控制器

需求 

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

此模块需要 Windows Server 2012 或更高版本
Powershell ActiveDirectory 模块

参数 

参数	注释
domain_password 字符串	您要访问的域的密码
domain_server 字符串	指定要连接到的 Active Directory 域服务实例。可以是 FQDN 或 NetBIOS 名称的形式。如果未指定，则该值基于运行 PowerShell 的计算机的域。
domain_username 字符串	与 AD 交互时使用的用户名。如果未设置此参数，则在使用 CredSSP 或 Kerberos 和凭据委托时，将改用 Ansible 用于登录的用户名。
filter 字符串	用于查找 ou 的过滤器。默认值： `"*"`
name 字符串 / 必需	组织单位的名称
path 字符串	指定创建新对象的 OU 或容器的 X.500 路径。默认为在连接到的域的底部添加 ou。
properties 字典	组织单位属性的自由格式字典。遵循 LDAP 属性名称，例如 `StreetAddress` 或 `PostalCode`。
protected 布尔值	指示是否阻止删除对象。当此 protected=true 时，您无法删除相应的对象，除非更改属性的值。选项 `false` ← (默认) `true`
recursive 布尔值	删除 OU 及其包含的任何子项。您必须指定此参数才能删除非空的 OU。选项 `false` ← (默认) `true`
state 字符串	指定 OU 的所需状态。当 state=present 时，如果指定的 OU 不存在，模块将尝试创建它。当 state=absent 时，模块将删除指定的 OU。当 state=absent 且 recursive=true 时，模块将删除所有 OU 和所有子 OU。选项 `"present"` ← (默认) `"absent"`

示例 

---
- name: Ensure OU is present & protected
  community.windows.win_domain_ou:
    name: AnsibleFest
    state: present

- name: Ensure OU is present & protected
  community.windows.win_domain_ou:
    name: EUC Users
    path: "DC=euc,DC=vmware,DC=lan"
    state: present
    protected: true
  delegate_to: win-ad1.euc.vmware.lab

- name: Ensure OU is absent
  community.windows.win_domain_ou:
    name: EUC Users
    path: "DC=euc,DC=vmware,DC=lan"
    state: absent
  delegate_to: win-ad1.euc.vmware.lab

- name: Ensure OU is present with specific properties
  community.windows.win_domain_ou:
    name: WS1Users
    path: "CN=EUC Users,DC=euc,DC=vmware,DC=lan"
    protected: true
    properties:
      city: Sandy Springs
      state: Georgia
      StreetAddress: 1155 Perimeter Center West
      country: US
      description: EUC Business Unit
      PostalCode: 30189
  delegate_to: win-ad1.euc.vmware.lab

- name: Ensure OU updated with new properties
  community.windows.win_domain_ou:
    name: WS1Users
    path: DC=euc,DC=vmware,DC=lan
    protected: false
    properties:
      city: Atlanta
      state: Georgia
      managedBy: [email protected]
  delegate_to: win-ad1.euc.vmware.lab

返回值 

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

键

描述

ou

字典

新的/更新的组织单位参数

返回：当 state=present 时

示例： {"AddedProperties": [], "City": "Sandy Springs", "Country": null, "DistinguishedName": "OU=VMW Atlanta,DC=ansible,DC=test", "LinkedGroupPolicyObjects": [], "ManagedBy": null, "ModifiedProperties": [], "Name": "VMW Atlanta", "ObjectClass": "organizationalUnit", "ObjectGUID": "3e987e30-93ad-4229-8cd0-cff6a91275e4", "PostalCode": null, "PropertyCount": 11, "PropertyNames": "City Country DistinguishedName LinkedGroupPolicyObjects ManagedBy Name ObjectClass ObjectGUID PostalCode State StreetAddress", "RemovedProperties": [], "State": "Georgia", "StreetAddress": "1155 Perimeter Center West"}

path

字符串

模块使用的基本 ou 路径，无论是否提供 path=DC=Ansible,DC=Test 或由模块派生。

返回：始终返回

示例： "{'path': 'DC=ansible,DC=test'}"

状态 

此模块将在 3.0.0 版本中删除。[已弃用]
有关更多信息，请参见已弃用。

作者

Joe Zollo (@joezollo)
Larry Lane (@gamethis)