Documentation

oneview_fc_network_facts - Retrieve the facts about one or more of the OneView Fibre Channel Networks

New in version 2.4.

Synopsis

  • Retrieve the facts about one or more of the Fibre Channel Networks from OneView.

Requirements

The below requirements are needed on the host that executes this module.

  • hpOneView >= 2.0.1
  • python >= 2.7.9

Parameters

Parameter Choices/Defaults Comments
config
Path to a .json configuration file containing the OneView client configuration. The configuration file is optional and when used should be present in the host running the ansible commands. If the file path is not provided, the configuration will be loaded from environment variables. For links to example configuration files or how to use the environment variables verify the notes section.
name
Fibre Channel Network name.
params
List of params to delimit, filter and sort the list of resources.
params allowed: - start: The first item to return, using 0-based indexing. - count: The number of resources to return. - filter: A general filter/query string to narrow the list of items returned. - sort: The sort order of the returned data set.

Notes

Note

Examples

- name: Gather facts about all Fibre Channel Networks
  oneview_fc_network_facts:
    config: /etc/oneview/oneview_config.json
  delegate_to: localhost

- debug: var=fc_networks

- name: Gather paginated, filtered and sorted facts about Fibre Channel Networks
  oneview_fc_network_facts:
    config: /etc/oneview/oneview_config.json
    params:
      start: 1
      count: 3
      sort: 'name:descending'
      filter: 'fabricType=FabricAttach'
  delegate_to: localhost
- debug: var=fc_networks

- name: Gather facts about a Fibre Channel Network by name
  oneview_fc_network_facts:
    config: /etc/oneview/oneview_config.json
    name: network name
  delegate_to: localhost

- debug: var=fc_networks

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
fc_networks
dict
Always, but can be null.
Has all the OneView facts about the Fibre Channel Networks.



Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Maintenance

This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by the Ansible Community, see here.

Author

  • Felipe Bulsoni (@fgbulsoni)
  • Thiago Miotto (@tmiotto)
  • Adriane Cardozo (@adriane-cardozo)

Hint

If you notice any issues in this documentation you can edit this document to improve it.