community.vmware.vmware_custom_attribute_manager 模块 – 为给定的 vSphere 对象管理 VMware 的自定义属性

注意

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

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

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

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

community.vmware 3.2.0 中的新增功能

概要 

此模块可用于为给定的 vSphere 对象添加、删除和更新自定义属性。

参数 

参数	注释
custom_attributes 列表 / 元素=字典 / 必需	需要管理的自定义属性的名称和值的列表。如果 `state=absent`，则自定义属性的值不是必需的，并将被忽略。
name 字符串 / 必需	属性的名称。
value 字符串	属性的值。默认值： `""`
hostname 字符串	vSphere vCenter 或 ESXi 服务器的主机名或 IP 地址。如果任务中未指定此值，则将使用环境变量 `VMWARE_HOST` 的值。
object_name 字符串 / 必需	要使用的 vSphere 对象的名称。
object_type 字符串 / 必需	与自定义属性关联的对象的类型。选项 `"集群"` `"数据中心"` `"数据存储"` `"分布式虚拟端口组"` `"分布式虚拟交换机"` `"文件夹"` `"主机系统"` `"资源池"` `"虚拟机"`
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 virtual machine custom attributes
  community.vmware.vmware_custom_attribute_manager:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    object_name: vm1
    object_type: VirtualMachine
    state: present
    custom_attributes:
      - name: MyAttribute
        value: MyValue
  delegate_to: localhost

- name: Add multiple virtual machine custom attributes
  community.vmware.vmware_custom_attribute_manager:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    object_name: vm1
    object_type: VirtualMachine
    state: present
    custom_attributes:
      - name: MyAttribute
        value: MyValue
      - name: MyAttribute2
        value: MyValue2
  delegate_to: localhost

- name: Remove virtual machine Attribute
  community.vmware.vmware_custom_attribute_manager:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    object_name: vm1
    object_type: VirtualMachine
    state: absent
    custom_attributes:
      - name: MyAttribute
  delegate_to: localhost
  register: attributes

作者

Mario Lenz (@mariolenz)