Try SpotterUpdates the network configuration on OpenManage Enterprise
| "added in version" 2.1.0 of dellemc.openmanage"
Authors: Jagadeesh N V(@jagadeeshnv)
Install with ansible-galaxy collection install dellemc.openmanage:==9.1.0
collections:
- name: dellemc.openmanage
version: 9.1.0This module allows the configuration of a DNS and an IPV4 or IPV6 network on OpenManage Enterprise.
---
- 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
port:
default: 443
description: OpenManage Enterprise or OpenManage Enterprise Modular HTTPS port.
type: int
ca_path:
description:
- The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for
the validation.
type: path
version_added: 5.0.0
version_added_collection: dellemc.openmanage
timeout:
default: 30
description: The socket level timeout in seconds.
type: int
version_added: 5.0.0
version_added_collection: dellemc.openmanage
hostname:
description: OpenManage Enterprise or OpenManage Enterprise Modular IP address or
hostname.
required: true
type: str
password:
description:
- OpenManage Enterprise or OpenManage Enterprise Modular password.
- If the password is not provided, then the environment variable C(OME_PASSWORD) is
used.
- 'Example: export OME_PASSWORD=password'
required: true
type: str
username:
description:
- OpenManage Enterprise or OpenManage Enterprise Modular username.
- If the username is not provided, then the environment variable C(OME_USERNAME) is
used.
- 'Example: export OME_USERNAME=username'
required: true
type: str
enable_nic:
default: true
description: Enable or disable Network Interface Card (NIC) configuration.
type: bool
reboot_delay:
description:
- The time in seconds, after which settings are applied.
- This option is not mandatory.
type: int
interface_name:
description:
- 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.
type: str
validate_certs:
default: true
description:
- If C(false), the SSL certificates will not be validated.
- Configure C(false) only on personally controlled sites where self-signed certificates
are used.
- Prior to collection version C(5.0.0), the I(validate_certs) is C(false) by default.
type: bool
version_added: 5.0.0
version_added_collection: dellemc.openmanage
management_vlan:
description:
- vLAN configuration.
- These settings are applicable for OpenManage Enterprise Modular.
suboptions:
enable_vlan:
description:
- Enable or disable vLAN for management.
- The vLAN configuration cannot be updated if the I(register_with_dns) field under
I(dns_configuration) is true.
- I(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.
required: true
type: bool
vlan_id:
description:
- vLAN ID.
- This option is applicable when I(enable_vlan) is true.
type: int
type: dict
dns_configuration:
description: Domain Name System(DNS) settings.
suboptions:
dns_domain_name:
description:
- Static DNS domain name
- This is applicable when I(use_dhcp_for_dns_domain_name) is false.
type: str
dns_name:
description:
- DNS name for I(hostname)
- This is applicable when I(register_with_dns) is true.
type: str
register_with_dns:
description:
- Register/Unregister I(dns_name) on the DNS Server.
- This option cannot be updated if vLAN configuration changes.
type: bool
use_dhcp_for_dns_domain_name:
description: Get the I(dns_domain_name) using a DHCP server.
type: bool
type: dict
ipv4_configuration:
description:
- IPv4 network configuration.
- I(Warning) Ensure that you have an alternate interface to access OpenManage Enterprise
as these options can change the current IPv4 address for I(hostname).
suboptions:
enable:
description:
- Enable or disable access to the network using IPv4.
required: true
type: bool
enable_dhcp:
description:
- Enable or disable the automatic request to get an IPv4 address from the IPv4
Dynamic Host Configuration Protocol (DHCP) server
- "If I(enable_dhcp) option is true, OpenManage Enterprise retrieves the IP configuration\u2014\
IPv4 address, subnet mask, and gateway from a DHCP server on the existing network."
type: bool
static_alternate_dns_server:
description:
- Static IPv4 DNS alternate server
- This option is applicable when I(use_dhcp_for_dns_server_names) is false.
type: str
static_gateway:
description:
- Static IPv4 gateway address
- This option is applicable when I(enable_dhcp) is false.
type: str
static_ip_address:
description:
- Static IPv4 address
- This option is applicable when I(enable_dhcp) is false.
type: str
static_preferred_dns_server:
description:
- Static IPv4 DNS preferred server
- This option is applicable when I(use_dhcp_for_dns_server_names) is false.
type: str
static_subnet_mask:
description:
- Static IPv4 subnet mask address
- This option is applicable when I(enable_dhcp) is false.
type: str
use_dhcp_for_dns_server_names:
description:
- This option allows to automatically request and obtain a DNS server IPv4 address
from the DHCP server.
- This option is applicable when I(enable_dhcp) is true.
type: bool
type: dict
ipv6_configuration:
description:
- IPv6 network configuration.
- I(Warning) Ensure that you have an alternate interface to access OpenManage Enterprise
as these options can change the current IPv6 address for I(hostname).
suboptions:
enable:
description: Enable or disable access to the network using the IPv6.
required: true
type: bool
enable_auto_configuration:
description:
- Enable or disable the automatic request to get an IPv6 address from the IPv6
DHCP server or router advertisements(RA)
- If I(enable_auto_configuration) is true, OME retrieves IP configuration-IPv6
address, prefix, and gateway, from a DHCPv6 server on the existing network
type: bool
static_alternate_dns_server:
description:
- Static IPv6 DNS alternate server
- This option is applicable when I(use_dhcp_for_dns_server_names) is false.
type: str
static_gateway:
description:
- Static IPv6 gateway address
- This option is applicable when I(enable_auto_configuration) is false.
type: str
static_ip_address:
description:
- Static IPv6 address
- This option is applicable when I(enable_auto_configuration) is false.
type: str
static_preferred_dns_server:
description:
- Static IPv6 DNS preferred server
- This option is applicable when I(use_dhcp_for_dns_server_names) is false.
type: str
static_prefix_length:
description:
- Static IPv6 prefix length
- This option is applicable when I(enable_auto_configuration) is false.
type: int
use_dhcp_for_dns_server_names:
description:
- This option allows to automatically request and obtain a DNS server IPv6 address
from the DHCP server.
- This option is applicable when I(enable_auto_configuration) is true
type: bool
type: dict
error_info:
description: Details of the HTTP error.
returned: on HTTP error
sample:
error:
'@Message.ExtendedInfo':
- Message: Unable to update the address configuration because a dependent field
is missing for Use DHCP for DNS Domain Name, Enable DHCP for ipv4 or Enable
Autoconfig for ipv6 settings for valid configuration .
MessageArgs:
- Use DHCP for DNS Domain Name, Enable DHCP for ipv4 or Enable Autoconfig
for ipv6 settings for valid configuration
MessageId: CAPP1304
RelatedProperties: []
Resolution: Make sure that all dependent fields contain valid content and
retry the operation.
Severity: Critical
code: Base.1.0.GeneralError
message: A general error has occurred. See ExtendedInfo for more information.
type: dict
job_info:
description: Details of the job to update in case OME version is >= 3.3.
returned: on success
sample:
Builtin: false
CreatedBy: system
Editable: true
EndTime: null
Id: 14902
JobDescription: Generic OME runtime task
JobName: OMERealtime_Task
JobStatus:
Id: 2080
Name: New
JobType:
Id: 207
Internal: true
Name: OMERealtime_Task
LastRun: null
LastRunStatus:
Id: 2080
Name: New
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
type: dict
msg:
description: Overall status of the network address configuration change.
returned: always
sample: Successfully updated network address configuration
type: str
network_configuration:
description: Updated application network address configuration.
returned: on success
sample:
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
type: dict