community.general.oneview_ethernet_network_info – Retrieve the information about one or more of the OneView Ethernet Networks

Note

This plugin is part of the community.general collection (version 3.7.0).

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

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

Synopsis

  • Retrieve the information about one or more of the Ethernet Networks from OneView.

  • This module was called oneview_ethernet_network_facts before Ansible 2.9, returning ansible_facts. Note that the community.general.oneview_ethernet_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 Choices/Defaults 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
Ethernet Network name.
options
list / elements=string
List with options to gather additional information about an Ethernet Network and related resources. Options allowed: associatedProfiles and associatedUplinkGroups.
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

Examples

- name: Gather information about all Ethernet Networks
  community.general.oneview_ethernet_network_info:
    config: /etc/oneview/oneview_config.json
  delegate_to: localhost
  register: result

- ansible.builtin.debug:
    msg: "{{ result.ethernet_networks }}"

- name: Gather paginated and filtered information about Ethernet Networks
  community.general.oneview_ethernet_network_info:
    config: /etc/oneview/oneview_config.json
    params:
      start: 1
      count: 3
      sort: 'name:descending'
      filter: 'purpose=General'
  delegate_to: localhost
  register: result

- ansible.builtin.debug:
    msg: "{{ result.ethernet_networks }}"

- name: Gather information about an Ethernet Network by name
  community.general.oneview_ethernet_network_info:
    config: /etc/oneview/oneview_config.json
    name: Ethernet network name
  delegate_to: localhost
  register: result

- ansible.builtin.debug:
    msg: "{{ result.ethernet_networks }}"

- name: Gather information about an Ethernet Network by name with options
  community.general.oneview_ethernet_network_info:
    config: /etc/oneview/oneview_config.json
    name: eth1
    options:
      - associatedProfiles
      - associatedUplinkGroups
  delegate_to: localhost
  register: result

- ansible.builtin.debug:
    msg: "{{ result.enet_associated_profiles }}"
- ansible.builtin.debug:
    msg: "{{ result.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
dictionary
When requested, but can be null.
Has all the OneView information about the profiles which are using the Ethernet network.

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

ethernet_networks
dictionary
Always, but can be null.
Has all the OneView information about the Ethernet Networks.



Authors

  • Felipe Bulsoni (@fgbulsoni)

  • Thiago Miotto (@tmiotto)

  • Adriane Cardozo (@adriane-cardozo)