Spec-Zone.ru › Ansible

Модуль vmware.vmware_rest.vcenter_network_info – Возвращает информацию о максимум 1000 видимых (с учетом проверок прав доступа) сетях в vCenter, соответствующих Network.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_network_info.

Новое в vmware.vmware_rest 0.1.0

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

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

  • Возвращает информацию о максимум 1000 видимых (с учетом проверок прав доступа) сетях в vCenter, соответствующих Network.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).

Если не задано или пусто, сети с любым именем соответствуют фильтру.

networks

список / элементы=строка

Идентификаторы сетей, которые могут соответствовать фильтру.

Если не задано или пусто, сети с любым идентификатором соответствуют фильтру.

Когда клиенты передают значение этой структуры в качестве параметра, поле должно содержать идентификатор ресурсов, возвращаемых vmware.vmware_rest.vcenter_network_info.

session_timeout

число с плавающей точкой

добавлено в vmware.vmware_rest 2.1.0

Параметры времени ожидания для сеанса клиента.

Максимальное количество секунд для всей операции, включая установление соединения, отправку запроса и ответ.

Значение по умолчанию — 300 с.

types

алиасы: filter_types

список / элементы=строка

Типы, которые должны иметь сети, чтобы соответствовать фильтру (см. type).

Если не задано, сети с любым типом соответствуют фильтру.

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: Get the dvswitch called my-portgroup
  vmware.vmware_rest.vcenter_network_info:
    filter_types: DISTRIBUTED_PORTGROUP
    filter_names: my portrgoup
  register: my_portgroup

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

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

Ключ

Описание

value

список / элементы=строка

Получить список сетей

Возвращается: При успехе

Пример: [{"name": "VM Network", "network": "network-1016", "type": "STANDARD_PORTGROUP"}, {"name": "second_vswitch", "network": "network-1018", "type": "STANDARD_PORTGROUP"}, {"name": "dvswitch1-DVUplinks-1020", "network": "dvportgroup-1021", "type": "DISTRIBUTED_PORTGROUP"}, {"name": "my portrgoup", "network": "dvportgroup-1022", "type": "DISTRIBUTED_PORTGROUP"}]

Авторы

  • Команда 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_network_info_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API