Spec-Zone.ru › Ansible

модуль community.vmware.vmware_dvswitch — создание или удаление распределённого коммутатора

Примечание

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

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

Для установки используйте: ansible-galaxy collection install community.vmware.

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

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

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

  • Этот модуль можно использовать для создания или удаления распределённого коммутатора.

Параметры

Параметр

Комментарии

contact

dictionary

Словарь для настройки имени и описания контактного лица администратора распределённого коммутатора.

description

string

Описание или другие сведения.

name

string

Имя администратора.

datacenter_name

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

string

Имя центра обработки данных, в котором будет находиться распределённый коммутатор.

Обязательный параметр, если не указан folder.

Взаимоисключающий параметр с folder.

description

string

Описание распределённого коммутатора.

discovery_operation

string

Выберите операцию обнаружения.

Обязательный параметр, если state=present.

Варианты:

  • "both"
  • "advertise"
  • "listen" ← (по умолчанию)

discovery_proto

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

string

Протокол обнаружения каналов между Cisco и протоколом обнаружения канального уровня.

Обязательный параметр, если state=present.

cdp: использовать протокол обнаружения Cisco (CDP).

lldp: использовать протокол обнаружения канального уровня (LLDP).

disabled: не использовать протокол обнаружения.

Варианты:

  • "cdp" ← (по умолчанию)
  • "lldp"
  • "disabled"

folder

string

Папка назначения: абсолютный путь, в котором будет размещён dvswitch.

Путь к папке должен включать центр обработки данных.

Обязательный параметр, если не указан datacenter.

Взаимоисключающий параметр с datacenter.

Примеры:

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

health_check

dictionary

Словарь для настройки проверки работоспособности распределённого коммутатора.

По умолчанию: {"teaming_failover": false, "teaming_failover_interval": 0, "vlan_mtu": false, "vlan_mtu_interval": 0}

teaming_failover

boolean

Проверка работоспособности объединения сетевых адаптеров и переключения при сбое.

Варианты:

  • false ← (по умолчанию)
  • true

teaming_failover_interval

integer

Интервал проверки работоспособности объединения сетевых адаптеров и переключения при сбое (в минутах).

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

По умолчанию: 0

vlan_mtu

boolean

Проверка работоспособности VLAN и MTU.

Варианты:

  • false ← (по умолчанию)
  • true

vlan_mtu_interval

integer

Интервал проверки работоспособности VLAN и MTU (в минутах).

Если проверка работоспособности VLAN и MTU включена, в клиенте vSphere по умолчанию используется значение 1.

По умолчанию: 0

hostname

string

Имя хоста или IP-адрес сервера vSphere vCenter.

Если значение не указано в задаче, вместо него будет использовано значение переменной окружения VMWARE_HOST.

mtu

integer

Максимальная единица передачи данных коммутатора.

Обязательный параметр, если state=present.

Допустимые значения: от 1280 до 9000 включительно.

По умолчанию: 1500

multicast_filtering_mode

string

Режим фильтрации многоадресного трафика.

Режим basic: многоадресный трафик для виртуальных машин пересылается в соответствии с MAC-адресом назначения группы многоадресной рассылки.

Режим snooping: распределённый коммутатор выполняет snooping IGMP и MLD в соответствии с RFC 4541.

Варианты:

  • "basic" ← (по умолчанию)
  • "snooping"

net_flow

dictionary

Словарь для настройки NetFlow распределённого коммутатора.

По умолчанию: {"active_flow_timeout": 60, "collector_port": 0, "idle_flow_timeout": 15, "internal_flows_only": false, "observation_domain_id": 0, "sampling_rate": 4096}

active_flow_timeout

integer

Время в секундах, которое следует выждать перед отправкой сведений после инициализации потока.

По умолчанию: 60

collector_ip

string

IP-адрес (IPv4 или IPv6) коллектора NetFlow.

collector_port

integer

Порт коллектора NetFlow.

По умолчанию: 0

idle_flow_timeout

integer

Время в секундах, которое следует выждать перед отправкой сведений после инициализации потока.

По умолчанию: 15

internal_flows_only

boolean

Если значение равно True, собираются только данные о сетевой активности между виртуальными машинами на одном хосте.

Варианты:

  • false ← (по умолчанию)
  • true

observation_domain_id

integer

Идентификатор сведений, связанных с коммутатором.

По умолчанию: 0

sampling_rate

integer

Доля данных, собираемых коммутатором.

Частота выборки определяет количество пакетов, отбрасываемых NetFlow после каждого собранного пакета.

Если значение равно 0, NetFlow анализирует каждый пакет: собирает один пакет и ничего не отбрасывает.

Если значение равно 1, NetFlow анализирует один пакет и отбрасывает следующий, и так далее.

По умолчанию: 4096

switch_ip

string

добавлено в community.vmware 4.3.0

Назначьте IP-адрес, чтобы коллектор NetFlow отображал распределённый коммутатор как одно сетевое устройство.

В противном случае он будет отображаться как несколько устройств, соответствующих каждому хосту.

