dellemc.openmanage.ome_devices module – Perform device-specific operations on target devices
Note
This module is part of the dellemc.openmanage collection (version 8.5.0).
To install it, use: ansible-galaxy collection install dellemc.openmanage
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: dellemc.openmanage.ome_devices
.
New in dellemc.openmanage 6.1.0
Synopsis
Perform device-specific operations such as refresh inventory, clear iDRAC job queue, and reset iDRAC from OpenManage Enterprise.
Requirements
The below requirements are needed on the host that executes this module.
python >= 3.8.6
Parameters
Parameter |
Comments |
---|---|
The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for the validation. |
|
A job is triggered for each action. Choices:
|
|
IDs of the target devices. This is mutually exclusive with device_service_tags. |
|
Service tag of the target devices. This is mutually exclusive with device_ids. |
|
OpenManage Enterprise IP address or hostname. |
|
Optional description for the job. |
|
Optional name for the job. |
|
Provide the cron string to schedule the job. Default: |
|
Provides an option to wait for the job completion. This option is applicable when state is This is applicable when job_schedule is Choices:
|
|
The maximum wait time of job_wait in seconds. The job is tracked only for this duration. This option is applicable when job_wait is Default: |
|
OpenManage Enterprise password. |
|
OpenManage Enterprise HTTPS port. Default: |
|
Choices:
|
|
The socket level timeout in seconds. Default: |
|
OpenManage Enterprise username. |
|
If Configure Prior to collection version Choices:
|
Notes
Note
For
idrac_reset
, the job triggers only the iDRAC reset operation and does not track the complete reset cycle.Run this module from a system that has direct access to Dell OpenManage Enterprise.
This module supports
check_mode
.
Examples
---
- name: Refresh Inventory
dellemc.openmanage.ome_devices:
hostname: "192.168.0.1"
username: "username"
password: "password"
ca_path: "/path/to/ca_cert.pem"
device_action: refresh_inventory
device_service_tags:
- SVCTAG1
- name: Clear iDRAC job queue
dellemc.openmanage.ome_devices:
hostname: "192.168.0.1"
username: "username"
password: "password"
ca_path: "/path/to/ca_cert.pem"
device_action: clear_idrac_job_queue
device_service_tags:
- SVCTAG1
- name: Reset iDRAC using the service tag
dellemc.openmanage.ome_devices:
hostname: "192.168.0.1"
username: "username"
password: "password"
ca_path: "/path/to/ca_cert.pem"
device_action: reset_idrac
device_service_tags:
- SVCTAG1
- name: Remove devices using servicetags
dellemc.openmanage.ome_devices:
hostname: "192.168.0.1"
username: "username"
password: "password"
ca_path: "/path/to/ca_cert.pem"
state: absent
device_service_tags:
- SVCTAG1
- SVCTAF2
- name: Remove devices using IDs
dellemc.openmanage.ome_devices:
hostname: "192.168.0.1"
username: "username"
password: "password"
ca_path: "/path/to/ca_cert.pem"
state: absent
device_ids:
- 10235
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Details of the HTTP Error. Returned: on HTTP error Sample: |
|
Job details of the devices operation. Returned: success Sample: |
|
Overall status of the devices operation. Returned: always Sample: |