vmware_vm_facts – Возвращение основных фактов о гостевой машине VMware

Новое в версии 2.0.

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

Обзор

Возвращение основных фактов о гостевой машине виртуальной машины vSphere или ESXi.
Имя кластера как факт добавлено в версии 2.7.

Требования

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

python >= 2.6
PyVmomi

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
hostname строка		Имя хоста или IP-адрес сервера vCenter vSphere или ESXi. Если значение не указано в задаче, используется значение переменной окружения `VMWARE_HOST`. Поддержка переменных окружения добавлена в Ansible 2.6.
password строка		Пароль сервера vCenter vSphere или ESXi. Если значение не указано в задаче, используется значение переменной окружения `VMWARE_PASSWORD`. Поддержка переменных окружения добавлена в Ansible 2.6. псевдонимы: pass, pwd
port целое число добавлено в 2.5	По умолчанию: 443	Номер порта сервера vCenter vSphere или ESXi. Если значение не указано в задаче, используется значение переменной окружения `VMWARE_PORT`. Поддержка переменных окружения добавлена в Ansible 2.6.
show_attribute логическое значение добавлено в 2.8	Варианты: нет ← да	Атрибуты, относящиеся к гостевой машине виртуальной машины, отображаются в фактах только при установленном значении `true`.
username строка		Имя пользователя сервера vCenter vSphere или ESXi. Если значение не указано в задаче, используется значение переменной окружения `VMWARE_USER`. Поддержка переменных окружения добавлена в Ansible 2.6. псевдонимы: admin, user
validate_certs логическое значение	Варианты: нет да ←	Разрешает подключение, когда сертификаты SSL недействительны. Устанавливается в значение `false`, когда сертификаты не доверяются. Если значение не указано в задаче, используется значение переменной окружения `VMWARE_VALIDATE_CERTS`. Поддержка переменных окружения добавлена в Ansible 2.6. Если установлено значение `yes`, убедитесь, что на данной машине установлен Python >= 2.7.9.
vm_type строка добавлено в 2.5	Варианты: все ← vm шаблон	Если установлено значение `vm`, сбор фактов выполняется только для виртуальных машин. Если установлено значение `template`, сбор фактов выполняется только для шаблонов виртуальных машин. Если установлено значение `all`, сбор фактов выполняется для всех виртуальных машин и шаблонов виртуальных машин.

Примечания

Примечание

Проверено на ESXi 6.7, vSphere 5.5 и vSphere 6.5
Начиная с версии 2.8, факты возвращаются в виде списка словарей вместо словаря.

Примеры

- name: Gather all registered virtual machines
  vmware_vm_facts:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
  delegate_to: localhost
  register: vmfacts

- debug:
    var: vmfacts.virtual_machines

- name: Gather only registered virtual machine templates
  vmware_vm_facts:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    vm_type: template
  delegate_to: localhost
  register: template_facts

- debug:
    var: template_facts.virtual_machines

- name: Gather only registered virtual machines
  vmware_vm_facts:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    vm_type: vm
  delegate_to: localhost
  register: vm_facts

- debug:
    var: vm_facts.virtual_machines

- name: Get UUID from given VM Name
  vmware_vm_facts:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    vm_type: vm
  delegate_to: localhost
  register: vm_facts

- debug:
    msg: "{{ item.uuid }}"
  with_items:
    - "{{ vm_facts.virtual_machines | json_query(query) }}"
  vars:
    query: "[?guest_name=='DC0_H0_VM0']"

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

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

Ключ	Возвращаемое значение	Описание
virtual_machines список	успех	список словарей виртуальных машин и их фактов Пример: [{'guest_name': 'ubuntu_t', 'cluster': None, 'esxi_hostname': '10.76.33.226', 'guest_fullname': 'Ubuntu Linux (64-разрядный)', 'ip_address': '', 'mac_address': ['00:50:56:87:a5:9a'], 'power_state': 'выключен', 'uuid': '4207072c-edd8-3bd5-64dc-903fd3a0db04', 'vm_network': {'00:50:56:87:a5:9a': {'ipv4': ['10.76.33.228'], 'ipv6': []}}, 'attributes': {'job': 'backup-prepare'}}]

Статус

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

Авторы

Joseph Callen (@jcpowermac)
Abhijeet Kasurde (@Akasurde)
Фёдор Вомпер (@sumkincpp)

Подсказка

Если вы обнаружите проблемы в этом документе, вы можете отредактировать этот документ, чтобы улучшить его.

© 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_vm_facts_module.html