Модуль community.vmware.vmware_guest_info – Сбор информации о виртуальной машине
Примечание
Этот модуль входит в коллекцию community.vmware (версия 4.7.1).
Вы, возможно, уже установили эту коллекцию, если используете пакет ansible. Она не входит в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install community.vmware.
Чтобы использовать её в плейбуке, укажите: community.vmware.vmware_guest_info.
Обзор
- Сбор информации о конкретной виртуальной машине на кластере VMware ESX.
Параметры
Параметр | Комментарии |
|---|---|
datacenter строка / обязательно | Целевой центр обработки данных для операции развертывания |
folder строка | Целевая папка, абсолютный или относительный путь к существующему гостю. Это требуется, если указан Папка должна включать центр обработки данных. Центр обработки данных ESX — ha-datacenter Примеры: folder: /ha-datacenter/vm folder: ha-datacenter/vm folder: /datacenter1/vm folder: datacenter1/vm folder: /datacenter1/vm/folder1 folder: datacenter1/vm/folder1 folder: /folder1/datacenter1/vm folder: folder1/datacenter1/vm folder: /folder1/datacenter1/vm/folder2 |
hostname строка | Имя хоста или IP-адрес сервера vCenter vSphere или ESXi. Если значение не указано в задаче, вместо него будет использовано значение переменной среды |
moid строка | |
name строка | |
name_match строка | Если несколько виртуальных машин соответствуют имени, использовать первую или последнюю найденную Варианты:
|
password псевдонимы: pass, pwd строка | Пароль сервера vCenter vSphere или ESXi. Если значение не указано в задаче, вместо него будет использовано значение переменной среды |
port целое число | Номер порта сервера vCenter vSphere или ESXi. Если значение не указано в задаче, вместо него будет использовано значение переменной среды По умолчанию: |
properties список / элементы=строка | Укажите свойства для извлечения. Если не указано, все свойства извлекаются (глубоко). Результаты возвращаются в структуре, идентичной API vSphere. Пример: properties: [ “config.hardware.memoryMB”, “config.hardware.numCPU”, “guest.disk”, “overallStatus” ] Только применимо, если |
proxy_host строка | Адрес прокси-сервера, который получит все запросы HTTPS и перенаправит их. Формат — имя хоста или IP-адрес. Если значение не указано в задаче, вместо него будет использовано значение переменной среды |
proxy_port целое число | Порт HTTP-прокси-сервера, который получит все запросы HTTPS и перенаправит их. Если значение не указано в задаче, вместо него будет использовано значение переменной среды |
schema строка | Укажите желаемую схему вывода. Схема вывода Схема вывода Варианты:
|
tag_details логическое | Если установлено Без этого флага С этим флагом Этот параметр добавлен для обеспечения обратной совместимости. Варианты:
|
tags логическое | Показывать теги или нет. Если установлено Если установлено Требуется vSphere Automation SDK. Варианты:
|
use_instance_uuid логическое | Использовать UUID экземпляра VMware вместо UUID BIOS. Варианты:
|
username псевдонимы: admin, user строка | Имя пользователя сервера vCenter vSphere или ESXi. Если значение не указано в задаче, вместо него будет использовано значение переменной среды |
uuid string | |
validate_certs boolean | Разрешает подключение, даже если сертификаты SSL недействительны. Установите в Если значение не указано в задаче, будет использовано значение переменной окружения Варианты:
|
Примечания
Примечание
- Все модули требуют доступа к API для записи и, следовательно, не поддерживаются в бесплатной лицензии ESXi.
- Все переменные и имена объектов VMware чувствительны к регистру.
Примеры
- name: Gather info from standalone ESXi server having datacenter as 'ha-datacenter'
community.vmware.vmware_guest_info:
hostname: "{{ vcenter_hostname }}"
username: "{{ vcenter_username }}"
password: "{{ vcenter_password }}"
datacenter: ha-datacenter
uuid: 421e4592-c069-924d-ce20-7e7533fab926
delegate_to: localhost
register: info
- name: Gather some info from a guest using the vSphere API output schema
community.vmware.vmware_guest_info:
hostname: "{{ vcenter_hostname }}"
username: "{{ vcenter_username }}"
password: "{{ vcenter_password }}"
datacenter: "{{ datacenter_name }}"
name: "{{ vm_name }}"
schema: "vsphere"
properties: ["config.hardware.memoryMB", "guest.disk", "overallStatus"]
delegate_to: localhost
register: info
- name: Gather some information about a guest using MoID
community.vmware.vmware_guest_info:
hostname: "{{ vcenter_hostname }}"
username: "{{ vcenter_username }}"
password: "{{ vcenter_password }}"
datacenter: "{{ datacenter_name }}"
moid: vm-42
schema: "vsphere"
properties: ["config.hardware.memoryMB", "guest.disk", "overallStatus"]
delegate_to: localhost
register: vm_moid_info
- name: Gather Managed object ID (moid) from a guest using the vSphere API output schema for REST Calls
community.vmware.vmware_guest_info:
hostname: "{{ vcenter_hostname }}"
username: "{{ vcenter_username }}"
password: "{{ vcenter_password }}"
datacenter: "{{ datacenter_name }}"
name: "{{ vm_name }}"
schema: "vsphere"
properties:
- _moId
delegate_to: localhost
register: moid_info
- name: Gather detailed information about tags and category associated with the given VM
community.vmware.vmware_guest_info:
hostname: "{{ vcenter_hostname }}"
username: "{{ vcenter_username }}"
password: "{{ vcenter_password }}"
datacenter: "{{ datacenter_name }}"
name: "{{ vm_name }}"
tags: true
tag_details: true
register: detailed_tag_info
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
Ключ | Описание |
|---|---|
instance dictionary | Метаданные о виртуальной машине Возвращается: всегда Пример: |
Ссылки на коллекцию
© 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/community/vmware/vmware_guest_info_module.html
