cisco.mso.ndo_template module – Manage Templates on Cisco Nexus Dashboard Orchestrator (NDO).
Note
This module is part of the cisco.mso collection (version 2.9.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_template
.
Synopsis
Manage Templates on Cisco Nexus Dashboard Orchestrator (NDO).
Requirements
The below requirements are needed on the host that executes this module.
Multi Site Orchestrator v2.1 or newer
Parameters
Parameter |
Comments |
---|---|
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 |
|
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 When using a HTTPAPI connection plugin the inventory variable |
|
Influence the output of this MSO module.
If the value is not specified in the task, the value of environment variable Choices:
|
|
The password to use for authentication. If the value is not specified in the task, the value of environment variables |
|
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 |
|
The list of sites attached to the template. Required when Set to an empty list Set to null |
|
The name of the site attached to the template. |
|
Use Use Use Choices:
|
|
The name of the template. |
|
The id of the template. This parameter is required when the |
|
The type of the template. Choices:
|
|
The name of the tenant attached to the template. Required when |
|
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 |
|
If If the value is not specified in the task, the value of environment variable The default is Choices:
|
|
If If the value is not specified in the task, the value of environment variable When using a HTTPAPI connection plugin the inventory variable The default is Choices:
|
|
The username to use for authentication. If the value is not specified in the task, the value of environment variables |
|
If This should only set to If the value is not specified in the task, the value of environment variable The default is Choices:
|
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 tenant policy template
cisco.mso.ndo_template:
host: mso_host
username: admin
password: SomeSecretPassword
template: ansible_tenant_policy
template_type: tenant
tenant: ansible_test_tenant
state: present
- name: Create a new l3out policy template
cisco.mso.ndo_template:
host: mso_host
username: admin
password: SomeSecretPassword
template: ansible_l3out_policy_template
template_type: l3out
tenant: ansible_test_tenant
sites:
- name: ansible_test_site
state: present
- name: Query a tenant policy template
cisco.mso.ndo_template:
host: mso_host
username: admin
password: SomeSecretPassword
template: ansible_tenant_policy
template_type: tenant
state: query
register: query_new_tenant_policy_template
- name: Query all tenant policy templates
cisco.mso.ndo_template:
host: mso_host
username: admin
password: SomeSecretPassword
template_type: tenant
state: query
register: query_all
- name: Query all templates
cisco.mso.ndo_template:
host: mso_host
username: admin
password: SomeSecretPassword
state: query
register: query_all
- name: Delete a tenant policy template
cisco.mso.ndo_template:
host: mso_host
username: admin
password: SomeSecretPassword
template: ansible_tenant_policy
template_type: tenant
state: absent