Try SpotterPerform device-specific operations on target devices
| "added in version" 6.1.0 of dellemc.openmanage"
Authors: Jagadeesh N V(@jagadeeshnv), ShivamSh3(@ShivamSh3)
Install with ansible-galaxy collection install dellemc.openmanage:==9.1.0
collections:
- name: dellemc.openmanage
version: 9.1.0Perform device-specific operations such as refresh inventory, clear iDRAC job queue, and reset iDRAC from OpenManage Enterprise.
---
- 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
port:
default: 443
description: OpenManage Enterprise HTTPS port.
type: int
state:
choices:
- present
- absent
default: present
description:
- C(present) Allows to perform the I(device_action) on the target devices.
- C(absent) Removes the device from OpenManage Enterprise. Job is not triggered. I(job_wait),
I(job_schedule), I(job_name), and I(job_description) are not applicable to this
operation.
type: str
ca_path:
description:
- The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for
the validation.
type: path
version_added: 5.0.0
version_added_collection: dellemc.openmanage
timeout:
default: 30
description: The socket level timeout in seconds.
type: int
version_added: 5.0.0
version_added_collection: dellemc.openmanage
hostname:
description: OpenManage Enterprise IP address or hostname.
required: true
type: str
job_name:
description: Optional name for the job.
type: str
job_wait:
default: true
description:
- Provides an option to wait for the job completion.
- This option is applicable when I(state) is C(present).
- This is applicable when I(job_schedule) is C(startnow).
type: bool
password:
description:
- OpenManage Enterprise password.
- If the password is not provided, then the environment variable C(OME_PASSWORD) is
used.
- 'Example: export OME_PASSWORD=password'
required: true
type: str
username:
description:
- OpenManage Enterprise username.
- If the username is not provided, then the environment variable C(OME_USERNAME) is
used.
- 'Example: export OME_USERNAME=username'
required: true
type: str
device_ids:
description:
- IDs of the target devices.
- This is mutually exclusive with I(device_service_tags).
elements: int
type: list
job_schedule:
default: startnow
description: Provide the cron string to schedule the job.
type: str
device_action:
choices:
- refresh_inventory
- reset_idrac
- clear_idrac_job_queue
default: refresh_inventory
description:
- C(refresh_inventory) refreshes the inventory on the target devices.
- C(reset_idrac) Triggers a reset on the target iDRACs.
- C(clear_idrac_job_queue) Clears the job queue on the target iDRACs.
- A job is triggered for each action.
type: str
validate_certs:
default: true
description:
- If C(false), the SSL certificates will not be validated.
- Configure C(false) only on personally controlled sites where self-signed certificates
are used.
- Prior to collection version C(5.0.0), the I(validate_certs) is C(false) by default.
type: bool
version_added: 5.0.0
version_added_collection: dellemc.openmanage
job_description:
description: Optional description for the job.
type: str
job_wait_timeout:
default: 1200
description:
- The maximum wait time of I(job_wait) in seconds. The job is tracked only for this
duration.
- This option is applicable when I(job_wait) is C(true).
type: int
device_service_tags:
description:
- Service tag of the target devices.
- This is mutually exclusive with I(device_ids).
elements: str
type: list
error_info:
description: Details of the HTTP Error.
returned: on HTTP error
sample:
error:
'@Message.ExtendedInfo':
- Message: Unable to complete the operation because the requested URI is invalid.
MessageArgs: []
MessageId: CGEN1002
RelatedProperties: []
Resolution: Enter a valid URI and retry the operation.
Severity: Critical
code: Base.1.0.GeneralError
message: A general error has occurred. See ExtendedInfo for more information.
type: dict
job:
description: Job details of the devices operation.
returned: success
sample:
Builtin: false
CreatedBy: admin
Editable: true
ExecutionHistories@odata.navigationLink: /api/JobService/Jobs(14874)/ExecutionHistories
Id: 14874
JobDescription: The Refresh inventory task initiated from OpenManage Ansible Modules
for devices with the ids '13216'.
JobName: Refresh inventory
JobStatus:
'@odata.type': '#JobService.JobStatus'
Id: 2020
Name: Scheduled
JobType:
'@odata.type': '#JobService.JobType'
Id: 8
Internal: false
Name: Inventory_Task
LastExecutionDetail:
'@odata.id': /api/JobService/Jobs(14874)/LastExecutionDetail
LastRunStatus:
'@odata.type': '#JobService.JobStatus'
Id: 2060
Name: Completed
Params:
- JobId: 14874
Key: action
Value: CONFIG_INVENTORY
- JobId: 14874
Key: isCollectDriverInventory
Value: 'true'
Schedule: startnow
State: Enabled
Targets:
- Data: ''
Id: 13216
JobId: 14874
TargetType:
Id: 1000
Name: DEVICE
UpdatedBy: null
UserGenerated: true
Visible: true
type: dict
msg:
description: Overall status of the devices operation.
returned: always
sample: Successfully removed the device(s).
type: str