Модуль vmware.vmware_rest.vcenter_vm_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_info.
Добавлено в vmware.vmware_rest 0.1.0
Краткое описание
- Возвращает информацию о виртуальной машине.
Требования
На узле, выполняющем этот модуль, должны быть установлены следующие компоненты.
- vSphere 7.0.3 или более поздней версии
- python >= 3.6
- aiohttp
Параметры
Параметр | Комментарии |
|---|---|
clusters list / elements=string | Кластеры, в которых должна находиться виртуальная машина, чтобы соответствовать фильтру. Если значение не задано или пусто, фильтру соответствуют виртуальные машины в любых кластерах. Если клиент передает значение этой структуры в качестве параметра, поле должно содержать идентификатор ресурса, возвращенного модулем vmware.vmware_rest.vcenter_cluster_info. |
datacenters псевдонимы: filter_datacenters list / elements=string | Центры обработки данных, в которых должна находиться виртуальная машина, чтобы соответствовать фильтру. Если значение не задано или пусто, фильтру соответствуют виртуальные машины в любых центрах обработки данных. Если клиент передает значение этой структуры в качестве параметра, поле должно содержать идентификатор ресурса, возвращенного модулем vmware.vmware_rest.vcenter_datacenter_info. |
folders псевдонимы: filter_folders list / elements=string | Папки, в которых должна находиться виртуальная машина, чтобы соответствовать фильтру. Если значение не задано или пусто, фильтру соответствуют виртуальные машины в любых папках. Если клиент передает значение этой структуры в качестве параметра, поле должно содержать идентификатор ресурса, возвращенного модулем vmware.vmware_rest.vcenter_folder_info. |
hosts list / elements=string | Узлы, на которых должна находиться виртуальная машина, чтобы соответствовать фильтру. Если значение не задано или пусто, фильтру соответствуют виртуальные машины на любых узлах. Если клиент передает значение этой структуры в качестве параметра, поле должно содержать идентификатор ресурса, возвращенного модулем vmware.vmware_rest.vcenter_host_info. |
names псевдонимы: filter_names list / elements=string | Имена, которым должны соответствовать виртуальные машины, чтобы пройти фильтр (см. name). Если значение не задано или пусто, фильтру соответствуют виртуальные машины с любыми именами. |
power_states list / elements=string | Состояния питания, в которых должна находиться виртуальная машина, чтобы соответствовать фильтру (см. Если значение не задано или пусто, фильтру соответствуют виртуальные машины с любым состоянием питания. |
resource_pools list / elements=string | Пулы ресурсов, в которых должна находиться виртуальная машина, чтобы соответствовать фильтру. Если значение не задано или пусто, фильтру соответствуют виртуальные машины в любых пулах ресурсов. Если клиент передает значение этой структуры в качестве параметра, поле должно содержать идентификатор ресурса, возвращенного модулем vmware.vmware_rest.vcenter_resourcepool_info. |
session_timeout float добавлено в vmware.vmware_rest 2.1.0 | Настройки времени ожидания сеанса клиента. Максимальное количество секунд для всей операции, включая установление соединения, отправку запроса и получение ответа. Значение по умолчанию — 300 с. |
vcenter_hostname string / обязательный | Имя узла или IP-адрес vSphere vCenter Если значение не указано в задаче, вместо него будет использовано значение переменной среды |
vcenter_password string / обязательный | Пароль vSphere vCenter Если значение не указано в задаче, вместо него будет использовано значение переменной среды |
vcenter_rest_log_file string | С помощью этого необязательного параметра можно задать расположение файла журнала. Этот файл будет использоваться для записи взаимодействия с HTTP REST. Файл будет сохранен на узле, на котором выполняется модуль. Если значение не указано в задаче, вместо него будет использовано значение переменной среды |
vcenter_username string / обязательный | Имя пользователя vSphere vCenter Если значение не указано в задаче, вместо него будет использовано значение переменной среды |
vcenter_validate_certs boolean | Разрешает подключение, если SSL-сертификаты недействительны. Установите значение Если значение не указано в задаче, вместо него будет использовано значение переменной среды Варианты:
|
vm string | Идентификатор виртуальной машины. Параметр должен содержать идентификатор ресурса, возвращенного модулем vmware.vmware_rest.vcenter_vm_info. Обязателен при state=[‘get’] |
vms list / elements=string | Идентификаторы виртуальных машин, которые могут соответствовать фильтру. Если значение не задано или пусто, фильтру соответствуют виртуальные машины с любыми идентификаторами. Если клиент передает значение этой структуры в качестве параметра, поле должно содержать идентификатор ресурса, возвращенного модулем 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 string | moid ресурса Возвращается: при успехе Пример: |
value dictionary | Дождаться выключения моей виртуальной машины Возвращается: при успехе Пример: |
Ссылки на коллекцию
© 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_info_module.html