dellemc.openmanage.ome_application_network_address module – Updates the network configuration on OpenManage Enterprise
Note
This module is part of the dellemc.openmanage collection (version 9.9.0).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install dellemc.openmanage.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: dellemc.openmanage.ome_application_network_address.
New in dellemc.openmanage 2.1.0
Synopsis
This module allows the configuration of a DNS and an IPV4 or IPV6 network on OpenManage Enterprise.
Requirements
The below requirements are needed on the host that executes this module.
python >= 3.9.6
Parameters
Parameter |
Comments |
|---|---|
The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for the validation. |
|
Domain Name System(DNS) settings. |
|
Static DNS domain name This is applicable when use_dhcp_for_dns_domain_name is false. |
|
DNS name for hostname This is applicable when register_with_dns is true. |
|
Register/Unregister dns_name on the DNS Server. This option cannot be updated if vLAN configuration changes. Choices:
|
|
Get the dns_domain_name using a DHCP server. Choices:
|
|
Enable or disable Network Interface Card (NIC) configuration. Choices:
|
|
OpenManage Enterprise or OpenManage Enterprise Modular IP address or hostname. |
|
If there are multiple interfaces, network configuration changes can be applied to a single interface using the interface name of the NIC. If this option is not specified, Primary interface is chosen by default. |
|
IPv4 network configuration. Warning Ensure that you have an alternate interface to access OpenManage Enterprise as these options can change the current IPv4 address for hostname. |
|
Enable or disable access to the network using IPv4. Choices:
|
|
Enable or disable the automatic request to get an IPv4 address from the IPv4 Dynamic Host Configuration Protocol (DHCP) server If enable_dhcp option is true, OpenManage Enterprise retrieves the IP configuration—IPv4 address, subnet mask, and gateway from a DHCP server on the existing network. Choices:
|
|
Static IPv4 DNS alternate server This option is applicable when use_dhcp_for_dns_server_names is false. |
|
Static IPv4 gateway address This option is applicable when enable_dhcp is false. |
|
Static IPv4 address This option is applicable when enable_dhcp is false. |
|
Static IPv4 DNS preferred server This option is applicable when use_dhcp_for_dns_server_names is false. |
|
Static IPv4 subnet mask address This option is applicable when enable_dhcp is false. |
|
This option allows to automatically request and obtain a DNS server IPv4 address from the DHCP server. This option is applicable when enable_dhcp is true. Choices:
|
|
IPv6 network configuration. Warning Ensure that you have an alternate interface to access OpenManage Enterprise as these options can change the current IPv6 address for hostname. |
|
Enable or disable access to the network using the IPv6. Choices:
|
|
Enable or disable the automatic request to get an IPv6 address from the IPv6 DHCP server or router advertisements(RA) If enable_auto_configuration is true, OME retrieves IP configuration-IPv6 address, prefix, and gateway, from a DHCPv6 server on the existing network Choices:
|
|
Static IPv6 DNS alternate server This option is applicable when use_dhcp_for_dns_server_names is false. |
|
Static IPv6 gateway address This option is applicable when enable_auto_configuration is false. |
|
Static IPv6 address This option is applicable when enable_auto_configuration is false. |
|
Static IPv6 DNS preferred server This option is applicable when use_dhcp_for_dns_server_names is false. |
|
Static IPv6 prefix length This option is applicable when enable_auto_configuration is false. |
|
This option allows to automatically request and obtain a DNS server IPv6 address from the DHCP server. This option is applicable when enable_auto_configuration is true Choices:
|
|
vLAN configuration. These settings are applicable for OpenManage Enterprise Modular. |
|
Enable or disable vLAN for management. The vLAN configuration cannot be updated if the register_with_dns field under dns_configuration is true. WARNING Ensure that the network cable is plugged to the correct port after the vLAN configuration changes have been made. If not, the configuration change may not be effective. Choices:
|
|
vLAN ID. This option is applicable when enable_vlan is true. |
|
OpenManage Enterprise or OpenManage Enterprise Modular password. If the password is not provided, then the environment variable Example: export OME_PASSWORD=password |
|
OpenManage Enterprise or OpenManage Enterprise Modular HTTPS port. Default: |
|
The time in seconds, after which settings are applied. This option is not mandatory. |
|
The socket level timeout in seconds. Default: |
|
OpenManage Enterprise or OpenManage Enterprise Modular username. If the username is not provided, then the environment variable Example: export OME_USERNAME=username |
|
If Configure Prior to collection version Choices:
|
|
Authentication token. If the x_auth_token is not provided, then the environment variable Example: export OME_X_AUTH_TOKEN=x_auth_token |
Notes
Note
The configuration changes can only be applied to one interface at a time.
The system management consoles might be unreachable for some time after the configuration changes are applied.
This module supports
check_mode.
Examples
---
- 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
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Details of the HTTP error. Returned: on HTTP error Sample: |
|
Details of the job to update in case OME version is >= 3.3. Returned: on success Sample: |
|
Overall status of the network address configuration change. Returned: always Sample: |
|
Updated application network address configuration. Returned: on success Sample: |