cisco.nxos.nxos_ntp module – Manages core NTP configuration.

Note

This module is part of the cisco.nxos collection (version 4.0.0).

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 cisco.nxos.

To use it in a playbook, specify: cisco.nxos.nxos_ntp.

New in cisco.nxos 1.0.0

DEPRECATED

Removed in

major release after 2024-01-01

Why

Updated module released with more functionality.

Alternative

nxos_ntp_global

Synopsis

  • Manages core NTP configuration.

Note

This module has a corresponding action plugin.

Parameters

Parameter

Comments

key_id

string

Authentication key identifier to use with given NTP server or peer or keyword ‘default’.

peer

string

Network address of NTP peer.

prefer

string

Makes given NTP server or peer the preferred NTP server or peer for the device.

Choices:

  • "enabled"

  • "disabled"

server

string

Network address of NTP server.

source_addr

string

Local source address from which NTP messages are sent or keyword ‘default’.

source_int

string

Local source interface from which NTP messages are sent. Must be fully qualified interface name or keyword ‘default’

state

string

Manage the state of the resource.

Choices:

  • "present" ← (default)

  • "absent"

vrf_name

string

Makes the device communicate with the given NTP server or peer over a specific VRF or keyword ‘default’.

Notes

Note

  • Limited Support for Cisco MDS

  • For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide <nxos_platform_options>`

  • For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide <network_guide>`

  • For more information on using Ansible to manage Cisco devices see the `Cisco integration page <https://www.ansible.com/integrations/networks/cisco>`_.

Examples

# Set NTP Server with parameters
- cisco.nxos.nxos_ntp:
    server: 1.2.3.4
    key_id: 32
    prefer: enabled
    host: '{{ inventory_hostname }}'
    username: '{{ un }}'
    password: '{{ pwd }}'

Return Values

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

Key

Description

changed

boolean

check to see if a change was made on the device

Returned: always

Sample: true

end_state

dictionary

k/v pairs of ntp info after module execution

Returned: always

Sample: {"address": "192.0.2.2", "key_id": "48", "peer_type": "server", "prefer": "enabled", "source": "192.0.2.3", "source_type": "source"}

existing

dictionary

k/v pairs of existing ntp server/peer

Returned: always

Sample: {"address": "192.0.2.2", "key_id": "32", "peer_type": "server", "prefer": "enabled", "source": "ethernet2/1", "source_type": "source-interface"}

proposed

dictionary

k/v pairs of parameters passed into module

Returned: always

Sample: {"address": "192.0.2.2", "key_id": "48", "peer_type": "server", "prefer": "enabled", "source": "192.0.2.3", "source_type": "source"}

updates

list / elements=string

command sent to the device

Returned: always

Sample: ["ntp server 192.0.2.2 prefer key 48", "no ntp source-interface ethernet2/1", "ntp source 192.0.2.3"]

Status

  • This module will be removed in a major release after 2024-01-01. [deprecated]

  • For more information see DEPRECATED.

Authors

  • Jason Edelman (@jedelman8)