dellemc.openmanage.idrac_network 模块 – 配置 iDRAC 网络属性

注意

此模块是 dellemc.openmanage 集合（版本 9.9.0）的一部分。

如果您使用的是 ansible 包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用： ansible-galaxy collection install dellemc.openmanage。您需要进一步的要求才能使用此模块，请参阅要求了解详细信息。

要在 playbook 中使用它，请指定： dellemc.openmanage.idrac_network。

dellemc.openmanage 2.1.0 中的新增功能

已弃用 

在:中删除: 2024-12-31 之后的重大版本
原因:: 已替换为 dellemc.openmanage.idrac_attributes。
替代方案:: 请改用 dellemc.openmanage.idrac_attributes。

概要 

此模块允许配置 iDRAC 网络设置。

要求 

执行此模块的主机需要满足以下要求。

omsdk >= 1.2.488
python >= 3.9.6

参数 

参数	注释
auto_config 字符串	允许启用或禁用自动配置以自动从 DHCP 获取域名。选项 `“已启用”` `“已禁用”`
auto_detect 字符串	允许自动检测 iDRAC 使用的可用网卡类型。选项 `“已启用”` `“已禁用”`
auto_negotiation 字符串	允许 iDRAC 自动设置双工模式和网络速度。选项 `“已启用”` `“已禁用”`
ca_path 路径在 dellemc.openmanage 5.0.0 中添加	包含用于验证的 CA 证书的隐私增强邮件 (PEM) 文件。
dns_from_dhcp 字符串	允许启用 DHCP 以获取 DNS 服务器地址。选项 `“已启用”` `“已禁用”`
dns_idrac_name 字符串	用于注册 iDRAC 的 DNS 名称。
duplex_mode 字符串	选择网卡的数据传输类型。选项 `“全双工”` `“半双工”`
enable_dhcp 字符串	允许在 iDRAC 中启用或禁用动态主机配置协议 (DHCP)。选项 `“已启用”` `“已禁用”`
enable_ipv4 字符串	允许启用或禁用 IPv4 配置。选项 `“已启用”` `“已禁用”`
enable_nic 字符串	允许启用或禁用 iDRAC 使用的网络接口控制器 (NIC)。选项 `“已启用”` `“已禁用”`
failover_network 字符串	选择剩余的 LOM 之一。如果网络发生故障，流量将通过故障转移网络路由。选项 `“全部”` `“LOM1”` `“LOM2”` `“LOM3”` `“LOM4”` `“无”`
idrac_ip 字符串 / 必需	iDRAC IP 地址。
idrac_password 别名：idrac_pwd 字符串 / 必需	iDRAC 用户密码。如果未提供密码，则使用环境变量 `IDRAC_PASSWORD`。示例：export IDRAC_PASSWORD=password
idrac_port 整数	iDRAC 端口。默认值： `443`
idrac_user 字符串 / 必需	iDRAC 用户名。如果未提供用户名，则使用环境变量 `IDRAC_USERNAME`。示例：export IDRAC_USERNAME=username
ip_address 字符串	输入有效的 iDRAC 静态 IPv4 地址。
network_speed 字符串	选择所选网卡的网络速度。选项 `“10T”` `“100T”` `“1000T”`
nic_mtu 整数	网卡的最大传输单元。
nic_selection 字符串	选择可用的网卡之一。选项 `“专用”` `“LOM1”` `“LOM2”` `“LOM3”` `“LOM4”`
register_idrac_on_dns 字符串	在域名系统 (DNS) 上注册 iDRAC。选项 `“已启用”` `“已禁用”`
setup_idrac_nic_vlan 字符串	允许在 iDRAC 上配置 VLAN。选项 `“已启用”` `“已禁用”`
share_mnt 字符串	（已弃用）具有 ansible 用户读写权限的网络共享的本地挂载路径。此选项对于网络共享是强制性的。此选项已弃用，将在更高版本中删除。
share_name 字符串	（已弃用）网络共享或本地路径。此选项已弃用，将在更高版本中删除。
share_password 别名：share_pwd 字符串	（已弃用）网络共享用户密码。此选项对于 CIFS 共享是强制性的。此选项已弃用，将在更高版本中删除。
share_user 字符串	（已弃用）网络共享用户名。如果用户是域的一部分，请使用 ‘user@domain’ 或 ‘domain\user’ 格式。此选项对于 CIFS 共享是强制性的。此选项已弃用，将在更高版本中删除。
static_dns 字符串	输入静态 DNS 域名。
static_dns_1 字符串	输入首选的静态 DNS 服务器 IPv4 地址。
static_dns_2 字符串	输入首选的静态 DNS 服务器 IPv4 地址。
static_gateway 字符串	输入到 iDRAC 的静态 IPv4 网关地址。
static_net_mask 字符串	输入到 iDRAC 的静态 IP 子网掩码。
timeout 整数在 dellemc.openmanage 5.0.0 中添加	套接字级别的超时时间（以秒为单位）。默认值： `30`
validate_certs 布尔值在 dellemc.openmanage 5.0.0 中添加	如果为 `false`，则不会验证 SSL 证书。仅在个人控制的且使用自签名证书的站点上配置 `false`。在集合版本 `5.0.0` 之前，validate_certs 默认为 `false`。选项 `false` `true` ← (默认)
vlan_id 整数	输入 VLAN ID。VLAN ID 必须是 1 到 4094 之间的数字。
vlan_priority 整数	输入 VLAN ID 的优先级。优先级值必须是 0 到 7 之间的数字。

