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

Примечание

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

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

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

Чтобы использовать модуль в плейбуке, укажите: 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	Поддержка: не применимо Это действие не изменяет состояние.	В режиме 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 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 dictionary	Содержит всю информацию OneView о группах логических интерконнектов. Возвращается: всегда, но может иметь значение 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_logical_interconnect_group_info_module.html