cisco.mso.mso_schema_template_deploy_status module – Check query of objects before deployment to site
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.mso_schema_template_deploy_status
.
Synopsis
Check query of objects in a template of a schema
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 name of the schema. |
|
The name of the site. |
|
Use Choices:
|
|
The name of the template. |
|
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: Query status of objects in a template
cisco.mso.mso_schema_template_deploy_status:
host: mso_host
username: admin
password: SomeSecretPassword
schema: Schema 1
template: Template 1
state: query
register: query_result
- name: Query status of objects using site
cisco.mso.mso_schema_template_deploy_status:
host: mso_host
username: admin
password: SomeSecretPassword
schema: Schema 1
site: ansible_test
state: query
register: query_result
- name: Query status of objects in a template associated with a site
cisco.mso.mso_schema_template_deploy_status:
host: mso_host
username: admin
password: SomeSecretPassword
schema: Schema 1
template: Template 1
site: ansible_test
state: query
register: query_result
- name: Query status of objects in all templates
cisco.mso.mso_schema_template_deploy_status:
host: mso_host
username: admin
password: SomeSecretPassword
schema: Schema 1
state: query
register: query_result