community.vmware.vmware_drs_group_manager 模块 – 管理 DRS 组中的虚拟机和主机。

注意

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

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

要安装它,请使用:ansible-galaxy collection install community.vmware

要在 playbook 中使用它,请指定:community.vmware.vmware_drs_group_manager

概要

  • 该模块可用于将虚拟机/主机添加到 DRS 组或从 DRS 组中删除它们。

参数

参数

注释

集群

别名: cluster_name

string / required

与 DRS 组关联的集群。

数据中心

别名: datacenter_name

string

数据中心的名称。

group_name

string / required

要管理的组的名称。

hostname

string

vSphere vCenter 或 ESXi 服务器的主机名或 IP 地址。

如果未在任务中指定该值,则将改用环境变量 VMWARE_HOST 的值。

hosts

list / elements=string

要在组中添加/删除的主机列表。

如果未设置 vms,则为必需。

hostsvms 是互斥参数。

密码

别名: pass, pwd

string

vSphere vCenter 或 ESXi 服务器的密码。

如果未在任务中指定该值,则将改用环境变量 VMWARE_PASSWORD 的值。

port

integer

vSphere vCenter 或 ESXi 服务器的端口号。

如果未在任务中指定该值,则将改用环境变量 VMWARE_PORT 的值。

默认值: 443

proxy_host

string

将接收所有 HTTPS 请求并转发它们的代理的地址。

格式为主机名或 IP。

如果未在任务中指定该值,则将改用环境变量 VMWARE_PROXY_HOST 的值。

proxy_port

integer

将接收所有 HTTPS 请求并转发它们的 HTTP 代理的端口。

如果未在任务中指定该值,则将改用环境变量 VMWARE_PROXY_PORT 的值。

state

string

如果设置为 present,则虚拟机/主机将被添加到给定的 DRS 组中。

如果设置为 absent,则虚拟机/主机将从给定的 DRS 组中删除。

选项

  • "present" ← (默认)

  • "absent"

用户名

别名: admin, user

string

vSphere vCenter 或 ESXi 服务器的用户名。

如果任务中未指定该值,则将使用环境变量 VMWARE_USER 的值代替。

validate_certs

布尔值

允许在 SSL 证书无效时进行连接。当证书不受信任时,设置为 false

如果任务中未指定该值,则将使用环境变量 VMWARE_VALIDATE_CERTS 的值代替。

选项

  • false

  • true ← (默认)

vms

list / elements=string

要在组中添加/删除的虚拟机列表。

如果未设置 hosts,则为必填项。

hostsvms 是互斥参数。

备注

注意

  • 所有模块都需要 API 写入权限,因此不支持免费的 ESXi 许可证。

  • 所有变量和 VMware 对象名称都区分大小写。

示例

---
- name: Add VMs in an existing DRS VM group
  delegate_to: localhost
  community.vmware.vmware_drs_group_manager:
    hostname: "{{ vcenter_hostname }}"
    password: "{{ vcenter_password }}"
    username: "{{ vcenter_username }}"
    cluster: DC0_C0
    datacenter: DC0
    group_name: TEST_VM_01
    vms:
      - DC0_C0_RP0_VM0
      - DC0_C0_RP0_VM1
    state: present

- name: Add Hosts in an existing DRS Host group
  delegate_to: localhost
  community.vmware.vmware_drs_group_manager:
    hostname: "{{ vcenter_hostname }}"
    password: "{{ vcenter_password }}"
    username: "{{ vcenter_username }}"
    cluster: DC0_C0
    datacenter: DC0
    group_name: TEST_HOST_01
    hosts:
      - DC0_C0_H0
      - DC0_C0_H1
      - DC0_C0_H2
    state: present

- name: Remove VM from an existing DRS VM group
  delegate_to: localhost
  community.vmware.vmware_drs_group_manager:
    hostname: "{{ vcenter_hostname }}"
    password: "{{ vcenter_password }}"
    username: "{{ vcenter_username }}"
    cluster: DC0_C0
    datacenter: DC0
    group_name: TEST_VM_01
    vms:
      - DC0_C0_RP0_VM0
    state: absent

- name: Remove host from an existing DRS Host group
  delegate_to: localhost
  community.vmware.vmware_drs_group_manager:
    hostname: "{{ vcenter_hostname }}"
    password: "{{ vcenter_password }}"
    username: "{{ vcenter_username }}"
    cluster: DC0_C0
    datacenter: DC0
    group_name: TEST_HOST_01
    hosts:
      - DC0_C0_H0
    state: absent

返回值

常见返回值记录在这里,以下是此模块特有的字段

描述

drs_group_member_info

字典

关于 DRS 组的元数据

返回: 始终

示例: {"Asia-Cluster1": [{"group_name": "vm_group_002", "type": "vm", "vms": ["dev-1"]}]}

msg

string

信息消息

返回: 始终

示例: "已成功更新主机组 TEST_HOST_01"

作者

  • Abhijeet Kasurde (@Akasurde)