迁移指南

本集合中的一些模块来自 ansible.windows 集合community.windows 集合。本文档将介绍为方便从旧模块过渡到本集合中的模块而进行的一些更改。

已迁移的模块

以下模块已以某种形式迁移到此集合中

  • ansible.windows.win_domain -> microsoft.ad.domain - 详情

  • ansible.windows.win_domain_controller -> microsoft.ad.domain_controller - 详情

  • ansible.windows.win_domain_membership -> microsoft.ad.membership - 详情

  • community.windows.win_domain_computer -> microsoft.ad.computer - 详情

  • community.windows.win_domain_group -> microsoft.ad.group - 详情

  • community.windows.win_domain_group_membership -> microsoft.ad.group - 详情

  • community.windows.win_domain_object_info -> microsoft.ad.object_info - 详情

  • community.windows.win_domain_ou -> microsoft.ad.ou - 详情

  • community.windows.win_domain_user -> microsoft.ad.user - 详情

虽然这些模块大部分可以直接替换使用,但也有一些需要考虑的重大更改。请参阅每个模块条目以获取更多信息。

模块 win_domain

已迁移到 microsoft.ad.domain

没有已知的重大更改,应该可以作为直接替换使用。reboot 选项已添加,以便模块处理任何需要的重新启动,而不是单独的 ansible.windows.win_reboot 任务。由于提升域控制器涉及的操作,强烈建议使用此选项。

模块 win_domain_controller

已迁移到 microsoft.ad.domain_controller

已删除以下选项

  • log_path - 不支持创建模块操作的调试日志

reboot 选项已添加,以便模块处理任何重新启动,而不是单独的 ansible.windows.win_reboot 任务。由于提升域控制器涉及的操作,强烈建议使用此选项。

模块 win_domain_membership

已迁移到 microsoft.ad.membership

已删除以下选项

  • log_path - 不支持创建模块操作的调试日志

reboot 选项已添加,以便模块处理任何需要的重新启动,而不是单独的 ansible.windows.win_reboot 任务。

模块 win_domain_computer

已迁移到 microsoft.ad.computer

state: present 时,dns_host_name 选项不是必需的,如果未定义,则会在不设置 dnsHostName LDAP 属性的情况下创建计算机对象。

enabled 的默认值为空,创建组时仍将启用该组,但如果省略此选项,则将使用现有状态。

选项ou现已重命名为path,以匹配其他模块设置的标准。

选项offline_domain_joinodj_blob_path已被移除。使用新的模块microsoft.ad.offline_join来生成脱机加入 Blob。例如

- name: create computer object
  microsoft.ad.computer:
    name: MyComputer
    state: present
  register: computer_obj

- name: create offline blob
  microsoft.ad.offline_join:
    identity: '{{ computer_obj.object_guid }}'
  when: computer_obj is changed
  register: offline_blob

- name: display offline blob
  debug:
    var: offline_blob.blob
  when: computer_obj is changed

模块 win_domain_group

已迁移到 microsoft.ad.group

以下选项已更改

  • attributes - 格式已更改,详见 属性指南

  • ignore_protection - 已移除,state: absent 将移除对象,无论其保护状态如何。

  • organizational_unitou - 已移除,请改用 path

  • protect - 已重命名为 protect_from_deletion,现在无需为 state: absent 移除组而取消设置。

win_domain_group 的返回值也已简化为仅返回:

  • distinguished_name - 受管 OU 的可分辨名称 (DN)

  • object_guid - 受管 OU 的对象 GUID

  • sid - 受管用户的安全标识符

所有其他返回值均已移除,如有需要,请使用 microsoft.ad.object_info 获取额外值。

模块 win_domain_group_membership

已迁移到 microsoft.ad.group

此模块的功能已合并到 microsoft.ad.group 中。使用 members 选项 addremoveset 分别添加、移除或设置组成员。

一个变化是 win_domain_group_membership 可以使用 SERVER\member-name 格式指定查找成员的服务器。此成员格式在 microsoft.ad.group 中不受支持,但从该集合的 v1.6.0 版本开始,可以使用字典作为成员值来实现相同的功能。例如

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

- name: Add a domain user/group from another Domain in the multi-domain forest to a domain group
  microsoft.ad.group:
    name: GroupinDomainAAA
    domain_server: DomainAAA.cloud
    members:
      add:
        - name: UserInDomainBBB
          server: DomainBBB.cloud
    state: present

更多信息,请参见 DN查找属性

模块 win_domain_object_info

已迁移到 microsoft.ad.object_info

没有已知的重大更改,应该可以作为直接替换使用。

模块 win_domain_ou

已迁移到 microsoft.ad.ou

以下选项已更改

  • protected - 已重命名为 protect_from_deletion,现在无需为 state: absent 移除 OU 而取消设置。

  • recursive - 已移除,state: absent 也将递归移除对象。

  • filter - 已移除,name 对象指的是 OU 名称,如果需要重命名或移动,则可以使用 identity 通过 DistinguishedNameObjectGUID 选择 OU。

  • properties - 已移除,请使用新的 attributes 选项。

win_domain_ou 的返回值也已简化为仅返回:

  • distinguished_name - 受管 OU 的可分辨名称 (DN)

  • object_guid - 受管 OU 的对象 GUID

所有其他返回值均已移除,如有需要,请使用 microsoft.ad.object_info 获取额外值。

模块 win_domain_user

已迁移到 microsoft.ad.user

以下选项已更改

  • attributes - 格式已更改,详见 属性指南

  • delegates - 格式已更改,详见 设置列表值

  • groups - 格式已更改,详见 设置列表值

  • groups_action - 已被新的 groups 格式取代。

  • groups_missing_behaviour - 已移至 group 字典值中,名为 missing_behaviour

  • spn - 格式已更改,详见 设置列表值

  • spn_action - 已被新的 spn 格式取代。

  • state - 无查询选项 - 请改用 microsoft.ad.object_info

  • enabled - 不再默认为 true。创建没有密码的新用户将使用 enabled=false,但设置密码将使用 enabled=true

groups_actionspn_actionset 值已重命名以符合常用习惯。已移除 state=query 功能以简化模块,并推荐使用 microsoft.ad.object_info(其设计用于返回有关 AD 对象的信息)。已移除 enabled 的默认值,以便在现有 AD 对象上设置其他属性时,无需始终指定 enabled

win_domain_user 的返回值也已简化为仅返回:

  • distinguished_name - 受管用户的可分辨名称 (DN)

  • object_guid - 受管用户的对象 GUID

  • sid - 受管用户的安全标识符

所有其他返回值均已移除,如有需要,请使用 microsoft.ad.object_info 获取额外值。