Модуль vmware.vmware_rest.vcenter_vm_hardware_disk — добавляет виртуальной машине виртуальный диск с тонким выделением ресурсов
Примечание
Этот модуль входит в коллекцию 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_disk.
Добавлено в vmware.vmware_rest 0.1.0
УСТАРЕЛ
- Удален в:
-
версии 5.0.0
- Причина:
-
Этот модуль перенесен в новую коллекцию vmware.vmware
- Альтернатива:
-
Вместо него используйте vmware.vmware.vm.
Краткое описание
- Добавляет виртуальный диск к виртуальной машине. Тип выделения ресурсов для диска всегда «тонкий». При добавлении виртуального диска можно создать новый файл VMDK или использовать существующий файл VMDK для виртуального диска.
Требования
На узле, выполняющем этот модуль, должны быть установлены следующие компоненты.
- vSphere 7.0.3 или новее
- python >= 3.6
- aiohttp
Параметры
Параметр | Комментарии |
|---|---|
backing словарь | Существующий физический ресурс, используемый виртуальным диском. Необходимо указать ровно один из параметров backing или new_vmdk. Если параметр не задан, виртуальный диск не будет подключен к существующему ресурсу. Обязателен при state=[‘present’] Допустимые атрибуты: - Этот ключ обязателен при [‘present’]. - Допустимые значения: - VMDK_FILE - Это поле необязательно и имеет значение только тогда, когда значение type равно VMDK_FILE. ([‘present’]) |
disk строка | Идентификатор виртуального диска. Значением параметра должен быть идентификатор ресурса, возвращаемый модулем vmware.vmware_rest.vcenter_vm_hardware_disk. Обязателен при state=[‘absent’, ‘present’] |
ide словарь | Адрес для подключения устройства к виртуальному адаптеру IDE. Если параметр не задан, сервер выберет доступный адрес; если доступных адресов нет, запрос завершится ошибкой. Допустимые атрибуты: - Если параметр не задан, сервер выберет адаптер со свободным подключением. Если свободных подключений IDE нет, запрос будет отклонен. ([‘present’]) - Если параметр не задан, сервер выберет доступный тип подключения. Если свободных подключений IDE нет, запрос будет отклонен. ([‘present’]) |
label строка | Имя элемента |
new_vmdk словарь | Параметры создания нового ресурса VMDK для виртуального диска. Необходимо указать ровно один из параметров backing или new_vmdk. Если параметр не задан, новый ресурс VMDK создан не будет. Допустимые атрибуты: - Если параметр не задан, сервер выберет имя на основе имени виртуальной машины. ([‘present’]) - Если параметр не задан, используется емкость, заданная по умолчанию для гостевой системы. ([‘present’]) - Если параметр не задан, применяется политика хранения по умолчанию для целевого хранилища данных (если применимо). В настоящее время политика хранения по умолчанию поддерживается только объектными хранилищами данных: VVol и vSAN. Для необъектных хранилищ данных, если параметр не задан, с файлом VMDK не будет связана политика хранения. ([‘present’]) - Допустимые ключи: - policy (string): Идентификатор политики хранения, которая должна быть связана с файлом VMDK. При передаче клиентами значения этой структуры в качестве параметра поле должно содержать идентификатор ресурса, возвращаемый модулем vmware.vmware_rest.vcenter_storage_policies_info. |
nvme словарь | Адрес для подключения устройства к виртуальному адаптеру NVMe. Если параметр не задан, сервер выберет доступный адрес; если доступных адресов нет, запрос завершится ошибкой. Обязателен при state=[‘present’] Допустимые атрибуты: - Этот ключ обязателен при [‘present’]. - Если параметр не задан, сервер выберет доступный номер устройства на указанном адаптере. Если на адаптере нет свободных подключений, запрос будет отклонен. ([‘present’]) |
sata словарь | Адрес для подключения устройства к виртуальному адаптеру SATA. Если параметр не задан, сервер выберет доступный адрес; если доступных адресов нет, запрос завершится ошибкой. Обязателен при state=[‘present’] Допустимые атрибуты: - Этот ключ обязателен при [‘present’]. - Если параметр не задан, сервер выберет доступный номер устройства на указанном адаптере. Если на адаптере нет свободных подключений, запрос будет отклонен. ([‘present’]) |
scsi словарь | Адрес для подключения устройства к виртуальному адаптеру SCSI. Если параметр не задан, сервер выберет доступный адрес; если доступных адресов нет, запрос завершится ошибкой. Обязателен при state=[‘present’] Допустимые атрибуты: - Этот ключ обязателен при [‘present’]. - Если параметр не задан, сервер выберет доступный номер устройства на указанном адаптере. Если на адаптере нет свободных подключений, запрос будет отклонен. ([‘present’]) |
session_timeout число с плавающей точкой добавлено в vmware.vmware_rest 2.1.0 | Настройки времени ожидания для сеанса клиента. Максимальное количество секунд для всей операции, включая установление соединения, отправку запроса и получение ответа. Значение по умолчанию — 300 с. |
state строка | Варианты:
|
type строка | Перечисление host_bus_adapter_type определяет допустимые типы адаптеров шины хоста, которые можно использовать для подключения виртуального устройства хранения к виртуальной машине. Варианты:
|
vcenter_hostname строка / обязательный | Имя хоста или IP-адрес vSphere vCenter Если значение не указано в задаче, вместо него будет использовано значение переменной среды |
vcenter_password строка / обязательный | Пароль vSphere vCenter Если значение не указано в задаче, вместо него будет использовано значение переменной среды |
vcenter_rest_log_file строка | С помощью этого необязательного параметра можно задать расположение файла журнала. Этот файл будет использоваться для записи взаимодействия HTTP REST. Файл будет сохранен на узле, на котором выполняется модуль. Если значение не указано в задаче, вместо него будет использовано значение переменной среды |
vcenter_username строка / обязательный | Имя пользователя vSphere vCenter Если значение не указано в задаче, вместо него будет использовано значение переменной среды |
vcenter_validate_certs логическое значение | Разрешает подключение при недействительных сертификатах SSL. Если сертификаты не являются доверенными, задайте значение Если значение не указано в задаче, вместо него будет использовано значение переменной среды Варианты:
|
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: Create a new disk
vmware.vmware_rest.vcenter_vm_hardware_disk:
vm: '{{ test_vm1_info.id }}'
type: SATA
new_vmdk:
capacity: 320000
register: my_new_disk
- name: Delete the disk
vmware.vmware_rest.vcenter_vm_hardware_disk:
vm: '{{ test_vm1_info.id }}'
disk: '{{ my_new_disk.id }}'
state: absent
register: _result
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
id строка | MOID ресурса Возвращается: при успешном выполнении Пример: |
value словарь | Создание нового диска Возвращается: при успешном выполнении Пример: |
Статус
- Этот модуль будет удален в версии 5.0.0. [устарел]
- Дополнительные сведения см. в разделе УСТАРЕЛ.
Ссылки на коллекцию
© 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_disk_module.html