Модуль community.general.oneview_fc_network_info — получение сведений об одной или нескольких сетях Fibre Channel OneView

Примечание

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

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

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

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

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

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

Получение сведений об одной или нескольких сетях Fibre Channel из 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	Имя сети Fibre Channel.
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.
Дополнительные плейбуки для модулей Ansible HPE OneView можно найти здесь: 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 Fibre Channel Networks
  community.general.oneview_fc_network_info:
    config: /etc/oneview/oneview_config.json
  delegate_to: localhost
  register: result

- name: Print fetched information about Fibre Channel Networks
  ansible.builtin.debug:
    msg: "{{ result.fc_networks }}"

- name: Gather paginated, filtered and sorted information about Fibre Channel Networks
  community.general.oneview_fc_network_info:
    config: /etc/oneview/oneview_config.json
    params:
      start: 1
      count: 3
      sort: 'name:descending'
      filter: 'fabricType=FabricAttach'
  delegate_to: localhost
  register: result

- name: Print fetched information about paginated, filtered and sorted list of Fibre Channel Networks
  ansible.builtin.debug:
    msg: "{{ result.fc_networks }}"

- name: Gather information about a Fibre Channel Network by name
  community.general.oneview_fc_network_info:
    config: /etc/oneview/oneview_config.json
    name: network name
  delegate_to: localhost
  register: result

- name: Print fetched information about Fibre Channel Network found by name
  ansible.builtin.debug:
    msg: "{{ result.fc_networks }}"

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

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

Ключ	Описание
fc_networks dictionary	Содержит все сведения OneView о сетях Fibre Channel. Возвращается: всегда, но значение может быть 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_fc_network_info_module.html