community.vmware.vmware_guest_custom_attributes 模块 – 为给定的虚拟机管理 VMware 的自定义属性

注意

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

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

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

要在剧本中使用它，请指定： community.vmware.vmware_guest_custom_attributes。

概要 

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

参数 

参数	注释
attributes 列表 / 元素=字典	需要管理的自定义属性名称和值的列表。如果 `state=absent`，则自定义属性值不是必需的，将被忽略。默认值： `[]`
name 字符串 / 必需	属性的名称。
value 字符串	属性的值。默认值： `""`
datacenter 字符串	虚拟机所在的 vCenter 数据中心名称。
folder 字符串	查找现有客户机的绝对路径。如果提供了 `name` 并且找到多个具有相同名称的虚拟机，则此参数是必需的。
hostname 字符串	vSphere vCenter 或 ESXi 服务器的主机名或 IP 地址。如果任务中未指定此值，则将使用环境变量 `VMWARE_HOST` 的值。
moid 字符串	要管理的实例的托管对象 ID（如果已知），这只是单个 vCenter 实例内的唯一标识符。如果没有提供 `name` 或 `uuid`，则此参数是必需的。
name 字符串	要使用的虚拟机的名称。如果没有提供 `uuid` 或 `moid`，则此参数是必需的。
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"`
use_instance_uuid 布尔值	是否使用 VMware 实例 UUID 而不是 BIOS UUID。选项 `false` ← (默认) `true`
username 别名：admin，user 字符串	vSphere vCenter 或 ESXi 服务器的用户名。如果任务中未指定值，则将使用环境变量`VMWARE_USER`的值。
uuid 字符串	已知情况下，要管理的虚拟机的UUID。这是VMware的唯一标识符。如果未提供`name` 或 `moid`，则此参数为必填参数。
validate_certs 布尔值	允许在SSL证书无效时连接。当证书不受信任时，将其设置为`false`。如果任务中未指定值，则将使用环境变量`VMWARE_VALIDATE_CERTS`的值。选项 `false` `true` ← (默认)

注释 

注意

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

示例 

- name: Add virtual machine custom attributes
  community.vmware.vmware_guest_custom_attributes:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    uuid: 421e4592-c069-924d-ce20-7e7533fab926
    state: present
    attributes:
      - name: MyAttribute
        value: MyValue
  delegate_to: localhost
  register: attributes

- name: Add multiple virtual machine custom attributes
  community.vmware.vmware_guest_custom_attributes:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    uuid: 421e4592-c069-924d-ce20-7e7533fab926
    state: present
    attributes:
      - name: MyAttribute
        value: MyValue
      - name: MyAttribute2
        value: MyValue2
  delegate_to: localhost
  register: attributes

- name: Remove virtual machine Attribute
  community.vmware.vmware_guest_custom_attributes:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    uuid: 421e4592-c069-924d-ce20-7e7533fab926
    state: absent
    attributes:
      - name: MyAttribute
  delegate_to: localhost
  register: attributes

- name: Remove virtual machine Attribute using Virtual Machine MoID
  community.vmware.vmware_guest_custom_attributes:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    moid: vm-42
    state: absent
    attributes:
      - name: MyAttribute
  delegate_to: localhost
  register: attributes

返回值 

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

键	描述
custom_attributes 字典	关于虚拟机属性的元数据返回：始终示例： `{"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"}`

作者

Jimmy Conner (@cigamit)
Abhijeet Kasurde (@Akasurde)