oneview_fcoe_network_info – Retrieve the information about one or more of the OneView FCoE Networks

New in version 2.4.

Synopsis

  • Retrieve the information about one or more of the FCoE Networks from OneView.
  • This module was called oneview_fcoe_network_facts before Ansible 2.9, returning ansible_facts. Note that the oneview_fcoe_network_info module no longer returns ansible_facts!

Aliases: oneview_fcoe_network_facts

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
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
-
FCoE Network name.
params
dictionary
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 information about all FCoE Networks
  oneview_fcoe_network_info:
    config: /etc/oneview/oneview_config.json
  delegate_to: localhost
  register: result

- debug:
    msg: "{{ result.fcoe_networks }}"

- name: Gather paginated, filtered and sorted information about FCoE Networks
  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

- debug:
    msg: "{{ result.fcoe_networks }}"

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

- debug:
    msg: "{{ result.fcoe_networks }}"

Return Values

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

Key Returned Description
fcoe_networks
dictionary
Always, but can be null.
Has all the OneView information about the FCoE Networks.



Status

Authors

  • 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.