community.general.oneview_fc_network_info – Получение информации об одной или нескольких сетях Fibre Channel OneView
Примечание
Этот плагин входит в коллекцию community.general (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install community.general.
Для использования в playbook укажите: community.general.oneview_fc_network_info.
Обзор
- Получение информации об одной или нескольких сетях Fibre Channel из OneView.
- Этот модуль назывался
oneview_fc_network_factsдо Ansible 2.9, возвращаяansible_facts. Обратите внимание, что модуль community.general.oneview_fc_network_info больше не возвращаетansible_facts!
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- hpOneView >= 2.0.1
- python >= 2.7.9
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| config путь | Путь к файлу конфигурации .json, содержащему конфигурацию клиента OneView. Файл конфигурации необязателен и, если используется, должен присутствовать на хосте, выполняющем команды ansible. Если путь к файлу не указан, конфигурация будет загружена из переменных окружения. Для получения ссылок на примеры файлов конфигурации или способов использования переменных окружения см. раздел Примечания. | |
| name строка | Имя сети Fibre Channel. | |
| 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
- Дополнительные 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 Fibre Channel Networks
community.general.oneview_fc_network_info:
config: /etc/oneview/oneview_config.json
delegate_to: localhost
register: result
- 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
- 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
- ansible.builtin.debug:
msg: "{{ result.fc_networks }}"
Значения возврата
Общие значения возврата документированы здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| fc_networks словарь | Всегда, но может быть пустым. | Содержит всю информацию OneView о сетях Fibre Channel. |
Авторы
- 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_fc_network_info_module.html