community.vmware.vmware_host_custom_attributes 模块 – 从 VMware 管理给定 ESXi 主机的自定义属性

注意

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

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

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

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

概要 

此模块可用于添加、删除和更新给定 ESXi 主机的自定义属性。

参数 

参数	注释
attributes 列表 / 元素=字典	需要管理的自定义属性的名称和值的列表。如果 `state=absent`，则不需要自定义属性的值，将被忽略。默认值： `[]`
name 字符串 / 必需	属性的名称。
value 字符串	属性的值。默认值： `""`
esxi_hostname 字符串 / 必需	要使用的 ESXi 主机的名称。这是一个必需的参数
hostname 字符串	vSphere vCenter 或 ESXi 服务器的主机名或 IP 地址。如果任务中未指定该值，则将使用环境变量 `VMWARE_HOST` 的值。
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"`
username 别名：admin, user 字符串	vSphere vCenter 或 ESXi 服务器的用户名。如果任务中未指定该值，则将使用环境变量 `VMWARE_USER` 的值。
validate_certs 布尔值	当 SSL 证书无效时允许连接。当证书不受信任时，设置为 `false`。如果任务中未指定该值，则将使用环境变量 `VMWARE_VALIDATE_CERTS` 的值。选择 `false` `true` ← (默认)

说明 

注意

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

示例 

- name: Add ESXi host custom attributes
  community.vmware.vmware_host_custom_attributes:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    esxi_hostname: host1
    state: present
    attributes:
      - name: MyAttribute
        value: MyValue
  delegate_to: localhost
  register: attributes

- name: Remove ESXi host Attribute
  community.vmware.vmware_host_custom_attributes:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    esxi_hostname: host1
    state: absent
    attributes:
      - name: MyAttribute
  delegate_to: localhost
  register: attributes

返回值 

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

键	描述
custom_attributes 字典	有关 ESXi 主机属性的元数据返回：已更改示例： `{"mycustom": "my_custom_value", "mycustom_2": "my_custom_value_2", "sample_1": "sample_1_value", "sample_2": "sample_2_value", "sample_3": "sample_3_value"}`

作者

Hunter Christain (@exp-hc)