В среде IPv6 хосты ESXi игнорируют IP-адрес коммутатора.

network_policy

dictionary

Словарь для настройки различных значений безопасности по умолчанию для групп портов.

Если заданы, эти параметры наследуются группами портов DVS.

forged_transmits

boolean

Указывает, разрешена ли подмена передаваемых пакетов.

Варианты:

  • false ← (по умолчанию)
  • true

mac_changes

boolean

Указывает, разрешено ли изменение MAC-адресов.

Варианты:

  • false ← (по умолчанию)
  • true

promiscuous

boolean

Указывает, разрешён ли неразборчивый режим.

Варианты:

  • false ← (по умолчанию)
  • true

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.

state

string

Если задано значение present и распределённый коммутатор не существует, он будет создан.

Если задано значение absent и распределённый коммутатор существует, он будет удалён.

Варианты:

  • "present" ← (по умолчанию)
  • "absent"

switch_name

псевдонимы: switch, dvswitch

string / обязательный

Имя распределённого vSwitch, который нужно создать или удалить.

switch_version

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

string

Версия создаваемого распределённого коммутатора.

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

Если версия не указана, используется версия сервера vCenter.

Обязательный параметр, если state=present.

uplink_prefix

string

Префикс, используемый для именования восходящих каналов.

Применяется только при создании распределённого коммутатора. Не используется, если распределённый коммутатор уже существует.

По умолчанию восходящие каналы создаются с именами Uplink 1, Uplink 2 и т. д.

По умолчанию: "Uplink "

uplink_quantity

integer

Количество восходящих каналов на хост ESXi, добавляемый к распределённому коммутатору.

Количество восходящих каналов можно увеличить или уменьшить, но уменьшение будет успешным, только если канал не используется группой портов.

Обязательный параметр, если state=present.

username

псевдонимы: admin, user

string

Имя пользователя сервера vSphere vCenter.

Если значение не указано в задаче, вместо него будет использовано значение переменной окружения VMWARE_USER.

validate_certs

boolean

Разрешает подключение, если SSL-сертификаты недействительны. Установите значение false, если сертификатам нельзя доверять.

Если значение не указано в задаче, вместо него будет использовано значение переменной окружения VMWARE_VALIDATE_CERTS.

Варианты:

  • false
  • true ← (по умолчанию)

Примечания

Примечание

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

Примеры

- name: Create dvSwitch
  community.vmware.vmware_dvswitch:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    datacenter: '{{ datacenter }}'
    switch: dvSwitch
    version: 6.0.0
    mtu: 9000
    uplink_quantity: 2
    discovery_protocol: lldp
    discovery_operation: both
    state: present
  delegate_to: localhost

- name: Create dvSwitch with all options
  community.vmware.vmware_dvswitch:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    datacenter: '{{ datacenter }}'
    switch: dvSwitch
    version: 6.5.0
    mtu: 9000
    uplink_quantity: 2
    uplink_prefix: 'Uplink_'
    discovery_protocol: cdp
    discovery_operation: both
    multicast_filtering_mode: snooping
    health_check:
      vlan_mtu: true
      vlan_mtu_interval: 1
      teaming_failover: true
      teaming_failover_interval: 1
    net_flow:
        collector_ip: 192.168.10.50
        collector_port: 50034
        observation_domain_id: 0
        switch_ip: 192.168.10.40
        active_flow_timeout: 60
        idle_flow_timeout: 15
        sampling_rate: 4096
        internal_flows_only: false
    state: present
  delegate_to: localhost

- name: Delete dvSwitch
  community.vmware.vmware_dvswitch:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    datacenter: '{{ datacenter }}'
    switch: dvSwitch
    state: absent
  delegate_to: localhost

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

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

Ключ

Описание

result

string

сведения о выполненной операции

Возвращается: всегда

Пример: "{'changed': False, 'contact': None, 'contact_details': None, 'description': None, 'discovery_operation': 'both', 'discovery_protocol': 'cdp', 'dvswitch': 'test', 'health_check_teaming': False, 'health_check_teaming_interval': 0, 'health_check_vlan': False, 'health_check_vlan_interval': 0, 'mtu': 9000, 'multicast_filtering_mode': 'basic', 'net_flow_active_flow_timeout': 60, 'net_flow_collector_ip': '192.168.10.50', 'net_flow_collector_port': 50034, 'net_flow_idle_flow_timeout': 15, 'net_flow_internal_flows_only': False, 'net_flow_observation_domain_id': 0, 'net_flow_sampling_rate': 4096, 'net_flow_switch_ip': '192.168.10.40', 'result': 'DVS already configured properly', 'uplink_quantity': 2, 'uplinks': ['Uplink_1', 'Uplink_2'], 'version': '6.6.0'}"

Авторы

  • Joseph Callen (@jcpowermac)
  • Abhijeet Kasurde (@Akasurde)
  • Christian Kotte (@ckotte)

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

  • Отслеживание проблем
  • Домашняя страница
  • Репозиторий (исходный код)

© 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_dvswitch_module.html

Spec-Zone.ru

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