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

Примечание

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

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

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

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

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

Обзор

Этот модуль можно использовать для сбора информации о хранилищах данных в инфраструктуре VMWare.

Параметры

Параметр	Комментарии
cluster string	Кластер для поиска хранилищ данных. Если задано, будет возвращена информация о хранилищах данных, принадлежащих этому кластеру. Этот параметр обязателен, если `datacenter` не указан.
datacenter aliases: datacenter_name string	Центр обработки данных для поиска хранилищ данных. Этот параметр обязателен, если `cluster` не указан.
gather_nfs_mount_info boolean	Сбор информации о монтировании хранилищ данных NFS. Отключено по умолчанию, так как это замедляет выполнение, если у вас много хранилищ данных. Действительно только когда `schema=summary`. Варианты: `false` ← (по умолчанию) `true`
gather_vmfs_mount_info boolean	Сбор информации о монтировании хранилищ данных VMFS. Отключено по умолчанию, так как это замедляет выполнение, если у вас много хранилищ данных. Действительно только когда `schema=summary`. Варианты: `false` ← (по умолчанию) `true`
hostname string	Имя хоста или IP-адрес сервера vSphere vCenter или ESXi. Если значение не указано в задаче, будет использовано значение переменной среды `VMWARE_HOST`.
name string	Имя хранилища данных для сопоставления. Если задано, возвращается информация о конкретных хранилищах данных.
password aliases: pass, pwd string	Пароль сервера vSphere vCenter или ESXi. Если значение не указано в задаче, будет использовано значение переменной среды `VMWARE_PASSWORD`.
port integer	Номер порта сервера vSphere vCenter или ESXi. Если значение не указано в задаче, будет использовано значение переменной среды `VMWARE_PORT`. По умолчанию: `443`
properties list / elements=string	Укажите свойства для извлечения. Если не указано, извлекаются все свойства (глубоко). Результаты возвращаются в структуре, идентичной API vsphere. Пример: properties: [ “name”, “info.vmfs.ssd”, “capability.vsanSparseSupported”, “overallStatus” ] Действительно только когда `schema=vsphere`.
proxy_host string	Адрес прокси-сервера, который будет получать все HTTPS-запросы и передавать их. Формат - имя хоста или IP-адрес. Если значение не указано в задаче, будет использовано значение переменной среды `VMWARE_PROXY_HOST`.
proxy_port integer	Порт HTTP-прокси, который будет получать все HTTPS-запросы и передавать их. Если значение не указано в задаче, будет использовано значение переменной среды `VMWARE_PROXY_PORT`.
schema string	Укажите желаемую схему вывода. Схема вывода «summary» — это устаревший вывод из модуля Схема вывода «vsphere» — это определение класса API vSphere Варианты: `"summary"` ← (по умолчанию) `"vsphere"`
show_tag boolean	Теги, связанные с хранилищем данных, отображаются, если установлено значение `true`. Варианты: `false` ← (по умолчанию) `true`
username aliases: admin, user string	Имя пользователя сервера vSphere vCenter или ESXi. Если значение не указано в задаче, будет использовано значение переменной среды `VMWARE_USER`.
validate_certs boolean	Разрешает подключение, когда SSL-сертификаты недействительны. Установите значение `false`, когда сертификаты не являются доверенными. Если значение не указано в задаче, будет использовано значение переменной среды `VMWARE_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Для всех модулей требуется доступ к записи API, поэтому они не поддерживаются в бесплатной лицензии ESXi.
Все переменные и имена объектов VMware чувствительны к регистру.

Примеры

- 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/"}]

Ключ

Описание

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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/vmware/vmware_datastore_info_module.html