community.vmware.vmware_vm_vm_drs_rule 模块 – 为给定集群中的虚拟机配置 VMware DRS 关联规则

注意

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

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

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

要在 playbook 中使用它，请指定： community.vmware.vmware_vm_vm_drs_rule。

概要 

此模块可用于为给定集群中的虚拟机配置 VMware DRS 关联规则。

参数 

参数	注释
affinity_rule 布尔值	如果设置为 `true`，则 DRS 规则将是关联规则。如果设置为 `false`，则 DRS 规则将是反关联规则。仅当 `state=present` 时有效。选项 `false` `true` ← (默认)
cluster_name 字符串 / 必填	虚拟机所在的所需集群名称，用于 DRS 规则。
datacenter 字符串在 community.vmware 4.6.0 中添加	搜索给定集群的数据中心。如果未设置，我们将使用遇到的第一个具有 `cluster_name` 的集群。
drs_rule_name 字符串 / 必填	要管理的 DRS 规则的名称。
enabled 布尔值	如果设置为 `true`，则 DRS 规则将被启用。仅当 `state=present` 时有效。选项 `false` ← (默认) `true`
hostname 字符串	vSphere vCenter 或 ESXi 服务器的主机名或 IP 地址。如果任务中未指定该值，则将改用环境变量 `VMWARE_HOST` 的值。
mandatory 布尔值	如果设置为 `true`，则 DRS 规则将是强制性的。仅当 `state=present` 时有效。选项 `false` ← (默认) `true`
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`，则如果 DRS 规则不存在，则创建它。如果设置为 `present`，则 DRS 规则已存在，它将更新为给定的配置。如果设置为 `absent`，则如果 DRS 规则存在，则将其删除。选项 `"present"` ← (默认) `"absent"`
username 别名：admin、user 字符串	vSphere vCenter 或 ESXi 服务器的用户名。如果任务中未指定该值，则将改用环境变量 `VMWARE_USER` 的值。
validate_certs 布尔值	当 SSL 证书无效时允许连接。当证书不受信任时，设置为 `false`。如果任务中未指定值，则将使用环境变量`VMWARE_VALIDATE_CERTS`的值。选项 `false` `true` ← (默认)
虚拟机列表 / 元素=字符串	需要应用DRS规则的虚拟机名称列表。如果`state=present`，则此项为必填。

备注 

注意

所有模块都需要API写访问权限，因此在免费ESXi许可证上不支持。
所有变量和VMware对象名称都区分大小写。

示例 

- name: Create DRS Affinity Rule for VM-VM
  community.vmware.vmware_vm_vm_drs_rule:
    hostname: "{{ esxi_server }}"
    username: "{{ esxi_username }}"
    password: "{{ esxi_password }}"
    datacenter: "{{ datacenter }}"
    cluster_name: "{{ cluster_name }}"
    vms:
        - vm1
        - vm2
    drs_rule_name: vm1-vm2-affinity-rule-001
    enabled: true
    mandatory: true
    affinity_rule: true
  delegate_to: localhost

- name: Create DRS Anti-Affinity Rule for VM-VM
  community.vmware.vmware_vm_vm_drs_rule:
    hostname: "{{ esxi_server }}"
    username: "{{ esxi_username }}"
    password: "{{ esxi_password }}"
    datacenter: "{{ datacenter }}"
    cluster_name: "{{ cluster_name }}"
    enabled: true
    vms:
        - vm1
        - vm2
    drs_rule_name: vm1-vm2-affinity-rule-001
    mandatory: true
    affinity_rule: false
  delegate_to: localhost

- name: Delete DRS Affinity Rule for VM-VM
  community.vmware.vmware_vm_vm_drs_rule:
    hostname: "{{ esxi_server }}"
    username: "{{ esxi_username }}"
    password: "{{ esxi_password }}"
    datacenter: "{{ datacenter }}"
    cluster_name: "{{ cluster_name }}"
    drs_rule_name: vm1-vm2-affinity-rule-001
    state: absent
  delegate_to: localhost

返回值 

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

键	描述
结果字典	关于DRS虚拟机和虚拟机规则的元数据返回：当state为present时示例： `{"rule_enabled": false, "rule_key": 20, "rule_mandatory": true, "rule_name": "drs_rule_0014", "rule_uuid": "525f3bc0-253f-825a-418e-2ec93bffc9ae", "rule_vms": ["VM_65", "VM_146"]}`

作者

Abhijeet Kasurde (@Akasurde)