Spec-Zone.ru › Ansible

Модуль community.vmware.vmware_vm_info — получение основных сведений о гостевой виртуальной машине VMware

Примечание

Этот модуль входит в коллекцию community.vmware (версия 6.2.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.vmware.

Чтобы использовать её в плейбуке, укажите: community.vmware.vmware_vm_info.

  • Краткое описание
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Краткое описание

  • Возвращает основные сведения о гостевой виртуальной машине vSphere или ESXi.

Параметры

Параметр

Комментарии

folder

string

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

Примеры:

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

string

Имя хоста или IP-адрес сервера vSphere vCenter.

Если значение не указано в задаче, вместо него будет использовано значение переменной окружения VMWARE_HOST.

password

псевдонимы: pass, pwd

string

Пароль сервера vSphere vCenter.

Если значение не указано в задаче, вместо него будет использовано значение переменной окружения VMWARE_PASSWORD.

port

integer

Номер порта сервера vSphere vCenter.

Если значение не указано в задаче, вместо него будет использовано значение переменной окружения VMWARE_PORT.

По умолчанию: 443

proxy_host

string

Адрес прокси-сервера, который будет принимать все HTTPS-запросы и перенаправлять их.

Укажите имя хоста или IP-адрес.

Если значение не указано в задаче, вместо него будет использовано значение переменной окружения VMWARE_PROXY_HOST.

proxy_port

integer

Порт HTTP-прокси-сервера, который будет принимать все HTTPS-запросы и перенаправлять их.

Если значение не указано в задаче, вместо него будет использовано значение переменной окружения VMWARE_PROXY_PORT.

show_allocated

boolean

Если задать значение True, будут показаны выделенное хранилище в байтах и память в МБ.

Варианты:

  • false ← (по умолчанию)
  • true

show_attribute

boolean

Атрибуты гостевой виртуальной машины отображаются в сведениях, только если задано значение true.

Варианты:

  • false ← (по умолчанию)
  • true

show_cluster

boolean

добавлено в community.vmware 3.5.0

Кластер виртуальной машины отображается, если задано значение true.

Варианты:

  • false
  • true ← (по умолчанию)

show_datacenter

boolean

добавлено в community.vmware 3.5.0

Центр обработки данных виртуальной машины отображается, если задано значение true.

Варианты:

  • false
  • true ← (по умолчанию)

show_datastore

boolean

добавлено в community.vmware 3.5.0

Хранилище данных виртуальной машины отображается, если задано значение true.

Варианты:

  • false
  • true ← (по умолчанию)

show_esxi_hostname

boolean

добавлено в community.vmware 3.5.0

Хост ESXi виртуальной машины отображается, если задано значение true.

Варианты:

  • false
  • true ← (по умолчанию)

show_folder

boolean

добавлено в community.vmware 3.7.0

Показывать папки

Варианты:

  • false
  • true ← (по умолчанию)

show_mac_address

boolean

добавлено в community.vmware 3.5.0

MAC-адрес виртуальной машины отображается, если задано значение true.

Варианты:

  • false
  • true ← (по умолчанию)

show_net

boolean

добавлено в community.vmware 3.5.0

Сеть виртуальной машины отображается, если задано значение true.

Варианты:

  • false
  • true ← (по умолчанию)

show_resource_pool

boolean

добавлено в community.vmware 3.5.0

Пул ресурсов виртуальной машины отображается, если задано значение true.

Варианты:

  • false
  • true ← (по умолчанию)

show_tag

boolean

Теги виртуальной машины отображаются, если задано значение true.

Варианты:

  • false ← (по умолчанию)
  • true

username

псевдонимы: admin, user

string

Имя пользователя сервера vSphere vCenter.

Если значение не указано в задаче, вместо него будет использовано значение переменной окружения VMWARE_USER.

validate_certs

boolean

Разрешает подключение, если SSL-сертификаты недействительны. Задайте значение false, если сертификаты не являются доверенными.

Если значение не указано в задаче, вместо него будет использовано значение переменной окружения VMWARE_VALIDATE_CERTS.

Варианты:

  • false
  • true ← (по умолчанию)

vm_name

string

Имя виртуальной машины, сведения о конфигурации которой нужно получить.

vm_type

string

Если задано значение vm, собираются сведения только о виртуальных машинах.

Если задано значение template, собираются сведения только о шаблонах виртуальных машин.

Если задано значение all, собираются сведения обо всех виртуальных машинах и шаблонах виртуальных машин.

Варианты:

  • "all" ← (по умолчанию)
  • "vm"
  • "template"

Примечания

Примечание

  • Для всех модулей требуется доступ на запись через API, поэтому они не поддерживаются при использовании бесплатной лицензии ESXi.
  • Все переменные и имена объектов VMware чувствительны к регистру.
  • Модули могут использовать библиотеку Python «requests», которая по умолчанию не использует системное хранилище сертификатов. Вы можете указать хранилище сертификатов, задав переменную окружения REQUESTS_CA_BUNDLE. Обратите внимание: если эта переменная задана, в некоторых случаях значение ‘false’ параметра ‘validate_certs’ может быть проигнорировано. Пример: ‘export REQUESTS_CA_BUNDLE=/path/to/your/ca_bundle.pem’

Примеры

- name: Gather all registered virtual machines
  community.vmware.vmware_vm_info:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
  delegate_to: localhost
  register: vm_info

- debug:
    var: vm_info.virtual_machines

- name: Gather one specific VM
  community.vmware.vmware_vm_info:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    vm_name: 'vm_name_as_per_vcenter'
  delegate_to: localhost
  register: vm_info

- debug:
    var: vm_info.virtual_machines

- name: Gather only registered virtual machine templates
  community.vmware.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
  community.vmware.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
      community.vmware.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 | community.general.json_query(query) }}"
      vars:
        query: "[?guest_name=='DC0_H0_VM0']"

