Spec-Zone.ru › Ansible

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

Примечание

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

Новая в vmware.vmware_rest 0.1.0

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

Описание

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

Требования

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

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

Параметры

Параметр

Комментарии

clusters

список / элементы=строка

Кластеры, которые должны содержать виртуальную машину для соответствия фильтру.

Если не задано или пусто, виртуальные машины в любом кластере соответствуют фильтру.

При передаче клиентом значения этой структуры в качестве параметра поле должно содержать идентификатор ресурсов, возвращаемых модулем vmware.vmware_rest.vcenter_cluster_info.

datacenters

псевдонимы: filter_datacenters

список / элементы=строка

Центры обработки данных, которые должны содержать виртуальную машину для соответствия фильтру.

Если не задано или пусто, виртуальные машины в любом ЦОД соответствуют фильтру.

При передаче клиентом значения этой структуры в качестве параметра поле должно содержать идентификатор ресурсов, возвращаемых модулем vmware.vmware_rest.vcenter_datacenter_info.

folders

псевдонимы: filter_folders

список / элементы=строка

Папки, которые должны содержать виртуальную машину для соответствия фильтру.

Если не задано или пусто, виртуальные машины в любой папке соответствуют фильтру.

При передаче клиентом значения этой структуры в качестве параметра поле должно содержать идентификатор ресурсов, возвращаемых модулем vmware.vmware_rest.vcenter_folder_info.

hosts

список / элементы=строка

Хосты, которые должны содержать виртуальную машину для соответствия фильтру.

Если не задано или пусто, виртуальные машины на любом хосте соответствуют фильтру.

При передаче клиентом значения этой структуры в качестве параметра поле должно содержать идентификатор ресурсов, возвращаемых модулем vmware.vmware_rest.vcenter_host_info.

names

псевдонимы: filter_names

список / элементы=строка

Имена, которые должны иметь виртуальные машины для соответствия фильтру (см. name).

Если не задано или пусто, виртуальные машины с любым именем соответствуют фильтру.

power_states

список / элементы=строка

