/ home / community / community.general / 8.5.0 / module / oneview_network_set_info

community.general.oneview_network_set_info (8.5.0) — module

Retrieve information about the OneView Network Sets

Authors: Felipe Bulsoni (@fgbulsoni), Thiago Miotto (@tmiotto), Adriane Cardozo (@adriane-cardozo)

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 information about the Network Sets from OneView.

Requirements

Python >= 2.7.9
hpOneView >= 2.0.1

Usage examples

Scanned by Steampunk Spotter

- name: Gather information about all Network Sets
  community.general.oneview_network_set_info:
    hostname: 172.16.101.48
    username: administrator
    password: my_password
    api_version: 500
  no_log: true
  delegate_to: localhost
  register: result

Scanned by Steampunk Spotter

- name: Print fetched information about Network Sets
  ansible.builtin.debug:
    msg: "{{ result.network_sets }}"

Scanned by Steampunk Spotter

- name: Gather paginated, filtered and sorted information about Network Sets
  community.general.oneview_network_set_info:
    hostname: 172.16.101.48
    username: administrator
    password: my_password
    api_version: 500
    params:
      start: 0
      count: 3
      sort: 'name:descending'
      filter: name='netset001'
  no_log: true
  delegate_to: localhost
  register: result

Scanned by Steampunk Spotter

- name: Print fetched information about paginated, filtered and sorted list of Network Sets
  ansible.builtin.debug:
    msg: "{{ result.network_sets }}"

Scanned by Steampunk Spotter

- name: Gather information about all Network Sets, excluding Ethernet networks
  community.general.oneview_network_set_info:
    hostname: 172.16.101.48
    username: administrator
    password: my_password
    api_version: 500
    options:
        - withoutEthernet
  no_log: true
  delegate_to: localhost
  register: result

Scanned by Steampunk Spotter

- name: Print fetched information about Network Sets, excluding Ethernet networks
  ansible.builtin.debug:
    msg: "{{ result.network_sets }}"

Scanned by Steampunk Spotter

- name: Gather information about a Network Set by name
  community.general.oneview_network_set_info:
    hostname: 172.16.101.48
    username: administrator
    password: my_password
    api_version: 500
    name: Name of the Network Set
  no_log: true
  delegate_to: localhost
  register: result

Scanned by Steampunk Spotter

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

Scanned by Steampunk Spotter

- name: Gather information about a Network Set by name, excluding Ethernet networks
  community.general.oneview_network_set_info:
    hostname: 172.16.101.48
    username: administrator
    password: my_password
    api_version: 500
    name: Name of the Network Set
    options:
        - withoutEthernet
  no_log: true
  delegate_to: localhost
  register: result

Scanned by Steampunk Spotter

- name: Print fetched information about Network Set found by name, excluding Ethernet networks
  ansible.builtin.debug:
    msg: "{{ result.network_sets }}"

Inputs

name:
description:
- Network Set 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 information about Network Set. Option allowed: V(withoutEthernet).
The option V(withoutEthernet) retrieves the list of network_sets excluding Ethernet
networks.'
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

network_sets:
  description: Has all the OneView information about the Network Sets.
  returned: Always, but can be empty.
  type: dict