Documentation

nxos_ntp - Manages core NTP configuration.

New in version 2.2.

Synopsis

  • Manages core NTP configuration.

Options

parameter required default choices comments
host
yes
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
key_id
no
Authentication key identifier to use with given NTP server or peer.
password
no
Specifies the password to use to authenticate the connection to the remote device. This is a common argument used for either cli or nxapi transports. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
peer
no
Network address of NTP peer.
port
no 0 (use common port)
Specifies the port to use when building the connection to the remote device. This value applies to either cli or nxapi. The port value will default to the appropriate transport common port if none is provided in the task. (cli=22, http=80, https=443).
prefer
no
  • enabled
  • disabled
Makes given NTP server or peer the preferred NTP server or peer for the device.
provider
no
Convenience method that allows all nxos arguments to be passed as a dict object. All constraints (required, choices, etc) must be met either by individual arguments or values in this dict.
server
no
Network address of NTP server.
source_addr
no
Local source address from which NTP messages are sent.
source_int
no
Local source interface from which NTP messages are sent. Must be fully qualified interface name.
ssh_keyfile
no
Specifies the SSH key to use to authenticate the connection to the remote device. This argument is only used for the cli transport. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_SSH_KEYFILE will be used instead.
state
no present
  • present
  • absent
Manage the state of the resource.
timeout
(added in 2.3)
no 10
Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. NX-API can be slow to return on long-running commands (sh mac, sh bgp, etc).
transport
yes cli
Configures the transport connection to use when connecting to the remote device. The transport argument supports connectivity to the device over cli (ssh) or nxapi.
use_ssl
no
  • yes
  • no
Configures the transport to use SSL if set to true only when the transport=nxapi, otherwise this value is ignored.
username
no
Configures the username to use to authenticate the connection to the remote device. This value is used to authenticate either the CLI login or the nxapi authentication depending on which transport is used. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
validate_certs
no
  • yes
  • no
If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. If the transport argument is not nxapi, this value is ignored.
vrf_name
no
Makes the device communicate with the given NTP server or peer over a specific VRF.

Examples

# Set NTP Server with parameters
- 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 Return Values, the following are the fields unique to this module:

name description returned type sample
end_state k/v pairs of ntp info after module execution always dict {'source': '3.3.3.3', 'source_type': 'source', 'key_id': '48', 'peer_type': 'server', 'address': '2.2.2.2', 'prefer': 'enabled'}
changed check to see if a change was made on the device always boolean True
updates command sent to the device always list ['ntp server 2.2.2.2 prefer key 48', 'no ntp source-interface ethernet2/1', 'ntp source 3.3.3.3']
proposed k/v pairs of parameters passed into module always dict {'source': '3.3.3.3', 'source_type': 'source', 'key_id': '48', 'peer_type': 'server', 'address': '2.2.2.2', 'prefer': 'enabled'}
existing ['k/v pairs of existing ntp server/peer'] always dict {'source': 'ethernet2/1', 'source_type': 'source-interface', 'key_id': '32', 'peer_type': 'server', 'address': '2.2.2.2', 'prefer': 'enabled'}


Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Support

This module is community maintained without core committer oversight.

For more information on what this means please read Module Support

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.