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

Примечание

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

Новая функция в vmware.vmware_rest 0.1.0

Обзор
Требования
Параметры
Примечания
Примеры
Значения возврата

Обзор

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

Требования

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

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

Параметры

Параметр	Комментарии
label строка	Имя элемента
port строка	Идентификатор виртуального последовательного порта. Параметр должен быть идентификатором ресурса, возвращаемого модулем vmware.vmware_rest.vcenter_vm_hardware_serial. Требуется при state=[‘get’]
session_timeout число с плавающей точкой добавлено в vmware.vmware_rest 2.1.0	Параметры таймаута для сеанса клиента. Максимальное количество секунд для всей операции, включая установление соединения, отправку запроса и получение ответа. Значение по умолчанию 300 с.
vcenter_hostname строка / обязательно	Имя хоста или IP-адрес vCenter vSphere Если значение не указано в задаче, будет использовано значение переменной среды `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 ← (по умолчанию)

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