说明 

注意

此模块需要 idrac_user 拥有 “管理员” 权限。
从可以直接访问 Dell iDRAC 的系统运行此模块。
此模块支持 idrac_ip 的 IPv4 和 IPv6 地址。
此模块支持 check_mode。

示例 

---
- name: Configure iDRAC network settings
  dellemc.openmanage.idrac_network:
       idrac_ip: "192.168.0.1"
       idrac_user: "user_name"
       idrac_password: "user_password"
       ca_path: "/path/to/ca_cert.pem"
       register_idrac_on_dns: Enabled
       dns_idrac_name: None
       auto_config: None
       static_dns: None
       setup_idrac_nic_vlan: Enabled
       vlan_id: 0
       vlan_priority: 1
       enable_nic: Enabled
       nic_selection: Dedicated
       failover_network: T_None
       auto_detect: Disabled
       auto_negotiation: Enabled
       network_speed: T_1000
       duplex_mode: Full
       nic_mtu: 1500
       ip_address: "192.168.0.1"
       enable_dhcp: Enabled
       enable_ipv4: Enabled
       static_dns_1: "192.168.0.1"
       static_dns_2: "192.168.0.1"
       dns_from_dhcp: Enabled
       static_gateway: None
       static_net_mask: None

返回值 

通用返回值记录在此处这里，以下是此模块特有的字段

键	描述
error_info 字典	HTTP 错误的详细信息。返回：在 HTTP 错误时返回示例： `{"error": {"@Message.ExtendedInfo": [{"Message": "由于发生错误，无法处理请求。", "MessageArgs": [], "MessageId": "GEN1234", "RelatedProperties": [], "Resolution": "重试操作。如果问题仍然存在，请联系系统管理员。", "Severity": "严重"}], "code": "Base.1.0.GeneralError", "message": "发生一般错误。有关更多信息，请参见 ExtendedInfo。"}}`
msg 字符串	成功配置 iDRAC 网络设置。返回：始终返回示例： `"成功配置 iDRAC 网络设置。"`
network_status 字典	网络设置操作作业的状态。返回：成功时返回示例： {"@odata.context": "/redfish/v1/$metadata#DellJob.DellJob", "@odata.id": "/redfish/v1/Managers/iDRAC.Embedded.1/Jobs/JID_856418531008", "@odata.type": "#DellJob.v1_0_2.DellJob", "CompletionTime": "2020-03-31T03:04:15", "Description": "作业实例", "EndTime": null, "Id": "JID_856418531008", "JobState": "已完成", "JobType": "导入配置", "Message": "成功导入并应用服务器配置配置文件。", "MessageArgs": [], "[email protected]": 0, "MessageId": "SYS053", "Name": "导入配置", "PercentComplete": 100, "StartTime": "TIME_NOW", "Status": "成功", "TargetSettingsURI": null, "retval": true}