community.network.ce_ntp_auth module – Manages NTP authentication configuration on HUAWEI CloudEngine switches.
Note
This module is part of the community.network collection (version 4.0.2).
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 community.network
.
To use it in a playbook, specify: community.network.ce_ntp_auth
.
Synopsis
Manages NTP authentication configuration on HUAWEI CloudEngine switches.
Parameters
Parameter |
Comments |
---|---|
Specify authentication algorithm. Choices:
|
|
Plain text with length of 1 to 255, encrypted text with length of 20 to 392. |
|
Whether the given password is in cleartext or has been encrypted. If in cleartext, the device will encrypt it before storing it. Choices:
|
|
Configure ntp authentication enable or unconfigure ntp authentication enable. Choices:
|
|
Authentication key identifier (numeric). |
|
Manage the state of the resource. Choices:
|
|
Whether the given key is required to be supplied by a time source for the device to synchronize to the time source. Choices:
|
Notes
Note
If
state=absent
, the module will attempt to remove the given key configuration. If a matching key configuration isn’t found on the device, the module will fail.If
state=absent
andauthentication=on
, authentication will be turned on.If
state=absent
andauthentication=off
, authentication will be turned off.Recommended connection is
network_cli
.This module also works with
local
connections for legacy playbooks.
Examples
- name: NTP AUTH test
hosts: cloudengine
connection: local
gather_facts: no
tasks:
- name: "Configure ntp authentication key-id"
community.network.ce_ntp_auth:
key_id: 32
auth_mode: md5
auth_pwd: 11111111111111111111111
- name: "Configure ntp authentication key-id and trusted authentication keyid"
community.network.ce_ntp_auth:
key_id: 32
auth_mode: md5
auth_pwd: 11111111111111111111111
trusted_key: enable
- name: "Configure ntp authentication key-id and authentication enable"
community.network.ce_ntp_auth:
key_id: 32
auth_mode: md5
auth_pwd: 11111111111111111111111
authentication: enable
- name: "Unconfigure ntp authentication key-id and trusted authentication keyid"
community.network.ce_ntp_auth:
key_id: 32
state: absent
- name: "Unconfigure ntp authentication key-id and authentication enable"
community.network.ce_ntp_auth:
key_id: 32
authentication: enable
state: absent
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
check to see if a change was made on the device Returned: always Sample: |
|
k/v pairs of ntp authentication after module execution Returned: always Sample: |
|
k/v pairs of existing ntp authentication Returned: always Sample: |
|
k/v pairs of parameters passed into module Returned: always Sample: |
|
state as sent in from the playbook Returned: always Sample: |
|
command sent to the device Returned: always Sample: |