oneview_datacenter_info – Retrieve information about the OneView Data Centers

New in version 2.5.

Synopsis

  • Retrieve information about the OneView Data Centers.
  • This module was called oneview_datacenter_facts before Ansible 2.9, returning ansible_facts. Note that the oneview_datacenter_info module no longer returns ansible_facts!

Aliases: oneview_datacenter_facts

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
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 information. Options available: 'visualContent'.
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. - filter: A general filter/query string to narrow the list of items returned. - sort: The sort order of the returned data set.

Notes

Note

Examples

- name: Gather information about all Data Centers
  oneview_datacenter_info:
    hostname: 172.16.101.48
    username: administrator
    password: my_password
    api_version: 500
  delegate_to: localhost
  register: result
- debug:
    msg: "{{ result.datacenters }}"

- name: Gather paginated, filtered and sorted information about Data Centers
  oneview_datacenter_info:
    hostname: 172.16.101.48
    username: administrator
    password: my_password
    api_version: 500
    params:
      start: 0
      count: 3
      sort: 'name:descending'
      filter: 'state=Unmanaged'
  register: result
- debug:
    msg: "{{ result.datacenters }}"

- name: Gather information about a Data Center by name
  oneview_datacenter_info:
    hostname: 172.16.101.48
    username: administrator
    password: my_password
    api_version: 500
    name: "My Data Center"
  delegate_to: localhost
  register: result
- debug:
    msg: "{{ result.datacenters }}"

- name: Gather information about the Data Center Visual Content
  oneview_datacenter_info:
    hostname: 172.16.101.48
    username: administrator
    password: my_password
    api_version: 500
    name: "My Data Center"
    options:
      - visualContent
  delegate_to: localhost
  register: result
- debug:
    msg: "{{ result.datacenters }}"
- debug:
    msg: "{{ result.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
dictionary
When requested, but can be null.
Has information about the Data Center Visual Content.

datacenters
dictionary
Always, but can be null.
Has all the OneView information about the Data Centers.



Status

Authors

  • 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.