community.vmware.vmware_guest_serial_port – Управление последовательными портами на существующей виртуальной машине
Примечание
Этот плагин входит в состав коллекции community.vmware (версия 1.6.0).
Для его установки используйте: ansible-galaxy collection install community.vmware.
Для использования в плейбуке укажите: community.vmware.vmware_guest_serial_port.
Обзор
- Этот модуль можно использовать для управления последовательными портами на существующей виртуальной машине.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| backings список / элементы=словарь / обязательный | Список настроек для последовательных портов. backing_type (строка): требуется для добавления, переконфигурации или удаления существующего последовательного порта. | ||
| backing_type строка / обязательный | Тип настроек необходим для добавления, переконфигурации или удаления последовательных портов. псевдонимы: type | ||
| device_name строка | Абсолютный путь к последовательному устройству. Требуется, когда backing_type=device. | ||
| direction строка |
| Направление подключения. Требуется, когда backing_type=network. | |
| endpoint строка |
| При использовании настроек последовательного порта через канал для подключения виртуальной машины к другому процессу, необходимо определить конечные точки. Требуется, когда backing_type=pipe. | |
| file_path строка | Путь к файлу на хосте, используемому в настройке. Требуется полный путь, например, <имя_хранилища>/<имя_файла>. Требуется, когда backing_type=file. | ||
| no_rx_loss булево |
| Включает оптимизированную передачу данных через канал. Требуется, когда backing_type=pipe. | |
| pipe_name строка | Имя канала на хосте. Требуется, когда backing_type=pipe. | ||
| service_uri строка | Идентифицирует локальный хост или систему в сети в зависимости от значения direction. Если виртуальная машина используется в качестве сервера, URI указывает хост, на котором запущена виртуальная машина. В этом случае имя хоста в URI должно быть пустым или указывать адрес локального хоста. Если виртуальная машина используется в качестве клиента, URI указывает удаленную систему в сети. Требуется, когда backing_type=network. | ||
| state строка |
| state требуется для определения, добавляем, изменяем или удаляем последовательный порт.Если state установлено в present, последовательный порт будет добавлен или изменён.Если state установлено в absent, существующий последовательный порт будет удалён.Для изменения или удаления существующего последовательного порта требуются backing_type и любое из service_uri, pipe_name, device_name или file_path. | |
| yield_on_poll булево |
| Включает поведение приостановки CPU. | |
| hostname строка | Имя хоста или IP-адрес сервера vCenter или ESXi vSphere. Если значение не указано в задаче, используется значение переменной окружения VMWARE_HOST. Поддержка переменных окружения добавлена в Ansible 2.6. | ||
| moid строка | Идентификатор управляемого объекта экземпляра для управления, если известен. Это уникальный идентификатор только в пределах одного экземпляра vCenter. Требуется, если name или uuid не указаны. | ||
| name строка | Имя виртуальной машины. Обязательный параметр, если параметр uuid или moid не указан. | ||
| password строка | Пароль сервера vCenter или ESXi vSphere. Если значение не указано в задаче, используется значение переменной окружения VMWARE_PASSWORD. Поддержка переменных окружения добавлена в Ansible 2.6. псевдонимы: pass, pwd | ||
| port целое число | Значение по умолчанию: 443 | Номер порта сервера vCenter или ESXi vSphere. Если значение не указано в задаче, используется значение переменной окружения VMWARE_PORT. Поддержка переменных окружения добавлена в Ansible 2.6. | |
| proxy_host строка | Адрес прокси, который будет получать все запросы HTTPS и перенаправлять их. Формат — имя хоста или IP-адрес. Если значение не указано в задаче, используется значение переменной окружения VMWARE_PROXY_HOST. Эта функция зависит от версии pyvmomi, большей чем v6.7.1.2018.12 | ||
| proxy_port целое число | Порт HTTP-прокси, который будет получать все запросы HTTPS и перенаправлять их. Если значение не указано в задаче, используется значение переменной окружения VMWARE_PROXY_PORT. | ||
| use_instance_uuid булево |
| Использовать UUID экземпляра VMware вместо BIOS UUID. | |
| username строка | Имя пользователя сервера vCenter или ESXi vSphere. Если значение не указано в задаче, используется значение переменной окружения VMWARE_USER. Поддержка переменных окружения добавлена в Ansible 2.6. псевдонимы: admin, user | ||
| uuid строка | UUID экземпляра для управления последовательными портами, уникальный идентификатор VMware. Обязательный параметр, если параметр name или moid не указан. | ||
| validate_certs булево |
| Разрешить подключение, когда сертификаты SSL недействительны. Установите в false, если сертификаты не доверяются.Если значение не указано в задаче, используется значение переменной окружения VMWARE_VALIDATE_CERTS. Поддержка переменных окружения добавлена в Ansible 2.6. Если установлено в true, убедитесь, что на данном компьютере установлен Python >= 2.7.9. | |
Примеры
# 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
# 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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/vmware/vmware_guest_serial_port_module.html