cisco.mso.ndo_template_deploy module – Deploy templates to sites 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_template_deploy.

New in cisco.mso 2.13.0

Synopsis

• Deploy templates to sites.

• Prior to deploy or redeploy a schema validation is executed.

• When schema validation fails, cisco.mso.ndo_template_deploy fails and deploy or redeploy will not be executed.

• Only supports NDO v3.7 and higher

Aliases: ndo_schema_template_deploy

Requirements

The below requirements are needed on the host that executes this module.

• Multi Site Orchestrator v2.1 or newer

Parameters

Parameter	Comments
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.
schema string	The name of the schema.
schema_id string	The ID of the schema.
sites list / elements=string	The list of site names where the template will be undeployed. This option is required when state=undeploy.
state string	Use deploy to deploy a template. Use redeploy to redeploy a template. Use undeploy to undeploy a template from specified sites. Use undeploy_all to undeploy a template from all sites. Use query to get deployment status. Choices: "deploy" ← (default) "redeploy" "undeploy" "undeploy_all" "query"
template string	The name of the template. This parameter or template_id is required.
template_id string	The ID of the template. This parameter or template is required.
template_type aliases: type string	The type of the template. template_type is ignored when template_id is provided. Choices: "tenant" "l3out" "application" ← (default) "fabric_policy" "fabric_resource" "monitoring_tenant" "monitoring_access" "service_device"
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. Use cisco.mso.ndo_template to create non-schema templates. Use cisco.mso.mso_schema_template to create schema/application templates.

• This module was written to support Multi Site Orchestrator v2.1 or newer. Some or all functionality may not work on earlier versions.

See Also

See also

cisco.mso.mso_schema_site

Manage sites in schemas.

cisco.mso.mso_schema_template

Manage templates in schemas.

cisco.mso.ndo_template

Manage Templates on Cisco Nexus Dashboard Orchestrator (NDO).

Examples

- name: Deploy a schema template
  cisco.mso.ndo_template_deploy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    schema: Schema 1
    template: Template 1
    state: deploy

- name: Deploy a fabric policy template
  cisco.mso.ndo_template_deploy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: Fabric Policy 1
    type: fabric_policy
    state: deploy

- name: Redeploy a schema template
  cisco.mso.ndo_template_deploy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    schema: Schema 1
    template: Template 1
    state: redeploy

- name: Redeploy a fabric policy template using template id
  cisco.mso.ndo_template_deploy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template_id: '{{ fabric_policy_1.current.templateId }}'
    state: deploy

- name: Undeploy a schema template
  cisco.mso.ndo_template_deploy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    schema: Schema 1
    template: Template 1
    sites: [Site1, Site2]
    state: undeploy

- name: Undeploy a fabric policy template from all sites
  cisco.mso.ndo_template_deploy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: Fabric Policy 1
    type: fabric_policy
    state: undeploy_all

- name: Undeploy a fabric policy template from one site
  cisco.mso.ndo_template_deploy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: Fabric Policy 1
    type: fabric_policy
    sites: [Site1]
    state: undeploy

- name: Query a schema template deploy status
  cisco.mso.ndo_template_deploy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    schema: Schema 1
    template: Template 1
    state: query
  register: query_result

- name: Query a fabric policy template deploy status
  cisco.mso.ndo_template_deploy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: Fabric Policy 1
    type: fabric_policy
    state: query
  register: query_result

Authors

• Akini Ross (@akinross)

• Samita Bhattacharjee (@samiib)

Collection links

• Issue Tracker
• Homepage
• Repository (Sources)