W3cubDocs

/Ansible

cisco.mso.ndo_ptp_policy module – Manage PTP Policies 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_ptp_policy.

Synopsis
Requirements
Parameters
Notes
See Also
Examples

Synopsis

Manage Precision Time Protocol (PTP) Policies 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	The administrative state of the PTP Policy. Choices: `"enabled"` `"disabled"`
description string	The description of the PTP Policy.
fabric_announce_interval integer	Fabric announce interval for the PTP policy. The value should be between 0 to 4. This is required when `state=present`.
fabric_announce_timeout integer	Fabric announce timeout for the PTP policy. The value should be between 2 to 10. This is required when `state=present`.
fabric_delay_interval integer	Fabric delay interval for the PTP policy. The value should be between -3 to 5. This is required when `state=present`.
fabric_profile_template string	Fabric profile template for the PTP policy. Choices: `"aes67_2015"` `"default"` `"smpte_2059_2"`
fabric_sync_interval integer	Fabric synchronization interval for the PTP Policy. The value should be between -4 to 1. This is required when `state=present`.
global_domain integer	Global domain number for the PTP Policy. The value should be between 1 to 128. This is required when `state=present`.
global_priority1 integer	Priority 1 for the PTP Policy. The value should be between 1 to 255. This is required when `state=present`.
global_priority2 integer	Priority 2 for the PTP Policy. The value should be between 1 to 255. This is required when `state=present`.
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.
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.
ptp_policy aliases: name string	The name of the PTP policy.
ptp_policy_uuid aliases: uuid string	The UUID of the PTP policy. This parameter is required when the `ptp_policy` needs to be updated.
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"`
template string / required	The name of the template. The template must be a fabric policy template.
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.
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. The cisco.mso.ndo_template module can be used for this.
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 PTP policy
  cisco.mso.ndo_ptp_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_fabric_policy_template
    ptp_policy: ansible_test_ptp_policy
    admin_state: enabled
    fabric_sync_interval: -3
    global_domain: 0
    fabric_delay_interval: -2
    global_priority1: 255
    global_priority2: 255
    fabric_announce_timeout: 3
    fabric_announce_interval: 1
    fabric_profile_template: aes67_2015
    state: present
  register: create_ptp

- name: Query a PTP policy with ptp_policy name
  cisco.mso.ndo_ptp_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_fabric_policy_template
    ptp_policy: ansible_test_ptp_policy
    state: query
  register: query_one

- name: Query a PTP policy with ptp_policy UUID
  cisco.mso.ndo_ptp_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_fabric_policy_template
    ptp_policy_uuid: "{{ create_ptp.current.uuid }}"
    state: query
  register: query_one_uuid

- name: Update a PTP policy name with UUID
  cisco.mso.ndo_ptp_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    ptp_policy: ansible_test_ptp_policy_updated
    ptp_policy_uuid: "{{ create_ptp.current.uuid }}"
    state: present

- name: Delete a PTP policy
  cisco.mso.ndo_ptp_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_test_ptp_policy_updated
    ptp_policy: ansible_test_ptp_policy
    state: absent

- name: Delete a PTP policy using UUID
  cisco.mso.ndo_ptp_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_fabric_policy_template
    ptp_policy_uuid: "{{ query_one.current.uuid }}"
    state: absent

Authors

Shreyas Srish (@shrsr)

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_ptp_policy_module.html