community.general.ocapi_info module – Manages Out-Of-Band controllers using Open Composable API (OCAPI)
Note
This module is part of the community.general collection (version 8.6.4).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install community.general
.
To use it in a playbook, specify: community.general.ocapi_info
.
New in community.general 6.3.0
Synopsis
Builds OCAPI URIs locally and sends them to remote OOB controllers to get information back.
Parameters
Parameter |
Comments |
---|---|
Base URI of OOB controller. |
|
Category to execute on OOB controller. |
|
Command to execute on OOB controller. |
|
Name of job for fetching status. |
|
Password for authenticating to OOB controller. |
|
For proxied inband requests, the slot number of the IOM. Only applies if |
|
Timeout in seconds for URL requests to OOB controller. Default: |
|
Username for authenticating to OOB controller. |
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: full This action does not modify state. |
Can run in |
|
Support: N/A This action does not modify state. |
Will return details on what has changed (or possibly needs changing in |
Examples
- name: Get job status
community.general.ocapi_info:
category: Status
command: JobStatus
baseuri: "http://iom1.wdc.com"
jobName: FirmwareUpdate
username: "{{ username }}"
password: "{{ password }}"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Details of the relevant operation. Applies to Returned: when supported |
|
Message with action result or error description. Returned: always Sample: |
|
Health of the operation. Applies to Returned: when supported Sample: |
|
Integer value for health of the operation (corresponds to Returned: when supported Sample: |
|
Status of the relevant operation. Applies to Returned: when supported Sample: |
|
Integer value of status (corresponds to operationStatus). Applies to Returned: when supported Sample: |
|
Percent complete of the relevant operation. Applies to Returned: when supported Sample: |
|
Dictionary containing status information. See OCAPI documentation for details. Returned: when supported Sample: |