W3cubDocs

/Ansible

cisco.mso.ndo_ntp_policy module – Manage NTP Policies in Fabric Policy Templates on Cisco Nexus Dashboard Orchestrator (NDO).

Note

This module is part of the cisco.mso collection (version 2.11.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.mso. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: cisco.mso.ndo_ntp_policy.

Synopsis
Requirements
Parameters
Notes
See Also
Examples

Synopsis

Manage NTP (NTP) Policies in Fabric Policy Templates on Cisco Nexus Dashboard Orchestrator (NDO).
This module is only supported on ND v3.1 (NDO v4.3) and later.

Requirements

The below requirements are needed on the host that executes this module.

Multi Site Orchestrator v2.1 or newer

Parameters

Parameter	Comments
admin_state string	Enable admin state. The default value is `admin_state=enabled`. Choices: `"enabled"` `"disabled"`
authentication_state string	Enable authentication state. The default value is `authentication_state=disabled`. Choices: `"enabled"` `"disabled"`
description string	The description of the NTP Policy. Providing an empty string will remove the `description=""` from the NTP Policy.
host aliases: hostname string	IP Address or hostname of the ACI Multi Site Orchestrator host. If the value is not specified in the task, the value of environment variable `MSO_HOST` will be used instead.
login_domain string	The login domain name to use for authentication. The default value is Local. If the value is not specified in the task, the value of environment variable `MSO_LOGIN_DOMAIN` will be used instead. When using a HTTPAPI connection plugin the inventory variable `ansible_httpapi_login_domain` will be used if this attribute is not specified.
master_mode string	Enable master mode. The default value is `master_mode=disabled`. Choices: `"enabled"` `"disabled"`
name aliases: ntp_policy string	The name of the NTP Policy.
ntp_keys list / elements=dictionary	The list of NTP client authentication keys. Providing a new list of `ntp_keys` will completely replace an existing one from the NTP Policy. Providing an empty list will remove the `ntp_keys=[]` from the NTP Policy.
authentication_type string	The type of authentication. The default value is `ntp_keys.authentication_type=md5`. Choices: `"md5"` `"sha1"`
id aliases: key_id integer / required	The key’s ID. The value must be between 1 and 65535.
key string	The key. Up to 40 alphanumerical characters.
trusted boolean	Set the NTP client authentication key to trusted. Choices: `false` `true`
ntp_providers list / elements=dictionary	The list of NTP providers. Providing a new list of `ntp_providers` will completely replace an existing one from the NTP Policy. Providing an empty list will remove the `ntp_providers=[]` from the NTP Policy.
authentication_key_id aliases: key_id integer	The NTP authentication key ID. The value must be between 1 and 65535.
host string / required	The hostname or IP address of the NTP provider.
management_epg aliases: epg string / required	The management EPG.
management_epg_type aliases: epg_type string / required	The type of the management EPG. Choices: `"inb"` `"oob"`
maximum_poll_interval aliases: max_poll integer	The maximum polling interval value. The default value is `ntp_providers.maximum_poll_interval=6`. The value must be between 4 and 16.
minimum_poll_interval aliases: min_poll integer	The minimum polling interval value. The default value is `ntp_providers.minimum_poll_interval=4`. The value must be between 4 and 16.
preferred boolean	Set the NTP provider to preferred. Choices: `false` `true`
output_level string	Influence the output of this MSO module. `normal` means the standard output, incl. `current` dict `info` adds informational output, incl. `previous`, `proposed` and `sent` dicts `debug` adds debugging output, incl. `filter_string`, `method`, `response`, `status` and `url` information If the value is not specified in the task, the value of environment variable `MSO_OUTPUT_LEVEL` will be used instead. Choices: `"debug"` `"info"` `"normal"` ← (default)
password string	The password to use for authentication. If the value is not specified in the task, the value of environment variables `MSO_PASSWORD` or `ANSIBLE_NET_PASSWORD` will be used instead.
port integer	Port number to be used for the REST connection. The default value depends on parameter `use_ssl`. If the value is not specified in the task, the value of environment variable `MSO_PORT` will be used instead.
server_state string	Enable server state. The default value is `server_state=disabled`. Choices: `"enabled"` `"disabled"`
state string	Use `absent` for removing. Use `query` for listing an object or multiple objects. Use `present` for creating or updating. Choices: `"absent"` `"query"` ← (default) `"present"`
stratum integer	The numerical value of the stratum. The default value is `stratum=4`. The value must be between 1 and 14.
template aliases: fabric_policy_template string	The name of the Fabric Policy template. This parameter or `template_id` is required.
template_id aliases: fabric_policy_template_id string	The ID of the Fabric Policy template. This parameter or `template` is required.
timeout integer	The socket level timeout in seconds. The default value is 30 seconds. If the value is not specified in the task, the value of environment variable `MSO_TIMEOUT` will be used instead.
use_proxy boolean	If `false`, it will not use a proxy, even if one is defined in an environment variable on the target hosts. If the value is not specified in the task, the value of environment variable `MSO_USE_PROXY` will be used instead. The default is `true`. Choices: `false` `true`
use_ssl boolean	If `false`, an HTTP connection will be used instead of the default HTTPS connection. If the value is not specified in the task, the value of environment variable `MSO_USE_SSL` will be used instead. When using a HTTPAPI connection plugin the inventory variable `ansible_httpapi_use_ssl` will be used if this attribute is not specified. The default is `false` when using a HTTPAPI connection plugin (mso or nd) and `true` when using the legacy connection method (only for mso). Choices: `false` `true`
username string	The username to use for authentication. If the value is not specified in the task, the value of environment variables `MSO_USERNAME` or `ANSIBLE_NET_USERNAME` will be used instead.
uuid aliases: ntp_policy_uuid string	The UUID of the NTP Policy. This parameter is required when the NTP Policy `name` needs to be updated.
validate_certs boolean	If `false`, SSL certificates will not be validated. This should only set to `false` when used on personally controlled sites using self-signed certificates. If the value is not specified in the task, the value of environment variable `MSO_VALIDATE_CERTS` will be used instead. The default is `true`. Choices: `false` `true`

Notes

Note

The template must exist before using this module in your playbook. Use cisco.mso.ndo_template to create the Fabric Policy template.
This module was written to support Multi Site Orchestrator v2.1 or newer. Some or all functionality may not work on earlier versions.

Examples

- name: Create a new NTP Policy object
  cisco.mso.ndo_ntp_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: fabric_policy_template
    name: ntp_policy_1
    ntp_keys:
      - id: 1
        key: my_key
        authentication_type: md5
        trusted: true
    ntp_providers:
      - host: background
        minimum_poll_interval: 4
        maximum_poll_interval: 16
        management_epg_type: oob
        management_epg: default
        preferred: true
        authentication_key_id: 1
    admin_state: enabled
    server_state: enabled
    master_mode: enabled
    stratum: 4
    authentication_state: enabled
    state: present
  register: ntp_policy_1

- name: Update a NTP Policy object name with UUID
  cisco.mso.ndo_ntp_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: fabric_policy_template
    name: ntp_policy_2
    uuid: "{{ ntp_policy_1.current.uuid }}"
    state: present

- name: Query a NTP Policy object with name
  cisco.mso.ndo_ntp_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: fabric_policy_template
    name: ntp_policy_2
    state: query
  register: query_name

- name: Query a NTP Policy object with UUID
  cisco.mso.ndo_ntp_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: fabric_policy_template
    uuid: "{{ ntp_policy_1.current.uuid }}"
    state: query
  register: query_uuid

- name: Query all NTP Policy objects in a Fabric Policy Template
  cisco.mso.ndo_ntp_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: fabric_policy_template
    state: query
  register: query_all

- name: Delete a NTP Policy object with name
  cisco.mso.ndo_ntp_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: fabric_policy_template
    name: ntp_policy_2
    state: absent

- name: Delete a NTP Policy object with UUID
  cisco.mso.ndo_ntp_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: fabric_policy_template
    uuid: "{{ ntp_policy_1.current.uuid }}"
    state: absent

Authors

Gaspard Micol (@gmicol)

Collection links

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/cisco/mso/ndo_ntp_policy_module.html