dellemc.openmanage.ome_device_mgmt_network 模块 – 配置 OpenManage Enterprise Modular 上设备的网络设置

注意

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

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

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

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

dellemc.openmanage 4.2.0 中的新增功能

概要 

此模块允许在 OpenManage Enterprise Modular 上配置机箱、服务器和 I/O 模块的网络设置。

参数 

参数	注释
ca_path 路径在 dellemc.openmanage 5.0.0 中添加	包含用于验证的 CA 证书的 Privacy Enhanced Mail (PEM) 文件。
delay 整数	应用设置后的时间（以秒为单位）。此选项仅适用于机箱。默认值： `0`
device_id 整数	设备的 ID。此选项与 device_service_tag 互斥。
device_service_tag 字符串	设备的服务标签。此选项与 device_id 互斥。
dns_configuration 字典	域名系统 (DNS) 设置。
auto_negotiation 布尔值	启用或禁用网络速度的自动协商。 `注意`：将 auto_negotiation 设置为 false 并选择网络端口速度可能会导致机箱失去与机架顶部网络交换机的连接，或者在 MCM 模式下失去与相邻机箱的连接。建议在大多数用例中将 auto_negotiation 设置为 `true`。当 use_dhcp_for_dns_domain_name 为 false 时适用。此选项仅适用于机箱。选项 `false` `true`
dns_domain_name 字符串	静态 DNS 域名当 use_dhcp_for_dns_domain_name 为 false 时适用。
dns_name 字符串	hostname 的 DNS 名称当 register_with_dns 为 true 时适用。
network_speed 字符串	网络端口的速度。当 auto_negotiation 为 false 时适用。 `10_MB` 选择 10 MB 的网络速度。 `100_MB` 选择 100 MB 的网络速度。此选项仅适用于机箱。选项 `"10_MB"` `"100_MB"`
register_with_dns 布尔值	在 DNS 服务器上注册/取消注册 dns_name。 `警告` 如果 VLAN 配置发生更改，则无法更新此选项。选项 `false` `true`
use_dhcp_for_dns_domain_name 布尔值	使用 DHCP 服务器获取 dns_domain_name。选项 `false` `true`
dns_server_settings 字典	DNS 服务器设置。此选项仅适用于 I/O 模块。
alternate_dns_server1 字符串	输入第一个备用 DNS 服务器的 IP 地址。
alternate_dns_server2 字符串	输入第二个备用 DNS 服务器的 IP 地址。
preferred_dns_server 字符串	输入首选 DNS 服务器的 IP 地址。
enable_nic 布尔值	启用或禁用设备的网络接口卡 (NIC) 配置。此选项不适用于 I/O 模块。选项 `false` `true` ←（默认）
hostname 字符串 / 必需	OpenManage Enterprise Modular IP 地址或主机名。
ipv4_configuration 字典	IPv4 网络配置。 `警告` 确保您有备用接口来访问 OpenManage Enterprise Modular，因为这些选项可能会更改 hostname 的当前 IPv4 地址。
enable_dhcp 布尔值	启用或禁用从 IPv4 动态主机配置协议 (DHCP) 服务器自动请求获取 IPv4 地址。 `注意` 如果此选项为 `true`，则为 static_ip_address、static_subnet_mask 和 static_gateway 提供的值将不适用于这些字段。但是，该模块可能会报告更改。选项 `false` `true`
enable_ipv4 布尔值 / 必需	启用或禁用使用 IPv4 访问网络。选项 `false` `true`
static_alternate_dns_server 字符串	静态 IPv4 DNS 备用服务器当 use_dhcp_for_dns_server_names 为 false 时适用。
static_gateway 字符串	静态 IPv4 网关地址当 enable_dhcp 为 false 时适用。
static_ip_address 字符串	静态 IPv4 地址当 enable_dhcp 为 false 时适用。
static_preferred_dns_server 字符串	静态 IPv4 DNS 首选服务器当 use_dhcp_for_dns_server_names 为 false 时适用。
static_subnet_mask 字符串	静态 IPv4 子网掩码地址当 enable_dhcp 为 false 时适用。
use_dhcp_to_obtain_dns_server_address 布尔值	此选项允许从 DHCP 服务器自动请求并获取 DNS 服务器的 IPv4 地址。当 enable_dhcp 为 true 时，此选项适用。 `注意` 如果此选项为 `true`，则为static_preferred_dns_server 和 static_alternate_dns_server 提供的值将不应用于这些字段。但是，该模块可能会报告更改。选项 `false` `true`
ipv6_configuration 字典	IPv6 网络配置。 `警告` 请确保您有备用接口来访问 OpenManage Enterprise Modular，因为这些选项可能会更改 hostname 的当前 IPv6 地址。
enable_auto_configuration 布尔值	启用或禁用从 IPv6 DHCP 服务器或路由器通告 (RA) 自动获取 IPv6 地址的请求如果 enable_auto_configuration 为 `true`，则 OpenManage Enterprise Modular 从现有网络上的 DHCPv6 服务器检索 IP 配置（IPv6 地址、前缀和网关地址）。 `注意` 如果此选项为 `true`，则为 static_ip_address、static_prefix_length 和 static_gateway 提供的值将不应用于这些字段。但是，该模块可能会报告更改。选项 `false` `true`
enable_ipv6 布尔值 / 必需	启用或禁用使用 IPv6 访问网络。选项 `false` `true`
static_alternate_dns_server 字符串	静态 IPv6 备用 DNS 服务器当 use_dhcp_for_dns_server_names 为 false 时适用。
static_gateway 字符串	静态 IPv6 网关地址当 enable_auto_configuration 为 false 时，此选项适用。
static_ip_address 字符串	静态 IPv6 地址当 enable_auto_configuration 为 false 时，此选项适用。
static_preferred_dns_server 字符串	静态 IPv6 首选 DNS 服务器当 use_dhcp_for_dns_server_names 为 false 时适用。
static_prefix_length 整数	静态 IPv6 前缀长度当 enable_auto_configuration 为 false 时，此选项适用。
use_dhcpv6_to_obtain_dns_server_address 布尔值	此选项允许自动从 DHCP 服务器请求和获取 DNS 服务器的 IPv6 地址。当 enable_auto_configuration 为 true 时，此选项适用 `注意` 如果此选项为 `true`，则为static_preferred_dns_server 和 static_alternate_dns_server 提供的值将不应用于这些字段。但是，该模块可能会报告更改。选项 `false` `true`
management_vlan 字典	VLAN 配置。
enable_vlan 布尔值 / 必需	启用或禁用管理的 VLAN。如果 dns_configuration 下的 register_with_dns 字段为 true，则无法更新 VLAN 配置。 `警告` 更改 VLAN 配置后，请确保将网线连接到正确的端口。否则，VLAN 配置更改可能不会应用。选项 `false` `true`
vlan_id 整数	VLAN ID。有效的 VLAN ID 为：1 到 4000 和 4021 到 4094。当 enable_vlan 为 true 时，此选项适用。
password 字符串	OpenManage Enterprise Modular 密码。如果未提供密码，则使用环境变量 `OME_PASSWORD`。示例：export OME_PASSWORD=password
port 整数	OpenManage Enterprise Modular HTTPS 端口。默认值: `443`
timeout 整数在 dellemc.openmanage 5.0.0 中添加	套接字级别的超时时间（以秒为单位）。默认值: `30`
username 字符串	OpenManage Enterprise Modular 用户名。如果未提供用户名，则使用环境变量 `OME_USERNAME`。示例：export OME_USERNAME=username
validate_certs 布尔值在 dellemc.openmanage 5.0.0 中添加	如果为 `false`，则不会验证 SSL 证书。仅在个人控制的站点（使用自签名证书）上配置 `false`。在集合版本 `5.0.0` 之前，validate_certs 默认为 `false`。选项 `false` `true` ←（默认）
x_auth_token 字符串在 dellemc.openmanage 9.3.0 中添加	身份验证令牌。如果未提供 x_auth_token，则使用环境变量 `OME_X_AUTH_TOKEN`。示例：export OME_X_AUTH_TOKEN=x_auth_token

