community.vmware.vmware_guest_info – Сбор информации о виртуальной машине

Примечание

Этот плагин входит в коллекцию community.vmware (версия 1.6.0).

Для его установки используйте: ansible-galaxy collection install community.vmware.

Чтобы использовать его в книге задач, укажите: community.vmware.vmware_guest_info.

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

Обзор

Сбор информации о виртуальной машине на кластере VMware ESX.
Этот модуль назывался vmware_guest_facts до Ansible 2.9. Способ использования не изменился.

Требования

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

python >= 2.6
PyVmomi

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
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 или ESXi vSphere. Если значение не указано в задаче, будет использовано значение переменной окружения `VMWARE_HOST`. Поддержка переменных окружения добавлена в Ansible 2.6.
moid строка		Идентификатор управляемого объекта экземпляра для управления, если он известен. Это уникальный идентификатор только внутри одного экземпляра vCenter. Требуется, если не указаны `name` или `uuid`.
name строка		Имя виртуальной машины, с которой нужно работать. Требуется, если не указаны `uuid` или `moid`.
name_match строка	Варианты: first ← last	Если найдено несколько виртуальных машин, соответствующих имени, используется первая или последняя найденная.
password строка		Пароль сервера vCenter или ESXi vSphere. Если значение не указано в задаче, будет использовано значение переменной окружения `VMWARE_PASSWORD`. Поддержка переменных окружения добавлена в Ansible 2.6. Псевдонимы: pass, pwd
port целое число	Значение по умолчанию: 443	Номер порта сервера vCenter или ESXi vSphere. Если значение не указано в задаче, будет использовано значение переменной окружения `VMWARE_PORT`. Поддержка переменных окружения добавлена в Ansible 2.6.
properties список / элементы=строка		Укажите свойства для извлечения. Если не указано, извлекаются все свойства (включая вложенные). Результаты возвращаются в структуре, идентичной структуре API vsphere. Пример: properties: [ "config.hardware.memoryMB", "config.hardware.numCPU", "guest.disk", "overallStatus" ] Допустимо только, когда `schema` равно `vsphere`.
proxy_host строка		Адрес прокси-сервера, который будет принимать все запросы HTTPS и перенаправлять их. Формат — имя хоста или IP-адрес. Если значение не указано в задаче, будет использовано значение переменной окружения `VMWARE_PROXY_HOST`. Эта функция зависит от версии pyvmomi, большей v6.7.1.2018.12
proxy_port целое число		Порт HTTP-прокси-сервера, который будет принимать все запросы HTTPS и перенаправлять их. Если значение не указано в задаче, будет использовано значение переменной окружения `VMWARE_PROXY_PORT`.
schema строка	Варианты: summary ← vsphere	Укажите желаемую схему вывода. Схема вывода 'summary' — это устаревшая схема вывода модуля. Схема вывода 'vsphere' — это определение класса API vSphere, которое требует pyvmomi>6.7.1.
tag_details логическое значение добавлено в 1.4.0 community.vmware	Варианты: нет ← да	Если установлено `True`, возвращаются подробные сведения о тегах. Без этого флага 'tags' возвращает список имен тегов. С этим флагом 'tags' возвращает список словарей о сведениях о тегах с дополнительными подробностями, такими как имя категории, идентификатор категории и идентификатор тега. Этот параметр добавлен для обеспечения обратной совместимости.
tags логическое значение	Варианты: нет ← да	Показывать или нет информацию о тегах. Если установлено `True`, отображается информация о тегах. Возвращается список имен тегов. Если установлено `False`, информация о тегах скрывается. Требуется vSphere Automation SDK.
use_instance_uuid логическое значение	Варианты: нет ← да	Использовать идентификатор UUID экземпляра VMware вместо BIOS UUID.
username строка		Имя пользователя сервера vCenter или ESXi vSphere. Если значение не указано в задаче, будет использовано значение переменной окружения `VMWARE_USER`. Поддержка переменных окружения добавлена в Ansible 2.6. Псевдонимы: admin, user
uuid строка		Идентификатор UUID экземпляра для управления, если он известен. Это уникальный идентификатор VMware. Требуется, если не указаны `name` или `moid`.
validate_certs логическое значение	Варианты: нет да ←	Разрешает подключение, когда сертификаты SSL недействительны. Установите в `false` при недоверенных сертификатах. Если значение не указано в задаче, будет использовано значение переменной окружения `VMWARE_VALIDATE_CERTS`. Поддержка переменных окружения добавлена в Ansible 2.6. Если установлено `true`, убедитесь, что на данном компьютере установлен Python >= 2.7.9.

Примечания

Примечание

Тестировано на vSphere 5.5, 6.7

Примеры

- 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 словарь	всегда	Сведения о виртуальной машине Пример: {'annotation': '', 'current_snapshot': None, 'customvalues': {}, 'guest_consolidation_needed': False, 'guest_question': None, 'guest_tools_status': 'guestToolsNotRunning', 'guest_tools_version': '10247', 'hw_cores_per_socket': 1, 'hw_datastores': ['ds_226_3'], 'hw_esxi_host': '10.76.33.226', 'hw_eth0': {'addresstype': 'assigned', 'ipaddresses': None, 'label': 'Сетевой адаптер 1', 'macaddress': '00:50:56:87:a5:9a', 'macaddress_dash': '00-50-56-87-a5-9a', 'portgroup_key': None, 'portgroup_portkey': None, 'summary': 'Сеть виртуальной машины'}, 'hw_files': ['[ds_226_3] ubuntu_t/ubuntu_t.vmx', '[ds_226_3] ubuntu_t/ubuntu_t.nvram', '[ds_226_3] ubuntu_t/ubuntu_t.vmsd', '[ds_226_3] ubuntu_t/vmware.log', '[ds_226_3] u0001/u0001.vmdk'], 'hw_folder': '/DC0/vm/Обнаруженная виртуальная машина', 'hw_guest_full_name': None, 'hw_guest_ha_state': None, 'hw_guest_id': None, 'hw_interfaces': ['eth0'], 'hw_is_template': False, 'hw_memtotal_mb': 1024, 'hw_name': 'ubuntu_t', 'hw_power_status': 'выключено', 'hw_processor_count': 1, 'hw_product_uuid': '4207072c-edd8-3bd5-64dc-903fd3a0db04', 'hw_version': 'vmx-13', 'instance_uuid': '5007769d-add3-1e12-f1fe-225ae2a07caf', 'ipv4': None, 'ipv6': None, 'module_hw': True, 'moid': 'vm-42', 'snapshots': [], 'tags': ['резервная копия'], 'vimref': 'vim.VirtualMachine:vm-42', 'vnc': {}}

Авторы

Лоик Блот (@nerzhul) <loic.blot@unix-experience.fr>

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/vmware/vmware_guest_info_module.html