Try SpotterConfigure network settings of devices on OpenManage Enterprise Modular
| "added in version" 4.2.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 to configure network settings on Chassis, Servers, and I/O Modules on OpenManage Enterprise Modular.
---
- 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
port:
default: 443
description: OpenManage Enterprise Modular HTTPS port.
type: int
delay:
default: 0
description:
- The time in seconds, after which settings are applied.
- This option is applicable only for Chassis.
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 Modular IP address or hostname.
required: true
type: str
password:
description:
- 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 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
device_id:
description:
- ID of the device.
- This option is mutually exclusive with I(device_service_tag).
type: int
enable_nic:
default: true
description:
- Enable or disable Network Interface Card (NIC) configuration of the device.
- This option is not applicable to I/O Module.
type: bool
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.
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.
- C(WARNING) Ensure that the network cable is connected to the correct port after
the VLAN configuration is changed. If not, the VLAN configuration changes may
not be applied.
required: true
type: bool
vlan_id:
description:
- VLAN ID.
- 'The valid VLAN IDs are: 1 to 4000, and 4021 to 4094.'
- This option is applicable when I(enable_vlan) is true.
type: int
type: dict
dns_configuration:
description: Domain Name System(DNS) settings.
suboptions:
auto_negotiation:
description:
- Enables or disables the auto negation of the network speed.
- 'C(NOTE): Setting I(auto_negotiation) to false and choosing a network port speed
may result in the chassis loosing link to the top of rack network switch, or
to the neighboring chassis in case of MCM mode. It is recommended that the I(auto_negotiation)
is set to C(true) for most use cases.'
- This is applicable when I(use_dhcp_for_dns_domain_name) is false.
- This is applicable only for Chassis.
type: bool
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
network_speed:
choices:
- 10_MB
- 100_MB
description:
- The speed of the network port.
- This is applicable when I(auto_negotiation) is false.
- C(10_MB) to select network speed of 10 MB.
- C(100_MB) to select network speed of 100 MB.
- This is applicable only for Chassis.
type: str
register_with_dns:
description:
- Register/Unregister I(dns_name) on the DNS Server.
- C(WARNING) 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
device_service_tag:
description:
- Service tag of the device.
- This option is mutually exclusive with I(device_id).
type: str
ipv4_configuration:
description:
- IPv4 network configuration.
- C(WARNING) Ensure that you have an alternate interface to access OpenManage Enterprise
Modular because these options can change the current IPv4 address for I(hostname).
suboptions:
enable_dhcp:
description:
- Enable or disable the automatic request to obtain an IPv4 address from the IPv4
Dynamic Host Configuration Protocol (DHCP) server.
- C(NOTE) If this option is C(true), the values provided for I(static_ip_address),
I(static_subnet_mask), and I(static_gateway) are not applied for these fields.
However, the module may report changes.
type: bool
enable_ipv4:
description:
- Enable or disable access to the network using IPv4.
required: true
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_to_obtain_dns_server_address:
description:
- This option allows to automatically request and obtain IPv4 address for the
DNS Server from the DHCP server.
- This option is applicable when I(enable_dhcp) is true.
- C(NOTE) If this option is C(true), the values provided for I(static_preferred_dns_server)
and I(static_alternate_dns_server) are not applied for these fields. However,
the module may report changes.
type: bool
type: dict
ipv6_configuration:
description:
- IPv6 network configuration.
- C(WARNING) Ensure that you have an alternate interface to access OpenManage Enterprise
Modular because these options can change the current IPv6 address for I(hostname).
suboptions:
enable_auto_configuration:
description:
- Enable or disable the automatic request to obtain an IPv6 address from the IPv6
DHCP server or router advertisements(RA)
- If I(enable_auto_configuration) is C(true), OpenManage Enterprise Modular retrieves
IP configuration (IPv6 address, prefix, and gateway address) from a DHCPv6 server
on the existing network.
- C(NOTE) If this option is C(true), the values provided for I(static_ip_address),
I(static_prefix_length), and I(static_gateway) are not applied for these fields.
However, the module may report changes.
type: bool
enable_ipv6:
description: Enable or disable access to the network using the IPv6.
required: true
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_dhcpv6_to_obtain_dns_server_address:
description:
- This option allows to automatically request and obtain a IPv6 address for the
DNS server from the DHCP server.
- This option is applicable when I(enable_auto_configuration) is true
- C(NOTE) If this option is C(true), the values provided for I(static_preferred_dns_server)
and I(static_alternate_dns_server) are not applied for these fields. However,
the module may report changes.
type: bool
type: dict
dns_server_settings:
description:
- DNS server settings.
- This is applicable only for I/O Module.
suboptions:
alternate_dns_server1:
description:
- Enter the IP address of the first alternate DNS server.
type: str
alternate_dns_server2:
description:
- Enter the IP address of the second alternate DNS server.
type: str
preferred_dns_server:
description:
- Enter the IP address of the preferred DNS server.
type: str
type: dict
error_info:
description: Details of the HTTP Error.
returned: on HTTP error
sample:
error:
'@Message.ExtendedInfo':
- Message: Unable to complete the request because IPV4 Settings Capability is
not Supported does not exist or is not applicable for the resource URI.
MessageArgs:
- IPV4 Settings Capability is not Supported
MessageId: CGEN1004
RelatedProperties: []
Resolution: Check the request resource URI. Refer to the OpenManage Enterprise-Modular
User's Guide for more information about resource URI and its properties.
Severity: Critical
code: Base.1.0.GeneralError
message: A general error has occurred. See ExtendedInfo for more information.
type: dict
msg:
description: Overall status of the network config operation.
returned: always
sample: Successfully applied the network settings.
type: str