Skip to content

Latest commit

 

History

History
226 lines (187 loc) · 7.39 KB

Trigger Map API -- Open Context Map Of Cisco ACI Device.md

File metadata and controls

226 lines (187 loc) · 7.39 KB
Raw

Trigger Map API Design -- Context Map Of Cisco ACI Device

POST /V1/Triggers/Run

Call this API to trigger a map built by Netbrain from third part software.

Detail Information

Title : Trigger Map And Path API

Version : 02/08/2019.

API Server URL : http(s)://IP address of NetBrain Web API Server/ServicesAPI/API/V1/Triggers/Run

Authentication :

Type In Name
Bearer Authentication Headers Authentication token

Request body(*required)

Name Type Description
domain_setting.tenant_id* string Tenant Id
domain_setting.domain_id* string Domain Id
basic_setting.triggered_by* string Trigger user
basic_setting.user_id string User Id，Not required
basic_setting.user* string User Name
### ### Note: If an external user account is being used, the "user" input value structure should be "autntication_id\username".
basic_setting.device string Device Name
basic_setting.interface string Interface Name，Not required
basic_setting.stub_name* string Stub Name
basic_setting.stub_setting object Stub Setting Information
basic_setting.stub_setting.mode int Triggered Type.
0: Real-Time,
1: On-Demand
map_setting object Map Setting Information
map_setting.map_create_mode* int Create Map Mode.
0: Map Device and Its Neighbors.
1: Open Site Map of the Device.
2: Open Existing Map.
3: Map a Path.
4: Create an Empty Map.
5: Context Map Of Legacy Device
6: Context Map Of Cisco ACI Device
7: Use Qapp to Create a Map
9: Multi devices Create a Map
### ### Note: the map_create_mode input value must corresponding to the predefined map stub trigger type in NetBrain UI system or "Some of the critical MapPath parameters are missing" response would be occured.
map_setting.context_map_cisco_aci_device_para Object parameters of Cisco ACI device context map.
map_setting.context_map_cisco_aci_device_para.apic* string apic parameter of Cisco ACI device.
map_setting.context_map_cisco_aci_device_para.device string device name parameter of Cisco ACI device.
### ### Note: if no value provided at here, legacy device will be set by basic_setting.device.
map_setting.context_map_cisco_aci_device_para.pod_id string pod id parameter of Cisco ACI device.
map_setting.context_map_cisco_aci_device_para.tenant_name string tenant name parameter of Cisco ACI device.
map_setting.context_map_cisco_aci_device_para.vrf_name string vrf name parameter of Cisco ACI device.
map_setting.context_map_cisco_aci_device_para.application_name string application name parameter of Cisco ACI device. 
body = {
    "domain_setting": {
        "tenant_id": "", # can not be null.
        "domain_id": ""  # can not be null.
    },
    "basic_setting": {
        "triggered_by": "", # can not be null.
        "user_id": "",
        "user": "", # can not be null.
        "device": "", # can not be null.
        "interface": "",
        "stub_name": "", # can not be null.
        "stub_setting": {
            "mode": 0,
            "max_waiting_hours": 1
        }
    },
    "map_setting": {
        "map_create_mode": 5,
        "context_map_cisco_aci_device_para": {
            "apic": "",
            "device": "",
            "pod_id": "",
            "tenant_name": "",
            "vrf_name": "",
            "application_name": ""
        }
    }
}

Path Parameters(*required)

No required parameters.

Headers

Data Format Headers

Name Type Description
Content-Type string support "application/json"
Accept string support "application/json"

Authorization Headers

Name Type Description
token string Authentication token, get from login API.

Response

Name Type Description
mapId string The ID of the map which users triggered from third party sofware.
mapName string The name of the map.
mapType string Create Map Mode.
0: Map Device and Its Neighbors.
1: Open Site Map of the Device.
2: Open Existing Map.
3: Map a Path.
4: Create an Empty Map.
mapUrl string The URL link of the map triggered by users.
statusCode integer The returned status code of executing the API.
statusDescription string The explanation of the status code.

Example

{
    'mapId': '5edcf486-108c-63e8-5c30-a6d32941d576',
    'mapName': 'APIExisting',
    'mapType': 1,
    'mapUrl': 'map.html?t=40e0032e-14e7-4fea-7d00-8fe8bd65efae&d=b924c2f0-7210-43ba-9cdd-d1757ae23742&id=5edcf486-108c-63e8-5c30-a6d32941d576&maptype=1',
    'stubName': 'APITest'
}

Full Example:

import requests
import json
import time
import requests.packages.urllib3 as urllib3
 
urllib3.disable_warnings()

token = "b33e987d-0042-4855-b099-5322c9ba0561"
host_url = "https://integrationlab.netbraintech.com/"
headers = {'Content-Type': 'application/json', 'Accept': 'application/json'}
headers["Token"] = token

API_Body = {
    "domain_setting": {
        "tenant_id": "40e0032e-14e7-4fea-7d00-8fe8bd65efae",
        "domain_id": "b924c2f0-7210-43ba-9cdd-d1757ae23742"
    },
    "basic_setting": {
        "triggered_by": "Netbrain",
        "user_id": "admin",
        "user": "gongdai.liu",
        "device": "US-BOS-R1",
        "stub_name": "APITest",
    },
    "map_setting": {
        "map_create_mode": 5,
        "context_map_cisco_aci_device_para": {
            "apic": "",
            "device": "",
            "pod_id": "",
            "tenant_name": "",
            "vrf_name": "",
            "application_name": ""
        }
    }
}

# Trigger API function
def TriggerTask(API_Body):
 
    # Trigger  API url
    API_URL = r"/ServicesAPI/API/V1/Triggers/Run"
    # Trigger API payload
 
    api_full_url = host_url + API_URL
    api_result = requests.post(api_full_url, data=json.dumps(
        API_Body), headers=headers, verify=False)
    if api_result.status_code == 200:
        return api_result.json()
    else:
        return api_result.json()
    
result = TriggerTask(API_Body)
result
{
    'mapId': '0d9db76c-4196-4a8d-a8bd-6f1f0ffccfa2',
    'mapName': 'APITest-20200306153351',
    'mapType': 1,
    'mapUrl': 'map.html?t=40e0032e-14e7-4fea-7d00-8fe8bd65efae&d=b924c2f0-7210-43ba-9cdd-d1757ae23742&id=0d9db76c-4196-4a8d-a8bd-6f1f0ffccfa2&maptype=1',
    'stubName': 'APITest'
}

cURL Code from Postman:

curl --location --request POST 'https://integrationlab.netbraintech.com/ServicesAPI/API/V1/Triggers/Run' \
--header 'token: b33e987d-0042-4855-b099-5322c9ba0561' \
--header 'Content-Type: application/json' \
--data-raw '{
    "domain_setting": {
        "tenant_id": "40e0032e-14e7-4fea-7d00-8fe8bd65efae",
        "domain_id": "b924c2f0-7210-43ba-9cdd-d1757ae23742"
    },
    "basic_setting": {
        "triggered_by": "Netbrain",
        "user_id": "admin",
        "user": "gongdai.liu",
        "device": "US-BOS-R1",
        "stub_name": "APITest",
    },
    "map_setting": {
        "map_create_mode": 5,
        "context_map_cisco_aci_device_para": {
            "apic": "XXXXXXX",
            "device": "US-BOS-R1",
            "pod_id": "XXXXXXX",
            "tenant_name": "XXXXXXX",
            "vrf_name": "XXXXXXX",
            "application_name": "XXXXXXX"
        }
    }
}'