dellemc.openmanage.ome_application_network_address 模块 – 更新 OpenManage Enterprise 上的网络配置

注意

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

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

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

要在 playbook 中使用它,请指定:dellemc.openmanage.ome_application_network_address

dellemc.openmanage 2.1.0 中的新增功能

概要

  • 此模块允许在 OpenManage Enterprise 上配置 DNS 和 IPV4 或 IPV6 网络。

要求

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

  • python >= 3.9.6

参数

参数

注释

ca_path

路径

在 dellemc.openmanage 5.0.0 中添加

包含要用于验证的 CA 证书的 Privacy Enhanced Mail (PEM) 文件。

dns_configuration

字典

域名系统 (DNS) 设置。

dns_domain_name

字符串

静态 DNS 域名

use_dhcp_for_dns_domain_name 为 false 时适用。

dns_name

字符串

hostname 的 DNS 名称

register_with_dns 为 true 时适用。

register_with_dns

布尔值

在 DNS 服务器上注册/取消注册 dns_name

如果 vLAN 配置发生更改,则无法更新此选项。

选项

  • false

  • true

use_dhcp_for_dns_domain_name

布尔值

使用 DHCP 服务器获取 dns_domain_name

选项

  • false

  • true

enable_nic

布尔值

启用或禁用网络接口卡 (NIC) 配置。

选项

  • false

  • true ←(默认)

hostname

字符串 / 必需

OpenManage Enterprise 或 OpenManage Enterprise Modular IP 地址或主机名。

interface_name

字符串

如果存在多个接口,则可以使用 NIC 的接口名称将网络配置更改应用于单个接口。

如果未指定此选项,则默认选择主接口。

ipv4_configuration

字典

IPv4 网络配置。

警告 确保您有备用接口来访问 OpenManage Enterprise,因为这些选项可能会更改 hostname 的当前 IPv4 地址。

enable

布尔值 / 必需

使用 IPv4 启用或禁用对网络的访问。

选项

  • false

  • true

enable_dhcp

布尔值

启用或禁用从 IPv4 动态主机配置协议 (DHCP) 服务器自动请求获取 IPv4 地址

如果 enable_dhcp 选项为 true,则 OpenManage Enterprise 从现有网络上的 DHCP 服务器检索 IP 配置 — 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_for_dns_server_names

布尔值

此选项允许从 DHCP 服务器自动请求并获取 DNS 服务器 IPv4 地址。

enable_dhcp 为 true 时适用。

选项

  • false

  • true

ipv6_configuration

字典

IPv6 网络配置。

警告 确保您有备用接口来访问 OpenManage Enterprise,因为这些选项可能会更改 hostname 的当前 IPv6 地址。

enable

布尔值 / 必需

使用 IPv6 启用或禁用对网络的访问。

选项

  • false

  • true

enable_auto_configuration

布尔值

启用或禁用从 IPv6 DHCP 服务器或路由器通告 (RA) 自动请求获取 IPv6 地址

如果 enable_auto_configuration 为 true,则 OME 从现有网络上的 DHCPv6 服务器检索 IP 配置 - 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_dhcp_for_dns_server_names

布尔值

此选项允许从 DHCP 服务器自动请求并获取 DNS 服务器 IPv6 地址。

enable_auto_configuration 为 true 时适用

选项

  • false

  • true

management_vlan

字典

vLAN 配置。

这些设置适用于 OpenManage Enterprise Modular。

enable_vlan

布尔值 / 必需

启用或禁用管理的 vLAN。

如果 dns_configuration 下的 register_with_dns 字段为 true,则无法更新 vLAN 配置。

警告 确保在 vLAN 配置更改完成后将网线插入正确的端口。否则,配置更改可能不会生效。

选项

  • false

  • true

vlan_id

整数

vLAN ID。

enable_vlan 为 true 时适用。

password

字符串

OpenManage Enterprise 或 OpenManage Enterprise Modular 密码。

