cisco.mso.ndo_node_setting module – Manage Fabric Policy Node Settings on Cisco Nexus Dashboard Orchestrator (NDO).

Note

This module is part of the cisco.mso collection (version 2.13.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_node_setting.

Synopsis
Requirements
Parameters
Notes
See Also
Examples

Synopsis

Manage Fabric Policy Node Settings 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
description string	The description of the Fabric Policy Node Settings.
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.
name aliases: node_setting string	The name of the Fabric Policy Node Settings.
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 dictionary	The Precision Time Protocol (PTP) of the Fabric Policy Node Settings.
node_domain integer	The node domain number of the PTP Settings. The value must be between 24 and 43.
priority_2 integer	The value that is used when advertising this clock. The value must be between 0 and 255, lower values are prioritized. The PTP priority 1 is set to a fixed value of 128.
state string	Use `enabled` to configure the PTP Settings. Both `ptp.node_domain` and `ptp.priority_2` are required when the state is `enabled`. Use `disabled` to remove the PTP Settings. 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"`
synce dictionary	The Synchronous Ethernet (SyncE) Interface Policy of the Fabric Policy Node Settings.
admin_state string	The administrative state of the SyncE Interface Policy. Choices: `"enabled"` `"disabled"`
quality_level string	The quality level option of the SyncE Interface Policy. Choices: `"option_1"` `"option_2_generation_1"` `"option_2_generation_2"`
state string	Use `enabled` to configure the SyncE Interface Policy. Both `synce.admin_state` and `synce.quality_level` are required when the state is `enabled`. Use `disabled` to remove the SyncE Interface Policy. Choices: `"enabled"` `"disabled"`
template aliases: fabric_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.
uuid aliases: node_setting_uuid string	The UUID of the Fabric Policy Node Settings. This parameter is required when the `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 Fabric Policy Node Setting
  cisco.mso.ndo_node_setting:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: fabric_template
    name: ns1
    state: present
  register: create_ns1

- name: Add SyncE config to the existing Fabric Policy Node Setting using Name
  cisco.mso.ndo_node_setting:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: fabric_template
    name: ns1
    synce:
      admin_state: enabled
      quality_level: option_2_generation_1
    state: present

- name: Add PTP config to the existing Fabric Policy Node Setting using UUID
  cisco.mso.ndo_node_setting:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: fabric_template
    uuid: "{{ create_ns1.current.uuid }}"
    name: ns1_updated
    ptp:
      node_domain: 25
      priority_2: 100
    state: present

- name: Query an existing Fabric Policy Node Setting using UUID
  cisco.mso.ndo_node_setting:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: fabric_template
    uuid: "{{ create_ns1.current.uuid }}"
    state: query
  register: query_with_uuid

- name: Query an existing Fabric Policy Node Setting using Name
  cisco.mso.ndo_node_setting:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: fabric_template
    name: ns1_updated
    state: query
  register: query_with_name

- name: Query all Fabric Policy Node Setting
  cisco.mso.ndo_node_setting:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: fabric_template
    state: query
  register: query_all

- name: Delete an existing Fabric Policy Node Setting using UUID
  cisco.mso.ndo_node_setting:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: fabric_template
    uuid: "{{ create_ns1.current.uuid }}"
    state: absent

- name: Delete an existing Fabric Policy Node Setting using Name
  cisco.mso.ndo_node_setting:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: fabric_template
    name: ns1_updated
    state: absent

Authors

Sabari Jaganathan (@sajagana)

Collection links

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