vmware_vm_facts – Возвращает основные сведения о гостевом виртуальном устройстве vSphere
Новая версия 2.0.
Обзор
- Возвращает основные сведения о гостевом виртуальном устройстве vSphere.
- Имя кластера в качестве факта добавлено в версии 2.7.
Требования
Ниже приведены требования к хосту, на котором выполняется этот модуль.
- python >= 2.6
- PyVmomi
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| hostname строка | Имя хоста или IP-адрес сервера vCenter или ESXi vSphere. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения VMWARE_HOST. Поддержка переменных окружения добавлена в версии 2.6. | |
| password строка | Пароль сервера vCenter или ESXi vSphere. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения VMWARE_PASSWORD. Поддержка переменных окружения добавлена в версии 2.6. псевдонимы: pass, pwd | |
| port целое число добавлено в 2.5 | Значение по умолчанию: 443 | Номер порта сервера vCenter или ESXi vSphere. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения VMWARE_PORT. Поддержка переменных окружения добавлена в версии 2.6. |
| username строка | Имя пользователя сервера vCenter или ESXi vSphere. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения VMWARE_USER. Поддержка переменных окружения добавлена в версии 2.6. псевдонимы: admin, user | |
| validate_certs булево |
| Разрешает подключение, когда сертификаты SSL недействительны. Установите в false, если сертификаты не проверены.Если значение не указано в задаче, вместо него будет использовано значение переменной окружения VMWARE_VALIDATE_CERTS. Поддержка переменных окружения добавлена в версии 2.6. Если установлено в yes, убедитесь, что на данном компьютере установлен Python >= 2.7.9. |
| vm_type - добавлено в 2.5 |
| Если установлено в vm, то сведения собираются только для виртуальных машин.Если установлено в template, то сведения собираются только для шаблонов виртуальных машин.Если установлено в all, то сведения собираются для всех виртуальных машин и шаблонов виртуальных машин. |
Примечания
Примечание
- Тестировалось на vSphere 5.5 и vSphere 6.5
Примеры
- 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
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| virtual_machines словарь | успех | словарь виртуальных машин и их сведений Пример: {'ubuntu_t': {'cluster': None, 'esxi_hostname': '10.76.33.226', 'guest_fullname': 'Ubuntu Linux (64-bit)', 'ip_address': '', 'mac_address': ['00:50:56:87:a5:9a'], 'power_state': 'poweredOff', 'uuid': '4207072c-edd8-3bd5-64dc-903fd3a0db04', 'vm_network': {}}} |
Статус
- Этот модуль не гарантирует обратную совместимость. [превью]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- Joseph Callen (@jcpowermac)
- Abhijeet Kasurde (@Akasurde)
Подсказка
Если вы обнаружите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/vmware_vm_facts_module.html