community.general.oneview_ethernet_network_info (8.5.0) — module

Install collection

Install with ansible-galaxy collection install community.general:==8.5.0

Add to requirements.yml

  collections:
    - name: community.general
      version: 8.5.0

Description

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

Requirements

• Python >= 2.7.9
• hpOneView >= 2.0.1

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Print fetched information about Ethernet Networks
  ansible.builtin.debug:
    msg: "{{ result.ethernet_networks }}"

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Print fetched information about paginated and filtered list of Ethernet Networks
  ansible.builtin.debug:
    msg: "{{ result.ethernet_networks }}"

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Print fetched information about Ethernet Network found by name
  ansible.builtin.debug:
    msg: "{{ result.ethernet_networks }}"

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Print fetched information about Ethernet Network Associated Uplink Groups
  ansible.builtin.debug:
    msg: "{{ result.enet_associated_uplink_groups }}"

Inputs

    
name:
    description:
    - Ethernet Network name.
    type: str

config:
    description:
    - 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.
    type: path

params:
    description:
    - List of parameters to delimit, filter and sort the list of resources.
    - 'Parameter keys allowed are:'
    - 'C(start): The first item to return, using 0-based indexing.'
    - 'C(count): The number of resources to return.'
    - 'C(filter): A general filter/query string to narrow the list of items returned.'
    - 'C(sort): The sort order of the returned data set.'
    type: dict

options:
    description:
    - 'List with options to gather additional information about an Ethernet Network and
      related resources. Options allowed: V(associatedProfiles) and V(associatedUplinkGroups).'
    elements: str
    type: list

hostname:
    description:
    - IP address or hostname for the appliance.
    type: str

password:
    description:
    - Password for API authentication.
    type: str

username:
    description:
    - Username for API authentication.
    type: str

api_version:
    description:
    - OneView API Version.
    type: int

image_streamer_hostname:
    description:
    - IP address or hostname for the HPE Image Streamer REST API.
    type: str

Outputs

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