dellemc.openmanage.idrac_timezone_ntp (9.1.0) — module

Install collection

Install with ansible-galaxy collection install dellemc.openmanage:==9.1.0

Add to requirements.yml

  collections:
    - name: dellemc.openmanage
      version: 9.1.0

Description

This module allows to configure time zone and NTP on iDRAC.

Requirements

• omsdk >= 1.2.488
• python >= 3.9.6

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

---
- 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"
       ca_path: "/path/to/ca_cert.pem"
       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"

Inputs

    
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

idrac_ip:
    description: iDRAC IP Address.
    required: true
    type: str

share_mnt:
    description:
    - (deprecated)Local mount path of the network share with read-write permission for
      ansible user. This option is mandatory for network shares.
    - This option is deprecated and will be removed in the later version.
    type: str

enable_ntp:
    choices:
    - Enabled
    - Disabled
    description: Allows to enable or disable NTP on iDRAC.
    type: str

idrac_port:
    default: 443
    description: iDRAC port.
    type: int

idrac_user:
    description:
    - iDRAC username.
    - If the username is not provided, then the environment variable C(IDRAC_USERNAME)
      is used.
    - 'Example: export IDRAC_USERNAME=username'
    required: true
    type: str

share_name:
    description:
    - (deprecated)Network share or a local path.
    - This option is deprecated and will be removed in the later version.
    type: str

share_user:
    description:
    - (deprecated)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.
    - This option is deprecated and will be removed in the later version.
    type: str

ntp_server_1:
    description: The IP address of the NTP server 1.
    type: str

ntp_server_2:
    description: The IP address of the NTP server 2.
    type: str

ntp_server_3:
    description: The IP address of the NTP server 3.
    type: str

idrac_password:
    aliases:
    - idrac_pwd
    description:
    - iDRAC user password.
    - If the password is not provided, then the environment variable C(IDRAC_PASSWORD)
      is used.
    - 'Example: export IDRAC_PASSWORD=password'
    required: true
    type: str

share_password:
    aliases:
    - share_pwd
    description:
    - (deprecated)Network share user password. This option is mandatory for CIFS share.
    - This option is deprecated and will be removed in the later version.
    type: str

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

setup_idrac_timezone:
    description: Allows to configure time zone on iDRAC.
    type: str

Outputs

error_info:
  description: Details of the HTTP Error.
  returned: on 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.
  type: dict
msg:
  description: Overall status of the timezone and ntp configuration.
  returned: always
  sample: Successfully configured the iDRAC time settings.
  type: str
timezone_ntp_status:
  description: Job details of the time zone setting operation.
  returned: success
  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: null
    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: null
    retval: true
  type: dict