oneview_san_manager_info – Retrieve information about one or more of the OneView SAN Managers¶
New in version 2.5.
Synopsis¶
Retrieve information about one or more of the SAN Managers from OneView
This module was called
oneview_san_manager_facts
before Ansible 2.9, returningansible_facts
. Note that the oneview_san_manager_info module no longer returnsansible_facts
!
Aliases: oneview_san_manager_facts
Requirements¶
The below requirements are needed on the host that executes this module.
hpOneView >= 2.0.1
python >= 2.7.9
Parameters¶
Notes¶
Note
A sample configuration file for the config parameter can be found at: https://github.com/HewlettPackard/oneview-ansible/blob/master/examples/oneview_config-rename.json
Check how to use environment variables for configuration at: https://github.com/HewlettPackard/oneview-ansible#environment-variables
Additional Playbooks for the HPE OneView Ansible modules can be found at: https://github.com/HewlettPackard/oneview-ansible/tree/master/examples
The OneView API version used will directly affect returned and expected fields in resources. Information on setting the desired API version and can be found at: https://github.com/HewlettPackard/oneview-ansible#setting-your-oneview-version
Examples¶
- name: Gather information about all SAN Managers
oneview_san_manager_info:
config: /etc/oneview/oneview_config.json
delegate_to: localhost
register: result
- debug:
msg: "{{ result.san_managers }}"
- name: Gather paginated, filtered and sorted information about SAN Managers
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
- debug:
msg: "{{ result.san_managers }}"
- name: Gather information about a SAN Manager by provider display name
oneview_san_manager_info:
config: /etc/oneview/oneview_config.json
provider_display_name: Brocade Network Advisor
delegate_to: localhost
register: result
- debug:
msg: "{{ result.san_managers }}"
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
san_managers
dictionary
|
Always, but can be null. |
Has all the OneView information about the SAN Managers.
|
Status¶
This module is not guaranteed to have a backwards compatible interface. [preview]
This module is maintained by the Ansible Community. [community]
Authors¶
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.