dellemc.openmanage.idrac_timezone_ntp – Configures time zone and NTP on iDRAC
Note
This plugin is part of the dellemc.openmanage collection (version 3.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.
To use it in a playbook, specify: dellemc.openmanage.idrac_timezone_ntp.
New in version 2.1.0: of dellemc.openmanage
Synopsis
- This module allows to configure time zone and NTP on iDRAC.
Requirements
The below requirements are needed on the host that executes this module.
- omsdk
- python >= 2.7.5
Parameters
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| enable_ntp
string
|
|
Allows to enable or disable NTP on iDRAC.
|
| idrac_ip
string / required
|
iDRAC IP Address.
|
|
| idrac_password
string / required
|
iDRAC user password.
aliases: idrac_pwd |
|
| idrac_port
integer
|
Default:
443
|
iDRAC port.
|
| idrac_user
string / required
|
iDRAC username.
|
|
| ntp_server_1
string
|
The IP address of the NTP server 1.
|
|
| ntp_server_2
string
|
The IP address of the NTP server 2.
|
|
| ntp_server_3
string
|
The IP address of the NTP server 3.
|
|
| setup_idrac_timezone
string
|
Allows to configure time zone on iDRAC.
|
|
| share_mnt
string
|
Local mount path of the network share with read-write permission for ansible user. This option is mandatory for network shares.
|
|
| share_name
string / required
|
Network share or a local path.
|
|
| share_password
string
|
Network share user password. This option is mandatory for CIFS share.
aliases: share_pwd |
|
| share_user
string
|
Network share user name. Use the format 'user@domain' or 'domain\\user' if user is part of a domain. This option is mandatory for CIFS share.
|
Notes
Note
- This module requires ‘Administrator’ privilege for idrac_user.
- Run this module from a system that has direct access to Dell EMC iDRAC.
- This module supports
check_mode.
Examples
---
- name: Configure time zone and NTP on iDRAC
dellemc.openmanage.idrac_timezone_ntp:
idrac_ip: "190.168.0.1"
idrac_user: "user_name"
idrac_password: "user_password"
share_name: "user_name:/share"
share_password: "share_password"
share_user: "user_name"
share_mnt: "/mnt/share"
setup_idrac_timezone: "UTC"
enable_ntp: Enabled
ntp_server_1: "190.168.0.1"
ntp_server_2: "190.168.0.2"
ntp_server_3: "190.168.0.3"
Return Values
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| error_info
dictionary
|
on HTTP error |
Details of the HTTP Error.
Sample:
{'error': {'@Message.ExtendedInfo': [{'Message': 'Unable to process the request because an error occurred.', 'MessageArgs': [], 'MessageId': 'GEN1234', 'RelatedProperties': [], 'Resolution': 'Retry the operation. If the issue persists, contact your system administrator.', 'Severity': 'Critical'}], 'code': 'Base.1.0.GeneralError', 'message': 'A general error has occurred. See ExtendedInfo for more information.'}}
|
| msg
string
|
always |
Overall status of the timezone and ntp configuration.
Sample:
Successfully configured the iDRAC time settings.
|
| timezone_ntp_status
dictionary
|
success |
Job details of the time zone setting operation.
Sample:
{'@odata.context': '/redfish/v1/$metadata#DellJob.DellJob', '@odata.id': '/redfish/v1/Managers/iDRAC.Embedded.1/Jobs/JID_861801613971', '@odata.type': '#DellJob.v1_0_0.DellJob', 'CompletionTime': '2020-04-06T19:06:01', 'Description': 'Job Instance', 'EndTime': None, 'Id': 'JID_861801613971', 'JobState': 'Completed', 'JobType': 'ImportConfiguration', 'Message': 'Successfully imported and applied Server Configuration Profile.', 'MessageArgs': [], 'MessageId': 'SYS053', 'Name': 'Import Configuration', 'PercentComplete': 100, 'StartTime': 'TIME_NOW', 'Status': 'Success', 'TargetSettingsURI': None, 'retval': True}
|
Authors
- Felix Stephen (@felixs88)
- Anooja Vardhineni (@anooja-vardhineni)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/dellemc/openmanage/idrac_timezone_ntp_module.html