W3cubDocs

/Ansible

nxos_ntp_auth - Manages NTP authentication.

New in version 2.2.

Synopsis
Options
Examples
Return Values
Notes
This is a Core Module

Synopsis

Manages NTP authentication.

Options

parameter	required	default	choices	comments
auth_type	no	text	text encrypt	Whether the given md5string is in cleartext or has been encrypted. If in cleartext, the device will encrypt it before storing it.
authentication	no		on off	Turns NTP authentication on or off.
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	yes			Authentication key identifier (numeric).
md5string	yes			MD5 String.
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.
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).
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.
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.
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.
trusted_key	no		true false	Whether the given key is required to be supplied by a time source for the device to synchronize to the time source.
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. The value of username 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.

Examples

# Basic NTP authentication configuration
- nxos_ntp_auth:
    key_id: 32
    md5string: hello
    auth_type: text
    host: {{ inventory_hostname }}
    username: {{ un }}
    password: {{ pwd }}

Return Values

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

name	description	returned	type	sample
state	state as sent in from the playbook	always	string	present
updates	command sent to the device	always	list	['ntp authentication-key 32 md5 helloWorld 0', 'ntp trusted-key 32']
proposed	k/v pairs of parameters passed into module	always	dict	{'auth_type': 'text', 'key_id': '32', 'authentication': 'off', 'trusted_key': 'true', 'md5string': 'helloWorld'}
end_state	k/v pairs of ntp authentication after module execution	always	dict	{'key_id': '32', 'authentication': 'off', 'trusted_key': 'true', 'md5string': 'kapqgWjwdg'}
changed	check to see if a change was made on the device	always	boolean	True
existing	['k/v pairs of existing ntp authentication']		dict	{'authentication': 'off', 'trusted_key': 'false'}

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.

Note

If state=absent and authentication=on, authentication will be turned off.

Note

If state=absent and authentication=off, authentication will be turned on.

This is a Core Module

For more information on what this means please read Core Modules

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

© 2012–2016 Michael DeHaan
© 2016 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/nxos_ntp_auth_module.html