Spec-Zone.ru › Ansible

vmware.vmware_rest.vcenter_vm_hardware_disk модуль — Добавляет виртуальный диск к виртуальной машине

Примечание

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

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

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

Описание

  • Добавляет виртуальный диск к виртуальной машине. При добавлении виртуального диска может быть создан новый файл VMDK или использован существующий файл VMDK для поддержки виртуального диска.

Требования

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

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

Параметры

Параметр

Комментарии

backing

dictionary

Существующий физический ресурс, поддерживающий виртуальный диск. Должен быть указан ровно один из параметров backing или new_vmdk.

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

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

  • type (str): Этот параметр определяет допустимые типы носителей для виртуального диска. ([‘present’])

Этот ключ необходим с [‘present’].

  • Допустимые значения:
  • VMDK_FILE
  • vmdk_file (str): Путь к файлу VMDK, поддерживающему виртуальный диск.

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

disk

string

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

Параметр должен быть идентификатором ресурса, возвращаемого функцией vmware.vmware_rest.vcenter_vm_hardware_disk. Требуется с state=[‘absent’, ‘present’]

ide

dictionary

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

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

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

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

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

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

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

label

string

Имя элемента

new_vmdk

dictionary

Спецификация для создания нового носителя VMDK для виртуального диска. Должен быть указан ровно один из параметров backing или new_vmdk.

Если не указано, новый носитель VMDK создаваться не будет.

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

  • name (str): Базовое имя файла VMDK. Имя не должно включать расширение файла ‘.vmdk’.

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

  • capacity (int): Емкость носителя виртуального диска в байтах.

Если не указано, используется емкость, зависящая от гостевой ОС. ([‘present’])

  • storage_policy (dict): Структура storage_policy_spec содержит информацию о политике хранения, которая должна быть связана с файлом VMDK.

Если не указано, применяется политика хранения по умолчанию целевого хранилища (если применимо). В настоящее время политика хранения по умолчанию поддерживается только объектно-ориентированными хранилищами: VVol & vSAN. Для хранилищ, не являющихся объектно-ориентированными, если не указано, политика хранения не будет связана с файлом VMDK. ([‘present’])

  • Допустимые ключи:
  • policy (string): Идентификатор политики хранения, которая должна быть связана с файлом VMDK.

Когда клиенты передают значение этой структуры в качестве параметра, поле должно быть идентификатором ресурса политики хранения.

nvme

dictionary

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

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

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

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

Этот ключ необходим с [‘present’].

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

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

sata

dictionary

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

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

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

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

Этот ключ необходим с [‘present’].

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

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

scsi

dictionary

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

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

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

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

Этот ключ необходим с [‘present’].

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

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

session_timeout

float

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

Параметры времени ожидания для сессии клиента.

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

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

state

string

Варианты:

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

type

string

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

Варианты:

  • "IDE"
  • "NVME"
  • "SATA"
  • "SCSI"

vcenter_hostname

string / required

Имя хоста или IP-адрес vSphere vCenter

Если значение не указано в задаче, вместо него будет использовано значение переменной среды VMWARE_HOST.

vcenter_password

string / обязательно

Пароль vCenter vSphere

Если значение не указано в задаче, будет использовано значение переменной окружения VMWARE_PASSWORD.

vcenter_rest_log_file

string

Вы можете использовать этот необязательный параметр для указания расположения файла журнала.

Этот файл будет использоваться для записи взаимодействия HTTP REST.

Файл будет сохранён на хосте, на котором запущен модуль.

Если значение не указано в задаче, будет использовано значение

переменной окружения VMWARE_REST_LOG_FILE.

vcenter_username

string / обязательно

Имя пользователя vCenter vSphere

Если значение не указано в задаче, будет использовано значение переменной окружения VMWARE_USER.

vcenter_validate_certs

boolean

Разрешает подключение, когда сертификаты SSL не валидны. Установите в false, если сертификаты не доверенны.

Если значение не указано в задаче, будет использовано значение переменной окружения VMWARE_VALIDATE_CERTS.

Варианты:

  • false
  • true ← (по умолчанию)

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: 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

string

moid ресурса

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

Пример: "16000"

value

словарь

Создать новый диск

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

Пример: {"backing": {"type": "VMDK_FILE", "vmdk_file": "[local] test_vm1/test_vm1_1.vmdk"}, "capacity": 320000, "label": "Hard disk 2", "sata": {"bus": 0, "unit": 0}, "type": "SATA"}

Авторы

  • Команда 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_disk_module.html

Spec-Zone.ru

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