- name: Get Tags from given VM Name
  block:
    - name: Get virtual machine info
      community.vmware.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 | community.general.json_query(query) }}"
      vars:
        query: "[?guest_name=='DC0_H0_VM0']"

- name: Gather all VMs from a specific folder
  community.vmware.vmware_vm_info:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    folder: "/Asia-Datacenter1/vm/prod"
  delegate_to: localhost
  register: vm_info

- name: Get datastore_url from given VM name
  block:
    - name: Get virtual machine info
      community.vmware.vmware_vm_info:
        hostname: '{{ vcenter_hostname }}'
        username: '{{ vcenter_username }}'
        password: '{{ vcenter_password }}'
      delegate_to: localhost
      register: vm_info

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

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

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

Ключ

Описание

virtual_machines

list / elements=string

список словарей с виртуальными машинами и сведениями о них

Возвращается: при успехе

Пример: [{"allocated": {"cpu": 2, "memory": 16, "storage": 500000000}, "attributes": {"job": "backup-prepare"}, "cluster": null, "datacenter": "Datacenter-1", "datastore_url": [{"name": "t880-o2g", "url": "/vmfs/volumes/e074264a-e5c82a58"}], "esxi_hostname": "10.76.33.226", "folder": "/Datacenter-1/vm", "guest_fullname": "Ubuntu Linux (64-bit)", "guest_name": "ubuntu_t", "ip_address": "", "mac_address": ["00:50:56:87:a5:9a"], "moid": "vm-24", "power_state": "poweredOff", "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"}], "uuid": "4207072c-edd8-3bd5-64dc-903fd3a0db04", "vm_network": {"00:50:56:87:a5:9a": {"ipv4": ["10.76.33.228/24"], "ipv6": []}}}]

Авторы

  • Joseph Callen (@jcpowermac)
  • Abhijeet Kasurde (@Akasurde)
  • Fedor Vompe (@sumkincpp)

Ссылки на коллекцию

  • Отслеживание проблем
  • Домашняя страница
  • Репозиторий (исходный код)

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/vmware/vmware_vm_info_module.html

Spec-Zone.ru

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