Spec-Zone.ru › Ansible

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

Примечание

Этот модуль является частью коллекции vmware.vmware_rest (версия 3.2.0).

Эта коллекция может быть уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install vmware.vmware_rest. Для использования этого модуля требуются дополнительные компоненты, см. Требования для подробной информации.

Для использования в playbook, укажите: vmware.vmware_rest.vcenter_vm_hardware_disk_info.

Новое в vmware.vmware_rest 0.1.0

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

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

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

Требования

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

  • vSphere 7.0.3 или выше
  • python >= 3.6
  • aiohttp

Параметры

Параметр

Комментарии

disk

string

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

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

label

string

Имя элемента

session_timeout

float

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

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

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

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

vcenter_hostname

string / required

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

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

vcenter_password

string / required

Пароль vSphere vCenter

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

vcenter_rest_log_file

string

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

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

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

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

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

vcenter_username

string / required

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

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

vcenter_validate_certs

boolean

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

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

Варианты:

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

vm

string / required

Идентификатор виртуальной машины.

Параметр должен быть id ресурса, возвращаемого 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–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_info_module.html

Spec-Zone.ru

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