Модуль community.vmware.vmware_dvs_portgroup_find — поиск порт-групп в среде VMware

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install community.vmware.

Чтобы использовать её в плейбуке, укажите: community.vmware.vmware_dvs_portgroup_find.

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

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

Поиск порт-групп по различным критериям, например по распределённому vSwitch, идентификатору VLAN или строке в имени.

Параметры

Параметр	Комментарии
dvswitch string	Имя распределённого vSwitch для поиска.
hostname string	Имя хоста или IP-адрес сервера vSphere vCenter. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `VMWARE_HOST`.
name string	Строка для поиска в имени порт-группы. Простая проверка вхождения с использованием операции `in` Python.
password псевдонимы: pass, pwd string	Пароль сервера vSphere vCenter. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `VMWARE_PASSWORD`.
port integer	Номер порта сервера vSphere vCenter. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `VMWARE_PORT`. По умолчанию: `443`
proxy_host string	Адрес прокси-сервера, который будет получать и перенаправлять все HTTPS-запросы. Формат: имя хоста или IP-адрес. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `VMWARE_PROXY_HOST`.
proxy_port integer	Порт HTTP-прокси, который будет получать и перенаправлять все HTTPS-запросы. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `VMWARE_PROXY_PORT`.
show_uplink boolean	Показывать или скрывать порт-группы uplink. Применимо только при указании `vlanid`. Варианты: `false` ← (по умолчанию) `true`
username псевдонимы: admin, user string	Имя пользователя сервера vSphere vCenter. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `VMWARE_USER`.
validate_certs boolean	Разрешает подключение, если SSL-сертификаты недействительны. Установите значение `false`, если сертификаты не являются доверенными. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `VMWARE_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)
vlanid integer	Идентификатор VLAN может быть любым числом от 1 до 4094. При поиске по этому критерию проверяются диапазоны VLAN для поиска возможных совпадений.

Примечания

Примечание

Всем модулям требуется доступ на запись через API, поэтому они не поддерживаются при использовании бесплатной лицензии ESXi.
Все переменные и имена объектов VMware чувствительны к регистру.
Модули могут использовать библиотеку Python ‘requests’, которая по умолчанию не применяет системное хранилище сертификатов. Можно указать хранилище сертификатов, задав переменную окружения REQUESTS_CA_BUNDLE. Обратите внимание: в некоторых случаях наличие этой переменной может привести к тому, что значение ‘false’ для параметра ‘validate_certs’ будет проигнорировано. Пример: ‘export REQUESTS_CA_BUNDLE=/path/to/your/ca_bundle.pem’

Примеры

- name: Get all portgroups in dvswitch vDS
  community.vmware.vmware_dvs_portgroup_find:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    dvswitch: 'vDS'
  delegate_to: localhost

- name: Confirm if vlan 15 is present
  community.vmware.vmware_dvs_portgroup_find:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    vlanid: '15'
  delegate_to: localhost

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

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

Ключ	Описание
dvs_portgroups list / elements=string	основные сведения о найденных порт-группах Возвращается: при успехе Пример: `[{"dvswitch": "vDS", "name": "N-51", "pvlan": true, "trunk": true, "vlan_id": "0"}]`

Авторы

David Martinez (@dx0xm)

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

© 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/community/vmware/vmware_dvs_portgroup_find_module.html