wti.remote.cpm_time_config (1.0.5) — module

Install collection

Install with ansible-galaxy collection install wti.remote:==1.0.5

Add to requirements.yml

  collections:
    - name: wti.remote
      version: 1.0.5

Description

Set Time/Date and NTP parameters parameters in WTI OOB and PDU devices

Usage examples

Scanned by Steampunk Spotter

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

# Set a static time/date and timezone of a WTI device
- name: Set known fixed time/date of a WTI device
  cpm_time_config:
    cpm_url: "nonexist.wti.com"
    cpm_username: "super"
    cpm_password: "super"
    use_https: true
    validate_certs: false
    date: "12/12/2019"
    time: "09:23:46"
    timezone: 5

Scanned by Steampunk Spotter

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

# Enable NTP and set primary and seconday servers of a WTI device
- name: Set NTP primary and seconday servers of a WTI device
  cpm_time_config:
    cpm_url: "nonexist.wti.com"
    cpm_username: "super"
    cpm_password: "super"
    use_https: true
    validate_certs: false
    timezone: 5
    ntpenable: 1
    ipv4address: "129.6.15.28.pool.ntp.org"
    timeout: 15

Inputs

    
date:
    description:
    - Static date in the format of two digit month, two digit day, four digit year separated
      by a slash symbol.
    required: false
    type: str

time:
    description:
    - Static time in the format of two digit hour, two digit minute, two digit second
      separated by a colon symbol.
    required: false
    type: str

cpm_url:
    description:
    - This is the URL of the WTI device to send the module.
    required: true
    type: str

timeout:
    description:
    - Set the network timeout in seconds of contacting the NTP servers, valid options
      can be from 1-60.
    required: false
    type: int

timezone:
    description:
    - This is timezone that is assigned to the WTI device.
    required: false
    type: int

ntpenable:
    choices:
    - 0
    - 1
    description:
    - This enables or disables the NTP client service.
    required: false
    type: int

use_https:
    default: true
    description:
    - Designates to use an https connection or http connection.
    required: false
    type: bool

use_proxy:
    default: false
    description:
    - Flag to control if the lookup will observe HTTP proxy environment variables when
      present.
    required: false
    type: bool

ipv4address:
    description:
    - Comma separated string of up to two addresses for a primary and secondary IPv4 base
      NTP server.
    required: false
    type: str

ipv6address:
    description:
    - Comma separated string of up to two addresses for a primary and secondary IPv6 base
      NTP server.
    required: false
    type: str

cpm_password:
    description:
    - This is the Password of the WTI device to send the module.
    required: true
    type: str

cpm_username:
    description:
    - This is the Username of the WTI device to send the module.
    required: true
    type: str

validate_certs:
    default: true
    description:
    - If false, SSL certificates will not be validated. This should only be used
    - on personally controlled sites using self-signed certificates.
    required: false
    type: bool

Outputs

data:
  contains:
    date:
      description: Current Date of the WTI device after module execution.
      returned: success
      sample: 11/14/2019
      type: str
    ntp:
      description: Current k/v pairs of ntp info of the WTI device after module execution.
      returned: always
      sample:
        enable: '0'
        ietf-ipv4:
          address:
          - primary: 192.168.0.169
            secondary: 12.34.56.78
        ietf-ipv6:
          address:
          - primary: ''
            secondary: ''
        timeout: '4'
      type: dict
    time:
      description: Current Time of the WTI device after module execution.
      returned: success
      sample: '12:12:00'
      type: str
    timezone:
      description: Current Timezone of the WTI device after module execution.
      returned: success
      sample: 5
      type: int
  description: The output JSON returned from the commands sent
  returned: always
  type: complex