dellemc.openmanage.ome_application_network_time (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 the configuration of network time on OpenManage Enterprise.

Requirements

• python >= 3.8.6

Usage examples

Scanned by Steampunk Spotter

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

---
- name: Configure system time
  dellemc.openmanage.ome_application_network_time:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    enable_ntp: false
    system_time: "2020-03-31 21:35:18"
    time_zone: "TZ_ID_11"

Scanned by Steampunk Spotter

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

- name: Configure NTP server for time synchronization
  dellemc.openmanage.ome_application_network_time:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    enable_ntp: true
    time_zone: "TZ_ID_66"
    primary_ntp_address: "192.168.0.2"
    secondary_ntp_address1: "192.168.0.2"
    secondary_ntp_address2: "192.168.0.4"

Inputs

    
port:
    default: 443
    description: OpenManage Enterprise or 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 or OpenManage Enterprise Modular IP address or
      hostname.
    required: true
    type: str

password:
    description:
    - OpenManage Enterprise or 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 or 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

time_zone:
    description:
    - The valid timezone ID to be used.
    - This option is applicable for both system time and NTP time synchronization.
    type: str

enable_ntp:
    description:
    - Enables or disables Network Time Protocol(NTP).
    - If I(enable_ntp) is false, then the NTP addresses reset to their default values.
    required: true
    type: bool

system_time:
    description:
    - Time in the current system.
    - This option is only applicable when I(enable_ntp) is false.
    - This option must be provided in following format 'yyyy-mm-dd hh:mm:ss'.
    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

primary_ntp_address:
    description:
    - The primary NTP address.
    - This option is applicable when I(enable_ntp) is true.
    type: str

secondary_ntp_address1:
    description:
    - The first secondary NTP address.
    - This option is applicable when I(enable_ntp) is true.
    type: str

secondary_ntp_address2:
    description:
    - The second secondary NTP address.
    - This option is applicable when I(enable_ntp) is true.
    type: str

Outputs

error_info:
  description: Details of the HTTP error.
  returned: on HTTP error
  sample:
    error:
      '@Message.ExtendedInfo':
      - Message: Unable to complete the request because the input value for  SystemTime  is
          missing or an invalid value is entered.
        MessageArgs:
        - SystemTime
        MessageId: CGEN6002
        RelatedProperties: []
        Resolution: Enter a valid value and retry the operation.
        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 network time configuration change.
  returned: always
  sample: Successfully configured network time.
  type: str
proxy_configuration:
  description: Updated application network time configuration.
  returned: success
  sample:
    EnableNTP: false
    JobId: null
    PrimaryNTPAddress: null
    SecondaryNTPAddress1: null
    SecondaryNTPAddress2: null
    SystemTime: null
    TimeSource: Local Clock
    TimeZone: TZ_ID_1
    TimeZoneIdLinux: null
    TimeZoneIdWindows: null
    UtcTime: null
  type: dict