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

Примечание

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

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

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

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

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

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

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

Параметры

Параметр	Комментарии
backings list / elements=dictionary / обязательный	Список конфигураций подключений для последовательных портов. Для добавления, перенастройки или удаления существующего последовательного порта требуется `backings[].backing_type`.
backing_type псевдонимы: type string / обязательный	Для добавления, перенастройки или удаления последовательных портов необходимо указать тип подключения.
device_name string	Абсолютный путь к последовательному устройству. Обязателен, если `backings[].backing_type=device`.
direction string	Направление соединения. Обязательно, если `backings[].backing_type=network`. Варианты: `"client"` ← (по умолчанию) `"server"`
endpoint string	При использовании канала последовательного порта для подключения виртуальной машины к другому процессу необходимо указать конечные точки. Обязательно, если `backings[].backing_type=pipe`. Варианты: `"client"` ← (по умолчанию) `"server"`
file_path string	Путь к файлу узла, используемому в этой конфигурации подключения. Требуется полный путь, например <datastore_name>/<file_name>. Обязателен, если `backings[].backing_type=file`.
no_rx_loss boolean	Включает оптимизированную передачу данных через канал. Обязателен, если `backings[].backing_type=pipe`. Варианты: `false` ← (по умолчанию) `true`
pipe_name string	Имя канала узла. Обязательно, если `backings[].backing_type=pipe`.
proxy_uri string добавлено в community.vmware 3.7.0	Указывает прокси-службу vSPC, которая предоставляет сетевой доступ к `backings[].service_uri`. Если указан URI прокси-сервера, виртуальная машина устанавливает соединение с прокси-службой и передает ей serviceURI и направление. Параметр `Use Virtual Serial Port Concentrator` включается автоматически, если задан `backings[].proxy_uri`.
service_uri string	Указывает локальный узел или систему в сети в зависимости от значения `backings[].direction`. Если виртуальная машина используется в качестве сервера, URI указывает узел, на котором она работает. В этом случае часть URI с именем узла должна быть пустой или содержать адрес локального узла. Если виртуальная машина используется в качестве клиента, URI указывает удаленную систему в сети. Обязательно, если `backings[].backing_type=pipe`.
state string	Параметр `backings[].state` необходим, чтобы указать, добавляется, изменяется или удаляется последовательный порт. Если `present`, последовательный порт будет добавлен или изменен. Если `absent`, существующий последовательный порт будет удален. Для изменения или удаления существующего последовательного порта необходимы `backings[].backing_type` и один из параметров: `backings[].service_uri`, `backings[].pipe_name`, `backings[].device_name` или `backings[].file_path`. Варианты: `"present"` ← (по умолчанию) `"absent"`
yield_on_poll boolean	Включает режим освобождения ресурсов ЦП. Варианты: `false` `true` ← (по умолчанию)
hostname string	Имя узла или IP-адрес сервера vSphere vCenter. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `VMWARE_HOST`.
moid string	Идентификатор управляемого объекта экземпляра, которым необходимо управлять, если он известен. Этот идентификатор уникален только в пределах одного экземпляра vCenter. Обязателен, если не указан `name` или `uuid`.
name string	Имя виртуальной машины. Этот параметр обязателен, если не указан параметр `uuid` или `moid`.
password псевдонимы: pass, pwd string	Пароль сервера vSphere vCenter. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `VMWARE_PASSWORD`.
port integer	Номер порта сервера vSphere vCenter. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `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 вместо UUID BIOS. Варианты: `false` ← (по умолчанию) `true`
username псевдонимы: admin, user string	Имя пользователя сервера vSphere vCenter. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `VMWARE_USER`.
uuid string	UUID экземпляра, последовательными портами которого необходимо управлять. Это уникальный идентификатор VMware. Этот параметр обязателен, если не указан параметр `name` или `moid`.
validate_certs boolean	Разрешает подключение при недействительных SSL-сертификатах. Если сертификатам нельзя доверять, задайте значение `false`. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `VMWARE_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

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

Примеры

# 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 dictionary	метаданные о последовательных портах виртуальной машины после управления ими Возвращается: всегда Пример: `[{"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–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_serial_port_module.html