Модуль community.general.oneview_san_manager_info – Получение информации об одном или нескольких менеджерах SAN OneView

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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`: Первый возвращаемый элемент, используя индексацию с нуля. - `count`: Количество возвращаемых ресурсов. - `query`: Общий строковый запрос для сужения списка возвращаемых ресурсов. - `sort`: Порядок сортировки возвращаемых данных.
password string	Пароль для аутентификации API.
provider_display_name string	Имя поставщика для отображения.
username string	Имя пользователя для аутентификации API.

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная добавлено в community.general 3.3.0 Это действие не изменяет состояние.	Может работать в режиме `check_mode` и возвращать предсказание изменения статуса без модификации целевого объекта.
diff_mode	Поддержка: Нет Это действие не изменяет состояние.	Возвращает подробности о том, что изменилось (или, возможно, что нужно изменить в `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 словарь	Содержит всю информацию OneView о SAN-менеджерах. Возвращаемое значение: Всегда, но может быть пустым.

Авторы

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

Ссылки на сборку

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