Spec-Zone.ru › Ansible

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

Добавлено в vmware.vmware_rest 0.1.0

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

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

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

Требования

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

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

Параметры

Параметр

Комментарии

datacenters

псевдонимы: filter_datacenters

list / elements=string

ЦОДы, в которых должна находиться сеть, чтобы она соответствовала фильтру.

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

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

folders

псевдонимы: filter_folders

list / elements=string

Папки, в которых должна находиться сеть, чтобы она соответствовала фильтру.

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

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

names

псевдонимы: filter_names

list / elements=string

Названия, которым должны соответствовать сети (см. name).

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

networks

list / elements=string

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

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

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

session_timeout

float

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

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

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

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

types

псевдонимы: filter_types

list / elements=string

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

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

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

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

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

Ключ

Описание

value

list / elements=string

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

Возвращается: При успешном выполнении

Пример: [{"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–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_network_info_module.html

Spec-Zone.ru

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