ansible.builtin.nxos_ntp_auth (v2.3.3.0-1) — module

Manages NTP authentication.

| "added in version" 2.2 of ansible.builtin"

Authors: Jason Edelman (@jedelman8)

preview | supported by community

Install Ansible via pip

Install with pip install ansible==2.3.3.0.post1

Description

Manages NTP authentication.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# Basic NTP authentication configuration
- nxos_ntp_auth:
    key_id: 32
    md5string: hello
    auth_type: text
    host: "{{ inventory_hostname }}"
    username: "{{ un }}"
    password: "{{ pwd }}"

Inputs

    
state:
    choices:
    - present
    - absent
    default: present
    description:
    - Manage the state of the resource.
    required: false

key_id:
    description:
    - Authentication key identifier (numeric).
    required: true

auth_type:
    choices:
    - text
    - encrypt
    default: text
    description:
    - Whether the given md5string is in cleartext or has been encrypted. If in cleartext,
      the device will encrypt it before storing it.
    required: false

md5string:
    default: null
    description:
    - MD5 String.
    required: true

trusted_key:
    choices:
    - 'true'
    - 'false'
    default: false
    description:
    - Whether the given key is required to be supplied by a time source for the device
      to synchronize to the time source.
    required: false

authentication:
    choices:
    - 'on'
    - 'off'
    default: null
    description:
    - Turns NTP authentication on or off.
    required: false

Outputs

changed:
  description: check to see if a change was made on the device
  returned: always
  sample: true
  type: boolean
end_state:
  description: k/v pairs of ntp authentication after module execution
  returned: always
  sample:
    authentication: 'off'
    key_id: '32'
    md5string: kapqgWjwdg
    trusted_key: 'true'
  type: dict
existing:
  description:
  - k/v pairs of existing ntp authentication
  returned: always
  sample:
    authentication: 'off'
    trusted_key: 'false'
  type: dict
proposed:
  description: k/v pairs of parameters passed into module
  returned: always
  sample:
    auth_type: text
    authentication: 'off'
    key_id: '32'
    md5string: helloWorld
    trusted_key: 'true'
  type: dict
state:
  description: state as sent in from the playbook
  returned: always
  sample: present
  type: string
updates:
  description: command sent to the device
  returned: always
  sample:
  - ntp authentication-key 32 md5 helloWorld 0
  - ntp trusted-key 32
  type: list