Spec-Zone.ru › Ansible

Модуль community.vmware.vmware_portgroup — создание группы портов VMware

Примечание

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

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

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

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

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

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

  • Создание группы портов VMware на стандартном коммутаторе VMware (vSS) для указанных хостов ESXi или хостов указанного кластера.

Параметры

Параметр

Комментарии

cluster_name

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

строка

Имя кластера, в котором находится хост.

Группа портов будет создана на всех хостах указанного кластера.

Этот параметр обязателен, если не указан hosts.

hostname

строка

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

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

hosts

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

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

Список имен хостов, на которые необходимо добавить группу портов.

Этот параметр обязателен, если не указан cluster_name.

password

псевдонимы: pass, pwd

строка

Пароль сервера vSphere vCenter.

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

port

целое число

Номер порта сервера vSphere vCenter.

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

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

portgroup

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

строка / обязательный

Имя добавляемой группы портов.

proxy_host

строка

Адрес прокси-сервера, который будет получать и пересылать все запросы HTTPS.

Указывается имя хоста или IP-адрес.

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

proxy_port

целое число

Порт HTTP-прокси-сервера, который будет получать и пересылать все запросы HTTPS.

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

security

псевдонимы: security_policy, network_policy

словарь

Сетевая политика задает параметры безопасности уровня 2 для группы портов, например разрешение неразборчивого режима, при котором адаптер гостевой системы прослушивает все пакеты, изменения MAC-адреса и поддельные передачи.

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

forged_transmits

логический

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

Варианты:

  • false
  • true

mac_changes

логический

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

Варианты:

  • false
  • true

promiscuous_mode

логический

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

Варианты:

  • false
  • true

state

строка

Определяет, должна ли группа портов существовать.

Варианты:

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

switch

псевдонимы: switch_name, vswitch

строка / обязательный

vSwitch, который необходимо изменить.

teaming

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

словарь

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

active_adapters

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

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

Все vmnic будут использоваться как активные адаптеры, если не заданы teaming.active_adapters и teaming.standby_adapters.

failback

логический

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

Варианты:

  • false
  • true

load_balancing

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

строка

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

Варианты:

  • "loadbalance_ip"
  • "loadbalance_srcmac"
  • "loadbalance_srcid"
  • "failover_explicit"

network_failure_detection

строка

Обнаружение сбоев сети.

Варианты:

  • "link_status_only"
  • "beacon_probing"

notify_switches

логический

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

Варианты:

  • false
  • true

standby_adapters

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

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

Все vmnic будут использоваться как активные адаптеры, если не заданы teaming.active_adapters и teaming.standby_adapters.

traffic_shaping

словарь

Словарь, задающий параметры формирования трафика для коммутатора.

average_bandwidth

целое число

Средняя пропускная способность (кбит/с).

burst_size

целое число

Размер всплеска (КБ).

enabled

логический

Состояние политики формирования трафика.

Варианты:

  • false
  • true

peak_bandwidth

целое число

Пиковая пропускная способность (кбит/с).

username

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

строка

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

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

validate_certs

логический

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

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

Варианты:

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

vlan_id

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

целое число

Идентификатор VLAN, назначаемый группе портов.

По умолчанию установлено значение 0 (без маркировки VLAN).

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

Примечания

Примечание

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

Примеры

- name: Add Management Network VM Portgroup
  community.vmware.vmware_portgroup:
    hostname: "{{ esxi_hostname }}"
    username: "{{ esxi_username }}"
    password: "{{ esxi_password }}"
    switch: "{{ vswitch_name }}"
    portgroup: "{{ portgroup_name }}"
    vlan_id: "{{ vlan_id }}"
  delegate_to: localhost

- name: Add Portgroup with Promiscuous Mode Enabled
  community.vmware.vmware_portgroup:
    hostname: "{{ esxi_hostname }}"
    username: "{{ esxi_username }}"
    password: "{{ esxi_password }}"
    switch: "{{ vswitch_name }}"
    portgroup: "{{ portgroup_name }}"
    security:
        promiscuous_mode: true
  delegate_to: localhost

- name: Add Management Network VM Portgroup to specific hosts
  community.vmware.vmware_portgroup:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    hosts: [esxi_hostname_one]
    switch: "{{ vswitch_name }}"
    portgroup: "{{ portgroup_name }}"
    vlan_id: "{{ vlan_id }}"
  delegate_to: localhost

- name: Add Management Network VM Portgroup to all hosts in a cluster
  community.vmware.vmware_portgroup:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    cluster_name: "{{ cluster_name }}"
    switch: "{{ vswitch_name }}"
    portgroup: "{{ portgroup_name }}"
    vlan_id: "{{ vlan_id }}"
  delegate_to: localhost

- name: Remove Management Network VM Portgroup to all hosts in a cluster
  community.vmware.vmware_portgroup:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    cluster_name: "{{ cluster_name }}"
    switch: "{{ vswitch_name }}"
    portgroup: "{{ portgroup_name }}"
    vlan_id: "{{ vlan_id }}"
    state: absent
  delegate_to: localhost

- name: Add Portgroup with all settings defined
  community.vmware.vmware_portgroup:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    esxi_hostname: "{{ inventory_hostname }}"
    switch: "{{ vswitch_name }}"
    portgroup: "{{ portgroup_name }}"
    vlan_id: 10
    security:
        promiscuous_mode: false
        mac_changes: false
        forged_transmits: false
    traffic_shaping:
        enabled: true
        average_bandwidth: 100000
        peak_bandwidth: 100000
        burst_size: 102400
    teaming:
        load_balancing: failover_explicit
        network_failure_detection: link_status_only
        notify_switches: true
        failback: true
        active_adapters:
            - vmnic0
        standby_adapters:
            - vmnic1
  delegate_to: localhost
  register: teaming_result

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

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

Ключ

Описание

result

словарь

метаданные группы портов

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

Пример: {"esxi01.example.com": {"changed": true, "failback": "No override", "failover_active": "No override", "failover_standby": "No override", "failure_detection": "No override", "load_balancing": "No override", "msg": "Port Group added", "notify_switches": "No override", "portgroup": "vMotion", "sec_forged_transmits": false, "sec_mac_changes": false, "sec_promiscuous_mode": false, "traffic_shaping": "No override", "vlan_id": 33, "vswitch": "vSwitch1"}}

Авторы

  • Joseph Callen (@jcpowermac)
  • Russell Teague (@mtnbikenc)
  • 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_portgroup_module.html

Spec-Zone.ru

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