dellemc.openmanage.ome_device_mgmt_network module – Configure network settings of devices on OpenManage Enterprise Modular
Note
This module is part of the dellemc.openmanage collection (version 8.5.0).
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_device_mgmt_network
.
New in dellemc.openmanage 4.2.0
Synopsis
This module allows to configure network settings on Chassis, Servers, and I/O Modules on OpenManage Enterprise Modular.
Requirements
The below requirements are needed on the host that executes this module.
python >= 3.8.6
Parameters
Parameter |
Comments |
---|---|
The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for the validation. |
|
The time in seconds, after which settings are applied. This option is applicable only for Chassis. Default: |
|
ID of the device. This option is mutually exclusive with device_service_tag. |
|
Service tag of the device. This option is mutually exclusive with device_id. |
|
Domain Name System(DNS) settings. |
|
Enables or disables the auto negation of the network speed.
This is applicable when use_dhcp_for_dns_domain_name is false. This is applicable only for Chassis. Choices:
|
|
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. |
|
The speed of the network port. This is applicable when auto_negotiation is false.
This is applicable only for Chassis. Choices:
|
|
Register/Unregister dns_name on the DNS Server.
Choices:
|
|
Get the dns_domain_name using a DHCP server. Choices:
|
|
DNS server settings. This is applicable only for I/O Module. |
|
Enter the IP address of the first alternate DNS server. |
|
Enter the IP address of the second alternate DNS server. |
|
Enter the IP address of the preferred DNS server. |
|
Enable or disable Network Interface Card (NIC) configuration of the device. This option is not applicable to I/O Module. Choices:
|
|
OpenManage Enterprise Modular IP address or hostname. |
|
IPv4 network configuration.
|
|
Enable or disable the automatic request to obtain an IPv4 address from the IPv4 Dynamic Host Configuration Protocol (DHCP) server.
Choices:
|
|
Enable or disable access to the network using IPv4. 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 IPv4 address for the DNS Server from the DHCP server. This option is applicable when enable_dhcp is true.
Choices:
|
|
IPv6 network configuration.
|
|
Enable or disable the automatic request to obtain an IPv6 address from the IPv6 DHCP server or router advertisements(RA) If enable_auto_configuration is
Choices:
|
|
Enable or disable access to the network using the IPv6. 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 IPv6 address for the DNS server from the DHCP server. This option is applicable when enable_auto_configuration is true
Choices:
|
|
VLAN configuration. |
|
Enable or disable VLAN for management. The VLAN configuration cannot be updated if the register_with_dns field under dns_configuration is true.
Choices:
|
|
VLAN ID. The valid VLAN IDs are: 1 to 4000, and 4021 to 4094. This option is applicable when enable_vlan is true. |
|
OpenManage Enterprise Modular password. |
|
OpenManage Enterprise Modular HTTPS port. Default: |
|
The socket level timeout in seconds. Default: |
|
OpenManage Enterprise Modular username. |
|
If Configure Prior to collection version Choices:
|
Notes
Note
Run this module from a system that has direct access to Dell OpenManage Enterprise Modular.
This module supports
check_mode
.
Examples
---
- 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
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: |
|
Overall status of the network config operation. Returned: always Sample: |