cisco.mso.ndo_pod_settings module – Manage Pod 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_pod_settings.

New in cisco.mso 2.11.0

Synopsis
Requirements
Parameters
Notes
See Also
Examples

Synopsis

Manage Pod 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 Pod 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.
macsec_policy dictionary	The MACsec Policy to be used. This parameter is mutually exclusive with `macsec_policy_uuid`. Providing an empty dictionary `macsec_policy={}` will remove the MACsec Policy from the Pod Settings.
name string	The name of the MACsec Policy to be used.
macsec_policy_uuid string	The UUID of the MACsec Policy to be used. Providing an empty string `macsec_policy_uuid=""` will remove the MACsec Policy from the Pod Settings. This parameter is mutually exclusive with `macsec_policy`.
name aliases: pod_settings string	The name of the Pod Settings.
ntp_policy dictionary	The NTP Policy to be used. This parameter is mutually exclusive with `ntp_policy_uuid`. Providing an empty dictionary `ntp_policy={}` will remove the NTP Policy from the Pod Settings.
name string	The name of the NTP Policy to be used.
ntp_policy_uuid string	The UUID of the NTP Policy to be used. Providing an empty string `ntp_policy_uuid=""` will remove the NTP Policy from the Pod Settings. This parameter is mutually exclusive with `ntp_policy`.
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.
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	The name of the template. The template must be a Fabric Policy template. This parameter or `template_id` is required.
template_id string	The ID of the template. The template must be a 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: pod_settings_uuid string	The UUID of the Pod 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.
The macsec_policy or macsec_policy_uuid must exist before using it with this module in your playbook. Use cisco.mso.ndo_macsec_policy to create the MACsec Policy.
The ntp_policy or ntp_policy_uuid must exist before using it with this module in your playbook. Use cisco.mso.ndo_ntp_policy to create the NTP Policy.
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 Pod Settings
  cisco.mso.ndo_pod_settings:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_test
    name: ansible_pod_settings
    state: present
  register: create_pod_settings

- name: Update Pod Settings
  cisco.mso.ndo_pod_settings:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_test
    name: ansible_pod_settings
    description: Updated Pod Settings
    macsec_policy:
      name: ansible_macsec_policy
    ntp_policy:
      name: ansible_ntp_policy
    state: present

- name: Update the Pod Settings using UUID
  cisco.mso.ndo_pod_settings:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_test
    uuid: "{{ create_pod_settings.current.uuid }}"
    macsec_policy_uuid: "{{ create_macsec_policy.current.uuid }}"
    ntp_policy_uuid: "{{ create_ntp_policy.current.uuid }}"
    state: present

- name: Query the Pod Settings using name
  cisco.mso.ndo_pod_settings:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_test
    name: ansible_pod_settings
    state: query
  register: query_with_name

- name: Query the Pod Settings using UUID
  cisco.mso.ndo_pod_settings:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_test
    uuid: "{{ create_pod_settings.current.uuid }}"
    state: query
  register: query_with_uuid

- name: Query all Pod Settings in a template
  cisco.mso.ndo_pod_settings:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_test
    state: query
  register: query_all_objects

- name: Delete the Pod Settings using Name
  cisco.mso.ndo_pod_settings:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_test
    name: ansible_pod_settings
    state: absent

- name: Delete the Pod Settings using UUID
  cisco.mso.ndo_pod_settings:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template_id: ansible_test
    uuid: "{{ create_pod_settings.current.uuid }}"
    state: absent

Authors

Akini Ross (@akinross)

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