community.vmware.vmware_category_info 模块 – 收集有关 VMware 标签类别的信息

注意

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

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

要安装它，请使用：ansible-galaxy collection install community.vmware。您需要满足更多要求才能使用此模块，请参阅 要求 了解详细信息。

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

概要

  • 此模块可用于收集有关 VMware 标签类别的信息。

  • 标签功能是在 vSphere 6 版本中引入的，因此此模块在早期版本的 vSphere 中不受支持。

要求

执行此模块的主机需要满足以下要求。

  • vSphere 自动化 SDK

参数

参数

注释

主机名

字符串

vSphere vCenter 服务器的主机名或 IP 地址。

如果未在任务中指定值，则将使用环境变量 VMWARE_HOST 的值。

password

别名：pass, pwd

字符串

vSphere vCenter 服务器的密码。

如果未在任务中指定值，则将使用环境变量 VMWARE_PASSWORD 的值。

端口

整数

vSphere vCenter 的端口号。

如果未在任务中指定值，则将使用环境变量 VMWARE_PORT 的值。

默认值：443

协议

字符串

连接到协议。

选项

  • "http"

  • "https" ← （默认）

proxy_host

字符串

将接收所有 HTTPS 请求并转发它们的代理的地址。

格式为主机名或 IP。

如果未在任务中指定值，则将使用环境变量 VMWARE_PROXY_HOST 的值。

proxy_port

整数

将接收所有 HTTPS 请求并转发它们的 HTTP 代理的端口。

如果未在任务中指定值，则将使用环境变量 VMWARE_PROXY_PORT 的值。

username

别名：admin, user

字符串

vSphere vCenter 服务器的用户名。

如果未在任务中指定值，则将使用环境变量 VMWARE_USER 的值。

validate_certs

布尔值

当 SSL 证书无效时允许连接。

当证书不受信任时设置为 false。

如果未在任务中指定值，则将使用环境变量 VMWARE_VALIDATE_CERTS 的值。

选项

  • false

  • true ← （默认）

注意

注意

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

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

示例

- name: Gather info about tag categories
  community.vmware.vmware_category_info:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
  delegate_to: localhost
  register: all_tag_category_info

- name: Gather category id from given tag category
  community.vmware.vmware_category_info:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
  delegate_to: localhost
  register: tag_category_results

- set_fact:
    category_id: "{{ item.category_id }}"
  loop: "{{ tag_category_results.tag_category_info|json_query(query) }}"
  vars:
    query: "[?category_name==`Category0001`]"
- debug: var=category_id

返回值

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

键

描述

tag_category_info

列表 / 元素=字符串

标签类别的元数据

返回：始终

示例: [{"category_associable_types": [], "category_cardinality": "MULTIPLE", "category_description": "超棒的描述", "category_id": "urn:vmomi:InventoryServiceCategory:e785088d-6981-4b1c-9fb8-1100c3e1f742:GLOBAL", "category_name": "Category0001", "category_used_by": []}, {"category_associable_types": ["VirtualMachine"], "category_cardinality": "SINGLE", "category_description": "另一个超棒的描述", "category_id": "urn:vmomi:InventoryServiceCategory:ae5b7c6c-e622-4671-9b96-76e93adb70f2:GLOBAL", "category_name": "template_tag", "category_used_by": []}]

作者

  • Abhijeet Kasurde (@Akasurde)