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

Примечание

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

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

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

Для использования в playbook, укажите: 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 список / элементы=строка	Центры обработки данных, которые должны содержать папку, чтобы папка соответствовала фильтру. Если не задано или пусто, папки в любом центре обработки данных соответствуют фильтру. Когда клиенты передают значение этой структуры в качестве параметра, поле должно содержать идентификатор ресурсов, возвращаемых функцией vmware.vmware_rest.vcenter_datacenter_info.
folders псевдонимы: filter_folders список / элементы=строка	Идентификаторы папок, которые могут соответствовать фильтру. Если не задано или пусто, папки с любым идентификатором соответствуют фильтру. Когда клиенты передают значение этой структуры в качестве параметра, поле должно содержать идентификатор ресурсов, возвращаемых функцией vmware.vmware_rest.vcenter_folder_info.
names псевдонимы: filter_names список / элементы=строка	Имена, которые должны иметь папки, чтобы соответствовать фильтру (см. name). Если не задано или пусто, папки с любым именем соответствуют фильтру.
parent_folders список / элементы=строка	Папки, которые должны содержать папку, чтобы папка соответствовала фильтру. Если не задано или пусто, папка в любой папке соответствует фильтру. Когда клиенты передают значение этой структуры в качестве параметра, поле должно содержать идентификатор ресурсов, возвращаемых функцией vmware.vmware_rest.vcenter_folder_info.
session_timeout число с плавающей точкой добавлено в vmware.vmware_rest 2.1.0	Настройки времени ожидания для сеанса клиента. Максимальное количество секунд для всей операции, включая установление соединения, отправку запроса и ответ. Значение по умолчанию – 300 с.
type псевдонимы: filter_type строка	Перечисляемый тип type определяет тип папки сервера vCenter. Тип папки определяет, какие типы дочерних элементов могут содержаться в папке. Варианты: `"DATACENTER"` `"DATASTORE"` `"HOST"` `"NETWORK"` `"VIRTUAL_MACHINE"`
vcenter_hostname строка / обязательно	Имя хоста или IP-адрес vSphere vCenter Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `VMWARE_HOST`.
vcenter_password строка / обязательно	Пароль vSphere vCenter Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `VMWARE_PASSWORD`.
vcenter_rest_log_file строка	Вы можете использовать этот необязательный параметр для установки местоположения файла журнала. Этот файл будет использоваться для записи взаимодействия HTTP REST. Файл будет храниться на хосте, на котором запущен модуль. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `VMWARE_REST_LOG_FILE`.
vcenter_username строка / обязательно	Имя пользователя vSphere vCenter Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `VMWARE_USER`.
vcenter_validate_certs булево	Разрешает подключение, когда 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 список / элементы=строка	Создаёт список всех папок с типом VIRTUAL_MACHINE и названием vm Возвращается: При успехе Пример: `[{"folder": "group-v1002", "name": "vm", "type": "VIRTUAL_MACHINE"}]`

Авторы

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

Ссылки на сборку

© 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/vmware/vmware_rest/vcenter_folder_info_module.html