Documentation

oneview_ethernet_network_facts - Retrieve the facts about one or more of the OneView Ethernet Networks

New in version 2.4.

Synopsis

  • Retrieve the facts about one or more of the Ethernet 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
Ethernet Network name.
options
List with options to gather additional facts about an Ethernet Network and related resources. Options allowed: associatedProfiles and associatedUplinkGroups.
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 Ethernet Networks
  oneview_ethernet_network_facts:
    config: /etc/oneview/oneview_config.json
  delegate_to: localhost

- debug: var=ethernet_networks

- name: Gather paginated and filtered facts about Ethernet Networks
  oneview_ethernet_network_facts:
    config: /etc/oneview/oneview_config.json
    params:
      start: 1
      count: 3
      sort: 'name:descending'
      filter: 'purpose=General'
  delegate_to: localhost

- debug: var=ethernet_networks

- name: Gather facts about an Ethernet Network by name
  oneview_ethernet_network_facts:
    config: /etc/oneview/oneview_config.json
    name: Ethernet network name
  delegate_to: localhost

- debug: var=ethernet_networks

- name: Gather facts about an Ethernet Network by name with options
  oneview_ethernet_network_facts:
    config: /etc/oneview/oneview_config.json
    name: eth1
    options:
      - associatedProfiles
      - associatedUplinkGroups
  delegate_to: localhost

- debug: var=enet_associated_profiles
- debug: var=enet_associated_uplink_groups

Return Values

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

Key
Returned
Description
enet_associated_profiles
dict
When requested, but can be null.
Has all the OneView facts about the profiles which are using the Ethernet network.

enet_associated_uplink_groups
dict
When requested, but can be null.
Has all the OneView facts about the uplink sets which are using the Ethernet network.

ethernet_networks
dict
Always, but can be null.
Has all the OneView facts about the Ethernet Networks.



Status

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

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.