nxos_ntp - Manages core NTP configuration.

New in version 2.2.

Synopsis

Parameters

Parameter Choices/Defaults Comments
key_id
Authentication key identifier to use with given NTP server or peer or keyword 'default'.
peer
Network address of NTP peer.
prefer
    Choices:
  • enabled
  • disabled
Makes given NTP server or peer the preferred NTP server or peer for the device.
provider
Deprecated
Starting with Ansible 2.5 we recommend using connection: network_cli.
This option is only required if you are using NX-API.
For more information please see the NXOS Platform Options guide.
A dict object containing connection details.
username
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.
authorize
bool

(added in 2.5.3)
    Choices:
  • no ←
  • yes
Instructs the module to enter privileged mode on the remote device before sending any commands. If not specified, the device will attempt to execute all commands in non-privileged mode. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_AUTHORIZE will be used instead.
ssh_keyfile
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.
use_proxy
bool

(added in 2.5)
    Choices:
  • no
  • yes ←
If no, the environment variables http_proxy and https_proxy will be ignored.
auth_pass
(added in 2.5.3)
 Default:
none
Specifies the password to use if required to enter privileged mode on the remote device. If authorize is false, then this argument does nothing. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_AUTH_PASS will be used instead.
host
required
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.
timeout
(added in 2.3)
 Default:
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).
use_ssl
bool
    Choices:
  • no ←
  • yes
Configures the transport to use SSL if set to true only when the transport=nxapi, otherwise this value is ignored.
password
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.
validate_certs
bool
    Choices:
  • no
  • yes
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.
port Default:
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).
transport
required
 Default:
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.
server
Network address of NTP server.
source_addr
Local source address from which NTP messages are sent or keyword 'default'
source_int
Local source interface from which NTP messages are sent. Must be fully qualified interface name or keyword 'default'
state
    Choices:
  • present ←
  • absent
Manage the state of the resource.
vrf_name
Makes the device communicate with the given NTP server or peer over a specific VRF or keyword 'default'.

Notes

Note

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, 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
dict
 always
k/v pairs of ntp info after module execution

Sample:
{'source': '192.0.2.3', 'source_type': 'source', 'key_id': '48', 'peer_type': 'server', 'address': '192.0.2.2', 'prefer': 'enabled'}
existing
dict
 always
k/v pairs of existing ntp server/peer

Sample:
{'source': 'ethernet2/1', 'source_type': 'source-interface', 'key_id': '32', 'peer_type': 'server', 'address': '192.0.2.2', 'prefer': 'enabled'}
proposed
dict
 always
k/v pairs of parameters passed into module

Sample:
{'source': '192.0.2.3', 'source_type': 'source', 'key_id': '48', 'peer_type': 'server', 'address': '192.0.2.2', 'prefer': 'enabled'}
updates
list
 always
command sent to the device

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 is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Maintenance

This module is flagged as network which means that it is maintained by the Ansible Network Team. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by the Ansible Network Team, see here.

Support

For more information about Red Hat’s support of this module, please refer to this Knowledge Base article

Author

  • Jason Edelman (@jedelman8)

Hint

If you notice any issues in this documentation you can edit this document to improve it.