Модуль vmware.vmware_rest.vcenter_folder_info – возвращает информацию не более чем о 1000 видимых (с учётом проверок разрешений) папках в vCenter, соответствующих Folder.FilterSpec.

Примечание

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

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

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

Чтобы использовать модуль в плейбуке, укажите: vmware.vmware_rest.vcenter_folder_info.

Новое в vmware.vmware_rest 0.1.0

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

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

Возвращает информацию не более чем о 1000 видимых (с учётом проверок разрешений) папках в vCenter, соответствующих Folder.FilterSpec.

Требования

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

vSphere 7.0.3 или более поздней версии
python >= 3.6
aiohttp

Параметры

Параметр	Комментарии
datacenters псевдонимы: filter_datacenters list / элементы=string	Центры обработки данных, в которых должна находиться папка, чтобы соответствовать фильтру. Если параметр не задан или пуст, фильтру соответствуют папки в любых центрах обработки данных. Если клиенты передают значение этой структуры в качестве параметра, поле должно содержать идентификатор ресурса, возвращённый модулем vmware.vmware_rest.vcenter_datacenter_info.
folders псевдонимы: filter_folders list / элементы=string	Идентификаторы папок, которые могут соответствовать фильтру. Если параметр не задан или пуст, фильтру соответствуют папки с любыми идентификаторами. Если клиенты передают значение этой структуры в качестве параметра, поле должно содержать идентификатор ресурса, возвращённый модулем vmware.vmware_rest.vcenter_folder_info.
names псевдонимы: filter_names list / элементы=string	Имена, которым должны соответствовать папки (см. name). Если параметр не задан или пуст, фильтру соответствуют папки с любыми именами.
parent_folders list / элементы=string	Папки, в которых должна находиться папка, чтобы соответствовать фильтру. Если параметр не задан или пуст, фильтру соответствуют папки, находящиеся в любых папках. Если клиенты передают значение этой структуры в качестве параметра, поле должно содержать идентификатор ресурса, возвращённый модулем vmware.vmware_rest.vcenter_folder_info.
session_timeout float добавлено в vmware.vmware_rest 2.1.0	Настройки тайм-аута клиентского сеанса. Максимальное время в секундах для всей операции, включая установление соединения, отправку запроса и получение ответа. Значение по умолчанию — 300 с.
type псевдонимы: filter_type string	Перечислимый тип type определяет тип папки сервера vCenter. Тип папки определяет, какие виды дочерних объектов могут в ней содержаться. Варианты: `"DATACENTER"` `"DATASTORE"` `"HOST"` `"NETWORK"` `"VIRTUAL_MACHINE"`
vcenter_hostname string / обязательный	Имя хоста или IP-адрес vSphere vCenter Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `VMWARE_HOST`.
vcenter_password string / обязательный	Пароль vSphere vCenter Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `VMWARE_PASSWORD`.
vcenter_rest_log_file string	С помощью этого необязательного параметра можно указать расположение файла журнала. Этот файл будет использоваться для записи взаимодействия по HTTP REST. Файл будет сохранён на хосте, на котором выполняется модуль. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `VMWARE_REST_LOG_FILE`.
vcenter_username string / обязательный	Имя пользователя vSphere vCenter Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `VMWARE_USER`.
vcenter_validate_certs boolean	Разрешает подключение, если SSL-сертификаты недействительны. Установите значение `false`, если сертификаты не являются доверенными. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `VMWARE_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Проверено на vSphere 7.0.3

Примеры

- name: Build a list of all the folders
  vmware.vmware_rest.vcenter_folder_info:
  register: my_folders

- name: Build a list of all the folders with the type VIRTUAL_MACHINE and called vm
  vmware.vmware_rest.vcenter_folder_info:
    filter_type: VIRTUAL_MACHINE
    filter_names:
    - vm
  register: my_folders

Возвращаемые значения

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

Ключ	Описание
value list / элементы=string	Создаёт список всех папок типа VIRTUAL_MACHINE с именем vm Возвращается: при успешном выполнении Пример: `[{"folder": "group-v1002", "name": "vm", "type": "VIRTUAL_MACHINE"}]`

Авторы

Команда Ansible Cloud (@ansible-collections)

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

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