dellemc.openmanage.ome_device_network_services module – Configure chassis network services settings on OpenManage Enterprise Modular
Note
This module is part of the dellemc.openmanage collection (version 9.6.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_device_network_services
.
New in dellemc.openmanage 4.3.0
Synopsis
This module allows to configure the network services on OpenManage Enterprise Modular.
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. |
|
The ID of the chassis for which the settings need to be updated. If the device ID is not specified, this module updates the network services settings for the hostname. device_id is mutually exclusive with device_service_tag. |
|
The service tag of the chassis for which the setting needs to be updated. If the device service tag is not specified, this module updates the network services settings for the hostname. device_service_tag is mutually exclusive with device_id. |
|
OpenManage Enterprise Modular IP address or hostname. |
|
OpenManage Enterprise Modular password. If the password is not provided, then the environment variable Example: export OME_PASSWORD=password |
|
OpenManage Enterprise Modular HTTPS port. Default: |
|
The settings for remote RACADM configuration. |
|
Enables or disables the remote RACADM settings. Choices:
|
|
The settings for SNMP configuration. |
|
The SNMP community string. Required when enabled is |
|
Enables or disables the SNMP settings. Choices:
|
|
The SNMP port number. |
|
The settings for SSH configuration. |
|
Enables or disables the SSH settings. Choices:
|
|
SSH idle timeout in minutes. |
|
The number of retries when the SSH session fails. |
|
Number of SSH sessions. |
|
The port number for SSH service. |
|
The socket level timeout in seconds. Default: |
|
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
Run this module from a system that has direct access to Dell OpenManage Enterprise Modular.
This module supports
check_mode
.
Examples
---
- name: Update network services settings of a chassis using the device ID
dellemc.openmanage.ome_device_network_services:
hostname: "192.168.0.1"
username: "username"
password: "password"
ca_path: "/path/to/ca_cert.pem"
device_id: 25011
snmp_settings:
enabled: true
port_number: 161
community_name: public
ssh_settings:
enabled: false
remote_racadm_settings:
enabled: false
- name: Update network services settings of a chassis using the device service tag.
dellemc.openmanage.ome_device_network_services:
hostname: "192.168.0.2"
username: "username"
password: "password"
ca_path: "/path/to/ca_cert.pem"
device_service_tag: GHRT2RL
snmp_settings:
enabled: false
ssh_settings:
enabled: true
port_number: 22
max_sessions: 1
max_auth_retries: 3
idle_timeout: 1
remote_racadm_settings:
enabled: false
- name: Update network services settings of the host chassis.
dellemc.openmanage.ome_device_network_services:
hostname: "192.168.0.3"
username: "username"
password: "password"
ca_path: "/path/to/ca_cert.pem"
snmp_settings:
enabled: false
ssh_settings:
enabled: false
remote_racadm_settings:
enabled: true
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 services settings. Returned: always Sample: |
|
returned when network services settings are updated successfully. Returned: success Sample: |