Модуль vmware.vmware_rest.vcenter_datacenter_info — получает сведения о дата-центре, соответствующем параметру datacenter.
Примечание
Этот модуль входит в коллекцию vmware.vmware_rest (версия 4.10.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install vmware.vmware_rest. Для использования этого модуля необходимы дополнительные требования. Подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: vmware.vmware_rest.vcenter_datacenter_info.
Добавлено в vmware.vmware_rest 0.1.0
Краткое описание
- Получает сведения о дата-центре, соответствующем параметру datacenter.
Требования
На хосте, выполняющем этот модуль, должны быть установлены следующие компоненты.
- vSphere 7.0.3 или более поздней версии
- python >= 3.6
- aiohttp
Параметры
Параметр | Комментарии |
|---|---|
datacenter строка | Идентификатор дата-центра. Значение параметра должно быть идентификатором ресурса, возвращаемого модулем vmware.vmware_rest.vcenter_datacenter_info. Обязателен при state=[‘get’] |
datacenters псевдонимы: filter_datacenters список / элементы=строка | Идентификаторы дата-центров, соответствующих фильтру. Если значение не задано или список пуст, фильтру соответствуют дата-центры с любым идентификатором. При передаче клиентами значения этой структуры в качестве параметра поле должно содержать идентификатор ресурса, возвращаемого модулем vmware.vmware_rest.vcenter_datacenter_info. |
folders псевдонимы: filter_folders список / элементы=строка | Папки, в которых должны находиться дата-центры, соответствующие фильтру. Если значение не задано или список пуст, фильтру соответствуют дата-центры из любой папки. При передаче клиентами значения этой структуры в качестве параметра поле должно содержать идентификатор ресурса, возвращаемого модулем vmware.vmware_rest.vcenter_folder_info. |
names псевдонимы: filter_names список / элементы=строка | Названия, которым должны соответствовать дата-центры (см. name). Если значение не задано или список пуст, фильтру соответствуют дата-центры с любым названием. |
session_timeout число с плавающей запятой добавлено в vmware.vmware_rest 2.1.0 | Настройки времени ожидания для клиентского сеанса. Максимальное количество секунд для всей операции, включая установление соединения, отправку запроса и получение ответа. Значение по умолчанию — 300 с. |
vcenter_hostname строка / обязательный | Имя хоста или IP-адрес vSphere vCenter. Если значение не указано в задаче, вместо него будет использовано значение переменной среды |
vcenter_password строка / обязательный | Пароль vSphere vCenter. Если значение не указано в задаче, вместо него будет использовано значение переменной среды |
vcenter_rest_log_file строка | Этот необязательный параметр позволяет указать расположение файла журнала. Этот файл будет использоваться для записи взаимодействия по HTTP REST. Файл будет сохранён на хосте, на котором выполняется модуль. Если значение не указано в задаче, вместо него будет использовано значение переменной среды |
vcenter_username строка / обязательный | Имя пользователя vSphere vCenter. Если значение не указано в задаче, вместо него будет использовано значение переменной среды |
vcenter_validate_certs логическое значение | Разрешает подключение при недействительных сертификатах SSL. Если сертификаты не являются доверенными, задайте значение Если значение не указано в задаче, вместо него будет использовано значение переменной среды Варианты:
|
Примечания
Примечание
- Проверено на vSphere 7.0.3
Примеры
- name: Get a list of all the datacenters register: existing_datacenters vmware.vmware_rest.vcenter_datacenter_info: - name: collect a list of the datacenters vmware.vmware_rest.vcenter_datacenter_info: register: my_datacenters
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
value список / элементы=строка | Список дата-центров. Возвращается: при успешном выполнении Пример: |
Ссылки на коллекцию
© 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_datacenter_info_module.html