vmware_vm_info – Возвращает базовые сведения о гостевом компьютере виртуальной машины VMware
Описание
- Возвращает базовые сведения о гостевом компьютере виртуальной машины vSphere или ESXi.
- Имя кластера в качестве факта добавлено в версии 2.7.
- Этот модуль назывался
vmware_vm_factsдо Ansible 2.9. Использование не изменилось.
Псевдонимы: vmware_vm_facts
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 2.6
- PyVmomi
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| folder строка добавлено в 2.9 | Укажите расположение папки с ВМ для сбора информации. Примеры: 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. Если значение не указано в задаче, используется значение переменной среды 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. |
| proxy_host строка добавлено в 2.9 | Адрес прокси-сервера, который будет принимать все запросы HTTPS и перенаправлять их. Формат — имя хоста или IP-адрес. Если значение не указано в задаче, используется значение переменной среды VMWARE_PROXY_HOST. Эта функция зависит от версии pyvmomi, большей чем v6.7.1.2018.12 | |
| proxy_port целое число добавлено в 2.9 | Порт HTTP-прокси-сервера, который будет принимать все запросы HTTPS и перенаправлять их. Если значение не указано в задаче, используется значение переменной среды VMWARE_PROXY_PORT. | |
| show_attribute логическое добавлено в 2.8 |
| Атрибуты, относящиеся к гостевому компьютеру виртуальной машины, отображаются только при установке этого параметра true. |
| show_tag логическое добавлено в 2.9 |
| Теги виртуальной машины отображаются, если параметр установлен на 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, информация собирается только для виртуальных машин.Если установлено значение template, информация собирается только для шаблонов виртуальных машин.Если установлено значение all, информация собирается для всех виртуальных машин и шаблонов виртуальных машин. |
Примечания
Примечание
- Тестировалось на ESXi 6.7, vSphere 5.5 и vSphere 6.5
- Начиная с версии 2.8, информация возвращается в виде списка словарей вместо словаря.
Примеры
- name: Gather all registered virtual machines
vmware_vm_info:
hostname: '{{ vcenter_hostname }}'
username: '{{ vcenter_username }}'
password: '{{ vcenter_password }}'
delegate_to: localhost
register: vminfo
- debug:
var: vminfo.virtual_machines
- name: Gather only registered virtual machine templates
vmware_vm_info:
hostname: '{{ vcenter_hostname }}'
username: '{{ vcenter_username }}'
password: '{{ vcenter_password }}'
vm_type: template
delegate_to: localhost
register: template_info
- debug:
var: template_info.virtual_machines
- name: Gather only registered virtual machines
vmware_vm_info:
hostname: '{{ vcenter_hostname }}'
username: '{{ vcenter_username }}'
password: '{{ vcenter_password }}'
vm_type: vm
delegate_to: localhost
register: vm_info
- debug:
var: vm_info.virtual_machines
- name: Get UUID from given VM Name
block:
- name: Get virtual machine info
vmware_vm_info:
hostname: '{{ vcenter_hostname }}'
username: '{{ vcenter_username }}'
password: '{{ vcenter_password }}'
folder: "/datacenter/vm/folder"
delegate_to: localhost
register: vm_info
- debug:
msg: "{{ item.uuid }}"
with_items:
- "{{ vm_info.virtual_machines | json_query(query) }}"
vars:
query: "[?guest_name=='DC0_H0_VM0']"
- name: Get Tags from given VM Name
block:
- name: Get virtual machine info
vmware_vm_info:
hostname: '{{ vcenter_hostname }}'
username: '{{ vcenter_username }}'
password: '{{ vcenter_password }}'
folder: "/datacenter/vm/folder"
delegate_to: localhost
register: vm_info
- debug:
msg: "{{ item.tags }}"
with_items:
- "{{ vm_info.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-bit)', 'ip_address': '', 'mac_address': ['00:50:56:87:a5:9a'], 'power_state': 'poweredOff', 'uuid': '4207072c-edd8-3bd5-64dc-903fd3a0db04', 'vm_network': {'00:50:56:87:a5:9a': {'ipv4': ['10.76.33.228'], 'ipv6': []}}, 'attributes': {'job': 'backup-prepare'}, 'tags': [{'category_id': 'urn:vmomi:InventoryServiceCategory:b316cc45-f1a9-4277-811d-56c7e7975203:GLOBAL', 'category_name': 'cat_0001', 'description': '', 'id': 'urn:vmomi:InventoryServiceTag:43737ec0-b832-4abf-abb1-fd2448ce3b26:GLOBAL', 'name': 'tag_0001'}]}] |
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- Joseph Callen (@jcpowermac)
- Abhijeet Kasurde (@Akasurde)
- Fedor Vompe (@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.9/modules/vmware_vm_info_module.html