Модуль community.general.oneview_fcoe_network_info – Получение информации об одной или нескольких сетях OneView FCoE

Примечание

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

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

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

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

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

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

Получение информации об одной или нескольких сетях FCoE из 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	Имя сети FCoE.
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
Дополнительные Playbook для модулей 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 FCoE Networks
  community.general.oneview_fcoe_network_info:
    config: /etc/oneview/oneview_config.json
  delegate_to: localhost
  register: result

- name: Print fetched information about FCoE Networks
  ansible.builtin.debug:
    msg: "{{ result.fcoe_networks }}"

- name: Gather paginated, filtered and sorted information about FCoE Networks
  community.general.oneview_fcoe_network_info:
    config: /etc/oneview/oneview_config.json
    params:
      start: 0
      count: 3
      sort: 'name:descending'
      filter: 'vlanId=2'
  delegate_to: localhost
  register: result

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

- name: Gather information about a FCoE Network by name
  community.general.oneview_fcoe_network_info:
    config: /etc/oneview/oneview_config.json
    name: Test FCoE Network Information
  delegate_to: localhost
  register: result

- name: Print fetched information about FCoE Network found by name
  ansible.builtin.debug:
    msg: "{{ result.fcoe_networks }}"

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

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

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

Авторы

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