Spec-Zone.ru › Ansible

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

Примечание

Этот модуль входит в состав коллекции vmware.vmware_rest (версия 3.2.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 / required

Имя хоста или IP-адрес vSphere vCenter

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

vcenter_password

string / required

Пароль vSphere vCenter

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

vcenter_rest_log_file

string

Этот необязательный параметр можно использовать для установки местоположения файла журнала.

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

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

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

переменной среды VMWARE_REST_LOG_FILE.

vcenter_username

string / required

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

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

vcenter_validate_certs

boolean

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

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

Варианты:

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

vm

string / required

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

Параметр должен быть идентификатором ресурса, возвращаемого 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/vmware/vmware_rest/vcenter_vm_hardware_serial_module.html

Spec-Zone.ru

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