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

Note

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

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. You need further requirements to be able to use this module, see Requirements for details.

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.

Aliases: remote_management.oneview.oneview_ethernet_network_info

Requirements

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

• Python >= 2.7.9

• hpOneView >= 2.0.1

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	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 parameters to delimit, filter and sort the list of resources. Parameter keys allowed are: 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.

Attributes

Attribute	Support	Description
check_mode	Support: full added in community.general 3.3.0 This action does not modify state.	Can run in check_mode and return changed status prediction without modifying target.
diff_mode	Support: N/A This action does not modify state.	Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.

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 Ethernet Networks
  community.general.oneview_ethernet_network_info:
    config: /etc/oneview/oneview_config.json
  delegate_to: localhost
  register: result

- name: Print fetched information about Ethernet Networks
  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

- name: Print fetched information about paginated and filtered list of Ethernet Networks
  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

- name: Print fetched information about Ethernet Network found by name
  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

- name: Print fetched information about Ethernet Network Associated Profiles
  ansible.builtin.debug:
    msg: "{{ result.enet_associated_profiles }}"

- name: Print fetched information about Ethernet Network Associated Uplink Groups
  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	Description
enet_associated_profiles dictionary	Has all the OneView information about the profiles which are using the Ethernet network. Returned: When requested, but can be null.
enet_associated_uplink_groups dictionary	Has all the OneView information about the uplink sets which are using the Ethernet network. Returned: When requested, but can be null.
ethernet_networks dictionary	Has all the OneView information about the Ethernet Networks. Returned: Always, but can be null.

Authors

• Felipe Bulsoni (@fgbulsoni)

• Thiago Miotto (@tmiotto)

• Adriane Cardozo (@adriane-cardozo)

Collection links

• Issue Tracker
• Repository (Sources)
• Ask for help
• Submit a bug report
• Request a feature
• Communication