community.general.oneview_fcoe_network_info – Получение информации об одной или нескольких сетях FCoE OneView
Примечание
Этот плагин является частью коллекции community.general (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install community.general.
Для использования в книге задач укажите: community.general.oneview_fcoe_network_info.
Описание
- Получение информации об одной или нескольких сетях FCoE из OneView.
- Этот модуль назывался
oneview_fcoe_network_factsдо Ansible 2.9, возвращаяansible_facts. Обратите внимание, что модуль community.general.oneview_fcoe_network_info больше не возвращаетansible_facts!
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- hpOneView >= 2.0.1
- python >= 2.7.9
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| config путь | Путь к файлу конфигурации .json, содержащему конфигурацию клиента OneView. Файл конфигурации является необязательным и при использовании должен быть на хосте, на котором выполняются команды ansible. Если путь к файлу не указан, конфигурация загружается из переменных среды. Для ссылок на примеры файлов конфигурации или способов использования переменных среды см. раздел примечаний. | |
| name строка | Имя сети FCoE. | |
| params словарь | Список параметров для ограничения, фильтрации и сортировки списка ресурсов. Разрешенные параметры: - start: Первый элемент для возврата, используя индексацию с нуля. - count: Количество возвращаемых ресурсов. - filter: Общая строка фильтра/запроса для сужения списка возвращаемых элементов. - sort: Порядок сортировки возвращаемого набора данных. |
Примечания
Примечание
- Пример файла конфигурации для параметра 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 FCoE Networks
community.general.oneview_fcoe_network_info:
config: /etc/oneview/oneview_config.json
delegate_to: localhost
register: result
- 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
- 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
- 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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/general/oneview_fcoe_network_info_module.html