community.general.oneview_datacenter_facts (0.1.4) — module

Retrieve information about the OneView Data Centers

Authors: Alex Monteiro (@aalexmonteiro), Madhav Bharadwaj (@madhav-bharadwaj), Priyanka Sood (@soodpr), Ricardo Galeno (@ricardogpsf)

Install collection

Install with ansible-galaxy collection install community.general:==0.1.4


Add to requirements.yml

  collections:
    - name: community.general
      version: 0.1.4

Description

Retrieve information about the OneView Data Centers.

This module was called C(oneview_datacenter_facts) before Ansible 2.9, returning C(ansible_facts). Note that the M(oneview_datacenter_info) module no longer returns C(ansible_facts)!


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- debug:
    msg: "{{ result.datacenters }}"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- debug:
    msg: "{{ result.datacenters }}"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- debug:
    msg: "{{ result.datacenters }}"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- debug:
    msg: "{{ result.datacenters }}"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- debug:
    msg: "{{ result.datacenter_visual_content }}"

Inputs

    
name:
    description:
    - Data Center name.

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 params to delimit, filter and sort the list of resources.
    - 'params allowed: - 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''.'

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