community.general.oneview_san_manager_info (8.5.0) — module

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 SAN Managers from OneView

Requirements

• Python >= 2.7.9
• hpOneView >= 2.0.1

Usage examples

Scanned by Steampunk Spotter

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

- name: Gather information about all SAN Managers
  community.general.oneview_san_manager_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.

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

Scanned by Steampunk Spotter

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

- 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

Scanned by Steampunk Spotter

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

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

Scanned by Steampunk Spotter

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

- 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

Scanned by Steampunk Spotter

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

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

Inputs

    
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: - V(start): The first item to return, using 0-based indexing. -
      V(count): The number of resources to return. - V(query): A general query string
      to narrow the list of resources returned. - V(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

provider_display_name:
    description:
    - Provider Display Name.
    type: str

image_streamer_hostname:
    description:
    - IP address or hostname for the HPE Image Streamer REST API.
    type: str

Outputs

san_managers:
  description: Has all the OneView information about the SAN Managers.
  returned: Always, but can be null.
  type: dict