community.general.oneview_enclosure_info – Получение информации об одном или нескольких шкафах

Примечание

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

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

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

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

Обзор

Получение информации об одном или нескольких шкафах из OneView.
Этот модуль назывался oneview_enclosure_facts до Ansible 2.9, возвращая ansible_facts. Обратите внимание, что модуль community.general.oneview_enclosure_info больше не возвращает ansible_facts!

Требования

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

hpOneView >= 2.0.1
python >= 2.7.9

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
config путь		Путь к файлу конфигурации .json, содержащему конфигурацию клиента OneView. Файл конфигурации необязателен и, если используется, должен быть на хосте, на котором выполняются команды ansible. Если путь к файлу не указан, конфигурация загружается из переменных среды. Для ссылок на примеры файлов конфигурации или способов использования переменных среды обратитесь к разделу примечаний.
name строка		Имя шкафа.
options строка		Список опций для сбора дополнительной информации о шкафу и связанных ресурсах. Допустимые опции: `script`, `environmentalConfiguration`, и `utilization`. Для опции `utilization`, вы можете указать конкретные параметры.
params словарь		Список параметров для ограничения, фильтрации и сортировки списка ресурсов. Допустимые параметры: - `start`: Первый элемент для возврата, используя индексацию с нуля. - `count`: Количество ресурсов для возврата. - `filter`: Общая строка фильтра/запроса для сужения списка возвращаемых элементов. - `sort`: Порядок сортировки возвращаемых данных.

Примечания

Примечание

Пример файла конфигурации для параметра config можно найти по адресу: https://github.com/HewlettPackard/oneview-ansible/blob/master/examples/oneview_config-rename.json
Инструкции по использованию переменных среды для конфигурации можно найти здесь: https://github.com/HewlettPackard/oneview-ansible#environment-variables
Дополнительные книги задач для модулей HPE OneView Ansible можно найти здесь: https://github.com/HewlettPackard/oneview-ansible/tree/master/examples
Версия API OneView, которая используется, напрямую влияет на возвращаемые и ожидаемые поля в ресурсах. Информация о настройке желаемой версии API доступна по адресу: https://github.com/HewlettPackard/oneview-ansible#setting-your-oneview-version

Примеры

- name: Gather information about all Enclosures
  community.general.oneview_enclosure_info:
    hostname: 172.16.101.48
    username: administrator
    password: my_password
    api_version: 500
  no_log: true
  delegate_to: localhost
  register: result
- ansible.builtin.debug:
    msg: "{{ result.enclosures }}"

- name: Gather paginated, filtered and sorted information about Enclosures
  community.general.oneview_enclosure_info:
    params:
      start: 0
      count: 3
      sort: name:descending
      filter: status=OK
    hostname: 172.16.101.48
    username: administrator
    password: my_password
    api_version: 500
  no_log: true
  delegate_to: localhost
  register: result
- ansible.builtin.debug:
    msg: "{{ result.enclosures }}"

- name: Gather information about an Enclosure by name
  community.general.oneview_enclosure_info:
    name: Enclosure-Name
    hostname: 172.16.101.48
    username: administrator
    password: my_password
    api_version: 500
  no_log: true
  delegate_to: localhost
  register: result
- ansible.builtin.debug:
    msg: "{{ result.enclosures }}"

- name: Gather information about an Enclosure by name with options
  community.general.oneview_enclosure_info:
    name: Test-Enclosure
    options:
      - script                       # optional
      - environmentalConfiguration   # optional
      - utilization                  # optional
    hostname: 172.16.101.48
    username: administrator
    password: my_password
    api_version: 500
  no_log: true
  delegate_to: localhost
  register: result
- ansible.builtin.debug:
    msg: "{{ result.enclosures }}"
- ansible.builtin.debug:
    msg: "{{ result.enclosure_script }}"
- ansible.builtin.debug:
    msg: "{{ result.enclosure_environmental_configuration }}"
- ansible.builtin.debug:
    msg: "{{ result.enclosure_utilization }}"

- name: "Gather information about an Enclosure with temperature data at a resolution of one sample per day, between two
         specified dates"
  community.general.oneview_enclosure_info:
    name: Test-Enclosure
    options:
      - utilization:                   # optional
          fields: AmbientTemperature
          filter:
            - startDate=2016-07-01T14:29:42.000Z
            - endDate=2017-07-01T03:29:42.000Z
          view: day
          refresh: false
    hostname: 172.16.101.48
    username: administrator
    password: my_password
    api_version: 500
  no_log: true
  delegate_to: localhost
  register: result
- ansible.builtin.debug:
    msg: "{{ result.enclosures }}"
- ansible.builtin.debug:
    msg: "{{ result.enclosure_utilization }}"

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

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

Ключ	Возвращаемое значение	Описание
enclosure_environmental_configuration словарь	При запросе, но может быть пустым.	Содержит всю информацию OneView о конфигурации среды шкафа.
enclosure_script строка	При запросе, но может быть пустым.	Содержит всю информацию OneView о скрипте шкафа.
enclosure_utilization словарь	При запросе, но может быть пустым.	Содержит всю информацию OneView об использовании шкафа.
enclosures словарь	Всегда, но может быть пустым.	Содержит всю информацию OneView о шкафах.

Авторы

Felipe Bulsoni (@fgbulsoni)
Thiago Miotto (@tmiotto)
Adriane Cardozo (@adriane-cardozo)

© 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/general/oneview_enclosure_info_module.html