mso_schema_template_deploy – Deploy schema templates to sites
New in version 2.8.
Synopsis
- Deploy schema templates to sites.
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 / required
|
IP Address or hostname of the ACI Multi Site Orchestrator host.
aliases: hostname |
|
| output_level
string
|
|
Influence the output of this ACI 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
|
| password
string / required
|
The password to use for authentication.
This option is mutual exclusive with private_key. If private_key is provided too, it will be used instead.
|
|
| port
integer
|
Port number to be used for the REST connection.
The default value depends on parameter `use_ssl`.
|
|
| schema
string / required
|
The name of the schema.
|
|
| site
string
|
The name of the site to undeploy.
|
|
| state
string
|
|
Use
deploy to deploy schema template.
Use
status to get deployment status.
Use undeploy to deploy schema template from a site.
|
| template
string
|
The name of the template.
aliases: name |
|
| timeout
integer
|
Default:
30
|
The socket level timeout in seconds.
|
| use_proxy
boolean
|
|
If no, it will not use a proxy, even if one is defined in an environment variable on the target hosts.
|
| use_ssl
boolean
|
|
If no, an HTTP connection will be used instead of the default HTTPS connection.
|
| username
string
|
Default:
"admin"
|
The username to use for authentication.
|
| 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.
|
Notes
Note
- Please read the Cisco ACI Guide for more detailed information on how to manage your ACI infrastructure using Ansible.
- This module was written to support ACI Multi Site Orchestrator v2.1 or newer. Some or all functionality may not work on earlier versions.
See Also
See also
- mso_schema_site – Manage sites in schemas
- The official documentation on the mso_schema_site module.
- mso_schema_template – Manage templates in schemas
- The official documentation on the mso_schema_template module.
Examples
- name: Deploy a schema template
mso_schema_template:
host: mso_host
username: admin
password: SomeSecretPassword
schema: Schema 1
template: Template 1
state: deploy
delegate_to: localhost
- name: Undeploy a schema template
mso_schema_template:
host: mso_host
username: admin
password: SomeSecretPassword
schema: Schema 1
template: Template 1
site: Site 1
state: undeploy
delegate_to: localhost
- name: Get deployment status
mso_schema:
host: mso_host
username: admin
password: SomeSecretPassword
schema: Schema 1
template: Template 1
state: status
delegate_to: localhost
register: status_result
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors
- Dag Wieers (@dagwieers)
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/mso_schema_template_deploy_module.html