Модуль community.vmware.vmware_guest_serial_port — Управление последовательными портами на существующей виртуальной машине

Примечание

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

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

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

Чтобы использовать его в книге задач, укажите: community.vmware.vmware_guest_serial_port.

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

Описание

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

Параметры

Параметр	Комментарии
backings список / элементы=словарь / обязательно	Список резервных копий для последовательных портов. `backings[].backing_type` необходимо для добавления, переконфигурации или удаления существующего последовательного порта.
backing_type псевдонимы: тип строка / обязательно	Тип резервной копии необходим для добавления, переконфигурации или удаления последовательных портов.
device_name строка	Абсолютный путь к последовательному устройству. Требуется при `backings[].backing_type=device`.
direction строка	Направление соединения. Требуется при `backings[].backing_type=network`. Варианты: `"client"` ← (по умолчанию) `"server"`
endpoint строка	При использовании резервной копии последовательного порта для подключения виртуальной машины к другому процессу, необходимо определить конечные точки. Требуется при `backings[].backing_type=pipe`. Варианты: `"client"` ← (по умолчанию) `"server"`
file_path строка	Путь к файлу хоста, используемому в этой резервной копии. Требуется полный путь, например, <имя_хранилища>/<имя_файла>. Требуется при `backings[].backing_type=file`.
no_rx_loss булево	Включает оптимизированную передачу данных через канал. Требуется при `backings[].backing_type=pipe`. Варианты: `false` ← (по умолчанию) `true`
pipe_name строка	Имя канала для канала хоста. Требуется при `backings[].backing_type=pipe`.
proxy_uri строка добавлен в community.vmware 3.7.0	Идентифицирует службу прокси vSPC, предоставляющую сетевой доступ к `backings[].service_uri`. Если вы укажете URI прокси, виртуальная машина инициирует соединение со службой прокси и пересылает serviceURI и направление прокси. Опция `Use Virtual Serial Port Concentrator` автоматически включена, когда `backings[].proxy_uri` установлена.
service_uri строка	Идентифицирует локальный хост или систему в сети в зависимости от значения `backings[].direction`. Если вы используете виртуальную машину в качестве сервера, URI идентифицирует хост, на котором работает виртуальная машина. В этом случае часть имени хоста URI должна быть пустой или должна указывать адрес локального хоста. Если вы используете виртуальную машину в качестве клиента, URI идентифицирует удалённую систему в сети. Требуется при `backings[].backing_type=pipe`.
state строка	`backings[].state` необходимо для определения, добавляем, изменяем или удаляем последовательный порт. Если `present`, последовательный порт будет добавлен или изменён. Если `absent`, существующий последовательный порт будет удалён. Если существующий последовательный порт для изменения или удаления, `backings[].backing_type` и один из `backings[].service_uri`, `backings[].pipe_name`, `backings[].device_name` или `backings[].file_path` требуются. Варианты: `"present"` ← (по умолчанию) `"absent"`
yield_on_poll булево	Включает поведение сдачи CPU. Варианты: `false` `true` ← (по умолчанию)
hostname строка	Имя хоста или IP-адрес сервера vCenter или ESXi vSphere. Если значение не указано в задаче, будет использовано значение переменной окружения `VMWARE_HOST`.
moid строка	Идентификатор управляемого объекта экземпляра для управления, если известен. Это уникальный идентификатор только в пределах одного экземпляра vCenter. Требуется, если `name` или `uuid` не указаны.
name строка	Имя виртуальной машины. Этот параметр обязателен, если параметр `uuid` или `moid` не указан.
password псевдонимы: pass, pwd строка	Пароль сервера vCenter или ESXi vSphere. Если значение не указано в задаче, будет использовано значение переменной окружения `VMWARE_PASSWORD`.

port integer	Номер порта сервера vSphere vCenter или ESXi. Если значение не указано в задаче, будет использовано значение переменной среды `VMWARE_PORT`. По умолчанию: `443`
proxy_host string	Адрес прокси-сервера, который будет принимать все запросы HTTPS и перенаправлять их. Формат — имя хоста или IP-адрес. Если значение не указано в задаче, будет использовано значение переменной среды `VMWARE_PROXY_HOST`.
proxy_port integer	Порт HTTP-прокси-сервера, который будет принимать все запросы HTTPS и перенаправлять их. Если значение не указано в задаче, будет использовано значение переменной среды `VMWARE_PROXY_PORT`.
use_instance_uuid boolean	Использовать UUID экземпляра VMware вместо BIOS UUID. Варианты: `false` ← (по умолчанию) `true`
username aliases: admin, user string	Имя пользователя сервера vSphere vCenter или ESXi. Если значение не указано в задаче, будет использовано значение переменной среды `VMWARE_USER`.
uuid string	UUID экземпляра для управления последовательными портами, уникальный идентификатор VMware. Это обязательный параметр, если параметры `name` или `moid` не указаны.
validate_certs boolean	Разрешает подключение, когда сертификаты SSL недействительны. Установите в `false`, если сертификаты ненадёжные. Если значение не указано в задаче, будет использовано значение переменной среды `VMWARE_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

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

Примеры

# Create serial ports
- name: Create multiple serial ports with Backing type - network, pipe, device and file
  community.vmware.vmware_guest_serial_port:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    name: "test_vm1"
    backings:
    - type: 'network'
      direction: 'client'
      service_uri: 'tcp://6000'
      yield_on_poll: true
    - type: 'pipe'
      pipe_name: 'serial_pipe'
      endpoint: 'client'
    - type: 'device'
      device_name: '/dev/char/serial/uart0'
    - type: 'file'
      file_path: '[datastore1]/file1'
      yield_on_poll:  true
    register: create_multiple_ports

# Create vSPC port
- name: Create network serial port with vSPC
  community.vmware.vmware_guest_serial_port:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    name: "test_vm1"
    backings:
    - type: 'network'
      direction: 'server'
      service_uri: 'vSPC.py'
      proxy_uri: 'telnets://<host>:<port>'
      yield_on_poll: true

# Modify existing serial port
- name: Modify Network backing type
  community.vmware.vmware_guest_serial_port:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    name: '{{ name }}'
    backings:
    - type: 'network'
      state: 'present'
      direction: 'server'
      service_uri: 'tcp://6000'
  delegate_to: localhost

# Remove serial port
- name: Remove pipe backing type
  community.vmware.vmware_guest_serial_port:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    name: '{{ name }}'
    backings:
    - type: 'pipe'
      state: 'absent'
  delegate_to: localhost

Значения возврата

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

Ключ	Описание
serial_port_data словарь	Метаданные о последовательных портах виртуальной машины после их управления Возвращаемое значение: всегда Пример: `[{"backing_type": "network", "direction": "client", "service_uri": "tcp://6000"}, {"backing_type": "pipe", "direction": "server", "pipe_name": "serial pipe"}]`

Авторы

Anusha Hegde (@anusha94)

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

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