/ home / community / community.general / 8.5.0 / module / oneview_logical_interconnect_group_info

community.general.oneview_logical_interconnect_group_info (8.5.0) — module

Retrieve information about one or more of the OneView Logical Interconnect Groups

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 one or more of the Logical Interconnect Groups from OneView

Requirements

Python >= 2.7.9
hpOneView >= 2.0.1

Usage examples

Scanned by Steampunk Spotter

- name: Gather information about all Logical Interconnect Groups
  community.general.oneview_logical_interconnect_group_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 Logical Interconnect Groups
  ansible.builtin.debug:
    msg: "{{ result.logical_interconnect_groups }}"

Scanned by Steampunk Spotter

- name: Gather paginated, filtered and sorted information about Logical Interconnect Groups
  community.general.oneview_logical_interconnect_group_info:
    params:
      start: 0
      count: 3
      sort: name:descending
      filter: name=LIGName
    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 paginated, filtered and sorted list of Logical Interconnect Groups
  ansible.builtin.debug:
    msg: "{{ result.logical_interconnect_groups }}"

Scanned by Steampunk Spotter

- name: Gather information about a Logical Interconnect Group by name
  community.general.oneview_logical_interconnect_group_info:
    name: logical interconnect group name
    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 Logical Interconnect Group found by name
  ansible.builtin.debug:
    msg: "{{ result.logical_interconnect_groups }}"

Inputs

    
name:
    description:
    - Logical Interconnect Group 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

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

logical_interconnect_groups:
  description: Has all the OneView information about the Logical Interconnect Groups.
  returned: Always, but can be null.
  type: dict