Модуль community.vmware.vmware_tag – Управление тегами VMware

Примечание

Этот модуль является частью коллекции community.vmware (версия 4.7.1).

Эта коллекция может быть уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.vmware. Для использования этого модуля требуются дополнительные компоненты, см. Требования для получения подробной информации.

Для использования в playbook, укажите: community.vmware.vmware_tag.

Краткое описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

Этот модуль можно использовать для создания, удаления и обновления тегов VMware.
Функция тегов была введена в версии vSphere 6, поэтому этот модуль не поддерживается в более ранних версиях vSphere.

Требования

Указанные ниже требования необходимы на хосте, на котором выполняется этот модуль.

vSphere Automation SDK

Параметры

Параметр	Комментарии
category_id string	Следует использовать уникальный ID, генерируемый vCenter. Пользователь может получить этот уникальный ID из модуля фактов. Обязательно, если `category_name` не задан.
category_name aliases: category string добавлено в community.vmware 3.5.0	Имя категории. Обязательно, если `category_id` не задан.
hostname string	Имя хоста или IP-адрес сервера vSphere vCenter. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `VMWARE_HOST`.
password aliases: pass, pwd string	Пароль сервера vSphere vCenter. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `VMWARE_PASSWORD`.
port integer	Номер порта vSphere vCenter. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `VMWARE_PORT`. Значение по умолчанию: `443`
protocol string	Протокол подключения. Варианты: `"http"` `"https"` ← (по умолчанию)
proxy_host string	Адрес прокси-сервера, который будет принимать все HTTPS-запросы и пересылать их. Формат — имя хоста или IP-адрес. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `VMWARE_PROXY_HOST`.
proxy_port integer	Порт HTTP-прокси, который будет принимать все HTTPS-запросы и пересылать их. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `VMWARE_PROXY_PORT`.
state string	Состояние тега. Если установлено в `present` и тег не существует, то тег создается. Если установлено в `present` и тег существует, то тег обновляется. Если установлено в `absent` и тег существует, то тег удаляется. Если установлено в `absent` и тег не существует, никаких действий не предпринимается. Варианты: `"present"` ← (по умолчанию) `"absent"`
tag_description aliases: description string	Описание тега. Это требуется только если `state=present`. Этот параметр игнорируется, когда `state=absent`. Процесс обновления тега разрешает только изменение описания. Значение по умолчанию: `""`
tag_name aliases: tag, name string / required	Имя тега для управления.
username aliases: admin, user string	Имя пользователя сервера vSphere vCenter. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `VMWARE_USER`.
validate_certs boolean	Разрешает подключение, когда 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)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/vmware/vmware_tag_module.html