Documentation

oneview_san_manager_facts - Retrieve facts about one or more of the OneView SAN Managers

New in version 2.5.

Synopsis

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

Requirements

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

  • hpOneView >= 2.0.1
  • python >= 2.7.9

Parameters

Parameter
Choices/Defaults
Comments
config
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.
params
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.
provider_display_name
Provider Display Name.

Notes

Note

Examples

- name: Gather facts about all SAN Managers
  oneview_san_manager_facts:
    config: /etc/oneview/oneview_config.json
  delegate_to: localhost

- debug: var=san_managers

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

- debug: var=san_managers

- name: Gather facts about a SAN Manager by provider display name
  oneview_san_manager_facts:
    config: /etc/oneview/oneview_config.json
    provider_display_name: Brocade Network Advisor
  delegate_to: localhost

- debug: var=san_managers

Return Values

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

Key
Returned
Description
san_managers
dict
Always, but can be null.
Has all the OneView facts about the SAN Managers.



Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Author

  • Felipe Bulsoni (@fgbulsoni)
  • Thiago Miotto (@tmiotto)
  • Adriane Cardozo (@adriane-cardozo)

Hint

If you notice any issues in this documentation you can edit this document to improve it.