community.vmware.vmware_dvswitch_info – Сбор информации о конфигурациях dvswitch
Примечание
Этот плагин входит в коллекцию community.vmware (версия 1.7.0).
Для его установки используйте: ansible-galaxy collection install community.vmware.
Чтобы использовать его в книге задач, укажите: community.vmware.vmware_dvswitch_info.
Обзор
- Этот модуль может использоваться для сбора информации о конфигурациях dvswitch.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- python >= 2.7
- PyVmomi
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| folder строка | Укажите расположение папки dvswitch для сбора информации. Примеры: folder: /datacenter1/network folder: datacenter1/network folder: /datacenter1/network/folder1 folder: datacenter1/network/folder1 folder: /folder1/datacenter1/network folder: folder1/datacenter1/network folder: /folder1/datacenter1/network/folder2 | |
| hostname строка | Имя хоста или IP-адрес сервера vCenter или ESXi vSphere. Если значение не указано в задаче, будет использовано значение переменной среды VMWARE_HOST. Поддержка переменных среды добавлена в Ansible 2.6. | |
| password строка | Пароль сервера vCenter или ESXi vSphere. Если значение не указано в задаче, будет использовано значение переменной среды VMWARE_PASSWORD. Поддержка переменных среды добавлена в Ansible 2.6. псевдонимы: pass, pwd | |
| port целое число | Значение по умолчанию: 443 | Номер порта сервера vCenter или ESXi vSphere. Если значение не указано в задаче, будет использовано значение переменной среды VMWARE_PORT. Поддержка переменных среды добавлена в Ansible 2.6. |
| properties список / элементы=строка | Укажите свойства, которые необходимо получить. Если не указано, все свойства извлекаются (рекурсивно). Результаты возвращаются в структуре, идентичной структуре API vsphere. Пример: properties: [ "summary.name", "summary.numPorts", "config.maxMtu", "overallStatus" ] Только при schema равном vsphere. | |
| proxy_host строка | Адрес прокси-сервера, который будет получать все запросы HTTPS и пересылать их. Формат — имя хоста или IP-адрес. Если значение не указано в задаче, будет использовано значение переменной среды VMWARE_PROXY_HOST. Эта функция зависит от версии pyvmomi, большей, чем v6.7.1.2018.12 | |
| proxy_port целое число | Порт HTTP-прокси-сервера, который будет получать все запросы HTTPS и пересылать их. Если значение не указано в задаче, будет использовано значение переменной среды VMWARE_PROXY_PORT. | |
| schema строка |
| Укажите желаемый формат вывода. Формат вывода 'summary' — это устаревший формат вывода модуля. Формат вывода 'vsphere' — это определение класса API vSphere, которое требует pyvmomi>6.7.1 |
| switch_name строка | Имя dvswitch, которое нужно найти. Если switch_name не указано, собирается информация обо всех dvswitch.псевдонимы: switch, dvswitch | |
| username строка | Имя пользователя сервера vCenter или ESXi vSphere. Если значение не указано в задаче, будет использовано значение переменной среды VMWARE_USER. Поддержка переменных среды добавлена в Ansible 2.6. псевдонимы: admin, user | |
| validate_certs булево |
| Разрешает подключение, когда сертификаты SSL недействительны. Установите значение false при недоверенных сертификатах.Если значение не указано в задаче, будет использовано значение переменной среды VMWARE_VALIDATE_CERTS. Поддержка переменных среды добавлена в Ansible 2.6. Если установлено значение true, убедитесь, что на данном компьютере установлен Python >= 2.7.9. |
Примеры
- name: Gather all registered dvswitch
community.vmware.vmware_dvswitch_info:
hostname: "{{ vcenter_hostname }}"
username: "{{ vcenter_username }}"
password: "{{ vcenter_password }}"
delegate_to: localhost
register: dvswitch_info
- name: Gather info about specific dvswitch
community.vmware.vmware_dvswitch_info:
hostname: "{{ vcenter_hostname }}"
username: "{{ vcenter_username }}"
password: "{{ vcenter_password }}"
switch_name: DVSwitch01
delegate_to: localhost
register: dvswitch_info
- name: Gather info from folder about specific dvswitch
community.vmware.vmware_dvswitch_info:
hostname: "{{ vcenter_hostname }}"
username: "{{ vcenter_username }}"
password: "{{ vcenter_password }}"
folder: /datacenter1/network/F01
switch_name: DVSwitch02
delegate_to: localhost
register: dvswitch_info
- name: Gather some info from a dvswitch using the vSphere API output schema
community.vmware.vmware_dvswitch_info:
hostname: "{{ vcenter_hostname }}"
username: "{{ vcenter_username }}"
password: "{{ vcenter_password }}"
schema: vsphere
properties:
- summary.name
- summary.numPorts
- config.maxMtu
- overallStatus
switch_name: DVSwitch01
register: dvswitch_info
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| distributed_virtual_switches список / элементы=строка | всегда | Список словарей dvswitch и их информации Пример: [{'configure': {'folder': 'network', 'hosts': ['esxi-test-02.local', 'esxi-test-01.local'], 'settings': {'healthCheck': {'TeamingHealthCheckConfig': False, 'VlanMtuHealthCheckConfig': False}, 'netflow': {'activeFlowTimeout': 60, 'collectorIpAddress': '', 'collectorPort': 0, 'idleFlowTimeout': 15, 'internalFlowsOnly': False, 'observationDomainId': 0, 'samplingRate': 0, 'switchIpAddress': None}, 'privateVlan': [], 'properties': {'administratorContact': {'contact': None, 'name': None}, 'advanced': {'maxMtu': 1500, 'multicastFilteringMode': 'legacyFiltering'}, 'discoveryProtocol': {'operation': 'listen', 'protocol': 'cdp'}, 'general': {'ioControl': True, 'name': 'DVSwitch01', 'numPorts': 10, 'numUplinks': 1, 'vendor': 'VMware, Inc.', 'version': '6.6.0'}}}}, 'uuid': '50 30 99 9c a7 60 8a 4f-05 9f e7 b5 da df 8f 17'}] |
Авторы
- sky-joker (@sky-joker)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/vmware/vmware_dvswitch_info_module.html
