Spec-Zone.ru › Ansible 2.11

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

Примечание

Этот плагин является частью коллекции community.vmware (версия 1.7.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
строка
    Варианты:
  • present ←
  • absent
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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/vmware/vmware_guest_serial_port_module.html

Spec-Zone.ru

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