Spec-Zone.ru › Ansible

Модуль vmware.vmware_rest.vcenter_vm_hardware_disk_info — возвращает информацию о виртуальном диске.

Примечание

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

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

  • Краткое описание
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

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

  • Возвращает информацию о виртуальном диске.

Требования

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

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

Параметры

Параметр

Комментарии

disk

string

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

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

label

string

Имя элемента

session_timeout

float

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

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

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

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

vcenter_hostname

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

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

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

vcenter_password

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

Пароль vSphere vCenter

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

vcenter_rest_log_file

string

С помощью этого необязательного параметра можно указать расположение файла журнала.

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

Файл будет сохранен на хосте, на котором выполняется модуль.

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

переменной среды VMWARE_REST_LOG_FILE.

vcenter_username

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

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

Если значение не указано в задаче, вместо него будет использовано значение переменной среды 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: Retrieve the disk information from the VM
  vmware.vmware_rest.vcenter_vm_hardware_disk_info:
    vm: '{{ test_vm1_info.id }}'
  register: _result

- name: Retrieve disk information using the label
  vmware.vmware_rest.vcenter_vm_hardware_disk_info:
    vm: '{{ test_vm1_info.id }}'
    label: Hard disk 1
  register: _result

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

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

Ключ

Описание

id

string

MOID ресурса

Возвращается: При успешном выполнении

Пример: "2000"

value

dictionary

Получение информации о диске по метке

Возвращается: При успешном выполнении

Пример: {"backing": {"type": "VMDK_FILE", "vmdk_file": "[local] test_vm1/test_vm1.vmdk"}, "capacity": 17179869184, "label": "Hard disk 1", "scsi": {"bus": 0, "unit": 0}, "type": "SCSI"}

Авторы

  • Ansible Cloud Team (@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_disk_info_module.html

Spec-Zone.ru

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