community.vmware.vmware_cluster_info – Сбор информации о кластерах, доступных в заданном vCenter

Примечание

Этот плагин входит в коллекцию community.vmware (версия 1.7.0).

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

Для использования в книге задач укажите: community.vmware.vmware_cluster_info.

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

Описание

Этот модуль используется для сбора информации о кластерах в инфраструктуре VMware.
Все значения и имена объектов VMware чувствительны к регистру.
Этот модуль назывался vmware_cluster_facts до Ansible 2.9. Использование не изменилось.

Требования

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

python >= 2.6
PyVmomi

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
cluster_name строка		Имя кластера. Если задано, будет возвращена информация об этом кластере. Этот параметр обязателен, если `datacenter` не указан.
datacenter строка		Центр обработки данных для поиска кластера/кластеров. Этот параметр обязателен, если `cluster_name` не указан.
hostname строка		Имя хоста или IP-адрес сервера vCenter или ESXi. Если значение не указано в задаче, будет использовано значение переменной окружения `VMWARE_HOST`. Поддержка переменных окружения добавлена в Ansible 2.6.
password строка		Пароль сервера vCenter или ESXi. Если значение не указано в задаче, будет использовано значение переменной окружения `VMWARE_PASSWORD`. Поддержка переменных окружения добавлена в Ansible 2.6. псевдонимы: pass, pwd
port целое число	Значение по умолчанию: 443	Номер порта сервера vCenter или ESXi. Если значение не указано в задаче, будет использовано значение переменной окружения `VMWARE_PORT`. Поддержка переменных окружения добавлена в Ansible 2.6.
properties список / элементы=строка добавлен в 1.0.0 community.vmware		Укажите свойства для извлечения. Пример: properties: [ "name", "configuration.dasConfig.enabled", "summary.totalCpu" ] Действительно только когда `schema` равен `vsphere`.
proxy_host строка		Адрес прокси, который будет принимать все запросы HTTPS и пересылать их. Формат - имя хоста или IP-адрес. Если значение не указано в задаче, будет использовано значение переменной окружения `VMWARE_PROXY_HOST`. Эта функция зависит от версии pyvmomi, большей чем v6.7.1.2018.12
proxy_port целое число		Порт HTTP-прокси, который будет принимать все запросы HTTPS и пересылать их. Если значение не указано в задаче, будет использовано значение переменной окружения `VMWARE_PROXY_PORT`.
schema строка добавлен в 1.0.0 community.vmware	Варианты: summary ← vsphere	Укажите желаемый формат вывода. Формат вывода 'summary' - это устаревший формат вывода модуля. Формат вывода 'vsphere' - это определение класса API vSphere, которое требует pyvmomi>6.7.1.
show_tag булево	Варианты: нет ← да	Теги, относящиеся к кластеру, отображаются, если установлено значение `True`.
username строка		Имя пользователя сервера vCenter или ESXi. Если значение не указано в задаче, будет использовано значение переменной окружения `VMWARE_USER`. Поддержка переменных окружения добавлена в Ansible 2.6. псевдонимы: admin, user
validate_certs булево	Варианты: нет да ←	Разрешает подключение, когда сертификаты SSL недействительны. Установите значение `false`, когда сертификаты не доверяются. Если значение не указано в задаче, будет использовано значение переменной окружения `VMWARE_VALIDATE_CERTS`. Поддержка переменных окружения добавлена в Ansible 2.6. Если установлено значение `true`, убедитесь, что на данном компьютере установлен Python >= 2.7.9.

Примечания

Примечание

Тестировалось на vSphere 6.5, 6.7

Примеры

- name: Gather cluster info from given datacenter
  community.vmware.vmware_cluster_info:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    datacenter: ha-datacenter
  delegate_to: localhost
  register: cluster_info

- name: Gather info from datacenter about specific cluster
  community.vmware.vmware_cluster_info:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    cluster_name: DC0_C0
  delegate_to: localhost
  register: cluster_info

- name: Gather info from datacenter about specific cluster with tags
  community.vmware.vmware_cluster_info:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    cluster_name: DC0_C0
    show_tag: True
  delegate_to: localhost
  register: cluster_info

- name: Gather some info from a cluster using the vSphere API output schema
  vmware_cluster_info:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    cluster_name: DC0_C0
    schema: vsphere
    properties:
      - name
      - configuration.dasConfig.enabled
      - summary.totalCpu
  delegate_to: localhost
  register: cluster_info

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

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

Ключ	Возвращаемое значение	Описание
clusters словарь	всегда	метаданные о доступных кластерах Центр обработки данных добавлен в возвращаемые значения с версии 1.6.0 Пример: {'DC0_C0': {'datacenter': 'DC0', 'drs_default_vm_behavior': None, 'drs_enable_vm_behavior_overrides': None, 'drs_vmotion_rate': None, 'enable_ha': None, 'enabled_drs': True, 'enabled_vsan': False, 'ha_admission_control_enabled': None, 'ha_failover_level': None, 'ha_host_monitoring': None, 'ha_restart_priority': None, 'ha_vm_failure_interval': None, 'ha_vm_max_failure_window': None, 'ha_vm_max_failures': None, 'ha_vm_min_up_time': None, 'ha_vm_monitoring': None, 'ha_vm_tools_monitoring': None, 'hosts': [{'folder': '/DC0/host/DC0_C0', 'name': 'esxi01.vsphere.local'}, {'folder': '/DC0/host/DC0_C0', 'name': 'esxi02.vsphere.local'}, {'folder': '/DC0/host/DC0_C0', 'name': 'esxi03.vsphere.local'}, {'folder': '/DC0/host/DC0_C0', 'name': 'esxi04.vsphere.local'}], 'moid': 'domain-c9', 'resource_summary': {'cpuCapacityMHz': 4224, 'cpuUsedMHz': 87, 'memCapacityMB': 6139, 'memUsedMB': 1254, 'pMemAvailableMB': 0, 'pMemCapacityMB': 0, 'storageCapacityMB': 33280, 'storageUsedMB': 19953}, 'tags': [{'category_id': 'urn:vmomi:InventoryServiceCategory:9fbf83de-7903-442e-8004-70fd3940297c:GLOBAL', 'category_name': 'sample_cluster_cat_0001', 'description': '', 'id': 'urn:vmomi:InventoryServiceTag:93d680db-b3a6-4834-85ad-3e9516e8fee8:GLOBAL', 'name': 'sample_cluster_tag_0001'}], 'vsan_auto_claim_storage': False}}

Авторы

Abhijeet Kasurde (@Akasurde)
Christian Neugum (@digifuchsi)

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