Модуль community.vmware.vmware_guest_network — управление сетевыми адаптерами указанной виртуальной машины в инфраструктуре vCenter

Примечание

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

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

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

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

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

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

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

Параметры

Параметр	Описание
allow_guest_os_mtu_change boolean	Разрешает гостевой ОС изменять MTU сетевого адаптера SR-IOV. Этот параметр совместим только с сетевыми адаптерами SR-IOV. Варианты: `false` `true` ← (по умолчанию)
cluster string	Имя кластера, которому принадлежит ВМ.
connected boolean	Указывает, должен ли сетевой адаптер быть подключен к сети. Варианты: `false` `true` ← (по умолчанию)
datacenter string	Центр обработки данных, которому принадлежит ВМ. По умолчанию: `"ha-datacenter"`
device_type string	Тип виртуального сетевого устройства. Допустимые варианты: `e1000`, `e1000e`, `pcnet32`, `vmxnet2`, `vmxnet3` (по умолчанию), `sriov`, `pvrdma`. По умолчанию: `"vmxnet3"`
directpath_io boolean	Включить Universal Pass-through (UPT). Совместимо только с `device_type=vmxnet3`. Варианты: `false` ← (по умолчанию) `true`
esxi_hostname string	Имя хоста ESXi, которому принадлежит ВМ.
folder string	Расположение папки указанной ВМ. Этот параметр требуется только в том случае, если существует несколько ВМ с одинаковым именем.
force boolean	Принудительно создать адаптер, даже если существующий адаптер подключен к той же сети. Варианты: `false` ← (по умолчанию) `true`
gather_network_info псевдонимы: gather_network_facts boolean	Возвращать сведения о текущих сетевых адаптерах гостевой ОС. Варианты: `false` ← (по умолчанию) `true`
guest_control boolean	Разрешить гостевой ОС управлять подключением устройства. Варианты: `false` `true` ← (по умолчанию)
hostname string	Имя хоста или IP-адрес сервера vSphere vCenter. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `VMWARE_HOST`.
label string	Метка сетевого адаптера, который нужно изменить. Чтобы получить соответствующее устройство для перенастройки, следует задать `mac_address` или `label`. Изменить имя сетевого адаптера.
mac_address string	MAC-адрес сетевого адаптера, который нужно изменить. Если MAC-адрес не указан, будет создан новый сетевой адаптер. Обязателен, если `state=absent`.
moid string	Идентификатор управляемого объекта экземпляра, которым нужно управлять, если он известен. Это уникальный идентификатор только в пределах одного экземпляра vCenter. Обязателен, если не указаны `uuid` или `name`.
name string	Имя виртуальной машины Обязательно, если не указаны `uuid` или `moid`.
network_name string	Имя сети в vSphere. Работает быстрее, чем o(vlan_id), в крупной инфраструктуре с большим количеством сетей.
password псевдонимы: pass, pwd string	Пароль сервера vSphere vCenter. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `VMWARE_PASSWORD`.
physical_function_backing string	Если задано, указывает PCI ID физической функции, которая будет использоваться в качестве основы для сетевого адаптера SR-IOV. Этот параметр совместим только с сетевыми адаптерами SR-IOV.
port integer	Номер порта сервера vSphere vCenter. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `VMWARE_PORT`. По умолчанию: `443`
proxy_host string	Адрес прокси-сервера, который будет получать все HTTPS-запросы и перенаправлять их. Укажите имя хоста или IP-адрес. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `VMWARE_PROXY_HOST`.
proxy_port integer	Порт HTTP-прокси-сервера, который будет получать все HTTPS-запросы и перенаправлять их. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `VMWARE_PROXY_PORT`.
pvrdma_device_protocol string добавлено в community.vmware 3.3.0	Используемый протокол устройства PVRDMA. Допустимые варианты: `rocev1`, `rocev2`. Этот параметр используется только для ВМ с аппаратной версией от 14 до 19 включительно.
start_connected boolean	Указывает, должен ли сетевой адаптер подключаться к сети при запуске. Варианты: `false` `true` ← (по умолчанию)
state string	Состояние сетевого адаптера. Если задано `present`, сетевой адаптер будет добавлен, если MAC-адрес или метка ещё не существуют либо не заданы. Если задано `absent`, необходимо задать параметр `mac_address`. Варианты: `"present"` ← (по умолчанию) `"absent"`
switch string	Имя (dv)switch для целевой сети. Этот параметр требуется только для распределённых коммутаторов.
use_instance_uuid boolean	Использовать UUID экземпляра VMware вместо UUID BIOS. Варианты: `false` ← (по умолчанию) `true`
username псевдонимы: admin, user string	Имя пользователя сервера vSphere vCenter. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `VMWARE_USER`.
uuid string	UUID виртуальной машины Обязателен, если не указаны `name` или `moid`.
validate_certs boolean	Разрешает подключение при недействительных сертификатах SSL. Установите значение `false`, если сертификатам нельзя доверять. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `VMWARE_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)
virtual_function_backing string	Если задано, указывает PCI ID физической функции, которая будет использоваться в качестве основы для сетевого адаптера SR-IOV. Этот параметр совместим только с сетевыми адаптерами SR-IOV.
vlan_id integer	Идентификатор VLAN, связанный с сетью.
wake_onlan boolean	Включить Wake-on-LAN. Варианты: `false` ← (по умолчанию) `true`

Примечания

Примечание

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

Примеры

- name: change network for 00:50:56:11:22:33 on vm01.domain.fake
  community.vmware.vmware_guest_network:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    datacenter: "{{ datacenter_name }}"
    name: vm01.domain.fake
    mac_address: 00:50:56:11:22:33
    network_name: admin-network
    state: present

- name: add a nic on network with vlan id 2001 for 422d000d-2000-ffff-0000-b00000000000
  community.vmware.vmware_guest_network:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    datacenter: "{{ datacenter_name }}"
    uuid: 422d000d-2000-ffff-0000-b00000000000
    vlan_id: 2001

- name: remove nic with mac 00:50:56:11:22:33 from vm01.domain.fake
  community.vmware.vmware_guest_network:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    datacenter: "{{ datacenter_name }}"
    mac_address: 00:50:56:11:22:33
    name: vm01.domain.fake
    state: absent

- name: add multiple nics to vm01.domain.fake
  community.vmware.vmware_guest_network:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    datacenter: "{{ datacenter_name }}"
    name: vm01.domain.fake
    state: present
    vlan_id: "{{ item.vlan_id | default(omit) }}"
    network_name: "{{ item.network_name | default(omit) }}"
    connected: "{{ item.connected | default(omit) }}"
  loop:
    - vlan_id: 2000
      connected: false
    - network_name: guest-net
      connected: true

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

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

Ключ	Описание
network_data dictionary	Для обратной совместимости: метаданные о сетевых адаптерах виртуальной машины Возвращается: при использовании параметра gather_network_info Пример: {"network_data": {"0": {"allow_guest_ctl": true, "connected": true, "device_type": "vmxnet3", "label": "Network adapter 2", "mac_addr": "00:50:56:AA:AA:AA", "mac_address": "00:50:56:AA:AA:AA", "name": "admin-net", "network_name": "admin-net", "start_connected": true, "switch": "vSwitch0", "unit_number": 8, "vlan_id": 10, "wake_onlan": false}, "1": {"allow_guest_ctl": true, "connected": true, "device_type": "vmxnet3", "label": "Network adapter 1", "mac_addr": "00:50:56:BB:BB:BB", "mac_address": "00:50:56:BB:BB:BB", "name": "guest-net", "network_name": "guest-net", "start_connected": true, "switch": "vSwitch0", "unit_number": 7, "vlan_id": 10, "wake_onlan": true}}}
network_info list / elements=string	Метаданные о сетевых адаптерах виртуальной машины Возвращается: всегда Пример: {"network_info": [{"allow_guest_ctl": true, "connected": true, "device_type": "vmxnet3", "label": "Network adapter 2", "mac_address": "00:50:56:AA:AA:AA", "network_name": "admin-net", "start_connected": true, "switch": "vSwitch0", "unit_number": 8, "vlan_id": 10, "wake_onlan": false}, {"allow_guest_ctl": true, "connected": true, "device_type": "vmxnet3", "label": "Network adapter 1", "mac_address": "00:50:56:BB:BB:BB", "network_name": "guest-net", "start_connected": true, "switch": "vSwitch0", "unit_number": 7, "vlan_id": 10, "wake_onlan": true}]}

Ключ

Описание

network_data

dictionary

Для обратной совместимости: метаданные о сетевых адаптерах виртуальной машины

Возвращается: при использовании параметра gather_network_info

Пример: {"network_data": {"0": {"allow_guest_ctl": true, "connected": true, "device_type": "vmxnet3", "label": "Network adapter 2", "mac_addr": "00:50:56:AA:AA:AA", "mac_address": "00:50:56:AA:AA:AA", "name": "admin-net", "network_name": "admin-net", "start_connected": true, "switch": "vSwitch0", "unit_number": 8, "vlan_id": 10, "wake_onlan": false}, "1": {"allow_guest_ctl": true, "connected": true, "device_type": "vmxnet3", "label": "Network adapter 1", "mac_addr": "00:50:56:BB:BB:BB", "mac_address": "00:50:56:BB:BB:BB", "name": "guest-net", "network_name": "guest-net", "start_connected": true, "switch": "vSwitch0", "unit_number": 7, "vlan_id": 10, "wake_onlan": true}}}

network_info

list / elements=string

Метаданные о сетевых адаптерах виртуальной машины

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

Пример: {"network_info": [{"allow_guest_ctl": true, "connected": true, "device_type": "vmxnet3", "label": "Network adapter 2", "mac_address": "00:50:56:AA:AA:AA", "network_name": "admin-net", "start_connected": true, "switch": "vSwitch0", "unit_number": 8, "vlan_id": 10, "wake_onlan": false}, {"allow_guest_ctl": true, "connected": true, "device_type": "vmxnet3", "label": "Network adapter 1", "mac_address": "00:50:56:BB:BB:BB", "network_name": "guest-net", "start_connected": true, "switch": "vSwitch0", "unit_number": 7, "vlan_id": 10, "wake_onlan": true}]}

Авторы

Diane Wang (@Tomorrow9)

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

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