Spec-Zone.ru › Ansible

модуль vmware.vmware_rest.vcenter_vm_hardware_cdrom — добавляет виртуальное устройство CD-ROM к виртуальной машине.

Примечание

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

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

  • УСТАРЕЛО
  • Краткое описание
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения
  • Статус

УСТАРЕЛО

Удалено в:

версии 5.0.0

Причина:

Этот модуль перенесён в новую коллекцию vmware.vmware

Альтернатива:

Вместо него используйте vmware.vmware.vm.

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

  • Добавляет виртуальное устройство CD-ROM к виртуальной машине.

Требования

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

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

Параметры

Параметр

Комментарии

allow_guest_control

логический

Флаг, указывающий, может ли гостевая система подключать и отключать устройство.

Если значение не задано, оно не изменяется.

Варианты:

  • false
  • true

backing

словарь

Физический ресурс, используемый виртуальным устройством CD-ROM.

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

Допустимые атрибуты:

- type (str): Этот параметр задаёт допустимые типы ресурсов, используемых виртуальным устройством CD-ROM. ([‘present’])

Этот ключ обязателен при [‘present’].

- Допустимые значения:

- CLIENT_DEVICE

- HOST_DEVICE

- ISO_FILE

- iso_file (str): Путь к файлу образа, который будет использоваться виртуальным устройством CD-ROM.

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

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

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

- device_access_type (str): Этот параметр задаёт допустимые типы доступа к устройству для физического ресурса виртуального устройства CD-ROM. ([‘present’])

- Допустимые значения:

- EMULATION

- PASSTHRU

- PASSTHRU_EXCLUSIVE

cdrom

строка

Идентификатор виртуального устройства CD-ROM.

Параметр должен содержать идентификатор ресурса, возвращённого модулем vmware.vmware_rest.vcenter_vm_hardware_cdrom. Обязателен при state=[‘absent’, ‘connect’, ‘disconnect’, ‘present’]

ide

словарь

Адрес подключения устройства к виртуальному адаптеру IDE.

Если значение не задано, сервер выберет доступный адрес; если доступных адресов нет, запрос завершится ошибкой.

Допустимые атрибуты:

- primary (bool): Флаг, указывающий, следует ли подключить устройство к первичному или вторичному адаптеру IDE виртуальной машины.

Если значение не задано, сервер выберет адаптер со свободным подключением. Если свободных подключений IDE нет, запрос будет отклонён. ([‘present’])

- master (bool): Флаг, указывающий, должно ли устройство быть ведущим или ведомым на адаптере IDE.

Если значение не задано, сервер выберет доступный тип подключения. Если свободных подключений IDE нет, запрос будет отклонён. ([‘present’])

label

строка

Название элемента

sata

словарь

Адрес подключения устройства к виртуальному адаптеру SATA.

Если значение не задано, сервер выберет доступный адрес; если доступных адресов нет, запрос завершится ошибкой. Обязательно при state=[‘present’]

Допустимые атрибуты:

- bus (int): Номер шины адаптера, к которому следует подключить устройство. ([‘present’])

Этот ключ обязателен при [‘present’].

- unit (int): Номер устройства.

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

session_timeout

число с плавающей точкой

добавлено в vmware.vmware_rest 2.1.0

Настройки времени ожидания для клиентского сеанса.

Максимальное количество секунд для всей операции, включая установление соединения, отправку запроса и получение ответа.

Значение по умолчанию — 300 с.

start_connected

логический

Флаг, указывающий, следует ли подключать виртуальное устройство при каждом включении виртуальной машины.

Если значение не задано, оно не изменяется.

Варианты:

  • false
  • true

state

строка

Варианты:

  • "absent"
  • "connect"
  • "disconnect"
  • "present" ← (по умолчанию)

type

строка

Перечисляемый тип host_bus_adapter_type определяет допустимые типы адаптеров шины узла, которые можно использовать для подключения CD-ROM к виртуальной машине.

Варианты:

  • "IDE"
  • "SATA"

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: Attach an ISO image to a guest VM
  vmware.vmware_rest.vcenter_vm_hardware_cdrom:
    vm: '{{ test_vm1_info.id }}'
    type: SATA
    sata:
      bus: 0
      unit: 2
    start_connected: true
    backing:
      iso_file: '[ro_datastore] fedora.iso'
      type: ISO_FILE
  register: _result

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

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

Ключ

Описание

id

строка

moid ресурса

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

Пример: "16002"

value

словарь

Подключение образа ISO к гостевой виртуальной машине

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

Пример: {"allow_guest_control": 0, "backing": {"iso_file": "[ro_datastore] fedora.iso", "type": "ISO_FILE"}, "label": "CD/DVD drive 1", "sata": {"bus": 0, "unit": 2}, "start_connected": 1, "state": "NOT_CONNECTED", "type": "SATA"}

Статус

  • Этот модуль будет удалён в версии 5.0.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_cdrom_module.html

Spec-Zone.ru

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