dellemc.openmanage.ome_discovery module – Create, modify, or delete a discovery job on OpenManage Enterprise
Note
This module is part of the dellemc.openmanage collection (version 9.8.0).
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 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_discovery.
New in dellemc.openmanage 3.3.0
Synopsis
This module allows to create, modify, or delete a discovery job.
Requirements
The below requirements are needed on the host that executes this module.
python >= 3.9.6
Parameters
Parameter |
Comments |
|---|---|
The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for the validation. |
|
Enable the use of SNMP community strings to receive SNMP traps using Application Settings in OpenManage Enterprise. This option is available only for the discovered iDRAC servers and MX7000 chassis. Choices:
|
|
Provide a cron expression based on Quartz cron format. |
|
Provide the list of discovery targets. Each discovery target is a set of network_address_detail, device_types, and one or more protocol credentials. This is mandatory when state is
|
|
Provide the type of devices to be discovered. The accepted types are SERVER, CHASSIS, NETWORK SWITCH, and STORAGE. A combination or all of the above can be provided. Supported protocols for each device type are: SERVER - wsman, redfish, snmp, ipmi, ssh, and vmware. CHASSIS - wsman, and redfish. NETWORK SWITCH - snmp. STORAGE - storage, and snmp. |
|
Intelligent Platform Management Interface (IPMI) |
|
KgKey for the IPMI protocol. |
|
Provide a password for the protocol. |
|
Enter the number of repeated attempts required to discover a device. Default: |
|
Enter the time in seconds after which a job must stop running. Default: |
|
Provide a username for the protocol. |
|
Provide the list of IP addresses, host names, or the range of IP addresses of the devices to be discovered or included. Sample Valid IP Range Formats 192.35.0.0 192.36.0.0-10.36.0.255 192.37.0.0/24 2345:f2b1:f083:135::5500/118 2345:f2b1:f083:135::a500-2607:f2b1:f083:135::a600 hostname.domain.tld hostname 2345:f2b1:f083:139::22a Sample Invalid IP Range Formats 192.35.0.* 192.36.0.0-255 192.35.0.0/255.255.255.0
|
|
REDFISH protocol. |
|
Enable the Certificate Authority (CA) check. Choices:
|
|
Provide certificate data for the CA check. |
|
Enable the Common Name (CN) check. Choices:
|
|
Provide a domain for the protocol. |
|
Provide a password for the protocol. |
|
Enter the port number that the job must use to discover the devices. Default: |
|
Enter the number of repeated attempts required to discover a device. Default: |
|
Enter the time in seconds after which a job must stop running. Default: |
|
Provide a username for the protocol. |
|
Simple Network Management Protocol (SNMP). |
|
Community string for the SNMP protocol. |
|
Enter the port number that the job must use to discover the devices. Default: |
|
Enter the number of repeated attempts required to discover a device. Default: |
|
Enter the time in seconds after which a job must stop running. Default: |
|
Secure Shell (SSH). |
|
Verify the known host key. Choices:
|
|
Use the SUDO option. Choices:
|
|
Provide a password for the protocol. |
|
Enter the port number that the job must use to discover the devices. Default: |
|
Enter the number of repeated attempts required to discover a device. Default: |
|
Enter the time in seconds after which a job must stop running. Default: |
|
Provide a username for the protocol. |
|
HTTPS Storage protocol. |
|
Enable the Certificate Authority (CA) check. Choices:
|
|
Provide certificate data for the CA check. |
|
Enable the Common Name (CN) check. Choices:
|
|
Provide a domain for the protocol. |
|
Provide a password for the protocol. |
|
Enter the port number that the job must use to discover the devices. Default: |
|
Enter the number of repeated attempts required to discover a device. Default: |
|
Enter the time in seconds after which a job must stop running. Default: |
|
Provide a username for the protocol. |
|
VMWARE protocol. |
|
Enable the Certificate Authority (CA) check. Choices:
|
|
Provide certificate data for the CA check. |
|
Enable the Common Name (CN) check. Choices:
|
|
Provide a domain for the protocol. |
|
Provide a password for the protocol. |
|
Enter the port number that the job must use to discover the devices. Default: |
|
Enter the number of repeated attempts required to discover a device. Default: |
|
Enter the time in seconds after which a job must stop running. Default: |
|
Provide a username for the protocol. |
|
Web Services-Management (WS-Man). |
|
Enable the Certificate Authority (CA) check. Choices:
|
|
Provide certificate data for the CA check. |
|
Enable the Common Name (CN) check. Choices:
|
|
Provide a domain for the protocol. |
|
Provide a password for the protocol. |
|
Enter the port number that the job must use to discover the devices. Default: |
|
Enter the number of repeated attempts required to discover a device. Default: |
|
Enter the time in seconds after which a job must stop running. Default: |
|
Provide a username for the protocol. |
|
ID of the discovery configuration group. This value is DiscoveryConfigGroupId in the return values under discovery_status. It is mutually exclusive with discovery_job_name. |
|
Name of the discovery configuration job. It is mutually exclusive with discovery_id. |
|
Enter the email address to which notifications are to be sent about the discovery job status. Configure the SMTP settings to allow sending notifications to an email address. |
|
OpenManage Enterprise IP address or hostname. |
|
Provides the option to ignore partial failures. Partial failures occur when there is a combination of both discovered and undiscovered IPs. If If This option is only applicable if job_wait is Choices:
|
|
Provides the option to wait for job completion. This option is applicable when state 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: |
|
New name of the discovery configuration job. |
|
OpenManage Enterprise password. If the password is not provided, then the environment variable Example: export OME_PASSWORD=password |
|
OpenManage Enterprise HTTPS port. Default: |
|
Provides the option to schedule the discovery job. If Choices:
|
|
discovery_job_name is mandatory for the creation of a new discovery job. If multiple discoveries of the same discovery_job_name exist, then the new discovery job will not be created.
Choices:
|
|
The socket level timeout in seconds. Default: |
|
Enable OpenManage Enterprise to receive the incoming SNMP traps from the discovered devices. This is effective only for servers discovered by using their iDRAC interface. Choices:
|
|
OpenManage Enterprise username. If the username is not provided, then the environment variable Example: export OME_USERNAME=username |
|
If Configure Prior to collection version Choices:
|
|
Authentication token. If the x_auth_token is not provided, then the environment variable Example: export OME_X_AUTH_TOKEN=x_auth_token |
Notes
Note
Run this module from a system that has direct access to Dell OpenManage Enterprise.
This module does not support
check_mode.If state is
present, then Idempotency is not supported.
Examples
---
- name: Discover servers in a range
dellemc.openmanage.ome_discovery:
hostname: "192.168.0.1"
username: "username"
password: "password"
ca_path: "/path/to/ca_cert.pem"
discovery_job_name: "Discovery_server_1"
discovery_config_targets:
- network_address_detail:
- 192.96.24.1-192.96.24.255
device_types:
- SERVER
wsman:
username: user
password: password
- name: Discover chassis in a range
dellemc.openmanage.ome_discovery:
hostname: "192.168.0.1"
username: "username"
password: "password"
ca_path: "/path/to/ca_cert.pem"
discovery_job_name: "Discovery_chassis_1"
discovery_config_targets:
- network_address_detail:
- 192.96.24.1-192.96.24.255
device_types:
- CHASSIS
wsman:
username: user
password: password
- name: Discover switches in a range
dellemc.openmanage.ome_discovery:
hostname: "192.168.0.1"
username: "username"
password: "password"
ca_path: "/path/to/ca_cert.pem"
discovery_job_name: "Discover_switch_1"
discovery_config_targets:
- network_address_detail:
- 192.96.24.1-192.96.24.255
device_types:
- NETWORK SWITCH
snmp:
community: snmp_creds
- name: Discover storage in a range
dellemc.openmanage.ome_discovery:
hostname: "192.168.0.1"
username: "username"
password: "password"
ca_path: "/path/to/ca_cert.pem"
discovery_job_name: "Discover_storage_1"
discovery_config_targets:
- network_address_detail:
- 192.96.24.1-192.96.24.255
device_types:
- STORAGE
storage:
username: user
password: password
snmp:
community: snmp_creds
- name: Delete a discovery job
dellemc.openmanage.ome_discovery:
hostname: "192.168.0.1"
username: "username"
password: "password"
ca_path: "/path/to/ca_cert.pem"
state: "absent"
discovery_job_name: "Discovery-123"
- name: Schedule the discovery of multiple devices ignoring partial failure and enable trap to receive alerts
dellemc.openmanage.ome_discovery:
hostname: "192.168.0.1"
username: "username"
password: "password"
ca_path: "/path/to/ca_cert.pem"
state: "present"
discovery_job_name: "Discovery-123"
discovery_config_targets:
- network_address_detail:
- 192.96.24.1-192.96.24.255
- 192.96.0.0/24
- 192.96.26.108
device_types:
- SERVER
- CHASSIS
- STORAGE
- NETWORK SWITCH
wsman:
username: wsman_user
password: wsman_pwd
redfish:
username: redfish_user
password: redfish_pwd
snmp:
community: snmp_community
- network_address_detail:
- 192.96.25.1-192.96.25.255
- ipmihost
- esxiserver
- sshserver
device_types:
- SERVER
ssh:
username: ssh_user
password: ssh_pwd
vmware:
username: vm_user
password: vmware_pwd
ipmi:
username: ipmi_user
password: ipmi_pwd
schedule: RunLater
cron: "0 0 9 ? * MON,WED,FRI *"
ignore_partial_failure: true
trap_destination: true
community_string: true
email_recipient: [email protected]
- name: Discover servers with ca check enabled
dellemc.openmanage.ome_discovery:
hostname: "192.168.0.1"
username: "username"
password: "password"
ca_path: "/path/to/ca_cert.pem"
discovery_job_name: "Discovery_server_ca1"
discovery_config_targets:
- network_address_detail:
- 192.96.24.108
device_types:
- SERVER
wsman:
username: user
password: password
ca_check: true
certificate_data: "{{ lookup('ansible.builtin.file', '/path/to/certificate_data_file') }}"
- name: Discover chassis with ca check enabled data
dellemc.openmanage.ome_discovery:
hostname: "192.168.0.1"
username: "username"
password: "password"
ca_path: "/path/to/ca_cert.pem"
discovery_job_name: "Discovery_chassis_ca1"
discovery_config_targets:
- network_address_detail:
- 192.96.24.108
device_types:
- CHASSIS
redfish:
username: user
password: password
ca_check: true
certificate_data: "-----BEGIN CERTIFICATE-----\r\n
ABCDEFGHIJKLMNOPQRSTUVWXYZaqwertyuiopasdfghjklzxcvbnmasdasagasvv\r\n
ABCDEFGHIJKLMNOPQRSTUVWXYZaqwertyuiopasdfghjklzxcvbnmasdasagasvv\r\n
ABCDEFGHIJKLMNOPQRSTUVWXYZaqwertyuiopasdfghjklzxcvbnmasdasagasvv\r\n
aqwertyuiopasdfghjklzxcvbnmasdasagasvv=\r\n
-----END CERTIFICATE-----"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
IDs of the discoveries with duplicate names. Returned: when discoveries with duplicate name exist for state is Sample: |
|
Details of the discovery job created or modified. If job_wait is true, Completed and Failed IPs are also listed. Returned: when state is Sample: |
|
Details of the HTTP Error. Returned: on HTTP error Sample: |
|
Detailed last execution history of a job. Returned: All time. Sample: |
|
Overall status of the discovery operation. Returned: always Sample: |