说明 

注意

从可以直接访问 Dell OpenManage Enterprise Modular 的系统运行此模块。
此模块支持 check_mode。

示例 

---
- name: Network settings for chassis
  dellemc.openmanage.ome_device_mgmt_network:
    hostname: 192.168.0.1
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    device_service_tag: CHAS123
    ipv4_configuration:
      enable_ipv4: true
      enable_dhcp: false
      static_ip_address: 192.168.0.2
      static_subnet_mask: 255.255.254.0
      static_gateway: 192.168.0.3
      use_dhcp_to_obtain_dns_server_address: false
      static_preferred_dns_server: 192.168.0.4
      static_alternate_dns_server: 192.168.0.5
    ipv6_configuration:
      enable_ipv6: true
      enable_auto_configuration: false
      static_ip_address: 2626:f2f2:f081:9:1c1c:f1f1:4747:1
      static_prefix_length: 10
      static_gateway: ffff::2607:f2b1:f081:9
      use_dhcpv6_to_obtain_dns_server_address: false
      static_preferred_dns_server: 2626:f2f2:f081:9:1c1c:f1f1:4747:3
      static_alternate_dns_server: 2626:f2f2:f081:9:1c1c:f1f1:4747:4
    dns_configuration:
      register_with_dns: true
      use_dhcp_for_dns_domain_name: false
      dns_name: "MX-SVCTAG"
      dns_domain_name: "dnslocaldomain"
      auto_negotiation: false
      network_speed: 100_MB

