community.general.oneview_network_set_info – Retrieve information about the OneView Network Sets

Note

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

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.

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

Synopsis

  • Retrieve information about the Network Sets from OneView.

  • This module was called oneview_network_set_facts before Ansible 2.9, returning ansible_facts. Note that the community.general.oneview_network_set_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

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

Network Set name.

options

list / elements=string

List with options to gather information about Network Set. Option allowed: withoutEthernet. The option withoutEthernet retrieves the list of network_sets excluding Ethernet networks.

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

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

- 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

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

- 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

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

- 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

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

- 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

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

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

network_sets

dictionary

Has all the OneView information about the Network Sets.

Returned: Always, but can be empty.

Authors

  • Felipe Bulsoni (@fgbulsoni)

  • Thiago Miotto (@tmiotto)

  • Adriane Cardozo (@adriane-cardozo)