community.vmware.vmware_tag 模块 – 管理 VMware 标签

注意

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

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

要安装它，请使用： ansible-galaxy collection install community.vmware。您需要其他要求才能使用此模块，请参阅要求获取详细信息。

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

概要 

此模块可用于创建/删除/更新 VMware 标签。
标签功能在 vSphere 6 版本中引入，因此此模块在早期版本的 vSphere 中不受支持。

要求 

在执行此模块的主机上需要以下要求。

vSphere 自动化 SDK

参数 

参数	注释
category_id 字符串	应使用 vCenter 生成的唯一 ID。用户可以从 facts 模块获取此唯一 ID。如果未设置 `category_name`，则需要此参数。
category_name 别名：category 字符串在 community.vmware 3.5.0 中添加	类别的名称。如果未设置 `category_id`，则需要此参数。
hostname 字符串	vSphere vCenter 服务器的主机名或 IP 地址。如果任务中未指定此值，则将使用环境变量 `VMWARE_HOST` 的值。
password 别名：pass, pwd 字符串	vSphere vCenter 服务器的密码。如果任务中未指定此值，则将使用环境变量 `VMWARE_PASSWORD` 的值。
port 整数	vSphere vCenter 的端口号。如果任务中未指定此值，则将使用环境变量 `VMWARE_PORT` 的值。默认值： `443`
protocol 字符串	连接协议。选项 `"http"` `"https"` ← (默认)
proxy_host 字符串	将接收所有 HTTPS 请求并转发它们的代理的地址。格式为主机名或 IP。如果任务中未指定此值，则将使用环境变量 `VMWARE_PROXY_HOST` 的值。
proxy_port 整数	将接收所有 HTTPS 请求并转发它们的 HTTP 代理的端口。如果任务中未指定此值，则将使用环境变量 `VMWARE_PROXY_PORT` 的值。
state 字符串	标签的状态。如果设置为 `present` 且标签不存在，则创建标签。如果设置为 `present` 且标签存在，则更新标签。如果设置为 `absent` 且标签存在，则删除标签。如果设置为 `absent` 且标签不存在，则不执行任何操作。选项 `"present"` ← (默认) `"absent"`
tag_description 别名：description 字符串	标签描述。仅当 `state=present` 时才需要此参数。当`state=absent`时，此参数将被忽略。更新标签的过程只允许更改描述。默认值： `""`
tag_name 别名：tag, name 字符串 / 必填	要管理的标签名称。
username 别名：admin, user 字符串	vSphere vCenter服务器的用户名。如果任务中未指定此值，则将使用环境变量`VMWARE_USER`的值。
validate_certs 布尔值	允许在SSL证书无效时连接。当证书不受信任时，将其设置为`false`。如果任务中未指定此值，则将使用环境变量`VMWARE_VALIDATE_CERTS`的值。选项 `false` `true` ← (默认)

备注 

注意

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

示例 

- name: Create a tag
  community.vmware.vmware_tag:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    category_id: 'urn:vmomi:InventoryServiceCategory:e785088d-6981-4b1c-9fb8-1100c3e1f742:GLOBAL'
    tag_name: Sample_Tag_0002
    tag_description: Sample Description
    state: present
  delegate_to: localhost

- name: Update tag description
  community.vmware.vmware_tag:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    tag_name: Sample_Tag_0002
    tag_description: Some fancy description
    state: present
  delegate_to: localhost

- name: Delete tag
  community.vmware.vmware_tag:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    tag_name: Sample_Tag_0002
    state: absent
  delegate_to: localhost

返回值 

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

键	描述
tag_status 字典	标签元数据的字典返回：成功时示例： `{"msg": "Tag 'Sample_Tag_0002' created.", "tag_id": "urn:vmomi:InventoryServiceTag:bff91819-f529-43c9-80ca-1c9dfda09441:GLOBAL"}`

作者

Abhijeet Kasurde (@Akasurde)