Spec-Zone.ru › Ansible

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

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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

Включить универсальный проход (UPT).

Совместимо только с device_type=vmxnet3.

Варианты:

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

esxi_hostname

string

Имя хоста ESXi, к которому принадлежит виртуальная машина.

folder

string

Расположение папки виртуальной машины; необходимо, если есть несколько виртуальных машин с одинаковым именем.

force

boolean

Принудительно создать адаптер, даже если к той же сети уже подключен существующий адаптер.

Варианты:

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

gather_network_info

aliases: gather_network_facts

boolean

Возвратить информацию о текущих адаптерах гостевой сети.

Варианты:

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

guest_control

boolean

Включает контроль гостевой операционной системы над подключением устройства.

Варианты:

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

hostname

string

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

Если значение не указано в задаче, будет использовано значение переменной окружения 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.

password

aliases: pass, pwd

string

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

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

physical_function_backing

string

Если задано, указывает идентификатор PCI физического устройства, используемого в качестве поддержки для адаптера сети SR-IOV.

Этот параметр совместим только с адаптерами сети SR-IOV.

порт

целое число

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

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

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

proxy_host

строка

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

Формат — имя хоста или IP-адрес.

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

proxy_port

целое число

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

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

pvrdma_device_protocol

строка

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

Используемый протокол устройства PVRDMA. Допустимые значения — rocev1, rocev2.

Этот параметр используется только на ВМ с версией оборудования >=14 и <= 19.

start_connected

булево

Подключить сетевую карту при запуске.

Варианты:

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

state

строка

Состояние сетевой карты.

При значении present, сетевая карта будет добавлена, если MAC-адрес или метка не существует или не заданы.

При значении absent, необходимо указать параметр mac_address.

Варианты:

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

switch

строка

Имя (dv)коммутатора для целевой сети, требуется только для dvswitches.

use_instance_uuid

булево

Использовать UUID экземпляра VMware вместо UUID BIOS.

Варианты:

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

имя_пользователя

псевдонимы: admin, пользователь

строка

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

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

uuid

строка

uuid ВМ

Требуется, если name или moid не указаны.

validate_certs

булево

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

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

Варианты:

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

virtual_function_backing

строка

Если задано, указывает PCI-ID физической функции, которая должна использоваться как поддержка для адаптера SR-IOV сети.

Этот параметр совместим только с адаптерами SR-IOV сети.

vlan_id

целое число

Идентификатор VLAN, связанный с сетью.

wake_onlan

булево

Включить пробуждение по сети.

Варианты:

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

Примечания

Примечание

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

Примеры

- 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

словарь

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

Возвращается: при использовании параметра 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

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

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

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

Пример: {"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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/vmware/vmware_guest_network_module.html

Spec-Zone.ru

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