FileMgr

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

✕ Tutup

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

# Copyright: (c) 2020, Anvitha Jain (@anvitha-jain) <anvjain@cisco.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_rest
short_description: Direct access to the Cisco MSO REST API
description:
- Enables the management of the Cisco MSO fabric through direct access to the Cisco MSO REST API.
- This module is not idempotent and does not report changes.
options:
  method:
    description:
    - The HTTP method of the request.
    - Using C(delete) is typically used for deleting objects.
    - Using C(get) is typically used for querying objects.
    - Using C(post) is typically used for modifying objects.
    - Using C(put) is typically used for modifying existing objects.
    - Using C(patch) is typically also used for modifying existing objects.
    type: str
    choices: [ delete, get, post, put, patch ]
    default: get
    aliases: [ action ]
  path:
    description:
    - URI being used to execute API calls.
    type: str
    required: true
    aliases: [ uri ]
  content:
    description:
    - Sets the payload of the API request directly.
    - This may be convenient to template simple requests.
    - For anything complex use the C(template) lookup plugin (see examples).
    type: raw
    aliases: [ payload ]
extends_documentation_fragment:
- cisco.mso.modules

notes:
- Most payloads are known not to be idempotent, so be careful when constructing payloads.
seealso:
- module: cisco.mso.mso_tenant
author:
- Anvitha Jain (@anvitha-jain)
"""

EXAMPLES = r"""
- name: Add schema (JSON)
  cisco.mso.mso_rest:
    host: mso
    username: admin
    password: SomeSecretPassword
    path: /mso/api/v1/schemas
    method: post
    content:
      {
          "displayName": "{{ mso_schema | default('ansible_test') }}",
          "templates": [{
              "name": "Template_1",
              "tenantId": "{{ add_tenant.jsondata.id }}",
              "displayName": "Template_1",
              "templateSubType": [],
              "templateType": "stretched-template",
              "anps": [],
              "contracts": [],
              "vrfs": [],
              "bds": [],
              "filters": [],
              "externalEpgs": [],
              "serviceGraphs": [],
              "intersiteL3outs": []
          }],
          "sites": [],
          "_updateVersion": 0
      }
  delegate_to: localhost

- name: Query schema
  cisco.mso.mso_rest:
    host: mso
    username: admin
    password: SomeSecretPassword
    path: /mso/api/v1/schemas
    method: get
  delegate_to: localhost

- name: Patch schema (YAML)
  cisco.mso.mso_rest:
    host: mso
    username: admin
    password: SomeSecretPassword
    path: "/mso/api/v1/schemas/{{ add_schema.jsondata.id }}"
    method: patch
    content:
      - op: add
        path: /templates/Template_1/anps/-
        value:
          name: AP2
          displayName: AP2
          epgs: []
        _updateVersion: 0
  delegate_to: localhost

- name: Add a tenant from a templated payload file from templates
  cisco.mso.mso_rest:
    host: mso
    username: admin
    password: SomeSecretPassword
    method: post
    path: /api/v1/tenants
    content: "{{ lookup('template', 'mso/tenant.json.j2') }}"
  delegate_to: localhost
"""

RETURN = r"""
"""

# Optional, only used for YAML validation
try:
    import yaml

HAS_YAML = True
except Exception:
    HAS_YAML = False

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

def main():
    argument_spec = mso_argument_spec()
    argument_spec.update(
        path=dict(type="str", required=True, aliases=["uri"]),
        method=dict(type="str", default="get", choices=["delete", "get", "post", "put", "patch"], aliases=["action"]),
        content=dict(type="raw", aliases=["payload"]),
    )

module = AnsibleModule(
        argument_spec=argument_spec,
    )

content = module.params.get("content")
    path = module.params.get("path")

mso = MSOModule(module)

# Validate content/payload
    if content and isinstance(content, str) and HAS_YAML:
        try:
            # Validate YAML/JSON string
            content = yaml.safe_load(content)
        except Exception as e:
            module.fail_json(msg="Failed to parse provided JSON/YAML payload: %s" % to_text(e), exception=to_text(e), payload=content)

mso.method = mso.params.get("method").upper()

# Perform request
    if module.check_mode:
        mso.result["jsondata"] = content
    else:
        mso.result["jsondata"] = mso.request(path, method=mso.method, data=content, api_version=None)

mso.result["status"] = mso.status

if mso.method != "GET":
        mso.result["changed"] = True
        if mso.method == "DELETE":
            mso.result["jsondata"] = None

# Report success
    mso.exit_json(**mso.result)

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