Try SpotterConfigure chassis network services settings on OpenManage Enterprise Modular
| "added in version" 4.3.0 of dellemc.openmanage"
Authors: Felix Stephen (@felixs88)
Install with ansible-galaxy collection install dellemc.openmanage:==9.1.0
collections:
- name: dellemc.openmanage
version: 9.1.0This module allows to configure the network services on OpenManage Enterprise Modular.
---
- 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
port:
default: 443
description: 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 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:
- 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 I(hostname).
- I(device_id) is mutually exclusive with I(device_service_tag).
type: int
ssh_settings:
description: The settings for SSH configuration.
suboptions:
enabled:
description: Enables or disables the SSH settings.
required: true
type: bool
idle_timeout:
description: SSH idle timeout in minutes.
type: float
max_auth_retries:
description: The number of retries when the SSH session fails.
type: int
max_sessions:
description: Number of SSH sessions.
type: int
port_number:
description: The port number for SSH service.
type: int
type: dict
snmp_settings:
description: The settings for SNMP configuration.
suboptions:
community_name:
description:
- The SNMP community string.
- Required when I(enabled) is C(true).
type: str
enabled:
description: Enables or disables the SNMP settings.
required: true
type: bool
port_number:
description: The SNMP port number.
type: int
type: dict
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
device_service_tag:
description:
- 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 I(hostname).
- I(device_service_tag) is mutually exclusive with I(device_id).
type: str
remote_racadm_settings:
description: The settings for remote RACADM configuration.
suboptions:
enabled:
description: Enables or disables the remote RACADM settings.
required: 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 network configuration because the SNMP PortNumber
is already in use.
MessageArgs:
- SNMP PortNumber
MessageId: CAPP1042
RelatedProperties: []
Resolution: Enter a different port number and retry the operation.
Severity: Informational
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 services settings.
returned: always
sample: Successfully updated the network services settings.
type: str
network_services_details:
description: returned when network services settings are updated successfully.
returned: success
sample:
EnableRemoteRacadm: true
SettingType: NetworkServices
SnmpConfiguration:
PortNumber: 161
SnmpEnabled: true
SnmpV1V2Credential:
CommunityName: public
SshConfiguration:
IdleTimeout: 60
MaxAuthRetries: 3
MaxSessions: 1
PortNumber: 22
SshEnabled: false
type: dict