Состояния питания, в которых должна находиться виртуальная машина для соответствия фильтру (см.

Если не задано или пусто, виртуальные машины в любом состоянии питания соответствуют фильтру.

resource_pools

список / элементы=строка

Пулы ресурсов, которые должны содержать виртуальную машину для соответствия фильтру.

Если не задано или пусто, виртуальные машины в любом пуле ресурсов соответствуют фильтру.

При передаче клиентом значения этой структуры в качестве параметра поле должно содержать идентификатор ресурсов, возвращаемых модулем vmware.vmware_rest.vcenter_resourcepool_info.

session_timeout

вещественное число

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

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

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

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

vcenter_hostname

строка / обязательно

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

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

vcenter_password

строка / обязательно

Пароль vCenter vSphere

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

vcenter_rest_log_file

строка

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

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

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

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

vcenter_username

строка / обязательно

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

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

vcenter_validate_certs

булево

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

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

Варианты:

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

vm

строка

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

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

vms

список / элементы=строка

Идентификаторы виртуальных машин, которые могут соответствовать фильтру.

Если не задано или пусто, виртуальные машины с любым идентификатором соответствуют фильтру.

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

Примечания

Примечание

  • Тестировалось на vSphere 7.0.3

Примеры

- name: Create a VM
  vmware.vmware_rest.vcenter_vm:
    placement:
      cluster: "{{ lookup('vmware.vmware_rest.cluster_moid', '/my_dc/host/my_cluster') }}"
      datastore: "{{ lookup('vmware.vmware_rest.datastore_moid', '/my_dc/datastore/local') }}"
      folder: "{{ lookup('vmware.vmware_rest.folder_moid', '/my_dc/vm') }}"
      resource_pool: "{{ lookup('vmware.vmware_rest.resource_pool_moid', '/my_dc/host/my_cluster/Resources') }}"
    name: test_vm1
    guest_OS: RHEL_7_64
    hardware_version: VMX_11
    memory:
      hot_add_enabled: true
      size_MiB: 1024
    disks:
    - type: SATA
      backing:
        type: VMDK_FILE
        vmdk_file: '[local] test_vm1/{{ disk_name }}.vmdk'
    - type: SATA
      new_vmdk:
        name: second_disk
        capacity: 32000000000
    cdroms:
    - type: SATA
      sata:
        bus: 0
        unit: 2
    nics:
    - backing:
        type: STANDARD_PORTGROUP
        network: "{{ lookup('vmware.vmware_rest.network_moid', '/my_dc/network/VM Network') }}"
  register: my_vm

- name: Wait until my VM is off
  vmware.vmware_rest.vcenter_vm_info:
    vm: '{{ my_vm.id }}'
  register: vm_info
  until:
  - vm_info is not failed
  - vm_info.value.power_state == "POWERED_OFF"
  retries: 60
  delay: 5

- register: _should_be_empty
  name: Search with an invalid filter
  vmware.vmware_rest.vcenter_vm_info:
    filter_names: test_vm1_does_not_exists

- 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

Значения возврата

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

Ключ

Описание

id

строка

moid ресурса

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

Пример: "vm-1049"

значение

словарь

Подождите, пока моя ВМ выключится

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

Пример: {"boot": {"delay": 0, "enter_setup_mode": 0, "retry": 0, "retry_delay": 10000, "type": "BIOS"}, "boot_devices": [], "cdroms": {"16002": {"allow_guest_control": 0, "backing": {"auto_detect": 1, "device_access_type": "EMULATION", "type": "HOST_DEVICE"}, "label": "CD/DVD drive 1", "sata": {"bus": 0, "unit": 2}, "start_connected": 0, "state": "NOT_CONNECTED", "type": "SATA"}}, "cpu": {"cores_per_socket": 1, "count": 1, "hot_add_enabled": 0, "hot_remove_enabled": 0}, "disks": {"16000": {"backing": {"type": "VMDK_FILE", "vmdk_file": "[local] test_vm1/rhel-8.5.vmdk"}, "capacity": 16106127360, "label": "Hard disk 1", "sata": {"bus": 0, "unit": 0}, "type": "SATA"}, "16001": {"backing": {"type": "VMDK_FILE", "vmdk_file": "[local] test_vm1_1/second_disk.vmdk"}, "capacity": 32000000000, "label": "Hard disk 2", "sata": {"bus": 0, "unit": 1}, "type": "SATA"}}, "floppies": {}, "guest_OS": "RHEL_7_64", "hardware": {"upgrade_policy": "NEVER", "upgrade_status": "NONE", "version": "VMX_11"}, "identity": {"bios_uuid": "4231943a-a1b5-9d24-1e05-d447e9ff0396", "instance_uuid": "5031e081-01a7-d61a-31f8-4bc54057ec60", "name": "test_vm1"}, "instant_clone_frozen": 0, "memory": {"hot_add_enabled": 1, "size_MiB": 1024}, "name": "test_vm1", "nics": {"4000": {"allow_guest_control": 0, "backing": {"network": "network-1041", "network_name": "VM Network", "type": "STANDARD_PORTGROUP"}, "label": "Network adapter 1", "mac_address": "00:50:56:b1:22:7d", "mac_type": "ASSIGNED", "pci_slot_number": 160, "start_connected": 0, "state": "NOT_CONNECTED", "type": "VMXNET3", "upt_compatibility_enabled": 0, "wake_on_lan_enabled": 0}}, "nvme_adapters": {}, "parallel_ports": {}, "power_state": "POWERED_OFF", "sata_adapters": {"15000": {"bus": 0, "label": "SATA controller 0", "pci_slot_number": 32, "type": "AHCI"}}, "scsi_adapters": {}, "serial_ports": {}}

Авторы

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

Spec-Zone.ru

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