Docs4dev
Docs
ansible / 2.10 / collections / community / network / ce_ntp_module.html

community.network.ce_ntp – Manages core NTP configuration on HUAWEI CloudEngine switches.

Note

This plugin is part of the community.network collection (version 1.3.0).

To install it use: ansible-galaxy collection install community.network.

To use it in a playbook, specify: community.network.ce_ntp.

Synopsis

  • Manages core NTP configuration on HUAWEI CloudEngine switches.

Parameters

Parameter Choices/Defaults Comments
is_preferred
string
    Choices:
  • enable
  • disable
Makes given NTP server or peer the preferred NTP server or peer for the device.
key_id
string
Authentication key identifier to use with given NTP server or peer.
peer
string
Network address of NTP peer.
server
string
Network address of NTP server.
source_int
string
Local source interface from which NTP messages are sent. Must be fully qualified interface name, i.e. 40GE1/0/22, vlanif10. Interface types, such as 10GE, 40GE, 100GE, Eth-Trunk, LoopBack, MEth, NULL, Tunnel, Vlanif.
state
string
    Choices:
  • present ←
  • absent
Manage the state of the resource.
vpn_name
string
Default:
"_public_"
Makes the device communicate with the given NTP server or peer over a specific vpn.

Notes

Note

  • This module requires the netconf system service be enabled on the remote device being managed.
  • Recommended connection is netconf.
  • This module also works with local connections for legacy playbooks.

Examples

- name: NTP test
  hosts: cloudengine
  connection: local
  gather_facts: no
  vars:
    cli:
      host: "{{ inventory_hostname }}"
      port: "{{ ansible_ssh_port }}"
      username: "{{ username }}"
      password: "{{ password }}"
      transport: cli

  tasks:

  - name: "Set NTP Server with parameters"
    community.network.ce_ntp:
      server: 192.8.2.6
      vpn_name: js
      source_int: vlanif4001
      is_preferred: enable
      key_id: 32
      provider: "{{ cli }}"

  - name: "Set NTP Peer with parameters"
    community.network.ce_ntp:
      peer: 192.8.2.6
      vpn_name: js
      source_int: vlanif4001
      is_preferred: enable
      key_id: 32
      provider: "{{ cli }}"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
changed
boolean
always
check to see if a change was made on the device

Sample:
True
end_state
dictionary
always
k/v pairs of ntp info after module execution

Sample:
{'is_preferred': 'enable', 'key_id': '48', 'server': '2.2.2.2', 'source_int': 'vlanif4002', 'vpn_name': 'js'}
existing
dictionary
always
k/v pairs of existing ntp server/peer

Sample:
{'is_preferred': 'disable', 'key_id': '32', 'server': '2.2.2.2', 'source_int': 'vlanif4002', 'vpn_name': 'js'}
proposed
dictionary
always
k/v pairs of parameters passed into module

Sample:
{'is_preferred': 'enable', 'key_id': '48', 'server': '2.2.2.2', 'source_int': 'vlanif4002', 'state': 'present', 'vpn_name': 'js'}
updates
list / elements=string
always
command sent to the device

Sample:
['ntp server 2.2.2.2 authentication-keyid 48 source-interface vlanif4002 vpn-instance js preferred']


Authors

  • Zhijin Zhou (@QijunPan)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/network/ce_ntp_module.html