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

Примечание

Этот модуль входит в коллекцию 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_parallel.

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

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

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

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

Требования

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

vSphere 7.0.3 или более поздней версии
python >= 3.6
aiohttp

Параметры

Параметр	Комментарии
allow_guest_control логическое значение	Флаг, указывающий, может ли гостевая система подключать и отключать устройство. Если значение не задано, оно не изменяется. Варианты: `false` `true`
backing словарь	Физический ресурс, используемый виртуальным параллельным портом. Если значение не задано, по умолчанию автоматически обнаруживается подходящее устройство хоста. Обязательно при state=[‘present’] Допустимые атрибуты: - `type` (str): Этот параметр задаёт допустимые типы ресурсов для виртуального параллельного порта. ([‘present’]) Этот ключ обязателен при [‘present’]. - Допустимые значения: - FILE - HOST_DEVICE - `file` (str): Путь к файлу, который будет использоваться в качестве ресурса виртуального параллельного порта. Это поле необязательно и имеет значение только в том случае, если значение type равно FILE. ([‘present’]) - `host_device` (str): Имя устройства, которое будет использоваться в качестве ресурса виртуального параллельного порта. Если значение не задано, виртуальный параллельный порт будет настроен на автоматическое обнаружение подходящего устройства хоста. ([‘present’])
label строка	Имя элемента
port строка	Идентификатор виртуального параллельного порта. Параметр должен содержать идентификатор ресурса, возвращённого модулем vmware.vmware_rest.vcenter_vm_hardware_parallel. Обязателен при state=[‘absent’, ‘connect’, ‘disconnect’, ‘present’]
session_timeout число с плавающей точкой добавлено в vmware.vmware_rest 2.1.0	Настройки времени ожидания для клиентского сеанса. Максимальное количество секунд для всей операции, включая установление соединения, отправку запроса и получение ответа. Значение по умолчанию — 300 с.
start_connected логическое значение	Флаг, указывающий, следует ли подключать виртуальное устройство при каждом включении виртуальной машины. Если значение не задано, оно не изменяется. Варианты: `false` `true`
state строка	Варианты: `"absent"` `"connect"` `"disconnect"` `"present"` ← (по умолчанию)
vcenter_hostname строка / обязательный	Имя хоста или IP-адрес vSphere vCenter Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `VMWARE_HOST`.
vcenter_password строка / обязательный	Пароль vSphere vCenter Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `VMWARE_PASSWORD`.
vcenter_rest_log_file строка	Этот необязательный параметр позволяет указать расположение файла журнала. Этот файл будет использоваться для записи взаимодействий HTTP REST. Файл будет сохранён на хосте, на котором выполняется модуль. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `VMWARE_REST_LOG_FILE`.
vcenter_username строка / обязательный	Имя пользователя vSphere vCenter Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `VMWARE_USER`.
vcenter_validate_certs логическое значение	Разрешает подключение, если SSL-сертификаты недействительны. Установите значение `false`, если сертификаты не являются доверенными. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `VMWARE_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)
vm строка / обязательный	Идентификатор виртуальной машины. Параметр должен содержать идентификатор ресурса, возвращённого модулем vmware.vmware_rest.vcenter_vm_info. Этот параметр обязателен.

Примечания

Примечание

Проверено на 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: Turn on guest control on the parallel port
  vmware.vmware_rest.vcenter_vm_hardware_parallel:
    vm: '{{ test_vm1_info.id }}'
    allow_guest_control: true
  register: _result

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

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

Ключ	Описание
id строка	moid ресурса Возвращается: при успешном выполнении Пример: `"10000"`
value словарь	Включение управления параллельным портом из гостевой системы Возвращается: при успешном выполнении Пример: `{"allow_guest_control": 1, "backing": {"auto_detect": 1, "host_device": "", "type": "HOST_DEVICE"}, "label": "Parallel port 1", "start_connected": 0, "state": "NOT_CONNECTED"}`

Авторы

Команда 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_parallel_module.html