dellemc.openmanage.ome_discovery 模块 – 在 OpenManage Enterprise 上创建、修改或删除发现作业
注意
此模块是 dellemc.openmanage 集合（版本 9.9.0）的一部分。
如果您正在使用 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用： ansible-galaxy collection install dellemc.openmanage。您需要其他要求才能使用此模块，有关详细信息，请参阅要求。
要在 playbook 中使用它，请指定：dellemc.openmanage.ome_discovery。
dellemc.openmanage 3.3.0 中的新增功能
概要
此模块允许创建、修改或删除发现作业。
要求
执行此模块的主机上需要以下要求。
python >= 3.9.6
参数
参数 |
注释 |
|---|---|
包含用于验证的 CA 证书的隐私增强邮件 (PEM) 文件。 |
|
启用使用 SNMP 社区字符串来接收使用 OpenManage Enterprise 中的应用程序设置的 SNMP 陷阱。此选项仅适用于发现的 iDRAC 服务器和 MX7000 机箱。 选项
|
|
提供基于 Quartz cron 格式的 cron 表达式。 |
|
提供发现目标列表。 每个发现目标都是一组 network_address_detail、device_types 和一个或多个协议凭据。 当 state 为
|
|
提供要发现的设备类型。 接受的类型为 SERVER、CHASSIS、NETWORK SWITCH 和 STORAGE。 可以提供上述类型的组合或所有类型。 每种设备类型支持的协议为 SERVER - wsman、redfish、snmp、ipmi、ssh 和 vmware。 CHASSIS - wsman 和 redfish。 NETWORK SWITCH - snmp。 STORAGE - storage 和 snmp。 |
|
智能平台管理接口 (IPMI) |
|
IPMI 协议的 KgKey。 |
|
为协议提供密码。 |
|
输入发现设备所需的重复尝试次数。 默认值： |
|
输入作业必须停止运行的时间（以秒为单位）。 默认值： |
|
为协议提供用户名。 |
|
提供要发现或包含的设备的 IP 地址、主机名或 IP 地址范围的列表。 有效的 IP 范围格式示例 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 主机名 2345:f2b1:f083:139::22a 无效的 IP 范围格式示例 192.35.0.* 192.36.0.0-255 192.35.0.0/255.255.255.0
|
|
REDFISH 协议。 |
|
启用证书颁发机构 (CA) 检查。 选项
|
|
为 CA 检查提供证书数据。 |
|
启用公用名 (CN) 检查。 选项
|
|
为协议提供域。 |
|
为协议提供密码。 |
|
输入作业必须用于发现设备的端口号。 默认值： |
|
输入发现设备所需的重复尝试次数。 默认值： |
|
输入作业必须停止运行的时间（以秒为单位）。 默认值： |
|
为协议提供用户名。 |
|
简单网络管理协议 (SNMP)。 |
|
SNMP 协议的社区字符串。 |
|
输入作业必须用于发现设备的端口号。 默认值： |
|
输入发现设备所需的重复尝试次数。 默认值： |
|
输入作业必须停止运行的时间（以秒为单位）。 默认值： |
|
安全外壳 (SSH)。 |
|
验证已知主机密钥。 选项
|
|
使用 SUDO 选项。 选项
|
|
为协议提供密码。 |
|
输入作业必须用于发现设备的端口号。 默认值： |
|
输入发现设备所需的重复尝试次数。 默认值： |
|
输入作业必须停止运行的时间（以秒为单位）。 默认值： |
|
为协议提供用户名。 |
|
HTTPS 存储协议。 |
|
启用证书颁发机构 (CA) 检查。 选项
|
|
为 CA 检查提供证书数据。 |
|
启用公用名 (CN) 检查。 选项
|
|
为协议提供域。 |
|
为协议提供密码。 |
|
输入作业必须用于发现设备的端口号。 默认值： |
|
输入发现设备所需的重复尝试次数。 默认值： |
|
输入作业必须停止运行的时间（以秒为单位）。 默认值： |
|
为协议提供用户名。 |
|
VMWARE 协议。 |
|
启用证书颁发机构 (CA) 检查。 选项
|
|
为 CA 检查提供证书数据。 |
|
启用公用名 (CN) 检查。 选项
|
|
为协议提供域。 |
|
为协议提供密码。 |
|
输入作业必须用于发现设备的端口号。 默认值： |
|
输入发现设备所需的重复尝试次数。 默认值： |
|
输入作业必须停止运行的时间（以秒为单位）。 默认值： |
|
为协议提供用户名。 |
|
Web 服务管理 (WS-Man)。 |
|
启用证书颁发机构 (CA) 检查。 选项
|
|
为 CA 检查提供证书数据。 |
|
启用公用名 (CN) 检查。 选项
|
|
为协议提供域。 |
|
为协议提供密码。 |
|
输入作业必须用于发现设备的端口号。 默认值： |
|
输入发现设备所需的重复尝试次数。 默认值： |
|
输入作业必须停止运行的时间（以秒为单位）。 默认值： |
|
为协议提供用户名。 |
|
发现配置组的 ID。 此值是 discovery_status 下返回值的 DiscoveryConfigGroupId。 它与 discovery_job_name 互斥。 |
|
发现配置作业的名称。 它与 discovery_id 互斥。 |
|
输入要向其发送关于发现作业状态通知的电子邮件地址。配置 SMTP 设置以允许向电子邮件地址发送通知。 |
|
OpenManage Enterprise IP 地址或主机名。 |
|
提供忽略部分失败的选项。当同时存在已发现和未发现的 IP 时，会发生部分失败。 如果为 如果为 仅当 job_wait 为 选项
|
|
提供等待作业完成的选项。 当 state 为 选项
|
|
job_wait 的最大等待时间（以秒为单位）。仅在此持续时间内跟踪作业。 当 job_wait 为 默认值： |
|
发现配置作业的新名称。 |
|
OpenManage Enterprise HTTPS 端口。 默认值： |
|
提供计划发现作业的选项。 如果选择 选项
|
|
创建新发现作业时，discovery_job_name 是强制性的。 如果存在多个具有相同 discovery_job_name 的发现，则不会创建新的发现作业。
选项
|
|
套接字级别的超时时间（以秒为单位）。 默认值： |
|
使 OpenManage Enterprise 能够接收来自已发现设备的传入 SNMP 陷阱。 这仅对使用 iDRAC 接口发现的服务器有效。 选项
|
|
如果为 仅在个人控制的站点上使用自签名证书时配置 在集合版本 选项
|
|
身份验证令牌。 如果未提供 x_auth_token，则使用环境变量 示例：export OME_X_AUTH_TOKEN=x_auth_token |
注释
注意
从可以直接访问 Dell OpenManage Enterprise 的系统运行此模块。
此模块不支持
check_mode。如果 state 为
present，则不支持幂等性。
示例
---
- 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-----"
返回值
常见返回值在此处记录 此处，以下是此模块特有的字段
键 |
描述 |
|---|---|
具有重复名称的发现的 ID。 返回：当 state 为 示例： |
|
创建或修改的发现作业的详细信息。 如果 job_wait 为 true，还会列出已完成和失败的 IP。 返回：当 state 为 示例： |
|
HTTP 错误的详细信息。 返回：在 HTTP 错误时 示例： |
|
作业的详细上次执行历史记录。 返回：始终。 示例： |
|
发现操作的总体状态。 返回：始终 示例： |