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 字符串	选择所选网卡的网络速度。选项 `"10M"` `"100M"` `"1000M"`
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": "Unable to process the request because an error occurred.", "MessageArgs": [], "MessageId": "GEN1234", "RelatedProperties": [], "Resolution": "Retry the operation. If the issue persists, contact your system administrator.", "Severity": "Critical"}], "code": "Base.1.0.GeneralError", "message": "A general error has occurred. See ExtendedInfo for more information."}}`
msg 字符串	已成功配置idrac网络设置。返回：始终示例： `"Successfully configured the idrac network settings."`
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": "Job Instance", "EndTime": null, "Id": "JID_856418531008", "JobState": "Completed", "JobType": "ImportConfiguration", "Message": "Successfully imported and applied Server Configuration Profile.", "MessageArgs": [], "[email protected]": 0, "MessageId": "SYS053", "Name": "Import Configuration", "PercentComplete": 100, "StartTime": "TIME_NOW", "Status": "Success", "TargetSettingsURI": null, "retval": true}