如果未提供密码,则使用环境变量 OME_PASSWORD

示例:export OME_PASSWORD=password

port

整数

OpenManage Enterprise 或 OpenManage Enterprise Modular HTTPS 端口。

默认: 443

reboot_delay

整数

应用设置后的延迟时间(以秒为单位)。

此选项不是强制性的。

timeout

整数

在 dellemc.openmanage 5.0.0 中添加

套接字级别的超时时间(以秒为单位)。

默认: 30

username

字符串

OpenManage Enterprise 或 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

备注

注意

  • 配置更改一次只能应用于一个接口。

  • 应用配置更改后,系统管理控制台可能会在一段时间内无法访问。

  • 此模块支持 check_mode

示例

---
- name: IPv4 network configuration for primary interface
  dellemc.openmanage.ome_application_network_address:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    enable_nic: true
    ipv4_configuration:
      enable: 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_for_dns_server_names: false
      static_preferred_dns_server: 192.168.0.4
      static_alternate_dns_server: 192.168.0.5
    reboot_delay: 5

- name: IPv6 network configuration for primary interface
  dellemc.openmanage.ome_application_network_address:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    ipv6_configuration:
      enable: true
      enable_auto_configuration: true
      static_ip_address: 2626:f2f2:f081:9:1c1c:f1f1:4747:1
      static_prefix_length: 10
      static_gateway: 2626:f2f2:f081:9:1c1c:f1f1:4747:2
      use_dhcp_for_dns_server_names: true
      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: Management vLAN configuration for primary interface
  dellemc.openmanage.ome_application_network_address:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    management_vlan:
      enable_vlan: true
      vlan_id: 3344
    dns_configuration:
      register_with_dns: false
    reboot_delay: 1

- name: DNS settings
  dellemc.openmanage.ome_application_network_address:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    ipv4_configuration:
      enable: true
      use_dhcp_for_dns_server_names: false
      static_preferred_dns_server: 192.168.0.4
      static_alternate_dns_server: 192.168.0.5
    dns_configuration:
      register_with_dns: true
      use_dhcp_for_dns_domain_name: false
      dns_name: "MX-SVCTAG"
      dns_domain_name: "dnslocaldomain"

- name: Disbale nic interface eth1
  dellemc.openmanage.ome_application_network_address:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    enable_nic: false
    interface_name: eth1

- name: Complete network settings for interface eth1
  dellemc.openmanage.ome_application_network_address:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    enable_nic: true
    interface_name: eth1
    ipv4_configuration:
      enable: 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_for_dns_server_names: false
      static_preferred_dns_server: 192.168.0.4
      static_alternate_dns_server: 192.168.0.5
    ipv6_configuration:
      enable: true
      enable_auto_configuration: true
      static_ip_address: 2626:f2f2:f081:9:1c1c:f1f1:4747:1
      static_prefix_length: 10
      static_gateway: ffff::2607:f2b1:f081:9
      use_dhcp_for_dns_server_names: true
      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"
    reboot_delay: 5

返回值

常见返回值记录在此处,以下是此模块特有的字段

描述

error_info

字典

HTTP 错误的详细信息。

返回: HTTP 错误时

示例: {"error": {"@Message.ExtendedInfo": [{"Message": "无法更新地址配置,因为缺少“使用 DHCP 获取 DNS 域名”、“启用 IPv4 的 DHCP”或“启用 IPv6 的自动配置”设置的依赖字段,请提供有效配置。", "MessageArgs": ["使用 DHCP 获取 DNS 域名", "启用 IPv4 的 DHCP", "或启用 IPv6 的自动配置设置以获得有效配置"], "MessageId": "CAPP1304", "RelatedProperties": [], "Resolution": "请确保所有依赖字段都包含有效内容,然后重试操作。", "Severity": "Critical"}], "code": "Base.1.0.GeneralError", "message": "发生了一般错误。有关更多信息,请参阅 ExtendedInfo。"}}

