Модуль community.vmware.vmware_category_info — Сбор информации о категориях тегов VMware

Примечание

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

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

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

Чтобы использовать его в плейбуке, укажите: community.vmware.vmware_category_info.

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

Описание

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

Требования

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

vSphere Automation SDK

Параметры

Параметр	Комментарии
hostname строка	Имя хоста или IP-адрес сервера vCenter vSphere. Если значение не указано в задаче, будет использовано значение переменной среды `VMWARE_HOST`.
password псевдонимы: pass, pwd строка	Пароль сервера vCenter vSphere. Если значение не указано в задаче, будет использовано значение переменной среды `VMWARE_PASSWORD`.
port целое число	Номер порта vCenter vSphere. Если значение не указано в задаче, будет использовано значение переменной среды `VMWARE_PORT`. По умолчанию: `443`
protocol строка	Протокол подключения. Варианты: `"http"` `"https"` ← (по умолчанию)
...	...

Примечания

Примечание

Все модули требуют доступа к 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": "awesome 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": "another awesome description", "category_id": "urn:vmomi:InventoryServiceCategory:ae5b7c6c-e622-4671-9b96-76e93adb70f2:GLOBAL", "category_name": "template_tag", "category_used_by": []}]

Ключ

Описание

tag_category_info

список / элементы=строка

Метаданные категорий тегов

Возвращается: всегда

Пример: [{"category_associable_types": [], "category_cardinality": "MULTIPLE", "category_description": "awesome 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": "another awesome description", "category_id": "urn:vmomi:InventoryServiceCategory:ae5b7c6c-e622-4671-9b96-76e93adb70f2:GLOBAL", "category_name": "template_tag", "category_used_by": []}]

Авторы

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_category_info_module.html