community.vmware.vmware_object_custom_attributes_info 模块 – 收集对象的自定义属性

注意

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

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

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

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

概要

• 此模块可以收集对象的自定义属性。

参数

参数	注释
hostname 字符串	vSphere vCenter 或 ESXi 服务器的主机名或 IP 地址。 如果未在任务中指定该值，则将使用环境变量 VMWARE_HOST 的值。
moid 字符串	要获取的实例的托管对象 ID（如果已知），这仅在单个 vCenter 实例中是唯一的标识符。 如果未提供 object_name，则这是必需的。
object_name 别名：name 字符串	要使用的对象的名称。
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 的值。
username 别名：admin, user 字符串	vSphere vCenter 或 ESXi 服务器的用户名。 如果未在任务中指定该值，则将使用环境变量 VMWARE_USER 的值。
validate_certs 布尔值	当 SSL 证书无效时允许连接。当证书不受信任时设置为 false。 如果任务中未指定该值，则将使用环境变量 VMWARE_VALIDATE_CERTS 的值。 选择 false true ← (默认)

备注

注意

• 支持 check_mode。

• 所有模块都需要 API 写入权限，因此在免费的 ESXi 许可证上不受支持。

• 所有变量和 VMware 对象名称都区分大小写。

示例

- name: Gather custom attributes of a virtual machine
  community.vmware.vmware_object_custom_attributes_info:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    validate_certs: false
    object_type: VirtualMachine
    object_name: "{{ object_name }}"
  register: vm_attributes

- name: Gather custom attributes of a virtual machine with moid
  community.vmware.vmware_object_custom_attributes_info:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    validate_certs: false
    object_type: VirtualMachine
    moid: "{{ moid }}"
  register: vm_attributes

返回值

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

键

描述

custom_attributes 列表 / 元素=字符串

对象的自定义属性列表。 返回： 始终 示例： ["[\n    {\n        \"attribute\": \"example01\"", "\n        \"key\": 132", "\n        \"type\": \"VirtualMachine\"", "\n        \"value\": \"10\"\n    }", "\n    {\n        \"attribute\": \"example02\"", "\n        \"key\": 131", "\n        \"type\": \"VirtualMachine\"", "\n        \"value\": \"20\"\n    }", "\n    {\n        \"attribute\": \"example03\"", "\n        \"key\": 130", "\n        \"type\": \"VirtualMachine\"", "\n        \"value\": null\n    }\n]"]

作者

• sky-joker (@sky-joker)

集合链接

• 问题跟踪器
• 主页
• 存储库（源代码）