ansible.builtin.oneview_ethernet_network_info (v2.9.27) — module

Install Ansible via pip

Install with pip install ansible==2.9.27

Description

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

This module was called C(oneview_ethernet_network_facts) before Ansible 2.9, returning C(ansible_facts). Note that the M(oneview_ethernet_network_info) module no longer returns C(ansible_facts)!

Requirements

• hpOneView >= 2.0.1
• python >= 2.7.9

Usage examples

Scanned by Steampunk Spotter

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

- name: Gather information about all Ethernet Networks
  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.

- 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
  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.

- 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
  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.

- 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
  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.

- debug:
    msg: "{{ result.enet_associated_profiles }}"

Scanned by Steampunk Spotter

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

- debug:
    msg: "{{ result.enet_associated_uplink_groups }}"

Inputs

    
name:
    description:
    - Ethernet Network name.

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 params to delimit, filter and sort the list of resources.
    - 'params allowed: - 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: C(associatedProfiles) and C(associatedUplinkGroups).'

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