cisco.mso.mso_schema_template_deploy_status – Check query of objects before deployment to site
Note
This plugin is part of the cisco.mso collection (version 1.2.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
.
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 | Choices/Defaults | Comments |
---|---|---|
host
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.
aliases: hostname |
|
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.
|
|
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.
|
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.
aliases: name |
|
site
string
|
The name of the site.
|
|
state
string
|
|
Use
query for listing query of objects.
|
template
string
|
The name of the template.
|
|
timeout
integer
|
Default:
30
|
The socket level timeout in 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
no , 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.
|
use_ssl
boolean
|
|
If
no , 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.
|
username
string
|
Default:
"admin"
|
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
no , SSL certificates will not be validated.
This should only set to
no 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.
|
Notes
Note
- Please read the mso_guide for more detailed information on how to manage your MSO infrastructure using Ansible.
- 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 delegate_to: localhost 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 delegate_to: localhost 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 delegate_to: localhost 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 delegate_to: localhost register: query_result
Authors
- Shreyas Srish (@shrsr)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/cisco/mso/mso_schema_template_deploy_status_module.html