community.general.oneview_datacenter_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 the OneView Data Centers.

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 Data Centers
  community.general.oneview_datacenter_info:
    hostname: 172.16.101.48
    username: administrator
    password: my_password
    api_version: 500
  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 Data Centers
  ansible.builtin.debug:
    msg: "{{ result.datacenters }}"

Scanned by Steampunk Spotter

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

- name: Gather paginated, filtered and sorted information about Data Centers
  community.general.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

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 Data Centers
  ansible.builtin.debug:
    msg: "{{ result.datacenters }}"

Scanned by Steampunk Spotter

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

- name: Gather information about a Data Center by name
  community.general.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

Scanned by Steampunk Spotter

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

- name: Print fetched information about Data Center found by name
  ansible.builtin.debug:
    msg: "{{ result.datacenters }}"

Scanned by Steampunk Spotter

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

- name: Gather information about the Data Center Visual Content
  community.general.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

Scanned by Steampunk Spotter

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

- name: Print fetched information about Data Center found by name
  ansible.builtin.debug:
    msg: "{{ result.datacenters }}"

Scanned by Steampunk Spotter

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

- name: Print fetched information about Data Center Visual Content
  ansible.builtin.debug:
    msg: "{{ result.datacenter_visual_content }}"

Inputs

    
name:
    description:
    - Data Center name.
    type: str

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 parameters to delimit, filter and sort the list of resources.
    - 'Parameter keys allowed are:'
    - 'C(start): The first item to return, using 0-based indexing.'
    - 'C(count): The number of resources to return.'
    - 'C(filter): A general filter/query string to narrow the list of items returned.'
    - 'C(sort): The sort order of the returned data set.'
    type: dict

options:
    description:
    - 'Retrieve additional information. Options available: ''visualContent''.'
    elements: str
    type: list

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

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

Outputs

datacenter_visual_content:
  description: Has information about the Data Center Visual Content.
  returned: When requested, but can be null.
  type: dict
datacenters:
  description: Has all the OneView information about the Data Centers.
  returned: Always, but can be null.
  type: dict