Spec-Zone.ru › Ansible

Модуль vmware.vmware_rest.vcenter_vm_hardware_ethernet — Добавление виртуального сетевого адаптера к виртуальной машине.

Примечание

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

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

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

Для использования в playbook, укажите: vmware.vmware_rest.vcenter_vm_hardware_ethernet.

Новое в vmware.vmware_rest 0.1.0

  • Обзор
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Значения возврата

Обзор

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

Требования

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

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

Параметры

Параметр

Комментарии

allow_guest_control

boolean

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

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

Варианты:

  • false
  • true

backing

dictionary

Физический ресурс, поддерживающий виртуальный адаптер 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

string

Имя элемента

mac_address

string

MAC-адрес.

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

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

mac_type

string

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

Варианты:

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

nic

string

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

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

pci_slot_number

integer

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

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

session_timeout

float

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

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

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

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

start_connected

boolean

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

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

Варианты:

  • false
  • true

state

string

Варианты:

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

type

string

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

Варианты:

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

upt_compatibility_enabled

boolean

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

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

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

Варианты:

  • false
  • true

vcenter_hostname

string / required

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

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

vcenter_password

string / required

Пароль vSphere vCenter

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

vcenter_rest_log_file

string

Вы можете использовать этот необязательный параметр для указания расположения файла журнала.

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

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

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

vcenter_username

string / обязательно

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

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

vcenter_validate_certs

boolean

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

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

Варианты:

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

vm

string / обязательно

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

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

wake_on_lan_enabled

boolean

Флаг, указывающий, нужно ли включить 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

string

moid ресурса

Возвращается: При успехе

Пример: "4000"

value

dictionary

Подключение VM к 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}

Авторы

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

Ссылки на сборку

  • Трекер проблем
  • Главная страница
  • Репозиторий (исходный код)

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

Spec-Zone.ru

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