job_info

字典

如果 OME 版本 >= 3.3,则提供更新作业的详细信息。

返回: 成功时

示例: {"Builtin": false, "CreatedBy": "system", "Editable": true, "EndTime": null, "Id": 14902, "JobDescription": "通用 OME 运行时任务", "JobName": "OMERealtime_Task", "JobStatus": {"Id": 2080, "Name": "新建"}, "JobType": {"Id": 207, "Internal": true, "Name": "OMERealtime_Task"}, "LastRun": null, "LastRunStatus": {"Id": 2080, "Name": "新建"}, "NextRun": null, "Params": [{"JobId": 14902, "Key": "Nmcli_Update", "Value": "{\"interfaceName\":\"eth0\",\"profileName\":\"eth0\",\"enableNIC\":true, \"ipv4Configuration\":{\"enable\":true,\"enableDHCP\":true,\"staticIPAddress\":\"\", \"staticSubnetMask\":\"\",\"staticGateway\":\"\",\"useDHCPForDNSServerNames\":true, \"staticPreferredDNSServer\":\"\",\"staticAlternateDNSServer\":\"\"}, \"ipv6Configuration\":{\"enable\":false,\"enableAutoConfiguration\":true,\"staticIPAddress\":\"\", \"staticPrefixLength\":0,\"staticGateway\":\"\",\"useDHCPForDNSServerNames\":false, \"staticPreferredDNSServer\":\"\",\"staticAlternateDNSServer\":\"\"}, \"managementVLAN\":{\"enableVLAN\":false,\"id\":0},\"dnsConfiguration\":{\"registerWithDNS\":false, \"dnsName\":\"\",\"useDHCPForDNSDomainName\":false,\"dnsDomainName\":\"\",\"fqdndomainName\":\"\", \"ipv4CurrentPreferredDNSServer\":\"\",\"ipv4CurrentAlternateDNSServer\":\"\", \"ipv6CurrentPreferredDNSServer\":\"\",\"ipv6CurrentAlternateDNSServer\":\"\"}, \"currentSettings\":{\"ipv4Address\":[],\"ipv4Gateway\":\"\",\"ipv4Dns\":[],\"ipv4Domain\":\"\", \"ipv6Address\":[],\"ipv6LinkLocalAddress\":\"\",\"ipv6Gateway\":\"\",\"ipv6Dns\":[], \"ipv6Domain\":\"\"},\"delay\":0,\"primaryInterface\":true,\"modifiedConfigs\":{}}"}], "Schedule": "startnow", "StartTime": null, "State": "Enabled", "Targets": [], "UpdatedBy": null, "Visible": true}

msg

字符串

网络地址配置更改的总体状态。

返回: 始终

示例: "成功更新网络地址配置"

network_configuration

字典

更新的应用程序网络地址配置。

返回: 成功时

示例: {"Delay": 0, "DnsConfiguration": {"DnsDomainName": "", "DnsName": "MX-SVCTAG", "RegisterWithDNS": false, "UseDHCPForDNSDomainName": true}, "EnableNIC": true, "InterfaceName": "eth0", "Ipv4Configuration": {"Enable": true, "EnableDHCP": false, "StaticAlternateDNSServer": "", "StaticGateway": "192.168.0.2", "StaticIPAddress": "192.168.0.3", "StaticPreferredDNSServer": "192.168.0.4", "StaticSubnetMask": "255.255.254.0", "UseDHCPForDNSServerNames": false}, "Ipv6Configuration": {"Enable": true, "EnableAutoConfiguration": true, "StaticAlternateDNSServer": "", "StaticGateway": "", "StaticIPAddress": "", "StaticPreferredDNSServer": "", "StaticPrefixLength": 0, "UseDHCPForDNSServerNames": true}, "ManagementVLAN": {"EnableVLAN": false, "Id": 1}, "PrimaryInterface": true}

作者

  • Jagadeesh N V(@jagadeeshnv)