Spec-Zone.ru › Ansible

Модуль vmware.vmware_rest.vcenter_vm_hardware_ethernet — добавляет виртуальный адаптер Ethernet в виртуальную машину.

Примечание

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

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

Для установки используйте: ansible-galaxy collection install vmware.vmware_rest. Для работы с этим модулем могут потребоваться дополнительные компоненты. Подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: vmware.vmware_rest.vcenter_vm_hardware_ethernet.

Добавлено в vmware.vmware_rest 0.1.0

  • УСТАРЕЛ
  • Краткое описание
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения
  • Статус

УСТАРЕЛ

Удалён в:

версии 5.0.0

Причина:

Этот модуль перенесён в новую коллекцию vmware.vmware

Альтернатива:

Вместо него используйте vmware.vmware.vm.

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

  • Добавляет виртуальный адаптер Ethernet в виртуальную машину.

Требования

На узле, выполняющем этот модуль, должны быть установлены следующие компоненты.

  • vSphere 7.0.3 или более поздней версии
  • python >= 3.6
  • aiohttp

Параметры

Параметр

Комментарии

allow_guest_control

логическое значение

Флаг, указывающий, может ли гостевая ОС подключать и отключать устройство.

Если значение не задано, оно не изменяется.

Варианты:

  • false
  • true

backing

словарь

Физический ресурс, к которому подключён виртуальный адаптер Ethernet.

Если значение не задано, система может попытаться найти подходящий ресурс. Если такой ресурс не найден, запрос завершится ошибкой. Обязательно при state=[‘present’]

Допустимые атрибуты:

- type (str): этот параметр определяет допустимые типы подключения виртуального адаптера Ethernet. ([‘present’])

Этот ключ обязателен при [‘present’].

- Допустимые значения:

- DISTRIBUTED_PORTGROUP

- HOST_DEVICE

- OPAQUE_NETWORK

- STANDARD_PORTGROUP

- network (str): идентификатор сети, к которой подключён виртуальный адаптер Ethernet.

Это поле необязательное и используется только в том случае, если значение type равно STANDARD_PORTGROUP, DISTRIBUTED_PORTGROUP или OPAQUE_NETWORK.

Если клиенты передают значение этой структуры в качестве параметра, поле должно содержать идентификатор ресурса, возвращённого модулем vmware.vmware_rest.vcenter_network_info. ([‘present’])

- distributed_port (str): ключ распределённого виртуального порта, к которому подключён виртуальный адаптер Ethernet. В зависимости от типа группы портов порт можно указать с помощью этого поля. Если группа портов использует раннее связывание (также называемое статическим), порт назначается при настройке адаптера Ethernet для его использования. Порт может быть назначен автоматически или явно — в зависимости от значения этого поля. Если группа портов является эфемерной, порт создаётся и назначается виртуальной машине при её включении и подключении адаптера Ethernet. Это поле нельзя указать, поскольку до использования свободных портов не существует.

Можно использовать для указания порта, если сеть, указанная в поле network, является статической распределённой группой портов или группой портов с ранним связыванием. Если значение не задано, порт будет назначен адаптеру Ethernet автоматически в соответствии с политикой, определяемой типом группы портов. ([‘present’])

label

строка

Имя элемента

mac_address

строка

MAC-адрес.

Это поле можно изменить в любое время. Изменения вступят в силу при следующем включении виртуальной машины.

Если значение не задано, оно не изменяется. Обязательно, если mac_type имеет значение MANUAL. Должно быть не задано, если тип MAC-адреса не MANUAL.

mac_type

строка

Перечислимый тип mac_address_type определяет допустимые источники MAC-адреса для виртуального адаптера Ethernet.

Варианты:

  • "ASSIGNED"
  • "GENERATED"
  • "MANUAL"

nic

строка

Идентификатор виртуального адаптера Ethernet.

Параметр должен содержать идентификатор ресурса, возвращённого модулем vmware.vmware_rest.vcenter_vm_hardware_ethernet. Обязательно при state=[‘absent’, ‘connect’, ‘disconnect’, ‘present’]

pci_slot_number

целое число

Адрес виртуального адаптера Ethernet на шине PCI. Если адрес PCI недействителен, сервер изменит его при запуске виртуальной машины или горячем добавлении устройства.

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

session_timeout

число с плавающей запятой

добавлено в vmware.vmware_rest 2.1.0

Настройки времени ожидания клиентского сеанса.

Максимальное количество секунд для всей операции, включая установление соединения, отправку запроса и получение ответа.

Значение по умолчанию — 300 с.

start_connected

логическое значение

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

Если значение не задано, оно не изменяется.

Варианты:

  • false
  • true

state

строка

Варианты:

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

type

строка

Перечислимый тип emulation_type определяет допустимые типы эмуляции виртуального адаптера Ethernet.

Варианты:

  • "E1000"
  • "E1000E"
  • "PCNET32"
  • "VMXNET"
  • "VMXNET2"
  • "VMXNET3"

upt_compatibility_enabled

логическое значение

Флаг, указывающий, следует ли включить совместимость Universal Pass-Through (UPT) для этого виртуального адаптера Ethernet.

Это поле можно изменить в любое время. Изменения вступят в силу при следующем включении виртуальной машины.

Если значение не задано, оно не изменяется. Должно быть не задано, если тип эмуляции виртуального адаптера Ethernet не VMXNET3.

