W3cubDocs

/Ansible

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 (on host that executes module)

  • hpOneView >= 2.0.1
  • python >= 2.7.9

Options

parameter required default choices comments
config
 no
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
 no
Ethernet Network name.
options
 no
List with options to gather additional facts about an Ethernet Network and related resources. Options allowed: associatedProfiles and associatedUplinkGroups.
params
 no
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.

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 Return Values, the following are the fields unique to this module:

name description returned type sample
ethernet_networks
Has all the OneView facts about the Ethernet Networks.
 Always, but can be null. dict
enet_associated_profiles
Has all the OneView facts about the profiles which are using the Ethernet network.
 When requested, but can be null. dict
enet_associated_uplink_groups
Has all the OneView facts about the uplink sets which are using the Ethernet network.
 When requested, but can be null. dict

Notes

Note

Status

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

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.

© 2012–2017 Michael DeHaan
© 2017 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/oneview_ethernet_network_facts_module.html