Модуль community.vmware.vmware_category — Управление категориями VMware

Примечание

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

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

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

Чтобы использовать его в книге задач, укажите: community.vmware.vmware_category.

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

Обзор

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

Требования

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

vSphere Automation SDK

END_OF_DOCUMENT_MARKER

Параметры

Параметр	Комментарии
associable_object_types list / elements=string	Список типов объектов, которые могут быть связаны с данной категорией. Варианты: `"All objects"` `"Cluster"` `"Content Library"` `"Datacenter"` `"Datastore"` `"Datastore Cluster"` `"Distributed Port Group"` `"Distributed Switch"` `"Folder"` `"Host"` `"Library item"` `"Network"` `"Host Network"` `"Opaque Network"` `"Resource Pool"` `"vApp"` `"Virtual Machine"`
category_cardinality string	Множественность категории. Этот параметр игнорируется при обновлении существующей категории. `single` означает, что объекту может быть назначен только один из тегов в этой категории. Например, если `category_name=Operating System`, то различные теги этой категории будут «Windows», «Linux» и так далее. В этом случае объекту VM может быть назначен только один из этих тегов, и поэтому множественность связанной категории здесь равна `single`. `multiple` означает, что объекту может быть назначено несколько тегов в этой категории. Например, если `category_name=Server`, то различные теги этой категории будут «AppServer», «DatabaseServer» и так далее. В этом случае объекту VM может быть назначено более одного из указанных выше тегов, и поэтому множественность связанной категории здесь равна `multiple`. Варианты: `"multiple"` ← (по умолчанию) `"single"`
category_description string	Описание категории. Это обязательное поле, если `state=present`. Этот параметр игнорируется, когда `state=absent`. Значение по умолчанию: `""`
category_name string / required	Имя категории для управления.
hostname string	Имя хоста или IP-адрес сервера vSphere vCenter. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `VMWARE_HOST`.
new_category_name string	Новое имя для существующей категории. Это значение используется при обновлении существующей категории.
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"`
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 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": "Category NewCat_0001 updated."}`

Авторы

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