Варианты:

  • false
  • true

vcenter_hostname

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

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

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

vcenter_password

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

Пароль vSphere vCenter

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

vcenter_rest_log_file

строка

С помощью этого необязательного параметра можно указать путь к файлу журнала.

Этот файл будет использоваться для записи взаимодействий по HTTP REST.

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

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

переменной окружения VMWARE_REST_LOG_FILE.

vcenter_username

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

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

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

vcenter_validate_certs

логическое значение

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

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

Варианты:

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

vm

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

Идентификатор виртуальной машины.

Параметр должен содержать идентификатор ресурса, возвращённого модулем vmware.vmware_rest.vcenter_vm_info. Этот параметр обязателен.

wake_on_lan_enabled

логическое значение

Флаг, указывающий, следует ли включить Wake-on-LAN для этого виртуального адаптера Ethernet.

Это поле можно изменить в любое время. Изменения вступят в силу при следующем включении виртуальной машины.

Если значение не задано, оно не изменяется.

Варианты:

  • false
  • true

Примечания

Примечание

  • Проверено на vSphere 7.0.3

Примеры

- name: Get the dvswitch called my-portgroup
  vmware.vmware_rest.vcenter_network_info:
    filter_types: DISTRIBUTED_PORTGROUP
    filter_names: my portrgoup
  register: my_portgroup

- name: Look up the VM called test_vm1 in the inventory
  register: search_result
  vmware.vmware_rest.vcenter_vm_info:
    filter_names:
    - test_vm1

- name: Collect information about a specific VM
  vmware.vmware_rest.vcenter_vm_info:
    vm: '{{ search_result.value[0].vm }}'
  register: test_vm1_info

- name: Attach a VM to a dvswitch
  vmware.vmware_rest.vcenter_vm_hardware_ethernet:
    vm: '{{ test_vm1_info.id }}'
    pci_slot_number: 4
    backing:
      type: DISTRIBUTED_PORTGROUP
      network: '{{ my_portgroup.value[0].network }}'
    start_connected: false
  register: vm_hardware_ethernet_1

- name: Turn the NIC's start_connected flag on
  vmware.vmware_rest.vcenter_vm_hardware_ethernet:
    nic: '{{ vm_hardware_ethernet_1.id }}'
    start_connected: true
    vm: '{{ test_vm1_info.id }}'

- name: Attach the VM to a standard portgroup
  vmware.vmware_rest.vcenter_vm_hardware_ethernet:
    vm: '{{ test_vm1_info.id }}'
    pci_slot_number: 4
    backing:
      type: STANDARD_PORTGROUP
      network: "{{ lookup('vmware.vmware_rest.network_moid', '/my_dc/network/VM Network') }}"
  register: _result

- name: Attach the VM to a standard portgroup (again)
  vmware.vmware_rest.vcenter_vm_hardware_ethernet:
    vm: '{{ test_vm1_info.id }}'
    pci_slot_number: 4
    backing:
      type: STANDARD_PORTGROUP
      network: "{{ lookup('vmware.vmware_rest.network_moid', '/my_dc/network/VM Network') }}"
  register: _result

- name: Collect a list of the NIC for a given VM
  vmware.vmware_rest.vcenter_vm_hardware_ethernet_info:
    vm: '{{ test_vm1_info.id }}'
  register: vm_nic

- name: Attach the VM to a standard portgroup (again) using the nic ID
  vmware.vmware_rest.vcenter_vm_hardware_ethernet:
    vm: '{{ test_vm1_info.id }}'
    nic: '{{ vm_nic.value[0].nic }}'
    backing:
      type: STANDARD_PORTGROUP
      network: "{{ lookup('vmware.vmware_rest.network_moid', '/my_dc/network/VM Network') }}"
  register: _result

- name: Attach to another standard portgroup
  vmware.vmware_rest.vcenter_vm_hardware_ethernet:
    vm: '{{ test_vm1_info.id }}'
    nic: '{{ vm_nic.value[0].nic }}'
    backing:
      type: STANDARD_PORTGROUP
      network: "{{ lookup('vmware.vmware_rest.network_moid', '/my_dc/network/second_vswitch') }}"
  register: _result

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

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

Ключ

Описание

id

строка

moid ресурса

Возвращается: при успешном выполнении

Пример: "4000"

value

словарь

Подключение виртуальной машины к dvswitch

Возвращается: при успешном выполнении

Пример: {"allow_guest_control": 0, "backing": {"connection_cookie": 632732945, "distributed_port": "2", "distributed_switch_uuid": "50 31 d3 c4 2d 09 4f e3-0f d6 7f 30 3d fe d4 a0", "network": "dvportgroup-1022", "type": "DISTRIBUTED_PORTGROUP"}, "label": "Network adapter 1", "mac_address": "00:50:56:b1:33:76", "mac_type": "ASSIGNED", "pci_slot_number": 4, "start_connected": 0, "state": "NOT_CONNECTED", "type": "VMXNET3", "upt_compatibility_enabled": 0, "wake_on_lan_enabled": 0}

Статус

  • Этот модуль будет удалён в версии 5.0.0. [устарел]
  • Дополнительную информацию см. в разделе УСТАРЕЛ.

Авторы

  • Команда Ansible Cloud (@ansible-collections)

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

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

© 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/vmware/vmware_rest/vcenter_vm_hardware_ethernet_module.html

Spec-Zone.ru

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