community.general.oneview_san_manager_info module – Retrieve information about one or more of the OneView SAN Managers

Note

This module is part of the community.general collection (version 8.5.0).

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. You need further requirements to be able to use this module, see Requirements for details.

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

Synopsis

  • Retrieve information about one or more of the SAN Managers from OneView

Aliases: remote_management.oneview.oneview_san_manager_info

Requirements

The below requirements are needed on the host that executes this module.

  • Python >= 2.7.9

  • hpOneView >= 2.0.1

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.

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. - query: A general query string to narrow the list of resources returned. - sort: The sort order of the returned data set.

password

string

Password for API authentication.

provider_display_name

string

Provider Display Name.

username

string

Username for API authentication.

Attributes

Attribute

Support

Description

check_mode

Support: full

added in community.general 3.3.0

This action does not modify state.

Can run in check_mode and return changed status prediction without modifying target.

diff_mode

Support: N/A

This action does not modify state.

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.

Notes

Note

Examples

- name: Gather information about all SAN Managers
  community.general.oneview_san_manager_info:
    config: /etc/oneview/oneview_config.json
  delegate_to: localhost
  register: result

- name: Print fetched information about SAN Managers
  ansible.builtin.debug:
    msg: "{{ result.san_managers }}"

- name: Gather paginated, filtered and sorted information about SAN Managers
  community.general.oneview_san_manager_info:
    config: /etc/oneview/oneview_config.json
    params:
      start: 0
      count: 3
      sort: name:ascending
      query: isInternal eq false
  delegate_to: localhost
  register: result

- name: Print fetched information about paginated, filtered and sorted list of SAN Managers
  ansible.builtin.debug:
    msg: "{{ result.san_managers }}"

- name: Gather information about a SAN Manager by provider display name
  community.general.oneview_san_manager_info:
    config: /etc/oneview/oneview_config.json
    provider_display_name: Brocade Network Advisor
  delegate_to: localhost
  register: result

- name: Print fetched information about SAN Manager found by provider display name
  ansible.builtin.debug:
    msg: "{{ result.san_managers }}"

Return Values

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

Key

Description

san_managers

dictionary

Has all the OneView information about the SAN Managers.

Returned: Always, but can be null.

Authors

  • Felipe Bulsoni (@fgbulsoni)

  • Thiago Miotto (@tmiotto)

  • Adriane Cardozo (@adriane-cardozo)