community.vmware.vmware_drs_group 模块 – 在给定集群中创建虚拟机/主机组。

注意

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

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

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

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

概要

  • 此模块可用于在给定集群中创建虚拟机/主机组。如果设置了 vms,则创建虚拟机组。如果设置了 hosts,则创建主机组。

参数

参数

注释

cluster_name

字符串 / 必需

要创建虚拟机/主机组的集群。

datacenter

别名:datacenter_name

字符串

要搜索给定集群的数据中心。如果未设置,我们将使用遇到的第一个具有 cluster_name 的集群。

group_name

字符串 / 必需

要创建或删除的组的名称。

hostname

字符串

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

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

hosts

列表 / 元素=字符串

要在组中创建的主机列表。

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

hostsvms 是互斥的参数。

password

别名:pass、pwd

字符串

vSphere vCenter 或 ESXi 服务器的密码。

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

port

整数

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

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

默认值: 443

proxy_host

字符串

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

格式为主机名或 IP。

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

proxy_port

整数

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

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

state

字符串

如果设置为 present 并且该组不存在,则将创建该组。

如果设置为 absent 并且该组存在,则将删除该组。

选项

  • "present" ← (默认)

  • "absent"

用户名

别名: admin, user

字符串

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

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

validate_certs

布尔值

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

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

选项

  • false

  • true ← (默认)

vms

列表 / 元素=字符串

要在组中创建的虚拟机列表。

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

hostsvms 是互斥的参数。

注释

注意

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

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

示例

---
- name: "Create DRS VM group"
  delegate_to: localhost
  community.vmware.vmware_drs_group:
    hostname: "{{ vcenter_hostname }}"
    password: "{{ vcenter_password }}"
    username: "{{ vcenter_username }}"
    cluster_name: DC0_C0
    datacenter_name: DC0
    group_name: TEST_VM_01
    vms:
      - DC0_C0_RP0_VM0
      - DC0_C0_RP0_VM1
    state: present

- name: "Create DRS Host group"
  delegate_to: localhost
  community.vmware.vmware_drs_group:
    hostname: "{{ vcenter_hostname }}"
    password: "{{ vcenter_password }}"
    username: "{{ vcenter_username }}"
    cluster_name: DC0_C0
    datacenter_name: DC0
    group_name: TEST_HOST_01
    hosts:
      - DC0_C0_H0
      - DC0_C0_H1
      - DC0_C0_H2
    state: present

- name: "Delete DRS Host group"
  delegate_to: localhost
  community.vmware.vmware_drs_group:
    hostname: "{{ vcenter_hostname }}"
    password: "{{ vcenter_password }}"
    username: "{{ vcenter_username }}"
    cluster_name: DC0_C0
    datacenter_name: DC0
    group_name: TEST_HOST_01
    state: absent

返回值

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

描述

drs_group_facts

字典

有关创建的 DRS 组的元数据

返回: 总是

示例: {"drs_group_facts": {"changed": true, "failed": false, "msg": "成功创建主机组TEST_HOST_01", "result": {"DC0_C0": [{"group_name": "TEST_HOST_01", "hosts": ["DC0_C0_H0", "DC0_C0_H1", "DC0_C0_H2"], "type": "host"}]}}}

作者

  • Karsten Kaj Jakobsen (@karstenjakobsen)