mso_schema – Manage schemas¶
New in version 2.8.
Requirements¶
The below requirements are needed on the host that executes this module.
- Multi Site Orchestrator v2.1 or newer
Parameters¶
Notes¶
Note
- Due to restrictions of the MSO REST API this module cannot create empty schemas (i.e. schemas without templates). Use the mso_schema_template to automatically create schemas with templates.
- 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: Add a new schema
  mso_schema:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    schema: Schema 1
    state: present
    templates:
    - name: Template1
      displayName: Template 1
      tenantId: north_europe
      anps:
        <...>
    - name: Template2
      displayName: Template 2
      tenantId: nort_europe
      anps:
        <...>
  delegate_to: localhost
- name: Remove schemas
  mso_schema:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    schema: Schema 1
    state: absent
  delegate_to: localhost
- name: Query a schema
  mso_schema:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    schema: Schema 1
    state: query
  delegate_to: localhost
  register: query_result
- name: Query all schemas
  mso_schema:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    state: query
  delegate_to: localhost
  register: query_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.
