Spec-Zone.ru › Ansible

Модуль community.general.oneview_san_manager_info — получение сведений об одном или нескольких менеджерах SAN OneView

Примечание

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

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

Для установки используйте: ansible-galaxy collection install community.general. Для работы с этим модулем требуются дополнительные компоненты. Подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: community.general.oneview_san_manager_info.

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

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

  • Получение сведений об одном или нескольких менеджерах SAN из OneView.

Требования

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

  • Python >= 2.7.9
  • hpOneView >= 2.0.1

Параметры

Параметр

Комментарии

api_version

integer

Версия API OneView.

config

path

Путь к файлу конфигурации JSON, содержащему конфигурацию клиента OneView. Файл конфигурации необязателен; если он используется, он должен находиться на хосте, где выполняются команды Ansible. Если путь к файлу не указан, конфигурация загружается из переменных среды. Ссылки на примеры файлов конфигурации и сведения об использовании переменных среды см. в разделе примечаний.

hostname

string

IP-адрес или имя хоста устройства.

image_streamer_hostname

string

IP-адрес или имя хоста REST API HPE Image Streamer.

params

dictionary

Список параметров для ограничения, фильтрации и сортировки списка ресурсов.

Допустимые параметры:

start: первый возвращаемый элемент с нумерацией от 0.

count: количество возвращаемых ресурсов.

query: общая строка запроса для сужения списка возвращаемых ресурсов.

sort: порядок сортировки возвращаемого набора данных.

password

string

Пароль для аутентификации в API.

provider_display_name

string

Отображаемое имя поставщика.

username

string

Имя пользователя для аутентификации в API.

Атрибуты

Атрибут

Поддержка

Описание

check_mode

Поддержка: полная

добавлен в community.general 3.3.0

Это действие не изменяет состояние.

Модуль может работать в режиме check_mode и возвращать прогноз изменения состояния, не изменяя целевой объект.

diff_mode

Поддержка: Н/Д

Это действие не изменяет состояние.

В режиме diff возвращает сведения об изменениях (или о том, что, возможно, потребуется изменить в check_mode).

Примечания

Примечание

  • Пример файла конфигурации для параметра 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 SAN Managers
  community.general.oneview_san_manager_info:
    config: /etc/oneview/oneview_config.json
  delegate_to: localhost
  register: result

- name: Print fetched information about SAN Managers
  ansible.builtin.debug:
    msg: "{{ result.san_managers }}"

- name: Gather paginated, filtered and sorted information about SAN Managers
  community.general.oneview_san_manager_info:
    config: /etc/oneview/oneview_config.json
    params:
      start: 0
      count: 3
      sort: name:ascending
      query: isInternal eq false
  delegate_to: localhost
  register: result

- name: Print fetched information about paginated, filtered and sorted list of SAN Managers
  ansible.builtin.debug:
    msg: "{{ result.san_managers }}"

- name: Gather information about a SAN Manager by provider display name
  community.general.oneview_san_manager_info:
    config: /etc/oneview/oneview_config.json
    provider_display_name: Brocade Network Advisor
  delegate_to: localhost
  register: result

- name: Print fetched information about SAN Manager found by provider display name
  ansible.builtin.debug:
    msg: "{{ result.san_managers }}"

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

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

Ключ

Описание

san_managers

dictionary

Содержит все сведения OneView о менеджерах SAN.

Возвращается: всегда, но может иметь значение null.

Авторы

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

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

  • Отслеживание проблем
  • Репозиторий (исходный код)
  • Задать вопрос
  • Сообщить об ошибке
  • Предложить функцию
  • Связь

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

Spec-Zone.ru

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