- name: Network settings for server
  dellemc.openmanage.ome_device_mgmt_network:
    hostname: 192.168.0.1
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    device_service_tag: SRVR123
    ipv4_configuration:
      enable_ipv4: true
      enable_dhcp: false
      static_ip_address: 192.168.0.2
      static_subnet_mask: 255.255.254.0
      static_gateway: 192.168.0.3
      use_dhcp_to_obtain_dns_server_address: false
      static_preferred_dns_server: 192.168.0.4
      static_alternate_dns_server: 192.168.0.5
    ipv6_configuration:
      enable_ipv6: true
      enable_auto_configuration: false
      static_ip_address: 2626:f2f2:f081:9:1c1c:f1f1:4747:1
      static_prefix_length: 10
      static_gateway: ffff::2607:f2b1:f081:9
      use_dhcpv6_to_obtain_dns_server_address: false
      static_preferred_dns_server: 2626:f2f2:f081:9:1c1c:f1f1:4747:3
      static_alternate_dns_server: 2626:f2f2:f081:9:1c1c:f1f1:4747:4

- name: Network settings for I/O module
  dellemc.openmanage.ome_device_mgmt_network:
    hostname: 192.168.0.1
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    device_service_tag: IOM1234
    ipv4_configuration:
      enable_ipv4: true
      enable_dhcp: false
      static_ip_address: 192.168.0.2
      static_subnet_mask: 255.255.254.0
      static_gateway: 192.168.0.3
    ipv6_configuration:
      enable_ipv6: true
      enable_auto_configuration: false
      static_ip_address: 2626:f2f2:f081:9:1c1c:f1f1:4747:1
      static_prefix_length: 10
      static_gateway: ffff::2607:f2b1:f081:9
    dns_server_settings:
      preferred_dns_server: 192.168.0.4
      alternate_dns_server1: 192.168.0.5

- name: Management VLAN configuration of chassis using device id
  dellemc.openmanage.ome_device_mgmt_network:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    device_id: 12345
    management_vlan:
      enable_vlan: true
      vlan_id: 2345
    dns_configuration:
      register_with_dns: false

返回值 

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

键

描述

error_info

字典

HTTP 错误的详细信息。

返回: 当发生 HTTP 错误时

示例: {"error": {"@Message.ExtendedInfo": [{"Message": "无法完成请求，因为不支持 IPv4 设置功能，或者该功能不存在，或者不适用于资源 URI。", "MessageArgs": ["不支持 IPv4 设置功能"], "MessageId": "CGEN1004", "RelatedProperties": [], "Resolution": "检查请求资源 URI。有关资源 URI 及其属性的更多信息，请参阅 OpenManage Enterprise-Modular 用户指南。", "Severity": "严重"}], "code": "Base.1.0.GeneralError", "message": "发生了一般错误。有关更多信息，请参阅 ExtendedInfo。"}}

msg

字符串

网络配置操作的总体状态。

返回: 总是

示例: "已成功应用网络设置。"

作者

Jagadeesh N V(@jagadeeshnv)

dellemc.openmanage.ome_device_mgmt_network 模块 – 配置 OpenManage Enterprise Modular 上设备的网络设置

概要 

要求 

参数 

说明 

示例 

返回值 

作者

集合链接

dellemc.openmanage.ome_device_mgmt_network 模块 – 配置 OpenManage Enterprise Modular 上设备的网络设置

概要

要求

参数

说明

示例

返回值

作者

集合链接

概要 

要求 

参数 

说明 

示例 

返回值 