Модуль vmware.vmware_rest.vcenter_vm_hardware_serial_info — возвращает информацию о виртуальном последовательном порте.

Примечание

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

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

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

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

Возвращает информацию о виртуальном последовательном порте.

Требования

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

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

Параметры

Параметр	Комментарии
label string	Имя элемента
port string	Идентификатор виртуального последовательного порта. Значением параметра должен быть идентификатор ресурса, возвращаемого модулем vmware.vmware_rest.vcenter_vm_hardware_serial. Обязателен при state=[‘get’]
session_timeout float добавлено в vmware.vmware_rest 2.1.0	Настройки времени ожидания для клиентского сеанса. Максимальное количество секунд на всю операцию, включая установление соединения, отправку запроса и получение ответа. Значение по умолчанию — 300 с.
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. Этот параметр обязателен.

Примечания

Примечание

Проверено на 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: Retrieve the serial ports information from the VM
  vmware.vmware_rest.vcenter_vm_hardware_serial_info:
    vm: '{{ test_vm1_info.id }}'
  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

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

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

Ключ	Описание
id string	moid ресурса Возвращается: При успешном выполнении Пример: `"9000"`
value dictionary	Получение существующего последовательного порта (label) Возвращается: При успешном выполнении Пример: `{"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_info_module.html