community.vmware.vmware_category – Управление категориями VMware

Примечание

Этот плагин входит в состав коллекции community.vmware (версия 1.7.0).

Для его установки используйте: ansible-galaxy collection install community.vmware.

Для использования в книге задач укажите: community.vmware.vmware_category.

Обзор
Требования
Параметры
Примечания
Примеры
Значения возврата

Обзор

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

Требования

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

python >= 2.6
PyVmomi
vSphere Automation SDK

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
associable_object_types список / элементы=строка	Варианты: Все объекты Кластер Библиотека контента Центр обработки данных Хранилище данных Кластер хранилищ данных Распределенная группа портов Распределённый коммутатор Папка Хост Элемент библиотеки Сеть Сеть хоста Неявная сеть Пул ресурсов vApp Виртуальная машина	Список типов объектов, которые могут быть связаны с данной категорией.
category_cardinality строка	Варианты: множественное ← единственное	Модальность категории. Этот параметр игнорируется при обновлении существующей категории.
category_description строка	Значение по умолчанию: ""	Описание категории. Это требуется только если `state` установлено в `present`. Этот параметр игнорируется, когда `state` установлено в `absent`.
category_name строка / обязательно		Имя категории, которую нужно обработать.
hostname строка		Имя хоста или IP-адрес сервера vCenter vSphere. Если значение не указано в задаче, используется значение переменной среды `VMWARE_HOST`.
new_category_name строка		Новое имя существующей категории. Это значение используется при обновлении существующей категории.
password строка		Пароль сервера vCenter vSphere. Если значение не указано в задаче, используется значение переменной среды `VMWARE_PASSWORD`. псевдонимы: pass, pwd
port целое число	Значение по умолчанию: 443	Номер порта vCenter vSphere. Если значение не указано в задаче, используется значение переменной среды `VMWARE_PORT`.
protocol строка	Варианты: http https ←	Протокол подключения.
state строка	Варианты: present ← absent	Состояние категории. Если установлено в `present`, и категория не существует, то категория создаётся. Если установлено в `present`, и категория существует, то категория обновляется. Если установлено в `absent`, и категория существует, то категория удаляется. Если установлено в `absent`, и категория не существует, никаких действий не выполняется. Процесс обновления категории позволяет изменить только имя и описание.
username строка		Имя пользователя сервера vCenter vSphere. Если значение не указано в задаче, используется значение переменной среды `VMWARE_USER`. псевдонимы: admin, user
validate_certs логическое	Варианты: no yes ←	Разрешает подключение, когда сертификаты SSL недействительны. Установите в `False`, когда сертификаты не надёжны. Если значение не указано в задаче, используется значение переменной среды `VMWARE_VALIDATE_CERTS`.

Примечания

Примечание

Тестировалось на vSphere 6.5

Примеры

- name: Create a category
  community.vmware.vmware_category:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    category_name: Sample_Cat_0001
    category_description: Sample Description
    category_cardinality: 'multiple'
    state: present

- name: Rename category
  community.vmware.vmware_category:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    category_name: Sample_Category_0001
    new_category_name: Sample_Category_0002
    state: present

- name: Update category description
  community.vmware.vmware_category:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    category_name: Sample_Category_0001
    category_description: Some fancy description
    state: present

- name: Delete category
  community.vmware.vmware_category:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    category_name: Sample_Category_0002
    state: absent

- name: Create category with 2 associable object types
  community.vmware.vmware_category:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    category_name: 'Sample_Category_0003'
    category_description: 'sample description'
    associable_object_types:
    - Datastore
    - Cluster
    state: present

Значения возврата

Общие значения возврата описаны здесь, следующие поля уникальны для этого модуля:

Ключ	Возвращённое значение	Описание
category_results словарь	при успехе	Словарь метаданных категории Пример: {'category_id': 'urn:vmomi:InventoryServiceCategory:d7120bda-9fa5-4f92-9d71-aa1acff2e5a8:GLOBAL', 'msg': 'Категория NewCat_0001 обновлена.'}

Авторы

Abhijeet Kasurde (@Akasurde)

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