Spec-Zone.ru › Ansible 2.9

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

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

Описание

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

Псевдонимы: vmware_guest_facts

Требования

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

  • 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.
Если значение не указано в задаче, будет использовано значение переменной среды VMWARE_HOST.
Поддержка переменных среды добавлена в Ansible 2.6.
moid
строка
добавлено в 2.9
Идентификатор управляемого объекта (Managed Object ID) экземпляра для управления, если известен. Это уникальный идентификатор только в рамках одного vCenter.
Требуется, если не указаны name или uuid.
name
строка
Имя виртуальной машины для работы.
Требуется, если не указаны uuid или moid.
name_match
строка
    Варианты:
  • первый ←
  • последний
Если несколько виртуальных машин соответствуют имени, используется первая или последняя найденная.
password
строка
Пароль vCenter или сервера ESXi.
Если значение не указано в задаче, будет использовано значение переменной среды VMWARE_PASSWORD.
Поддержка переменных среды добавлена в Ansible 2.6.

псевдонимы: pass, pwd
port
целое число
добавлено в 2.5
По умолчанию:
443
Номер порта vCenter или сервера ESXi.
Если значение не указано в задаче, будет использовано значение переменной среды VMWARE_PORT.
Поддержка переменных среды добавлена в Ansible 2.6.
properties
список
добавлено в 2.8
Укажите свойства для извлечения.
Если не указано, извлекаются все свойства (вглубь).
Результаты возвращаются в структуре, идентичной структуре API vSphere.
Пример:
properties: [
"config.hardware.memoryMB",
"config.hardware.numCPU",
"guest.disk",
"overallStatus"
]
Только при schema vsphere.
proxy_host
строка
добавлено в 2.9
Адрес прокси-сервера, который будет получать все запросы HTTPS и пересылать их.
Формат — имя хоста или IP-адрес.
Если значение не указано в задаче, будет использовано значение переменной среды VMWARE_PROXY_HOST.
Эта функция зависит от версии pyvmomi, большей, чем v6.7.1.2018.12
proxy_port
целое число
добавлено в 2.9
Порт HTTP-прокси, который будет получать все запросы HTTPS и пересылать их.
Если значение не указано в задаче, будет использовано значение переменной среды VMWARE_PROXY_PORT.
schema
строка
добавлено в 2.8
    Варианты:
  • summary ←
  • vsphere
Укажите желаемую схему вывода.
Схема вывода 'summary' — это устаревшая схема вывода модуля.
Схема вывода 'vsphere' — это определение класса API vSphere, которое требует pyvmomi>6.7.1
tags
логическое значение
добавлено в 2.8
    Варианты:
  • нет ←
  • да
Показывать теги или нет.
Если установлено True, отображается информация о тегах.
Если установлено False, информация о тегах скрыта.
Требуется VMware Automation SDK и vCloud Suite SDK.
use_instance_uuid
логическое значение
добавлено в 2.8
    Варианты:
  • нет ←
  • да
Использовать идентификатор экземпляра VMware, а не BIOS UUID.
username
строка
Имя пользователя vCenter или сервера ESXi.
Если значение не указано в задаче, будет использовано значение переменной среды VMWARE_USER.
Поддержка переменных среды добавлена в Ansible 2.6.

псевдонимы: admin, user
uuid
строка
Идентификатор экземпляра (UUID) для управления, если известен. Уникальный идентификатор VMware.
Требуется, если не указаны name или moid.
validate_certs
логическое значение
    Варианты:
  • нет
  • да ←
Разрешает подключение, когда сертификаты SSL недействительны. Установите значение false, когда сертификаты не доверяются.
Если значение не указано в задаче, будет использовано значение переменной среды VMWARE_VALIDATE_CERTS.
Поддержка переменных среды добавлена в Ansible 2.6.
Если установлено yes, убедитесь, что на данном компьютере установлен Python >= 2.7.9.

Примечания

Примечание

  • Проверено на vSphere 5.5, 6.7

Примеры

- name: Gather info from standalone ESXi server having datacenter as 'ha-datacenter'
  vmware_guest_info:
    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: info

- name: Gather some info from a guest using the vSphere API output schema
  vmware_guest_info:
    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: info

- name: Gather some information about a guest using MoID
  vmware_guest_facts:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    validate_certs: no
    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
  vmware_guest_info:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    validate_certs: no
    datacenter: "{{ datacenter_name }}"
    name: "{{ vm_name }}"
    schema: "vsphere"
    properties:
      - _moId
  delegate_to: localhost
  register: moid_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': 'poweredOff', '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': ['backup'], 'vnc': {}, 'moid': 'vm-42', 'vimref': 'vim.VirtualMachine:vm-42'}


Статус

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

Авторы

  • 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.9/modules/vmware_guest_info_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API