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

Примечание

Этот плагин является частью коллекции community.vmware (версия 1.6.0).

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

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

Обзор
Требования
Параметры
Примечания
Примеры
Значения возврата

Обзор

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

Требования

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

python >= 2.6
PyVmomi

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
cluster строка		Кластер для поиска хранилищ данных. Если задано, будет возвращена информация о хранилищах данных, принадлежащих этому кластеру. Этот параметр обязателен, если `datacenter` не указан.
datacenter строка		Центр обработки данных для поиска хранилищ данных. Этот параметр обязателен, если `cluster` не указан. псевдонимы: datacenter_name
gather_nfs_mount_info булево	Варианты: нет ← да	Сбор информации о подключении хранилищ NFS. Отключен по умолчанию, так как замедляет выполнение при большом количестве хранилищ. Действителен только тогда, когда `schema` равно `summary`.
gather_vmfs_mount_info булево	Варианты: нет ← да	Сбор информации о подключении хранилищ VMFS. Отключен по умолчанию, так как замедляет выполнение при большом количестве хранилищ. Действителен только тогда, когда `schema` равно `summary`.
hostname строка		Имя хоста или IP-адрес сервера vCenter или ESXi. Если значение не указано в задаче, используется значение переменной окружения `VMWARE_HOST`. Поддержка переменных окружения добавлена в Ansible 2.6.
name строка		Имя хранилища данных для сопоставления. Если задано, возвращается информация о конкретных хранилищах данных.
password строка		Пароль сервера vCenter или ESXi. Если значение не указано в задаче, используется значение переменной окружения `VMWARE_PASSWORD`. Поддержка переменных окружения добавлена в Ansible 2.6. псевдонимы: pass, pwd
port целое число	По умолчанию: 443	Номер порта сервера vCenter или ESXi. Если значение не указано в задаче, используется значение переменной окружения `VMWARE_PORT`. Поддержка переменных окружения добавлена в Ansible 2.6.
properties список / элементы=строка		Укажите свойства для извлечения. Если не указано, извлекаются все свойства (рекурсивно). Результаты возвращаются в структуре, идентичной структуре API vSphere. Пример: properties: [ "name", "info.vmfs.ssd", "capability.vsanSparseSupported", "overallStatus" ] Действительно только когда `schema` равно `vsphere`.
proxy_host строка		Адрес прокси-сервера, который будет принимать все запросы HTTPS и перенаправлять их. Формат — имя хоста или IP-адрес. Если значение не указано в задаче, используется значение переменной окружения `VMWARE_PROXY_HOST`. Эта функция зависит от версии pyvmomi, большей чем v6.7.1.2018.12
proxy_port целое число		Порт HTTP-прокси-сервера, который будет принимать все запросы HTTPS и перенаправлять их. Если значение не указано в задаче, используется значение переменной окружения `VMWARE_PROXY_PORT`.
schema строка	Варианты: краткое описание ← vsphere	Укажите желаемую схему вывода. Схема вывода 'краткое описание' — это устаревшая схема вывода модуля. Схема вывода 'vsphere' — это определение класса API vSphere, которое требует pyvmomi>6.7.1
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 5.5, 6.0 и 6.5

Примеры

- name: Gather info from standalone ESXi server having datacenter as 'ha-datacenter'
  community.vmware.vmware_datastore_info:
    hostname: '{{ esxi_hostname }}'
    username: '{{ esxi_username }}'
    password: '{{ esxi_password }}'
    datacenter_name: "ha-datacenter"
  delegate_to: localhost
  register: info

- name: Gather info from datacenter about specific datastore
  community.vmware.vmware_datastore_info:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    datacenter_name: '{{ datacenter_name }}'
    name: datastore1
  delegate_to: localhost
  register: info

- name: Gather some info from a datastore using the vSphere API output schema
  community.vmware.vmware_datastore_info:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    datacenter_name: '{{ datacenter_name }}'
    schema: vsphere
    properties:
      - name
      - info.vmfs.ssd
      - capability.vsanSparseSupported
      - overallStatus
  delegate_to: localhost
  register: info

Значения возврата

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

Ключ	Возвращаемое значение	Описание
datastores список / элементы=строка	всегда	метаданные о доступных хранилищах данных Пример: [{'accessible': False, 'capacity': 42681237504, 'datastore_cluster': 'datacluster0', 'freeSpace': 39638269952, 'maintenanceMode': 'normal', 'multipleHostAccess': False, 'name': 'datastore2', 'provisioned': 12289211488, 'type': 'VMFS', 'uncommitted': 9246243936, 'url': 'ds:///vmfs/volumes/5a69b18a-c03cd88c-36ae-5254001249ce/', 'vmfs_blockSize': 1024, 'vmfs_uuid': '5a69b18a-c03cd88c-36ae-5254001249ce', 'vmfs_version': '6.81'}, {'accessible': True, 'capacity': 5497558138880, 'datastore_cluster': 'datacluster0', 'freeSpace': 4279000641536, 'maintenanceMode': 'normal', 'multipleHostAccess': True, 'name': 'datastore3', 'nfs_path': '/vol/datastore3', 'nfs_server': 'nfs_server1', 'provisioned': 1708109410304, 'type': 'NFS', 'uncommitted': 489551912960, 'url': 'ds:///vmfs/volumes/420b3e73-67070776/'}]

Авторы

Tim Rightnour (@garbled1)

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