FileMgr

✏️ /lib/python3.9/site-packages/ansible_collections/cisco/mso/plugins/modules/mso_schema_template.py

✕ Tutup

# -*- coding: utf-8 -*-

# Copyright: (c) 2018, Dag Wieers (@dagwieers) <dag@wieers.com>
# GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt)

from __future__ import absolute_import, division, print_function

__metaclass__ = type

ANSIBLE_METADATA = {"metadata_version": "1.1", "status": ["preview"], "supported_by": "community"}

DOCUMENTATION = r"""
---
module: mso_schema_template
short_description: Manage templates in schemas
description:
- Manage templates on Cisco ACI Multi-Site.
author:
- Dag Wieers (@dagwieers)
options:
  tenant:
    description:
    - The tenant used for this template.
    type: str
    required: true
  schema:
    description:
    - The name of the schema.
    type: str
    required: true
  schema_description:
    description:
    - The description of Schema is supported on versions of MSO that are 3.3 or greater.
    type: str
  template_description:
    description:
    - The description of template is supported on versions of MSO that are 3.3 or greater.
    type: str
  template:
    description:
    - The name of the template.
    type: str
    aliases: [ name ]
  display_name:
    description:
    - The name as displayed on the MSO web interface.
    type: str
  state:
    description:
    - Use C(present) or C(absent) for adding or removing.
    - Use C(query) for listing an object or multiple objects.
    type: str
    choices: [ absent, present, query ]
    default: present
notes:
- Due to restrictions of the MSO REST API this module creates schemas when needed, and removes them when the last template has been removed.
seealso:
- module: cisco.mso.mso_schema
- module: cisco.mso.mso_schema_site
extends_documentation_fragment: cisco.mso.modules
"""

EXAMPLES = r"""
- name: Add a new template to a schema
  cisco.mso.mso_schema_template:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    tenant: Tenant 1
    schema: Schema 1
    template: Template 1
    state: present
  delegate_to: localhost

- name: Remove a template from a schema
  cisco.mso.mso_schema_template:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    tenant: Tenant 1
    schema: Schema 1
    template: Template 1
    state: absent
  delegate_to: localhost

- name: Query a template
  cisco.mso.mso_schema_template:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    tenant: Tenant 1
    schema: Schema 1
    template: Template 1
    state: query
  delegate_to: localhost
  register: query_result

- name: Query all templates
  cisco.mso.mso_schema_template:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    tenant: Tenant 1
    schema: Schema 1
    state: query
  delegate_to: localhost
  register: query_result
"""

RETURN = r"""
"""

from ansible.module_utils.basic import AnsibleModule
from ansible_collections.cisco.mso.plugins.module_utils.mso import MSOModule, mso_argument_spec

def main():
    argument_spec = mso_argument_spec()
    argument_spec.update(
        tenant=dict(type="str", required=True),
        schema=dict(type="str", required=True),
        schema_description=dict(type="str"),
        template_description=dict(type="str"),
        template=dict(type="str", aliases=["name"]),
        display_name=dict(type="str"),
        state=dict(type="str", default="present", choices=["absent", "present", "query"]),
    )

module = AnsibleModule(
        argument_spec=argument_spec,
        supports_check_mode=True,
        required_if=[
            ["state", "absent", ["template"]],
            ["state", "present", ["template"]],
        ],
    )

tenant = module.params.get("tenant")
    schema = module.params.get("schema")
    schema_description = module.params.get("schema_description")
    template_description = module.params.get("template_description")
    template = module.params.get("template")
    if template is not None:
        template = template.replace(" ", "")
    display_name = module.params.get("display_name")
    state = module.params.get("state")

mso = MSOModule(module)

# Get schema
    schema_obj = mso.get_obj("schemas", displayName=schema)

mso.existing = {}
    if schema_obj:
        # Schema exists
        schema_path = "schemas/{id}".format(**schema_obj)

# Get template
        templates = [t.get("name") for t in schema_obj.get("templates")]
        if template:
            if template in templates:
                template_idx = templates.index(template)
                mso.existing = schema_obj.get("templates")[template_idx]
        else:
            mso.existing = schema_obj.get("templates")
    else:
        schema_path = "schemas"

if state == "query":
        if not mso.existing:
            if template:
                mso.fail_json(msg="Template '{0}' not found".format(template))
            else:
                mso.existing = []
        mso.exit_json()

template_path = "/templates/{0}".format(template)
    ops = []

mso.previous = mso.existing
    if state == "absent":
        mso.proposed = mso.sent = {}
        if not schema_obj:
            # There was no schema to begin with
            pass
        elif len(templates) == 1 and mso.existing:
            # There is only one tenant, remove schema
            mso.existing = {}
            if not module.check_mode:
                mso.request(schema_path, method="DELETE")
        elif mso.existing:
            # Remove existing template
            mso.existing = {}
            ops.append(dict(op="remove", path=template_path))

elif state == "present":
        tenant_id = mso.lookup_tenant(tenant)

if display_name is None:
            display_name = mso.existing.get("displayName", template)

if not schema_obj:
            # Schema does not exist, so we have to create it
            payload = dict(
                displayName=schema,
                templates=[
                    dict(
                        name=template,
                        displayName=display_name,
                        tenantId=tenant_id,
                    )
                ],
                sites=[],
            )

