vmware.vmware_rest.vcenter_vm_hardware_cdrom модуль — Добавляет виртуальное устройство CD-ROM в виртуальную машину.
Примечание
Этот модуль является частью коллекции 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_cdrom.
Введено в vmware.vmware_rest 0.1.0
Описание
- Добавляет виртуальное устройство CD-ROM в виртуальную машину.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- vSphere 7.0.3 или выше
- python >= 3.6
- aiohttp
Параметры
Параметр | Комментарии |
|---|---|
allow_guest_control boolean | Флаг, указывающий, может ли гость подключать и отключать устройство. Если не указано, значение не изменяется. Варианты:
|
backing dictionary | Физический ресурс, поддерживающий виртуальное устройство CD-ROM. Если не указано, используется автоматическое определение подходящего устройства хоста. Требуется с state=[‘present’] Допустимые атрибуты:
Этот ключ необходим с [‘present’].
Это поле является необязательным и актуально только тогда, когда значение type равно ISO_FILE. ([‘present’])
Если не указано, виртуальное устройство CD-ROM будет настроено на автоматическое обнаружение подходящего устройства хоста. ([‘present’])
|
cdrom string | Идентификатор виртуального устройства CD-ROM. Параметр должен быть id ресурса, возвращаемого vmware.vmware_rest.vcenter_vm_hardware_cdrom. Требуется с state=[‘absent’, ‘connect’, ‘disconnect’, ‘present’] |
ide dictionary | Адрес для подключения устройства к виртуальному адаптеру IDE. Если не указано, сервер выберет доступный адрес; если доступных адресов нет, запрос завершится ошибкой. Допустимые атрибуты:
Если не указано, сервер выберет адаптер с доступным подключением. Если доступных подключений IDE нет, запрос будет отклонен. ([‘present’])
Если не указано, сервер выберет доступный тип подключения. Если доступных подключений IDE нет, запрос будет отклонен. ([‘present’]) |
label string | Имя элемента |
sata dictionary | Адрес для подключения устройства к виртуальному адаптеру SATA. Если не указано, сервер выберет доступный адрес; если доступных адресов нет, запрос завершится ошибкой. Требуется с state=[‘present’] Допустимые атрибуты:
Этот ключ необходим с [‘present’].
Если не указано, сервер выберет доступный номер устройства на указанном адаптере. Если на адаптере нет доступных подключений, запрос будет отклонен. ([‘present’]) |
session_timeout float добавлено в vmware.vmware_rest 2.1.0 | Параметры времени ожидания для сеанса клиента. Максимальное количество секунд для всей операции, включая установление соединения, отправку запроса и получение ответа. Значение по умолчанию — 300 с. |
start_connected boolean | Флаг, указывающий, должно ли виртуальное устройство быть подключено при каждом включении виртуальной машины. Если не указано, значение не изменяется. Варианты:
|
state string | Варианты:
|
type string | Перечисляемый тип host_bus_adapter_type определяет допустимые типы адаптеров шины хоста, которые могут использоваться для подключения Cdrom к виртуальной машине. Варианты:
|
vcenter_hostname string / required | Имя хоста или IP-адрес vSphere vCenter Если значение не указано в задаче, вместо него будет использовано значение переменной среды |
vcenter_password string / required | Пароль vSphere vCenter Если значение не указано в задаче, вместо него будет использовано значение переменной среды |
vcenter_rest_log_file string | Этот необязательный параметр можно использовать для указания местоположения файла журнала. Этот файл будет использоваться для записи взаимодействия HTTP REST. Файл будет храниться на хосте, на котором запущен модуль. Если значение не указано в задаче, вместо него будет использовано значение переменной среды |
vcenter_username string / required | Имя пользователя vSphere vCenter Если значение не указано в задаче, вместо него будет использовано значение переменной среды |
vcenter_validate_certs boolean | Разрешает подключение, когда сертификаты SSL недействительны. Установите в Если значение не указано в задаче, будет использовано значение переменной окружения Варианты:
|
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: 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 string | moid ресурса Возвращается: При успехе Пример: |
value словарь | Присоединение образа ISO к гостевой виртуальной машине Возвращается: При успехе Пример: |
Ссылки на сборку
© 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_cdrom_module.html