vmware_guest_facts – Сбор фактов о виртуальной машине

Новая версия 2.3.

Обзор
Требования
Параметры
Примечания
Примеры
Возвращаемые значения
Статус

Обзор

Сбор фактов о виртуальной машине на кластере VMware ESX.

Требования

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

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 folder: vm/folder2 folder: folder2
hostname строка		Имя хоста или IP-адрес сервера vCenter vSphere или ESXi. Если значение не указано в задаче, используется значение переменной среды `VMWARE_HOST`. Поддержка переменных среды добавлена в Ansible 2.6.
name -		Имя виртуальной машины, с которой нужно работать. Обязательно, если не указан UUID.
name_match -	Варианты: первый ← последний	Если несколько виртуальных машин соответствуют имени, используется первая или последняя найденная.
password строка		Пароль сервера vCenter vSphere или ESXi. Если значение не указано в задаче, используется значение переменной среды `VMWARE_PASSWORD`. Поддержка переменных среды добавлена в Ansible 2.6. псевдонимы: pass, pwd
port целое число добавлен в 2.5	По умолчанию: 443	Номер порта сервера vCenter vSphere или ESXi. Если значение не указано в задаче, используется значение переменной среды `VMWARE_PORT`. Поддержка переменных среды добавлена в Ansible 2.6.
properties список добавлен в 2.8		Укажите свойства для извлечения. Если не указано, извлекаются все свойства (глубоко). Результаты возвращаются в структуре, идентичной структуре API vsphere. Пример: properties: [ "config.hardware.memoryMB", "config.hardware.numCPU", "guest.disk", "overallStatus" ] Только при `schema` `vsphere`.
schema строка добавлен в 2.8	Варианты: сводка ← vsphere	Укажите желаемую схему вывода. Схема вывода 'сводка' — это устаревшая схема вывода модуля. Схема вывода 'vsphere' — это определение класса API vSphere, которое требует pyvmomi > 6.7.1
tags логическое значение добавлен в 2.8	Варианты: нет ← да	Показывать или нет теги. Если установлено `True`, отображаются фактические данные тегов. Если установлено `False`, данные тегов скрываются. Требуется vSphere Automation SDK и vCloud Suite SDK.
use_instance_uuid логическое значение добавлен в 2.8	Варианты: нет ← да	Использовать UUID экземпляра VMware вместо BIOS UUID.
username строка		Имя пользователя сервера vCenter vSphere или ESXi. Если значение не указано в задаче, используется значение переменной среды `VMWARE_USER`. Поддержка переменных среды добавлена в Ansible 2.6. псевдонимы: admin, user
uuid -		UUID экземпляра для управления, если известен, это уникальный идентификатор VMware. Обязательно, если не указано имя.
validate_certs логическое значение	Варианты: нет да ←	Разрешает подключение, когда сертификаты SSL недействительны. Установите значение в `false`, когда сертификаты не доверяются. Если значение не указано в задаче, используется значение переменной среды `VMWARE_VALIDATE_CERTS`. Поддержка переменных среды добавлена в Ansible 2.6. Если установлено `yes`, убедитесь, что на данном компьютере установлен Python >= 2.7.9.

Примечания

Примечание

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

Примеры

- name: Gather facts from standalone ESXi server having datacenter as 'ha-datacenter'
  vmware_guest_facts:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    datacenter: ha-datacenter
    validate_certs: no
    uuid: 421e4592-c069-924d-ce20-7e7533fab926
  delegate_to: localhost
  register: facts

- name: Gather some facts from a guest using the vSphere API output schema
  vmware_guest_facts:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    validate_certs: no
    datacenter: "{{ datacenter_name }}"
    name: "{{ vm_name }}"
    schema: "vsphere"
    properties: ["config.hardware.memoryMB", "guest.disk", "overallStatus"]
  delegate_to: localhost
  register: facts

Возвращаемые значения

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

Ключ	Возвращаемое значение	Описание
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, 'snapshots': [], 'tags': ['резервная копия'], 'vnc': {}}

Статус

Данному модулю не гарантируется обратная совместимость интерфейса. [превью]
Этот модуль поддерживается сообществом Ansible. [сообщество]

Авторы

Loic Blot (@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.8/modules/vmware_guest_facts_module.html