if schema_description is not None:
                payload.update(description=schema_description)
            if template_description is not None:
                payload["templates"][0].update(description=template_description)

mso.existing = payload.get("templates")[0]

if not module.check_mode:
                mso.request(schema_path, method="POST", data=payload)

elif mso.existing:
            # Template exists, so we have to update it
            payload = dict(
                name=template,
                displayName=display_name,
                description=template_description,
                tenantId=tenant_id,
            )

mso.sanitize(payload, collate=True)

ops.append(dict(op="replace", path=template_path + "/displayName", value=display_name))
            ops.append(dict(op="replace", path=template_path + "/tenantId", value=tenant_id))

mso.existing = mso.proposed
        else:
            # Template does not exist, so we have to add it
            payload = dict(
                name=template,
                displayName=display_name,
                tenantId=tenant_id,
            )

mso.sanitize(payload, collate=True)

ops.append(dict(op="add", path="/templates/-", value=payload))

mso.existing = mso.proposed

if not module.check_mode:
        mso.request(schema_path, method="PATCH", data=ops)

mso.exit_json()

if __name__ == "__main__":
    main()

Batal

⬅ plugins 67 item

Nama	Tipe	Ukuran	Diubah	Perm	Aksi
📁 __pycache__	dir	—	16/09/24 06:47	0755	📂
🐍 mso_backup.py	py	10.7 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 mso_backup_schedule.py	py	6.4 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 mso_dhcp_option_policy.py	py	4.6 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 mso_dhcp_option_policy_option.py	py	5.4 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 mso_dhcp_relay_policy.py	py	4.5 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 mso_dhcp_relay_policy_provider.py	py	8 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 mso_label.py	py	4 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 mso_remote_location.py	py	7.8 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 mso_rest.py	py	5.1 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 mso_role.py	py	7.1 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 mso_schema.py	py	3.3 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 mso_schema_clone.py	py	3.7 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 mso_schema_site.py	py	4.9 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 mso_schema_site_anp.py	py	6.4 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 mso_schema_site_anp_epg.py	py	9.6 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 mso_schema_site_anp_epg_bulk_staticport.py	py	14.7 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 mso_schema_site_anp_epg_domain.py	py	18.1 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 mso_schema_site_anp_epg_selector.py	py	13 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 mso_schema_site_anp_epg_staticleaf.py	py	7.8 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 mso_schema_site_anp_epg_staticport.py	py	14 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 mso_schema_site_anp_epg_subnet.py	py	8.3 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 mso_schema_site_bd.py	py	6.7 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 mso_schema_site_bd_l3out.py	py	8 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 mso_schema_site_bd_subnet.py	py	8.3 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 mso_schema_site_external_epg.py	py	7.2 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 mso_schema_site_external_epg_selector.py	py	8.9 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 mso_schema_site_l3out.py	py	7.2 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 mso_schema_site_service_graph.py	py	9.1 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 mso_schema_site_vrf.py	py	5.7 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 mso_schema_site_vrf_region.py	py	8.5 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 mso_schema_site_vrf_region_cidr.py	py	9.6 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 mso_schema_site_vrf_region_cidr_subnet.py	py	10.5 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 mso_schema_site_vrf_region_hub_network.py	py	7.6 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 mso_schema_template.py	py	7.5 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 mso_schema_template_anp.py	py	5.7 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 mso_schema_template_anp_epg.py	py	15.1 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 mso_schema_template_anp_epg_contract.py	py	8 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 mso_schema_template_anp_epg_selector.py	py	8.5 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 mso_schema_template_anp_epg_subnet.py	py	7.4 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 mso_schema_template_bd.py	py	16.9 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 mso_schema_template_bd_dhcp_policy.py	py	7.2 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 mso_schema_template_bd_subnet.py	py	7.5 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 mso_schema_template_clone.py	py	7.7 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 mso_schema_template_contract_filter.py	py	17 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 mso_schema_template_contract_service_graph.py	py	12.3 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 mso_schema_template_deploy.py	py	4 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 mso_schema_template_deploy_status.py	py	4.5 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 mso_schema_template_external_epg.py	py	10.8 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 mso_schema_template_external_epg_contract.py	py	7.6 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 mso_schema_template_external_epg_selector.py	py	7.6 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 mso_schema_template_external_epg_subnet.py	py	7.2 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 mso_schema_template_externalepg.py	py	10.8 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 mso_schema_template_filter_entry.py	py	12.3 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 mso_schema_template_l3out.py	py	6.6 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 mso_schema_template_migrate.py	py	6.3 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 mso_schema_template_service_graph.py	py	8.7 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 mso_schema_template_vrf.py	py	6.6 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 mso_schema_template_vrf_contract.py	py	8.7 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 mso_schema_validate.py	py	2 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 mso_service_node_type.py	py	4.5 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 mso_site.py	py	8.5 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 mso_tenant.py	py	6.1 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 mso_tenant_site.py	py	13.2 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 mso_user.py	py	7.9 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 mso_version.py	py	1.5 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 ndo_schema_template_deploy.py	py	4.2 KB	08/11/23 12:12	0644	✏️ ⬇

✏️ Rename

🔑 Ubah Permission