Модуль community.general.oneview_logical_interconnect_group_info – Получение информации об одной или нескольких группах логических коммутаторов OneView

Примечание

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

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

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

Для использования в playbook, укажите: community.general.oneview_logical_interconnect_group_info.

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

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

Получение информации об одной или нескольких группах логических коммутаторов из 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.
name string	Имя группы логических коммутаторов.
params dictionary	Список параметров для ограничения, фильтрации и сортировки списка ресурсов. Допустимые ключи параметров: `start`: Первый возвращаемый элемент, с использованием индексации, начинающейся с 0. `count`: Количество возвращаемых ресурсов. `filter`: Общая строка фильтра/запроса для сужения списка возвращаемых элементов. `sort`: Порядок сортировки возвращаемого набора данных.
password string	Пароль для аутентификации API.
username string	Имя пользователя для аутентификации API.

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная добавлено в community.general 3.3.0 Это действие не изменяет состояние.	Может работать в режиме `check_mode` и возвращать прогноз измененного статуса без изменения целевого объекта.
diff_mode	Поддержка: N/A Это действие не изменяет состояние.	В режиме 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
Дополнительные Playbook для модулей 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 Logical Interconnect Groups
  community.general.oneview_logical_interconnect_group_info:
    hostname: 172.16.101.48
    username: administrator
    password: my_password
    api_version: 500
  no_log: true
  delegate_to: localhost
  register: result

- name: Print fetched information about Logical Interconnect Groups
  ansible.builtin.debug:
    msg: "{{ result.logical_interconnect_groups }}"

- name: Gather paginated, filtered and sorted information about Logical Interconnect Groups
  community.general.oneview_logical_interconnect_group_info:
    params:
      start: 0
      count: 3
      sort: name:descending
      filter: name=LIGName
    hostname: 172.16.101.48
    username: administrator
    password: my_password
    api_version: 500
  no_log: true
  delegate_to: localhost
  register: result

- name: Print fetched information about paginated, filtered and sorted list of Logical Interconnect Groups
  ansible.builtin.debug:
    msg: "{{ result.logical_interconnect_groups }}"

- name: Gather information about a Logical Interconnect Group by name
  community.general.oneview_logical_interconnect_group_info:
    name: logical interconnect group name
    hostname: 172.16.101.48
    username: administrator
    password: my_password
    api_version: 500
  no_log: true
  delegate_to: localhost
  register: result

- name: Print fetched information about Logical Interconnect Group found by name
  ansible.builtin.debug:
    msg: "{{ result.logical_interconnect_groups }}"

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

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

Ключ	Описание
logical_interconnect_groups словарь	Содержит всю информацию OneView о группах логических соединений. Возвращается: Всегда, но может быть нулевым.

Авторы

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_logical_interconnect_group_info_module.html