You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

community.general.oneview_fcoe_network_info module – Retrieve the information about one or more of the OneView FCoE Networks

Note

This module is part of the community.general collection (version 4.8.3).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install community.general.

To use it in a playbook, specify: community.general.oneview_fcoe_network_info.

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 community.general.oneview_fcoe_network_info module no longer returns ansible_facts!

Requirements

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

• hpOneView >= 2.0.1

• python >= 2.7.9

Parameters

Parameter	Comments
api_version integer	OneView API Version.
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.
hostname string	IP address or hostname for the appliance.
image_streamer_hostname string	IP address or hostname for the HPE Image Streamer REST API.
name string	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.
password string	Password for API authentication.
username string	Username for API authentication.

Notes

Note

• A sample configuration file for the config parameter can be found at: https://github.com/HewlettPackard/oneview-ansible/blob/master/examples/oneview_config-rename.json

• Check how to use environment variables for configuration at: https://github.com/HewlettPackard/oneview-ansible#environment-variables

• Additional Playbooks for the HPE OneView Ansible modules can be found at: https://github.com/HewlettPackard/oneview-ansible/tree/master/examples

• The OneView API version used will directly affect returned and expected fields in resources. Information on setting the desired API version and can be found at: https://github.com/HewlettPackard/oneview-ansible#setting-your-oneview-version

Examples

- 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 }}"

Return Values

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

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

Authors

• Felipe Bulsoni (@fgbulsoni)

• Thiago Miotto (@tmiotto)

• Adriane Cardozo (@adriane-cardozo)

Collection links

Issue Tracker Repository (Sources) Submit a bug report Request a feature Communication