cisco.mso.ndo_synce_interface_policy module – Manage syncE Interface 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_synce_interface_policy.

Synopsis
Requirements
Parameters
Notes
Examples

Synopsis

Manage syncE Interface 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 syncE Interface Policy. The default value is disabled. Choices: `"enabled"` `"disabled"`
description string	The description of the syncE Interface 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.
interface_policy aliases: name string	The name of the syncE Interface Policy.
interface_policy_uuid aliases: uuid string	The uuid of the syncE Interface Policy. This parameter is required when the `interface_policy` needs to be updated.
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.
selection_input string	The selection input of the syncE Interface Policy. The default value is disabled. Choices: `"enabled"` `"disabled"`
src_priority integer	The source priority of the syncE Interface Policy. The value must be an integer between 1 and 254. The default value is 100.
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"`
sync_state_msg string	The sync state message of the syncE Interface Policy. The default value is enabled. Choices: `"enabled"` `"disabled"`
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`
wait_to_restore integer	The delay before attempting to restore synchronization on a SyncE interface after a disruption. The value must be an integer between 0 and 12. The default value is 5.

Notes

Note

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 syncE interface policy
  cisco.mso.ndo_synce_interface_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_fabric_policy_template
    interface_policy: ansible_test_interface_policy
    admin_state: enabled
    sync_state_msg: enabled
    selection_input: enabled
    src_priority: 100
    wait_to_restore: 5
    state: present
  register: create

- name: Query a syncE interface policy with interface_policy name
  cisco.mso.ndo_synce_interface_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_fabric_policy_template
    interface_policy: ansible_test_interface_policy
    state: query
  register: query_one

- name: Query all syncE interface policies in the template
  cisco.mso.ndo_synce_interface_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_fabric_policy_template
    state: query
  register: query_all

- name: Query a syncE interface policy with interface_policy UUID
  cisco.mso.ndo_synce_interface_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_fabric_policy_template
    interface_policy_uuid: '{{ create.current.uuid }}'
    state: query
  register: query_one_by_uuid

- name: Delete a syncE interface policy
  cisco.mso.ndo_synce_interface_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_fabric_policy_template
    interface_policy: ansible_test_interface_policy
    state: absent

Authors

Anvitha Jain (@anvjain)

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