Spec-Zone.ru › Ansible

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

Примечание

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

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

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

Для использования в playbook, укажите: vmware.vmware_rest.vcenter_vm_hardware_parallel.

Новое в 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
  • file (str): Путь к файлу, который должен использоваться в качестве обеспечения работы виртуального параллельного порта.

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

  • host_device (str): Имя устройства, которое должно использоваться в качестве обеспечения работы виртуального параллельного порта.

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

label

string

Имя элемента

port

string

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

Параметр должен быть идентификатором ресурса, возвращаемого vmware.vmware_rest.vcenter_vm_hardware_parallel. Требуется при 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. Этот параметр обязателен.

Примечания

Примечание

  • Тестировалось на 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

string

moid ресурса

Возвращается: При успехе

Пример: "10000"

value

dictionary

Включить управление гостем на параллельном порту

Возвращается: При успехе

Пример: {"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 Team (@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_parallel_module.html

Spec-Zone.ru

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