Spec-Zone.ru › Ansible

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

Примечание

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

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

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

Чтобы использовать его в плейбуке, укажите: vmware.vmware_rest.vcenter_vm_hardware_serial.

Добавлено в vmware.vmware_rest 0.1.0

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

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

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

Требования

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

  • vSphere 7.0.3 или выше
  • python >= 3.6
  • aiohttp

Параметры

Параметр

Комментарии

allow_guest_control

boolean

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

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

Варианты:

  • false
  • true

backing

dictionary

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

Если значение не задано, по умолчанию выполняется автоматический поиск подходящего устройства узла. Обязательно при state=[‘present’]

Допустимые атрибуты:

- type (str): этот параметр задаёт допустимые типы ресурсов, обеспечивающих работу виртуального последовательного порта. ([‘present’])

Этот ключ обязателен при [‘present’].

- Допустимые значения:

- FILE

- HOST_DEVICE

- NETWORK_CLIENT

- NETWORK_SERVER

- PIPE_CLIENT

- PIPE_SERVER

- file (str): путь к файлу, обеспечивающему работу виртуального последовательного порта.

Это поле необязательно и используется только тогда, когда значение type равно FILE. ([‘present’])

- host_device (str): имя устройства, обеспечивающего работу виртуального последовательного порта.

Если значение не задано, виртуальный последовательный порт будет настроен на автоматический поиск подходящего устройства узла. ([‘present’])

- pipe (str): имя канала, обеспечивающего работу виртуального последовательного порта.

Это поле необязательно и используется только тогда, когда значение type равно PIPE_SERVER или PIPE_CLIENT. ([‘present’])

- no_rx_loss (bool): флаг, включающий оптимизированную передачу данных через канал. Если значение равно true, узел буферизует данные, чтобы предотвратить переполнение. Это позволяет виртуальной машине считывать все данные, переданные через канал, без потерь.

Если значение не задано, по умолчанию используется false. ([‘present’])

- network_location (str): URI, указывающий расположение сетевой службы, обеспечивающей работу виртуального последовательного порта.

- Если type равно NETWORK_SERVER, это поле указывает расположение, которое клиенты используют для подключения к этому серверу. Имя узла в URI должно быть пустым или указывать адрес узла, на котором выполняется виртуальная машина.

- Если type равно NETWORK_CLIENT, это поле указывает расположение, которое виртуальная машина использует для подключения к удалённому серверу.

Это поле необязательно и используется только тогда, когда значение type равно NETWORK_SERVER или NETWORK_CLIENT. ([‘present’])

- proxy (str): прокси-служба, обеспечивающая сетевой доступ к ресурсу. Если значение задано, виртуальная машина устанавливает соединение с прокси-службой и пересылает ей трафик.

Если значение не задано, прокси-служба не используется. ([‘present’])

label

string

Имя элемента

port

string

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

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

session_timeout

float

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

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

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

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

start_connected

boolean

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

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

Варианты:

  • false
  • true

state

string

Варианты:

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

vcenter_hostname

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

Имя узла или IP-адрес vSphere vCenter

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

vcenter_password

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

Пароль vSphere vCenter

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

vcenter_rest_log_file

string

С помощью этого необязательного параметра можно задать расположение файла журнала.

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

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

Если значение не указано в задаче, вместо него будет использоваться

значение переменной среды VMWARE_REST_LOG_FILE.

vcenter_username

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

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

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

vcenter_validate_certs

boolean

Разрешает подключение, если SSL-сертификаты недействительны. Если сертификатам не доверяют, задайте значение false.

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

Варианты:

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

vm

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

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

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

yield_on_poll

boolean

Поведение уступки процессорного времени. Если значение равно true, виртуальная машина будет периодически освобождать процессор, если её единственная задача — опрос виртуального последовательного порта. Время, необходимое для повторного получения процессора, зависит от степени активности других виртуальных машин на узле.

Это поле можно изменять в любое время; изменения для подключённого виртуального последовательного порта вступают в силу немедленно.

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

Варианты:

  • false
  • true

Примечания

Примечание

  • Проверено на vSphere 7.0.3

Примеры

- 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: Create a new serial port
  vmware.vmware_rest.vcenter_vm_hardware_serial:
    vm: '{{ test_vm1_info.id }}'
    label: Serial port 2
    allow_guest_control: true
  register: _result

- name: Create another serial port with a label
  vmware.vmware_rest.vcenter_vm_hardware_serial:
    vm: '{{ test_vm1_info.id }}'
    label: Serial port 2
    allow_guest_control: true
  register: _result

- name: Create an existing serial port (label)
  vmware.vmware_rest.vcenter_vm_hardware_serial:
    vm: '{{ test_vm1_info.id }}'
    label: Serial port 1
    allow_guest_control: true
  register: _result

- name: Get an existing serial port (label)
  vmware.vmware_rest.vcenter_vm_hardware_serial_info:
    vm: '{{ test_vm1_info.id }}'
    label: Serial port 1
  register: serial_port_1

- name: Delete an existing serial port (port id)
  vmware.vmware_rest.vcenter_vm_hardware_serial:
    vm: '{{ test_vm1_info.id }}'
    port: '{{ serial_port_1.id }}'
    state: absent
  register: _result

- name: Delete an existing serial port (label)
  vmware.vmware_rest.vcenter_vm_hardware_serial:
    vm: '{{ test_vm1_info.id }}'
    label: Serial port 2
    state: absent
  register: _result

Возвращаемые значения

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

Ключ

Описание

id

string

moid ресурса

Возвращается: при успешном выполнении

Пример: "9000"

value

dictionary

Создать существующий последовательный порт (метка)

Возвращается: при успешном выполнении

Пример: {"allow_guest_control": 1, "backing": {"auto_detect": 1, "host_device": "", "type": "HOST_DEVICE"}, "label": "Serial port 1", "start_connected": 0, "state": "NOT_CONNECTED", "yield_on_poll": 0}

Авторы

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

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

  • Отслеживание проблем
  • Репозиторий (исходный код)

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

Spec-Zone.ru

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