community.vmware.vmware_guest_custom_attribute_defs 模块 – 从 VMware 管理虚拟机的自定义属性定义

注意

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

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

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

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

概要 

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

参数 

参数	注释
attribute_key 字符串	自定义属性定义的名称。这是必需参数，如果 `state=present` 或 `state=absent`。
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` 且定义不存在，则创建自定义属性定义。如果设置为 `present` 且定义存在，则不执行任何操作。如果设置为 `absent` 且定义存在，则删除自定义属性定义。如果设置为 `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 VMware Attribute Definition
  community.vmware.vmware_guest_custom_attribute_defs:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    state: present
    attribute_key: custom_attr_def_1
  delegate_to: localhost
  register: defs

- name: Remove VMware Attribute Definition
  community.vmware.vmware_guest_custom_attribute_defs:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    state: absent
    attribute_key: custom_attr_def_1
  delegate_to: localhost
  register: defs

返回值 

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

键	描述
custom_attribute_defs 列表 / 元素=字符串	所有当前属性定义的列表返回：始终示例： `["sample_5", "sample_4"]`

作者

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