oneview_datacenter_facts - Retrieve facts about the OneView Data Centers
New in version 2.5.
Synopsis
- Retrieve facts about the OneView Data Centers.
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.
|
|
| name |
Data Center name.
|
|
| options |
Retrieve additional facts. Options available: 'visualContent'.
|
|
| 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. - filter: A general filter/query string to narrow the list of items returned. - sort: The sort order of the returned data set.
|
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 facts about all Data Centers
oneview_datacenter_facts:
hostname: 172.16.101.48
username: administrator
password: my_password
api_version: 500
delegate_to: localhost
- debug: var=datacenters
- name: Gather paginated, filtered and sorted facts about Data Centers
oneview_datacenter_facts:
hostname: 172.16.101.48
username: administrator
password: my_password
api_version: 500
params:
start: 0
count: 3
sort: 'name:descending'
filter: 'state=Unmanaged'
- debug: var=datacenters
- name: Gather facts about a Data Center by name
oneview_datacenter_facts:
hostname: 172.16.101.48
username: administrator
password: my_password
api_version: 500
name: "My Data Center"
delegate_to: localhost
- debug: var=datacenters
- name: Gather facts about the Data Center Visual Content
oneview_datacenter_facts:
hostname: 172.16.101.48
username: administrator
password: my_password
api_version: 500
name: "My Data Center"
options:
- visualContent
delegate_to: localhost
- debug: var=datacenters
- debug: var=datacenter_visual_content
Return Values
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| datacenter_visual_content
dict
|
When requested, but can be null. |
Has facts about the Data Center Visual Content.
|
| datacenters
dict
|
Always, but can be null. |
Has all the OneView facts about the Data Centers.
|
Status
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Maintenance
This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.
For a list of other modules that are also maintained by the Ansible Community, see here.
Author
- Alex Monteiro (@aalexmonteiro)
- Madhav Bharadwaj (@madhav-bharadwaj)
- Priyanka Sood (@soodpr)
- Ricardo Galeno (@ricardogpsf)
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.6/modules/oneview_datacenter_facts_module.html