ansible / ansible.builtin / v2.9.27 / module / _oneview_enclosure_facts Retrieve information about one or more Enclosures | "added in version" 2.5 of ansible.builtin" Authors: Felipe Bulsoni (@fgbulsoni), Thiago Miotto (@tmiotto), Adriane Cardozo (@adriane-cardozo) preview | supported by communityansible.builtin._oneview_enclosure_facts (v2.9.27) — module
pip
Install with pip install ansible==2.9.27
Retrieve information about one or more of the Enclosures from OneView.
This module was called C(oneview_enclosure_facts) before Ansible 2.9, returning C(ansible_facts). Note that the M(oneview_enclosure_info) module no longer returns C(ansible_facts)!
- name: Gather information about all Enclosures oneview_enclosure_info: hostname: 172.16.101.48 username: administrator password: my_password api_version: 500 no_log: true delegate_to: localhost register: result
- debug: msg: "{{ result.enclosures }}"
- name: Gather paginated, filtered and sorted information about Enclosures oneview_enclosure_info: params: start: 0 count: 3 sort: name:descending filter: status=OK hostname: 172.16.101.48 username: administrator password: my_password api_version: 500 no_log: true delegate_to: localhost register: result
- debug: msg: "{{ result.enclosures }}"
- name: Gather information about an Enclosure by name oneview_enclosure_info: name: Enclosure-Name hostname: 172.16.101.48 username: administrator password: my_password api_version: 500 no_log: true delegate_to: localhost register: result
- debug: msg: "{{ result.enclosures }}"
- name: Gather information about an Enclosure by name with options oneview_enclosure_info: name: Test-Enclosure options: - script # optional - environmentalConfiguration # optional - utilization # optional hostname: 172.16.101.48 username: administrator password: my_password api_version: 500 no_log: true delegate_to: localhost register: result
- debug: msg: "{{ result.enclosures }}"
- debug: msg: "{{ result.enclosure_script }}"
- debug: msg: "{{ result.enclosure_environmental_configuration }}"
- debug: msg: "{{ result.enclosure_utilization }}"
- name: "Gather information about an Enclosure with temperature data at a resolution of one sample per day, between two specified dates" oneview_enclosure_info: name: Test-Enclosure options: - utilization: # optional fields: AmbientTemperature filter: - startDate=2016-07-01T14:29:42.000Z - endDate=2017-07-01T03:29:42.000Z view: day refresh: false hostname: 172.16.101.48 username: administrator password: my_password api_version: 500 no_log: true delegate_to: localhost register: result
- debug: msg: "{{ result.enclosures }}"
- debug: msg: "{{ result.enclosure_utilization }}"
name: description: - Enclosure 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: - 'List with options to gather additional information about an Enclosure and related resources. Options allowed: C(script), C(environmentalConfiguration), and C(utilization). For the option C(utilization), you can provide specific parameters.' 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
enclosure_environmental_configuration: description: Has all the OneView information about the environmental configuration of an Enclosure. returned: When requested, but can be null. type: dict enclosure_script: description: Has all the OneView information about the script of an Enclosure. returned: When requested, but can be null. type: str enclosure_utilization: description: Has all the OneView information about the utilization of an Enclosure. returned: When requested, but can be null. type: dict enclosures: description: Has all the OneView information about the Enclosures. returned: Always, but can be null. type: dict