Модуль community.vmware.vmware_portgroup – Создание VMware portgroup

Примечание

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

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

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

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

Обзор
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

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

Параметры

Параметр	Комментарии
cluster_name алиасы: cluster строка	Имя кластера для членства хоста. Группа портов будет создана на всех хостах данного кластера. Этот параметр обязателен, если `hosts` не указан.
hostname строка	Имя хоста или IP-адрес сервера vCenter или ESXi vSphere. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `VMWARE_HOST`.
hosts алиасы: esxi_hostname список / элементы=строка	Список имен хостов, на которых требуется добавить группу портов. Этот параметр обязателен, если `cluster_name` не указан.
password алиасы: pass, pwd строка	Пароль сервера vCenter или ESXi vSphere. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `VMWARE_PASSWORD`.
port целое число	Номер порта сервера vCenter или ESXi vSphere. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `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 для группы портов, такие как режим promiscuous, где адаптер гостевой системы прослушивает все пакеты, изменения MAC-адресов и поддельные трансляции. Словарь, который настраивает различные значения безопасности для группы портов.
forged_transmits логическое	Указывает, разрешены ли поддельные трансляции. Варианты: `false` `true`
mac_changes логическое	Указывает, разрешены ли изменения MAC-адресов. Варианты: `false` `true`
promiscuous_mode логическое	Указывает, разрешен ли режим promiscuous. Варианты: `false` `true`
state строка	Определяет, должна ли группа портов присутствовать. Варианты: `"present"` ← (по умолчанию) `"absent"`
switch алиасы: switch_name, vswitch строка / обязательно	vSwitch для изменения.
teaming алиасы: teaming_policy словарь	Словарь, который настраивает различные значения агрегирования для группы портов.
active_adapters список / элементы=строка	Список активных адаптеров, используемых для балансировки нагрузки. Все vmnics используются как активные адаптеры, если `teaming.active_adapters` и `teaming.standby_adapters` не определены.

failback boolean	Указывает, использовать ли резервное подключение при восстановлении каналов. Варианты: `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 boolean	Указывает, уведомлять ли физический коммутатор при отказе канала. Варианты: `false` `true`
standby_adapters список / элементы=строка	Список резервных адаптеров, используемых для переключения. Все vmnics используются в качестве активных адаптеров, если `teaming.active_adapters` и `teaming.standby_adapters` не определены.
traffic_shaping словарь	Словарь, настраивающий формирование трафика для коммутатора.
average_bandwidth целое число	Средняя пропускная способность (кбит/с).
burst_size целое число	Размер очереди (КБ).
enabled boolean	Статус политики формирования трафика. Варианты: `false` `true`
peak_bandwidth целое число	Пиковая пропускная способность (кбит/с).
username псевдонимы: admin, user строка	Имя пользователя сервера vCenter или ESXi. Если значение не указано в задаче, используется значение переменной среды `VMWARE_USER`.
validate_certs boolean	Разрешает подключение, когда сертификаты SSL недействительны. Установите в `false`, когда сертификаты не доверяются. Если значение не указано в задаче, используется значение переменной среды `VMWARE_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)
vlan_id псевдонимы: vlan целое число	Идентификатор VLAN для назначения портгруппе. По умолчанию установлено в 0 (без маркировки VLAN). По умолчанию: `0`

Примечания

Примечание

Все модули требуют доступа к API для записи и, следовательно, не поддерживаются в бесплатной лицензии ESXi.
Все имена переменных и объектов VMware чувствительны к регистру.

Примеры

- 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"}}`

Ключ

Описание

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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/vmware/vmware_portgroup_module.html