{
"openapi": "3.1.0",
"info": {
"title": "UX 1.0 Configuration",
"description": "Configuration of UX 1.0 device and policy.\nIncludes API operations for the following:\n Managing original SD-WAN device configurations and policy configurations\n Device templates and feature templates",
"contact": {
"email": "vmanage@cisco.com"
},
"license": {
"name": "Commercial License",
"url": "https://www.cisco.com/c/en/us/solutions/enterprise-networks/sd-wan/index.html"
},
"version": "26.1.0+2026-01-06",
"x-provenance": {
"method": "harvested",
"authored_by": "Cisco Catalyst SD-WAN",
"harvested_by": "API Evangelist",
"harvested_on": "2026-08-19",
"first_party": true,
"provider_published": true,
"source_host": "pubhub.devnetcloud.com",
"note": "4,138 operations across 2,841 paths, published by Cisco as self-contained per-operation OpenAPI 3.1.0 fragments on the DevNet CDN and consolidated here into 13 documents. Ownership verified from info.contact vmanage@cisco.com and the Cisco license URL rather than from the fetch host."
},
"x-evidence": [
{
"type": "source",
"url": "https://pubhub.devnetcloud.com/media/cisco-catalyst-sd-wan-26-1-api-guide/docs/"
},
{
"type": "source",
"url": "https://developer.cisco.com/docs/sdwan/"
}
]
},
"servers": [
{
"url": "/dataservice"
}
],
"tags": [
{
"name": "Configuration - Advanced Inspection Profile Definition"
},
{
"name": "Configuration - Azure Connect"
},
{
"name": "Configuration - Cloud On Ramp"
},
{
"name": "Configuration - CloudExpress"
},
{
"name": "Configuration - Device Template"
},
{
"name": "Configuration - FQDN List Builder"
},
{
"name": "Configuration - General Template"
},
{
"name": "Configuration - Ise Server"
},
{
"name": "Configuration - Policy AMP Definition Builder"
},
{
"name": "Configuration - Policy ASPath List Builder"
},
{
"name": "Configuration - Policy Access List Definition Builder"
},
{
"name": "Configuration - Policy App Probe Class List Builder"
},
{
"name": "Configuration - Policy AppRoute Definition Builder"
},
{
"name": "Configuration - Policy Application List Builder"
},
{
"name": "Configuration - Policy Cflowd Definition Builder"
},
{
"name": "Configuration - Policy Cloud Application Builder"
},
{
"name": "Configuration - Policy Color List Builder"
},
{
"name": "Configuration - Policy Community List Builder"
},
{
"name": "Configuration - Policy Control Definition Builder"
},
{
"name": "Configuration - Policy Custom Application Builder"
},
{
"name": "Configuration - Policy Data Definition Builder"
},
{
"name": "Configuration - Policy Data IPV6 Prefix List Builder"
},
{
"name": "Configuration - Policy Data Prefix All Types Of Lists Builder"
},
{
"name": "Configuration - Policy Data Prefix List Builder"
},
{
"name": "Configuration - Policy Data Prefix and FQDN All Types Of Lists Builder"
},
{
"name": "Configuration - Policy Device Access Definition Builder"
},
{
"name": "Configuration - Policy DialPeer Definition Builder"
},
{
"name": "Configuration - Policy Expanded Community List Builder"
},
{
"name": "Configuration - Policy Extended Community List Builder"
},
{
"name": "Configuration - Policy FXO Port Definition Builder"
},
{
"name": "Configuration - Policy FXS Port Definition Builder"
},
{
"name": "Configuration - Policy FXSDID Port Definition Builder"
},
{
"name": "Configuration - Policy Fax Protocol List Builder"
},
{
"name": "Configuration - Policy Forwarding Class List Builder"
},
{
"name": "Configuration - Policy Geo Location List Builder"
},
{
"name": "Configuration - Policy Hub and Spoke Definition Builder"
},
{
"name": "Configuration - Policy IPS Signature List Builder"
},
{
"name": "Configuration - Policy IPv6 Access Definition Builder"
},
{
"name": "Configuration - Policy IPv6 Device Access Definition Builder"
},
{
"name": "Configuration - Policy IPv6 Prefix List Builder"
},
{
"name": "Configuration - Policy Identity List Builder"
},
{
"name": "Configuration - Policy Intrusion Prevention Definition Builder"
},
{
"name": "Configuration - Policy List Builder"
},
{
"name": "Configuration - Policy Local Domain Definition Builder"
},
{
"name": "Configuration - Policy Local Domain Name List Builder"
},
{
"name": "Configuration - Policy Media Profile List Builder"
},
{
"name": "Configuration - Policy Mesh Definition Builder"
},
{
"name": "Configuration - Policy Mirror List Builder"
},
{
"name": "Configuration - Policy Modem Passthrough List Builder"
},
{
"name": "Configuration - Policy PRI ISDN Port Definition Builder"
},
{
"name": "Configuration - Policy Policer Class List Builder"
},
{
"name": "Configuration - Policy Port List Builder"
},
{
"name": "Configuration - Policy Prefix List Builder"
},
{
"name": "Configuration - Policy Prefix for All Types of Lists Builder"
},
{
"name": "Configuration - Policy Protocol Name List Builder"
},
{
"name": "Configuration - Policy Qos Map Definition Builder"
},
{
"name": "Configuration - Policy Region List Builder"
},
{
"name": "Configuration - Policy Rewrite Rule Definition Builder"
},
{
"name": "Configuration - Policy SLA Class List Builder"
},
{
"name": "Configuration - Policy Scalable Group Tag List Builder"
},
{
"name": "Configuration - Policy Security Assembler"
},
{
"name": "Configuration - Policy Site List Builder"
},
{
"name": "Configuration - Policy Supervisory Disc List Builder"
},
{
"name": "Configuration - Policy TLOC List Builder"
},
{
"name": "Configuration - Policy Threat Grid Api Key List"
},
{
"name": "Configuration - Policy TranslationProfile List Builder"
},
{
"name": "Configuration - Policy TranslationRules List Builder"
},
{
"name": "Configuration - Policy Trunk Group List Builder"
},
{
"name": "Configuration - Policy URL BlackList Builder"
},
{
"name": "Configuration - Policy URL Filtering Definition Builder"
},
{
"name": "Configuration - Policy URL WhiteList Builder"
},
{
"name": "Configuration - Policy Umbrella Data List Builder"
},
{
"name": "Configuration - Policy VPN List Builder"
},
{
"name": "Configuration - Policy VPN Membership Group Definition Builder"
},
{
"name": "Configuration - Policy VPN-Qos Map Definition Builder"
},
{
"name": "Configuration - Policy Voice Assembler"
},
{
"name": "Configuration - Policy Zone Based Firewall Definition Builder"
},
{
"name": "Configuration - Policy Zone List Builder"
},
{
"name": "Configuration - Policy vEdge Assembler"
},
{
"name": "Configuration - Policy vEdge Route Definition Builder"
},
{
"name": "Configuration - Policy vSmart Assembler"
},
{
"name": "Configuration - Preferred Color Group List Builder"
},
{
"name": "Configuration - Quick Connect"
},
{
"name": "Configuration - Rule Set Definition"
},
{
"name": "Configuration - SSL Decryption Policy Definition Builder"
},
{
"name": "Configuration - SSL Decryption UTD Profile Definition"
},
{
"name": "Configuration - Secure Internet Gateway Tunnels"
},
{
"name": "Configuration - Security Group Definition"
},
{
"name": "Configuration - Security Template Policy"
},
{
"name": "Configuration - Template Configuration"
},
{
"name": "Configuration - Template Lock"
},
{
"name": "Configuration - Template Master"
},
{
"name": "Configuration - Topology"
},
{
"name": "Configuration - Voice Template Policy"
},
{
"name": "Configuration - vEdge Template Policy"
},
{
"name": "Configuration - vSmart Template Policy"
}
],
"paths": {
"/template/cloudx": {
"get": {
"tags": [
"Configuration - CloudExpress"
],
"description": "Get CloudX feature list",
"operationId": "getCloudXStatus",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"CloudX status": {
"description": "CloudX status",
"value": {
"data": [
{
"appType": "amazon_aws",
"longName": "Amazon AWS",
"totalSites": 2,
"goodSites": 0,
"badSites": 0,
"averageSites": 0
}
]
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Device Inventory-read,Cloud OnRamp-read,Cloud OnRamp-write"
}
},
"/template/cloudx/addcloudx/{type}": {
"post": {
"tags": [
"Configuration - CloudExpress"
],
"description": "Add cloudx gateway",
"operationId": "addCloudxType",
"parameters": [
{
"name": "type",
"in": "path",
"description": "Cloudx type",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Cloudx",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Cloudx": {
"description": "Cloudx"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"deprecated": true,
"x-roles-required": "Template Configuration-write,Template Deploy-write,Cloud OnRamp-write"
}
},
"/template/cloudx/attachedclient": {
"get": {
"tags": [
"Configuration - CloudExpress"
],
"description": "Get attached client site list",
"operationId": "getAttachedClientList",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"CloudX attached client site": {
"description": "CloudX attached client site",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Template Configuration-read,Template Deploy-read,Template Deploy-write,Cloud OnRamp-read,Cloud OnRamp-write"
}
},
"/template/cloudx/attacheddia": {
"get": {
"tags": [
"Configuration - CloudExpress"
],
"description": "Get attached Dia site list",
"operationId": "getAttachedDiaList",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"CloudX attached Dia site": {
"description": "CloudX attached Dia site",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Template Configuration-read,Template Deploy-read,Template Deploy-write,Cloud OnRamp-read,Cloud OnRamp-write"
}
},
"/template/cloudx/attachedgateway": {
"get": {
"tags": [
"Configuration - CloudExpress"
],
"description": "Get attached gateway list",
"operationId": "getAttachedGatewayList",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"CloudX attached gateway": {
"description": "CloudX attached gateway",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Template Configuration-read,Template Deploy-read,Template Deploy-write,Cloud OnRamp-read,Cloud OnRamp-write"
}
},
"/template/cloudx/availableapps": {
"get": {
"tags": [
"Configuration - CloudExpress"
],
"description": "Get CloudX available apps list",
"operationId": "getCloudXAvailableApps",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"CloudX app list": {
"description": "CloudX app list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Device Inventory-read,Cloud OnRamp-read,Cloud OnRamp-write"
}
},
"/template/cloudx/clientlist": {
"get": {
"tags": [
"Configuration - CloudExpress"
],
"description": "Get site list",
"operationId": "getSiteList",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"CloudX site": {
"description": "CloudX site",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Template Configuration-read,Template Deploy-read,Template Deploy-write,Cloud OnRamp-read,Cloud OnRamp-write"
}
},
"/template/cloudx/dialist": {
"get": {
"tags": [
"Configuration - CloudExpress"
],
"description": "Get Dia site list",
"operationId": "getDiaList",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"CloudX Dia site": {
"description": "CloudX Dia site",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Template Configuration-read,Template Deploy-read,Template Deploy-write,Cloud OnRamp-read,Cloud OnRamp-write"
}
},
"/template/cloudx/gatewaylist": {
"get": {
"tags": [
"Configuration - CloudExpress"
],
"description": "Get gateway list",
"operationId": "getGatewayList",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"CloudX gateway": {
"description": "CloudX gateway",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Template Configuration-read,Template Deploy-read,Template Deploy-write,Cloud OnRamp-read,Cloud OnRamp-write"
}
},
"/template/cloudx/interfaces": {
"post": {
"tags": [
"Configuration - CloudExpress"
],
"description": "Enable cloudx gateway",
"operationId": "addCloudxInterfaces",
"requestBody": {
"description": "Cloudx",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Cloudx": {
"description": "Cloudx"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Template Configuration-write,Template Deploy-write,Cloud OnRamp-write"
}
},
"/template/cloudx/manage/apps": {
"get": {
"tags": [
"Configuration - CloudExpress"
],
"description": "Get apps and vpns",
"operationId": "getApps",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"CloudX apps and vpns": {
"description": "CloudX apps and vpns",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Template Configuration-read,Template Deploy-read,Template Deploy-write,Cloud OnRamp-read,Cloud OnRamp-write"
},
"put": {
"tags": [
"Configuration - CloudExpress"
],
"description": "Edit apps and vpns",
"operationId": "editApps",
"requestBody": {
"description": "Cloudx apps and vpns",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Cloudx apps and vpns": {
"description": "Cloudx apps and vpns",
"value": {
"appList": [
{
"appType": "amazon_aws",
"longName": "Amazon AWS",
"appVpnList": "1,10"
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Change required": {
"description": "Change required",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Template Configuration-write,Template Deploy-write,Cloud OnRamp-write"
},
"post": {
"tags": [
"Configuration - CloudExpress"
],
"description": "Add apps and vpns",
"operationId": "addApps",
"requestBody": {
"description": "Cloudx apps and vpns",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Cloudx apps and vpns": {
"description": "Cloudx apps and vpns",
"value": {
"appList": [
{
"appType": "amazon_aws",
"longName": "Amazon AWS",
"appVpnList": "1,5"
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"CloudX apps and vpns": {
"description": "CloudX apps and vpns",
"value": {
"pushRequired": false
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Template Configuration-write,Template Deploy-write,Cloud OnRamp-write"
}
},
"/template/cloudx/sig_tunnels": {
"get": {
"tags": [
"Configuration - Secure Internet Gateway Tunnels"
],
"description": "Get Secure Internet Gateway Tunnel List",
"operationId": "getSigTunnelList_ConfigurationSecureInternetGatewayTunnels_2803",
"parameters": [
{
"name": "deviceId",
"in": "query",
"description": "DeviceIp/SystemIp",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Template Configuration-read,Template Deploy-read,Template Deploy-write,Cloud OnRamp-read,Cloud OnRamp-write"
}
},
"/template/cloudx/status": {
"get": {
"tags": [
"Configuration - CloudExpress"
],
"description": "Get sites per application per vpn",
"operationId": "sitePerApp",
"parameters": [
{
"name": "appName",
"in": "query",
"description": "App name",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "vpnId",
"in": "query",
"description": "VPN Id",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"CloudX site": {
"description": "CloudX site",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Device Inventory-read,Cloud OnRamp-read,Cloud OnRamp-write"
}
},
"/template/config/attach/{deviceId}": {
"put": {
"tags": [
"Configuration - Template Configuration"
],
"description": "Upload device config",
"operationId": "uploadConfig",
"parameters": [
{
"name": "deviceId",
"in": "path",
"description": "Device Model ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Template config",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Template config": {
"description": "Template config"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Device Inventory-write,Template Deploy-write"
}
},
"/template/config/attached/{deviceId}": {
"get": {
"tags": [
"Configuration - Template Configuration"
],
"description": "Get local template attached config for given device",
"operationId": "getAttachedConfig",
"parameters": [
{
"name": "deviceId",
"in": "path",
"description": "Device Model ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "type",
"in": "query",
"description": "Config type",
"schema": {
"type": "string",
"enum": [
"CFS",
"RFS",
"DRAFT_RFS",
"DRAFT_CFS"
],
"default": "CFS"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Attached config": {
"description": "Attached config",
"value": {
"config": "no config \nconfig\n system\n host-name vm1\n system-ip 172.16.255.11\n site-id 100\n port-offset 1\n admin-tech-on-failure\n admin-tech-on-software-rollback\n route-consistency-check\n no vrrp-advt-with-phymac\n organization-name \"vIPtela Inc Regression\"\n vbond vbond\n aaa\n auth-order local radius tacacs\n usergroup basic\n task system read\n task interface read\n !\n usergroup netadmin\n !\n usergroup operator\n task system read\n task interface read\n task policy read\n task routing read\n task security read\n !\n usergroup tenantadmin\n !\n user admin\n password $6$tebXK3g64oMdWjSp$kIbJ/qShDI4/eLQ0M8NLyCK7rlmsZAlnwGFqCVZc7rNlIE6f8O1Q6IuP4pHJinc8pSTNGAEYtoCAwDuAiGPF9/\n !\n ciscotacro-user true\n ciscotacrw-user true\n !\n logging\n disk\n enable\n !\n !\n ntp\n parent\n no enable\n stratum 5\n exit\n !\n support\n zbfw-tcp-finwait-time 30\n zbfw-tcp-idle-time 3600\n zbfw-tcp-synwait-time 30\n zbfw-udp-idle-time 30\n !\n !\n omp\n no shutdown\n graceful-restart\n timers\n holdtime 15\n graceful-restart-timer 120\n exit\n advertise ospf external\n advertise connected\n advertise static\n !\n security\n ipsec\n integrity-type ip-udp-esp esp\n !\n !\n vpn 0\n host vbond ip 10.0.12.26 2001:a0:c::1a\n interface ge0/1\n ip address 10.0.26.11/24\n no ipv6 shutdown\n no shutdown\n !\n interface ge0/2\n ip address 10.0.5.11/24\n no ipv6 shutdown\n tunnel-interface\n encapsulation ipsec\n color lte\n hello-tolerance 12\n no allow-service bgp\n allow-service dhcp\n allow-service dns\n allow-service icmp\n no allow-service sshd\n no allow-service netconf\n no allow-service ntp\n no allow-service ospf\n no allow-service stun\n allow-service https\n !\n no shutdown\n !\n interface ge0/4\n ip address 10.0.7.11/24\n no ipv6 shutdown\n no shutdown\n !\n interface ge0/7\n ip address 10.0.100.11/24\n no ipv6 shutdown\n no shutdown\n !\n ip route 0.0.0.0/0 10.0.5.13\n !\n vpn 1\n router\n ospf\n router-id 172.16.255.11\n timers spf 200 1000 10000\n redistribute static\n redistribute omp\n area 0\n interface ge0/0\n exit\n exit\n !\n !\n interface ge0/0\n ip address 10.2.2.11/24\n no ipv6 shutdown\n no shutdown\n !\n !\n vpn 512\n interface eth0\n ip dhcp-client\n no ipv6 shutdown\n ipv6 dhcp-client\n no shutdown\n !\n !\n !\n!"
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Device Inventory-read,Device Inventory-write,Device Inventory > Edge-read,Device Inventory > Controller-read,Device Inventory > Edge-write"
}
},
"/template/config/device/mode/cli": {
"get": {
"tags": [
"Configuration - Template Configuration"
],
"description": "Generates a JSON object that contains a list of valid devices in CLI mode",
"operationId": "generateCLIModeDevices",
"parameters": [
{
"name": "type",
"in": "query",
"description": "Device type",
"required": true,
"schema": {
"type": "string",
"enum": [
"vedge",
"controller",
"vmanage"
]
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Devices": {
"description": "Devices",
"value": {
"data": [
{
"deviceIP": "172.16.255.16",
"uuid": "C8K-0c9b3b23-bdcd-4162-8d4f-774e44e081ee",
"host-name": "vm6",
"local-system-ip": "172.16.255.16"
},
{
"deviceIP": "172.16.255.21",
"uuid": "76611d8b-dca9-47fd-b204-338af931f506",
"host-name": "vm11",
"local-system-ip": "172.16.255.21"
},
{
"deviceIP": "172.16.255.11",
"uuid": "9c8d59ec-e4ad-468a-8fb0-15a7747a9c30",
"host-name": "vm1",
"local-system-ip": "172.16.255.11"
},
{
"deviceIP": "172.16.255.15",
"uuid": "C8K-ae0d5e97-4b0e-4a05-8582-9cc0d93c456c",
"host-name": "vm5",
"local-system-ip": "172.16.255.15"
},
{
"deviceIP": "172.16.255.14",
"uuid": "554b21bf-cad3-4efe-91fa-4c68549a6616",
"host-name": "vm4",
"local-system-ip": "172.16.255.14"
}
]
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Device Inventory-read,Device Inventory-write,Template Deploy-read,Template Deploy-write,Device Inventory > Edge-write"
},
"post": {
"tags": [
"Configuration - Template Configuration"
],
"description": "Given a JSON list of devices not managed by any third member partners, push to devices from a CLI template",
"operationId": "updateDeviceToCLIMode",
"requestBody": {
"description": "Device list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Device list": {
"description": "Device list",
"value": {
"deviceType": "vedge",
"devices": [
{
"deviceId": "932f70dd-5815-4712-b9ed-3d34a238f2ca",
"deviceIP": "172.16.255.21"
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Device template Id": {
"description": "Device template Id",
"value": {
"id": "device_config_mode_cli-01242017T020647984"
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Device Inventory-write,Template Deploy-write,Device Inventory > Edge-write"
}
},
"/template/config/device/mode/vmanage": {
"get": {
"tags": [
"Configuration - Template Configuration"
],
"description": "Get list of devices that are allowable for vmanage modes",
"operationId": "generatevManageModeDevices",
"parameters": [
{
"name": "type",
"in": "query",
"description": "Device type",
"required": true,
"schema": {
"type": "string",
"enum": [
"vedge",
"controller",
"vmanage"
]
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Devices": {
"description": "Devices",
"value": {
"data": [
{
"deviceIP": "169.254.10.1",
"uuid": "8b669639-758b-4287-b07f-09b9d334ce24",
"configCloudxMode": "none",
"host-name": "vm200",
"local-system-ip": "172.16.255.200"
},
{
"deviceIP": "169.254.10.2",
"uuid": "b0497670-2e62-404f-8136-21b226cd4c8b",
"configCloudxMode": "none",
"host-name": "vm201",
"local-system-ip": "172.16.255.201"
},
{
"deviceIP": "169.254.10.3",
"uuid": "d22cafc2-a0d2-4f57-b0a3-d9147818084a",
"configCloudxMode": "none",
"host-name": "vm202",
"local-system-ip": "172.16.255.202"
}
]
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Device Inventory-read,Device Inventory-write,Template Deploy-read,Template Deploy-write"
}
},
"/template/config/diff/{deviceId}": {
"get": {
"tags": [
"Configuration - Template Configuration"
],
"description": "Generates a JSON object that contains the diff for a given device",
"operationId": "getDeviceDiff",
"parameters": [
{
"name": "deviceId",
"in": "path",
"description": "Device Model ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Config diff": {
"description": "Config diff",
"value": {
"config": "Config diff for device 9c8d59ec-e4ad-468a-8fb0-15a7747a9c30"
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Device Inventory-read,Device Inventory-write,Template Deploy-read,Template Deploy-write"
}
},
"/template/config/quickConnect/submitDevices": {
"post": {
"tags": [
"Configuration - Quick Connect"
],
"description": "Creates and pushes bootstrap configurations onto day0 devices.",
"operationId": "submitDay0Config",
"requestBody": {
"content": {
"*/*": {
"schema": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"valueType": {
"type": "string",
"enum": [
"ARRAY",
"OBJECT",
"STRING",
"NUMBER",
"TRUE",
"FALSE",
"NULL"
]
}
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"data": {
"description": "data",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Device Inventory-read,Device Inventory-write,Template Deploy-read,Template Deploy-write"
}
},
"/template/config/rmalist/{oldDeviceId}": {
"get": {
"tags": [
"Configuration - Template Configuration"
],
"description": "Get compatible devices of model, chassis number, certificate serial number with the old device",
"operationId": "getCompatibleDevices",
"parameters": [
{
"name": "oldDeviceId",
"in": "path",
"description": "Device Model ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Devices": {
"description": "Devices",
"value": {
"data": [
{
"deviceModel": "vedge",
"chasisNumber": "71001c48-fdcf-4ac0-aaf3-ca4a20386a18",
"serialNumber": "f0b1985ba82e4c4889c225c59ca9a878",
"uuid": "67b2de20-0564-4ba6-837f-b24bc6a686ad"
}
]
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Device Inventory-read,Device Inventory-write,Template Deploy-read,Template Deploy-write"
}
},
"/template/config/rmaupdate": {
"put": {
"tags": [
"Configuration - Template Configuration"
],
"description": "Update new device",
"operationId": "rmaUpdate",
"requestBody": {
"description": "Template config",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Template config": {
"description": "Template config",
"value": {
"oldDeviceUUID": "C8K-075aaa13-0f11-4f76-a02e-fe3750080fcf",
"newDeviceUUID": "C8K-3bb1154f-ae09-48fb-9fe1-5ddc3b16089e"
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Device Inventory-write,Template Deploy-write"
}
},
"/template/config/running/{deviceId}": {
"get": {
"tags": [
"Configuration - Template Configuration"
],
"description": "Get device running config",
"operationId": "getRunningConfig",
"parameters": [
{
"name": "deviceId",
"in": "path",
"description": "Device Model ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Running config": {
"description": "Running config",
"value": {
"config": "system\nhost-name vm1\nsystem-ip 172.16.255.11\nsite-id 100\nport-offset 1\nno daemon-restart\nadmin-tech-on-failure\nadmin-tech-on-software-rollback\nroute-consistency-check\nno vrrp-advt-with-phymac\norganization-name \"vIPtela Inc Regression\"\nvbond vbond\naaa\n auth-order local radius tacacs\n usergroup basic\n task system read\n task interface read\n !\n usergroup netadmin\n !\n usergroup operator\n task system read\n task interface read\n task policy read\n task routing read\n task security read\n !\n usergroup tenantadmin\n !\n user admin\n password $6$tebXK3g64oMdWjSp$kIbJ/qShDI4/eLQ0M8NLyCK7rlmsZAlnwGFqCVZc7rNlIE6f8O1Q6IuP4pHJinc8pSTNGAEYtoCAwDuAiGPF9/\n !\n ciscotacro-user true\n ciscotacrw-user true\n!\nlogging\n disk\n enable\n !\n!\nntp\n parent\n no enable\n stratum 5\n exit\n!\nsupport\n zbfw-tcp-finwait-time 30\n zbfw-tcp-idle-time 3600\n zbfw-tcp-synwait-time 30\n zbfw-udp-idle-time 30\n!\n!\nomp\nno shutdown\ngraceful-restart\ntimers\n holdtime 15\n graceful-restart-timer 120\nexit\nadvertise ospf external\nadvertise connected\nadvertise static\n!\nsecurity\nipsec\n integrity-type ip-udp-esp esp\n!\n!\nvpn 0\nhost vbond ip 10.0.12.26 2001:a0:c::1a\ninterface ge0/1\n ip address 10.0.26.11/24\n no shutdown\n!\ninterface ge0/2\n ip address 10.0.5.11/24\n tunnel-interface\n encapsulation ipsec\n color lte\n no allow-service bgp\n allow-service dhcp\n allow-service dns\n allow-service icmp\n no allow-service sshd\n no allow-service netconf\n no allow-service ntp\n no allow-service ospf\n no allow-service stun\n allow-service https\n !\n no shutdown\n!\ninterface ge0/4\n ip address 10.0.7.11/24\n no shutdown\n!\ninterface ge0/7\n ip address 10.0.100.11/24\n no shutdown\n!\nip route 0.0.0.0/0 10.0.5.13\n!\nvpn 1\nrouter\n ospf\n router-id 172.16.255.11\n timers spf 200 1000 10000\n redistribute static\n redistribute omp\n area 0\n interface ge0/0\n exit\n exit\n !\n!\ninterface ge0/0\n ip address 10.2.2.11/24\n no shutdown\n!\n!\nvpn 512\ninterface eth0\n ip dhcp-client\n ipv6 dhcp-client\n no shutdown\n!\n!"
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Device Inventory-read,Device Inventory-write,Device Inventory > Edge-read,Device Inventory > Controller-read,Device Inventory > Edge-write"
}
},
"/template/config/vpn/{deviceId}": {
"get": {
"tags": [
"Configuration - Template Configuration"
],
"description": "Get list of configured VPN (excluding reserved VPN) for a device",
"operationId": "getVpnForDevice",
"parameters": [
{
"name": "deviceId",
"in": "path",
"description": "Device Model ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"VPN": {
"description": "VPN",
"value": [
"1"
]
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Device Inventory-read,Device Inventory-write,Template Deploy-read,Template Deploy-write"
}
},
"/template/cor": {
"post": {
"tags": [
"Configuration - Cloud On Ramp"
],
"description": "Map Host to Transit VPC/VNet",
"operationId": "createAndMap",
"requestBody": {
"description": "Map host to transit VPC request",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Map host to transit VPC request": {
"description": "Map host to transit VPC request"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Task Id": {
"description": "Task Id",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"deprecated": true,
"x-roles-required": "Cloud OnRamp-write"
},
"get": {
"tags": [
"Configuration - Cloud On Ramp"
],
"description": "Get Cloud On Ramp list",
"operationId": "getCORStatus",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Cloud on ramp status": {
"description": "Cloud on ramp status",
"value": {
"data": [
{
"accountId": "010098612700",
"accountName": "010098612700",
"cloudType": "AWS",
"mappedAccountCount": 0,
"cloudRegionList": [
{
"cloudRegion": "us-west-1",
"transitVpcCount": 1,
"hostVpcCount": 0,
"deviceCount": 2,
"hostVpcReachableCount": 0,
"hostVpcUnreachableCount": 0,
"deviceReachableCount": 0,
"deviceUnreachableCount": 2
}
]
}
]
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"deprecated": true,
"x-roles-required": "Cloud OnRamp-read"
}
},
"/template/cor/accountid/{accountid}": {
"delete": {
"tags": [
"Configuration - Cloud On Ramp"
],
"description": "Delete transit VPC/VNet",
"operationId": "removeTransitVPC",
"parameters": [
{
"name": "accountid",
"in": "path",
"description": "Account Id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "transitvpcid",
"in": "query",
"description": "Cloud VPC Id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cloudregion",
"in": "query",
"description": "Cloud region",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cloudtype",
"in": "query",
"description": "Cloud type",
"schema": {
"type": "string",
"default": "AWS"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Task Id": {
"description": "Task Id",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"deprecated": true,
"x-roles-required": "Cloud OnRamp-write"
}
},
"/template/cor/acquireResourcePool": {
"post": {
"tags": [
"Configuration - Cloud On Ramp"
],
"description": "Acquire IP from resource pool",
"operationId": "acquireResourcePool",
"requestBody": {
"description": "Add IP from resource pool request",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Add IP from resource pool request": {
"description": "Add IP from resource pool request"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"deprecated": true,
"x-roles-required": "Cloud OnRamp-write"
}
},
"/template/cor/ami": {
"get": {
"tags": [
"Configuration - Cloud On Ramp"
],
"description": "Get AMI list",
"operationId": "getAmiList",
"parameters": [
{
"name": "accountid",
"in": "query",
"description": "Account Id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cloudregion",
"in": "query",
"description": "Cloud region",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cloudtype",
"in": "query",
"description": "Cloud type",
"schema": {
"type": "string",
"default": "AWS"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"AMI": {
"description": "AMI",
"value": "{\"data\":{\n \"amis\":[\n {\n \"amiId\":\"ami-00c8377340219e9fc\",\n \"version\":\"18.3.0\",\n \"modelType\":\"vedge\"\n },\n {\n \"amiId\":\"ami-0136d4095d027e741\",\n \"version\":\"19.1.0-temp\",\n \"modelType\":\"vedge\"\n },\n {\n \"amiId\":\"ami-02a3c4c89a7e3294e\",\n \"version\":\"19.1.0\",\n \"modelType\":\"vedge\"\n },\n {\n \"amiId\":\"ami-02f9c3711e326dcb6\",\n \"version\":\"csr-CSR_SDWAN-AMI.16.12.01b-8ffa16cf-1756-44a2-9e95-2b4369bb2fe9-ami-0be17bfec080cee40.4\",\n \"modelType\":\"csr\"\n },\n {\n \"amiId\":\"ami-053eee5e68e33f25b\",\n \"version\":\"Cisco-CSR-SDWAN-16.12.03-8ffa16cf-1756-44a2-9e95-2b4369bb2fe9-ami-0379a842c0f9e5378.4\",\n \"modelType\":\"csr\"\n }\n ]}"
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"deprecated": true,
"x-roles-required": "Cloud OnRamp-read"
}
},
"/template/cor/cloud": {
"get": {
"tags": [
"Configuration - Cloud On Ramp"
],
"description": "Get cloud list",
"operationId": "getCloudList",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Cloud type": {
"description": "Cloud type",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"deprecated": true,
"x-roles-required": "Cloud OnRamp-read"
}
},
"/template/cor/cloud/account": {
"get": {
"tags": [
"Configuration - Cloud On Ramp"
],
"description": "Get cloud accounts",
"operationId": "getCloudAccounts",
"parameters": [
{
"name": "cloudtype",
"in": "query",
"description": "Cloud type",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cloudEnvironment",
"in": "query",
"description": "Cloud environment",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Cloud account": {
"description": "Cloud account",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"deprecated": true,
"x-roles-required": "Cloud OnRamp-read"
}
},
"/template/cor/cloud/authenticate": {
"put": {
"tags": [
"Configuration - Cloud On Ramp"
],
"description": "Authenticate and update cloud account credentials",
"operationId": "authenticateCredAndUpdate",
"requestBody": {
"description": "Cloud account credential",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Cloud account credential": {
"description": "Cloud account credential",
"value": {
"cloudType": "AWS",
"authType": "KEY",
"apiKey": "dummy",
"secretKey": "dummy"
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Cloud account": {
"description": "Cloud account",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"deprecated": true,
"x-roles-required": "Cloud OnRamp-write"
},
"post": {
"tags": [
"Configuration - Cloud On Ramp"
],
"description": "Authenticate cloud account credentials",
"operationId": "authenticateCloudOnRampCredAndAdd",
"requestBody": {
"description": "Cloud account credential",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Cloud account credential": {
"description": "Cloud account credential",
"value": {
"cloudType": "AWS",
"authType": "KEY",
"apiKey": "dummy",
"secretKey": "dummy"
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Cloud account": {
"description": "Cloud account",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"deprecated": true,
"x-roles-required": "Cloud OnRamp-write"
}
},
"/template/cor/cloud/host/accountdetails": {
"get": {
"tags": [
"Configuration - Cloud On Ramp"
],
"description": "Get cloud host VPC account details",
"operationId": "getCloudHostVpcAccountDetails",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Cloud host account": {
"description": "Cloud host account",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"deprecated": true,
"x-roles-required": "Cloud OnRamp-read"
}
},
"/template/cor/cloud/mappedhostaccounts": {
"get": {
"tags": [
"Configuration - Cloud On Ramp"
],
"description": "Get cloud mapped accounts view",
"operationId": "getCloudMappedHostAccounts",
"parameters": [
{
"name": "accountid",
"in": "query",
"description": "Account Id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cloudtype",
"in": "query",
"description": "Cloud type",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Cloud mapped host account": {
"description": "Cloud mapped host account",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"deprecated": true,
"x-roles-required": "Cloud OnRamp-read"
}
},
"/template/cor/createResourcePool": {
"post": {
"tags": [
"Configuration - Cloud On Ramp"
],
"description": "Add resource pool",
"operationId": "createResourcePool",
"requestBody": {
"description": "Add resource pool request",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Add resource pool request": {
"description": "Add resource pool request"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"deprecated": true,
"x-roles-required": "Cloud OnRamp-write"
}
},
"/template/cor/deleteDevicepair": {
"delete": {
"tags": [
"Configuration - Cloud On Ramp"
],
"description": "Remove device pair",
"operationId": "removeDeviceId",
"parameters": [
{
"name": "accountid",
"in": "query",
"description": "Account Id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "transitvpcid",
"in": "query",
"description": "VPC Id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "transitvpcname",
"in": "query",
"description": "VPC Name",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cloudregion",
"in": "query",
"description": "Cloud region",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cloudtype",
"in": "query",
"description": "Cloud type",
"schema": {
"type": "string",
"default": "AWS"
}
},
{
"name": "devicePairId",
"in": "query",
"description": "Device pair Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Task Id": {
"description": "Task Id",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"deprecated": true,
"x-roles-required": "Cloud OnRamp-write"
}
},
"/template/cor/device": {
"get": {
"tags": [
"Configuration - Cloud On Ramp"
],
"description": "Get available device list",
"operationId": "getCloudOnRampDevices",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Devices": {
"description": "Devices",
"value": "\"data\":[\n {\n \"uuid\":\"f21dbb35-30b3-47f4-93bb-d2b2fe092d35\",\n \"deviceIP\":\"1.1.1.100\",\n \"host-name\":\"AWS-vEdge-1\",\n \"deviceModel\":\"vedge-cloud\",\n \"modelType\":\"vedge\"\n },\n {\n \"uuid\":\"52c7911f-c5b0-45df-b826-3155809a2a1a\",\n \"deviceIP\":\"1.1.1.200\",\n \"host-name\":\"AWS-vEdge-2\",\n \"deviceModel\":\"vedge-cloud\",\n \"modelType\":\"vedge\"\n }\n ]"
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"deprecated": true,
"x-roles-required": "Cloud OnRamp-read"
}
},
"/template/cor/devicepair": {
"post": {
"tags": [
"Configuration - Cloud On Ramp"
],
"description": "Add device pair",
"operationId": "addDevicePair",
"requestBody": {
"description": "Add device pair request",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Add device pair request": {
"description": "Add device pair request"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Task Id": {
"description": "Task Id",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"deprecated": true,
"x-roles-required": "Cloud OnRamp-write"
}
},
"/template/cor/devicepair/hostvpc": {
"get": {
"tags": [
"Configuration - Cloud On Ramp"
],
"description": "Get host VPC details",
"operationId": "getHostVPCs",
"parameters": [
{
"name": "transitVpcId",
"in": "query",
"description": "Transit VPC Id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "devicePairId",
"in": "query",
"description": "Device pair Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Host VPC": {
"description": "Host VPC",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"deprecated": true,
"x-roles-required": "Cloud OnRamp-read"
}
},
"/template/cor/externalId": {
"get": {
"tags": [
"Configuration - Cloud On Ramp"
],
"description": "Get the vManage external ID for AWS",
"operationId": "getExternalId",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"externalId": {
"description": "externalId",
"value": "12345abcd"
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"deprecated": true,
"x-roles-required": "Cloud OnRamp-read"
}
},
"/template/cor/getTransitDevicePairAndHostList": {
"get": {
"tags": [
"Configuration - Cloud On Ramp"
],
"description": "Get device and host details",
"operationId": "getTransitDevicePairAndHostList",
"parameters": [
{
"name": "accountId",
"in": "query",
"description": "Account Id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cloudRegion",
"in": "query",
"description": "Cloud region",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Device and host": {
"description": "Device and host",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"deprecated": true,
"x-roles-required": "Cloud OnRamp-read"
}
},
"/template/cor/getTransitVpnList": {
"get": {
"tags": [
"Configuration - Cloud On Ramp"
],
"description": "Get transit VPN list",
"operationId": "getTransitVpcVpnList",
"parameters": [
{
"name": "accountId",
"in": "query",
"description": "Account Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Transit VPN": {
"description": "Transit VPN",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"deprecated": true,
"x-roles-required": "Cloud OnRamp-read"
}
},
"/template/cor/hostvpc": {
"get": {
"tags": [
"Configuration - Cloud On Ramp"
],
"description": "Get host VPC/VNet list",
"operationId": "getCloudHostVPCs",
"parameters": [
{
"name": "accountid",
"in": "query",
"description": "Account Id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cloudregion",
"in": "query",
"description": "Cloud region",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cloudtype",
"in": "query",
"description": "Cloud type",
"schema": {
"type": "string",
"default": "AWS"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"VPC/VNet": {
"description": "VPC/VNet",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"deprecated": true,
"x-roles-required": "Cloud OnRamp-read"
}
},
"/template/cor/map": {
"post": {
"tags": [
"Configuration - Cloud On Ramp"
],
"description": "Map host to transit VPC/VNet",
"operationId": "mapVPCs",
"requestBody": {
"description": "Map host to VPC/VNet",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Map host to VPC/VNet": {
"description": "Map host to VPC/VNet"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Task Id": {
"description": "Task Id",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"deprecated": true,
"x-roles-required": "Cloud OnRamp-write"
},
"delete": {
"tags": [
"Configuration - Cloud On Ramp"
],
"description": "Unmap host from transit VPC/VNet",
"operationId": "unmapVPCs",
"requestBody": {
"description": "Unmap host to VPC/VNet",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Unmap host to VPC/VNet": {
"description": "Unmap host to VPC/VNet"
}
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Task Id": {
"description": "Task Id",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"deprecated": true,
"x-roles-required": "Cloud OnRamp-write"
},
"get": {
"tags": [
"Configuration - Cloud On Ramp"
],
"description": "Get mapped VPC/VNet list",
"operationId": "getMappedVPCs",
"parameters": [
{
"name": "accountid",
"in": "query",
"description": "Account Id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cloudregion",
"in": "query",
"description": "Cloud region",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Task Id": {
"description": "Task Id",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"deprecated": true,
"x-roles-required": "Cloud OnRamp-read"
}
},
"/template/cor/pem": {
"get": {
"tags": [
"Configuration - Cloud On Ramp"
],
"description": "Get transit VPC PEM key list",
"operationId": "getPemKeyList",
"parameters": [
{
"name": "accountid",
"in": "query",
"description": "Account Id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cloudregion",
"in": "query",
"description": "Cloud region",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cloudtype",
"in": "query",
"description": "Cloud type",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"PEM key": {
"description": "PEM key",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"deprecated": true,
"x-roles-required": "Cloud OnRamp-read"
}
},
"/template/cor/scale/down": {
"post": {
"tags": [
"Configuration - Cloud On Ramp"
],
"description": "Scale down cloud on ramp",
"operationId": "scaleDown",
"requestBody": {
"description": "Update VPC",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Update VPC": {
"description": "Update VPC"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"deprecated": true,
"x-roles-required": "viptela-reserved-cloud"
}
},
"/template/cor/scale/up": {
"post": {
"tags": [
"Configuration - Cloud On Ramp"
],
"description": "Scale up cloud on ramp",
"operationId": "scaleUp",
"requestBody": {
"description": "Update VPC",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Update VPC": {
"description": "Update VPC"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"deprecated": true,
"x-roles-required": "viptela-reserved-cloud"
}
},
"/template/cor/transitvpc": {
"get": {
"tags": [
"Configuration - Cloud On Ramp"
],
"description": "Get transit VPC/VNet list",
"operationId": "getTransitVPCs",
"parameters": [
{
"name": "accountid",
"in": "query",
"description": "Account Id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cloudregion",
"in": "query",
"description": "Cloud region",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cloudtype",
"in": "query",
"description": "Cloud type",
"schema": {
"type": "string",
"default": "AWS"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"VPC/VNet list": {
"description": "VPC/VNet list",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"deprecated": true,
"x-roles-required": "Cloud OnRamp-read"
},
"put": {
"tags": [
"Configuration - Cloud On Ramp"
],
"description": "Update transit VPC/VNet",
"operationId": "updateTransitVPC",
"requestBody": {
"description": "VPC",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"VPC": {
"description": "VPC",
"value": {
"accountId": "010098612700",
"cloudRegion": "us-west-1",
"cloudType": "AWS",
"transitVpcName": "DemoVPC",
"transitVpcId": "vpc-0dfdd169a61492554",
"dia": "DISABLED"
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"deprecated": true,
"x-roles-required": "Cloud OnRamp-write"
},
"post": {
"tags": [
"Configuration - Cloud On Ramp"
],
"description": "Create transit VPC/VNet",
"operationId": "addTransitVPC",
"requestBody": {
"description": "VPC",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"VPC": {
"description": "VPC",
"value": {
"accountId": "010098612700",
"cloudRegion": "us-west-1",
"cloudType": "AWS",
"transitVpcName": "DemoVPC",
"transitVpcSize": "c3.large",
"amiId": "ami-0f0f993e800121941",
"deviceModelType": "vedge",
"transitVpcSubnet": "",
"maxHostVpcPerDevicePair": 1,
"devicePairList": [
{
"deviceList": [
{
"uuid": "f21dbb35-30b3-47f4-93bb-d2b2fe092d35",
"preference": "active"
},
{
"uuid": "52c7911f-c5b0-45df-b826-3155809a2a1a",
"preference": "backup"
}
],
"devicePairId": "f21dbb35-30b3-47f4-93bb-d2b2fe092d35",
"isPrimary": true
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Task Id": {
"description": "Task Id",
"value": {
"id": "b634bf94-b47b-40a2-ba72-d289036234fd"
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"deprecated": true,
"x-roles-required": "Cloud OnRamp-write"
}
},
"/template/cor/transitvpc/autoscale-properties": {
"put": {
"tags": [
"Configuration - Cloud On Ramp"
],
"description": "Update transit VPC autoscale properties",
"operationId": "updateTransitVpcAutoscaleProperties",
"requestBody": {
"description": "VPC",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"VPC": {
"description": "VPC",
"value": {
"accountId": "010098612700",
"cloudRegion": "us-west-1",
"cloudType": "AWS",
"transitVpcName": "DemoVPC",
"transitVpcId": "vpc-0dfdd169a61492554",
"maxHostVpcPerDevicePair": 2
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Task Id": {
"description": "Task Id",
"value": {
"id": ""
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"deprecated": true,
"x-roles-required": "Cloud OnRamp-write"
}
},
"/template/cor/transitvpc/size": {
"get": {
"tags": [
"Configuration - Cloud On Ramp"
],
"description": "Get transit VPC supported size",
"operationId": "getTransitVPCSupportedSize",
"parameters": [
{
"name": "cloudtype",
"in": "query",
"description": "Cloud type",
"schema": {
"type": "string",
"default": "AWS"
}
},
{
"name": "cloudEnvironment",
"in": "query",
"description": "Cloud environment",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"VPC size": {
"description": "VPC size",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"deprecated": true,
"x-roles-required": "Cloud OnRamp-read"
}
},
"/template/cortex": {
"get": {
"tags": [
"Configuration - Azure Connect"
],
"description": "Get Cortex List",
"operationId": "getCortexStatus",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Cortex status": {
"description": "Cortex status",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Cortex-read"
}
},
"/template/cortex/cloud/authenticate": {
"post": {
"tags": [
"Configuration - Azure Connect"
],
"description": "Authenticate Cloud Account Credentials",
"operationId": "authenticateAzureConnectCredAndAdd",
"requestBody": {
"description": "Credential",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Credential": {
"description": "Credential"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Cortex-write"
}
},
"/template/cortex/map": {
"get": {
"tags": [
"Configuration - Azure Connect"
],
"description": "Get Mapped WAN Resource Groups",
"operationId": "getMappedWanResourceGroups",
"parameters": [
{
"name": "accountid",
"in": "query",
"description": "Account Id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cloudregion",
"in": "query",
"description": "Cloud region",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"WAN resource groups": {
"description": "WAN resource groups",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Cortex-write"
}
},
"/template/cortex/sync": {
"post": {
"tags": [
"Configuration - Azure Connect"
],
"description": "Sync WAN Resource Groups",
"operationId": "syncWanResourceGroups",
"requestBody": {
"description": "WAN resource group",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"WAN resource group": {
"description": "WAN resource group"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Task Id": {
"description": "Task Id",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Cortex-write"
}
},
"/template/cortex/wanrg": {
"get": {
"tags": [
"Configuration - Azure Connect"
],
"description": "Get WAN Resource Groups",
"operationId": "getWanResourceGroups",
"parameters": [
{
"name": "accountid",
"in": "query",
"description": "Account Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"WAN resource groups": {
"description": "WAN resource groups",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Cortex-write"
},
"post": {
"tags": [
"Configuration - Azure Connect"
],
"description": "Create WAN Resource Groups",
"operationId": "saveWanResourceGroups",
"requestBody": {
"description": "WAN resource group",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"WAN resource group": {
"description": "WAN resource group"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Task Id": {
"description": "Task Id",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Cortex-write"
},
"put": {
"tags": [
"Configuration - Azure Connect"
],
"description": "Edit WAN Resource Groups",
"operationId": "editWanResourceGroups",
"requestBody": {
"description": "WAN resource group",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"WAN resource group": {
"description": "WAN resource group"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Cortex-write"
},
"delete": {
"tags": [
"Configuration - Azure Connect"
],
"description": "Delete WAN Resource Groups",
"operationId": "deleteWanResourceGroups",
"requestBody": {
"description": "WAN resource group",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"WAN resource group": {
"description": "WAN resource group"
}
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Task Id": {
"description": "Task Id",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Cortex-write"
}
},
"/template/device": {
"get": {
"tags": [
"Configuration - Template Master"
],
"description": "Generate template list
Note: In a multitenant vManage system, this API is only available in the Provider view.",
"operationId": "generateMasterTemplateList",
"parameters": [
{
"name": "feature",
"in": "query",
"description": "Feature",
"required": true,
"schema": {
"type": "string",
"enum": [
"lawful-interception",
"cloud-dock",
"network-design",
"vmanage-default",
"all"
]
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Template list": {
"description": "Template list",
"value": {
"data": [
{
"deviceType": "vsmart",
"lastUpdatedBy": "admin",
"factoryDefault": false,
"templateName": "vSmartConfigurationTemplate",
"devicesAttached": 0,
"draftMode": false,
"templateDescription": "Config template for vSmarts",
"templateClass": "vedge",
"lastUpdatedOn": 1529606745011,
"configType": "file",
"templateId": "e1f3de23-1ded-49d8-85b1-1e6ab668775f",
"templateAttached": 0
},
{
"deviceType": "vedge-C1111-8PLTELA",
"lastUpdatedBy": "system",
"templateClass": "cedge",
"configType": "template",
"templateId": "b6aacdc9-ae1f-4471-a359-13657ce98204",
"factoryDefault": true,
"templateName": "Factory_Default_C1111_8PLTELA_V01",
"devicesAttached": 0,
"draftMode": false,
"templateDescription": "Factory Default template for C1111-8PLTELA",
"lastUpdatedOn": 1588082428579,
"templateAttached": 15
}
]
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/device/cli": {
"post": {
"tags": [
"Configuration - Template Master"
],
"description": "Create CLI template
Note: In a multitenant vManage system, this API is only available in the Provider view.",
"operationId": "createCLITemplate",
"requestBody": {
"description": "Create template request",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Template": {
"description": "Template",
"value": {
"templateName": "vSmartConfigurationTemplate",
"templateDescription": "Config template for vSmarts",
"deviceType": "vsmart",
"templateConfiguration": "system\n host-name {{Hostname}}\n gps-location latitude {{gps-latitude}}\n gps-location longitude {{gps-longitude}}\n system-ip {{System-IP}}\n site-id {{Site-ID}}\n organization-name \"Cisco Sy1 - 19968\"\n vbond vbond.cisco.com\n aaa\n auth-order local radius tacacs\n usergroup basic\n task system read write\n task interface read write\n !\n usergroup netadmin\n !\n usergroup operator\n task system read\n task interface read\n task policy read\n task routing read\n task security read\n !\n user admin\n password $6$YsNdljyTklJyRlUZ$u.vOqeMSUbzfc.aWBty9OIovNCxlUASviwfgXO2bTCJV5ddUoV7EG8Q3EA3Yl0aMv./GnJLPPbjC6uQPjtwVo.\n !\n !\n logging\n disk\n enable\n !\n !\n !\n omp\n no shutdown\n send-path-limit 8\n send-backup-paths\n graceful-restart\n !\n banner\n login \"Cisco SD-WAN/Viptela dCloud Demo V2\"\n !\n !\n vpn 0\n dns 198.18.1.1 secondary\n dns 198.18.1.254 primary\n host vbond.cisco.com ip 198.18.1.11 198.18.1.21\n interface eth0\n ip address {{Tunnel-IP-Address}}\n ipv6 dhcp-client\n tunnel-interface\n allow-service dhcp\n allow-service dns\n allow-service icmp\n allow-service sshd\n allow-service netconf\n no allow-service ntp\n no allow-service stun\n !\n no shutdown\n !\n ip route 0.0.0.0/0 {{Default GW}}\n !\n vpn 512\n !",
"factoryDefault": false,
"configType": "file"
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Template Id": {
"description": "Template Id",
"value": {
"templateId": "81b558c9-f575-4255-ac11-2e5437be1ea0"
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/device/config/attachBootStrap": {
"post": {
"tags": [
"Configuration - Device Template"
],
"description": "Attach feature device template
Note: In a multitenant vManage system, this API is only available in the Provider view.",
"operationId": "pushMasterTemplate_ConfigurationDeviceTemplate_3904",
"requestBody": {
"description": "Device template",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Device template": {
"description": "Device template",
"value": {
"deviceTemplateList": [
{
"templateId": "41f6a440-c5cc-4cc6-9ca1-af18e332a781",
"device": [
{
"csv-status": "complete",
"csv-deviceId": "5e5f45e7-3062-44b2-b6f6-40c682149e05",
"csv-deviceIP": "172.16.255.11",
"csv-host-name": "vm1",
"//system/host-name": "vm1",
"//system/system-ip": "172.16.255.11",
"//system/site-id": "100",
"csv-templateId": "41f6a440-c5cc-4cc6-9ca1-af18e332a781",
"selected": "true"
}
],
"isEdited": false,
"isMasterEdited": false,
"isDraftDisabled": false
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Task Id": {
"description": "Task Id",
"value": "\"{\"id\":\"push_feature_template_configuration-01232017T154359940\"}\""
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Template Deploy-write"
}
},
"/template/device/config/attachcli": {
"post": {
"tags": [
"Configuration - Device Template"
],
"description": "Attach CLI device template
Note: In a multitenant vManage system, this API is only available in the Provider view.",
"operationId": "pushCLITemplate",
"requestBody": {
"description": "Device template",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Device template": {
"description": "Device template",
"value": "{\n \"deviceTemplateList\":[\n {\n \"templateId\":\"41f6a440-c5cc-4cc6-9ca1-af18e332a781\", \n \"device\":[ \n {\n \"csv-status\":\"complete\",\n \"csv-deviceId\":\"5e5f45e7-3062-44b2-b6f6-40c682149e05\",\n \"csv-deviceIP\":\"172.16.255.11\",\n \"csv-host-name\":\"vm1\",\n \"//system/host-name\":\"vm1\",\n \"//system/system-ip\":\"172.16.255.11\",\n \"//system/site-id\":\"100\",\n \"csv-templateId\":\"41f6a440-c5cc-4cc6-9ca1-af18e332a781\",\n \"selected\":\"true\"\n \"pseudoCommitTimer\":11\n }\n ],\n \"isEdited\":false, \n \"isMasterEdited\":false, \n \"isDraftDisabled\":false \n }\n ]\n}"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Task Id": {
"description": "Task Id",
"value": {
"id": "push_file_template_configuration-d13a002a-0475-43bf-85db-ef9224112a52"
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Template Deploy-write"
}
},
"/template/device/config/attachcloudx": {
"put": {
"tags": [
"Configuration - Device Template"
],
"description": "Edit already enabled gateways, clients, dias
Note: In a multitenant vManage system, this API is only available in the Provider view.",
"operationId": "editCloudxConfig",
"requestBody": {
"description": "CloudX config",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"CloudX config": {
"description": "CloudX config",
"value": {
"isEdited": true,
"siteList": [
100,
400
],
"siteType": "dia"
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "string"
},
"examples": {
"Tenant Id": {
"description": "Tenant Id",
"value": {
"id": "push_file_template_configuration-01242017T020647984"
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Template Deploy-write"
},
"post": {
"tags": [
"Configuration - Device Template"
],
"description": "Enable gateways, clients, dias",
"operationId": "pushCloudxConfig",
"requestBody": {
"description": "CloudX config",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"CloudX config": {
"description": "CloudX config",
"value": {
"isEdited": false,
"siteList": [
100
],
"siteType": "dia"
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "string"
},
"examples": {
"Tenant Id": {
"description": "Tenant Id",
"value": {
"id": "push_file_template_configuration-01242017T020647984"
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Template Deploy-write"
}
},
"/template/device/config/attached/{masterTemplateId}": {
"get": {
"tags": [
"Configuration - Device Template"
],
"description": "Get attached device list by master template Id
Note: In a multitenant vManage system, this API is only available in the Provider view.",
"operationId": "getAttachedDeviceList",
"parameters": [
{
"name": "masterTemplateId",
"in": "path",
"description": "Template Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Device list": {
"description": "Device list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Template Deploy-read,Template Configuration-read"
}
},
"/template/device/config/attachedconfig": {
"get": {
"tags": [
"Configuration - Device Template"
],
"description": "Get attached config to device
Note: In a multitenant vManage system, this API is only available in the Provider view.",
"operationId": "getAttachedConfigToDevice",
"parameters": [
{
"name": "deviceId",
"in": "query",
"description": "Device Model ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "policyId",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"CLI config": {
"description": "CLI config",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Template Deploy-read,Device Inventory-read"
}
},
"/template/device/config/attachfeature": {
"post": {
"tags": [
"Configuration - Device Template"
],
"description": "Attach feature device template
Note: In a multitenant vManage system, this API is only available in the Provider view.",
"operationId": "pushMasterTemplate_ConfigurationDeviceTemplate_3704",
"requestBody": {
"description": "Device template",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Device template": {
"description": "Device template",
"value": {
"deviceTemplateList": [
{
"templateId": "41f6a440-c5cc-4cc6-9ca1-af18e332a781",
"device": [
{
"csv-status": "complete",
"csv-deviceId": "5e5f45e7-3062-44b2-b6f6-40c682149e05",
"csv-deviceIP": "172.16.255.11",
"csv-host-name": "vm1",
"//system/host-name": "vm1",
"//system/system-ip": "172.16.255.11",
"//system/site-id": "100",
"csv-templateId": "41f6a440-c5cc-4cc6-9ca1-af18e332a781",
"selected": "true"
}
],
"isEdited": false,
"isMasterEdited": false,
"isDraftDisabled": false
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Task Id": {
"description": "Task Id",
"value": {
"id": "push_feature_template_configuration-4794e7ed-8912-477b-86ec-07b87621ade4"
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Template Deploy-write"
}
},
"/template/device/config/attachment": {
"post": {
"tags": [
"Configuration - Device Template"
],
"description": "Attach device template
Note: In a multitenant vManage system, this API is only available in the Provider view.",
"operationId": "attachDeviceTemplate",
"requestBody": {
"description": "Device template",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Device template": {
"description": "Device template",
"value": {
"deviceTemplateList": [
{
"templateId": "41f6a440-c5cc-4cc6-9ca1-af18e332a781",
"device": [
{
"csv-status": "complete",
"csv-deviceId": "C8K-8f8cc50c-b05b-4a60-956b-5bdd8e79e5c0",
"csv-deviceIP": "172.16.255.15",
"csv-host-name": "vm5",
"//system/host-name": "vm5",
"//system/system-ip": "172.16.255.15",
"//system/site-id": "100",
"csv-templateId": "41f6a440-c5cc-4cc6-9ca1-af18e332a781",
"selected": "true"
}
],
"isEdited": false,
"isMasterEdited": false,
"isDraftDisabled": false
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Task Id": {
"description": "Task Id",
"value": {
"id": "push_template_configuration-3140b324-7a4b-465d-92cc-847a6c01c340"
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Template Deploy-write"
}
},
"/template/device/config/available/{masterTemplateId}": {
"get": {
"tags": [
"Configuration - Device Template"
],
"description": "Get possible device list by master template Id
Note: In a multitenant vManage system, this API is only available in the Provider view.",
"operationId": "getDeviceListByMasterTemplateId",
"parameters": [
{
"name": "masterTemplateId",
"in": "path",
"description": "Template Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Device list": {
"description": "Device list",
"value": {
"data": [
{
"deviceIP": "172.16.255.16",
"device-groups": [
"No groups"
],
"uuid": "C8K-5783e055-2703-440e-91f0-41f4af941603",
"site-id": "600",
"host-name": "vm6",
"local-system-ip": "172.16.255.16"
}
]
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Template Deploy-read"
}
},
"/template/device/config/config": {
"post": {
"tags": [
"Configuration - Device Template"
],
"description": "Get device configuration
Note: In a multitenant vManage system, this API is only available in the Provider view.",
"operationId": "getDeviceConfigurationPreview",
"requestBody": {
"description": "Device template",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Device template": {
"description": "Device template",
"value": {
"templateId": "45d94bf1-30fb-4b00-8bde-2a62c8af97b5",
"device": {
"csv-status": "complete",
"csv-deviceId": "a1d010e6-bd61-4fbd-8980-96f02db4d0b9",
"csv-deviceIP": "172.16.255.21",
"csv-host-name": "vm11",
"csv-templateId": "45d94bf1-30fb-4b00-8bde-2a62c8af97b5"
},
"isEdited": false,
"isMasterEdited": false
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"examples": {
"Device config": {
"description": "Device config",
"value": "system\nhost-name vm11\ngps-location latitude 35.0\ngps-location longitude -78.0\nsystem-ip 172.16.255.21\nsite-id 100\norganization-name \"vIPtela Inc Regression\"\nclock timezone America/Los_Angeles\nvbond 10.0.12.26\naaa\n auth-order local radius tacacs\n usergroup basic\n task system read write\n task interface read write\n !"
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Template Deploy-read,Template Deploy-write"
}
},
"/template/device/config/detach": {
"post": {
"tags": [
"Configuration - Device Template"
],
"description": "Detach device template
Note: In a multitenant vManage system, this API is only available in the Provider view.",
"operationId": "detachDeviceTemplate",
"requestBody": {
"description": "Device template",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Device template": {
"description": "Device template",
"value": {}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"deprecated": true,
"x-roles-required": "Template Deploy-write"
}
},
"/template/device/config/detachcloudx": {
"post": {
"tags": [
"Configuration - Device Template"
],
"description": "Disable enabled gateways, clients, dias
Note: In a multitenant vManage system, this API is only available in the Provider view.",
"operationId": "detachSites_ConfigurationDeviceTemplate_3604",
"requestBody": {
"description": "CloudX config",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"CloudX config": {
"description": "CloudX config",
"value": {
"siteList": [
100
],
"siteType": "none"
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "string"
},
"examples": {
"Tenant Id": {
"description": "Tenant Id",
"value": {
"id": "push_file_template_configuration-01242017T020647984"
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Template Deploy-write"
}
},
"/template/device/config/duplicateip": {
"post": {
"tags": [
"Configuration - Device Template"
],
"description": "Detects duplicate system IP from a list of devices
Note: In a multitenant vManage system, this API is only available in the Provider view.",
"operationId": "getDevicesWithDuplicateIP",
"requestBody": {
"description": "Device list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Device list": {
"description": "Device list",
"value": {
"device": [
{
"csv-deviceIP": "10.1.0.1",
"csv-deviceId": "ebdc8bd9-17e5-4eb3-a5e0-f438403a83de",
"csv-host-name": "DC1-VEDGE1"
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Device list": {
"description": "Device list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Template Configuration-read,Template Deploy-read,Template Deploy-write"
}
},
"/template/device/config/duplicatelocationname": {
"post": {
"tags": [
"Configuration - Device Template"
],
"description": "Detects duplicate system IP from a list of devices
Note: In a multitenant vManage system, this API is only available in the Provider view.",
"operationId": "getDevicesWithDuplicateLocationName",
"requestBody": {
"description": "Device list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Device list": {
"description": "Device list",
"value": {
"locations": [
{
"locationName": "Milpitas, CA",
"csv-deviceId": "ebdc8bd9-17e5-4eb3-a5e0-f438403a83de"
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Device list": {
"description": "Device list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Template Configuration-read,Template Deploy-read,Template Deploy-write"
}
},
"/template/device/config/exportcsv": {
"post": {
"tags": [
"Configuration - Device Template"
],
"description": "Export the device template to CSV format for given template id
Note: In a multitenant vManage system, this API is only available in the Provider view.",
"operationId": "createInputWithoutDevice",
"requestBody": {
"description": "Device template",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Device template": {
"description": "Device template",
"value": {
"templateId": "e1f3de23-1ded-49d8-85b1-1e6ab668775f",
"isEdited": false,
"isMasterEdited": false
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Device input": {
"description": "Device input",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Template Deploy-write"
}
},
"/template/device/config/input": {
"post": {
"tags": [
"Configuration - Device Template"
],
"description": "Create device input
Note: In a multitenant vManage system, this API is only available in the Provider view.",
"operationId": "createDeviceInput",
"requestBody": {
"description": "Template device input",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Template device input": {
"description": "Template device input",
"value": {
"templateId": "6c7d22bc-73d5-4877-9402-26c75a22bd08",
"deviceIds": [
"ebdc8bd9-17e5-4eb3-a5e0-f438403a83de"
],
"isEdited": false,
"isMasterEdited": false
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Device input": {
"description": "Device input",
"value": {
"data": [
{
"csv-status": "in_complete",
"csv-deviceId": "a1d010e6-bd61-4fbd-8980-96f02db4d0b9",
"csv-deviceIP": "172.16.255.21",
"csv-host-name": "vm11",
"//system/host-name": "vm11",
"//system/system-ip": "172.16.255.21",
"//system/site-id": "11"
}
]
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Template Deploy-write"
}
},
"/template/device/config/process/input/file": {
"post": {
"tags": [
"Configuration - Device Template"
],
"description": "Process input comma separated file
Note: In a multitenant vManage system, this API is only available in the Provider view.",
"operationId": "processInputCommaSepFile",
"requestBody": {
"description": "Device template",
"content": {
"multipart/form-data": {
"schema": {
"type": "object"
},
"examples": {
"Device template": {
"description": "Device template"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "string"
},
"examples": {
"Device config": {
"description": "Device config",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Template Deploy-write"
}
},
"/template/device/config/quickconnectvariable": {
"post": {
"tags": [
"Configuration - Device Template"
],
"description": "Get connection variables to be configured",
"operationId": "getQuickConnectVariables",
"requestBody": {
"description": "Device List",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Device List": {
"description": "Device List",
"value": []
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Variable list": {
"description": "Variable list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Template Deploy-write"
}
},
"/template/device/config/vbond": {
"get": {
"tags": [
"Configuration - Device Template"
],
"description": "Check if vBond is configured
Note: In a multitenant vManage system, this API is only available in the Provider view.",
"operationId": "checkVbond",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Is vBond configured": {
"description": "Is vBond configured",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Template Deploy-read,Template Configuration-read"
}
},
"/template/device/config/verify": {
"post": {
"tags": [
"Configuration - Device Template"
],
"description": "Validate full template\"\n
Note: In a multitenant vManage system, this API is only available in the Provider view.",
"operationId": "validateTemplate",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"valueType": {
"type": "string",
"enum": [
"ARRAY",
"OBJECT",
"STRING",
"NUMBER",
"TRUE",
"FALSE",
"NULL"
]
}
}
}
}
}
},
"required": true
},
"responses": {
"default": {
"description": "default response",
"content": {
"application/json": {}
}
}
},
"deprecated": true,
"x-roles-required": "Template Deploy-write"
}
},
"/template/device/feature": {
"post": {
"tags": [
"Configuration - Template Master"
],
"description": "Create a device template from feature templates and sub templates
Note: In a multitenant vManage system, this API is only available in the Provider view.",
"operationId": "createMasterTemplate",
"requestBody": {
"description": "Create template request",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Template": {
"description": "Template",
"value": {
"templateName": "vEdge_Device_Template",
"templateDescription": "Demo device template",
"deviceType": "vedge-100",
"configType": "template",
"factoryDefault": false,
"policyId": "",
"featureTemplateUidRange": [],
"connectionPreferenceRequired": true,
"connectionPreference": true,
"generalTemplates": [
{
"templateId": "3b30e089-2e26-44f1-b5b2-ac44f3f4279e",
"templateType": "aaa"
},
{
"templateId": "0419c4f6-eb61-4048-a3fe-78ea7f7248b0",
"templateType": "bfd-vedge"
},
{
"templateId": "eb7162be-b018-47c5-b1de-bbb65ff802e3",
"templateType": "omp-vedge"
},
{
"templateId": "486d419f-4e6c-44a5-a6fb-7b5ccf94ff90",
"templateType": "security-vedge"
},
{
"templateId": "7d7396a2-4715-44d8-8f6e-ddf0ca06be44",
"templateType": "system-vedge",
"subTemplates": [
{
"templateId": "edf3d309-91d4-45be-98d9-cfd57a05a479",
"templateType": "logging"
}
]
},
{
"templateId": "171e9bd4-7a7b-460d-b692-83f0d5ce0124",
"templateType": "vpn-vedge",
"subTemplates": [
{
"templateId": "a632ee5f-f489-46ec-8761-1b493d5a6a40",
"templateType": "vpn-vedge-interface"
}
]
},
{
"templateId": "45ea940a-45d2-4fd9-8da2-570a1a6d6874",
"templateType": "vpn-vedge"
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Template Id": {
"description": "Template Id",
"value": {
"templateId": "81610551-9dc5-492f-ad3b-b2c30077b992"
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/device/migration": {
"get": {
"tags": [
"Configuration - Template Master"
],
"description": "Generate a list of templates which require migration
Note: In a multitenant vManage system, this API is only available in the Provider view.",
"operationId": "generateTemplateForMigration",
"parameters": [
{
"name": "hasAAA",
"in": "query",
"description": "Return only those uses AAA",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Template": {
"description": "Template",
"value": {
"data": [
{
"deviceType": "vedge-CSR-1000v",
"lastUpdatedBy": "admin",
"templateClass": "cedge_vedge",
"templateId": "c62e6fba-fb53-4562-b436-3878de0fbbc2",
"configType": "template",
"factoryDefault": false,
"templateName": "BranchType1Template-CSR",
"devicesAttached": 2,
"templateDescription": "Branch Type 1 Template for CSR Routers",
"lastUpdatedOn": 1588093291553,
"templateAttached": 22
}
]
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
},
"post": {
"tags": [
"Configuration - Template Master"
],
"description": "Migrate the device templates given the template Ids",
"operationId": "migrateTemplates",
"parameters": [
{
"name": "id",
"in": "query",
"description": "Template Id",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "prefix",
"in": "query",
"description": "Prefix",
"schema": {
"type": "string",
"default": "cisco"
}
},
{
"name": "includeAll",
"in": "query",
"description": "Include all flag",
"schema": {
"type": "boolean",
"default": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Task Id": {
"description": "Task Id",
"value": {
"status": "Template migration started",
"taskId": "TEMPLATE_MIGRATIONa548c416-bfb8-46dd-9866-d0aa042f17ab"
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/device/migration_info": {
"get": {
"tags": [
"Configuration - Template Master"
],
"description": "Returns the mapping between old and migrated templates
Note: In a multitenant vManage system, this API is only available in the Provider view.",
"operationId": "migrationInfo",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Migrated templates mapping": {
"description": "Migrated templates mapping",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/device/object/{templateId}": {
"get": {
"tags": [
"Configuration - Template Master"
],
"description": "Generate template by Id
Note: In a multitenant vManage system, this API is only available in the Provider view.",
"operationId": "getMasterTemplateDefinition",
"parameters": [
{
"name": "templateId",
"in": "path",
"description": "Template Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Template": {
"description": "Template",
"value": {
"templateName": "Default_EQUINIX_DHCP_DNS_ICGW_CSR1000V_Template_V02",
"templateDescription": "Default DHCP DNS device template for Equinix Interconnect Gateway CSR1000V",
"deviceType": "vedge-CSR-1000v",
"configType": "template",
"factoryDefault": true,
"policyId": "",
"featureTemplateUidRange": [],
"connectionPreference": true,
"connectionPreferenceRequired": true,
"generalTemplates": [
{
"templateId": "857c21b1-6ceb-41a6-b4f1-f6f2c2fb3de6",
"templateType": "cedge_aaa"
},
{
"templateId": "154fbddf-4430-4629-8fdc-6fd12d35d8b6",
"templateType": "cisco_bfd"
},
{
"templateId": "c8f31360-9b6a-451e-8d21-aba3ac0c41d9",
"templateType": "cisco_omp"
},
{
"templateId": "348a0dc3-2796-4b8f-9158-6faa384fa14c",
"templateType": "cisco_security"
},
{
"templateId": "32372d0e-bcf6-416f-9c16-2d2ab14bd752",
"templateType": "cisco_system",
"subTemplates": [
{
"templateId": "8627651a-0140-42d9-925b-706e6281dbac",
"templateType": "cisco_logging"
}
]
},
{
"templateId": "e54fc487-46d4-4f8c-8ffd-fec76ed1826c",
"templateType": "cisco_vpn",
"subTemplates": [
{
"templateId": "b8415ca4-16de-4bbb-90f3-05d652747370",
"templateType": "cisco_vpn_interface"
}
]
},
{
"templateId": "db1d1bbf-a6b3-47b5-8c05-1f6004e3d68d",
"templateType": "cisco_vpn",
"subTemplates": [
{
"templateId": "5f0d22ae-b5ae-4c3c-afa7-53e2c8119ebd",
"templateType": "cisco_vpn_interface"
}
]
},
{
"templateId": "b71170bc-97be-47b5-b9f8-bcf1782a8286",
"templateType": "cedge_global"
}
],
"templateClass": "cedge",
"templateId": "067250e7-4e82-4ce0-9e42-1a58a9634afb",
"deviceRole": "sdwan-edge",
"draftMode": false
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/device/resource-group/{resourceGroupName}/{templateId}": {
"post": {
"tags": [
"Configuration - Template Master"
],
"description": "Change template resource group",
"operationId": "changeTemplateResourceGroup_ConfigurationTemplateMaster_6404",
"parameters": [
{
"name": "templateId",
"in": "path",
"description": "Template Id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "resourceGroupName",
"in": "path",
"description": "Resource group name",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/device/syncstatus": {
"get": {
"tags": [
"Configuration - Template Master"
],
"description": "Get template sync status
Note: In a multitenant vManage system, this API is only available in the Provider view.",
"operationId": "getOutOfSyncTemplates",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Template list": {
"description": "Template list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/device/syncstatus/{templateId}": {
"get": {
"tags": [
"Configuration - Template Master"
],
"description": "Get out of sync devices
Note: In a multitenant vManage system, this API is only available in the Provider view.",
"operationId": "getOutOfSyncDevices",
"parameters": [
{
"name": "templateId",
"in": "path",
"description": "Template Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Devices": {
"description": "Devices",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/device/{templateId}": {
"delete": {
"tags": [
"Configuration - Template Master"
],
"description": "Delete template
Note: In a multitenant vManage system, this API is only available in the Provider view.",
"operationId": "deleteMasterTemplate",
"parameters": [
{
"name": "templateId",
"in": "path",
"description": "Template Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
},
"put": {
"tags": [
"Configuration - Template Master"
],
"description": "Edit template
Note: In a multitenant vManage system, this API is only available in the Provider view.",
"operationId": "editMasterTemplate",
"parameters": [
{
"name": "templateId",
"in": "path",
"description": "Template Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Template",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Template": {
"description": "Template",
"value": {
"templateId": "81610551-9dc5-492f-ad3b-b2c30077b992",
"templateName": "vEdge_Device_Template",
"templateDescription": "Demo device template",
"deviceType": "vedge-100",
"configType": "template",
"factoryDefault": false,
"policyId": "",
"featureTemplateUidRange": [],
"connectionPreferenceRequired": true,
"connectionPreference": true,
"draftMode": false,
"generalTemplates": [
{
"templateId": "3b30e089-2e26-44f1-b5b2-ac44f3f4279e",
"templateType": "aaa"
},
{
"templateId": "e1b5b6e9-3b54-4279-a532-a2aaaef3e6a1",
"templateType": "bfd-vedge"
},
{
"templateId": "998725f9-3572-4950-a5e5-d48827d347cd",
"templateType": "omp-vedge"
},
{
"templateId": "486d419f-4e6c-44a5-a6fb-7b5ccf94ff90",
"templateType": "security-vedge"
},
{
"templateId": "7d7396a2-4715-44d8-8f6e-ddf0ca06be44",
"templateType": "system-vedge",
"subTemplates": [
{
"templateId": "edf3d309-91d4-45be-98d9-cfd57a05a479",
"templateType": "logging"
}
]
},
{
"templateId": "171e9bd4-7a7b-460d-b692-83f0d5ce0124",
"templateType": "vpn-vedge",
"subTemplates": [
{
"templateId": "a632ee5f-f489-46ec-8761-1b493d5a6a40",
"templateType": "vpn-vedge-interface"
}
]
},
{
"templateId": "45ea940a-45d2-4fd9-8da2-570a1a6d6874",
"templateType": "vpn-vedge"
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Attached devices": {
"description": "Attached devices",
"value": {
"data": {
"attachedDevices": []
}
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/device/{templateId}/featuretemplates": {
"get": {
"tags": [
"Configuration - Template Master"
],
"description": "get Associated Feature Templates Details",
"operationId": "getAssociatedFeatureTemplatesDetails",
"parameters": [
{
"name": "templateId",
"in": "path",
"description": "TemplateId",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/feature": {
"get": {
"tags": [
"Configuration - General Template"
],
"description": "Get feature template list
Note: In a multitenant vManage system, this API is only available in the Provider view.",
"operationId": "generateFeatureTemplateList",
"parameters": [
{
"name": "summary",
"in": "query",
"description": "Flag to include template definition",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "offset",
"in": "query",
"description": "Pagination offset",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "limit",
"in": "query",
"description": "Pagination limit on templateId",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "type",
"in": "query",
"description": "Template type to filter for",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Feature template": {
"description": "Feature template",
"value": {
"data": [
{
"templateId": "07a5de3c-4dfa-4eb3-bf52-7ee8076e29a9",
"templateName": "Default_Azure_vWAN_C8000V_VPN0_INTF_GE1_V01",
"templateDescription": "Default VPN 0 Interface GigabitEthernet1 template for Azure vWAN C8000V",
"templateType": "cisco_vpn_interface",
"deviceType": [
"vedge-C8000V"
],
"lastUpdatedBy": "system",
"lastUpdatedOn": 1631281281614,
"factoryDefault": true,
"devicesAttached": 0,
"attachedMastersCount": 1,
"templateMinVersion": "20.4.0",
"configType": "xml",
"createdBy": "system",
"createdOn": 1631281281614,
"resourceGroup": "global"
}
]
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Template Configuration-read,Template Deploy-read,Policy Configuration-read"
},
"post": {
"tags": [
"Configuration - General Template"
],
"description": "Create feature template",
"operationId": "createFeatureTemplate",
"requestBody": {
"description": "Feature template",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"CedgeVoiceCard-example": {
"description": "CedgeVoiceCard-example",
"value": {
"templateName": "template_voice_card",
"templateDescription": "template_voice_card",
"templateType": "cedgeVoiceCard",
"deviceType": [
"vedge-ISR-4461"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"voice-card": {
"vipType": "constant",
"vipObjectType": "tree",
"vipPrimaryKey": [
"port-id"
],
"vipValue": [
{
"port-id": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "1/0/7"
},
"id": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "1/0",
"vipVariableName": "analog_id"
},
"module-type": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "SM-X-8FXS/12FXO"
},
"description": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "analog_description_"
},
"caller-id": {
"enable": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "analog_caller_id_"
}
},
"port-type": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "FXS",
"vipVariableName": "analog_port_type_"
},
"secondary": {
"dialtone": {
"vipObjectType": "node-only",
"vipType": "ignore",
"vipValue": "false",
"vipVariableName": "analog_secondary_dialtone_"
}
},
"shutdown": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "false",
"vipVariableName": "analog_shutdown_"
},
"connection": {
"plar": {
"plar-num": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "analog_connection_plarnum_"
},
"opx-num-only": {
"vipType": "ignore",
"vipValue": "",
"vipObjectType": "object"
}
}
},
"signal": {
"did-type": {
"vipType": "ignore",
"vipValue": "",
"vipObjectType": "object"
},
"signal-choice": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "loopStart",
"vipVariableName": "analog_signal_choice_"
}
},
"port-range": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "7",
"vipVariableName": "analog_port_range_"
},
"local-bypass": {
"vipType": "constant",
"vipValue": "true",
"vipObjectType": "object"
}
}
]
},
"voice-card-dig": {
"vipType": "constant",
"vipObjectType": "tree",
"vipPrimaryKey": [
"dig-port-id"
],
"vipValue": [
{
"dig-port-id": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "0/1/0"
},
"id-dig": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "0/1"
},
"framing": {
"vipObjectType": "object",
"vipType": "notIgnore",
"vipValue": "esf",
"vipVariableName": "framing_0"
},
"interface": {
"vipType": "constant",
"vipValue": [
{
"port-id": {
"vipType": "constant",
"vipValue": "0/1/0",
"vipObjectType": "object"
},
"clock-priority": {
"vipType": "constant",
"vipValue": 0,
"vipObjectType": "object"
},
"controller-shutdown": {
"vipType": "constant",
"vipValue": "false",
"vipObjectType": "object"
},
"serial-intf-shutdown": {
"vipType": "constant",
"vipValue": "false",
"vipObjectType": "object"
},
"voiceport-shutdown": {
"vipType": "constant",
"vipValue": true,
"vipObjectType": "object"
},
"clock-type": {
"vipType": "constant",
"vipValue": "line",
"vipObjectType": "object"
},
"clock-position": {
"vipType": "ignore",
"vipValue": "",
"vipObjectType": "object"
}
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"port-id"
]
},
"interface-type": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "T1 PRI"
},
"line-termination": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "120-ohm",
"vipVariableName": "digital_line-termination"
},
"linecode": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "b8zs",
"vipVariableName": "linecode_0"
},
"module-type": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "NIM-1MFT-T1/E1"
},
"network-side": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "false",
"vipVariableName": "digital_network-side"
},
"switch-type": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "primary-4ess",
"vipVariableName": "digital_switch-type"
},
"timeslots": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "digital_timeslots"
},
"delay-connect-timer": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 20,
"vipVariableName": "digital_delay_connect_timer"
},
"dsp-hairpin": {
"vipType": "constant",
"vipValue": "false",
"vipObjectType": "object"
},
"framing-australia": {
"vipType": "constant",
"vipValue": "false",
"vipObjectType": "object"
},
"network-participation": {
"vipType": "constant",
"vipValue": "true",
"vipObjectType": "object"
},
"isdn-timer": {
"isdn-timer-T200": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 1000,
"vipVariableName": "digital_isdn-timer-T200"
},
"isdn-timer-T203": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 30000,
"vipVariableName": "digital_isdn-timer-T203"
},
"isdn-timer-T301": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 300000,
"vipVariableName": "digital_isdn-timer-T301"
},
"isdn-timer-T303": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 4000,
"vipVariableName": "digital_isdn-timer-T303"
},
"isdn-timer-T306": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 30000,
"vipVariableName": "digital_isdn-timer-T306"
},
"isdn-timer-T309": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 90000,
"vipVariableName": "digital_isdn-timer-T309"
},
"isdn-timer-T310": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 30000,
"vipVariableName": "digital_isdn-timer-T310"
},
"isdn-timer-T321": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 40000,
"vipVariableName": "digital_isdn-timer-T321"
}
},
"cablelength-long": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "-7.5",
"vipVariableName": "digital_cablelength-long"
}
}
]
},
"clock-dig": {
"sync": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "digital_sync"
},
"wait-to-restore": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 300,
"vipVariableName": "digital_wait-to-restore"
}
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleCedgevoicecard"
},
"CedgeVoiceSrst-example": {
"description": "CedgeVoiceSrst-example",
"value": {
"templateName": "template_voice_srst",
"templateDescription": "template_voice_srst",
"templateType": "cedgeVoiceSrst",
"deviceType": [
"vedge-ISR-4461"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"register": {
"global": {
"max-pool": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 2000
},
"system-message": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": ""
},
"max-dn": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 3500
},
"call-manager-fallback": {
"moh": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "false",
"vipVariableName": "srst_moh"
},
"filename": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": ""
}
}
},
"pool": {
"vipType": "ignore",
"vipObjectType": "tree",
"vipPrimaryKey": [
"pool-tag"
],
"vipValue": []
}
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleCedgevoicesrst"
},
"aaa-example": {
"description": "aaa-example",
"value": {
"templateName": "template_aaa",
"templateDescription": "template_aaa",
"templateType": "aaa",
"deviceType": [
"vedge-cloud"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"aaa": {
"auth-order": {
"vipType": "constant",
"vipValue": [
{
"vipType": "constant",
"vipValue": "local",
"vipObjectType": "object"
},
{
"vipType": "constant",
"vipValue": "radius",
"vipObjectType": "object"
},
{
"vipType": "constant",
"vipValue": "tacacs",
"vipObjectType": "object"
}
],
"vipObjectType": "list",
"vipVariableName": "auth_order"
},
"auth-fallback": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "auth_fallback"
},
"admin-auth-order": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "admin_auth_order"
},
"logs": {
"audit-disable": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "disable_audit_logs"
},
"netconf-disable": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "disable_netconf_logs"
}
},
"radius-servers": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"10.124.19.169"
],
"vipVariableName": "radius_servers"
},
"usergroup": {
"vipType": "constant",
"vipValue": [
{
"name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "netadmin"
},
"viewMode": "view",
"priority-order": [
"name"
]
},
{
"name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "basic"
},
"priority-order": [
"name",
"task"
],
"task": {
"vipType": "constant",
"vipValue": [
{
"mode": {
"vipType": "constant",
"vipValue": "system",
"vipObjectType": "object"
},
"permission": {
"vipType": "constant",
"vipValue": [
{
"vipType": "constant",
"vipValue": "read",
"vipObjectType": "object"
},
{
"vipType": "constant",
"vipValue": "write",
"vipObjectType": "object"
}
],
"vipObjectType": "list"
},
"priority-order": [
"mode",
"permission"
]
},
{
"mode": {
"vipType": "constant",
"vipValue": "interface",
"vipObjectType": "object"
},
"permission": {
"vipType": "constant",
"vipValue": [
{
"vipType": "constant",
"vipValue": "read",
"vipObjectType": "object"
},
{
"vipType": "constant",
"vipValue": "write",
"vipObjectType": "object"
}
],
"vipObjectType": "list"
},
"priority-order": [
"mode",
"permission"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"mode"
]
}
},
{
"name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "operator"
},
"priority-order": [
"name",
"task"
],
"task": {
"vipType": "constant",
"vipValue": [
{
"mode": {
"vipType": "constant",
"vipValue": "system",
"vipObjectType": "object"
},
"permission": {
"vipType": "constant",
"vipValue": [
{
"vipType": "constant",
"vipValue": "read",
"vipObjectType": "object"
}
],
"vipObjectType": "list"
},
"priority-order": [
"mode",
"permission"
]
},
{
"mode": {
"vipType": "constant",
"vipValue": "interface",
"vipObjectType": "object"
},
"permission": {
"vipType": "constant",
"vipValue": [
{
"vipType": "constant",
"vipValue": "read",
"vipObjectType": "object"
}
],
"vipObjectType": "list"
},
"priority-order": [
"mode",
"permission"
]
},
{
"mode": {
"vipType": "constant",
"vipValue": "policy",
"vipObjectType": "object"
},
"permission": {
"vipType": "constant",
"vipValue": [
{
"vipType": "constant",
"vipValue": "read",
"vipObjectType": "object"
}
],
"vipObjectType": "list"
},
"priority-order": [
"mode",
"permission"
]
},
{
"mode": {
"vipType": "constant",
"vipValue": "routing",
"vipObjectType": "object"
},
"permission": {
"vipType": "constant",
"vipValue": [
{
"vipType": "constant",
"vipValue": "read",
"vipObjectType": "object"
}
],
"vipObjectType": "list"
},
"priority-order": [
"mode",
"permission"
]
},
{
"mode": {
"vipType": "constant",
"vipValue": "security",
"vipObjectType": "object"
},
"permission": {
"vipType": "constant",
"vipValue": [
{
"vipType": "constant",
"vipValue": "read",
"vipObjectType": "object"
}
],
"vipObjectType": "list"
},
"priority-order": [
"mode",
"permission"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"mode"
]
}
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"name"
]
},
"user": {
"vipType": "constant",
"vipValue": [
{
"vipOptional": false,
"name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "admin",
"vipVariableName": "user_name_0"
},
"password": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "$6$lobvrA==$docad9oDqytPru2qmWu7Wd9GIoWqs0Q7aA47ytuoDbVj3AzmnDrydGFMyJ1Qjby88mNavWArKslt23B74l2yE0"
},
"pubkey-chain": {
"vipObjectType": "tree",
"vipType": "ignore",
"vipValue": [],
"vipVariableName": "user_pubkey_chain_0",
"vipPrimaryKey": [
"usertag"
]
},
"description": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": ""
},
"group": {
"vipType": "constant",
"vipValue": [],
"vipObjectType": "list"
},
"priority-order": [
"name",
"password",
"secret",
"description",
"group",
"pubkey-chain"
]
},
{
"name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "user2",
"vipVariableName": "user_name"
},
"password": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "$6$PyPTaQ==$mWaktr/vdIOlWz/i9z6NkuESZGPlr0KDVOHVwAmmsXjl0YrSXLUegNhi23crgLIe1bEZ5PhUKX6j.kR/ZDJ8d0"
},
"description": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "account1",
"vipVariableName": "user_description"
},
"group": {
"vipType": "constant",
"vipValue": [
{
"vipType": "constant",
"vipValue": "netadmin",
"vipObjectType": "object"
}
],
"vipObjectType": "list",
"vipVariableName": "user_group"
},
"pubkey-chain": {
"vipObjectType": "tree",
"vipType": "ignore",
"vipValue": [],
"vipVariableName": "user_pubkey_chain_1",
"vipPrimaryKey": [
"usertag"
]
},
"priority-order": [
"name",
"password",
"secret",
"description",
"group",
"pubkey-chain"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"name"
]
},
"task": {
"vipType": "constant",
"vipValue": [
{
"name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "task1"
},
"oper-exec": {
"accept": {
"vipObjectType": "tree",
"vipType": "ignore",
"vipValue": [],
"vipPrimaryKey": [
"command"
]
},
"deny": {
"vipObjectType": "tree",
"vipType": "ignore",
"vipValue": [],
"vipPrimaryKey": [
"command"
]
},
"default-action": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "accept",
"vipVariableName": "default_action"
}
},
"config": {
"accept": {
"vipObjectType": "tree",
"vipType": "ignore",
"vipValue": [],
"vipPrimaryKey": [
"command"
]
},
"deny": {
"vipObjectType": "tree",
"vipType": "ignore",
"vipValue": [],
"vipPrimaryKey": [
"command"
]
},
"default-action": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "accept",
"vipVariableName": "default_action"
}
}
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"name"
]
},
"accounting": {
"key": "accounting",
"description": "Enable/disable user accounting",
"details": "Enable/disable user accounting",
"optionType": [
{
"value": "constant",
"display": "Global",
"iconClass": "language",
"iconColor": "icon-global"
},
{
"value": "variable",
"display": "Device Specific",
"iconClass": "router",
"iconColor": "icon-variable"
},
{
"value": "ignore",
"display": "Default",
"iconClass": "check_circle",
"iconColor": "icon-default"
}
],
"originalDefaultOption": "ignore",
"defaultOption": "ignore",
"dataType": {
"type": "boolean",
"default": false
},
"dataPath": [
"aaa"
],
"vipObjectType": "object",
"objectType": "object",
"deleteFlag": false,
"vipValue": "true",
"vipType": "constant",
"vipVariableName": "aaa_accounting"
},
"ciscotacro-user": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": true
},
"ciscotacrw-user": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": true
}
},
"tacacs": {
"timeout": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 5,
"vipVariableName": "tacacs_timeout"
},
"authentication": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "pap",
"vipVariableName": "tacacs_authentication"
},
"server": {
"vipType": "constant",
"vipValue": [
{
"address": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "30.30.30.30",
"vipVariableName": "tacacs_tacacs_address"
},
"auth-port": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 49,
"vipVariableName": "tacacs_tacacs_auth_port"
},
"vpn": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 14,
"vipVariableName": "tacacs_tacacs_vpn"
},
"source-interface": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "GigabitEthernet1/",
"vipVariableName": "tacacs_tacacs_source_interface"
},
"key": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "123456789a",
"vipVariableName": "tacacs_tacacs_key"
},
"secret-key": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "123456789a",
"vipVariableName": "tacacs_tacacs_secret_key"
},
"priority": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 6,
"vipVariableName": "tacacs_tacacs_priority"
},
"priority-order": [
"address",
"auth-port",
"vpn",
"source-interface",
"key",
"secret-key",
"priority"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"address"
]
}
},
"radius": {
"timeout": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 6,
"vipVariableName": "radius_timeout"
},
"retransmit": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 4,
"vipVariableName": "retransmit"
},
"server": {
"vipType": "constant",
"vipValue": [
{
"address": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "20.20.20.20",
"vipVariableName": "radius_radius_address"
},
"tag": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "radis2",
"vipVariableName": "radius_radius_tag"
},
"auth-port": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1812,
"vipVariableName": "radius_radius_auth_port"
},
"acct-port": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1813,
"vipVariableName": "radius_radius_acct_port"
},
"vpn": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 0,
"vipVariableName": "radius_radius_vpn"
},
"source-interface": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "GigabitEthernet0/",
"vipVariableName": "radius_radius_source_interface"
},
"key": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "123456789a",
"vipVariableName": "radius_radius_key"
},
"secret-key": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "123456789a",
"vipVariableName": "radius_radius_secret_key"
},
"priority": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1,
"vipVariableName": "radius_radius_priority"
},
"priority-order": [
"address",
"auth-port",
"vpn",
"source-interface",
"key",
"secret-key",
"priority",
"tag",
"acct-port"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"address"
]
}
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleAaa"
},
"appqoe-example": {
"description": "appqoe-example",
"value": {
"templateName": "AppQoE",
"templateDescription": "template for AppQoE",
"templateType": "appqoe",
"deviceType": [
"vedge-C8000V"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"appnav-controller-group": {
"vipObjectType": "tree",
"vipType": "constant",
"vipValue": [
{
"group-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "ACG-APPQOE"
},
"appnav-controllers": {
"vipObjectType": "tree",
"vipType": "constant",
"vipPrimaryKey": [
"address"
],
"vipValue": [
{
"address": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "10.10.10.10"
},
"vpn": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 512
}
}
]
}
}
],
"vipPrimaryKey": [
"group-name"
]
},
"service-node-group": {
"vipObjectType": "tree",
"vipType": "constant",
"vipValue": [
{
"name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "SNG-APPQOE"
},
"internal": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": false
},
"service-node": {
"vipObjectType": "tree",
"vipType": "constant",
"vipPrimaryKey": [
"address"
],
"vipValue": [
{
"address": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "10.10.11.11"
},
"vpg-ip": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": ""
}
}
]
}
}
],
"vipPrimaryKey": [
"name"
]
},
"service-context": {
"appqoe": {
"vipObjectType": "tree",
"vipType": "constant",
"vipPrimaryKey": [
"name"
],
"vipValue": [
{
"name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "/1"
},
"appnav-controller-group": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "ACG-APPQOE"
},
"service-node-groups": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"SNG-APPQOE"
]
},
"service-node-group": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "SNG-APPQOE"
},
"enable": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "true"
},
"vpn": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 0,
"vipVariableName": "appqoe_vrf"
}
}
]
}
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleAppqoe"
},
"archive-example": {
"description": "archive-example",
"value": {
"templateName": "template_archive",
"templateDescription": "template_archive",
"templateType": "archive",
"deviceType": [
"vedge-cloud"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"archive": {},
"interval": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 6,
"vipVariableName": "archive_interval"
},
"path": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "/tmp/",
"vipVariableName": "archive_path"
},
"ssh-id-file": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "123456789a",
"vipVariableName": "archive_ssh_id_file"
},
"vpn": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 13,
"vipVariableName": "archive_vpn"
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleArchive"
},
"banner-example": {
"description": "banner-example",
"value": {
"templateName": "template_banner",
"templateDescription": "template_banner",
"templateType": "banner",
"deviceType": [
"vedge-cloud"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"login": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "logging_banner",
"vipVariableName": "banner_login"
},
"motd": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "motd_banner",
"vipVariableName": "banner_motd"
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleBanner"
},
"bfd-vedge-example": {
"description": "bfd-vedge-example",
"value": {
"templateName": "template_vedge_cloud",
"templateDescription": "template_vedge_cloud",
"templateType": "bfd-vedge",
"deviceType": [
"vedge-cloud"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"app-route": {
"multiplier": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 6,
"vipVariableName": "bfd_multiplier"
},
"poll-interval": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 3000000,
"vipVariableName": "bfd_poll_interval"
}
},
"default-dscp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 32,
"vipVariableName": "bfd_default_dscp"
},
"color": {
"vipType": "constant",
"vipValue": [
{
"color": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "gold",
"vipVariableName": "bfd_color"
},
"hello-interval": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 2000,
"vipVariableName": "bfd_hello_interval"
},
"multiplier": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 6,
"vipVariableName": "bfd_color_multiplier"
},
"pmtu-discovery": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "bfd_pmtu_discovery"
},
"dscp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 36,
"vipVariableName": "bfd_dscp"
},
"priority-order": [
"color",
"hello-interval",
"multiplier",
"pmtu-discovery",
"dscp"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"color"
]
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleBfdVedge"
},
"bgp-example": {
"description": "bgp-example",
"value": {
"templateName": "template_bgp",
"templateDescription": "template_bgp",
"templateType": "bgp",
"deviceType": [
"vedge-cloud"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"bgp": {
"as-num": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "1",
"vipVariableName": "bgp_as_num"
},
"shutdown": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "false",
"vipVariableName": "bgp_shutdown"
},
"router-id": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "1.1.1.1",
"vipVariableName": "bgp_router_id"
},
"propagate-aspath": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "propagate_aspath"
},
"distance": {
"external": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 18,
"vipVariableName": "routes-distance_external"
},
"internal": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 200,
"vipVariableName": "routes-distance_internal"
},
"local": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 18,
"vipVariableName": "routes-distance_local"
}
},
"timers": {
"keepalive": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 60,
"vipVariableName": "bgp_keepalive"
},
"holdtime": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 180,
"vipVariableName": "bgp_holdtime"
}
},
"best-path": {
"compare-router-id": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "false",
"vipVariableName": "bgp_compare_router_id"
},
"med": {
"always-compare": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "false",
"vipVariableName": "bgp_always_compare"
},
"deterministic": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "false",
"vipVariableName": "bgp_deterministic"
},
"missing-as-worst": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "false",
"vipVariableName": "bgp_missing_as_worst"
}
},
"as-path": {
"multipath-relax": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "false",
"vipVariableName": "bgp_multipath_relax"
}
}
},
"address-family": {
"vipType": "constant",
"vipValue": [
{
"maximum-paths": {
"paths": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 20,
"vipVariableName": "bgp_maximum_paths"
}
},
"family-type": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "ipv4-unicast"
},
"aggregate-address": {
"vipType": "constant",
"vipValue": [
{
"prefix": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "2.2.2.0/24",
"vipVariableName": "bgp_aggregate_aggregate_address_prefix"
},
"as-set": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "bgp_aggregate_as_set"
},
"summary-only": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "bgp_aggregate_summary_only"
},
"priority-order": [
"prefix",
"as-set",
"summary-only"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"prefix"
]
},
"network": {
"vipType": "constant",
"vipValue": [
{
"prefix": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "2.2.2.2/24",
"vipVariableName": "bgp_network_network_address_prefix"
},
"priority-order": [
"prefix"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"prefix"
]
},
"redistribute": {
"vipType": "constant",
"vipValue": [
{
"protocol": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "ospf",
"vipVariableName": "bgp_redistribute_protocol"
},
"route-policy": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "forward",
"vipVariableName": "bgp_redistribute_route_policy"
},
"priority-order": [
"protocol",
"route-policy"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"protocol"
]
},
"priority-order": [
"family-type",
"aggregate-address",
"network",
"maximum-paths",
"redistribute"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"family-type"
]
},
"neighbor": {
"vipType": "ignore",
"vipValue": [],
"vipObjectType": "tree",
"vipPrimaryKey": [
"address"
]
},
"ipv6-neighbor": {
"vipType": "ignore",
"vipValue": [],
"vipObjectType": "tree",
"vipPrimaryKey": [
"address"
]
}
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleBgp"
},
"bridge-example": {
"description": "bridge-example",
"value": {
"templateName": "vedge_bridge",
"templateDescription": "vedge_bridge",
"templateType": "bridge",
"deviceType": [
"vedge-cloud"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"age-time": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 300,
"vipVariableName": "bridge_ageTime"
},
"max-macs": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 2048,
"vipVariableName": "bridge_maxMacs"
},
"name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "B1",
"vipVariableName": "bridge_name"
},
"vlan": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 20,
"vipVariableName": "bridge_vlan"
},
"interface": {
"vipType": "constant",
"vipValue": [
{
"if-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "gi0/0/1",
"vipVariableName": "bridge_if_name"
},
"description": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "DS1",
"vipVariableName": "bridge_description"
},
"native-vlan": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "bridge_native_vlan"
},
"static-mac-address": {
"vipType": "constant",
"vipValue": [
{
"macaddr": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "00:11:22:33:44:55",
"vipVariableName": "bridge_macaddr_0"
},
"priority-order": [
"macaddr"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"macaddr"
]
},
"shutdown": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "false",
"vipVariableName": "bridge_shutdown"
},
"priority-order": [
"if-name",
"description",
"native-vlan",
"static-mac-address",
"shutdown"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"if-name"
]
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleBridge"
},
"cedge_aaa-example": {
"description": "cedge_aaa-example",
"value": {
"templateName": "template_cisco_aaa",
"templateDescription": "template_cisco_aaa",
"templateType": "cedge_aaa",
"deviceType": [
"vedge-C8000V"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"user": {
"vipType": "constant",
"vipValue": [
{
"vipOptional": false,
"name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "admin",
"vipVariableName": "user_name_0"
},
"password": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "$6$RdHS7A==$N0jOegKO7hBvpD.O3fspFjJIWLk3uwoGV.mahG/urlP0A6qNLAfEaumxzOZeDZzHm8GJ4Zu2TfjHNyGZsEw/G.",
"vipVariableName": "user_password1"
},
"secret": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "$9$2F2M4.wG2FQH1k$j8V3jr29Ld7XgVVmUioAtprLSSCa7HGUq6lhQiJdo6I",
"vipVariableName": "password_secret1"
},
"pubkey-chain": {
"vipObjectType": "tree",
"vipType": "ignore",
"vipValue": [],
"vipVariableName": "user_pubkey_chain_0",
"vipPrimaryKey": [
"key-string"
]
},
"privilege": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "15",
"vipVariableName": "user_privilege_0"
},
"priority-order": [
"name",
"password",
"secret",
"pubkey-chain",
"privilege"
]
},
{
"name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "user2",
"vipVariableName": "user_name"
},
"password": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "$6$w14hwQ==$5C0sq9jN7DCflg5cT1SsYgN9vtLemN.NPva5WiejtAoplBcXtEi9dspNbSe5Lor6MArRDHqJJfAqI2Ucodz/Y.",
"vipVariableName": "user_password2"
},
"secret": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "$9$2lEK3FAH3l.D3k$jo4MfjLU9nWLlPWRKR0OUuJ/iI14cozctcMo5Pv7eYs",
"vipVariableName": "password_secret2"
},
"privilege": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "15",
"vipVariableName": "user_privilege"
},
"pubkey-chain": {
"vipObjectType": "tree",
"vipType": "ignore",
"vipValue": [],
"vipVariableName": "user_pubkey_chain_1",
"vipPrimaryKey": [
"key-string"
]
},
"priority-order": [
"name",
"password",
"secret",
"pubkey-chain",
"privilege"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"name"
]
},
"tacacs": {
"vipObjectType": "tree",
"vipPrimaryKey": [
"group-name"
],
"vipType": "constant",
"vipValue": [
{
"group-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "tacacs-512"
},
"vpn": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 512,
"vipVariableName": "tacacs_group_group_vpn"
},
"source-interface": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "GigabitEthernet1/",
"vipVariableName": "tacacs_group_group_source_interface"
},
"server": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
{
"address": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "20.20.20.20"
},
"port": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 49,
"vipVariableName": "tacacs_auth_port"
},
"timeout": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 5,
"vipVariableName": "tacacs_timeout"
},
"key": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "123456789a",
"vipVariableName": "tacacs_key",
"vipNeedsEncryption": "true"
},
"secret-key": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "1543595f507f7d73706a34"
},
"key-enum": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 6
},
"inGroup": {
"vipType": "ignore",
"vipValue": ""
}
}
],
"vipPrimaryKey": [
"address"
]
}
}
]
},
"radius": {
"vipObjectType": "tree",
"vipPrimaryKey": [
"group-name"
],
"vipType": "constant",
"vipValue": [
{
"group-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "radius-0"
},
"vpn": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 0,
"vipVariableName": "radius_group_vpn"
},
"source-interface": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "GigabitEthernet0/",
"vipVariableName": "radius_group_source_interface"
},
"server": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
{
"address": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "10.10.10.10"
},
"auth-port": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1812,
"vipVariableName": "radius_auth_port"
},
"acct-port": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1813,
"vipVariableName": "radius_acct_port"
},
"timeout": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 10,
"vipVariableName": "radius_timeout"
},
"retransmit": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 4,
"vipVariableName": "radius_retransmit"
},
"key": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "123456789a",
"vipNeedsEncryption": "true"
},
"secret-key": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "055a545c7519185e415c16"
},
"key-enum": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 6
},
"key-type": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "key",
"vipVariableName": "radius_radius_key_type"
},
"inGroup": {
"vipType": "ignore",
"vipValue": ""
}
}
],
"vipPrimaryKey": [
"address"
]
}
}
]
},
"accounting": {
"dot1x": {
"default": {
"start-stop": {
"accounting_group": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "dot1x_acct_group"
}
}
}
},
"accounting-rule": {
"vipObjectType": "tree",
"vipType": "constant",
"vipValue": [
{
"rule-id": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "0"
},
"method": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "network",
"vipVariableName": "accounting_method"
},
"level": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "15",
"vipVariableName": "accounting_level"
},
"start-stop": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "accounting_start_stop"
},
"group": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "tacacs-512",
"vipVariableName": "accounting_server"
}
}
],
"vipPrimaryKey": [
"rule-id"
]
}
},
"authorization": {
"authorization-console": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "auth_console"
},
"authorization-config-commands": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "auth_config_cmds"
},
"authorization-rule": {
"vipObjectType": "tree",
"vipType": "constant",
"vipValue": [
{
"rule-id": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "0"
},
"method": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "commands",
"vipVariableName": "authRule_method"
},
"level": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "15",
"vipVariableName": "authRule_level"
},
"group": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "tacacs-512",
"vipVariableName": "authRule_server"
},
"if-authenticated": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "if_auth"
}
}
],
"vipPrimaryKey": [
"rule-id"
]
}
},
"authentication": {
"dot1x": {
"default": {
"authentication_group": {
"key": "authentication_group",
"description": "Authentication Param",
"details": "Authentication configurations parameters",
"optionType": [
{
"value": "constant",
"display": "Global",
"iconClass": "language",
"iconColor": "icon-global"
},
{
"value": "variable",
"display": "Device Specific",
"iconClass": "router",
"iconColor": "icon-variable"
},
{
"value": "ignore",
"display": "Default",
"iconClass": "check_circle",
"iconColor": "icon-default"
}
],
"originalDefaultOption": "ignore",
"defaultOption": "ignore",
"dataType": {
"type": "boolean",
"default": false
},
"dataPath": [
"default"
],
"vipObjectType": "object",
"objectType": "object",
"deleteFlag": false,
"vipValue": "true",
"vipType": "constant",
"vipVariableName": "dot1x_auth_group"
}
}
}
},
"server-auth-order": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "radius-0"
},
"radius-dynamic-author": {
"radius-client": {
"vipObjectType": "tree",
"vipType": "constant",
"vipValue": [
{
"ip": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "192.168.1.111",
"vipVariableName": "radius_coa_ip"
},
"vpn": {
"vipObjectType": "tree",
"vipType": "constant",
"vipValue": [
{
"name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 0,
"vipVariableName": "radiuscoa_vpn_name"
},
"server-key": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "123456789a",
"vipVariableName": "radiuscoa_vpn_key",
"vipNeedsEncryption": "true"
}
}
],
"vipPrimaryKey": [
"name"
]
}
}
],
"vipPrimaryKey": [
"ip"
]
},
"rda-server-key": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "123456789a",
"vipVariableName": "radius_client_server_key",
"vipNeedsEncryption": "true"
},
"domain-stripping": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "yes",
"vipVariableName": "radius_client_domain_stripping"
},
"auth-type": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "all",
"vipVariableName": "radius_client_auth_type"
},
"port": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1700,
"vipVariableName": "radius_client_port"
}
},
"radius-trustsec": {
"cts-auth-list": {
"vipObjectType": "object",
"vipType": "ignore",
"vipVariableName": "trustsec_auth_list"
},
"radius-trustsec-group": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "_empty"
}
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleCedgeAaa"
},
"cedge_global-example": {
"description": "cedge_global-example",
"value": {
"templateName": "template_cedge_global",
"templateDescription": "template_cedge_global",
"templateType": "cedge_global",
"deviceType": [
"vedge-C8000V"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"nat64-global": {
"nat64-timeout": {
"udp-timeout": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 2,
"vipVariableName": "udp_timeout"
},
"tcp-timeout": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 120,
"vipVariableName": "tcp_timeout"
}
}
},
"http-global": {
"http-authentication": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "local",
"vipVariableName": "http_authentication"
}
},
"ssh": {
"version": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 2,
"vipVariableName": "ssh_version"
}
},
"services-global": {
"services-ip": {
"http-server": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "http_server"
},
"https-server": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "https_server"
},
"source-intrf": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "ge1/",
"vipVariableName": "source_interface"
},
"arp-proxy": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "arp_proxy"
},
"ftp-passive": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "ftp_passive"
},
"rcmd": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "rcmd"
},
"domain-lookup": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "domain_lookup"
},
"lldp": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "lldp"
},
"cdp": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "cdp"
},
"line-vty": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "line_vty"
}
},
"services-other": {
"source-route": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "source_route"
},
"bootp": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "bootp"
},
"tcp-keepalives-out": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "tcp_keepalives_out"
},
"tcp-keepalives-in": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "tcp_keepalives_in"
},
"tcp-small-servers": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "tcp_small_servers"
},
"udp-small-servers": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "udp_small_servers"
},
"snmp-ifindex-persist": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "snmp_ifindex_persist"
},
"console-logging": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "console_logging"
},
"vty-logging": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vty_logging"
}
}
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleCedgeGlobal"
},
"cedge_igmp-example": {
"description": "cedge_igmp-example",
"value": {
"templateName": "template_igmp",
"templateDescription": "template_igmp",
"templateType": "cedge_igmp",
"templateMinVersion": "15.0.0",
"transitionInProgress": true,
"viewMode": "add",
"deviceType": [
"vedge-C8000V"
],
"deviceModels": [
{
"name": "vedge-C8000V",
"displayName": "C8000v",
"deviceType": "vedge",
"isCliSupported": true,
"isCiscoDeviceModel": true
}
],
"templateUrl": "/app/configuration/template/feature/templates/cedge_igmp-15.0.0.html",
"removeTableRow": {},
"templateDefinition": {
"igmp": {
"interface": {
"vipType": "constant",
"vipValue": [
{
"name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "GigabitEthernet1",
"vipVariableName": "igmp_interface_name_details"
},
"join-group": {
"vipType": "constant",
"vipValue": [
{
"group-address": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "224.1.1.1",
"vipVariableName": "igmp_interface_group_address_0"
},
"source": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "10.10.10.10",
"vipVariableName": "igmp_interface_source_0"
},
"priority-order": [
"group-address",
"source"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"group-address",
"source"
]
},
"priority-order": [
"name",
"join-group"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"name"
]
}
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleCedgeIgmp"
},
"cedge_multicast-example": {
"description": "cedge_multicast-example",
"value": {
"templateName": "template_multicast",
"templateDescription": "template_multicast",
"templateType": "cedge_multicast",
"deviceType": [
"vedge-C8000V"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"multicast-replicator": {
"local": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "multicast_replicator_local"
},
"threshold": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 180,
"vipVariableName": "multicast_replicator_threshold"
}
},
"multicast": {
"spt-only": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "multicast_replicator_spt"
}
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleCedgeMulticast"
},
"cedge_pim-example": {
"description": "cedge_pim-example",
"value": {
"templateName": "template_pim",
"templateDescription": "template_pim",
"templateType": "cedge_pim",
"deviceType": [
"vedge-C8000V"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"pim": {
"send-rp-discovery": {
"if-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "interface2",
"vipVariableName": "pim_rp_discovery_interface"
},
"scope": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 30,
"vipVariableName": "pim_rp_discovery_scope"
}
},
"auto-rp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "pim_auto_rp"
},
"spt-threshold": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "0",
"vipVariableName": "pim_spt_threshold"
},
"ssm": {
"range": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "AccessList1",
"vipVariableName": "pim_range"
}
},
"bsr-candidate": {
"bsr-interface-name": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "_empty",
"vipVariableName": "pim_bsr_interface"
},
"mask": {
"vipObjectType": "object",
"vipType": "ignore"
},
"priority": {
"vipObjectType": "object",
"vipType": "ignore"
},
"accept-rp-candidate": {
"vipObjectType": "object",
"vipType": "ignore"
}
},
"interface": {
"vipType": "constant",
"vipValue": [
{
"name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "Interface3",
"vipVariableName": "pim_if_name"
},
"query-interval": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 30,
"vipVariableName": "pim_hello_interval"
},
"join-prune-interval": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 60,
"vipVariableName": "pim_join_prune_interval"
},
"priority-order": [
"name",
"query-interval",
"join-prune-interval"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"name"
]
},
"rp-addr": {
"vipType": "constant",
"vipValue": [
{
"address": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "1.1.1.1",
"vipVariableName": "pim_rp_addr_ip"
},
"access-list": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "AccessList2",
"vipVariableName": "pim_rp_addr_access_list"
},
"override": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "pim_rp_addr_override"
},
"priority-order": [
"access-list",
"address",
"override"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"access-list"
]
},
"send-rp-announce": {
"send-rp-announce-list": {
"vipType": "constant",
"vipValue": [
{
"if-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "Interface1",
"vipVariableName": "pim_rp_announce_interface"
},
"scope": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 40,
"vipVariableName": "pim_rp_announce_scope"
},
"priority-order": [
"if-name",
"scope"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"if-name"
]
}
}
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleCedgePim"
},
"cellular-cedge-controller-example": {
"description": "cellular-cedge-controller-example",
"value": {
"deviceType": [
"vedge-ISR-4331"
],
"templateType": "cellular-cedge-controller",
"templateMinVersion": "15.0.0",
"templateDefinition": {
"id": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "cellular_id"
},
"lte": {
"failovertimer": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "cellular_failover_timeout"
},
"firmware": {
"auto-sim": {}
},
"sim": {
"max-retry": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "cellular_failover_retries"
},
"primary": {
"slot": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "cellular_primary_slot"
}
}
}
}
},
"factoryDefault": false,
"templateName": "template_cellular_controller",
"templateDescription": "template_controller"
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleCellularCedgeController"
},
"cellular-cedge-gps-controller-example": {
"description": "cellular-cedge-gps-controller-example",
"value": {
"templateName": "template_gps",
"templateDescription": "template_gps",
"templateType": "cellular-cedge-gps-controller",
"deviceType": [
"vedge-C8000V"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"gps": {
"enable": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "gps_enable"
},
"mode": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "ms-based",
"vipVariableName": "gps_mode"
},
"nmea-conf": {
"nmea": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "gps_nmea"
}
},
"nmea": {
"ip": {
"udp": {
"source-address": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "10.10.10.10",
"vipVariableName": "gps_source_address"
},
"destination-address": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "20.20.20.20",
"vipVariableName": "gps_destination_address"
},
"destination-port": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 4431,
"vipVariableName": "gps_destination_port"
}
}
}
}
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleCellularCedgeGpsController"
},
"cellular-cedge-profile-example": {
"description": "cellular-cedge-profile-example",
"value": {
"deviceType": [
"vedge-ISR-4461"
],
"templateType": "cellular-cedge-profile",
"templateMinVersion": "15.0.0",
"templateDefinition": {
"apn": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "cellular_profile_apn"
},
"authentication": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "cellular_profile_authentication"
},
"id": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "cellular_profile_profile_id"
},
"no-overwrite": {
"vipObjectType": "node-only",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "cellular_profile_no_overwrite"
},
"password": {},
"pdn-type": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "pdn_type"
},
"username": {}
},
"factoryDefault": false,
"templateName": "template_celluar",
"templateDescription": "template_celluar"
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleCellularCedgeProfile"
},
"cellular-gateway-platform-example": {
"description": "cellular-gateway-platform-example",
"value": {
"templateName": "template_cellular_gateway_platform",
"templateDescription": "template_cellular_gateway_platform",
"templateType": "cellular-gateway-platform",
"deviceType": [
"cellular-gateway-CG522-E"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"timezone": {
"time": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "gateway_platform_timezone"
}
},
"interface": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "gateway_platform_interface"
},
"password": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "gateway_platform_password"
},
"controller": {
"cellular": {
"ip-source-violation-action": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "gateway_profile_ip_source_violation_action"
},
"auto-sim": {
"vipObjectType": "node-only",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "gateway_profile_auto_sim"
},
"sim": {
"sim-primary": {
"primary-slot": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "gateway_profile_primary_slot"
},
"failovertimer": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "gateway_profile_failovertimer"
},
"max-retry": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "gateway_profile_max-retry"
}
}
}
}
},
"ntp": {
"vipObjectType": "tree",
"vipType": "constant",
"vipPrimaryKey": [
"name"
],
"vipValue": [
{
"server": {
"name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "192.168.0.100"
}
}
}
]
},
"ip": {
"host": {
"vipType": "constant",
"vipValue": [
{
"hostname": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "vpn_host_hostname"
},
"ip": {
"vipObjectType": "list",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "vpn_host_ip"
},
"priority-order": [
"hostname",
"ip"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"hostname"
]
}
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleCellularGatewayPlatform"
},
"cellular-gateway-profile-example": {
"description": "cellular-gateway-profile-example",
"value": {
"templateName": "template_cellular_gateway_profile",
"templateDescription": "template_cellular_gateway_profile",
"templateType": "cellular-gateway-profile",
"deviceType": [
"cellular-gateway-CG522-E"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"sim-slot-number": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "gateway_profile_sim-slot-number"
},
"attach-profile": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "_empty"
},
"cellular-profile": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "_empty"
},
"profile": {
"vipType": "constant",
"vipValue": [
{
"id": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "cellularprofile_id"
},
"apn": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "cellularprofile_apn"
},
"pdn-type": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "cellularprofile_pdn_type"
},
"authentication": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "cellularprofile_authentication"
},
"username": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "cellularprofile_username"
},
"password": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "cellularprofile_password"
},
"priority-order": [
"id",
"apn",
"pdn-type",
"authentication",
"username",
"password"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"id"
]
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleCellularGatewayProfile"
},
"cellular-profile-example": {
"description": "cellular-profile-example",
"value": {
"templateName": "template_cellular_profile",
"templateDescription": "template_cellular_profile",
"templateType": "cellular-profile",
"deviceType": [
"vedge-1000"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"if-name": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "cellular_if_name_template_cellular_profile"
},
"profile": {
"profile-id": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "profile_id"
},
"apn": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "cellular_apn"
},
"auth": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "None",
"vipVariableName": "cellular-profile_auth"
},
"ip-addr": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "cellular_ip_addr"
},
"name": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "cellular-profile_name"
},
"pdn-type": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "pdn_type"
},
"user-name": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "cellular_user_name"
},
"password": {},
"primary-dns": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "cellular_primary_dns"
},
"secondary-dns": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "cellular_secondary_dns"
},
"user-pass": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "cellular_user_pass"
}
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleCellularProfile"
},
"cisco_banner-example": {
"description": "cisco_banner-example",
"value": {
"deviceType": [
"vedge-C8000V"
],
"templateType": "cisco_banner",
"templateMinVersion": "15.0.0",
"templateDefinition": {
"login": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "login_example",
"vipVariableName": "banner_login"
},
"motd": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "motd_example",
"vipVariableName": "banner_motd"
}
},
"factoryDefault": false,
"templateName": "banner03",
"templateDescription": "banner"
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleCiscoBanner"
},
"cisco_bfd-example": {
"description": "cisco_bfd-example",
"value": {
"templateName": "cisco_bfd",
"templateDescription": "cisco_bfd",
"templateType": "cisco_bfd",
"deviceType": [
"vedge-C8000V"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"app-route": {
"multiplier": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "bfd_multiplier"
},
"poll-interval": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "bfd_poll_interval"
}
},
"default-dscp": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "bfd_default_dscp"
},
"color": {
"vipType": "constant",
"vipValue": [
{
"color": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "bfd_color"
},
"hello-interval": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "bfd_hello_interval"
},
"multiplier": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "bfd_color_multiplier"
},
"pmtu-discovery": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "bfd_pmtu_discovery"
},
"dscp": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "bfd_dscp"
},
"priority-order": [
"color",
"hello-interval",
"multiplier",
"pmtu-discovery",
"dscp"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"color"
]
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleCiscoBfd"
},
"cisco_bgp-example": {
"description": "cisco_bgp-example",
"value": {
"templateName": "template_bgp_c8000v",
"templateDescription": "template_bgp_c8000v",
"templateType": "cisco_bgp",
"deviceType": [
"vedge-C8000V"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"bgp": {
"as-num": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "bgp_as_num"
},
"shutdown": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "bgp_shutdown"
},
"router-id": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "bgp_router_id"
},
"propagate-aspath": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "propagate_aspath"
},
"distance": {
"external": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "routes-distance_external"
},
"internal": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "routes-distance_internal"
},
"local": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "routes-distance_local"
}
},
"timers": {
"keepalive": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 60,
"vipVariableName": "bgp_keepalive"
},
"holdtime": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 180,
"vipVariableName": "bgp_holdtime"
}
},
"best-path": {
"compare-router-id": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "false",
"vipVariableName": "bgp_compare_router_id"
},
"med": {
"always-compare": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "false",
"vipVariableName": "bgp_always_compare"
},
"deterministic": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "false",
"vipVariableName": "bgp_deterministic"
},
"missing-as-worst": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "false",
"vipVariableName": "bgp_missing_as_worst"
}
},
"as-path": {
"multipath-relax": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "false",
"vipVariableName": "bgp_multipath_relax"
}
}
},
"propagate-community": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "propagate_community"
},
"target": {
"route-target-ipv4": {
"vipObjectType": "tree",
"vipType": "ignore",
"vipValue": [],
"vipPrimaryKey": [
"vpn-id"
]
},
"route-target-ipv6": {
"vipObjectType": "tree",
"vipType": "ignore",
"vipValue": [],
"vipPrimaryKey": [
"vpn-id"
]
}
},
"mpls-interface": {
"vipObjectType": "tree",
"vipType": "constant",
"vipValue": [
{
"if-name": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "interface_0"
}
}
],
"vipPrimaryKey": [
"if-name"
]
},
"address-family": {
"vipType": "constant",
"vipValue": [
{
"maximum-paths": {
"paths": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "bgp_maximum_paths"
}
},
"default-information": {
"originate": {
"vipObjectType": "node-only",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "bgp_default_information"
}
},
"family-type": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "ipv4-unicast"
},
"aggregate-address": {
"vipType": "ignore",
"vipValue": [],
"vipObjectType": "tree",
"vipPrimaryKey": [
"prefix"
]
},
"network": {
"vipType": "ignore",
"vipValue": [],
"vipObjectType": "tree",
"vipPrimaryKey": [
"prefix"
]
},
"redistribute": {
"vipType": "ignore",
"vipValue": [],
"vipObjectType": "tree",
"vipPrimaryKey": [
"protocol"
]
},
"table-map": {
"name": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "",
"vipVariableName": "bgp_ipv4-name"
},
"filter": {
"vipObjectType": "node-only",
"vipType": "ignore",
"vipValue": "false",
"vipVariableName": "bgp_ipv4-filter"
}
},
"priority-order": [
"family-type",
"aggregate-address",
"network",
"maximum-paths",
"default-information",
"redistribute",
"table-map"
]
},
{
"maximum-paths": {
"paths": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "bgp_ipv6_ipv6_maximum_paths",
"ipType": "ipv6"
}
},
"default-information": {
"originate": {
"vipObjectType": "node-only",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "bgp_ipv6_ipv6_default_information",
"ipType": "ipv6"
}
},
"family-type": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "ipv6-unicast",
"ipType": "ipv6"
},
"ipv6-aggregate-address": {
"vipType": "ignore",
"vipValue": [],
"vipObjectType": "tree",
"vipPrimaryKey": [
"prefix"
]
},
"ipv6-network": {
"vipType": "ignore",
"vipValue": [],
"vipObjectType": "tree",
"vipPrimaryKey": [
"prefix"
]
},
"redistribute": {
"vipType": "constant",
"vipValue": [
{
"protocol": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "bgp_ipv6_redistribute_protocol_ipv6"
},
"route-policy": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "bgp_ipv6_redistribute_route_policy_ipv6"
},
"priority-order": [
"protocol",
"route-policy"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"protocol"
]
},
"table-map": {
"name": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "",
"vipVariableName": "bgp_ipv6-name",
"ipType": "ipv6"
},
"filter": {
"vipObjectType": "node-only",
"vipType": "ignore",
"vipValue": "false",
"vipVariableName": "bgp_ipv6-filter",
"ipType": "ipv6"
}
},
"priority-order": [
"family-type",
"ipv6-aggregate-address",
"ipv6-network",
"maximum-paths",
"default-information",
"redistribute",
"table-map"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"family-type"
]
},
"neighbor": {
"vipType": "constant",
"vipValue": [
{
"address": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "bgp_neighbor_address"
},
"description": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "bgp_neighbor_description"
},
"shutdown": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "bgp_neighbor_neighbor_shutdown"
},
"remote-as": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "bgp_neighbor_remote_as"
},
"timers": {
"keepalive": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "bgp_neighbor_keepalive_ngbr"
},
"holdtime": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "bgp_neighbor_holdtime_ngbr"
}
},
"update-source": {
"if-name": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "bgp_neighbor_if_name"
}
},
"next-hop-self": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "bgp_neighbor_next_hop_self"
},
"send-community": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "bgp_neighbor_send_community"
},
"send-ext-community": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "bgp_neighbor_send_ext_community"
},
"ebgp-multihop": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "bgp_neighbor_ebgp_multihop"
},
"password": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "bgp_neighbor_password"
},
"send-label": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": ""
},
"send-label-explicit": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": ""
},
"as-override": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": ""
},
"allowas-in": {
"as-number": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": ""
}
},
"address-family": {
"vipType": "ignore",
"vipValue": [],
"vipObjectType": "tree",
"vipPrimaryKey": [
"family-type"
]
},
"allowas-in-check": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "false"
},
"priority-order": [
"address",
"description",
"shutdown",
"remote-as",
"timers",
"update-source",
"next-hop-self",
"send-community",
"send-ext-community",
"ebgp-multihop",
"password",
"address-family"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"address"
]
},
"ipv6-neighbor": {
"vipType": "ignore",
"vipValue": [],
"vipObjectType": "tree",
"vipPrimaryKey": [
"address"
]
}
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleCiscoBgp"
},
"cisco_dhcp_server-example": {
"description": "cisco_dhcp_server-example",
"value": {
"templateName": "template_dhcp_server",
"templateDescription": "template_dhcp_server",
"templateType": "cisco_dhcp_server",
"deviceType": [
"vedge-C8000V"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"address-pool": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "dhcp_address_pool"
},
"exclude": {
"vipObjectType": "list",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "dhcp-address_exclude"
},
"lease-time": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "lease_time"
},
"options": {
"interface-mtu": {
"vipObjectType": "object",
"vipType": "ignore",
"vipVariableName": "dhcp_interface_mtu"
},
"domain-name": {
"vipObjectType": "object",
"vipType": "ignore",
"vipVariableName": "dhcp_domain_name"
},
"default-gateway": {
"vipObjectType": "object",
"vipType": "ignore",
"vipVariableName": "dhcp_default_gateway"
},
"dns-servers": {
"vipObjectType": "list",
"vipType": "ignore",
"vipVariableName": "dhcp_dns_server"
},
"tftp-servers": {
"vipObjectType": "list",
"vipType": "ignore",
"vipVariableName": "tftp-server"
},
"option-code": {
"vipType": "ignore",
"vipValue": [],
"vipObjectType": "tree",
"vipPrimaryKey": [
"code"
]
}
},
"static-lease": {
"vipType": "constant",
"vipValue": [
{
"mac-address": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "dhcp_mac_address"
},
"ip": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "dhcp_ip"
},
"host-name": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "dhcp_hostname"
},
"priority-order": [
"mac-address",
"ip",
"host-name"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"mac-address"
]
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleCiscoDhcpServer"
},
"cisco_dsp_farm-example": {
"description": "cisco_dsp_farm-example",
"value": {
"templateName": "template_dsp_farm",
"templateDescription": "template_dsp_farm",
"templateType": "cisco_dsp_farm",
"deviceType": [
"vedge-ISR-4461"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"media-resource": {
"vipType": "constant",
"vipValue": [
{
"slot-id": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "1/0"
},
"module-type": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "SM-X-PVDM-500"
},
"priority-order": [
"slot-id",
"module-type"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"slot-id"
]
},
"sccp-config": {
"local-interface": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "sscp_config__localinterface"
},
"server-list": {
"vipType": "constant",
"vipValue": [
{
"ip": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "1.1.1.1"
},
"identifier": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 10
},
"priority-order": [
"ip",
"identifier"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"ip"
]
},
"cucm-group": {
"vipType": "constant",
"vipValue": [
{
"cucm-group-id": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 314,
"vipVariableName": "cucmgroupid"
},
"cucm-server-list-priority": {
"vipType": "constant",
"vipValue": [
{
"cucm-server-identifier": {
"vipValue": 10,
"vipType": "constant",
"vipVariableName": "cucmserverid",
"vipObjectType": "object"
},
"cucm-server-ip": {
"vipValue": "1.1.1.1",
"vipType": "constant",
"vipVariableName": "cucmserverip",
"vipObjectType": "object"
},
"cucm-server-priority": {
"vipValue": 1,
"vipType": "constant",
"vipVariableName": "cucmserverpriority",
"vipObjectType": "object"
}
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"cucm-server-identifier"
]
},
"cucm-media-resource-group-list": {
"vipObjectType": "tree",
"vipType": "constant",
"vipValue": [
{
"media-resource-group-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "groupname1",
"vipVariableName": "mediaresourcegroupname"
},
"profile-id": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 604,
"vipVariableName": "profileid"
}
}
],
"vipPrimaryKey": [
"media-resource-group-name"
]
},
"cucm-switchover": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "graceful"
},
"cucm-switchback": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "guard"
},
"priority-order": [
"cucm-group-id",
"cucm-server-list-priority",
"cucm-media-resource-group-list",
"cucm-switchover",
"cucm-switchback"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"cucm-group-id"
]
}
},
"profile": {
"vipType": "constant",
"vipValue": [
{
"profile-id": {
"vipValue": 604,
"vipType": "constant",
"vipVariableName": "profileid",
"vipObjectType": "object"
},
"profile-type": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "conference"
},
"codec": {
"g722-64": {
"vipValue": "false",
"vipType": "constant",
"vipVariableName": "g72264",
"vipObjectType": "object"
},
"g729abr8": {
"vipValue": "true",
"vipType": "constant",
"vipVariableName": "g729abr8",
"vipObjectType": "object"
},
"g729ar8": {
"vipValue": "true",
"vipType": "constant",
"vipVariableName": "g729ar8",
"vipObjectType": "object"
},
"g729br8": {
"vipValue": "true",
"vipType": "constant",
"vipVariableName": "g729br8",
"vipObjectType": "object"
},
"g729r8": {
"vipValue": "true",
"vipType": "constant",
"vipVariableName": "g729r8",
"vipObjectType": "object"
},
"g711alaw": {
"vipValue": "true",
"vipType": "constant",
"vipVariableName": "g711alaw",
"vipObjectType": "object"
},
"g711ulaw": {
"vipValue": "true",
"vipType": "constant",
"vipVariableName": "g711ulaw",
"vipObjectType": "object"
}
},
"max-session": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 4
},
"application": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "sccp"
},
"shutdown": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "false",
"vipVariableName": "uc_shutdown"
},
"conference-max-participants": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 8
}
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"profile-id"
]
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleCiscoDspFarm"
},
"cisco_logging-example": {
"description": "cisco_logging-example",
"value": {
"templateName": "template_cisco_logging",
"templateDescription": "template_cisco_logging",
"templateType": "cisco_logging",
"deviceType": [
"vedge-C8000V"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"disk": {
"enable": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "logging_disk_enable"
},
"file": {
"size": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "logging_max_file_size"
},
"rotate": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "logging_disk_rotation"
}
}
},
"tls-profile": {
"vipType": "constant",
"vipValue": [
{
"profile": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "tls_profile_profile"
},
"tls-version": {
"version": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "version"
}
},
"auth-type": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "Server"
},
"ciphersuite": {
"ciphersuite-list": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "tls_profile_ciphersuite_list"
}
},
"priority-order": [
"profile",
"tls-version",
"auth-type",
"ciphersuite"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"profile"
]
},
"server": {
"vipType": "constant",
"vipValue": [
{
"name": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "logging_server_name"
},
"vpn": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "logging_server_vpn"
},
"source-interface": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "logging_server_source_interface"
},
"priority": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "logging_server_server_cisco_priority"
},
"tls": {
"enable-tls": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "logging_server_enable_tls"
},
"tls-properties": {
"custom-profile": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "false",
"vipVariableName": "logging_server_custom_profile_0"
},
"profile": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "_empty",
"vipVariableName": "logging_server_profile_0"
}
}
},
"priority-order": [
"name",
"vpn",
"source-interface",
"priority",
"tls"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"name"
]
},
"ipv6-server": {
"vipType": "constant",
"vipValue": [
{
"name": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "logging_ipv6_server_name_ipv6"
},
"vpn": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "logging_ipv6_server_vpn_ipv6"
},
"source-interface": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "logging_ipv6_server_source_interface_ipv6"
},
"priority": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "logging_ipv6_server_server_cisco_priority_ipv6"
},
"tls": {
"enable-tls": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "logging_ipv6_server_enable_tls_ipv6"
},
"tls-properties": {
"custom-profile": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "false",
"vipVariableName": "logging_server_custom_profile_0"
},
"profile": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "_empty",
"vipVariableName": "logging_server_profile_0"
}
}
},
"priority-order": [
"name",
"vpn",
"source-interface",
"priority",
"tls"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"name"
]
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleCiscoLogging"
},
"cisco_ntp-example": {
"description": "cisco_ntp-example",
"value": {
"templateName": "template_cisco_ntp",
"templateDescription": "template_cisco_ntp",
"templateType": "cisco_ntp",
"deviceType": [
"vedge-C8000V"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"master": {
"enable": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "enable"
},
"stratum": {},
"source": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "source"
}
},
"keys": {
"trusted": {
"vipObjectType": "list",
"vipType": "ignore",
"vipVariableName": "trusted_key"
},
"authentication": {
"vipType": "constant",
"vipValue": [
{
"number": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "ntp_auth_ntp_auth_number"
},
"md5": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "ntp_auth_md5"
},
"priority-order": [
"number",
"md5"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"number"
]
}
},
"server": {
"vipType": "constant",
"vipValue": [
{
"name": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "ntp_server_name"
},
"key": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "ntp_server_server_auth_key"
},
"vpn": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "ntp_server_vpn"
},
"version": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "ntp_server_version"
},
"source-interface": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "ntp_server_source_interface"
},
"prefer": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "ntp_server_prefer"
},
"priority-order": [
"name",
"key",
"vpn",
"version",
"source-interface",
"prefer"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"name"
]
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleCiscoNtp"
},
"cisco_omp-example": {
"description": "cisco_omp-example",
"value": {
"templateName": "template_cisco_omp",
"templateDescription": "template_cisco_omp",
"templateType": "cisco_omp",
"deviceType": [
"vedge-C8000V"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"graceful-restart": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "omp_graceful_restart"
},
"send-path-limit": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "omp_send_path_limit"
},
"overlay-as": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "overlay_as"
},
"ecmp-limit": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "omp_ecmp_limit"
},
"shutdown": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "omp_shutdown"
},
"timers": {
"advertisement-interval": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "omp_advertisement_interval"
},
"graceful-restart-timer": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "omp_graceful_restart_timer"
},
"holdtime": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "omp_holdtime"
},
"eor-timer": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "omp_eor_timer"
}
},
"omp-admin-distance-ipv4": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "vpn_omp-admin-distance-ipv4"
},
"omp-admin-distance-ipv6": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "vpn_omp-admin-distance-ipv6"
},
"advertise": {
"vipType": "constant",
"vipValue": [
{
"priority-order": [
"protocol"
],
"protocol": {
"vipType": "constant",
"vipValue": "bgp",
"vipObjectType": "object"
}
},
{
"priority-order": [
"protocol",
"route"
],
"protocol": {
"vipType": "constant",
"vipValue": "ospf",
"vipObjectType": "object"
},
"route": {
"vipType": "constant",
"vipValue": "external",
"vipObjectType": "object"
}
},
{
"priority-order": [
"protocol"
],
"protocol": {
"vipType": "constant",
"vipValue": "connected",
"vipObjectType": "object"
}
},
{
"priority-order": [
"protocol"
],
"protocol": {
"vipType": "constant",
"vipValue": "static",
"vipObjectType": "object"
}
},
{
"priority-order": [
"protocol"
],
"protocol": {
"vipType": "constant",
"vipValue": "eigrp",
"vipObjectType": "object"
}
},
{
"priority-order": [
"protocol"
],
"protocol": {
"vipType": "constant",
"vipValue": "lisp",
"vipObjectType": "object"
}
},
{
"priority-order": [
"protocol"
],
"protocol": {
"vipType": "constant",
"vipValue": "isis",
"vipObjectType": "object"
}
},
{
"priority-order": [
"protocol"
],
"protocol": {
"vipType": "constant",
"vipValue": "ospfv3",
"vipObjectType": "object"
}
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"protocol"
]
},
"ipv6-advertise": {
"vipType": "constant",
"vipValue": [
{
"priority-order": [
"protocol"
],
"protocol": {
"vipType": "constant",
"vipValue": "bgp",
"vipObjectType": "object"
}
},
{
"priority-order": [
"protocol"
],
"protocol": {
"vipType": "constant",
"vipValue": "connected",
"vipObjectType": "object"
}
},
{
"priority-order": [
"protocol"
],
"protocol": {
"vipType": "constant",
"vipValue": "static",
"vipObjectType": "object"
}
},
{
"priority-order": [
"protocol"
],
"protocol": {
"vipType": "constant",
"vipValue": "eigrp",
"vipObjectType": "object"
}
},
{
"priority-order": [
"protocol"
],
"protocol": {
"vipType": "constant",
"vipValue": "lisp",
"vipObjectType": "object"
}
},
{
"priority-order": [
"protocol"
],
"protocol": {
"vipType": "constant",
"vipValue": "isis",
"vipObjectType": "object"
}
},
{
"priority-order": [
"protocol",
"route"
],
"protocol": {
"vipType": "constant",
"vipValue": "ospf",
"vipObjectType": "object"
},
"route": {
"vipType": "constant",
"vipValue": "external",
"vipObjectType": "object"
}
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"protocol"
]
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleCiscoOmp"
},
"cisco_ospf-example": {
"description": "cisco_ospf-example",
"value": {
"templateName": "template_cisco_ospf",
"templateDescription": "template_cisco_ospf",
"templateType": "cisco_ospf",
"deviceType": [
"vedge-C8000V"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"ospf": {
"router-id": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "ospf_router_id"
},
"auto-cost": {
"reference-bandwidth": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "ospf_reference_bandwidth"
}
},
"compatible": {
"rfc1583": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "ospf_rfc1583"
}
},
"distance": {
"external": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "ospf_distance_external"
},
"inter-area": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "ospf_distance_inter_area"
},
"intra-area": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "ospf_distance_intra_area"
}
},
"timers": {
"spf": {
"delay": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 200,
"vipVariableName": "ospf_delay"
},
"initial-hold": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "ospf_initial_hold"
},
"max-hold": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "ospf_max_hold"
}
}
},
"route-policy": {
"vipType": "constant",
"vipValue": [
{
"direction": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "in"
},
"pol-name": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "ospf_pol_name"
},
"priority-order": [
"direction",
"pol-name"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"direction"
]
},
"redistribute": {
"vipType": "constant",
"vipValue": [
{
"protocol": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "ospf_redistribute_protocol"
},
"route-policy": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "ospf_redistribute_route_policy"
},
"priority-order": [
"protocol",
"route-policy"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"protocol"
]
},
"max-metric": {
"router-lsa": {
"vipType": "constant",
"vipValue": [
{
"ad-type": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "on-startup"
},
"time": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "ospf_router_lsa_time"
},
"priority-order": [
"ad-type",
"time"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"ad-type"
]
}
},
"area": {
"vipType": "constant",
"vipValue": [
{
"a-num": {
"originalDefaultOption": "constant",
"dataPath": [],
"vipObjectType": "object",
"vipValue": "",
"vipType": "variableName",
"vipVariableName": "ospf_area_a_num"
},
"nssa": {
"no-summary": {
"vipType": "variableName",
"vipObjectType": "node-only",
"vipVariableName": "ospf_area_no_summary"
}
},
"priority-order": [
"a-num",
"nssa"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"a-num"
]
}
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleCiscoOspf"
},
"cisco_ospfv3-example": {
"description": "cisco_ospfv3-example",
"value": {
"templateName": "template_ospfv3",
"templateDescription": "template_ospfv3",
"templateType": "cisco_ospfv3",
"deviceType": [
"vedge-C8000V"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"ospfv3": {
"address-family": {
"ipv4": {
"router-id": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "ospfv3_router_id"
},
"auto-cost": {
"reference-bandwidth": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 100,
"vipVariableName": "ospfv3_reference_bandwidth"
}
},
"distance-ipv4": {
"distance": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "ospfv3_distance_distance"
},
"ospf": {
"external": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "ospfv3_distance_external"
},
"inter-area": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "ospfv3_distance_inter_area"
},
"intra-area": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "ospfv3_distance_intra_area"
}
}
},
"table-map": {
"name": {
"vipObjectType": "object",
"vipType": "ignore",
"vipVariableName": "ospfv3_distance_name"
}
},
"compatible": {
"rfc1583": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "ospfv3_rfc1583"
}
},
"timers": {
"throttle": {
"spf": {
"delay": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 200,
"vipVariableName": "ospfv3_delay"
},
"initial-hold": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 1000,
"vipVariableName": "ospfv3_initial_hold"
},
"max-hold": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 10000,
"vipVariableName": "ospfv3_max_hold"
}
}
}
},
"redistribute": {
"vipType": "constant",
"vipValue": [
{
"protocol": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "ospf_redistribute_protocol"
},
"route-policy": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "ospf_redistribute_route_policy"
},
"priority-order": [
"protocol",
"route-policy"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"protocol"
]
},
"max-metric": {
"router-lsa": {
"vipType": "constant",
"vipValue": [
{
"ad-type": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "on-startup"
},
"time": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "ospf_router_lsa_time"
},
"priority-order": [
"ad-type",
"time"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"ad-type"
]
}
}
},
"ipv6": {
"router-id": {
"vipObjectType": "object",
"vipType": "ignore",
"vipVariableName": "ospfv3_router_id_ipv6"
},
"auto-cost": {
"reference-bandwidth": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 100,
"vipVariableName": "ospfv3_reference_bandwidth_ipv6"
}
},
"distance-ipv4": {
"distance": {},
"ospf": {
"external": {},
"inter-area": {},
"intra-area": {}
}
},
"table-map": {
"name": {
"vipObjectType": "object",
"vipType": "ignore",
"vipVariableName": "ospfv3_distance_name_ipv6"
}
},
"compatible": {
"rfc1583": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "ospfv3_rfc1583_ipv6"
}
},
"distance-ipv6": {
"ospf": {
"external": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 110,
"vipVariableName": "ospfv3_distance_external_ipv6"
},
"inter-area": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 110,
"vipVariableName": "ospfv3_distance_inter_area_ipv6"
},
"intra-area": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 110,
"vipVariableName": "ospfv3_distance_intra_area_ipv6"
}
},
"distance": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 110,
"vipVariableName": "ospfv3_distance_distance_ipv6"
}
},
"timers": {
"throttle": {
"spf": {
"delay": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 200,
"vipVariableName": "ospfv3_delay_ipv6"
},
"initial-hold": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 1000,
"vipVariableName": "ospfv3_initial_hold_ipv6"
},
"max-hold": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 10000,
"vipVariableName": "ospfv3_max_hold_ipv6"
}
}
}
},
"max-metric": {
"router-lsa": {
"vipType": "ignore",
"vipValue": [],
"vipObjectType": "tree",
"vipPrimaryKey": [
"ad-type"
]
}
}
}
}
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleCiscoOspfv3"
},
"cisco_secure_internet_gateway-example": {
"description": "cisco_secure_internet_gateway-example",
"value": {
"templateName": "secure_internet_gateway",
"templateDescription": "secure_internet_gateway",
"templateType": "cisco_secure_internet_gateway",
"deviceType": [
"vedge-C8000V"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"vpn-id": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 0
},
"interface": {
"vipType": "constant",
"vipValue": [
{
"if-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "ipsec1",
"vipVariableName": "tunnel_if_name"
},
"auto": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true"
},
"shutdown": {
"vipObjectType": "object",
"vipType": "notIgnore",
"vipValue": "false",
"vipVariableName": "tunnel_shutdown"
},
"description": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "tunnel_description"
},
"ip": {
"unnumbered": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "true"
}
},
"tunnel-source-interface": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "GigabitEthernet1",
"vipVariableName": "tunnel_tunnel_source_interface"
},
"tunnel-destination": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "dynamic"
},
"application": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "sig"
},
"tunnel-set": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "secure-internet-gateway-umbrella"
},
"tunnel-dc-preference": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "primary-dc"
},
"tcp-mss-adjust": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 1300,
"vipVariableName": "tunnel_tcp_mss_adjust_"
},
"mtu": {
"vipObjectType": "object",
"vipType": "notIgnore",
"vipValue": 1400,
"vipVariableName": "tunnel_mtu_"
},
"dead-peer-detection": {
"dpd-interval": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 10,
"vipVariableName": "tunnel_dpd_interval"
},
"dpd-retries": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 3,
"vipVariableName": "tunnel_dpd_retries"
}
},
"ike": {
"ike-version": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 2
},
"authentication-type": {
"pre-shared-key-dynamic": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "true"
}
},
"ike-rekey-interval": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 14400,
"vipVariableName": "tunnel_ike_rekey_interval_"
},
"ike-ciphersuite": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "aes256-cbc-sha1",
"vipVariableName": "tunnel_ike_ciphersuite"
},
"ike-group": {
"vipObjectType": "object",
"vipType": "notIgnore",
"vipValue": "14",
"vipVariableName": "tunnel_ike_group"
}
},
"ipsec": {
"ipsec-rekey-interval": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 720,
"vipVariableName": "tunnel_ipsec_rekey_interval"
},
"ipsec-replay-window": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1024,
"vipVariableName": "tunnel_ipsec_replay_window"
},
"ipsec-ciphersuite": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "aes256-cbc-sha1",
"vipVariableName": "tunnel_ipsec_ciphersuite"
},
"perfect-forward-secrecy": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "tunnel_perfect_forward_secrecy"
}
},
"tracker": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "tracker2"
},
"track-enable": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true"
}
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"if-name"
]
},
"service": {
"vipType": "constant",
"vipValue": [
{
"svc-type": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "sig"
},
"ha-pairs": {
"interface-pair": {
"vipType": "constant",
"vipObjectType": "tree",
"vipPrimaryKey": [
"active-interface",
"backup-interface"
],
"vipValue": [
{
"active-interface": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "ipsec1"
},
"backup-interface": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "None"
},
"active-interface-weight": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 10
},
"backup-interface-weight": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1
},
"priority-order": [
"active-interface",
"backup-interface",
"active-interface-weight",
"backup-interface-weight"
]
}
]
}
},
"umbrella-data-center": {
"data-center-primary": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "vpn_umbprimarydc"
},
"data-center-secondary": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "vpn_umbsecondarydc"
}
}
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"svc-type"
]
},
"tracker-src-ip": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "vpn_trackersrcip"
},
"tracker": {
"vipType": "constant",
"vipValue": [
{
"name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "tracker2",
"vipVariableName": "tracker_name"
},
"endpoint-api-url": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "https://dns.org",
"vipVariableName": "tracker_endpoint-api-url"
},
"threshold": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 600,
"vipVariableName": "tracker_threshold"
},
"interval": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 120,
"vipVariableName": "tracker_interval"
},
"multiplier": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 6,
"vipVariableName": "tracker_multiplier"
},
"tracker-type": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "SIG"
},
"priority-order": [
"tracker-type",
"name",
"endpoint-api-url",
"threshold",
"interval",
"multiplier"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"tracker-type",
"name"
]
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleCiscoSecureInternetGateway"
},
"cisco_security-example": {
"description": "cisco_security-example",
"value": {
"templateName": "template_security",
"templateDescription": "template_security",
"templateType": "cisco_security",
"deviceType": [
"vedge-C8000V"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"ipsec": {
"rekey": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 86400,
"vipVariableName": "security_rekey"
},
"replay-window": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "512",
"vipVariableName": "security_replay_window"
},
"extended-ar-window": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 256,
"vipVariableName": "security_extended-ar-window"
},
"authentication-type": {
"vipType": "constant",
"vipValue": [
"sha1-hmac",
"ah-sha1-hmac",
"ah-no-id"
],
"vipObjectType": "list",
"vipVariableName": "security_authenticationType"
},
"integrity-type": {
"vipType": "constant",
"vipValue": [
"esp",
"ip-udp-esp",
"ip-udp-esp-no-id"
],
"vipObjectType": "list"
},
"pairwise-keying": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "security_pairwise_keying"
}
},
"trustsec": {
"keychain": {
"vipType": "constant",
"vipValue": [
{
"name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "keychain_zyp"
},
"keyid": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1
}
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"name",
"keyid"
]
}
},
"key": {
"vipType": "constant",
"vipValue": [
{
"id": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1
},
"chain-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "keychain_zyp"
},
"send-id": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1,
"vipVariableName": "key_send-id"
},
"recv-id": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1,
"vipVariableName": "key_receiver-id"
},
"cryptographic-algorithm-choice": {
"tcp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "aes-128-cmac"
}
},
"key-string": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "123456789A",
"vipVariableName": "key_key-string"
},
"send-lifetime": {
"lifetime-group-v1": {
"end-choice": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "infinite"
},
"local": {
"vipType": "constant",
"vipObjectType": "node-only",
"vipValue": "false"
},
"start-epoch": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1627824420
},
"infinite": {
"vipType": "constant",
"vipObjectType": "node-only",
"vipValue": "true"
}
}
},
"accept-lifetime": {
"lifetime-group-v1": {
"end-choice": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "infinite",
"vipVariableName": "key_accept-lifetime-end-format"
},
"local": {
"vipType": "constant",
"vipObjectType": "node-only",
"vipValue": "true"
},
"start-epoch": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1627824480
},
"infinite": {
"vipType": "constant",
"vipObjectType": "node-only",
"vipValue": "true"
}
}
},
"include-tcp-options": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "key_include-tcp-options"
},
"accept-ao-mismatch": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "key_accept-ao-mismatch"
}
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"chain-name",
"id"
]
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleCiscoSecurity"
},
"cisco_sig_credential-example": {
"description": "cisco_sig_credential-example",
"value": {
"templateName": "template_SIG_Credentials",
"templateDescription": "template_SIG_Credentials",
"templateType": "cisco_sig_credentials",
"deviceType": [
"vedge-C8000V"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"umbrella": {
"api-key": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "123456789a",
"vipVariableName": "system_api_key"
},
"api-secret": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "123456789a",
"vipVariableName": "system_api_secret",
"vipNeedsEncryption": true
},
"org-id": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "SIG",
"vipVariableName": "system_org_id"
}
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleCiscoSigCredentials"
},
"cisco_snmp-example": {
"description": "cisco_snmp-example",
"value": {
"templateName": "cisco_snmp",
"templateDescription": "template for cisco snmp",
"templateType": "cisco_snmp",
"deviceType": [
"vedge-C8000V"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"shutdown": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "false",
"vipVariableName": "snmp_shutdown"
},
"contact": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "jefrey",
"vipVariableName": "snmp_contact"
},
"name": {},
"location": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "shanghai",
"vipVariableName": "snmp_device_location"
},
"view": {
"vipType": "constant",
"vipValue": [
{
"name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "snmpView"
},
"oid": {
"vipType": "constant",
"vipValue": [
{
"id": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "snmp_view_id_0"
},
"exclude": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "snmp_view_exclude_0"
},
"priority-order": [
"id",
"exclude"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"id"
]
},
"priority-order": [
"name",
"oid"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"name"
]
},
"community": {
"vipType": "constant",
"vipValue": [
{
"name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "c1",
"vipNeedsEncryption": "true"
},
"view": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "snmpView",
"vipVariableName": "snmp_community_view"
},
"authorization": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "read-only",
"vipVariableName": "snmp_community_authorization"
},
"priority-order": [
"name",
"authorization",
"view"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"name"
]
},
"trap": {
"target": {
"vipType": "constant",
"vipValue": [
{
"vpn-id": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 111,
"vipVariableName": "snmp_trap_vpn_id"
},
"ip": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "10.10.10.10",
"vipVariableName": "snmp_trap_ip"
},
"port": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 2000,
"vipVariableName": "snmp_trap_port"
},
"community-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "c1",
"vipVariableName": "snmp_trap_community_name",
"vipNeedsEncryption": "true"
},
"user": {},
"source-interface": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "GigabitEthernet1",
"vipVariableName": "snmp_trap_source_interface"
},
"users": {
"vipObjectType": "object",
"vipType": "constant"
},
"priority-order": [
"vpn-id",
"ip",
"port",
"community-name",
"source-interface"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"vpn-id",
"ip",
"port"
]
}
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleCiscoSnmp"
},
"cisco_system-example": {
"description": "cisco_system-example",
"value": {
"templateName": "template_cisco_system",
"templateDescription": "template_cisco_system",
"templateType": "cisco_system",
"deviceType": [
"vedge-C8000V"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"clock": {
"timezone": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "Asia/Shanghai",
"vipVariableName": "system_timezone"
}
},
"gps-location": {
"latitude": {
"vipObjectType": "object",
"vipType": "ignore",
"vipVariableName": "system_latitude"
},
"longitude": {
"vipObjectType": "object",
"vipType": "ignore",
"vipVariableName": "system_longitude"
}
},
"location": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "shanghai",
"vipVariableName": "system_location"
},
"track-transport": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "system_track_transport"
},
"track-interface-tag": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1,
"vipVariableName": "system_track_interface_tag"
},
"port-offset": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1,
"vipVariableName": "system_port_offset"
},
"port-hop": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "system_port_hop"
},
"control-session-pps": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 600,
"vipVariableName": "system_control_session_pps"
},
"description": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "description1",
"vipVariableName": "system_description"
},
"device-groups": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"11"
],
"vipVariableName": "system_device_groups"
},
"controller-group-list": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"12"
],
"vipVariableName": "system_controller_group_list"
},
"site-id": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 100,
"vipVariableName": "system_site_id"
},
"overlay-id": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1,
"vipVariableName": "system_overlay_id"
},
"system-ip": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "172.16.255.15"
},
"host-name": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "host_zzz"
},
"console-baud-rate": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "115200",
"vipVariableName": "system_console_baud_rate"
},
"max-omp-sessions": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 16,
"vipVariableName": "system_max_omp_sessions"
},
"track-default-gateway": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "system_track_default_gateway"
},
"idle-timeout": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 60,
"vipVariableName": "system_idle-timeout"
},
"admin-tech-on-failure": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "system_admin_tech_on_failure"
},
"multi-tenant": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "system_multi-tenant"
},
"on-demand": {
"enable": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "system_on-demand-enable"
},
"idle-timeout": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 5,
"vipVariableName": "system_on-demand-idle-timeout"
}
},
"tracker": {
"vipType": "constant",
"vipValue": [
{
"name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "tracker1",
"vipVariableName": "tracker_name"
},
"endpoint-ip": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "10.10.10.10",
"vipVariableName": "tracker_endpoint-ip"
},
"threshold": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 600,
"vipVariableName": "tracker_threshold"
},
"interval": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 120,
"vipVariableName": "tracker_interval"
},
"multiplier": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 6,
"vipVariableName": "tracker_multiplier"
},
"type": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "interface",
"vipVariableName": "tracker_tracker_type"
},
"priority-order": [
"name",
"endpoint-ip",
"endpoint-dns-name",
"endpoint-api-url",
"threshold",
"interval",
"multiplier",
"type"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"name"
]
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleCiscoSystem"
},
"cisco_thousandeye-example": {
"description": "cisco_thousandeye-example",
"value": {
"templateName": "ThousandEyesAgent",
"templateDescription": "ThousandEyesAgent",
"templateType": "cisco_thousandeyes",
"deviceType": [
"vedge-ISR-4461"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"virtual-application": {
"vipType": "constant",
"vipValue": [
{
"instance-id": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "835d52c5-fdcf-4047-afa5-0f70b99b6188",
"vipVariableName": "instance_id"
},
"application-type": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "te",
"vipVariableName": "application_type"
},
"te": {
"token": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "aabbccddee",
"vipVariableName": "thousandeyes_token",
"vipNeedsEncryption": "true"
},
"vpn": {
"vipObjectType": "object",
"vipType": "ignore",
"vipVariableName": "thousandeyes_vpn"
},
"name-server": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "thousandeyes_name_server"
},
"hostname": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "host_zyp",
"vipVariableName": "thousandeyes_hostname"
},
"proxy_type": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "static",
"vipVariableName": "thousandeyes_proxy_type"
},
"proxy_static": {
"proxy_host": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "20.20.20,20",
"vipVariableName": "thousandeyes_proxy_host"
},
"proxy_port": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 2000,
"vipVariableName": "thousandeyes_proxy_port"
}
},
"proxy_pac": {
"pac_url": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "thousandeyes_pac_url"
}
}
},
"priority-order": [
"instance-id",
"application-type",
"te"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"instance-id"
]
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleCiscoThousandeyes"
},
"cisco_trustsec-example": {
"description": "cisco_trustsec-example",
"value": {
"templateName": "template_trustsec",
"templateDescription": "template_trustsec",
"templateType": "cisco_trustsec",
"deviceType": [
"vedge-CSR-1000v"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"sxp-default": {
"enable-sxp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "sxp_default_enable_sxp"
},
"sxp-source-ip": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "10.10.10.23",
"vipVariableName": "sxp_default_source_ip"
},
"sxp-default-password": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "123456789a",
"vipVariableName": "sxp_default_password",
"vipNeedsEncryption": "true"
},
"sxp-key-chain": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "chain1",
"vipVariableName": "sxp_default_key_chain"
},
"sxp-log-binding-changes": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "sxp_default_log_binding"
},
"sxp-reconciliation-period": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 180,
"vipVariableName": "sxp_default_reconciliation_period"
},
"sxp-retry-period": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 180,
"vipVariableName": "sxp_default_retry_period"
},
"speaker-hold-time": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 180,
"vipVariableName": "sxp_default_speaker_hold_time"
},
"listener-hold-time-min": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 90,
"vipVariableName": "sxp_default_listener_hold_time_min"
},
"listener-hold-time-max": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 240,
"vipVariableName": "sxp_default_listener_hold_time_max"
},
"sxp-node-id-type": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "ip"
},
"sxp-node-id": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "1.1.1.1",
"vipVariableName": "sxp_default_node_id"
}
},
"device-sgt": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "trustsec_device_sgt"
},
"credentials-id": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "1",
"vipVariableName": "trustsec_credentials_id"
},
"credentials-password": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "aabbccddee",
"vipVariableName": "trustsec_credentials_pwd",
"vipNeedsEncryption": "true"
},
"enable-enforcement": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "trustsec_enable_enforcement"
},
"sxp-connection-list": {
"vipType": "constant",
"vipValue": [
{
"connection-peer-ip": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "2.2.2.2"
},
"connection-source-ip": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "2.2.2.5",
"vipVariableName": "sxp-connection_source-ip"
},
"connection-preshared-key": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "default"
},
"connection-mode": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "local"
},
"connection-mode-type": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "speaker"
},
"connection-min-hold-time": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 180,
"vipVariableName": "sxp-connection_min-hold-time"
},
"connection-max-hold-time": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 0,
"vipVariableName": "sxp-connection_max-hold-time_0"
},
"connection-vpn-id": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 24,
"vipVariableName": "sxp-connection_vpn-id"
},
"priority-order": [
"connection-peer-ip",
"connection-source-ip",
"connection-preshared-key",
"connection-mode",
"connection-mode-type",
"connection-min-hold-time",
"connection-max-hold-time",
"connection-vpn-id"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"connection-peer-ip"
]
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleCiscoTrustsec"
},
"cisco_vp-example": {
"description": "cisco_vp-example",
"value": {
"templateName": "template_cisco_vpn",
"templateDescription": "template_cisco_vpn",
"templateType": "cisco_vpn",
"deviceType": [
"vedge-C8000V"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"vpn-id": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 13
},
"name": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "vpn_name"
},
"ecmp-hash-key": {
"layer4": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_layer4"
}
},
"nat64-global": {
"prefix": {
"stateful": {}
}
},
"nat64": {
"v4": {
"pool": {
"vipType": "ignore",
"vipValue": [],
"vipObjectType": "tree",
"vipPrimaryKey": [
"name"
]
}
}
},
"tenant-vpn-id": {},
"org-name": {},
"omp-admin-distance-ipv4": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "vpn_omp-admin-distance-ipv4"
},
"omp-admin-distance-ipv6": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "vpn_omp-admin-distance-ipv6"
},
"nat": {
"natpool": {
"vipType": "constant",
"vipValue": [
{
"name": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "vpn_nat_pool_name"
},
"prefix-length": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "vpn_nat_prefix_length"
},
"range-start": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "vpn_nat_range_start"
},
"range-end": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "vpn_nat_range_end"
},
"overload": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "vpn_nat_pool_overload"
},
"direction": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "outside",
"vipVariableName": "vpn_nat_direction"
},
"priority-order": [
"name",
"prefix-length",
"range-start",
"range-end",
"overload",
"direction"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"name"
]
},
"port-forward": {
"vipType": "ignore",
"vipValue": [],
"vipObjectType": "tree",
"vipPrimaryKey": [
"source-port",
"translate-port",
"source-ip",
"translate-ip",
"proto"
]
},
"static": {
"vipType": "ignore",
"vipValue": [],
"vipObjectType": "tree",
"vipPrimaryKey": [
"source-ip",
"translate-ip"
]
}
},
"dns": {
"vipType": "constant",
"vipValue": [
{
"role": {
"vipType": "constant",
"vipValue": "primary",
"vipObjectType": "object"
},
"dns-addr": {
"vipType": "constant",
"vipValue": "1.1.1.1",
"vipObjectType": "object"
},
"priority-order": [
"dns-addr",
"role"
]
},
{
"role": {
"vipType": "constant",
"vipValue": "secondary",
"vipObjectType": "object"
},
"dns-addr": {
"vipType": "constant",
"vipValue": "2.2.2.2",
"vipObjectType": "object"
},
"priority-order": [
"dns-addr",
"role"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"dns-addr"
]
},
"route-import": {
"vipType": "constant",
"vipValue": [
{
"protocol": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "bgp",
"vipVariableName": "route_leak_from_proto"
},
"protocol-sub-type": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": "external",
"vipVariableName": "route_leak_from_proto_sub"
},
"redistribute": {
"vipValue": [],
"vipType": "ignore",
"vipObjectType": "tree",
"vipPrimaryKey": [
"protocol"
]
}
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"protocol"
]
},
"route-export": {
"vipType": "ignore",
"vipValue": [],
"vipObjectType": "tree",
"vipPrimaryKey": [
"protocol"
]
},
"host": {
"vipType": "constant",
"vipValue": [
{
"hostname": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "host_zyp",
"vipVariableName": "vpn_host_hostname"
},
"ip": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"192.168.0.100"
],
"vipVariableName": "vpn_host_ip"
},
"priority-order": [
"hostname",
"ip"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"hostname"
]
},
"service": {
"vipType": "constant",
"vipValue": [
{
"svc-type": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "FW"
},
"address": {
"vipObjectType": "list",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "vpn_service_address"
},
"track-enable": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "vpn_service_service_track"
},
"priority-order": [
"svc-type",
"address",
"track-enable"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"svc-type"
]
},
"ip": {
"route": {
"vipType": "constant",
"vipValue": [
{
"prefix": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "vpn_ipv4_ip_prefix"
},
"next-hop": {
"vipType": "constant",
"vipValue": [
{
"address": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "3.3.3.3",
"vipVariableName": "vpn_next_hop_ip_address_0"
},
"distance": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 4,
"vipVariableName": "vpn_next_hop_ip_distance_0"
},
"priority-order": [
"address",
"distance"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"address"
]
},
"priority-order": [
"prefix",
"next-hop",
"next-hop-with-track"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"prefix"
]
},
"gre-route": {
"vipType": "constant",
"vipValue": [
{
"prefix": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "vpn_gre_route_gre_route_prefix"
},
"vpn": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 0
},
"interface": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"2"
],
"vipVariableName": "vpn_gre_route_gre_route_interface"
},
"priority-order": [
"prefix",
"vpn",
"interface"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"prefix"
]
},
"ipsec-route": {
"vipType": "constant",
"vipValue": [
{
"prefix": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "vpn_ipsec_route_ipsec_route_prefix"
},
"vpn": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 0
},
"interface": {
"vipObjectType": "list",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "vpn_ipsec_route_ipsec_route_interface"
},
"priority-order": [
"prefix",
"vpn",
"interface"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"prefix"
]
},
"service-route": {
"vipType": "constant",
"vipValue": [
{
"prefix": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "vpn_serviceroute_prefix"
},
"vpn": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 0
},
"service": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "sig"
},
"priority-order": [
"prefix",
"vpn",
"service"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"prefix"
]
}
},
"ipv6": {
"route": {
"vipType": "constant",
"vipValue": [
{
"prefix": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "vpn_ipv6_ipv6_prefix"
},
"next-hop": {
"vipType": "constant",
"vipValue": [
{
"address": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "fe80::1",
"vipVariableName": "vpn_next_hop_ipv6_address_0"
},
"distance": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 1,
"vipVariableName": "vpn_next_hop_ipv6_distance_0"
},
"priority-order": [
"address",
"distance"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"address"
]
},
"priority-order": [
"prefix",
"next-hop"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"prefix"
]
}
},
"omp": {
"advertise": {
"vipType": "constant",
"vipValue": [
{
"priority-order": [
"protocol",
"route-policy",
"protocol-sub-type"
],
"protocol": {
"vipType": "constant",
"vipValue": "ospf",
"vipObjectType": "object"
},
"route-policy": {
"vipType": "variable",
"vipValue": "",
"vipObjectType": "object"
},
"protocol-sub-type": {
"vipType": "constant",
"vipValue": "external",
"vipObjectType": "object"
}
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"protocol"
]
},
"ipv6-advertise": {
"vipType": "ignore",
"vipValue": [],
"vipObjectType": "tree",
"vipPrimaryKey": [
"protocol"
]
}
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleCiscoVpn"
},
"cisco_vpn_interface-example": {
"description": "cisco_vpn_interface-example",
"value": {
"templateName": "cisco_vpn_interface_ethernet",
"templateDescription": "cisco_vpn_interface_ethernet",
"templateType": "cisco_vpn_interface",
"deviceType": [
"vedge-C8000V"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"if-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "GigabitEthernet1/",
"vipVariableName": "vpn_if_name"
},
"description": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "descript1",
"vipVariableName": "vpn_if_description"
},
"ip": {
"dhcp-client": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true"
},
"dhcp-distance": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 10,
"vipVariableName": "vpn_if_ipv4_dhcp_distance"
},
"secondary-address": {
"vipType": "constant",
"vipValue": [
{
"address": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "10.10.10.10/24",
"vipVariableName": "vpn_if_secondary_address_0"
},
"priority-order": [
"address"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"address"
]
}
},
"dhcp-helper": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"10.10.10.254"
],
"vipVariableName": "vpn_if_dhcp_helper"
},
"flow-control": {},
"clear-dont-fragment": {},
"pmtu": {},
"mtu": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1500,
"vipVariableName": "vpn_if_ip_mtu"
},
"static-ingress-qos": {},
"tcp-mss-adjust": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1400,
"vipVariableName": "vpn_if_tcp_mss_adjust"
},
"mac-address": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "00:02:03:04:05:06",
"vipVariableName": "vpn_if_mac_address"
},
"speed": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "1000",
"vipVariableName": "vpn_if_speed"
},
"duplex": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "full",
"vipVariableName": "vpn_if_duplex"
},
"shutdown": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "false",
"vipVariableName": "vpn_if_shutdown"
},
"arp-timeout": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1200,
"vipVariableName": "vpn_if_arp_timeout"
},
"autonegotiate": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_autonegotiate"
},
"shaping-rate": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "10000"
},
"qos-map": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "m1",
"vipVariableName": "qos_map"
},
"qos-map-vpn": {
"vipObjectType": "object",
"vipType": "ignore",
"vipVariableName": "vpn-qos_map"
},
"tracker": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"1"
],
"vipVariableName": "vpn_if_tracker"
},
"bandwidth-upstream": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 100000,
"vipVariableName": "vpn_if_bandwidth_upstream"
},
"bandwidth-downstream": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 200000,
"vipVariableName": "vpn_if_bandwidth_downstream"
},
"block-non-source-ip": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_block_non_source_ip"
},
"rewrite-rule": {
"rule-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "rule1",
"vipVariableName": "rewrite_rule_name"
}
},
"tloc-extension": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "tloc",
"vipVariableName": "vpn_if_tloc_extension"
},
"load-interval": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 30,
"vipVariableName": "vpn_if_load_interval"
},
"icmp-redirect-disable": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "vpn_if_icmp_redirect_disable"
},
"tloc-extension-gre-from": {
"src-ip": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "192.168.1.113",
"vipVariableName": "vpn_if_tloc-ext_gre_from_src_ip"
},
"xconnect": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "connect1",
"vipVariableName": "vpn_if_tloc-ext_gre_from_xconnect"
}
},
"access-list": {
"vipType": "constant",
"vipValue": [
{
"acl-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "9.9.9.9",
"vipVariableName": "access_list_ingress_acl_name_ipv4"
},
"direction": {
"vipType": "constant",
"vipValue": "in",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
},
{
"acl-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "6.6.6.6",
"vipVariableName": "ipv4_access_list_egress_acl_name_ipv4"
},
"direction": {
"vipType": "constant",
"vipValue": "out",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"direction"
]
},
"tunnel-interface": {
"encapsulation": {
"vipType": "constant",
"vipValue": [
{
"preference": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 7,
"vipVariableName": "vpn_if_tunnel_gre_preference"
},
"weight": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 2,
"vipVariableName": "vpn_if_tunnel_gre_weight"
},
"encap": {
"vipType": "constant",
"vipValue": "gre",
"vipObjectType": "object"
},
"priority-order": [
"encap",
"preference",
"weight"
]
},
{
"preference": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 6,
"vipVariableName": "vpn_if_tunnel_ipsec_preference"
},
"weight": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 2,
"vipVariableName": "vpn_if_tunnel_ipsec_weight"
},
"encap": {
"vipType": "constant",
"vipValue": "ipsec",
"vipObjectType": "object"
},
"priority-order": [
"encap",
"preference",
"weight"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"encap"
]
},
"group": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"1"
],
"vipVariableName": "vpn_if_tunnel_group"
},
"border": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_border"
},
"color": {
"value": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "gold",
"vipVariableName": "vpn_if_tunnel_color_value"
},
"restrict": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_color_restrict"
}
},
"carrier": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "carrier8",
"vipVariableName": "vpn_if_tunnel_carrier"
},
"bind": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "tunnel1",
"vipVariableName": "vpn_if_tunnel_bind"
},
"allow-service": {
"dhcp": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_dhcp"
},
"dns": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_dns"
},
"icmp": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_icmp"
},
"sshd": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_sshd"
},
"ntp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_ntp"
},
"stun": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_stun"
},
"all": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_all"
},
"bgp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_bgp"
},
"ospf": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_ospf"
},
"netconf": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_netconf"
},
"snmp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_snmp"
},
"https": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_https"
}
},
"max-control-connections": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 16,
"vipVariableName": "vpn_if_tunnel_max_control_connections"
},
"vbond-as-stun-server": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_vbond_as_stun_server"
},
"exclude-controller-group-list": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"2"
],
"vipVariableName": "vpn_if_tunnel_exclude_controller_group_list"
},
"vmanage-connection-preference": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 7,
"vipVariableName": "vpn_if_tunnel_vmanage_connection_preference"
},
"port-hop": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_port_hop"
},
"low-bandwidth-link": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_low_bandwidth_link"
},
"last-resort-circuit": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_last_resort_circuit"
},
"nat-refresh-interval": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 3,
"vipVariableName": "vpn_if_tunnel_nat_refresh_interval"
},
"hello-interval": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 600,
"vipVariableName": "vpn_if_tunnel_hello_interval"
},
"hello-tolerance": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 12,
"vipVariableName": "vpn_if_tunnel_hello_tolerance"
},
"tloc-extension-gre-to": {
"dst-ip": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "20.20.20.20",
"vipVariableName": "vpn_if_tunnel_tloc_ext_gre_to_dst_ip"
}
},
"tunnel-qos": {
"mode": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "hub"
}
},
"tunnels-bandwidth": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 40,
"vipVariableName": "vpn_if_tunnel_tunnels-bandwidth"
},
"tunnel-tcp-mss-adjust": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1380,
"vipVariableName": "vpn_if_tunnel_tunnel_tcp_mss_adjust"
},
"clear-dont-fragment": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_tunnel_clear_dont_fragment"
},
"propagate-sgt": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_tunnel_propagate_sgt"
},
"network-broadcast": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_tunnel_network_broadcast"
}
},
"auto-bandwidth-detect": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_auto_bandwidth_detect"
},
"iperf-server": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "10.140.36.89",
"vipVariableName": "vpn_if_iperf_server"
},
"media-type": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "rj45",
"vipVariableName": "vpn_if_media-type"
},
"intrf-mtu": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1500,
"vipVariableName": "vpn_if_intrf_mtu"
},
"ip-directed-broadcast": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_ip-directed-broadcast"
},
"trustsec": {
"propagate": {
"sgt": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true"
}
},
"static": {
"sgt": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 13,
"vipVariableName": "trusted_sgt"
},
"trusted": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "trusted_trusted"
}
},
"enable": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "trusted-enable"
},
"enforcement": {
"enable": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "trusted_enforcement_enable"
},
"sgt": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 14,
"vipVariableName": "trusted_enforcement_sgt"
}
}
},
"ipv6": {
"access-list": {
"vipType": "constant",
"vipValue": [
{
"acl-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "2001:4860:4801:48::33",
"vipVariableName": "access_list_ingress_acl_name_ipv6"
},
"direction": {
"vipType": "constant",
"vipValue": "in",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
},
{
"acl-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "2001:4860:4801:48::44",
"vipVariableName": "access_list_egress_acl_name_ipv6"
},
"direction": {
"vipType": "constant",
"vipValue": "out",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"direction"
]
},
"address": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "",
"vipVariableName": "vpn_if_ipv6_ipv6_address"
},
"dhcp-helper-v6": {
"vipType": "ignore",
"vipValue": [],
"vipObjectType": "tree",
"vipPrimaryKey": [
"address"
]
},
"secondary-address": {
"vipType": "ignore",
"vipValue": [],
"vipObjectType": "tree",
"vipPrimaryKey": [
"address"
]
}
},
"nat": {
"udp-timeout": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 2,
"vipVariableName": "nat_udp_timeout"
},
"tcp-timeout": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 120,
"vipVariableName": "nat_tcp_timeout"
},
"natpool": {},
"nat-choice": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "interface",
"vipVariableName": "nat-type"
},
"overload": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true"
},
"interface": {
"loopback-interface": {
"vipObjectType": "object",
"vipType": "ignore"
}
},
"static": {
"vipType": "constant",
"vipValue": [
{
"source-ip": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "192.168.1.111",
"vipVariableName": "vpn_static_nat_source_ip"
},
"translate-ip": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "10.10.20.20",
"vipVariableName": "vpn_static_nat_translate_ip"
},
"static-nat-direction": {
"vipObjectType": "object",
"vipType": "notIgnore",
"vipValue": "inside",
"vipVariableName": "vpn_static_nat_static_nat_direction"
},
"source-vpn": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 12,
"vipVariableName": "vpn_static_nat_source_vpn"
},
"priority-order": [
"source-ip",
"translate-ip",
"static-nat-direction",
"source-vpn"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"source-ip",
"translate-ip"
]
}
},
"arp": {
"ip": {
"vipType": "constant",
"vipValue": [
{
"addr": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "192.168.1.112",
"vipVariableName": "vpn_bridge_arp_addr"
},
"mac": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "00:00:00:00:00:02",
"vipVariableName": "vpn_bridge_arp_mac"
},
"priority-order": [
"addr",
"mac"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"addr"
]
}
},
"vrrp": {
"vipType": "constant",
"vipValue": [
{
"grp-id": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1,
"vipVariableName": "vpn_if_vrrp_grpid"
},
"priority": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 100,
"vipVariableName": "vpn_if_vrrp_priority"
},
"timer": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1000,
"vipVariableName": "vpn_if_vrrp_timer"
},
"track-omp": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_vrrp_track_omp"
},
"ipv4": {
"address": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "30.30.30.30",
"vipVariableName": "vpn_if_vrrp_vrrp_ipaddress"
}
},
"ipv4-secondary": {
"vipType": "ignore",
"vipValue": [],
"vipPrimaryKey": [
"address"
]
},
"tracking-object": {
"vipObjectType": "tree",
"vipType": "constant",
"vipValue": [
{
"name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1,
"vipVariableName": "vrrp_tracker_object_name_vrrp_tracker_name0"
},
"track-action": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "decrement",
"vipVariableName": "vrrp_tracker_object_action_vrrp_tracker_track_action0"
},
"decrement": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 14,
"vipVariableName": "vrrp_tracker_object_decrement_vrrp_tracker_decrement_0"
}
}
],
"vipPrimaryKey": [
"name"
]
},
"priority-order": [
"grp-id",
"priority",
"timer",
"track-omp",
"track-prefix-list",
"tracking-object",
"ipv4",
"ipv4-secondary"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"grp-id"
]
},
"ipv6-vrrp": {
"vipType": "ignore",
"vipValue": [],
"vipObjectType": "tree",
"vipPrimaryKey": [
"grp-id"
]
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleCiscoVpnInterface"
},
"cisco_vpn_interface_gre-example": {
"description": "cisco_vpn_interface_gre-example",
"value": {
"templateName": "template_vpn_interface_gre",
"templateDescription": "template_vpn_interface_gre",
"templateType": "cisco_vpn_interface_gre",
"deviceType": [
"vedge-C8000V"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"if-name": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "vpn_if_name_template_vpn_interface_gre"
},
"description": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "vpn_if_description"
},
"application": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "vpn_if_application"
},
"ip": {
"address": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "vpn_if_ipv4_address"
}
},
"shutdown": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "false",
"vipVariableName": "vpn_if_shutdown"
},
"tunnel-source": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "vpn_if_tunnel_source"
},
"tunnel-destination": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "vpn_if_tunnel_destination"
},
"mtu": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 300,
"vipVariableName": "vpn_if_ip_mtu"
},
"tcp-mss-adjust": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "vpn_if_tcp_mss_adjust"
},
"rewrite-rule": {
"rule-name": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "rewrite_rule_name"
}
},
"access-list": {
"vipType": "constant",
"vipValue": [
{
"acl-name": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "access_list_egress_acl_name_ipv4"
},
"direction": {
"vipType": "constant",
"vipValue": "out",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"direction"
]
},
"clear-dont-fragment": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "vpn_gre_tunnel_tunnel_clear_dont_fragment"
},
"tracker": {
"vipObjectType": "list",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "tracker"
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleCiscoVpnInterfaceGre"
},
"cisco_vpn_interface_ipsec-example": {
"description": "cisco_vpn_interface_ipsec-example",
"value": {
"templateName": "vpn_interface_ipsec",
"templateDescription": "vpn_interface_ipsec",
"templateType": "cisco_vpn_interface_ipsec",
"deviceType": [
"vedge-C8000V"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"if-name": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "vpn_if_name_vpn_interface_ipsec"
},
"description": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "vpn_if_description"
},
"application": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "sig",
"vipVariableName": "vpn_if_application"
},
"ip": {
"address": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "vpn_if_ipv4_address"
}
},
"shutdown": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "false",
"vipVariableName": "vpn_if_shutdown"
},
"tunnel-source": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "vpn_if_tunnel_source"
},
"tunnel-destination": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "vpn_if_tunnel_destination"
},
"mtu": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1500,
"vipVariableName": "vpn_if_mtu"
},
"tcp-mss-adjust": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "vpn_if_tcp_mss_adjust"
},
"dead-peer-detection": {
"dpd-interval": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 10,
"vipVariableName": "vpn_if_dpd_interval"
},
"dpd-retries": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 3,
"vipVariableName": "vpn_if_dpd_retries"
}
},
"ike": {
"ike-version": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 2,
"vipVariableName": "vpn_if_ike_version"
},
"ike-rekey-interval": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1440,
"vipVariableName": "vpn_if_ike_rekey_interval"
},
"ike-ciphersuite": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "aes256-cbc-sha1",
"vipVariableName": "vpn_if_ike_ciphersuite"
},
"ike-group": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "16",
"vipVariableName": "vpn_if_ike_group"
},
"authentication-type": {
"pre-shared-key": {
"pre-shared-secret": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "123456789a",
"vipVariableName": "vpn_if_pre_shared_secret"
},
"ike-local-id": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "123456789a",
"vipVariableName": "vpn_if_ike_local_id"
},
"ike-remote-id": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "123456789a",
"vipVariableName": "vpn_if_ike_remote_id"
}
}
}
},
"ipsec": {
"ipsec-rekey-interval": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 3600,
"vipVariableName": "vpn_if_ipsec_rekey_interval"
},
"ipsec-replay-window": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 512,
"vipVariableName": "vpn_if_ipsec_replay_window"
},
"ipsec-ciphersuite": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "aes256-gcm",
"vipVariableName": "vpn_if_ipsec_ciphersuite"
},
"perfect-forward-secrecy": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "group-16",
"vipVariableName": "vpn_if_ipsec_perfect_forward_secrecy"
}
},
"clear-dont-fragment": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "vpn_ipsec_tunnel_tunnel_clear_dont_fragment"
},
"tracker": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"tracker2"
],
"vipVariableName": "tracker"
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleCiscoVpnInterfaceIpsec"
},
"cisco_wireless_la-example": {
"description": "cisco_wireless_la-example",
"value": {
"templateName": "template_wireless",
"templateDescription": "template_wireless",
"templateType": "cisco_wireless_lan",
"deviceType": [
"vedge-C1101-4PLTEPW"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"radio": {
"shutdown-2.4ghz": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "false",
"vipVariableName": "radio_shutdown_2.4ghz"
},
"shutdown-5ghz": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "false",
"vipVariableName": "radio_shutdown-5ghz"
}
},
"country": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "BH",
"vipVariableName": "country_country"
},
"mgmt": {
"username": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "cisco",
"vipVariableName": "mgmt_username"
},
"password": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "123456789a",
"vipVariableName": "mgmt_password"
},
"address": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "0.0.0.0",
"vipVariableName": "mgmt_address"
},
"netmask": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "0.0.0.0",
"vipVariableName": "mgmt_netmask"
},
"default-gateway": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "0.0.0.0",
"vipVariableName": "mgmt_default_gateway"
}
},
"ssid": {
"vipType": "constant",
"vipValue": [
{
"name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "SSID1"
},
"admin-state": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "wifi-ssid_admin-state"
},
"broadcast-ssid": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "wifi-ssid_broadcast-ssid"
},
"vlan-id": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 123,
"vipVariableName": "wifi-ssid_vlan-id"
},
"radio-type": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "24ghz",
"vipVariableName": "wifi-ssid_radio-type"
},
"security-type": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "personal",
"vipVariableName": "wifi-ssid_security-type"
},
"radius-server-ip": {
"vipObjectType": "object",
"vipType": "ignore",
"vipVariableName": "wifi-ssid_server_ip_0"
},
"radius-server-port": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 1812,
"vipVariableName": "wifi-ssid_server_port_0"
},
"radius-server-secret": {
"vipObjectType": "object",
"vipType": "ignore",
"vipVariableName": "wifi-ssid_server_secret_0"
},
"passphrase": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "123456789a",
"vipVariableName": "wifi-ssid_passphrase"
},
"qos-profile": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "bronze",
"vipVariableName": "wifi-ssid_qos-profile"
},
"priority-order": [
"name",
"admin-state",
"broadcast-ssid",
"passphrase",
"qos-profile",
"radio-type",
"radius-server-ip",
"radius-server-port",
"radius-server-secret",
"security-type",
"vlan-id"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"name"
]
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleCiscoWirelessLan"
},
"cli-template-example": {
"description": "cli-template-example",
"value": {
"templateName": "template_cli_addon_template",
"templateDescription": "template_cli_addon_template",
"templateType": "cli-template",
"deviceType": [
"vedge-C8000V"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"config": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "abcdedfdgdggfggfgfggfgfgfgfggfghtrhg"
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleCliTemplate"
},
"dhcp-server-example": {
"description": "dhcp-server-example",
"value": {
"templateName": "template_vedge_dhcpserver",
"templateDescription": "template_vedge_dhcpserver",
"templateType": "dhcp-server",
"deviceType": [
"vedge-cloud"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"address-pool": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "192.168.1.10/24",
"vipVariableName": "dhcp_address_pool"
},
"exclude": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"192.168.1.111"
],
"vipVariableName": "dhcp-address_exclude"
},
"max-leases": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 600,
"vipVariableName": "max_leases"
},
"offer-time": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 300,
"vipVariableName": "offer_time"
},
"lease-time": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 86400,
"vipVariableName": "lease_time"
},
"admin-state": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "up",
"vipVariableName": "admin_state"
},
"options": {
"interface-mtu": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1500,
"vipVariableName": "dhcp_interface_mtu"
},
"domain-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "dns.org",
"vipVariableName": "dhcp_domain_name"
},
"default-gateway": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "192.168.1.254",
"vipVariableName": "dhcp_default_gateway"
},
"dns-servers": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"10.124.19.173"
],
"vipVariableName": "dhcp_dns_server"
},
"tftp-servers": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"10.124.19.169"
],
"vipVariableName": "tftp-server"
},
"option-code": {
"vipType": "constant",
"vipValue": [
{
"code": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 120,
"vipVariableName": "dhcp_option-code"
},
"ascii": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "000001edabcd",
"vipVariableName": "dhcp_ascii"
},
"hex": {
"vipObjectType": "object",
"vipType": "ignore"
},
"ip": {
"vipObjectType": "list",
"vipType": "ignore"
},
"priority-order": [
"code",
"ascii",
"hex",
"ip"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"code"
]
}
},
"static-lease": {
"vipType": "constant",
"vipValue": [
{
"mac-address": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "00:00:00:00:00:11",
"vipVariableName": "dhcp_mac_address"
},
"ip": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "192.168.1.20",
"vipVariableName": "dhcp_ip"
},
"host-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "vm5",
"vipVariableName": "dhcp_hostname"
},
"priority-order": [
"mac-address",
"ip",
"host-name"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"mac-address"
]
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleDhcpServer"
},
"eigrp-example": {
"description": "eigrp-example",
"value": {
"templateName": "template_eigrp",
"templateDescription": "template_eigrp",
"templateType": "eigrp",
"deviceType": [
"vedge-C8000V"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"eigrp": {
"as-num": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 11,
"vipVariableName": "eigrp_as_num"
},
"hello-interval": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 10,
"vipVariableName": "eigrp_hello-interval"
},
"hold-time": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 30,
"vipVariableName": "eigrp_hold-time"
},
"table-map": {
"name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "p1",
"vipVariableName": "eigrp_name"
}
},
"authentication": {
"type": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "md5",
"vipVariableName": "eigrp_type"
},
"auth-key": {},
"keychain": {
"key": {
"vipType": "constant",
"vipValue": [
{
"key_id": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1,
"vipVariableName": "key_id_key_id"
},
"keystring": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "123456789a",
"vipVariableName": "keystring_keystring"
}
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"key_id"
]
}
}
},
"address-family": {
"vipType": "constant",
"vipValue": [
{
"type": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "ipv4"
},
"network": {
"vipType": "constant",
"vipValue": [
{
"prefix": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "20.20.20.10/24",
"vipVariableName": "eigrp_network_network_address_prefix"
},
"priority-order": [
"prefix"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"prefix"
]
},
"topology": {
"base": {
"redistribute": {
"vipType": "constant",
"vipValue": [
{
"protocol": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "nat-route",
"vipVariableName": "eigrp_redistribute_protocol"
},
"route-map": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "forward",
"vipVariableName": "eigrp_redistribute_route_map"
},
"priority-order": [
"protocol",
"route-map"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"protocol"
]
}
}
},
"priority-order": [
"type",
"network",
"topology"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"type"
]
},
"af-interface": {
"vipType": "constant",
"vipValue": [
{
"name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "GigabitEthernet2/",
"vipVariableName": "eigrp_interface_name"
},
"shutdown": {
"vipObjectType": "node-only",
"vipType": "ignore",
"vipValue": "false",
"vipVariableName": "eigrp_interface_ip_shutdown"
},
"summary-address": {
"vipType": "constant",
"vipValue": [
{
"prefix": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "10.10.10.0/24",
"vipVariableName": "vpn_next_hop_ip_prefix_0"
},
"priority-order": [
"prefix"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"prefix"
]
},
"priority-order": [
"name",
"shutdown",
"summary-address"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"name"
]
}
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleEigrp"
},
"igmp-example": {
"description": "igmp-example",
"value": {
"templateName": "template_igmp",
"templateDescription": "template_igmp",
"templateType": "igmp",
"deviceType": [
"vedge-cloud"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"igmp": {
"shutdown": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "false",
"vipVariableName": "igmp_shutdown"
},
"interface": {
"vipType": "constant",
"vipValue": [
{
"name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "gi/0/0/1",
"vipVariableName": "igmp_interface_name_details"
},
"join-group": {
"vipType": "constant",
"vipValue": [
{
"group-address": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "239.1.1.1",
"vipVariableName": "igmp_interface_group_address_0"
},
"priority-order": [
"group-address"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"group-address"
]
},
"priority-order": [
"name",
"join-group"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"name"
]
}
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleIgmp"
},
"logging-example": {
"description": "logging-example",
"value": {
"templateName": "template_logging",
"templateDescription": "template_logging",
"templateType": "logging",
"deviceType": [
"vedge-cloud"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"disk": {
"enable": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "logging_disk_enable"
},
"file": {
"size": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 20,
"vipVariableName": "logging_max_file_size"
},
"rotate": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 10,
"vipVariableName": "logging_disk_rotation"
}
},
"priority": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "information",
"vipVariableName": "logging_disk_priority"
}
},
"server": {
"vipType": "constant",
"vipValue": [
{
"name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "10.124.19.169",
"vipVariableName": "logging_server_name"
},
"vpn": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 100,
"vipVariableName": "logging_server_vpn"
},
"source-interface": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "GigabitEthernet0",
"vipVariableName": "logging_server_source_interface"
},
"priority": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "emergency",
"vipVariableName": "logging_server_server_priority"
},
"priority-order": [
"name",
"vpn",
"source-interface",
"priority"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"name"
]
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleLogging"
},
"multicast-example": {
"description": "multicast-example",
"value": {
"templateName": "template_multicast",
"templateDescription": "template_multicast",
"templateType": "multicast",
"deviceType": [
"vedge-cloud"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"multicast-replicator": {
"local": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "multicast_replicator_local"
},
"threshold": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 60,
"vipVariableName": "multicast_replicator_threshold"
}
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleMulticast"
},
"ntp-example": {
"description": "ntp-example",
"value": {
"templateName": "template_ntp",
"templateDescription": "template_ntp",
"templateType": "ntp",
"deviceType": [
"vedge-cloud"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"keys": {
"trusted": {
"vipObjectType": "list",
"vipType": "ignore",
"vipVariableName": "trusted_key"
},
"authentication": {
"vipType": "constant",
"vipValue": [
{
"number": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1,
"vipVariableName": "ntp_auth_auth_key"
},
"md5": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "123456",
"vipVariableName": "ntp_auth_md5"
},
"priority-order": [
"number",
"md5"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"number"
]
}
},
"server": {
"vipType": "constant",
"vipValue": [
{
"name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "10.124.19.169",
"vipVariableName": "ntp_server_host"
},
"key": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1,
"vipVariableName": "ntp_server_server_auth_key"
},
"vpn": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 10,
"vipVariableName": "ntp_server_vpn"
},
"version": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 4,
"vipVariableName": "ntp_server_version"
},
"source-interface": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "gi0/1",
"vipVariableName": "ntp_server_source_interface"
},
"prefer": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "ntp_server_prefer"
},
"priority-order": [
"name",
"key",
"vpn",
"version",
"source-interface",
"prefer"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"name"
]
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleNtp"
},
"omp-vedge-example": {
"description": "omp-vedge-example",
"value": {
"templateName": "template_vedge",
"templateDescription": "template_vedge",
"templateType": "omp-vedge",
"deviceType": [
"vedge-1000"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"graceful-restart": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "omp_graceful_restart"
},
"send-path-limit": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 8,
"vipVariableName": "omp_send_path_limit"
},
"overlay-as": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 12,
"vipVariableName": "overlay_as"
},
"ecmp-limit": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 8,
"vipVariableName": "omp_ecmp_limit"
},
"shutdown": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "false",
"vipVariableName": "omp_shutdown"
},
"timers": {
"advertisement-interval": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 4,
"vipVariableName": "omp_advertisement_interval"
},
"graceful-restart-timer": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 86400,
"vipVariableName": "omp_graceful_restart_timer"
},
"holdtime": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 120,
"vipVariableName": "omp_holdtime"
},
"eor-timer": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 600,
"vipVariableName": "omp_eor_timer"
}
},
"distance": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 16,
"vipVariableName": "vpn_distance"
},
"advertise": {
"vipType": "constant",
"vipValue": [
{
"priority-order": [
"protocol"
],
"protocol": {
"vipType": "constant",
"vipValue": "bgp",
"vipObjectType": "object"
}
},
{
"priority-order": [
"protocol",
"route"
],
"protocol": {
"vipType": "constant",
"vipValue": "ospf",
"vipObjectType": "object"
},
"route": {
"vipType": "constant",
"vipValue": "external",
"vipObjectType": "object"
}
},
{
"priority-order": [
"protocol"
],
"protocol": {
"vipType": "constant",
"vipValue": "connected",
"vipObjectType": "object"
}
},
{
"priority-order": [
"protocol"
],
"protocol": {
"vipType": "constant",
"vipValue": "static",
"vipObjectType": "object"
}
},
{
"priority-order": [
"protocol"
],
"protocol": {
"vipType": "constant",
"vipValue": "eigrp",
"vipObjectType": "object"
}
},
{
"priority-order": [
"protocol"
],
"protocol": {
"vipType": "constant",
"vipValue": "lisp",
"vipObjectType": "object"
}
},
{
"priority-order": [
"protocol"
],
"protocol": {
"vipType": "constant",
"vipValue": "isis",
"vipObjectType": "object"
}
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"protocol"
]
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleOmpVedge"
},
"omp-vsmart-example": {
"description": "omp-vsmart-example",
"value": {
"templateName": "vsmart_omp",
"templateDescription": "vsmart_omp",
"templateType": "omp-vsmart",
"deviceType": [
"vsmart"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"graceful-restart": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "omp_graceful_restart"
},
"send-path-limit": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 8,
"vipVariableName": "omp_send_path_limit"
},
"send-backup-paths": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "omp_send_backup_paths"
},
"discard-rejected": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "omp_discard_rejected"
},
"shutdown": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "false",
"vipVariableName": "omp_shutdown"
},
"timers": {
"advertisement-interval": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 4,
"vipVariableName": "omp_advertisement_interval"
},
"graceful-restart-timer": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 86400,
"vipVariableName": "omp_graceful_restart_timer"
},
"holdtime": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 120,
"vipVariableName": "omp_holdtime"
},
"eor-timer": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 600,
"vipVariableName": "omp_eor_timer"
}
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleOmpVsmart"
},
"ospf-example": {
"description": "ospf-example",
"value": {
"templateName": "vedge_ospf",
"templateDescription": "vedge_ospf",
"templateType": "ospf",
"deviceType": [
"vedge-cloud"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"ospf": {
"router-id": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "10.10.10.10",
"vipVariableName": "ospf_router_id"
},
"auto-cost": {
"reference-bandwidth": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 100,
"vipVariableName": "ospf_reference_bandwidth"
}
},
"compatible": {
"rfc1583": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "ospf_rfc1583"
}
},
"distance": {
"external": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 5,
"vipVariableName": "ospf_distance_external"
},
"inter-area": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 10,
"vipVariableName": "ospf_distance_inter_area"
},
"intra-area": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 10,
"vipVariableName": "ospf_distance_intra_area"
}
},
"timers": {
"spf": {
"delay": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 200,
"vipVariableName": "ospf_delay"
},
"initial-hold": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1000,
"vipVariableName": "ospf_initial_hold"
},
"max-hold": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 10000,
"vipVariableName": "ospf_max_hold"
}
}
},
"route-policy": {
"vipType": "constant",
"vipValue": [
{
"direction": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "in"
},
"pol-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "p1",
"vipVariableName": "ospf_pol_name"
},
"priority-order": [
"direction",
"pol-name"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"direction"
]
},
"default-information": {
"originate": {
"always": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "ospf_originate_always"
},
"metric": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 4,
"vipVariableName": "ospf_originate_metric"
},
"metric-type": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "type1",
"vipVariableName": "ospf_originate_metric_type"
}
}
},
"redistribute": {
"vipType": "constant",
"vipValue": [
{
"protocol": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "bgp",
"vipVariableName": "ospf_redistribute_protocol"
},
"route-policy": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "p1",
"vipVariableName": "ospf_redistribute_route_policy"
},
"priority-order": [
"protocol",
"route-policy"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"protocol"
]
},
"max-metric": {
"router-lsa": {
"vipType": "constant",
"vipValue": [
{
"ad-type": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "administrative"
},
"priority-order": [
"ad-type"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"ad-type"
]
}
},
"area": {
"vipType": "constant",
"vipValue": [
{
"a-num": {
"originalDefaultOption": "constant",
"dataPath": [],
"vipObjectType": "object",
"vipValue": 0,
"vipType": "constant",
"vipVariableName": "ospf_area_a_num"
},
"stub": {
"no-summary": {
"vipType": "constant",
"vipObjectType": "node-only",
"vipVariableName": "ospf_area_no_summary",
"vipValue": "true"
}
},
"priority-order": [
"a-num",
"stub"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"a-num"
]
}
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleOspf"
},
"pim-example": {
"description": "pim-example",
"value": {
"templateName": "template_pim",
"templateDescription": "template_pim",
"templateType": "pim",
"deviceType": [
"vedge-cloud"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"pim": {
"shutdown": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "false",
"vipVariableName": "pim_shutdown"
},
"auto-rp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "pim_auto_rp"
},
"spt-threshold": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 100,
"vipVariableName": "pim_spt_threshold"
},
"replicator-selection": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "sticky",
"vipVariableName": "pim_replicator_selection"
},
"interface": {
"vipType": "constant",
"vipValue": [
{
"name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "gi3",
"vipVariableName": "pim_if_name"
},
"hello-interval": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 60,
"vipVariableName": "pim_hello_interval"
},
"join-prune-interval": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 120,
"vipVariableName": "pim_join_prune_interval"
},
"priority-order": [
"name",
"hello-interval",
"join-prune-interval"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"name"
]
}
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExamplePim"
},
"probe-example": {
"description": "probe-example",
"value": {
"templateName": "template_probes",
"templateDescription": "template_probes",
"templateType": "probes",
"deviceType": [
"vedge-C8000V"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"bfd-probe-path": {
"all-tlocs": {
"vipType": "constant",
"vipValue": true,
"vipObjectType": "object"
},
"trigger-on-change": {
"key": "trigger-on-change",
"description": "Start event / On-Change based probe-paths",
"details": "Start event / On-Change based probe-paths",
"optionType": [
{
"value": "constant",
"display": "Global",
"iconClass": "language",
"iconColor": "icon-global"
}
],
"originalDefaultOption": "constant",
"defaultOption": "constant",
"dataType": {
"type": "boolean",
"default": false
},
"dataPath": [
"bfd-probe-path"
],
"vipObjectType": "object",
"objectType": "object",
"deleteFlag": false,
"vipValue": true,
"vipType": "constant"
}
},
"probe": {
"latency": {
"key": "latency",
"description": "Latency-Probe Frequency",
"details": "Latency-Probe Frequency in seconds: <0..65530>",
"optionType": [
{
"value": "constant",
"display": "Global",
"iconClass": "language",
"iconColor": "icon-global"
},
{
"value": "variable",
"display": "Device Specific",
"iconClass": "router",
"iconColor": "icon-variable"
}
],
"originalDefaultOption": "constant",
"defaultOption": "constant",
"dataType": {
"type": "number",
"min": 0,
"max": 65530,
"default": 30
},
"dataPath": [
"probe"
],
"vipObjectType": "object",
"objectType": "object",
"deleteFlag": false,
"vipValue": 60,
"vipType": "constant",
"vipVariableName": "probe_latency"
},
"saas": {}
},
"probe-path": {
"trigger": {
"key": "trigger",
"description": "trigger",
"details": "trigger",
"optionType": [
{
"value": "constant",
"display": "Global",
"iconClass": "language",
"iconColor": "icon-global"
}
],
"originalDefaultOption": "constant",
"defaultOption": "constant",
"dataType": {
"type": "enum",
"values": [
{
"key": "on-change",
"value": "on-change"
},
{
"key": "periodic",
"value": "periodic"
}
]
},
"dataPath": [
"probe-path"
],
"vipObjectType": "object",
"objectType": "object",
"deleteFlag": false,
"vipValue": "on-change",
"vipType": "constant"
},
"branch": {
"color-all-dia": {
"vipType": "constant",
"vipValue": true,
"vipObjectType": "node-only"
}
}
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleProbes"
},
"secure-internet-gateway-example": {
"description": "secure-internet-gateway-example",
"value": {
"templateName": "template_sig_vedge",
"templateDescription": "template_sig_vedge",
"templateType": "secure-internet-gateway",
"deviceType": [
"vedge-cloud"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"vpn-id": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 0
},
"interface": {
"vipType": "constant",
"vipValue": [
{
"if-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "ipsec1",
"vipVariableName": "tunnel_if_name"
},
"auto": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true"
},
"shutdown": {
"vipObjectType": "object",
"vipType": "notIgnore",
"vipValue": "false",
"vipVariableName": "tunnel_shutdown"
},
"description": {
"vipObjectType": "object",
"vipType": "ignore",
"vipVariableName": "tunnel_description"
},
"ip": {
"unnumbered": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "true"
}
},
"tunnel-source-interface": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "gi0/1",
"vipVariableName": "tunnel_tunnel_source_interface"
},
"tunnel-destination": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "dynamic"
},
"tunnel-set": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "secure-internet-gateway-umbrella"
},
"tunnel-dc-preference": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "primary-dc"
},
"tcp-mss-adjust": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 1300,
"vipVariableName": "tunnel_tcp_mss_adjust_"
},
"mtu": {
"vipObjectType": "object",
"vipType": "notIgnore",
"vipValue": 1400,
"vipVariableName": "tunnel_mtu_"
},
"dead-peer-detection": {
"dpd-interval": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 10,
"vipVariableName": "tunnel_dpd_interval"
},
"dpd-retries": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 3,
"vipVariableName": "tunnel_dpd_retries"
}
},
"ike": {
"ike-version": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 2
},
"authentication-type": {
"pre-shared-key-dynamic": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "true"
}
},
"ike-rekey-interval": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 14400,
"vipVariableName": "tunnel_ike_rekey_interval_"
},
"ike-ciphersuite": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "aes256-cbc-sha2",
"vipVariableName": "tunnel_ike_ciphersuite"
},
"ike-group": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "14",
"vipVariableName": "tunnel_ike_group"
}
},
"ipsec": {
"ipsec-rekey-interval": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1800,
"vipVariableName": "tunnel_ipsec_rekey_interval"
},
"ipsec-replay-window": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 512,
"vipVariableName": "tunnel_ipsec_replay_window"
},
"ipsec-ciphersuite": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "aes256-cbc-sha384",
"vipVariableName": "tunnel_ipsec_ciphersuite"
},
"perfect-forward-secrecy": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "group-14",
"vipVariableName": "tunnel_perfect_forward_secrecy"
}
},
"tracker": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "tracker"
},
"track-enable": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true"
}
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"if-name"
]
},
"service": {
"vipType": "constant",
"vipValue": [
{
"svc-type": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "sig"
},
"ha-pairs": {
"interface-pair": {
"vipType": "constant",
"vipObjectType": "tree",
"vipPrimaryKey": [
"active-interface",
"backup-interface"
],
"vipValue": [
{
"active-interface": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "ipsec1"
},
"backup-interface": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "None"
},
"active-interface-weight": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 7
},
"backup-interface-weight": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1
},
"priority-order": [
"active-interface",
"backup-interface",
"active-interface-weight",
"backup-interface-weight"
]
}
]
}
},
"umbrella-data-center": {
"data-center-primary": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "au1-a.vpn.sig.umbrella.com",
"vipVariableName": "vpn_umbprimarydc"
},
"data-center-secondary": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "us2-b.vpn.sig.umbrella.com",
"vipVariableName": "vpn_umbsecondarydc"
}
}
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"svc-type"
]
},
"tracker": {
"vipType": "constant",
"vipValue": [
{
"name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "tracker",
"vipVariableName": "tracker_name"
},
"endpoint-api-url": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "https://www.baidu.com",
"vipVariableName": "tracker_endpoint-api-url"
},
"threshold": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 600,
"vipVariableName": "tracker_threshold"
},
"interval": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 120,
"vipVariableName": "tracker_interval"
},
"multiplier": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 6,
"vipVariableName": "tracker_multiplier"
},
"tracker-type": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "SIG"
},
"priority-order": [
"tracker-type",
"name",
"endpoint-api-url",
"threshold",
"interval",
"multiplier"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"tracker-type",
"name"
]
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleSecureInternetGateway"
},
"security-vedge-example": {
"description": "security-vedge-example",
"value": {
"templateName": "template_security_vedge",
"templateDescription": "template_security_vedge",
"templateType": "security-vedge",
"deviceType": [
"vedge-cloud"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"ipsec": {
"rekey": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 86400,
"vipVariableName": "security_rekey"
},
"replay-window": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "1024",
"vipVariableName": "security_replay_window"
},
"authentication-type": {
"vipType": "constant",
"vipValue": [
"sha1-hmac",
"ah-sha1-hmac",
"ah-no-id"
],
"vipObjectType": "list",
"vipVariableName": "security_authenticationType"
},
"integrity-type": {
"vipType": "constant",
"vipValue": [
"esp",
"ip-udp-esp",
"ip-udp-esp-no-id"
],
"vipObjectType": "list"
},
"pairwise-keying": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "security_pairwise_keying"
}
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleSecurityVedge"
},
"security-vsmart-example": {
"description": "security-vsmart-example",
"value": {
"templateName": "template_security_vsmart",
"templateDescription": "template_security_vsmart",
"templateType": "security-vsmart",
"deviceType": [
"vsmart"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"control": {
"protocol": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "dtls",
"vipVariableName": "security_protocol"
}
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleSecurityVsmart"
},
"sig-credential-example": {
"description": "sig-credential-example",
"value": {
"templateName": "template_sig_credentials",
"templateDescription": "template_sig_credentials",
"templateType": "sig-credentials",
"deviceType": [
"vedge-cloud"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"umbrella": {
"api-key": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "123456789a",
"vipVariableName": "system_api_key"
},
"api-secret": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "123456789a",
"vipVariableName": "system_api_secret",
"vipNeedsEncryption": true
},
"org-id": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "viptela",
"vipVariableName": "system_org_id"
}
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleSigCredentials"
},
"snmp-example": {
"description": "snmp-example",
"value": {
"templateName": "template_snmp",
"templateDescription": "template_snmp",
"templateType": "snmp",
"deviceType": [
"vedge-cloud"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"shutdown": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "false",
"vipVariableName": "snmp_shutdown"
},
"contact": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "jefrey",
"vipVariableName": "snmp_contact"
},
"name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "snmpv2",
"vipVariableName": "snmp_device_name"
},
"location": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "Shanghai",
"vipVariableName": "snmp_device_location"
},
"view": {
"vipType": "constant",
"vipValue": [
{
"name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": " v2"
},
"oid": {
"vipType": "constant",
"vipValue": [
{
"id": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "snmp_view_id_0"
},
"exclude": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "snmp_view_exclude_0"
},
"priority-order": [
"id",
"exclude"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"id"
]
},
"priority-order": [
"name",
"oid"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"name"
]
},
"community": {
"vipType": "constant",
"vipValue": [
{
"name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "c1",
"vipNeedsEncryption": "true"
},
"view": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": " v2",
"vipVariableName": "snmp_community_view"
},
"authorization": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "read-only",
"vipVariableName": "snmp_community_authorization"
},
"priority-order": [
"name",
"authorization",
"view"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"name"
]
},
"trap": {
"group": {
"vipType": "constant",
"vipValue": [
{
"group-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "trap1"
},
"enable": {
"vipType": "constant",
"vipValue": [
{
"module": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "bfd",
"vipVariableName": "snmp_trap_types_module_0"
},
"level": {
"vipType": "constant",
"vipValue": [
"major"
],
"vipObjectType": "list",
"vipVariableName": "snmp_trap_types_level_0"
},
"priority-order": [
"module",
"level"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"module"
]
},
"priority-order": [
"group-name",
"enable"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"group-name"
]
},
"target": {
"vipType": "constant",
"vipValue": [
{
"vpn-id": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 12,
"vipVariableName": "snmp_trap_vpn_id"
},
"ip": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "10.10.10.10",
"vipVariableName": "snmp_trap_ip"
},
"port": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1000,
"vipVariableName": "snmp_trap_port"
},
"group-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "trap1",
"vipVariableName": "snmp_trap_trap_group_name"
},
"community-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "c1",
"vipVariableName": "snmp_trap_community_name",
"vipNeedsEncryption": "true"
},
"user": {},
"source-interface": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "GigabitEthernet2",
"vipVariableName": "snmp_trap_source_interface"
},
"users": {
"vipObjectType": "object",
"vipType": "constant"
},
"priority-order": [
"vpn-id",
"ip",
"port",
"group-name",
"community-name",
"source-interface"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"vpn-id",
"ip",
"port"
]
}
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleSnmp"
},
"switchport-example": {
"description": "switchport-example",
"value": {
"templateName": "template_switchport",
"templateDescription": "template_switchport",
"templateType": "switchport",
"deviceType": [
"vedge-C8000V"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"slot": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 0
},
"module": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "4"
},
"age-time": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 300,
"vipVariableName": "switchport_age_time"
},
"subslot": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1
},
"interface": {
"vipType": "constant",
"vipValue": [
{
"if-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "GigabitEthernet0/1/3",
"vipVariableName": "switchport_if_if_name"
},
"switchport": {
"mode": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "trunk"
},
"trunk": {
"allowed": {
"vlan": {
"vlans": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "100",
"vipVariableName": "switchport_if_trunk_allowed_vlans"
}
}
},
"native": {
"vlan": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "",
"vipVariableName": "switchport_if_trunk_native_vlan"
}
}
}
},
"shutdown": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "false",
"vipVariableName": "switchport_if_shutdown"
},
"speed": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "100",
"vipVariableName": "switchport_if_speed"
},
"duplex": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "full",
"vipVariableName": "switchport_if_duplex"
},
"dot1x": {
"port-control": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "auto",
"vipVariableName": "802.1X_port-control"
},
"voice-vlan": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 200,
"vipVariableName": "802.1X_voice-vlan"
},
"pae-enable": {
"vipObjectType": "object",
"vipType": "notIgnore",
"vipValue": "true",
"vipVariableName": "802.1X_pae-enable"
},
"mac-authentication-bypass": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "802.1X_mac-auth-bypass"
},
"authentication": {
"host-mode": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "single-host",
"vipVariableName": "802.1X_host-mode"
},
"enable-periodic-reauth": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "802.1X_enable-periodic-reauth"
},
"periodic-reauthentication": {
"inactivity": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 60,
"vipVariableName": "802.1X_inactivity"
},
"reauthentication": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 30,
"vipVariableName": "802.1X_reauthentication"
}
},
"control-direction": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "both",
"vipVariableName": "802.1X_control_direction"
},
"event": {
"restricted-vlan": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 400,
"vipVariableName": "802.1X_restricted-vlan"
},
"guest-vlan": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 300,
"vipVariableName": "802.1X_guest-vlan"
},
"critical-vlan": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 201,
"vipVariableName": "802.1X_critical-vlan"
},
"enable-voice": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "802.1X_enable-voice"
}
}
}
},
"priority-order": [
"if-name",
"shutdown",
"switchport",
"speed",
"duplex",
"dot1x"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"if-name"
]
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleSwitchport"
},
"system-vedge-example": {
"description": "system-vedge-example",
"value": {
"templateName": "template_system",
"templateDescription": "template_system",
"templateType": "system-vedge",
"deviceType": [
"vedge-cloud"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"clock": {
"timezone": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "Africa/Casablanca",
"vipVariableName": "system_timezone"
}
},
"gps-location": {
"latitude": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "system_latitude"
},
"longitude": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "system_longitude"
}
},
"timer": {
"dns-cache-timeout": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 2,
"vipVariableName": "system_dns_cache_timeout"
}
},
"location": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "Shanghai",
"vipVariableName": "system_location"
},
"system-tunnel-mtu": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1024,
"vipVariableName": "system_system_tunnel_mtu"
},
"track-transport": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "system_track_transport"
},
"track-interface-tag": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 2,
"vipVariableName": "system_track_interface_tag"
},
"port-offset": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1,
"vipVariableName": "system_port_offset"
},
"port-hop": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "system_port_hop"
},
"control-session-pps": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 600,
"vipVariableName": "system_control_session_pps"
},
"description": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "description1",
"vipVariableName": "system_description"
},
"device-groups": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"group1"
],
"vipVariableName": "system_device_groups"
},
"controller-group-list": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"1"
],
"vipVariableName": "system_controller_group_list"
},
"eco-friendly-mode": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "system_eco_friendly_mode"
},
"site-id": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "system_site_id"
},
"overlay-id": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1,
"vipVariableName": "system_overlay_id"
},
"system-ip": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "system_system_ip"
},
"host-name": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "system_host_name"
},
"console-baud-rate": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "9600",
"vipVariableName": "system_console_baud_rate"
},
"max-omp-sessions": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 12,
"vipVariableName": "system_max_omp_sessions"
},
"usb-controller": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "false",
"vipVariableName": "system_usb_controller"
},
"track-default-gateway": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "system_track_default_gateway"
},
"multicast-buffer-percent": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 20,
"vipVariableName": "system_multicast_buffer_percent"
},
"host-policer-pps": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 20000,
"vipVariableName": "system_host_policer_pps"
},
"icmp-error-pps": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 200,
"vipVariableName": "system_icmp_error_pps"
},
"vbond": {
"local": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "system_local"
},
"remote": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "10.10.20.20"
}
},
"allow-same-site-tunnels": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "system_allow_same_site_tunnels"
},
"route-consistency-check": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "system_route_consistency_check"
},
"idle-timeout": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 30,
"vipVariableName": "system_idle-timeout"
},
"admin-tech-on-failure": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "system_admin_tech_on_failure"
},
"region": {
"region-id": {
"id": {}
}
},
"role": {},
"on-demand": {
"enable": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "system_on-demand-enable"
},
"idle-timeout": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 20,
"vipVariableName": "system_on-demand-idle-timeout"
}
},
"tracker": {
"vipType": "constant",
"vipValue": [
{
"name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "interface",
"vipVariableName": "tracker_name"
},
"endpoint-ip": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "10.10.10.10",
"vipVariableName": "tracker_endpoint-ip"
},
"threshold": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 600,
"vipVariableName": "tracker_threshold"
},
"interval": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 120,
"vipVariableName": "tracker_interval"
},
"multiplier": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 6,
"vipVariableName": "tracker_multiplier"
},
"tracker-elements": {
"vipObjectType": "list",
"vipType": "ignore"
},
"boolean": {
"vipObjectType": "object",
"vipType": "ignore"
},
"tracker-type": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "interface",
"vipVariableName": "tracker_tracker_type_"
},
"priority-order": [
"name",
"tracker-type",
"tracker-elements",
"boolean",
"endpoint-ip",
"endpoint-dns-name",
"endpoint-api-url",
"endpoint-ip-transport-port",
"threshold",
"interval",
"multiplier"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"name"
]
},
"track-list": {
"vipType": "constant",
"vipValue": [
{
"list-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "tracker2",
"vipVariableName": "tracker_list_name_"
},
"interface": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"GigabitEthernet1"
],
"vipVariableName": "tracker_interface_"
},
"priority-order": [
"list-name",
"interface",
"sig-container"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"list-name"
]
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleSystemVedge"
},
"system-vsmart-example": {
"description": "system-vsmart-example",
"value": {
"templateName": "template_system_vsmart",
"templateDescription": "template_system_vsmart",
"templateType": "system-vsmart",
"deviceType": [
"vsmart"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"clock": {
"timezone": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "Asia/Chongqing",
"vipVariableName": "system_timezone"
}
},
"gps-location": {
"latitude": {
"vipObjectType": "object",
"vipType": "ignore",
"vipVariableName": "system_latitude"
},
"longitude": {
"vipObjectType": "object",
"vipType": "ignore",
"vipVariableName": "system_longitude"
}
},
"timer": {
"dns-cache-timeout": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 2,
"vipVariableName": "system_dns_cache_timeout"
}
},
"location": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "Shanghai",
"vipVariableName": "system_location"
},
"system-tunnel-mtu": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1024,
"vipVariableName": "system_system_tunnel_mtu"
},
"track-transport": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "system_track_transport"
},
"port-offset": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1,
"vipVariableName": "system_port_offset"
},
"port-hop": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "system_port_hop"
},
"control-session-pps": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 400,
"vipVariableName": "system_control_session_pps"
},
"controller-group-id": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1,
"vipVariableName": "system_controller_group_id"
},
"description": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "Description1",
"vipVariableName": "system_description"
},
"device-groups": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"group1"
],
"vipVariableName": "system_device_groups"
},
"site-id": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "100"
},
"overlay-id": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1,
"vipVariableName": "system_overlay_id"
},
"system-ip": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "172.16.255.15"
},
"host-name": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "vm5"
},
"ipv6-strict-control": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "system_ipv6_strict_control"
},
"track-default-gateway": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "system_track_default_gateway"
},
"host-policer-pps": {},
"icmp-error-pps": {},
"iptables-enable": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "system_iptables_enable"
},
"admin-tech-on-failure": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "system_admin_tech_on_failure"
},
"idle-timeout": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 60,
"vipVariableName": "system_idle-timeout"
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleSystemVsmart"
},
"t1-e1-controller-example": {
"description": "t1-e1-controller-example",
"value": {
"templateName": "template_t1e1_controller",
"templateDescription": "template_t1e1_controller",
"templateType": "t1-e1-controller",
"deviceType": [
"vedge-C8000V"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"card": {
"type": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "t1"
},
"slot": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 0
},
"bay": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1
}
},
"bandwidth-upstream": {},
"bandwidth-downstream": {},
"controller-tx-ex-list": {
"vipType": "constant",
"vipValue": [
{
"name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "T1"
},
"number": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "0/1/1"
},
"framing": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "esf",
"vipVariableName": "framing"
},
"clock": {
"source": {
"line": {
"line-mode": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "primary",
"vipVariableName": "line_mode"
}
},
"internal": {
"vipType": "ignore"
},
"loop-timed": {
"vipType": "ignore"
}
}
},
"description": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "Description1",
"vipVariableName": "description"
},
"linecode": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "ami",
"vipVariableName": "line_code"
},
"cablelength": {
"long": {
"vipType": "ignore"
},
"short": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "_empty",
"vipVariableName": "short_length"
}
},
"channel-group": {
"vipType": "ignore",
"vipValue": [],
"vipObjectType": "tree",
"vipPrimaryKey": [
"number"
]
},
"priority-order": [
"name",
"number",
"subSlot",
"framing",
"line-mode",
"internal",
"loop-timed",
"description",
"linecode",
"cablelength",
"clock",
"channel-group"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"name",
"number"
]
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleT1E1Controller"
},
"tenant-example": {
"description": "tenant-example",
"value": {
"templateName": "template_tenant",
"templateDescription": "template_tenant",
"templateType": "tenant",
"deviceType": [
"vedge-C8000V"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"tenant": {
"vipType": "constant",
"vipValue": [
{
"org-name": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "org_tenant"
}
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"org-name"
]
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleTenant"
},
"ucse-example": {
"description": "ucse-example",
"value": {
"templateName": "template_ucse",
"templateDescription": "template_ucse",
"templateType": "ucse",
"deviceType": [
"vedge-ISR-4461"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"bay": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1
},
"slot": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 3
},
"imc": {
"access-port": {
"dedicated": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": ""
},
"shared-lom": {
"ge1": {
"vipObjectType": "node-only",
"vipType": "ignore",
"vipValue": ""
},
"ge2": {
"vipObjectType": "node-only",
"vipType": "ignore",
"vipValue": ""
},
"ge3": {
"vipObjectType": "node-only",
"vipType": "ignore",
"vipValue": ""
},
"te2": {
"vipObjectType": "node-only",
"vipType": "ignore",
"vipValue": ""
},
"te3": {
"vipObjectType": "node-only",
"vipType": "ignore",
"vipValue": ""
},
"console": {
"vipObjectType": "node-only",
"vipType": "ignore",
"vipValue": ""
},
"failover": {
"ge2": {
"vipObjectType": "node-only",
"vipType": "ignore",
"vipValue": ""
},
"te2": {
"vipObjectType": "node-only",
"vipType": "ignore",
"vipValue": ""
}
}
}
},
"ip": {
"static-case": {
"address": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "10.10.10.10/24",
"vipVariableName": "ucse_address"
},
"default-gateway": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "10.10.10.1",
"vipVariableName": "ucse_default_gateway_default-gateway"
}
}
},
"vlan": {
"vlan-id": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 100,
"vipVariableName": "ucse_default_gateway_vlan-id"
},
"priority": {
"vipObjectType": "object",
"vipType": "ignore",
"vipVariableName": "ucse_default_gateway_priority"
}
}
},
"subslot-name": {
"vipValue": "1/3",
"vipType": "constant",
"vipObjectType": "object",
"vipVariableName": ""
},
"module-type": {
"vipValue": "ucse",
"vipType": "constant",
"vipObjectType": "object",
"vipVariableName": "ucse"
},
"interface": {
"vipType": "constant",
"vipValue": [
{
"if-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "ucse1/3/",
"vipVariableName": "ucse_if_if_name"
},
"switchport": {
"mode": {
"key": "mode",
"description": "Switch port type",
"details": "Set type of switch port: access/trunk",
"optionType": [
{
"value": "constant",
"display": "Global",
"iconClass": "language",
"iconColor": "icon-global"
}
],
"originalDefaultOption": "constant",
"defaultOption": "constant",
"dataType": {
"type": "enum",
"values": [
{
"key": "access",
"value": "access"
},
{
"key": "trunk",
"value": "trunk"
}
]
},
"dataPath": [
"switchport"
],
"vipObjectType": "object",
"objectType": "object",
"deleteFlag": false
},
"access": {
"vlan": {
"vlan": {
"key": "vlan",
"description": "VLAN ID",
"details": "Set VLAN identifier associated with bridging domain",
"optionType": [
{
"value": "constant",
"display": "Global",
"iconClass": "language",
"iconColor": "icon-global"
},
{
"value": "variable",
"display": "Device Specific",
"iconClass": "router",
"iconColor": "icon-variable"
},
{
"value": "ignore",
"display": "Default",
"iconClass": "check_circle",
"iconColor": "icon-default"
}
],
"originalDefaultOption": "ignore",
"defaultOption": "ignore",
"dataType": {
"type": "number",
"min": 1,
"max": 4094
},
"dataPath": [
"vlan"
],
"vipObjectType": "object",
"objectType": "object",
"deleteFlag": false
}
}
},
"trunk": {
"allowed": {
"vlan": {
"vlans": {
"key": "vlans",
"description": "Allowed VLANS",
"details": "Configure VLAN IDs used with the trunk",
"optionType": [
{
"value": "constant",
"display": "Global",
"iconClass": "language",
"iconColor": "icon-global"
},
{
"value": "variable",
"display": "Device Specific",
"iconClass": "router",
"iconColor": "icon-variable"
},
{
"value": "ignore",
"display": "Default",
"iconClass": "check_circle",
"iconColor": "icon-default"
}
],
"originalDefaultOption": "ignore",
"defaultOption": "ignore",
"dataType": {
"type": "string",
"range": "1-4094"
},
"dataPath": [
"vlan"
],
"vipObjectType": "object",
"objectType": "object",
"deleteFlag": false
}
}
},
"native": {
"vlan": {
"key": "vlan",
"description": "Native VLAN ID",
"details": "Configure VLAN ID used for native VLAN",
"optionType": [
{
"value": "constant",
"display": "Global",
"iconClass": "language",
"iconColor": "icon-global"
},
{
"value": "variable",
"display": "Device Specific",
"iconClass": "router",
"iconColor": "icon-variable"
},
{
"value": "ignore",
"display": "Default",
"iconClass": "check_circle",
"iconColor": "icon-default"
}
],
"originalDefaultOption": "ignore",
"defaultOption": "ignore",
"dataType": {
"type": "number",
"min": 1,
"max": 4094
},
"dataPath": [
"native"
],
"vipObjectType": "object",
"objectType": "object",
"deleteFlag": false
}
}
}
},
"ip": {
"static-case": {
"address": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "20.20.20.20/24",
"vipVariableName": "ucse_if_ipv4_address"
}
}
},
"priority-order": [
"if-name",
"shutdown",
"ip"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"if-name"
]
},
"priority-order": [
"subslot-name",
"bay",
"slot",
"imc",
"interface",
"module-type"
]
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleUcse"
},
"virtual-application-utd-example": {
"description": "virtual-application-utd-example",
"value": {
"templateName": "security_app_hosting",
"templateDescription": "security_app_hosting",
"templateType": "virtual-application-utd",
"deviceType": [
"vedge-CSR-1000v"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"virtual-application": {
"vipType": "constant",
"vipValue": [
{
"instance-id": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "6a0018c9-2083-4045-98ab-44a2f2457d9b",
"vipVariableName": "instance_id"
},
"application-type": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "utd",
"vipVariableName": "application_type"
},
"utd": {
"nat": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "nat"
},
"database-url": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "database_url"
},
"resource-profile": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "medium",
"vipVariableName": "resource_profile"
}
},
"priority-order": [
"instance-id",
"application-type",
"utd"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"instance-id"
]
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleVirtualApplicationUtd"
},
"vpn-cedge-interface-cellular-example": {
"description": "vpn-cedge-interface-cellular-example",
"value": {
"templateName": "vpn_interface_cellular",
"templateDescription": "vpn_interface_cellular",
"templateType": "vpn-cedge-interface-cellular",
"deviceType": [
"vedge-C8000V"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"if-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "GigabitEthernet1",
"vipVariableName": "vpn_if_name"
},
"description": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "basic_configuration",
"vipVariableName": "vpn_if_description"
},
"ip": {
"address": {}
},
"ipv6": {
"address": {},
"access-list": {
"vipType": "ignore",
"vipValue": [],
"vipObjectType": "tree",
"vipPrimaryKey": [
"direction"
]
}
},
"dhcp-helper": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"10.10.10.10"
],
"vipVariableName": "vpn_if_dhcp_helper"
},
"clear-dont-fragment": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_clear_dont_fragment"
},
"pmtu": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_pmtu"
},
"mtu": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1428,
"vipVariableName": "vpn_if_ip_mtu"
},
"static-ingress-qos": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "vpn_if_static_ingress_qos"
},
"tcp-mss-adjust": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1380,
"vipVariableName": "vpn_if_tcp_mss_adjust"
},
"shutdown": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "false",
"vipVariableName": "vpn_if_shutdown"
},
"arp-timeout": {},
"autonegotiate": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "vpn_if_autonegotiate"
},
"shaping-rate": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 100000,
"vipVariableName": "rewrite_shaping_rate"
},
"qos-map": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "qos-map"
},
"tracker": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"TRACKER2"
],
"vipVariableName": "vpn_if_tracker"
},
"bandwidth-upstream": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 100000,
"vipVariableName": "vpn_if_bandwidth_upstream"
},
"bandwidth-downstream": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 50000,
"vipVariableName": "vpn_if_bandwidth_downstream"
},
"block-non-source-ip": {},
"rewrite-rule": {
"rule-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "Rule1",
"vipVariableName": "rewrite_rule-name"
}
},
"tloc-extension": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "vpn_if_tloc_extension"
},
"icmp-redirect-disable": {},
"tloc-extension-gre-from": {
"src-ip": {},
"xconnect": {}
},
"access-list": {
"vipType": "constant",
"vipValue": [
{
"acl-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "10.10.10.10",
"vipVariableName": "access_list_ingress_acl_name_ipv4"
},
"direction": {
"vipType": "constant",
"vipValue": "in",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
},
{
"acl-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "20.20.20.20",
"vipVariableName": "access_list_egress_acl_name_ipv4"
},
"direction": {
"vipType": "constant",
"vipValue": "out",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"direction"
]
},
"policer": {
"vipType": "constant",
"vipValue": [
{
"policer-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "policer1",
"vipVariableName": "policer_ingress_policer_name"
},
"direction": {
"vipType": "constant",
"vipValue": "in",
"vipObjectType": "object"
},
"priority-order": [
"policer-name",
"direction"
]
},
{
"policer-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "policer2",
"vipVariableName": "policer_egress_policer_name"
},
"direction": {
"vipType": "constant",
"vipValue": "out",
"vipObjectType": "object"
},
"priority-order": [
"policer-name",
"direction"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"policer-name",
"direction"
]
},
"profile": {},
"technology": {},
"tunnel-interface": {
"encapsulation": {
"vipType": "constant",
"vipValue": [
{
"preference": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 7,
"vipVariableName": "vpn_if_tunnel_gre_preference"
},
"weight": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 10,
"vipVariableName": "vpn_if_tunnel_gre_weight"
},
"encap": {
"vipType": "constant",
"vipValue": "gre",
"vipObjectType": "object"
},
"priority-order": [
"encap",
"preference",
"weight"
]
},
{
"preference": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 5,
"vipVariableName": "vpn_if_tunnel_ipsec_preference"
},
"weight": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1,
"vipVariableName": "vpn_if_tunnel_ipsec_weight"
},
"encap": {
"vipType": "constant",
"vipValue": "ipsec",
"vipObjectType": "object"
},
"priority-order": [
"encap",
"preference",
"weight"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"encap"
]
},
"group": {
"vipObjectType": "list",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "vpn_if_tunnel_group"
},
"border": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_border"
},
"color": {
"value": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "3g",
"vipVariableName": "vpn_if_tunnel_color_value"
},
"restrict": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_color_restrict"
}
},
"carrier": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "carrier1",
"vipVariableName": "vpn_if_tunnel_carrier"
},
"bind": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "tunnel0",
"vipVariableName": "vpn_if_tunnel_bind"
},
"allow-service": {
"dhcp": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_dhcp"
},
"dns": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_dns"
},
"icmp": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_icmp"
},
"sshd": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_sshd"
},
"ntp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_ntp"
},
"stun": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_stun"
},
"all": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_all"
},
"bgp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_bgp"
},
"ospf": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_ospf"
},
"netconf": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_netconf"
},
"snmp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_snmp"
},
"https": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_https"
}
},
"max-control-connections": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 8,
"vipVariableName": "vpn_if_tunnel_max_control_connections"
},
"vbond-as-stun-server": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_vbond_as_stun_server"
},
"exclude-controller-group-list": {
"vipObjectType": "list",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "vpn_if_tunnel_exclude_controller_group_list"
},
"vmanage-connection-preference": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 6,
"vipVariableName": "vpn_if_tunnel_vmanage_connection_preference"
},
"port-hop": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_port_hop"
},
"low-bandwidth-link": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_low_bandwidth_link"
},
"last-resort-circuit": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_last-resort-circuit"
},
"hold-time": {},
"nat-refresh-interval": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 5,
"vipVariableName": "vpn_if_tunnel_nat_refresh_interval"
},
"hello-interval": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1000,
"vipVariableName": "vpn_if_tunnel_hello_interval"
},
"hello-tolerance": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 12,
"vipVariableName": "vpn_if_tunnel_hello_tolerance"
},
"tloc-extension-gre-to": {
"dst-ip": {}
},
"tunnel-qos": {
"mode": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "hub"
}
},
"tunnel-tcp-mss-adjust": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1400,
"vipVariableName": "vpn_if_tunnel_tunnel_tcp_mss_adjust"
},
"clear-dont-fragment": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_tunnel_clear_dont_fragment"
},
"network-broadcast": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_tunnel_network_broadcast"
}
},
"nat64-enable": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "false"
},
"ip-directed-broadcast": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_ip-directed-broadcast"
},
"qos-map-vpn": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "",
"vipVariableName": "vpn-qos_map"
},
"nat": {
"refresh": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "outbound",
"vipVariableName": "nat_refresh"
},
"log-translations": {},
"udp-timeout": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1,
"vipVariableName": "nat_udp_timeout"
},
"tcp-timeout": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 60,
"vipVariableName": "nat_tcp_timeout"
},
"block-icmp-error": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "nat_block_icmp_error"
},
"respond-to-ping": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "nat_respond_to_ping"
},
"natpool": {
"range-start": {},
"range-end": {}
},
"port-forward": {
"vipType": "ignore",
"vipValue": [],
"vipObjectType": "tree",
"vipPrimaryKey": [
"port-start",
"port-end",
"proto"
]
}
},
"arp": {
"ip": {
"vipType": "constant",
"vipValue": [
{
"addr": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "192.168.1.111",
"vipVariableName": "vpn_bridge_arp_addr"
},
"mac": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "00:00:00:00:00:01",
"vipVariableName": "vpn_bridge_arp_mac"
},
"priority-order": [
"addr",
"mac"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"addr"
]
}
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleVpnCedgeInterfaceCellular"
},
"vpn-cedge-interface-multilink-controller-example": {
"description": "vpn-cedge-interface-multilink-controller-example",
"value": {
"templateName": "vpn_interface_multilink",
"templateDescription": "vpn_interface_multilink",
"templateType": "vpn-cedge-interface-multilink-controller",
"deviceType": [
"vedge-C8000V"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"if-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "Multilink1",
"vipVariableName": "if_multilink_ctrl_if_name"
},
"ppp": {
"authentication": {
"method": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "chap"
},
"pap": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "false"
},
"callin": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "false",
"vipVariableName": "pppoa_dsl_auth-callin"
}
},
"chap": {
"hostname": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "vm5",
"vipVariableName": "pppoa_dsl_chap_hostname"
},
"password": {
"ppp-auth-password": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "123456789a",
"vipVariableName": "pppoa_dsl_ppp_auth_password"
}
}
},
"multilink": {
"group": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1,
"vipVariableName": "if_multilink_ctrl_multilink_group"
},
"fragment": {
"disable": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "if_multilink_fragment_disable_multilink_fragment_disable"
},
"delay": {
"delay-value": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 60,
"vipVariableName": "if_multilink_fragment_delay_value_multilink_fragment_delay_value"
}
}
},
"interleave": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "if_multilink_interleave_multilink_interleave"
}
}
},
"description": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "descrip1",
"vipVariableName": "if_multilink_ctrl_description"
},
"ip": {
"address": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "5.5.5.5/24",
"vipVariableName": "if_multilink_ctrl_ip_addr"
}
},
"ipv6": {
"address": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "2001:4860:4801:48::33/16",
"vipVariableName": "if_multilink_ctrl_ipv6_address"
},
"access-list": {
"vipType": "constant",
"vipValue": [
{
"acl-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": " 2001:4860:4801:48::55",
"vipVariableName": "access_list_ingress_acl_name_ipv6"
},
"direction": {
"vipType": "constant",
"vipValue": "in",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
},
{
"acl-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": " 2001:4860:4801:48::66",
"vipVariableName": "access_list_egress_acl_name_ipv6"
},
"direction": {
"vipType": "constant",
"vipValue": "out",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"direction"
]
}
},
"pmtu": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_pmtu"
},
"mtu": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1500,
"vipVariableName": "if_multilink_ctrl_mtu"
},
"static-ingress-qos": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1,
"vipVariableName": "vpn_if_static_ingress_qos"
},
"tcp-mss-adjust": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1300,
"vipVariableName": "vpn_if_tcp_mss_adjust"
},
"tloc-extension": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "tloc",
"vipVariableName": "vpn_if_tloc_extension"
},
"shutdown": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "false",
"vipVariableName": "if_multilink_ctrl_shutdown"
},
"autonegotiate": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "vpn_if_autonegotiate"
},
"shaping-rate": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 100000,
"vipVariableName": "qos_shaping-rate"
},
"qos-map": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "",
"vipVariableName": "qos-map"
},
"qos-map-vpn": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "q1",
"vipVariableName": "vpn-qos_map"
},
"bandwidth-upstream": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 100000,
"vipVariableName": "if_multilink_ctrl_bandwidth_upstream"
},
"bandwidth-downstream": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 200000,
"vipVariableName": "if_multilink_ctrl_bandwidth_downstream"
},
"rewrite-rule": {
"rule-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "r1",
"vipVariableName": "rewrite_rule-name"
}
},
"access-list": {
"vipType": "constant",
"vipValue": [
{
"acl-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "6.6.6.6/24",
"vipVariableName": "access_list_ingress_acl_name_ipv4"
},
"direction": {
"vipType": "constant",
"vipValue": "in",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
},
{
"acl-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "7.7.7.7/24",
"vipVariableName": "access_list_egress_acl_name_ipv4"
},
"direction": {
"vipType": "constant",
"vipValue": "out",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"direction"
]
},
"policer": {
"vipType": "constant",
"vipValue": [
{
"policer-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "policer1",
"vipVariableName": "policer_ingress_policer_name"
},
"direction": {
"vipType": "constant",
"vipValue": "in",
"vipObjectType": "object"
},
"priority-order": [
"policer-name",
"direction"
]
},
{
"policer-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "policer1",
"vipVariableName": "policer_egress_policer_name"
},
"direction": {
"vipType": "constant",
"vipValue": "out",
"vipObjectType": "object"
},
"priority-order": [
"policer-name",
"direction"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"policer-name",
"direction"
]
},
"tunnel-interface": {
"encapsulation": {
"vipType": "constant",
"vipValue": [
{
"preference": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 7,
"vipVariableName": "vpn_if_tunnel_gre_preference"
},
"weight": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 10,
"vipVariableName": "vpn_if_tunnel_gre_weight"
},
"encap": {
"vipType": "constant",
"vipValue": "gre",
"vipObjectType": "object"
},
"priority-order": [
"encap",
"preference",
"weight"
]
},
{
"preference": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 5,
"vipVariableName": "vpn_if_tunnel_ipsec_preference"
},
"weight": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 2,
"vipVariableName": "vpn_if_tunnel_ipsec_weight"
},
"encap": {
"vipType": "constant",
"vipValue": "ipsec",
"vipObjectType": "object"
},
"priority-order": [
"encap",
"preference",
"weight"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"encap"
]
},
"group": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"15"
],
"vipVariableName": "vpn_if_tunnel_group"
},
"border": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_border"
},
"color": {
"value": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "mpls",
"vipVariableName": "color_value"
},
"restrict": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_color_restrict"
}
},
"carrier": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "carrier5",
"vipVariableName": "vpn_if_tunnel_carrier"
},
"bind": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "tunnel1",
"vipVariableName": "vpn_if_tunnel_bind"
},
"allow-service": {
"dhcp": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_dhcp"
},
"dns": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_dns"
},
"icmp": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_icmp"
},
"sshd": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_sshd"
},
"ntp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_ntp"
},
"stun": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_stun"
},
"all": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_all"
},
"bgp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_bgp"
},
"ospf": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_ospf"
},
"netconf": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_netconf"
},
"snmp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_snmp"
},
"https": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true"
}
},
"max-control-connections": {
"vipObjectType": "object",
"vipType": "ignore",
"vipVariableName": "vpn_if_tunnel_max_control_connections"
},
"vbond-as-stun-server": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "false",
"vipVariableName": "vpn_if_tunnel_vbond_as_stun_server"
},
"exclude-controller-group-list": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"3"
],
"vipVariableName": "vpn_if_tunnel_exclude_controller_group_list"
},
"vmanage-connection-preference": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 7,
"vipVariableName": "vpn_if_tunnel_vmanage_connection_preference"
},
"port-hop": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_port_hop"
},
"low-bandwidth-link": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_low_bandwidth_link"
},
"last-resort-circuit": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_last_resort_circuit"
},
"hold-time": {},
"nat-refresh-interval": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 60,
"vipVariableName": "vpn_if_tunnel_nat_refresh_interval"
},
"hello-interval": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 600,
"vipVariableName": "vpn_if_tunnel_hello_interval"
},
"hello-tolerance": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 12,
"vipVariableName": "vpn_if_tunnel_hello_tolerance"
},
"tloc-extension-gre-to": {
"dst-ip": {}
},
"tunnel-tcp-mss-adjust": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1300,
"vipVariableName": "vpn_if_tunnel_tunnel_tcp_mss_adjust"
},
"clear-dont-fragment": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_tunnel_clear_dont_fragment"
},
"network-broadcast": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_tunnel_network_broadcast"
}
},
"nat64-enable": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "false"
},
"qos-adaptive": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "false",
"vipVariableName": "adaptive_qos"
},
"clear-dont-fragment": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_clear_dont_fragment"
},
"ip-directed-broadcast": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_ip-directed-broadcast"
},
"controller": {
"controller-tx-ex-list": {
"vipType": "constant",
"vipValue": [
{
"name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "T1"
},
"number": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "0/0/1"
},
"framing": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "ef",
"vipVariableName": "controller_tx_ex_list_framing"
},
"clock": {
"source": {
"line": {
"line-mode": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "primary",
"vipVariableName": "controller_tx_ex_list_line_mode"
}
},
"internal": {
"vipObjectType": "node-only",
"vipType": "ignore",
"vipValue": "",
"vipVariableName": "controller_tx_ex_list_controller_tx_ex_list_internal_0"
}
}
},
"description": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "descript1",
"vipVariableName": "controller_tx_ex_list_multilink_description"
},
"linecode": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "b8zs",
"vipVariableName": "controller_tx_ex_list_linecode"
},
"cablelength": {
"long": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "100",
"vipVariableName": "controller_tx_ex_list_long"
},
"short": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": ""
}
},
"channel-group": {
"vipType": "constant",
"vipValue": [
{
"number": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1,
"vipVariableName": "multilink_channel_group_number_0"
},
"timeslots": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": "2021-08-25",
"vipVariableName": "multilink_channel_group_timeslots_0"
},
"priority-order": [
"number",
"timeslots"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"number"
]
},
"priority-order": [
"name",
"number",
"framing",
"line-mode",
"internal",
"description",
"linecode",
"long",
"short",
"channel-group"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"name",
"number"
]
}
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleVpnCedgeInterfaceMultilinkController"
},
"vpn-interface-ethpppoe-example": {
"description": "vpn-interface-ethpppoe-example",
"value": {
"templateName": "vpn_interface_ethernet_pppoe",
"templateDescription": "vpn_interface_ethernet_pppoe",
"templateType": "vpn-interface-ethpppoe",
"deviceType": [
"vedge-ISR-4331"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"if-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "gi0/0/1",
"vipVariableName": "pppoe_dsl_if_name"
},
"shutdown": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "false",
"vipVariableName": "pppoe_dsl_shutdown"
},
"description": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "description1",
"vipVariableName": "pppoe_dsl_description"
},
"bridge-dot1q": {
"encap": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 123,
"vipVariableName": "pppoe_dsl_dot1q_encap"
}
},
"pppoe-client": {
"dial-pool-number": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 255,
"vipVariableName": "pppoe_dsl_dial_pool_number"
},
"ppp-max-payload": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 64,
"vipVariableName": "pppoe_dsl_ppp_max_payload"
}
},
"ip": {
"address-negotiated": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "true"
}
},
"shaping-rate": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "rewrite_shaping_rate"
},
"qos-map": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "map1",
"vipVariableName": "rewrite_qos_map"
},
"qos-map-vpn": {
"vipObjectType": "object",
"vipType": "ignore",
"vipVariableName": "vpn-qos_map"
},
"rewrite-rule": {
"rule-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "rul1",
"vipVariableName": "rewrite_rule_name"
}
},
"mtu": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1500,
"vipVariableName": "pppoe_dsl_ip_mtu"
},
"tcp-mss-adjust": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1400,
"vipVariableName": "pppoe_dsl_tcp_mss_adjust"
},
"tloc-extension": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "tloc1",
"vipVariableName": "pppoe_dsl_tloc_extension"
},
"tracker": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"trak1"
],
"vipVariableName": "pppoe_dsl_tracker"
},
"bandwidth-upstream": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 100000,
"vipVariableName": "pppoe_dsl_bandwidth_upstream"
},
"bandwidth-downstream": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 200000,
"vipVariableName": "pppoe_dsl_bandwidth_downstream"
},
"access-list": {
"vipType": "constant",
"vipValue": [
{
"acl-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "5.5.5.5",
"vipVariableName": "access_list_ingress_acl_name_ipv4"
},
"direction": {
"vipType": "constant",
"vipValue": "in",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
},
{
"acl-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "6.6.6.6",
"vipVariableName": "access_list_egress_acl_name_ipv4"
},
"direction": {
"vipType": "constant",
"vipValue": "out",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"direction"
]
},
"ipv6": {
"access-list": {
"vipType": "constant",
"vipValue": [
{
"acl-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "1050:0:0:0:5:600:300c:326b",
"vipVariableName": "access_list_ingress_acl_name_ipv6"
},
"direction": {
"vipType": "constant",
"vipValue": "in",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
},
{
"acl-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "1050:0:0:0:5:600:300c:3312",
"vipVariableName": "access_list_egress_acl_name_ipv6"
},
"direction": {
"vipType": "constant",
"vipValue": "out",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"direction"
]
}
},
"policer": {
"vipType": "constant",
"vipValue": [
{
"policer-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "policer1",
"vipVariableName": "policer_ingress_policer_name"
},
"direction": {
"vipType": "constant",
"vipValue": "in",
"vipObjectType": "object"
},
"priority-order": [
"policer-name",
"direction"
]
},
{
"policer-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "policer1",
"vipVariableName": "policer_egress_policer_name"
},
"direction": {
"vipType": "constant",
"vipValue": "out",
"vipObjectType": "object"
},
"priority-order": [
"policer-name",
"direction"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"policer-name",
"direction"
]
},
"tunnel-interface": {
"encapsulation": {
"vipType": "constant",
"vipValue": [
{
"preference": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 7,
"vipVariableName": "vpn_if_tunnel_gre_preference"
},
"weight": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 2,
"vipVariableName": "vpn_if_tunnel_gre_weight"
},
"encap": {
"vipType": "constant",
"vipValue": "gre",
"vipObjectType": "object"
},
"priority-order": [
"encap",
"preference",
"weight"
]
},
{
"preference": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 7,
"vipVariableName": "vpn_if_tunnel_ipsec_preference"
},
"weight": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 2,
"vipVariableName": "vpn_if_tunnel_ipsec_weight"
},
"encap": {
"vipType": "constant",
"vipValue": "ipsec",
"vipObjectType": "object"
},
"priority-order": [
"encap",
"preference",
"weight"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"encap"
]
},
"group": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"4"
],
"vipVariableName": "vpn_if_tunnel_group"
},
"border": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_border"
},
"color": {
"value": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "biz-internet",
"vipVariableName": "color_value"
},
"restrict": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_color_restrict"
}
},
"carrier": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "carrier8",
"vipVariableName": "vpn_if_tunnel_carrier"
},
"bind": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "0",
"vipVariableName": "vpn_if_tunnel_bind"
},
"allow-service": {
"dhcp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_dhcp"
},
"dns": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_dns"
},
"icmp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_icmp"
},
"sshd": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_sshd"
},
"ntp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_ntp"
},
"stun": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_stun"
},
"all": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_all"
},
"bgp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_bgp"
},
"ospf": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_ospf"
},
"netconf": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_netconf"
},
"snmp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_snmp"
},
"https": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true"
}
},
"max-control-connections": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 8,
"vipVariableName": "vpn_if_tunnel_max_control_connections"
},
"vbond-as-stun-server": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_vbond_as_stun_server"
},
"exclude-controller-group-list": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"4"
],
"vipVariableName": "vpn_if_tunnel_exclude_controller_group_list"
},
"vmanage-connection-preference": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 5,
"vipVariableName": "vpn_if_tunnel_vmanage_connection_preference"
},
"port-hop": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_port_hop"
},
"low-bandwidth-link": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_low_bandwidth_link"
},
"last-resort-circuit": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_last_resort_circuit"
},
"hold-time": {},
"nat-refresh-interval": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 60,
"vipVariableName": "vpn_if_tunnel_nat_refresh_interval"
},
"hello-interval": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 600,
"vipVariableName": "vpn_if_tunnel_hello_interval"
},
"hello-tolerance": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 12,
"vipVariableName": "vpn_if_tunnel_hello_tolerance"
},
"tloc-extension-gre-to": {
"dst-ip": {}
},
"tunnel-tcp-mss-adjust": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1300,
"vipVariableName": "vpn_if_tunnel_tunnel_tcp_mss_adjust"
},
"clear-dont-fragment": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_tunnel_clear_dont_fragment"
},
"network-broadcast": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_tunnel_network_broadcast"
}
},
"nat64-enable": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "false"
},
"ppp": {
"authentication": {
"method": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "chap"
},
"pap": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "false"
},
"callin": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "false",
"vipVariableName": "pppoe_dsl_auth-callin"
}
},
"chap": {
"hostname": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "host_zzz",
"vipVariableName": "pppoe_dsl_chap_hostname"
},
"password": {
"ppp-auth-password": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "123456789a",
"vipVariableName": "pppoe_dsl_chap_auth_password"
}
}
}
},
"ip-directed-broadcast": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_ip-directed-broadcast"
},
"qos-adaptive": {
"period": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 10,
"vipVariableName": "qos_adaptive_period"
},
"downstream": {
"bandwidth-down": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1000,
"vipVariableName": "qos_adaptive_downstream_bandwidth_down"
},
"range": {
"dmin": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1000,
"vipVariableName": "qos_adaptive_downstream_range_dmin"
},
"dmax": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 2000,
"vipVariableName": "qos_adaptive_downstream_range_dmax"
}
}
},
"upstream": {
"bandwidth-up": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1000,
"vipVariableName": "qos_adaptive_upstream_bandwidth_up"
},
"range": {
"umin": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1000,
"vipVariableName": "qos_adaptive_upstream_range_umin"
},
"umax": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 2000,
"vipVariableName": "qos_adaptive_upstream_range_umax"
}
}
}
},
"nat": {
"log-translations": {},
"udp-timeout": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 2,
"vipVariableName": "nat_udp_timeout"
},
"tcp-timeout": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 60,
"vipVariableName": "nat_tcp_timeout"
},
"natpool": {
"range-start": {},
"range-end": {}
}
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleVpnInterfaceEthpppoe"
},
"vpn-interface-ipoe-example": {
"description": "vpn-interface-ipoe-example",
"value": {
"templateName": "vpn_interface_dsl_ipoe",
"templateDescription": "vpn_interface_dsl_ipoe",
"templateType": "vpn-interface-ipoe",
"deviceType": [
"vedge-C1117-4PLTEEAW"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"if-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "Ethernet1/0/0",
"vipVariableName": "pppoe_dsl_if_name"
},
"bridge-dot1q": {
"encap": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 111,
"vipVariableName": "pppoe_dsl_dot1q_encap"
}
},
"shutdown": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "false",
"vipVariableName": "pppoe_dsl_shutdown"
},
"description": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "descrip1",
"vipVariableName": "pppoe_dsl_description"
},
"pppoe-client": {
"ppp-max-payload": {},
"dial-pool-number": {}
},
"ip": {
"address-negotiated": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "true"
},
"dhcp-client": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true"
},
"dhcp-distance": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 2,
"vipVariableName": "vpn_if_ipv4_dhcp_distance"
}
},
"shaping-rate": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "rewrite_shaping_rate"
},
"qos-map": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "map1",
"vipVariableName": "rewrite_qos_map"
},
"qos-map-vpn": {
"vipObjectType": "object",
"vipType": "ignore",
"vipVariableName": "vpn-qos_map"
},
"rewrite-rule": {
"rule-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "rule1",
"vipVariableName": "rewrite_rule_name"
}
},
"mtu": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1500,
"vipVariableName": "pppoe_dsl_ip_mtu"
},
"tcp-mss-adjust": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1400,
"vipVariableName": "pppoe_dsl_tcp_mss_adjust"
},
"tloc-extension": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "tloc",
"vipVariableName": "pppoe_dsl_tloc_extension"
},
"tracker": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"tracker1"
],
"vipVariableName": "pppoe_dsl_tracker"
},
"bandwidth-upstream": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 100000,
"vipVariableName": "pppoe_dsl_bandwidth_upstream"
},
"bandwidth-downstream": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 100000,
"vipVariableName": "pppoe_dsl_bandwidth_downstream"
},
"access-list": {
"vipType": "constant",
"vipValue": [
{
"acl-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "5.5.5.5",
"vipVariableName": "access_list_ingress_acl_name_ipv4"
},
"direction": {
"vipType": "constant",
"vipValue": "in",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
},
{
"acl-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "6.6.6.6",
"vipVariableName": "access_list_egress_acl_name_ipv4"
},
"direction": {
"vipType": "constant",
"vipValue": "out",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"direction"
]
},
"ipv6": {
"access-list": {
"vipType": "constant",
"vipValue": [
{
"acl-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "1050:0:0:0:5:600:300c:326b",
"vipVariableName": "access_list_ingress_acl_name_ipv6"
},
"direction": {
"vipType": "constant",
"vipValue": "in",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
},
{
"acl-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "1050:0:0:0:5:600:300c:947e",
"vipVariableName": "access_list_egress_acl_name_ipv6"
},
"direction": {
"vipType": "constant",
"vipValue": "out",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"direction"
]
}
},
"policer": {
"vipType": "constant",
"vipValue": [
{
"policer-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "policer1",
"vipVariableName": "policer_ingress_policer_name"
},
"direction": {
"vipType": "constant",
"vipValue": "in",
"vipObjectType": "object"
},
"priority-order": [
"policer-name",
"direction"
]
},
{
"policer-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "policer1",
"vipVariableName": "policer_egress_policer_name"
},
"direction": {
"vipType": "constant",
"vipValue": "out",
"vipObjectType": "object"
},
"priority-order": [
"policer-name",
"direction"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"policer-name",
"direction"
]
},
"tunnel-interface": {
"encapsulation": {
"vipType": "constant",
"vipValue": [
{
"preference": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 10,
"vipVariableName": "vpn_if_tunnel_gre_preference"
},
"weight": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 2,
"vipVariableName": "vpn_if_tunnel_gre_weight"
},
"encap": {
"vipType": "constant",
"vipValue": "gre",
"vipObjectType": "object"
},
"priority-order": [
"encap",
"preference",
"weight"
]
},
{
"preference": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 6,
"vipVariableName": "vpn_if_tunnel_ipsec_preference"
},
"weight": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 2,
"vipVariableName": "vpn_if_tunnel_ipsec_weight"
},
"encap": {
"vipType": "constant",
"vipValue": "ipsec",
"vipObjectType": "object"
},
"priority-order": [
"encap",
"preference",
"weight"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"encap"
]
},
"group": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"14"
],
"vipVariableName": "vpn_if_tunnel_group"
},
"border": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_border"
},
"color": {
"value": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "lte",
"vipVariableName": "color_value"
},
"restrict": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_color_restrict"
}
},
"carrier": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "carrier3",
"vipVariableName": "vpn_if_tunnel_carrier"
},
"bind": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "tunnel1",
"vipVariableName": "vpn_if_tunnel_bind"
},
"allow-service": {
"dhcp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_dhcp"
},
"dns": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_dns"
},
"icmp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_icmp"
},
"sshd": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_sshd"
},
"ntp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_ntp"
},
"stun": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_stun"
},
"all": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_all"
},
"bgp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_bgp"
},
"ospf": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_ospf"
},
"netconf": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_netconf"
},
"snmp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_snmp"
},
"https": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "false"
}
},
"max-control-connections": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 8,
"vipVariableName": "vpn_if_tunnel_max_control_connections"
},
"vbond-as-stun-server": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_vbond_as_stun_server"
},
"exclude-controller-group-list": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"9"
],
"vipVariableName": "vpn_if_tunnel_exclude_controller_group_list"
},
"vmanage-connection-preference": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 7,
"vipVariableName": "vpn_if_tunnel_vmanage_connection_preference"
},
"port-hop": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_port_hop"
},
"low-bandwidth-link": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_low_bandwidth_link"
},
"last-resort-circuit": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_last_resort_circuit"
},
"hold-time": {},
"nat-refresh-interval": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 10,
"vipVariableName": "vpn_if_tunnel_nat_refresh_interval"
},
"hello-interval": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 600,
"vipVariableName": "vpn_if_tunnel_hello_interval"
},
"hello-tolerance": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 12,
"vipVariableName": "vpn_if_tunnel_hello_tolerance"
},
"tloc-extension-gre-to": {
"dst-ip": {}
},
"tunnel-tcp-mss-adjust": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1380,
"vipVariableName": "vpn_if_tunnel_tunnel_tcp_mss_adjust"
},
"clear-dont-fragment": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_tunnel_clear_dont_fragment"
},
"network-broadcast": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_tunnel_network_broadcast"
}
},
"nat64-enable": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "false"
},
"ppp": {
"authentication": {
"method": {},
"pap": {}
},
"chap": {
"hostname": {},
"password": {
"ppp-auth-password": {}
}
},
"pap": {
"sent-username": {
"username": {
"username-string": {},
"password": {},
"ppp-auth-password": {}
}
}
}
},
"dhcp-helper": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"1.1.1.1"
],
"vipVariableName": "vpn_if_dhcp_helper"
},
"controller-type": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "ipoe",
"vipVariableName": "ipoe"
},
"ip-directed-broadcast": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_ip-directed-broadcast"
},
"qos-adaptive": {
"period": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 15,
"vipVariableName": "qos_adaptive_period"
},
"downstream": {
"bandwidth-down": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 200,
"vipVariableName": "qos_adaptive_downstream_bandwidth_down"
},
"range": {
"dmin": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 200,
"vipVariableName": "qos_adaptive_downstream_range_dmin"
},
"dmax": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 300,
"vipVariableName": "qos_adaptive_downstream_range_dmax"
}
}
},
"upstream": {
"bandwidth-up": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 100,
"vipVariableName": "qos_adaptive_upstream_bandwidth_up"
},
"range": {
"umin": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 100,
"vipVariableName": "qos_adaptive_upstream_range_umin"
},
"umax": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 200,
"vipVariableName": "qos_adaptive_upstream_range_umax"
}
}
}
},
"controller": {
"vdsl": {
"vipType": "constant",
"vipValue": [
{
"modem": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "2",
"vipVariableName": "pppoe_dsl_modem"
},
"name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "1",
"vipVariableName": "pppoe_dsl_vdsl_name"
},
"sra": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "pppoe_dsl_sra"
},
"operating": {
"mode": {
"auto": {
"adsl2plus": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "true"
}
}
}
},
"priority-order": [
"name",
"sra",
"operating",
"modem"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"name"
]
}
},
"nat": {
"log-translations": {},
"udp-timeout": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 30,
"vipVariableName": "nat_udp_timeout"
},
"tcp-timeout": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 60,
"vipVariableName": "nat_tcp_timeout"
},
"natpool": {
"range-start": {},
"range-end": {}
}
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleVpnInterfaceIpoe"
},
"vpn-interface-pppoa-example": {
"description": "vpn-interface-pppoa-example",
"value": {
"templateName": "template_vpn_interface_pppoa",
"templateDescription": "template_vpn_interface_pppoa",
"templateType": "vpn-interface-pppoa",
"deviceType": [
"vedge-ISR-4331"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"if-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "ATM1/0/0",
"vipVariableName": "pppoa_dsl_if_name"
},
"shutdown": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "false",
"vipVariableName": "pppoa_dsl_shutdown"
},
"description": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "atm",
"vipVariableName": "pppoa_dsl_description"
},
"bandwidth-upstream": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 10000,
"vipVariableName": "pppoa_dsl_bandwidth_upstream"
},
"bandwidth-downstream": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 20000,
"vipVariableName": "pppoa_dsl_bandwidth_downstream"
},
"mtu": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1500,
"vipVariableName": "pppoa_dsl_ip_mtu"
},
"tcp-mss-adjust": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1400,
"vipVariableName": "pppoa_dsl_tcp_mss_adjust"
},
"tloc-extension": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "tloc",
"vipVariableName": "pppoa_dsl_tloc_extension"
},
"tracker": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"trak1"
],
"vipVariableName": "pppoa_dsl_tracker"
},
"shaping-rate": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "rewrite_shaping_rate"
},
"qos-map": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "m1",
"vipVariableName": "rewrite_qos_map"
},
"qos-map-vpn": {
"vipObjectType": "object",
"vipType": "ignore",
"vipVariableName": "vpn-qos_map"
},
"rewrite-rule": {
"rule-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "r1",
"vipVariableName": "rewrite_rule_name"
}
},
"access-list": {
"vipType": "constant",
"vipValue": [
{
"acl-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "11.11.11.11",
"vipVariableName": "access_list_ingress_acl_name_ipv4"
},
"direction": {
"vipType": "constant",
"vipValue": "in",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
},
{
"acl-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "22.22.22.22",
"vipVariableName": "access_list_egress_acl_name_ipv4"
},
"direction": {
"vipType": "constant",
"vipValue": "out",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"direction"
]
},
"ipv6": {
"access-list": {
"vipType": "constant",
"vipValue": [
{
"acl-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "1050:0:0:0:5:600:300c:326b",
"vipVariableName": "access_list_ingress_acl_name_ipv6"
},
"direction": {
"vipType": "constant",
"vipValue": "in",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
},
{
"acl-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "1050:0:0:0:5:600:300c:4412",
"vipVariableName": "access_list_egress_acl_name_ipv6"
},
"direction": {
"vipType": "constant",
"vipValue": "out",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"direction"
]
}
},
"policer": {
"vipType": "constant",
"vipValue": [
{
"policer-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "poli1",
"vipVariableName": "policer_ingress_policer_name"
},
"direction": {
"vipType": "constant",
"vipValue": "in",
"vipObjectType": "object"
},
"priority-order": [
"policer-name",
"direction"
]
},
{
"policer-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "poli1",
"vipVariableName": "policer_egress_policer_name"
},
"direction": {
"vipType": "constant",
"vipValue": "out",
"vipObjectType": "object"
},
"priority-order": [
"policer-name",
"direction"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"policer-name",
"direction"
]
},
"tunnel-interface": {
"encapsulation": {
"vipType": "constant",
"vipValue": [
{
"preference": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 4,
"vipVariableName": "vpn_if_tunnel_gre_preference"
},
"weight": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 2,
"vipVariableName": "vpn_if_tunnel_gre_weight"
},
"encap": {
"vipType": "constant",
"vipValue": "gre",
"vipObjectType": "object"
},
"priority-order": [
"encap",
"preference",
"weight"
]
},
{
"preference": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 7,
"vipVariableName": "vpn_if_tunnel_ipsec_preference"
},
"weight": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 3,
"vipVariableName": "vpn_if_tunnel_ipsec_weight"
},
"encap": {
"vipType": "constant",
"vipValue": "ipsec",
"vipObjectType": "object"
},
"priority-order": [
"encap",
"preference",
"weight"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"encap"
]
},
"group": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"2"
],
"vipVariableName": "vpn_if_tunnel_group"
},
"border": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_border"
},
"color": {
"value": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "gold",
"vipVariableName": "color_value"
},
"restrict": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_color_restrict"
}
},
"carrier": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "carrier3",
"vipVariableName": "vpn_if_tunnel_carrier"
},
"bind": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "tunnel2",
"vipVariableName": "vpn_if_tunnel_bind"
},
"allow-service": {
"dhcp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_dhcp"
},
"dns": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_dns"
},
"icmp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_icmp"
},
"sshd": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_sshd"
},
"ntp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_ntp"
},
"stun": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_stun"
},
"all": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_all"
},
"bgp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_bgp"
},
"ospf": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_ospf"
},
"netconf": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_netconf"
},
"snmp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_snmp"
},
"https": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true"
}
},
"max-control-connections": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 6,
"vipVariableName": "vpn_if_tunnel_max_control_connections"
},
"vbond-as-stun-server": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_vbond_as_stun_server"
},
"exclude-controller-group-list": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"3"
],
"vipVariableName": "vpn_if_tunnel_exclude_controller_group_list"
},
"vmanage-connection-preference": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 7,
"vipVariableName": "vpn_if_tunnel_vmanage_connection_preference"
},
"port-hop": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_port_hop"
},
"low-bandwidth-link": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_low_bandwidth_link"
},
"last-resort-circuit": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_last_resort_circuit"
},
"hold-time": {},
"nat-refresh-interval": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 10,
"vipVariableName": "vpn_if_tunnel_nat_refresh_interval"
},
"hello-interval": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1000,
"vipVariableName": "vpn_if_tunnel_hello_interval"
},
"hello-tolerance": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 12,
"vipVariableName": "vpn_if_tunnel_hello_tolerance"
},
"tloc-extension-gre-to": {
"dst-ip": {}
},
"tunnel-tcp-mss-adjust": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1350,
"vipVariableName": "vpn_if_tunnel_tunnel_tcp_mss_adjust"
},
"clear-dont-fragment": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_tunnel_clear_dont_fragment"
},
"network-broadcast": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_tunnel_network_broadcast"
}
},
"nat64-enable": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "false"
},
"ppp": {
"authentication": {
"method": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "chap"
},
"pap": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "false"
},
"callin": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "callin",
"vipVariableName": "pppoa_dsl_pap_auth_callin"
}
},
"chap": {
"hostname": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "cisco",
"vipVariableName": "pppoa_dsl_chap_hostname"
},
"password": {
"ppp-auth-password": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "cisco123456",
"vipVariableName": "pppoa_dsl_ppp_auth_password"
}
}
}
},
"ip-directed-broadcast": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_ip-directed-broadcast"
},
"qos-adaptive": {
"period": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 10,
"vipVariableName": "qos_adaptive_period"
},
"downstream": {
"bandwidth-down": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 15,
"vipVariableName": "qos_adaptive_downstream_bandwidth_down"
},
"range": {
"dmin": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 10,
"vipVariableName": "qos_adaptive_downstream_range_dmin"
},
"dmax": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 20,
"vipVariableName": "qos_adaptive_downstream_range_dmax"
}
}
},
"upstream": {
"bandwidth-up": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 10,
"vipVariableName": "qos_adaptive_upstream_bandwidth_up"
},
"range": {
"umin": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 10,
"vipVariableName": "qos_adaptive_upstream_range_umin"
},
"umax": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 20,
"vipVariableName": "qos_adaptive_upstream_range_umax"
}
}
}
},
"controller": {
"vdsl": {
"vipType": "constant",
"vipValue": [
{
"modem": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "configuration",
"vipVariableName": "pppoa_dsl_modem"
},
"name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "1",
"vipVariableName": "pppoa_dsl_vdsl_name"
},
"sra": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "pppoa_dsl_sra"
},
"operating": {
"mode": {
"auto": {
"adsl2plus": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "true"
}
}
}
},
"priority-order": [
"name",
"sra",
"operating",
"modem"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"name"
]
}
},
"pvc": {
"vipType": "constant",
"vipValue": [
{
"local-vpi-vci": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "1/1",
"vipVariableName": "pppoa_dsl_local_vpi_vci"
},
"dialer": {
"pool-member": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 4,
"vipVariableName": "pppoa_dsl_pool_member"
}
},
"encapsulation": {
"aal5nlpid": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "true"
}
},
"priority-order": [
"local-vpi-vci",
"vbr-nrt",
"vbr-rt",
"encapsulation",
"dialer"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"local-vpi-vci"
]
},
"nat": {
"log-translations": {},
"udp-timeout": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 30,
"vipVariableName": "nat_udp_timeout"
},
"tcp-timeout": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 60,
"vipVariableName": "nat_tcp_timeout"
},
"natpool": {
"range-start": {},
"range-end": {}
}
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleVpnInterfacePppoa"
},
"vpn-interface-pppoe-example": {
"description": "vpn-interface-pppoe-example",
"value": {
"templateName": "template_interface_dsl_pppoe",
"templateDescription": "template_interface_dsl_pppoe",
"templateType": "vpn-interface-pppoe",
"deviceType": [
"vedge-ISR-4331"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"if-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "Ethernet1/0/0",
"vipVariableName": "pppoe_dsl_if_name"
},
"bridge-dot1q": {
"encap": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 22,
"vipVariableName": "pppoe_dsl_dot1q_encap"
}
},
"shutdown": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "false",
"vipVariableName": "pppoe_dsl_shutdown"
},
"description": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "description1",
"vipVariableName": "pppoe_dsl_description"
},
"pppoe-client": {
"ppp-max-payload": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 64,
"vipVariableName": "pppoe_dsl_ppp_max_payload"
},
"dial-pool-number": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 200,
"vipVariableName": "pppoe_dsl_dial_pool_number"
}
},
"ip": {
"address-negotiated": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "true"
}
},
"shaping-rate": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "rewrite_shaping_rate"
},
"qos-map": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "m1",
"vipVariableName": "rewrite_qos_map"
},
"qos-map-vpn": {
"vipObjectType": "object",
"vipType": "ignore",
"vipVariableName": "vpn-qos_map"
},
"rewrite-rule": {
"rule-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "rul1",
"vipVariableName": "rewrite_rule_name"
}
},
"mtu": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1500,
"vipVariableName": "pppoe_dsl_ip_mtu"
},
"tcp-mss-adjust": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1480,
"vipVariableName": "pppoe_dsl_tcp_mss_adjust"
},
"tloc-extension": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "tloc",
"vipVariableName": "pppoe_dsl_tloc_extension"
},
"tracker": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"tracker1"
],
"vipVariableName": "pppoe_dsl_tracker"
},
"bandwidth-upstream": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 100000,
"vipVariableName": "pppoe_dsl_bandwidth_upstream"
},
"bandwidth-downstream": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 200000,
"vipVariableName": "pppoe_dsl_bandwidth_downstream"
},
"access-list": {
"vipType": "constant",
"vipValue": [
{
"acl-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "5.5.5.5",
"vipVariableName": "access_list_ingress_acl_name_ipv4"
},
"direction": {
"vipType": "constant",
"vipValue": "in",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
},
{
"acl-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "6.6.6.6",
"vipVariableName": "access_list_egress_acl_name_ipv4"
},
"direction": {
"vipType": "constant",
"vipValue": "out",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"direction"
]
},
"ipv6": {
"access-list": {
"vipType": "constant",
"vipValue": [
{
"acl-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "1050:0:0:0:5:600:300c:326b",
"vipVariableName": "access_list_ingress_acl_name_ipv6"
},
"direction": {
"vipType": "constant",
"vipValue": "in",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
},
{
"acl-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "1050:0:0:0:5:600:300c:4436",
"vipVariableName": "access_list_egress_acl_name_ipv6"
},
"direction": {
"vipType": "constant",
"vipValue": "out",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"direction"
]
}
},
"policer": {
"vipType": "constant",
"vipValue": [
{
"policer-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "policer1",
"vipVariableName": "policer_ingress_policer_name"
},
"direction": {
"vipType": "constant",
"vipValue": "in",
"vipObjectType": "object"
},
"priority-order": [
"policer-name",
"direction"
]
},
{
"policer-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "policer1",
"vipVariableName": "policer_egress_policer_name"
},
"direction": {
"vipType": "constant",
"vipValue": "out",
"vipObjectType": "object"
},
"priority-order": [
"policer-name",
"direction"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"policer-name",
"direction"
]
},
"tunnel-interface": {
"encapsulation": {
"vipType": "constant",
"vipValue": [
{
"preference": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 4,
"vipVariableName": "vpn_if_tunnel_gre_preference"
},
"weight": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1,
"vipVariableName": "vpn_if_tunnel_gre_weight"
},
"encap": {
"vipType": "constant",
"vipValue": "gre",
"vipObjectType": "object"
},
"priority-order": [
"encap",
"preference",
"weight"
]
},
{
"preference": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 7,
"vipVariableName": "vpn_if_tunnel_ipsec_preference"
},
"weight": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 2,
"vipVariableName": "vpn_if_tunnel_ipsec_weight"
},
"encap": {
"vipType": "constant",
"vipValue": "ipsec",
"vipObjectType": "object"
},
"priority-order": [
"encap",
"preference",
"weight"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"encap"
]
},
"group": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"22"
],
"vipVariableName": "vpn_if_tunnel_group"
},
"border": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_border"
},
"color": {
"value": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "lte",
"vipVariableName": "color_value"
},
"restrict": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_color_restrict"
}
},
"carrier": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "carrier1",
"vipVariableName": "vpn_if_tunnel_carrier"
},
"bind": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "tunnel1",
"vipVariableName": "vpn_if_tunnel_bind"
},
"allow-service": {
"dhcp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_dhcp"
},
"dns": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_dns"
},
"icmp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_icmp"
},
"sshd": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_sshd"
},
"ntp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_ntp"
},
"stun": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_stun"
},
"all": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_all"
},
"bgp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_bgp"
},
"ospf": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_ospf"
},
"netconf": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_netconf"
},
"snmp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_snmp"
},
"https": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "false"
}
},
"max-control-connections": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 8,
"vipVariableName": "vpn_if_tunnel_max_control_connections"
},
"vbond-as-stun-server": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_vbond_as_stun_server"
},
"exclude-controller-group-list": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"13"
],
"vipVariableName": "vpn_if_tunnel_exclude_controller_group_list"
},
"vmanage-connection-preference": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 7,
"vipVariableName": "vpn_if_tunnel_vmanage_connection_preference"
},
"port-hop": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_port_hop"
},
"low-bandwidth-link": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_low_bandwidth_link"
},
"last-resort-circuit": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_last_resort_circuit"
},
"hold-time": {},
"nat-refresh-interval": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 6,
"vipVariableName": "vpn_if_tunnel_nat_refresh_interval"
},
"hello-interval": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 600,
"vipVariableName": "vpn_if_tunnel_hello_interval"
},
"hello-tolerance": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 12,
"vipVariableName": "vpn_if_tunnel_hello_tolerance"
},
"tloc-extension-gre-to": {
"dst-ip": {}
},
"tunnel-tcp-mss-adjust": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1380,
"vipVariableName": "vpn_if_tunnel_tunnel_tcp_mss_adjust"
},
"clear-dont-fragment": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_tunnel_clear_dont_fragment"
},
"network-broadcast": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_tunnel_network_broadcast"
}
},
"nat64-enable": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "false"
},
"ppp": {
"authentication": {
"method": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "chap"
},
"pap": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "false"
},
"callin": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "callin",
"vipVariableName": "pppoa_dsl_pap_auth_callin"
}
},
"chap": {
"hostname": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "host_aaa",
"vipVariableName": "pppoe_dsl_chap_hostname"
},
"password": {
"ppp-auth-password": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "123456789a",
"vipVariableName": "pppoe_dsl_ppp_auth_password"
}
}
}
},
"ip-directed-broadcast": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_ip-directed-broadcast"
},
"qos-adaptive": {
"period": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 12,
"vipVariableName": "qos_adaptive_period"
},
"downstream": {
"bandwidth-down": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 300,
"vipVariableName": "qos_adaptive_downstream_bandwidth_down"
},
"range": {
"dmin": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 200,
"vipVariableName": "qos_adaptive_downstream_range_dmin"
},
"dmax": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 400,
"vipVariableName": "qos_adaptive_downstream_range_dmax"
}
}
},
"upstream": {
"bandwidth-up": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 200,
"vipVariableName": "qos_adaptive_upstream_bandwidth_up"
},
"range": {
"umin": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 100,
"vipVariableName": "qos_adaptive_upstream_range_umin"
},
"umax": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 300,
"vipVariableName": "qos_adaptive_upstream_range_umax"
}
}
}
},
"controller": {
"vdsl": {
"vipType": "constant",
"vipValue": [
{
"modem": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "config",
"vipVariableName": "pppoe_dsl_modem"
},
"name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "1",
"vipVariableName": "pppoe_dsl_vdsl_name"
},
"sra": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "false",
"vipVariableName": "pppoe_dsl_sra"
},
"operating": {
"mode": {
"auto": {
"adsl2plus": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "true"
}
}
}
},
"priority-order": [
"name",
"sra",
"operating",
"modem"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"name"
]
}
},
"nat": {
"log-translations": {},
"udp-timeout": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 10,
"vipVariableName": "nat_udp_timeout"
},
"tcp-timeout": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 120,
"vipVariableName": "nat_tcp_timeout"
},
"natpool": {
"range-start": {},
"range-end": {}
}
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleVpnInterfacePppoe"
},
"vpn-interface-svi-example": {
"description": "vpn-interface-svi-example",
"value": {
"templateName": "vpn_interface_svi",
"templateDescription": "vpn_interface_svi",
"templateType": "vpn-interface-svi",
"deviceType": [
"vedge-C8000V"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"if-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "Vlan100",
"vipVariableName": "vpn_if_svi_if_name"
},
"description": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "GigabitEthernet1",
"vipVariableName": "vpn_if_svi_description"
},
"ip": {
"address": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "1.1.1.1/24",
"vipVariableName": "vpn_if_svi_if_ipv4_prefix"
},
"secondary-address": {
"vipType": "ignore",
"vipValue": [],
"vipObjectType": "tree",
"vipPrimaryKey": [
"address"
]
}
},
"ipv6": {
"address": {
"vipObjectType": "object",
"vipType": "ignore",
"vipVariableName": "vpn_if_svi_ipv6_ipv6_address"
},
"secondary-address": {
"vipType": "ignore",
"vipValue": [],
"vipObjectType": "tree",
"vipPrimaryKey": [
"address"
]
},
"access-list": {
"vipType": "ignore",
"vipValue": [],
"vipObjectType": "tree",
"vipPrimaryKey": [
"direction"
]
},
"dhcp-helper-v6": {
"vipType": "ignore",
"vipValue": [],
"vipObjectType": "tree",
"vipPrimaryKey": [
"address"
]
}
},
"dhcp-helper": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"10.10.10.10"
],
"vipVariableName": "vpn_if_svi_dhcp_helper"
},
"mtu": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1500,
"vipVariableName": "vpn_if_svi_ip_mtu"
},
"tcp-mss-adjust": {
"vipObjectType": "object",
"vipType": "ignore",
"vipVariableName": "vpn_if_svi_tcp_mss_adjust"
},
"shutdown": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "false",
"vipVariableName": "vpn_if_svi_shutdown"
},
"arp-timeout": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 1200,
"vipVariableName": "vpn_if_svi_arp_timeout"
},
"access-list": {
"vipType": "constant",
"vipValue": [
{
"acl-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "2.2.2.2",
"vipVariableName": "access_list_ingress_acl_name_ipv4"
},
"direction": {
"vipType": "constant",
"vipValue": "in",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
},
{
"acl-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "3.3.3.3",
"vipVariableName": "ipv4_access_list_egress_acl_name_ipv4"
},
"direction": {
"vipType": "constant",
"vipValue": "out",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"direction"
]
},
"ip-directed-broadcast": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "false",
"vipVariableName": "vpn_if_ip-directed-broadcast"
},
"intrf-mtu": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1500,
"vipVariableName": "vpn_if_svi_if_mtu"
},
"vrrp": {
"vipType": "ignore",
"vipValue": [],
"vipObjectType": "tree",
"vipPrimaryKey": [
"grp-id"
]
},
"ipv6-vrrp": {
"vipType": "constant",
"vipValue": [
{
"grp-id": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 2,
"vipVariableName": "vpn_if_vrrp_ipv6_grpid_ipv6",
"ipType": "ipv6"
},
"priority": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 50,
"vipVariableName": "vpn_if_vrrp_ipv6_priority_ipv6",
"ipType": "ipv6"
},
"timer": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 100,
"vipVariableName": "vpn_if_vrrp_ipv6_timer_ipv6",
"ipType": "ipv6"
},
"track-omp": {
"vipObjectType": "node-only",
"vipType": "ignore",
"vipValue": "false",
"vipVariableName": "vpn_if_vrrp_ipv6_track_omp_ipv6",
"ipType": "ipv6"
},
"track-prefix-list": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "24",
"vipVariableName": "vpn_if_vrrp_ipv6_track_prefix_list_ipv6",
"ipType": "ipv6"
},
"ipv6": {
"vipType": "constant",
"vipValue": [
{
"prefix": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "",
"vipVariableName": "vpn_if_vrrp_ipv6_vrrp_ip_prefix_ipv6",
"ipType": "ipv6"
},
"ipv6-link-local": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "2001:db8:0:1:1:1:1:1",
"vipVariableName": "vpn_if_vrrp_ipv6_vrrp_link_local_address_ipv6",
"ipType": "ipv6"
},
"priority-order": [
"ipv6-link-local",
"prefix"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"ipv6-link-local"
]
},
"ipv6-secondary": {
"vipType": "ignore",
"vipValue": [],
"vipPrimaryKey": [
"prefix"
],
"ipType": "ipv6"
},
"priority-order": [
"grp-id",
"priority",
"timer",
"track-omp",
"track-prefix-list",
"ipv6",
"ipv6-secondary"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"grp-id"
]
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleVpnInterfaceSvi"
},
"vpn-interface-t1-e1-example": {
"description": "vpn-interface-t1-e1-example",
"value": {
"templateName": "vpn_interface_t1e1",
"templateDescription": "vpn_interface_t1e1",
"templateType": "vpn-interface-t1-e1",
"deviceType": [
"vedge-C8000V"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"if-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "serial11",
"vipVariableName": "vpn_if_name"
},
"description": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "descrip1",
"vipVariableName": "vpn_if_description"
},
"ip": {
"address": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "10.10.10.10/24",
"vipVariableName": "vpn_if_ipv4_address"
}
},
"ipv6": {
"address": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "2001:db8:8086:6502::/64",
"vipVariableName": "vpn_if_ipv6_address"
},
"access-list": {
"vipType": "constant",
"vipValue": [
{
"acl-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "2001:db8:8086:6512::/64",
"vipVariableName": "access_list_ingress_acl_name_ipv6"
},
"direction": {
"vipType": "constant",
"vipValue": "in",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
},
{
"acl-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "2001:db8:8086:6522::/64",
"vipVariableName": "access_list_egress_acl_name_ipv6"
},
"direction": {
"vipType": "constant",
"vipValue": "out",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"direction"
]
}
},
"dhcp-helper": {},
"clear-dont-fragment": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_clear_dont_fragment"
},
"pmtu": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_pmtu"
},
"mtu": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1500,
"vipVariableName": "vpn_if_ip_mtu"
},
"static-ingress-qos": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 7,
"vipVariableName": "vpn_if_static_ingress_qos"
},
"tcp-mss-adjust": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1380,
"vipVariableName": "vpn_if_tcp_mss_adjust"
},
"shutdown": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "false",
"vipVariableName": "vpn_if_shutdown"
},
"arp-timeout": {},
"autonegotiate": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "vpn_if_autonegotiate"
},
"shaping-rate": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1000,
"vipVariableName": "qos_shaping-rate"
},
"qos-map": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "map1",
"vipVariableName": "qos-map"
},
"tracker": {},
"bandwidth-upstream": {},
"bandwidth-downstream": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 100000,
"vipVariableName": "bandwidth_downstream"
},
"block-non-source-ip": {},
"rewrite-rule": {
"rule-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "rule1",
"vipVariableName": "rewrite_rule-name"
}
},
"tloc-extension": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "tloc",
"vipVariableName": "vpn_if_tloc_extension"
},
"icmp-redirect-disable": {},
"tloc-extension-gre-from": {
"src-ip": {},
"xconnect": {}
},
"access-list": {
"vipType": "constant",
"vipValue": [
{
"acl-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "10.10.10.10",
"vipVariableName": "access_list_ingress_acl_name_ipv4"
},
"direction": {
"vipType": "constant",
"vipValue": "in",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
},
{
"acl-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "20.20.20.20",
"vipVariableName": "access_list_egress_acl_name_ipv4"
},
"direction": {
"vipType": "constant",
"vipValue": "out",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"direction"
]
},
"policer": {
"vipType": "ignore",
"vipValue": [],
"vipObjectType": "tree",
"vipPrimaryKey": [
"policer-name",
"direction"
]
},
"profile": {},
"technology": {},
"tunnel-interface": {
"encapsulation": {
"vipType": "constant",
"vipValue": [
{
"preference": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 7,
"vipVariableName": "vpn_if_tunnel_gre_preference"
},
"weight": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 2,
"vipVariableName": "vpn_if_tunnel_gre_weight"
},
"encap": {
"vipType": "constant",
"vipValue": "gre",
"vipObjectType": "object"
},
"priority-order": [
"encap",
"preference",
"weight"
]
},
{
"preference": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 7,
"vipVariableName": "vpn_if_tunnel_ipsec_preference"
},
"weight": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1,
"vipVariableName": "vpn_if_tunnel_ipsec_weight"
},
"encap": {
"vipType": "constant",
"vipValue": "ipsec",
"vipObjectType": "object"
},
"priority-order": [
"encap",
"preference",
"weight"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"encap"
]
},
"group": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"11"
],
"vipVariableName": "vpn_if_tunnel_group"
},
"border": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_border"
},
"color": {
"value": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "metro-ethernet",
"vipVariableName": "vpn_if_tunnel_color_value"
},
"restrict": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_color_restrict"
}
},
"carrier": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "carrier5",
"vipVariableName": "vpn_if_tunnel_carrier"
},
"bind": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "tunnel1",
"vipVariableName": "vpn_if_tunnel_bind"
},
"allow-service": {
"dhcp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_dhcp"
},
"dns": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_dns"
},
"icmp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_icmp"
},
"sshd": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_sshd"
},
"ntp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_ntp"
},
"stun": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_stun"
},
"all": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_all"
},
"bgp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_bgp"
},
"ospf": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_ospf"
},
"netconf": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_netconf"
},
"snmp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_snmp"
},
"https": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_https"
}
},
"max-control-connections": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 7,
"vipVariableName": "vpn_if_tunnel_max_control_connections"
},
"vbond-as-stun-server": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_vbond_as_stun_server"
},
"exclude-controller-group-list": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"13"
],
"vipVariableName": "vpn_if_tunnel_exclude_controller_group_list"
},
"vmanage-connection-preference": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 5,
"vipVariableName": "vpn_if_tunnel_vmanage_connection_preference"
},
"port-hop": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_port_hop"
},
"low-bandwidth-link": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_low_bandwidth_link"
},
"last-resort-circuit": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_last-resort-circuit"
},
"hold-time": {},
"nat-refresh-interval": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 5,
"vipVariableName": "vpn_if_tunnel_nat_refresh_interval"
},
"hello-interval": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 600,
"vipVariableName": "vpn_if_tunnel_hello_interval"
},
"hello-tolerance": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 12,
"vipVariableName": "vpn_if_tunnel_hello_tolerance"
},
"tloc-extension-gre-to": {
"dst-ip": {}
},
"tunnel-qos": {
"mode": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "hub"
}
},
"tunnel-tcp-mss-adjust": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1380,
"vipVariableName": "vpn_if_tunnel_tunnel_tcp_mss_adjust"
},
"clear-dont-fragment": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_tunnel_clear_dont_fragment"
},
"network-broadcast": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_tunnel_network_broadcast"
}
},
"nat64-enable": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "false"
},
"qos-map-vpn": {
"vipObjectType": "object",
"vipType": "ignore",
"vipVariableName": "vpn-qos_map"
},
"bandwidth": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "100000",
"vipVariableName": "vpn_if_bandwidth"
},
"clock-rate": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "19200",
"vipVariableName": "vpn_if_clock-rate"
},
"encapsulation-serial": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "hdlc",
"vipVariableName": "vpn_if_encapsulation-serial"
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleVpnInterfaceT1E1"
},
"vpn-vedge-interface-bridge-example": {
"description": "vpn-vedge-interface-bridge-example",
"value": {
"templateName": "vpn_vedge_interface_bridge",
"templateDescription": "vpn_vedge_interface_bridge",
"templateType": "vpn-vedge-interface-bridge",
"deviceType": [
"vedge-cloud"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"if-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "ge1/",
"vipVariableName": "vpn_if_name"
},
"description": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "GigabitEthernet1",
"vipVariableName": "vpn_if_description"
},
"ip": {
"address": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "5.5.5.5/24",
"vipVariableName": "vpn_if_ipv4_address"
},
"secondary-address": {
"vipType": "ignore",
"vipValue": [],
"vipObjectType": "tree",
"vipPrimaryKey": [
"address"
]
}
},
"dhcp-helper": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"5.5.5.1"
],
"vipVariableName": "vpn_if_dhcp_helper"
},
"clear-dont-fragment": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_clear_dont_fragment"
},
"mtu": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1500,
"vipVariableName": "vpn_if_ip_mtu"
},
"tcp-mss-adjust": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1300,
"vipVariableName": "vpn_if_tcp_mss_adjust"
},
"shutdown": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "false",
"vipVariableName": "vpn_if_shutdown"
},
"arp-timeout": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 300,
"vipVariableName": "vpn_if_arp_timeout"
},
"mac-address": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "00:00:00:00:02:02",
"vipVariableName": "vpn_if_mac_address"
},
"icmp-redirect-disable": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_icmp_redirect_disable"
},
"access-list": {
"vipType": "constant",
"vipValue": [
{
"acl-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "6.6.6.6",
"vipVariableName": "access_list_ingress_acl_name_ipv4"
},
"direction": {
"vipType": "constant",
"vipValue": "in",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
},
{
"acl-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "7.7.7.7",
"vipVariableName": "access_list_egress_acl_name_ipv4"
},
"direction": {
"vipType": "constant",
"vipValue": "out",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"direction"
]
},
"block-non-source-ip": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_block_non_source_ip"
},
"arp": {
"ip": {
"vipType": "constant",
"vipValue": [
{
"addr": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "192.168.1.120",
"vipVariableName": "vpn_bridge_arp_addr"
},
"mac": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "00:00:00:00:02:02",
"vipVariableName": "vpn_bridge_arp_mac"
},
"priority-order": [
"addr",
"mac"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"addr"
]
}
},
"vrrp": {
"vipType": "ignore",
"vipValue": [],
"vipObjectType": "tree",
"vipPrimaryKey": [
"grp-id"
]
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleVpnVedgeInterfaceBridge"
},
"vpn-vedge-interface-cellular-example": {
"description": "vpn-vedge-interface-cellular-example",
"value": {
"templateName": "vpn_vedge_interface_cellular",
"templateDescription": "vpn_vedge_interface_cellular",
"templateType": "vpn-vedge-interface-cellular",
"deviceType": [
"vedge-cloud"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"if-name": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "vpn_if_name_vpn_vedge_interface_cellular"
},
"description": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "Descrip1",
"vipVariableName": "vpn_if_description"
},
"ip": {
"dhcp-client": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true"
},
"dhcp-distance": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 12,
"vipVariableName": "vpn_if_ipv4_dhcp_distance"
}
},
"ipv6": {
"dhcp-client": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true"
},
"dhcp-distance": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 1,
"vipVariableName": "vpn_if_ipv6_dhcp_distance"
},
"dhcp-rapid-commit": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_ipv6_dhcp_rapid_commit"
},
"access-list": {
"vipType": "constant",
"vipValue": [
{
"acl-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "2001:DB8::1",
"vipVariableName": "access_list_ingress_acl_name_ipv6"
},
"direction": {
"vipType": "constant",
"vipValue": "in",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
},
{
"acl-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "2001:db8:a::123/64",
"vipVariableName": "access_list_egress_acl_name_ipv6"
},
"direction": {
"vipType": "constant",
"vipValue": "out",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"direction"
]
},
"ipv6-shutdown": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "false",
"vipVariableName": "vpn_if_ipv6_shutdown"
}
},
"dhcp-helper": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"10.10.10.10"
],
"vipVariableName": "vpn_if_dhcp_helper"
},
"clear-dont-fragment": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_clear_dont_fragment"
},
"pmtu": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_pmtu"
},
"mtu": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1428,
"vipVariableName": "vpn_if_ip_mtu"
},
"static-ingress-qos": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1,
"vipVariableName": "vpn_if_static_ingress_qos"
},
"tcp-mss-adjust": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1300,
"vipVariableName": "vpn_if_tcp_mss_adjust"
},
"shutdown": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "false",
"vipVariableName": "vpn_if_shutdown"
},
"arp-timeout": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 600,
"vipVariableName": "vpn_if_arp_timeout"
},
"autonegotiate": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "vpn_if_autonegotiate"
},
"shaping-rate": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 100000,
"vipVariableName": "qos_shaping-rate"
},
"qos-map": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "Map1",
"vipVariableName": "qos-map"
},
"tracker": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"Tracker1"
],
"vipVariableName": "vpn_if_tracker"
},
"bandwidth-upstream": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 100000,
"vipVariableName": "vpn_if_bandwidth_upstream"
},
"bandwidth-downstream": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 200000,
"vipVariableName": "vpn_if_bandwidth_downstream"
},
"block-non-source-ip": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_block_non_source_ip"
},
"rewrite-rule": {
"rule-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "Rule1",
"vipVariableName": "rewrite_rule-name"
}
},
"tloc-extension": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "TOLC",
"vipVariableName": "vpn_if_tloc_extension"
},
"icmp-redirect-disable": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "false",
"vipVariableName": "vpn_if_icmp_redirect_disable"
},
"tloc-extension-gre-from": {
"src-ip": {},
"xconnect": {}
},
"access-list": {
"vipType": "constant",
"vipValue": [
{
"acl-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "5.5.5.5",
"vipVariableName": "access_list_ingress_acl_name_ipv4"
},
"direction": {
"vipType": "constant",
"vipValue": "in",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
},
{
"acl-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "6.6.6.6",
"vipVariableName": "access_list_egress_acl_name_ipv4"
},
"direction": {
"vipType": "constant",
"vipValue": "out",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"direction"
]
},
"policer": {
"vipType": "constant",
"vipValue": [
{
"policer-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "P1",
"vipVariableName": "policer_ingress_policer_name"
},
"direction": {
"vipType": "constant",
"vipValue": "in",
"vipObjectType": "object"
},
"priority-order": [
"policer-name",
"direction"
]
},
{
"policer-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "p1",
"vipVariableName": "policer_egress_policer_name"
},
"direction": {
"vipType": "constant",
"vipValue": "out",
"vipObjectType": "object"
},
"priority-order": [
"policer-name",
"direction"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"policer-name",
"direction"
]
},
"profile": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1,
"vipVariableName": "vpn_if_profile_id"
},
"technology": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "lte",
"vipVariableName": "vpn_if_technology"
},
"tunnel-interface": {
"encapsulation": {
"vipType": "constant",
"vipValue": [
{
"preference": {
"vipObjectType": "object",
"vipType": "ignore",
"vipVariableName": "vpn_if_tunnel_ipsec_preference"
},
"weight": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 1,
"vipVariableName": "vpn_if_tunnel_ipsec_weight"
},
"encap": {
"vipType": "constant",
"vipValue": "ipsec",
"vipObjectType": "object"
},
"priority-order": [
"encap",
"preference",
"weight"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"encap"
]
},
"group": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"2"
],
"vipVariableName": "vpn_if_tunnel_group"
},
"border": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_border"
},
"color": {
"value": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "gold",
"vipVariableName": "vpn_if_tunnel_color_value"
},
"restrict": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_color_restrict"
}
},
"carrier": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "default",
"vipVariableName": "vpn_if_tunnel_carrier"
},
"bind": {
"vipObjectType": "object",
"vipType": "ignore",
"vipVariableName": "vpn_if_tunnel_bind"
},
"allow-service": {
"dhcp": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_dhcp"
},
"dns": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_dns"
},
"icmp": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_icmp"
},
"sshd": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_sshd"
},
"ntp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_ntp"
},
"stun": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_stun"
},
"all": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_all"
},
"bgp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_bgp"
},
"ospf": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_ospf"
},
"netconf": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_netconf"
},
"https": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_https"
}
},
"max-control-connections": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 6,
"vipVariableName": "vpn_if_tunnel_max_control_connections"
},
"vbond-as-stun-server": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_vbond_as_stun_server"
},
"exclude-controller-group-list": {
"vipObjectType": "list",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "vpn_if_tunnel_exclude_controller_group_list"
},
"vmanage-connection-preference": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 6,
"vipVariableName": "vpn_if_tunnel_vmanage_connection_preference"
},
"port-hop": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_port_hop"
},
"low-bandwidth-link": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_low_bandwidth_link"
},
"last-resort-circuit": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "false",
"vipVariableName": "vpn_if_tunnel_last-resort-circuit"
},
"hold-time": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 7000,
"vipVariableName": "hold-time"
},
"nat-refresh-interval": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 5,
"vipVariableName": "vpn_if_tunnel_nat_refresh_interval"
},
"hello-interval": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 1000,
"vipVariableName": "vpn_if_tunnel_hello_interval"
},
"hello-tolerance": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 12,
"vipVariableName": "vpn_if_tunnel_hello_tolerance"
},
"tloc-extension-gre-to": {
"dst-ip": {}
},
"tunnel-qos": {
"mode": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "hub"
}
}
},
"nat64-enable": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "false"
},
"nat": {
"refresh": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "bi-directional",
"vipVariableName": "nat_refresh"
},
"log-translations": {},
"udp-timeout": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 5,
"vipVariableName": "nat_udp_timeout"
},
"tcp-timeout": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 120,
"vipVariableName": "nat_tcp_timeout"
},
"block-icmp-error": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "nat_block_icmp_error"
},
"respond-to-ping": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "nat_respond_to_ping"
},
"natpool": {
"range-start": {},
"range-end": {}
},
"port-forward": {
"vipType": "constant",
"vipValue": [
{
"port-start": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1000
},
"port-end": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 2000
},
"proto": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "udp"
},
"private-vpn": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 100,
"vipVariableName": "vpn_interface_private_vpn"
},
"private-ip-address": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "4.4.4.4",
"vipVariableName": "vpn_interface_private_ip_address"
},
"priority-order": [
"port-start",
"port-end",
"proto",
"private-vpn",
"private-ip-address"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"port-start",
"port-end",
"proto"
]
}
},
"arp": {
"ip": {
"vipType": "constant",
"vipValue": [
{
"addr": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "192.168.1.111",
"vipVariableName": "vpn_bridge_arp_addr"
},
"mac": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "00:00:00:00:00:01",
"vipVariableName": "vpn_bridge_arp_mac"
},
"priority-order": [
"addr",
"mac"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"addr"
]
}
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleVpnVedgeInterfaceCellular"
},
"vpn-vedge-interface-gre-example": {
"description": "vpn-vedge-interface-gre-example",
"value": {
"templateName": "template_vedge_interface_gre",
"templateDescription": "template_vedge_interface_gre",
"templateType": "vpn-vedge-interface-gre",
"deviceType": [
"vedge-cloud"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"if-name": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "vpn_if_name_template_vedge_interface_gre"
},
"description": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "vpn_if_description"
},
"ip": {
"address": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "3.3.5.5/16",
"vipVariableName": "vpn_if_ipv4_address"
}
},
"shutdown": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "false",
"vipVariableName": "vpn_if_shutdown"
},
"tunnel-source": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "3.3.4.4",
"vipVariableName": "vpn_if_tunnel_source"
},
"tunnel-destination": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "20.20.20.20",
"vipVariableName": "vpn_if_tunnel_destination"
},
"keepalive": {
"interval": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 20,
"vipVariableName": "vpn_if_interval"
},
"retries": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 6,
"vipVariableName": "vpn_if_retries"
}
},
"mtu": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1500,
"vipVariableName": "vpn_if_ip_mtu"
},
"clear-dont-fragment": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_clear_dont_fragment"
},
"tcp-mss-adjust": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1300,
"vipVariableName": "vpn_if_tcp_mss_adjust"
},
"rewrite-rule": {
"rule-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "rule1",
"vipVariableName": "rewrite_rule_name"
}
},
"access-list": {
"vipType": "constant",
"vipValue": [
{
"acl-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "6.6.6.6",
"vipVariableName": "access_list_ingress_acl_name_ipv4"
},
"direction": {
"vipType": "constant",
"vipValue": "in",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
},
{
"acl-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "7.7.7.7",
"vipVariableName": "access_list_egress_acl_name_ipv4"
},
"direction": {
"vipType": "constant",
"vipValue": "out",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"direction"
]
},
"policer": {
"vipType": "constant",
"vipValue": [
{
"policer-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "policer1",
"vipVariableName": "policer_ingress_policer_name"
},
"direction": {
"vipType": "constant",
"vipValue": "in",
"vipObjectType": "object"
},
"priority-order": [
"policer-name",
"direction"
]
},
{
"policer-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "policer1",
"vipVariableName": "policer_egress_policer_name"
},
"direction": {
"vipType": "constant",
"vipValue": "out",
"vipObjectType": "object"
},
"priority-order": [
"policer-name",
"direction"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"policer-name",
"direction"
]
},
"tracker": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"Tracker1"
],
"vipVariableName": "tracker"
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleVpnVedgeInterfaceGre"
},
"vpn-vedge-interface-ipsec-example": {
"description": "vpn-vedge-interface-ipsec-example",
"value": {
"templateName": "vpn-vedge-interface-ipsec",
"templateDescription": "vpn-vedge-interface-ipsec",
"templateType": "vpn-vedge-interface-ipsec",
"deviceType": [
"vedge-cloud"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"if-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "ipsec1",
"vipVariableName": "vpn_if_name"
},
"description": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "Description1",
"vipVariableName": "vpn_if_description"
},
"ip": {
"address": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "192.168.0.111/24",
"vipVariableName": "vpn_if_ipv4_address"
}
},
"shutdown": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "false",
"vipVariableName": "vpn_if_shutdown"
},
"tunnel-source-interface": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "gi1/1",
"vipVariableName": "vpn_if_tunnel_source_interface"
},
"tunnel-destination": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "20.20.20.20",
"vipVariableName": "vpn_if_tunnel_destination"
},
"mtu": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1500,
"vipVariableName": "vpn_if_mtu"
},
"tcp-mss-adjust": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1400,
"vipVariableName": "vpn_if_tcp_mss_adjust"
},
"dead-peer-detection": {
"dpd-interval": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 50,
"vipVariableName": "vpn_if_dpd_interval"
},
"dpd-retries": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 3,
"vipVariableName": "vpn_if_dpd_retries"
}
},
"ike": {
"ike-version": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 2,
"vipVariableName": "vpn_if_ike_version"
},
"ike-rekey-interval": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 14400,
"vipVariableName": "vpn_if_ike_rekey_interval"
},
"ike-ciphersuite": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "aes256-cbc-sha1",
"vipVariableName": "vpn_if_ike_ciphersuite"
},
"ike-group": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "16",
"vipVariableName": "vpn_if_ike_group"
},
"authentication-type": {
"pre-shared-key": {
"pre-shared-secret": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "123456789a",
"vipVariableName": "vpn_if_pre_shared_secret"
},
"ike-local-id": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "1",
"vipVariableName": "vpn_if_ike_local_id"
},
"ike-remote-id": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "2",
"vipVariableName": "vpn_if_ike_remote_id"
}
}
}
},
"ipsec": {
"ipsec-rekey-interval": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 3600,
"vipVariableName": "vpn_if_ipsec_rekey_interval"
},
"ipsec-replay-window": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 512,
"vipVariableName": "vpn_if_ipsec_replay_window"
},
"ipsec-ciphersuite": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "aes256-cbc-sha256",
"vipVariableName": "vpn_if_ipsec_ciphersuite"
},
"perfect-forward-secrecy": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "group-16",
"vipVariableName": "vpn_if_ipsec_perfect_forward_secrecy"
}
},
"tracker": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"t1"
],
"vipVariableName": "tracker"
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleVpnVedgeInterfaceIpsec"
},
"vpn-vedge-interface-natpool-example": {
"description": "vpn-vedge-interface-natpool-example",
"value": {
"templateName": "template_vpn_interface_natpool",
"templateDescription": "template_vpn_interface_natpool",
"templateType": "vpn-vedge-interface-natpool",
"deviceType": [
"vedge-cloud"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"if-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "natpool1",
"vipVariableName": "vpn_if_name"
},
"description": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "Description1",
"vipVariableName": "vpn_if_description"
},
"ip": {
"address": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "1.1.2.2/24",
"vipVariableName": "vpn_if_ipv4_address"
}
},
"shutdown": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "false",
"vipVariableName": "vpn_if_shutdown"
},
"nat": {
"refresh": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "bi-directional",
"vipVariableName": "vpn_if_refresh"
},
"udp-timeout": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 2,
"vipVariableName": "vpn_if_udp_timeout"
},
"tcp-timeout": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 120,
"vipVariableName": "vpn_if_tcp_timeout"
},
"block-icmp-error": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "vpn_if_block_icmp"
},
"respond-to-ping": {},
"direction": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "inside",
"vipVariableName": "vpn_if_direction"
},
"overload": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "vpn_if_overload"
},
"port-forward": {
"vipType": "constant",
"vipValue": [
{
"port-start": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1000,
"vipVariableName": "vpn_interface_port_start"
},
"port-end": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 2000,
"vipVariableName": "vpn_interface_port_end"
},
"proto": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "udp",
"vipVariableName": "vpn_interface_proto"
},
"private-vpn": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 0,
"vipVariableName": "vpn_interface_private_vpn"
},
"private-ip-address": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "192.168.1.111",
"vipVariableName": "vpn_interface_private_ip_address"
},
"priority-order": [
"port-start",
"port-end",
"proto",
"private-vpn",
"private-ip-address"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"port-start",
"port-end",
"proto"
]
},
"static": {
"vipType": "constant",
"vipValue": [
{
"source-ip": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "192.168.1.10",
"vipVariableName": "vpn_nat_pool_source_ip"
},
"translate-ip": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "10.10.10.10",
"vipVariableName": "vpn_nat_pool_translate_ip"
},
"static-nat-direction": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "outside",
"vipVariableName": "vpn_nat_pool_static_nat_direction"
},
"priority-order": [
"source-ip",
"translate-ip",
"static-nat-direction"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"source-ip"
]
},
"tracker": {
"vipType": "constant",
"vipValue": [
{
"interface": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": [
"ge0/0"
],
"vipVariableName": "vpn_nat_pool_tracker_interface"
},
"priority-order": [
"interface"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"interface"
]
}
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleVpnVedgeInterfaceNatpool"
},
"vpn-vedge-interface-ppp-example": {
"description": "vpn-vedge-interface-ppp-example",
"value": {
"templateName": "vpn_vedge_interface_ppp",
"templateDescription": "vpn_vedge_interface_ppp",
"templateType": "vpn-vedge-interface-ppp",
"deviceType": [
"vedge-cloud"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"if-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "ppp1",
"vipVariableName": "vpn_if_name"
},
"description": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "d1",
"vipVariableName": "vpn_if_description"
},
"clear-dont-fragment": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_clear_dont_fragment"
},
"mac-address": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "00:00:00:00:00:11",
"vipVariableName": "vpn_if_mac_address"
},
"mtu": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1492,
"vipVariableName": "vpn_if_ip_mtu"
},
"pmtu": {},
"tcp-mss-adjust": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1400,
"vipVariableName": "vpn_if_tcp_mss_adjust"
},
"shutdown": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "false",
"vipVariableName": "vpn_if_shutdown"
},
"rewrite-rule": {
"rule-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "rule1",
"vipVariableName": "rewrite_rule_name"
}
},
"ppp": {
"ac-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "ac1",
"vipVariableName": "ppp_ac_name"
},
"authentication": {
"vipType": "constant",
"vipValue": [
{
"hostname": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "admin",
"vipVariableName": "ppp_chap_chap_hostname"
},
"password": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "admin",
"vipVariableName": "ppp_chap_chap_password"
},
"priority-order": [
"auth-choice",
"hostname",
"password"
],
"auth-choice": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "chap"
}
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"auth-choice"
]
}
},
"tloc-extension": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "tloc",
"vipVariableName": "vpn_if_tloc_extension"
},
"bandwidth-upstream": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 100000,
"vipVariableName": "vpn_if_bandwidth_upstream"
},
"bandwidth-downstream": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 200000,
"vipVariableName": "vpn_if_bandwidth_downstream"
},
"icmp-redirect-disable": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_icmp_redirect_disable"
},
"access-list": {
"vipType": "constant",
"vipValue": [
{
"acl-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "3.3.3.3",
"vipVariableName": "access_list_ingress_acl_name_ipv4"
},
"direction": {
"vipType": "constant",
"vipValue": "in",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
},
{
"acl-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "4.4.4.4",
"vipVariableName": "access_list_egress_acl_name_ipv4"
},
"direction": {
"vipType": "constant",
"vipValue": "out",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"direction"
]
},
"ipv6": {
"access-list": {
"vipType": "constant",
"vipValue": [
{
"acl-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "2001:4860:4801:48::33",
"vipVariableName": "access_list_ingress_acl_name_ipv6"
},
"direction": {
"vipType": "constant",
"vipValue": "in",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
},
{
"acl-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "2001:4860:4801:48::55",
"vipVariableName": "access_list_egress_acl_name_ipv6"
},
"direction": {
"vipType": "constant",
"vipValue": "out",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"direction"
]
}
},
"policer": {
"vipType": "constant",
"vipValue": [
{
"policer-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "policer1",
"vipVariableName": "policer_ingress_policer_name"
},
"direction": {
"vipType": "constant",
"vipValue": "in",
"vipObjectType": "object"
},
"priority-order": [
"policer-name",
"direction"
]
},
{
"policer-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "policer1",
"vipVariableName": "policer_egress_policer_name"
},
"direction": {
"vipType": "constant",
"vipValue": "out",
"vipObjectType": "object"
},
"priority-order": [
"policer-name",
"direction"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"policer-name",
"direction"
]
},
"tunnel-interface": {
"encapsulation": {
"vipType": "constant",
"vipValue": [
{
"preference": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 7,
"vipVariableName": "vpn_if_tunnel_gre_preference"
},
"weight": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1,
"vipVariableName": "vpn_if_tunnel_gre_weight"
},
"encap": {
"vipType": "constant",
"vipValue": "gre",
"vipObjectType": "object"
},
"priority-order": [
"encap",
"preference",
"weight"
]
},
{
"preference": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 6,
"vipVariableName": "vpn_if_tunnel_ipsec_preference"
},
"weight": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 2,
"vipVariableName": "vpn_if_tunnel_ipsec_weight"
},
"encap": {
"vipType": "constant",
"vipValue": "ipsec",
"vipObjectType": "object"
},
"priority-order": [
"encap",
"preference",
"weight"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"encap"
]
},
"group": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"2"
],
"vipVariableName": "vpn_if_tunnel_group"
},
"border": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_border"
},
"color": {
"value": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "custom3",
"vipVariableName": "color_value"
},
"restrict": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_color_restrict"
}
},
"carrier": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "carrier4",
"vipVariableName": "vpn_if_tunnel_carrier"
},
"bind": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "tunnel1",
"vipVariableName": "vpn_if_tunnel_bind"
},
"allow-service": {
"dhcp": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_dhcp"
},
"dns": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_dns"
},
"icmp": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_icmp"
},
"sshd": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_sshd"
},
"ntp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_ntp"
},
"stun": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_stun"
},
"all": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_all"
},
"bgp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_bgp"
},
"ospf": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_ospf"
},
"netconf": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_netconf"
}
},
"max-control-connections": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 8,
"vipVariableName": "vpn_if_tunnel_max_control_connections"
},
"vbond-as-stun-server": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_vbond_as_stun_server"
},
"exclude-controller-group-list": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"2"
],
"vipVariableName": "vpn_if_tunnel_exclude_controller_group_list"
},
"vmanage-connection-preference": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 6,
"vipVariableName": "vpn_if_tunnel_vmanage_connection_preference"
},
"port-hop": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_port_hop"
},
"low-bandwidth-link": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_low_bandwidth_link"
},
"last-resort-circuit": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_last_resort_circuit"
},
"hold-time": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 7000,
"vipVariableName": "hold-time"
},
"nat-refresh-interval": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 5,
"vipVariableName": "vpn_if_tunnel_nat_refresh_interval"
},
"hello-interval": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 600,
"vipVariableName": "vpn_if_tunnel_hello_interval"
},
"hello-tolerance": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 14,
"vipVariableName": "vpn_if_tunnel_hello_tolerance"
},
"tloc-extension-gre-to": {
"dst-ip": {}
}
},
"nat64-enable": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "false"
},
"tracker": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"trapper"
],
"vipVariableName": "vpn_if_tracker"
},
"autonegotiate": {},
"block-non-source-ip": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_block_non_source_ip"
},
"nat": {
"refresh": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "outbound",
"vipVariableName": "nat_refresh"
},
"log-translations": {},
"udp-timeout": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1,
"vipVariableName": "nat_udp_timeout"
},
"tcp-timeout": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 60,
"vipVariableName": "nat_tcp_timeout"
},
"block-icmp-error": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "nat_block_icmp_error"
},
"respond-to-ping": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "nat_respond_to_ping"
},
"natpool": {
"range-start": {},
"range-end": {}
},
"port-forward": {
"vipType": "constant",
"vipValue": [
{
"port-start": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1000
},
"port-end": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 2000
},
"proto": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "udp"
},
"private-vpn": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 0,
"vipVariableName": "vpn_interface_private_vpn"
},
"private-ip-address": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "192.168.0.111",
"vipVariableName": "vpn_interface_private_ip_address"
},
"priority-order": [
"port-start",
"port-end",
"proto",
"private-vpn",
"private-ip-address"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"port-start",
"port-end",
"proto"
]
}
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleVpnVedgeInterfacePpp"
},
"vpn-vedge-interface-vap-example": {
"description": "vpn-vedge-interface-vap-example",
"value": {
"templateName": "template_wifi_ssid",
"templateDescription": "template_wifi_ssid",
"templateType": "vpn-vedge-interface-vap",
"deviceType": [
"vedge-100-WM"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"if-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "vap2",
"vipVariableName": "WiFi_if_name"
},
"description": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "lanEthernet",
"vipVariableName": "WiFi_if_description"
},
"shutdown": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "false",
"vipVariableName": "WiFi_if_shutdown"
},
"data-security": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "wpa2-enterprise"
},
"mgmt-security": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "required",
"vipVariableName": "WiFi_mgmt_security"
},
"radius-servers": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"10.124.19.169"
],
"vipVariableName": "WiFi_if_radius-servers"
},
"ssid": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "wifi_zhangyp",
"vipVariableName": "WiFi_if_ssid"
},
"max-clients": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 20,
"vipVariableName": "WiFi_if_max_clients"
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleVpnVedgeInterfaceVap"
},
"vpn-vedge-interface-example": {
"description": "vpn-vedge-interface-example",
"value": {
"templateName": "vpn_interface_ethernet",
"templateDescription": "vpn_interface_ethernet",
"templateType": "vpn-vedge-interface",
"deviceType": [
"vedge-cloud"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"if-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "ge3/",
"vipVariableName": "vpn_if_name"
},
"description": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "description1",
"vipVariableName": "vpn_if_description"
},
"ip": {
"dhcp-client": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true"
},
"dhcp-distance": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 6,
"vipVariableName": "vpn_if_ipv4_dhcp_distance"
},
"secondary-address": {
"vipType": "ignore",
"vipValue": [],
"vipObjectType": "tree",
"vipPrimaryKey": [
"address"
]
}
},
"dhcp-helper": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"10.124.19.169"
],
"vipVariableName": "vpn_if_dhcp_helper"
},
"flow-control": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "autoneg",
"vipVariableName": "vpn_if_flow_control"
},
"clear-dont-fragment": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_clear_dont_fragment"
},
"pmtu": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_pmtu"
},
"mtu": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1500,
"vipVariableName": "vpn_if_ip_mtu"
},
"static-ingress-qos": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1,
"vipVariableName": "vpn_if_static_ingress_qos"
},
"tcp-mss-adjust": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1400,
"vipVariableName": "vpn_if_tcp_mss_adjust"
},
"mac-address": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "00:01:02:03:04:10",
"vipVariableName": "vpn_if_mac_address"
},
"speed": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "1000",
"vipVariableName": "vpn_if_speed"
},
"duplex": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "full",
"vipVariableName": "vpn_if_duplex"
},
"shutdown": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "false",
"vipVariableName": "vpn_if_shutdown"
},
"arp-timeout": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1800,
"vipVariableName": "vpn_if_arp_timeout"
},
"autonegotiate": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "vpn_if_autonegotiate"
},
"shaping-rate": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 300000,
"vipVariableName": "qos_shaping_rate"
},
"qos-map": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "map1",
"vipVariableName": "qos_map"
},
"tracker": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"tracker1"
],
"vipVariableName": "vpn_if_tracker"
},
"bandwidth-upstream": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 100000,
"vipVariableName": "vpn_if_bandwidth_upstream"
},
"bandwidth-downstream": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 200000,
"vipVariableName": "vpn_if_bandwidth_downstream"
},
"block-non-source-ip": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_block_non_source_ip"
},
"rewrite-rule": {
"rule-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "rule1",
"vipVariableName": "rewrite_rule_name"
}
},
"tloc-extension": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "tloc",
"vipVariableName": "vpn_if_tloc_extension"
},
"icmp-redirect-disable": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_icmp_redirect_disable"
},
"tloc-extension-gre-from": {
"src-ip": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "50.50.50.50",
"vipVariableName": "vpn_if_tloc-ext_gre_from_src_ip"
},
"xconnect": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "x1",
"vipVariableName": "vpn_if_tloc-ext_gre_from_xconnect"
}
},
"access-list": {
"vipType": "constant",
"vipValue": [
{
"acl-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "5.5.5.5",
"vipVariableName": "access_list_ingress_acl_name_ipv4"
},
"direction": {
"vipType": "constant",
"vipValue": "in",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
},
{
"acl-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "6.6.6.6",
"vipVariableName": "ipv4_access_list_egress_acl_name_ipv4"
},
"direction": {
"vipType": "constant",
"vipValue": "out",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"direction"
]
},
"policer": {
"vipType": "constant",
"vipValue": [
{
"policer-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "policer1",
"vipVariableName": "policer_ingress_policer_name"
},
"direction": {
"vipType": "constant",
"vipValue": "in",
"vipObjectType": "object"
},
"priority-order": [
"policer-name",
"direction"
]
},
{
"policer-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "policer1",
"vipVariableName": "policer_egress_policer_name"
},
"direction": {
"vipType": "constant",
"vipValue": "out",
"vipObjectType": "object"
},
"priority-order": [
"policer-name",
"direction"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"policer-name",
"direction"
]
},
"tunnel-interface": {
"encapsulation": {
"vipType": "constant",
"vipValue": [
{
"preference": {
"vipObjectType": "object",
"vipType": "ignore",
"vipVariableName": "vpn_if_tunnel_ipsec_preference"
},
"weight": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 1,
"vipVariableName": "vpn_if_tunnel_ipsec_weight"
},
"encap": {
"vipType": "constant",
"vipValue": "ipsec",
"vipObjectType": "object"
},
"priority-order": [
"encap",
"preference",
"weight"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"encap"
]
},
"group": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"11"
],
"vipVariableName": "vpn_if_tunnel_group"
},
"border": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_border"
},
"color": {
"value": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "custom2",
"vipVariableName": "vpn_if_tunnel_color_value"
},
"restrict": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_color_restrict"
}
},
"carrier": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "default",
"vipVariableName": "vpn_if_tunnel_carrier"
},
"bind": {
"vipObjectType": "object",
"vipType": "ignore",
"vipVariableName": "vpn_if_tunnel_bind"
},
"allow-service": {
"dhcp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_dhcp"
},
"dns": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_dns"
},
"icmp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_icmp"
},
"sshd": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_sshd"
},
"ntp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_ntp"
},
"stun": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_stun"
},
"all": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_all"
},
"bgp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_bgp"
},
"ospf": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_ospf"
},
"netconf": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_netconf"
},
"snmp": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "false"
},
"https": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_https"
}
},
"max-control-connections": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 8,
"vipVariableName": "vpn_if_tunnel_max_control_connections"
},
"vbond-as-stun-server": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_vbond_as_stun_server"
},
"exclude-controller-group-list": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"2"
],
"vipVariableName": "vpn_if_tunnel_exclude_controller_group_list"
},
"vmanage-connection-preference": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 7,
"vipVariableName": "vpn_if_tunnel_vmanage_connection_preference"
},
"port-hop": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_port_hop"
},
"low-bandwidth-link": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_low_bandwidth_link"
},
"last-resort-circuit": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "false",
"vipVariableName": "vpn_if_tunnel_last_resort_circuit"
},
"hold-time": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 7000,
"vipVariableName": "hold-time"
},
"nat-refresh-interval": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 5,
"vipVariableName": "vpn_if_tunnel_nat_refresh_interval"
},
"hello-interval": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 1000,
"vipVariableName": "vpn_if_tunnel_hello_interval"
},
"hello-tolerance": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 12,
"vipVariableName": "vpn_if_tunnel_hello_tolerance"
},
"tloc-extension-gre-to": {
"dst-ip": {
"vipObjectType": "object",
"vipType": "ignore",
"vipVariableName": "vpn_if_tunnel_tloc_ext_gre_to_dst_ip"
}
}
},
"ip-directed-broadcast": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_ip-directed-broadcast"
},
"ipv6": {
"access-list": {
"vipType": "constant",
"vipValue": [
{
"acl-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": " 2001:4860:4801:48::77",
"vipVariableName": "access_list_ingress_acl_name_ipv6"
},
"direction": {
"vipType": "constant",
"vipValue": "in",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
},
{
"acl-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": " 2001:4860:4801:48::88",
"vipVariableName": "access_list_egress_acl_name_ipv6"
},
"direction": {
"vipType": "constant",
"vipValue": "out",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"direction"
]
},
"address": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "",
"vipVariableName": "vpn_if_ipv6_ipv6_address"
},
"dhcp-helper-v6": {
"vipType": "ignore",
"vipValue": [],
"vipObjectType": "tree",
"vipPrimaryKey": [
"address"
]
},
"secondary-address": {
"vipType": "ignore",
"vipValue": [],
"vipObjectType": "tree",
"vipPrimaryKey": [
"address"
]
},
"ipv6-shutdown": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "false",
"vipVariableName": "vpn_if_ipv6_ipv6_shutdown"
}
},
"nat": {
"vipType": "ignore",
"vipObjectType": "node-only"
},
"arp": {
"ip": {
"vipType": "constant",
"vipValue": [
{
"addr": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "192.168.1.223",
"vipVariableName": "vpn_bridge_arp_addr"
},
"mac": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "00:00:01:02:00:33",
"vipVariableName": "vpn_bridge_arp_mac"
},
"priority-order": [
"addr",
"mac"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"addr"
]
}
},
"vrrp": {
"vipType": "ignore",
"vipValue": [],
"vipObjectType": "tree",
"vipPrimaryKey": [
"grp-id"
]
},
"ipv6-vrrp": {
"vipType": "ignore",
"vipValue": [],
"vipObjectType": "tree",
"vipPrimaryKey": [
"grp-id"
]
},
"dot1x": {
"control-direction": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "in-and-out",
"vipVariableName": "802.1X_control_direction"
},
"wake-on-lan": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "802.1X_wake_on_lan"
},
"reauthentication": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 3,
"vipVariableName": "802.1X_reauthentication"
},
"auth-fail-vlan": {
"vipObjectType": "object",
"vipType": "ignore",
"vipVariableName": "802.1X_auth_fail_vlan"
},
"guest-vlan": {
"vipObjectType": "object",
"vipType": "ignore",
"vipVariableName": "802.1X_guest_vlan"
},
"default-vlan": {
"vipObjectType": "object",
"vipType": "ignore",
"vipVariableName": "802.1X_default_vlan"
},
"host-mode": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "single-host",
"vipVariableName": "802.1X_host_mode"
},
"nas-identifier": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "17",
"vipVariableName": "802.1X_nas_identifier"
},
"nas-ip-address": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "5.5.5.5",
"vipVariableName": "802.1X_nas_ip_address"
},
"radius-servers": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"10.124.19.169"
],
"vipVariableName": "802.1X_radius_server"
},
"accounting-interval": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 30,
"vipVariableName": "802.1X_accounting_interval"
},
"timeout": {
"inactivity": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 10,
"vipVariableName": "802.1X_timeout_inactivity"
}
},
"das": {
"port": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 3799,
"vipVariableName": "802.1X_das_port"
},
"time-window": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 300,
"vipVariableName": "802.1X_das_time_window"
},
"require-timestamp": {
"vipObjectType": "node-only",
"vipType": "ignore",
"vipValue": "false",
"vipVariableName": "802.1X_das_require_timestamp"
},
"client": {
"vipObjectType": "object",
"vipType": "ignore",
"vipVariableName": "802.1X_das_client"
},
"secret-key": {
"vipObjectType": "object",
"vipType": "ignore",
"vipVariableName": "802.1X_das_secret_key"
},
"vpn": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 0,
"vipVariableName": "802.1X_das_vpn"
}
},
"mac-authentication-bypass": {
"server": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "false",
"vipVariableName": "802.1X_mab_server"
},
"allow": {}
},
"acct-req-attr": {
"vipType": "constant",
"vipValue": [
{
"id": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1,
"vipVariableName": "vpn_interface_acct_id"
},
"string": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "string",
"vipVariableName": "vpn_interface_acct_string"
},
"priority-order": [
"id",
"string"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"id"
]
},
"auth-reject-vlan": {
"vipObjectType": "object",
"vipType": "ignore",
"vipVariableName": "802.1X_auth_reject_vlan"
}
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleVpnVedgeInterface"
},
"vpn-vedge-pppoe-enabled-interface-example": {
"description": "vpn-vedge-pppoe-enabled-interface-example",
"value": {
"templateName": "vpn_vedge_interface_ppp_ethernet",
"templateDescription": "vpn_vedge_interface_ppp_ethernet",
"templateType": "vpn-vedge-pppoe-enabled-interface",
"deviceType": [
"vedge-cloud"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"if-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "ge3/",
"vipVariableName": "vpn_if_name"
},
"description": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "description1",
"vipVariableName": "vpn_if_description"
},
"pppoe-client": {
"ppp-interface": {
"vipType": "link-variable",
"vipObjectType": "object",
"vipValue": ""
}
},
"ip": {
"address": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "10.124.17.123/24",
"vipVariableName": "vpn_if_ipv4_address"
}
},
"ipv6": {
"dhcp-client": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true"
},
"dhcp-distance": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1,
"vipVariableName": "vpn_if_ipv6_dhcp_distance"
},
"access-list": {
"vipType": "constant",
"vipValue": [
{
"acl-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "2001:4860:4801:48::33",
"vipVariableName": "access_list_ingress_acl_name_ipv6"
},
"direction": {
"vipType": "constant",
"vipValue": "in",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
},
{
"acl-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "2001:4860:4801:48::44",
"vipVariableName": "access_list_egress_acl_name_ipv6"
},
"direction": {
"vipType": "constant",
"vipValue": "out",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"direction"
]
},
"ipv6-shutdown": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "false",
"vipVariableName": "vpn_if_ipv6_shutdown"
},
"dhcp-rapid-commit": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_ipv6_dhcp_rapid_commit"
}
},
"dhcp-helper": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"12.13.14.15"
],
"vipVariableName": "vpn_if_dhcp_helper"
},
"flow-control": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "both",
"vipVariableName": "vpn_if_flow_control"
},
"mtu": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1500,
"vipVariableName": "vpn_if_ip_mtu"
},
"static-ingress-qos": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1,
"vipVariableName": "vpn_if_static_ingress_qos"
},
"tcp-mss-adjust": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1380,
"vipVariableName": "vpn_if_tcp_mss_adjust"
},
"mac-address": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "00:00:00:00:00:11",
"vipVariableName": "vpn_if_mac_address"
},
"speed": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "1000",
"vipVariableName": "vpn_if_speed"
},
"duplex": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "full",
"vipVariableName": "vpn_if_duplex"
},
"shutdown": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "false",
"vipVariableName": "vpn_if_shutdown"
},
"arp-timeout": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1200,
"vipVariableName": "vpn_if_arp_timeout"
},
"shaping-rate": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 100000,
"vipVariableName": "qos_shaping_rate"
},
"qos-map": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "map1",
"vipVariableName": "qos_map"
},
"rewrite-rule": {
"rule-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "rule1",
"vipVariableName": "rewrite_rule_name"
}
},
"bandwidth-upstream": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 200000,
"vipVariableName": "vpn_if_bandwidth_upstream"
},
"bandwidth-downstream": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 200000,
"vipVariableName": "vpn_if_bandwidth_downstream"
},
"icmp-redirect-disable": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_icmp_redirect_disable"
},
"access-list": {
"vipType": "constant",
"vipValue": [
{
"acl-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "10.10.10.10",
"vipVariableName": "access_list_ingress_acl_name_ipv4"
},
"direction": {
"vipType": "constant",
"vipValue": "in",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
},
{
"acl-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "20.20.20.20",
"vipVariableName": "access_list_egress_acl_name_ipv4"
},
"direction": {
"vipType": "constant",
"vipValue": "out",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"direction"
]
},
"policer": {
"vipType": "constant",
"vipValue": [
{
"policer-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "policer1",
"vipVariableName": "policer_ingress_policer_name"
},
"direction": {
"vipType": "constant",
"vipValue": "in",
"vipObjectType": "object"
},
"priority-order": [
"policer-name",
"direction"
]
},
{
"policer-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "policer1",
"vipVariableName": "policer_egress_policer_name"
},
"direction": {
"vipType": "constant",
"vipValue": "out",
"vipObjectType": "object"
},
"priority-order": [
"policer-name",
"direction"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"policer-name",
"direction"
]
},
"pmtu": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_pmtu"
},
"tloc-extension": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "tloc",
"vipVariableName": "vpn_if_tloc_extension"
},
"autonegotiate": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "vpn_if_autonegotiate"
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleVpnVedgePppoeEnabledInterface"
},
"vpn-vedge-example": {
"description": "vpn-vedge-example",
"value": {
"templateName": "template_vpn",
"templateDescription": "template_vpn",
"templateType": "vpn-vedge",
"deviceType": [
"vedge-cloud"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"vpn-id": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 12
},
"name": {
"vipObjectType": "object",
"vipType": "ignore",
"vipVariableName": "vpn_name"
},
"ecmp-hash-key": {
"layer4": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_layer4"
}
},
"tcp-optimization": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_tcp_optimization"
},
"nat64-global": {
"prefix": {
"stateful": {}
}
},
"nat64": {
"v4": {
"pool": {
"vipType": "constant",
"vipValue": [
{
"name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "pool1"
},
"start-address": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "6.6.6.6",
"vipVariableName": "vpn_interface_start_address"
},
"end-address": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "7.7.7.7",
"vipVariableName": "vpn_interface_end_address"
},
"overload": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_interface_overload"
},
"priority-order": [
"name",
"start-address",
"end-address",
"overload"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"name"
]
}
}
},
"route-import": {
"vipType": "constant",
"vipValue": [
{
"protocol": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "bgp",
"vipVariableName": "vpn_interface_leakfromprotocol"
}
},
{
"protocol": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "connected",
"vipVariableName": "vpn_interface_leakfromprotocol"
}
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"protocol"
]
},
"route-export": {
"vipType": "ignore",
"vipValue": [],
"vipObjectType": "tree",
"vipPrimaryKey": [
"protocol"
]
},
"dns": {
"vipType": "constant",
"vipValue": [
{
"role": {
"vipType": "constant",
"vipValue": "primary",
"vipObjectType": "object"
},
"dns-addr": {
"vipType": "constant",
"vipValue": "10.124.19.169",
"vipObjectType": "object"
},
"priority-order": [
"dns-addr",
"role"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"dns-addr"
]
},
"host": {
"vipType": "constant",
"vipValue": [
{
"hostname": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "vm5",
"vipVariableName": "vpn_host_hostname"
},
"ip": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"172.16.255.15"
],
"vipVariableName": "vpn_host_ip"
},
"priority-order": [
"hostname",
"ip"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"hostname"
]
},
"service": {
"vipType": "constant",
"vipValue": [
{
"svc-type": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "FW"
},
"address": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"10.10.5.5"
],
"vipVariableName": "vpn_service_address"
},
"track-enable": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_service_service_track"
},
"priority-order": [
"svc-type",
"address",
"track-enable"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"svc-type"
]
},
"ip": {
"route": {
"vipType": "constant",
"vipValue": [
{
"prefix": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "20.20.20.20/24",
"vipVariableName": "vpn_ipv4_ip_prefix"
},
"next-hop": {
"vipType": "constant",
"vipValue": [
{
"address": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "20.20.20.1",
"vipVariableName": "vpn_next_hop_ip_address_0"
},
"distance": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 3,
"vipVariableName": "vpn_next_hop_ip_distance_0"
},
"tracker": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "",
"vipVariableName": "vpn_next_hop_ip_tracker_0"
},
"priority-order": [
"address",
"distance",
"tracker"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"address"
]
},
"priority-order": [
"prefix",
"next-hop"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"prefix"
]
},
"gre-route": {
"vipType": "constant",
"vipValue": [
{
"prefix": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "4.4.4.4/16",
"vipVariableName": "vpn_gre_route_gre_route_prefix"
},
"vpn": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 0
},
"interface": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"2"
],
"vipVariableName": "vpn_gre_route_gre_route_interface"
},
"priority-order": [
"prefix",
"vpn",
"interface"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"prefix"
]
},
"ipsec-route": {
"vipType": "constant",
"vipValue": [
{
"prefix": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "5.5.5.5/16",
"vipVariableName": "vpn_ipsec_route_ipsec_route_prefix"
},
"vpn": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 0
},
"interface": {
"vipObjectType": "list",
"vipType": "ignore",
"vipVariableName": "vpn_ipsec_route_ipsec_route_interface"
},
"priority-order": [
"prefix",
"vpn",
"interface"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"prefix"
]
},
"service-route": {
"vipType": "constant",
"vipValue": [
{
"prefix": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "3.3.3.3/16",
"vipVariableName": "vpn_serviceroute_prefix"
},
"vpn": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 0
},
"service": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "sig"
},
"priority-order": [
"prefix",
"vpn",
"service"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"prefix"
]
}
},
"ipv6": {
"route": {
"vipType": "constant",
"vipValue": [
{
"prefix": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "2001:db8:8086:6502::/64",
"vipVariableName": "vpn_ipv6_ipv6_prefix"
},
"next-hop": {
"vipType": "constant",
"vipValue": [
{
"address": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "2001:db8:8086:6501::",
"vipVariableName": "vpn_next_hop_ipv6_address_0"
},
"distance": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1,
"vipVariableName": "vpn_next_hop_ipv6_distance_0"
},
"priority-order": [
"address",
"distance"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"address"
]
},
"priority-order": [
"prefix",
"next-hop"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"prefix"
]
}
},
"omp": {
"advertise": {
"vipType": "constant",
"vipValue": [
{
"priority-order": [
"protocol"
],
"protocol": {
"vipType": "constant",
"vipValue": "bgp",
"vipObjectType": "object"
}
},
{
"priority-order": [
"protocol"
],
"protocol": {
"vipType": "constant",
"vipValue": "static",
"vipObjectType": "object"
}
},
{
"priority-order": [
"protocol"
],
"protocol": {
"vipType": "constant",
"vipValue": "connected",
"vipObjectType": "object"
}
},
{
"priority-order": [
"protocol",
"protocol-sub-type"
],
"protocol": {
"vipType": "constant",
"vipValue": "ospf",
"vipObjectType": "object"
},
"protocol-sub-type": {
"vipType": "constant",
"vipValue": "external",
"vipObjectType": "object"
}
},
{
"priority-order": [
"protocol",
"prefix-list"
],
"protocol": {
"vipType": "constant",
"vipValue": "network",
"vipObjectType": "object"
},
"prefix-list": {
"vipType": "constant",
"vipValue": [
{
"prefix-entry": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "10.10.10.10/24",
"vipVariableName": "vpn_omp_network_network_prefix"
},
"priority-order": [
"prefix-entry"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"prefix-entry"
]
}
},
{
"priority-order": [
"protocol"
],
"protocol": {
"vipType": "constant",
"vipValue": "eigrp",
"vipObjectType": "object"
}
},
{
"priority-order": [
"protocol"
],
"protocol": {
"vipType": "constant",
"vipValue": "lisp",
"vipObjectType": "object"
}
},
{
"priority-order": [
"protocol"
],
"protocol": {
"vipType": "constant",
"vipValue": "isis",
"vipObjectType": "object"
}
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"protocol"
]
},
"distance": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 12,
"vipVariableName": "vpn_distance"
},
"ipv6-advertise": {
"vipType": "ignore",
"vipValue": [],
"vipObjectType": "tree",
"vipPrimaryKey": [
"protocol"
]
}
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleVpnVedge"
},
"vpn-vmanage-interface-example": {
"description": "vpn-vmanage-interface-example",
"value": {
"templateName": "vpn_vmanage_interface",
"templateDescription": "vpn_vmanage_interface",
"templateType": "vpn-vmanage-interface",
"deviceType": [
"vmanage"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"if-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "ge1/",
"vipVariableName": "vpn_if_name"
},
"description": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "dd1",
"vipVariableName": "vpn_if_description"
},
"ip": {
"dhcp-client": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true"
},
"dhcp-distance": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 4,
"vipVariableName": "vpn_if_ip_dhcp_distance"
}
},
"ipv6": {
"dhcp-client": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true"
},
"dhcp-distance": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 4,
"vipVariableName": "vpn_if_ipv6_dhcp_distance"
},
"dhcp-rapid-commit": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_ipv6_dhcp_rapid_commit"
}
},
"dhcp-helper": {},
"flow-control": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "autoneg",
"vipVariableName": "vpn_if_flow_control"
},
"clear-dont-fragment": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_clear_dont_fragment"
},
"pmtu": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_pmtu"
},
"mtu": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1500,
"vipVariableName": "vpn_if_mtu"
},
"static-ingress-qos": {},
"tcp-mss-adjust": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1480,
"vipVariableName": "vpn_if_tcp_mss_adjust"
},
"mac-address": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "00:00:00:00:00:02",
"vipVariableName": "vpn_if_mac-address"
},
"speed": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "1000",
"vipVariableName": "vpn_if_speed"
},
"duplex": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "full",
"vipVariableName": "vpn_if_'duplex"
},
"shutdown": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "false",
"vipVariableName": "vpn_if_shutdown"
},
"arp-timeout": {},
"autonegotiate": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_autonegotiate"
},
"arp": {
"ip": {
"vipType": "constant",
"vipValue": [
{
"addr": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "10.10.10.10",
"vipVariableName": "vpn_bridge_arp_addr"
},
"mac": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "00:00:00:00:00:01",
"vipVariableName": "vpn_bridge_arp_mac"
},
"priority-order": [
"addr",
"mac"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"addr"
]
}
},
"tunnel-interface": {
"color": {
"value": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "green",
"vipVariableName": "vpn_if_tunnel_color_value"
},
"restrict": {}
},
"carrier": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "carrier2",
"vipVariableName": "vpn_if_tunnel_carrier"
},
"hello-interval": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 600,
"vipVariableName": "vpn_if_tunnel_hello_interval"
},
"hello-tolerance": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 12,
"vipVariableName": "vpn_if_tunnel_hello_tolerance"
},
"nat-refresh-interval": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 5,
"vipVariableName": "vpn_if_tunnel_nat_refresh_interval"
},
"allow-service": {
"all": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_all"
},
"dhcp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_dhcp"
},
"dns": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_dns"
},
"icmp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_icmp"
},
"sshd": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_sshd"
},
"netconf": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_netconf"
},
"ntp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_ntp"
},
"stun": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_stun"
},
"bgp": {},
"https": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_https"
}
},
"connections-limit": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 50,
"vipVariableName": "vpn_if_tunnel_connections_limit"
},
"group": {
"vipObjectType": "list",
"vipType": "ignore"
},
"low-bandwidth-link": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_low-bandwidth-link"
}
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleVpnVmanageInterface"
},
"vpn-vsmart-interface-example": {
"description": "vpn-vsmart-interface-example",
"value": {
"templateName": "vpn_vsmart_interface",
"templateDescription": "vpn_vsmart_interface",
"templateType": "vpn-vsmart-interface",
"deviceType": [
"vsmart"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"if-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "GigabitEthernet0",
"vipVariableName": "vpn_if_name"
},
"description": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "description",
"vipVariableName": "vpn_if_description"
},
"ip": {
"dhcp-client": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true"
},
"dhcp-distance": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1,
"vipVariableName": "vpn_if_ip_dhcp-distance"
}
},
"ipv6": {
"dhcp-client": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true"
},
"dhcp-distance": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 1,
"vipVariableName": "vpn_if_ipv6_dhcp-distance"
},
"dhcp-rapid-commit": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_ipv6_dhcp-rapid-commit"
}
},
"dhcp-helper": {},
"flow-control": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "egress",
"vipVariableName": "vpn_if_flow_control"
},
"clear-dont-fragment": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_clear_dont_fragment"
},
"pmtu": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_pmtu"
},
"mtu": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1500,
"vipVariableName": "vpn_if_mtu"
},
"static-ingress-qos": {},
"tcp-mss-adjust": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1490,
"vipVariableName": "vpn_if_tcp_mss_adjust"
},
"mac-address": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "B8:08:CF:42:FB:16",
"vipVariableName": "vpn_if_mac_address"
},
"speed": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "1000",
"vipVariableName": "vpn_if_speed"
},
"duplex": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "full",
"vipVariableName": "vpn_if_duplex"
},
"shutdown": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "false",
"vipVariableName": "vpn_if_shutdown"
},
"arp-timeout": {},
"autonegotiate": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_autonegotiate"
},
"arp": {
"ip": {
"vipType": "constant",
"vipValue": [
{
"addr": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "10.140.36.89",
"vipVariableName": "vpn_bridge_arp_addr"
},
"mac": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "B8:08:CF:42:FB:16",
"vipVariableName": "vpn_bridge_arp_mac"
},
"priority-order": [
"addr",
"mac"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"addr"
]
}
},
"tunnel-interface": {
"color": {
"value": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "gold",
"vipVariableName": "vpn_if_tunnel_color_value"
},
"restrict": {}
},
"carrier": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "carrier8",
"vipVariableName": "vpn_if_tunnel_carrier"
},
"hello-interval": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 600,
"vipVariableName": "vpn_if_tunnel_hello-interval"
},
"hello-tolerance": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 12,
"vipVariableName": "vpn_if_tunnel_hello-tolerance"
},
"nat-refresh-interval": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 10,
"vipVariableName": "vpn_if_tunnel_nat_refresh_interval"
},
"allow-service": {
"all": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "all"
},
"dhcp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_dhcp"
},
"dns": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_dns"
},
"icmp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_icmp"
},
"sshd": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_sshd"
},
"netconf": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_netconf"
},
"ntp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_ntp"
},
"stun": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_stun"
},
"bgp": {}
},
"group": {
"vipObjectType": "list",
"vipType": "ignore"
}
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleVpnVsmartInterface"
},
"vpn-vsmart-example": {
"description": "vpn-vsmart-example",
"value": {
"templateName": "template_vpn_vsmart",
"templateDescription": "template_vpn_vsmart",
"templateType": "vpn-vsmart",
"deviceType": [
"vsmart"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"vpn-id": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "512"
},
"name": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "vpn_name"
},
"dns": {
"vipType": "constant",
"vipValue": [
{
"role": {
"vipType": "constant",
"vipValue": "primary",
"vipObjectType": "object"
},
"dns-addr": {
"vipType": "constant",
"vipValue": "10.124.19.169",
"vipObjectType": "object"
},
"priority-order": [
"dns-addr",
"role"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"dns-addr"
]
},
"host": {
"vipType": "constant",
"vipValue": [
{
"hostname": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "YAPZHANG-WT2",
"vipVariableName": "vpn_host_hostname"
},
"ip": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"10.140.36.89"
],
"vipVariableName": "vpn_host_ip"
},
"priority-order": [
"hostname",
"ip"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"hostname"
]
},
"ip": {
"route": {
"vipType": "constant",
"vipValue": [
{
"prefix": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "20.20.20.20/24",
"vipVariableName": "vpn_ipv4_ip_prefix"
},
"next-hop": {
"vipType": "constant",
"vipValue": [
{
"address": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "20.20.20.1",
"vipVariableName": "vpn_next_hop_ip_address_0"
},
"distance": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1,
"vipVariableName": "vpn_next_hop_ip_distance_0"
},
"priority-order": [
"address",
"distance"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"address"
]
},
"priority-order": [
"prefix",
"next-hop"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"prefix"
]
}
},
"ipv6": {
"route": {
"vipType": "constant",
"vipValue": [
{
"prefix": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "FF01::101/16",
"vipVariableName": "vpn_ipv6_ipv6_prefix"
},
"next-hop": {
"vipType": "constant",
"vipValue": [
{
"address": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "FF01::100",
"vipVariableName": "vpn_next_hop_ipv6_address_0"
},
"distance": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1,
"vipVariableName": "vpn_next_hop_ipv6_distance_0"
},
"priority-order": [
"address",
"distance"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"address"
]
},
"priority-order": [
"prefix",
"next-hop"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"prefix"
]
}
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleVpnVsmart"
},
"wla-example": {
"description": "wla-example",
"value": {
"templateName": "template_wifi_radio",
"templateDescription": "template_wifi_radio",
"templateType": "wlan",
"deviceType": [
"vedge-100-WM"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"radio": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "2.4GHz"
},
"country": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "Costa Rica"
},
"channel-bandwidth": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "20",
"vipVariableName": "channel-bandwidth"
},
"guard-interval": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "800",
"vipVariableName": "guard-interval"
},
"channel": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "10"
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleWlan"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Feature template": {
"description": "Feature template",
"value": {
"templateId": "ff3b31b1-0262-44d3-badf-d9cf472fb4b1"
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Template Configuration-write,Template Deploy-write,Policy Configuration-write"
}
},
"/template/feature/clone": {
"post": {
"tags": [
"Configuration - General Template"
],
"description": "Clone a feature template
Note: In a multitenant vManage system, this API is only available in the Provider view.",
"operationId": "cloneTemplate",
"parameters": [
{
"name": "id",
"in": "query",
"description": "Template Id to clone from",
"required": true,
"schema": {
"type": "string"
},
"example": "220a6bd0-28ef-4c88-92e6-ee7539396fd7"
},
{
"name": "name",
"in": "query",
"description": "Name for the cloned template",
"required": true,
"schema": {
"type": "string"
},
"example": "BR2-VPN10-Feature"
},
{
"name": "desc",
"in": "query",
"description": "Description for the cloned template",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Template Id": {
"description": "Template Id",
"value": {
"templateId": "ff3b31b1-0262-44d3-badf-d9cf472fb4b1"
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Template Configuration-write,Template Deploy-write,Policy Configuration-write"
}
},
"/template/feature/default/networkinterface": {
"get": {
"tags": [
"Configuration - General Template"
],
"description": "Get default network interface
Note: In a multitenant vManage system, this API is only available in the Provider view.",
"operationId": "getNetworkInterface",
"parameters": [
{
"name": "deviceModel",
"in": "query",
"description": "Device model",
"required": true,
"schema": {
"type": "string",
"enum": [
"ENCS",
"C8200-UCPE",
"C8200-UCPEVM"
]
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Default network Interface": {
"description": "Default network Interface",
"value": {
"data": [
{
"lan": [
"GE0-2",
"GE0-3",
"GE0-4",
"GE0-5"
]
}
]
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/feature/default/networks": {
"get": {
"tags": [
"Configuration - General Template"
],
"description": "Get default networks
Note: In a multitenant vManage system, this API is only available in the Provider view.",
"operationId": "getDefaultNetworks",
"parameters": [
{
"name": "deviceModel",
"in": "query",
"description": "Device model",
"required": true,
"schema": {
"type": "string",
"enum": [
"vedge-nfvis-ENCS5400",
"vedge-nfvis-C8200-UCPE",
"vedge-nfvis-C8200-UCPEVM"
]
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Default network": {
"description": "Default network",
"value": {
"data": [
{
"name": "wan-net",
"sriov": false,
"trunk": true,
"bridge": "wan-br",
"bridgePort": "GE0-0"
},
{
"name": "wan2-net",
"sriov": false,
"trunk": true,
"bridge": "wan2-br",
"bridgePort": "GE0-1"
},
{
"name": "lan-net",
"sriov": false,
"trunk": true,
"bridge": "lan-br",
"bridgePort": "int-LAN"
},
{
"name": "GE0-0-SRIOV-1",
"sriov": true,
"trunk": true
},
{
"name": "GE0-0-SRIOV-2",
"sriov": true,
"trunk": true
},
{
"name": "GE0-1-SRIOV-1",
"sriov": true,
"trunk": true
},
{
"name": "GE0-1-SRIOV-2",
"sriov": true,
"trunk": true
},
{
"name": "LAN-SRIOV-1",
"sriov": true,
"trunk": true
},
{
"name": "LAN-SRIOV-2",
"sriov": true,
"trunk": true
},
{
"name": "LAN-SRIOV-3",
"sriov": true,
"trunk": true
}
]
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Template Configuration-read,Template Deploy-read,Template Deploy-write"
}
},
"/template/feature/definition/{templateId}": {
"get": {
"tags": [
"Configuration - General Template"
],
"description": "Get the configured template definition for given template Id
Note: In a multitenant vManage system, this API is only available in the Provider view.",
"operationId": "getTemplateDefinition",
"parameters": [
{
"name": "templateId",
"in": "path",
"description": "Template Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Template definition": {
"description": "Template definition",
"value": {
"appnav-controller-group": {
"vipObjectType": "tree",
"vipType": "constant",
"vipValue": [
{
"group-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "ACG-APPQOE"
},
"appnav-controllers": {
"vipObjectType": "tree",
"vipType": "constant",
"vipPrimaryKey": [
"address"
],
"vipValue": [
{
"address": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "10.10.10.10"
},
"vpn": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 512
}
}
]
}
}
],
"vipPrimaryKey": [
"group-name"
]
},
"service-node-group": {
"vipObjectType": "tree",
"vipType": "constant",
"vipValue": [
{
"name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "SNG-APPQOE"
},
"internal": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": false
},
"service-node": {
"vipObjectType": "tree",
"vipType": "constant",
"vipPrimaryKey": [
"address"
],
"vipValue": [
{
"address": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "10.10.11.11"
},
"vpg-ip": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": ""
}
}
]
}
}
],
"vipPrimaryKey": [
"name"
]
},
"service-context": {
"appqoe": {
"vipObjectType": "tree",
"vipType": "constant",
"vipPrimaryKey": [
"name"
],
"vipValue": [
{
"name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "/1"
},
"appnav-controller-group": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "ACG-APPQOE"
},
"service-node-groups": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"SNG-APPQOE"
]
},
"service-node-group": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "SNG-APPQOE"
},
"enable": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "true"
},
"vpn": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 0,
"vipVariableName": "appqoe_vrf"
}
}
]
}
}
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Template Configuration-read,Template Deploy-read,Policy Configuration-read"
}
},
"/template/feature/devicetemplates/{templateId}": {
"get": {
"tags": [
"Configuration - General Template"
],
"description": "Get all device templates for this feature template
Note: In a multitenant vManage system, this API is only available in the Provider view.",
"operationId": "getDeviceTemplatesAttachedToFeature",
"parameters": [
{
"name": "templateId",
"in": "path",
"description": "Feature template Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Template": {
"description": "Template",
"value": {
"data": [
{
"templateName": "Default_SDBranch_C8000V_Template_V01",
"templateId": "cd72321b-9ff0-4fb3-badd-965d528e71ac"
},
{
"templateName": "Default_BOOTSTRAP_DHCP_8000V_Template_V01",
"templateId": "41c50079-1978-462e-8489-d4ad5d3b3644"
},
{
"templateName": "Default_MEGAPORT_ICGW_C8000V_Template_V01",
"templateId": "5880350d-bdb9-4d34-85b0-782c77c96ea9"
},
{
"templateName": "Default_EQUINIX_DHCP_DNS_ICGW_CSR1000V_Template_V02",
"templateId": "600ca2bc-0cc1-4c1b-a3cd-4fa4ae4dc2e1"
},
{
"templateName": "Default_Azure_vWAN_C8000V_Template_V01",
"templateId": "a1e8373a-9b9b-4d22-b275-bc1671891798"
},
{
"templateName": "Factory_Default_C8000V_V01",
"templateId": "0513c5c1-b1e9-4b89-875f-fbe0f8957611"
},
{
"templateName": "Default_BOOTSTRAP_STATIC_8000V_Template_V01",
"templateId": "af0119de-0223-4ddd-9515-f12a03affc77"
},
{
"templateName": "Default_AWS_TGW_C8000V_Template_V01",
"templateId": "7188945f-7b44-4d45-8dbc-71a24218bcbd"
},
{
"templateName": "Default_GCP_C8000V_Template_V01",
"templateId": "873e7414-dd35-4706-b776-c7d2b6d1ee55"
},
{
"templateName": "Default_AWS_TGW_CSR1000V_Template_V01",
"templateId": "d4e1bd4b-bec8-4522-94c5-7047b44ee02a"
},
{
"templateName": "Factory_Default_ISR_4331_V01",
"templateId": "6c69af42-5cc4-4f76-92b7-f0e20d4969e4"
},
{
"templateName": "Factory_Default_C1111_8PLTELA_V01",
"templateId": "ef3a49c8-87cb-41b5-913e-042d110ca1f2"
}
]
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Template Configuration-read,Template Configuration-write,Template Deploy-read,Template Deploy-write"
}
},
"/template/feature/li": {
"post": {
"tags": [
"Configuration - General Template"
],
"description": "Create LI feature template
Note: In a multitenant vManage system, this API is only available in the Provider view.",
"operationId": "createLITemplate",
"requestBody": {
"description": "LI template",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"LI template": {
"description": "LI template",
"value": {}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Template Id": {
"description": "Template Id",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Lawful Interception-write"
},
"get": {
"tags": [
"Configuration - General Template"
],
"description": "Get LI feature template",
"operationId": "listLITemplate",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"LI template": {
"description": "LI template",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Lawful Interception-read"
}
},
"/template/feature/li/{templateId}": {
"put": {
"tags": [
"Configuration - General Template"
],
"description": "Update LI feature template
Note: In a multitenant vManage system, this API is only available in the Provider view.",
"operationId": "editLITemplate",
"parameters": [
{
"name": "templateId",
"in": "path",
"description": "Template Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "LI template",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"LI template": {
"description": "LI template",
"value": {}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Template": {
"description": "Template",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Lawful Interception-write"
}
},
"/template/feature/master/{type_name}": {
"get": {
"tags": [
"Configuration - General Template"
],
"description": "Generate template type definition by device type
Note: In a multitenant vManage system, this API is only available in the Provider view.",
"operationId": "generateMasterTemplateDefinition",
"parameters": [
{
"name": "type_name",
"in": "path",
"description": "Device type",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Template": {
"description": "Template",
"value": {
"name": "vedge",
"fields": [
{
"min": 0,
"deviceModels": [
"vedge-1000",
"vedge-2000",
"vedge-cloud",
"vedge-5000",
"vedge-ISR1100-6G",
"vedge-100-B",
"vedge-ISR1100-4G",
"vedge-100",
"vedge-ISR1100-4GLTE",
"vedge-100-WM",
"vedge-100-M",
"vedge-ISR1100X-6G",
"vedge-ISR1100X-4G"
],
"max": 1,
"displayName": "AAA",
"name": "aaa"
},
{
"subtree": [
{
"subtree": [
{
"min": 0,
"deviceModels": [
"vedge-1000",
"vedge-2000",
"vedge-cloud",
"vedge-5000",
"vedge-ISR1100-6G",
"vedge-100-B",
"vedge-ISR1100-4G",
"vedge-100",
"vedge-ISR1100-4GLTE",
"vedge-100-WM",
"vedge-100-M",
"vedge-ISR1100X-6G",
"vedge-ISR1100X-4G"
],
"max": 1,
"displayName": "DHCPServer",
"name": "dhcp-server"
}
]
}
],
"min": 0,
"deviceModels": [
"vedge-1000",
"vedge-2000",
"vedge-cloud",
"vedge-5000",
"vedge-ISR1100-6G",
"vedge-100-B",
"vedge-ISR1100-4G",
"vedge-100",
"vedge-ISR1100-4GLTE",
"vedge-100-WM",
"vedge-100-M",
"vedge-ISR1100X-6G",
"vedge-ISR1100X-4G"
],
"max": 62,
"displayName": "VPN",
"name": "vpn-vedge",
"type": ""
}
]
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Template Configuration-read,Template Configuration-write,Template Deploy-read,Template Deploy-write"
}
},
"/template/feature/migration": {
"get": {
"tags": [
"Configuration - General Template"
],
"description": "Generate a list of templates which require migration
Note: In a multitenant vManage system, this API is only available in the Provider view.",
"operationId": "getTemplateForMigration",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Template list": {
"description": "Template list",
"value": {
"data": [
{
"deviceType": "vedge-CSR-1000v",
"lastUpdatedBy": "admin",
"templateClass": "cedge_vedge",
"templateId": "c62e6fba-fb53-4562-b436-3878de0fbbc2",
"configType": "template",
"factoryDefault": false,
"templateName": "BranchType1Template-CSR",
"devicesAttached": 2,
"templateDescription": "Branch Type 1 Template for CSR Routers",
"lastUpdatedOn": 1588093291553,
"templateAttached": 22
}
]
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Template Configuration-read,Template Deploy-read,Policy Configuration-read,Lawful Interception-read"
}
},
"/template/feature/object/{templateId}": {
"get": {
"tags": [
"Configuration - General Template"
],
"description": "Get template object definition for given template Id
Note: In a multitenant vManage system, this API is only available in the Provider view.",
"operationId": "getGeneralTemplate",
"parameters": [
{
"name": "templateId",
"in": "path",
"description": "Template Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Template": {
"description": "Template",
"value": {
"templateType": "cedgeVoiceCard",
"templateMinVersion": "15.0.0",
"deviceType": [
"vedge-ISR-4461"
],
"lastUpdatedBy": "admin",
"editedTemplateDefinition": {
"voice-card": {
"vipType": "constant",
"vipObjectType": "tree",
"vipPrimaryKey": [
"port-id"
],
"vipValue": [
{
"port-id": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "1/0/7"
},
"id": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "1/0",
"vipVariableName": "analog_id"
},
"module-type": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "SM-X-8FXS/12FXO"
},
"description": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "analog_description_"
},
"caller-id": {
"enable": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "analog_caller_id_"
}
},
"port-type": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "FXS",
"vipVariableName": "analog_port_type_"
},
"secondary": {
"dialtone": {
"vipObjectType": "node-only",
"vipType": "ignore",
"vipValue": "false",
"vipVariableName": "analog_secondary_dialtone_"
}
},
"shutdown": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "false",
"vipVariableName": "analog_shutdown_"
},
"connection": {
"plar": {
"plar-num": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "analog_connection_plarnum_"
},
"opx-num-only": {
"vipType": "ignore",
"vipValue": "",
"vipObjectType": "object"
}
}
},
"signal": {
"did-type": {
"vipType": "ignore",
"vipValue": "",
"vipObjectType": "object"
},
"signal-choice": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "loopStart",
"vipVariableName": "analog_signal_choice_"
}
},
"port-range": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "7",
"vipVariableName": "analog_port_range_"
},
"local-bypass": {
"vipType": "constant",
"vipValue": "true",
"vipObjectType": "object"
}
}
]
},
"voice-card-dig": {
"vipType": "constant",
"vipObjectType": "tree",
"vipPrimaryKey": [
"dig-port-id"
],
"vipValue": [
{
"dig-port-id": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "0/1/0"
},
"id-dig": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "0/1"
},
"framing": {
"vipObjectType": "object",
"vipType": "notIgnore",
"vipValue": "esf",
"vipVariableName": "framing_0"
},
"interface": {
"vipType": "constant",
"vipValue": [
{
"port-id": {
"vipType": "constant",
"vipValue": "0/1/0",
"vipObjectType": "object"
},
"clock-priority": {
"vipType": "constant",
"vipValue": 0,
"vipObjectType": "object"
},
"controller-shutdown": {
"vipType": "constant",
"vipValue": "false",
"vipObjectType": "object"
},
"serial-intf-shutdown": {
"vipType": "constant",
"vipValue": "false",
"vipObjectType": "object"
},
"voiceport-shutdown": {
"vipType": "constant",
"vipValue": true,
"vipObjectType": "object"
},
"clock-type": {
"vipType": "constant",
"vipValue": "line",
"vipObjectType": "object"
},
"clock-position": {
"vipType": "ignore",
"vipValue": "",
"vipObjectType": "object"
}
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"port-id"
]
},
"interface-type": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "T1 PRI"
},
"line-termination": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "120-ohm",
"vipVariableName": "digital_line-termination"
},
"linecode": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "b8zs",
"vipVariableName": "linecode_0"
},
"module-type": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "NIM-1MFT-T1/E1"
},
"network-side": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "false",
"vipVariableName": "digital_network-side"
},
"switch-type": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "primary-4ess",
"vipVariableName": "digital_switch-type"
},
"timeslots": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "digital_timeslots"
},
"delay-connect-timer": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 20,
"vipVariableName": "digital_delay_connect_timer"
},
"dsp-hairpin": {
"vipType": "constant",
"vipValue": "false",
"vipObjectType": "object"
},
"framing-australia": {
"vipType": "constant",
"vipValue": "false",
"vipObjectType": "object"
},
"network-participation": {
"vipType": "constant",
"vipValue": "true",
"vipObjectType": "object"
},
"isdn-timer": {
"isdn-timer-T200": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 1000,
"vipVariableName": "digital_isdn-timer-T200"
},
"isdn-timer-T203": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 30000,
"vipVariableName": "digital_isdn-timer-T203"
},
"isdn-timer-T301": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 300000,
"vipVariableName": "digital_isdn-timer-T301"
},
"isdn-timer-T303": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 4000,
"vipVariableName": "digital_isdn-timer-T303"
},
"isdn-timer-T306": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 30000,
"vipVariableName": "digital_isdn-timer-T306"
},
"isdn-timer-T309": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 90000,
"vipVariableName": "digital_isdn-timer-T309"
},
"isdn-timer-T310": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 30000,
"vipVariableName": "digital_isdn-timer-T310"
},
"isdn-timer-T321": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 40000,
"vipVariableName": "digital_isdn-timer-T321"
}
},
"cablelength-long": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "-7.5",
"vipVariableName": "digital_cablelength-long"
}
}
]
},
"clock-dig": {
"sync": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "digital_sync"
},
"wait-to-restore": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 300,
"vipVariableName": "digital_wait-to-restore"
}
}
},
"gTemplateClass": "cedge",
"templateDefinition": {
"voice-card": {
"vipType": "constant",
"vipObjectType": "tree",
"vipPrimaryKey": [
"port-id"
],
"vipValue": [
{
"port-id": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "1/0/7"
},
"id": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "1/0",
"vipVariableName": "analog_id"
},
"module-type": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "SM-X-8FXS/12FXO"
},
"description": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "analog_description_"
},
"caller-id": {
"enable": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "analog_caller_id_"
}
},
"port-type": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "FXS",
"vipVariableName": "analog_port_type_"
},
"secondary": {
"dialtone": {
"vipObjectType": "node-only",
"vipType": "ignore",
"vipValue": "false",
"vipVariableName": "analog_secondary_dialtone_"
}
},
"shutdown": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "false",
"vipVariableName": "analog_shutdown_"
},
"connection": {
"plar": {
"plar-num": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "analog_connection_plarnum_"
},
"opx-num-only": {
"vipType": "ignore",
"vipValue": "",
"vipObjectType": "object"
}
}
},
"signal": {
"did-type": {
"vipType": "ignore",
"vipValue": "",
"vipObjectType": "object"
},
"signal-choice": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "loopStart",
"vipVariableName": "analog_signal_choice_"
}
},
"port-range": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "7",
"vipVariableName": "analog_port_range_"
},
"local-bypass": {
"vipType": "constant",
"vipValue": "true",
"vipObjectType": "object"
}
}
]
},
"voice-card-dig": {
"vipType": "constant",
"vipObjectType": "tree",
"vipPrimaryKey": [
"dig-port-id"
],
"vipValue": [
{
"dig-port-id": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "0/1/0"
},
"id-dig": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "0/1"
},
"framing": {
"vipObjectType": "object",
"vipType": "notIgnore",
"vipValue": "esf",
"vipVariableName": "framing_0"
},
"interface": {
"vipType": "constant",
"vipValue": [
{
"port-id": {
"vipType": "constant",
"vipValue": "0/1/0",
"vipObjectType": "object"
},
"clock-priority": {
"vipType": "constant",
"vipValue": 0,
"vipObjectType": "object"
},
"controller-shutdown": {
"vipType": "constant",
"vipValue": "false",
"vipObjectType": "object"
},
"serial-intf-shutdown": {
"vipType": "constant",
"vipValue": "false",
"vipObjectType": "object"
},
"voiceport-shutdown": {
"vipType": "constant",
"vipValue": true,
"vipObjectType": "object"
},
"clock-type": {
"vipType": "constant",
"vipValue": "line",
"vipObjectType": "object"
},
"clock-position": {
"vipType": "ignore",
"vipValue": "",
"vipObjectType": "object"
}
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"port-id"
]
},
"interface-type": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "T1 PRI"
},
"line-termination": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "120-ohm",
"vipVariableName": "digital_line-termination"
},
"linecode": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "b8zs",
"vipVariableName": "linecode_0"
},
"module-type": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "NIM-1MFT-T1/E1"
},
"network-side": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "false",
"vipVariableName": "digital_network-side"
},
"switch-type": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "primary-4ess",
"vipVariableName": "digital_switch-type"
},
"timeslots": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "digital_timeslots"
},
"delay-connect-timer": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 20,
"vipVariableName": "digital_delay_connect_timer"
},
"dsp-hairpin": {
"vipType": "constant",
"vipValue": "false",
"vipObjectType": "object"
},
"framing-australia": {
"vipType": "constant",
"vipValue": "false",
"vipObjectType": "object"
},
"network-participation": {
"vipType": "constant",
"vipValue": "true",
"vipObjectType": "object"
},
"isdn-timer": {
"isdn-timer-T200": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 1000,
"vipVariableName": "digital_isdn-timer-T200"
},
"isdn-timer-T203": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 30000,
"vipVariableName": "digital_isdn-timer-T203"
},
"isdn-timer-T301": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 300000,
"vipVariableName": "digital_isdn-timer-T301"
},
"isdn-timer-T303": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 4000,
"vipVariableName": "digital_isdn-timer-T303"
},
"isdn-timer-T306": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 30000,
"vipVariableName": "digital_isdn-timer-T306"
},
"isdn-timer-T309": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 90000,
"vipVariableName": "digital_isdn-timer-T309"
},
"isdn-timer-T310": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 30000,
"vipVariableName": "digital_isdn-timer-T310"
},
"isdn-timer-T321": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 40000,
"vipVariableName": "digital_isdn-timer-T321"
}
},
"cablelength-long": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "-7.5",
"vipVariableName": "digital_cablelength-long"
}
}
]
},
"clock-dig": {
"sync": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "digital_sync"
},
"wait-to-restore": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 300,
"vipVariableName": "digital_wait-to-restore"
}
}
},
"configType": "xml",
"attachedMastersCount": 0,
"templateId": "30ebbc4a-6596-45b8-acfb-c62fe2add788",
"createdOn": 1652776377626,
"@rid": 918,
"factoryDefault": false,
"feature": "vmanage-default",
"templateName": "template_voice_card",
"createdBy": "admin",
"devicesAttached": 0,
"templateDescription": "template_voice_card",
"lastUpdatedOn": 1652776377626
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Template Configuration-read,Template Deploy-read,Policy Configuration-read"
}
},
"/template/feature/resource-group/{resourceGroupName}/{templateId}": {
"post": {
"tags": [
"Configuration - General Template"
],
"description": "Change template resource group",
"operationId": "changeTemplateResourceGroup_ConfigurationGeneralTemplate_6504",
"parameters": [
{
"name": "templateId",
"in": "path",
"description": "Template Id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "resourceGroupName",
"in": "path",
"description": "Resrouce group name",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Template Configuration-write,Template Deploy-write"
}
},
"/template/feature/types": {
"get": {
"tags": [
"Configuration - General Template"
],
"description": "Generate template types
Note: In a multitenant vManage system, this API is only available in the Provider view.",
"operationId": "generateTemplateTypes",
"parameters": [
{
"name": "type",
"in": "query",
"description": "Device type",
"required": true,
"schema": {
"type": "string",
"enum": [
"vedge",
"cedge",
"all",
"default"
]
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Template type": {
"description": "Template type",
"value": {
"data": [
{
"parent": "basic_info",
"default": "aaa/aaa.json",
"deviceModels": [
{
"name": "vedge-1000"
},
{
"name": "vedge-2000"
},
{
"name": "vedge-cloud"
},
{
"name": "vedge-5000"
},
{
"name": "vedge-ISR1100-6G"
},
{
"name": "vedge-100-B"
},
{
"name": "vedge-ISR1100-4G"
},
{
"name": "vedge-100"
},
{
"name": "vsmart"
},
{
"name": "vedge-ISR1100-4GLTE"
},
{
"name": "vedge-100-WM"
},
{
"name": "vmanage"
},
{
"name": "vbond"
},
{
"name": "vedge-100-M"
},
{
"name": "vedge-ISR1100X-6G"
},
{
"name": "vedge-ISR1100X-4G"
}
],
"displayName": "AAA",
"name": "aaa",
"typeClass": "DefaultGeneralTemplate",
"description": "AAA",
"write_permission": true,
"read_permission": true,
"helperType": []
}
]
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Template Configuration-read,Template Configuration-write,Template Deploy-read,Template Deploy-write"
}
},
"/template/feature/types/definition/{type_name}/{version}": {
"get": {
"tags": [
"Configuration - General Template"
],
"description": "Generate template type definition
Note: In a multitenant vManage system, this API is only available in the Provider view.",
"operationId": "generateTemplateTypeDefinition",
"parameters": [
{
"name": "type_name",
"in": "path",
"description": "Feature template type",
"required": true,
"schema": {
"type": "string",
"example": "cisco_system"
}
},
{
"name": "version",
"in": "path",
"description": "Version",
"required": true,
"schema": {
"type": "string",
"example": "2"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Template type": {
"description": "Template type",
"value": {
"xmlPath": [],
"xmlRootTag": "system",
"nameSpace": "http://viptela.com/system",
"name": "cisco_system",
"fields": [
{
"optionType": [
"constant",
"ignore"
],
"description": "Enable Migration Mode to Hierarchical SDWAN",
"dataType": {
"type": "enum",
"values": [
{
"key": "enabled",
"value": "Enable"
},
{
"key": "enabled-from-bgp-core",
"value": "Enable from BGP Core"
}
]
},
"defaultOption": "ignore",
"dataPath": [],
"details": "Enable migration mode to Hierarchical SDWAN",
"key": "enable-hsdwan-migration",
"objectType": "object"
},
{
"optionType": [
"constant",
"ignore"
],
"description": "Migration BGP Community",
"dataType": {
"max": 4294967295,
"type": "number",
"min": 1
},
"defaultOption": "ignore",
"dataPath": [],
"details": "Set BGP community during migration from BGP-core based network",
"key": "migration-bgp-community",
"objectType": "object"
}
]
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Template Configuration-read,Template Configuration-write,Template Deploy-read,Template Deploy-write"
}
},
"/template/feature/{deviceType}": {
"get": {
"tags": [
"Configuration - General Template"
],
"description": "Generate template based on device
Note: In a multitenant vManage system, this API is only available in the Provider view.",
"operationId": "generateTemplateByDeviceType",
"parameters": [
{
"name": "deviceType",
"in": "path",
"description": "Device type",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Feature template": {
"description": "Feature template",
"value": {
"data": [
{
"templateMinVersion": "20.1.0",
"templateType": "logging",
"deviceType": [
"vedge-1000",
"vedge-2000",
"vedge-cloud",
"vedge-5000",
"vedge-ISR1100-6G",
"vedge-100-B",
"vedge-ISR1100-4G",
"vedge-100",
"vsmart",
"vedge-ISR1100-4GLTE",
"vedge-100-WM",
"vmanage",
"vedge-100-M",
"vedge-ISR1100X-6G",
"vedge-ISR1100X-4G"
],
"lastUpdatedBy": "system",
"editedTemplateDefinition": {
"disk": {
"enable": {
"vipObjectType": "object",
"vipValue": "true",
"vipType": "ignore"
},
"file": {
"size": {
"vipObjectType": "object",
"vipValue": 10,
"vipType": "ignore"
},
"rotate": {
"vipObjectType": "object",
"vipValue": 10,
"vipType": "ignore"
}
},
"priority": {
"vipObjectType": "object",
"vipValue": "information",
"vipType": "ignore"
}
}
},
"gTemplateClass": "vedge",
"templateDefinition": {
"disk": {
"enable": {
"vipObjectType": "object",
"vipValue": "true",
"vipType": "ignore"
},
"file": {
"size": {
"vipObjectType": "object",
"vipValue": 10,
"vipType": "ignore"
},
"rotate": {
"vipObjectType": "object",
"vipValue": 10,
"vipType": "ignore"
}
},
"priority": {
"vipObjectType": "object",
"vipValue": "information",
"vipType": "ignore"
}
}
},
"configType": "xml",
"attachedMastersCount": 1,
"templateId": "5f459c3b-2e77-4399-8b0d-f1d5cf048035",
"createdOn": 1652417246799,
"@rid": 108,
"factoryDefault": true,
"feature": "vmanage-default",
"templateName": "Factory_Default_Logging_Template_V01",
"createdBy": "system",
"devicesAttached": 0,
"templateDescription": "DefaultLoggingtemplatesettingsVersion01",
"lastUpdatedOn": 1652417246799
}
]
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Template Configuration-read,Template Deploy-read,Template Deploy-write"
}
},
"/template/feature/{templateId}": {
"delete": {
"tags": [
"Configuration - General Template"
],
"description": "Delete feature template",
"operationId": "deleteGeneralTemplate",
"parameters": [
{
"name": "templateId",
"in": "path",
"description": "Template Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Template Configuration-write"
},
"put": {
"tags": [
"Configuration - General Template"
],
"description": "Update feature template
Note: In a multitenant vManage system, this API is only available in the Provider view.",
"operationId": "editFeatureTemplate",
"parameters": [
{
"name": "templateId",
"in": "path",
"description": "Template Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Template",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"CedgeVoiceCard-example": {
"description": "CedgeVoiceCard-example",
"value": {
"templateName": "template_voice_card",
"templateDescription": "template_voice_card",
"templateType": "cedgeVoiceCard",
"deviceType": [
"vedge-ISR-4461"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"voice-card": {
"vipType": "constant",
"vipObjectType": "tree",
"vipPrimaryKey": [
"port-id"
],
"vipValue": [
{
"port-id": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "1/0/7"
},
"id": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "1/0",
"vipVariableName": "analog_id"
},
"module-type": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "SM-X-8FXS/12FXO"
},
"description": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "analog_description_"
},
"caller-id": {
"enable": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "analog_caller_id_"
}
},
"port-type": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "FXS",
"vipVariableName": "analog_port_type_"
},
"secondary": {
"dialtone": {
"vipObjectType": "node-only",
"vipType": "ignore",
"vipValue": "false",
"vipVariableName": "analog_secondary_dialtone_"
}
},
"shutdown": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "false",
"vipVariableName": "analog_shutdown_"
},
"connection": {
"plar": {
"plar-num": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "analog_connection_plarnum_"
},
"opx-num-only": {
"vipType": "ignore",
"vipValue": "",
"vipObjectType": "object"
}
}
},
"signal": {
"did-type": {
"vipType": "ignore",
"vipValue": "",
"vipObjectType": "object"
},
"signal-choice": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "loopStart",
"vipVariableName": "analog_signal_choice_"
}
},
"port-range": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "7",
"vipVariableName": "analog_port_range_"
},
"local-bypass": {
"vipType": "constant",
"vipValue": "true",
"vipObjectType": "object"
}
}
]
},
"voice-card-dig": {
"vipType": "constant",
"vipObjectType": "tree",
"vipPrimaryKey": [
"dig-port-id"
],
"vipValue": [
{
"dig-port-id": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "0/1/0"
},
"id-dig": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "0/1"
},
"framing": {
"vipObjectType": "object",
"vipType": "notIgnore",
"vipValue": "esf",
"vipVariableName": "framing_0"
},
"interface": {
"vipType": "constant",
"vipValue": [
{
"port-id": {
"vipType": "constant",
"vipValue": "0/1/0",
"vipObjectType": "object"
},
"clock-priority": {
"vipType": "constant",
"vipValue": 0,
"vipObjectType": "object"
},
"controller-shutdown": {
"vipType": "constant",
"vipValue": "false",
"vipObjectType": "object"
},
"serial-intf-shutdown": {
"vipType": "constant",
"vipValue": "false",
"vipObjectType": "object"
},
"voiceport-shutdown": {
"vipType": "constant",
"vipValue": true,
"vipObjectType": "object"
},
"clock-type": {
"vipType": "constant",
"vipValue": "line",
"vipObjectType": "object"
},
"clock-position": {
"vipType": "ignore",
"vipValue": "",
"vipObjectType": "object"
}
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"port-id"
]
},
"interface-type": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "T1 PRI"
},
"line-termination": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "120-ohm",
"vipVariableName": "digital_line-termination"
},
"linecode": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "b8zs",
"vipVariableName": "linecode_0"
},
"module-type": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "NIM-1MFT-T1/E1"
},
"network-side": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "false",
"vipVariableName": "digital_network-side"
},
"switch-type": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "primary-4ess",
"vipVariableName": "digital_switch-type"
},
"timeslots": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "digital_timeslots"
},
"delay-connect-timer": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 20,
"vipVariableName": "digital_delay_connect_timer"
},
"dsp-hairpin": {
"vipType": "constant",
"vipValue": "false",
"vipObjectType": "object"
},
"framing-australia": {
"vipType": "constant",
"vipValue": "false",
"vipObjectType": "object"
},
"network-participation": {
"vipType": "constant",
"vipValue": "true",
"vipObjectType": "object"
},
"isdn-timer": {
"isdn-timer-T200": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 1000,
"vipVariableName": "digital_isdn-timer-T200"
},
"isdn-timer-T203": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 30000,
"vipVariableName": "digital_isdn-timer-T203"
},
"isdn-timer-T301": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 300000,
"vipVariableName": "digital_isdn-timer-T301"
},
"isdn-timer-T303": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 4000,
"vipVariableName": "digital_isdn-timer-T303"
},
"isdn-timer-T306": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 30000,
"vipVariableName": "digital_isdn-timer-T306"
},
"isdn-timer-T309": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 90000,
"vipVariableName": "digital_isdn-timer-T309"
},
"isdn-timer-T310": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 30000,
"vipVariableName": "digital_isdn-timer-T310"
},
"isdn-timer-T321": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 40000,
"vipVariableName": "digital_isdn-timer-T321"
}
},
"cablelength-long": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "-7.5",
"vipVariableName": "digital_cablelength-long"
}
}
]
},
"clock-dig": {
"sync": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "digital_sync"
},
"wait-to-restore": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 300,
"vipVariableName": "digital_wait-to-restore"
}
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleCedgevoicecard"
},
"CedgeVoiceSrst-example": {
"description": "CedgeVoiceSrst-example",
"value": {
"templateName": "template_voice_srst",
"templateDescription": "template_voice_srst",
"templateType": "cedgeVoiceSrst",
"deviceType": [
"vedge-ISR-4461"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"register": {
"global": {
"max-pool": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 2000
},
"system-message": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": ""
},
"max-dn": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 3500
},
"call-manager-fallback": {
"moh": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "false",
"vipVariableName": "srst_moh"
},
"filename": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": ""
}
}
},
"pool": {
"vipType": "ignore",
"vipObjectType": "tree",
"vipPrimaryKey": [
"pool-tag"
],
"vipValue": []
}
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleCedgevoicesrst"
},
"aaa-example": {
"description": "aaa-example",
"value": {
"templateName": "template_aaa",
"templateDescription": "template_aaa",
"templateType": "aaa",
"deviceType": [
"vedge-cloud"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"aaa": {
"auth-order": {
"vipType": "constant",
"vipValue": [
{
"vipType": "constant",
"vipValue": "local",
"vipObjectType": "object"
},
{
"vipType": "constant",
"vipValue": "radius",
"vipObjectType": "object"
},
{
"vipType": "constant",
"vipValue": "tacacs",
"vipObjectType": "object"
}
],
"vipObjectType": "list",
"vipVariableName": "auth_order"
},
"auth-fallback": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "auth_fallback"
},
"admin-auth-order": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "admin_auth_order"
},
"logs": {
"audit-disable": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "disable_audit_logs"
},
"netconf-disable": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "disable_netconf_logs"
}
},
"radius-servers": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"10.124.19.169"
],
"vipVariableName": "radius_servers"
},
"usergroup": {
"vipType": "constant",
"vipValue": [
{
"name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "netadmin"
},
"viewMode": "view",
"priority-order": [
"name"
]
},
{
"name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "basic"
},
"priority-order": [
"name",
"task"
],
"task": {
"vipType": "constant",
"vipValue": [
{
"mode": {
"vipType": "constant",
"vipValue": "system",
"vipObjectType": "object"
},
"permission": {
"vipType": "constant",
"vipValue": [
{
"vipType": "constant",
"vipValue": "read",
"vipObjectType": "object"
},
{
"vipType": "constant",
"vipValue": "write",
"vipObjectType": "object"
}
],
"vipObjectType": "list"
},
"priority-order": [
"mode",
"permission"
]
},
{
"mode": {
"vipType": "constant",
"vipValue": "interface",
"vipObjectType": "object"
},
"permission": {
"vipType": "constant",
"vipValue": [
{
"vipType": "constant",
"vipValue": "read",
"vipObjectType": "object"
},
{
"vipType": "constant",
"vipValue": "write",
"vipObjectType": "object"
}
],
"vipObjectType": "list"
},
"priority-order": [
"mode",
"permission"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"mode"
]
}
},
{
"name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "operator"
},
"priority-order": [
"name",
"task"
],
"task": {
"vipType": "constant",
"vipValue": [
{
"mode": {
"vipType": "constant",
"vipValue": "system",
"vipObjectType": "object"
},
"permission": {
"vipType": "constant",
"vipValue": [
{
"vipType": "constant",
"vipValue": "read",
"vipObjectType": "object"
}
],
"vipObjectType": "list"
},
"priority-order": [
"mode",
"permission"
]
},
{
"mode": {
"vipType": "constant",
"vipValue": "interface",
"vipObjectType": "object"
},
"permission": {
"vipType": "constant",
"vipValue": [
{
"vipType": "constant",
"vipValue": "read",
"vipObjectType": "object"
}
],
"vipObjectType": "list"
},
"priority-order": [
"mode",
"permission"
]
},
{
"mode": {
"vipType": "constant",
"vipValue": "policy",
"vipObjectType": "object"
},
"permission": {
"vipType": "constant",
"vipValue": [
{
"vipType": "constant",
"vipValue": "read",
"vipObjectType": "object"
}
],
"vipObjectType": "list"
},
"priority-order": [
"mode",
"permission"
]
},
{
"mode": {
"vipType": "constant",
"vipValue": "routing",
"vipObjectType": "object"
},
"permission": {
"vipType": "constant",
"vipValue": [
{
"vipType": "constant",
"vipValue": "read",
"vipObjectType": "object"
}
],
"vipObjectType": "list"
},
"priority-order": [
"mode",
"permission"
]
},
{
"mode": {
"vipType": "constant",
"vipValue": "security",
"vipObjectType": "object"
},
"permission": {
"vipType": "constant",
"vipValue": [
{
"vipType": "constant",
"vipValue": "read",
"vipObjectType": "object"
}
],
"vipObjectType": "list"
},
"priority-order": [
"mode",
"permission"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"mode"
]
}
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"name"
]
},
"user": {
"vipType": "constant",
"vipValue": [
{
"vipOptional": false,
"name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "admin",
"vipVariableName": "user_name_0"
},
"password": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "$6$lobvrA==$docad9oDqytPru2qmWu7Wd9GIoWqs0Q7aA47ytuoDbVj3AzmnDrydGFMyJ1Qjby88mNavWArKslt23B74l2yE0"
},
"pubkey-chain": {
"vipObjectType": "tree",
"vipType": "ignore",
"vipValue": [],
"vipVariableName": "user_pubkey_chain_0",
"vipPrimaryKey": [
"usertag"
]
},
"description": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": ""
},
"group": {
"vipType": "constant",
"vipValue": [],
"vipObjectType": "list"
},
"priority-order": [
"name",
"password",
"secret",
"description",
"group",
"pubkey-chain"
]
},
{
"name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "user2",
"vipVariableName": "user_name"
},
"password": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "$6$PyPTaQ==$mWaktr/vdIOlWz/i9z6NkuESZGPlr0KDVOHVwAmmsXjl0YrSXLUegNhi23crgLIe1bEZ5PhUKX6j.kR/ZDJ8d0"
},
"description": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "account1",
"vipVariableName": "user_description"
},
"group": {
"vipType": "constant",
"vipValue": [
{
"vipType": "constant",
"vipValue": "netadmin",
"vipObjectType": "object"
}
],
"vipObjectType": "list",
"vipVariableName": "user_group"
},
"pubkey-chain": {
"vipObjectType": "tree",
"vipType": "ignore",
"vipValue": [],
"vipVariableName": "user_pubkey_chain_1",
"vipPrimaryKey": [
"usertag"
]
},
"priority-order": [
"name",
"password",
"secret",
"description",
"group",
"pubkey-chain"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"name"
]
},
"task": {
"vipType": "constant",
"vipValue": [
{
"name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "task1"
},
"oper-exec": {
"accept": {
"vipObjectType": "tree",
"vipType": "ignore",
"vipValue": [],
"vipPrimaryKey": [
"command"
]
},
"deny": {
"vipObjectType": "tree",
"vipType": "ignore",
"vipValue": [],
"vipPrimaryKey": [
"command"
]
},
"default-action": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "accept",
"vipVariableName": "default_action"
}
},
"config": {
"accept": {
"vipObjectType": "tree",
"vipType": "ignore",
"vipValue": [],
"vipPrimaryKey": [
"command"
]
},
"deny": {
"vipObjectType": "tree",
"vipType": "ignore",
"vipValue": [],
"vipPrimaryKey": [
"command"
]
},
"default-action": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "accept",
"vipVariableName": "default_action"
}
}
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"name"
]
},
"accounting": {
"key": "accounting",
"description": "Enable/disable user accounting",
"details": "Enable/disable user accounting",
"optionType": [
{
"value": "constant",
"display": "Global",
"iconClass": "language",
"iconColor": "icon-global"
},
{
"value": "variable",
"display": "Device Specific",
"iconClass": "router",
"iconColor": "icon-variable"
},
{
"value": "ignore",
"display": "Default",
"iconClass": "check_circle",
"iconColor": "icon-default"
}
],
"originalDefaultOption": "ignore",
"defaultOption": "ignore",
"dataType": {
"type": "boolean",
"default": false
},
"dataPath": [
"aaa"
],
"vipObjectType": "object",
"objectType": "object",
"deleteFlag": false,
"vipValue": "true",
"vipType": "constant",
"vipVariableName": "aaa_accounting"
},
"ciscotacro-user": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": true
},
"ciscotacrw-user": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": true
}
},
"tacacs": {
"timeout": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 5,
"vipVariableName": "tacacs_timeout"
},
"authentication": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "pap",
"vipVariableName": "tacacs_authentication"
},
"server": {
"vipType": "constant",
"vipValue": [
{
"address": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "30.30.30.30",
"vipVariableName": "tacacs_tacacs_address"
},
"auth-port": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 49,
"vipVariableName": "tacacs_tacacs_auth_port"
},
"vpn": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 14,
"vipVariableName": "tacacs_tacacs_vpn"
},
"source-interface": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "GigabitEthernet1/",
"vipVariableName": "tacacs_tacacs_source_interface"
},
"key": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "123456789a",
"vipVariableName": "tacacs_tacacs_key"
},
"secret-key": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "123456789a",
"vipVariableName": "tacacs_tacacs_secret_key"
},
"priority": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 6,
"vipVariableName": "tacacs_tacacs_priority"
},
"priority-order": [
"address",
"auth-port",
"vpn",
"source-interface",
"key",
"secret-key",
"priority"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"address"
]
}
},
"radius": {
"timeout": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 6,
"vipVariableName": "radius_timeout"
},
"retransmit": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 4,
"vipVariableName": "retransmit"
},
"server": {
"vipType": "constant",
"vipValue": [
{
"address": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "20.20.20.20",
"vipVariableName": "radius_radius_address"
},
"tag": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "radis2",
"vipVariableName": "radius_radius_tag"
},
"auth-port": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1812,
"vipVariableName": "radius_radius_auth_port"
},
"acct-port": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1813,
"vipVariableName": "radius_radius_acct_port"
},
"vpn": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 0,
"vipVariableName": "radius_radius_vpn"
},
"source-interface": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "GigabitEthernet0/",
"vipVariableName": "radius_radius_source_interface"
},
"key": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "123456789a",
"vipVariableName": "radius_radius_key"
},
"secret-key": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "123456789a",
"vipVariableName": "radius_radius_secret_key"
},
"priority": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1,
"vipVariableName": "radius_radius_priority"
},
"priority-order": [
"address",
"auth-port",
"vpn",
"source-interface",
"key",
"secret-key",
"priority",
"tag",
"acct-port"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"address"
]
}
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleAaa"
},
"appqoe-example": {
"description": "appqoe-example",
"value": {
"templateName": "AppQoE",
"templateDescription": "template for AppQoE",
"templateType": "appqoe",
"deviceType": [
"vedge-C8000V"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"appnav-controller-group": {
"vipObjectType": "tree",
"vipType": "constant",
"vipValue": [
{
"group-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "ACG-APPQOE"
},
"appnav-controllers": {
"vipObjectType": "tree",
"vipType": "constant",
"vipPrimaryKey": [
"address"
],
"vipValue": [
{
"address": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "10.10.10.10"
},
"vpn": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 512
}
}
]
}
}
],
"vipPrimaryKey": [
"group-name"
]
},
"service-node-group": {
"vipObjectType": "tree",
"vipType": "constant",
"vipValue": [
{
"name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "SNG-APPQOE"
},
"internal": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": false
},
"service-node": {
"vipObjectType": "tree",
"vipType": "constant",
"vipPrimaryKey": [
"address"
],
"vipValue": [
{
"address": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "10.10.11.11"
},
"vpg-ip": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": ""
}
}
]
}
}
],
"vipPrimaryKey": [
"name"
]
},
"service-context": {
"appqoe": {
"vipObjectType": "tree",
"vipType": "constant",
"vipPrimaryKey": [
"name"
],
"vipValue": [
{
"name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "/1"
},
"appnav-controller-group": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "ACG-APPQOE"
},
"service-node-groups": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"SNG-APPQOE"
]
},
"service-node-group": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "SNG-APPQOE"
},
"enable": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "true"
},
"vpn": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 0,
"vipVariableName": "appqoe_vrf"
}
}
]
}
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleAppqoe"
},
"archive-example": {
"description": "archive-example",
"value": {
"templateName": "template_archive",
"templateDescription": "template_archive",
"templateType": "archive",
"deviceType": [
"vedge-cloud"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"archive": {},
"interval": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 6,
"vipVariableName": "archive_interval"
},
"path": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "/tmp/",
"vipVariableName": "archive_path"
},
"ssh-id-file": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "123456789a",
"vipVariableName": "archive_ssh_id_file"
},
"vpn": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 13,
"vipVariableName": "archive_vpn"
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleArchive"
},
"banner-example": {
"description": "banner-example",
"value": {
"templateName": "template_banner",
"templateDescription": "template_banner",
"templateType": "banner",
"deviceType": [
"vedge-cloud"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"login": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "logging_banner",
"vipVariableName": "banner_login"
},
"motd": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "motd_banner",
"vipVariableName": "banner_motd"
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleBanner"
},
"bfd-vedge-example": {
"description": "bfd-vedge-example",
"value": {
"templateName": "template_vedge_cloud",
"templateDescription": "template_vedge_cloud",
"templateType": "bfd-vedge",
"deviceType": [
"vedge-cloud"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"app-route": {
"multiplier": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 6,
"vipVariableName": "bfd_multiplier"
},
"poll-interval": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 3000000,
"vipVariableName": "bfd_poll_interval"
}
},
"default-dscp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 32,
"vipVariableName": "bfd_default_dscp"
},
"color": {
"vipType": "constant",
"vipValue": [
{
"color": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "gold",
"vipVariableName": "bfd_color"
},
"hello-interval": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 2000,
"vipVariableName": "bfd_hello_interval"
},
"multiplier": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 6,
"vipVariableName": "bfd_color_multiplier"
},
"pmtu-discovery": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "bfd_pmtu_discovery"
},
"dscp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 36,
"vipVariableName": "bfd_dscp"
},
"priority-order": [
"color",
"hello-interval",
"multiplier",
"pmtu-discovery",
"dscp"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"color"
]
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleBfdVedge"
},
"bgp-example": {
"description": "bgp-example",
"value": {
"templateName": "template_bgp",
"templateDescription": "template_bgp",
"templateType": "bgp",
"deviceType": [
"vedge-cloud"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"bgp": {
"as-num": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "1",
"vipVariableName": "bgp_as_num"
},
"shutdown": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "false",
"vipVariableName": "bgp_shutdown"
},
"router-id": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "1.1.1.1",
"vipVariableName": "bgp_router_id"
},
"propagate-aspath": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "propagate_aspath"
},
"distance": {
"external": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 18,
"vipVariableName": "routes-distance_external"
},
"internal": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 200,
"vipVariableName": "routes-distance_internal"
},
"local": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 18,
"vipVariableName": "routes-distance_local"
}
},
"timers": {
"keepalive": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 60,
"vipVariableName": "bgp_keepalive"
},
"holdtime": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 180,
"vipVariableName": "bgp_holdtime"
}
},
"best-path": {
"compare-router-id": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "false",
"vipVariableName": "bgp_compare_router_id"
},
"med": {
"always-compare": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "false",
"vipVariableName": "bgp_always_compare"
},
"deterministic": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "false",
"vipVariableName": "bgp_deterministic"
},
"missing-as-worst": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "false",
"vipVariableName": "bgp_missing_as_worst"
}
},
"as-path": {
"multipath-relax": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "false",
"vipVariableName": "bgp_multipath_relax"
}
}
},
"address-family": {
"vipType": "constant",
"vipValue": [
{
"maximum-paths": {
"paths": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 20,
"vipVariableName": "bgp_maximum_paths"
}
},
"family-type": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "ipv4-unicast"
},
"aggregate-address": {
"vipType": "constant",
"vipValue": [
{
"prefix": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "2.2.2.0/24",
"vipVariableName": "bgp_aggregate_aggregate_address_prefix"
},
"as-set": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "bgp_aggregate_as_set"
},
"summary-only": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "bgp_aggregate_summary_only"
},
"priority-order": [
"prefix",
"as-set",
"summary-only"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"prefix"
]
},
"network": {
"vipType": "constant",
"vipValue": [
{
"prefix": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "2.2.2.2/24",
"vipVariableName": "bgp_network_network_address_prefix"
},
"priority-order": [
"prefix"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"prefix"
]
},
"redistribute": {
"vipType": "constant",
"vipValue": [
{
"protocol": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "ospf",
"vipVariableName": "bgp_redistribute_protocol"
},
"route-policy": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "forward",
"vipVariableName": "bgp_redistribute_route_policy"
},
"priority-order": [
"protocol",
"route-policy"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"protocol"
]
},
"priority-order": [
"family-type",
"aggregate-address",
"network",
"maximum-paths",
"redistribute"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"family-type"
]
},
"neighbor": {
"vipType": "ignore",
"vipValue": [],
"vipObjectType": "tree",
"vipPrimaryKey": [
"address"
]
},
"ipv6-neighbor": {
"vipType": "ignore",
"vipValue": [],
"vipObjectType": "tree",
"vipPrimaryKey": [
"address"
]
}
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleBgp"
},
"bridge-example": {
"description": "bridge-example",
"value": {
"templateName": "vedge_bridge",
"templateDescription": "vedge_bridge",
"templateType": "bridge",
"deviceType": [
"vedge-cloud"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"age-time": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 300,
"vipVariableName": "bridge_ageTime"
},
"max-macs": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 2048,
"vipVariableName": "bridge_maxMacs"
},
"name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "B1",
"vipVariableName": "bridge_name"
},
"vlan": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 20,
"vipVariableName": "bridge_vlan"
},
"interface": {
"vipType": "constant",
"vipValue": [
{
"if-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "gi0/0/1",
"vipVariableName": "bridge_if_name"
},
"description": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "DS1",
"vipVariableName": "bridge_description"
},
"native-vlan": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "bridge_native_vlan"
},
"static-mac-address": {
"vipType": "constant",
"vipValue": [
{
"macaddr": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "00:11:22:33:44:55",
"vipVariableName": "bridge_macaddr_0"
},
"priority-order": [
"macaddr"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"macaddr"
]
},
"shutdown": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "false",
"vipVariableName": "bridge_shutdown"
},
"priority-order": [
"if-name",
"description",
"native-vlan",
"static-mac-address",
"shutdown"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"if-name"
]
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleBridge"
},
"cedge_aaa-example": {
"description": "cedge_aaa-example",
"value": {
"templateName": "template_cisco_aaa",
"templateDescription": "template_cisco_aaa",
"templateType": "cedge_aaa",
"deviceType": [
"vedge-C8000V"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"user": {
"vipType": "constant",
"vipValue": [
{
"vipOptional": false,
"name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "admin",
"vipVariableName": "user_name_0"
},
"password": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "$6$RdHS7A==$N0jOegKO7hBvpD.O3fspFjJIWLk3uwoGV.mahG/urlP0A6qNLAfEaumxzOZeDZzHm8GJ4Zu2TfjHNyGZsEw/G.",
"vipVariableName": "user_password1"
},
"secret": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "$9$2F2M4.wG2FQH1k$j8V3jr29Ld7XgVVmUioAtprLSSCa7HGUq6lhQiJdo6I",
"vipVariableName": "password_secret1"
},
"pubkey-chain": {
"vipObjectType": "tree",
"vipType": "ignore",
"vipValue": [],
"vipVariableName": "user_pubkey_chain_0",
"vipPrimaryKey": [
"key-string"
]
},
"privilege": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "15",
"vipVariableName": "user_privilege_0"
},
"priority-order": [
"name",
"password",
"secret",
"pubkey-chain",
"privilege"
]
},
{
"name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "user2",
"vipVariableName": "user_name"
},
"password": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "$6$w14hwQ==$5C0sq9jN7DCflg5cT1SsYgN9vtLemN.NPva5WiejtAoplBcXtEi9dspNbSe5Lor6MArRDHqJJfAqI2Ucodz/Y.",
"vipVariableName": "user_password2"
},
"secret": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "$9$2lEK3FAH3l.D3k$jo4MfjLU9nWLlPWRKR0OUuJ/iI14cozctcMo5Pv7eYs",
"vipVariableName": "password_secret2"
},
"privilege": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "15",
"vipVariableName": "user_privilege"
},
"pubkey-chain": {
"vipObjectType": "tree",
"vipType": "ignore",
"vipValue": [],
"vipVariableName": "user_pubkey_chain_1",
"vipPrimaryKey": [
"key-string"
]
},
"priority-order": [
"name",
"password",
"secret",
"pubkey-chain",
"privilege"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"name"
]
},
"tacacs": {
"vipObjectType": "tree",
"vipPrimaryKey": [
"group-name"
],
"vipType": "constant",
"vipValue": [
{
"group-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "tacacs-512"
},
"vpn": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 512,
"vipVariableName": "tacacs_group_group_vpn"
},
"source-interface": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "GigabitEthernet1/",
"vipVariableName": "tacacs_group_group_source_interface"
},
"server": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
{
"address": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "20.20.20.20"
},
"port": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 49,
"vipVariableName": "tacacs_auth_port"
},
"timeout": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 5,
"vipVariableName": "tacacs_timeout"
},
"key": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "123456789a",
"vipVariableName": "tacacs_key",
"vipNeedsEncryption": "true"
},
"secret-key": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "1543595f507f7d73706a34"
},
"key-enum": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 6
},
"inGroup": {
"vipType": "ignore",
"vipValue": ""
}
}
],
"vipPrimaryKey": [
"address"
]
}
}
]
},
"radius": {
"vipObjectType": "tree",
"vipPrimaryKey": [
"group-name"
],
"vipType": "constant",
"vipValue": [
{
"group-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "radius-0"
},
"vpn": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 0,
"vipVariableName": "radius_group_vpn"
},
"source-interface": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "GigabitEthernet0/",
"vipVariableName": "radius_group_source_interface"
},
"server": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
{
"address": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "10.10.10.10"
},
"auth-port": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1812,
"vipVariableName": "radius_auth_port"
},
"acct-port": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1813,
"vipVariableName": "radius_acct_port"
},
"timeout": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 10,
"vipVariableName": "radius_timeout"
},
"retransmit": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 4,
"vipVariableName": "radius_retransmit"
},
"key": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "123456789a",
"vipNeedsEncryption": "true"
},
"secret-key": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "055a545c7519185e415c16"
},
"key-enum": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 6
},
"key-type": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "key",
"vipVariableName": "radius_radius_key_type"
},
"inGroup": {
"vipType": "ignore",
"vipValue": ""
}
}
],
"vipPrimaryKey": [
"address"
]
}
}
]
},
"accounting": {
"dot1x": {
"default": {
"start-stop": {
"accounting_group": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "dot1x_acct_group"
}
}
}
},
"accounting-rule": {
"vipObjectType": "tree",
"vipType": "constant",
"vipValue": [
{
"rule-id": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "0"
},
"method": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "network",
"vipVariableName": "accounting_method"
},
"level": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "15",
"vipVariableName": "accounting_level"
},
"start-stop": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "accounting_start_stop"
},
"group": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "tacacs-512",
"vipVariableName": "accounting_server"
}
}
],
"vipPrimaryKey": [
"rule-id"
]
}
},
"authorization": {
"authorization-console": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "auth_console"
},
"authorization-config-commands": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "auth_config_cmds"
},
"authorization-rule": {
"vipObjectType": "tree",
"vipType": "constant",
"vipValue": [
{
"rule-id": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "0"
},
"method": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "commands",
"vipVariableName": "authRule_method"
},
"level": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "15",
"vipVariableName": "authRule_level"
},
"group": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "tacacs-512",
"vipVariableName": "authRule_server"
},
"if-authenticated": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "if_auth"
}
}
],
"vipPrimaryKey": [
"rule-id"
]
}
},
"authentication": {
"dot1x": {
"default": {
"authentication_group": {
"key": "authentication_group",
"description": "Authentication Param",
"details": "Authentication configurations parameters",
"optionType": [
{
"value": "constant",
"display": "Global",
"iconClass": "language",
"iconColor": "icon-global"
},
{
"value": "variable",
"display": "Device Specific",
"iconClass": "router",
"iconColor": "icon-variable"
},
{
"value": "ignore",
"display": "Default",
"iconClass": "check_circle",
"iconColor": "icon-default"
}
],
"originalDefaultOption": "ignore",
"defaultOption": "ignore",
"dataType": {
"type": "boolean",
"default": false
},
"dataPath": [
"default"
],
"vipObjectType": "object",
"objectType": "object",
"deleteFlag": false,
"vipValue": "true",
"vipType": "constant",
"vipVariableName": "dot1x_auth_group"
}
}
}
},
"server-auth-order": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "radius-0"
},
"radius-dynamic-author": {
"radius-client": {
"vipObjectType": "tree",
"vipType": "constant",
"vipValue": [
{
"ip": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "192.168.1.111",
"vipVariableName": "radius_coa_ip"
},
"vpn": {
"vipObjectType": "tree",
"vipType": "constant",
"vipValue": [
{
"name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 0,
"vipVariableName": "radiuscoa_vpn_name"
},
"server-key": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "123456789a",
"vipVariableName": "radiuscoa_vpn_key",
"vipNeedsEncryption": "true"
}
}
],
"vipPrimaryKey": [
"name"
]
}
}
],
"vipPrimaryKey": [
"ip"
]
},
"rda-server-key": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "123456789a",
"vipVariableName": "radius_client_server_key",
"vipNeedsEncryption": "true"
},
"domain-stripping": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "yes",
"vipVariableName": "radius_client_domain_stripping"
},
"auth-type": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "all",
"vipVariableName": "radius_client_auth_type"
},
"port": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1700,
"vipVariableName": "radius_client_port"
}
},
"radius-trustsec": {
"cts-auth-list": {
"vipObjectType": "object",
"vipType": "ignore",
"vipVariableName": "trustsec_auth_list"
},
"radius-trustsec-group": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "_empty"
}
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleCedgeAaa"
},
"cedge_global-example": {
"description": "cedge_global-example",
"value": {
"templateName": "template_cedge_global",
"templateDescription": "template_cedge_global",
"templateType": "cedge_global",
"deviceType": [
"vedge-C8000V"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"nat64-global": {
"nat64-timeout": {
"udp-timeout": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 2,
"vipVariableName": "udp_timeout"
},
"tcp-timeout": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 120,
"vipVariableName": "tcp_timeout"
}
}
},
"http-global": {
"http-authentication": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "local",
"vipVariableName": "http_authentication"
}
},
"ssh": {
"version": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 2,
"vipVariableName": "ssh_version"
}
},
"services-global": {
"services-ip": {
"http-server": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "http_server"
},
"https-server": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "https_server"
},
"source-intrf": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "ge1/",
"vipVariableName": "source_interface"
},
"arp-proxy": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "arp_proxy"
},
"ftp-passive": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "ftp_passive"
},
"rcmd": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "rcmd"
},
"domain-lookup": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "domain_lookup"
},
"lldp": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "lldp"
},
"cdp": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "cdp"
},
"line-vty": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "line_vty"
}
},
"services-other": {
"source-route": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "source_route"
},
"bootp": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "bootp"
},
"tcp-keepalives-out": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "tcp_keepalives_out"
},
"tcp-keepalives-in": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "tcp_keepalives_in"
},
"tcp-small-servers": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "tcp_small_servers"
},
"udp-small-servers": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "udp_small_servers"
},
"snmp-ifindex-persist": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "snmp_ifindex_persist"
},
"console-logging": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "console_logging"
},
"vty-logging": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vty_logging"
}
}
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleCedgeGlobal"
},
"cedge_igmp-example": {
"description": "cedge_igmp-example",
"value": {
"templateName": "template_igmp",
"templateDescription": "template_igmp",
"templateType": "cedge_igmp",
"templateMinVersion": "15.0.0",
"transitionInProgress": true,
"viewMode": "add",
"deviceType": [
"vedge-C8000V"
],
"deviceModels": [
{
"name": "vedge-C8000V",
"displayName": "C8000v",
"deviceType": "vedge",
"isCliSupported": true,
"isCiscoDeviceModel": true
}
],
"templateUrl": "/app/configuration/template/feature/templates/cedge_igmp-15.0.0.html",
"removeTableRow": {},
"templateDefinition": {
"igmp": {
"interface": {
"vipType": "constant",
"vipValue": [
{
"name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "GigabitEthernet1",
"vipVariableName": "igmp_interface_name_details"
},
"join-group": {
"vipType": "constant",
"vipValue": [
{
"group-address": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "224.1.1.1",
"vipVariableName": "igmp_interface_group_address_0"
},
"source": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "10.10.10.10",
"vipVariableName": "igmp_interface_source_0"
},
"priority-order": [
"group-address",
"source"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"group-address",
"source"
]
},
"priority-order": [
"name",
"join-group"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"name"
]
}
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleCedgeIgmp"
},
"cedge_multicast-example": {
"description": "cedge_multicast-example",
"value": {
"templateName": "template_multicast",
"templateDescription": "template_multicast",
"templateType": "cedge_multicast",
"deviceType": [
"vedge-C8000V"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"multicast-replicator": {
"local": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "multicast_replicator_local"
},
"threshold": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 180,
"vipVariableName": "multicast_replicator_threshold"
}
},
"multicast": {
"spt-only": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "multicast_replicator_spt"
}
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleCedgeMulticast"
},
"cedge_pim-example": {
"description": "cedge_pim-example",
"value": {
"templateName": "template_pim",
"templateDescription": "template_pim",
"templateType": "cedge_pim",
"deviceType": [
"vedge-C8000V"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"pim": {
"send-rp-discovery": {
"if-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "interface2",
"vipVariableName": "pim_rp_discovery_interface"
},
"scope": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 30,
"vipVariableName": "pim_rp_discovery_scope"
}
},
"auto-rp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "pim_auto_rp"
},
"spt-threshold": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "0",
"vipVariableName": "pim_spt_threshold"
},
"ssm": {
"range": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "AccessList1",
"vipVariableName": "pim_range"
}
},
"bsr-candidate": {
"bsr-interface-name": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "_empty",
"vipVariableName": "pim_bsr_interface"
},
"mask": {
"vipObjectType": "object",
"vipType": "ignore"
},
"priority": {
"vipObjectType": "object",
"vipType": "ignore"
},
"accept-rp-candidate": {
"vipObjectType": "object",
"vipType": "ignore"
}
},
"interface": {
"vipType": "constant",
"vipValue": [
{
"name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "Interface3",
"vipVariableName": "pim_if_name"
},
"query-interval": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 30,
"vipVariableName": "pim_hello_interval"
},
"join-prune-interval": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 60,
"vipVariableName": "pim_join_prune_interval"
},
"priority-order": [
"name",
"query-interval",
"join-prune-interval"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"name"
]
},
"rp-addr": {
"vipType": "constant",
"vipValue": [
{
"address": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "1.1.1.1",
"vipVariableName": "pim_rp_addr_ip"
},
"access-list": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "AccessList2",
"vipVariableName": "pim_rp_addr_access_list"
},
"override": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "pim_rp_addr_override"
},
"priority-order": [
"access-list",
"address",
"override"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"access-list"
]
},
"send-rp-announce": {
"send-rp-announce-list": {
"vipType": "constant",
"vipValue": [
{
"if-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "Interface1",
"vipVariableName": "pim_rp_announce_interface"
},
"scope": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 40,
"vipVariableName": "pim_rp_announce_scope"
},
"priority-order": [
"if-name",
"scope"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"if-name"
]
}
}
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleCedgePim"
},
"cellular-cedge-controller-example": {
"description": "cellular-cedge-controller-example",
"value": {
"deviceType": [
"vedge-ISR-4331"
],
"templateType": "cellular-cedge-controller",
"templateMinVersion": "15.0.0",
"templateDefinition": {
"id": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "cellular_id"
},
"lte": {
"failovertimer": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "cellular_failover_timeout"
},
"firmware": {
"auto-sim": {}
},
"sim": {
"max-retry": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "cellular_failover_retries"
},
"primary": {
"slot": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "cellular_primary_slot"
}
}
}
}
},
"factoryDefault": false,
"templateName": "template_cellular_controller",
"templateDescription": "template_controller"
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleCellularCedgeController"
},
"cellular-cedge-gps-controller-example": {
"description": "cellular-cedge-gps-controller-example",
"value": {
"templateName": "template_gps",
"templateDescription": "template_gps",
"templateType": "cellular-cedge-gps-controller",
"deviceType": [
"vedge-C8000V"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"gps": {
"enable": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "gps_enable"
},
"mode": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "ms-based",
"vipVariableName": "gps_mode"
},
"nmea-conf": {
"nmea": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "gps_nmea"
}
},
"nmea": {
"ip": {
"udp": {
"source-address": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "10.10.10.10",
"vipVariableName": "gps_source_address"
},
"destination-address": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "20.20.20.20",
"vipVariableName": "gps_destination_address"
},
"destination-port": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 4431,
"vipVariableName": "gps_destination_port"
}
}
}
}
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleCellularCedgeGpsController"
},
"cellular-cedge-profile-example": {
"description": "cellular-cedge-profile-example",
"value": {
"deviceType": [
"vedge-ISR-4461"
],
"templateType": "cellular-cedge-profile",
"templateMinVersion": "15.0.0",
"templateDefinition": {
"apn": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "cellular_profile_apn"
},
"authentication": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "cellular_profile_authentication"
},
"id": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "cellular_profile_profile_id"
},
"no-overwrite": {
"vipObjectType": "node-only",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "cellular_profile_no_overwrite"
},
"password": {},
"pdn-type": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "pdn_type"
},
"username": {}
},
"factoryDefault": false,
"templateName": "template_celluar",
"templateDescription": "template_celluar"
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleCellularCedgeProfile"
},
"cellular-gateway-platform-example": {
"description": "cellular-gateway-platform-example",
"value": {
"templateName": "template_cellular_gateway_platform",
"templateDescription": "template_cellular_gateway_platform",
"templateType": "cellular-gateway-platform",
"deviceType": [
"cellular-gateway-CG522-E"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"timezone": {
"time": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "gateway_platform_timezone"
}
},
"interface": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "gateway_platform_interface"
},
"password": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "gateway_platform_password"
},
"controller": {
"cellular": {
"ip-source-violation-action": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "gateway_profile_ip_source_violation_action"
},
"auto-sim": {
"vipObjectType": "node-only",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "gateway_profile_auto_sim"
},
"sim": {
"sim-primary": {
"primary-slot": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "gateway_profile_primary_slot"
},
"failovertimer": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "gateway_profile_failovertimer"
},
"max-retry": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "gateway_profile_max-retry"
}
}
}
}
},
"ntp": {
"vipObjectType": "tree",
"vipType": "constant",
"vipPrimaryKey": [
"name"
],
"vipValue": [
{
"server": {
"name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "192.168.0.100"
}
}
}
]
},
"ip": {
"host": {
"vipType": "constant",
"vipValue": [
{
"hostname": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "vpn_host_hostname"
},
"ip": {
"vipObjectType": "list",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "vpn_host_ip"
},
"priority-order": [
"hostname",
"ip"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"hostname"
]
}
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleCellularGatewayPlatform"
},
"cellular-gateway-profile-example": {
"description": "cellular-gateway-profile-example",
"value": {
"templateName": "template_cellular_gateway_profile",
"templateDescription": "template_cellular_gateway_profile",
"templateType": "cellular-gateway-profile",
"deviceType": [
"cellular-gateway-CG522-E"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"sim-slot-number": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "gateway_profile_sim-slot-number"
},
"attach-profile": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "_empty"
},
"cellular-profile": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "_empty"
},
"profile": {
"vipType": "constant",
"vipValue": [
{
"id": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "cellularprofile_id"
},
"apn": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "cellularprofile_apn"
},
"pdn-type": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "cellularprofile_pdn_type"
},
"authentication": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "cellularprofile_authentication"
},
"username": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "cellularprofile_username"
},
"password": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "cellularprofile_password"
},
"priority-order": [
"id",
"apn",
"pdn-type",
"authentication",
"username",
"password"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"id"
]
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleCellularGatewayProfile"
},
"cellular-profile-example": {
"description": "cellular-profile-example",
"value": {
"templateName": "template_cellular_profile",
"templateDescription": "template_cellular_profile",
"templateType": "cellular-profile",
"deviceType": [
"vedge-1000"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"if-name": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "cellular_if_name_template_cellular_profile"
},
"profile": {
"profile-id": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "profile_id"
},
"apn": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "cellular_apn"
},
"auth": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "None",
"vipVariableName": "cellular-profile_auth"
},
"ip-addr": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "cellular_ip_addr"
},
"name": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "cellular-profile_name"
},
"pdn-type": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "pdn_type"
},
"user-name": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "cellular_user_name"
},
"password": {},
"primary-dns": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "cellular_primary_dns"
},
"secondary-dns": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "cellular_secondary_dns"
},
"user-pass": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "cellular_user_pass"
}
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleCellularProfile"
},
"cisco_banner-example": {
"description": "cisco_banner-example",
"value": {
"deviceType": [
"vedge-C8000V"
],
"templateType": "cisco_banner",
"templateMinVersion": "15.0.0",
"templateDefinition": {
"login": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "login_example",
"vipVariableName": "banner_login"
},
"motd": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "motd_example",
"vipVariableName": "banner_motd"
}
},
"factoryDefault": false,
"templateName": "banner03",
"templateDescription": "banner"
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleCiscoBanner"
},
"cisco_bfd-example": {
"description": "cisco_bfd-example",
"value": {
"templateName": "cisco_bfd",
"templateDescription": "cisco_bfd",
"templateType": "cisco_bfd",
"deviceType": [
"vedge-C8000V"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"app-route": {
"multiplier": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "bfd_multiplier"
},
"poll-interval": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "bfd_poll_interval"
}
},
"default-dscp": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "bfd_default_dscp"
},
"color": {
"vipType": "constant",
"vipValue": [
{
"color": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "bfd_color"
},
"hello-interval": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "bfd_hello_interval"
},
"multiplier": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "bfd_color_multiplier"
},
"pmtu-discovery": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "bfd_pmtu_discovery"
},
"dscp": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "bfd_dscp"
},
"priority-order": [
"color",
"hello-interval",
"multiplier",
"pmtu-discovery",
"dscp"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"color"
]
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleCiscoBfd"
},
"cisco_bgp-example": {
"description": "cisco_bgp-example",
"value": {
"templateName": "template_bgp_c8000v",
"templateDescription": "template_bgp_c8000v",
"templateType": "cisco_bgp",
"deviceType": [
"vedge-C8000V"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"bgp": {
"as-num": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "bgp_as_num"
},
"shutdown": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "bgp_shutdown"
},
"router-id": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "bgp_router_id"
},
"propagate-aspath": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "propagate_aspath"
},
"distance": {
"external": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "routes-distance_external"
},
"internal": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "routes-distance_internal"
},
"local": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "routes-distance_local"
}
},
"timers": {
"keepalive": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 60,
"vipVariableName": "bgp_keepalive"
},
"holdtime": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 180,
"vipVariableName": "bgp_holdtime"
}
},
"best-path": {
"compare-router-id": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "false",
"vipVariableName": "bgp_compare_router_id"
},
"med": {
"always-compare": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "false",
"vipVariableName": "bgp_always_compare"
},
"deterministic": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "false",
"vipVariableName": "bgp_deterministic"
},
"missing-as-worst": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "false",
"vipVariableName": "bgp_missing_as_worst"
}
},
"as-path": {
"multipath-relax": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "false",
"vipVariableName": "bgp_multipath_relax"
}
}
},
"propagate-community": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "propagate_community"
},
"target": {
"route-target-ipv4": {
"vipObjectType": "tree",
"vipType": "ignore",
"vipValue": [],
"vipPrimaryKey": [
"vpn-id"
]
},
"route-target-ipv6": {
"vipObjectType": "tree",
"vipType": "ignore",
"vipValue": [],
"vipPrimaryKey": [
"vpn-id"
]
}
},
"mpls-interface": {
"vipObjectType": "tree",
"vipType": "constant",
"vipValue": [
{
"if-name": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "interface_0"
}
}
],
"vipPrimaryKey": [
"if-name"
]
},
"address-family": {
"vipType": "constant",
"vipValue": [
{
"maximum-paths": {
"paths": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "bgp_maximum_paths"
}
},
"default-information": {
"originate": {
"vipObjectType": "node-only",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "bgp_default_information"
}
},
"family-type": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "ipv4-unicast"
},
"aggregate-address": {
"vipType": "ignore",
"vipValue": [],
"vipObjectType": "tree",
"vipPrimaryKey": [
"prefix"
]
},
"network": {
"vipType": "ignore",
"vipValue": [],
"vipObjectType": "tree",
"vipPrimaryKey": [
"prefix"
]
},
"redistribute": {
"vipType": "ignore",
"vipValue": [],
"vipObjectType": "tree",
"vipPrimaryKey": [
"protocol"
]
},
"table-map": {
"name": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "",
"vipVariableName": "bgp_ipv4-name"
},
"filter": {
"vipObjectType": "node-only",
"vipType": "ignore",
"vipValue": "false",
"vipVariableName": "bgp_ipv4-filter"
}
},
"priority-order": [
"family-type",
"aggregate-address",
"network",
"maximum-paths",
"default-information",
"redistribute",
"table-map"
]
},
{
"maximum-paths": {
"paths": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "bgp_ipv6_ipv6_maximum_paths",
"ipType": "ipv6"
}
},
"default-information": {
"originate": {
"vipObjectType": "node-only",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "bgp_ipv6_ipv6_default_information",
"ipType": "ipv6"
}
},
"family-type": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "ipv6-unicast",
"ipType": "ipv6"
},
"ipv6-aggregate-address": {
"vipType": "ignore",
"vipValue": [],
"vipObjectType": "tree",
"vipPrimaryKey": [
"prefix"
]
},
"ipv6-network": {
"vipType": "ignore",
"vipValue": [],
"vipObjectType": "tree",
"vipPrimaryKey": [
"prefix"
]
},
"redistribute": {
"vipType": "constant",
"vipValue": [
{
"protocol": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "bgp_ipv6_redistribute_protocol_ipv6"
},
"route-policy": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "bgp_ipv6_redistribute_route_policy_ipv6"
},
"priority-order": [
"protocol",
"route-policy"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"protocol"
]
},
"table-map": {
"name": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "",
"vipVariableName": "bgp_ipv6-name",
"ipType": "ipv6"
},
"filter": {
"vipObjectType": "node-only",
"vipType": "ignore",
"vipValue": "false",
"vipVariableName": "bgp_ipv6-filter",
"ipType": "ipv6"
}
},
"priority-order": [
"family-type",
"ipv6-aggregate-address",
"ipv6-network",
"maximum-paths",
"default-information",
"redistribute",
"table-map"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"family-type"
]
},
"neighbor": {
"vipType": "constant",
"vipValue": [
{
"address": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "bgp_neighbor_address"
},
"description": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "bgp_neighbor_description"
},
"shutdown": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "bgp_neighbor_neighbor_shutdown"
},
"remote-as": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "bgp_neighbor_remote_as"
},
"timers": {
"keepalive": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "bgp_neighbor_keepalive_ngbr"
},
"holdtime": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "bgp_neighbor_holdtime_ngbr"
}
},
"update-source": {
"if-name": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "bgp_neighbor_if_name"
}
},
"next-hop-self": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "bgp_neighbor_next_hop_self"
},
"send-community": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "bgp_neighbor_send_community"
},
"send-ext-community": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "bgp_neighbor_send_ext_community"
},
"ebgp-multihop": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "bgp_neighbor_ebgp_multihop"
},
"password": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "bgp_neighbor_password"
},
"send-label": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": ""
},
"send-label-explicit": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": ""
},
"as-override": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": ""
},
"allowas-in": {
"as-number": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": ""
}
},
"address-family": {
"vipType": "ignore",
"vipValue": [],
"vipObjectType": "tree",
"vipPrimaryKey": [
"family-type"
]
},
"allowas-in-check": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "false"
},
"priority-order": [
"address",
"description",
"shutdown",
"remote-as",
"timers",
"update-source",
"next-hop-self",
"send-community",
"send-ext-community",
"ebgp-multihop",
"password",
"address-family"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"address"
]
},
"ipv6-neighbor": {
"vipType": "ignore",
"vipValue": [],
"vipObjectType": "tree",
"vipPrimaryKey": [
"address"
]
}
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleCiscoBgp"
},
"cisco_dhcp_server-example": {
"description": "cisco_dhcp_server-example",
"value": {
"templateName": "template_dhcp_server",
"templateDescription": "template_dhcp_server",
"templateType": "cisco_dhcp_server",
"deviceType": [
"vedge-C8000V"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"address-pool": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "dhcp_address_pool"
},
"exclude": {
"vipObjectType": "list",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "dhcp-address_exclude"
},
"lease-time": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "lease_time"
},
"options": {
"interface-mtu": {
"vipObjectType": "object",
"vipType": "ignore",
"vipVariableName": "dhcp_interface_mtu"
},
"domain-name": {
"vipObjectType": "object",
"vipType": "ignore",
"vipVariableName": "dhcp_domain_name"
},
"default-gateway": {
"vipObjectType": "object",
"vipType": "ignore",
"vipVariableName": "dhcp_default_gateway"
},
"dns-servers": {
"vipObjectType": "list",
"vipType": "ignore",
"vipVariableName": "dhcp_dns_server"
},
"tftp-servers": {
"vipObjectType": "list",
"vipType": "ignore",
"vipVariableName": "tftp-server"
},
"option-code": {
"vipType": "ignore",
"vipValue": [],
"vipObjectType": "tree",
"vipPrimaryKey": [
"code"
]
}
},
"static-lease": {
"vipType": "constant",
"vipValue": [
{
"mac-address": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "dhcp_mac_address"
},
"ip": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "dhcp_ip"
},
"host-name": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "dhcp_hostname"
},
"priority-order": [
"mac-address",
"ip",
"host-name"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"mac-address"
]
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleCiscoDhcpServer"
},
"cisco_dsp_farm-example": {
"description": "cisco_dsp_farm-example",
"value": {
"templateName": "template_dsp_farm",
"templateDescription": "template_dsp_farm",
"templateType": "cisco_dsp_farm",
"deviceType": [
"vedge-ISR-4461"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"media-resource": {
"vipType": "constant",
"vipValue": [
{
"slot-id": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "1/0"
},
"module-type": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "SM-X-PVDM-500"
},
"priority-order": [
"slot-id",
"module-type"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"slot-id"
]
},
"sccp-config": {
"local-interface": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "sscp_config__localinterface"
},
"server-list": {
"vipType": "constant",
"vipValue": [
{
"ip": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "1.1.1.1"
},
"identifier": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 10
},
"priority-order": [
"ip",
"identifier"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"ip"
]
},
"cucm-group": {
"vipType": "constant",
"vipValue": [
{
"cucm-group-id": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 314,
"vipVariableName": "cucmgroupid"
},
"cucm-server-list-priority": {
"vipType": "constant",
"vipValue": [
{
"cucm-server-identifier": {
"vipValue": 10,
"vipType": "constant",
"vipVariableName": "cucmserverid",
"vipObjectType": "object"
},
"cucm-server-ip": {
"vipValue": "1.1.1.1",
"vipType": "constant",
"vipVariableName": "cucmserverip",
"vipObjectType": "object"
},
"cucm-server-priority": {
"vipValue": 1,
"vipType": "constant",
"vipVariableName": "cucmserverpriority",
"vipObjectType": "object"
}
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"cucm-server-identifier"
]
},
"cucm-media-resource-group-list": {
"vipObjectType": "tree",
"vipType": "constant",
"vipValue": [
{
"media-resource-group-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "groupname1",
"vipVariableName": "mediaresourcegroupname"
},
"profile-id": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 604,
"vipVariableName": "profileid"
}
}
],
"vipPrimaryKey": [
"media-resource-group-name"
]
},
"cucm-switchover": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "graceful"
},
"cucm-switchback": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "guard"
},
"priority-order": [
"cucm-group-id",
"cucm-server-list-priority",
"cucm-media-resource-group-list",
"cucm-switchover",
"cucm-switchback"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"cucm-group-id"
]
}
},
"profile": {
"vipType": "constant",
"vipValue": [
{
"profile-id": {
"vipValue": 604,
"vipType": "constant",
"vipVariableName": "profileid",
"vipObjectType": "object"
},
"profile-type": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "conference"
},
"codec": {
"g722-64": {
"vipValue": "false",
"vipType": "constant",
"vipVariableName": "g72264",
"vipObjectType": "object"
},
"g729abr8": {
"vipValue": "true",
"vipType": "constant",
"vipVariableName": "g729abr8",
"vipObjectType": "object"
},
"g729ar8": {
"vipValue": "true",
"vipType": "constant",
"vipVariableName": "g729ar8",
"vipObjectType": "object"
},
"g729br8": {
"vipValue": "true",
"vipType": "constant",
"vipVariableName": "g729br8",
"vipObjectType": "object"
},
"g729r8": {
"vipValue": "true",
"vipType": "constant",
"vipVariableName": "g729r8",
"vipObjectType": "object"
},
"g711alaw": {
"vipValue": "true",
"vipType": "constant",
"vipVariableName": "g711alaw",
"vipObjectType": "object"
},
"g711ulaw": {
"vipValue": "true",
"vipType": "constant",
"vipVariableName": "g711ulaw",
"vipObjectType": "object"
}
},
"max-session": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 4
},
"application": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "sccp"
},
"shutdown": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "false",
"vipVariableName": "uc_shutdown"
},
"conference-max-participants": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 8
}
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"profile-id"
]
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleCiscoDspFarm"
},
"cisco_logging-example": {
"description": "cisco_logging-example",
"value": {
"templateName": "template_cisco_logging",
"templateDescription": "template_cisco_logging",
"templateType": "cisco_logging",
"deviceType": [
"vedge-C8000V"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"disk": {
"enable": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "logging_disk_enable"
},
"file": {
"size": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "logging_max_file_size"
},
"rotate": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "logging_disk_rotation"
}
}
},
"tls-profile": {
"vipType": "constant",
"vipValue": [
{
"profile": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "tls_profile_profile"
},
"tls-version": {
"version": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "version"
}
},
"auth-type": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "Server"
},
"ciphersuite": {
"ciphersuite-list": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "tls_profile_ciphersuite_list"
}
},
"priority-order": [
"profile",
"tls-version",
"auth-type",
"ciphersuite"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"profile"
]
},
"server": {
"vipType": "constant",
"vipValue": [
{
"name": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "logging_server_name"
},
"vpn": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "logging_server_vpn"
},
"source-interface": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "logging_server_source_interface"
},
"priority": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "logging_server_server_cisco_priority"
},
"tls": {
"enable-tls": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "logging_server_enable_tls"
},
"tls-properties": {
"custom-profile": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "false",
"vipVariableName": "logging_server_custom_profile_0"
},
"profile": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "_empty",
"vipVariableName": "logging_server_profile_0"
}
}
},
"priority-order": [
"name",
"vpn",
"source-interface",
"priority",
"tls"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"name"
]
},
"ipv6-server": {
"vipType": "constant",
"vipValue": [
{
"name": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "logging_ipv6_server_name_ipv6"
},
"vpn": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "logging_ipv6_server_vpn_ipv6"
},
"source-interface": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "logging_ipv6_server_source_interface_ipv6"
},
"priority": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "logging_ipv6_server_server_cisco_priority_ipv6"
},
"tls": {
"enable-tls": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "logging_ipv6_server_enable_tls_ipv6"
},
"tls-properties": {
"custom-profile": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "false",
"vipVariableName": "logging_server_custom_profile_0"
},
"profile": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "_empty",
"vipVariableName": "logging_server_profile_0"
}
}
},
"priority-order": [
"name",
"vpn",
"source-interface",
"priority",
"tls"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"name"
]
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleCiscoLogging"
},
"cisco_ntp-example": {
"description": "cisco_ntp-example",
"value": {
"templateName": "template_cisco_ntp",
"templateDescription": "template_cisco_ntp",
"templateType": "cisco_ntp",
"deviceType": [
"vedge-C8000V"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"master": {
"enable": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "enable"
},
"stratum": {},
"source": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "source"
}
},
"keys": {
"trusted": {
"vipObjectType": "list",
"vipType": "ignore",
"vipVariableName": "trusted_key"
},
"authentication": {
"vipType": "constant",
"vipValue": [
{
"number": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "ntp_auth_ntp_auth_number"
},
"md5": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "ntp_auth_md5"
},
"priority-order": [
"number",
"md5"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"number"
]
}
},
"server": {
"vipType": "constant",
"vipValue": [
{
"name": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "ntp_server_name"
},
"key": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "ntp_server_server_auth_key"
},
"vpn": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "ntp_server_vpn"
},
"version": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "ntp_server_version"
},
"source-interface": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "ntp_server_source_interface"
},
"prefer": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "ntp_server_prefer"
},
"priority-order": [
"name",
"key",
"vpn",
"version",
"source-interface",
"prefer"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"name"
]
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleCiscoNtp"
},
"cisco_omp-example": {
"description": "cisco_omp-example",
"value": {
"templateName": "template_cisco_omp",
"templateDescription": "template_cisco_omp",
"templateType": "cisco_omp",
"deviceType": [
"vedge-C8000V"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"graceful-restart": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "omp_graceful_restart"
},
"send-path-limit": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "omp_send_path_limit"
},
"overlay-as": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "overlay_as"
},
"ecmp-limit": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "omp_ecmp_limit"
},
"shutdown": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "omp_shutdown"
},
"timers": {
"advertisement-interval": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "omp_advertisement_interval"
},
"graceful-restart-timer": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "omp_graceful_restart_timer"
},
"holdtime": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "omp_holdtime"
},
"eor-timer": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "omp_eor_timer"
}
},
"omp-admin-distance-ipv4": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "vpn_omp-admin-distance-ipv4"
},
"omp-admin-distance-ipv6": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "vpn_omp-admin-distance-ipv6"
},
"advertise": {
"vipType": "constant",
"vipValue": [
{
"priority-order": [
"protocol"
],
"protocol": {
"vipType": "constant",
"vipValue": "bgp",
"vipObjectType": "object"
}
},
{
"priority-order": [
"protocol",
"route"
],
"protocol": {
"vipType": "constant",
"vipValue": "ospf",
"vipObjectType": "object"
},
"route": {
"vipType": "constant",
"vipValue": "external",
"vipObjectType": "object"
}
},
{
"priority-order": [
"protocol"
],
"protocol": {
"vipType": "constant",
"vipValue": "connected",
"vipObjectType": "object"
}
},
{
"priority-order": [
"protocol"
],
"protocol": {
"vipType": "constant",
"vipValue": "static",
"vipObjectType": "object"
}
},
{
"priority-order": [
"protocol"
],
"protocol": {
"vipType": "constant",
"vipValue": "eigrp",
"vipObjectType": "object"
}
},
{
"priority-order": [
"protocol"
],
"protocol": {
"vipType": "constant",
"vipValue": "lisp",
"vipObjectType": "object"
}
},
{
"priority-order": [
"protocol"
],
"protocol": {
"vipType": "constant",
"vipValue": "isis",
"vipObjectType": "object"
}
},
{
"priority-order": [
"protocol"
],
"protocol": {
"vipType": "constant",
"vipValue": "ospfv3",
"vipObjectType": "object"
}
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"protocol"
]
},
"ipv6-advertise": {
"vipType": "constant",
"vipValue": [
{
"priority-order": [
"protocol"
],
"protocol": {
"vipType": "constant",
"vipValue": "bgp",
"vipObjectType": "object"
}
},
{
"priority-order": [
"protocol"
],
"protocol": {
"vipType": "constant",
"vipValue": "connected",
"vipObjectType": "object"
}
},
{
"priority-order": [
"protocol"
],
"protocol": {
"vipType": "constant",
"vipValue": "static",
"vipObjectType": "object"
}
},
{
"priority-order": [
"protocol"
],
"protocol": {
"vipType": "constant",
"vipValue": "eigrp",
"vipObjectType": "object"
}
},
{
"priority-order": [
"protocol"
],
"protocol": {
"vipType": "constant",
"vipValue": "lisp",
"vipObjectType": "object"
}
},
{
"priority-order": [
"protocol"
],
"protocol": {
"vipType": "constant",
"vipValue": "isis",
"vipObjectType": "object"
}
},
{
"priority-order": [
"protocol",
"route"
],
"protocol": {
"vipType": "constant",
"vipValue": "ospf",
"vipObjectType": "object"
},
"route": {
"vipType": "constant",
"vipValue": "external",
"vipObjectType": "object"
}
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"protocol"
]
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleCiscoOmp"
},
"cisco_ospf-example": {
"description": "cisco_ospf-example",
"value": {
"templateName": "template_cisco_ospf",
"templateDescription": "template_cisco_ospf",
"templateType": "cisco_ospf",
"deviceType": [
"vedge-C8000V"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"ospf": {
"router-id": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "ospf_router_id"
},
"auto-cost": {
"reference-bandwidth": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "ospf_reference_bandwidth"
}
},
"compatible": {
"rfc1583": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "ospf_rfc1583"
}
},
"distance": {
"external": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "ospf_distance_external"
},
"inter-area": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "ospf_distance_inter_area"
},
"intra-area": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "ospf_distance_intra_area"
}
},
"timers": {
"spf": {
"delay": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 200,
"vipVariableName": "ospf_delay"
},
"initial-hold": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "ospf_initial_hold"
},
"max-hold": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "ospf_max_hold"
}
}
},
"route-policy": {
"vipType": "constant",
"vipValue": [
{
"direction": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "in"
},
"pol-name": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "ospf_pol_name"
},
"priority-order": [
"direction",
"pol-name"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"direction"
]
},
"redistribute": {
"vipType": "constant",
"vipValue": [
{
"protocol": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "ospf_redistribute_protocol"
},
"route-policy": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "ospf_redistribute_route_policy"
},
"priority-order": [
"protocol",
"route-policy"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"protocol"
]
},
"max-metric": {
"router-lsa": {
"vipType": "constant",
"vipValue": [
{
"ad-type": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "on-startup"
},
"time": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "ospf_router_lsa_time"
},
"priority-order": [
"ad-type",
"time"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"ad-type"
]
}
},
"area": {
"vipType": "constant",
"vipValue": [
{
"a-num": {
"originalDefaultOption": "constant",
"dataPath": [],
"vipObjectType": "object",
"vipValue": "",
"vipType": "variableName",
"vipVariableName": "ospf_area_a_num"
},
"nssa": {
"no-summary": {
"vipType": "variableName",
"vipObjectType": "node-only",
"vipVariableName": "ospf_area_no_summary"
}
},
"priority-order": [
"a-num",
"nssa"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"a-num"
]
}
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleCiscoOspf"
},
"cisco_ospfv3-example": {
"description": "cisco_ospfv3-example",
"value": {
"templateName": "template_ospfv3",
"templateDescription": "template_ospfv3",
"templateType": "cisco_ospfv3",
"deviceType": [
"vedge-C8000V"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"ospfv3": {
"address-family": {
"ipv4": {
"router-id": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "ospfv3_router_id"
},
"auto-cost": {
"reference-bandwidth": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 100,
"vipVariableName": "ospfv3_reference_bandwidth"
}
},
"distance-ipv4": {
"distance": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "ospfv3_distance_distance"
},
"ospf": {
"external": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "ospfv3_distance_external"
},
"inter-area": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "ospfv3_distance_inter_area"
},
"intra-area": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "ospfv3_distance_intra_area"
}
}
},
"table-map": {
"name": {
"vipObjectType": "object",
"vipType": "ignore",
"vipVariableName": "ospfv3_distance_name"
}
},
"compatible": {
"rfc1583": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "ospfv3_rfc1583"
}
},
"timers": {
"throttle": {
"spf": {
"delay": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 200,
"vipVariableName": "ospfv3_delay"
},
"initial-hold": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 1000,
"vipVariableName": "ospfv3_initial_hold"
},
"max-hold": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 10000,
"vipVariableName": "ospfv3_max_hold"
}
}
}
},
"redistribute": {
"vipType": "constant",
"vipValue": [
{
"protocol": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "ospf_redistribute_protocol"
},
"route-policy": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "ospf_redistribute_route_policy"
},
"priority-order": [
"protocol",
"route-policy"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"protocol"
]
},
"max-metric": {
"router-lsa": {
"vipType": "constant",
"vipValue": [
{
"ad-type": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "on-startup"
},
"time": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "ospf_router_lsa_time"
},
"priority-order": [
"ad-type",
"time"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"ad-type"
]
}
}
},
"ipv6": {
"router-id": {
"vipObjectType": "object",
"vipType": "ignore",
"vipVariableName": "ospfv3_router_id_ipv6"
},
"auto-cost": {
"reference-bandwidth": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 100,
"vipVariableName": "ospfv3_reference_bandwidth_ipv6"
}
},
"distance-ipv4": {
"distance": {},
"ospf": {
"external": {},
"inter-area": {},
"intra-area": {}
}
},
"table-map": {
"name": {
"vipObjectType": "object",
"vipType": "ignore",
"vipVariableName": "ospfv3_distance_name_ipv6"
}
},
"compatible": {
"rfc1583": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "ospfv3_rfc1583_ipv6"
}
},
"distance-ipv6": {
"ospf": {
"external": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 110,
"vipVariableName": "ospfv3_distance_external_ipv6"
},
"inter-area": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 110,
"vipVariableName": "ospfv3_distance_inter_area_ipv6"
},
"intra-area": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 110,
"vipVariableName": "ospfv3_distance_intra_area_ipv6"
}
},
"distance": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 110,
"vipVariableName": "ospfv3_distance_distance_ipv6"
}
},
"timers": {
"throttle": {
"spf": {
"delay": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 200,
"vipVariableName": "ospfv3_delay_ipv6"
},
"initial-hold": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 1000,
"vipVariableName": "ospfv3_initial_hold_ipv6"
},
"max-hold": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 10000,
"vipVariableName": "ospfv3_max_hold_ipv6"
}
}
}
},
"max-metric": {
"router-lsa": {
"vipType": "ignore",
"vipValue": [],
"vipObjectType": "tree",
"vipPrimaryKey": [
"ad-type"
]
}
}
}
}
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleCiscoOspfv3"
},
"cisco_secure_internet_gateway-example": {
"description": "cisco_secure_internet_gateway-example",
"value": {
"templateName": "secure_internet_gateway",
"templateDescription": "secure_internet_gateway",
"templateType": "cisco_secure_internet_gateway",
"deviceType": [
"vedge-C8000V"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"vpn-id": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 0
},
"interface": {
"vipType": "constant",
"vipValue": [
{
"if-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "ipsec1",
"vipVariableName": "tunnel_if_name"
},
"auto": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true"
},
"shutdown": {
"vipObjectType": "object",
"vipType": "notIgnore",
"vipValue": "false",
"vipVariableName": "tunnel_shutdown"
},
"description": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "tunnel_description"
},
"ip": {
"unnumbered": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "true"
}
},
"tunnel-source-interface": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "GigabitEthernet1",
"vipVariableName": "tunnel_tunnel_source_interface"
},
"tunnel-destination": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "dynamic"
},
"application": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "sig"
},
"tunnel-set": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "secure-internet-gateway-umbrella"
},
"tunnel-dc-preference": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "primary-dc"
},
"tcp-mss-adjust": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 1300,
"vipVariableName": "tunnel_tcp_mss_adjust_"
},
"mtu": {
"vipObjectType": "object",
"vipType": "notIgnore",
"vipValue": 1400,
"vipVariableName": "tunnel_mtu_"
},
"dead-peer-detection": {
"dpd-interval": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 10,
"vipVariableName": "tunnel_dpd_interval"
},
"dpd-retries": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 3,
"vipVariableName": "tunnel_dpd_retries"
}
},
"ike": {
"ike-version": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 2
},
"authentication-type": {
"pre-shared-key-dynamic": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "true"
}
},
"ike-rekey-interval": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 14400,
"vipVariableName": "tunnel_ike_rekey_interval_"
},
"ike-ciphersuite": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "aes256-cbc-sha1",
"vipVariableName": "tunnel_ike_ciphersuite"
},
"ike-group": {
"vipObjectType": "object",
"vipType": "notIgnore",
"vipValue": "14",
"vipVariableName": "tunnel_ike_group"
}
},
"ipsec": {
"ipsec-rekey-interval": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 720,
"vipVariableName": "tunnel_ipsec_rekey_interval"
},
"ipsec-replay-window": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1024,
"vipVariableName": "tunnel_ipsec_replay_window"
},
"ipsec-ciphersuite": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "aes256-cbc-sha1",
"vipVariableName": "tunnel_ipsec_ciphersuite"
},
"perfect-forward-secrecy": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "tunnel_perfect_forward_secrecy"
}
},
"tracker": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "tracker2"
},
"track-enable": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true"
}
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"if-name"
]
},
"service": {
"vipType": "constant",
"vipValue": [
{
"svc-type": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "sig"
},
"ha-pairs": {
"interface-pair": {
"vipType": "constant",
"vipObjectType": "tree",
"vipPrimaryKey": [
"active-interface",
"backup-interface"
],
"vipValue": [
{
"active-interface": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "ipsec1"
},
"backup-interface": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "None"
},
"active-interface-weight": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 10
},
"backup-interface-weight": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1
},
"priority-order": [
"active-interface",
"backup-interface",
"active-interface-weight",
"backup-interface-weight"
]
}
]
}
},
"umbrella-data-center": {
"data-center-primary": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "vpn_umbprimarydc"
},
"data-center-secondary": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "vpn_umbsecondarydc"
}
}
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"svc-type"
]
},
"tracker-src-ip": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "vpn_trackersrcip"
},
"tracker": {
"vipType": "constant",
"vipValue": [
{
"name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "tracker2",
"vipVariableName": "tracker_name"
},
"endpoint-api-url": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "https://dns.org",
"vipVariableName": "tracker_endpoint-api-url"
},
"threshold": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 600,
"vipVariableName": "tracker_threshold"
},
"interval": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 120,
"vipVariableName": "tracker_interval"
},
"multiplier": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 6,
"vipVariableName": "tracker_multiplier"
},
"tracker-type": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "SIG"
},
"priority-order": [
"tracker-type",
"name",
"endpoint-api-url",
"threshold",
"interval",
"multiplier"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"tracker-type",
"name"
]
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleCiscoSecureInternetGateway"
},
"cisco_security-example": {
"description": "cisco_security-example",
"value": {
"templateName": "template_security",
"templateDescription": "template_security",
"templateType": "cisco_security",
"deviceType": [
"vedge-C8000V"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"ipsec": {
"rekey": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 86400,
"vipVariableName": "security_rekey"
},
"replay-window": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "512",
"vipVariableName": "security_replay_window"
},
"extended-ar-window": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 256,
"vipVariableName": "security_extended-ar-window"
},
"authentication-type": {
"vipType": "constant",
"vipValue": [
"sha1-hmac",
"ah-sha1-hmac",
"ah-no-id"
],
"vipObjectType": "list",
"vipVariableName": "security_authenticationType"
},
"integrity-type": {
"vipType": "constant",
"vipValue": [
"esp",
"ip-udp-esp",
"ip-udp-esp-no-id"
],
"vipObjectType": "list"
},
"pairwise-keying": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "security_pairwise_keying"
}
},
"trustsec": {
"keychain": {
"vipType": "constant",
"vipValue": [
{
"name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "keychain_zyp"
},
"keyid": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1
}
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"name",
"keyid"
]
}
},
"key": {
"vipType": "constant",
"vipValue": [
{
"id": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1
},
"chain-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "keychain_zyp"
},
"send-id": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1,
"vipVariableName": "key_send-id"
},
"recv-id": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1,
"vipVariableName": "key_receiver-id"
},
"cryptographic-algorithm-choice": {
"tcp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "aes-128-cmac"
}
},
"key-string": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "123456789A",
"vipVariableName": "key_key-string"
},
"send-lifetime": {
"lifetime-group-v1": {
"end-choice": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "infinite"
},
"local": {
"vipType": "constant",
"vipObjectType": "node-only",
"vipValue": "false"
},
"start-epoch": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1627824420
},
"infinite": {
"vipType": "constant",
"vipObjectType": "node-only",
"vipValue": "true"
}
}
},
"accept-lifetime": {
"lifetime-group-v1": {
"end-choice": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "infinite",
"vipVariableName": "key_accept-lifetime-end-format"
},
"local": {
"vipType": "constant",
"vipObjectType": "node-only",
"vipValue": "true"
},
"start-epoch": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1627824480
},
"infinite": {
"vipType": "constant",
"vipObjectType": "node-only",
"vipValue": "true"
}
}
},
"include-tcp-options": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "key_include-tcp-options"
},
"accept-ao-mismatch": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "key_accept-ao-mismatch"
}
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"chain-name",
"id"
]
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleCiscoSecurity"
},
"cisco_sig_credential-example": {
"description": "cisco_sig_credential-example",
"value": {
"templateName": "template_SIG_Credentials",
"templateDescription": "template_SIG_Credentials",
"templateType": "cisco_sig_credentials",
"deviceType": [
"vedge-C8000V"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"umbrella": {
"api-key": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "123456789a",
"vipVariableName": "system_api_key"
},
"api-secret": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "123456789a",
"vipVariableName": "system_api_secret",
"vipNeedsEncryption": true
},
"org-id": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "SIG",
"vipVariableName": "system_org_id"
}
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleCiscoSigCredentials"
},
"cisco_snmp-example": {
"description": "cisco_snmp-example",
"value": {
"templateName": "cisco_snmp",
"templateDescription": "template for cisco snmp",
"templateType": "cisco_snmp",
"deviceType": [
"vedge-C8000V"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"shutdown": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "false",
"vipVariableName": "snmp_shutdown"
},
"contact": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "jefrey",
"vipVariableName": "snmp_contact"
},
"name": {},
"location": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "shanghai",
"vipVariableName": "snmp_device_location"
},
"view": {
"vipType": "constant",
"vipValue": [
{
"name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "snmpView"
},
"oid": {
"vipType": "constant",
"vipValue": [
{
"id": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "snmp_view_id_0"
},
"exclude": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "snmp_view_exclude_0"
},
"priority-order": [
"id",
"exclude"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"id"
]
},
"priority-order": [
"name",
"oid"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"name"
]
},
"community": {
"vipType": "constant",
"vipValue": [
{
"name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "c1",
"vipNeedsEncryption": "true"
},
"view": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "snmpView",
"vipVariableName": "snmp_community_view"
},
"authorization": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "read-only",
"vipVariableName": "snmp_community_authorization"
},
"priority-order": [
"name",
"authorization",
"view"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"name"
]
},
"trap": {
"target": {
"vipType": "constant",
"vipValue": [
{
"vpn-id": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 111,
"vipVariableName": "snmp_trap_vpn_id"
},
"ip": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "10.10.10.10",
"vipVariableName": "snmp_trap_ip"
},
"port": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 2000,
"vipVariableName": "snmp_trap_port"
},
"community-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "c1",
"vipVariableName": "snmp_trap_community_name",
"vipNeedsEncryption": "true"
},
"user": {},
"source-interface": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "GigabitEthernet1",
"vipVariableName": "snmp_trap_source_interface"
},
"users": {
"vipObjectType": "object",
"vipType": "constant"
},
"priority-order": [
"vpn-id",
"ip",
"port",
"community-name",
"source-interface"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"vpn-id",
"ip",
"port"
]
}
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleCiscoSnmp"
},
"cisco_system-example": {
"description": "cisco_system-example",
"value": {
"templateName": "template_cisco_system",
"templateDescription": "template_cisco_system",
"templateType": "cisco_system",
"deviceType": [
"vedge-C8000V"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"clock": {
"timezone": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "Asia/Shanghai",
"vipVariableName": "system_timezone"
}
},
"gps-location": {
"latitude": {
"vipObjectType": "object",
"vipType": "ignore",
"vipVariableName": "system_latitude"
},
"longitude": {
"vipObjectType": "object",
"vipType": "ignore",
"vipVariableName": "system_longitude"
}
},
"location": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "shanghai",
"vipVariableName": "system_location"
},
"track-transport": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "system_track_transport"
},
"track-interface-tag": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1,
"vipVariableName": "system_track_interface_tag"
},
"port-offset": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1,
"vipVariableName": "system_port_offset"
},
"port-hop": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "system_port_hop"
},
"control-session-pps": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 600,
"vipVariableName": "system_control_session_pps"
},
"description": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "description1",
"vipVariableName": "system_description"
},
"device-groups": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"11"
],
"vipVariableName": "system_device_groups"
},
"controller-group-list": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"12"
],
"vipVariableName": "system_controller_group_list"
},
"site-id": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 100,
"vipVariableName": "system_site_id"
},
"overlay-id": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1,
"vipVariableName": "system_overlay_id"
},
"system-ip": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "172.16.255.15"
},
"host-name": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "host_zzz"
},
"console-baud-rate": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "115200",
"vipVariableName": "system_console_baud_rate"
},
"max-omp-sessions": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 16,
"vipVariableName": "system_max_omp_sessions"
},
"track-default-gateway": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "system_track_default_gateway"
},
"idle-timeout": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 60,
"vipVariableName": "system_idle-timeout"
},
"admin-tech-on-failure": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "system_admin_tech_on_failure"
},
"multi-tenant": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "system_multi-tenant"
},
"on-demand": {
"enable": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "system_on-demand-enable"
},
"idle-timeout": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 5,
"vipVariableName": "system_on-demand-idle-timeout"
}
},
"tracker": {
"vipType": "constant",
"vipValue": [
{
"name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "tracker1",
"vipVariableName": "tracker_name"
},
"endpoint-ip": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "10.10.10.10",
"vipVariableName": "tracker_endpoint-ip"
},
"threshold": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 600,
"vipVariableName": "tracker_threshold"
},
"interval": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 120,
"vipVariableName": "tracker_interval"
},
"multiplier": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 6,
"vipVariableName": "tracker_multiplier"
},
"type": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "interface",
"vipVariableName": "tracker_tracker_type"
},
"priority-order": [
"name",
"endpoint-ip",
"endpoint-dns-name",
"endpoint-api-url",
"threshold",
"interval",
"multiplier",
"type"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"name"
]
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleCiscoSystem"
},
"cisco_thousandeye-example": {
"description": "cisco_thousandeye-example",
"value": {
"templateName": "ThousandEyesAgent",
"templateDescription": "ThousandEyesAgent",
"templateType": "cisco_thousandeyes",
"deviceType": [
"vedge-ISR-4461"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"virtual-application": {
"vipType": "constant",
"vipValue": [
{
"instance-id": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "835d52c5-fdcf-4047-afa5-0f70b99b6188",
"vipVariableName": "instance_id"
},
"application-type": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "te",
"vipVariableName": "application_type"
},
"te": {
"token": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "aabbccddee",
"vipVariableName": "thousandeyes_token",
"vipNeedsEncryption": "true"
},
"vpn": {
"vipObjectType": "object",
"vipType": "ignore",
"vipVariableName": "thousandeyes_vpn"
},
"name-server": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "thousandeyes_name_server"
},
"hostname": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "host_zyp",
"vipVariableName": "thousandeyes_hostname"
},
"proxy_type": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "static",
"vipVariableName": "thousandeyes_proxy_type"
},
"proxy_static": {
"proxy_host": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "20.20.20,20",
"vipVariableName": "thousandeyes_proxy_host"
},
"proxy_port": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 2000,
"vipVariableName": "thousandeyes_proxy_port"
}
},
"proxy_pac": {
"pac_url": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "thousandeyes_pac_url"
}
}
},
"priority-order": [
"instance-id",
"application-type",
"te"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"instance-id"
]
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleCiscoThousandeyes"
},
"cisco_trustsec-example": {
"description": "cisco_trustsec-example",
"value": {
"templateName": "template_trustsec",
"templateDescription": "template_trustsec",
"templateType": "cisco_trustsec",
"deviceType": [
"vedge-CSR-1000v"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"sxp-default": {
"enable-sxp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "sxp_default_enable_sxp"
},
"sxp-source-ip": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "10.10.10.23",
"vipVariableName": "sxp_default_source_ip"
},
"sxp-default-password": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "123456789a",
"vipVariableName": "sxp_default_password",
"vipNeedsEncryption": "true"
},
"sxp-key-chain": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "chain1",
"vipVariableName": "sxp_default_key_chain"
},
"sxp-log-binding-changes": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "sxp_default_log_binding"
},
"sxp-reconciliation-period": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 180,
"vipVariableName": "sxp_default_reconciliation_period"
},
"sxp-retry-period": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 180,
"vipVariableName": "sxp_default_retry_period"
},
"speaker-hold-time": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 180,
"vipVariableName": "sxp_default_speaker_hold_time"
},
"listener-hold-time-min": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 90,
"vipVariableName": "sxp_default_listener_hold_time_min"
},
"listener-hold-time-max": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 240,
"vipVariableName": "sxp_default_listener_hold_time_max"
},
"sxp-node-id-type": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "ip"
},
"sxp-node-id": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "1.1.1.1",
"vipVariableName": "sxp_default_node_id"
}
},
"device-sgt": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "trustsec_device_sgt"
},
"credentials-id": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "1",
"vipVariableName": "trustsec_credentials_id"
},
"credentials-password": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "aabbccddee",
"vipVariableName": "trustsec_credentials_pwd",
"vipNeedsEncryption": "true"
},
"enable-enforcement": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "trustsec_enable_enforcement"
},
"sxp-connection-list": {
"vipType": "constant",
"vipValue": [
{
"connection-peer-ip": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "2.2.2.2"
},
"connection-source-ip": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "2.2.2.5",
"vipVariableName": "sxp-connection_source-ip"
},
"connection-preshared-key": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "default"
},
"connection-mode": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "local"
},
"connection-mode-type": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "speaker"
},
"connection-min-hold-time": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 180,
"vipVariableName": "sxp-connection_min-hold-time"
},
"connection-max-hold-time": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 0,
"vipVariableName": "sxp-connection_max-hold-time_0"
},
"connection-vpn-id": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 24,
"vipVariableName": "sxp-connection_vpn-id"
},
"priority-order": [
"connection-peer-ip",
"connection-source-ip",
"connection-preshared-key",
"connection-mode",
"connection-mode-type",
"connection-min-hold-time",
"connection-max-hold-time",
"connection-vpn-id"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"connection-peer-ip"
]
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleCiscoTrustsec"
},
"cisco_vp-example": {
"description": "cisco_vp-example",
"value": {
"templateName": "template_cisco_vpn",
"templateDescription": "template_cisco_vpn",
"templateType": "cisco_vpn",
"deviceType": [
"vedge-C8000V"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"vpn-id": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 13
},
"name": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "vpn_name"
},
"ecmp-hash-key": {
"layer4": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_layer4"
}
},
"nat64-global": {
"prefix": {
"stateful": {}
}
},
"nat64": {
"v4": {
"pool": {
"vipType": "ignore",
"vipValue": [],
"vipObjectType": "tree",
"vipPrimaryKey": [
"name"
]
}
}
},
"tenant-vpn-id": {},
"org-name": {},
"omp-admin-distance-ipv4": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "vpn_omp-admin-distance-ipv4"
},
"omp-admin-distance-ipv6": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "vpn_omp-admin-distance-ipv6"
},
"nat": {
"natpool": {
"vipType": "constant",
"vipValue": [
{
"name": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "vpn_nat_pool_name"
},
"prefix-length": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "vpn_nat_prefix_length"
},
"range-start": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "vpn_nat_range_start"
},
"range-end": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "vpn_nat_range_end"
},
"overload": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "vpn_nat_pool_overload"
},
"direction": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "outside",
"vipVariableName": "vpn_nat_direction"
},
"priority-order": [
"name",
"prefix-length",
"range-start",
"range-end",
"overload",
"direction"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"name"
]
},
"port-forward": {
"vipType": "ignore",
"vipValue": [],
"vipObjectType": "tree",
"vipPrimaryKey": [
"source-port",
"translate-port",
"source-ip",
"translate-ip",
"proto"
]
},
"static": {
"vipType": "ignore",
"vipValue": [],
"vipObjectType": "tree",
"vipPrimaryKey": [
"source-ip",
"translate-ip"
]
}
},
"dns": {
"vipType": "constant",
"vipValue": [
{
"role": {
"vipType": "constant",
"vipValue": "primary",
"vipObjectType": "object"
},
"dns-addr": {
"vipType": "constant",
"vipValue": "1.1.1.1",
"vipObjectType": "object"
},
"priority-order": [
"dns-addr",
"role"
]
},
{
"role": {
"vipType": "constant",
"vipValue": "secondary",
"vipObjectType": "object"
},
"dns-addr": {
"vipType": "constant",
"vipValue": "2.2.2.2",
"vipObjectType": "object"
},
"priority-order": [
"dns-addr",
"role"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"dns-addr"
]
},
"route-import": {
"vipType": "constant",
"vipValue": [
{
"protocol": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "bgp",
"vipVariableName": "route_leak_from_proto"
},
"protocol-sub-type": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": "external",
"vipVariableName": "route_leak_from_proto_sub"
},
"redistribute": {
"vipValue": [],
"vipType": "ignore",
"vipObjectType": "tree",
"vipPrimaryKey": [
"protocol"
]
}
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"protocol"
]
},
"route-export": {
"vipType": "ignore",
"vipValue": [],
"vipObjectType": "tree",
"vipPrimaryKey": [
"protocol"
]
},
"host": {
"vipType": "constant",
"vipValue": [
{
"hostname": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "host_zyp",
"vipVariableName": "vpn_host_hostname"
},
"ip": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"192.168.0.100"
],
"vipVariableName": "vpn_host_ip"
},
"priority-order": [
"hostname",
"ip"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"hostname"
]
},
"service": {
"vipType": "constant",
"vipValue": [
{
"svc-type": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "FW"
},
"address": {
"vipObjectType": "list",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "vpn_service_address"
},
"track-enable": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "vpn_service_service_track"
},
"priority-order": [
"svc-type",
"address",
"track-enable"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"svc-type"
]
},
"ip": {
"route": {
"vipType": "constant",
"vipValue": [
{
"prefix": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "vpn_ipv4_ip_prefix"
},
"next-hop": {
"vipType": "constant",
"vipValue": [
{
"address": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "3.3.3.3",
"vipVariableName": "vpn_next_hop_ip_address_0"
},
"distance": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 4,
"vipVariableName": "vpn_next_hop_ip_distance_0"
},
"priority-order": [
"address",
"distance"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"address"
]
},
"priority-order": [
"prefix",
"next-hop",
"next-hop-with-track"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"prefix"
]
},
"gre-route": {
"vipType": "constant",
"vipValue": [
{
"prefix": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "vpn_gre_route_gre_route_prefix"
},
"vpn": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 0
},
"interface": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"2"
],
"vipVariableName": "vpn_gre_route_gre_route_interface"
},
"priority-order": [
"prefix",
"vpn",
"interface"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"prefix"
]
},
"ipsec-route": {
"vipType": "constant",
"vipValue": [
{
"prefix": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "vpn_ipsec_route_ipsec_route_prefix"
},
"vpn": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 0
},
"interface": {
"vipObjectType": "list",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "vpn_ipsec_route_ipsec_route_interface"
},
"priority-order": [
"prefix",
"vpn",
"interface"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"prefix"
]
},
"service-route": {
"vipType": "constant",
"vipValue": [
{
"prefix": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "vpn_serviceroute_prefix"
},
"vpn": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 0
},
"service": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "sig"
},
"priority-order": [
"prefix",
"vpn",
"service"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"prefix"
]
}
},
"ipv6": {
"route": {
"vipType": "constant",
"vipValue": [
{
"prefix": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "vpn_ipv6_ipv6_prefix"
},
"next-hop": {
"vipType": "constant",
"vipValue": [
{
"address": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "fe80::1",
"vipVariableName": "vpn_next_hop_ipv6_address_0"
},
"distance": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 1,
"vipVariableName": "vpn_next_hop_ipv6_distance_0"
},
"priority-order": [
"address",
"distance"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"address"
]
},
"priority-order": [
"prefix",
"next-hop"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"prefix"
]
}
},
"omp": {
"advertise": {
"vipType": "constant",
"vipValue": [
{
"priority-order": [
"protocol",
"route-policy",
"protocol-sub-type"
],
"protocol": {
"vipType": "constant",
"vipValue": "ospf",
"vipObjectType": "object"
},
"route-policy": {
"vipType": "variable",
"vipValue": "",
"vipObjectType": "object"
},
"protocol-sub-type": {
"vipType": "constant",
"vipValue": "external",
"vipObjectType": "object"
}
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"protocol"
]
},
"ipv6-advertise": {
"vipType": "ignore",
"vipValue": [],
"vipObjectType": "tree",
"vipPrimaryKey": [
"protocol"
]
}
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleCiscoVpn"
},
"cisco_vpn_interface-example": {
"description": "cisco_vpn_interface-example",
"value": {
"templateName": "cisco_vpn_interface_ethernet",
"templateDescription": "cisco_vpn_interface_ethernet",
"templateType": "cisco_vpn_interface",
"deviceType": [
"vedge-C8000V"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"if-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "GigabitEthernet1/",
"vipVariableName": "vpn_if_name"
},
"description": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "descript1",
"vipVariableName": "vpn_if_description"
},
"ip": {
"dhcp-client": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true"
},
"dhcp-distance": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 10,
"vipVariableName": "vpn_if_ipv4_dhcp_distance"
},
"secondary-address": {
"vipType": "constant",
"vipValue": [
{
"address": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "10.10.10.10/24",
"vipVariableName": "vpn_if_secondary_address_0"
},
"priority-order": [
"address"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"address"
]
}
},
"dhcp-helper": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"10.10.10.254"
],
"vipVariableName": "vpn_if_dhcp_helper"
},
"flow-control": {},
"clear-dont-fragment": {},
"pmtu": {},
"mtu": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1500,
"vipVariableName": "vpn_if_ip_mtu"
},
"static-ingress-qos": {},
"tcp-mss-adjust": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1400,
"vipVariableName": "vpn_if_tcp_mss_adjust"
},
"mac-address": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "00:02:03:04:05:06",
"vipVariableName": "vpn_if_mac_address"
},
"speed": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "1000",
"vipVariableName": "vpn_if_speed"
},
"duplex": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "full",
"vipVariableName": "vpn_if_duplex"
},
"shutdown": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "false",
"vipVariableName": "vpn_if_shutdown"
},
"arp-timeout": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1200,
"vipVariableName": "vpn_if_arp_timeout"
},
"autonegotiate": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_autonegotiate"
},
"shaping-rate": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "10000"
},
"qos-map": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "m1",
"vipVariableName": "qos_map"
},
"qos-map-vpn": {
"vipObjectType": "object",
"vipType": "ignore",
"vipVariableName": "vpn-qos_map"
},
"tracker": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"1"
],
"vipVariableName": "vpn_if_tracker"
},
"bandwidth-upstream": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 100000,
"vipVariableName": "vpn_if_bandwidth_upstream"
},
"bandwidth-downstream": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 200000,
"vipVariableName": "vpn_if_bandwidth_downstream"
},
"block-non-source-ip": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_block_non_source_ip"
},
"rewrite-rule": {
"rule-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "rule1",
"vipVariableName": "rewrite_rule_name"
}
},
"tloc-extension": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "tloc",
"vipVariableName": "vpn_if_tloc_extension"
},
"load-interval": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 30,
"vipVariableName": "vpn_if_load_interval"
},
"icmp-redirect-disable": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "vpn_if_icmp_redirect_disable"
},
"tloc-extension-gre-from": {
"src-ip": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "192.168.1.113",
"vipVariableName": "vpn_if_tloc-ext_gre_from_src_ip"
},
"xconnect": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "connect1",
"vipVariableName": "vpn_if_tloc-ext_gre_from_xconnect"
}
},
"access-list": {
"vipType": "constant",
"vipValue": [
{
"acl-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "9.9.9.9",
"vipVariableName": "access_list_ingress_acl_name_ipv4"
},
"direction": {
"vipType": "constant",
"vipValue": "in",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
},
{
"acl-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "6.6.6.6",
"vipVariableName": "ipv4_access_list_egress_acl_name_ipv4"
},
"direction": {
"vipType": "constant",
"vipValue": "out",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"direction"
]
},
"tunnel-interface": {
"encapsulation": {
"vipType": "constant",
"vipValue": [
{
"preference": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 7,
"vipVariableName": "vpn_if_tunnel_gre_preference"
},
"weight": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 2,
"vipVariableName": "vpn_if_tunnel_gre_weight"
},
"encap": {
"vipType": "constant",
"vipValue": "gre",
"vipObjectType": "object"
},
"priority-order": [
"encap",
"preference",
"weight"
]
},
{
"preference": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 6,
"vipVariableName": "vpn_if_tunnel_ipsec_preference"
},
"weight": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 2,
"vipVariableName": "vpn_if_tunnel_ipsec_weight"
},
"encap": {
"vipType": "constant",
"vipValue": "ipsec",
"vipObjectType": "object"
},
"priority-order": [
"encap",
"preference",
"weight"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"encap"
]
},
"group": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"1"
],
"vipVariableName": "vpn_if_tunnel_group"
},
"border": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_border"
},
"color": {
"value": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "gold",
"vipVariableName": "vpn_if_tunnel_color_value"
},
"restrict": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_color_restrict"
}
},
"carrier": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "carrier8",
"vipVariableName": "vpn_if_tunnel_carrier"
},
"bind": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "tunnel1",
"vipVariableName": "vpn_if_tunnel_bind"
},
"allow-service": {
"dhcp": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_dhcp"
},
"dns": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_dns"
},
"icmp": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_icmp"
},
"sshd": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_sshd"
},
"ntp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_ntp"
},
"stun": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_stun"
},
"all": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_all"
},
"bgp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_bgp"
},
"ospf": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_ospf"
},
"netconf": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_netconf"
},
"snmp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_snmp"
},
"https": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_https"
}
},
"max-control-connections": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 16,
"vipVariableName": "vpn_if_tunnel_max_control_connections"
},
"vbond-as-stun-server": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_vbond_as_stun_server"
},
"exclude-controller-group-list": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"2"
],
"vipVariableName": "vpn_if_tunnel_exclude_controller_group_list"
},
"vmanage-connection-preference": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 7,
"vipVariableName": "vpn_if_tunnel_vmanage_connection_preference"
},
"port-hop": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_port_hop"
},
"low-bandwidth-link": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_low_bandwidth_link"
},
"last-resort-circuit": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_last_resort_circuit"
},
"nat-refresh-interval": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 3,
"vipVariableName": "vpn_if_tunnel_nat_refresh_interval"
},
"hello-interval": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 600,
"vipVariableName": "vpn_if_tunnel_hello_interval"
},
"hello-tolerance": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 12,
"vipVariableName": "vpn_if_tunnel_hello_tolerance"
},
"tloc-extension-gre-to": {
"dst-ip": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "20.20.20.20",
"vipVariableName": "vpn_if_tunnel_tloc_ext_gre_to_dst_ip"
}
},
"tunnel-qos": {
"mode": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "hub"
}
},
"tunnels-bandwidth": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 40,
"vipVariableName": "vpn_if_tunnel_tunnels-bandwidth"
},
"tunnel-tcp-mss-adjust": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1380,
"vipVariableName": "vpn_if_tunnel_tunnel_tcp_mss_adjust"
},
"clear-dont-fragment": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_tunnel_clear_dont_fragment"
},
"propagate-sgt": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_tunnel_propagate_sgt"
},
"network-broadcast": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_tunnel_network_broadcast"
}
},
"auto-bandwidth-detect": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_auto_bandwidth_detect"
},
"iperf-server": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "10.140.36.89",
"vipVariableName": "vpn_if_iperf_server"
},
"media-type": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "rj45",
"vipVariableName": "vpn_if_media-type"
},
"intrf-mtu": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1500,
"vipVariableName": "vpn_if_intrf_mtu"
},
"ip-directed-broadcast": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_ip-directed-broadcast"
},
"trustsec": {
"propagate": {
"sgt": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true"
}
},
"static": {
"sgt": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 13,
"vipVariableName": "trusted_sgt"
},
"trusted": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "trusted_trusted"
}
},
"enable": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "trusted-enable"
},
"enforcement": {
"enable": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "trusted_enforcement_enable"
},
"sgt": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 14,
"vipVariableName": "trusted_enforcement_sgt"
}
}
},
"ipv6": {
"access-list": {
"vipType": "constant",
"vipValue": [
{
"acl-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "2001:4860:4801:48::33",
"vipVariableName": "access_list_ingress_acl_name_ipv6"
},
"direction": {
"vipType": "constant",
"vipValue": "in",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
},
{
"acl-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "2001:4860:4801:48::44",
"vipVariableName": "access_list_egress_acl_name_ipv6"
},
"direction": {
"vipType": "constant",
"vipValue": "out",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"direction"
]
},
"address": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "",
"vipVariableName": "vpn_if_ipv6_ipv6_address"
},
"dhcp-helper-v6": {
"vipType": "ignore",
"vipValue": [],
"vipObjectType": "tree",
"vipPrimaryKey": [
"address"
]
},
"secondary-address": {
"vipType": "ignore",
"vipValue": [],
"vipObjectType": "tree",
"vipPrimaryKey": [
"address"
]
}
},
"nat": {
"udp-timeout": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 2,
"vipVariableName": "nat_udp_timeout"
},
"tcp-timeout": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 120,
"vipVariableName": "nat_tcp_timeout"
},
"natpool": {},
"nat-choice": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "interface",
"vipVariableName": "nat-type"
},
"overload": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true"
},
"interface": {
"loopback-interface": {
"vipObjectType": "object",
"vipType": "ignore"
}
},
"static": {
"vipType": "constant",
"vipValue": [
{
"source-ip": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "192.168.1.111",
"vipVariableName": "vpn_static_nat_source_ip"
},
"translate-ip": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "10.10.20.20",
"vipVariableName": "vpn_static_nat_translate_ip"
},
"static-nat-direction": {
"vipObjectType": "object",
"vipType": "notIgnore",
"vipValue": "inside",
"vipVariableName": "vpn_static_nat_static_nat_direction"
},
"source-vpn": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 12,
"vipVariableName": "vpn_static_nat_source_vpn"
},
"priority-order": [
"source-ip",
"translate-ip",
"static-nat-direction",
"source-vpn"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"source-ip",
"translate-ip"
]
}
},
"arp": {
"ip": {
"vipType": "constant",
"vipValue": [
{
"addr": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "192.168.1.112",
"vipVariableName": "vpn_bridge_arp_addr"
},
"mac": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "00:00:00:00:00:02",
"vipVariableName": "vpn_bridge_arp_mac"
},
"priority-order": [
"addr",
"mac"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"addr"
]
}
},
"vrrp": {
"vipType": "constant",
"vipValue": [
{
"grp-id": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1,
"vipVariableName": "vpn_if_vrrp_grpid"
},
"priority": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 100,
"vipVariableName": "vpn_if_vrrp_priority"
},
"timer": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1000,
"vipVariableName": "vpn_if_vrrp_timer"
},
"track-omp": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_vrrp_track_omp"
},
"ipv4": {
"address": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "30.30.30.30",
"vipVariableName": "vpn_if_vrrp_vrrp_ipaddress"
}
},
"ipv4-secondary": {
"vipType": "ignore",
"vipValue": [],
"vipPrimaryKey": [
"address"
]
},
"tracking-object": {
"vipObjectType": "tree",
"vipType": "constant",
"vipValue": [
{
"name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1,
"vipVariableName": "vrrp_tracker_object_name_vrrp_tracker_name0"
},
"track-action": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "decrement",
"vipVariableName": "vrrp_tracker_object_action_vrrp_tracker_track_action0"
},
"decrement": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 14,
"vipVariableName": "vrrp_tracker_object_decrement_vrrp_tracker_decrement_0"
}
}
],
"vipPrimaryKey": [
"name"
]
},
"priority-order": [
"grp-id",
"priority",
"timer",
"track-omp",
"track-prefix-list",
"tracking-object",
"ipv4",
"ipv4-secondary"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"grp-id"
]
},
"ipv6-vrrp": {
"vipType": "ignore",
"vipValue": [],
"vipObjectType": "tree",
"vipPrimaryKey": [
"grp-id"
]
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleCiscoVpnInterface"
},
"cisco_vpn_interface_gre-example": {
"description": "cisco_vpn_interface_gre-example",
"value": {
"templateName": "template_vpn_interface_gre",
"templateDescription": "template_vpn_interface_gre",
"templateType": "cisco_vpn_interface_gre",
"deviceType": [
"vedge-C8000V"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"if-name": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "vpn_if_name_template_vpn_interface_gre"
},
"description": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "vpn_if_description"
},
"application": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "vpn_if_application"
},
"ip": {
"address": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "vpn_if_ipv4_address"
}
},
"shutdown": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "false",
"vipVariableName": "vpn_if_shutdown"
},
"tunnel-source": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "vpn_if_tunnel_source"
},
"tunnel-destination": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "vpn_if_tunnel_destination"
},
"mtu": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 300,
"vipVariableName": "vpn_if_ip_mtu"
},
"tcp-mss-adjust": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "vpn_if_tcp_mss_adjust"
},
"rewrite-rule": {
"rule-name": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "rewrite_rule_name"
}
},
"access-list": {
"vipType": "constant",
"vipValue": [
{
"acl-name": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "access_list_egress_acl_name_ipv4"
},
"direction": {
"vipType": "constant",
"vipValue": "out",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"direction"
]
},
"clear-dont-fragment": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "vpn_gre_tunnel_tunnel_clear_dont_fragment"
},
"tracker": {
"vipObjectType": "list",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "tracker"
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleCiscoVpnInterfaceGre"
},
"cisco_vpn_interface_ipsec-example": {
"description": "cisco_vpn_interface_ipsec-example",
"value": {
"templateName": "vpn_interface_ipsec",
"templateDescription": "vpn_interface_ipsec",
"templateType": "cisco_vpn_interface_ipsec",
"deviceType": [
"vedge-C8000V"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"if-name": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "vpn_if_name_vpn_interface_ipsec"
},
"description": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "vpn_if_description"
},
"application": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "sig",
"vipVariableName": "vpn_if_application"
},
"ip": {
"address": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "vpn_if_ipv4_address"
}
},
"shutdown": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "false",
"vipVariableName": "vpn_if_shutdown"
},
"tunnel-source": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "vpn_if_tunnel_source"
},
"tunnel-destination": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "vpn_if_tunnel_destination"
},
"mtu": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1500,
"vipVariableName": "vpn_if_mtu"
},
"tcp-mss-adjust": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "vpn_if_tcp_mss_adjust"
},
"dead-peer-detection": {
"dpd-interval": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 10,
"vipVariableName": "vpn_if_dpd_interval"
},
"dpd-retries": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 3,
"vipVariableName": "vpn_if_dpd_retries"
}
},
"ike": {
"ike-version": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 2,
"vipVariableName": "vpn_if_ike_version"
},
"ike-rekey-interval": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1440,
"vipVariableName": "vpn_if_ike_rekey_interval"
},
"ike-ciphersuite": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "aes256-cbc-sha1",
"vipVariableName": "vpn_if_ike_ciphersuite"
},
"ike-group": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "16",
"vipVariableName": "vpn_if_ike_group"
},
"authentication-type": {
"pre-shared-key": {
"pre-shared-secret": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "123456789a",
"vipVariableName": "vpn_if_pre_shared_secret"
},
"ike-local-id": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "123456789a",
"vipVariableName": "vpn_if_ike_local_id"
},
"ike-remote-id": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "123456789a",
"vipVariableName": "vpn_if_ike_remote_id"
}
}
}
},
"ipsec": {
"ipsec-rekey-interval": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 3600,
"vipVariableName": "vpn_if_ipsec_rekey_interval"
},
"ipsec-replay-window": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 512,
"vipVariableName": "vpn_if_ipsec_replay_window"
},
"ipsec-ciphersuite": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "aes256-gcm",
"vipVariableName": "vpn_if_ipsec_ciphersuite"
},
"perfect-forward-secrecy": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "group-16",
"vipVariableName": "vpn_if_ipsec_perfect_forward_secrecy"
}
},
"clear-dont-fragment": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "vpn_ipsec_tunnel_tunnel_clear_dont_fragment"
},
"tracker": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"tracker2"
],
"vipVariableName": "tracker"
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleCiscoVpnInterfaceIpsec"
},
"cisco_wireless_la-example": {
"description": "cisco_wireless_la-example",
"value": {
"templateName": "template_wireless",
"templateDescription": "template_wireless",
"templateType": "cisco_wireless_lan",
"deviceType": [
"vedge-C1101-4PLTEPW"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"radio": {
"shutdown-2.4ghz": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "false",
"vipVariableName": "radio_shutdown_2.4ghz"
},
"shutdown-5ghz": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "false",
"vipVariableName": "radio_shutdown-5ghz"
}
},
"country": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "BH",
"vipVariableName": "country_country"
},
"mgmt": {
"username": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "cisco",
"vipVariableName": "mgmt_username"
},
"password": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "123456789a",
"vipVariableName": "mgmt_password"
},
"address": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "0.0.0.0",
"vipVariableName": "mgmt_address"
},
"netmask": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "0.0.0.0",
"vipVariableName": "mgmt_netmask"
},
"default-gateway": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "0.0.0.0",
"vipVariableName": "mgmt_default_gateway"
}
},
"ssid": {
"vipType": "constant",
"vipValue": [
{
"name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "SSID1"
},
"admin-state": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "wifi-ssid_admin-state"
},
"broadcast-ssid": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "wifi-ssid_broadcast-ssid"
},
"vlan-id": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 123,
"vipVariableName": "wifi-ssid_vlan-id"
},
"radio-type": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "24ghz",
"vipVariableName": "wifi-ssid_radio-type"
},
"security-type": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "personal",
"vipVariableName": "wifi-ssid_security-type"
},
"radius-server-ip": {
"vipObjectType": "object",
"vipType": "ignore",
"vipVariableName": "wifi-ssid_server_ip_0"
},
"radius-server-port": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 1812,
"vipVariableName": "wifi-ssid_server_port_0"
},
"radius-server-secret": {
"vipObjectType": "object",
"vipType": "ignore",
"vipVariableName": "wifi-ssid_server_secret_0"
},
"passphrase": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "123456789a",
"vipVariableName": "wifi-ssid_passphrase"
},
"qos-profile": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "bronze",
"vipVariableName": "wifi-ssid_qos-profile"
},
"priority-order": [
"name",
"admin-state",
"broadcast-ssid",
"passphrase",
"qos-profile",
"radio-type",
"radius-server-ip",
"radius-server-port",
"radius-server-secret",
"security-type",
"vlan-id"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"name"
]
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleCiscoWirelessLan"
},
"cli-template-example": {
"description": "cli-template-example",
"value": {
"templateName": "template_cli_addon_template",
"templateDescription": "template_cli_addon_template",
"templateType": "cli-template",
"deviceType": [
"vedge-C8000V"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"config": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "abcdedfdgdggfggfgfggfgfgfgfggfghtrhg"
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleCliTemplate"
},
"dhcp-server-example": {
"description": "dhcp-server-example",
"value": {
"templateName": "template_vedge_dhcpserver",
"templateDescription": "template_vedge_dhcpserver",
"templateType": "dhcp-server",
"deviceType": [
"vedge-cloud"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"address-pool": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "192.168.1.10/24",
"vipVariableName": "dhcp_address_pool"
},
"exclude": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"192.168.1.111"
],
"vipVariableName": "dhcp-address_exclude"
},
"max-leases": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 600,
"vipVariableName": "max_leases"
},
"offer-time": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 300,
"vipVariableName": "offer_time"
},
"lease-time": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 86400,
"vipVariableName": "lease_time"
},
"admin-state": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "up",
"vipVariableName": "admin_state"
},
"options": {
"interface-mtu": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1500,
"vipVariableName": "dhcp_interface_mtu"
},
"domain-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "dns.org",
"vipVariableName": "dhcp_domain_name"
},
"default-gateway": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "192.168.1.254",
"vipVariableName": "dhcp_default_gateway"
},
"dns-servers": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"10.124.19.173"
],
"vipVariableName": "dhcp_dns_server"
},
"tftp-servers": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"10.124.19.169"
],
"vipVariableName": "tftp-server"
},
"option-code": {
"vipType": "constant",
"vipValue": [
{
"code": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 120,
"vipVariableName": "dhcp_option-code"
},
"ascii": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "000001edabcd",
"vipVariableName": "dhcp_ascii"
},
"hex": {
"vipObjectType": "object",
"vipType": "ignore"
},
"ip": {
"vipObjectType": "list",
"vipType": "ignore"
},
"priority-order": [
"code",
"ascii",
"hex",
"ip"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"code"
]
}
},
"static-lease": {
"vipType": "constant",
"vipValue": [
{
"mac-address": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "00:00:00:00:00:11",
"vipVariableName": "dhcp_mac_address"
},
"ip": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "192.168.1.20",
"vipVariableName": "dhcp_ip"
},
"host-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "vm5",
"vipVariableName": "dhcp_hostname"
},
"priority-order": [
"mac-address",
"ip",
"host-name"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"mac-address"
]
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleDhcpServer"
},
"eigrp-example": {
"description": "eigrp-example",
"value": {
"templateName": "template_eigrp",
"templateDescription": "template_eigrp",
"templateType": "eigrp",
"deviceType": [
"vedge-C8000V"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"eigrp": {
"as-num": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 11,
"vipVariableName": "eigrp_as_num"
},
"hello-interval": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 10,
"vipVariableName": "eigrp_hello-interval"
},
"hold-time": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 30,
"vipVariableName": "eigrp_hold-time"
},
"table-map": {
"name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "p1",
"vipVariableName": "eigrp_name"
}
},
"authentication": {
"type": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "md5",
"vipVariableName": "eigrp_type"
},
"auth-key": {},
"keychain": {
"key": {
"vipType": "constant",
"vipValue": [
{
"key_id": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1,
"vipVariableName": "key_id_key_id"
},
"keystring": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "123456789a",
"vipVariableName": "keystring_keystring"
}
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"key_id"
]
}
}
},
"address-family": {
"vipType": "constant",
"vipValue": [
{
"type": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "ipv4"
},
"network": {
"vipType": "constant",
"vipValue": [
{
"prefix": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "20.20.20.10/24",
"vipVariableName": "eigrp_network_network_address_prefix"
},
"priority-order": [
"prefix"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"prefix"
]
},
"topology": {
"base": {
"redistribute": {
"vipType": "constant",
"vipValue": [
{
"protocol": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "nat-route",
"vipVariableName": "eigrp_redistribute_protocol"
},
"route-map": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "forward",
"vipVariableName": "eigrp_redistribute_route_map"
},
"priority-order": [
"protocol",
"route-map"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"protocol"
]
}
}
},
"priority-order": [
"type",
"network",
"topology"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"type"
]
},
"af-interface": {
"vipType": "constant",
"vipValue": [
{
"name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "GigabitEthernet2/",
"vipVariableName": "eigrp_interface_name"
},
"shutdown": {
"vipObjectType": "node-only",
"vipType": "ignore",
"vipValue": "false",
"vipVariableName": "eigrp_interface_ip_shutdown"
},
"summary-address": {
"vipType": "constant",
"vipValue": [
{
"prefix": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "10.10.10.0/24",
"vipVariableName": "vpn_next_hop_ip_prefix_0"
},
"priority-order": [
"prefix"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"prefix"
]
},
"priority-order": [
"name",
"shutdown",
"summary-address"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"name"
]
}
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleEigrp"
},
"igmp-example": {
"description": "igmp-example",
"value": {
"templateName": "template_igmp",
"templateDescription": "template_igmp",
"templateType": "igmp",
"deviceType": [
"vedge-cloud"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"igmp": {
"shutdown": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "false",
"vipVariableName": "igmp_shutdown"
},
"interface": {
"vipType": "constant",
"vipValue": [
{
"name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "gi/0/0/1",
"vipVariableName": "igmp_interface_name_details"
},
"join-group": {
"vipType": "constant",
"vipValue": [
{
"group-address": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "239.1.1.1",
"vipVariableName": "igmp_interface_group_address_0"
},
"priority-order": [
"group-address"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"group-address"
]
},
"priority-order": [
"name",
"join-group"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"name"
]
}
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleIgmp"
},
"logging-example": {
"description": "logging-example",
"value": {
"templateName": "template_logging",
"templateDescription": "template_logging",
"templateType": "logging",
"deviceType": [
"vedge-cloud"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"disk": {
"enable": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "logging_disk_enable"
},
"file": {
"size": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 20,
"vipVariableName": "logging_max_file_size"
},
"rotate": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 10,
"vipVariableName": "logging_disk_rotation"
}
},
"priority": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "information",
"vipVariableName": "logging_disk_priority"
}
},
"server": {
"vipType": "constant",
"vipValue": [
{
"name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "10.124.19.169",
"vipVariableName": "logging_server_name"
},
"vpn": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 100,
"vipVariableName": "logging_server_vpn"
},
"source-interface": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "GigabitEthernet0",
"vipVariableName": "logging_server_source_interface"
},
"priority": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "emergency",
"vipVariableName": "logging_server_server_priority"
},
"priority-order": [
"name",
"vpn",
"source-interface",
"priority"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"name"
]
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleLogging"
},
"multicast-example": {
"description": "multicast-example",
"value": {
"templateName": "template_multicast",
"templateDescription": "template_multicast",
"templateType": "multicast",
"deviceType": [
"vedge-cloud"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"multicast-replicator": {
"local": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "multicast_replicator_local"
},
"threshold": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 60,
"vipVariableName": "multicast_replicator_threshold"
}
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleMulticast"
},
"ntp-example": {
"description": "ntp-example",
"value": {
"templateName": "template_ntp",
"templateDescription": "template_ntp",
"templateType": "ntp",
"deviceType": [
"vedge-cloud"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"keys": {
"trusted": {
"vipObjectType": "list",
"vipType": "ignore",
"vipVariableName": "trusted_key"
},
"authentication": {
"vipType": "constant",
"vipValue": [
{
"number": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1,
"vipVariableName": "ntp_auth_auth_key"
},
"md5": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "123456",
"vipVariableName": "ntp_auth_md5"
},
"priority-order": [
"number",
"md5"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"number"
]
}
},
"server": {
"vipType": "constant",
"vipValue": [
{
"name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "10.124.19.169",
"vipVariableName": "ntp_server_host"
},
"key": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1,
"vipVariableName": "ntp_server_server_auth_key"
},
"vpn": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 10,
"vipVariableName": "ntp_server_vpn"
},
"version": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 4,
"vipVariableName": "ntp_server_version"
},
"source-interface": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "gi0/1",
"vipVariableName": "ntp_server_source_interface"
},
"prefer": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "ntp_server_prefer"
},
"priority-order": [
"name",
"key",
"vpn",
"version",
"source-interface",
"prefer"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"name"
]
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleNtp"
},
"omp-vedge-example": {
"description": "omp-vedge-example",
"value": {
"templateName": "template_vedge",
"templateDescription": "template_vedge",
"templateType": "omp-vedge",
"deviceType": [
"vedge-1000"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"graceful-restart": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "omp_graceful_restart"
},
"send-path-limit": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 8,
"vipVariableName": "omp_send_path_limit"
},
"overlay-as": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 12,
"vipVariableName": "overlay_as"
},
"ecmp-limit": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 8,
"vipVariableName": "omp_ecmp_limit"
},
"shutdown": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "false",
"vipVariableName": "omp_shutdown"
},
"timers": {
"advertisement-interval": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 4,
"vipVariableName": "omp_advertisement_interval"
},
"graceful-restart-timer": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 86400,
"vipVariableName": "omp_graceful_restart_timer"
},
"holdtime": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 120,
"vipVariableName": "omp_holdtime"
},
"eor-timer": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 600,
"vipVariableName": "omp_eor_timer"
}
},
"distance": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 16,
"vipVariableName": "vpn_distance"
},
"advertise": {
"vipType": "constant",
"vipValue": [
{
"priority-order": [
"protocol"
],
"protocol": {
"vipType": "constant",
"vipValue": "bgp",
"vipObjectType": "object"
}
},
{
"priority-order": [
"protocol",
"route"
],
"protocol": {
"vipType": "constant",
"vipValue": "ospf",
"vipObjectType": "object"
},
"route": {
"vipType": "constant",
"vipValue": "external",
"vipObjectType": "object"
}
},
{
"priority-order": [
"protocol"
],
"protocol": {
"vipType": "constant",
"vipValue": "connected",
"vipObjectType": "object"
}
},
{
"priority-order": [
"protocol"
],
"protocol": {
"vipType": "constant",
"vipValue": "static",
"vipObjectType": "object"
}
},
{
"priority-order": [
"protocol"
],
"protocol": {
"vipType": "constant",
"vipValue": "eigrp",
"vipObjectType": "object"
}
},
{
"priority-order": [
"protocol"
],
"protocol": {
"vipType": "constant",
"vipValue": "lisp",
"vipObjectType": "object"
}
},
{
"priority-order": [
"protocol"
],
"protocol": {
"vipType": "constant",
"vipValue": "isis",
"vipObjectType": "object"
}
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"protocol"
]
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleOmpVedge"
},
"omp-vsmart-example": {
"description": "omp-vsmart-example",
"value": {
"templateName": "vsmart_omp",
"templateDescription": "vsmart_omp",
"templateType": "omp-vsmart",
"deviceType": [
"vsmart"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"graceful-restart": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "omp_graceful_restart"
},
"send-path-limit": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 8,
"vipVariableName": "omp_send_path_limit"
},
"send-backup-paths": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "omp_send_backup_paths"
},
"discard-rejected": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "omp_discard_rejected"
},
"shutdown": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "false",
"vipVariableName": "omp_shutdown"
},
"timers": {
"advertisement-interval": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 4,
"vipVariableName": "omp_advertisement_interval"
},
"graceful-restart-timer": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 86400,
"vipVariableName": "omp_graceful_restart_timer"
},
"holdtime": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 120,
"vipVariableName": "omp_holdtime"
},
"eor-timer": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 600,
"vipVariableName": "omp_eor_timer"
}
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleOmpVsmart"
},
"ospf-example": {
"description": "ospf-example",
"value": {
"templateName": "vedge_ospf",
"templateDescription": "vedge_ospf",
"templateType": "ospf",
"deviceType": [
"vedge-cloud"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"ospf": {
"router-id": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "10.10.10.10",
"vipVariableName": "ospf_router_id"
},
"auto-cost": {
"reference-bandwidth": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 100,
"vipVariableName": "ospf_reference_bandwidth"
}
},
"compatible": {
"rfc1583": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "ospf_rfc1583"
}
},
"distance": {
"external": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 5,
"vipVariableName": "ospf_distance_external"
},
"inter-area": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 10,
"vipVariableName": "ospf_distance_inter_area"
},
"intra-area": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 10,
"vipVariableName": "ospf_distance_intra_area"
}
},
"timers": {
"spf": {
"delay": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 200,
"vipVariableName": "ospf_delay"
},
"initial-hold": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1000,
"vipVariableName": "ospf_initial_hold"
},
"max-hold": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 10000,
"vipVariableName": "ospf_max_hold"
}
}
},
"route-policy": {
"vipType": "constant",
"vipValue": [
{
"direction": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "in"
},
"pol-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "p1",
"vipVariableName": "ospf_pol_name"
},
"priority-order": [
"direction",
"pol-name"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"direction"
]
},
"default-information": {
"originate": {
"always": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "ospf_originate_always"
},
"metric": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 4,
"vipVariableName": "ospf_originate_metric"
},
"metric-type": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "type1",
"vipVariableName": "ospf_originate_metric_type"
}
}
},
"redistribute": {
"vipType": "constant",
"vipValue": [
{
"protocol": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "bgp",
"vipVariableName": "ospf_redistribute_protocol"
},
"route-policy": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "p1",
"vipVariableName": "ospf_redistribute_route_policy"
},
"priority-order": [
"protocol",
"route-policy"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"protocol"
]
},
"max-metric": {
"router-lsa": {
"vipType": "constant",
"vipValue": [
{
"ad-type": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "administrative"
},
"priority-order": [
"ad-type"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"ad-type"
]
}
},
"area": {
"vipType": "constant",
"vipValue": [
{
"a-num": {
"originalDefaultOption": "constant",
"dataPath": [],
"vipObjectType": "object",
"vipValue": 0,
"vipType": "constant",
"vipVariableName": "ospf_area_a_num"
},
"stub": {
"no-summary": {
"vipType": "constant",
"vipObjectType": "node-only",
"vipVariableName": "ospf_area_no_summary",
"vipValue": "true"
}
},
"priority-order": [
"a-num",
"stub"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"a-num"
]
}
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleOspf"
},
"pim-example": {
"description": "pim-example",
"value": {
"templateName": "template_pim",
"templateDescription": "template_pim",
"templateType": "pim",
"deviceType": [
"vedge-cloud"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"pim": {
"shutdown": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "false",
"vipVariableName": "pim_shutdown"
},
"auto-rp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "pim_auto_rp"
},
"spt-threshold": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 100,
"vipVariableName": "pim_spt_threshold"
},
"replicator-selection": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "sticky",
"vipVariableName": "pim_replicator_selection"
},
"interface": {
"vipType": "constant",
"vipValue": [
{
"name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "gi3",
"vipVariableName": "pim_if_name"
},
"hello-interval": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 60,
"vipVariableName": "pim_hello_interval"
},
"join-prune-interval": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 120,
"vipVariableName": "pim_join_prune_interval"
},
"priority-order": [
"name",
"hello-interval",
"join-prune-interval"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"name"
]
}
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExamplePim"
},
"probe-example": {
"description": "probe-example",
"value": {
"templateName": "template_probes",
"templateDescription": "template_probes",
"templateType": "probes",
"deviceType": [
"vedge-C8000V"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"bfd-probe-path": {
"all-tlocs": {
"vipType": "constant",
"vipValue": true,
"vipObjectType": "object"
},
"trigger-on-change": {
"key": "trigger-on-change",
"description": "Start event / On-Change based probe-paths",
"details": "Start event / On-Change based probe-paths",
"optionType": [
{
"value": "constant",
"display": "Global",
"iconClass": "language",
"iconColor": "icon-global"
}
],
"originalDefaultOption": "constant",
"defaultOption": "constant",
"dataType": {
"type": "boolean",
"default": false
},
"dataPath": [
"bfd-probe-path"
],
"vipObjectType": "object",
"objectType": "object",
"deleteFlag": false,
"vipValue": true,
"vipType": "constant"
}
},
"probe": {
"latency": {
"key": "latency",
"description": "Latency-Probe Frequency",
"details": "Latency-Probe Frequency in seconds: <0..65530>",
"optionType": [
{
"value": "constant",
"display": "Global",
"iconClass": "language",
"iconColor": "icon-global"
},
{
"value": "variable",
"display": "Device Specific",
"iconClass": "router",
"iconColor": "icon-variable"
}
],
"originalDefaultOption": "constant",
"defaultOption": "constant",
"dataType": {
"type": "number",
"min": 0,
"max": 65530,
"default": 30
},
"dataPath": [
"probe"
],
"vipObjectType": "object",
"objectType": "object",
"deleteFlag": false,
"vipValue": 60,
"vipType": "constant",
"vipVariableName": "probe_latency"
},
"saas": {}
},
"probe-path": {
"trigger": {
"key": "trigger",
"description": "trigger",
"details": "trigger",
"optionType": [
{
"value": "constant",
"display": "Global",
"iconClass": "language",
"iconColor": "icon-global"
}
],
"originalDefaultOption": "constant",
"defaultOption": "constant",
"dataType": {
"type": "enum",
"values": [
{
"key": "on-change",
"value": "on-change"
},
{
"key": "periodic",
"value": "periodic"
}
]
},
"dataPath": [
"probe-path"
],
"vipObjectType": "object",
"objectType": "object",
"deleteFlag": false,
"vipValue": "on-change",
"vipType": "constant"
},
"branch": {
"color-all-dia": {
"vipType": "constant",
"vipValue": true,
"vipObjectType": "node-only"
}
}
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleProbes"
},
"secure-internet-gateway-example": {
"description": "secure-internet-gateway-example",
"value": {
"templateName": "template_sig_vedge",
"templateDescription": "template_sig_vedge",
"templateType": "secure-internet-gateway",
"deviceType": [
"vedge-cloud"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"vpn-id": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 0
},
"interface": {
"vipType": "constant",
"vipValue": [
{
"if-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "ipsec1",
"vipVariableName": "tunnel_if_name"
},
"auto": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true"
},
"shutdown": {
"vipObjectType": "object",
"vipType": "notIgnore",
"vipValue": "false",
"vipVariableName": "tunnel_shutdown"
},
"description": {
"vipObjectType": "object",
"vipType": "ignore",
"vipVariableName": "tunnel_description"
},
"ip": {
"unnumbered": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "true"
}
},
"tunnel-source-interface": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "gi0/1",
"vipVariableName": "tunnel_tunnel_source_interface"
},
"tunnel-destination": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "dynamic"
},
"tunnel-set": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "secure-internet-gateway-umbrella"
},
"tunnel-dc-preference": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "primary-dc"
},
"tcp-mss-adjust": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 1300,
"vipVariableName": "tunnel_tcp_mss_adjust_"
},
"mtu": {
"vipObjectType": "object",
"vipType": "notIgnore",
"vipValue": 1400,
"vipVariableName": "tunnel_mtu_"
},
"dead-peer-detection": {
"dpd-interval": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 10,
"vipVariableName": "tunnel_dpd_interval"
},
"dpd-retries": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 3,
"vipVariableName": "tunnel_dpd_retries"
}
},
"ike": {
"ike-version": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 2
},
"authentication-type": {
"pre-shared-key-dynamic": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "true"
}
},
"ike-rekey-interval": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 14400,
"vipVariableName": "tunnel_ike_rekey_interval_"
},
"ike-ciphersuite": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "aes256-cbc-sha2",
"vipVariableName": "tunnel_ike_ciphersuite"
},
"ike-group": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "14",
"vipVariableName": "tunnel_ike_group"
}
},
"ipsec": {
"ipsec-rekey-interval": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1800,
"vipVariableName": "tunnel_ipsec_rekey_interval"
},
"ipsec-replay-window": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 512,
"vipVariableName": "tunnel_ipsec_replay_window"
},
"ipsec-ciphersuite": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "aes256-cbc-sha384",
"vipVariableName": "tunnel_ipsec_ciphersuite"
},
"perfect-forward-secrecy": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "group-14",
"vipVariableName": "tunnel_perfect_forward_secrecy"
}
},
"tracker": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "tracker"
},
"track-enable": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true"
}
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"if-name"
]
},
"service": {
"vipType": "constant",
"vipValue": [
{
"svc-type": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "sig"
},
"ha-pairs": {
"interface-pair": {
"vipType": "constant",
"vipObjectType": "tree",
"vipPrimaryKey": [
"active-interface",
"backup-interface"
],
"vipValue": [
{
"active-interface": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "ipsec1"
},
"backup-interface": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "None"
},
"active-interface-weight": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 7
},
"backup-interface-weight": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1
},
"priority-order": [
"active-interface",
"backup-interface",
"active-interface-weight",
"backup-interface-weight"
]
}
]
}
},
"umbrella-data-center": {
"data-center-primary": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "au1-a.vpn.sig.umbrella.com",
"vipVariableName": "vpn_umbprimarydc"
},
"data-center-secondary": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "us2-b.vpn.sig.umbrella.com",
"vipVariableName": "vpn_umbsecondarydc"
}
}
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"svc-type"
]
},
"tracker": {
"vipType": "constant",
"vipValue": [
{
"name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "tracker",
"vipVariableName": "tracker_name"
},
"endpoint-api-url": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "https://www.baidu.com",
"vipVariableName": "tracker_endpoint-api-url"
},
"threshold": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 600,
"vipVariableName": "tracker_threshold"
},
"interval": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 120,
"vipVariableName": "tracker_interval"
},
"multiplier": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 6,
"vipVariableName": "tracker_multiplier"
},
"tracker-type": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "SIG"
},
"priority-order": [
"tracker-type",
"name",
"endpoint-api-url",
"threshold",
"interval",
"multiplier"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"tracker-type",
"name"
]
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleSecureInternetGateway"
},
"security-vedge-example": {
"description": "security-vedge-example",
"value": {
"templateName": "template_security_vedge",
"templateDescription": "template_security_vedge",
"templateType": "security-vedge",
"deviceType": [
"vedge-cloud"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"ipsec": {
"rekey": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 86400,
"vipVariableName": "security_rekey"
},
"replay-window": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "1024",
"vipVariableName": "security_replay_window"
},
"authentication-type": {
"vipType": "constant",
"vipValue": [
"sha1-hmac",
"ah-sha1-hmac",
"ah-no-id"
],
"vipObjectType": "list",
"vipVariableName": "security_authenticationType"
},
"integrity-type": {
"vipType": "constant",
"vipValue": [
"esp",
"ip-udp-esp",
"ip-udp-esp-no-id"
],
"vipObjectType": "list"
},
"pairwise-keying": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "security_pairwise_keying"
}
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleSecurityVedge"
},
"security-vsmart-example": {
"description": "security-vsmart-example",
"value": {
"templateName": "template_security_vsmart",
"templateDescription": "template_security_vsmart",
"templateType": "security-vsmart",
"deviceType": [
"vsmart"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"control": {
"protocol": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "dtls",
"vipVariableName": "security_protocol"
}
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleSecurityVsmart"
},
"sig-credential-example": {
"description": "sig-credential-example",
"value": {
"templateName": "template_sig_credentials",
"templateDescription": "template_sig_credentials",
"templateType": "sig-credentials",
"deviceType": [
"vedge-cloud"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"umbrella": {
"api-key": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "123456789a",
"vipVariableName": "system_api_key"
},
"api-secret": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "123456789a",
"vipVariableName": "system_api_secret",
"vipNeedsEncryption": true
},
"org-id": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "viptela",
"vipVariableName": "system_org_id"
}
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleSigCredentials"
},
"snmp-example": {
"description": "snmp-example",
"value": {
"templateName": "template_snmp",
"templateDescription": "template_snmp",
"templateType": "snmp",
"deviceType": [
"vedge-cloud"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"shutdown": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "false",
"vipVariableName": "snmp_shutdown"
},
"contact": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "jefrey",
"vipVariableName": "snmp_contact"
},
"name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "snmpv2",
"vipVariableName": "snmp_device_name"
},
"location": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "Shanghai",
"vipVariableName": "snmp_device_location"
},
"view": {
"vipType": "constant",
"vipValue": [
{
"name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": " v2"
},
"oid": {
"vipType": "constant",
"vipValue": [
{
"id": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "snmp_view_id_0"
},
"exclude": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "snmp_view_exclude_0"
},
"priority-order": [
"id",
"exclude"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"id"
]
},
"priority-order": [
"name",
"oid"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"name"
]
},
"community": {
"vipType": "constant",
"vipValue": [
{
"name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "c1",
"vipNeedsEncryption": "true"
},
"view": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": " v2",
"vipVariableName": "snmp_community_view"
},
"authorization": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "read-only",
"vipVariableName": "snmp_community_authorization"
},
"priority-order": [
"name",
"authorization",
"view"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"name"
]
},
"trap": {
"group": {
"vipType": "constant",
"vipValue": [
{
"group-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "trap1"
},
"enable": {
"vipType": "constant",
"vipValue": [
{
"module": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "bfd",
"vipVariableName": "snmp_trap_types_module_0"
},
"level": {
"vipType": "constant",
"vipValue": [
"major"
],
"vipObjectType": "list",
"vipVariableName": "snmp_trap_types_level_0"
},
"priority-order": [
"module",
"level"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"module"
]
},
"priority-order": [
"group-name",
"enable"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"group-name"
]
},
"target": {
"vipType": "constant",
"vipValue": [
{
"vpn-id": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 12,
"vipVariableName": "snmp_trap_vpn_id"
},
"ip": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "10.10.10.10",
"vipVariableName": "snmp_trap_ip"
},
"port": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1000,
"vipVariableName": "snmp_trap_port"
},
"group-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "trap1",
"vipVariableName": "snmp_trap_trap_group_name"
},
"community-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "c1",
"vipVariableName": "snmp_trap_community_name",
"vipNeedsEncryption": "true"
},
"user": {},
"source-interface": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "GigabitEthernet2",
"vipVariableName": "snmp_trap_source_interface"
},
"users": {
"vipObjectType": "object",
"vipType": "constant"
},
"priority-order": [
"vpn-id",
"ip",
"port",
"group-name",
"community-name",
"source-interface"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"vpn-id",
"ip",
"port"
]
}
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleSnmp"
},
"switchport-example": {
"description": "switchport-example",
"value": {
"templateName": "template_switchport",
"templateDescription": "template_switchport",
"templateType": "switchport",
"deviceType": [
"vedge-C8000V"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"slot": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 0
},
"module": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "4"
},
"age-time": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 300,
"vipVariableName": "switchport_age_time"
},
"subslot": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1
},
"interface": {
"vipType": "constant",
"vipValue": [
{
"if-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "GigabitEthernet0/1/3",
"vipVariableName": "switchport_if_if_name"
},
"switchport": {
"mode": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "trunk"
},
"trunk": {
"allowed": {
"vlan": {
"vlans": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "100",
"vipVariableName": "switchport_if_trunk_allowed_vlans"
}
}
},
"native": {
"vlan": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "",
"vipVariableName": "switchport_if_trunk_native_vlan"
}
}
}
},
"shutdown": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "false",
"vipVariableName": "switchport_if_shutdown"
},
"speed": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "100",
"vipVariableName": "switchport_if_speed"
},
"duplex": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "full",
"vipVariableName": "switchport_if_duplex"
},
"dot1x": {
"port-control": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "auto",
"vipVariableName": "802.1X_port-control"
},
"voice-vlan": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 200,
"vipVariableName": "802.1X_voice-vlan"
},
"pae-enable": {
"vipObjectType": "object",
"vipType": "notIgnore",
"vipValue": "true",
"vipVariableName": "802.1X_pae-enable"
},
"mac-authentication-bypass": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "802.1X_mac-auth-bypass"
},
"authentication": {
"host-mode": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "single-host",
"vipVariableName": "802.1X_host-mode"
},
"enable-periodic-reauth": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "802.1X_enable-periodic-reauth"
},
"periodic-reauthentication": {
"inactivity": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 60,
"vipVariableName": "802.1X_inactivity"
},
"reauthentication": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 30,
"vipVariableName": "802.1X_reauthentication"
}
},
"control-direction": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "both",
"vipVariableName": "802.1X_control_direction"
},
"event": {
"restricted-vlan": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 400,
"vipVariableName": "802.1X_restricted-vlan"
},
"guest-vlan": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 300,
"vipVariableName": "802.1X_guest-vlan"
},
"critical-vlan": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 201,
"vipVariableName": "802.1X_critical-vlan"
},
"enable-voice": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "802.1X_enable-voice"
}
}
}
},
"priority-order": [
"if-name",
"shutdown",
"switchport",
"speed",
"duplex",
"dot1x"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"if-name"
]
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleSwitchport"
},
"system-vedge-example": {
"description": "system-vedge-example",
"value": {
"templateName": "template_system",
"templateDescription": "template_system",
"templateType": "system-vedge",
"deviceType": [
"vedge-cloud"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"clock": {
"timezone": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "Africa/Casablanca",
"vipVariableName": "system_timezone"
}
},
"gps-location": {
"latitude": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "system_latitude"
},
"longitude": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "system_longitude"
}
},
"timer": {
"dns-cache-timeout": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 2,
"vipVariableName": "system_dns_cache_timeout"
}
},
"location": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "Shanghai",
"vipVariableName": "system_location"
},
"system-tunnel-mtu": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1024,
"vipVariableName": "system_system_tunnel_mtu"
},
"track-transport": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "system_track_transport"
},
"track-interface-tag": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 2,
"vipVariableName": "system_track_interface_tag"
},
"port-offset": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1,
"vipVariableName": "system_port_offset"
},
"port-hop": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "system_port_hop"
},
"control-session-pps": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 600,
"vipVariableName": "system_control_session_pps"
},
"description": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "description1",
"vipVariableName": "system_description"
},
"device-groups": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"group1"
],
"vipVariableName": "system_device_groups"
},
"controller-group-list": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"1"
],
"vipVariableName": "system_controller_group_list"
},
"eco-friendly-mode": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "system_eco_friendly_mode"
},
"site-id": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "system_site_id"
},
"overlay-id": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1,
"vipVariableName": "system_overlay_id"
},
"system-ip": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "system_system_ip"
},
"host-name": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "system_host_name"
},
"console-baud-rate": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "9600",
"vipVariableName": "system_console_baud_rate"
},
"max-omp-sessions": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 12,
"vipVariableName": "system_max_omp_sessions"
},
"usb-controller": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "false",
"vipVariableName": "system_usb_controller"
},
"track-default-gateway": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "system_track_default_gateway"
},
"multicast-buffer-percent": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 20,
"vipVariableName": "system_multicast_buffer_percent"
},
"host-policer-pps": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 20000,
"vipVariableName": "system_host_policer_pps"
},
"icmp-error-pps": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 200,
"vipVariableName": "system_icmp_error_pps"
},
"vbond": {
"local": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "system_local"
},
"remote": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "10.10.20.20"
}
},
"allow-same-site-tunnels": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "system_allow_same_site_tunnels"
},
"route-consistency-check": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "system_route_consistency_check"
},
"idle-timeout": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 30,
"vipVariableName": "system_idle-timeout"
},
"admin-tech-on-failure": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "system_admin_tech_on_failure"
},
"region": {
"region-id": {
"id": {}
}
},
"role": {},
"on-demand": {
"enable": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "system_on-demand-enable"
},
"idle-timeout": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 20,
"vipVariableName": "system_on-demand-idle-timeout"
}
},
"tracker": {
"vipType": "constant",
"vipValue": [
{
"name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "interface",
"vipVariableName": "tracker_name"
},
"endpoint-ip": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "10.10.10.10",
"vipVariableName": "tracker_endpoint-ip"
},
"threshold": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 600,
"vipVariableName": "tracker_threshold"
},
"interval": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 120,
"vipVariableName": "tracker_interval"
},
"multiplier": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 6,
"vipVariableName": "tracker_multiplier"
},
"tracker-elements": {
"vipObjectType": "list",
"vipType": "ignore"
},
"boolean": {
"vipObjectType": "object",
"vipType": "ignore"
},
"tracker-type": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "interface",
"vipVariableName": "tracker_tracker_type_"
},
"priority-order": [
"name",
"tracker-type",
"tracker-elements",
"boolean",
"endpoint-ip",
"endpoint-dns-name",
"endpoint-api-url",
"endpoint-ip-transport-port",
"threshold",
"interval",
"multiplier"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"name"
]
},
"track-list": {
"vipType": "constant",
"vipValue": [
{
"list-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "tracker2",
"vipVariableName": "tracker_list_name_"
},
"interface": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"GigabitEthernet1"
],
"vipVariableName": "tracker_interface_"
},
"priority-order": [
"list-name",
"interface",
"sig-container"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"list-name"
]
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleSystemVedge"
},
"system-vsmart-example": {
"description": "system-vsmart-example",
"value": {
"templateName": "template_system_vsmart",
"templateDescription": "template_system_vsmart",
"templateType": "system-vsmart",
"deviceType": [
"vsmart"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"clock": {
"timezone": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "Asia/Chongqing",
"vipVariableName": "system_timezone"
}
},
"gps-location": {
"latitude": {
"vipObjectType": "object",
"vipType": "ignore",
"vipVariableName": "system_latitude"
},
"longitude": {
"vipObjectType": "object",
"vipType": "ignore",
"vipVariableName": "system_longitude"
}
},
"timer": {
"dns-cache-timeout": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 2,
"vipVariableName": "system_dns_cache_timeout"
}
},
"location": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "Shanghai",
"vipVariableName": "system_location"
},
"system-tunnel-mtu": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1024,
"vipVariableName": "system_system_tunnel_mtu"
},
"track-transport": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "system_track_transport"
},
"port-offset": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1,
"vipVariableName": "system_port_offset"
},
"port-hop": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "system_port_hop"
},
"control-session-pps": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 400,
"vipVariableName": "system_control_session_pps"
},
"controller-group-id": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1,
"vipVariableName": "system_controller_group_id"
},
"description": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "Description1",
"vipVariableName": "system_description"
},
"device-groups": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"group1"
],
"vipVariableName": "system_device_groups"
},
"site-id": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "100"
},
"overlay-id": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1,
"vipVariableName": "system_overlay_id"
},
"system-ip": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "172.16.255.15"
},
"host-name": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "vm5"
},
"ipv6-strict-control": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "system_ipv6_strict_control"
},
"track-default-gateway": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "system_track_default_gateway"
},
"host-policer-pps": {},
"icmp-error-pps": {},
"iptables-enable": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "system_iptables_enable"
},
"admin-tech-on-failure": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "system_admin_tech_on_failure"
},
"idle-timeout": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 60,
"vipVariableName": "system_idle-timeout"
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleSystemVsmart"
},
"t1-e1-controller-example": {
"description": "t1-e1-controller-example",
"value": {
"templateName": "template_t1e1_controller",
"templateDescription": "template_t1e1_controller",
"templateType": "t1-e1-controller",
"deviceType": [
"vedge-C8000V"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"card": {
"type": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "t1"
},
"slot": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 0
},
"bay": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1
}
},
"bandwidth-upstream": {},
"bandwidth-downstream": {},
"controller-tx-ex-list": {
"vipType": "constant",
"vipValue": [
{
"name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "T1"
},
"number": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "0/1/1"
},
"framing": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "esf",
"vipVariableName": "framing"
},
"clock": {
"source": {
"line": {
"line-mode": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "primary",
"vipVariableName": "line_mode"
}
},
"internal": {
"vipType": "ignore"
},
"loop-timed": {
"vipType": "ignore"
}
}
},
"description": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "Description1",
"vipVariableName": "description"
},
"linecode": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "ami",
"vipVariableName": "line_code"
},
"cablelength": {
"long": {
"vipType": "ignore"
},
"short": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "_empty",
"vipVariableName": "short_length"
}
},
"channel-group": {
"vipType": "ignore",
"vipValue": [],
"vipObjectType": "tree",
"vipPrimaryKey": [
"number"
]
},
"priority-order": [
"name",
"number",
"subSlot",
"framing",
"line-mode",
"internal",
"loop-timed",
"description",
"linecode",
"cablelength",
"clock",
"channel-group"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"name",
"number"
]
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleT1E1Controller"
},
"tenant-example": {
"description": "tenant-example",
"value": {
"templateName": "template_tenant",
"templateDescription": "template_tenant",
"templateType": "tenant",
"deviceType": [
"vedge-C8000V"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"tenant": {
"vipType": "constant",
"vipValue": [
{
"org-name": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "org_tenant"
}
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"org-name"
]
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleTenant"
},
"ucse-example": {
"description": "ucse-example",
"value": {
"templateName": "template_ucse",
"templateDescription": "template_ucse",
"templateType": "ucse",
"deviceType": [
"vedge-ISR-4461"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"bay": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1
},
"slot": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 3
},
"imc": {
"access-port": {
"dedicated": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": ""
},
"shared-lom": {
"ge1": {
"vipObjectType": "node-only",
"vipType": "ignore",
"vipValue": ""
},
"ge2": {
"vipObjectType": "node-only",
"vipType": "ignore",
"vipValue": ""
},
"ge3": {
"vipObjectType": "node-only",
"vipType": "ignore",
"vipValue": ""
},
"te2": {
"vipObjectType": "node-only",
"vipType": "ignore",
"vipValue": ""
},
"te3": {
"vipObjectType": "node-only",
"vipType": "ignore",
"vipValue": ""
},
"console": {
"vipObjectType": "node-only",
"vipType": "ignore",
"vipValue": ""
},
"failover": {
"ge2": {
"vipObjectType": "node-only",
"vipType": "ignore",
"vipValue": ""
},
"te2": {
"vipObjectType": "node-only",
"vipType": "ignore",
"vipValue": ""
}
}
}
},
"ip": {
"static-case": {
"address": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "10.10.10.10/24",
"vipVariableName": "ucse_address"
},
"default-gateway": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "10.10.10.1",
"vipVariableName": "ucse_default_gateway_default-gateway"
}
}
},
"vlan": {
"vlan-id": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 100,
"vipVariableName": "ucse_default_gateway_vlan-id"
},
"priority": {
"vipObjectType": "object",
"vipType": "ignore",
"vipVariableName": "ucse_default_gateway_priority"
}
}
},
"subslot-name": {
"vipValue": "1/3",
"vipType": "constant",
"vipObjectType": "object",
"vipVariableName": ""
},
"module-type": {
"vipValue": "ucse",
"vipType": "constant",
"vipObjectType": "object",
"vipVariableName": "ucse"
},
"interface": {
"vipType": "constant",
"vipValue": [
{
"if-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "ucse1/3/",
"vipVariableName": "ucse_if_if_name"
},
"switchport": {
"mode": {
"key": "mode",
"description": "Switch port type",
"details": "Set type of switch port: access/trunk",
"optionType": [
{
"value": "constant",
"display": "Global",
"iconClass": "language",
"iconColor": "icon-global"
}
],
"originalDefaultOption": "constant",
"defaultOption": "constant",
"dataType": {
"type": "enum",
"values": [
{
"key": "access",
"value": "access"
},
{
"key": "trunk",
"value": "trunk"
}
]
},
"dataPath": [
"switchport"
],
"vipObjectType": "object",
"objectType": "object",
"deleteFlag": false
},
"access": {
"vlan": {
"vlan": {
"key": "vlan",
"description": "VLAN ID",
"details": "Set VLAN identifier associated with bridging domain",
"optionType": [
{
"value": "constant",
"display": "Global",
"iconClass": "language",
"iconColor": "icon-global"
},
{
"value": "variable",
"display": "Device Specific",
"iconClass": "router",
"iconColor": "icon-variable"
},
{
"value": "ignore",
"display": "Default",
"iconClass": "check_circle",
"iconColor": "icon-default"
}
],
"originalDefaultOption": "ignore",
"defaultOption": "ignore",
"dataType": {
"type": "number",
"min": 1,
"max": 4094
},
"dataPath": [
"vlan"
],
"vipObjectType": "object",
"objectType": "object",
"deleteFlag": false
}
}
},
"trunk": {
"allowed": {
"vlan": {
"vlans": {
"key": "vlans",
"description": "Allowed VLANS",
"details": "Configure VLAN IDs used with the trunk",
"optionType": [
{
"value": "constant",
"display": "Global",
"iconClass": "language",
"iconColor": "icon-global"
},
{
"value": "variable",
"display": "Device Specific",
"iconClass": "router",
"iconColor": "icon-variable"
},
{
"value": "ignore",
"display": "Default",
"iconClass": "check_circle",
"iconColor": "icon-default"
}
],
"originalDefaultOption": "ignore",
"defaultOption": "ignore",
"dataType": {
"type": "string",
"range": "1-4094"
},
"dataPath": [
"vlan"
],
"vipObjectType": "object",
"objectType": "object",
"deleteFlag": false
}
}
},
"native": {
"vlan": {
"key": "vlan",
"description": "Native VLAN ID",
"details": "Configure VLAN ID used for native VLAN",
"optionType": [
{
"value": "constant",
"display": "Global",
"iconClass": "language",
"iconColor": "icon-global"
},
{
"value": "variable",
"display": "Device Specific",
"iconClass": "router",
"iconColor": "icon-variable"
},
{
"value": "ignore",
"display": "Default",
"iconClass": "check_circle",
"iconColor": "icon-default"
}
],
"originalDefaultOption": "ignore",
"defaultOption": "ignore",
"dataType": {
"type": "number",
"min": 1,
"max": 4094
},
"dataPath": [
"native"
],
"vipObjectType": "object",
"objectType": "object",
"deleteFlag": false
}
}
}
},
"ip": {
"static-case": {
"address": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "20.20.20.20/24",
"vipVariableName": "ucse_if_ipv4_address"
}
}
},
"priority-order": [
"if-name",
"shutdown",
"ip"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"if-name"
]
},
"priority-order": [
"subslot-name",
"bay",
"slot",
"imc",
"interface",
"module-type"
]
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleUcse"
},
"virtual-application-utd-example": {
"description": "virtual-application-utd-example",
"value": {
"templateName": "security_app_hosting",
"templateDescription": "security_app_hosting",
"templateType": "virtual-application-utd",
"deviceType": [
"vedge-CSR-1000v"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"virtual-application": {
"vipType": "constant",
"vipValue": [
{
"instance-id": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "6a0018c9-2083-4045-98ab-44a2f2457d9b",
"vipVariableName": "instance_id"
},
"application-type": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "utd",
"vipVariableName": "application_type"
},
"utd": {
"nat": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "nat"
},
"database-url": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "database_url"
},
"resource-profile": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "medium",
"vipVariableName": "resource_profile"
}
},
"priority-order": [
"instance-id",
"application-type",
"utd"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"instance-id"
]
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleVirtualApplicationUtd"
},
"vpn-cedge-interface-cellular-example": {
"description": "vpn-cedge-interface-cellular-example",
"value": {
"templateName": "vpn_interface_cellular",
"templateDescription": "vpn_interface_cellular",
"templateType": "vpn-cedge-interface-cellular",
"deviceType": [
"vedge-C8000V"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"if-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "GigabitEthernet1",
"vipVariableName": "vpn_if_name"
},
"description": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "basic_configuration",
"vipVariableName": "vpn_if_description"
},
"ip": {
"address": {}
},
"ipv6": {
"address": {},
"access-list": {
"vipType": "ignore",
"vipValue": [],
"vipObjectType": "tree",
"vipPrimaryKey": [
"direction"
]
}
},
"dhcp-helper": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"10.10.10.10"
],
"vipVariableName": "vpn_if_dhcp_helper"
},
"clear-dont-fragment": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_clear_dont_fragment"
},
"pmtu": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_pmtu"
},
"mtu": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1428,
"vipVariableName": "vpn_if_ip_mtu"
},
"static-ingress-qos": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "vpn_if_static_ingress_qos"
},
"tcp-mss-adjust": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1380,
"vipVariableName": "vpn_if_tcp_mss_adjust"
},
"shutdown": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "false",
"vipVariableName": "vpn_if_shutdown"
},
"arp-timeout": {},
"autonegotiate": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "vpn_if_autonegotiate"
},
"shaping-rate": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 100000,
"vipVariableName": "rewrite_shaping_rate"
},
"qos-map": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "qos-map"
},
"tracker": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"TRACKER2"
],
"vipVariableName": "vpn_if_tracker"
},
"bandwidth-upstream": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 100000,
"vipVariableName": "vpn_if_bandwidth_upstream"
},
"bandwidth-downstream": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 50000,
"vipVariableName": "vpn_if_bandwidth_downstream"
},
"block-non-source-ip": {},
"rewrite-rule": {
"rule-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "Rule1",
"vipVariableName": "rewrite_rule-name"
}
},
"tloc-extension": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "vpn_if_tloc_extension"
},
"icmp-redirect-disable": {},
"tloc-extension-gre-from": {
"src-ip": {},
"xconnect": {}
},
"access-list": {
"vipType": "constant",
"vipValue": [
{
"acl-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "10.10.10.10",
"vipVariableName": "access_list_ingress_acl_name_ipv4"
},
"direction": {
"vipType": "constant",
"vipValue": "in",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
},
{
"acl-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "20.20.20.20",
"vipVariableName": "access_list_egress_acl_name_ipv4"
},
"direction": {
"vipType": "constant",
"vipValue": "out",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"direction"
]
},
"policer": {
"vipType": "constant",
"vipValue": [
{
"policer-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "policer1",
"vipVariableName": "policer_ingress_policer_name"
},
"direction": {
"vipType": "constant",
"vipValue": "in",
"vipObjectType": "object"
},
"priority-order": [
"policer-name",
"direction"
]
},
{
"policer-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "policer2",
"vipVariableName": "policer_egress_policer_name"
},
"direction": {
"vipType": "constant",
"vipValue": "out",
"vipObjectType": "object"
},
"priority-order": [
"policer-name",
"direction"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"policer-name",
"direction"
]
},
"profile": {},
"technology": {},
"tunnel-interface": {
"encapsulation": {
"vipType": "constant",
"vipValue": [
{
"preference": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 7,
"vipVariableName": "vpn_if_tunnel_gre_preference"
},
"weight": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 10,
"vipVariableName": "vpn_if_tunnel_gre_weight"
},
"encap": {
"vipType": "constant",
"vipValue": "gre",
"vipObjectType": "object"
},
"priority-order": [
"encap",
"preference",
"weight"
]
},
{
"preference": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 5,
"vipVariableName": "vpn_if_tunnel_ipsec_preference"
},
"weight": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1,
"vipVariableName": "vpn_if_tunnel_ipsec_weight"
},
"encap": {
"vipType": "constant",
"vipValue": "ipsec",
"vipObjectType": "object"
},
"priority-order": [
"encap",
"preference",
"weight"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"encap"
]
},
"group": {
"vipObjectType": "list",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "vpn_if_tunnel_group"
},
"border": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_border"
},
"color": {
"value": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "3g",
"vipVariableName": "vpn_if_tunnel_color_value"
},
"restrict": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_color_restrict"
}
},
"carrier": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "carrier1",
"vipVariableName": "vpn_if_tunnel_carrier"
},
"bind": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "tunnel0",
"vipVariableName": "vpn_if_tunnel_bind"
},
"allow-service": {
"dhcp": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_dhcp"
},
"dns": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_dns"
},
"icmp": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_icmp"
},
"sshd": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_sshd"
},
"ntp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_ntp"
},
"stun": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_stun"
},
"all": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_all"
},
"bgp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_bgp"
},
"ospf": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_ospf"
},
"netconf": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_netconf"
},
"snmp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_snmp"
},
"https": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_https"
}
},
"max-control-connections": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 8,
"vipVariableName": "vpn_if_tunnel_max_control_connections"
},
"vbond-as-stun-server": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_vbond_as_stun_server"
},
"exclude-controller-group-list": {
"vipObjectType": "list",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "vpn_if_tunnel_exclude_controller_group_list"
},
"vmanage-connection-preference": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 6,
"vipVariableName": "vpn_if_tunnel_vmanage_connection_preference"
},
"port-hop": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_port_hop"
},
"low-bandwidth-link": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_low_bandwidth_link"
},
"last-resort-circuit": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_last-resort-circuit"
},
"hold-time": {},
"nat-refresh-interval": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 5,
"vipVariableName": "vpn_if_tunnel_nat_refresh_interval"
},
"hello-interval": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1000,
"vipVariableName": "vpn_if_tunnel_hello_interval"
},
"hello-tolerance": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 12,
"vipVariableName": "vpn_if_tunnel_hello_tolerance"
},
"tloc-extension-gre-to": {
"dst-ip": {}
},
"tunnel-qos": {
"mode": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "hub"
}
},
"tunnel-tcp-mss-adjust": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1400,
"vipVariableName": "vpn_if_tunnel_tunnel_tcp_mss_adjust"
},
"clear-dont-fragment": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_tunnel_clear_dont_fragment"
},
"network-broadcast": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_tunnel_network_broadcast"
}
},
"nat64-enable": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "false"
},
"ip-directed-broadcast": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_ip-directed-broadcast"
},
"qos-map-vpn": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "",
"vipVariableName": "vpn-qos_map"
},
"nat": {
"refresh": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "outbound",
"vipVariableName": "nat_refresh"
},
"log-translations": {},
"udp-timeout": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1,
"vipVariableName": "nat_udp_timeout"
},
"tcp-timeout": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 60,
"vipVariableName": "nat_tcp_timeout"
},
"block-icmp-error": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "nat_block_icmp_error"
},
"respond-to-ping": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "nat_respond_to_ping"
},
"natpool": {
"range-start": {},
"range-end": {}
},
"port-forward": {
"vipType": "ignore",
"vipValue": [],
"vipObjectType": "tree",
"vipPrimaryKey": [
"port-start",
"port-end",
"proto"
]
}
},
"arp": {
"ip": {
"vipType": "constant",
"vipValue": [
{
"addr": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "192.168.1.111",
"vipVariableName": "vpn_bridge_arp_addr"
},
"mac": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "00:00:00:00:00:01",
"vipVariableName": "vpn_bridge_arp_mac"
},
"priority-order": [
"addr",
"mac"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"addr"
]
}
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleVpnCedgeInterfaceCellular"
},
"vpn-cedge-interface-multilink-controller-example": {
"description": "vpn-cedge-interface-multilink-controller-example",
"value": {
"templateName": "vpn_interface_multilink",
"templateDescription": "vpn_interface_multilink",
"templateType": "vpn-cedge-interface-multilink-controller",
"deviceType": [
"vedge-C8000V"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"if-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "Multilink1",
"vipVariableName": "if_multilink_ctrl_if_name"
},
"ppp": {
"authentication": {
"method": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "chap"
},
"pap": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "false"
},
"callin": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "false",
"vipVariableName": "pppoa_dsl_auth-callin"
}
},
"chap": {
"hostname": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "vm5",
"vipVariableName": "pppoa_dsl_chap_hostname"
},
"password": {
"ppp-auth-password": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "123456789a",
"vipVariableName": "pppoa_dsl_ppp_auth_password"
}
}
},
"multilink": {
"group": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1,
"vipVariableName": "if_multilink_ctrl_multilink_group"
},
"fragment": {
"disable": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "if_multilink_fragment_disable_multilink_fragment_disable"
},
"delay": {
"delay-value": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 60,
"vipVariableName": "if_multilink_fragment_delay_value_multilink_fragment_delay_value"
}
}
},
"interleave": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "if_multilink_interleave_multilink_interleave"
}
}
},
"description": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "descrip1",
"vipVariableName": "if_multilink_ctrl_description"
},
"ip": {
"address": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "5.5.5.5/24",
"vipVariableName": "if_multilink_ctrl_ip_addr"
}
},
"ipv6": {
"address": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "2001:4860:4801:48::33/16",
"vipVariableName": "if_multilink_ctrl_ipv6_address"
},
"access-list": {
"vipType": "constant",
"vipValue": [
{
"acl-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": " 2001:4860:4801:48::55",
"vipVariableName": "access_list_ingress_acl_name_ipv6"
},
"direction": {
"vipType": "constant",
"vipValue": "in",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
},
{
"acl-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": " 2001:4860:4801:48::66",
"vipVariableName": "access_list_egress_acl_name_ipv6"
},
"direction": {
"vipType": "constant",
"vipValue": "out",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"direction"
]
}
},
"pmtu": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_pmtu"
},
"mtu": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1500,
"vipVariableName": "if_multilink_ctrl_mtu"
},
"static-ingress-qos": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1,
"vipVariableName": "vpn_if_static_ingress_qos"
},
"tcp-mss-adjust": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1300,
"vipVariableName": "vpn_if_tcp_mss_adjust"
},
"tloc-extension": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "tloc",
"vipVariableName": "vpn_if_tloc_extension"
},
"shutdown": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "false",
"vipVariableName": "if_multilink_ctrl_shutdown"
},
"autonegotiate": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "vpn_if_autonegotiate"
},
"shaping-rate": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 100000,
"vipVariableName": "qos_shaping-rate"
},
"qos-map": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "",
"vipVariableName": "qos-map"
},
"qos-map-vpn": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "q1",
"vipVariableName": "vpn-qos_map"
},
"bandwidth-upstream": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 100000,
"vipVariableName": "if_multilink_ctrl_bandwidth_upstream"
},
"bandwidth-downstream": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 200000,
"vipVariableName": "if_multilink_ctrl_bandwidth_downstream"
},
"rewrite-rule": {
"rule-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "r1",
"vipVariableName": "rewrite_rule-name"
}
},
"access-list": {
"vipType": "constant",
"vipValue": [
{
"acl-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "6.6.6.6/24",
"vipVariableName": "access_list_ingress_acl_name_ipv4"
},
"direction": {
"vipType": "constant",
"vipValue": "in",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
},
{
"acl-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "7.7.7.7/24",
"vipVariableName": "access_list_egress_acl_name_ipv4"
},
"direction": {
"vipType": "constant",
"vipValue": "out",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"direction"
]
},
"policer": {
"vipType": "constant",
"vipValue": [
{
"policer-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "policer1",
"vipVariableName": "policer_ingress_policer_name"
},
"direction": {
"vipType": "constant",
"vipValue": "in",
"vipObjectType": "object"
},
"priority-order": [
"policer-name",
"direction"
]
},
{
"policer-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "policer1",
"vipVariableName": "policer_egress_policer_name"
},
"direction": {
"vipType": "constant",
"vipValue": "out",
"vipObjectType": "object"
},
"priority-order": [
"policer-name",
"direction"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"policer-name",
"direction"
]
},
"tunnel-interface": {
"encapsulation": {
"vipType": "constant",
"vipValue": [
{
"preference": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 7,
"vipVariableName": "vpn_if_tunnel_gre_preference"
},
"weight": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 10,
"vipVariableName": "vpn_if_tunnel_gre_weight"
},
"encap": {
"vipType": "constant",
"vipValue": "gre",
"vipObjectType": "object"
},
"priority-order": [
"encap",
"preference",
"weight"
]
},
{
"preference": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 5,
"vipVariableName": "vpn_if_tunnel_ipsec_preference"
},
"weight": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 2,
"vipVariableName": "vpn_if_tunnel_ipsec_weight"
},
"encap": {
"vipType": "constant",
"vipValue": "ipsec",
"vipObjectType": "object"
},
"priority-order": [
"encap",
"preference",
"weight"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"encap"
]
},
"group": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"15"
],
"vipVariableName": "vpn_if_tunnel_group"
},
"border": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_border"
},
"color": {
"value": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "mpls",
"vipVariableName": "color_value"
},
"restrict": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_color_restrict"
}
},
"carrier": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "carrier5",
"vipVariableName": "vpn_if_tunnel_carrier"
},
"bind": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "tunnel1",
"vipVariableName": "vpn_if_tunnel_bind"
},
"allow-service": {
"dhcp": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_dhcp"
},
"dns": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_dns"
},
"icmp": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_icmp"
},
"sshd": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_sshd"
},
"ntp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_ntp"
},
"stun": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_stun"
},
"all": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_all"
},
"bgp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_bgp"
},
"ospf": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_ospf"
},
"netconf": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_netconf"
},
"snmp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_snmp"
},
"https": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true"
}
},
"max-control-connections": {
"vipObjectType": "object",
"vipType": "ignore",
"vipVariableName": "vpn_if_tunnel_max_control_connections"
},
"vbond-as-stun-server": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "false",
"vipVariableName": "vpn_if_tunnel_vbond_as_stun_server"
},
"exclude-controller-group-list": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"3"
],
"vipVariableName": "vpn_if_tunnel_exclude_controller_group_list"
},
"vmanage-connection-preference": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 7,
"vipVariableName": "vpn_if_tunnel_vmanage_connection_preference"
},
"port-hop": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_port_hop"
},
"low-bandwidth-link": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_low_bandwidth_link"
},
"last-resort-circuit": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_last_resort_circuit"
},
"hold-time": {},
"nat-refresh-interval": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 60,
"vipVariableName": "vpn_if_tunnel_nat_refresh_interval"
},
"hello-interval": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 600,
"vipVariableName": "vpn_if_tunnel_hello_interval"
},
"hello-tolerance": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 12,
"vipVariableName": "vpn_if_tunnel_hello_tolerance"
},
"tloc-extension-gre-to": {
"dst-ip": {}
},
"tunnel-tcp-mss-adjust": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1300,
"vipVariableName": "vpn_if_tunnel_tunnel_tcp_mss_adjust"
},
"clear-dont-fragment": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_tunnel_clear_dont_fragment"
},
"network-broadcast": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_tunnel_network_broadcast"
}
},
"nat64-enable": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "false"
},
"qos-adaptive": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "false",
"vipVariableName": "adaptive_qos"
},
"clear-dont-fragment": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_clear_dont_fragment"
},
"ip-directed-broadcast": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_ip-directed-broadcast"
},
"controller": {
"controller-tx-ex-list": {
"vipType": "constant",
"vipValue": [
{
"name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "T1"
},
"number": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "0/0/1"
},
"framing": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "ef",
"vipVariableName": "controller_tx_ex_list_framing"
},
"clock": {
"source": {
"line": {
"line-mode": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "primary",
"vipVariableName": "controller_tx_ex_list_line_mode"
}
},
"internal": {
"vipObjectType": "node-only",
"vipType": "ignore",
"vipValue": "",
"vipVariableName": "controller_tx_ex_list_controller_tx_ex_list_internal_0"
}
}
},
"description": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "descript1",
"vipVariableName": "controller_tx_ex_list_multilink_description"
},
"linecode": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "b8zs",
"vipVariableName": "controller_tx_ex_list_linecode"
},
"cablelength": {
"long": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "100",
"vipVariableName": "controller_tx_ex_list_long"
},
"short": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": ""
}
},
"channel-group": {
"vipType": "constant",
"vipValue": [
{
"number": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1,
"vipVariableName": "multilink_channel_group_number_0"
},
"timeslots": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": "2021-08-25",
"vipVariableName": "multilink_channel_group_timeslots_0"
},
"priority-order": [
"number",
"timeslots"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"number"
]
},
"priority-order": [
"name",
"number",
"framing",
"line-mode",
"internal",
"description",
"linecode",
"long",
"short",
"channel-group"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"name",
"number"
]
}
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleVpnCedgeInterfaceMultilinkController"
},
"vpn-interface-ethpppoe-example": {
"description": "vpn-interface-ethpppoe-example",
"value": {
"templateName": "vpn_interface_ethernet_pppoe",
"templateDescription": "vpn_interface_ethernet_pppoe",
"templateType": "vpn-interface-ethpppoe",
"deviceType": [
"vedge-ISR-4331"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"if-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "gi0/0/1",
"vipVariableName": "pppoe_dsl_if_name"
},
"shutdown": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "false",
"vipVariableName": "pppoe_dsl_shutdown"
},
"description": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "description1",
"vipVariableName": "pppoe_dsl_description"
},
"bridge-dot1q": {
"encap": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 123,
"vipVariableName": "pppoe_dsl_dot1q_encap"
}
},
"pppoe-client": {
"dial-pool-number": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 255,
"vipVariableName": "pppoe_dsl_dial_pool_number"
},
"ppp-max-payload": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 64,
"vipVariableName": "pppoe_dsl_ppp_max_payload"
}
},
"ip": {
"address-negotiated": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "true"
}
},
"shaping-rate": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "rewrite_shaping_rate"
},
"qos-map": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "map1",
"vipVariableName": "rewrite_qos_map"
},
"qos-map-vpn": {
"vipObjectType": "object",
"vipType": "ignore",
"vipVariableName": "vpn-qos_map"
},
"rewrite-rule": {
"rule-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "rul1",
"vipVariableName": "rewrite_rule_name"
}
},
"mtu": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1500,
"vipVariableName": "pppoe_dsl_ip_mtu"
},
"tcp-mss-adjust": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1400,
"vipVariableName": "pppoe_dsl_tcp_mss_adjust"
},
"tloc-extension": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "tloc1",
"vipVariableName": "pppoe_dsl_tloc_extension"
},
"tracker": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"trak1"
],
"vipVariableName": "pppoe_dsl_tracker"
},
"bandwidth-upstream": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 100000,
"vipVariableName": "pppoe_dsl_bandwidth_upstream"
},
"bandwidth-downstream": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 200000,
"vipVariableName": "pppoe_dsl_bandwidth_downstream"
},
"access-list": {
"vipType": "constant",
"vipValue": [
{
"acl-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "5.5.5.5",
"vipVariableName": "access_list_ingress_acl_name_ipv4"
},
"direction": {
"vipType": "constant",
"vipValue": "in",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
},
{
"acl-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "6.6.6.6",
"vipVariableName": "access_list_egress_acl_name_ipv4"
},
"direction": {
"vipType": "constant",
"vipValue": "out",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"direction"
]
},
"ipv6": {
"access-list": {
"vipType": "constant",
"vipValue": [
{
"acl-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "1050:0:0:0:5:600:300c:326b",
"vipVariableName": "access_list_ingress_acl_name_ipv6"
},
"direction": {
"vipType": "constant",
"vipValue": "in",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
},
{
"acl-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "1050:0:0:0:5:600:300c:3312",
"vipVariableName": "access_list_egress_acl_name_ipv6"
},
"direction": {
"vipType": "constant",
"vipValue": "out",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"direction"
]
}
},
"policer": {
"vipType": "constant",
"vipValue": [
{
"policer-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "policer1",
"vipVariableName": "policer_ingress_policer_name"
},
"direction": {
"vipType": "constant",
"vipValue": "in",
"vipObjectType": "object"
},
"priority-order": [
"policer-name",
"direction"
]
},
{
"policer-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "policer1",
"vipVariableName": "policer_egress_policer_name"
},
"direction": {
"vipType": "constant",
"vipValue": "out",
"vipObjectType": "object"
},
"priority-order": [
"policer-name",
"direction"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"policer-name",
"direction"
]
},
"tunnel-interface": {
"encapsulation": {
"vipType": "constant",
"vipValue": [
{
"preference": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 7,
"vipVariableName": "vpn_if_tunnel_gre_preference"
},
"weight": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 2,
"vipVariableName": "vpn_if_tunnel_gre_weight"
},
"encap": {
"vipType": "constant",
"vipValue": "gre",
"vipObjectType": "object"
},
"priority-order": [
"encap",
"preference",
"weight"
]
},
{
"preference": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 7,
"vipVariableName": "vpn_if_tunnel_ipsec_preference"
},
"weight": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 2,
"vipVariableName": "vpn_if_tunnel_ipsec_weight"
},
"encap": {
"vipType": "constant",
"vipValue": "ipsec",
"vipObjectType": "object"
},
"priority-order": [
"encap",
"preference",
"weight"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"encap"
]
},
"group": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"4"
],
"vipVariableName": "vpn_if_tunnel_group"
},
"border": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_border"
},
"color": {
"value": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "biz-internet",
"vipVariableName": "color_value"
},
"restrict": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_color_restrict"
}
},
"carrier": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "carrier8",
"vipVariableName": "vpn_if_tunnel_carrier"
},
"bind": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "0",
"vipVariableName": "vpn_if_tunnel_bind"
},
"allow-service": {
"dhcp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_dhcp"
},
"dns": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_dns"
},
"icmp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_icmp"
},
"sshd": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_sshd"
},
"ntp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_ntp"
},
"stun": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_stun"
},
"all": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_all"
},
"bgp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_bgp"
},
"ospf": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_ospf"
},
"netconf": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_netconf"
},
"snmp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_snmp"
},
"https": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true"
}
},
"max-control-connections": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 8,
"vipVariableName": "vpn_if_tunnel_max_control_connections"
},
"vbond-as-stun-server": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_vbond_as_stun_server"
},
"exclude-controller-group-list": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"4"
],
"vipVariableName": "vpn_if_tunnel_exclude_controller_group_list"
},
"vmanage-connection-preference": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 5,
"vipVariableName": "vpn_if_tunnel_vmanage_connection_preference"
},
"port-hop": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_port_hop"
},
"low-bandwidth-link": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_low_bandwidth_link"
},
"last-resort-circuit": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_last_resort_circuit"
},
"hold-time": {},
"nat-refresh-interval": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 60,
"vipVariableName": "vpn_if_tunnel_nat_refresh_interval"
},
"hello-interval": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 600,
"vipVariableName": "vpn_if_tunnel_hello_interval"
},
"hello-tolerance": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 12,
"vipVariableName": "vpn_if_tunnel_hello_tolerance"
},
"tloc-extension-gre-to": {
"dst-ip": {}
},
"tunnel-tcp-mss-adjust": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1300,
"vipVariableName": "vpn_if_tunnel_tunnel_tcp_mss_adjust"
},
"clear-dont-fragment": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_tunnel_clear_dont_fragment"
},
"network-broadcast": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_tunnel_network_broadcast"
}
},
"nat64-enable": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "false"
},
"ppp": {
"authentication": {
"method": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "chap"
},
"pap": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "false"
},
"callin": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "false",
"vipVariableName": "pppoe_dsl_auth-callin"
}
},
"chap": {
"hostname": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "host_zzz",
"vipVariableName": "pppoe_dsl_chap_hostname"
},
"password": {
"ppp-auth-password": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "123456789a",
"vipVariableName": "pppoe_dsl_chap_auth_password"
}
}
}
},
"ip-directed-broadcast": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_ip-directed-broadcast"
},
"qos-adaptive": {
"period": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 10,
"vipVariableName": "qos_adaptive_period"
},
"downstream": {
"bandwidth-down": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1000,
"vipVariableName": "qos_adaptive_downstream_bandwidth_down"
},
"range": {
"dmin": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1000,
"vipVariableName": "qos_adaptive_downstream_range_dmin"
},
"dmax": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 2000,
"vipVariableName": "qos_adaptive_downstream_range_dmax"
}
}
},
"upstream": {
"bandwidth-up": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1000,
"vipVariableName": "qos_adaptive_upstream_bandwidth_up"
},
"range": {
"umin": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1000,
"vipVariableName": "qos_adaptive_upstream_range_umin"
},
"umax": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 2000,
"vipVariableName": "qos_adaptive_upstream_range_umax"
}
}
}
},
"nat": {
"log-translations": {},
"udp-timeout": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 2,
"vipVariableName": "nat_udp_timeout"
},
"tcp-timeout": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 60,
"vipVariableName": "nat_tcp_timeout"
},
"natpool": {
"range-start": {},
"range-end": {}
}
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleVpnInterfaceEthpppoe"
},
"vpn-interface-ipoe-example": {
"description": "vpn-interface-ipoe-example",
"value": {
"templateName": "vpn_interface_dsl_ipoe",
"templateDescription": "vpn_interface_dsl_ipoe",
"templateType": "vpn-interface-ipoe",
"deviceType": [
"vedge-C1117-4PLTEEAW"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"if-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "Ethernet1/0/0",
"vipVariableName": "pppoe_dsl_if_name"
},
"bridge-dot1q": {
"encap": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 111,
"vipVariableName": "pppoe_dsl_dot1q_encap"
}
},
"shutdown": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "false",
"vipVariableName": "pppoe_dsl_shutdown"
},
"description": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "descrip1",
"vipVariableName": "pppoe_dsl_description"
},
"pppoe-client": {
"ppp-max-payload": {},
"dial-pool-number": {}
},
"ip": {
"address-negotiated": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "true"
},
"dhcp-client": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true"
},
"dhcp-distance": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 2,
"vipVariableName": "vpn_if_ipv4_dhcp_distance"
}
},
"shaping-rate": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "rewrite_shaping_rate"
},
"qos-map": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "map1",
"vipVariableName": "rewrite_qos_map"
},
"qos-map-vpn": {
"vipObjectType": "object",
"vipType": "ignore",
"vipVariableName": "vpn-qos_map"
},
"rewrite-rule": {
"rule-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "rule1",
"vipVariableName": "rewrite_rule_name"
}
},
"mtu": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1500,
"vipVariableName": "pppoe_dsl_ip_mtu"
},
"tcp-mss-adjust": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1400,
"vipVariableName": "pppoe_dsl_tcp_mss_adjust"
},
"tloc-extension": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "tloc",
"vipVariableName": "pppoe_dsl_tloc_extension"
},
"tracker": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"tracker1"
],
"vipVariableName": "pppoe_dsl_tracker"
},
"bandwidth-upstream": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 100000,
"vipVariableName": "pppoe_dsl_bandwidth_upstream"
},
"bandwidth-downstream": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 100000,
"vipVariableName": "pppoe_dsl_bandwidth_downstream"
},
"access-list": {
"vipType": "constant",
"vipValue": [
{
"acl-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "5.5.5.5",
"vipVariableName": "access_list_ingress_acl_name_ipv4"
},
"direction": {
"vipType": "constant",
"vipValue": "in",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
},
{
"acl-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "6.6.6.6",
"vipVariableName": "access_list_egress_acl_name_ipv4"
},
"direction": {
"vipType": "constant",
"vipValue": "out",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"direction"
]
},
"ipv6": {
"access-list": {
"vipType": "constant",
"vipValue": [
{
"acl-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "1050:0:0:0:5:600:300c:326b",
"vipVariableName": "access_list_ingress_acl_name_ipv6"
},
"direction": {
"vipType": "constant",
"vipValue": "in",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
},
{
"acl-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "1050:0:0:0:5:600:300c:947e",
"vipVariableName": "access_list_egress_acl_name_ipv6"
},
"direction": {
"vipType": "constant",
"vipValue": "out",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"direction"
]
}
},
"policer": {
"vipType": "constant",
"vipValue": [
{
"policer-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "policer1",
"vipVariableName": "policer_ingress_policer_name"
},
"direction": {
"vipType": "constant",
"vipValue": "in",
"vipObjectType": "object"
},
"priority-order": [
"policer-name",
"direction"
]
},
{
"policer-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "policer1",
"vipVariableName": "policer_egress_policer_name"
},
"direction": {
"vipType": "constant",
"vipValue": "out",
"vipObjectType": "object"
},
"priority-order": [
"policer-name",
"direction"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"policer-name",
"direction"
]
},
"tunnel-interface": {
"encapsulation": {
"vipType": "constant",
"vipValue": [
{
"preference": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 10,
"vipVariableName": "vpn_if_tunnel_gre_preference"
},
"weight": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 2,
"vipVariableName": "vpn_if_tunnel_gre_weight"
},
"encap": {
"vipType": "constant",
"vipValue": "gre",
"vipObjectType": "object"
},
"priority-order": [
"encap",
"preference",
"weight"
]
},
{
"preference": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 6,
"vipVariableName": "vpn_if_tunnel_ipsec_preference"
},
"weight": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 2,
"vipVariableName": "vpn_if_tunnel_ipsec_weight"
},
"encap": {
"vipType": "constant",
"vipValue": "ipsec",
"vipObjectType": "object"
},
"priority-order": [
"encap",
"preference",
"weight"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"encap"
]
},
"group": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"14"
],
"vipVariableName": "vpn_if_tunnel_group"
},
"border": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_border"
},
"color": {
"value": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "lte",
"vipVariableName": "color_value"
},
"restrict": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_color_restrict"
}
},
"carrier": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "carrier3",
"vipVariableName": "vpn_if_tunnel_carrier"
},
"bind": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "tunnel1",
"vipVariableName": "vpn_if_tunnel_bind"
},
"allow-service": {
"dhcp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_dhcp"
},
"dns": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_dns"
},
"icmp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_icmp"
},
"sshd": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_sshd"
},
"ntp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_ntp"
},
"stun": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_stun"
},
"all": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_all"
},
"bgp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_bgp"
},
"ospf": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_ospf"
},
"netconf": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_netconf"
},
"snmp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_snmp"
},
"https": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "false"
}
},
"max-control-connections": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 8,
"vipVariableName": "vpn_if_tunnel_max_control_connections"
},
"vbond-as-stun-server": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_vbond_as_stun_server"
},
"exclude-controller-group-list": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"9"
],
"vipVariableName": "vpn_if_tunnel_exclude_controller_group_list"
},
"vmanage-connection-preference": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 7,
"vipVariableName": "vpn_if_tunnel_vmanage_connection_preference"
},
"port-hop": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_port_hop"
},
"low-bandwidth-link": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_low_bandwidth_link"
},
"last-resort-circuit": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_last_resort_circuit"
},
"hold-time": {},
"nat-refresh-interval": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 10,
"vipVariableName": "vpn_if_tunnel_nat_refresh_interval"
},
"hello-interval": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 600,
"vipVariableName": "vpn_if_tunnel_hello_interval"
},
"hello-tolerance": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 12,
"vipVariableName": "vpn_if_tunnel_hello_tolerance"
},
"tloc-extension-gre-to": {
"dst-ip": {}
},
"tunnel-tcp-mss-adjust": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1380,
"vipVariableName": "vpn_if_tunnel_tunnel_tcp_mss_adjust"
},
"clear-dont-fragment": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_tunnel_clear_dont_fragment"
},
"network-broadcast": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_tunnel_network_broadcast"
}
},
"nat64-enable": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "false"
},
"ppp": {
"authentication": {
"method": {},
"pap": {}
},
"chap": {
"hostname": {},
"password": {
"ppp-auth-password": {}
}
},
"pap": {
"sent-username": {
"username": {
"username-string": {},
"password": {},
"ppp-auth-password": {}
}
}
}
},
"dhcp-helper": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"1.1.1.1"
],
"vipVariableName": "vpn_if_dhcp_helper"
},
"controller-type": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "ipoe",
"vipVariableName": "ipoe"
},
"ip-directed-broadcast": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_ip-directed-broadcast"
},
"qos-adaptive": {
"period": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 15,
"vipVariableName": "qos_adaptive_period"
},
"downstream": {
"bandwidth-down": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 200,
"vipVariableName": "qos_adaptive_downstream_bandwidth_down"
},
"range": {
"dmin": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 200,
"vipVariableName": "qos_adaptive_downstream_range_dmin"
},
"dmax": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 300,
"vipVariableName": "qos_adaptive_downstream_range_dmax"
}
}
},
"upstream": {
"bandwidth-up": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 100,
"vipVariableName": "qos_adaptive_upstream_bandwidth_up"
},
"range": {
"umin": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 100,
"vipVariableName": "qos_adaptive_upstream_range_umin"
},
"umax": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 200,
"vipVariableName": "qos_adaptive_upstream_range_umax"
}
}
}
},
"controller": {
"vdsl": {
"vipType": "constant",
"vipValue": [
{
"modem": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "2",
"vipVariableName": "pppoe_dsl_modem"
},
"name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "1",
"vipVariableName": "pppoe_dsl_vdsl_name"
},
"sra": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "pppoe_dsl_sra"
},
"operating": {
"mode": {
"auto": {
"adsl2plus": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "true"
}
}
}
},
"priority-order": [
"name",
"sra",
"operating",
"modem"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"name"
]
}
},
"nat": {
"log-translations": {},
"udp-timeout": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 30,
"vipVariableName": "nat_udp_timeout"
},
"tcp-timeout": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 60,
"vipVariableName": "nat_tcp_timeout"
},
"natpool": {
"range-start": {},
"range-end": {}
}
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleVpnInterfaceIpoe"
},
"vpn-interface-pppoa-example": {
"description": "vpn-interface-pppoa-example",
"value": {
"templateName": "template_vpn_interface_pppoa",
"templateDescription": "template_vpn_interface_pppoa",
"templateType": "vpn-interface-pppoa",
"deviceType": [
"vedge-ISR-4331"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"if-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "ATM1/0/0",
"vipVariableName": "pppoa_dsl_if_name"
},
"shutdown": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "false",
"vipVariableName": "pppoa_dsl_shutdown"
},
"description": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "atm",
"vipVariableName": "pppoa_dsl_description"
},
"bandwidth-upstream": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 10000,
"vipVariableName": "pppoa_dsl_bandwidth_upstream"
},
"bandwidth-downstream": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 20000,
"vipVariableName": "pppoa_dsl_bandwidth_downstream"
},
"mtu": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1500,
"vipVariableName": "pppoa_dsl_ip_mtu"
},
"tcp-mss-adjust": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1400,
"vipVariableName": "pppoa_dsl_tcp_mss_adjust"
},
"tloc-extension": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "tloc",
"vipVariableName": "pppoa_dsl_tloc_extension"
},
"tracker": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"trak1"
],
"vipVariableName": "pppoa_dsl_tracker"
},
"shaping-rate": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "rewrite_shaping_rate"
},
"qos-map": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "m1",
"vipVariableName": "rewrite_qos_map"
},
"qos-map-vpn": {
"vipObjectType": "object",
"vipType": "ignore",
"vipVariableName": "vpn-qos_map"
},
"rewrite-rule": {
"rule-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "r1",
"vipVariableName": "rewrite_rule_name"
}
},
"access-list": {
"vipType": "constant",
"vipValue": [
{
"acl-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "11.11.11.11",
"vipVariableName": "access_list_ingress_acl_name_ipv4"
},
"direction": {
"vipType": "constant",
"vipValue": "in",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
},
{
"acl-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "22.22.22.22",
"vipVariableName": "access_list_egress_acl_name_ipv4"
},
"direction": {
"vipType": "constant",
"vipValue": "out",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"direction"
]
},
"ipv6": {
"access-list": {
"vipType": "constant",
"vipValue": [
{
"acl-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "1050:0:0:0:5:600:300c:326b",
"vipVariableName": "access_list_ingress_acl_name_ipv6"
},
"direction": {
"vipType": "constant",
"vipValue": "in",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
},
{
"acl-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "1050:0:0:0:5:600:300c:4412",
"vipVariableName": "access_list_egress_acl_name_ipv6"
},
"direction": {
"vipType": "constant",
"vipValue": "out",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"direction"
]
}
},
"policer": {
"vipType": "constant",
"vipValue": [
{
"policer-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "poli1",
"vipVariableName": "policer_ingress_policer_name"
},
"direction": {
"vipType": "constant",
"vipValue": "in",
"vipObjectType": "object"
},
"priority-order": [
"policer-name",
"direction"
]
},
{
"policer-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "poli1",
"vipVariableName": "policer_egress_policer_name"
},
"direction": {
"vipType": "constant",
"vipValue": "out",
"vipObjectType": "object"
},
"priority-order": [
"policer-name",
"direction"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"policer-name",
"direction"
]
},
"tunnel-interface": {
"encapsulation": {
"vipType": "constant",
"vipValue": [
{
"preference": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 4,
"vipVariableName": "vpn_if_tunnel_gre_preference"
},
"weight": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 2,
"vipVariableName": "vpn_if_tunnel_gre_weight"
},
"encap": {
"vipType": "constant",
"vipValue": "gre",
"vipObjectType": "object"
},
"priority-order": [
"encap",
"preference",
"weight"
]
},
{
"preference": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 7,
"vipVariableName": "vpn_if_tunnel_ipsec_preference"
},
"weight": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 3,
"vipVariableName": "vpn_if_tunnel_ipsec_weight"
},
"encap": {
"vipType": "constant",
"vipValue": "ipsec",
"vipObjectType": "object"
},
"priority-order": [
"encap",
"preference",
"weight"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"encap"
]
},
"group": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"2"
],
"vipVariableName": "vpn_if_tunnel_group"
},
"border": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_border"
},
"color": {
"value": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "gold",
"vipVariableName": "color_value"
},
"restrict": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_color_restrict"
}
},
"carrier": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "carrier3",
"vipVariableName": "vpn_if_tunnel_carrier"
},
"bind": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "tunnel2",
"vipVariableName": "vpn_if_tunnel_bind"
},
"allow-service": {
"dhcp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_dhcp"
},
"dns": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_dns"
},
"icmp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_icmp"
},
"sshd": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_sshd"
},
"ntp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_ntp"
},
"stun": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_stun"
},
"all": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_all"
},
"bgp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_bgp"
},
"ospf": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_ospf"
},
"netconf": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_netconf"
},
"snmp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_snmp"
},
"https": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true"
}
},
"max-control-connections": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 6,
"vipVariableName": "vpn_if_tunnel_max_control_connections"
},
"vbond-as-stun-server": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_vbond_as_stun_server"
},
"exclude-controller-group-list": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"3"
],
"vipVariableName": "vpn_if_tunnel_exclude_controller_group_list"
},
"vmanage-connection-preference": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 7,
"vipVariableName": "vpn_if_tunnel_vmanage_connection_preference"
},
"port-hop": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_port_hop"
},
"low-bandwidth-link": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_low_bandwidth_link"
},
"last-resort-circuit": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_last_resort_circuit"
},
"hold-time": {},
"nat-refresh-interval": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 10,
"vipVariableName": "vpn_if_tunnel_nat_refresh_interval"
},
"hello-interval": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1000,
"vipVariableName": "vpn_if_tunnel_hello_interval"
},
"hello-tolerance": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 12,
"vipVariableName": "vpn_if_tunnel_hello_tolerance"
},
"tloc-extension-gre-to": {
"dst-ip": {}
},
"tunnel-tcp-mss-adjust": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1350,
"vipVariableName": "vpn_if_tunnel_tunnel_tcp_mss_adjust"
},
"clear-dont-fragment": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_tunnel_clear_dont_fragment"
},
"network-broadcast": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_tunnel_network_broadcast"
}
},
"nat64-enable": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "false"
},
"ppp": {
"authentication": {
"method": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "chap"
},
"pap": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "false"
},
"callin": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "callin",
"vipVariableName": "pppoa_dsl_pap_auth_callin"
}
},
"chap": {
"hostname": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "cisco",
"vipVariableName": "pppoa_dsl_chap_hostname"
},
"password": {
"ppp-auth-password": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "cisco123456",
"vipVariableName": "pppoa_dsl_ppp_auth_password"
}
}
}
},
"ip-directed-broadcast": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_ip-directed-broadcast"
},
"qos-adaptive": {
"period": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 10,
"vipVariableName": "qos_adaptive_period"
},
"downstream": {
"bandwidth-down": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 15,
"vipVariableName": "qos_adaptive_downstream_bandwidth_down"
},
"range": {
"dmin": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 10,
"vipVariableName": "qos_adaptive_downstream_range_dmin"
},
"dmax": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 20,
"vipVariableName": "qos_adaptive_downstream_range_dmax"
}
}
},
"upstream": {
"bandwidth-up": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 10,
"vipVariableName": "qos_adaptive_upstream_bandwidth_up"
},
"range": {
"umin": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 10,
"vipVariableName": "qos_adaptive_upstream_range_umin"
},
"umax": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 20,
"vipVariableName": "qos_adaptive_upstream_range_umax"
}
}
}
},
"controller": {
"vdsl": {
"vipType": "constant",
"vipValue": [
{
"modem": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "configuration",
"vipVariableName": "pppoa_dsl_modem"
},
"name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "1",
"vipVariableName": "pppoa_dsl_vdsl_name"
},
"sra": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "pppoa_dsl_sra"
},
"operating": {
"mode": {
"auto": {
"adsl2plus": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "true"
}
}
}
},
"priority-order": [
"name",
"sra",
"operating",
"modem"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"name"
]
}
},
"pvc": {
"vipType": "constant",
"vipValue": [
{
"local-vpi-vci": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "1/1",
"vipVariableName": "pppoa_dsl_local_vpi_vci"
},
"dialer": {
"pool-member": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 4,
"vipVariableName": "pppoa_dsl_pool_member"
}
},
"encapsulation": {
"aal5nlpid": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "true"
}
},
"priority-order": [
"local-vpi-vci",
"vbr-nrt",
"vbr-rt",
"encapsulation",
"dialer"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"local-vpi-vci"
]
},
"nat": {
"log-translations": {},
"udp-timeout": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 30,
"vipVariableName": "nat_udp_timeout"
},
"tcp-timeout": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 60,
"vipVariableName": "nat_tcp_timeout"
},
"natpool": {
"range-start": {},
"range-end": {}
}
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleVpnInterfacePppoa"
},
"vpn-interface-pppoe-example": {
"description": "vpn-interface-pppoe-example",
"value": {
"templateName": "template_interface_dsl_pppoe",
"templateDescription": "template_interface_dsl_pppoe",
"templateType": "vpn-interface-pppoe",
"deviceType": [
"vedge-ISR-4331"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"if-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "Ethernet1/0/0",
"vipVariableName": "pppoe_dsl_if_name"
},
"bridge-dot1q": {
"encap": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 22,
"vipVariableName": "pppoe_dsl_dot1q_encap"
}
},
"shutdown": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "false",
"vipVariableName": "pppoe_dsl_shutdown"
},
"description": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "description1",
"vipVariableName": "pppoe_dsl_description"
},
"pppoe-client": {
"ppp-max-payload": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 64,
"vipVariableName": "pppoe_dsl_ppp_max_payload"
},
"dial-pool-number": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 200,
"vipVariableName": "pppoe_dsl_dial_pool_number"
}
},
"ip": {
"address-negotiated": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "true"
}
},
"shaping-rate": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "rewrite_shaping_rate"
},
"qos-map": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "m1",
"vipVariableName": "rewrite_qos_map"
},
"qos-map-vpn": {
"vipObjectType": "object",
"vipType": "ignore",
"vipVariableName": "vpn-qos_map"
},
"rewrite-rule": {
"rule-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "rul1",
"vipVariableName": "rewrite_rule_name"
}
},
"mtu": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1500,
"vipVariableName": "pppoe_dsl_ip_mtu"
},
"tcp-mss-adjust": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1480,
"vipVariableName": "pppoe_dsl_tcp_mss_adjust"
},
"tloc-extension": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "tloc",
"vipVariableName": "pppoe_dsl_tloc_extension"
},
"tracker": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"tracker1"
],
"vipVariableName": "pppoe_dsl_tracker"
},
"bandwidth-upstream": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 100000,
"vipVariableName": "pppoe_dsl_bandwidth_upstream"
},
"bandwidth-downstream": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 200000,
"vipVariableName": "pppoe_dsl_bandwidth_downstream"
},
"access-list": {
"vipType": "constant",
"vipValue": [
{
"acl-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "5.5.5.5",
"vipVariableName": "access_list_ingress_acl_name_ipv4"
},
"direction": {
"vipType": "constant",
"vipValue": "in",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
},
{
"acl-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "6.6.6.6",
"vipVariableName": "access_list_egress_acl_name_ipv4"
},
"direction": {
"vipType": "constant",
"vipValue": "out",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"direction"
]
},
"ipv6": {
"access-list": {
"vipType": "constant",
"vipValue": [
{
"acl-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "1050:0:0:0:5:600:300c:326b",
"vipVariableName": "access_list_ingress_acl_name_ipv6"
},
"direction": {
"vipType": "constant",
"vipValue": "in",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
},
{
"acl-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "1050:0:0:0:5:600:300c:4436",
"vipVariableName": "access_list_egress_acl_name_ipv6"
},
"direction": {
"vipType": "constant",
"vipValue": "out",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"direction"
]
}
},
"policer": {
"vipType": "constant",
"vipValue": [
{
"policer-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "policer1",
"vipVariableName": "policer_ingress_policer_name"
},
"direction": {
"vipType": "constant",
"vipValue": "in",
"vipObjectType": "object"
},
"priority-order": [
"policer-name",
"direction"
]
},
{
"policer-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "policer1",
"vipVariableName": "policer_egress_policer_name"
},
"direction": {
"vipType": "constant",
"vipValue": "out",
"vipObjectType": "object"
},
"priority-order": [
"policer-name",
"direction"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"policer-name",
"direction"
]
},
"tunnel-interface": {
"encapsulation": {
"vipType": "constant",
"vipValue": [
{
"preference": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 4,
"vipVariableName": "vpn_if_tunnel_gre_preference"
},
"weight": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1,
"vipVariableName": "vpn_if_tunnel_gre_weight"
},
"encap": {
"vipType": "constant",
"vipValue": "gre",
"vipObjectType": "object"
},
"priority-order": [
"encap",
"preference",
"weight"
]
},
{
"preference": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 7,
"vipVariableName": "vpn_if_tunnel_ipsec_preference"
},
"weight": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 2,
"vipVariableName": "vpn_if_tunnel_ipsec_weight"
},
"encap": {
"vipType": "constant",
"vipValue": "ipsec",
"vipObjectType": "object"
},
"priority-order": [
"encap",
"preference",
"weight"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"encap"
]
},
"group": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"22"
],
"vipVariableName": "vpn_if_tunnel_group"
},
"border": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_border"
},
"color": {
"value": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "lte",
"vipVariableName": "color_value"
},
"restrict": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_color_restrict"
}
},
"carrier": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "carrier1",
"vipVariableName": "vpn_if_tunnel_carrier"
},
"bind": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "tunnel1",
"vipVariableName": "vpn_if_tunnel_bind"
},
"allow-service": {
"dhcp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_dhcp"
},
"dns": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_dns"
},
"icmp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_icmp"
},
"sshd": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_sshd"
},
"ntp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_ntp"
},
"stun": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_stun"
},
"all": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_all"
},
"bgp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_bgp"
},
"ospf": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_ospf"
},
"netconf": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_netconf"
},
"snmp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_snmp"
},
"https": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "false"
}
},
"max-control-connections": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 8,
"vipVariableName": "vpn_if_tunnel_max_control_connections"
},
"vbond-as-stun-server": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_vbond_as_stun_server"
},
"exclude-controller-group-list": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"13"
],
"vipVariableName": "vpn_if_tunnel_exclude_controller_group_list"
},
"vmanage-connection-preference": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 7,
"vipVariableName": "vpn_if_tunnel_vmanage_connection_preference"
},
"port-hop": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_port_hop"
},
"low-bandwidth-link": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_low_bandwidth_link"
},
"last-resort-circuit": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_last_resort_circuit"
},
"hold-time": {},
"nat-refresh-interval": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 6,
"vipVariableName": "vpn_if_tunnel_nat_refresh_interval"
},
"hello-interval": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 600,
"vipVariableName": "vpn_if_tunnel_hello_interval"
},
"hello-tolerance": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 12,
"vipVariableName": "vpn_if_tunnel_hello_tolerance"
},
"tloc-extension-gre-to": {
"dst-ip": {}
},
"tunnel-tcp-mss-adjust": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1380,
"vipVariableName": "vpn_if_tunnel_tunnel_tcp_mss_adjust"
},
"clear-dont-fragment": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_tunnel_clear_dont_fragment"
},
"network-broadcast": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_tunnel_network_broadcast"
}
},
"nat64-enable": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "false"
},
"ppp": {
"authentication": {
"method": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "chap"
},
"pap": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "false"
},
"callin": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "callin",
"vipVariableName": "pppoa_dsl_pap_auth_callin"
}
},
"chap": {
"hostname": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "host_aaa",
"vipVariableName": "pppoe_dsl_chap_hostname"
},
"password": {
"ppp-auth-password": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "123456789a",
"vipVariableName": "pppoe_dsl_ppp_auth_password"
}
}
}
},
"ip-directed-broadcast": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_ip-directed-broadcast"
},
"qos-adaptive": {
"period": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 12,
"vipVariableName": "qos_adaptive_period"
},
"downstream": {
"bandwidth-down": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 300,
"vipVariableName": "qos_adaptive_downstream_bandwidth_down"
},
"range": {
"dmin": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 200,
"vipVariableName": "qos_adaptive_downstream_range_dmin"
},
"dmax": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 400,
"vipVariableName": "qos_adaptive_downstream_range_dmax"
}
}
},
"upstream": {
"bandwidth-up": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 200,
"vipVariableName": "qos_adaptive_upstream_bandwidth_up"
},
"range": {
"umin": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 100,
"vipVariableName": "qos_adaptive_upstream_range_umin"
},
"umax": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 300,
"vipVariableName": "qos_adaptive_upstream_range_umax"
}
}
}
},
"controller": {
"vdsl": {
"vipType": "constant",
"vipValue": [
{
"modem": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "config",
"vipVariableName": "pppoe_dsl_modem"
},
"name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "1",
"vipVariableName": "pppoe_dsl_vdsl_name"
},
"sra": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "false",
"vipVariableName": "pppoe_dsl_sra"
},
"operating": {
"mode": {
"auto": {
"adsl2plus": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "true"
}
}
}
},
"priority-order": [
"name",
"sra",
"operating",
"modem"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"name"
]
}
},
"nat": {
"log-translations": {},
"udp-timeout": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 10,
"vipVariableName": "nat_udp_timeout"
},
"tcp-timeout": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 120,
"vipVariableName": "nat_tcp_timeout"
},
"natpool": {
"range-start": {},
"range-end": {}
}
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleVpnInterfacePppoe"
},
"vpn-interface-svi-example": {
"description": "vpn-interface-svi-example",
"value": {
"templateName": "vpn_interface_svi",
"templateDescription": "vpn_interface_svi",
"templateType": "vpn-interface-svi",
"deviceType": [
"vedge-C8000V"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"if-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "Vlan100",
"vipVariableName": "vpn_if_svi_if_name"
},
"description": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "GigabitEthernet1",
"vipVariableName": "vpn_if_svi_description"
},
"ip": {
"address": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "1.1.1.1/24",
"vipVariableName": "vpn_if_svi_if_ipv4_prefix"
},
"secondary-address": {
"vipType": "ignore",
"vipValue": [],
"vipObjectType": "tree",
"vipPrimaryKey": [
"address"
]
}
},
"ipv6": {
"address": {
"vipObjectType": "object",
"vipType": "ignore",
"vipVariableName": "vpn_if_svi_ipv6_ipv6_address"
},
"secondary-address": {
"vipType": "ignore",
"vipValue": [],
"vipObjectType": "tree",
"vipPrimaryKey": [
"address"
]
},
"access-list": {
"vipType": "ignore",
"vipValue": [],
"vipObjectType": "tree",
"vipPrimaryKey": [
"direction"
]
},
"dhcp-helper-v6": {
"vipType": "ignore",
"vipValue": [],
"vipObjectType": "tree",
"vipPrimaryKey": [
"address"
]
}
},
"dhcp-helper": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"10.10.10.10"
],
"vipVariableName": "vpn_if_svi_dhcp_helper"
},
"mtu": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1500,
"vipVariableName": "vpn_if_svi_ip_mtu"
},
"tcp-mss-adjust": {
"vipObjectType": "object",
"vipType": "ignore",
"vipVariableName": "vpn_if_svi_tcp_mss_adjust"
},
"shutdown": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "false",
"vipVariableName": "vpn_if_svi_shutdown"
},
"arp-timeout": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 1200,
"vipVariableName": "vpn_if_svi_arp_timeout"
},
"access-list": {
"vipType": "constant",
"vipValue": [
{
"acl-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "2.2.2.2",
"vipVariableName": "access_list_ingress_acl_name_ipv4"
},
"direction": {
"vipType": "constant",
"vipValue": "in",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
},
{
"acl-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "3.3.3.3",
"vipVariableName": "ipv4_access_list_egress_acl_name_ipv4"
},
"direction": {
"vipType": "constant",
"vipValue": "out",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"direction"
]
},
"ip-directed-broadcast": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "false",
"vipVariableName": "vpn_if_ip-directed-broadcast"
},
"intrf-mtu": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1500,
"vipVariableName": "vpn_if_svi_if_mtu"
},
"vrrp": {
"vipType": "ignore",
"vipValue": [],
"vipObjectType": "tree",
"vipPrimaryKey": [
"grp-id"
]
},
"ipv6-vrrp": {
"vipType": "constant",
"vipValue": [
{
"grp-id": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 2,
"vipVariableName": "vpn_if_vrrp_ipv6_grpid_ipv6",
"ipType": "ipv6"
},
"priority": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 50,
"vipVariableName": "vpn_if_vrrp_ipv6_priority_ipv6",
"ipType": "ipv6"
},
"timer": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 100,
"vipVariableName": "vpn_if_vrrp_ipv6_timer_ipv6",
"ipType": "ipv6"
},
"track-omp": {
"vipObjectType": "node-only",
"vipType": "ignore",
"vipValue": "false",
"vipVariableName": "vpn_if_vrrp_ipv6_track_omp_ipv6",
"ipType": "ipv6"
},
"track-prefix-list": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "24",
"vipVariableName": "vpn_if_vrrp_ipv6_track_prefix_list_ipv6",
"ipType": "ipv6"
},
"ipv6": {
"vipType": "constant",
"vipValue": [
{
"prefix": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "",
"vipVariableName": "vpn_if_vrrp_ipv6_vrrp_ip_prefix_ipv6",
"ipType": "ipv6"
},
"ipv6-link-local": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "2001:db8:0:1:1:1:1:1",
"vipVariableName": "vpn_if_vrrp_ipv6_vrrp_link_local_address_ipv6",
"ipType": "ipv6"
},
"priority-order": [
"ipv6-link-local",
"prefix"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"ipv6-link-local"
]
},
"ipv6-secondary": {
"vipType": "ignore",
"vipValue": [],
"vipPrimaryKey": [
"prefix"
],
"ipType": "ipv6"
},
"priority-order": [
"grp-id",
"priority",
"timer",
"track-omp",
"track-prefix-list",
"ipv6",
"ipv6-secondary"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"grp-id"
]
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleVpnInterfaceSvi"
},
"vpn-interface-t1-e1-example": {
"description": "vpn-interface-t1-e1-example",
"value": {
"templateName": "vpn_interface_t1e1",
"templateDescription": "vpn_interface_t1e1",
"templateType": "vpn-interface-t1-e1",
"deviceType": [
"vedge-C8000V"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"if-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "serial11",
"vipVariableName": "vpn_if_name"
},
"description": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "descrip1",
"vipVariableName": "vpn_if_description"
},
"ip": {
"address": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "10.10.10.10/24",
"vipVariableName": "vpn_if_ipv4_address"
}
},
"ipv6": {
"address": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "2001:db8:8086:6502::/64",
"vipVariableName": "vpn_if_ipv6_address"
},
"access-list": {
"vipType": "constant",
"vipValue": [
{
"acl-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "2001:db8:8086:6512::/64",
"vipVariableName": "access_list_ingress_acl_name_ipv6"
},
"direction": {
"vipType": "constant",
"vipValue": "in",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
},
{
"acl-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "2001:db8:8086:6522::/64",
"vipVariableName": "access_list_egress_acl_name_ipv6"
},
"direction": {
"vipType": "constant",
"vipValue": "out",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"direction"
]
}
},
"dhcp-helper": {},
"clear-dont-fragment": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_clear_dont_fragment"
},
"pmtu": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_pmtu"
},
"mtu": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1500,
"vipVariableName": "vpn_if_ip_mtu"
},
"static-ingress-qos": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 7,
"vipVariableName": "vpn_if_static_ingress_qos"
},
"tcp-mss-adjust": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1380,
"vipVariableName": "vpn_if_tcp_mss_adjust"
},
"shutdown": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "false",
"vipVariableName": "vpn_if_shutdown"
},
"arp-timeout": {},
"autonegotiate": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "vpn_if_autonegotiate"
},
"shaping-rate": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1000,
"vipVariableName": "qos_shaping-rate"
},
"qos-map": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "map1",
"vipVariableName": "qos-map"
},
"tracker": {},
"bandwidth-upstream": {},
"bandwidth-downstream": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 100000,
"vipVariableName": "bandwidth_downstream"
},
"block-non-source-ip": {},
"rewrite-rule": {
"rule-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "rule1",
"vipVariableName": "rewrite_rule-name"
}
},
"tloc-extension": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "tloc",
"vipVariableName": "vpn_if_tloc_extension"
},
"icmp-redirect-disable": {},
"tloc-extension-gre-from": {
"src-ip": {},
"xconnect": {}
},
"access-list": {
"vipType": "constant",
"vipValue": [
{
"acl-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "10.10.10.10",
"vipVariableName": "access_list_ingress_acl_name_ipv4"
},
"direction": {
"vipType": "constant",
"vipValue": "in",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
},
{
"acl-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "20.20.20.20",
"vipVariableName": "access_list_egress_acl_name_ipv4"
},
"direction": {
"vipType": "constant",
"vipValue": "out",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"direction"
]
},
"policer": {
"vipType": "ignore",
"vipValue": [],
"vipObjectType": "tree",
"vipPrimaryKey": [
"policer-name",
"direction"
]
},
"profile": {},
"technology": {},
"tunnel-interface": {
"encapsulation": {
"vipType": "constant",
"vipValue": [
{
"preference": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 7,
"vipVariableName": "vpn_if_tunnel_gre_preference"
},
"weight": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 2,
"vipVariableName": "vpn_if_tunnel_gre_weight"
},
"encap": {
"vipType": "constant",
"vipValue": "gre",
"vipObjectType": "object"
},
"priority-order": [
"encap",
"preference",
"weight"
]
},
{
"preference": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 7,
"vipVariableName": "vpn_if_tunnel_ipsec_preference"
},
"weight": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1,
"vipVariableName": "vpn_if_tunnel_ipsec_weight"
},
"encap": {
"vipType": "constant",
"vipValue": "ipsec",
"vipObjectType": "object"
},
"priority-order": [
"encap",
"preference",
"weight"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"encap"
]
},
"group": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"11"
],
"vipVariableName": "vpn_if_tunnel_group"
},
"border": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_border"
},
"color": {
"value": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "metro-ethernet",
"vipVariableName": "vpn_if_tunnel_color_value"
},
"restrict": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_color_restrict"
}
},
"carrier": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "carrier5",
"vipVariableName": "vpn_if_tunnel_carrier"
},
"bind": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "tunnel1",
"vipVariableName": "vpn_if_tunnel_bind"
},
"allow-service": {
"dhcp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_dhcp"
},
"dns": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_dns"
},
"icmp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_icmp"
},
"sshd": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_sshd"
},
"ntp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_ntp"
},
"stun": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_stun"
},
"all": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_all"
},
"bgp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_bgp"
},
"ospf": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_ospf"
},
"netconf": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_netconf"
},
"snmp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_snmp"
},
"https": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_https"
}
},
"max-control-connections": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 7,
"vipVariableName": "vpn_if_tunnel_max_control_connections"
},
"vbond-as-stun-server": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_vbond_as_stun_server"
},
"exclude-controller-group-list": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"13"
],
"vipVariableName": "vpn_if_tunnel_exclude_controller_group_list"
},
"vmanage-connection-preference": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 5,
"vipVariableName": "vpn_if_tunnel_vmanage_connection_preference"
},
"port-hop": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_port_hop"
},
"low-bandwidth-link": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_low_bandwidth_link"
},
"last-resort-circuit": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_last-resort-circuit"
},
"hold-time": {},
"nat-refresh-interval": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 5,
"vipVariableName": "vpn_if_tunnel_nat_refresh_interval"
},
"hello-interval": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 600,
"vipVariableName": "vpn_if_tunnel_hello_interval"
},
"hello-tolerance": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 12,
"vipVariableName": "vpn_if_tunnel_hello_tolerance"
},
"tloc-extension-gre-to": {
"dst-ip": {}
},
"tunnel-qos": {
"mode": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "hub"
}
},
"tunnel-tcp-mss-adjust": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1380,
"vipVariableName": "vpn_if_tunnel_tunnel_tcp_mss_adjust"
},
"clear-dont-fragment": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_tunnel_clear_dont_fragment"
},
"network-broadcast": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_tunnel_network_broadcast"
}
},
"nat64-enable": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "false"
},
"qos-map-vpn": {
"vipObjectType": "object",
"vipType": "ignore",
"vipVariableName": "vpn-qos_map"
},
"bandwidth": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "100000",
"vipVariableName": "vpn_if_bandwidth"
},
"clock-rate": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "19200",
"vipVariableName": "vpn_if_clock-rate"
},
"encapsulation-serial": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "hdlc",
"vipVariableName": "vpn_if_encapsulation-serial"
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleVpnInterfaceT1E1"
},
"vpn-vedge-interface-bridge-example": {
"description": "vpn-vedge-interface-bridge-example",
"value": {
"templateName": "vpn_vedge_interface_bridge",
"templateDescription": "vpn_vedge_interface_bridge",
"templateType": "vpn-vedge-interface-bridge",
"deviceType": [
"vedge-cloud"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"if-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "ge1/",
"vipVariableName": "vpn_if_name"
},
"description": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "GigabitEthernet1",
"vipVariableName": "vpn_if_description"
},
"ip": {
"address": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "5.5.5.5/24",
"vipVariableName": "vpn_if_ipv4_address"
},
"secondary-address": {
"vipType": "ignore",
"vipValue": [],
"vipObjectType": "tree",
"vipPrimaryKey": [
"address"
]
}
},
"dhcp-helper": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"5.5.5.1"
],
"vipVariableName": "vpn_if_dhcp_helper"
},
"clear-dont-fragment": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_clear_dont_fragment"
},
"mtu": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1500,
"vipVariableName": "vpn_if_ip_mtu"
},
"tcp-mss-adjust": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1300,
"vipVariableName": "vpn_if_tcp_mss_adjust"
},
"shutdown": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "false",
"vipVariableName": "vpn_if_shutdown"
},
"arp-timeout": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 300,
"vipVariableName": "vpn_if_arp_timeout"
},
"mac-address": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "00:00:00:00:02:02",
"vipVariableName": "vpn_if_mac_address"
},
"icmp-redirect-disable": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_icmp_redirect_disable"
},
"access-list": {
"vipType": "constant",
"vipValue": [
{
"acl-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "6.6.6.6",
"vipVariableName": "access_list_ingress_acl_name_ipv4"
},
"direction": {
"vipType": "constant",
"vipValue": "in",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
},
{
"acl-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "7.7.7.7",
"vipVariableName": "access_list_egress_acl_name_ipv4"
},
"direction": {
"vipType": "constant",
"vipValue": "out",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"direction"
]
},
"block-non-source-ip": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_block_non_source_ip"
},
"arp": {
"ip": {
"vipType": "constant",
"vipValue": [
{
"addr": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "192.168.1.120",
"vipVariableName": "vpn_bridge_arp_addr"
},
"mac": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "00:00:00:00:02:02",
"vipVariableName": "vpn_bridge_arp_mac"
},
"priority-order": [
"addr",
"mac"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"addr"
]
}
},
"vrrp": {
"vipType": "ignore",
"vipValue": [],
"vipObjectType": "tree",
"vipPrimaryKey": [
"grp-id"
]
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleVpnVedgeInterfaceBridge"
},
"vpn-vedge-interface-cellular-example": {
"description": "vpn-vedge-interface-cellular-example",
"value": {
"templateName": "vpn_vedge_interface_cellular",
"templateDescription": "vpn_vedge_interface_cellular",
"templateType": "vpn-vedge-interface-cellular",
"deviceType": [
"vedge-cloud"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"if-name": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "vpn_if_name_vpn_vedge_interface_cellular"
},
"description": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "Descrip1",
"vipVariableName": "vpn_if_description"
},
"ip": {
"dhcp-client": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true"
},
"dhcp-distance": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 12,
"vipVariableName": "vpn_if_ipv4_dhcp_distance"
}
},
"ipv6": {
"dhcp-client": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true"
},
"dhcp-distance": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 1,
"vipVariableName": "vpn_if_ipv6_dhcp_distance"
},
"dhcp-rapid-commit": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_ipv6_dhcp_rapid_commit"
},
"access-list": {
"vipType": "constant",
"vipValue": [
{
"acl-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "2001:DB8::1",
"vipVariableName": "access_list_ingress_acl_name_ipv6"
},
"direction": {
"vipType": "constant",
"vipValue": "in",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
},
{
"acl-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "2001:db8:a::123/64",
"vipVariableName": "access_list_egress_acl_name_ipv6"
},
"direction": {
"vipType": "constant",
"vipValue": "out",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"direction"
]
},
"ipv6-shutdown": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "false",
"vipVariableName": "vpn_if_ipv6_shutdown"
}
},
"dhcp-helper": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"10.10.10.10"
],
"vipVariableName": "vpn_if_dhcp_helper"
},
"clear-dont-fragment": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_clear_dont_fragment"
},
"pmtu": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_pmtu"
},
"mtu": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1428,
"vipVariableName": "vpn_if_ip_mtu"
},
"static-ingress-qos": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1,
"vipVariableName": "vpn_if_static_ingress_qos"
},
"tcp-mss-adjust": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1300,
"vipVariableName": "vpn_if_tcp_mss_adjust"
},
"shutdown": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "false",
"vipVariableName": "vpn_if_shutdown"
},
"arp-timeout": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 600,
"vipVariableName": "vpn_if_arp_timeout"
},
"autonegotiate": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "vpn_if_autonegotiate"
},
"shaping-rate": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 100000,
"vipVariableName": "qos_shaping-rate"
},
"qos-map": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "Map1",
"vipVariableName": "qos-map"
},
"tracker": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"Tracker1"
],
"vipVariableName": "vpn_if_tracker"
},
"bandwidth-upstream": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 100000,
"vipVariableName": "vpn_if_bandwidth_upstream"
},
"bandwidth-downstream": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 200000,
"vipVariableName": "vpn_if_bandwidth_downstream"
},
"block-non-source-ip": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_block_non_source_ip"
},
"rewrite-rule": {
"rule-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "Rule1",
"vipVariableName": "rewrite_rule-name"
}
},
"tloc-extension": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "TOLC",
"vipVariableName": "vpn_if_tloc_extension"
},
"icmp-redirect-disable": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "false",
"vipVariableName": "vpn_if_icmp_redirect_disable"
},
"tloc-extension-gre-from": {
"src-ip": {},
"xconnect": {}
},
"access-list": {
"vipType": "constant",
"vipValue": [
{
"acl-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "5.5.5.5",
"vipVariableName": "access_list_ingress_acl_name_ipv4"
},
"direction": {
"vipType": "constant",
"vipValue": "in",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
},
{
"acl-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "6.6.6.6",
"vipVariableName": "access_list_egress_acl_name_ipv4"
},
"direction": {
"vipType": "constant",
"vipValue": "out",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"direction"
]
},
"policer": {
"vipType": "constant",
"vipValue": [
{
"policer-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "P1",
"vipVariableName": "policer_ingress_policer_name"
},
"direction": {
"vipType": "constant",
"vipValue": "in",
"vipObjectType": "object"
},
"priority-order": [
"policer-name",
"direction"
]
},
{
"policer-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "p1",
"vipVariableName": "policer_egress_policer_name"
},
"direction": {
"vipType": "constant",
"vipValue": "out",
"vipObjectType": "object"
},
"priority-order": [
"policer-name",
"direction"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"policer-name",
"direction"
]
},
"profile": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1,
"vipVariableName": "vpn_if_profile_id"
},
"technology": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "lte",
"vipVariableName": "vpn_if_technology"
},
"tunnel-interface": {
"encapsulation": {
"vipType": "constant",
"vipValue": [
{
"preference": {
"vipObjectType": "object",
"vipType": "ignore",
"vipVariableName": "vpn_if_tunnel_ipsec_preference"
},
"weight": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 1,
"vipVariableName": "vpn_if_tunnel_ipsec_weight"
},
"encap": {
"vipType": "constant",
"vipValue": "ipsec",
"vipObjectType": "object"
},
"priority-order": [
"encap",
"preference",
"weight"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"encap"
]
},
"group": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"2"
],
"vipVariableName": "vpn_if_tunnel_group"
},
"border": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_border"
},
"color": {
"value": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "gold",
"vipVariableName": "vpn_if_tunnel_color_value"
},
"restrict": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_color_restrict"
}
},
"carrier": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "default",
"vipVariableName": "vpn_if_tunnel_carrier"
},
"bind": {
"vipObjectType": "object",
"vipType": "ignore",
"vipVariableName": "vpn_if_tunnel_bind"
},
"allow-service": {
"dhcp": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_dhcp"
},
"dns": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_dns"
},
"icmp": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_icmp"
},
"sshd": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_sshd"
},
"ntp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_ntp"
},
"stun": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_stun"
},
"all": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_all"
},
"bgp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_bgp"
},
"ospf": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_ospf"
},
"netconf": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_netconf"
},
"https": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_https"
}
},
"max-control-connections": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 6,
"vipVariableName": "vpn_if_tunnel_max_control_connections"
},
"vbond-as-stun-server": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_vbond_as_stun_server"
},
"exclude-controller-group-list": {
"vipObjectType": "list",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "vpn_if_tunnel_exclude_controller_group_list"
},
"vmanage-connection-preference": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 6,
"vipVariableName": "vpn_if_tunnel_vmanage_connection_preference"
},
"port-hop": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_port_hop"
},
"low-bandwidth-link": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_low_bandwidth_link"
},
"last-resort-circuit": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "false",
"vipVariableName": "vpn_if_tunnel_last-resort-circuit"
},
"hold-time": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 7000,
"vipVariableName": "hold-time"
},
"nat-refresh-interval": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 5,
"vipVariableName": "vpn_if_tunnel_nat_refresh_interval"
},
"hello-interval": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 1000,
"vipVariableName": "vpn_if_tunnel_hello_interval"
},
"hello-tolerance": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 12,
"vipVariableName": "vpn_if_tunnel_hello_tolerance"
},
"tloc-extension-gre-to": {
"dst-ip": {}
},
"tunnel-qos": {
"mode": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "hub"
}
}
},
"nat64-enable": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "false"
},
"nat": {
"refresh": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "bi-directional",
"vipVariableName": "nat_refresh"
},
"log-translations": {},
"udp-timeout": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 5,
"vipVariableName": "nat_udp_timeout"
},
"tcp-timeout": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 120,
"vipVariableName": "nat_tcp_timeout"
},
"block-icmp-error": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "nat_block_icmp_error"
},
"respond-to-ping": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "nat_respond_to_ping"
},
"natpool": {
"range-start": {},
"range-end": {}
},
"port-forward": {
"vipType": "constant",
"vipValue": [
{
"port-start": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1000
},
"port-end": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 2000
},
"proto": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "udp"
},
"private-vpn": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 100,
"vipVariableName": "vpn_interface_private_vpn"
},
"private-ip-address": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "4.4.4.4",
"vipVariableName": "vpn_interface_private_ip_address"
},
"priority-order": [
"port-start",
"port-end",
"proto",
"private-vpn",
"private-ip-address"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"port-start",
"port-end",
"proto"
]
}
},
"arp": {
"ip": {
"vipType": "constant",
"vipValue": [
{
"addr": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "192.168.1.111",
"vipVariableName": "vpn_bridge_arp_addr"
},
"mac": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "00:00:00:00:00:01",
"vipVariableName": "vpn_bridge_arp_mac"
},
"priority-order": [
"addr",
"mac"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"addr"
]
}
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleVpnVedgeInterfaceCellular"
},
"vpn-vedge-interface-gre-example": {
"description": "vpn-vedge-interface-gre-example",
"value": {
"templateName": "template_vedge_interface_gre",
"templateDescription": "template_vedge_interface_gre",
"templateType": "vpn-vedge-interface-gre",
"deviceType": [
"vedge-cloud"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"if-name": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "vpn_if_name_template_vedge_interface_gre"
},
"description": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "vpn_if_description"
},
"ip": {
"address": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "3.3.5.5/16",
"vipVariableName": "vpn_if_ipv4_address"
}
},
"shutdown": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "false",
"vipVariableName": "vpn_if_shutdown"
},
"tunnel-source": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "3.3.4.4",
"vipVariableName": "vpn_if_tunnel_source"
},
"tunnel-destination": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "20.20.20.20",
"vipVariableName": "vpn_if_tunnel_destination"
},
"keepalive": {
"interval": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 20,
"vipVariableName": "vpn_if_interval"
},
"retries": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 6,
"vipVariableName": "vpn_if_retries"
}
},
"mtu": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1500,
"vipVariableName": "vpn_if_ip_mtu"
},
"clear-dont-fragment": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_clear_dont_fragment"
},
"tcp-mss-adjust": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1300,
"vipVariableName": "vpn_if_tcp_mss_adjust"
},
"rewrite-rule": {
"rule-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "rule1",
"vipVariableName": "rewrite_rule_name"
}
},
"access-list": {
"vipType": "constant",
"vipValue": [
{
"acl-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "6.6.6.6",
"vipVariableName": "access_list_ingress_acl_name_ipv4"
},
"direction": {
"vipType": "constant",
"vipValue": "in",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
},
{
"acl-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "7.7.7.7",
"vipVariableName": "access_list_egress_acl_name_ipv4"
},
"direction": {
"vipType": "constant",
"vipValue": "out",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"direction"
]
},
"policer": {
"vipType": "constant",
"vipValue": [
{
"policer-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "policer1",
"vipVariableName": "policer_ingress_policer_name"
},
"direction": {
"vipType": "constant",
"vipValue": "in",
"vipObjectType": "object"
},
"priority-order": [
"policer-name",
"direction"
]
},
{
"policer-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "policer1",
"vipVariableName": "policer_egress_policer_name"
},
"direction": {
"vipType": "constant",
"vipValue": "out",
"vipObjectType": "object"
},
"priority-order": [
"policer-name",
"direction"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"policer-name",
"direction"
]
},
"tracker": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"Tracker1"
],
"vipVariableName": "tracker"
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleVpnVedgeInterfaceGre"
},
"vpn-vedge-interface-ipsec-example": {
"description": "vpn-vedge-interface-ipsec-example",
"value": {
"templateName": "vpn-vedge-interface-ipsec",
"templateDescription": "vpn-vedge-interface-ipsec",
"templateType": "vpn-vedge-interface-ipsec",
"deviceType": [
"vedge-cloud"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"if-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "ipsec1",
"vipVariableName": "vpn_if_name"
},
"description": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "Description1",
"vipVariableName": "vpn_if_description"
},
"ip": {
"address": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "192.168.0.111/24",
"vipVariableName": "vpn_if_ipv4_address"
}
},
"shutdown": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "false",
"vipVariableName": "vpn_if_shutdown"
},
"tunnel-source-interface": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "gi1/1",
"vipVariableName": "vpn_if_tunnel_source_interface"
},
"tunnel-destination": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "20.20.20.20",
"vipVariableName": "vpn_if_tunnel_destination"
},
"mtu": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1500,
"vipVariableName": "vpn_if_mtu"
},
"tcp-mss-adjust": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1400,
"vipVariableName": "vpn_if_tcp_mss_adjust"
},
"dead-peer-detection": {
"dpd-interval": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 50,
"vipVariableName": "vpn_if_dpd_interval"
},
"dpd-retries": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 3,
"vipVariableName": "vpn_if_dpd_retries"
}
},
"ike": {
"ike-version": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 2,
"vipVariableName": "vpn_if_ike_version"
},
"ike-rekey-interval": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 14400,
"vipVariableName": "vpn_if_ike_rekey_interval"
},
"ike-ciphersuite": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "aes256-cbc-sha1",
"vipVariableName": "vpn_if_ike_ciphersuite"
},
"ike-group": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "16",
"vipVariableName": "vpn_if_ike_group"
},
"authentication-type": {
"pre-shared-key": {
"pre-shared-secret": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "123456789a",
"vipVariableName": "vpn_if_pre_shared_secret"
},
"ike-local-id": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "1",
"vipVariableName": "vpn_if_ike_local_id"
},
"ike-remote-id": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "2",
"vipVariableName": "vpn_if_ike_remote_id"
}
}
}
},
"ipsec": {
"ipsec-rekey-interval": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 3600,
"vipVariableName": "vpn_if_ipsec_rekey_interval"
},
"ipsec-replay-window": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 512,
"vipVariableName": "vpn_if_ipsec_replay_window"
},
"ipsec-ciphersuite": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "aes256-cbc-sha256",
"vipVariableName": "vpn_if_ipsec_ciphersuite"
},
"perfect-forward-secrecy": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "group-16",
"vipVariableName": "vpn_if_ipsec_perfect_forward_secrecy"
}
},
"tracker": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"t1"
],
"vipVariableName": "tracker"
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleVpnVedgeInterfaceIpsec"
},
"vpn-vedge-interface-natpool-example": {
"description": "vpn-vedge-interface-natpool-example",
"value": {
"templateName": "template_vpn_interface_natpool",
"templateDescription": "template_vpn_interface_natpool",
"templateType": "vpn-vedge-interface-natpool",
"deviceType": [
"vedge-cloud"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"if-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "natpool1",
"vipVariableName": "vpn_if_name"
},
"description": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "Description1",
"vipVariableName": "vpn_if_description"
},
"ip": {
"address": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "1.1.2.2/24",
"vipVariableName": "vpn_if_ipv4_address"
}
},
"shutdown": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "false",
"vipVariableName": "vpn_if_shutdown"
},
"nat": {
"refresh": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "bi-directional",
"vipVariableName": "vpn_if_refresh"
},
"udp-timeout": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 2,
"vipVariableName": "vpn_if_udp_timeout"
},
"tcp-timeout": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 120,
"vipVariableName": "vpn_if_tcp_timeout"
},
"block-icmp-error": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "vpn_if_block_icmp"
},
"respond-to-ping": {},
"direction": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "inside",
"vipVariableName": "vpn_if_direction"
},
"overload": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "vpn_if_overload"
},
"port-forward": {
"vipType": "constant",
"vipValue": [
{
"port-start": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1000,
"vipVariableName": "vpn_interface_port_start"
},
"port-end": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 2000,
"vipVariableName": "vpn_interface_port_end"
},
"proto": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "udp",
"vipVariableName": "vpn_interface_proto"
},
"private-vpn": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 0,
"vipVariableName": "vpn_interface_private_vpn"
},
"private-ip-address": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "192.168.1.111",
"vipVariableName": "vpn_interface_private_ip_address"
},
"priority-order": [
"port-start",
"port-end",
"proto",
"private-vpn",
"private-ip-address"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"port-start",
"port-end",
"proto"
]
},
"static": {
"vipType": "constant",
"vipValue": [
{
"source-ip": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "192.168.1.10",
"vipVariableName": "vpn_nat_pool_source_ip"
},
"translate-ip": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "10.10.10.10",
"vipVariableName": "vpn_nat_pool_translate_ip"
},
"static-nat-direction": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "outside",
"vipVariableName": "vpn_nat_pool_static_nat_direction"
},
"priority-order": [
"source-ip",
"translate-ip",
"static-nat-direction"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"source-ip"
]
},
"tracker": {
"vipType": "constant",
"vipValue": [
{
"interface": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": [
"ge0/0"
],
"vipVariableName": "vpn_nat_pool_tracker_interface"
},
"priority-order": [
"interface"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"interface"
]
}
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleVpnVedgeInterfaceNatpool"
},
"vpn-vedge-interface-ppp-example": {
"description": "vpn-vedge-interface-ppp-example",
"value": {
"templateName": "vpn_vedge_interface_ppp",
"templateDescription": "vpn_vedge_interface_ppp",
"templateType": "vpn-vedge-interface-ppp",
"deviceType": [
"vedge-cloud"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"if-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "ppp1",
"vipVariableName": "vpn_if_name"
},
"description": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "d1",
"vipVariableName": "vpn_if_description"
},
"clear-dont-fragment": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_clear_dont_fragment"
},
"mac-address": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "00:00:00:00:00:11",
"vipVariableName": "vpn_if_mac_address"
},
"mtu": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1492,
"vipVariableName": "vpn_if_ip_mtu"
},
"pmtu": {},
"tcp-mss-adjust": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1400,
"vipVariableName": "vpn_if_tcp_mss_adjust"
},
"shutdown": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "false",
"vipVariableName": "vpn_if_shutdown"
},
"rewrite-rule": {
"rule-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "rule1",
"vipVariableName": "rewrite_rule_name"
}
},
"ppp": {
"ac-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "ac1",
"vipVariableName": "ppp_ac_name"
},
"authentication": {
"vipType": "constant",
"vipValue": [
{
"hostname": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "admin",
"vipVariableName": "ppp_chap_chap_hostname"
},
"password": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "admin",
"vipVariableName": "ppp_chap_chap_password"
},
"priority-order": [
"auth-choice",
"hostname",
"password"
],
"auth-choice": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "chap"
}
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"auth-choice"
]
}
},
"tloc-extension": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "tloc",
"vipVariableName": "vpn_if_tloc_extension"
},
"bandwidth-upstream": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 100000,
"vipVariableName": "vpn_if_bandwidth_upstream"
},
"bandwidth-downstream": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 200000,
"vipVariableName": "vpn_if_bandwidth_downstream"
},
"icmp-redirect-disable": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_icmp_redirect_disable"
},
"access-list": {
"vipType": "constant",
"vipValue": [
{
"acl-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "3.3.3.3",
"vipVariableName": "access_list_ingress_acl_name_ipv4"
},
"direction": {
"vipType": "constant",
"vipValue": "in",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
},
{
"acl-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "4.4.4.4",
"vipVariableName": "access_list_egress_acl_name_ipv4"
},
"direction": {
"vipType": "constant",
"vipValue": "out",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"direction"
]
},
"ipv6": {
"access-list": {
"vipType": "constant",
"vipValue": [
{
"acl-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "2001:4860:4801:48::33",
"vipVariableName": "access_list_ingress_acl_name_ipv6"
},
"direction": {
"vipType": "constant",
"vipValue": "in",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
},
{
"acl-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "2001:4860:4801:48::55",
"vipVariableName": "access_list_egress_acl_name_ipv6"
},
"direction": {
"vipType": "constant",
"vipValue": "out",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"direction"
]
}
},
"policer": {
"vipType": "constant",
"vipValue": [
{
"policer-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "policer1",
"vipVariableName": "policer_ingress_policer_name"
},
"direction": {
"vipType": "constant",
"vipValue": "in",
"vipObjectType": "object"
},
"priority-order": [
"policer-name",
"direction"
]
},
{
"policer-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "policer1",
"vipVariableName": "policer_egress_policer_name"
},
"direction": {
"vipType": "constant",
"vipValue": "out",
"vipObjectType": "object"
},
"priority-order": [
"policer-name",
"direction"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"policer-name",
"direction"
]
},
"tunnel-interface": {
"encapsulation": {
"vipType": "constant",
"vipValue": [
{
"preference": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 7,
"vipVariableName": "vpn_if_tunnel_gre_preference"
},
"weight": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1,
"vipVariableName": "vpn_if_tunnel_gre_weight"
},
"encap": {
"vipType": "constant",
"vipValue": "gre",
"vipObjectType": "object"
},
"priority-order": [
"encap",
"preference",
"weight"
]
},
{
"preference": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 6,
"vipVariableName": "vpn_if_tunnel_ipsec_preference"
},
"weight": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 2,
"vipVariableName": "vpn_if_tunnel_ipsec_weight"
},
"encap": {
"vipType": "constant",
"vipValue": "ipsec",
"vipObjectType": "object"
},
"priority-order": [
"encap",
"preference",
"weight"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"encap"
]
},
"group": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"2"
],
"vipVariableName": "vpn_if_tunnel_group"
},
"border": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_border"
},
"color": {
"value": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "custom3",
"vipVariableName": "color_value"
},
"restrict": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_color_restrict"
}
},
"carrier": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "carrier4",
"vipVariableName": "vpn_if_tunnel_carrier"
},
"bind": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "tunnel1",
"vipVariableName": "vpn_if_tunnel_bind"
},
"allow-service": {
"dhcp": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_dhcp"
},
"dns": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_dns"
},
"icmp": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_icmp"
},
"sshd": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_sshd"
},
"ntp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_ntp"
},
"stun": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_stun"
},
"all": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_all"
},
"bgp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_bgp"
},
"ospf": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_ospf"
},
"netconf": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_netconf"
}
},
"max-control-connections": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 8,
"vipVariableName": "vpn_if_tunnel_max_control_connections"
},
"vbond-as-stun-server": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_vbond_as_stun_server"
},
"exclude-controller-group-list": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"2"
],
"vipVariableName": "vpn_if_tunnel_exclude_controller_group_list"
},
"vmanage-connection-preference": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 6,
"vipVariableName": "vpn_if_tunnel_vmanage_connection_preference"
},
"port-hop": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_port_hop"
},
"low-bandwidth-link": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_low_bandwidth_link"
},
"last-resort-circuit": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_last_resort_circuit"
},
"hold-time": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 7000,
"vipVariableName": "hold-time"
},
"nat-refresh-interval": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 5,
"vipVariableName": "vpn_if_tunnel_nat_refresh_interval"
},
"hello-interval": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 600,
"vipVariableName": "vpn_if_tunnel_hello_interval"
},
"hello-tolerance": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 14,
"vipVariableName": "vpn_if_tunnel_hello_tolerance"
},
"tloc-extension-gre-to": {
"dst-ip": {}
}
},
"nat64-enable": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "false"
},
"tracker": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"trapper"
],
"vipVariableName": "vpn_if_tracker"
},
"autonegotiate": {},
"block-non-source-ip": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_block_non_source_ip"
},
"nat": {
"refresh": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "outbound",
"vipVariableName": "nat_refresh"
},
"log-translations": {},
"udp-timeout": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1,
"vipVariableName": "nat_udp_timeout"
},
"tcp-timeout": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 60,
"vipVariableName": "nat_tcp_timeout"
},
"block-icmp-error": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "nat_block_icmp_error"
},
"respond-to-ping": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "nat_respond_to_ping"
},
"natpool": {
"range-start": {},
"range-end": {}
},
"port-forward": {
"vipType": "constant",
"vipValue": [
{
"port-start": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1000
},
"port-end": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 2000
},
"proto": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "udp"
},
"private-vpn": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 0,
"vipVariableName": "vpn_interface_private_vpn"
},
"private-ip-address": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "192.168.0.111",
"vipVariableName": "vpn_interface_private_ip_address"
},
"priority-order": [
"port-start",
"port-end",
"proto",
"private-vpn",
"private-ip-address"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"port-start",
"port-end",
"proto"
]
}
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleVpnVedgeInterfacePpp"
},
"vpn-vedge-interface-vap-example": {
"description": "vpn-vedge-interface-vap-example",
"value": {
"templateName": "template_wifi_ssid",
"templateDescription": "template_wifi_ssid",
"templateType": "vpn-vedge-interface-vap",
"deviceType": [
"vedge-100-WM"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"if-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "vap2",
"vipVariableName": "WiFi_if_name"
},
"description": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "lanEthernet",
"vipVariableName": "WiFi_if_description"
},
"shutdown": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "false",
"vipVariableName": "WiFi_if_shutdown"
},
"data-security": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "wpa2-enterprise"
},
"mgmt-security": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "required",
"vipVariableName": "WiFi_mgmt_security"
},
"radius-servers": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"10.124.19.169"
],
"vipVariableName": "WiFi_if_radius-servers"
},
"ssid": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "wifi_zhangyp",
"vipVariableName": "WiFi_if_ssid"
},
"max-clients": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 20,
"vipVariableName": "WiFi_if_max_clients"
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleVpnVedgeInterfaceVap"
},
"vpn-vedge-interface-example": {
"description": "vpn-vedge-interface-example",
"value": {
"templateName": "vpn_interface_ethernet",
"templateDescription": "vpn_interface_ethernet",
"templateType": "vpn-vedge-interface",
"deviceType": [
"vedge-cloud"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"if-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "ge3/",
"vipVariableName": "vpn_if_name"
},
"description": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "description1",
"vipVariableName": "vpn_if_description"
},
"ip": {
"dhcp-client": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true"
},
"dhcp-distance": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 6,
"vipVariableName": "vpn_if_ipv4_dhcp_distance"
},
"secondary-address": {
"vipType": "ignore",
"vipValue": [],
"vipObjectType": "tree",
"vipPrimaryKey": [
"address"
]
}
},
"dhcp-helper": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"10.124.19.169"
],
"vipVariableName": "vpn_if_dhcp_helper"
},
"flow-control": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "autoneg",
"vipVariableName": "vpn_if_flow_control"
},
"clear-dont-fragment": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_clear_dont_fragment"
},
"pmtu": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_pmtu"
},
"mtu": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1500,
"vipVariableName": "vpn_if_ip_mtu"
},
"static-ingress-qos": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1,
"vipVariableName": "vpn_if_static_ingress_qos"
},
"tcp-mss-adjust": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1400,
"vipVariableName": "vpn_if_tcp_mss_adjust"
},
"mac-address": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "00:01:02:03:04:10",
"vipVariableName": "vpn_if_mac_address"
},
"speed": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "1000",
"vipVariableName": "vpn_if_speed"
},
"duplex": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "full",
"vipVariableName": "vpn_if_duplex"
},
"shutdown": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "false",
"vipVariableName": "vpn_if_shutdown"
},
"arp-timeout": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1800,
"vipVariableName": "vpn_if_arp_timeout"
},
"autonegotiate": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "vpn_if_autonegotiate"
},
"shaping-rate": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 300000,
"vipVariableName": "qos_shaping_rate"
},
"qos-map": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "map1",
"vipVariableName": "qos_map"
},
"tracker": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"tracker1"
],
"vipVariableName": "vpn_if_tracker"
},
"bandwidth-upstream": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 100000,
"vipVariableName": "vpn_if_bandwidth_upstream"
},
"bandwidth-downstream": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 200000,
"vipVariableName": "vpn_if_bandwidth_downstream"
},
"block-non-source-ip": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_block_non_source_ip"
},
"rewrite-rule": {
"rule-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "rule1",
"vipVariableName": "rewrite_rule_name"
}
},
"tloc-extension": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "tloc",
"vipVariableName": "vpn_if_tloc_extension"
},
"icmp-redirect-disable": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_icmp_redirect_disable"
},
"tloc-extension-gre-from": {
"src-ip": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "50.50.50.50",
"vipVariableName": "vpn_if_tloc-ext_gre_from_src_ip"
},
"xconnect": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "x1",
"vipVariableName": "vpn_if_tloc-ext_gre_from_xconnect"
}
},
"access-list": {
"vipType": "constant",
"vipValue": [
{
"acl-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "5.5.5.5",
"vipVariableName": "access_list_ingress_acl_name_ipv4"
},
"direction": {
"vipType": "constant",
"vipValue": "in",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
},
{
"acl-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "6.6.6.6",
"vipVariableName": "ipv4_access_list_egress_acl_name_ipv4"
},
"direction": {
"vipType": "constant",
"vipValue": "out",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"direction"
]
},
"policer": {
"vipType": "constant",
"vipValue": [
{
"policer-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "policer1",
"vipVariableName": "policer_ingress_policer_name"
},
"direction": {
"vipType": "constant",
"vipValue": "in",
"vipObjectType": "object"
},
"priority-order": [
"policer-name",
"direction"
]
},
{
"policer-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "policer1",
"vipVariableName": "policer_egress_policer_name"
},
"direction": {
"vipType": "constant",
"vipValue": "out",
"vipObjectType": "object"
},
"priority-order": [
"policer-name",
"direction"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"policer-name",
"direction"
]
},
"tunnel-interface": {
"encapsulation": {
"vipType": "constant",
"vipValue": [
{
"preference": {
"vipObjectType": "object",
"vipType": "ignore",
"vipVariableName": "vpn_if_tunnel_ipsec_preference"
},
"weight": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 1,
"vipVariableName": "vpn_if_tunnel_ipsec_weight"
},
"encap": {
"vipType": "constant",
"vipValue": "ipsec",
"vipObjectType": "object"
},
"priority-order": [
"encap",
"preference",
"weight"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"encap"
]
},
"group": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"11"
],
"vipVariableName": "vpn_if_tunnel_group"
},
"border": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_border"
},
"color": {
"value": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "custom2",
"vipVariableName": "vpn_if_tunnel_color_value"
},
"restrict": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_color_restrict"
}
},
"carrier": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "default",
"vipVariableName": "vpn_if_tunnel_carrier"
},
"bind": {
"vipObjectType": "object",
"vipType": "ignore",
"vipVariableName": "vpn_if_tunnel_bind"
},
"allow-service": {
"dhcp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_dhcp"
},
"dns": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_dns"
},
"icmp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_icmp"
},
"sshd": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_sshd"
},
"ntp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_ntp"
},
"stun": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_stun"
},
"all": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_all"
},
"bgp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_bgp"
},
"ospf": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_ospf"
},
"netconf": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_netconf"
},
"snmp": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "false"
},
"https": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_https"
}
},
"max-control-connections": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 8,
"vipVariableName": "vpn_if_tunnel_max_control_connections"
},
"vbond-as-stun-server": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_vbond_as_stun_server"
},
"exclude-controller-group-list": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"2"
],
"vipVariableName": "vpn_if_tunnel_exclude_controller_group_list"
},
"vmanage-connection-preference": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 7,
"vipVariableName": "vpn_if_tunnel_vmanage_connection_preference"
},
"port-hop": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_port_hop"
},
"low-bandwidth-link": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_low_bandwidth_link"
},
"last-resort-circuit": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "false",
"vipVariableName": "vpn_if_tunnel_last_resort_circuit"
},
"hold-time": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 7000,
"vipVariableName": "hold-time"
},
"nat-refresh-interval": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 5,
"vipVariableName": "vpn_if_tunnel_nat_refresh_interval"
},
"hello-interval": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 1000,
"vipVariableName": "vpn_if_tunnel_hello_interval"
},
"hello-tolerance": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 12,
"vipVariableName": "vpn_if_tunnel_hello_tolerance"
},
"tloc-extension-gre-to": {
"dst-ip": {
"vipObjectType": "object",
"vipType": "ignore",
"vipVariableName": "vpn_if_tunnel_tloc_ext_gre_to_dst_ip"
}
}
},
"ip-directed-broadcast": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_ip-directed-broadcast"
},
"ipv6": {
"access-list": {
"vipType": "constant",
"vipValue": [
{
"acl-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": " 2001:4860:4801:48::77",
"vipVariableName": "access_list_ingress_acl_name_ipv6"
},
"direction": {
"vipType": "constant",
"vipValue": "in",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
},
{
"acl-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": " 2001:4860:4801:48::88",
"vipVariableName": "access_list_egress_acl_name_ipv6"
},
"direction": {
"vipType": "constant",
"vipValue": "out",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"direction"
]
},
"address": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "",
"vipVariableName": "vpn_if_ipv6_ipv6_address"
},
"dhcp-helper-v6": {
"vipType": "ignore",
"vipValue": [],
"vipObjectType": "tree",
"vipPrimaryKey": [
"address"
]
},
"secondary-address": {
"vipType": "ignore",
"vipValue": [],
"vipObjectType": "tree",
"vipPrimaryKey": [
"address"
]
},
"ipv6-shutdown": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "false",
"vipVariableName": "vpn_if_ipv6_ipv6_shutdown"
}
},
"nat": {
"vipType": "ignore",
"vipObjectType": "node-only"
},
"arp": {
"ip": {
"vipType": "constant",
"vipValue": [
{
"addr": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "192.168.1.223",
"vipVariableName": "vpn_bridge_arp_addr"
},
"mac": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "00:00:01:02:00:33",
"vipVariableName": "vpn_bridge_arp_mac"
},
"priority-order": [
"addr",
"mac"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"addr"
]
}
},
"vrrp": {
"vipType": "ignore",
"vipValue": [],
"vipObjectType": "tree",
"vipPrimaryKey": [
"grp-id"
]
},
"ipv6-vrrp": {
"vipType": "ignore",
"vipValue": [],
"vipObjectType": "tree",
"vipPrimaryKey": [
"grp-id"
]
},
"dot1x": {
"control-direction": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "in-and-out",
"vipVariableName": "802.1X_control_direction"
},
"wake-on-lan": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "802.1X_wake_on_lan"
},
"reauthentication": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 3,
"vipVariableName": "802.1X_reauthentication"
},
"auth-fail-vlan": {
"vipObjectType": "object",
"vipType": "ignore",
"vipVariableName": "802.1X_auth_fail_vlan"
},
"guest-vlan": {
"vipObjectType": "object",
"vipType": "ignore",
"vipVariableName": "802.1X_guest_vlan"
},
"default-vlan": {
"vipObjectType": "object",
"vipType": "ignore",
"vipVariableName": "802.1X_default_vlan"
},
"host-mode": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "single-host",
"vipVariableName": "802.1X_host_mode"
},
"nas-identifier": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "17",
"vipVariableName": "802.1X_nas_identifier"
},
"nas-ip-address": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "5.5.5.5",
"vipVariableName": "802.1X_nas_ip_address"
},
"radius-servers": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"10.124.19.169"
],
"vipVariableName": "802.1X_radius_server"
},
"accounting-interval": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 30,
"vipVariableName": "802.1X_accounting_interval"
},
"timeout": {
"inactivity": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 10,
"vipVariableName": "802.1X_timeout_inactivity"
}
},
"das": {
"port": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 3799,
"vipVariableName": "802.1X_das_port"
},
"time-window": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 300,
"vipVariableName": "802.1X_das_time_window"
},
"require-timestamp": {
"vipObjectType": "node-only",
"vipType": "ignore",
"vipValue": "false",
"vipVariableName": "802.1X_das_require_timestamp"
},
"client": {
"vipObjectType": "object",
"vipType": "ignore",
"vipVariableName": "802.1X_das_client"
},
"secret-key": {
"vipObjectType": "object",
"vipType": "ignore",
"vipVariableName": "802.1X_das_secret_key"
},
"vpn": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 0,
"vipVariableName": "802.1X_das_vpn"
}
},
"mac-authentication-bypass": {
"server": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "false",
"vipVariableName": "802.1X_mab_server"
},
"allow": {}
},
"acct-req-attr": {
"vipType": "constant",
"vipValue": [
{
"id": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1,
"vipVariableName": "vpn_interface_acct_id"
},
"string": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "string",
"vipVariableName": "vpn_interface_acct_string"
},
"priority-order": [
"id",
"string"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"id"
]
},
"auth-reject-vlan": {
"vipObjectType": "object",
"vipType": "ignore",
"vipVariableName": "802.1X_auth_reject_vlan"
}
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleVpnVedgeInterface"
},
"vpn-vedge-pppoe-enabled-interface-example": {
"description": "vpn-vedge-pppoe-enabled-interface-example",
"value": {
"templateName": "vpn_vedge_interface_ppp_ethernet",
"templateDescription": "vpn_vedge_interface_ppp_ethernet",
"templateType": "vpn-vedge-pppoe-enabled-interface",
"deviceType": [
"vedge-cloud"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"if-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "ge3/",
"vipVariableName": "vpn_if_name"
},
"description": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "description1",
"vipVariableName": "vpn_if_description"
},
"pppoe-client": {
"ppp-interface": {
"vipType": "link-variable",
"vipObjectType": "object",
"vipValue": ""
}
},
"ip": {
"address": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "10.124.17.123/24",
"vipVariableName": "vpn_if_ipv4_address"
}
},
"ipv6": {
"dhcp-client": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true"
},
"dhcp-distance": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1,
"vipVariableName": "vpn_if_ipv6_dhcp_distance"
},
"access-list": {
"vipType": "constant",
"vipValue": [
{
"acl-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "2001:4860:4801:48::33",
"vipVariableName": "access_list_ingress_acl_name_ipv6"
},
"direction": {
"vipType": "constant",
"vipValue": "in",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
},
{
"acl-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "2001:4860:4801:48::44",
"vipVariableName": "access_list_egress_acl_name_ipv6"
},
"direction": {
"vipType": "constant",
"vipValue": "out",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"direction"
]
},
"ipv6-shutdown": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "false",
"vipVariableName": "vpn_if_ipv6_shutdown"
},
"dhcp-rapid-commit": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_ipv6_dhcp_rapid_commit"
}
},
"dhcp-helper": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"12.13.14.15"
],
"vipVariableName": "vpn_if_dhcp_helper"
},
"flow-control": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "both",
"vipVariableName": "vpn_if_flow_control"
},
"mtu": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1500,
"vipVariableName": "vpn_if_ip_mtu"
},
"static-ingress-qos": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1,
"vipVariableName": "vpn_if_static_ingress_qos"
},
"tcp-mss-adjust": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1380,
"vipVariableName": "vpn_if_tcp_mss_adjust"
},
"mac-address": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "00:00:00:00:00:11",
"vipVariableName": "vpn_if_mac_address"
},
"speed": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "1000",
"vipVariableName": "vpn_if_speed"
},
"duplex": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "full",
"vipVariableName": "vpn_if_duplex"
},
"shutdown": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "false",
"vipVariableName": "vpn_if_shutdown"
},
"arp-timeout": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1200,
"vipVariableName": "vpn_if_arp_timeout"
},
"shaping-rate": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 100000,
"vipVariableName": "qos_shaping_rate"
},
"qos-map": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "map1",
"vipVariableName": "qos_map"
},
"rewrite-rule": {
"rule-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "rule1",
"vipVariableName": "rewrite_rule_name"
}
},
"bandwidth-upstream": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 200000,
"vipVariableName": "vpn_if_bandwidth_upstream"
},
"bandwidth-downstream": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 200000,
"vipVariableName": "vpn_if_bandwidth_downstream"
},
"icmp-redirect-disable": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_icmp_redirect_disable"
},
"access-list": {
"vipType": "constant",
"vipValue": [
{
"acl-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "10.10.10.10",
"vipVariableName": "access_list_ingress_acl_name_ipv4"
},
"direction": {
"vipType": "constant",
"vipValue": "in",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
},
{
"acl-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "20.20.20.20",
"vipVariableName": "access_list_egress_acl_name_ipv4"
},
"direction": {
"vipType": "constant",
"vipValue": "out",
"vipObjectType": "object"
},
"priority-order": [
"direction",
"acl-name"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"direction"
]
},
"policer": {
"vipType": "constant",
"vipValue": [
{
"policer-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "policer1",
"vipVariableName": "policer_ingress_policer_name"
},
"direction": {
"vipType": "constant",
"vipValue": "in",
"vipObjectType": "object"
},
"priority-order": [
"policer-name",
"direction"
]
},
{
"policer-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "policer1",
"vipVariableName": "policer_egress_policer_name"
},
"direction": {
"vipType": "constant",
"vipValue": "out",
"vipObjectType": "object"
},
"priority-order": [
"policer-name",
"direction"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"policer-name",
"direction"
]
},
"pmtu": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_pmtu"
},
"tloc-extension": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "tloc",
"vipVariableName": "vpn_if_tloc_extension"
},
"autonegotiate": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "true",
"vipVariableName": "vpn_if_autonegotiate"
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleVpnVedgePppoeEnabledInterface"
},
"vpn-vedge-example": {
"description": "vpn-vedge-example",
"value": {
"templateName": "template_vpn",
"templateDescription": "template_vpn",
"templateType": "vpn-vedge",
"deviceType": [
"vedge-cloud"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"vpn-id": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 12
},
"name": {
"vipObjectType": "object",
"vipType": "ignore",
"vipVariableName": "vpn_name"
},
"ecmp-hash-key": {
"layer4": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_layer4"
}
},
"tcp-optimization": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_tcp_optimization"
},
"nat64-global": {
"prefix": {
"stateful": {}
}
},
"nat64": {
"v4": {
"pool": {
"vipType": "constant",
"vipValue": [
{
"name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "pool1"
},
"start-address": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "6.6.6.6",
"vipVariableName": "vpn_interface_start_address"
},
"end-address": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "7.7.7.7",
"vipVariableName": "vpn_interface_end_address"
},
"overload": {
"vipObjectType": "node-only",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_interface_overload"
},
"priority-order": [
"name",
"start-address",
"end-address",
"overload"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"name"
]
}
}
},
"route-import": {
"vipType": "constant",
"vipValue": [
{
"protocol": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "bgp",
"vipVariableName": "vpn_interface_leakfromprotocol"
}
},
{
"protocol": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "connected",
"vipVariableName": "vpn_interface_leakfromprotocol"
}
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"protocol"
]
},
"route-export": {
"vipType": "ignore",
"vipValue": [],
"vipObjectType": "tree",
"vipPrimaryKey": [
"protocol"
]
},
"dns": {
"vipType": "constant",
"vipValue": [
{
"role": {
"vipType": "constant",
"vipValue": "primary",
"vipObjectType": "object"
},
"dns-addr": {
"vipType": "constant",
"vipValue": "10.124.19.169",
"vipObjectType": "object"
},
"priority-order": [
"dns-addr",
"role"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"dns-addr"
]
},
"host": {
"vipType": "constant",
"vipValue": [
{
"hostname": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "vm5",
"vipVariableName": "vpn_host_hostname"
},
"ip": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"172.16.255.15"
],
"vipVariableName": "vpn_host_ip"
},
"priority-order": [
"hostname",
"ip"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"hostname"
]
},
"service": {
"vipType": "constant",
"vipValue": [
{
"svc-type": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "FW"
},
"address": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"10.10.5.5"
],
"vipVariableName": "vpn_service_address"
},
"track-enable": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_service_service_track"
},
"priority-order": [
"svc-type",
"address",
"track-enable"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"svc-type"
]
},
"ip": {
"route": {
"vipType": "constant",
"vipValue": [
{
"prefix": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "20.20.20.20/24",
"vipVariableName": "vpn_ipv4_ip_prefix"
},
"next-hop": {
"vipType": "constant",
"vipValue": [
{
"address": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "20.20.20.1",
"vipVariableName": "vpn_next_hop_ip_address_0"
},
"distance": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 3,
"vipVariableName": "vpn_next_hop_ip_distance_0"
},
"tracker": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": "",
"vipVariableName": "vpn_next_hop_ip_tracker_0"
},
"priority-order": [
"address",
"distance",
"tracker"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"address"
]
},
"priority-order": [
"prefix",
"next-hop"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"prefix"
]
},
"gre-route": {
"vipType": "constant",
"vipValue": [
{
"prefix": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "4.4.4.4/16",
"vipVariableName": "vpn_gre_route_gre_route_prefix"
},
"vpn": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 0
},
"interface": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"2"
],
"vipVariableName": "vpn_gre_route_gre_route_interface"
},
"priority-order": [
"prefix",
"vpn",
"interface"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"prefix"
]
},
"ipsec-route": {
"vipType": "constant",
"vipValue": [
{
"prefix": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "5.5.5.5/16",
"vipVariableName": "vpn_ipsec_route_ipsec_route_prefix"
},
"vpn": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 0
},
"interface": {
"vipObjectType": "list",
"vipType": "ignore",
"vipVariableName": "vpn_ipsec_route_ipsec_route_interface"
},
"priority-order": [
"prefix",
"vpn",
"interface"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"prefix"
]
},
"service-route": {
"vipType": "constant",
"vipValue": [
{
"prefix": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "3.3.3.3/16",
"vipVariableName": "vpn_serviceroute_prefix"
},
"vpn": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 0
},
"service": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "sig"
},
"priority-order": [
"prefix",
"vpn",
"service"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"prefix"
]
}
},
"ipv6": {
"route": {
"vipType": "constant",
"vipValue": [
{
"prefix": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "2001:db8:8086:6502::/64",
"vipVariableName": "vpn_ipv6_ipv6_prefix"
},
"next-hop": {
"vipType": "constant",
"vipValue": [
{
"address": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "2001:db8:8086:6501::",
"vipVariableName": "vpn_next_hop_ipv6_address_0"
},
"distance": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1,
"vipVariableName": "vpn_next_hop_ipv6_distance_0"
},
"priority-order": [
"address",
"distance"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"address"
]
},
"priority-order": [
"prefix",
"next-hop"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"prefix"
]
}
},
"omp": {
"advertise": {
"vipType": "constant",
"vipValue": [
{
"priority-order": [
"protocol"
],
"protocol": {
"vipType": "constant",
"vipValue": "bgp",
"vipObjectType": "object"
}
},
{
"priority-order": [
"protocol"
],
"protocol": {
"vipType": "constant",
"vipValue": "static",
"vipObjectType": "object"
}
},
{
"priority-order": [
"protocol"
],
"protocol": {
"vipType": "constant",
"vipValue": "connected",
"vipObjectType": "object"
}
},
{
"priority-order": [
"protocol",
"protocol-sub-type"
],
"protocol": {
"vipType": "constant",
"vipValue": "ospf",
"vipObjectType": "object"
},
"protocol-sub-type": {
"vipType": "constant",
"vipValue": "external",
"vipObjectType": "object"
}
},
{
"priority-order": [
"protocol",
"prefix-list"
],
"protocol": {
"vipType": "constant",
"vipValue": "network",
"vipObjectType": "object"
},
"prefix-list": {
"vipType": "constant",
"vipValue": [
{
"prefix-entry": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "10.10.10.10/24",
"vipVariableName": "vpn_omp_network_network_prefix"
},
"priority-order": [
"prefix-entry"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"prefix-entry"
]
}
},
{
"priority-order": [
"protocol"
],
"protocol": {
"vipType": "constant",
"vipValue": "eigrp",
"vipObjectType": "object"
}
},
{
"priority-order": [
"protocol"
],
"protocol": {
"vipType": "constant",
"vipValue": "lisp",
"vipObjectType": "object"
}
},
{
"priority-order": [
"protocol"
],
"protocol": {
"vipType": "constant",
"vipValue": "isis",
"vipObjectType": "object"
}
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"protocol"
]
},
"distance": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 12,
"vipVariableName": "vpn_distance"
},
"ipv6-advertise": {
"vipType": "ignore",
"vipValue": [],
"vipObjectType": "tree",
"vipPrimaryKey": [
"protocol"
]
}
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleVpnVedge"
},
"vpn-vmanage-interface-example": {
"description": "vpn-vmanage-interface-example",
"value": {
"templateName": "vpn_vmanage_interface",
"templateDescription": "vpn_vmanage_interface",
"templateType": "vpn-vmanage-interface",
"deviceType": [
"vmanage"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"if-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "ge1/",
"vipVariableName": "vpn_if_name"
},
"description": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "dd1",
"vipVariableName": "vpn_if_description"
},
"ip": {
"dhcp-client": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true"
},
"dhcp-distance": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 4,
"vipVariableName": "vpn_if_ip_dhcp_distance"
}
},
"ipv6": {
"dhcp-client": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true"
},
"dhcp-distance": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 4,
"vipVariableName": "vpn_if_ipv6_dhcp_distance"
},
"dhcp-rapid-commit": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_ipv6_dhcp_rapid_commit"
}
},
"dhcp-helper": {},
"flow-control": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "autoneg",
"vipVariableName": "vpn_if_flow_control"
},
"clear-dont-fragment": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_clear_dont_fragment"
},
"pmtu": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_pmtu"
},
"mtu": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1500,
"vipVariableName": "vpn_if_mtu"
},
"static-ingress-qos": {},
"tcp-mss-adjust": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1480,
"vipVariableName": "vpn_if_tcp_mss_adjust"
},
"mac-address": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "00:00:00:00:00:02",
"vipVariableName": "vpn_if_mac-address"
},
"speed": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "1000",
"vipVariableName": "vpn_if_speed"
},
"duplex": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "full",
"vipVariableName": "vpn_if_'duplex"
},
"shutdown": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "false",
"vipVariableName": "vpn_if_shutdown"
},
"arp-timeout": {},
"autonegotiate": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_autonegotiate"
},
"arp": {
"ip": {
"vipType": "constant",
"vipValue": [
{
"addr": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "10.10.10.10",
"vipVariableName": "vpn_bridge_arp_addr"
},
"mac": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "00:00:00:00:00:01",
"vipVariableName": "vpn_bridge_arp_mac"
},
"priority-order": [
"addr",
"mac"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"addr"
]
}
},
"tunnel-interface": {
"color": {
"value": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "green",
"vipVariableName": "vpn_if_tunnel_color_value"
},
"restrict": {}
},
"carrier": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "carrier2",
"vipVariableName": "vpn_if_tunnel_carrier"
},
"hello-interval": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 600,
"vipVariableName": "vpn_if_tunnel_hello_interval"
},
"hello-tolerance": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 12,
"vipVariableName": "vpn_if_tunnel_hello_tolerance"
},
"nat-refresh-interval": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 5,
"vipVariableName": "vpn_if_tunnel_nat_refresh_interval"
},
"allow-service": {
"all": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_all"
},
"dhcp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_dhcp"
},
"dns": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_dns"
},
"icmp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_icmp"
},
"sshd": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_sshd"
},
"netconf": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_netconf"
},
"ntp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_ntp"
},
"stun": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_stun"
},
"bgp": {},
"https": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_https"
}
},
"connections-limit": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 50,
"vipVariableName": "vpn_if_tunnel_connections_limit"
},
"group": {
"vipObjectType": "list",
"vipType": "ignore"
},
"low-bandwidth-link": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_low-bandwidth-link"
}
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleVpnVmanageInterface"
},
"vpn-vsmart-interface-example": {
"description": "vpn-vsmart-interface-example",
"value": {
"templateName": "vpn_vsmart_interface",
"templateDescription": "vpn_vsmart_interface",
"templateType": "vpn-vsmart-interface",
"deviceType": [
"vsmart"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"if-name": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "GigabitEthernet0",
"vipVariableName": "vpn_if_name"
},
"description": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "description",
"vipVariableName": "vpn_if_description"
},
"ip": {
"dhcp-client": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true"
},
"dhcp-distance": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1,
"vipVariableName": "vpn_if_ip_dhcp-distance"
}
},
"ipv6": {
"dhcp-client": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true"
},
"dhcp-distance": {
"vipObjectType": "object",
"vipType": "ignore",
"vipValue": 1,
"vipVariableName": "vpn_if_ipv6_dhcp-distance"
},
"dhcp-rapid-commit": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_ipv6_dhcp-rapid-commit"
}
},
"dhcp-helper": {},
"flow-control": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "egress",
"vipVariableName": "vpn_if_flow_control"
},
"clear-dont-fragment": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_clear_dont_fragment"
},
"pmtu": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_pmtu"
},
"mtu": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1500,
"vipVariableName": "vpn_if_mtu"
},
"static-ingress-qos": {},
"tcp-mss-adjust": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1490,
"vipVariableName": "vpn_if_tcp_mss_adjust"
},
"mac-address": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "B8:08:CF:42:FB:16",
"vipVariableName": "vpn_if_mac_address"
},
"speed": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "1000",
"vipVariableName": "vpn_if_speed"
},
"duplex": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "full",
"vipVariableName": "vpn_if_duplex"
},
"shutdown": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "false",
"vipVariableName": "vpn_if_shutdown"
},
"arp-timeout": {},
"autonegotiate": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_autonegotiate"
},
"arp": {
"ip": {
"vipType": "constant",
"vipValue": [
{
"addr": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "10.140.36.89",
"vipVariableName": "vpn_bridge_arp_addr"
},
"mac": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "B8:08:CF:42:FB:16",
"vipVariableName": "vpn_bridge_arp_mac"
},
"priority-order": [
"addr",
"mac"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"addr"
]
}
},
"tunnel-interface": {
"color": {
"value": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "gold",
"vipVariableName": "vpn_if_tunnel_color_value"
},
"restrict": {}
},
"carrier": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "carrier8",
"vipVariableName": "vpn_if_tunnel_carrier"
},
"hello-interval": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 600,
"vipVariableName": "vpn_if_tunnel_hello-interval"
},
"hello-tolerance": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 12,
"vipVariableName": "vpn_if_tunnel_hello-tolerance"
},
"nat-refresh-interval": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 10,
"vipVariableName": "vpn_if_tunnel_nat_refresh_interval"
},
"allow-service": {
"all": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "all"
},
"dhcp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_dhcp"
},
"dns": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_dns"
},
"icmp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_icmp"
},
"sshd": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_sshd"
},
"netconf": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_netconf"
},
"ntp": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_ntp"
},
"stun": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "true",
"vipVariableName": "vpn_if_tunnel_stun"
},
"bgp": {}
},
"group": {
"vipObjectType": "list",
"vipType": "ignore"
}
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleVpnVsmartInterface"
},
"vpn-vsmart-example": {
"description": "vpn-vsmart-example",
"value": {
"templateName": "template_vpn_vsmart",
"templateDescription": "template_vpn_vsmart",
"templateType": "vpn-vsmart",
"deviceType": [
"vsmart"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"vpn-id": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "512"
},
"name": {
"vipObjectType": "object",
"vipType": "variableName",
"vipValue": "",
"vipVariableName": "vpn_name"
},
"dns": {
"vipType": "constant",
"vipValue": [
{
"role": {
"vipType": "constant",
"vipValue": "primary",
"vipObjectType": "object"
},
"dns-addr": {
"vipType": "constant",
"vipValue": "10.124.19.169",
"vipObjectType": "object"
},
"priority-order": [
"dns-addr",
"role"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"dns-addr"
]
},
"host": {
"vipType": "constant",
"vipValue": [
{
"hostname": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "YAPZHANG-WT2",
"vipVariableName": "vpn_host_hostname"
},
"ip": {
"vipObjectType": "list",
"vipType": "constant",
"vipValue": [
"10.140.36.89"
],
"vipVariableName": "vpn_host_ip"
},
"priority-order": [
"hostname",
"ip"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"hostname"
]
},
"ip": {
"route": {
"vipType": "constant",
"vipValue": [
{
"prefix": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "20.20.20.20/24",
"vipVariableName": "vpn_ipv4_ip_prefix"
},
"next-hop": {
"vipType": "constant",
"vipValue": [
{
"address": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "20.20.20.1",
"vipVariableName": "vpn_next_hop_ip_address_0"
},
"distance": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1,
"vipVariableName": "vpn_next_hop_ip_distance_0"
},
"priority-order": [
"address",
"distance"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"address"
]
},
"priority-order": [
"prefix",
"next-hop"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"prefix"
]
}
},
"ipv6": {
"route": {
"vipType": "constant",
"vipValue": [
{
"prefix": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "FF01::101/16",
"vipVariableName": "vpn_ipv6_ipv6_prefix"
},
"next-hop": {
"vipType": "constant",
"vipValue": [
{
"address": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "FF01::100",
"vipVariableName": "vpn_next_hop_ipv6_address_0"
},
"distance": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": 1,
"vipVariableName": "vpn_next_hop_ipv6_distance_0"
},
"priority-order": [
"address",
"distance"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"address"
]
},
"priority-order": [
"prefix",
"next-hop"
]
}
],
"vipObjectType": "tree",
"vipPrimaryKey": [
"prefix"
]
}
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleVpnVsmart"
},
"wla-example": {
"description": "wla-example",
"value": {
"templateName": "template_wifi_radio",
"templateDescription": "template_wifi_radio",
"templateType": "wlan",
"deviceType": [
"vedge-100-WM"
],
"templateMinVersion": "15.0.0",
"templateDefinition": {
"radio": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "2.4GHz"
},
"country": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "Costa Rica"
},
"channel-bandwidth": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "20",
"vipVariableName": "channel-bandwidth"
},
"guard-interval": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "800",
"vipVariableName": "guard-interval"
},
"channel": {
"vipObjectType": "object",
"vipType": "constant",
"vipValue": "10"
}
},
"factoryDefault": false
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigTemplateGeneralGeneraltemplaterestfulresourceRequestExampleWlan"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Template": {
"description": "Template",
"value": {
"masterTemplatesAffected": []
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Template Configuration-write,Template Deploy-write,Policy Configuration-write"
}
},
"/template/lock/{processId}": {
"delete": {
"tags": [
"Configuration - Template Lock"
],
"description": "Remove lock",
"operationId": "removeLock",
"parameters": [
{
"name": "processId",
"in": "path",
"description": "Process Id",
"required": true,
"schema": {
"type": "string",
"example": "push_feature_template_configuration-ea4fe240-520c-4aaf-b674-7dfb46b0105e"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Template Configuration-write,Template Deploy-write,Policy Configuration-write"
},
"put": {
"tags": [
"Configuration - Template Lock"
],
"description": "Update lease",
"operationId": "updateLeaseTime",
"parameters": [
{
"name": "processId",
"in": "path",
"description": "Process Id",
"required": true,
"schema": {
"type": "string",
"example": "push_feature_template_configuration-ea4fe240-520c-4aaf-b674-7dfb46b0105e"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Template Configuration-write,Template Deploy-write,Policy Configuration-write"
}
},
"/template/policy/assembly/security": {
"post": {
"tags": [
"Configuration - Policy Security Assembler"
],
"description": "Get policy assembly preview",
"operationId": "preview_ConfigurationPolicySecurityAssembler_3404",
"requestBody": {
"description": "Policy assembly",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy assembly": {
"description": "Policy assembly",
"value": {
"assembly": [
{
"definitionId": "aee2adc2-7b10-437e-8d74-fc52557f7cb7",
"type": "appRoute",
"entries": [
{
"siteLists": [
"cf4bbb13-0a3f-4302-adfa-6cfce6b3950c"
],
"vpnLists": [
"ab2b3ffa-b390-4143-95f3-14d084efc85f"
]
}
]
},
{
"definitionId": "605fabbd-4c99-4be4-8842-aebb256f7010",
"type": "hubAndSpoke"
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy assembly preview": {
"description": "Policy assembly preview",
"value": "{\n \"preview\":\"viptela-policy:policy\n sla-class VoiceVideoSLA\n latency 100\n !\n sla-class WebSLA\n latency 150\n !\n control-policy control_-1240443936\n \"\n}"
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Security Policy Configuration-read,Security Policy Configuration-write"
}
},
"/template/policy/assembly/security/{id}": {
"get": {
"tags": [
"Configuration - Policy Security Assembler"
],
"description": "Get policy assembly preview for feature policy",
"operationId": "previewById_ConfigurationPolicySecurityAssembler_3903",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy assembly preview": {
"description": "Policy assembly preview",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Security Policy Configuration-read,Security Policy Configuration-write"
}
},
"/template/policy/assembly/vedge": {
"post": {
"tags": [
"Configuration - Policy vEdge Assembler"
],
"description": "Get policy assembly preview",
"operationId": "preview_ConfigurationPolicyVedgeAssembler_3104",
"requestBody": {
"description": "Policy assembly",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy assembly": {
"description": "Policy assembly",
"value": {
"assembly": [
{
"definitionId": "aee2adc2-7b10-437e-8d74-fc52557f7cb7",
"type": "appRoute",
"entries": [
{
"siteLists": [
"cf4bbb13-0a3f-4302-adfa-6cfce6b3950c"
],
"vpnLists": [
"ab2b3ffa-b390-4143-95f3-14d084efc85f"
]
}
]
},
{
"definitionId": "605fabbd-4c99-4be4-8842-aebb256f7010",
"type": "hubAndSpoke"
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy assembly preview": {
"description": "Policy assembly preview",
"value": "{\n \"preview\":\"viptela-policy:policy\n sla-class VoiceVideoSLA\n latency 100\n !\n sla-class WebSLA\n latency 150\n !\n control-policy control_-1240443936\n \"\n}"
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Security Policy Configuration-read,Security Policy Configuration-write"
}
},
"/template/policy/assembly/vedge/{id}": {
"get": {
"tags": [
"Configuration - Policy vEdge Assembler"
],
"description": "Get policy assembly preview for feature policy",
"operationId": "previewById_ConfigurationPolicyVedgeAssembler_3603",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy assembly preview": {
"description": "Policy assembly preview",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Security Policy Configuration-read,Security Policy Configuration-write"
}
},
"/template/policy/assembly/voice": {
"post": {
"tags": [
"Configuration - Policy Voice Assembler"
],
"description": "Get policy assembly preview",
"operationId": "preview_ConfigurationPolicyVoiceAssembler_3104",
"requestBody": {
"description": "Policy assembly",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy assembly": {
"description": "Policy assembly",
"value": {
"assembly": [
{
"definitionId": "aee2adc2-7b10-437e-8d74-fc52557f7cb7",
"type": "appRoute",
"entries": [
{
"siteLists": [
"cf4bbb13-0a3f-4302-adfa-6cfce6b3950c"
],
"vpnLists": [
"ab2b3ffa-b390-4143-95f3-14d084efc85f"
]
}
]
},
{
"definitionId": "605fabbd-4c99-4be4-8842-aebb256f7010",
"type": "hubAndSpoke"
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy assembly preview": {
"description": "Policy assembly preview",
"value": "{\n \"preview\":\"viptela-policy:policy\n sla-class VoiceVideoSLA\n latency 100\n !\n sla-class WebSLA\n latency 150\n !\n control-policy control_-1240443936\n \"\n}"
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Security Policy Configuration-read,Security Policy Configuration-write"
}
},
"/template/policy/assembly/voice/{id}": {
"get": {
"tags": [
"Configuration - Policy Voice Assembler"
],
"description": "Get policy assembly preview for feature policy",
"operationId": "previewById_ConfigurationPolicyVoiceAssembler_3603",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy assembly preview": {
"description": "Policy assembly preview",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Security Policy Configuration-read,Security Policy Configuration-write"
}
},
"/template/policy/assembly/vsmart": {
"post": {
"tags": [
"Configuration - Policy vSmart Assembler"
],
"description": "Get policy assembly preview",
"operationId": "preview_ConfigurationPolicyVsmartAssembler_3204",
"requestBody": {
"description": "Policy assembly",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy assembly": {
"description": "Policy assembly",
"value": {
"assembly": [
{
"definitionId": "aee2adc2-7b10-437e-8d74-fc52557f7cb7",
"type": "appRoute",
"entries": [
{
"siteLists": [
"cf4bbb13-0a3f-4302-adfa-6cfce6b3950c"
],
"vpnLists": [
"ab2b3ffa-b390-4143-95f3-14d084efc85f"
]
}
]
},
{
"definitionId": "605fabbd-4c99-4be4-8842-aebb256f7010",
"type": "hubAndSpoke"
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy assembly preview": {
"description": "Policy assembly preview",
"value": "{\n \"preview\":\"viptela-policy:policy\n sla-class VoiceVideoSLA\n latency 100\n !\n sla-class WebSLA\n latency 150\n !\n control-policy control_-1240443936\n \"\n}"
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Security Policy Configuration-read,Security Policy Configuration-write"
}
},
"/template/policy/assembly/vsmart/{id}": {
"get": {
"tags": [
"Configuration - Policy vSmart Assembler"
],
"description": "Get policy assembly preview for feature policy",
"operationId": "previewById_ConfigurationPolicyVsmartAssembler_3703",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy assembly preview": {
"description": "Policy assembly preview",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Security Policy Configuration-read,Security Policy Configuration-write"
}
},
"/template/policy/clouddiscoveredapp": {
"get": {
"tags": [
"Configuration - Policy Cloud Application Builder"
],
"description": "Get all cloud discovered applications",
"operationId": "getCloudDiscoveredApps",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Cloud Discovered App": {
"description": "Cloud Discovered App",
"value": {
"data": [
{
"appId": "679cdb6f-67d8-45bd-9de0-a73138a9ca05",
"appName": "DemoApp",
"lastUpdated": "1590201349732",
"owner": "admin"
}
]
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
},
"post": {
"tags": [
"Configuration - Policy Custom Application Builder"
],
"description": "Set SLA class for policy cloud discovered applications",
"operationId": "MapTrafficProfiles",
"requestBody": {
"description": "App payload",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"App payload": {
"description": "App payload",
"value": "[\n {\n \"appId\":\"71001c48-fdcf-4ac0-aaf3-ca4a20386a18\",\n \"slaClass\":\"video\",\n }\n]"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"App": {
"description": "App",
"value": {
"appId": "679cdb6f-67d8-45bd-9de0-a73138a9ca05"
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/customapp": {
"get": {
"tags": [
"Configuration - Policy Custom Application Builder"
],
"description": "Get all policy custom applications",
"operationId": "getCustomApps",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Custom App": {
"description": "Custom App",
"value": {
"data": [
{
"appId": "679cdb6f-67d8-45bd-9de0-a73138a9ca05",
"appName": "DemoApp",
"lastUpdated": "1590201349732",
"owner": "admin"
}
]
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
},
"post": {
"tags": [
"Configuration - Policy Custom Application Builder"
],
"description": "Create Custom Applications",
"operationId": "createCustomApplication",
"requestBody": {
"description": "Create Custom Application",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Create Custom Application Payload": {
"description": "Create Custom Application Payload",
"value": {
"appName": "demo_app",
"serverNames": [
"demo.app.com"
],
"L3L4": [
{
"ipAddresses": [
"10.2.56.45"
],
"ports": "5666",
"l4Protocol": "TCP-UDP"
}
],
"attributes": {
"application-family": "instant-messaging",
"application-group": "flash-group",
"traffic-class": "multimedia-conferencing",
"business-relevance": "business-irrelevant"
}
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Task Response": {
"description": "Task Response",
"value": {
"taskId": "sdavc_rest_api_call-27166314-0a04-4bc3-8af5-27b78684c902"
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/customapp/{id}": {
"get": {
"tags": [
"Configuration - Policy Custom Application Builder"
],
"description": "Get a policy custom applications",
"operationId": "getCustomAppById",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Custom App": {
"description": "Custom App",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
},
"delete": {
"tags": [
"Configuration - Policy Custom Application Builder"
],
"description": "Delete Custom Application",
"operationId": "deleteCustomApp",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Custom Application UUID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Task Response": {
"description": "Task Response",
"value": {
"taskId": "sdavc_rest_api_call-27166314-0a04-4bc3-8af5-27b78684c902"
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
},
"put": {
"tags": [
"Configuration - Policy Custom Application Builder"
],
"description": "Update Custom Applications",
"operationId": "updateCustomApplication",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Custom Application UUID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Update Custom Application",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Update Custom Application Payload": {
"description": "Update Custom Application Payload",
"value": {
"appName": "demo_app",
"serverNames": [
"demo.app.com"
],
"L3L4": [
{
"ipAddresses": [
"10.2.56.45"
],
"ports": "5666",
"l4Protocol": "TCP-UDP"
}
],
"attributes": {
"application-family": "instant-messaging",
"application-group": "flash-group",
"traffic-class": "multimedia-conferencing",
"business-relevance": "business-irrelevant"
}
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Task Response": {
"description": "Task Response",
"value": {
"taskId": "sdavc_rest_api_call-27166314-0a04-4bc3-8af5-27b78684c902"
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/definition/acl": {
"get": {
"tags": [
"Configuration - Policy Access List Definition Builder"
],
"description": "Get policy definitions",
"operationId": "getDefinitions_ConfigurationPolicyAccessListDefinitionBuilder_3103",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,ACL Policy-read,ACL Policy-write"
},
"post": {
"tags": [
"Configuration - Policy Access List Definition Builder"
],
"description": "Create policy definition",
"operationId": "createPolicyDefinition_ConfigurationPolicyAccessListDefinitionBuilder_3104",
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write,ACL Policy-write"
}
},
"/template/policy/definition/acl/bulk": {
"put": {
"tags": [
"Configuration - Policy Access List Definition Builder"
],
"description": "Create/Edit policy definitions in bulk",
"operationId": "savePolicyDefinitionInBulk_ConfigurationPolicyAccessListDefinitionBuilder_3603",
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/definition/acl/multiple/{id}": {
"put": {
"tags": [
"Configuration - Policy Access List Definition Builder"
],
"description": "Edit multiple policy definitions",
"operationId": "editMultiplePolicyDefinition_ConfigurationPolicyAccessListDefinitionBuilder_4503",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/definition/acl/preview": {
"post": {
"tags": [
"Configuration - Policy Access List Definition Builder"
],
"description": "Preview policy definition",
"operationId": "previewPolicyDefinition_ConfigurationPolicyAccessListDefinitionBuilder_3904",
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/definition/acl/preview/{id}": {
"get": {
"tags": [
"Configuration - Policy Access List Definition Builder"
],
"description": "Preview policy definition",
"operationId": "previewPolicyDefinitionById_ConfigurationPolicyAccessListDefinitionBuilder_4403",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/definition/acl/{id}": {
"get": {
"tags": [
"Configuration - Policy Access List Definition Builder"
],
"description": "Get a specific policy definitions",
"operationId": "getPolicyDefinition_ConfigurationPolicyAccessListDefinitionBuilder_3603",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,ACL Policy-read,ACL Policy-write"
},
"delete": {
"tags": [
"Configuration - Policy Access List Definition Builder"
],
"description": "Delete policy definition",
"operationId": "deletePolicyDefinition_ConfigurationPolicyAccessListDefinitionBuilder_3606",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write,ACL Policy-write"
},
"put": {
"tags": [
"Configuration - Policy Access List Definition Builder"
],
"description": "Edit a policy definitions",
"operationId": "editPolicyDefinition_ConfigurationPolicyAccessListDefinitionBuilder_3603",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write,ACL Policy-write"
}
},
"/template/policy/definition/aclv6": {
"get": {
"tags": [
"Configuration - Policy IPv6 Access Definition Builder"
],
"description": "Get policy definitions",
"operationId": "getDefinitions_ConfigurationPolicyIpv6AccessDefinitionBuilder_3303",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,ACL Policy-read,ACL Policy-write"
},
"post": {
"tags": [
"Configuration - Policy IPv6 Access Definition Builder"
],
"description": "Create policy definition",
"operationId": "createPolicyDefinition_ConfigurationPolicyIpv6AccessDefinitionBuilder_3304",
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write,ACL Policy-write"
}
},
"/template/policy/definition/aclv6/bulk": {
"put": {
"tags": [
"Configuration - Policy IPv6 Access Definition Builder"
],
"description": "Create/Edit policy definitions in bulk",
"operationId": "savePolicyDefinitionInBulk_ConfigurationPolicyIpv6AccessDefinitionBuilder_3803",
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/definition/aclv6/multiple/{id}": {
"put": {
"tags": [
"Configuration - Policy IPv6 Access Definition Builder"
],
"description": "Edit multiple policy definitions",
"operationId": "editMultiplePolicyDefinition_ConfigurationPolicyIpv6AccessDefinitionBuilder_4703",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/definition/aclv6/preview": {
"post": {
"tags": [
"Configuration - Policy IPv6 Access Definition Builder"
],
"description": "Preview policy definition",
"operationId": "previewPolicyDefinition_ConfigurationPolicyIpv6AccessDefinitionBuilder_4104",
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/definition/aclv6/preview/{id}": {
"get": {
"tags": [
"Configuration - Policy IPv6 Access Definition Builder"
],
"description": "Preview policy definition",
"operationId": "previewPolicyDefinitionById_ConfigurationPolicyIpv6AccessDefinitionBuilder_4603",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/definition/aclv6/{id}": {
"get": {
"tags": [
"Configuration - Policy IPv6 Access Definition Builder"
],
"description": "Get a specific policy definitions",
"operationId": "getPolicyDefinition_ConfigurationPolicyIpv6AccessDefinitionBuilder_3803",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,ACL Policy-read,ACL Policy-write"
},
"put": {
"tags": [
"Configuration - Policy IPv6 Access Definition Builder"
],
"description": "Edit a policy definitions",
"operationId": "editPolicyDefinition_ConfigurationPolicyIpv6AccessDefinitionBuilder_3803",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write,ACL Policy-write"
},
"delete": {
"tags": [
"Configuration - Policy IPv6 Access Definition Builder"
],
"description": "Delete policy definition",
"operationId": "deletePolicyDefinition_ConfigurationPolicyIpv6AccessDefinitionBuilder_3806",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write,ACL Policy-write"
}
},
"/template/policy/definition/advancedMalwareProtection": {
"get": {
"tags": [
"Configuration - Policy AMP Definition Builder"
],
"description": "Get policy definitions",
"operationId": "getDefinitions_ConfigurationPolicyAmpDefinitionBuilder_5303",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
},
"post": {
"tags": [
"Configuration - Policy AMP Definition Builder"
],
"description": "Create policy definition",
"operationId": "createPolicyDefinition_ConfigurationPolicyAmpDefinitionBuilder_5304",
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"ACL policy": {
"description": "ACL policy",
"value": {
"name": "Demo-ACL",
"type": "acl",
"description": "Demo-ACL",
"defaultAction": {
"type": "accept"
},
"sequences": [
{
"sequenceId": 1,
"sequenceName": "Access Control List",
"baseAction": "accept",
"sequenceType": "acl",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "dscp",
"value": "46"
}
]
},
"actions": [
{
"type": "class",
"parameter": {
"ref": "89d20034-7149-4492-b392-b5c4f7903235"
}
}
]
}
]
}
},
"ZBFW definition": {
"description": "ZBFW definition",
"value": {
"name": "Demo-ZBFW",
"type": "zoneBasedFW",
"description": "Demo-ZBFW",
"definition": {
"defaultAction": {
"type": "drop"
},
"sequences": [],
"entries": [
{
"sourceZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53",
"destinationZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53"
}
]
}
}
},
"IPS definition": {
"description": "IPS definition",
"value": {
"name": "Demo-IPS-Policy",
"type": "intrusionPrevention",
"description": "Testing",
"definition": {
"signatureSet": "security",
"inspectionMode": "detection",
"signatureWhiteList": {
"ref": "ad189f08-af06-4799-97d6-0a7c7409cb8d"
},
"logLevel": "error",
"logging": [],
"targetVpns": [
"10"
]
}
}
},
"URL filtering definition": {
"description": "URL filtering definition",
"value": {
"name": "Demo-URL-Filtering-Policy",
"type": "urlFiltering",
"description": "",
"definition": {
"webCategoriesAction": "block",
"webCategories": [
"auctions",
"bot-nets"
],
"webReputation": "moderate-risk",
"urlWhiteList": {
"ref": "c20e31fb-fcea-4f48-93e3-09d2c6492d8b"
},
"urlBlackList": {
"ref": "557ed432-6cf8-495b-a445-d340d4c6236e"
},
"blockPageAction": "text",
"blockPageContents": "Access to the requested page has been denied. Please contact your Network Administrator",
"enableAlerts": true,
"alerts": [
"blacklist",
"whitelist",
"categories-reputation"
],
"logging": [],
"targetVpns": [
"10",
"20"
]
}
}
},
"AMP definition": {
"description": "AMP definition",
"value": {
"name": "Demo-AMP-Policy",
"type": "advancedMalwareProtection",
"description": "",
"definition": {
"matchAllVpn": false,
"fileReputationCloudServer": "nam",
"fileReputationEstServer": "nam",
"fileReputationAlert": "critical",
"fileAnalysisCloudServer": "",
"fileAnalysisFileTypes": [],
"fileAnalysisAlert": "",
"targetVpns": [
"10",
"20"
]
}
}
},
"DNS definition": {
"description": "DNS definition",
"value": {
"name": "Demo-DNS-Policy",
"type": "DNSSecurity",
"description": "Testing",
"definition": {
"localDomainBypassList": {
"ref": "143f753f-8d51-4be6-805d-bc330f09982f"
},
"matchAllVpn": true,
"umbrellaDefault": true,
"childOrgId": "7999118",
"localDomainBypassEnabled": true,
"dnsCrypt": true,
"umbrellaData": {
"ref": "e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa"
}
}
}
},
"HubandSpoke definition": {
"description": "HubandSpoke definition",
"value": {
"name": "Demo-Hub-n-Spoke-Policy",
"type": "hubAndSpoke",
"description": "Demo-Hub-n-Spoke-Policy",
"definition": {
"vpnList": "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf",
"subDefinitions": [
{
"name": "My Hub-and-Spoke",
"equalPreference": false,
"advertiseTloc": true,
"spokes": [
{
"siteList": "5c58c36c-9cd6-468f-8434-ee6d5801c6ba",
"hubs": [
{
"siteList": "24747ccd-4f7f-4dfa-8800-34f565fb65b4",
"preference": "20",
"prefixLists": [
"b5c4d764-20bc-4de3-9bac-52ef70f1186c"
],
"ipv6PrefixLists": []
}
]
}
],
"tlocList": "1e97c258-4323-4754-9dc0-44e9656d43bf"
}
]
}
}
},
"VPN membership group definition": {
"description": "VPN membership group definition",
"value": {
"name": "Demo-VPN-Membership-Policy",
"type": "vpnMembershipGroup",
"description": "Demo-VPN-Membership-Policy",
"definition": {
"sites": [
{
"siteList": "24747ccd-4f7f-4dfa-8800-34f565fb65b4",
"vpnList": [
"cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"
]
},
{
"siteList": "5c58c36c-9cd6-468f-8434-ee6d5801c6ba",
"vpnList": [
"cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"
]
}
]
}
}
},
"AppRoute definition": {
"description": "AppRoute definition",
"value": {
"name": "Demo-AAR-Policy",
"type": "appRoute",
"description": "Demo-AAR-Policy",
"sequences": [
{
"sequenceId": 1,
"sequenceName": "App Route",
"sequenceType": "appRoute",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "appList",
"ref": "b6752dba-969b-46de-a7e7-da11910fb1bf"
},
{
"field": "dnsAppList",
"ref": "b6752dba-969b-46de-a7e7-da11910fb1bf"
},
{
"field": "dns",
"value": "request"
},
{
"field": "dscp",
"value": "46"
},
{
"field": "plp",
"value": "high"
},
{
"field": "protocol",
"value": "6"
},
{
"field": "sourceDataPrefixList",
"ref": "6c2b7164-5de2-4775-938c-b443504324ab"
},
{
"field": "sourcePort",
"value": "1025"
},
{
"field": "destinationDataPrefixList",
"ref": "6c2b7164-5de2-4775-938c-b443504324ab"
},
{
"field": "destinationPort",
"value": "65000"
}
]
},
"actions": [
{
"type": "backupSlaPreferredColor",
"parameter": "biz-internet"
},
{
"type": "count",
"parameter": "Demo-Counter"
},
{
"type": "log",
"parameter": ""
},
{
"type": "slaClass",
"parameter": [
{
"field": "name",
"ref": "46cea5a1-1570-4921-b87a-837d590eb37e"
},
{
"field": "preferredColor",
"value": "public-internet"
},
{
"field": "strict"
}
]
}
]
},
{
"sequenceId": 11,
"sequenceName": "App Route",
"sequenceType": "appRoute",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "saasAppList",
"ref": "1e6688ce-2d21-4d7a-9a93-ae6a8ebd4a06"
}
]
},
"actions": [
{
"type": "cloudSaas",
"parameter": ""
}
]
},
{
"sequenceId": 21,
"sequenceName": "App Route",
"sequenceType": "appRoute",
"sequenceIpType": "ipv6",
"match": {
"entries": [
{
"field": "dscp",
"value": "46"
},
{
"field": "protocol",
"value": "6"
},
{
"field": "sourceIpv6",
"value": "2001::/8"
},
{
"field": "sourcePort",
"value": "65000"
},
{
"field": "destinationIpv6",
"value": "2001::/8"
},
{
"field": "destinationPort",
"value": "65000"
}
]
},
"actions": [
{
"type": "backupSlaPreferredColor",
"parameter": "biz-internet"
},
{
"type": "count",
"parameter": "Demo-Counter"
},
{
"type": "log",
"parameter": ""
},
{
"type": "slaClass",
"parameter": [
{
"field": "name",
"ref": "46cea5a1-1570-4921-b87a-837d590eb37e"
},
{
"field": "preferredColor",
"value": "public-internet"
},
{
"field": "strict"
}
]
}
]
}
]
}
},
"Data policy definition": {
"description": "Data policy definition",
"value": {
"name": "Demo-Data-Policy",
"type": "data",
"description": "Demo-Data-Policy",
"defaultAction": {
"type": "drop"
},
"sequences": [
{
"sequenceId": 1,
"sequenceName": "Custom",
"baseAction": "accept",
"sequenceType": "data",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "appList",
"ref": "b6752dba-969b-46de-a7e7-da11910fb1bf"
},
{
"field": "dnsAppList",
"ref": "b6752dba-969b-46de-a7e7-da11910fb1bf"
},
{
"field": "dns",
"value": "response"
},
{
"field": "dscp",
"value": "46"
},
{
"field": "packetLength",
"value": "1504"
},
{
"field": "plp",
"value": "high"
},
{
"field": "protocol",
"value": "6"
},
{
"field": "sourceDataPrefixList",
"ref": "6c2b7164-5de2-4775-938c-b443504324ab"
},
{
"field": "sourcePort",
"value": "65000"
},
{
"field": "destinationIp",
"value": "10.0.0.0/12"
},
{
"field": "destinationPort",
"value": "65000"
},
{
"field": "tcp",
"value": "syn"
}
]
},
"actions": [
{
"type": "count",
"parameter": "Demo-Counter"
},
{
"type": "set",
"parameter": [
{
"field": "dscp",
"value": "34"
},
{
"field": "forwardingClass",
"value": "ef-class"
},
{
"field": "localTlocList",
"value": {
"color": "public-internet",
"restrict": "",
"encap": "ipsec"
}
},
{
"field": "nextHop",
"value": "10.0.0.1"
},
{
"field": "policer",
"ref": "ecf250c7-bef0-405b-8e74-4d67440cac90"
}
]
},
{
"type": "cflowd"
},
{
"type": "log",
"parameter": ""
},
{
"type": "nat",
"parameter": {
"field": "pool",
"value": "1"
}
},
{
"type": "redirectDns",
"parameter": {
"field": "dnsType",
"value": "umbrella"
}
}
]
},
{
"sequenceId": 11,
"sequenceName": "Custom",
"baseAction": "accept",
"sequenceType": "data",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "appList",
"ref": "b6752dba-969b-46de-a7e7-da11910fb1bf"
}
]
},
"actions": [
{
"type": "set",
"parameter": [
{
"field": "service",
"value": {
"type": "FW",
"vpn": "10",
"tloc": {
"ip": "10.0.0.1",
"color": "biz-internet",
"encap": "ipsec"
}
}
}
]
},
{
"type": "tcpOptimization",
"parameter": ""
},
{
"type": "lossProtect",
"parameter": "fecAdaptive"
},
{
"type": "lossProtectFec",
"parameter": "fecAdaptive"
},
{
"type": "sig",
"parameter": ""
}
]
}
]
}
},
"CFlowd definition": {
"description": "CFlowd definition",
"value": {
"name": "Demo-cflowd-Policy",
"type": "cflowd",
"description": "Demo-cflowd-Policy",
"definition": {
"flowActiveTimeout": 3600,
"flowInactiveTimeout": 3600,
"flowSamplingInterval": 65513,
"templateRefresh": 86400,
"collectors": [
{
"vpn": "10",
"address": "10.0.0.1",
"port": 9912,
"transport": "transport_tcp",
"sourceInterface": "ge0/1"
},
{
"vpn": "20",
"address": "10.0.0.1",
"port": 1025,
"transport": "transport_udp",
"sourceInterface": "GigabitEthernet0/0/1"
}
],
"protocol": "ipv4"
}
}
},
"QoS map definition": {
"description": "QoS map definition",
"value": {
"name": "Demo-QoS-Policy",
"type": "qosMap",
"description": "Demo-QoS-Policy",
"definition": {
"qosSchedulers": [
{
"queue": "0",
"bandwidthPercent": "75",
"bufferPercent": "75",
"burst": "15000",
"scheduling": "llq",
"drops": "tail-drop",
"classMapRef": ""
},
{
"queue": "7",
"bandwidthPercent": "25",
"bufferPercent": "25",
"scheduling": "wrr",
"drops": "red-drop",
"classMapRef": "4484c444-b956-4016-bd15-538b74fc2785"
}
]
}
}
},
"VPN-QoS map definition": {
"description": "VPN-QoS map definition",
"value": {
"name": "Demo-VPN-QoS-Policy",
"type": "vpnQosMap",
"description": "Demo-VPN-QoS-Policy",
"definition": {
"vpnQosSchedulers": [
{
"vpnListRef": "",
"bandwidthRate": "100000",
"shapingRate": "120000",
"childMapRef": ""
},
{
"childMapRef": ""
}
]
}
}
},
"Rewrite rule definition": {
"description": "Rewrite rule definition",
"value": {
"name": "Demo-Rewrite-Rule",
"type": "rewriteRule",
"description": "Demo-Rewrite-Rule",
"definition": {
"rules": [
{
"class": "4484c444-b956-4016-bd15-538b74fc2785",
"plp": "low",
"dscp": "46",
"layer2Cos": "2"
}
]
}
}
},
"Device access policy definition": {
"description": "Device access policy definition",
"value": {
"name": "Demo-DeviceAccess-Policy",
"type": "deviceaccesspolicy",
"description": "Demo-DeviceAccess-Policy",
"defaultAction": {
"type": "drop"
},
"sequences": [
{
"sequenceId": 1,
"sequenceName": "Device Access Control List",
"baseAction": "accept",
"sequenceType": "deviceaccesspolicy",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "destinationPort",
"value": "22"
},
{
"field": "sourceIp",
"value": "10.10.24.0/24"
},
{
"field": "sourcePort",
"value": "65000"
},
{
"field": "destinationIp",
"value": "10.10.10.1/32"
},
{
"field": "vpn",
"value": "10"
}
]
},
"actions": []
},
{
"sequenceId": 11,
"sequenceName": "Device Access Control List",
"baseAction": "drop",
"sequenceType": "deviceaccesspolicy",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "destinationPort",
"value": "161"
},
{
"field": "sourceDataPrefixList",
"ref": "6c2b7164-5de2-4775-938c-b443504324ab"
}
]
},
"actions": []
}
]
}
},
"vEdge route definition": {
"description": "vEdge route definition",
"value": {
"name": "Demo-Route-Policy",
"type": "vedgeRoute",
"description": "Demo-Route-Policy",
"defaultAction": {
"type": "reject"
},
"sequences": [
{
"sequenceId": 1,
"sequenceName": "Route",
"baseAction": "accept",
"sequenceType": "vedgeRoute",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "address",
"ref": "b5c4d764-20bc-4de3-9bac-52ef70f1186c"
},
{
"field": "asPath",
"ref": "79f8c180-1a23-4f09-800d-62652b571258"
},
{
"field": "community",
"matchFlag": "or",
"ref": "33de059b-27ec-4a83-be28-8985128381eb"
},
{
"field": "localPreference",
"value": "200"
},
{
"field": "metric",
"value": "100"
},
{
"field": "nextHop",
"ref": "b5c4d764-20bc-4de3-9bac-52ef70f1186c"
},
{
"field": "ompTag",
"value": "10"
},
{
"field": "affinity",
"value": "10"
},
{
"field": "origin",
"value": "igp"
},
{
"field": "ospfTag",
"value": "10"
},
{
"field": "peer",
"value": "10.0.0.1"
}
]
},
"actions": [
{
"type": "set",
"parameter": [
{
"field": "asPath",
"value": {
"exclude": "120 130",
"prepend": "65521 65521"
}
},
{
"field": "localPreference",
"value": "200"
},
{
"field": "metricType",
"value": "type1"
},
{
"field": "metric",
"value": "100"
},
{
"field": "nextHop",
"value": "10.0.0.1"
},
{
"field": "ompTag",
"value": "100"
},
{
"field": "weight",
"value": "200"
},
{
"field": "ospfTag",
"value": "122"
},
{
"field": "originator",
"value": "10.0.0.1"
},
{
"field": "origin",
"value": "igp"
},
{
"field": "community",
"value": "1000:10000"
}
]
}
]
}
]
}
},
"vSmart definition": {
"description": "vSmart definition",
"value": {
"policyDescription": "Demo-Centralized-Policy",
"policyType": "feature",
"policyName": "Demo-Centralized-Policy",
"policyDefinition": {
"assembly": [
{
"definitionId": "eb0daba9-7fc4-4f4f-bae7-cd958f81f863",
"type": "cflowd",
"entries": [
{
"siteLists": [
"5c58c36c-9cd6-468f-8434-ee6d5801c6ba",
"24747ccd-4f7f-4dfa-8800-34f565fb65b4"
]
}
]
},
{
"definitionId": "3e33fa50-a30d-4586-9d69-106121feaaf4",
"type": "data",
"entries": [
{
"direction": "service",
"siteLists": [
"5c58c36c-9cd6-468f-8434-ee6d5801c6ba",
"24747ccd-4f7f-4dfa-8800-34f565fb65b4"
],
"vpnLists": [
"cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"
]
}
]
},
{
"definitionId": "8b2e7c44-2666-48a7-87a0-36a43c2d003e",
"type": "appRoute",
"entries": [
{
"siteLists": [
"5c58c36c-9cd6-468f-8434-ee6d5801c6ba",
"24747ccd-4f7f-4dfa-8800-34f565fb65b4"
],
"vpnLists": [
"cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"
]
}
]
},
{
"definitionId": "1b76052e-1cb5-44b1-8e5e-4096cb261736",
"type": "vpnMembershipGroup"
},
{
"definitionId": "62960276-c797-41fd-bebb-c017fc752f4e",
"type": "hubAndSpoke"
}
]
},
"isPolicyActivated": false
}
},
"vEdge definition": {
"description": "vEdge definition",
"value": {
"policyDescription": "Demo-Local-Policy",
"policyType": "feature",
"policyName": "Demo-Local-Policy",
"policyDefinition": {
"assembly": [
{
"definitionId": "56283dcf-6dda-4831-bcd1-d9cf62d33fdc",
"type": "qosMap"
},
{
"definitionId": "a75ead1f-f6ab-4a80-af29-79b742b31c5c",
"type": "rewriteRule"
},
{
"definitionId": "555dd393-e7b6-4861-866f-f227f5f780b7",
"type": "deviceAccessPolicy"
},
{
"definitionId": "22655824-d0df-4a8b-9be0-9808938a0e6b",
"type": "vedgeRoute"
}
],
"settings": {
"flowVisibility": true,
"flowVisibilityIPv6": true,
"appVisibility": true,
"cloudQos": true,
"cloudQosServiceSide": true,
"implicitAclLogging": true,
"appVisibilityIPv6": true
}
},
"isPolicyActivated": false
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Task Id": {
"description": "Task Id",
"value": {
"definitionId": "00f718df-4f95-4363-8639-1fe855c9eb09"
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/definition/advancedMalwareProtection/bulk": {
"put": {
"tags": [
"Configuration - Policy AMP Definition Builder"
],
"description": "Create/Edit policy definitions in bulk",
"operationId": "savePolicyDefinitionInBulk_ConfigurationPolicyAmpDefinitionBuilder_5803",
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/definition/advancedMalwareProtection/multiple/{id}": {
"put": {
"tags": [
"Configuration - Policy AMP Definition Builder"
],
"description": "Edit multiple policy definitions",
"operationId": "editMultiplePolicyDefinition_ConfigurationPolicyAmpDefinitionBuilder_6703",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/definition/advancedMalwareProtection/preview": {
"post": {
"tags": [
"Configuration - Policy AMP Definition Builder"
],
"description": "Preview policy definition",
"operationId": "previewPolicyDefinition_ConfigurationPolicyAmpDefinitionBuilder_6104",
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/definition/advancedMalwareProtection/preview/{id}": {
"get": {
"tags": [
"Configuration - Policy AMP Definition Builder"
],
"description": "Preview policy definition",
"operationId": "previewPolicyDefinitionById_ConfigurationPolicyAmpDefinitionBuilder_6603",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/definition/advancedMalwareProtection/{id}": {
"get": {
"tags": [
"Configuration - Policy AMP Definition Builder"
],
"description": "Get a specific policy definitions",
"operationId": "getPolicyDefinition_ConfigurationPolicyAmpDefinitionBuilder_5803",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
},
"put": {
"tags": [
"Configuration - Policy AMP Definition Builder"
],
"description": "Edit a policy definitions",
"operationId": "editPolicyDefinition_ConfigurationPolicyAmpDefinitionBuilder_5803",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"ACL policy": {
"description": "ACL policy",
"value": {
"name": "Demo-ACL",
"type": "acl",
"description": "Demo-ACL",
"defaultAction": {
"type": "accept"
},
"sequences": [
{
"sequenceId": 1,
"sequenceName": "Access Control List",
"baseAction": "accept",
"sequenceType": "acl",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "dscp",
"value": "46"
},
{
"field": "protocol",
"value": "6"
}
]
},
"actions": [
{
"type": "class",
"parameter": {
"ref": "89d20034-7149-4492-b392-b5c4f7903235"
}
}
]
}
]
}
},
"ZBFW definition": {
"description": "ZBFW definition",
"value": {
"name": "Demo-ZBFW",
"type": "zoneBasedFW",
"description": "Demo-ZBFW",
"definition": {
"defaultAction": {
"type": "drop"
},
"sequences": [
{
"sequenceId": 1,
"sequenceName": "Demo-Rule-1",
"baseAction": "inspect",
"sequenceType": "zoneBasedFW",
"match": {
"entries": [
{
"field": "sourceDataPrefixList",
"ref": "ecbea5de-b200-4ff7-aa76-f537b5f858e9"
}
]
},
"actions": []
}
],
"entries": [
{
"sourceZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53",
"destinationZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53"
}
]
}
}
},
"IPS definition": {
"description": "IPS definition",
"value": {
"name": "Demo-IPS-Policy",
"type": "intrusionPrevention",
"description": "Testing",
"definition": {
"signatureSet": "security",
"inspectionMode": "detection",
"signatureWhiteList": {
"ref": "ad189f08-af06-4799-97d6-0a7c7409cb8d"
},
"logLevel": "error",
"logging": [],
"targetVpns": [
"10",
"20"
]
}
}
},
"URL filtering definition": {
"description": "URL filtering definition",
"value": {
"name": "Demo-URL-Filtering-Policy",
"type": "urlFiltering",
"description": "",
"definition": {
"webCategoriesAction": "block",
"webCategories": [
"auctions",
"bot-nets",
"news-and-media"
],
"webReputation": "moderate-risk",
"urlWhiteList": {
"ref": "c20e31fb-fcea-4f48-93e3-09d2c6492d8b"
},
"urlBlackList": {
"ref": "557ed432-6cf8-495b-a445-d340d4c6236e"
},
"blockPageAction": "text",
"blockPageContents": "Access to the requested page has been denied. Please contact your Network Administrator",
"enableAlerts": true,
"alerts": [
"blacklist",
"whitelist",
"categories-reputation"
],
"logging": [],
"targetVpns": [
"30"
]
}
}
},
"AMP definition": {
"description": "AMP definition",
"value": {
"name": "Demo-AMP-Policy",
"type": "advancedMalwareProtection",
"description": "",
"definition": {
"matchAllVpn": true,
"fileReputationCloudServer": "nam",
"fileReputationEstServer": "nam",
"fileReputationAlert": "critical",
"fileAnalysisCloudServer": "nam",
"fileAnalysisFileTypes": [
"pdf",
"ms-exe"
],
"fileAnalysisAlert": "critical",
"targetVpns": [
"10",
"20"
],
"fileAnalysisEnabled": true
}
}
},
"DNS definition": {
"description": "DNS definition",
"value": {
"name": "Demo-DNS-Policy",
"type": "DNSSecurity",
"description": "Testing",
"definition": {
"localDomainBypassList": {
"ref": "143f753f-8d51-4be6-805d-bc330f09982f"
},
"matchAllVpn": false,
"targetVpns": [
{
"vpns": [
"10"
],
"umbrellaDefault": false,
"childOrgId": "7999118",
"dnsServerIP": "10.10.10.1",
"localDomainBypassEnabled": true
}
],
"dnsCrypt": true,
"umbrellaData": {
"ref": "e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa"
}
}
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {
"masterTemplatesAffected": []
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"delete": {
"tags": [
"Configuration - Policy AMP Definition Builder"
],
"description": "Delete policy definition",
"operationId": "deletePolicyDefinition_ConfigurationPolicyAmpDefinitionBuilder_5806",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/definition/advancedinspectionprofile": {
"get": {
"tags": [
"Configuration - Advanced Inspection Profile Definition"
],
"description": "Get policy definitions",
"operationId": "getDefinitions_ConfigurationAdvancedInspectionProfileDefinition_5303",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
},
"post": {
"tags": [
"Configuration - Advanced Inspection Profile Definition"
],
"description": "Create policy definition",
"operationId": "createPolicyDefinition_ConfigurationAdvancedInspectionProfileDefinition_5304",
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"ACL policy": {
"description": "ACL policy",
"value": {
"name": "Demo-ACL",
"type": "acl",
"description": "Demo-ACL",
"defaultAction": {
"type": "accept"
},
"sequences": [
{
"sequenceId": 1,
"sequenceName": "Access Control List",
"baseAction": "accept",
"sequenceType": "acl",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "dscp",
"value": "46"
}
]
},
"actions": [
{
"type": "class",
"parameter": {
"ref": "89d20034-7149-4492-b392-b5c4f7903235"
}
}
]
}
]
}
},
"ZBFW definition": {
"description": "ZBFW definition",
"value": {
"name": "Demo-ZBFW",
"type": "zoneBasedFW",
"description": "Demo-ZBFW",
"definition": {
"defaultAction": {
"type": "drop"
},
"sequences": [],
"entries": [
{
"sourceZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53",
"destinationZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53"
}
]
}
}
},
"IPS definition": {
"description": "IPS definition",
"value": {
"name": "Demo-IPS-Policy",
"type": "intrusionPrevention",
"description": "Testing",
"definition": {
"signatureSet": "security",
"inspectionMode": "detection",
"signatureWhiteList": {
"ref": "ad189f08-af06-4799-97d6-0a7c7409cb8d"
},
"logLevel": "error",
"logging": [],
"targetVpns": [
"10"
]
}
}
},
"URL filtering definition": {
"description": "URL filtering definition",
"value": {
"name": "Demo-URL-Filtering-Policy",
"type": "urlFiltering",
"description": "",
"definition": {
"webCategoriesAction": "block",
"webCategories": [
"auctions",
"bot-nets"
],
"webReputation": "moderate-risk",
"urlWhiteList": {
"ref": "c20e31fb-fcea-4f48-93e3-09d2c6492d8b"
},
"urlBlackList": {
"ref": "557ed432-6cf8-495b-a445-d340d4c6236e"
},
"blockPageAction": "text",
"blockPageContents": "Access to the requested page has been denied. Please contact your Network Administrator",
"enableAlerts": true,
"alerts": [
"blacklist",
"whitelist",
"categories-reputation"
],
"logging": [],
"targetVpns": [
"10",
"20"
]
}
}
},
"AMP definition": {
"description": "AMP definition",
"value": {
"name": "Demo-AMP-Policy",
"type": "advancedMalwareProtection",
"description": "",
"definition": {
"matchAllVpn": false,
"fileReputationCloudServer": "nam",
"fileReputationEstServer": "nam",
"fileReputationAlert": "critical",
"fileAnalysisCloudServer": "",
"fileAnalysisFileTypes": [],
"fileAnalysisAlert": "",
"targetVpns": [
"10",
"20"
]
}
}
},
"DNS definition": {
"description": "DNS definition",
"value": {
"name": "Demo-DNS-Policy",
"type": "DNSSecurity",
"description": "Testing",
"definition": {
"localDomainBypassList": {
"ref": "143f753f-8d51-4be6-805d-bc330f09982f"
},
"matchAllVpn": true,
"umbrellaDefault": true,
"childOrgId": "7999118",
"localDomainBypassEnabled": true,
"dnsCrypt": true,
"umbrellaData": {
"ref": "e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa"
}
}
}
},
"HubandSpoke definition": {
"description": "HubandSpoke definition",
"value": {
"name": "Demo-Hub-n-Spoke-Policy",
"type": "hubAndSpoke",
"description": "Demo-Hub-n-Spoke-Policy",
"definition": {
"vpnList": "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf",
"subDefinitions": [
{
"name": "My Hub-and-Spoke",
"equalPreference": false,
"advertiseTloc": true,
"spokes": [
{
"siteList": "5c58c36c-9cd6-468f-8434-ee6d5801c6ba",
"hubs": [
{
"siteList": "24747ccd-4f7f-4dfa-8800-34f565fb65b4",
"preference": "20",
"prefixLists": [
"b5c4d764-20bc-4de3-9bac-52ef70f1186c"
],
"ipv6PrefixLists": []
}
]
}
],
"tlocList": "1e97c258-4323-4754-9dc0-44e9656d43bf"
}
]
}
}
},
"VPN membership group definition": {
"description": "VPN membership group definition",
"value": {
"name": "Demo-VPN-Membership-Policy",
"type": "vpnMembershipGroup",
"description": "Demo-VPN-Membership-Policy",
"definition": {
"sites": [
{
"siteList": "24747ccd-4f7f-4dfa-8800-34f565fb65b4",
"vpnList": [
"cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"
]
},
{
"siteList": "5c58c36c-9cd6-468f-8434-ee6d5801c6ba",
"vpnList": [
"cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"
]
}
]
}
}
},
"AppRoute definition": {
"description": "AppRoute definition",
"value": {
"name": "Demo-AAR-Policy",
"type": "appRoute",
"description": "Demo-AAR-Policy",
"sequences": [
{
"sequenceId": 1,
"sequenceName": "App Route",
"sequenceType": "appRoute",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "appList",
"ref": "b6752dba-969b-46de-a7e7-da11910fb1bf"
},
{
"field": "dnsAppList",
"ref": "b6752dba-969b-46de-a7e7-da11910fb1bf"
},
{
"field": "dns",
"value": "request"
},
{
"field": "dscp",
"value": "46"
},
{
"field": "plp",
"value": "high"
},
{
"field": "protocol",
"value": "6"
},
{
"field": "sourceDataPrefixList",
"ref": "6c2b7164-5de2-4775-938c-b443504324ab"
},
{
"field": "sourcePort",
"value": "1025"
},
{
"field": "destinationDataPrefixList",
"ref": "6c2b7164-5de2-4775-938c-b443504324ab"
},
{
"field": "destinationPort",
"value": "65000"
}
]
},
"actions": [
{
"type": "backupSlaPreferredColor",
"parameter": "biz-internet"
},
{
"type": "count",
"parameter": "Demo-Counter"
},
{
"type": "log",
"parameter": ""
},
{
"type": "slaClass",
"parameter": [
{
"field": "name",
"ref": "46cea5a1-1570-4921-b87a-837d590eb37e"
},
{
"field": "preferredColor",
"value": "public-internet"
},
{
"field": "strict"
}
]
}
]
},
{
"sequenceId": 11,
"sequenceName": "App Route",
"sequenceType": "appRoute",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "saasAppList",
"ref": "1e6688ce-2d21-4d7a-9a93-ae6a8ebd4a06"
}
]
},
"actions": [
{
"type": "cloudSaas",
"parameter": ""
}
]
},
{
"sequenceId": 21,
"sequenceName": "App Route",
"sequenceType": "appRoute",
"sequenceIpType": "ipv6",
"match": {
"entries": [
{
"field": "dscp",
"value": "46"
},
{
"field": "protocol",
"value": "6"
},
{
"field": "sourceIpv6",
"value": "2001::/8"
},
{
"field": "sourcePort",
"value": "65000"
},
{
"field": "destinationIpv6",
"value": "2001::/8"
},
{
"field": "destinationPort",
"value": "65000"
}
]
},
"actions": [
{
"type": "backupSlaPreferredColor",
"parameter": "biz-internet"
},
{
"type": "count",
"parameter": "Demo-Counter"
},
{
"type": "log",
"parameter": ""
},
{
"type": "slaClass",
"parameter": [
{
"field": "name",
"ref": "46cea5a1-1570-4921-b87a-837d590eb37e"
},
{
"field": "preferredColor",
"value": "public-internet"
},
{
"field": "strict"
}
]
}
]
}
]
}
},
"Data policy definition": {
"description": "Data policy definition",
"value": {
"name": "Demo-Data-Policy",
"type": "data",
"description": "Demo-Data-Policy",
"defaultAction": {
"type": "drop"
},
"sequences": [
{
"sequenceId": 1,
"sequenceName": "Custom",
"baseAction": "accept",
"sequenceType": "data",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "appList",
"ref": "b6752dba-969b-46de-a7e7-da11910fb1bf"
},
{
"field": "dnsAppList",
"ref": "b6752dba-969b-46de-a7e7-da11910fb1bf"
},
{
"field": "dns",
"value": "response"
},
{
"field": "dscp",
"value": "46"
},
{
"field": "packetLength",
"value": "1504"
},
{
"field": "plp",
"value": "high"
},
{
"field": "protocol",
"value": "6"
},
{
"field": "sourceDataPrefixList",
"ref": "6c2b7164-5de2-4775-938c-b443504324ab"
},
{
"field": "sourcePort",
"value": "65000"
},
{
"field": "destinationIp",
"value": "10.0.0.0/12"
},
{
"field": "destinationPort",
"value": "65000"
},
{
"field": "tcp",
"value": "syn"
}
]
},
"actions": [
{
"type": "count",
"parameter": "Demo-Counter"
},
{
"type": "set",
"parameter": [
{
"field": "dscp",
"value": "34"
},
{
"field": "forwardingClass",
"value": "ef-class"
},
{
"field": "localTlocList",
"value": {
"color": "public-internet",
"restrict": "",
"encap": "ipsec"
}
},
{
"field": "nextHop",
"value": "10.0.0.1"
},
{
"field": "policer",
"ref": "ecf250c7-bef0-405b-8e74-4d67440cac90"
}
]
},
{
"type": "cflowd"
},
{
"type": "log",
"parameter": ""
},
{
"type": "nat",
"parameter": {
"field": "pool",
"value": "1"
}
},
{
"type": "redirectDns",
"parameter": {
"field": "dnsType",
"value": "umbrella"
}
}
]
},
{
"sequenceId": 11,
"sequenceName": "Custom",
"baseAction": "accept",
"sequenceType": "data",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "appList",
"ref": "b6752dba-969b-46de-a7e7-da11910fb1bf"
}
]
},
"actions": [
{
"type": "set",
"parameter": [
{
"field": "service",
"value": {
"type": "FW",
"vpn": "10",
"tloc": {
"ip": "10.0.0.1",
"color": "biz-internet",
"encap": "ipsec"
}
}
}
]
},
{
"type": "tcpOptimization",
"parameter": ""
},
{
"type": "lossProtect",
"parameter": "fecAdaptive"
},
{
"type": "lossProtectFec",
"parameter": "fecAdaptive"
},
{
"type": "sig",
"parameter": ""
}
]
}
]
}
},
"CFlowd definition": {
"description": "CFlowd definition",
"value": {
"name": "Demo-cflowd-Policy",
"type": "cflowd",
"description": "Demo-cflowd-Policy",
"definition": {
"flowActiveTimeout": 3600,
"flowInactiveTimeout": 3600,
"flowSamplingInterval": 65513,
"templateRefresh": 86400,
"collectors": [
{
"vpn": "10",
"address": "10.0.0.1",
"port": 9912,
"transport": "transport_tcp",
"sourceInterface": "ge0/1"
},
{
"vpn": "20",
"address": "10.0.0.1",
"port": 1025,
"transport": "transport_udp",
"sourceInterface": "GigabitEthernet0/0/1"
}
],
"protocol": "ipv4"
}
}
},
"QoS map definition": {
"description": "QoS map definition",
"value": {
"name": "Demo-QoS-Policy",
"type": "qosMap",
"description": "Demo-QoS-Policy",
"definition": {
"qosSchedulers": [
{
"queue": "0",
"bandwidthPercent": "75",
"bufferPercent": "75",
"burst": "15000",
"scheduling": "llq",
"drops": "tail-drop",
"classMapRef": ""
},
{
"queue": "7",
"bandwidthPercent": "25",
"bufferPercent": "25",
"scheduling": "wrr",
"drops": "red-drop",
"classMapRef": "4484c444-b956-4016-bd15-538b74fc2785"
}
]
}
}
},
"VPN-QoS map definition": {
"description": "VPN-QoS map definition",
"value": {
"name": "Demo-VPN-QoS-Policy",
"type": "vpnQosMap",
"description": "Demo-VPN-QoS-Policy",
"definition": {
"vpnQosSchedulers": [
{
"vpnListRef": "",
"bandwidthRate": "100000",
"shapingRate": "120000",
"childMapRef": ""
},
{
"childMapRef": ""
}
]
}
}
},
"Rewrite rule definition": {
"description": "Rewrite rule definition",
"value": {
"name": "Demo-Rewrite-Rule",
"type": "rewriteRule",
"description": "Demo-Rewrite-Rule",
"definition": {
"rules": [
{
"class": "4484c444-b956-4016-bd15-538b74fc2785",
"plp": "low",
"dscp": "46",
"layer2Cos": "2"
}
]
}
}
},
"Device access policy definition": {
"description": "Device access policy definition",
"value": {
"name": "Demo-DeviceAccess-Policy",
"type": "deviceaccesspolicy",
"description": "Demo-DeviceAccess-Policy",
"defaultAction": {
"type": "drop"
},
"sequences": [
{
"sequenceId": 1,
"sequenceName": "Device Access Control List",
"baseAction": "accept",
"sequenceType": "deviceaccesspolicy",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "destinationPort",
"value": "22"
},
{
"field": "sourceIp",
"value": "10.10.24.0/24"
},
{
"field": "sourcePort",
"value": "65000"
},
{
"field": "destinationIp",
"value": "10.10.10.1/32"
},
{
"field": "vpn",
"value": "10"
}
]
},
"actions": []
},
{
"sequenceId": 11,
"sequenceName": "Device Access Control List",
"baseAction": "drop",
"sequenceType": "deviceaccesspolicy",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "destinationPort",
"value": "161"
},
{
"field": "sourceDataPrefixList",
"ref": "6c2b7164-5de2-4775-938c-b443504324ab"
}
]
},
"actions": []
}
]
}
},
"vEdge route definition": {
"description": "vEdge route definition",
"value": {
"name": "Demo-Route-Policy",
"type": "vedgeRoute",
"description": "Demo-Route-Policy",
"defaultAction": {
"type": "reject"
},
"sequences": [
{
"sequenceId": 1,
"sequenceName": "Route",
"baseAction": "accept",
"sequenceType": "vedgeRoute",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "address",
"ref": "b5c4d764-20bc-4de3-9bac-52ef70f1186c"
},
{
"field": "asPath",
"ref": "79f8c180-1a23-4f09-800d-62652b571258"
},
{
"field": "community",
"matchFlag": "or",
"ref": "33de059b-27ec-4a83-be28-8985128381eb"
},
{
"field": "localPreference",
"value": "200"
},
{
"field": "metric",
"value": "100"
},
{
"field": "nextHop",
"ref": "b5c4d764-20bc-4de3-9bac-52ef70f1186c"
},
{
"field": "ompTag",
"value": "10"
},
{
"field": "affinity",
"value": "10"
},
{
"field": "origin",
"value": "igp"
},
{
"field": "ospfTag",
"value": "10"
},
{
"field": "peer",
"value": "10.0.0.1"
}
]
},
"actions": [
{
"type": "set",
"parameter": [
{
"field": "asPath",
"value": {
"exclude": "120 130",
"prepend": "65521 65521"
}
},
{
"field": "localPreference",
"value": "200"
},
{
"field": "metricType",
"value": "type1"
},
{
"field": "metric",
"value": "100"
},
{
"field": "nextHop",
"value": "10.0.0.1"
},
{
"field": "ompTag",
"value": "100"
},
{
"field": "weight",
"value": "200"
},
{
"field": "ospfTag",
"value": "122"
},
{
"field": "originator",
"value": "10.0.0.1"
},
{
"field": "origin",
"value": "igp"
},
{
"field": "community",
"value": "1000:10000"
}
]
}
]
}
]
}
},
"vSmart definition": {
"description": "vSmart definition",
"value": {
"policyDescription": "Demo-Centralized-Policy",
"policyType": "feature",
"policyName": "Demo-Centralized-Policy",
"policyDefinition": {
"assembly": [
{
"definitionId": "eb0daba9-7fc4-4f4f-bae7-cd958f81f863",
"type": "cflowd",
"entries": [
{
"siteLists": [
"5c58c36c-9cd6-468f-8434-ee6d5801c6ba",
"24747ccd-4f7f-4dfa-8800-34f565fb65b4"
]
}
]
},
{
"definitionId": "3e33fa50-a30d-4586-9d69-106121feaaf4",
"type": "data",
"entries": [
{
"direction": "service",
"siteLists": [
"5c58c36c-9cd6-468f-8434-ee6d5801c6ba",
"24747ccd-4f7f-4dfa-8800-34f565fb65b4"
],
"vpnLists": [
"cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"
]
}
]
},
{
"definitionId": "8b2e7c44-2666-48a7-87a0-36a43c2d003e",
"type": "appRoute",
"entries": [
{
"siteLists": [
"5c58c36c-9cd6-468f-8434-ee6d5801c6ba",
"24747ccd-4f7f-4dfa-8800-34f565fb65b4"
],
"vpnLists": [
"cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"
]
}
]
},
{
"definitionId": "1b76052e-1cb5-44b1-8e5e-4096cb261736",
"type": "vpnMembershipGroup"
},
{
"definitionId": "62960276-c797-41fd-bebb-c017fc752f4e",
"type": "hubAndSpoke"
}
]
},
"isPolicyActivated": false
}
},
"vEdge definition": {
"description": "vEdge definition",
"value": {
"policyDescription": "Demo-Local-Policy",
"policyType": "feature",
"policyName": "Demo-Local-Policy",
"policyDefinition": {
"assembly": [
{
"definitionId": "56283dcf-6dda-4831-bcd1-d9cf62d33fdc",
"type": "qosMap"
},
{
"definitionId": "a75ead1f-f6ab-4a80-af29-79b742b31c5c",
"type": "rewriteRule"
},
{
"definitionId": "555dd393-e7b6-4861-866f-f227f5f780b7",
"type": "deviceAccessPolicy"
},
{
"definitionId": "22655824-d0df-4a8b-9be0-9808938a0e6b",
"type": "vedgeRoute"
}
],
"settings": {
"flowVisibility": true,
"flowVisibilityIPv6": true,
"appVisibility": true,
"cloudQos": true,
"cloudQosServiceSide": true,
"implicitAclLogging": true,
"appVisibilityIPv6": true
}
},
"isPolicyActivated": false
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Task Id": {
"description": "Task Id",
"value": {
"definitionId": "00f718df-4f95-4363-8639-1fe855c9eb09"
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/definition/advancedinspectionprofile/bulk": {
"put": {
"tags": [
"Configuration - Advanced Inspection Profile Definition"
],
"description": "Create/Edit policy definitions in bulk",
"operationId": "savePolicyDefinitionInBulk_ConfigurationAdvancedInspectionProfileDefinition_5803",
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/definition/advancedinspectionprofile/multiple/{id}": {
"put": {
"tags": [
"Configuration - Advanced Inspection Profile Definition"
],
"description": "Edit multiple policy definitions",
"operationId": "editMultiplePolicyDefinition_ConfigurationAdvancedInspectionProfileDefinition_6703",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/definition/advancedinspectionprofile/preview": {
"post": {
"tags": [
"Configuration - Advanced Inspection Profile Definition"
],
"description": "Preview policy definition",
"operationId": "previewPolicyDefinition_ConfigurationAdvancedInspectionProfileDefinition_6104",
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/definition/advancedinspectionprofile/preview/{id}": {
"get": {
"tags": [
"Configuration - Advanced Inspection Profile Definition"
],
"description": "Preview policy definition",
"operationId": "previewPolicyDefinitionById_ConfigurationAdvancedInspectionProfileDefinition_6603",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/definition/advancedinspectionprofile/{id}": {
"put": {
"tags": [
"Configuration - Advanced Inspection Profile Definition"
],
"description": "Edit a policy definitions",
"operationId": "editPolicyDefinition_ConfigurationAdvancedInspectionProfileDefinition_5803",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"ACL policy": {
"description": "ACL policy",
"value": {
"name": "Demo-ACL",
"type": "acl",
"description": "Demo-ACL",
"defaultAction": {
"type": "accept"
},
"sequences": [
{
"sequenceId": 1,
"sequenceName": "Access Control List",
"baseAction": "accept",
"sequenceType": "acl",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "dscp",
"value": "46"
},
{
"field": "protocol",
"value": "6"
}
]
},
"actions": [
{
"type": "class",
"parameter": {
"ref": "89d20034-7149-4492-b392-b5c4f7903235"
}
}
]
}
]
}
},
"ZBFW definition": {
"description": "ZBFW definition",
"value": {
"name": "Demo-ZBFW",
"type": "zoneBasedFW",
"description": "Demo-ZBFW",
"definition": {
"defaultAction": {
"type": "drop"
},
"sequences": [
{
"sequenceId": 1,
"sequenceName": "Demo-Rule-1",
"baseAction": "inspect",
"sequenceType": "zoneBasedFW",
"match": {
"entries": [
{
"field": "sourceDataPrefixList",
"ref": "ecbea5de-b200-4ff7-aa76-f537b5f858e9"
}
]
},
"actions": []
}
],
"entries": [
{
"sourceZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53",
"destinationZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53"
}
]
}
}
},
"IPS definition": {
"description": "IPS definition",
"value": {
"name": "Demo-IPS-Policy",
"type": "intrusionPrevention",
"description": "Testing",
"definition": {
"signatureSet": "security",
"inspectionMode": "detection",
"signatureWhiteList": {
"ref": "ad189f08-af06-4799-97d6-0a7c7409cb8d"
},
"logLevel": "error",
"logging": [],
"targetVpns": [
"10",
"20"
]
}
}
},
"URL filtering definition": {
"description": "URL filtering definition",
"value": {
"name": "Demo-URL-Filtering-Policy",
"type": "urlFiltering",
"description": "",
"definition": {
"webCategoriesAction": "block",
"webCategories": [
"auctions",
"bot-nets",
"news-and-media"
],
"webReputation": "moderate-risk",
"urlWhiteList": {
"ref": "c20e31fb-fcea-4f48-93e3-09d2c6492d8b"
},
"urlBlackList": {
"ref": "557ed432-6cf8-495b-a445-d340d4c6236e"
},
"blockPageAction": "text",
"blockPageContents": "Access to the requested page has been denied. Please contact your Network Administrator",
"enableAlerts": true,
"alerts": [
"blacklist",
"whitelist",
"categories-reputation"
],
"logging": [],
"targetVpns": [
"30"
]
}
}
},
"AMP definition": {
"description": "AMP definition",
"value": {
"name": "Demo-AMP-Policy",
"type": "advancedMalwareProtection",
"description": "",
"definition": {
"matchAllVpn": true,
"fileReputationCloudServer": "nam",
"fileReputationEstServer": "nam",
"fileReputationAlert": "critical",
"fileAnalysisCloudServer": "nam",
"fileAnalysisFileTypes": [
"pdf",
"ms-exe"
],
"fileAnalysisAlert": "critical",
"targetVpns": [
"10",
"20"
],
"fileAnalysisEnabled": true
}
}
},
"DNS definition": {
"description": "DNS definition",
"value": {
"name": "Demo-DNS-Policy",
"type": "DNSSecurity",
"description": "Testing",
"definition": {
"localDomainBypassList": {
"ref": "143f753f-8d51-4be6-805d-bc330f09982f"
},
"matchAllVpn": false,
"targetVpns": [
{
"vpns": [
"10"
],
"umbrellaDefault": false,
"childOrgId": "7999118",
"dnsServerIP": "10.10.10.1",
"localDomainBypassEnabled": true
}
],
"dnsCrypt": true,
"umbrellaData": {
"ref": "e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa"
}
}
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {
"masterTemplatesAffected": []
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"get": {
"tags": [
"Configuration - Advanced Inspection Profile Definition"
],
"description": "Get a specific policy definitions",
"operationId": "getPolicyDefinition_ConfigurationAdvancedInspectionProfileDefinition_5803",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
},
"delete": {
"tags": [
"Configuration - Advanced Inspection Profile Definition"
],
"description": "Delete policy definition",
"operationId": "deletePolicyDefinition_ConfigurationAdvancedInspectionProfileDefinition_5806",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/definition/approute": {
"get": {
"tags": [
"Configuration - Policy AppRoute Definition Builder"
],
"description": "Get policy definitions",
"operationId": "getDefinitions_ConfigurationPolicyApprouteDefinitionBuilder_3603",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,AppRoute Policy-read,AppRoute Policy-write"
},
"post": {
"tags": [
"Configuration - Policy AppRoute Definition Builder"
],
"description": "Create policy definition",
"operationId": "createPolicyDefinition_ConfigurationPolicyApprouteDefinitionBuilder_3604",
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-writeAppRoute Policy-write"
}
},
"/template/policy/definition/approute/bulk": {
"put": {
"tags": [
"Configuration - Policy AppRoute Definition Builder"
],
"description": "Create/Edit policy definitions in bulk",
"operationId": "savePolicyDefinitionInBulk_ConfigurationPolicyApprouteDefinitionBuilder_4103",
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/definition/approute/multiple/{id}": {
"put": {
"tags": [
"Configuration - Policy AppRoute Definition Builder"
],
"description": "Edit multiple policy definitions",
"operationId": "editMultiplePolicyDefinition_ConfigurationPolicyApprouteDefinitionBuilder_5003",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/definition/approute/preview": {
"post": {
"tags": [
"Configuration - Policy AppRoute Definition Builder"
],
"description": "Preview policy definition",
"operationId": "previewPolicyDefinition_ConfigurationPolicyApprouteDefinitionBuilder_4404",
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/definition/approute/preview/{id}": {
"get": {
"tags": [
"Configuration - Policy AppRoute Definition Builder"
],
"description": "Preview policy definition",
"operationId": "previewPolicyDefinitionById_ConfigurationPolicyApprouteDefinitionBuilder_4903",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/definition/approute/{id}": {
"get": {
"tags": [
"Configuration - Policy AppRoute Definition Builder"
],
"description": "Get a specific policy definitions",
"operationId": "getPolicyDefinition_ConfigurationPolicyApprouteDefinitionBuilder_4103",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,AppRoute Policy-read,AppRoute Policy-write"
},
"put": {
"tags": [
"Configuration - Policy AppRoute Definition Builder"
],
"description": "Edit a policy definitions",
"operationId": "editPolicyDefinition_ConfigurationPolicyApprouteDefinitionBuilder_4103",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-writeAppRoute Policy-write"
},
"delete": {
"tags": [
"Configuration - Policy AppRoute Definition Builder"
],
"description": "Delete policy definition",
"operationId": "deletePolicyDefinition_ConfigurationPolicyApprouteDefinitionBuilder_4106",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-writeAppRoute Policy-write"
}
},
"/template/policy/definition/cflowd": {
"get": {
"tags": [
"Configuration - Policy Cflowd Definition Builder"
],
"description": "Get policy definitions",
"operationId": "getDefinitions_ConfigurationPolicyCflowdDefinitionBuilder_3403",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,CFlowD Policy-read,CFlowD Policy-write"
},
"post": {
"tags": [
"Configuration - Policy Cflowd Definition Builder"
],
"description": "Create policy definition",
"operationId": "createPolicyDefinition_ConfigurationPolicyCflowdDefinitionBuilder_3404",
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write,CFlowD Policy-write"
}
},
"/template/policy/definition/cflowd/bulk": {
"put": {
"tags": [
"Configuration - Policy Cflowd Definition Builder"
],
"description": "Create/Edit policy definitions in bulk",
"operationId": "savePolicyDefinitionInBulk_ConfigurationPolicyCflowdDefinitionBuilder_3903",
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/definition/cflowd/multiple/{id}": {
"put": {
"tags": [
"Configuration - Policy Cflowd Definition Builder"
],
"description": "Edit multiple policy definitions",
"operationId": "editMultiplePolicyDefinition_ConfigurationPolicyCflowdDefinitionBuilder_4803",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/definition/cflowd/preview": {
"post": {
"tags": [
"Configuration - Policy Cflowd Definition Builder"
],
"description": "Preview policy definition",
"operationId": "previewPolicyDefinition_ConfigurationPolicyCflowdDefinitionBuilder_4204",
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/definition/cflowd/preview/{id}": {
"get": {
"tags": [
"Configuration - Policy Cflowd Definition Builder"
],
"description": "Preview policy definition",
"operationId": "previewPolicyDefinitionById_ConfigurationPolicyCflowdDefinitionBuilder_4703",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/definition/cflowd/{id}": {
"delete": {
"tags": [
"Configuration - Policy Cflowd Definition Builder"
],
"description": "Delete policy definition",
"operationId": "deletePolicyDefinition_ConfigurationPolicyCflowdDefinitionBuilder_3906",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write,CFlowD Policy-write"
},
"put": {
"tags": [
"Configuration - Policy Cflowd Definition Builder"
],
"description": "Edit a policy definitions",
"operationId": "editPolicyDefinition_ConfigurationPolicyCflowdDefinitionBuilder_3903",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write,CFlowD Policy-write"
},
"get": {
"tags": [
"Configuration - Policy Cflowd Definition Builder"
],
"description": "Get a specific policy definitions",
"operationId": "getPolicyDefinition_ConfigurationPolicyCflowdDefinitionBuilder_3903",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,CFlowD Policy-read,CFlowD Policy-write"
}
},
"/template/policy/definition/control": {
"get": {
"tags": [
"Configuration - Policy Control Definition Builder"
],
"description": "Get policy definitions",
"operationId": "getDefinitions_ConfigurationPolicyControlDefinitionBuilder_3503",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Topology Policy-read,Topology Policy-write"
},
"post": {
"tags": [
"Configuration - Policy Control Definition Builder"
],
"description": "Create policy definition",
"operationId": "createPolicyDefinition_ConfigurationPolicyControlDefinitionBuilder_3504",
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Topology Policy-write,Policy Configuration-write"
}
},
"/template/policy/definition/control/bulk": {
"put": {
"tags": [
"Configuration - Policy Control Definition Builder"
],
"description": "Create/Edit policy definitions in bulk",
"operationId": "savePolicyDefinitionInBulk_ConfigurationPolicyControlDefinitionBuilder_4003",
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/definition/control/multiple/{id}": {
"put": {
"tags": [
"Configuration - Policy Control Definition Builder"
],
"description": "Edit multiple policy definitions",
"operationId": "editMultiplePolicyDefinition_ConfigurationPolicyControlDefinitionBuilder_4903",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/definition/control/preview": {
"post": {
"tags": [
"Configuration - Policy Control Definition Builder"
],
"description": "Preview policy definition",
"operationId": "previewPolicyDefinition_ConfigurationPolicyControlDefinitionBuilder_4304",
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/definition/control/preview/{id}": {
"get": {
"tags": [
"Configuration - Policy Control Definition Builder"
],
"description": "Preview policy definition",
"operationId": "previewPolicyDefinitionById_ConfigurationPolicyControlDefinitionBuilder_4803",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/definition/control/{id}": {
"delete": {
"tags": [
"Configuration - Policy Control Definition Builder"
],
"description": "Delete policy definition",
"operationId": "deletePolicyDefinition_ConfigurationPolicyControlDefinitionBuilder_4006",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Topology Policy-write,Policy Configuration-write"
},
"put": {
"tags": [
"Configuration - Policy Control Definition Builder"
],
"description": "Edit a policy definitions",
"operationId": "editPolicyDefinition_ConfigurationPolicyControlDefinitionBuilder_4003",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Topology Policy-write,Policy Configuration-write"
},
"get": {
"tags": [
"Configuration - Policy Control Definition Builder"
],
"description": "Get a specific policy definitions",
"operationId": "getPolicyDefinition_ConfigurationPolicyControlDefinitionBuilder_4003",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Topology Policy-read,Topology Policy-write"
}
},
"/template/policy/definition/data": {
"get": {
"tags": [
"Configuration - Policy Data Definition Builder"
],
"description": "Get policy definitions",
"operationId": "getDefinitions_ConfigurationPolicyDataDefinitionBuilder_3203",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
},
"post": {
"tags": [
"Configuration - Policy Data Definition Builder"
],
"description": "Create policy definition",
"operationId": "createPolicyDefinition_ConfigurationPolicyDataDefinitionBuilder_3204",
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"ACL policy": {
"description": "ACL policy",
"value": {
"name": "Demo-ACL",
"type": "acl",
"description": "Demo-ACL",
"defaultAction": {
"type": "accept"
},
"sequences": [
{
"sequenceId": 1,
"sequenceName": "Access Control List",
"baseAction": "accept",
"sequenceType": "acl",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "dscp",
"value": "46"
}
]
},
"actions": [
{
"type": "class",
"parameter": {
"ref": "89d20034-7149-4492-b392-b5c4f7903235"
}
}
]
}
]
}
},
"ZBFW definition": {
"description": "ZBFW definition",
"value": {
"name": "Demo-ZBFW",
"type": "zoneBasedFW",
"description": "Demo-ZBFW",
"definition": {
"defaultAction": {
"type": "drop"
},
"sequences": [],
"entries": [
{
"sourceZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53",
"destinationZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53"
}
]
}
}
},
"IPS definition": {
"description": "IPS definition",
"value": {
"name": "Demo-IPS-Policy",
"type": "intrusionPrevention",
"description": "Testing",
"definition": {
"signatureSet": "security",
"inspectionMode": "detection",
"signatureWhiteList": {
"ref": "ad189f08-af06-4799-97d6-0a7c7409cb8d"
},
"logLevel": "error",
"logging": [],
"targetVpns": [
"10"
]
}
}
},
"URL filtering definition": {
"description": "URL filtering definition",
"value": {
"name": "Demo-URL-Filtering-Policy",
"type": "urlFiltering",
"description": "",
"definition": {
"webCategoriesAction": "block",
"webCategories": [
"auctions",
"bot-nets"
],
"webReputation": "moderate-risk",
"urlWhiteList": {
"ref": "c20e31fb-fcea-4f48-93e3-09d2c6492d8b"
},
"urlBlackList": {
"ref": "557ed432-6cf8-495b-a445-d340d4c6236e"
},
"blockPageAction": "text",
"blockPageContents": "Access to the requested page has been denied. Please contact your Network Administrator",
"enableAlerts": true,
"alerts": [
"blacklist",
"whitelist",
"categories-reputation"
],
"logging": [],
"targetVpns": [
"10",
"20"
]
}
}
},
"AMP definition": {
"description": "AMP definition",
"value": {
"name": "Demo-AMP-Policy",
"type": "advancedMalwareProtection",
"description": "",
"definition": {
"matchAllVpn": false,
"fileReputationCloudServer": "nam",
"fileReputationEstServer": "nam",
"fileReputationAlert": "critical",
"fileAnalysisCloudServer": "",
"fileAnalysisFileTypes": [],
"fileAnalysisAlert": "",
"targetVpns": [
"10",
"20"
]
}
}
},
"DNS definition": {
"description": "DNS definition",
"value": {
"name": "Demo-DNS-Policy",
"type": "DNSSecurity",
"description": "Testing",
"definition": {
"localDomainBypassList": {
"ref": "143f753f-8d51-4be6-805d-bc330f09982f"
},
"matchAllVpn": true,
"umbrellaDefault": true,
"childOrgId": "7999118",
"localDomainBypassEnabled": true,
"dnsCrypt": true,
"umbrellaData": {
"ref": "e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa"
}
}
}
},
"HubandSpoke definition": {
"description": "HubandSpoke definition",
"value": {
"name": "Demo-Hub-n-Spoke-Policy",
"type": "hubAndSpoke",
"description": "Demo-Hub-n-Spoke-Policy",
"definition": {
"vpnList": "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf",
"subDefinitions": [
{
"name": "My Hub-and-Spoke",
"equalPreference": false,
"advertiseTloc": true,
"spokes": [
{
"siteList": "5c58c36c-9cd6-468f-8434-ee6d5801c6ba",
"hubs": [
{
"siteList": "24747ccd-4f7f-4dfa-8800-34f565fb65b4",
"preference": "20",
"prefixLists": [
"b5c4d764-20bc-4de3-9bac-52ef70f1186c"
],
"ipv6PrefixLists": []
}
]
}
],
"tlocList": "1e97c258-4323-4754-9dc0-44e9656d43bf"
}
]
}
}
},
"VPN membership group definition": {
"description": "VPN membership group definition",
"value": {
"name": "Demo-VPN-Membership-Policy",
"type": "vpnMembershipGroup",
"description": "Demo-VPN-Membership-Policy",
"definition": {
"sites": [
{
"siteList": "24747ccd-4f7f-4dfa-8800-34f565fb65b4",
"vpnList": [
"cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"
]
},
{
"siteList": "5c58c36c-9cd6-468f-8434-ee6d5801c6ba",
"vpnList": [
"cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"
]
}
]
}
}
},
"AppRoute definition": {
"description": "AppRoute definition",
"value": {
"name": "Demo-AAR-Policy",
"type": "appRoute",
"description": "Demo-AAR-Policy",
"sequences": [
{
"sequenceId": 1,
"sequenceName": "App Route",
"sequenceType": "appRoute",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "appList",
"ref": "b6752dba-969b-46de-a7e7-da11910fb1bf"
},
{
"field": "dnsAppList",
"ref": "b6752dba-969b-46de-a7e7-da11910fb1bf"
},
{
"field": "dns",
"value": "request"
},
{
"field": "dscp",
"value": "46"
},
{
"field": "plp",
"value": "high"
},
{
"field": "protocol",
"value": "6"
},
{
"field": "sourceDataPrefixList",
"ref": "6c2b7164-5de2-4775-938c-b443504324ab"
},
{
"field": "sourcePort",
"value": "1025"
},
{
"field": "destinationDataPrefixList",
"ref": "6c2b7164-5de2-4775-938c-b443504324ab"
},
{
"field": "destinationPort",
"value": "65000"
}
]
},
"actions": [
{
"type": "backupSlaPreferredColor",
"parameter": "biz-internet"
},
{
"type": "count",
"parameter": "Demo-Counter"
},
{
"type": "log",
"parameter": ""
},
{
"type": "slaClass",
"parameter": [
{
"field": "name",
"ref": "46cea5a1-1570-4921-b87a-837d590eb37e"
},
{
"field": "preferredColor",
"value": "public-internet"
},
{
"field": "strict"
}
]
}
]
},
{
"sequenceId": 11,
"sequenceName": "App Route",
"sequenceType": "appRoute",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "saasAppList",
"ref": "1e6688ce-2d21-4d7a-9a93-ae6a8ebd4a06"
}
]
},
"actions": [
{
"type": "cloudSaas",
"parameter": ""
}
]
},
{
"sequenceId": 21,
"sequenceName": "App Route",
"sequenceType": "appRoute",
"sequenceIpType": "ipv6",
"match": {
"entries": [
{
"field": "dscp",
"value": "46"
},
{
"field": "protocol",
"value": "6"
},
{
"field": "sourceIpv6",
"value": "2001::/8"
},
{
"field": "sourcePort",
"value": "65000"
},
{
"field": "destinationIpv6",
"value": "2001::/8"
},
{
"field": "destinationPort",
"value": "65000"
}
]
},
"actions": [
{
"type": "backupSlaPreferredColor",
"parameter": "biz-internet"
},
{
"type": "count",
"parameter": "Demo-Counter"
},
{
"type": "log",
"parameter": ""
},
{
"type": "slaClass",
"parameter": [
{
"field": "name",
"ref": "46cea5a1-1570-4921-b87a-837d590eb37e"
},
{
"field": "preferredColor",
"value": "public-internet"
},
{
"field": "strict"
}
]
}
]
}
]
}
},
"Data policy definition": {
"description": "Data policy definition",
"value": {
"name": "Demo-Data-Policy",
"type": "data",
"description": "Demo-Data-Policy",
"defaultAction": {
"type": "drop"
},
"sequences": [
{
"sequenceId": 1,
"sequenceName": "Custom",
"baseAction": "accept",
"sequenceType": "data",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "appList",
"ref": "b6752dba-969b-46de-a7e7-da11910fb1bf"
},
{
"field": "dnsAppList",
"ref": "b6752dba-969b-46de-a7e7-da11910fb1bf"
},
{
"field": "dns",
"value": "response"
},
{
"field": "dscp",
"value": "46"
},
{
"field": "packetLength",
"value": "1504"
},
{
"field": "plp",
"value": "high"
},
{
"field": "protocol",
"value": "6"
},
{
"field": "sourceDataPrefixList",
"ref": "6c2b7164-5de2-4775-938c-b443504324ab"
},
{
"field": "sourcePort",
"value": "65000"
},
{
"field": "destinationIp",
"value": "10.0.0.0/12"
},
{
"field": "destinationPort",
"value": "65000"
},
{
"field": "tcp",
"value": "syn"
}
]
},
"actions": [
{
"type": "count",
"parameter": "Demo-Counter"
},
{
"type": "set",
"parameter": [
{
"field": "dscp",
"value": "34"
},
{
"field": "forwardingClass",
"value": "ef-class"
},
{
"field": "localTlocList",
"value": {
"color": "public-internet",
"restrict": "",
"encap": "ipsec"
}
},
{
"field": "nextHop",
"value": "10.0.0.1"
},
{
"field": "policer",
"ref": "ecf250c7-bef0-405b-8e74-4d67440cac90"
}
]
},
{
"type": "cflowd"
},
{
"type": "log",
"parameter": ""
},
{
"type": "nat",
"parameter": {
"field": "pool",
"value": "1"
}
},
{
"type": "redirectDns",
"parameter": {
"field": "dnsType",
"value": "umbrella"
}
}
]
},
{
"sequenceId": 11,
"sequenceName": "Custom",
"baseAction": "accept",
"sequenceType": "data",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "appList",
"ref": "b6752dba-969b-46de-a7e7-da11910fb1bf"
}
]
},
"actions": [
{
"type": "set",
"parameter": [
{
"field": "service",
"value": {
"type": "FW",
"vpn": "10",
"tloc": {
"ip": "10.0.0.1",
"color": "biz-internet",
"encap": "ipsec"
}
}
}
]
},
{
"type": "tcpOptimization",
"parameter": ""
},
{
"type": "lossProtect",
"parameter": "fecAdaptive"
},
{
"type": "lossProtectFec",
"parameter": "fecAdaptive"
},
{
"type": "sig",
"parameter": ""
}
]
}
]
}
},
"CFlowd definition": {
"description": "CFlowd definition",
"value": {
"name": "Demo-cflowd-Policy",
"type": "cflowd",
"description": "Demo-cflowd-Policy",
"definition": {
"flowActiveTimeout": 3600,
"flowInactiveTimeout": 3600,
"flowSamplingInterval": 65513,
"templateRefresh": 86400,
"collectors": [
{
"vpn": "10",
"address": "10.0.0.1",
"port": 9912,
"transport": "transport_tcp",
"sourceInterface": "ge0/1"
},
{
"vpn": "20",
"address": "10.0.0.1",
"port": 1025,
"transport": "transport_udp",
"sourceInterface": "GigabitEthernet0/0/1"
}
],
"protocol": "ipv4"
}
}
},
"QoS map definition": {
"description": "QoS map definition",
"value": {
"name": "Demo-QoS-Policy",
"type": "qosMap",
"description": "Demo-QoS-Policy",
"definition": {
"qosSchedulers": [
{
"queue": "0",
"bandwidthPercent": "75",
"bufferPercent": "75",
"burst": "15000",
"scheduling": "llq",
"drops": "tail-drop",
"classMapRef": ""
},
{
"queue": "7",
"bandwidthPercent": "25",
"bufferPercent": "25",
"scheduling": "wrr",
"drops": "red-drop",
"classMapRef": "4484c444-b956-4016-bd15-538b74fc2785"
}
]
}
}
},
"VPN-QoS map definition": {
"description": "VPN-QoS map definition",
"value": {
"name": "Demo-VPN-QoS-Policy",
"type": "vpnQosMap",
"description": "Demo-VPN-QoS-Policy",
"definition": {
"vpnQosSchedulers": [
{
"vpnListRef": "",
"bandwidthRate": "100000",
"shapingRate": "120000",
"childMapRef": ""
},
{
"childMapRef": ""
}
]
}
}
},
"Rewrite rule definition": {
"description": "Rewrite rule definition",
"value": {
"name": "Demo-Rewrite-Rule",
"type": "rewriteRule",
"description": "Demo-Rewrite-Rule",
"definition": {
"rules": [
{
"class": "4484c444-b956-4016-bd15-538b74fc2785",
"plp": "low",
"dscp": "46",
"layer2Cos": "2"
}
]
}
}
},
"Device access policy definition": {
"description": "Device access policy definition",
"value": {
"name": "Demo-DeviceAccess-Policy",
"type": "deviceaccesspolicy",
"description": "Demo-DeviceAccess-Policy",
"defaultAction": {
"type": "drop"
},
"sequences": [
{
"sequenceId": 1,
"sequenceName": "Device Access Control List",
"baseAction": "accept",
"sequenceType": "deviceaccesspolicy",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "destinationPort",
"value": "22"
},
{
"field": "sourceIp",
"value": "10.10.24.0/24"
},
{
"field": "sourcePort",
"value": "65000"
},
{
"field": "destinationIp",
"value": "10.10.10.1/32"
},
{
"field": "vpn",
"value": "10"
}
]
},
"actions": []
},
{
"sequenceId": 11,
"sequenceName": "Device Access Control List",
"baseAction": "drop",
"sequenceType": "deviceaccesspolicy",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "destinationPort",
"value": "161"
},
{
"field": "sourceDataPrefixList",
"ref": "6c2b7164-5de2-4775-938c-b443504324ab"
}
]
},
"actions": []
}
]
}
},
"vEdge route definition": {
"description": "vEdge route definition",
"value": {
"name": "Demo-Route-Policy",
"type": "vedgeRoute",
"description": "Demo-Route-Policy",
"defaultAction": {
"type": "reject"
},
"sequences": [
{
"sequenceId": 1,
"sequenceName": "Route",
"baseAction": "accept",
"sequenceType": "vedgeRoute",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "address",
"ref": "b5c4d764-20bc-4de3-9bac-52ef70f1186c"
},
{
"field": "asPath",
"ref": "79f8c180-1a23-4f09-800d-62652b571258"
},
{
"field": "community",
"matchFlag": "or",
"ref": "33de059b-27ec-4a83-be28-8985128381eb"
},
{
"field": "localPreference",
"value": "200"
},
{
"field": "metric",
"value": "100"
},
{
"field": "nextHop",
"ref": "b5c4d764-20bc-4de3-9bac-52ef70f1186c"
},
{
"field": "ompTag",
"value": "10"
},
{
"field": "affinity",
"value": "10"
},
{
"field": "origin",
"value": "igp"
},
{
"field": "ospfTag",
"value": "10"
},
{
"field": "peer",
"value": "10.0.0.1"
}
]
},
"actions": [
{
"type": "set",
"parameter": [
{
"field": "asPath",
"value": {
"exclude": "120 130",
"prepend": "65521 65521"
}
},
{
"field": "localPreference",
"value": "200"
},
{
"field": "metricType",
"value": "type1"
},
{
"field": "metric",
"value": "100"
},
{
"field": "nextHop",
"value": "10.0.0.1"
},
{
"field": "ompTag",
"value": "100"
},
{
"field": "weight",
"value": "200"
},
{
"field": "ospfTag",
"value": "122"
},
{
"field": "originator",
"value": "10.0.0.1"
},
{
"field": "origin",
"value": "igp"
},
{
"field": "community",
"value": "1000:10000"
}
]
}
]
}
]
}
},
"vSmart definition": {
"description": "vSmart definition",
"value": {
"policyDescription": "Demo-Centralized-Policy",
"policyType": "feature",
"policyName": "Demo-Centralized-Policy",
"policyDefinition": {
"assembly": [
{
"definitionId": "eb0daba9-7fc4-4f4f-bae7-cd958f81f863",
"type": "cflowd",
"entries": [
{
"siteLists": [
"5c58c36c-9cd6-468f-8434-ee6d5801c6ba",
"24747ccd-4f7f-4dfa-8800-34f565fb65b4"
]
}
]
},
{
"definitionId": "3e33fa50-a30d-4586-9d69-106121feaaf4",
"type": "data",
"entries": [
{
"direction": "service",
"siteLists": [
"5c58c36c-9cd6-468f-8434-ee6d5801c6ba",
"24747ccd-4f7f-4dfa-8800-34f565fb65b4"
],
"vpnLists": [
"cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"
]
}
]
},
{
"definitionId": "8b2e7c44-2666-48a7-87a0-36a43c2d003e",
"type": "appRoute",
"entries": [
{
"siteLists": [
"5c58c36c-9cd6-468f-8434-ee6d5801c6ba",
"24747ccd-4f7f-4dfa-8800-34f565fb65b4"
],
"vpnLists": [
"cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"
]
}
]
},
{
"definitionId": "1b76052e-1cb5-44b1-8e5e-4096cb261736",
"type": "vpnMembershipGroup"
},
{
"definitionId": "62960276-c797-41fd-bebb-c017fc752f4e",
"type": "hubAndSpoke"
}
]
},
"isPolicyActivated": false
}
},
"vEdge definition": {
"description": "vEdge definition",
"value": {
"policyDescription": "Demo-Local-Policy",
"policyType": "feature",
"policyName": "Demo-Local-Policy",
"policyDefinition": {
"assembly": [
{
"definitionId": "56283dcf-6dda-4831-bcd1-d9cf62d33fdc",
"type": "qosMap"
},
{
"definitionId": "a75ead1f-f6ab-4a80-af29-79b742b31c5c",
"type": "rewriteRule"
},
{
"definitionId": "555dd393-e7b6-4861-866f-f227f5f780b7",
"type": "deviceAccessPolicy"
},
{
"definitionId": "22655824-d0df-4a8b-9be0-9808938a0e6b",
"type": "vedgeRoute"
}
],
"settings": {
"flowVisibility": true,
"flowVisibilityIPv6": true,
"appVisibility": true,
"cloudQos": true,
"cloudQosServiceSide": true,
"implicitAclLogging": true,
"appVisibilityIPv6": true
}
},
"isPolicyActivated": false
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Task Id": {
"description": "Task Id",
"value": {
"definitionId": "00f718df-4f95-4363-8639-1fe855c9eb09"
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/definition/data/bulk": {
"put": {
"tags": [
"Configuration - Policy Data Definition Builder"
],
"description": "Create/Edit policy definitions in bulk",
"operationId": "savePolicyDefinitionInBulk_ConfigurationPolicyDataDefinitionBuilder_3703",
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/definition/data/multiple/{id}": {
"put": {
"tags": [
"Configuration - Policy Data Definition Builder"
],
"description": "Edit multiple policy definitions",
"operationId": "editMultiplePolicyDefinition_ConfigurationPolicyDataDefinitionBuilder_4603",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/definition/data/preview": {
"post": {
"tags": [
"Configuration - Policy Data Definition Builder"
],
"description": "Preview policy definition",
"operationId": "previewPolicyDefinition_ConfigurationPolicyDataDefinitionBuilder_4004",
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/definition/data/preview/{id}": {
"get": {
"tags": [
"Configuration - Policy Data Definition Builder"
],
"description": "Preview policy definition",
"operationId": "previewPolicyDefinitionById_ConfigurationPolicyDataDefinitionBuilder_4503",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/definition/data/{id}": {
"get": {
"tags": [
"Configuration - Policy Data Definition Builder"
],
"description": "Get a specific policy definitions",
"operationId": "getPolicyDefinition_ConfigurationPolicyDataDefinitionBuilder_3703",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
},
"delete": {
"tags": [
"Configuration - Policy Data Definition Builder"
],
"description": "Delete policy definition",
"operationId": "deletePolicyDefinition_ConfigurationPolicyDataDefinitionBuilder_3706",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"put": {
"tags": [
"Configuration - Policy Data Definition Builder"
],
"description": "Edit a policy definitions",
"operationId": "editPolicyDefinition_ConfigurationPolicyDataDefinitionBuilder_3703",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"ACL policy": {
"description": "ACL policy",
"value": {
"name": "Demo-ACL",
"type": "acl",
"description": "Demo-ACL",
"defaultAction": {
"type": "accept"
},
"sequences": [
{
"sequenceId": 1,
"sequenceName": "Access Control List",
"baseAction": "accept",
"sequenceType": "acl",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "dscp",
"value": "46"
},
{
"field": "protocol",
"value": "6"
}
]
},
"actions": [
{
"type": "class",
"parameter": {
"ref": "89d20034-7149-4492-b392-b5c4f7903235"
}
}
]
}
]
}
},
"ZBFW definition": {
"description": "ZBFW definition",
"value": {
"name": "Demo-ZBFW",
"type": "zoneBasedFW",
"description": "Demo-ZBFW",
"definition": {
"defaultAction": {
"type": "drop"
},
"sequences": [
{
"sequenceId": 1,
"sequenceName": "Demo-Rule-1",
"baseAction": "inspect",
"sequenceType": "zoneBasedFW",
"match": {
"entries": [
{
"field": "sourceDataPrefixList",
"ref": "ecbea5de-b200-4ff7-aa76-f537b5f858e9"
}
]
},
"actions": []
}
],
"entries": [
{
"sourceZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53",
"destinationZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53"
}
]
}
}
},
"IPS definition": {
"description": "IPS definition",
"value": {
"name": "Demo-IPS-Policy",
"type": "intrusionPrevention",
"description": "Testing",
"definition": {
"signatureSet": "security",
"inspectionMode": "detection",
"signatureWhiteList": {
"ref": "ad189f08-af06-4799-97d6-0a7c7409cb8d"
},
"logLevel": "error",
"logging": [],
"targetVpns": [
"10",
"20"
]
}
}
},
"URL filtering definition": {
"description": "URL filtering definition",
"value": {
"name": "Demo-URL-Filtering-Policy",
"type": "urlFiltering",
"description": "",
"definition": {
"webCategoriesAction": "block",
"webCategories": [
"auctions",
"bot-nets",
"news-and-media"
],
"webReputation": "moderate-risk",
"urlWhiteList": {
"ref": "c20e31fb-fcea-4f48-93e3-09d2c6492d8b"
},
"urlBlackList": {
"ref": "557ed432-6cf8-495b-a445-d340d4c6236e"
},
"blockPageAction": "text",
"blockPageContents": "Access to the requested page has been denied. Please contact your Network Administrator",
"enableAlerts": true,
"alerts": [
"blacklist",
"whitelist",
"categories-reputation"
],
"logging": [],
"targetVpns": [
"30"
]
}
}
},
"AMP definition": {
"description": "AMP definition",
"value": {
"name": "Demo-AMP-Policy",
"type": "advancedMalwareProtection",
"description": "",
"definition": {
"matchAllVpn": true,
"fileReputationCloudServer": "nam",
"fileReputationEstServer": "nam",
"fileReputationAlert": "critical",
"fileAnalysisCloudServer": "nam",
"fileAnalysisFileTypes": [
"pdf",
"ms-exe"
],
"fileAnalysisAlert": "critical",
"targetVpns": [
"10",
"20"
],
"fileAnalysisEnabled": true
}
}
},
"DNS definition": {
"description": "DNS definition",
"value": {
"name": "Demo-DNS-Policy",
"type": "DNSSecurity",
"description": "Testing",
"definition": {
"localDomainBypassList": {
"ref": "143f753f-8d51-4be6-805d-bc330f09982f"
},
"matchAllVpn": false,
"targetVpns": [
{
"vpns": [
"10"
],
"umbrellaDefault": false,
"childOrgId": "7999118",
"dnsServerIP": "10.10.10.1",
"localDomainBypassEnabled": true
}
],
"dnsCrypt": true,
"umbrellaData": {
"ref": "e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa"
}
}
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {
"masterTemplatesAffected": []
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/definition/deviceaccesspolicy": {
"get": {
"tags": [
"Configuration - Policy Device Access Definition Builder"
],
"description": "Get policy definitions",
"operationId": "getDefinitions_ConfigurationPolicyDeviceAccessDefinitionBuilder_4603",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Device Access Policy-readDevice Access Policy-write"
},
"post": {
"tags": [
"Configuration - Policy Device Access Definition Builder"
],
"description": "Create policy definition",
"operationId": "createPolicyDefinition_ConfigurationPolicyDeviceAccessDefinitionBuilder_4604",
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write,Device Access Policy-write"
}
},
"/template/policy/definition/deviceaccesspolicy/bulk": {
"put": {
"tags": [
"Configuration - Policy Device Access Definition Builder"
],
"description": "Create/Edit policy definitions in bulk",
"operationId": "savePolicyDefinitionInBulk_ConfigurationPolicyDeviceAccessDefinitionBuilder_5103",
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/definition/deviceaccesspolicy/multiple/{id}": {
"put": {
"tags": [
"Configuration - Policy Device Access Definition Builder"
],
"description": "Edit multiple policy definitions",
"operationId": "editMultiplePolicyDefinition_ConfigurationPolicyDeviceAccessDefinitionBuilder_6003",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/definition/deviceaccesspolicy/preview": {
"post": {
"tags": [
"Configuration - Policy Device Access Definition Builder"
],
"description": "Preview policy definition",
"operationId": "previewPolicyDefinition_ConfigurationPolicyDeviceAccessDefinitionBuilder_5404",
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/definition/deviceaccesspolicy/preview/{id}": {
"get": {
"tags": [
"Configuration - Policy Device Access Definition Builder"
],
"description": "Preview policy definition",
"operationId": "previewPolicyDefinitionById_ConfigurationPolicyDeviceAccessDefinitionBuilder_5903",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/definition/deviceaccesspolicy/{id}": {
"put": {
"tags": [
"Configuration - Policy Device Access Definition Builder"
],
"description": "Edit a policy definitions",
"operationId": "editPolicyDefinition_ConfigurationPolicyDeviceAccessDefinitionBuilder_5103",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write,Device Access Policy-write"
},
"delete": {
"tags": [
"Configuration - Policy Device Access Definition Builder"
],
"description": "Delete policy definition",
"operationId": "deletePolicyDefinition_ConfigurationPolicyDeviceAccessDefinitionBuilder_5106",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write,Device Access Policy-write"
},
"get": {
"tags": [
"Configuration - Policy Device Access Definition Builder"
],
"description": "Get a specific policy definitions",
"operationId": "getPolicyDefinition_ConfigurationPolicyDeviceAccessDefinitionBuilder_5103",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Device Access Policy-readDevice Access Policy-write"
}
},
"/template/policy/definition/deviceaccesspolicyv6": {
"get": {
"tags": [
"Configuration - Policy IPv6 Device Access Definition Builder"
],
"description": "Get policy definitions",
"operationId": "getDefinitions_ConfigurationPolicyIpv6DeviceAccessDefinitionBuilder_4803",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Device Access Policy-readDevice Access Policy-write"
},
"post": {
"tags": [
"Configuration - Policy IPv6 Device Access Definition Builder"
],
"description": "Create policy definition",
"operationId": "createPolicyDefinition_ConfigurationPolicyIpv6DeviceAccessDefinitionBuilder_4804",
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write,Device Access Policy-write"
}
},
"/template/policy/definition/deviceaccesspolicyv6/bulk": {
"put": {
"tags": [
"Configuration - Policy IPv6 Device Access Definition Builder"
],
"description": "Create/Edit policy definitions in bulk",
"operationId": "savePolicyDefinitionInBulk_ConfigurationPolicyIpv6DeviceAccessDefinitionBuilder_5303",
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/definition/deviceaccesspolicyv6/multiple/{id}": {
"put": {
"tags": [
"Configuration - Policy IPv6 Device Access Definition Builder"
],
"description": "Edit multiple policy definitions",
"operationId": "editMultiplePolicyDefinition_ConfigurationPolicyIpv6DeviceAccessDefinitionBuilder_6203",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/definition/deviceaccesspolicyv6/preview": {
"post": {
"tags": [
"Configuration - Policy IPv6 Device Access Definition Builder"
],
"description": "Preview policy definition",
"operationId": "previewPolicyDefinition_ConfigurationPolicyIpv6DeviceAccessDefinitionBuilder_5604",
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/definition/deviceaccesspolicyv6/preview/{id}": {
"get": {
"tags": [
"Configuration - Policy IPv6 Device Access Definition Builder"
],
"description": "Preview policy definition",
"operationId": "previewPolicyDefinitionById_ConfigurationPolicyIpv6DeviceAccessDefinitionBuilder_6103",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/definition/deviceaccesspolicyv6/{id}": {
"get": {
"tags": [
"Configuration - Policy IPv6 Device Access Definition Builder"
],
"description": "Get a specific policy definitions",
"operationId": "getPolicyDefinition_ConfigurationPolicyIpv6DeviceAccessDefinitionBuilder_5303",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Device Access Policy-readDevice Access Policy-write"
},
"put": {
"tags": [
"Configuration - Policy IPv6 Device Access Definition Builder"
],
"description": "Edit a policy definitions",
"operationId": "editPolicyDefinition_ConfigurationPolicyIpv6DeviceAccessDefinitionBuilder_5303",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write,Device Access Policy-write"
},
"delete": {
"tags": [
"Configuration - Policy IPv6 Device Access Definition Builder"
],
"description": "Delete policy definition",
"operationId": "deletePolicyDefinition_ConfigurationPolicyIpv6DeviceAccessDefinitionBuilder_5306",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write,Device Access Policy-write"
}
},
"/template/policy/definition/dialpeer": {
"get": {
"tags": [
"Configuration - Policy DialPeer Definition Builder"
],
"description": "Get policy definitions",
"operationId": "getDefinitions_ConfigurationPolicyDialpeerDefinitionBuilder_3603",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
},
"post": {
"tags": [
"Configuration - Policy DialPeer Definition Builder"
],
"description": "Create policy definition",
"operationId": "createPolicyDefinition_ConfigurationPolicyDialpeerDefinitionBuilder_3604",
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"ACL policy": {
"description": "ACL policy",
"value": {
"name": "Demo-ACL",
"type": "acl",
"description": "Demo-ACL",
"defaultAction": {
"type": "accept"
},
"sequences": [
{
"sequenceId": 1,
"sequenceName": "Access Control List",
"baseAction": "accept",
"sequenceType": "acl",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "dscp",
"value": "46"
}
]
},
"actions": [
{
"type": "class",
"parameter": {
"ref": "89d20034-7149-4492-b392-b5c4f7903235"
}
}
]
}
]
}
},
"ZBFW definition": {
"description": "ZBFW definition",
"value": {
"name": "Demo-ZBFW",
"type": "zoneBasedFW",
"description": "Demo-ZBFW",
"definition": {
"defaultAction": {
"type": "drop"
},
"sequences": [],
"entries": [
{
"sourceZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53",
"destinationZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53"
}
]
}
}
},
"IPS definition": {
"description": "IPS definition",
"value": {
"name": "Demo-IPS-Policy",
"type": "intrusionPrevention",
"description": "Testing",
"definition": {
"signatureSet": "security",
"inspectionMode": "detection",
"signatureWhiteList": {
"ref": "ad189f08-af06-4799-97d6-0a7c7409cb8d"
},
"logLevel": "error",
"logging": [],
"targetVpns": [
"10"
]
}
}
},
"URL filtering definition": {
"description": "URL filtering definition",
"value": {
"name": "Demo-URL-Filtering-Policy",
"type": "urlFiltering",
"description": "",
"definition": {
"webCategoriesAction": "block",
"webCategories": [
"auctions",
"bot-nets"
],
"webReputation": "moderate-risk",
"urlWhiteList": {
"ref": "c20e31fb-fcea-4f48-93e3-09d2c6492d8b"
},
"urlBlackList": {
"ref": "557ed432-6cf8-495b-a445-d340d4c6236e"
},
"blockPageAction": "text",
"blockPageContents": "Access to the requested page has been denied. Please contact your Network Administrator",
"enableAlerts": true,
"alerts": [
"blacklist",
"whitelist",
"categories-reputation"
],
"logging": [],
"targetVpns": [
"10",
"20"
]
}
}
},
"AMP definition": {
"description": "AMP definition",
"value": {
"name": "Demo-AMP-Policy",
"type": "advancedMalwareProtection",
"description": "",
"definition": {
"matchAllVpn": false,
"fileReputationCloudServer": "nam",
"fileReputationEstServer": "nam",
"fileReputationAlert": "critical",
"fileAnalysisCloudServer": "",
"fileAnalysisFileTypes": [],
"fileAnalysisAlert": "",
"targetVpns": [
"10",
"20"
]
}
}
},
"DNS definition": {
"description": "DNS definition",
"value": {
"name": "Demo-DNS-Policy",
"type": "DNSSecurity",
"description": "Testing",
"definition": {
"localDomainBypassList": {
"ref": "143f753f-8d51-4be6-805d-bc330f09982f"
},
"matchAllVpn": true,
"umbrellaDefault": true,
"childOrgId": "7999118",
"localDomainBypassEnabled": true,
"dnsCrypt": true,
"umbrellaData": {
"ref": "e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa"
}
}
}
},
"HubandSpoke definition": {
"description": "HubandSpoke definition",
"value": {
"name": "Demo-Hub-n-Spoke-Policy",
"type": "hubAndSpoke",
"description": "Demo-Hub-n-Spoke-Policy",
"definition": {
"vpnList": "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf",
"subDefinitions": [
{
"name": "My Hub-and-Spoke",
"equalPreference": false,
"advertiseTloc": true,
"spokes": [
{
"siteList": "5c58c36c-9cd6-468f-8434-ee6d5801c6ba",
"hubs": [
{
"siteList": "24747ccd-4f7f-4dfa-8800-34f565fb65b4",
"preference": "20",
"prefixLists": [
"b5c4d764-20bc-4de3-9bac-52ef70f1186c"
],
"ipv6PrefixLists": []
}
]
}
],
"tlocList": "1e97c258-4323-4754-9dc0-44e9656d43bf"
}
]
}
}
},
"VPN membership group definition": {
"description": "VPN membership group definition",
"value": {
"name": "Demo-VPN-Membership-Policy",
"type": "vpnMembershipGroup",
"description": "Demo-VPN-Membership-Policy",
"definition": {
"sites": [
{
"siteList": "24747ccd-4f7f-4dfa-8800-34f565fb65b4",
"vpnList": [
"cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"
]
},
{
"siteList": "5c58c36c-9cd6-468f-8434-ee6d5801c6ba",
"vpnList": [
"cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"
]
}
]
}
}
},
"AppRoute definition": {
"description": "AppRoute definition",
"value": {
"name": "Demo-AAR-Policy",
"type": "appRoute",
"description": "Demo-AAR-Policy",
"sequences": [
{
"sequenceId": 1,
"sequenceName": "App Route",
"sequenceType": "appRoute",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "appList",
"ref": "b6752dba-969b-46de-a7e7-da11910fb1bf"
},
{
"field": "dnsAppList",
"ref": "b6752dba-969b-46de-a7e7-da11910fb1bf"
},
{
"field": "dns",
"value": "request"
},
{
"field": "dscp",
"value": "46"
},
{
"field": "plp",
"value": "high"
},
{
"field": "protocol",
"value": "6"
},
{
"field": "sourceDataPrefixList",
"ref": "6c2b7164-5de2-4775-938c-b443504324ab"
},
{
"field": "sourcePort",
"value": "1025"
},
{
"field": "destinationDataPrefixList",
"ref": "6c2b7164-5de2-4775-938c-b443504324ab"
},
{
"field": "destinationPort",
"value": "65000"
}
]
},
"actions": [
{
"type": "backupSlaPreferredColor",
"parameter": "biz-internet"
},
{
"type": "count",
"parameter": "Demo-Counter"
},
{
"type": "log",
"parameter": ""
},
{
"type": "slaClass",
"parameter": [
{
"field": "name",
"ref": "46cea5a1-1570-4921-b87a-837d590eb37e"
},
{
"field": "preferredColor",
"value": "public-internet"
},
{
"field": "strict"
}
]
}
]
},
{
"sequenceId": 11,
"sequenceName": "App Route",
"sequenceType": "appRoute",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "saasAppList",
"ref": "1e6688ce-2d21-4d7a-9a93-ae6a8ebd4a06"
}
]
},
"actions": [
{
"type": "cloudSaas",
"parameter": ""
}
]
},
{
"sequenceId": 21,
"sequenceName": "App Route",
"sequenceType": "appRoute",
"sequenceIpType": "ipv6",
"match": {
"entries": [
{
"field": "dscp",
"value": "46"
},
{
"field": "protocol",
"value": "6"
},
{
"field": "sourceIpv6",
"value": "2001::/8"
},
{
"field": "sourcePort",
"value": "65000"
},
{
"field": "destinationIpv6",
"value": "2001::/8"
},
{
"field": "destinationPort",
"value": "65000"
}
]
},
"actions": [
{
"type": "backupSlaPreferredColor",
"parameter": "biz-internet"
},
{
"type": "count",
"parameter": "Demo-Counter"
},
{
"type": "log",
"parameter": ""
},
{
"type": "slaClass",
"parameter": [
{
"field": "name",
"ref": "46cea5a1-1570-4921-b87a-837d590eb37e"
},
{
"field": "preferredColor",
"value": "public-internet"
},
{
"field": "strict"
}
]
}
]
}
]
}
},
"Data policy definition": {
"description": "Data policy definition",
"value": {
"name": "Demo-Data-Policy",
"type": "data",
"description": "Demo-Data-Policy",
"defaultAction": {
"type": "drop"
},
"sequences": [
{
"sequenceId": 1,
"sequenceName": "Custom",
"baseAction": "accept",
"sequenceType": "data",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "appList",
"ref": "b6752dba-969b-46de-a7e7-da11910fb1bf"
},
{
"field": "dnsAppList",
"ref": "b6752dba-969b-46de-a7e7-da11910fb1bf"
},
{
"field": "dns",
"value": "response"
},
{
"field": "dscp",
"value": "46"
},
{
"field": "packetLength",
"value": "1504"
},
{
"field": "plp",
"value": "high"
},
{
"field": "protocol",
"value": "6"
},
{
"field": "sourceDataPrefixList",
"ref": "6c2b7164-5de2-4775-938c-b443504324ab"
},
{
"field": "sourcePort",
"value": "65000"
},
{
"field": "destinationIp",
"value": "10.0.0.0/12"
},
{
"field": "destinationPort",
"value": "65000"
},
{
"field": "tcp",
"value": "syn"
}
]
},
"actions": [
{
"type": "count",
"parameter": "Demo-Counter"
},
{
"type": "set",
"parameter": [
{
"field": "dscp",
"value": "34"
},
{
"field": "forwardingClass",
"value": "ef-class"
},
{
"field": "localTlocList",
"value": {
"color": "public-internet",
"restrict": "",
"encap": "ipsec"
}
},
{
"field": "nextHop",
"value": "10.0.0.1"
},
{
"field": "policer",
"ref": "ecf250c7-bef0-405b-8e74-4d67440cac90"
}
]
},
{
"type": "cflowd"
},
{
"type": "log",
"parameter": ""
},
{
"type": "nat",
"parameter": {
"field": "pool",
"value": "1"
}
},
{
"type": "redirectDns",
"parameter": {
"field": "dnsType",
"value": "umbrella"
}
}
]
},
{
"sequenceId": 11,
"sequenceName": "Custom",
"baseAction": "accept",
"sequenceType": "data",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "appList",
"ref": "b6752dba-969b-46de-a7e7-da11910fb1bf"
}
]
},
"actions": [
{
"type": "set",
"parameter": [
{
"field": "service",
"value": {
"type": "FW",
"vpn": "10",
"tloc": {
"ip": "10.0.0.1",
"color": "biz-internet",
"encap": "ipsec"
}
}
}
]
},
{
"type": "tcpOptimization",
"parameter": ""
},
{
"type": "lossProtect",
"parameter": "fecAdaptive"
},
{
"type": "lossProtectFec",
"parameter": "fecAdaptive"
},
{
"type": "sig",
"parameter": ""
}
]
}
]
}
},
"CFlowd definition": {
"description": "CFlowd definition",
"value": {
"name": "Demo-cflowd-Policy",
"type": "cflowd",
"description": "Demo-cflowd-Policy",
"definition": {
"flowActiveTimeout": 3600,
"flowInactiveTimeout": 3600,
"flowSamplingInterval": 65513,
"templateRefresh": 86400,
"collectors": [
{
"vpn": "10",
"address": "10.0.0.1",
"port": 9912,
"transport": "transport_tcp",
"sourceInterface": "ge0/1"
},
{
"vpn": "20",
"address": "10.0.0.1",
"port": 1025,
"transport": "transport_udp",
"sourceInterface": "GigabitEthernet0/0/1"
}
],
"protocol": "ipv4"
}
}
},
"QoS map definition": {
"description": "QoS map definition",
"value": {
"name": "Demo-QoS-Policy",
"type": "qosMap",
"description": "Demo-QoS-Policy",
"definition": {
"qosSchedulers": [
{
"queue": "0",
"bandwidthPercent": "75",
"bufferPercent": "75",
"burst": "15000",
"scheduling": "llq",
"drops": "tail-drop",
"classMapRef": ""
},
{
"queue": "7",
"bandwidthPercent": "25",
"bufferPercent": "25",
"scheduling": "wrr",
"drops": "red-drop",
"classMapRef": "4484c444-b956-4016-bd15-538b74fc2785"
}
]
}
}
},
"VPN-QoS map definition": {
"description": "VPN-QoS map definition",
"value": {
"name": "Demo-VPN-QoS-Policy",
"type": "vpnQosMap",
"description": "Demo-VPN-QoS-Policy",
"definition": {
"vpnQosSchedulers": [
{
"vpnListRef": "",
"bandwidthRate": "100000",
"shapingRate": "120000",
"childMapRef": ""
},
{
"childMapRef": ""
}
]
}
}
},
"Rewrite rule definition": {
"description": "Rewrite rule definition",
"value": {
"name": "Demo-Rewrite-Rule",
"type": "rewriteRule",
"description": "Demo-Rewrite-Rule",
"definition": {
"rules": [
{
"class": "4484c444-b956-4016-bd15-538b74fc2785",
"plp": "low",
"dscp": "46",
"layer2Cos": "2"
}
]
}
}
},
"Device access policy definition": {
"description": "Device access policy definition",
"value": {
"name": "Demo-DeviceAccess-Policy",
"type": "deviceaccesspolicy",
"description": "Demo-DeviceAccess-Policy",
"defaultAction": {
"type": "drop"
},
"sequences": [
{
"sequenceId": 1,
"sequenceName": "Device Access Control List",
"baseAction": "accept",
"sequenceType": "deviceaccesspolicy",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "destinationPort",
"value": "22"
},
{
"field": "sourceIp",
"value": "10.10.24.0/24"
},
{
"field": "sourcePort",
"value": "65000"
},
{
"field": "destinationIp",
"value": "10.10.10.1/32"
},
{
"field": "vpn",
"value": "10"
}
]
},
"actions": []
},
{
"sequenceId": 11,
"sequenceName": "Device Access Control List",
"baseAction": "drop",
"sequenceType": "deviceaccesspolicy",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "destinationPort",
"value": "161"
},
{
"field": "sourceDataPrefixList",
"ref": "6c2b7164-5de2-4775-938c-b443504324ab"
}
]
},
"actions": []
}
]
}
},
"vEdge route definition": {
"description": "vEdge route definition",
"value": {
"name": "Demo-Route-Policy",
"type": "vedgeRoute",
"description": "Demo-Route-Policy",
"defaultAction": {
"type": "reject"
},
"sequences": [
{
"sequenceId": 1,
"sequenceName": "Route",
"baseAction": "accept",
"sequenceType": "vedgeRoute",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "address",
"ref": "b5c4d764-20bc-4de3-9bac-52ef70f1186c"
},
{
"field": "asPath",
"ref": "79f8c180-1a23-4f09-800d-62652b571258"
},
{
"field": "community",
"matchFlag": "or",
"ref": "33de059b-27ec-4a83-be28-8985128381eb"
},
{
"field": "localPreference",
"value": "200"
},
{
"field": "metric",
"value": "100"
},
{
"field": "nextHop",
"ref": "b5c4d764-20bc-4de3-9bac-52ef70f1186c"
},
{
"field": "ompTag",
"value": "10"
},
{
"field": "affinity",
"value": "10"
},
{
"field": "origin",
"value": "igp"
},
{
"field": "ospfTag",
"value": "10"
},
{
"field": "peer",
"value": "10.0.0.1"
}
]
},
"actions": [
{
"type": "set",
"parameter": [
{
"field": "asPath",
"value": {
"exclude": "120 130",
"prepend": "65521 65521"
}
},
{
"field": "localPreference",
"value": "200"
},
{
"field": "metricType",
"value": "type1"
},
{
"field": "metric",
"value": "100"
},
{
"field": "nextHop",
"value": "10.0.0.1"
},
{
"field": "ompTag",
"value": "100"
},
{
"field": "weight",
"value": "200"
},
{
"field": "ospfTag",
"value": "122"
},
{
"field": "originator",
"value": "10.0.0.1"
},
{
"field": "origin",
"value": "igp"
},
{
"field": "community",
"value": "1000:10000"
}
]
}
]
}
]
}
},
"vSmart definition": {
"description": "vSmart definition",
"value": {
"policyDescription": "Demo-Centralized-Policy",
"policyType": "feature",
"policyName": "Demo-Centralized-Policy",
"policyDefinition": {
"assembly": [
{
"definitionId": "eb0daba9-7fc4-4f4f-bae7-cd958f81f863",
"type": "cflowd",
"entries": [
{
"siteLists": [
"5c58c36c-9cd6-468f-8434-ee6d5801c6ba",
"24747ccd-4f7f-4dfa-8800-34f565fb65b4"
]
}
]
},
{
"definitionId": "3e33fa50-a30d-4586-9d69-106121feaaf4",
"type": "data",
"entries": [
{
"direction": "service",
"siteLists": [
"5c58c36c-9cd6-468f-8434-ee6d5801c6ba",
"24747ccd-4f7f-4dfa-8800-34f565fb65b4"
],
"vpnLists": [
"cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"
]
}
]
},
{
"definitionId": "8b2e7c44-2666-48a7-87a0-36a43c2d003e",
"type": "appRoute",
"entries": [
{
"siteLists": [
"5c58c36c-9cd6-468f-8434-ee6d5801c6ba",
"24747ccd-4f7f-4dfa-8800-34f565fb65b4"
],
"vpnLists": [
"cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"
]
}
]
},
{
"definitionId": "1b76052e-1cb5-44b1-8e5e-4096cb261736",
"type": "vpnMembershipGroup"
},
{
"definitionId": "62960276-c797-41fd-bebb-c017fc752f4e",
"type": "hubAndSpoke"
}
]
},
"isPolicyActivated": false
}
},
"vEdge definition": {
"description": "vEdge definition",
"value": {
"policyDescription": "Demo-Local-Policy",
"policyType": "feature",
"policyName": "Demo-Local-Policy",
"policyDefinition": {
"assembly": [
{
"definitionId": "56283dcf-6dda-4831-bcd1-d9cf62d33fdc",
"type": "qosMap"
},
{
"definitionId": "a75ead1f-f6ab-4a80-af29-79b742b31c5c",
"type": "rewriteRule"
},
{
"definitionId": "555dd393-e7b6-4861-866f-f227f5f780b7",
"type": "deviceAccessPolicy"
},
{
"definitionId": "22655824-d0df-4a8b-9be0-9808938a0e6b",
"type": "vedgeRoute"
}
],
"settings": {
"flowVisibility": true,
"flowVisibilityIPv6": true,
"appVisibility": true,
"cloudQos": true,
"cloudQosServiceSide": true,
"implicitAclLogging": true,
"appVisibilityIPv6": true
}
},
"isPolicyActivated": false
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Task Id": {
"description": "Task Id",
"value": {
"definitionId": "00f718df-4f95-4363-8639-1fe855c9eb09"
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/definition/dialpeer/bulk": {
"put": {
"tags": [
"Configuration - Policy DialPeer Definition Builder"
],
"description": "Create/Edit policy definitions in bulk",
"operationId": "savePolicyDefinitionInBulk_ConfigurationPolicyDialpeerDefinitionBuilder_4103",
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/definition/dialpeer/multiple/{id}": {
"put": {
"tags": [
"Configuration - Policy DialPeer Definition Builder"
],
"description": "Edit multiple policy definitions",
"operationId": "editMultiplePolicyDefinition_ConfigurationPolicyDialpeerDefinitionBuilder_5003",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/definition/dialpeer/preview": {
"post": {
"tags": [
"Configuration - Policy DialPeer Definition Builder"
],
"description": "Preview policy definition",
"operationId": "previewPolicyDefinition_ConfigurationPolicyDialpeerDefinitionBuilder_4404",
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/definition/dialpeer/preview/{id}": {
"get": {
"tags": [
"Configuration - Policy DialPeer Definition Builder"
],
"description": "Preview policy definition",
"operationId": "previewPolicyDefinitionById_ConfigurationPolicyDialpeerDefinitionBuilder_4903",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/definition/dialpeer/{id}": {
"delete": {
"tags": [
"Configuration - Policy DialPeer Definition Builder"
],
"description": "Delete policy definition",
"operationId": "deletePolicyDefinition_ConfigurationPolicyDialpeerDefinitionBuilder_4106",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"get": {
"tags": [
"Configuration - Policy DialPeer Definition Builder"
],
"description": "Get a specific policy definitions",
"operationId": "getPolicyDefinition_ConfigurationPolicyDialpeerDefinitionBuilder_4103",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
},
"put": {
"tags": [
"Configuration - Policy DialPeer Definition Builder"
],
"description": "Edit a policy definitions",
"operationId": "editPolicyDefinition_ConfigurationPolicyDialpeerDefinitionBuilder_4103",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"ACL policy": {
"description": "ACL policy",
"value": {
"name": "Demo-ACL",
"type": "acl",
"description": "Demo-ACL",
"defaultAction": {
"type": "accept"
},
"sequences": [
{
"sequenceId": 1,
"sequenceName": "Access Control List",
"baseAction": "accept",
"sequenceType": "acl",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "dscp",
"value": "46"
},
{
"field": "protocol",
"value": "6"
}
]
},
"actions": [
{
"type": "class",
"parameter": {
"ref": "89d20034-7149-4492-b392-b5c4f7903235"
}
}
]
}
]
}
},
"ZBFW definition": {
"description": "ZBFW definition",
"value": {
"name": "Demo-ZBFW",
"type": "zoneBasedFW",
"description": "Demo-ZBFW",
"definition": {
"defaultAction": {
"type": "drop"
},
"sequences": [
{
"sequenceId": 1,
"sequenceName": "Demo-Rule-1",
"baseAction": "inspect",
"sequenceType": "zoneBasedFW",
"match": {
"entries": [
{
"field": "sourceDataPrefixList",
"ref": "ecbea5de-b200-4ff7-aa76-f537b5f858e9"
}
]
},
"actions": []
}
],
"entries": [
{
"sourceZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53",
"destinationZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53"
}
]
}
}
},
"IPS definition": {
"description": "IPS definition",
"value": {
"name": "Demo-IPS-Policy",
"type": "intrusionPrevention",
"description": "Testing",
"definition": {
"signatureSet": "security",
"inspectionMode": "detection",
"signatureWhiteList": {
"ref": "ad189f08-af06-4799-97d6-0a7c7409cb8d"
},
"logLevel": "error",
"logging": [],
"targetVpns": [
"10",
"20"
]
}
}
},
"URL filtering definition": {
"description": "URL filtering definition",
"value": {
"name": "Demo-URL-Filtering-Policy",
"type": "urlFiltering",
"description": "",
"definition": {
"webCategoriesAction": "block",
"webCategories": [
"auctions",
"bot-nets",
"news-and-media"
],
"webReputation": "moderate-risk",
"urlWhiteList": {
"ref": "c20e31fb-fcea-4f48-93e3-09d2c6492d8b"
},
"urlBlackList": {
"ref": "557ed432-6cf8-495b-a445-d340d4c6236e"
},
"blockPageAction": "text",
"blockPageContents": "Access to the requested page has been denied. Please contact your Network Administrator",
"enableAlerts": true,
"alerts": [
"blacklist",
"whitelist",
"categories-reputation"
],
"logging": [],
"targetVpns": [
"30"
]
}
}
},
"AMP definition": {
"description": "AMP definition",
"value": {
"name": "Demo-AMP-Policy",
"type": "advancedMalwareProtection",
"description": "",
"definition": {
"matchAllVpn": true,
"fileReputationCloudServer": "nam",
"fileReputationEstServer": "nam",
"fileReputationAlert": "critical",
"fileAnalysisCloudServer": "nam",
"fileAnalysisFileTypes": [
"pdf",
"ms-exe"
],
"fileAnalysisAlert": "critical",
"targetVpns": [
"10",
"20"
],
"fileAnalysisEnabled": true
}
}
},
"DNS definition": {
"description": "DNS definition",
"value": {
"name": "Demo-DNS-Policy",
"type": "DNSSecurity",
"description": "Testing",
"definition": {
"localDomainBypassList": {
"ref": "143f753f-8d51-4be6-805d-bc330f09982f"
},
"matchAllVpn": false,
"targetVpns": [
{
"vpns": [
"10"
],
"umbrellaDefault": false,
"childOrgId": "7999118",
"dnsServerIP": "10.10.10.1",
"localDomainBypassEnabled": true
}
],
"dnsCrypt": true,
"umbrellaData": {
"ref": "e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa"
}
}
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {
"masterTemplatesAffected": []
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/definition/dnssecurity": {
"get": {
"tags": [
"Configuration - Policy Local Domain Definition Builder"
],
"description": "Get policy definitions",
"operationId": "getDefinitions_ConfigurationPolicyLocalDomainDefinitionBuilder_3903",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
},
"post": {
"tags": [
"Configuration - Policy Local Domain Definition Builder"
],
"description": "Create policy definition",
"operationId": "createPolicyDefinition_ConfigurationPolicyLocalDomainDefinitionBuilder_3904",
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"ACL policy": {
"description": "ACL policy",
"value": {
"name": "Demo-ACL",
"type": "acl",
"description": "Demo-ACL",
"defaultAction": {
"type": "accept"
},
"sequences": [
{
"sequenceId": 1,
"sequenceName": "Access Control List",
"baseAction": "accept",
"sequenceType": "acl",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "dscp",
"value": "46"
}
]
},
"actions": [
{
"type": "class",
"parameter": {
"ref": "89d20034-7149-4492-b392-b5c4f7903235"
}
}
]
}
]
}
},
"ZBFW definition": {
"description": "ZBFW definition",
"value": {
"name": "Demo-ZBFW",
"type": "zoneBasedFW",
"description": "Demo-ZBFW",
"definition": {
"defaultAction": {
"type": "drop"
},
"sequences": [],
"entries": [
{
"sourceZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53",
"destinationZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53"
}
]
}
}
},
"IPS definition": {
"description": "IPS definition",
"value": {
"name": "Demo-IPS-Policy",
"type": "intrusionPrevention",
"description": "Testing",
"definition": {
"signatureSet": "security",
"inspectionMode": "detection",
"signatureWhiteList": {
"ref": "ad189f08-af06-4799-97d6-0a7c7409cb8d"
},
"logLevel": "error",
"logging": [],
"targetVpns": [
"10"
]
}
}
},
"URL filtering definition": {
"description": "URL filtering definition",
"value": {
"name": "Demo-URL-Filtering-Policy",
"type": "urlFiltering",
"description": "",
"definition": {
"webCategoriesAction": "block",
"webCategories": [
"auctions",
"bot-nets"
],
"webReputation": "moderate-risk",
"urlWhiteList": {
"ref": "c20e31fb-fcea-4f48-93e3-09d2c6492d8b"
},
"urlBlackList": {
"ref": "557ed432-6cf8-495b-a445-d340d4c6236e"
},
"blockPageAction": "text",
"blockPageContents": "Access to the requested page has been denied. Please contact your Network Administrator",
"enableAlerts": true,
"alerts": [
"blacklist",
"whitelist",
"categories-reputation"
],
"logging": [],
"targetVpns": [
"10",
"20"
]
}
}
},
"AMP definition": {
"description": "AMP definition",
"value": {
"name": "Demo-AMP-Policy",
"type": "advancedMalwareProtection",
"description": "",
"definition": {
"matchAllVpn": false,
"fileReputationCloudServer": "nam",
"fileReputationEstServer": "nam",
"fileReputationAlert": "critical",
"fileAnalysisCloudServer": "",
"fileAnalysisFileTypes": [],
"fileAnalysisAlert": "",
"targetVpns": [
"10",
"20"
]
}
}
},
"DNS definition": {
"description": "DNS definition",
"value": {
"name": "Demo-DNS-Policy",
"type": "DNSSecurity",
"description": "Testing",
"definition": {
"localDomainBypassList": {
"ref": "143f753f-8d51-4be6-805d-bc330f09982f"
},
"matchAllVpn": true,
"umbrellaDefault": true,
"childOrgId": "7999118",
"localDomainBypassEnabled": true,
"dnsCrypt": true,
"umbrellaData": {
"ref": "e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa"
}
}
}
},
"HubandSpoke definition": {
"description": "HubandSpoke definition",
"value": {
"name": "Demo-Hub-n-Spoke-Policy",
"type": "hubAndSpoke",
"description": "Demo-Hub-n-Spoke-Policy",
"definition": {
"vpnList": "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf",
"subDefinitions": [
{
"name": "My Hub-and-Spoke",
"equalPreference": false,
"advertiseTloc": true,
"spokes": [
{
"siteList": "5c58c36c-9cd6-468f-8434-ee6d5801c6ba",
"hubs": [
{
"siteList": "24747ccd-4f7f-4dfa-8800-34f565fb65b4",
"preference": "20",
"prefixLists": [
"b5c4d764-20bc-4de3-9bac-52ef70f1186c"
],
"ipv6PrefixLists": []
}
]
}
],
"tlocList": "1e97c258-4323-4754-9dc0-44e9656d43bf"
}
]
}
}
},
"VPN membership group definition": {
"description": "VPN membership group definition",
"value": {
"name": "Demo-VPN-Membership-Policy",
"type": "vpnMembershipGroup",
"description": "Demo-VPN-Membership-Policy",
"definition": {
"sites": [
{
"siteList": "24747ccd-4f7f-4dfa-8800-34f565fb65b4",
"vpnList": [
"cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"
]
},
{
"siteList": "5c58c36c-9cd6-468f-8434-ee6d5801c6ba",
"vpnList": [
"cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"
]
}
]
}
}
},
"AppRoute definition": {
"description": "AppRoute definition",
"value": {
"name": "Demo-AAR-Policy",
"type": "appRoute",
"description": "Demo-AAR-Policy",
"sequences": [
{
"sequenceId": 1,
"sequenceName": "App Route",
"sequenceType": "appRoute",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "appList",
"ref": "b6752dba-969b-46de-a7e7-da11910fb1bf"
},
{
"field": "dnsAppList",
"ref": "b6752dba-969b-46de-a7e7-da11910fb1bf"
},
{
"field": "dns",
"value": "request"
},
{
"field": "dscp",
"value": "46"
},
{
"field": "plp",
"value": "high"
},
{
"field": "protocol",
"value": "6"
},
{
"field": "sourceDataPrefixList",
"ref": "6c2b7164-5de2-4775-938c-b443504324ab"
},
{
"field": "sourcePort",
"value": "1025"
},
{
"field": "destinationDataPrefixList",
"ref": "6c2b7164-5de2-4775-938c-b443504324ab"
},
{
"field": "destinationPort",
"value": "65000"
}
]
},
"actions": [
{
"type": "backupSlaPreferredColor",
"parameter": "biz-internet"
},
{
"type": "count",
"parameter": "Demo-Counter"
},
{
"type": "log",
"parameter": ""
},
{
"type": "slaClass",
"parameter": [
{
"field": "name",
"ref": "46cea5a1-1570-4921-b87a-837d590eb37e"
},
{
"field": "preferredColor",
"value": "public-internet"
},
{
"field": "strict"
}
]
}
]
},
{
"sequenceId": 11,
"sequenceName": "App Route",
"sequenceType": "appRoute",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "saasAppList",
"ref": "1e6688ce-2d21-4d7a-9a93-ae6a8ebd4a06"
}
]
},
"actions": [
{
"type": "cloudSaas",
"parameter": ""
}
]
},
{
"sequenceId": 21,
"sequenceName": "App Route",
"sequenceType": "appRoute",
"sequenceIpType": "ipv6",
"match": {
"entries": [
{
"field": "dscp",
"value": "46"
},
{
"field": "protocol",
"value": "6"
},
{
"field": "sourceIpv6",
"value": "2001::/8"
},
{
"field": "sourcePort",
"value": "65000"
},
{
"field": "destinationIpv6",
"value": "2001::/8"
},
{
"field": "destinationPort",
"value": "65000"
}
]
},
"actions": [
{
"type": "backupSlaPreferredColor",
"parameter": "biz-internet"
},
{
"type": "count",
"parameter": "Demo-Counter"
},
{
"type": "log",
"parameter": ""
},
{
"type": "slaClass",
"parameter": [
{
"field": "name",
"ref": "46cea5a1-1570-4921-b87a-837d590eb37e"
},
{
"field": "preferredColor",
"value": "public-internet"
},
{
"field": "strict"
}
]
}
]
}
]
}
},
"Data policy definition": {
"description": "Data policy definition",
"value": {
"name": "Demo-Data-Policy",
"type": "data",
"description": "Demo-Data-Policy",
"defaultAction": {
"type": "drop"
},
"sequences": [
{
"sequenceId": 1,
"sequenceName": "Custom",
"baseAction": "accept",
"sequenceType": "data",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "appList",
"ref": "b6752dba-969b-46de-a7e7-da11910fb1bf"
},
{
"field": "dnsAppList",
"ref": "b6752dba-969b-46de-a7e7-da11910fb1bf"
},
{
"field": "dns",
"value": "response"
},
{
"field": "dscp",
"value": "46"
},
{
"field": "packetLength",
"value": "1504"
},
{
"field": "plp",
"value": "high"
},
{
"field": "protocol",
"value": "6"
},
{
"field": "sourceDataPrefixList",
"ref": "6c2b7164-5de2-4775-938c-b443504324ab"
},
{
"field": "sourcePort",
"value": "65000"
},
{
"field": "destinationIp",
"value": "10.0.0.0/12"
},
{
"field": "destinationPort",
"value": "65000"
},
{
"field": "tcp",
"value": "syn"
}
]
},
"actions": [
{
"type": "count",
"parameter": "Demo-Counter"
},
{
"type": "set",
"parameter": [
{
"field": "dscp",
"value": "34"
},
{
"field": "forwardingClass",
"value": "ef-class"
},
{
"field": "localTlocList",
"value": {
"color": "public-internet",
"restrict": "",
"encap": "ipsec"
}
},
{
"field": "nextHop",
"value": "10.0.0.1"
},
{
"field": "policer",
"ref": "ecf250c7-bef0-405b-8e74-4d67440cac90"
}
]
},
{
"type": "cflowd"
},
{
"type": "log",
"parameter": ""
},
{
"type": "nat",
"parameter": {
"field": "pool",
"value": "1"
}
},
{
"type": "redirectDns",
"parameter": {
"field": "dnsType",
"value": "umbrella"
}
}
]
},
{
"sequenceId": 11,
"sequenceName": "Custom",
"baseAction": "accept",
"sequenceType": "data",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "appList",
"ref": "b6752dba-969b-46de-a7e7-da11910fb1bf"
}
]
},
"actions": [
{
"type": "set",
"parameter": [
{
"field": "service",
"value": {
"type": "FW",
"vpn": "10",
"tloc": {
"ip": "10.0.0.1",
"color": "biz-internet",
"encap": "ipsec"
}
}
}
]
},
{
"type": "tcpOptimization",
"parameter": ""
},
{
"type": "lossProtect",
"parameter": "fecAdaptive"
},
{
"type": "lossProtectFec",
"parameter": "fecAdaptive"
},
{
"type": "sig",
"parameter": ""
}
]
}
]
}
},
"CFlowd definition": {
"description": "CFlowd definition",
"value": {
"name": "Demo-cflowd-Policy",
"type": "cflowd",
"description": "Demo-cflowd-Policy",
"definition": {
"flowActiveTimeout": 3600,
"flowInactiveTimeout": 3600,
"flowSamplingInterval": 65513,
"templateRefresh": 86400,
"collectors": [
{
"vpn": "10",
"address": "10.0.0.1",
"port": 9912,
"transport": "transport_tcp",
"sourceInterface": "ge0/1"
},
{
"vpn": "20",
"address": "10.0.0.1",
"port": 1025,
"transport": "transport_udp",
"sourceInterface": "GigabitEthernet0/0/1"
}
],
"protocol": "ipv4"
}
}
},
"QoS map definition": {
"description": "QoS map definition",
"value": {
"name": "Demo-QoS-Policy",
"type": "qosMap",
"description": "Demo-QoS-Policy",
"definition": {
"qosSchedulers": [
{
"queue": "0",
"bandwidthPercent": "75",
"bufferPercent": "75",
"burst": "15000",
"scheduling": "llq",
"drops": "tail-drop",
"classMapRef": ""
},
{
"queue": "7",
"bandwidthPercent": "25",
"bufferPercent": "25",
"scheduling": "wrr",
"drops": "red-drop",
"classMapRef": "4484c444-b956-4016-bd15-538b74fc2785"
}
]
}
}
},
"VPN-QoS map definition": {
"description": "VPN-QoS map definition",
"value": {
"name": "Demo-VPN-QoS-Policy",
"type": "vpnQosMap",
"description": "Demo-VPN-QoS-Policy",
"definition": {
"vpnQosSchedulers": [
{
"vpnListRef": "",
"bandwidthRate": "100000",
"shapingRate": "120000",
"childMapRef": ""
},
{
"childMapRef": ""
}
]
}
}
},
"Rewrite rule definition": {
"description": "Rewrite rule definition",
"value": {
"name": "Demo-Rewrite-Rule",
"type": "rewriteRule",
"description": "Demo-Rewrite-Rule",
"definition": {
"rules": [
{
"class": "4484c444-b956-4016-bd15-538b74fc2785",
"plp": "low",
"dscp": "46",
"layer2Cos": "2"
}
]
}
}
},
"Device access policy definition": {
"description": "Device access policy definition",
"value": {
"name": "Demo-DeviceAccess-Policy",
"type": "deviceaccesspolicy",
"description": "Demo-DeviceAccess-Policy",
"defaultAction": {
"type": "drop"
},
"sequences": [
{
"sequenceId": 1,
"sequenceName": "Device Access Control List",
"baseAction": "accept",
"sequenceType": "deviceaccesspolicy",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "destinationPort",
"value": "22"
},
{
"field": "sourceIp",
"value": "10.10.24.0/24"
},
{
"field": "sourcePort",
"value": "65000"
},
{
"field": "destinationIp",
"value": "10.10.10.1/32"
},
{
"field": "vpn",
"value": "10"
}
]
},
"actions": []
},
{
"sequenceId": 11,
"sequenceName": "Device Access Control List",
"baseAction": "drop",
"sequenceType": "deviceaccesspolicy",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "destinationPort",
"value": "161"
},
{
"field": "sourceDataPrefixList",
"ref": "6c2b7164-5de2-4775-938c-b443504324ab"
}
]
},
"actions": []
}
]
}
},
"vEdge route definition": {
"description": "vEdge route definition",
"value": {
"name": "Demo-Route-Policy",
"type": "vedgeRoute",
"description": "Demo-Route-Policy",
"defaultAction": {
"type": "reject"
},
"sequences": [
{
"sequenceId": 1,
"sequenceName": "Route",
"baseAction": "accept",
"sequenceType": "vedgeRoute",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "address",
"ref": "b5c4d764-20bc-4de3-9bac-52ef70f1186c"
},
{
"field": "asPath",
"ref": "79f8c180-1a23-4f09-800d-62652b571258"
},
{
"field": "community",
"matchFlag": "or",
"ref": "33de059b-27ec-4a83-be28-8985128381eb"
},
{
"field": "localPreference",
"value": "200"
},
{
"field": "metric",
"value": "100"
},
{
"field": "nextHop",
"ref": "b5c4d764-20bc-4de3-9bac-52ef70f1186c"
},
{
"field": "ompTag",
"value": "10"
},
{
"field": "affinity",
"value": "10"
},
{
"field": "origin",
"value": "igp"
},
{
"field": "ospfTag",
"value": "10"
},
{
"field": "peer",
"value": "10.0.0.1"
}
]
},
"actions": [
{
"type": "set",
"parameter": [
{
"field": "asPath",
"value": {
"exclude": "120 130",
"prepend": "65521 65521"
}
},
{
"field": "localPreference",
"value": "200"
},
{
"field": "metricType",
"value": "type1"
},
{
"field": "metric",
"value": "100"
},
{
"field": "nextHop",
"value": "10.0.0.1"
},
{
"field": "ompTag",
"value": "100"
},
{
"field": "weight",
"value": "200"
},
{
"field": "ospfTag",
"value": "122"
},
{
"field": "originator",
"value": "10.0.0.1"
},
{
"field": "origin",
"value": "igp"
},
{
"field": "community",
"value": "1000:10000"
}
]
}
]
}
]
}
},
"vSmart definition": {
"description": "vSmart definition",
"value": {
"policyDescription": "Demo-Centralized-Policy",
"policyType": "feature",
"policyName": "Demo-Centralized-Policy",
"policyDefinition": {
"assembly": [
{
"definitionId": "eb0daba9-7fc4-4f4f-bae7-cd958f81f863",
"type": "cflowd",
"entries": [
{
"siteLists": [
"5c58c36c-9cd6-468f-8434-ee6d5801c6ba",
"24747ccd-4f7f-4dfa-8800-34f565fb65b4"
]
}
]
},
{
"definitionId": "3e33fa50-a30d-4586-9d69-106121feaaf4",
"type": "data",
"entries": [
{
"direction": "service",
"siteLists": [
"5c58c36c-9cd6-468f-8434-ee6d5801c6ba",
"24747ccd-4f7f-4dfa-8800-34f565fb65b4"
],
"vpnLists": [
"cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"
]
}
]
},
{
"definitionId": "8b2e7c44-2666-48a7-87a0-36a43c2d003e",
"type": "appRoute",
"entries": [
{
"siteLists": [
"5c58c36c-9cd6-468f-8434-ee6d5801c6ba",
"24747ccd-4f7f-4dfa-8800-34f565fb65b4"
],
"vpnLists": [
"cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"
]
}
]
},
{
"definitionId": "1b76052e-1cb5-44b1-8e5e-4096cb261736",
"type": "vpnMembershipGroup"
},
{
"definitionId": "62960276-c797-41fd-bebb-c017fc752f4e",
"type": "hubAndSpoke"
}
]
},
"isPolicyActivated": false
}
},
"vEdge definition": {
"description": "vEdge definition",
"value": {
"policyDescription": "Demo-Local-Policy",
"policyType": "feature",
"policyName": "Demo-Local-Policy",
"policyDefinition": {
"assembly": [
{
"definitionId": "56283dcf-6dda-4831-bcd1-d9cf62d33fdc",
"type": "qosMap"
},
{
"definitionId": "a75ead1f-f6ab-4a80-af29-79b742b31c5c",
"type": "rewriteRule"
},
{
"definitionId": "555dd393-e7b6-4861-866f-f227f5f780b7",
"type": "deviceAccessPolicy"
},
{
"definitionId": "22655824-d0df-4a8b-9be0-9808938a0e6b",
"type": "vedgeRoute"
}
],
"settings": {
"flowVisibility": true,
"flowVisibilityIPv6": true,
"appVisibility": true,
"cloudQos": true,
"cloudQosServiceSide": true,
"implicitAclLogging": true,
"appVisibilityIPv6": true
}
},
"isPolicyActivated": false
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Task Id": {
"description": "Task Id",
"value": {
"definitionId": "00f718df-4f95-4363-8639-1fe855c9eb09"
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/definition/dnssecurity/bulk": {
"put": {
"tags": [
"Configuration - Policy Local Domain Definition Builder"
],
"description": "Create/Edit policy definitions in bulk",
"operationId": "savePolicyDefinitionInBulk_ConfigurationPolicyLocalDomainDefinitionBuilder_4403",
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/definition/dnssecurity/multiple/{id}": {
"put": {
"tags": [
"Configuration - Policy Local Domain Definition Builder"
],
"description": "Edit multiple policy definitions",
"operationId": "editMultiplePolicyDefinition_ConfigurationPolicyLocalDomainDefinitionBuilder_5303",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/definition/dnssecurity/preview": {
"post": {
"tags": [
"Configuration - Policy Local Domain Definition Builder"
],
"description": "Preview policy definition",
"operationId": "previewPolicyDefinition_ConfigurationPolicyLocalDomainDefinitionBuilder_4704",
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/definition/dnssecurity/preview/{id}": {
"get": {
"tags": [
"Configuration - Policy Local Domain Definition Builder"
],
"description": "Preview policy definition",
"operationId": "previewPolicyDefinitionById_ConfigurationPolicyLocalDomainDefinitionBuilder_5203",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/definition/dnssecurity/{id}": {
"get": {
"tags": [
"Configuration - Policy Local Domain Definition Builder"
],
"description": "Get a specific policy definitions",
"operationId": "getPolicyDefinition_ConfigurationPolicyLocalDomainDefinitionBuilder_4403",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
},
"put": {
"tags": [
"Configuration - Policy Local Domain Definition Builder"
],
"description": "Edit a policy definitions",
"operationId": "editPolicyDefinition_ConfigurationPolicyLocalDomainDefinitionBuilder_4403",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"ACL policy": {
"description": "ACL policy",
"value": {
"name": "Demo-ACL",
"type": "acl",
"description": "Demo-ACL",
"defaultAction": {
"type": "accept"
},
"sequences": [
{
"sequenceId": 1,
"sequenceName": "Access Control List",
"baseAction": "accept",
"sequenceType": "acl",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "dscp",
"value": "46"
},
{
"field": "protocol",
"value": "6"
}
]
},
"actions": [
{
"type": "class",
"parameter": {
"ref": "89d20034-7149-4492-b392-b5c4f7903235"
}
}
]
}
]
}
},
"ZBFW definition": {
"description": "ZBFW definition",
"value": {
"name": "Demo-ZBFW",
"type": "zoneBasedFW",
"description": "Demo-ZBFW",
"definition": {
"defaultAction": {
"type": "drop"
},
"sequences": [
{
"sequenceId": 1,
"sequenceName": "Demo-Rule-1",
"baseAction": "inspect",
"sequenceType": "zoneBasedFW",
"match": {
"entries": [
{
"field": "sourceDataPrefixList",
"ref": "ecbea5de-b200-4ff7-aa76-f537b5f858e9"
}
]
},
"actions": []
}
],
"entries": [
{
"sourceZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53",
"destinationZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53"
}
]
}
}
},
"IPS definition": {
"description": "IPS definition",
"value": {
"name": "Demo-IPS-Policy",
"type": "intrusionPrevention",
"description": "Testing",
"definition": {
"signatureSet": "security",
"inspectionMode": "detection",
"signatureWhiteList": {
"ref": "ad189f08-af06-4799-97d6-0a7c7409cb8d"
},
"logLevel": "error",
"logging": [],
"targetVpns": [
"10",
"20"
]
}
}
},
"URL filtering definition": {
"description": "URL filtering definition",
"value": {
"name": "Demo-URL-Filtering-Policy",
"type": "urlFiltering",
"description": "",
"definition": {
"webCategoriesAction": "block",
"webCategories": [
"auctions",
"bot-nets",
"news-and-media"
],
"webReputation": "moderate-risk",
"urlWhiteList": {
"ref": "c20e31fb-fcea-4f48-93e3-09d2c6492d8b"
},
"urlBlackList": {
"ref": "557ed432-6cf8-495b-a445-d340d4c6236e"
},
"blockPageAction": "text",
"blockPageContents": "Access to the requested page has been denied. Please contact your Network Administrator",
"enableAlerts": true,
"alerts": [
"blacklist",
"whitelist",
"categories-reputation"
],
"logging": [],
"targetVpns": [
"30"
]
}
}
},
"AMP definition": {
"description": "AMP definition",
"value": {
"name": "Demo-AMP-Policy",
"type": "advancedMalwareProtection",
"description": "",
"definition": {
"matchAllVpn": true,
"fileReputationCloudServer": "nam",
"fileReputationEstServer": "nam",
"fileReputationAlert": "critical",
"fileAnalysisCloudServer": "nam",
"fileAnalysisFileTypes": [
"pdf",
"ms-exe"
],
"fileAnalysisAlert": "critical",
"targetVpns": [
"10",
"20"
],
"fileAnalysisEnabled": true
}
}
},
"DNS definition": {
"description": "DNS definition",
"value": {
"name": "Demo-DNS-Policy",
"type": "DNSSecurity",
"description": "Testing",
"definition": {
"localDomainBypassList": {
"ref": "143f753f-8d51-4be6-805d-bc330f09982f"
},
"matchAllVpn": false,
"targetVpns": [
{
"vpns": [
"10"
],
"umbrellaDefault": false,
"childOrgId": "7999118",
"dnsServerIP": "10.10.10.1",
"localDomainBypassEnabled": true
}
],
"dnsCrypt": true,
"umbrellaData": {
"ref": "e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa"
}
}
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {
"masterTemplatesAffected": []
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"delete": {
"tags": [
"Configuration - Policy Local Domain Definition Builder"
],
"description": "Delete policy definition",
"operationId": "deletePolicyDefinition_ConfigurationPolicyLocalDomainDefinitionBuilder_4406",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/definition/fxoport": {
"get": {
"tags": [
"Configuration - Policy FXO Port Definition Builder"
],
"description": "Get policy definitions",
"operationId": "getDefinitions_ConfigurationPolicyFxoPortDefinitionBuilder_3503",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
},
"post": {
"tags": [
"Configuration - Policy FXO Port Definition Builder"
],
"description": "Create policy definition",
"operationId": "createPolicyDefinition_ConfigurationPolicyFxoPortDefinitionBuilder_3504",
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"ACL policy": {
"description": "ACL policy",
"value": {
"name": "Demo-ACL",
"type": "acl",
"description": "Demo-ACL",
"defaultAction": {
"type": "accept"
},
"sequences": [
{
"sequenceId": 1,
"sequenceName": "Access Control List",
"baseAction": "accept",
"sequenceType": "acl",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "dscp",
"value": "46"
}
]
},
"actions": [
{
"type": "class",
"parameter": {
"ref": "89d20034-7149-4492-b392-b5c4f7903235"
}
}
]
}
]
}
},
"ZBFW definition": {
"description": "ZBFW definition",
"value": {
"name": "Demo-ZBFW",
"type": "zoneBasedFW",
"description": "Demo-ZBFW",
"definition": {
"defaultAction": {
"type": "drop"
},
"sequences": [],
"entries": [
{
"sourceZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53",
"destinationZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53"
}
]
}
}
},
"IPS definition": {
"description": "IPS definition",
"value": {
"name": "Demo-IPS-Policy",
"type": "intrusionPrevention",
"description": "Testing",
"definition": {
"signatureSet": "security",
"inspectionMode": "detection",
"signatureWhiteList": {
"ref": "ad189f08-af06-4799-97d6-0a7c7409cb8d"
},
"logLevel": "error",
"logging": [],
"targetVpns": [
"10"
]
}
}
},
"URL filtering definition": {
"description": "URL filtering definition",
"value": {
"name": "Demo-URL-Filtering-Policy",
"type": "urlFiltering",
"description": "",
"definition": {
"webCategoriesAction": "block",
"webCategories": [
"auctions",
"bot-nets"
],
"webReputation": "moderate-risk",
"urlWhiteList": {
"ref": "c20e31fb-fcea-4f48-93e3-09d2c6492d8b"
},
"urlBlackList": {
"ref": "557ed432-6cf8-495b-a445-d340d4c6236e"
},
"blockPageAction": "text",
"blockPageContents": "Access to the requested page has been denied. Please contact your Network Administrator",
"enableAlerts": true,
"alerts": [
"blacklist",
"whitelist",
"categories-reputation"
],
"logging": [],
"targetVpns": [
"10",
"20"
]
}
}
},
"AMP definition": {
"description": "AMP definition",
"value": {
"name": "Demo-AMP-Policy",
"type": "advancedMalwareProtection",
"description": "",
"definition": {
"matchAllVpn": false,
"fileReputationCloudServer": "nam",
"fileReputationEstServer": "nam",
"fileReputationAlert": "critical",
"fileAnalysisCloudServer": "",
"fileAnalysisFileTypes": [],
"fileAnalysisAlert": "",
"targetVpns": [
"10",
"20"
]
}
}
},
"DNS definition": {
"description": "DNS definition",
"value": {
"name": "Demo-DNS-Policy",
"type": "DNSSecurity",
"description": "Testing",
"definition": {
"localDomainBypassList": {
"ref": "143f753f-8d51-4be6-805d-bc330f09982f"
},
"matchAllVpn": true,
"umbrellaDefault": true,
"childOrgId": "7999118",
"localDomainBypassEnabled": true,
"dnsCrypt": true,
"umbrellaData": {
"ref": "e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa"
}
}
}
},
"HubandSpoke definition": {
"description": "HubandSpoke definition",
"value": {
"name": "Demo-Hub-n-Spoke-Policy",
"type": "hubAndSpoke",
"description": "Demo-Hub-n-Spoke-Policy",
"definition": {
"vpnList": "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf",
"subDefinitions": [
{
"name": "My Hub-and-Spoke",
"equalPreference": false,
"advertiseTloc": true,
"spokes": [
{
"siteList": "5c58c36c-9cd6-468f-8434-ee6d5801c6ba",
"hubs": [
{
"siteList": "24747ccd-4f7f-4dfa-8800-34f565fb65b4",
"preference": "20",
"prefixLists": [
"b5c4d764-20bc-4de3-9bac-52ef70f1186c"
],
"ipv6PrefixLists": []
}
]
}
],
"tlocList": "1e97c258-4323-4754-9dc0-44e9656d43bf"
}
]
}
}
},
"VPN membership group definition": {
"description": "VPN membership group definition",
"value": {
"name": "Demo-VPN-Membership-Policy",
"type": "vpnMembershipGroup",
"description": "Demo-VPN-Membership-Policy",
"definition": {
"sites": [
{
"siteList": "24747ccd-4f7f-4dfa-8800-34f565fb65b4",
"vpnList": [
"cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"
]
},
{
"siteList": "5c58c36c-9cd6-468f-8434-ee6d5801c6ba",
"vpnList": [
"cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"
]
}
]
}
}
},
"AppRoute definition": {
"description": "AppRoute definition",
"value": {
"name": "Demo-AAR-Policy",
"type": "appRoute",
"description": "Demo-AAR-Policy",
"sequences": [
{
"sequenceId": 1,
"sequenceName": "App Route",
"sequenceType": "appRoute",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "appList",
"ref": "b6752dba-969b-46de-a7e7-da11910fb1bf"
},
{
"field": "dnsAppList",
"ref": "b6752dba-969b-46de-a7e7-da11910fb1bf"
},
{
"field": "dns",
"value": "request"
},
{
"field": "dscp",
"value": "46"
},
{
"field": "plp",
"value": "high"
},
{
"field": "protocol",
"value": "6"
},
{
"field": "sourceDataPrefixList",
"ref": "6c2b7164-5de2-4775-938c-b443504324ab"
},
{
"field": "sourcePort",
"value": "1025"
},
{
"field": "destinationDataPrefixList",
"ref": "6c2b7164-5de2-4775-938c-b443504324ab"
},
{
"field": "destinationPort",
"value": "65000"
}
]
},
"actions": [
{
"type": "backupSlaPreferredColor",
"parameter": "biz-internet"
},
{
"type": "count",
"parameter": "Demo-Counter"
},
{
"type": "log",
"parameter": ""
},
{
"type": "slaClass",
"parameter": [
{
"field": "name",
"ref": "46cea5a1-1570-4921-b87a-837d590eb37e"
},
{
"field": "preferredColor",
"value": "public-internet"
},
{
"field": "strict"
}
]
}
]
},
{
"sequenceId": 11,
"sequenceName": "App Route",
"sequenceType": "appRoute",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "saasAppList",
"ref": "1e6688ce-2d21-4d7a-9a93-ae6a8ebd4a06"
}
]
},
"actions": [
{
"type": "cloudSaas",
"parameter": ""
}
]
},
{
"sequenceId": 21,
"sequenceName": "App Route",
"sequenceType": "appRoute",
"sequenceIpType": "ipv6",
"match": {
"entries": [
{
"field": "dscp",
"value": "46"
},
{
"field": "protocol",
"value": "6"
},
{
"field": "sourceIpv6",
"value": "2001::/8"
},
{
"field": "sourcePort",
"value": "65000"
},
{
"field": "destinationIpv6",
"value": "2001::/8"
},
{
"field": "destinationPort",
"value": "65000"
}
]
},
"actions": [
{
"type": "backupSlaPreferredColor",
"parameter": "biz-internet"
},
{
"type": "count",
"parameter": "Demo-Counter"
},
{
"type": "log",
"parameter": ""
},
{
"type": "slaClass",
"parameter": [
{
"field": "name",
"ref": "46cea5a1-1570-4921-b87a-837d590eb37e"
},
{
"field": "preferredColor",
"value": "public-internet"
},
{
"field": "strict"
}
]
}
]
}
]
}
},
"Data policy definition": {
"description": "Data policy definition",
"value": {
"name": "Demo-Data-Policy",
"type": "data",
"description": "Demo-Data-Policy",
"defaultAction": {
"type": "drop"
},
"sequences": [
{
"sequenceId": 1,
"sequenceName": "Custom",
"baseAction": "accept",
"sequenceType": "data",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "appList",
"ref": "b6752dba-969b-46de-a7e7-da11910fb1bf"
},
{
"field": "dnsAppList",
"ref": "b6752dba-969b-46de-a7e7-da11910fb1bf"
},
{
"field": "dns",
"value": "response"
},
{
"field": "dscp",
"value": "46"
},
{
"field": "packetLength",
"value": "1504"
},
{
"field": "plp",
"value": "high"
},
{
"field": "protocol",
"value": "6"
},
{
"field": "sourceDataPrefixList",
"ref": "6c2b7164-5de2-4775-938c-b443504324ab"
},
{
"field": "sourcePort",
"value": "65000"
},
{
"field": "destinationIp",
"value": "10.0.0.0/12"
},
{
"field": "destinationPort",
"value": "65000"
},
{
"field": "tcp",
"value": "syn"
}
]
},
"actions": [
{
"type": "count",
"parameter": "Demo-Counter"
},
{
"type": "set",
"parameter": [
{
"field": "dscp",
"value": "34"
},
{
"field": "forwardingClass",
"value": "ef-class"
},
{
"field": "localTlocList",
"value": {
"color": "public-internet",
"restrict": "",
"encap": "ipsec"
}
},
{
"field": "nextHop",
"value": "10.0.0.1"
},
{
"field": "policer",
"ref": "ecf250c7-bef0-405b-8e74-4d67440cac90"
}
]
},
{
"type": "cflowd"
},
{
"type": "log",
"parameter": ""
},
{
"type": "nat",
"parameter": {
"field": "pool",
"value": "1"
}
},
{
"type": "redirectDns",
"parameter": {
"field": "dnsType",
"value": "umbrella"
}
}
]
},
{
"sequenceId": 11,
"sequenceName": "Custom",
"baseAction": "accept",
"sequenceType": "data",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "appList",
"ref": "b6752dba-969b-46de-a7e7-da11910fb1bf"
}
]
},
"actions": [
{
"type": "set",
"parameter": [
{
"field": "service",
"value": {
"type": "FW",
"vpn": "10",
"tloc": {
"ip": "10.0.0.1",
"color": "biz-internet",
"encap": "ipsec"
}
}
}
]
},
{
"type": "tcpOptimization",
"parameter": ""
},
{
"type": "lossProtect",
"parameter": "fecAdaptive"
},
{
"type": "lossProtectFec",
"parameter": "fecAdaptive"
},
{
"type": "sig",
"parameter": ""
}
]
}
]
}
},
"CFlowd definition": {
"description": "CFlowd definition",
"value": {
"name": "Demo-cflowd-Policy",
"type": "cflowd",
"description": "Demo-cflowd-Policy",
"definition": {
"flowActiveTimeout": 3600,
"flowInactiveTimeout": 3600,
"flowSamplingInterval": 65513,
"templateRefresh": 86400,
"collectors": [
{
"vpn": "10",
"address": "10.0.0.1",
"port": 9912,
"transport": "transport_tcp",
"sourceInterface": "ge0/1"
},
{
"vpn": "20",
"address": "10.0.0.1",
"port": 1025,
"transport": "transport_udp",
"sourceInterface": "GigabitEthernet0/0/1"
}
],
"protocol": "ipv4"
}
}
},
"QoS map definition": {
"description": "QoS map definition",
"value": {
"name": "Demo-QoS-Policy",
"type": "qosMap",
"description": "Demo-QoS-Policy",
"definition": {
"qosSchedulers": [
{
"queue": "0",
"bandwidthPercent": "75",
"bufferPercent": "75",
"burst": "15000",
"scheduling": "llq",
"drops": "tail-drop",
"classMapRef": ""
},
{
"queue": "7",
"bandwidthPercent": "25",
"bufferPercent": "25",
"scheduling": "wrr",
"drops": "red-drop",
"classMapRef": "4484c444-b956-4016-bd15-538b74fc2785"
}
]
}
}
},
"VPN-QoS map definition": {
"description": "VPN-QoS map definition",
"value": {
"name": "Demo-VPN-QoS-Policy",
"type": "vpnQosMap",
"description": "Demo-VPN-QoS-Policy",
"definition": {
"vpnQosSchedulers": [
{
"vpnListRef": "",
"bandwidthRate": "100000",
"shapingRate": "120000",
"childMapRef": ""
},
{
"childMapRef": ""
}
]
}
}
},
"Rewrite rule definition": {
"description": "Rewrite rule definition",
"value": {
"name": "Demo-Rewrite-Rule",
"type": "rewriteRule",
"description": "Demo-Rewrite-Rule",
"definition": {
"rules": [
{
"class": "4484c444-b956-4016-bd15-538b74fc2785",
"plp": "low",
"dscp": "46",
"layer2Cos": "2"
}
]
}
}
},
"Device access policy definition": {
"description": "Device access policy definition",
"value": {
"name": "Demo-DeviceAccess-Policy",
"type": "deviceaccesspolicy",
"description": "Demo-DeviceAccess-Policy",
"defaultAction": {
"type": "drop"
},
"sequences": [
{
"sequenceId": 1,
"sequenceName": "Device Access Control List",
"baseAction": "accept",
"sequenceType": "deviceaccesspolicy",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "destinationPort",
"value": "22"
},
{
"field": "sourceIp",
"value": "10.10.24.0/24"
},
{
"field": "sourcePort",
"value": "65000"
},
{
"field": "destinationIp",
"value": "10.10.10.1/32"
},
{
"field": "vpn",
"value": "10"
}
]
},
"actions": []
},
{
"sequenceId": 11,
"sequenceName": "Device Access Control List",
"baseAction": "drop",
"sequenceType": "deviceaccesspolicy",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "destinationPort",
"value": "161"
},
{
"field": "sourceDataPrefixList",
"ref": "6c2b7164-5de2-4775-938c-b443504324ab"
}
]
},
"actions": []
}
]
}
},
"vEdge route definition": {
"description": "vEdge route definition",
"value": {
"name": "Demo-Route-Policy",
"type": "vedgeRoute",
"description": "Demo-Route-Policy",
"defaultAction": {
"type": "reject"
},
"sequences": [
{
"sequenceId": 1,
"sequenceName": "Route",
"baseAction": "accept",
"sequenceType": "vedgeRoute",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "address",
"ref": "b5c4d764-20bc-4de3-9bac-52ef70f1186c"
},
{
"field": "asPath",
"ref": "79f8c180-1a23-4f09-800d-62652b571258"
},
{
"field": "community",
"matchFlag": "or",
"ref": "33de059b-27ec-4a83-be28-8985128381eb"
},
{
"field": "localPreference",
"value": "200"
},
{
"field": "metric",
"value": "100"
},
{
"field": "nextHop",
"ref": "b5c4d764-20bc-4de3-9bac-52ef70f1186c"
},
{
"field": "ompTag",
"value": "10"
},
{
"field": "affinity",
"value": "10"
},
{
"field": "origin",
"value": "igp"
},
{
"field": "ospfTag",
"value": "10"
},
{
"field": "peer",
"value": "10.0.0.1"
}
]
},
"actions": [
{
"type": "set",
"parameter": [
{
"field": "asPath",
"value": {
"exclude": "120 130",
"prepend": "65521 65521"
}
},
{
"field": "localPreference",
"value": "200"
},
{
"field": "metricType",
"value": "type1"
},
{
"field": "metric",
"value": "100"
},
{
"field": "nextHop",
"value": "10.0.0.1"
},
{
"field": "ompTag",
"value": "100"
},
{
"field": "weight",
"value": "200"
},
{
"field": "ospfTag",
"value": "122"
},
{
"field": "originator",
"value": "10.0.0.1"
},
{
"field": "origin",
"value": "igp"
},
{
"field": "community",
"value": "1000:10000"
}
]
}
]
}
]
}
},
"vSmart definition": {
"description": "vSmart definition",
"value": {
"policyDescription": "Demo-Centralized-Policy",
"policyType": "feature",
"policyName": "Demo-Centralized-Policy",
"policyDefinition": {
"assembly": [
{
"definitionId": "eb0daba9-7fc4-4f4f-bae7-cd958f81f863",
"type": "cflowd",
"entries": [
{
"siteLists": [
"5c58c36c-9cd6-468f-8434-ee6d5801c6ba",
"24747ccd-4f7f-4dfa-8800-34f565fb65b4"
]
}
]
},
{
"definitionId": "3e33fa50-a30d-4586-9d69-106121feaaf4",
"type": "data",
"entries": [
{
"direction": "service",
"siteLists": [
"5c58c36c-9cd6-468f-8434-ee6d5801c6ba",
"24747ccd-4f7f-4dfa-8800-34f565fb65b4"
],
"vpnLists": [
"cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"
]
}
]
},
{
"definitionId": "8b2e7c44-2666-48a7-87a0-36a43c2d003e",
"type": "appRoute",
"entries": [
{
"siteLists": [
"5c58c36c-9cd6-468f-8434-ee6d5801c6ba",
"24747ccd-4f7f-4dfa-8800-34f565fb65b4"
],
"vpnLists": [
"cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"
]
}
]
},
{
"definitionId": "1b76052e-1cb5-44b1-8e5e-4096cb261736",
"type": "vpnMembershipGroup"
},
{
"definitionId": "62960276-c797-41fd-bebb-c017fc752f4e",
"type": "hubAndSpoke"
}
]
},
"isPolicyActivated": false
}
},
"vEdge definition": {
"description": "vEdge definition",
"value": {
"policyDescription": "Demo-Local-Policy",
"policyType": "feature",
"policyName": "Demo-Local-Policy",
"policyDefinition": {
"assembly": [
{
"definitionId": "56283dcf-6dda-4831-bcd1-d9cf62d33fdc",
"type": "qosMap"
},
{
"definitionId": "a75ead1f-f6ab-4a80-af29-79b742b31c5c",
"type": "rewriteRule"
},
{
"definitionId": "555dd393-e7b6-4861-866f-f227f5f780b7",
"type": "deviceAccessPolicy"
},
{
"definitionId": "22655824-d0df-4a8b-9be0-9808938a0e6b",
"type": "vedgeRoute"
}
],
"settings": {
"flowVisibility": true,
"flowVisibilityIPv6": true,
"appVisibility": true,
"cloudQos": true,
"cloudQosServiceSide": true,
"implicitAclLogging": true,
"appVisibilityIPv6": true
}
},
"isPolicyActivated": false
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Task Id": {
"description": "Task Id",
"value": {
"definitionId": "00f718df-4f95-4363-8639-1fe855c9eb09"
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/definition/fxoport/bulk": {
"put": {
"tags": [
"Configuration - Policy FXO Port Definition Builder"
],
"description": "Create/Edit policy definitions in bulk",
"operationId": "savePolicyDefinitionInBulk_ConfigurationPolicyFxoPortDefinitionBuilder_4003",
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/definition/fxoport/multiple/{id}": {
"put": {
"tags": [
"Configuration - Policy FXO Port Definition Builder"
],
"description": "Edit multiple policy definitions",
"operationId": "editMultiplePolicyDefinition_ConfigurationPolicyFxoPortDefinitionBuilder_4903",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/definition/fxoport/preview": {
"post": {
"tags": [
"Configuration - Policy FXO Port Definition Builder"
],
"description": "Preview policy definition",
"operationId": "previewPolicyDefinition_ConfigurationPolicyFxoPortDefinitionBuilder_4304",
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/definition/fxoport/preview/{id}": {
"get": {
"tags": [
"Configuration - Policy FXO Port Definition Builder"
],
"description": "Preview policy definition",
"operationId": "previewPolicyDefinitionById_ConfigurationPolicyFxoPortDefinitionBuilder_4803",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/definition/fxoport/{id}": {
"put": {
"tags": [
"Configuration - Policy FXO Port Definition Builder"
],
"description": "Edit a policy definitions",
"operationId": "editPolicyDefinition_ConfigurationPolicyFxoPortDefinitionBuilder_4003",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"ACL policy": {
"description": "ACL policy",
"value": {
"name": "Demo-ACL",
"type": "acl",
"description": "Demo-ACL",
"defaultAction": {
"type": "accept"
},
"sequences": [
{
"sequenceId": 1,
"sequenceName": "Access Control List",
"baseAction": "accept",
"sequenceType": "acl",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "dscp",
"value": "46"
},
{
"field": "protocol",
"value": "6"
}
]
},
"actions": [
{
"type": "class",
"parameter": {
"ref": "89d20034-7149-4492-b392-b5c4f7903235"
}
}
]
}
]
}
},
"ZBFW definition": {
"description": "ZBFW definition",
"value": {
"name": "Demo-ZBFW",
"type": "zoneBasedFW",
"description": "Demo-ZBFW",
"definition": {
"defaultAction": {
"type": "drop"
},
"sequences": [
{
"sequenceId": 1,
"sequenceName": "Demo-Rule-1",
"baseAction": "inspect",
"sequenceType": "zoneBasedFW",
"match": {
"entries": [
{
"field": "sourceDataPrefixList",
"ref": "ecbea5de-b200-4ff7-aa76-f537b5f858e9"
}
]
},
"actions": []
}
],
"entries": [
{
"sourceZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53",
"destinationZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53"
}
]
}
}
},
"IPS definition": {
"description": "IPS definition",
"value": {
"name": "Demo-IPS-Policy",
"type": "intrusionPrevention",
"description": "Testing",
"definition": {
"signatureSet": "security",
"inspectionMode": "detection",
"signatureWhiteList": {
"ref": "ad189f08-af06-4799-97d6-0a7c7409cb8d"
},
"logLevel": "error",
"logging": [],
"targetVpns": [
"10",
"20"
]
}
}
},
"URL filtering definition": {
"description": "URL filtering definition",
"value": {
"name": "Demo-URL-Filtering-Policy",
"type": "urlFiltering",
"description": "",
"definition": {
"webCategoriesAction": "block",
"webCategories": [
"auctions",
"bot-nets",
"news-and-media"
],
"webReputation": "moderate-risk",
"urlWhiteList": {
"ref": "c20e31fb-fcea-4f48-93e3-09d2c6492d8b"
},
"urlBlackList": {
"ref": "557ed432-6cf8-495b-a445-d340d4c6236e"
},
"blockPageAction": "text",
"blockPageContents": "Access to the requested page has been denied. Please contact your Network Administrator",
"enableAlerts": true,
"alerts": [
"blacklist",
"whitelist",
"categories-reputation"
],
"logging": [],
"targetVpns": [
"30"
]
}
}
},
"AMP definition": {
"description": "AMP definition",
"value": {
"name": "Demo-AMP-Policy",
"type": "advancedMalwareProtection",
"description": "",
"definition": {
"matchAllVpn": true,
"fileReputationCloudServer": "nam",
"fileReputationEstServer": "nam",
"fileReputationAlert": "critical",
"fileAnalysisCloudServer": "nam",
"fileAnalysisFileTypes": [
"pdf",
"ms-exe"
],
"fileAnalysisAlert": "critical",
"targetVpns": [
"10",
"20"
],
"fileAnalysisEnabled": true
}
}
},
"DNS definition": {
"description": "DNS definition",
"value": {
"name": "Demo-DNS-Policy",
"type": "DNSSecurity",
"description": "Testing",
"definition": {
"localDomainBypassList": {
"ref": "143f753f-8d51-4be6-805d-bc330f09982f"
},
"matchAllVpn": false,
"targetVpns": [
{
"vpns": [
"10"
],
"umbrellaDefault": false,
"childOrgId": "7999118",
"dnsServerIP": "10.10.10.1",
"localDomainBypassEnabled": true
}
],
"dnsCrypt": true,
"umbrellaData": {
"ref": "e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa"
}
}
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {
"masterTemplatesAffected": []
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"delete": {
"tags": [
"Configuration - Policy FXO Port Definition Builder"
],
"description": "Delete policy definition",
"operationId": "deletePolicyDefinition_ConfigurationPolicyFxoPortDefinitionBuilder_4006",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"get": {
"tags": [
"Configuration - Policy FXO Port Definition Builder"
],
"description": "Get a specific policy definitions",
"operationId": "getPolicyDefinition_ConfigurationPolicyFxoPortDefinitionBuilder_4003",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/definition/fxsdidport": {
"get": {
"tags": [
"Configuration - Policy FXSDID Port Definition Builder"
],
"description": "Get policy definitions",
"operationId": "getDefinitions_ConfigurationPolicyFxsdidPortDefinitionBuilder_3803",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
},
"post": {
"tags": [
"Configuration - Policy FXSDID Port Definition Builder"
],
"description": "Create policy definition",
"operationId": "createPolicyDefinition_ConfigurationPolicyFxsdidPortDefinitionBuilder_3804",
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"ACL policy": {
"description": "ACL policy",
"value": {
"name": "Demo-ACL",
"type": "acl",
"description": "Demo-ACL",
"defaultAction": {
"type": "accept"
},
"sequences": [
{
"sequenceId": 1,
"sequenceName": "Access Control List",
"baseAction": "accept",
"sequenceType": "acl",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "dscp",
"value": "46"
}
]
},
"actions": [
{
"type": "class",
"parameter": {
"ref": "89d20034-7149-4492-b392-b5c4f7903235"
}
}
]
}
]
}
},
"ZBFW definition": {
"description": "ZBFW definition",
"value": {
"name": "Demo-ZBFW",
"type": "zoneBasedFW",
"description": "Demo-ZBFW",
"definition": {
"defaultAction": {
"type": "drop"
},
"sequences": [],
"entries": [
{
"sourceZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53",
"destinationZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53"
}
]
}
}
},
"IPS definition": {
"description": "IPS definition",
"value": {
"name": "Demo-IPS-Policy",
"type": "intrusionPrevention",
"description": "Testing",
"definition": {
"signatureSet": "security",
"inspectionMode": "detection",
"signatureWhiteList": {
"ref": "ad189f08-af06-4799-97d6-0a7c7409cb8d"
},
"logLevel": "error",
"logging": [],
"targetVpns": [
"10"
]
}
}
},
"URL filtering definition": {
"description": "URL filtering definition",
"value": {
"name": "Demo-URL-Filtering-Policy",
"type": "urlFiltering",
"description": "",
"definition": {
"webCategoriesAction": "block",
"webCategories": [
"auctions",
"bot-nets"
],
"webReputation": "moderate-risk",
"urlWhiteList": {
"ref": "c20e31fb-fcea-4f48-93e3-09d2c6492d8b"
},
"urlBlackList": {
"ref": "557ed432-6cf8-495b-a445-d340d4c6236e"
},
"blockPageAction": "text",
"blockPageContents": "Access to the requested page has been denied. Please contact your Network Administrator",
"enableAlerts": true,
"alerts": [
"blacklist",
"whitelist",
"categories-reputation"
],
"logging": [],
"targetVpns": [
"10",
"20"
]
}
}
},
"AMP definition": {
"description": "AMP definition",
"value": {
"name": "Demo-AMP-Policy",
"type": "advancedMalwareProtection",
"description": "",
"definition": {
"matchAllVpn": false,
"fileReputationCloudServer": "nam",
"fileReputationEstServer": "nam",
"fileReputationAlert": "critical",
"fileAnalysisCloudServer": "",
"fileAnalysisFileTypes": [],
"fileAnalysisAlert": "",
"targetVpns": [
"10",
"20"
]
}
}
},
"DNS definition": {
"description": "DNS definition",
"value": {
"name": "Demo-DNS-Policy",
"type": "DNSSecurity",
"description": "Testing",
"definition": {
"localDomainBypassList": {
"ref": "143f753f-8d51-4be6-805d-bc330f09982f"
},
"matchAllVpn": true,
"umbrellaDefault": true,
"childOrgId": "7999118",
"localDomainBypassEnabled": true,
"dnsCrypt": true,
"umbrellaData": {
"ref": "e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa"
}
}
}
},
"HubandSpoke definition": {
"description": "HubandSpoke definition",
"value": {
"name": "Demo-Hub-n-Spoke-Policy",
"type": "hubAndSpoke",
"description": "Demo-Hub-n-Spoke-Policy",
"definition": {
"vpnList": "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf",
"subDefinitions": [
{
"name": "My Hub-and-Spoke",
"equalPreference": false,
"advertiseTloc": true,
"spokes": [
{
"siteList": "5c58c36c-9cd6-468f-8434-ee6d5801c6ba",
"hubs": [
{
"siteList": "24747ccd-4f7f-4dfa-8800-34f565fb65b4",
"preference": "20",
"prefixLists": [
"b5c4d764-20bc-4de3-9bac-52ef70f1186c"
],
"ipv6PrefixLists": []
}
]
}
],
"tlocList": "1e97c258-4323-4754-9dc0-44e9656d43bf"
}
]
}
}
},
"VPN membership group definition": {
"description": "VPN membership group definition",
"value": {
"name": "Demo-VPN-Membership-Policy",
"type": "vpnMembershipGroup",
"description": "Demo-VPN-Membership-Policy",
"definition": {
"sites": [
{
"siteList": "24747ccd-4f7f-4dfa-8800-34f565fb65b4",
"vpnList": [
"cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"
]
},
{
"siteList": "5c58c36c-9cd6-468f-8434-ee6d5801c6ba",
"vpnList": [
"cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"
]
}
]
}
}
},
"AppRoute definition": {
"description": "AppRoute definition",
"value": {
"name": "Demo-AAR-Policy",
"type": "appRoute",
"description": "Demo-AAR-Policy",
"sequences": [
{
"sequenceId": 1,
"sequenceName": "App Route",
"sequenceType": "appRoute",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "appList",
"ref": "b6752dba-969b-46de-a7e7-da11910fb1bf"
},
{
"field": "dnsAppList",
"ref": "b6752dba-969b-46de-a7e7-da11910fb1bf"
},
{
"field": "dns",
"value": "request"
},
{
"field": "dscp",
"value": "46"
},
{
"field": "plp",
"value": "high"
},
{
"field": "protocol",
"value": "6"
},
{
"field": "sourceDataPrefixList",
"ref": "6c2b7164-5de2-4775-938c-b443504324ab"
},
{
"field": "sourcePort",
"value": "1025"
},
{
"field": "destinationDataPrefixList",
"ref": "6c2b7164-5de2-4775-938c-b443504324ab"
},
{
"field": "destinationPort",
"value": "65000"
}
]
},
"actions": [
{
"type": "backupSlaPreferredColor",
"parameter": "biz-internet"
},
{
"type": "count",
"parameter": "Demo-Counter"
},
{
"type": "log",
"parameter": ""
},
{
"type": "slaClass",
"parameter": [
{
"field": "name",
"ref": "46cea5a1-1570-4921-b87a-837d590eb37e"
},
{
"field": "preferredColor",
"value": "public-internet"
},
{
"field": "strict"
}
]
}
]
},
{
"sequenceId": 11,
"sequenceName": "App Route",
"sequenceType": "appRoute",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "saasAppList",
"ref": "1e6688ce-2d21-4d7a-9a93-ae6a8ebd4a06"
}
]
},
"actions": [
{
"type": "cloudSaas",
"parameter": ""
}
]
},
{
"sequenceId": 21,
"sequenceName": "App Route",
"sequenceType": "appRoute",
"sequenceIpType": "ipv6",
"match": {
"entries": [
{
"field": "dscp",
"value": "46"
},
{
"field": "protocol",
"value": "6"
},
{
"field": "sourceIpv6",
"value": "2001::/8"
},
{
"field": "sourcePort",
"value": "65000"
},
{
"field": "destinationIpv6",
"value": "2001::/8"
},
{
"field": "destinationPort",
"value": "65000"
}
]
},
"actions": [
{
"type": "backupSlaPreferredColor",
"parameter": "biz-internet"
},
{
"type": "count",
"parameter": "Demo-Counter"
},
{
"type": "log",
"parameter": ""
},
{
"type": "slaClass",
"parameter": [
{
"field": "name",
"ref": "46cea5a1-1570-4921-b87a-837d590eb37e"
},
{
"field": "preferredColor",
"value": "public-internet"
},
{
"field": "strict"
}
]
}
]
}
]
}
},
"Data policy definition": {
"description": "Data policy definition",
"value": {
"name": "Demo-Data-Policy",
"type": "data",
"description": "Demo-Data-Policy",
"defaultAction": {
"type": "drop"
},
"sequences": [
{
"sequenceId": 1,
"sequenceName": "Custom",
"baseAction": "accept",
"sequenceType": "data",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "appList",
"ref": "b6752dba-969b-46de-a7e7-da11910fb1bf"
},
{
"field": "dnsAppList",
"ref": "b6752dba-969b-46de-a7e7-da11910fb1bf"
},
{
"field": "dns",
"value": "response"
},
{
"field": "dscp",
"value": "46"
},
{
"field": "packetLength",
"value": "1504"
},
{
"field": "plp",
"value": "high"
},
{
"field": "protocol",
"value": "6"
},
{
"field": "sourceDataPrefixList",
"ref": "6c2b7164-5de2-4775-938c-b443504324ab"
},
{
"field": "sourcePort",
"value": "65000"
},
{
"field": "destinationIp",
"value": "10.0.0.0/12"
},
{
"field": "destinationPort",
"value": "65000"
},
{
"field": "tcp",
"value": "syn"
}
]
},
"actions": [
{
"type": "count",
"parameter": "Demo-Counter"
},
{
"type": "set",
"parameter": [
{
"field": "dscp",
"value": "34"
},
{
"field": "forwardingClass",
"value": "ef-class"
},
{
"field": "localTlocList",
"value": {
"color": "public-internet",
"restrict": "",
"encap": "ipsec"
}
},
{
"field": "nextHop",
"value": "10.0.0.1"
},
{
"field": "policer",
"ref": "ecf250c7-bef0-405b-8e74-4d67440cac90"
}
]
},
{
"type": "cflowd"
},
{
"type": "log",
"parameter": ""
},
{
"type": "nat",
"parameter": {
"field": "pool",
"value": "1"
}
},
{
"type": "redirectDns",
"parameter": {
"field": "dnsType",
"value": "umbrella"
}
}
]
},
{
"sequenceId": 11,
"sequenceName": "Custom",
"baseAction": "accept",
"sequenceType": "data",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "appList",
"ref": "b6752dba-969b-46de-a7e7-da11910fb1bf"
}
]
},
"actions": [
{
"type": "set",
"parameter": [
{
"field": "service",
"value": {
"type": "FW",
"vpn": "10",
"tloc": {
"ip": "10.0.0.1",
"color": "biz-internet",
"encap": "ipsec"
}
}
}
]
},
{
"type": "tcpOptimization",
"parameter": ""
},
{
"type": "lossProtect",
"parameter": "fecAdaptive"
},
{
"type": "lossProtectFec",
"parameter": "fecAdaptive"
},
{
"type": "sig",
"parameter": ""
}
]
}
]
}
},
"CFlowd definition": {
"description": "CFlowd definition",
"value": {
"name": "Demo-cflowd-Policy",
"type": "cflowd",
"description": "Demo-cflowd-Policy",
"definition": {
"flowActiveTimeout": 3600,
"flowInactiveTimeout": 3600,
"flowSamplingInterval": 65513,
"templateRefresh": 86400,
"collectors": [
{
"vpn": "10",
"address": "10.0.0.1",
"port": 9912,
"transport": "transport_tcp",
"sourceInterface": "ge0/1"
},
{
"vpn": "20",
"address": "10.0.0.1",
"port": 1025,
"transport": "transport_udp",
"sourceInterface": "GigabitEthernet0/0/1"
}
],
"protocol": "ipv4"
}
}
},
"QoS map definition": {
"description": "QoS map definition",
"value": {
"name": "Demo-QoS-Policy",
"type": "qosMap",
"description": "Demo-QoS-Policy",
"definition": {
"qosSchedulers": [
{
"queue": "0",
"bandwidthPercent": "75",
"bufferPercent": "75",
"burst": "15000",
"scheduling": "llq",
"drops": "tail-drop",
"classMapRef": ""
},
{
"queue": "7",
"bandwidthPercent": "25",
"bufferPercent": "25",
"scheduling": "wrr",
"drops": "red-drop",
"classMapRef": "4484c444-b956-4016-bd15-538b74fc2785"
}
]
}
}
},
"VPN-QoS map definition": {
"description": "VPN-QoS map definition",
"value": {
"name": "Demo-VPN-QoS-Policy",
"type": "vpnQosMap",
"description": "Demo-VPN-QoS-Policy",
"definition": {
"vpnQosSchedulers": [
{
"vpnListRef": "",
"bandwidthRate": "100000",
"shapingRate": "120000",
"childMapRef": ""
},
{
"childMapRef": ""
}
]
}
}
},
"Rewrite rule definition": {
"description": "Rewrite rule definition",
"value": {
"name": "Demo-Rewrite-Rule",
"type": "rewriteRule",
"description": "Demo-Rewrite-Rule",
"definition": {
"rules": [
{
"class": "4484c444-b956-4016-bd15-538b74fc2785",
"plp": "low",
"dscp": "46",
"layer2Cos": "2"
}
]
}
}
},
"Device access policy definition": {
"description": "Device access policy definition",
"value": {
"name": "Demo-DeviceAccess-Policy",
"type": "deviceaccesspolicy",
"description": "Demo-DeviceAccess-Policy",
"defaultAction": {
"type": "drop"
},
"sequences": [
{
"sequenceId": 1,
"sequenceName": "Device Access Control List",
"baseAction": "accept",
"sequenceType": "deviceaccesspolicy",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "destinationPort",
"value": "22"
},
{
"field": "sourceIp",
"value": "10.10.24.0/24"
},
{
"field": "sourcePort",
"value": "65000"
},
{
"field": "destinationIp",
"value": "10.10.10.1/32"
},
{
"field": "vpn",
"value": "10"
}
]
},
"actions": []
},
{
"sequenceId": 11,
"sequenceName": "Device Access Control List",
"baseAction": "drop",
"sequenceType": "deviceaccesspolicy",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "destinationPort",
"value": "161"
},
{
"field": "sourceDataPrefixList",
"ref": "6c2b7164-5de2-4775-938c-b443504324ab"
}
]
},
"actions": []
}
]
}
},
"vEdge route definition": {
"description": "vEdge route definition",
"value": {
"name": "Demo-Route-Policy",
"type": "vedgeRoute",
"description": "Demo-Route-Policy",
"defaultAction": {
"type": "reject"
},
"sequences": [
{
"sequenceId": 1,
"sequenceName": "Route",
"baseAction": "accept",
"sequenceType": "vedgeRoute",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "address",
"ref": "b5c4d764-20bc-4de3-9bac-52ef70f1186c"
},
{
"field": "asPath",
"ref": "79f8c180-1a23-4f09-800d-62652b571258"
},
{
"field": "community",
"matchFlag": "or",
"ref": "33de059b-27ec-4a83-be28-8985128381eb"
},
{
"field": "localPreference",
"value": "200"
},
{
"field": "metric",
"value": "100"
},
{
"field": "nextHop",
"ref": "b5c4d764-20bc-4de3-9bac-52ef70f1186c"
},
{
"field": "ompTag",
"value": "10"
},
{
"field": "affinity",
"value": "10"
},
{
"field": "origin",
"value": "igp"
},
{
"field": "ospfTag",
"value": "10"
},
{
"field": "peer",
"value": "10.0.0.1"
}
]
},
"actions": [
{
"type": "set",
"parameter": [
{
"field": "asPath",
"value": {
"exclude": "120 130",
"prepend": "65521 65521"
}
},
{
"field": "localPreference",
"value": "200"
},
{
"field": "metricType",
"value": "type1"
},
{
"field": "metric",
"value": "100"
},
{
"field": "nextHop",
"value": "10.0.0.1"
},
{
"field": "ompTag",
"value": "100"
},
{
"field": "weight",
"value": "200"
},
{
"field": "ospfTag",
"value": "122"
},
{
"field": "originator",
"value": "10.0.0.1"
},
{
"field": "origin",
"value": "igp"
},
{
"field": "community",
"value": "1000:10000"
}
]
}
]
}
]
}
},
"vSmart definition": {
"description": "vSmart definition",
"value": {
"policyDescription": "Demo-Centralized-Policy",
"policyType": "feature",
"policyName": "Demo-Centralized-Policy",
"policyDefinition": {
"assembly": [
{
"definitionId": "eb0daba9-7fc4-4f4f-bae7-cd958f81f863",
"type": "cflowd",
"entries": [
{
"siteLists": [
"5c58c36c-9cd6-468f-8434-ee6d5801c6ba",
"24747ccd-4f7f-4dfa-8800-34f565fb65b4"
]
}
]
},
{
"definitionId": "3e33fa50-a30d-4586-9d69-106121feaaf4",
"type": "data",
"entries": [
{
"direction": "service",
"siteLists": [
"5c58c36c-9cd6-468f-8434-ee6d5801c6ba",
"24747ccd-4f7f-4dfa-8800-34f565fb65b4"
],
"vpnLists": [
"cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"
]
}
]
},
{
"definitionId": "8b2e7c44-2666-48a7-87a0-36a43c2d003e",
"type": "appRoute",
"entries": [
{
"siteLists": [
"5c58c36c-9cd6-468f-8434-ee6d5801c6ba",
"24747ccd-4f7f-4dfa-8800-34f565fb65b4"
],
"vpnLists": [
"cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"
]
}
]
},
{
"definitionId": "1b76052e-1cb5-44b1-8e5e-4096cb261736",
"type": "vpnMembershipGroup"
},
{
"definitionId": "62960276-c797-41fd-bebb-c017fc752f4e",
"type": "hubAndSpoke"
}
]
},
"isPolicyActivated": false
}
},
"vEdge definition": {
"description": "vEdge definition",
"value": {
"policyDescription": "Demo-Local-Policy",
"policyType": "feature",
"policyName": "Demo-Local-Policy",
"policyDefinition": {
"assembly": [
{
"definitionId": "56283dcf-6dda-4831-bcd1-d9cf62d33fdc",
"type": "qosMap"
},
{
"definitionId": "a75ead1f-f6ab-4a80-af29-79b742b31c5c",
"type": "rewriteRule"
},
{
"definitionId": "555dd393-e7b6-4861-866f-f227f5f780b7",
"type": "deviceAccessPolicy"
},
{
"definitionId": "22655824-d0df-4a8b-9be0-9808938a0e6b",
"type": "vedgeRoute"
}
],
"settings": {
"flowVisibility": true,
"flowVisibilityIPv6": true,
"appVisibility": true,
"cloudQos": true,
"cloudQosServiceSide": true,
"implicitAclLogging": true,
"appVisibilityIPv6": true
}
},
"isPolicyActivated": false
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Task Id": {
"description": "Task Id",
"value": {
"definitionId": "00f718df-4f95-4363-8639-1fe855c9eb09"
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/definition/fxsdidport/bulk": {
"put": {
"tags": [
"Configuration - Policy FXSDID Port Definition Builder"
],
"description": "Create/Edit policy definitions in bulk",
"operationId": "savePolicyDefinitionInBulk_ConfigurationPolicyFxsdidPortDefinitionBuilder_4303",
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/definition/fxsdidport/multiple/{id}": {
"put": {
"tags": [
"Configuration - Policy FXSDID Port Definition Builder"
],
"description": "Edit multiple policy definitions",
"operationId": "editMultiplePolicyDefinition_ConfigurationPolicyFxsdidPortDefinitionBuilder_5203",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/definition/fxsdidport/preview": {
"post": {
"tags": [
"Configuration - Policy FXSDID Port Definition Builder"
],
"description": "Preview policy definition",
"operationId": "previewPolicyDefinition_ConfigurationPolicyFxsdidPortDefinitionBuilder_4604",
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/definition/fxsdidport/preview/{id}": {
"get": {
"tags": [
"Configuration - Policy FXSDID Port Definition Builder"
],
"description": "Preview policy definition",
"operationId": "previewPolicyDefinitionById_ConfigurationPolicyFxsdidPortDefinitionBuilder_5103",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/definition/fxsdidport/{id}": {
"delete": {
"tags": [
"Configuration - Policy FXSDID Port Definition Builder"
],
"description": "Delete policy definition",
"operationId": "deletePolicyDefinition_ConfigurationPolicyFxsdidPortDefinitionBuilder_4306",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"get": {
"tags": [
"Configuration - Policy FXSDID Port Definition Builder"
],
"description": "Get a specific policy definitions",
"operationId": "getPolicyDefinition_ConfigurationPolicyFxsdidPortDefinitionBuilder_4303",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
},
"put": {
"tags": [
"Configuration - Policy FXSDID Port Definition Builder"
],
"description": "Edit a policy definitions",
"operationId": "editPolicyDefinition_ConfigurationPolicyFxsdidPortDefinitionBuilder_4303",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"ACL policy": {
"description": "ACL policy",
"value": {
"name": "Demo-ACL",
"type": "acl",
"description": "Demo-ACL",
"defaultAction": {
"type": "accept"
},
"sequences": [
{
"sequenceId": 1,
"sequenceName": "Access Control List",
"baseAction": "accept",
"sequenceType": "acl",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "dscp",
"value": "46"
},
{
"field": "protocol",
"value": "6"
}
]
},
"actions": [
{
"type": "class",
"parameter": {
"ref": "89d20034-7149-4492-b392-b5c4f7903235"
}
}
]
}
]
}
},
"ZBFW definition": {
"description": "ZBFW definition",
"value": {
"name": "Demo-ZBFW",
"type": "zoneBasedFW",
"description": "Demo-ZBFW",
"definition": {
"defaultAction": {
"type": "drop"
},
"sequences": [
{
"sequenceId": 1,
"sequenceName": "Demo-Rule-1",
"baseAction": "inspect",
"sequenceType": "zoneBasedFW",
"match": {
"entries": [
{
"field": "sourceDataPrefixList",
"ref": "ecbea5de-b200-4ff7-aa76-f537b5f858e9"
}
]
},
"actions": []
}
],
"entries": [
{
"sourceZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53",
"destinationZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53"
}
]
}
}
},
"IPS definition": {
"description": "IPS definition",
"value": {
"name": "Demo-IPS-Policy",
"type": "intrusionPrevention",
"description": "Testing",
"definition": {
"signatureSet": "security",
"inspectionMode": "detection",
"signatureWhiteList": {
"ref": "ad189f08-af06-4799-97d6-0a7c7409cb8d"
},
"logLevel": "error",
"logging": [],
"targetVpns": [
"10",
"20"
]
}
}
},
"URL filtering definition": {
"description": "URL filtering definition",
"value": {
"name": "Demo-URL-Filtering-Policy",
"type": "urlFiltering",
"description": "",
"definition": {
"webCategoriesAction": "block",
"webCategories": [
"auctions",
"bot-nets",
"news-and-media"
],
"webReputation": "moderate-risk",
"urlWhiteList": {
"ref": "c20e31fb-fcea-4f48-93e3-09d2c6492d8b"
},
"urlBlackList": {
"ref": "557ed432-6cf8-495b-a445-d340d4c6236e"
},
"blockPageAction": "text",
"blockPageContents": "Access to the requested page has been denied. Please contact your Network Administrator",
"enableAlerts": true,
"alerts": [
"blacklist",
"whitelist",
"categories-reputation"
],
"logging": [],
"targetVpns": [
"30"
]
}
}
},
"AMP definition": {
"description": "AMP definition",
"value": {
"name": "Demo-AMP-Policy",
"type": "advancedMalwareProtection",
"description": "",
"definition": {
"matchAllVpn": true,
"fileReputationCloudServer": "nam",
"fileReputationEstServer": "nam",
"fileReputationAlert": "critical",
"fileAnalysisCloudServer": "nam",
"fileAnalysisFileTypes": [
"pdf",
"ms-exe"
],
"fileAnalysisAlert": "critical",
"targetVpns": [
"10",
"20"
],
"fileAnalysisEnabled": true
}
}
},
"DNS definition": {
"description": "DNS definition",
"value": {
"name": "Demo-DNS-Policy",
"type": "DNSSecurity",
"description": "Testing",
"definition": {
"localDomainBypassList": {
"ref": "143f753f-8d51-4be6-805d-bc330f09982f"
},
"matchAllVpn": false,
"targetVpns": [
{
"vpns": [
"10"
],
"umbrellaDefault": false,
"childOrgId": "7999118",
"dnsServerIP": "10.10.10.1",
"localDomainBypassEnabled": true
}
],
"dnsCrypt": true,
"umbrellaData": {
"ref": "e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa"
}
}
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {
"masterTemplatesAffected": []
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/definition/fxsport": {
"get": {
"tags": [
"Configuration - Policy FXS Port Definition Builder"
],
"description": "Get policy definitions",
"operationId": "getDefinitions_ConfigurationPolicyFxsPortDefinitionBuilder_3503",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
},
"post": {
"tags": [
"Configuration - Policy FXS Port Definition Builder"
],
"description": "Create policy definition",
"operationId": "createPolicyDefinition_ConfigurationPolicyFxsPortDefinitionBuilder_3504",
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"ACL policy": {
"description": "ACL policy",
"value": {
"name": "Demo-ACL",
"type": "acl",
"description": "Demo-ACL",
"defaultAction": {
"type": "accept"
},
"sequences": [
{
"sequenceId": 1,
"sequenceName": "Access Control List",
"baseAction": "accept",
"sequenceType": "acl",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "dscp",
"value": "46"
}
]
},
"actions": [
{
"type": "class",
"parameter": {
"ref": "89d20034-7149-4492-b392-b5c4f7903235"
}
}
]
}
]
}
},
"ZBFW definition": {
"description": "ZBFW definition",
"value": {
"name": "Demo-ZBFW",
"type": "zoneBasedFW",
"description": "Demo-ZBFW",
"definition": {
"defaultAction": {
"type": "drop"
},
"sequences": [],
"entries": [
{
"sourceZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53",
"destinationZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53"
}
]
}
}
},
"IPS definition": {
"description": "IPS definition",
"value": {
"name": "Demo-IPS-Policy",
"type": "intrusionPrevention",
"description": "Testing",
"definition": {
"signatureSet": "security",
"inspectionMode": "detection",
"signatureWhiteList": {
"ref": "ad189f08-af06-4799-97d6-0a7c7409cb8d"
},
"logLevel": "error",
"logging": [],
"targetVpns": [
"10"
]
}
}
},
"URL filtering definition": {
"description": "URL filtering definition",
"value": {
"name": "Demo-URL-Filtering-Policy",
"type": "urlFiltering",
"description": "",
"definition": {
"webCategoriesAction": "block",
"webCategories": [
"auctions",
"bot-nets"
],
"webReputation": "moderate-risk",
"urlWhiteList": {
"ref": "c20e31fb-fcea-4f48-93e3-09d2c6492d8b"
},
"urlBlackList": {
"ref": "557ed432-6cf8-495b-a445-d340d4c6236e"
},
"blockPageAction": "text",
"blockPageContents": "Access to the requested page has been denied. Please contact your Network Administrator",
"enableAlerts": true,
"alerts": [
"blacklist",
"whitelist",
"categories-reputation"
],
"logging": [],
"targetVpns": [
"10",
"20"
]
}
}
},
"AMP definition": {
"description": "AMP definition",
"value": {
"name": "Demo-AMP-Policy",
"type": "advancedMalwareProtection",
"description": "",
"definition": {
"matchAllVpn": false,
"fileReputationCloudServer": "nam",
"fileReputationEstServer": "nam",
"fileReputationAlert": "critical",
"fileAnalysisCloudServer": "",
"fileAnalysisFileTypes": [],
"fileAnalysisAlert": "",
"targetVpns": [
"10",
"20"
]
}
}
},
"DNS definition": {
"description": "DNS definition",
"value": {
"name": "Demo-DNS-Policy",
"type": "DNSSecurity",
"description": "Testing",
"definition": {
"localDomainBypassList": {
"ref": "143f753f-8d51-4be6-805d-bc330f09982f"
},
"matchAllVpn": true,
"umbrellaDefault": true,
"childOrgId": "7999118",
"localDomainBypassEnabled": true,
"dnsCrypt": true,
"umbrellaData": {
"ref": "e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa"
}
}
}
},
"HubandSpoke definition": {
"description": "HubandSpoke definition",
"value": {
"name": "Demo-Hub-n-Spoke-Policy",
"type": "hubAndSpoke",
"description": "Demo-Hub-n-Spoke-Policy",
"definition": {
"vpnList": "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf",
"subDefinitions": [
{
"name": "My Hub-and-Spoke",
"equalPreference": false,
"advertiseTloc": true,
"spokes": [
{
"siteList": "5c58c36c-9cd6-468f-8434-ee6d5801c6ba",
"hubs": [
{
"siteList": "24747ccd-4f7f-4dfa-8800-34f565fb65b4",
"preference": "20",
"prefixLists": [
"b5c4d764-20bc-4de3-9bac-52ef70f1186c"
],
"ipv6PrefixLists": []
}
]
}
],
"tlocList": "1e97c258-4323-4754-9dc0-44e9656d43bf"
}
]
}
}
},
"VPN membership group definition": {
"description": "VPN membership group definition",
"value": {
"name": "Demo-VPN-Membership-Policy",
"type": "vpnMembershipGroup",
"description": "Demo-VPN-Membership-Policy",
"definition": {
"sites": [
{
"siteList": "24747ccd-4f7f-4dfa-8800-34f565fb65b4",
"vpnList": [
"cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"
]
},
{
"siteList": "5c58c36c-9cd6-468f-8434-ee6d5801c6ba",
"vpnList": [
"cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"
]
}
]
}
}
},
"AppRoute definition": {
"description": "AppRoute definition",
"value": {
"name": "Demo-AAR-Policy",
"type": "appRoute",
"description": "Demo-AAR-Policy",
"sequences": [
{
"sequenceId": 1,
"sequenceName": "App Route",
"sequenceType": "appRoute",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "appList",
"ref": "b6752dba-969b-46de-a7e7-da11910fb1bf"
},
{
"field": "dnsAppList",
"ref": "b6752dba-969b-46de-a7e7-da11910fb1bf"
},
{
"field": "dns",
"value": "request"
},
{
"field": "dscp",
"value": "46"
},
{
"field": "plp",
"value": "high"
},
{
"field": "protocol",
"value": "6"
},
{
"field": "sourceDataPrefixList",
"ref": "6c2b7164-5de2-4775-938c-b443504324ab"
},
{
"field": "sourcePort",
"value": "1025"
},
{
"field": "destinationDataPrefixList",
"ref": "6c2b7164-5de2-4775-938c-b443504324ab"
},
{
"field": "destinationPort",
"value": "65000"
}
]
},
"actions": [
{
"type": "backupSlaPreferredColor",
"parameter": "biz-internet"
},
{
"type": "count",
"parameter": "Demo-Counter"
},
{
"type": "log",
"parameter": ""
},
{
"type": "slaClass",
"parameter": [
{
"field": "name",
"ref": "46cea5a1-1570-4921-b87a-837d590eb37e"
},
{
"field": "preferredColor",
"value": "public-internet"
},
{
"field": "strict"
}
]
}
]
},
{
"sequenceId": 11,
"sequenceName": "App Route",
"sequenceType": "appRoute",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "saasAppList",
"ref": "1e6688ce-2d21-4d7a-9a93-ae6a8ebd4a06"
}
]
},
"actions": [
{
"type": "cloudSaas",
"parameter": ""
}
]
},
{
"sequenceId": 21,
"sequenceName": "App Route",
"sequenceType": "appRoute",
"sequenceIpType": "ipv6",
"match": {
"entries": [
{
"field": "dscp",
"value": "46"
},
{
"field": "protocol",
"value": "6"
},
{
"field": "sourceIpv6",
"value": "2001::/8"
},
{
"field": "sourcePort",
"value": "65000"
},
{
"field": "destinationIpv6",
"value": "2001::/8"
},
{
"field": "destinationPort",
"value": "65000"
}
]
},
"actions": [
{
"type": "backupSlaPreferredColor",
"parameter": "biz-internet"
},
{
"type": "count",
"parameter": "Demo-Counter"
},
{
"type": "log",
"parameter": ""
},
{
"type": "slaClass",
"parameter": [
{
"field": "name",
"ref": "46cea5a1-1570-4921-b87a-837d590eb37e"
},
{
"field": "preferredColor",
"value": "public-internet"
},
{
"field": "strict"
}
]
}
]
}
]
}
},
"Data policy definition": {
"description": "Data policy definition",
"value": {
"name": "Demo-Data-Policy",
"type": "data",
"description": "Demo-Data-Policy",
"defaultAction": {
"type": "drop"
},
"sequences": [
{
"sequenceId": 1,
"sequenceName": "Custom",
"baseAction": "accept",
"sequenceType": "data",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "appList",
"ref": "b6752dba-969b-46de-a7e7-da11910fb1bf"
},
{
"field": "dnsAppList",
"ref": "b6752dba-969b-46de-a7e7-da11910fb1bf"
},
{
"field": "dns",
"value": "response"
},
{
"field": "dscp",
"value": "46"
},
{
"field": "packetLength",
"value": "1504"
},
{
"field": "plp",
"value": "high"
},
{
"field": "protocol",
"value": "6"
},
{
"field": "sourceDataPrefixList",
"ref": "6c2b7164-5de2-4775-938c-b443504324ab"
},
{
"field": "sourcePort",
"value": "65000"
},
{
"field": "destinationIp",
"value": "10.0.0.0/12"
},
{
"field": "destinationPort",
"value": "65000"
},
{
"field": "tcp",
"value": "syn"
}
]
},
"actions": [
{
"type": "count",
"parameter": "Demo-Counter"
},
{
"type": "set",
"parameter": [
{
"field": "dscp",
"value": "34"
},
{
"field": "forwardingClass",
"value": "ef-class"
},
{
"field": "localTlocList",
"value": {
"color": "public-internet",
"restrict": "",
"encap": "ipsec"
}
},
{
"field": "nextHop",
"value": "10.0.0.1"
},
{
"field": "policer",
"ref": "ecf250c7-bef0-405b-8e74-4d67440cac90"
}
]
},
{
"type": "cflowd"
},
{
"type": "log",
"parameter": ""
},
{
"type": "nat",
"parameter": {
"field": "pool",
"value": "1"
}
},
{
"type": "redirectDns",
"parameter": {
"field": "dnsType",
"value": "umbrella"
}
}
]
},
{
"sequenceId": 11,
"sequenceName": "Custom",
"baseAction": "accept",
"sequenceType": "data",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "appList",
"ref": "b6752dba-969b-46de-a7e7-da11910fb1bf"
}
]
},
"actions": [
{
"type": "set",
"parameter": [
{
"field": "service",
"value": {
"type": "FW",
"vpn": "10",
"tloc": {
"ip": "10.0.0.1",
"color": "biz-internet",
"encap": "ipsec"
}
}
}
]
},
{
"type": "tcpOptimization",
"parameter": ""
},
{
"type": "lossProtect",
"parameter": "fecAdaptive"
},
{
"type": "lossProtectFec",
"parameter": "fecAdaptive"
},
{
"type": "sig",
"parameter": ""
}
]
}
]
}
},
"CFlowd definition": {
"description": "CFlowd definition",
"value": {
"name": "Demo-cflowd-Policy",
"type": "cflowd",
"description": "Demo-cflowd-Policy",
"definition": {
"flowActiveTimeout": 3600,
"flowInactiveTimeout": 3600,
"flowSamplingInterval": 65513,
"templateRefresh": 86400,
"collectors": [
{
"vpn": "10",
"address": "10.0.0.1",
"port": 9912,
"transport": "transport_tcp",
"sourceInterface": "ge0/1"
},
{
"vpn": "20",
"address": "10.0.0.1",
"port": 1025,
"transport": "transport_udp",
"sourceInterface": "GigabitEthernet0/0/1"
}
],
"protocol": "ipv4"
}
}
},
"QoS map definition": {
"description": "QoS map definition",
"value": {
"name": "Demo-QoS-Policy",
"type": "qosMap",
"description": "Demo-QoS-Policy",
"definition": {
"qosSchedulers": [
{
"queue": "0",
"bandwidthPercent": "75",
"bufferPercent": "75",
"burst": "15000",
"scheduling": "llq",
"drops": "tail-drop",
"classMapRef": ""
},
{
"queue": "7",
"bandwidthPercent": "25",
"bufferPercent": "25",
"scheduling": "wrr",
"drops": "red-drop",
"classMapRef": "4484c444-b956-4016-bd15-538b74fc2785"
}
]
}
}
},
"VPN-QoS map definition": {
"description": "VPN-QoS map definition",
"value": {
"name": "Demo-VPN-QoS-Policy",
"type": "vpnQosMap",
"description": "Demo-VPN-QoS-Policy",
"definition": {
"vpnQosSchedulers": [
{
"vpnListRef": "",
"bandwidthRate": "100000",
"shapingRate": "120000",
"childMapRef": ""
},
{
"childMapRef": ""
}
]
}
}
},
"Rewrite rule definition": {
"description": "Rewrite rule definition",
"value": {
"name": "Demo-Rewrite-Rule",
"type": "rewriteRule",
"description": "Demo-Rewrite-Rule",
"definition": {
"rules": [
{
"class": "4484c444-b956-4016-bd15-538b74fc2785",
"plp": "low",
"dscp": "46",
"layer2Cos": "2"
}
]
}
}
},
"Device access policy definition": {
"description": "Device access policy definition",
"value": {
"name": "Demo-DeviceAccess-Policy",
"type": "deviceaccesspolicy",
"description": "Demo-DeviceAccess-Policy",
"defaultAction": {
"type": "drop"
},
"sequences": [
{
"sequenceId": 1,
"sequenceName": "Device Access Control List",
"baseAction": "accept",
"sequenceType": "deviceaccesspolicy",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "destinationPort",
"value": "22"
},
{
"field": "sourceIp",
"value": "10.10.24.0/24"
},
{
"field": "sourcePort",
"value": "65000"
},
{
"field": "destinationIp",
"value": "10.10.10.1/32"
},
{
"field": "vpn",
"value": "10"
}
]
},
"actions": []
},
{
"sequenceId": 11,
"sequenceName": "Device Access Control List",
"baseAction": "drop",
"sequenceType": "deviceaccesspolicy",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "destinationPort",
"value": "161"
},
{
"field": "sourceDataPrefixList",
"ref": "6c2b7164-5de2-4775-938c-b443504324ab"
}
]
},
"actions": []
}
]
}
},
"vEdge route definition": {
"description": "vEdge route definition",
"value": {
"name": "Demo-Route-Policy",
"type": "vedgeRoute",
"description": "Demo-Route-Policy",
"defaultAction": {
"type": "reject"
},
"sequences": [
{
"sequenceId": 1,
"sequenceName": "Route",
"baseAction": "accept",
"sequenceType": "vedgeRoute",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "address",
"ref": "b5c4d764-20bc-4de3-9bac-52ef70f1186c"
},
{
"field": "asPath",
"ref": "79f8c180-1a23-4f09-800d-62652b571258"
},
{
"field": "community",
"matchFlag": "or",
"ref": "33de059b-27ec-4a83-be28-8985128381eb"
},
{
"field": "localPreference",
"value": "200"
},
{
"field": "metric",
"value": "100"
},
{
"field": "nextHop",
"ref": "b5c4d764-20bc-4de3-9bac-52ef70f1186c"
},
{
"field": "ompTag",
"value": "10"
},
{
"field": "affinity",
"value": "10"
},
{
"field": "origin",
"value": "igp"
},
{
"field": "ospfTag",
"value": "10"
},
{
"field": "peer",
"value": "10.0.0.1"
}
]
},
"actions": [
{
"type": "set",
"parameter": [
{
"field": "asPath",
"value": {
"exclude": "120 130",
"prepend": "65521 65521"
}
},
{
"field": "localPreference",
"value": "200"
},
{
"field": "metricType",
"value": "type1"
},
{
"field": "metric",
"value": "100"
},
{
"field": "nextHop",
"value": "10.0.0.1"
},
{
"field": "ompTag",
"value": "100"
},
{
"field": "weight",
"value": "200"
},
{
"field": "ospfTag",
"value": "122"
},
{
"field": "originator",
"value": "10.0.0.1"
},
{
"field": "origin",
"value": "igp"
},
{
"field": "community",
"value": "1000:10000"
}
]
}
]
}
]
}
},
"vSmart definition": {
"description": "vSmart definition",
"value": {
"policyDescription": "Demo-Centralized-Policy",
"policyType": "feature",
"policyName": "Demo-Centralized-Policy",
"policyDefinition": {
"assembly": [
{
"definitionId": "eb0daba9-7fc4-4f4f-bae7-cd958f81f863",
"type": "cflowd",
"entries": [
{
"siteLists": [
"5c58c36c-9cd6-468f-8434-ee6d5801c6ba",
"24747ccd-4f7f-4dfa-8800-34f565fb65b4"
]
}
]
},
{
"definitionId": "3e33fa50-a30d-4586-9d69-106121feaaf4",
"type": "data",
"entries": [
{
"direction": "service",
"siteLists": [
"5c58c36c-9cd6-468f-8434-ee6d5801c6ba",
"24747ccd-4f7f-4dfa-8800-34f565fb65b4"
],
"vpnLists": [
"cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"
]
}
]
},
{
"definitionId": "8b2e7c44-2666-48a7-87a0-36a43c2d003e",
"type": "appRoute",
"entries": [
{
"siteLists": [
"5c58c36c-9cd6-468f-8434-ee6d5801c6ba",
"24747ccd-4f7f-4dfa-8800-34f565fb65b4"
],
"vpnLists": [
"cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"
]
}
]
},
{
"definitionId": "1b76052e-1cb5-44b1-8e5e-4096cb261736",
"type": "vpnMembershipGroup"
},
{
"definitionId": "62960276-c797-41fd-bebb-c017fc752f4e",
"type": "hubAndSpoke"
}
]
},
"isPolicyActivated": false
}
},
"vEdge definition": {
"description": "vEdge definition",
"value": {
"policyDescription": "Demo-Local-Policy",
"policyType": "feature",
"policyName": "Demo-Local-Policy",
"policyDefinition": {
"assembly": [
{
"definitionId": "56283dcf-6dda-4831-bcd1-d9cf62d33fdc",
"type": "qosMap"
},
{
"definitionId": "a75ead1f-f6ab-4a80-af29-79b742b31c5c",
"type": "rewriteRule"
},
{
"definitionId": "555dd393-e7b6-4861-866f-f227f5f780b7",
"type": "deviceAccessPolicy"
},
{
"definitionId": "22655824-d0df-4a8b-9be0-9808938a0e6b",
"type": "vedgeRoute"
}
],
"settings": {
"flowVisibility": true,
"flowVisibilityIPv6": true,
"appVisibility": true,
"cloudQos": true,
"cloudQosServiceSide": true,
"implicitAclLogging": true,
"appVisibilityIPv6": true
}
},
"isPolicyActivated": false
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Task Id": {
"description": "Task Id",
"value": {
"definitionId": "00f718df-4f95-4363-8639-1fe855c9eb09"
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/definition/fxsport/bulk": {
"put": {
"tags": [
"Configuration - Policy FXS Port Definition Builder"
],
"description": "Create/Edit policy definitions in bulk",
"operationId": "savePolicyDefinitionInBulk_ConfigurationPolicyFxsPortDefinitionBuilder_4003",
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/definition/fxsport/multiple/{id}": {
"put": {
"tags": [
"Configuration - Policy FXS Port Definition Builder"
],
"description": "Edit multiple policy definitions",
"operationId": "editMultiplePolicyDefinition_ConfigurationPolicyFxsPortDefinitionBuilder_4903",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/definition/fxsport/preview": {
"post": {
"tags": [
"Configuration - Policy FXS Port Definition Builder"
],
"description": "Preview policy definition",
"operationId": "previewPolicyDefinition_ConfigurationPolicyFxsPortDefinitionBuilder_4304",
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/definition/fxsport/preview/{id}": {
"get": {
"tags": [
"Configuration - Policy FXS Port Definition Builder"
],
"description": "Preview policy definition",
"operationId": "previewPolicyDefinitionById_ConfigurationPolicyFxsPortDefinitionBuilder_4803",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/definition/fxsport/{id}": {
"get": {
"tags": [
"Configuration - Policy FXS Port Definition Builder"
],
"description": "Get a specific policy definitions",
"operationId": "getPolicyDefinition_ConfigurationPolicyFxsPortDefinitionBuilder_4003",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
},
"put": {
"tags": [
"Configuration - Policy FXS Port Definition Builder"
],
"description": "Edit a policy definitions",
"operationId": "editPolicyDefinition_ConfigurationPolicyFxsPortDefinitionBuilder_4003",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"ACL policy": {
"description": "ACL policy",
"value": {
"name": "Demo-ACL",
"type": "acl",
"description": "Demo-ACL",
"defaultAction": {
"type": "accept"
},
"sequences": [
{
"sequenceId": 1,
"sequenceName": "Access Control List",
"baseAction": "accept",
"sequenceType": "acl",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "dscp",
"value": "46"
},
{
"field": "protocol",
"value": "6"
}
]
},
"actions": [
{
"type": "class",
"parameter": {
"ref": "89d20034-7149-4492-b392-b5c4f7903235"
}
}
]
}
]
}
},
"ZBFW definition": {
"description": "ZBFW definition",
"value": {
"name": "Demo-ZBFW",
"type": "zoneBasedFW",
"description": "Demo-ZBFW",
"definition": {
"defaultAction": {
"type": "drop"
},
"sequences": [
{
"sequenceId": 1,
"sequenceName": "Demo-Rule-1",
"baseAction": "inspect",
"sequenceType": "zoneBasedFW",
"match": {
"entries": [
{
"field": "sourceDataPrefixList",
"ref": "ecbea5de-b200-4ff7-aa76-f537b5f858e9"
}
]
},
"actions": []
}
],
"entries": [
{
"sourceZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53",
"destinationZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53"
}
]
}
}
},
"IPS definition": {
"description": "IPS definition",
"value": {
"name": "Demo-IPS-Policy",
"type": "intrusionPrevention",
"description": "Testing",
"definition": {
"signatureSet": "security",
"inspectionMode": "detection",
"signatureWhiteList": {
"ref": "ad189f08-af06-4799-97d6-0a7c7409cb8d"
},
"logLevel": "error",
"logging": [],
"targetVpns": [
"10",
"20"
]
}
}
},
"URL filtering definition": {
"description": "URL filtering definition",
"value": {
"name": "Demo-URL-Filtering-Policy",
"type": "urlFiltering",
"description": "",
"definition": {
"webCategoriesAction": "block",
"webCategories": [
"auctions",
"bot-nets",
"news-and-media"
],
"webReputation": "moderate-risk",
"urlWhiteList": {
"ref": "c20e31fb-fcea-4f48-93e3-09d2c6492d8b"
},
"urlBlackList": {
"ref": "557ed432-6cf8-495b-a445-d340d4c6236e"
},
"blockPageAction": "text",
"blockPageContents": "Access to the requested page has been denied. Please contact your Network Administrator",
"enableAlerts": true,
"alerts": [
"blacklist",
"whitelist",
"categories-reputation"
],
"logging": [],
"targetVpns": [
"30"
]
}
}
},
"AMP definition": {
"description": "AMP definition",
"value": {
"name": "Demo-AMP-Policy",
"type": "advancedMalwareProtection",
"description": "",
"definition": {
"matchAllVpn": true,
"fileReputationCloudServer": "nam",
"fileReputationEstServer": "nam",
"fileReputationAlert": "critical",
"fileAnalysisCloudServer": "nam",
"fileAnalysisFileTypes": [
"pdf",
"ms-exe"
],
"fileAnalysisAlert": "critical",
"targetVpns": [
"10",
"20"
],
"fileAnalysisEnabled": true
}
}
},
"DNS definition": {
"description": "DNS definition",
"value": {
"name": "Demo-DNS-Policy",
"type": "DNSSecurity",
"description": "Testing",
"definition": {
"localDomainBypassList": {
"ref": "143f753f-8d51-4be6-805d-bc330f09982f"
},
"matchAllVpn": false,
"targetVpns": [
{
"vpns": [
"10"
],
"umbrellaDefault": false,
"childOrgId": "7999118",
"dnsServerIP": "10.10.10.1",
"localDomainBypassEnabled": true
}
],
"dnsCrypt": true,
"umbrellaData": {
"ref": "e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa"
}
}
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {
"masterTemplatesAffected": []
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"delete": {
"tags": [
"Configuration - Policy FXS Port Definition Builder"
],
"description": "Delete policy definition",
"operationId": "deletePolicyDefinition_ConfigurationPolicyFxsPortDefinitionBuilder_4006",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/definition/hubandspoke": {
"post": {
"tags": [
"Configuration - Policy Hub and Spoke Definition Builder"
],
"description": "Create policy definition",
"operationId": "createPolicyDefinition_ConfigurationPolicyHubSpokeDefinitionBuilder_3904",
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Topology Policy-write,Policy Configuration-write"
},
"get": {
"tags": [
"Configuration - Policy Hub and Spoke Definition Builder"
],
"description": "Get policy definitions",
"operationId": "getDefinitions_ConfigurationPolicyHubSpokeDefinitionBuilder_3903",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Topology Policy-read,Topology Policy-write"
}
},
"/template/policy/definition/hubandspoke/bulk": {
"put": {
"tags": [
"Configuration - Policy Hub and Spoke Definition Builder"
],
"description": "Create/Edit policy definitions in bulk",
"operationId": "savePolicyDefinitionInBulk_ConfigurationPolicyHubSpokeDefinitionBuilder_4403",
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/definition/hubandspoke/multiple/{id}": {
"put": {
"tags": [
"Configuration - Policy Hub and Spoke Definition Builder"
],
"description": "Edit multiple policy definitions",
"operationId": "editMultiplePolicyDefinition_ConfigurationPolicyHubSpokeDefinitionBuilder_5303",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/definition/hubandspoke/preview": {
"post": {
"tags": [
"Configuration - Policy Hub and Spoke Definition Builder"
],
"description": "Preview policy definition",
"operationId": "previewPolicyDefinition_ConfigurationPolicyHubSpokeDefinitionBuilder_4704",
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/definition/hubandspoke/preview/{id}": {
"get": {
"tags": [
"Configuration - Policy Hub and Spoke Definition Builder"
],
"description": "Preview policy definition",
"operationId": "previewPolicyDefinitionById_ConfigurationPolicyHubSpokeDefinitionBuilder_5203",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/definition/hubandspoke/{id}": {
"get": {
"tags": [
"Configuration - Policy Hub and Spoke Definition Builder"
],
"description": "Get a specific policy definitions",
"operationId": "getPolicyDefinition_ConfigurationPolicyHubSpokeDefinitionBuilder_4403",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Topology Policy-read,Topology Policy-write"
},
"put": {
"tags": [
"Configuration - Policy Hub and Spoke Definition Builder"
],
"description": "Edit a policy definitions",
"operationId": "editPolicyDefinition_ConfigurationPolicyHubSpokeDefinitionBuilder_4403",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Topology Policy-write,Policy Configuration-write"
},
"delete": {
"tags": [
"Configuration - Policy Hub and Spoke Definition Builder"
],
"description": "Delete policy definition",
"operationId": "deletePolicyDefinition_ConfigurationPolicyHubSpokeDefinitionBuilder_4406",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Topology Policy-write,Policy Configuration-write"
}
},
"/template/policy/definition/intrusionprevention": {
"get": {
"tags": [
"Configuration - Policy Intrusion Prevention Definition Builder"
],
"description": "Get policy definitions",
"operationId": "getDefinitions_ConfigurationPolicyIntrusionPreventionDefinitionBuilder_4703",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
},
"post": {
"tags": [
"Configuration - Policy Intrusion Prevention Definition Builder"
],
"description": "Create policy definition",
"operationId": "createPolicyDefinition_ConfigurationPolicyIntrusionPreventionDefinitionBuilder_4704",
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"ACL policy": {
"description": "ACL policy",
"value": {
"name": "Demo-ACL",
"type": "acl",
"description": "Demo-ACL",
"defaultAction": {
"type": "accept"
},
"sequences": [
{
"sequenceId": 1,
"sequenceName": "Access Control List",
"baseAction": "accept",
"sequenceType": "acl",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "dscp",
"value": "46"
}
]
},
"actions": [
{
"type": "class",
"parameter": {
"ref": "89d20034-7149-4492-b392-b5c4f7903235"
}
}
]
}
]
}
},
"ZBFW definition": {
"description": "ZBFW definition",
"value": {
"name": "Demo-ZBFW",
"type": "zoneBasedFW",
"description": "Demo-ZBFW",
"definition": {
"defaultAction": {
"type": "drop"
},
"sequences": [],
"entries": [
{
"sourceZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53",
"destinationZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53"
}
]
}
}
},
"IPS definition": {
"description": "IPS definition",
"value": {
"name": "Demo-IPS-Policy",
"type": "intrusionPrevention",
"description": "Testing",
"definition": {
"signatureSet": "security",
"inspectionMode": "detection",
"signatureWhiteList": {
"ref": "ad189f08-af06-4799-97d6-0a7c7409cb8d"
},
"logLevel": "error",
"logging": [],
"targetVpns": [
"10"
]
}
}
},
"URL filtering definition": {
"description": "URL filtering definition",
"value": {
"name": "Demo-URL-Filtering-Policy",
"type": "urlFiltering",
"description": "",
"definition": {
"webCategoriesAction": "block",
"webCategories": [
"auctions",
"bot-nets"
],
"webReputation": "moderate-risk",
"urlWhiteList": {
"ref": "c20e31fb-fcea-4f48-93e3-09d2c6492d8b"
},
"urlBlackList": {
"ref": "557ed432-6cf8-495b-a445-d340d4c6236e"
},
"blockPageAction": "text",
"blockPageContents": "Access to the requested page has been denied. Please contact your Network Administrator",
"enableAlerts": true,
"alerts": [
"blacklist",
"whitelist",
"categories-reputation"
],
"logging": [],
"targetVpns": [
"10",
"20"
]
}
}
},
"AMP definition": {
"description": "AMP definition",
"value": {
"name": "Demo-AMP-Policy",
"type": "advancedMalwareProtection",
"description": "",
"definition": {
"matchAllVpn": false,
"fileReputationCloudServer": "nam",
"fileReputationEstServer": "nam",
"fileReputationAlert": "critical",
"fileAnalysisCloudServer": "",
"fileAnalysisFileTypes": [],
"fileAnalysisAlert": "",
"targetVpns": [
"10",
"20"
]
}
}
},
"DNS definition": {
"description": "DNS definition",
"value": {
"name": "Demo-DNS-Policy",
"type": "DNSSecurity",
"description": "Testing",
"definition": {
"localDomainBypassList": {
"ref": "143f753f-8d51-4be6-805d-bc330f09982f"
},
"matchAllVpn": true,
"umbrellaDefault": true,
"childOrgId": "7999118",
"localDomainBypassEnabled": true,
"dnsCrypt": true,
"umbrellaData": {
"ref": "e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa"
}
}
}
},
"HubandSpoke definition": {
"description": "HubandSpoke definition",
"value": {
"name": "Demo-Hub-n-Spoke-Policy",
"type": "hubAndSpoke",
"description": "Demo-Hub-n-Spoke-Policy",
"definition": {
"vpnList": "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf",
"subDefinitions": [
{
"name": "My Hub-and-Spoke",
"equalPreference": false,
"advertiseTloc": true,
"spokes": [
{
"siteList": "5c58c36c-9cd6-468f-8434-ee6d5801c6ba",
"hubs": [
{
"siteList": "24747ccd-4f7f-4dfa-8800-34f565fb65b4",
"preference": "20",
"prefixLists": [
"b5c4d764-20bc-4de3-9bac-52ef70f1186c"
],
"ipv6PrefixLists": []
}
]
}
],
"tlocList": "1e97c258-4323-4754-9dc0-44e9656d43bf"
}
]
}
}
},
"VPN membership group definition": {
"description": "VPN membership group definition",
"value": {
"name": "Demo-VPN-Membership-Policy",
"type": "vpnMembershipGroup",
"description": "Demo-VPN-Membership-Policy",
"definition": {
"sites": [
{
"siteList": "24747ccd-4f7f-4dfa-8800-34f565fb65b4",
"vpnList": [
"cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"
]
},
{
"siteList": "5c58c36c-9cd6-468f-8434-ee6d5801c6ba",
"vpnList": [
"cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"
]
}
]
}
}
},
"AppRoute definition": {
"description": "AppRoute definition",
"value": {
"name": "Demo-AAR-Policy",
"type": "appRoute",
"description": "Demo-AAR-Policy",
"sequences": [
{
"sequenceId": 1,
"sequenceName": "App Route",
"sequenceType": "appRoute",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "appList",
"ref": "b6752dba-969b-46de-a7e7-da11910fb1bf"
},
{
"field": "dnsAppList",
"ref": "b6752dba-969b-46de-a7e7-da11910fb1bf"
},
{
"field": "dns",
"value": "request"
},
{
"field": "dscp",
"value": "46"
},
{
"field": "plp",
"value": "high"
},
{
"field": "protocol",
"value": "6"
},
{
"field": "sourceDataPrefixList",
"ref": "6c2b7164-5de2-4775-938c-b443504324ab"
},
{
"field": "sourcePort",
"value": "1025"
},
{
"field": "destinationDataPrefixList",
"ref": "6c2b7164-5de2-4775-938c-b443504324ab"
},
{
"field": "destinationPort",
"value": "65000"
}
]
},
"actions": [
{
"type": "backupSlaPreferredColor",
"parameter": "biz-internet"
},
{
"type": "count",
"parameter": "Demo-Counter"
},
{
"type": "log",
"parameter": ""
},
{
"type": "slaClass",
"parameter": [
{
"field": "name",
"ref": "46cea5a1-1570-4921-b87a-837d590eb37e"
},
{
"field": "preferredColor",
"value": "public-internet"
},
{
"field": "strict"
}
]
}
]
},
{
"sequenceId": 11,
"sequenceName": "App Route",
"sequenceType": "appRoute",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "saasAppList",
"ref": "1e6688ce-2d21-4d7a-9a93-ae6a8ebd4a06"
}
]
},
"actions": [
{
"type": "cloudSaas",
"parameter": ""
}
]
},
{
"sequenceId": 21,
"sequenceName": "App Route",
"sequenceType": "appRoute",
"sequenceIpType": "ipv6",
"match": {
"entries": [
{
"field": "dscp",
"value": "46"
},
{
"field": "protocol",
"value": "6"
},
{
"field": "sourceIpv6",
"value": "2001::/8"
},
{
"field": "sourcePort",
"value": "65000"
},
{
"field": "destinationIpv6",
"value": "2001::/8"
},
{
"field": "destinationPort",
"value": "65000"
}
]
},
"actions": [
{
"type": "backupSlaPreferredColor",
"parameter": "biz-internet"
},
{
"type": "count",
"parameter": "Demo-Counter"
},
{
"type": "log",
"parameter": ""
},
{
"type": "slaClass",
"parameter": [
{
"field": "name",
"ref": "46cea5a1-1570-4921-b87a-837d590eb37e"
},
{
"field": "preferredColor",
"value": "public-internet"
},
{
"field": "strict"
}
]
}
]
}
]
}
},
"Data policy definition": {
"description": "Data policy definition",
"value": {
"name": "Demo-Data-Policy",
"type": "data",
"description": "Demo-Data-Policy",
"defaultAction": {
"type": "drop"
},
"sequences": [
{
"sequenceId": 1,
"sequenceName": "Custom",
"baseAction": "accept",
"sequenceType": "data",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "appList",
"ref": "b6752dba-969b-46de-a7e7-da11910fb1bf"
},
{
"field": "dnsAppList",
"ref": "b6752dba-969b-46de-a7e7-da11910fb1bf"
},
{
"field": "dns",
"value": "response"
},
{
"field": "dscp",
"value": "46"
},
{
"field": "packetLength",
"value": "1504"
},
{
"field": "plp",
"value": "high"
},
{
"field": "protocol",
"value": "6"
},
{
"field": "sourceDataPrefixList",
"ref": "6c2b7164-5de2-4775-938c-b443504324ab"
},
{
"field": "sourcePort",
"value": "65000"
},
{
"field": "destinationIp",
"value": "10.0.0.0/12"
},
{
"field": "destinationPort",
"value": "65000"
},
{
"field": "tcp",
"value": "syn"
}
]
},
"actions": [
{
"type": "count",
"parameter": "Demo-Counter"
},
{
"type": "set",
"parameter": [
{
"field": "dscp",
"value": "34"
},
{
"field": "forwardingClass",
"value": "ef-class"
},
{
"field": "localTlocList",
"value": {
"color": "public-internet",
"restrict": "",
"encap": "ipsec"
}
},
{
"field": "nextHop",
"value": "10.0.0.1"
},
{
"field": "policer",
"ref": "ecf250c7-bef0-405b-8e74-4d67440cac90"
}
]
},
{
"type": "cflowd"
},
{
"type": "log",
"parameter": ""
},
{
"type": "nat",
"parameter": {
"field": "pool",
"value": "1"
}
},
{
"type": "redirectDns",
"parameter": {
"field": "dnsType",
"value": "umbrella"
}
}
]
},
{
"sequenceId": 11,
"sequenceName": "Custom",
"baseAction": "accept",
"sequenceType": "data",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "appList",
"ref": "b6752dba-969b-46de-a7e7-da11910fb1bf"
}
]
},
"actions": [
{
"type": "set",
"parameter": [
{
"field": "service",
"value": {
"type": "FW",
"vpn": "10",
"tloc": {
"ip": "10.0.0.1",
"color": "biz-internet",
"encap": "ipsec"
}
}
}
]
},
{
"type": "tcpOptimization",
"parameter": ""
},
{
"type": "lossProtect",
"parameter": "fecAdaptive"
},
{
"type": "lossProtectFec",
"parameter": "fecAdaptive"
},
{
"type": "sig",
"parameter": ""
}
]
}
]
}
},
"CFlowd definition": {
"description": "CFlowd definition",
"value": {
"name": "Demo-cflowd-Policy",
"type": "cflowd",
"description": "Demo-cflowd-Policy",
"definition": {
"flowActiveTimeout": 3600,
"flowInactiveTimeout": 3600,
"flowSamplingInterval": 65513,
"templateRefresh": 86400,
"collectors": [
{
"vpn": "10",
"address": "10.0.0.1",
"port": 9912,
"transport": "transport_tcp",
"sourceInterface": "ge0/1"
},
{
"vpn": "20",
"address": "10.0.0.1",
"port": 1025,
"transport": "transport_udp",
"sourceInterface": "GigabitEthernet0/0/1"
}
],
"protocol": "ipv4"
}
}
},
"QoS map definition": {
"description": "QoS map definition",
"value": {
"name": "Demo-QoS-Policy",
"type": "qosMap",
"description": "Demo-QoS-Policy",
"definition": {
"qosSchedulers": [
{
"queue": "0",
"bandwidthPercent": "75",
"bufferPercent": "75",
"burst": "15000",
"scheduling": "llq",
"drops": "tail-drop",
"classMapRef": ""
},
{
"queue": "7",
"bandwidthPercent": "25",
"bufferPercent": "25",
"scheduling": "wrr",
"drops": "red-drop",
"classMapRef": "4484c444-b956-4016-bd15-538b74fc2785"
}
]
}
}
},
"VPN-QoS map definition": {
"description": "VPN-QoS map definition",
"value": {
"name": "Demo-VPN-QoS-Policy",
"type": "vpnQosMap",
"description": "Demo-VPN-QoS-Policy",
"definition": {
"vpnQosSchedulers": [
{
"vpnListRef": "",
"bandwidthRate": "100000",
"shapingRate": "120000",
"childMapRef": ""
},
{
"childMapRef": ""
}
]
}
}
},
"Rewrite rule definition": {
"description": "Rewrite rule definition",
"value": {
"name": "Demo-Rewrite-Rule",
"type": "rewriteRule",
"description": "Demo-Rewrite-Rule",
"definition": {
"rules": [
{
"class": "4484c444-b956-4016-bd15-538b74fc2785",
"plp": "low",
"dscp": "46",
"layer2Cos": "2"
}
]
}
}
},
"Device access policy definition": {
"description": "Device access policy definition",
"value": {
"name": "Demo-DeviceAccess-Policy",
"type": "deviceaccesspolicy",
"description": "Demo-DeviceAccess-Policy",
"defaultAction": {
"type": "drop"
},
"sequences": [
{
"sequenceId": 1,
"sequenceName": "Device Access Control List",
"baseAction": "accept",
"sequenceType": "deviceaccesspolicy",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "destinationPort",
"value": "22"
},
{
"field": "sourceIp",
"value": "10.10.24.0/24"
},
{
"field": "sourcePort",
"value": "65000"
},
{
"field": "destinationIp",
"value": "10.10.10.1/32"
},
{
"field": "vpn",
"value": "10"
}
]
},
"actions": []
},
{
"sequenceId": 11,
"sequenceName": "Device Access Control List",
"baseAction": "drop",
"sequenceType": "deviceaccesspolicy",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "destinationPort",
"value": "161"
},
{
"field": "sourceDataPrefixList",
"ref": "6c2b7164-5de2-4775-938c-b443504324ab"
}
]
},
"actions": []
}
]
}
},
"vEdge route definition": {
"description": "vEdge route definition",
"value": {
"name": "Demo-Route-Policy",
"type": "vedgeRoute",
"description": "Demo-Route-Policy",
"defaultAction": {
"type": "reject"
},
"sequences": [
{
"sequenceId": 1,
"sequenceName": "Route",
"baseAction": "accept",
"sequenceType": "vedgeRoute",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "address",
"ref": "b5c4d764-20bc-4de3-9bac-52ef70f1186c"
},
{
"field": "asPath",
"ref": "79f8c180-1a23-4f09-800d-62652b571258"
},
{
"field": "community",
"matchFlag": "or",
"ref": "33de059b-27ec-4a83-be28-8985128381eb"
},
{
"field": "localPreference",
"value": "200"
},
{
"field": "metric",
"value": "100"
},
{
"field": "nextHop",
"ref": "b5c4d764-20bc-4de3-9bac-52ef70f1186c"
},
{
"field": "ompTag",
"value": "10"
},
{
"field": "affinity",
"value": "10"
},
{
"field": "origin",
"value": "igp"
},
{
"field": "ospfTag",
"value": "10"
},
{
"field": "peer",
"value": "10.0.0.1"
}
]
},
"actions": [
{
"type": "set",
"parameter": [
{
"field": "asPath",
"value": {
"exclude": "120 130",
"prepend": "65521 65521"
}
},
{
"field": "localPreference",
"value": "200"
},
{
"field": "metricType",
"value": "type1"
},
{
"field": "metric",
"value": "100"
},
{
"field": "nextHop",
"value": "10.0.0.1"
},
{
"field": "ompTag",
"value": "100"
},
{
"field": "weight",
"value": "200"
},
{
"field": "ospfTag",
"value": "122"
},
{
"field": "originator",
"value": "10.0.0.1"
},
{
"field": "origin",
"value": "igp"
},
{
"field": "community",
"value": "1000:10000"
}
]
}
]
}
]
}
},
"vSmart definition": {
"description": "vSmart definition",
"value": {
"policyDescription": "Demo-Centralized-Policy",
"policyType": "feature",
"policyName": "Demo-Centralized-Policy",
"policyDefinition": {
"assembly": [
{
"definitionId": "eb0daba9-7fc4-4f4f-bae7-cd958f81f863",
"type": "cflowd",
"entries": [
{
"siteLists": [
"5c58c36c-9cd6-468f-8434-ee6d5801c6ba",
"24747ccd-4f7f-4dfa-8800-34f565fb65b4"
]
}
]
},
{
"definitionId": "3e33fa50-a30d-4586-9d69-106121feaaf4",
"type": "data",
"entries": [
{
"direction": "service",
"siteLists": [
"5c58c36c-9cd6-468f-8434-ee6d5801c6ba",
"24747ccd-4f7f-4dfa-8800-34f565fb65b4"
],
"vpnLists": [
"cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"
]
}
]
},
{
"definitionId": "8b2e7c44-2666-48a7-87a0-36a43c2d003e",
"type": "appRoute",
"entries": [
{
"siteLists": [
"5c58c36c-9cd6-468f-8434-ee6d5801c6ba",
"24747ccd-4f7f-4dfa-8800-34f565fb65b4"
],
"vpnLists": [
"cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"
]
}
]
},
{
"definitionId": "1b76052e-1cb5-44b1-8e5e-4096cb261736",
"type": "vpnMembershipGroup"
},
{
"definitionId": "62960276-c797-41fd-bebb-c017fc752f4e",
"type": "hubAndSpoke"
}
]
},
"isPolicyActivated": false
}
},
"vEdge definition": {
"description": "vEdge definition",
"value": {
"policyDescription": "Demo-Local-Policy",
"policyType": "feature",
"policyName": "Demo-Local-Policy",
"policyDefinition": {
"assembly": [
{
"definitionId": "56283dcf-6dda-4831-bcd1-d9cf62d33fdc",
"type": "qosMap"
},
{
"definitionId": "a75ead1f-f6ab-4a80-af29-79b742b31c5c",
"type": "rewriteRule"
},
{
"definitionId": "555dd393-e7b6-4861-866f-f227f5f780b7",
"type": "deviceAccessPolicy"
},
{
"definitionId": "22655824-d0df-4a8b-9be0-9808938a0e6b",
"type": "vedgeRoute"
}
],
"settings": {
"flowVisibility": true,
"flowVisibilityIPv6": true,
"appVisibility": true,
"cloudQos": true,
"cloudQosServiceSide": true,
"implicitAclLogging": true,
"appVisibilityIPv6": true
}
},
"isPolicyActivated": false
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Task Id": {
"description": "Task Id",
"value": {
"definitionId": "00f718df-4f95-4363-8639-1fe855c9eb09"
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/definition/intrusionprevention/bulk": {
"put": {
"tags": [
"Configuration - Policy Intrusion Prevention Definition Builder"
],
"description": "Create/Edit policy definitions in bulk",
"operationId": "savePolicyDefinitionInBulk_ConfigurationPolicyIntrusionPreventionDefinitionBuilder_5203",
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/definition/intrusionprevention/multiple/{id}": {
"put": {
"tags": [
"Configuration - Policy Intrusion Prevention Definition Builder"
],
"description": "Edit multiple policy definitions",
"operationId": "editMultiplePolicyDefinition_ConfigurationPolicyIntrusionPreventionDefinitionBuilder_6103",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/definition/intrusionprevention/preview": {
"post": {
"tags": [
"Configuration - Policy Intrusion Prevention Definition Builder"
],
"description": "Preview policy definition",
"operationId": "previewPolicyDefinition_ConfigurationPolicyIntrusionPreventionDefinitionBuilder_5504",
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/definition/intrusionprevention/preview/{id}": {
"get": {
"tags": [
"Configuration - Policy Intrusion Prevention Definition Builder"
],
"description": "Preview policy definition",
"operationId": "previewPolicyDefinitionById_ConfigurationPolicyIntrusionPreventionDefinitionBuilder_6003",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/definition/intrusionprevention/{id}": {
"get": {
"tags": [
"Configuration - Policy Intrusion Prevention Definition Builder"
],
"description": "Get a specific policy definitions",
"operationId": "getPolicyDefinition_ConfigurationPolicyIntrusionPreventionDefinitionBuilder_5203",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
},
"delete": {
"tags": [
"Configuration - Policy Intrusion Prevention Definition Builder"
],
"description": "Delete policy definition",
"operationId": "deletePolicyDefinition_ConfigurationPolicyIntrusionPreventionDefinitionBuilder_5206",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"put": {
"tags": [
"Configuration - Policy Intrusion Prevention Definition Builder"
],
"description": "Edit a policy definitions",
"operationId": "editPolicyDefinition_ConfigurationPolicyIntrusionPreventionDefinitionBuilder_5203",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"ACL policy": {
"description": "ACL policy",
"value": {
"name": "Demo-ACL",
"type": "acl",
"description": "Demo-ACL",
"defaultAction": {
"type": "accept"
},
"sequences": [
{
"sequenceId": 1,
"sequenceName": "Access Control List",
"baseAction": "accept",
"sequenceType": "acl",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "dscp",
"value": "46"
},
{
"field": "protocol",
"value": "6"
}
]
},
"actions": [
{
"type": "class",
"parameter": {
"ref": "89d20034-7149-4492-b392-b5c4f7903235"
}
}
]
}
]
}
},
"ZBFW definition": {
"description": "ZBFW definition",
"value": {
"name": "Demo-ZBFW",
"type": "zoneBasedFW",
"description": "Demo-ZBFW",
"definition": {
"defaultAction": {
"type": "drop"
},
"sequences": [
{
"sequenceId": 1,
"sequenceName": "Demo-Rule-1",
"baseAction": "inspect",
"sequenceType": "zoneBasedFW",
"match": {
"entries": [
{
"field": "sourceDataPrefixList",
"ref": "ecbea5de-b200-4ff7-aa76-f537b5f858e9"
}
]
},
"actions": []
}
],
"entries": [
{
"sourceZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53",
"destinationZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53"
}
]
}
}
},
"IPS definition": {
"description": "IPS definition",
"value": {
"name": "Demo-IPS-Policy",
"type": "intrusionPrevention",
"description": "Testing",
"definition": {
"signatureSet": "security",
"inspectionMode": "detection",
"signatureWhiteList": {
"ref": "ad189f08-af06-4799-97d6-0a7c7409cb8d"
},
"logLevel": "error",
"logging": [],
"targetVpns": [
"10",
"20"
]
}
}
},
"URL filtering definition": {
"description": "URL filtering definition",
"value": {
"name": "Demo-URL-Filtering-Policy",
"type": "urlFiltering",
"description": "",
"definition": {
"webCategoriesAction": "block",
"webCategories": [
"auctions",
"bot-nets",
"news-and-media"
],
"webReputation": "moderate-risk",
"urlWhiteList": {
"ref": "c20e31fb-fcea-4f48-93e3-09d2c6492d8b"
},
"urlBlackList": {
"ref": "557ed432-6cf8-495b-a445-d340d4c6236e"
},
"blockPageAction": "text",
"blockPageContents": "Access to the requested page has been denied. Please contact your Network Administrator",
"enableAlerts": true,
"alerts": [
"blacklist",
"whitelist",
"categories-reputation"
],
"logging": [],
"targetVpns": [
"30"
]
}
}
},
"AMP definition": {
"description": "AMP definition",
"value": {
"name": "Demo-AMP-Policy",
"type": "advancedMalwareProtection",
"description": "",
"definition": {
"matchAllVpn": true,
"fileReputationCloudServer": "nam",
"fileReputationEstServer": "nam",
"fileReputationAlert": "critical",
"fileAnalysisCloudServer": "nam",
"fileAnalysisFileTypes": [
"pdf",
"ms-exe"
],
"fileAnalysisAlert": "critical",
"targetVpns": [
"10",
"20"
],
"fileAnalysisEnabled": true
}
}
},
"DNS definition": {
"description": "DNS definition",
"value": {
"name": "Demo-DNS-Policy",
"type": "DNSSecurity",
"description": "Testing",
"definition": {
"localDomainBypassList": {
"ref": "143f753f-8d51-4be6-805d-bc330f09982f"
},
"matchAllVpn": false,
"targetVpns": [
{
"vpns": [
"10"
],
"umbrellaDefault": false,
"childOrgId": "7999118",
"dnsServerIP": "10.10.10.1",
"localDomainBypassEnabled": true
}
],
"dnsCrypt": true,
"umbrellaData": {
"ref": "e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa"
}
}
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {
"masterTemplatesAffected": []
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/definition/mesh": {
"post": {
"tags": [
"Configuration - Policy Mesh Definition Builder"
],
"description": "Create policy definition",
"operationId": "createPolicyDefinition_ConfigurationPolicyMeshDefinitionBuilder_3204",
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Topology Policy-write,Policy Configuration-write"
},
"get": {
"tags": [
"Configuration - Policy Mesh Definition Builder"
],
"description": "Get policy definitions",
"operationId": "getDefinitions_ConfigurationPolicyMeshDefinitionBuilder_3203",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Topology Policy-read,Topology Policy-write"
}
},
"/template/policy/definition/mesh/bulk": {
"put": {
"tags": [
"Configuration - Policy Mesh Definition Builder"
],
"description": "Create/Edit policy definitions in bulk",
"operationId": "savePolicyDefinitionInBulk_ConfigurationPolicyMeshDefinitionBuilder_3703",
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/definition/mesh/multiple/{id}": {
"put": {
"tags": [
"Configuration - Policy Mesh Definition Builder"
],
"description": "Edit multiple policy definitions",
"operationId": "editMultiplePolicyDefinition_ConfigurationPolicyMeshDefinitionBuilder_4603",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/definition/mesh/preview": {
"post": {
"tags": [
"Configuration - Policy Mesh Definition Builder"
],
"description": "Preview policy definition",
"operationId": "previewPolicyDefinition_ConfigurationPolicyMeshDefinitionBuilder_4004",
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/definition/mesh/preview/{id}": {
"get": {
"tags": [
"Configuration - Policy Mesh Definition Builder"
],
"description": "Preview policy definition",
"operationId": "previewPolicyDefinitionById_ConfigurationPolicyMeshDefinitionBuilder_4503",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/definition/mesh/{id}": {
"put": {
"tags": [
"Configuration - Policy Mesh Definition Builder"
],
"description": "Edit a policy definitions",
"operationId": "editPolicyDefinition_ConfigurationPolicyMeshDefinitionBuilder_3703",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Topology Policy-write,Policy Configuration-write"
},
"get": {
"tags": [
"Configuration - Policy Mesh Definition Builder"
],
"description": "Get a specific policy definitions",
"operationId": "getPolicyDefinition_ConfigurationPolicyMeshDefinitionBuilder_3703",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Topology Policy-read,Topology Policy-write"
},
"delete": {
"tags": [
"Configuration - Policy Mesh Definition Builder"
],
"description": "Delete policy definition",
"operationId": "deletePolicyDefinition_ConfigurationPolicyMeshDefinitionBuilder_3706",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Topology Policy-write,Policy Configuration-write"
}
},
"/template/policy/definition/priisdnport": {
"post": {
"tags": [
"Configuration - Policy PRI ISDN Port Definition Builder"
],
"description": "Create policy definition",
"operationId": "createPolicyDefinition_ConfigurationPolicyPriIsdnPortDefinitionBuilder_3904",
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"ACL policy": {
"description": "ACL policy",
"value": {
"name": "Demo-ACL",
"type": "acl",
"description": "Demo-ACL",
"defaultAction": {
"type": "accept"
},
"sequences": [
{
"sequenceId": 1,
"sequenceName": "Access Control List",
"baseAction": "accept",
"sequenceType": "acl",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "dscp",
"value": "46"
}
]
},
"actions": [
{
"type": "class",
"parameter": {
"ref": "89d20034-7149-4492-b392-b5c4f7903235"
}
}
]
}
]
}
},
"ZBFW definition": {
"description": "ZBFW definition",
"value": {
"name": "Demo-ZBFW",
"type": "zoneBasedFW",
"description": "Demo-ZBFW",
"definition": {
"defaultAction": {
"type": "drop"
},
"sequences": [],
"entries": [
{
"sourceZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53",
"destinationZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53"
}
]
}
}
},
"IPS definition": {
"description": "IPS definition",
"value": {
"name": "Demo-IPS-Policy",
"type": "intrusionPrevention",
"description": "Testing",
"definition": {
"signatureSet": "security",
"inspectionMode": "detection",
"signatureWhiteList": {
"ref": "ad189f08-af06-4799-97d6-0a7c7409cb8d"
},
"logLevel": "error",
"logging": [],
"targetVpns": [
"10"
]
}
}
},
"URL filtering definition": {
"description": "URL filtering definition",
"value": {
"name": "Demo-URL-Filtering-Policy",
"type": "urlFiltering",
"description": "",
"definition": {
"webCategoriesAction": "block",
"webCategories": [
"auctions",
"bot-nets"
],
"webReputation": "moderate-risk",
"urlWhiteList": {
"ref": "c20e31fb-fcea-4f48-93e3-09d2c6492d8b"
},
"urlBlackList": {
"ref": "557ed432-6cf8-495b-a445-d340d4c6236e"
},
"blockPageAction": "text",
"blockPageContents": "Access to the requested page has been denied. Please contact your Network Administrator",
"enableAlerts": true,
"alerts": [
"blacklist",
"whitelist",
"categories-reputation"
],
"logging": [],
"targetVpns": [
"10",
"20"
]
}
}
},
"AMP definition": {
"description": "AMP definition",
"value": {
"name": "Demo-AMP-Policy",
"type": "advancedMalwareProtection",
"description": "",
"definition": {
"matchAllVpn": false,
"fileReputationCloudServer": "nam",
"fileReputationEstServer": "nam",
"fileReputationAlert": "critical",
"fileAnalysisCloudServer": "",
"fileAnalysisFileTypes": [],
"fileAnalysisAlert": "",
"targetVpns": [
"10",
"20"
]
}
}
},
"DNS definition": {
"description": "DNS definition",
"value": {
"name": "Demo-DNS-Policy",
"type": "DNSSecurity",
"description": "Testing",
"definition": {
"localDomainBypassList": {
"ref": "143f753f-8d51-4be6-805d-bc330f09982f"
},
"matchAllVpn": true,
"umbrellaDefault": true,
"childOrgId": "7999118",
"localDomainBypassEnabled": true,
"dnsCrypt": true,
"umbrellaData": {
"ref": "e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa"
}
}
}
},
"HubandSpoke definition": {
"description": "HubandSpoke definition",
"value": {
"name": "Demo-Hub-n-Spoke-Policy",
"type": "hubAndSpoke",
"description": "Demo-Hub-n-Spoke-Policy",
"definition": {
"vpnList": "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf",
"subDefinitions": [
{
"name": "My Hub-and-Spoke",
"equalPreference": false,
"advertiseTloc": true,
"spokes": [
{
"siteList": "5c58c36c-9cd6-468f-8434-ee6d5801c6ba",
"hubs": [
{
"siteList": "24747ccd-4f7f-4dfa-8800-34f565fb65b4",
"preference": "20",
"prefixLists": [
"b5c4d764-20bc-4de3-9bac-52ef70f1186c"
],
"ipv6PrefixLists": []
}
]
}
],
"tlocList": "1e97c258-4323-4754-9dc0-44e9656d43bf"
}
]
}
}
},
"VPN membership group definition": {
"description": "VPN membership group definition",
"value": {
"name": "Demo-VPN-Membership-Policy",
"type": "vpnMembershipGroup",
"description": "Demo-VPN-Membership-Policy",
"definition": {
"sites": [
{
"siteList": "24747ccd-4f7f-4dfa-8800-34f565fb65b4",
"vpnList": [
"cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"
]
},
{
"siteList": "5c58c36c-9cd6-468f-8434-ee6d5801c6ba",
"vpnList": [
"cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"
]
}
]
}
}
},
"AppRoute definition": {
"description": "AppRoute definition",
"value": {
"name": "Demo-AAR-Policy",
"type": "appRoute",
"description": "Demo-AAR-Policy",
"sequences": [
{
"sequenceId": 1,
"sequenceName": "App Route",
"sequenceType": "appRoute",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "appList",
"ref": "b6752dba-969b-46de-a7e7-da11910fb1bf"
},
{
"field": "dnsAppList",
"ref": "b6752dba-969b-46de-a7e7-da11910fb1bf"
},
{
"field": "dns",
"value": "request"
},
{
"field": "dscp",
"value": "46"
},
{
"field": "plp",
"value": "high"
},
{
"field": "protocol",
"value": "6"
},
{
"field": "sourceDataPrefixList",
"ref": "6c2b7164-5de2-4775-938c-b443504324ab"
},
{
"field": "sourcePort",
"value": "1025"
},
{
"field": "destinationDataPrefixList",
"ref": "6c2b7164-5de2-4775-938c-b443504324ab"
},
{
"field": "destinationPort",
"value": "65000"
}
]
},
"actions": [
{
"type": "backupSlaPreferredColor",
"parameter": "biz-internet"
},
{
"type": "count",
"parameter": "Demo-Counter"
},
{
"type": "log",
"parameter": ""
},
{
"type": "slaClass",
"parameter": [
{
"field": "name",
"ref": "46cea5a1-1570-4921-b87a-837d590eb37e"
},
{
"field": "preferredColor",
"value": "public-internet"
},
{
"field": "strict"
}
]
}
]
},
{
"sequenceId": 11,
"sequenceName": "App Route",
"sequenceType": "appRoute",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "saasAppList",
"ref": "1e6688ce-2d21-4d7a-9a93-ae6a8ebd4a06"
}
]
},
"actions": [
{
"type": "cloudSaas",
"parameter": ""
}
]
},
{
"sequenceId": 21,
"sequenceName": "App Route",
"sequenceType": "appRoute",
"sequenceIpType": "ipv6",
"match": {
"entries": [
{
"field": "dscp",
"value": "46"
},
{
"field": "protocol",
"value": "6"
},
{
"field": "sourceIpv6",
"value": "2001::/8"
},
{
"field": "sourcePort",
"value": "65000"
},
{
"field": "destinationIpv6",
"value": "2001::/8"
},
{
"field": "destinationPort",
"value": "65000"
}
]
},
"actions": [
{
"type": "backupSlaPreferredColor",
"parameter": "biz-internet"
},
{
"type": "count",
"parameter": "Demo-Counter"
},
{
"type": "log",
"parameter": ""
},
{
"type": "slaClass",
"parameter": [
{
"field": "name",
"ref": "46cea5a1-1570-4921-b87a-837d590eb37e"
},
{
"field": "preferredColor",
"value": "public-internet"
},
{
"field": "strict"
}
]
}
]
}
]
}
},
"Data policy definition": {
"description": "Data policy definition",
"value": {
"name": "Demo-Data-Policy",
"type": "data",
"description": "Demo-Data-Policy",
"defaultAction": {
"type": "drop"
},
"sequences": [
{
"sequenceId": 1,
"sequenceName": "Custom",
"baseAction": "accept",
"sequenceType": "data",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "appList",
"ref": "b6752dba-969b-46de-a7e7-da11910fb1bf"
},
{
"field": "dnsAppList",
"ref": "b6752dba-969b-46de-a7e7-da11910fb1bf"
},
{
"field": "dns",
"value": "response"
},
{
"field": "dscp",
"value": "46"
},
{
"field": "packetLength",
"value": "1504"
},
{
"field": "plp",
"value": "high"
},
{
"field": "protocol",
"value": "6"
},
{
"field": "sourceDataPrefixList",
"ref": "6c2b7164-5de2-4775-938c-b443504324ab"
},
{
"field": "sourcePort",
"value": "65000"
},
{
"field": "destinationIp",
"value": "10.0.0.0/12"
},
{
"field": "destinationPort",
"value": "65000"
},
{
"field": "tcp",
"value": "syn"
}
]
},
"actions": [
{
"type": "count",
"parameter": "Demo-Counter"
},
{
"type": "set",
"parameter": [
{
"field": "dscp",
"value": "34"
},
{
"field": "forwardingClass",
"value": "ef-class"
},
{
"field": "localTlocList",
"value": {
"color": "public-internet",
"restrict": "",
"encap": "ipsec"
}
},
{
"field": "nextHop",
"value": "10.0.0.1"
},
{
"field": "policer",
"ref": "ecf250c7-bef0-405b-8e74-4d67440cac90"
}
]
},
{
"type": "cflowd"
},
{
"type": "log",
"parameter": ""
},
{
"type": "nat",
"parameter": {
"field": "pool",
"value": "1"
}
},
{
"type": "redirectDns",
"parameter": {
"field": "dnsType",
"value": "umbrella"
}
}
]
},
{
"sequenceId": 11,
"sequenceName": "Custom",
"baseAction": "accept",
"sequenceType": "data",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "appList",
"ref": "b6752dba-969b-46de-a7e7-da11910fb1bf"
}
]
},
"actions": [
{
"type": "set",
"parameter": [
{
"field": "service",
"value": {
"type": "FW",
"vpn": "10",
"tloc": {
"ip": "10.0.0.1",
"color": "biz-internet",
"encap": "ipsec"
}
}
}
]
},
{
"type": "tcpOptimization",
"parameter": ""
},
{
"type": "lossProtect",
"parameter": "fecAdaptive"
},
{
"type": "lossProtectFec",
"parameter": "fecAdaptive"
},
{
"type": "sig",
"parameter": ""
}
]
}
]
}
},
"CFlowd definition": {
"description": "CFlowd definition",
"value": {
"name": "Demo-cflowd-Policy",
"type": "cflowd",
"description": "Demo-cflowd-Policy",
"definition": {
"flowActiveTimeout": 3600,
"flowInactiveTimeout": 3600,
"flowSamplingInterval": 65513,
"templateRefresh": 86400,
"collectors": [
{
"vpn": "10",
"address": "10.0.0.1",
"port": 9912,
"transport": "transport_tcp",
"sourceInterface": "ge0/1"
},
{
"vpn": "20",
"address": "10.0.0.1",
"port": 1025,
"transport": "transport_udp",
"sourceInterface": "GigabitEthernet0/0/1"
}
],
"protocol": "ipv4"
}
}
},
"QoS map definition": {
"description": "QoS map definition",
"value": {
"name": "Demo-QoS-Policy",
"type": "qosMap",
"description": "Demo-QoS-Policy",
"definition": {
"qosSchedulers": [
{
"queue": "0",
"bandwidthPercent": "75",
"bufferPercent": "75",
"burst": "15000",
"scheduling": "llq",
"drops": "tail-drop",
"classMapRef": ""
},
{
"queue": "7",
"bandwidthPercent": "25",
"bufferPercent": "25",
"scheduling": "wrr",
"drops": "red-drop",
"classMapRef": "4484c444-b956-4016-bd15-538b74fc2785"
}
]
}
}
},
"VPN-QoS map definition": {
"description": "VPN-QoS map definition",
"value": {
"name": "Demo-VPN-QoS-Policy",
"type": "vpnQosMap",
"description": "Demo-VPN-QoS-Policy",
"definition": {
"vpnQosSchedulers": [
{
"vpnListRef": "",
"bandwidthRate": "100000",
"shapingRate": "120000",
"childMapRef": ""
},
{
"childMapRef": ""
}
]
}
}
},
"Rewrite rule definition": {
"description": "Rewrite rule definition",
"value": {
"name": "Demo-Rewrite-Rule",
"type": "rewriteRule",
"description": "Demo-Rewrite-Rule",
"definition": {
"rules": [
{
"class": "4484c444-b956-4016-bd15-538b74fc2785",
"plp": "low",
"dscp": "46",
"layer2Cos": "2"
}
]
}
}
},
"Device access policy definition": {
"description": "Device access policy definition",
"value": {
"name": "Demo-DeviceAccess-Policy",
"type": "deviceaccesspolicy",
"description": "Demo-DeviceAccess-Policy",
"defaultAction": {
"type": "drop"
},
"sequences": [
{
"sequenceId": 1,
"sequenceName": "Device Access Control List",
"baseAction": "accept",
"sequenceType": "deviceaccesspolicy",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "destinationPort",
"value": "22"
},
{
"field": "sourceIp",
"value": "10.10.24.0/24"
},
{
"field": "sourcePort",
"value": "65000"
},
{
"field": "destinationIp",
"value": "10.10.10.1/32"
},
{
"field": "vpn",
"value": "10"
}
]
},
"actions": []
},
{
"sequenceId": 11,
"sequenceName": "Device Access Control List",
"baseAction": "drop",
"sequenceType": "deviceaccesspolicy",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "destinationPort",
"value": "161"
},
{
"field": "sourceDataPrefixList",
"ref": "6c2b7164-5de2-4775-938c-b443504324ab"
}
]
},
"actions": []
}
]
}
},
"vEdge route definition": {
"description": "vEdge route definition",
"value": {
"name": "Demo-Route-Policy",
"type": "vedgeRoute",
"description": "Demo-Route-Policy",
"defaultAction": {
"type": "reject"
},
"sequences": [
{
"sequenceId": 1,
"sequenceName": "Route",
"baseAction": "accept",
"sequenceType": "vedgeRoute",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "address",
"ref": "b5c4d764-20bc-4de3-9bac-52ef70f1186c"
},
{
"field": "asPath",
"ref": "79f8c180-1a23-4f09-800d-62652b571258"
},
{
"field": "community",
"matchFlag": "or",
"ref": "33de059b-27ec-4a83-be28-8985128381eb"
},
{
"field": "localPreference",
"value": "200"
},
{
"field": "metric",
"value": "100"
},
{
"field": "nextHop",
"ref": "b5c4d764-20bc-4de3-9bac-52ef70f1186c"
},
{
"field": "ompTag",
"value": "10"
},
{
"field": "affinity",
"value": "10"
},
{
"field": "origin",
"value": "igp"
},
{
"field": "ospfTag",
"value": "10"
},
{
"field": "peer",
"value": "10.0.0.1"
}
]
},
"actions": [
{
"type": "set",
"parameter": [
{
"field": "asPath",
"value": {
"exclude": "120 130",
"prepend": "65521 65521"
}
},
{
"field": "localPreference",
"value": "200"
},
{
"field": "metricType",
"value": "type1"
},
{
"field": "metric",
"value": "100"
},
{
"field": "nextHop",
"value": "10.0.0.1"
},
{
"field": "ompTag",
"value": "100"
},
{
"field": "weight",
"value": "200"
},
{
"field": "ospfTag",
"value": "122"
},
{
"field": "originator",
"value": "10.0.0.1"
},
{
"field": "origin",
"value": "igp"
},
{
"field": "community",
"value": "1000:10000"
}
]
}
]
}
]
}
},
"vSmart definition": {
"description": "vSmart definition",
"value": {
"policyDescription": "Demo-Centralized-Policy",
"policyType": "feature",
"policyName": "Demo-Centralized-Policy",
"policyDefinition": {
"assembly": [
{
"definitionId": "eb0daba9-7fc4-4f4f-bae7-cd958f81f863",
"type": "cflowd",
"entries": [
{
"siteLists": [
"5c58c36c-9cd6-468f-8434-ee6d5801c6ba",
"24747ccd-4f7f-4dfa-8800-34f565fb65b4"
]
}
]
},
{
"definitionId": "3e33fa50-a30d-4586-9d69-106121feaaf4",
"type": "data",
"entries": [
{
"direction": "service",
"siteLists": [
"5c58c36c-9cd6-468f-8434-ee6d5801c6ba",
"24747ccd-4f7f-4dfa-8800-34f565fb65b4"
],
"vpnLists": [
"cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"
]
}
]
},
{
"definitionId": "8b2e7c44-2666-48a7-87a0-36a43c2d003e",
"type": "appRoute",
"entries": [
{
"siteLists": [
"5c58c36c-9cd6-468f-8434-ee6d5801c6ba",
"24747ccd-4f7f-4dfa-8800-34f565fb65b4"
],
"vpnLists": [
"cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"
]
}
]
},
{
"definitionId": "1b76052e-1cb5-44b1-8e5e-4096cb261736",
"type": "vpnMembershipGroup"
},
{
"definitionId": "62960276-c797-41fd-bebb-c017fc752f4e",
"type": "hubAndSpoke"
}
]
},
"isPolicyActivated": false
}
},
"vEdge definition": {
"description": "vEdge definition",
"value": {
"policyDescription": "Demo-Local-Policy",
"policyType": "feature",
"policyName": "Demo-Local-Policy",
"policyDefinition": {
"assembly": [
{
"definitionId": "56283dcf-6dda-4831-bcd1-d9cf62d33fdc",
"type": "qosMap"
},
{
"definitionId": "a75ead1f-f6ab-4a80-af29-79b742b31c5c",
"type": "rewriteRule"
},
{
"definitionId": "555dd393-e7b6-4861-866f-f227f5f780b7",
"type": "deviceAccessPolicy"
},
{
"definitionId": "22655824-d0df-4a8b-9be0-9808938a0e6b",
"type": "vedgeRoute"
}
],
"settings": {
"flowVisibility": true,
"flowVisibilityIPv6": true,
"appVisibility": true,
"cloudQos": true,
"cloudQosServiceSide": true,
"implicitAclLogging": true,
"appVisibilityIPv6": true
}
},
"isPolicyActivated": false
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Task Id": {
"description": "Task Id",
"value": {
"definitionId": "00f718df-4f95-4363-8639-1fe855c9eb09"
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"get": {
"tags": [
"Configuration - Policy PRI ISDN Port Definition Builder"
],
"description": "Get policy definitions",
"operationId": "getDefinitions_ConfigurationPolicyPriIsdnPortDefinitionBuilder_3903",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/definition/priisdnport/bulk": {
"put": {
"tags": [
"Configuration - Policy PRI ISDN Port Definition Builder"
],
"description": "Create/Edit policy definitions in bulk",
"operationId": "savePolicyDefinitionInBulk_ConfigurationPolicyPriIsdnPortDefinitionBuilder_4403",
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/definition/priisdnport/multiple/{id}": {
"put": {
"tags": [
"Configuration - Policy PRI ISDN Port Definition Builder"
],
"description": "Edit multiple policy definitions",
"operationId": "editMultiplePolicyDefinition_ConfigurationPolicyPriIsdnPortDefinitionBuilder_5303",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/definition/priisdnport/preview": {
"post": {
"tags": [
"Configuration - Policy PRI ISDN Port Definition Builder"
],
"description": "Preview policy definition",
"operationId": "previewPolicyDefinition_ConfigurationPolicyPriIsdnPortDefinitionBuilder_4704",
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/definition/priisdnport/preview/{id}": {
"get": {
"tags": [
"Configuration - Policy PRI ISDN Port Definition Builder"
],
"description": "Preview policy definition",
"operationId": "previewPolicyDefinitionById_ConfigurationPolicyPriIsdnPortDefinitionBuilder_5203",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/definition/priisdnport/{id}": {
"get": {
"tags": [
"Configuration - Policy PRI ISDN Port Definition Builder"
],
"description": "Get a specific policy definitions",
"operationId": "getPolicyDefinition_ConfigurationPolicyPriIsdnPortDefinitionBuilder_4403",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
},
"put": {
"tags": [
"Configuration - Policy PRI ISDN Port Definition Builder"
],
"description": "Edit a policy definitions",
"operationId": "editPolicyDefinition_ConfigurationPolicyPriIsdnPortDefinitionBuilder_4403",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"ACL policy": {
"description": "ACL policy",
"value": {
"name": "Demo-ACL",
"type": "acl",
"description": "Demo-ACL",
"defaultAction": {
"type": "accept"
},
"sequences": [
{
"sequenceId": 1,
"sequenceName": "Access Control List",
"baseAction": "accept",
"sequenceType": "acl",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "dscp",
"value": "46"
},
{
"field": "protocol",
"value": "6"
}
]
},
"actions": [
{
"type": "class",
"parameter": {
"ref": "89d20034-7149-4492-b392-b5c4f7903235"
}
}
]
}
]
}
},
"ZBFW definition": {
"description": "ZBFW definition",
"value": {
"name": "Demo-ZBFW",
"type": "zoneBasedFW",
"description": "Demo-ZBFW",
"definition": {
"defaultAction": {
"type": "drop"
},
"sequences": [
{
"sequenceId": 1,
"sequenceName": "Demo-Rule-1",
"baseAction": "inspect",
"sequenceType": "zoneBasedFW",
"match": {
"entries": [
{
"field": "sourceDataPrefixList",
"ref": "ecbea5de-b200-4ff7-aa76-f537b5f858e9"
}
]
},
"actions": []
}
],
"entries": [
{
"sourceZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53",
"destinationZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53"
}
]
}
}
},
"IPS definition": {
"description": "IPS definition",
"value": {
"name": "Demo-IPS-Policy",
"type": "intrusionPrevention",
"description": "Testing",
"definition": {
"signatureSet": "security",
"inspectionMode": "detection",
"signatureWhiteList": {
"ref": "ad189f08-af06-4799-97d6-0a7c7409cb8d"
},
"logLevel": "error",
"logging": [],
"targetVpns": [
"10",
"20"
]
}
}
},
"URL filtering definition": {
"description": "URL filtering definition",
"value": {
"name": "Demo-URL-Filtering-Policy",
"type": "urlFiltering",
"description": "",
"definition": {
"webCategoriesAction": "block",
"webCategories": [
"auctions",
"bot-nets",
"news-and-media"
],
"webReputation": "moderate-risk",
"urlWhiteList": {
"ref": "c20e31fb-fcea-4f48-93e3-09d2c6492d8b"
},
"urlBlackList": {
"ref": "557ed432-6cf8-495b-a445-d340d4c6236e"
},
"blockPageAction": "text",
"blockPageContents": "Access to the requested page has been denied. Please contact your Network Administrator",
"enableAlerts": true,
"alerts": [
"blacklist",
"whitelist",
"categories-reputation"
],
"logging": [],
"targetVpns": [
"30"
]
}
}
},
"AMP definition": {
"description": "AMP definition",
"value": {
"name": "Demo-AMP-Policy",
"type": "advancedMalwareProtection",
"description": "",
"definition": {
"matchAllVpn": true,
"fileReputationCloudServer": "nam",
"fileReputationEstServer": "nam",
"fileReputationAlert": "critical",
"fileAnalysisCloudServer": "nam",
"fileAnalysisFileTypes": [
"pdf",
"ms-exe"
],
"fileAnalysisAlert": "critical",
"targetVpns": [
"10",
"20"
],
"fileAnalysisEnabled": true
}
}
},
"DNS definition": {
"description": "DNS definition",
"value": {
"name": "Demo-DNS-Policy",
"type": "DNSSecurity",
"description": "Testing",
"definition": {
"localDomainBypassList": {
"ref": "143f753f-8d51-4be6-805d-bc330f09982f"
},
"matchAllVpn": false,
"targetVpns": [
{
"vpns": [
"10"
],
"umbrellaDefault": false,
"childOrgId": "7999118",
"dnsServerIP": "10.10.10.1",
"localDomainBypassEnabled": true
}
],
"dnsCrypt": true,
"umbrellaData": {
"ref": "e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa"
}
}
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {
"masterTemplatesAffected": []
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"delete": {
"tags": [
"Configuration - Policy PRI ISDN Port Definition Builder"
],
"description": "Delete policy definition",
"operationId": "deletePolicyDefinition_ConfigurationPolicyPriIsdnPortDefinitionBuilder_4406",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/definition/qosmap": {
"get": {
"tags": [
"Configuration - Policy Qos Map Definition Builder"
],
"description": "Get policy definitions",
"operationId": "getDefinitions_ConfigurationPolicyQosMapDefinitionBuilder_3403",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,QoSMap Policy-read,QoSMap Policy-write,Policy Configuration-write"
},
"post": {
"tags": [
"Configuration - Policy Qos Map Definition Builder"
],
"description": "Create policy definition",
"operationId": "createPolicyDefinition_ConfigurationPolicyQosMapDefinitionBuilder_3404",
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "QoSMap Policy-write,Policy Configuration-write"
}
},
"/template/policy/definition/qosmap/bulk": {
"put": {
"tags": [
"Configuration - Policy Qos Map Definition Builder"
],
"description": "Create/Edit policy definitions in bulk",
"operationId": "savePolicyDefinitionInBulk_ConfigurationPolicyQosMapDefinitionBuilder_3903",
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/definition/qosmap/multiple/{id}": {
"put": {
"tags": [
"Configuration - Policy Qos Map Definition Builder"
],
"description": "Edit multiple policy definitions",
"operationId": "editMultiplePolicyDefinition_ConfigurationPolicyQosMapDefinitionBuilder_4803",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/definition/qosmap/preview": {
"post": {
"tags": [
"Configuration - Policy Qos Map Definition Builder"
],
"description": "Preview policy definition",
"operationId": "previewPolicyDefinition_ConfigurationPolicyQosMapDefinitionBuilder_4204",
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/definition/qosmap/preview/{id}": {
"get": {
"tags": [
"Configuration - Policy Qos Map Definition Builder"
],
"description": "Preview policy definition",
"operationId": "previewPolicyDefinitionById_ConfigurationPolicyQosMapDefinitionBuilder_4703",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/definition/qosmap/{id}": {
"get": {
"tags": [
"Configuration - Policy Qos Map Definition Builder"
],
"description": "Get a specific policy definitions",
"operationId": "getPolicyDefinition_ConfigurationPolicyQosMapDefinitionBuilder_3903",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,QoSMap Policy-read,Policy Configuration-write,QoSMap Policy-write"
},
"delete": {
"tags": [
"Configuration - Policy Qos Map Definition Builder"
],
"description": "Delete policy definition",
"operationId": "deletePolicyDefinition_ConfigurationPolicyQosMapDefinitionBuilder_3906",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "QoSMap Policy-write,Policy Configuration-write"
},
"put": {
"tags": [
"Configuration - Policy Qos Map Definition Builder"
],
"description": "Edit a policy definitions",
"operationId": "editPolicyDefinition_ConfigurationPolicyQosMapDefinitionBuilder_3903",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "QoSMap Policy-write,Policy Configuration-write"
}
},
"/template/policy/definition/rewriterule": {
"get": {
"tags": [
"Configuration - Policy Rewrite Rule Definition Builder"
],
"description": "Get policy definitions",
"operationId": "getDefinitions_ConfigurationPolicyRewriteRuleDefinitionBuilder_3903",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Rewrite Policy-read,Rewrite Policy-write"
},
"post": {
"tags": [
"Configuration - Policy Rewrite Rule Definition Builder"
],
"description": "Create policy definition",
"operationId": "createPolicyDefinition_ConfigurationPolicyRewriteRuleDefinitionBuilder_3904",
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write,Rewrite Policy-write"
}
},
"/template/policy/definition/rewriterule/bulk": {
"put": {
"tags": [
"Configuration - Policy Rewrite Rule Definition Builder"
],
"description": "Create/Edit policy definitions in bulk",
"operationId": "savePolicyDefinitionInBulk_ConfigurationPolicyRewriteRuleDefinitionBuilder_4403",
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/definition/rewriterule/multiple/{id}": {
"put": {
"tags": [
"Configuration - Policy Rewrite Rule Definition Builder"
],
"description": "Edit multiple policy definitions",
"operationId": "editMultiplePolicyDefinition_ConfigurationPolicyRewriteRuleDefinitionBuilder_5303",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/definition/rewriterule/preview": {
"post": {
"tags": [
"Configuration - Policy Rewrite Rule Definition Builder"
],
"description": "Preview policy definition",
"operationId": "previewPolicyDefinition_ConfigurationPolicyRewriteRuleDefinitionBuilder_4704",
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/definition/rewriterule/preview/{id}": {
"get": {
"tags": [
"Configuration - Policy Rewrite Rule Definition Builder"
],
"description": "Preview policy definition",
"operationId": "previewPolicyDefinitionById_ConfigurationPolicyRewriteRuleDefinitionBuilder_5203",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/definition/rewriterule/{id}": {
"get": {
"tags": [
"Configuration - Policy Rewrite Rule Definition Builder"
],
"description": "Get a specific policy definitions",
"operationId": "getPolicyDefinition_ConfigurationPolicyRewriteRuleDefinitionBuilder_4403",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Rewrite Policy-read,Rewrite Policy-write"
},
"put": {
"tags": [
"Configuration - Policy Rewrite Rule Definition Builder"
],
"description": "Edit a policy definitions",
"operationId": "editPolicyDefinition_ConfigurationPolicyRewriteRuleDefinitionBuilder_4403",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write,Rewrite Policy-write"
},
"delete": {
"tags": [
"Configuration - Policy Rewrite Rule Definition Builder"
],
"description": "Delete policy definition",
"operationId": "deletePolicyDefinition_ConfigurationPolicyRewriteRuleDefinitionBuilder_4406",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write,Rewrite Policy-write"
}
},
"/template/policy/definition/ruleset": {
"get": {
"tags": [
"Configuration - Rule Set Definition"
],
"description": "Get policy definitions",
"operationId": "getDefinitions_ConfigurationRuleSetDefinition_3503",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
},
"post": {
"tags": [
"Configuration - Rule Set Definition"
],
"description": "Create policy definition",
"operationId": "createPolicyDefinition_ConfigurationRuleSetDefinition_3504",
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"ACL policy": {
"description": "ACL policy",
"value": {
"name": "Demo-ACL",
"type": "acl",
"description": "Demo-ACL",
"defaultAction": {
"type": "accept"
},
"sequences": [
{
"sequenceId": 1,
"sequenceName": "Access Control List",
"baseAction": "accept",
"sequenceType": "acl",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "dscp",
"value": "46"
}
]
},
"actions": [
{
"type": "class",
"parameter": {
"ref": "89d20034-7149-4492-b392-b5c4f7903235"
}
}
]
}
]
}
},
"ZBFW definition": {
"description": "ZBFW definition",
"value": {
"name": "Demo-ZBFW",
"type": "zoneBasedFW",
"description": "Demo-ZBFW",
"definition": {
"defaultAction": {
"type": "drop"
},
"sequences": [],
"entries": [
{
"sourceZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53",
"destinationZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53"
}
]
}
}
},
"IPS definition": {
"description": "IPS definition",
"value": {
"name": "Demo-IPS-Policy",
"type": "intrusionPrevention",
"description": "Testing",
"definition": {
"signatureSet": "security",
"inspectionMode": "detection",
"signatureWhiteList": {
"ref": "ad189f08-af06-4799-97d6-0a7c7409cb8d"
},
"logLevel": "error",
"logging": [],
"targetVpns": [
"10"
]
}
}
},
"URL filtering definition": {
"description": "URL filtering definition",
"value": {
"name": "Demo-URL-Filtering-Policy",
"type": "urlFiltering",
"description": "",
"definition": {
"webCategoriesAction": "block",
"webCategories": [
"auctions",
"bot-nets"
],
"webReputation": "moderate-risk",
"urlWhiteList": {
"ref": "c20e31fb-fcea-4f48-93e3-09d2c6492d8b"
},
"urlBlackList": {
"ref": "557ed432-6cf8-495b-a445-d340d4c6236e"
},
"blockPageAction": "text",
"blockPageContents": "Access to the requested page has been denied. Please contact your Network Administrator",
"enableAlerts": true,
"alerts": [
"blacklist",
"whitelist",
"categories-reputation"
],
"logging": [],
"targetVpns": [
"10",
"20"
]
}
}
},
"AMP definition": {
"description": "AMP definition",
"value": {
"name": "Demo-AMP-Policy",
"type": "advancedMalwareProtection",
"description": "",
"definition": {
"matchAllVpn": false,
"fileReputationCloudServer": "nam",
"fileReputationEstServer": "nam",
"fileReputationAlert": "critical",
"fileAnalysisCloudServer": "",
"fileAnalysisFileTypes": [],
"fileAnalysisAlert": "",
"targetVpns": [
"10",
"20"
]
}
}
},
"DNS definition": {
"description": "DNS definition",
"value": {
"name": "Demo-DNS-Policy",
"type": "DNSSecurity",
"description": "Testing",
"definition": {
"localDomainBypassList": {
"ref": "143f753f-8d51-4be6-805d-bc330f09982f"
},
"matchAllVpn": true,
"umbrellaDefault": true,
"childOrgId": "7999118",
"localDomainBypassEnabled": true,
"dnsCrypt": true,
"umbrellaData": {
"ref": "e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa"
}
}
}
},
"HubandSpoke definition": {
"description": "HubandSpoke definition",
"value": {
"name": "Demo-Hub-n-Spoke-Policy",
"type": "hubAndSpoke",
"description": "Demo-Hub-n-Spoke-Policy",
"definition": {
"vpnList": "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf",
"subDefinitions": [
{
"name": "My Hub-and-Spoke",
"equalPreference": false,
"advertiseTloc": true,
"spokes": [
{
"siteList": "5c58c36c-9cd6-468f-8434-ee6d5801c6ba",
"hubs": [
{
"siteList": "24747ccd-4f7f-4dfa-8800-34f565fb65b4",
"preference": "20",
"prefixLists": [
"b5c4d764-20bc-4de3-9bac-52ef70f1186c"
],
"ipv6PrefixLists": []
}
]
}
],
"tlocList": "1e97c258-4323-4754-9dc0-44e9656d43bf"
}
]
}
}
},
"VPN membership group definition": {
"description": "VPN membership group definition",
"value": {
"name": "Demo-VPN-Membership-Policy",
"type": "vpnMembershipGroup",
"description": "Demo-VPN-Membership-Policy",
"definition": {
"sites": [
{
"siteList": "24747ccd-4f7f-4dfa-8800-34f565fb65b4",
"vpnList": [
"cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"
]
},
{
"siteList": "5c58c36c-9cd6-468f-8434-ee6d5801c6ba",
"vpnList": [
"cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"
]
}
]
}
}
},
"AppRoute definition": {
"description": "AppRoute definition",
"value": {
"name": "Demo-AAR-Policy",
"type": "appRoute",
"description": "Demo-AAR-Policy",
"sequences": [
{
"sequenceId": 1,
"sequenceName": "App Route",
"sequenceType": "appRoute",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "appList",
"ref": "b6752dba-969b-46de-a7e7-da11910fb1bf"
},
{
"field": "dnsAppList",
"ref": "b6752dba-969b-46de-a7e7-da11910fb1bf"
},
{
"field": "dns",
"value": "request"
},
{
"field": "dscp",
"value": "46"
},
{
"field": "plp",
"value": "high"
},
{
"field": "protocol",
"value": "6"
},
{
"field": "sourceDataPrefixList",
"ref": "6c2b7164-5de2-4775-938c-b443504324ab"
},
{
"field": "sourcePort",
"value": "1025"
},
{
"field": "destinationDataPrefixList",
"ref": "6c2b7164-5de2-4775-938c-b443504324ab"
},
{
"field": "destinationPort",
"value": "65000"
}
]
},
"actions": [
{
"type": "backupSlaPreferredColor",
"parameter": "biz-internet"
},
{
"type": "count",
"parameter": "Demo-Counter"
},
{
"type": "log",
"parameter": ""
},
{
"type": "slaClass",
"parameter": [
{
"field": "name",
"ref": "46cea5a1-1570-4921-b87a-837d590eb37e"
},
{
"field": "preferredColor",
"value": "public-internet"
},
{
"field": "strict"
}
]
}
]
},
{
"sequenceId": 11,
"sequenceName": "App Route",
"sequenceType": "appRoute",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "saasAppList",
"ref": "1e6688ce-2d21-4d7a-9a93-ae6a8ebd4a06"
}
]
},
"actions": [
{
"type": "cloudSaas",
"parameter": ""
}
]
},
{
"sequenceId": 21,
"sequenceName": "App Route",
"sequenceType": "appRoute",
"sequenceIpType": "ipv6",
"match": {
"entries": [
{
"field": "dscp",
"value": "46"
},
{
"field": "protocol",
"value": "6"
},
{
"field": "sourceIpv6",
"value": "2001::/8"
},
{
"field": "sourcePort",
"value": "65000"
},
{
"field": "destinationIpv6",
"value": "2001::/8"
},
{
"field": "destinationPort",
"value": "65000"
}
]
},
"actions": [
{
"type": "backupSlaPreferredColor",
"parameter": "biz-internet"
},
{
"type": "count",
"parameter": "Demo-Counter"
},
{
"type": "log",
"parameter": ""
},
{
"type": "slaClass",
"parameter": [
{
"field": "name",
"ref": "46cea5a1-1570-4921-b87a-837d590eb37e"
},
{
"field": "preferredColor",
"value": "public-internet"
},
{
"field": "strict"
}
]
}
]
}
]
}
},
"Data policy definition": {
"description": "Data policy definition",
"value": {
"name": "Demo-Data-Policy",
"type": "data",
"description": "Demo-Data-Policy",
"defaultAction": {
"type": "drop"
},
"sequences": [
{
"sequenceId": 1,
"sequenceName": "Custom",
"baseAction": "accept",
"sequenceType": "data",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "appList",
"ref": "b6752dba-969b-46de-a7e7-da11910fb1bf"
},
{
"field": "dnsAppList",
"ref": "b6752dba-969b-46de-a7e7-da11910fb1bf"
},
{
"field": "dns",
"value": "response"
},
{
"field": "dscp",
"value": "46"
},
{
"field": "packetLength",
"value": "1504"
},
{
"field": "plp",
"value": "high"
},
{
"field": "protocol",
"value": "6"
},
{
"field": "sourceDataPrefixList",
"ref": "6c2b7164-5de2-4775-938c-b443504324ab"
},
{
"field": "sourcePort",
"value": "65000"
},
{
"field": "destinationIp",
"value": "10.0.0.0/12"
},
{
"field": "destinationPort",
"value": "65000"
},
{
"field": "tcp",
"value": "syn"
}
]
},
"actions": [
{
"type": "count",
"parameter": "Demo-Counter"
},
{
"type": "set",
"parameter": [
{
"field": "dscp",
"value": "34"
},
{
"field": "forwardingClass",
"value": "ef-class"
},
{
"field": "localTlocList",
"value": {
"color": "public-internet",
"restrict": "",
"encap": "ipsec"
}
},
{
"field": "nextHop",
"value": "10.0.0.1"
},
{
"field": "policer",
"ref": "ecf250c7-bef0-405b-8e74-4d67440cac90"
}
]
},
{
"type": "cflowd"
},
{
"type": "log",
"parameter": ""
},
{
"type": "nat",
"parameter": {
"field": "pool",
"value": "1"
}
},
{
"type": "redirectDns",
"parameter": {
"field": "dnsType",
"value": "umbrella"
}
}
]
},
{
"sequenceId": 11,
"sequenceName": "Custom",
"baseAction": "accept",
"sequenceType": "data",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "appList",
"ref": "b6752dba-969b-46de-a7e7-da11910fb1bf"
}
]
},
"actions": [
{
"type": "set",
"parameter": [
{
"field": "service",
"value": {
"type": "FW",
"vpn": "10",
"tloc": {
"ip": "10.0.0.1",
"color": "biz-internet",
"encap": "ipsec"
}
}
}
]
},
{
"type": "tcpOptimization",
"parameter": ""
},
{
"type": "lossProtect",
"parameter": "fecAdaptive"
},
{
"type": "lossProtectFec",
"parameter": "fecAdaptive"
},
{
"type": "sig",
"parameter": ""
}
]
}
]
}
},
"CFlowd definition": {
"description": "CFlowd definition",
"value": {
"name": "Demo-cflowd-Policy",
"type": "cflowd",
"description": "Demo-cflowd-Policy",
"definition": {
"flowActiveTimeout": 3600,
"flowInactiveTimeout": 3600,
"flowSamplingInterval": 65513,
"templateRefresh": 86400,
"collectors": [
{
"vpn": "10",
"address": "10.0.0.1",
"port": 9912,
"transport": "transport_tcp",
"sourceInterface": "ge0/1"
},
{
"vpn": "20",
"address": "10.0.0.1",
"port": 1025,
"transport": "transport_udp",
"sourceInterface": "GigabitEthernet0/0/1"
}
],
"protocol": "ipv4"
}
}
},
"QoS map definition": {
"description": "QoS map definition",
"value": {
"name": "Demo-QoS-Policy",
"type": "qosMap",
"description": "Demo-QoS-Policy",
"definition": {
"qosSchedulers": [
{
"queue": "0",
"bandwidthPercent": "75",
"bufferPercent": "75",
"burst": "15000",
"scheduling": "llq",
"drops": "tail-drop",
"classMapRef": ""
},
{
"queue": "7",
"bandwidthPercent": "25",
"bufferPercent": "25",
"scheduling": "wrr",
"drops": "red-drop",
"classMapRef": "4484c444-b956-4016-bd15-538b74fc2785"
}
]
}
}
},
"VPN-QoS map definition": {
"description": "VPN-QoS map definition",
"value": {
"name": "Demo-VPN-QoS-Policy",
"type": "vpnQosMap",
"description": "Demo-VPN-QoS-Policy",
"definition": {
"vpnQosSchedulers": [
{
"vpnListRef": "",
"bandwidthRate": "100000",
"shapingRate": "120000",
"childMapRef": ""
},
{
"childMapRef": ""
}
]
}
}
},
"Rewrite rule definition": {
"description": "Rewrite rule definition",
"value": {
"name": "Demo-Rewrite-Rule",
"type": "rewriteRule",
"description": "Demo-Rewrite-Rule",
"definition": {
"rules": [
{
"class": "4484c444-b956-4016-bd15-538b74fc2785",
"plp": "low",
"dscp": "46",
"layer2Cos": "2"
}
]
}
}
},
"Device access policy definition": {
"description": "Device access policy definition",
"value": {
"name": "Demo-DeviceAccess-Policy",
"type": "deviceaccesspolicy",
"description": "Demo-DeviceAccess-Policy",
"defaultAction": {
"type": "drop"
},
"sequences": [
{
"sequenceId": 1,
"sequenceName": "Device Access Control List",
"baseAction": "accept",
"sequenceType": "deviceaccesspolicy",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "destinationPort",
"value": "22"
},
{
"field": "sourceIp",
"value": "10.10.24.0/24"
},
{
"field": "sourcePort",
"value": "65000"
},
{
"field": "destinationIp",
"value": "10.10.10.1/32"
},
{
"field": "vpn",
"value": "10"
}
]
},
"actions": []
},
{
"sequenceId": 11,
"sequenceName": "Device Access Control List",
"baseAction": "drop",
"sequenceType": "deviceaccesspolicy",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "destinationPort",
"value": "161"
},
{
"field": "sourceDataPrefixList",
"ref": "6c2b7164-5de2-4775-938c-b443504324ab"
}
]
},
"actions": []
}
]
}
},
"vEdge route definition": {
"description": "vEdge route definition",
"value": {
"name": "Demo-Route-Policy",
"type": "vedgeRoute",
"description": "Demo-Route-Policy",
"defaultAction": {
"type": "reject"
},
"sequences": [
{
"sequenceId": 1,
"sequenceName": "Route",
"baseAction": "accept",
"sequenceType": "vedgeRoute",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "address",
"ref": "b5c4d764-20bc-4de3-9bac-52ef70f1186c"
},
{
"field": "asPath",
"ref": "79f8c180-1a23-4f09-800d-62652b571258"
},
{
"field": "community",
"matchFlag": "or",
"ref": "33de059b-27ec-4a83-be28-8985128381eb"
},
{
"field": "localPreference",
"value": "200"
},
{
"field": "metric",
"value": "100"
},
{
"field": "nextHop",
"ref": "b5c4d764-20bc-4de3-9bac-52ef70f1186c"
},
{
"field": "ompTag",
"value": "10"
},
{
"field": "affinity",
"value": "10"
},
{
"field": "origin",
"value": "igp"
},
{
"field": "ospfTag",
"value": "10"
},
{
"field": "peer",
"value": "10.0.0.1"
}
]
},
"actions": [
{
"type": "set",
"parameter": [
{
"field": "asPath",
"value": {
"exclude": "120 130",
"prepend": "65521 65521"
}
},
{
"field": "localPreference",
"value": "200"
},
{
"field": "metricType",
"value": "type1"
},
{
"field": "metric",
"value": "100"
},
{
"field": "nextHop",
"value": "10.0.0.1"
},
{
"field": "ompTag",
"value": "100"
},
{
"field": "weight",
"value": "200"
},
{
"field": "ospfTag",
"value": "122"
},
{
"field": "originator",
"value": "10.0.0.1"
},
{
"field": "origin",
"value": "igp"
},
{
"field": "community",
"value": "1000:10000"
}
]
}
]
}
]
}
},
"vSmart definition": {
"description": "vSmart definition",
"value": {
"policyDescription": "Demo-Centralized-Policy",
"policyType": "feature",
"policyName": "Demo-Centralized-Policy",
"policyDefinition": {
"assembly": [
{
"definitionId": "eb0daba9-7fc4-4f4f-bae7-cd958f81f863",
"type": "cflowd",
"entries": [
{
"siteLists": [
"5c58c36c-9cd6-468f-8434-ee6d5801c6ba",
"24747ccd-4f7f-4dfa-8800-34f565fb65b4"
]
}
]
},
{
"definitionId": "3e33fa50-a30d-4586-9d69-106121feaaf4",
"type": "data",
"entries": [
{
"direction": "service",
"siteLists": [
"5c58c36c-9cd6-468f-8434-ee6d5801c6ba",
"24747ccd-4f7f-4dfa-8800-34f565fb65b4"
],
"vpnLists": [
"cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"
]
}
]
},
{
"definitionId": "8b2e7c44-2666-48a7-87a0-36a43c2d003e",
"type": "appRoute",
"entries": [
{
"siteLists": [
"5c58c36c-9cd6-468f-8434-ee6d5801c6ba",
"24747ccd-4f7f-4dfa-8800-34f565fb65b4"
],
"vpnLists": [
"cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"
]
}
]
},
{
"definitionId": "1b76052e-1cb5-44b1-8e5e-4096cb261736",
"type": "vpnMembershipGroup"
},
{
"definitionId": "62960276-c797-41fd-bebb-c017fc752f4e",
"type": "hubAndSpoke"
}
]
},
"isPolicyActivated": false
}
},
"vEdge definition": {
"description": "vEdge definition",
"value": {
"policyDescription": "Demo-Local-Policy",
"policyType": "feature",
"policyName": "Demo-Local-Policy",
"policyDefinition": {
"assembly": [
{
"definitionId": "56283dcf-6dda-4831-bcd1-d9cf62d33fdc",
"type": "qosMap"
},
{
"definitionId": "a75ead1f-f6ab-4a80-af29-79b742b31c5c",
"type": "rewriteRule"
},
{
"definitionId": "555dd393-e7b6-4861-866f-f227f5f780b7",
"type": "deviceAccessPolicy"
},
{
"definitionId": "22655824-d0df-4a8b-9be0-9808938a0e6b",
"type": "vedgeRoute"
}
],
"settings": {
"flowVisibility": true,
"flowVisibilityIPv6": true,
"appVisibility": true,
"cloudQos": true,
"cloudQosServiceSide": true,
"implicitAclLogging": true,
"appVisibilityIPv6": true
}
},
"isPolicyActivated": false
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Task Id": {
"description": "Task Id",
"value": {
"definitionId": "00f718df-4f95-4363-8639-1fe855c9eb09"
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/definition/ruleset/bulk": {
"put": {
"tags": [
"Configuration - Rule Set Definition"
],
"description": "Create/Edit policy definitions in bulk",
"operationId": "savePolicyDefinitionInBulk_ConfigurationRuleSetDefinition_4003",
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/definition/ruleset/multiple/{id}": {
"put": {
"tags": [
"Configuration - Rule Set Definition"
],
"description": "Edit multiple policy definitions",
"operationId": "editMultiplePolicyDefinition_ConfigurationRuleSetDefinition_4903",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/definition/ruleset/preview": {
"post": {
"tags": [
"Configuration - Rule Set Definition"
],
"description": "Preview policy definition",
"operationId": "previewPolicyDefinition_ConfigurationRuleSetDefinition_4304",
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/definition/ruleset/preview/{id}": {
"get": {
"tags": [
"Configuration - Rule Set Definition"
],
"description": "Preview policy definition",
"operationId": "previewPolicyDefinitionById_ConfigurationRuleSetDefinition_4803",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/definition/ruleset/{id}": {
"delete": {
"tags": [
"Configuration - Rule Set Definition"
],
"description": "Delete policy definition",
"operationId": "deletePolicyDefinition_ConfigurationRuleSetDefinition_4006",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"get": {
"tags": [
"Configuration - Rule Set Definition"
],
"description": "Get a specific policy definitions",
"operationId": "getPolicyDefinition_ConfigurationRuleSetDefinition_4003",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
},
"put": {
"tags": [
"Configuration - Rule Set Definition"
],
"description": "Edit a policy definitions",
"operationId": "editPolicyDefinition_ConfigurationRuleSetDefinition_4003",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"ACL policy": {
"description": "ACL policy",
"value": {
"name": "Demo-ACL",
"type": "acl",
"description": "Demo-ACL",
"defaultAction": {
"type": "accept"
},
"sequences": [
{
"sequenceId": 1,
"sequenceName": "Access Control List",
"baseAction": "accept",
"sequenceType": "acl",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "dscp",
"value": "46"
},
{
"field": "protocol",
"value": "6"
}
]
},
"actions": [
{
"type": "class",
"parameter": {
"ref": "89d20034-7149-4492-b392-b5c4f7903235"
}
}
]
}
]
}
},
"ZBFW definition": {
"description": "ZBFW definition",
"value": {
"name": "Demo-ZBFW",
"type": "zoneBasedFW",
"description": "Demo-ZBFW",
"definition": {
"defaultAction": {
"type": "drop"
},
"sequences": [
{
"sequenceId": 1,
"sequenceName": "Demo-Rule-1",
"baseAction": "inspect",
"sequenceType": "zoneBasedFW",
"match": {
"entries": [
{
"field": "sourceDataPrefixList",
"ref": "ecbea5de-b200-4ff7-aa76-f537b5f858e9"
}
]
},
"actions": []
}
],
"entries": [
{
"sourceZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53",
"destinationZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53"
}
]
}
}
},
"IPS definition": {
"description": "IPS definition",
"value": {
"name": "Demo-IPS-Policy",
"type": "intrusionPrevention",
"description": "Testing",
"definition": {
"signatureSet": "security",
"inspectionMode": "detection",
"signatureWhiteList": {
"ref": "ad189f08-af06-4799-97d6-0a7c7409cb8d"
},
"logLevel": "error",
"logging": [],
"targetVpns": [
"10",
"20"
]
}
}
},
"URL filtering definition": {
"description": "URL filtering definition",
"value": {
"name": "Demo-URL-Filtering-Policy",
"type": "urlFiltering",
"description": "",
"definition": {
"webCategoriesAction": "block",
"webCategories": [
"auctions",
"bot-nets",
"news-and-media"
],
"webReputation": "moderate-risk",
"urlWhiteList": {
"ref": "c20e31fb-fcea-4f48-93e3-09d2c6492d8b"
},
"urlBlackList": {
"ref": "557ed432-6cf8-495b-a445-d340d4c6236e"
},
"blockPageAction": "text",
"blockPageContents": "Access to the requested page has been denied. Please contact your Network Administrator",
"enableAlerts": true,
"alerts": [
"blacklist",
"whitelist",
"categories-reputation"
],
"logging": [],
"targetVpns": [
"30"
]
}
}
},
"AMP definition": {
"description": "AMP definition",
"value": {
"name": "Demo-AMP-Policy",
"type": "advancedMalwareProtection",
"description": "",
"definition": {
"matchAllVpn": true,
"fileReputationCloudServer": "nam",
"fileReputationEstServer": "nam",
"fileReputationAlert": "critical",
"fileAnalysisCloudServer": "nam",
"fileAnalysisFileTypes": [
"pdf",
"ms-exe"
],
"fileAnalysisAlert": "critical",
"targetVpns": [
"10",
"20"
],
"fileAnalysisEnabled": true
}
}
},
"DNS definition": {
"description": "DNS definition",
"value": {
"name": "Demo-DNS-Policy",
"type": "DNSSecurity",
"description": "Testing",
"definition": {
"localDomainBypassList": {
"ref": "143f753f-8d51-4be6-805d-bc330f09982f"
},
"matchAllVpn": false,
"targetVpns": [
{
"vpns": [
"10"
],
"umbrellaDefault": false,
"childOrgId": "7999118",
"dnsServerIP": "10.10.10.1",
"localDomainBypassEnabled": true
}
],
"dnsCrypt": true,
"umbrellaData": {
"ref": "e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa"
}
}
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {
"masterTemplatesAffected": []
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/definition/securitygroup": {
"post": {
"tags": [
"Configuration - Security Group Definition"
],
"description": "Create policy definition",
"operationId": "createPolicyDefinition_ConfigurationSecurityGroupDefinition_4104",
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"ACL policy": {
"description": "ACL policy",
"value": {
"name": "Demo-ACL",
"type": "acl",
"description": "Demo-ACL",
"defaultAction": {
"type": "accept"
},
"sequences": [
{
"sequenceId": 1,
"sequenceName": "Access Control List",
"baseAction": "accept",
"sequenceType": "acl",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "dscp",
"value": "46"
}
]
},
"actions": [
{
"type": "class",
"parameter": {
"ref": "89d20034-7149-4492-b392-b5c4f7903235"
}
}
]
}
]
}
},
"ZBFW definition": {
"description": "ZBFW definition",
"value": {
"name": "Demo-ZBFW",
"type": "zoneBasedFW",
"description": "Demo-ZBFW",
"definition": {
"defaultAction": {
"type": "drop"
},
"sequences": [],
"entries": [
{
"sourceZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53",
"destinationZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53"
}
]
}
}
},
"IPS definition": {
"description": "IPS definition",
"value": {
"name": "Demo-IPS-Policy",
"type": "intrusionPrevention",
"description": "Testing",
"definition": {
"signatureSet": "security",
"inspectionMode": "detection",
"signatureWhiteList": {
"ref": "ad189f08-af06-4799-97d6-0a7c7409cb8d"
},
"logLevel": "error",
"logging": [],
"targetVpns": [
"10"
]
}
}
},
"URL filtering definition": {
"description": "URL filtering definition",
"value": {
"name": "Demo-URL-Filtering-Policy",
"type": "urlFiltering",
"description": "",
"definition": {
"webCategoriesAction": "block",
"webCategories": [
"auctions",
"bot-nets"
],
"webReputation": "moderate-risk",
"urlWhiteList": {
"ref": "c20e31fb-fcea-4f48-93e3-09d2c6492d8b"
},
"urlBlackList": {
"ref": "557ed432-6cf8-495b-a445-d340d4c6236e"
},
"blockPageAction": "text",
"blockPageContents": "Access to the requested page has been denied. Please contact your Network Administrator",
"enableAlerts": true,
"alerts": [
"blacklist",
"whitelist",
"categories-reputation"
],
"logging": [],
"targetVpns": [
"10",
"20"
]
}
}
},
"AMP definition": {
"description": "AMP definition",
"value": {
"name": "Demo-AMP-Policy",
"type": "advancedMalwareProtection",
"description": "",
"definition": {
"matchAllVpn": false,
"fileReputationCloudServer": "nam",
"fileReputationEstServer": "nam",
"fileReputationAlert": "critical",
"fileAnalysisCloudServer": "",
"fileAnalysisFileTypes": [],
"fileAnalysisAlert": "",
"targetVpns": [
"10",
"20"
]
}
}
},
"DNS definition": {
"description": "DNS definition",
"value": {
"name": "Demo-DNS-Policy",
"type": "DNSSecurity",
"description": "Testing",
"definition": {
"localDomainBypassList": {
"ref": "143f753f-8d51-4be6-805d-bc330f09982f"
},
"matchAllVpn": true,
"umbrellaDefault": true,
"childOrgId": "7999118",
"localDomainBypassEnabled": true,
"dnsCrypt": true,
"umbrellaData": {
"ref": "e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa"
}
}
}
},
"HubandSpoke definition": {
"description": "HubandSpoke definition",
"value": {
"name": "Demo-Hub-n-Spoke-Policy",
"type": "hubAndSpoke",
"description": "Demo-Hub-n-Spoke-Policy",
"definition": {
"vpnList": "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf",
"subDefinitions": [
{
"name": "My Hub-and-Spoke",
"equalPreference": false,
"advertiseTloc": true,
"spokes": [
{
"siteList": "5c58c36c-9cd6-468f-8434-ee6d5801c6ba",
"hubs": [
{
"siteList": "24747ccd-4f7f-4dfa-8800-34f565fb65b4",
"preference": "20",
"prefixLists": [
"b5c4d764-20bc-4de3-9bac-52ef70f1186c"
],
"ipv6PrefixLists": []
}
]
}
],
"tlocList": "1e97c258-4323-4754-9dc0-44e9656d43bf"
}
]
}
}
},
"VPN membership group definition": {
"description": "VPN membership group definition",
"value": {
"name": "Demo-VPN-Membership-Policy",
"type": "vpnMembershipGroup",
"description": "Demo-VPN-Membership-Policy",
"definition": {
"sites": [
{
"siteList": "24747ccd-4f7f-4dfa-8800-34f565fb65b4",
"vpnList": [
"cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"
]
},
{
"siteList": "5c58c36c-9cd6-468f-8434-ee6d5801c6ba",
"vpnList": [
"cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"
]
}
]
}
}
},
"AppRoute definition": {
"description": "AppRoute definition",
"value": {
"name": "Demo-AAR-Policy",
"type": "appRoute",
"description": "Demo-AAR-Policy",
"sequences": [
{
"sequenceId": 1,
"sequenceName": "App Route",
"sequenceType": "appRoute",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "appList",
"ref": "b6752dba-969b-46de-a7e7-da11910fb1bf"
},
{
"field": "dnsAppList",
"ref": "b6752dba-969b-46de-a7e7-da11910fb1bf"
},
{
"field": "dns",
"value": "request"
},
{
"field": "dscp",
"value": "46"
},
{
"field": "plp",
"value": "high"
},
{
"field": "protocol",
"value": "6"
},
{
"field": "sourceDataPrefixList",
"ref": "6c2b7164-5de2-4775-938c-b443504324ab"
},
{
"field": "sourcePort",
"value": "1025"
},
{
"field": "destinationDataPrefixList",
"ref": "6c2b7164-5de2-4775-938c-b443504324ab"
},
{
"field": "destinationPort",
"value": "65000"
}
]
},
"actions": [
{
"type": "backupSlaPreferredColor",
"parameter": "biz-internet"
},
{
"type": "count",
"parameter": "Demo-Counter"
},
{
"type": "log",
"parameter": ""
},
{
"type": "slaClass",
"parameter": [
{
"field": "name",
"ref": "46cea5a1-1570-4921-b87a-837d590eb37e"
},
{
"field": "preferredColor",
"value": "public-internet"
},
{
"field": "strict"
}
]
}
]
},
{
"sequenceId": 11,
"sequenceName": "App Route",
"sequenceType": "appRoute",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "saasAppList",
"ref": "1e6688ce-2d21-4d7a-9a93-ae6a8ebd4a06"
}
]
},
"actions": [
{
"type": "cloudSaas",
"parameter": ""
}
]
},
{
"sequenceId": 21,
"sequenceName": "App Route",
"sequenceType": "appRoute",
"sequenceIpType": "ipv6",
"match": {
"entries": [
{
"field": "dscp",
"value": "46"
},
{
"field": "protocol",
"value": "6"
},
{
"field": "sourceIpv6",
"value": "2001::/8"
},
{
"field": "sourcePort",
"value": "65000"
},
{
"field": "destinationIpv6",
"value": "2001::/8"
},
{
"field": "destinationPort",
"value": "65000"
}
]
},
"actions": [
{
"type": "backupSlaPreferredColor",
"parameter": "biz-internet"
},
{
"type": "count",
"parameter": "Demo-Counter"
},
{
"type": "log",
"parameter": ""
},
{
"type": "slaClass",
"parameter": [
{
"field": "name",
"ref": "46cea5a1-1570-4921-b87a-837d590eb37e"
},
{
"field": "preferredColor",
"value": "public-internet"
},
{
"field": "strict"
}
]
}
]
}
]
}
},
"Data policy definition": {
"description": "Data policy definition",
"value": {
"name": "Demo-Data-Policy",
"type": "data",
"description": "Demo-Data-Policy",
"defaultAction": {
"type": "drop"
},
"sequences": [
{
"sequenceId": 1,
"sequenceName": "Custom",
"baseAction": "accept",
"sequenceType": "data",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "appList",
"ref": "b6752dba-969b-46de-a7e7-da11910fb1bf"
},
{
"field": "dnsAppList",
"ref": "b6752dba-969b-46de-a7e7-da11910fb1bf"
},
{
"field": "dns",
"value": "response"
},
{
"field": "dscp",
"value": "46"
},
{
"field": "packetLength",
"value": "1504"
},
{
"field": "plp",
"value": "high"
},
{
"field": "protocol",
"value": "6"
},
{
"field": "sourceDataPrefixList",
"ref": "6c2b7164-5de2-4775-938c-b443504324ab"
},
{
"field": "sourcePort",
"value": "65000"
},
{
"field": "destinationIp",
"value": "10.0.0.0/12"
},
{
"field": "destinationPort",
"value": "65000"
},
{
"field": "tcp",
"value": "syn"
}
]
},
"actions": [
{
"type": "count",
"parameter": "Demo-Counter"
},
{
"type": "set",
"parameter": [
{
"field": "dscp",
"value": "34"
},
{
"field": "forwardingClass",
"value": "ef-class"
},
{
"field": "localTlocList",
"value": {
"color": "public-internet",
"restrict": "",
"encap": "ipsec"
}
},
{
"field": "nextHop",
"value": "10.0.0.1"
},
{
"field": "policer",
"ref": "ecf250c7-bef0-405b-8e74-4d67440cac90"
}
]
},
{
"type": "cflowd"
},
{
"type": "log",
"parameter": ""
},
{
"type": "nat",
"parameter": {
"field": "pool",
"value": "1"
}
},
{
"type": "redirectDns",
"parameter": {
"field": "dnsType",
"value": "umbrella"
}
}
]
},
{
"sequenceId": 11,
"sequenceName": "Custom",
"baseAction": "accept",
"sequenceType": "data",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "appList",
"ref": "b6752dba-969b-46de-a7e7-da11910fb1bf"
}
]
},
"actions": [
{
"type": "set",
"parameter": [
{
"field": "service",
"value": {
"type": "FW",
"vpn": "10",
"tloc": {
"ip": "10.0.0.1",
"color": "biz-internet",
"encap": "ipsec"
}
}
}
]
},
{
"type": "tcpOptimization",
"parameter": ""
},
{
"type": "lossProtect",
"parameter": "fecAdaptive"
},
{
"type": "lossProtectFec",
"parameter": "fecAdaptive"
},
{
"type": "sig",
"parameter": ""
}
]
}
]
}
},
"CFlowd definition": {
"description": "CFlowd definition",
"value": {
"name": "Demo-cflowd-Policy",
"type": "cflowd",
"description": "Demo-cflowd-Policy",
"definition": {
"flowActiveTimeout": 3600,
"flowInactiveTimeout": 3600,
"flowSamplingInterval": 65513,
"templateRefresh": 86400,
"collectors": [
{
"vpn": "10",
"address": "10.0.0.1",
"port": 9912,
"transport": "transport_tcp",
"sourceInterface": "ge0/1"
},
{
"vpn": "20",
"address": "10.0.0.1",
"port": 1025,
"transport": "transport_udp",
"sourceInterface": "GigabitEthernet0/0/1"
}
],
"protocol": "ipv4"
}
}
},
"QoS map definition": {
"description": "QoS map definition",
"value": {
"name": "Demo-QoS-Policy",
"type": "qosMap",
"description": "Demo-QoS-Policy",
"definition": {
"qosSchedulers": [
{
"queue": "0",
"bandwidthPercent": "75",
"bufferPercent": "75",
"burst": "15000",
"scheduling": "llq",
"drops": "tail-drop",
"classMapRef": ""
},
{
"queue": "7",
"bandwidthPercent": "25",
"bufferPercent": "25",
"scheduling": "wrr",
"drops": "red-drop",
"classMapRef": "4484c444-b956-4016-bd15-538b74fc2785"
}
]
}
}
},
"VPN-QoS map definition": {
"description": "VPN-QoS map definition",
"value": {
"name": "Demo-VPN-QoS-Policy",
"type": "vpnQosMap",
"description": "Demo-VPN-QoS-Policy",
"definition": {
"vpnQosSchedulers": [
{
"vpnListRef": "",
"bandwidthRate": "100000",
"shapingRate": "120000",
"childMapRef": ""
},
{
"childMapRef": ""
}
]
}
}
},
"Rewrite rule definition": {
"description": "Rewrite rule definition",
"value": {
"name": "Demo-Rewrite-Rule",
"type": "rewriteRule",
"description": "Demo-Rewrite-Rule",
"definition": {
"rules": [
{
"class": "4484c444-b956-4016-bd15-538b74fc2785",
"plp": "low",
"dscp": "46",
"layer2Cos": "2"
}
]
}
}
},
"Device access policy definition": {
"description": "Device access policy definition",
"value": {
"name": "Demo-DeviceAccess-Policy",
"type": "deviceaccesspolicy",
"description": "Demo-DeviceAccess-Policy",
"defaultAction": {
"type": "drop"
},
"sequences": [
{
"sequenceId": 1,
"sequenceName": "Device Access Control List",
"baseAction": "accept",
"sequenceType": "deviceaccesspolicy",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "destinationPort",
"value": "22"
},
{
"field": "sourceIp",
"value": "10.10.24.0/24"
},
{
"field": "sourcePort",
"value": "65000"
},
{
"field": "destinationIp",
"value": "10.10.10.1/32"
},
{
"field": "vpn",
"value": "10"
}
]
},
"actions": []
},
{
"sequenceId": 11,
"sequenceName": "Device Access Control List",
"baseAction": "drop",
"sequenceType": "deviceaccesspolicy",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "destinationPort",
"value": "161"
},
{
"field": "sourceDataPrefixList",
"ref": "6c2b7164-5de2-4775-938c-b443504324ab"
}
]
},
"actions": []
}
]
}
},
"vEdge route definition": {
"description": "vEdge route definition",
"value": {
"name": "Demo-Route-Policy",
"type": "vedgeRoute",
"description": "Demo-Route-Policy",
"defaultAction": {
"type": "reject"
},
"sequences": [
{
"sequenceId": 1,
"sequenceName": "Route",
"baseAction": "accept",
"sequenceType": "vedgeRoute",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "address",
"ref": "b5c4d764-20bc-4de3-9bac-52ef70f1186c"
},
{
"field": "asPath",
"ref": "79f8c180-1a23-4f09-800d-62652b571258"
},
{
"field": "community",
"matchFlag": "or",
"ref": "33de059b-27ec-4a83-be28-8985128381eb"
},
{
"field": "localPreference",
"value": "200"
},
{
"field": "metric",
"value": "100"
},
{
"field": "nextHop",
"ref": "b5c4d764-20bc-4de3-9bac-52ef70f1186c"
},
{
"field": "ompTag",
"value": "10"
},
{
"field": "affinity",
"value": "10"
},
{
"field": "origin",
"value": "igp"
},
{
"field": "ospfTag",
"value": "10"
},
{
"field": "peer",
"value": "10.0.0.1"
}
]
},
"actions": [
{
"type": "set",
"parameter": [
{
"field": "asPath",
"value": {
"exclude": "120 130",
"prepend": "65521 65521"
}
},
{
"field": "localPreference",
"value": "200"
},
{
"field": "metricType",
"value": "type1"
},
{
"field": "metric",
"value": "100"
},
{
"field": "nextHop",
"value": "10.0.0.1"
},
{
"field": "ompTag",
"value": "100"
},
{
"field": "weight",
"value": "200"
},
{
"field": "ospfTag",
"value": "122"
},
{
"field": "originator",
"value": "10.0.0.1"
},
{
"field": "origin",
"value": "igp"
},
{
"field": "community",
"value": "1000:10000"
}
]
}
]
}
]
}
},
"vSmart definition": {
"description": "vSmart definition",
"value": {
"policyDescription": "Demo-Centralized-Policy",
"policyType": "feature",
"policyName": "Demo-Centralized-Policy",
"policyDefinition": {
"assembly": [
{
"definitionId": "eb0daba9-7fc4-4f4f-bae7-cd958f81f863",
"type": "cflowd",
"entries": [
{
"siteLists": [
"5c58c36c-9cd6-468f-8434-ee6d5801c6ba",
"24747ccd-4f7f-4dfa-8800-34f565fb65b4"
]
}
]
},
{
"definitionId": "3e33fa50-a30d-4586-9d69-106121feaaf4",
"type": "data",
"entries": [
{
"direction": "service",
"siteLists": [
"5c58c36c-9cd6-468f-8434-ee6d5801c6ba",
"24747ccd-4f7f-4dfa-8800-34f565fb65b4"
],
"vpnLists": [
"cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"
]
}
]
},
{
"definitionId": "8b2e7c44-2666-48a7-87a0-36a43c2d003e",
"type": "appRoute",
"entries": [
{
"siteLists": [
"5c58c36c-9cd6-468f-8434-ee6d5801c6ba",
"24747ccd-4f7f-4dfa-8800-34f565fb65b4"
],
"vpnLists": [
"cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"
]
}
]
},
{
"definitionId": "1b76052e-1cb5-44b1-8e5e-4096cb261736",
"type": "vpnMembershipGroup"
},
{
"definitionId": "62960276-c797-41fd-bebb-c017fc752f4e",
"type": "hubAndSpoke"
}
]
},
"isPolicyActivated": false
}
},
"vEdge definition": {
"description": "vEdge definition",
"value": {
"policyDescription": "Demo-Local-Policy",
"policyType": "feature",
"policyName": "Demo-Local-Policy",
"policyDefinition": {
"assembly": [
{
"definitionId": "56283dcf-6dda-4831-bcd1-d9cf62d33fdc",
"type": "qosMap"
},
{
"definitionId": "a75ead1f-f6ab-4a80-af29-79b742b31c5c",
"type": "rewriteRule"
},
{
"definitionId": "555dd393-e7b6-4861-866f-f227f5f780b7",
"type": "deviceAccessPolicy"
},
{
"definitionId": "22655824-d0df-4a8b-9be0-9808938a0e6b",
"type": "vedgeRoute"
}
],
"settings": {
"flowVisibility": true,
"flowVisibilityIPv6": true,
"appVisibility": true,
"cloudQos": true,
"cloudQosServiceSide": true,
"implicitAclLogging": true,
"appVisibilityIPv6": true
}
},
"isPolicyActivated": false
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Task Id": {
"description": "Task Id",
"value": {
"definitionId": "00f718df-4f95-4363-8639-1fe855c9eb09"
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"get": {
"tags": [
"Configuration - Security Group Definition"
],
"description": "Get policy definitions",
"operationId": "getDefinitions_ConfigurationSecurityGroupDefinition_4103",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/definition/securitygroup/bulk": {
"put": {
"tags": [
"Configuration - Security Group Definition"
],
"description": "Create/Edit policy definitions in bulk",
"operationId": "savePolicyDefinitionInBulk_ConfigurationSecurityGroupDefinition_4603",
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/definition/securitygroup/multiple/{id}": {
"put": {
"tags": [
"Configuration - Security Group Definition"
],
"description": "Edit multiple policy definitions",
"operationId": "editMultiplePolicyDefinition_ConfigurationSecurityGroupDefinition_5503",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/definition/securitygroup/preview": {
"post": {
"tags": [
"Configuration - Security Group Definition"
],
"description": "Preview policy definition",
"operationId": "previewPolicyDefinition_ConfigurationSecurityGroupDefinition_4904",
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/definition/securitygroup/preview/{id}": {
"get": {
"tags": [
"Configuration - Security Group Definition"
],
"description": "Preview policy definition",
"operationId": "previewPolicyDefinitionById_ConfigurationSecurityGroupDefinition_5403",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/definition/securitygroup/{id}": {
"put": {
"tags": [
"Configuration - Security Group Definition"
],
"description": "Edit a policy definitions",
"operationId": "editPolicyDefinition_ConfigurationSecurityGroupDefinition_4603",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"ACL policy": {
"description": "ACL policy",
"value": {
"name": "Demo-ACL",
"type": "acl",
"description": "Demo-ACL",
"defaultAction": {
"type": "accept"
},
"sequences": [
{
"sequenceId": 1,
"sequenceName": "Access Control List",
"baseAction": "accept",
"sequenceType": "acl",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "dscp",
"value": "46"
},
{
"field": "protocol",
"value": "6"
}
]
},
"actions": [
{
"type": "class",
"parameter": {
"ref": "89d20034-7149-4492-b392-b5c4f7903235"
}
}
]
}
]
}
},
"ZBFW definition": {
"description": "ZBFW definition",
"value": {
"name": "Demo-ZBFW",
"type": "zoneBasedFW",
"description": "Demo-ZBFW",
"definition": {
"defaultAction": {
"type": "drop"
},
"sequences": [
{
"sequenceId": 1,
"sequenceName": "Demo-Rule-1",
"baseAction": "inspect",
"sequenceType": "zoneBasedFW",
"match": {
"entries": [
{
"field": "sourceDataPrefixList",
"ref": "ecbea5de-b200-4ff7-aa76-f537b5f858e9"
}
]
},
"actions": []
}
],
"entries": [
{
"sourceZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53",
"destinationZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53"
}
]
}
}
},
"IPS definition": {
"description": "IPS definition",
"value": {
"name": "Demo-IPS-Policy",
"type": "intrusionPrevention",
"description": "Testing",
"definition": {
"signatureSet": "security",
"inspectionMode": "detection",
"signatureWhiteList": {
"ref": "ad189f08-af06-4799-97d6-0a7c7409cb8d"
},
"logLevel": "error",
"logging": [],
"targetVpns": [
"10",
"20"
]
}
}
},
"URL filtering definition": {
"description": "URL filtering definition",
"value": {
"name": "Demo-URL-Filtering-Policy",
"type": "urlFiltering",
"description": "",
"definition": {
"webCategoriesAction": "block",
"webCategories": [
"auctions",
"bot-nets",
"news-and-media"
],
"webReputation": "moderate-risk",
"urlWhiteList": {
"ref": "c20e31fb-fcea-4f48-93e3-09d2c6492d8b"
},
"urlBlackList": {
"ref": "557ed432-6cf8-495b-a445-d340d4c6236e"
},
"blockPageAction": "text",
"blockPageContents": "Access to the requested page has been denied. Please contact your Network Administrator",
"enableAlerts": true,
"alerts": [
"blacklist",
"whitelist",
"categories-reputation"
],
"logging": [],
"targetVpns": [
"30"
]
}
}
},
"AMP definition": {
"description": "AMP definition",
"value": {
"name": "Demo-AMP-Policy",
"type": "advancedMalwareProtection",
"description": "",
"definition": {
"matchAllVpn": true,
"fileReputationCloudServer": "nam",
"fileReputationEstServer": "nam",
"fileReputationAlert": "critical",
"fileAnalysisCloudServer": "nam",
"fileAnalysisFileTypes": [
"pdf",
"ms-exe"
],
"fileAnalysisAlert": "critical",
"targetVpns": [
"10",
"20"
],
"fileAnalysisEnabled": true
}
}
},
"DNS definition": {
"description": "DNS definition",
"value": {
"name": "Demo-DNS-Policy",
"type": "DNSSecurity",
"description": "Testing",
"definition": {
"localDomainBypassList": {
"ref": "143f753f-8d51-4be6-805d-bc330f09982f"
},
"matchAllVpn": false,
"targetVpns": [
{
"vpns": [
"10"
],
"umbrellaDefault": false,
"childOrgId": "7999118",
"dnsServerIP": "10.10.10.1",
"localDomainBypassEnabled": true
}
],
"dnsCrypt": true,
"umbrellaData": {
"ref": "e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa"
}
}
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {
"masterTemplatesAffected": []
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"get": {
"tags": [
"Configuration - Security Group Definition"
],
"description": "Get a specific policy definitions",
"operationId": "getPolicyDefinition_ConfigurationSecurityGroupDefinition_4603",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
},
"delete": {
"tags": [
"Configuration - Security Group Definition"
],
"description": "Delete policy definition",
"operationId": "deletePolicyDefinition_ConfigurationSecurityGroupDefinition_4606",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/definition/srstphoneprofile": {
"post": {
"tags": [
"Configuration - Policy DialPeer Definition Builder"
],
"description": "Create policy definition",
"operationId": "createPolicyDefinition_ConfigurationPolicyDialpeerDefinitionBuilder_4404",
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"ACL policy": {
"description": "ACL policy",
"value": {
"name": "Demo-ACL",
"type": "acl",
"description": "Demo-ACL",
"defaultAction": {
"type": "accept"
},
"sequences": [
{
"sequenceId": 1,
"sequenceName": "Access Control List",
"baseAction": "accept",
"sequenceType": "acl",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "dscp",
"value": "46"
}
]
},
"actions": [
{
"type": "class",
"parameter": {
"ref": "89d20034-7149-4492-b392-b5c4f7903235"
}
}
]
}
]
}
},
"ZBFW definition": {
"description": "ZBFW definition",
"value": {
"name": "Demo-ZBFW",
"type": "zoneBasedFW",
"description": "Demo-ZBFW",
"definition": {
"defaultAction": {
"type": "drop"
},
"sequences": [],
"entries": [
{
"sourceZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53",
"destinationZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53"
}
]
}
}
},
"IPS definition": {
"description": "IPS definition",
"value": {
"name": "Demo-IPS-Policy",
"type": "intrusionPrevention",
"description": "Testing",
"definition": {
"signatureSet": "security",
"inspectionMode": "detection",
"signatureWhiteList": {
"ref": "ad189f08-af06-4799-97d6-0a7c7409cb8d"
},
"logLevel": "error",
"logging": [],
"targetVpns": [
"10"
]
}
}
},
"URL filtering definition": {
"description": "URL filtering definition",
"value": {
"name": "Demo-URL-Filtering-Policy",
"type": "urlFiltering",
"description": "",
"definition": {
"webCategoriesAction": "block",
"webCategories": [
"auctions",
"bot-nets"
],
"webReputation": "moderate-risk",
"urlWhiteList": {
"ref": "c20e31fb-fcea-4f48-93e3-09d2c6492d8b"
},
"urlBlackList": {
"ref": "557ed432-6cf8-495b-a445-d340d4c6236e"
},
"blockPageAction": "text",
"blockPageContents": "Access to the requested page has been denied. Please contact your Network Administrator",
"enableAlerts": true,
"alerts": [
"blacklist",
"whitelist",
"categories-reputation"
],
"logging": [],
"targetVpns": [
"10",
"20"
]
}
}
},
"AMP definition": {
"description": "AMP definition",
"value": {
"name": "Demo-AMP-Policy",
"type": "advancedMalwareProtection",
"description": "",
"definition": {
"matchAllVpn": false,
"fileReputationCloudServer": "nam",
"fileReputationEstServer": "nam",
"fileReputationAlert": "critical",
"fileAnalysisCloudServer": "",
"fileAnalysisFileTypes": [],
"fileAnalysisAlert": "",
"targetVpns": [
"10",
"20"
]
}
}
},
"DNS definition": {
"description": "DNS definition",
"value": {
"name": "Demo-DNS-Policy",
"type": "DNSSecurity",
"description": "Testing",
"definition": {
"localDomainBypassList": {
"ref": "143f753f-8d51-4be6-805d-bc330f09982f"
},
"matchAllVpn": true,
"umbrellaDefault": true,
"childOrgId": "7999118",
"localDomainBypassEnabled": true,
"dnsCrypt": true,
"umbrellaData": {
"ref": "e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa"
}
}
}
},
"HubandSpoke definition": {
"description": "HubandSpoke definition",
"value": {
"name": "Demo-Hub-n-Spoke-Policy",
"type": "hubAndSpoke",
"description": "Demo-Hub-n-Spoke-Policy",
"definition": {
"vpnList": "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf",
"subDefinitions": [
{
"name": "My Hub-and-Spoke",
"equalPreference": false,
"advertiseTloc": true,
"spokes": [
{
"siteList": "5c58c36c-9cd6-468f-8434-ee6d5801c6ba",
"hubs": [
{
"siteList": "24747ccd-4f7f-4dfa-8800-34f565fb65b4",
"preference": "20",
"prefixLists": [
"b5c4d764-20bc-4de3-9bac-52ef70f1186c"
],
"ipv6PrefixLists": []
}
]
}
],
"tlocList": "1e97c258-4323-4754-9dc0-44e9656d43bf"
}
]
}
}
},
"VPN membership group definition": {
"description": "VPN membership group definition",
"value": {
"name": "Demo-VPN-Membership-Policy",
"type": "vpnMembershipGroup",
"description": "Demo-VPN-Membership-Policy",
"definition": {
"sites": [
{
"siteList": "24747ccd-4f7f-4dfa-8800-34f565fb65b4",
"vpnList": [
"cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"
]
},
{
"siteList": "5c58c36c-9cd6-468f-8434-ee6d5801c6ba",
"vpnList": [
"cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"
]
}
]
}
}
},
"AppRoute definition": {
"description": "AppRoute definition",
"value": {
"name": "Demo-AAR-Policy",
"type": "appRoute",
"description": "Demo-AAR-Policy",
"sequences": [
{
"sequenceId": 1,
"sequenceName": "App Route",
"sequenceType": "appRoute",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "appList",
"ref": "b6752dba-969b-46de-a7e7-da11910fb1bf"
},
{
"field": "dnsAppList",
"ref": "b6752dba-969b-46de-a7e7-da11910fb1bf"
},
{
"field": "dns",
"value": "request"
},
{
"field": "dscp",
"value": "46"
},
{
"field": "plp",
"value": "high"
},
{
"field": "protocol",
"value": "6"
},
{
"field": "sourceDataPrefixList",
"ref": "6c2b7164-5de2-4775-938c-b443504324ab"
},
{
"field": "sourcePort",
"value": "1025"
},
{
"field": "destinationDataPrefixList",
"ref": "6c2b7164-5de2-4775-938c-b443504324ab"
},
{
"field": "destinationPort",
"value": "65000"
}
]
},
"actions": [
{
"type": "backupSlaPreferredColor",
"parameter": "biz-internet"
},
{
"type": "count",
"parameter": "Demo-Counter"
},
{
"type": "log",
"parameter": ""
},
{
"type": "slaClass",
"parameter": [
{
"field": "name",
"ref": "46cea5a1-1570-4921-b87a-837d590eb37e"
},
{
"field": "preferredColor",
"value": "public-internet"
},
{
"field": "strict"
}
]
}
]
},
{
"sequenceId": 11,
"sequenceName": "App Route",
"sequenceType": "appRoute",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "saasAppList",
"ref": "1e6688ce-2d21-4d7a-9a93-ae6a8ebd4a06"
}
]
},
"actions": [
{
"type": "cloudSaas",
"parameter": ""
}
]
},
{
"sequenceId": 21,
"sequenceName": "App Route",
"sequenceType": "appRoute",
"sequenceIpType": "ipv6",
"match": {
"entries": [
{
"field": "dscp",
"value": "46"
},
{
"field": "protocol",
"value": "6"
},
{
"field": "sourceIpv6",
"value": "2001::/8"
},
{
"field": "sourcePort",
"value": "65000"
},
{
"field": "destinationIpv6",
"value": "2001::/8"
},
{
"field": "destinationPort",
"value": "65000"
}
]
},
"actions": [
{
"type": "backupSlaPreferredColor",
"parameter": "biz-internet"
},
{
"type": "count",
"parameter": "Demo-Counter"
},
{
"type": "log",
"parameter": ""
},
{
"type": "slaClass",
"parameter": [
{
"field": "name",
"ref": "46cea5a1-1570-4921-b87a-837d590eb37e"
},
{
"field": "preferredColor",
"value": "public-internet"
},
{
"field": "strict"
}
]
}
]
}
]
}
},
"Data policy definition": {
"description": "Data policy definition",
"value": {
"name": "Demo-Data-Policy",
"type": "data",
"description": "Demo-Data-Policy",
"defaultAction": {
"type": "drop"
},
"sequences": [
{
"sequenceId": 1,
"sequenceName": "Custom",
"baseAction": "accept",
"sequenceType": "data",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "appList",
"ref": "b6752dba-969b-46de-a7e7-da11910fb1bf"
},
{
"field": "dnsAppList",
"ref": "b6752dba-969b-46de-a7e7-da11910fb1bf"
},
{
"field": "dns",
"value": "response"
},
{
"field": "dscp",
"value": "46"
},
{
"field": "packetLength",
"value": "1504"
},
{
"field": "plp",
"value": "high"
},
{
"field": "protocol",
"value": "6"
},
{
"field": "sourceDataPrefixList",
"ref": "6c2b7164-5de2-4775-938c-b443504324ab"
},
{
"field": "sourcePort",
"value": "65000"
},
{
"field": "destinationIp",
"value": "10.0.0.0/12"
},
{
"field": "destinationPort",
"value": "65000"
},
{
"field": "tcp",
"value": "syn"
}
]
},
"actions": [
{
"type": "count",
"parameter": "Demo-Counter"
},
{
"type": "set",
"parameter": [
{
"field": "dscp",
"value": "34"
},
{
"field": "forwardingClass",
"value": "ef-class"
},
{
"field": "localTlocList",
"value": {
"color": "public-internet",
"restrict": "",
"encap": "ipsec"
}
},
{
"field": "nextHop",
"value": "10.0.0.1"
},
{
"field": "policer",
"ref": "ecf250c7-bef0-405b-8e74-4d67440cac90"
}
]
},
{
"type": "cflowd"
},
{
"type": "log",
"parameter": ""
},
{
"type": "nat",
"parameter": {
"field": "pool",
"value": "1"
}
},
{
"type": "redirectDns",
"parameter": {
"field": "dnsType",
"value": "umbrella"
}
}
]
},
{
"sequenceId": 11,
"sequenceName": "Custom",
"baseAction": "accept",
"sequenceType": "data",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "appList",
"ref": "b6752dba-969b-46de-a7e7-da11910fb1bf"
}
]
},
"actions": [
{
"type": "set",
"parameter": [
{
"field": "service",
"value": {
"type": "FW",
"vpn": "10",
"tloc": {
"ip": "10.0.0.1",
"color": "biz-internet",
"encap": "ipsec"
}
}
}
]
},
{
"type": "tcpOptimization",
"parameter": ""
},
{
"type": "lossProtect",
"parameter": "fecAdaptive"
},
{
"type": "lossProtectFec",
"parameter": "fecAdaptive"
},
{
"type": "sig",
"parameter": ""
}
]
}
]
}
},
"CFlowd definition": {
"description": "CFlowd definition",
"value": {
"name": "Demo-cflowd-Policy",
"type": "cflowd",
"description": "Demo-cflowd-Policy",
"definition": {
"flowActiveTimeout": 3600,
"flowInactiveTimeout": 3600,
"flowSamplingInterval": 65513,
"templateRefresh": 86400,
"collectors": [
{
"vpn": "10",
"address": "10.0.0.1",
"port": 9912,
"transport": "transport_tcp",
"sourceInterface": "ge0/1"
},
{
"vpn": "20",
"address": "10.0.0.1",
"port": 1025,
"transport": "transport_udp",
"sourceInterface": "GigabitEthernet0/0/1"
}
],
"protocol": "ipv4"
}
}
},
"QoS map definition": {
"description": "QoS map definition",
"value": {
"name": "Demo-QoS-Policy",
"type": "qosMap",
"description": "Demo-QoS-Policy",
"definition": {
"qosSchedulers": [
{
"queue": "0",
"bandwidthPercent": "75",
"bufferPercent": "75",
"burst": "15000",
"scheduling": "llq",
"drops": "tail-drop",
"classMapRef": ""
},
{
"queue": "7",
"bandwidthPercent": "25",
"bufferPercent": "25",
"scheduling": "wrr",
"drops": "red-drop",
"classMapRef": "4484c444-b956-4016-bd15-538b74fc2785"
}
]
}
}
},
"VPN-QoS map definition": {
"description": "VPN-QoS map definition",
"value": {
"name": "Demo-VPN-QoS-Policy",
"type": "vpnQosMap",
"description": "Demo-VPN-QoS-Policy",
"definition": {
"vpnQosSchedulers": [
{
"vpnListRef": "",
"bandwidthRate": "100000",
"shapingRate": "120000",
"childMapRef": ""
},
{
"childMapRef": ""
}
]
}
}
},
"Rewrite rule definition": {
"description": "Rewrite rule definition",
"value": {
"name": "Demo-Rewrite-Rule",
"type": "rewriteRule",
"description": "Demo-Rewrite-Rule",
"definition": {
"rules": [
{
"class": "4484c444-b956-4016-bd15-538b74fc2785",
"plp": "low",
"dscp": "46",
"layer2Cos": "2"
}
]
}
}
},
"Device access policy definition": {
"description": "Device access policy definition",
"value": {
"name": "Demo-DeviceAccess-Policy",
"type": "deviceaccesspolicy",
"description": "Demo-DeviceAccess-Policy",
"defaultAction": {
"type": "drop"
},
"sequences": [
{
"sequenceId": 1,
"sequenceName": "Device Access Control List",
"baseAction": "accept",
"sequenceType": "deviceaccesspolicy",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "destinationPort",
"value": "22"
},
{
"field": "sourceIp",
"value": "10.10.24.0/24"
},
{
"field": "sourcePort",
"value": "65000"
},
{
"field": "destinationIp",
"value": "10.10.10.1/32"
},
{
"field": "vpn",
"value": "10"
}
]
},
"actions": []
},
{
"sequenceId": 11,
"sequenceName": "Device Access Control List",
"baseAction": "drop",
"sequenceType": "deviceaccesspolicy",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "destinationPort",
"value": "161"
},
{
"field": "sourceDataPrefixList",
"ref": "6c2b7164-5de2-4775-938c-b443504324ab"
}
]
},
"actions": []
}
]
}
},
"vEdge route definition": {
"description": "vEdge route definition",
"value": {
"name": "Demo-Route-Policy",
"type": "vedgeRoute",
"description": "Demo-Route-Policy",
"defaultAction": {
"type": "reject"
},
"sequences": [
{
"sequenceId": 1,
"sequenceName": "Route",
"baseAction": "accept",
"sequenceType": "vedgeRoute",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "address",
"ref": "b5c4d764-20bc-4de3-9bac-52ef70f1186c"
},
{
"field": "asPath",
"ref": "79f8c180-1a23-4f09-800d-62652b571258"
},
{
"field": "community",
"matchFlag": "or",
"ref": "33de059b-27ec-4a83-be28-8985128381eb"
},
{
"field": "localPreference",
"value": "200"
},
{
"field": "metric",
"value": "100"
},
{
"field": "nextHop",
"ref": "b5c4d764-20bc-4de3-9bac-52ef70f1186c"
},
{
"field": "ompTag",
"value": "10"
},
{
"field": "affinity",
"value": "10"
},
{
"field": "origin",
"value": "igp"
},
{
"field": "ospfTag",
"value": "10"
},
{
"field": "peer",
"value": "10.0.0.1"
}
]
},
"actions": [
{
"type": "set",
"parameter": [
{
"field": "asPath",
"value": {
"exclude": "120 130",
"prepend": "65521 65521"
}
},
{
"field": "localPreference",
"value": "200"
},
{
"field": "metricType",
"value": "type1"
},
{
"field": "metric",
"value": "100"
},
{
"field": "nextHop",
"value": "10.0.0.1"
},
{
"field": "ompTag",
"value": "100"
},
{
"field": "weight",
"value": "200"
},
{
"field": "ospfTag",
"value": "122"
},
{
"field": "originator",
"value": "10.0.0.1"
},
{
"field": "origin",
"value": "igp"
},
{
"field": "community",
"value": "1000:10000"
}
]
}
]
}
]
}
},
"vSmart definition": {
"description": "vSmart definition",
"value": {
"policyDescription": "Demo-Centralized-Policy",
"policyType": "feature",
"policyName": "Demo-Centralized-Policy",
"policyDefinition": {
"assembly": [
{
"definitionId": "eb0daba9-7fc4-4f4f-bae7-cd958f81f863",
"type": "cflowd",
"entries": [
{
"siteLists": [
"5c58c36c-9cd6-468f-8434-ee6d5801c6ba",
"24747ccd-4f7f-4dfa-8800-34f565fb65b4"
]
}
]
},
{
"definitionId": "3e33fa50-a30d-4586-9d69-106121feaaf4",
"type": "data",
"entries": [
{
"direction": "service",
"siteLists": [
"5c58c36c-9cd6-468f-8434-ee6d5801c6ba",
"24747ccd-4f7f-4dfa-8800-34f565fb65b4"
],
"vpnLists": [
"cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"
]
}
]
},
{
"definitionId": "8b2e7c44-2666-48a7-87a0-36a43c2d003e",
"type": "appRoute",
"entries": [
{
"siteLists": [
"5c58c36c-9cd6-468f-8434-ee6d5801c6ba",
"24747ccd-4f7f-4dfa-8800-34f565fb65b4"
],
"vpnLists": [
"cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"
]
}
]
},
{
"definitionId": "1b76052e-1cb5-44b1-8e5e-4096cb261736",
"type": "vpnMembershipGroup"
},
{
"definitionId": "62960276-c797-41fd-bebb-c017fc752f4e",
"type": "hubAndSpoke"
}
]
},
"isPolicyActivated": false
}
},
"vEdge definition": {
"description": "vEdge definition",
"value": {
"policyDescription": "Demo-Local-Policy",
"policyType": "feature",
"policyName": "Demo-Local-Policy",
"policyDefinition": {
"assembly": [
{
"definitionId": "56283dcf-6dda-4831-bcd1-d9cf62d33fdc",
"type": "qosMap"
},
{
"definitionId": "a75ead1f-f6ab-4a80-af29-79b742b31c5c",
"type": "rewriteRule"
},
{
"definitionId": "555dd393-e7b6-4861-866f-f227f5f780b7",
"type": "deviceAccessPolicy"
},
{
"definitionId": "22655824-d0df-4a8b-9be0-9808938a0e6b",
"type": "vedgeRoute"
}
],
"settings": {
"flowVisibility": true,
"flowVisibilityIPv6": true,
"appVisibility": true,
"cloudQos": true,
"cloudQosServiceSide": true,
"implicitAclLogging": true,
"appVisibilityIPv6": true
}
},
"isPolicyActivated": false
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Task Id": {
"description": "Task Id",
"value": {
"definitionId": "00f718df-4f95-4363-8639-1fe855c9eb09"
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"get": {
"tags": [
"Configuration - Policy DialPeer Definition Builder"
],
"description": "Get policy definitions",
"operationId": "getDefinitions_ConfigurationPolicyDialpeerDefinitionBuilder_4403",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/definition/srstphoneprofile/bulk": {
"put": {
"tags": [
"Configuration - Policy DialPeer Definition Builder"
],
"description": "Create/Edit policy definitions in bulk",
"operationId": "savePolicyDefinitionInBulk_ConfigurationPolicyDialpeerDefinitionBuilder_4903",
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/definition/srstphoneprofile/multiple/{id}": {
"put": {
"tags": [
"Configuration - Policy DialPeer Definition Builder"
],
"description": "Edit multiple policy definitions",
"operationId": "editMultiplePolicyDefinition_ConfigurationPolicyDialpeerDefinitionBuilder_5803",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/definition/srstphoneprofile/preview": {
"post": {
"tags": [
"Configuration - Policy DialPeer Definition Builder"
],
"description": "Preview policy definition",
"operationId": "previewPolicyDefinition_ConfigurationPolicyDialpeerDefinitionBuilder_5204",
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/definition/srstphoneprofile/preview/{id}": {
"get": {
"tags": [
"Configuration - Policy DialPeer Definition Builder"
],
"description": "Preview policy definition",
"operationId": "previewPolicyDefinitionById_ConfigurationPolicyDialpeerDefinitionBuilder_5703",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/definition/srstphoneprofile/{id}": {
"get": {
"tags": [
"Configuration - Policy DialPeer Definition Builder"
],
"description": "Get a specific policy definitions",
"operationId": "getPolicyDefinition_ConfigurationPolicyDialpeerDefinitionBuilder_4903",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
},
"delete": {
"tags": [
"Configuration - Policy DialPeer Definition Builder"
],
"description": "Delete policy definition",
"operationId": "deletePolicyDefinition_ConfigurationPolicyDialpeerDefinitionBuilder_4906",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"put": {
"tags": [
"Configuration - Policy DialPeer Definition Builder"
],
"description": "Edit a policy definitions",
"operationId": "editPolicyDefinition_ConfigurationPolicyDialpeerDefinitionBuilder_4903",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"ACL policy": {
"description": "ACL policy",
"value": {
"name": "Demo-ACL",
"type": "acl",
"description": "Demo-ACL",
"defaultAction": {
"type": "accept"
},
"sequences": [
{
"sequenceId": 1,
"sequenceName": "Access Control List",
"baseAction": "accept",
"sequenceType": "acl",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "dscp",
"value": "46"
},
{
"field": "protocol",
"value": "6"
}
]
},
"actions": [
{
"type": "class",
"parameter": {
"ref": "89d20034-7149-4492-b392-b5c4f7903235"
}
}
]
}
]
}
},
"ZBFW definition": {
"description": "ZBFW definition",
"value": {
"name": "Demo-ZBFW",
"type": "zoneBasedFW",
"description": "Demo-ZBFW",
"definition": {
"defaultAction": {
"type": "drop"
},
"sequences": [
{
"sequenceId": 1,
"sequenceName": "Demo-Rule-1",
"baseAction": "inspect",
"sequenceType": "zoneBasedFW",
"match": {
"entries": [
{
"field": "sourceDataPrefixList",
"ref": "ecbea5de-b200-4ff7-aa76-f537b5f858e9"
}
]
},
"actions": []
}
],
"entries": [
{
"sourceZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53",
"destinationZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53"
}
]
}
}
},
"IPS definition": {
"description": "IPS definition",
"value": {
"name": "Demo-IPS-Policy",
"type": "intrusionPrevention",
"description": "Testing",
"definition": {
"signatureSet": "security",
"inspectionMode": "detection",
"signatureWhiteList": {
"ref": "ad189f08-af06-4799-97d6-0a7c7409cb8d"
},
"logLevel": "error",
"logging": [],
"targetVpns": [
"10",
"20"
]
}
}
},
"URL filtering definition": {
"description": "URL filtering definition",
"value": {
"name": "Demo-URL-Filtering-Policy",
"type": "urlFiltering",
"description": "",
"definition": {
"webCategoriesAction": "block",
"webCategories": [
"auctions",
"bot-nets",
"news-and-media"
],
"webReputation": "moderate-risk",
"urlWhiteList": {
"ref": "c20e31fb-fcea-4f48-93e3-09d2c6492d8b"
},
"urlBlackList": {
"ref": "557ed432-6cf8-495b-a445-d340d4c6236e"
},
"blockPageAction": "text",
"blockPageContents": "Access to the requested page has been denied. Please contact your Network Administrator",
"enableAlerts": true,
"alerts": [
"blacklist",
"whitelist",
"categories-reputation"
],
"logging": [],
"targetVpns": [
"30"
]
}
}
},
"AMP definition": {
"description": "AMP definition",
"value": {
"name": "Demo-AMP-Policy",
"type": "advancedMalwareProtection",
"description": "",
"definition": {
"matchAllVpn": true,
"fileReputationCloudServer": "nam",
"fileReputationEstServer": "nam",
"fileReputationAlert": "critical",
"fileAnalysisCloudServer": "nam",
"fileAnalysisFileTypes": [
"pdf",
"ms-exe"
],
"fileAnalysisAlert": "critical",
"targetVpns": [
"10",
"20"
],
"fileAnalysisEnabled": true
}
}
},
"DNS definition": {
"description": "DNS definition",
"value": {
"name": "Demo-DNS-Policy",
"type": "DNSSecurity",
"description": "Testing",
"definition": {
"localDomainBypassList": {
"ref": "143f753f-8d51-4be6-805d-bc330f09982f"
},
"matchAllVpn": false,
"targetVpns": [
{
"vpns": [
"10"
],
"umbrellaDefault": false,
"childOrgId": "7999118",
"dnsServerIP": "10.10.10.1",
"localDomainBypassEnabled": true
}
],
"dnsCrypt": true,
"umbrellaData": {
"ref": "e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa"
}
}
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {
"masterTemplatesAffected": []
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/definition/ssldecryption": {
"post": {
"tags": [
"Configuration - SSL Decryption Policy Definition Builder"
],
"description": "Create policy definition",
"operationId": "createPolicyDefinition_ConfigurationSslDecryptionPolicyDefinitionBuilder_4104",
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"ACL policy": {
"description": "ACL policy",
"value": {
"name": "Demo-ACL",
"type": "acl",
"description": "Demo-ACL",
"defaultAction": {
"type": "accept"
},
"sequences": [
{
"sequenceId": 1,
"sequenceName": "Access Control List",
"baseAction": "accept",
"sequenceType": "acl",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "dscp",
"value": "46"
}
]
},
"actions": [
{
"type": "class",
"parameter": {
"ref": "89d20034-7149-4492-b392-b5c4f7903235"
}
}
]
}
]
}
},
"ZBFW definition": {
"description": "ZBFW definition",
"value": {
"name": "Demo-ZBFW",
"type": "zoneBasedFW",
"description": "Demo-ZBFW",
"definition": {
"defaultAction": {
"type": "drop"
},
"sequences": [],
"entries": [
{
"sourceZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53",
"destinationZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53"
}
]
}
}
},
"IPS definition": {
"description": "IPS definition",
"value": {
"name": "Demo-IPS-Policy",
"type": "intrusionPrevention",
"description": "Testing",
"definition": {
"signatureSet": "security",
"inspectionMode": "detection",
"signatureWhiteList": {
"ref": "ad189f08-af06-4799-97d6-0a7c7409cb8d"
},
"logLevel": "error",
"logging": [],
"targetVpns": [
"10"
]
}
}
},
"URL filtering definition": {
"description": "URL filtering definition",
"value": {
"name": "Demo-URL-Filtering-Policy",
"type": "urlFiltering",
"description": "",
"definition": {
"webCategoriesAction": "block",
"webCategories": [
"auctions",
"bot-nets"
],
"webReputation": "moderate-risk",
"urlWhiteList": {
"ref": "c20e31fb-fcea-4f48-93e3-09d2c6492d8b"
},
"urlBlackList": {
"ref": "557ed432-6cf8-495b-a445-d340d4c6236e"
},
"blockPageAction": "text",
"blockPageContents": "Access to the requested page has been denied. Please contact your Network Administrator",
"enableAlerts": true,
"alerts": [
"blacklist",
"whitelist",
"categories-reputation"
],
"logging": [],
"targetVpns": [
"10",
"20"
]
}
}
},
"AMP definition": {
"description": "AMP definition",
"value": {
"name": "Demo-AMP-Policy",
"type": "advancedMalwareProtection",
"description": "",
"definition": {
"matchAllVpn": false,
"fileReputationCloudServer": "nam",
"fileReputationEstServer": "nam",
"fileReputationAlert": "critical",
"fileAnalysisCloudServer": "",
"fileAnalysisFileTypes": [],
"fileAnalysisAlert": "",
"targetVpns": [
"10",
"20"
]
}
}
},
"DNS definition": {
"description": "DNS definition",
"value": {
"name": "Demo-DNS-Policy",
"type": "DNSSecurity",
"description": "Testing",
"definition": {
"localDomainBypassList": {
"ref": "143f753f-8d51-4be6-805d-bc330f09982f"
},
"matchAllVpn": true,
"umbrellaDefault": true,
"childOrgId": "7999118",
"localDomainBypassEnabled": true,
"dnsCrypt": true,
"umbrellaData": {
"ref": "e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa"
}
}
}
},
"HubandSpoke definition": {
"description": "HubandSpoke definition",
"value": {
"name": "Demo-Hub-n-Spoke-Policy",
"type": "hubAndSpoke",
"description": "Demo-Hub-n-Spoke-Policy",
"definition": {
"vpnList": "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf",
"subDefinitions": [
{
"name": "My Hub-and-Spoke",
"equalPreference": false,
"advertiseTloc": true,
"spokes": [
{
"siteList": "5c58c36c-9cd6-468f-8434-ee6d5801c6ba",
"hubs": [
{
"siteList": "24747ccd-4f7f-4dfa-8800-34f565fb65b4",
"preference": "20",
"prefixLists": [
"b5c4d764-20bc-4de3-9bac-52ef70f1186c"
],
"ipv6PrefixLists": []
}
]
}
],
"tlocList": "1e97c258-4323-4754-9dc0-44e9656d43bf"
}
]
}
}
},
"VPN membership group definition": {
"description": "VPN membership group definition",
"value": {
"name": "Demo-VPN-Membership-Policy",
"type": "vpnMembershipGroup",
"description": "Demo-VPN-Membership-Policy",
"definition": {
"sites": [
{
"siteList": "24747ccd-4f7f-4dfa-8800-34f565fb65b4",
"vpnList": [
"cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"
]
},
{
"siteList": "5c58c36c-9cd6-468f-8434-ee6d5801c6ba",
"vpnList": [
"cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"
]
}
]
}
}
},
"AppRoute definition": {
"description": "AppRoute definition",
"value": {
"name": "Demo-AAR-Policy",
"type": "appRoute",
"description": "Demo-AAR-Policy",
"sequences": [
{
"sequenceId": 1,
"sequenceName": "App Route",
"sequenceType": "appRoute",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "appList",
"ref": "b6752dba-969b-46de-a7e7-da11910fb1bf"
},
{
"field": "dnsAppList",
"ref": "b6752dba-969b-46de-a7e7-da11910fb1bf"
},
{
"field": "dns",
"value": "request"
},
{
"field": "dscp",
"value": "46"
},
{
"field": "plp",
"value": "high"
},
{
"field": "protocol",
"value": "6"
},
{
"field": "sourceDataPrefixList",
"ref": "6c2b7164-5de2-4775-938c-b443504324ab"
},
{
"field": "sourcePort",
"value": "1025"
},
{
"field": "destinationDataPrefixList",
"ref": "6c2b7164-5de2-4775-938c-b443504324ab"
},
{
"field": "destinationPort",
"value": "65000"
}
]
},
"actions": [
{
"type": "backupSlaPreferredColor",
"parameter": "biz-internet"
},
{
"type": "count",
"parameter": "Demo-Counter"
},
{
"type": "log",
"parameter": ""
},
{
"type": "slaClass",
"parameter": [
{
"field": "name",
"ref": "46cea5a1-1570-4921-b87a-837d590eb37e"
},
{
"field": "preferredColor",
"value": "public-internet"
},
{
"field": "strict"
}
]
}
]
},
{
"sequenceId": 11,
"sequenceName": "App Route",
"sequenceType": "appRoute",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "saasAppList",
"ref": "1e6688ce-2d21-4d7a-9a93-ae6a8ebd4a06"
}
]
},
"actions": [
{
"type": "cloudSaas",
"parameter": ""
}
]
},
{
"sequenceId": 21,
"sequenceName": "App Route",
"sequenceType": "appRoute",
"sequenceIpType": "ipv6",
"match": {
"entries": [
{
"field": "dscp",
"value": "46"
},
{
"field": "protocol",
"value": "6"
},
{
"field": "sourceIpv6",
"value": "2001::/8"
},
{
"field": "sourcePort",
"value": "65000"
},
{
"field": "destinationIpv6",
"value": "2001::/8"
},
{
"field": "destinationPort",
"value": "65000"
}
]
},
"actions": [
{
"type": "backupSlaPreferredColor",
"parameter": "biz-internet"
},
{
"type": "count",
"parameter": "Demo-Counter"
},
{
"type": "log",
"parameter": ""
},
{
"type": "slaClass",
"parameter": [
{
"field": "name",
"ref": "46cea5a1-1570-4921-b87a-837d590eb37e"
},
{
"field": "preferredColor",
"value": "public-internet"
},
{
"field": "strict"
}
]
}
]
}
]
}
},
"Data policy definition": {
"description": "Data policy definition",
"value": {
"name": "Demo-Data-Policy",
"type": "data",
"description": "Demo-Data-Policy",
"defaultAction": {
"type": "drop"
},
"sequences": [
{
"sequenceId": 1,
"sequenceName": "Custom",
"baseAction": "accept",
"sequenceType": "data",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "appList",
"ref": "b6752dba-969b-46de-a7e7-da11910fb1bf"
},
{
"field": "dnsAppList",
"ref": "b6752dba-969b-46de-a7e7-da11910fb1bf"
},
{
"field": "dns",
"value": "response"
},
{
"field": "dscp",
"value": "46"
},
{
"field": "packetLength",
"value": "1504"
},
{
"field": "plp",
"value": "high"
},
{
"field": "protocol",
"value": "6"
},
{
"field": "sourceDataPrefixList",
"ref": "6c2b7164-5de2-4775-938c-b443504324ab"
},
{
"field": "sourcePort",
"value": "65000"
},
{
"field": "destinationIp",
"value": "10.0.0.0/12"
},
{
"field": "destinationPort",
"value": "65000"
},
{
"field": "tcp",
"value": "syn"
}
]
},
"actions": [
{
"type": "count",
"parameter": "Demo-Counter"
},
{
"type": "set",
"parameter": [
{
"field": "dscp",
"value": "34"
},
{
"field": "forwardingClass",
"value": "ef-class"
},
{
"field": "localTlocList",
"value": {
"color": "public-internet",
"restrict": "",
"encap": "ipsec"
}
},
{
"field": "nextHop",
"value": "10.0.0.1"
},
{
"field": "policer",
"ref": "ecf250c7-bef0-405b-8e74-4d67440cac90"
}
]
},
{
"type": "cflowd"
},
{
"type": "log",
"parameter": ""
},
{
"type": "nat",
"parameter": {
"field": "pool",
"value": "1"
}
},
{
"type": "redirectDns",
"parameter": {
"field": "dnsType",
"value": "umbrella"
}
}
]
},
{
"sequenceId": 11,
"sequenceName": "Custom",
"baseAction": "accept",
"sequenceType": "data",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "appList",
"ref": "b6752dba-969b-46de-a7e7-da11910fb1bf"
}
]
},
"actions": [
{
"type": "set",
"parameter": [
{
"field": "service",
"value": {
"type": "FW",
"vpn": "10",
"tloc": {
"ip": "10.0.0.1",
"color": "biz-internet",
"encap": "ipsec"
}
}
}
]
},
{
"type": "tcpOptimization",
"parameter": ""
},
{
"type": "lossProtect",
"parameter": "fecAdaptive"
},
{
"type": "lossProtectFec",
"parameter": "fecAdaptive"
},
{
"type": "sig",
"parameter": ""
}
]
}
]
}
},
"CFlowd definition": {
"description": "CFlowd definition",
"value": {
"name": "Demo-cflowd-Policy",
"type": "cflowd",
"description": "Demo-cflowd-Policy",
"definition": {
"flowActiveTimeout": 3600,
"flowInactiveTimeout": 3600,
"flowSamplingInterval": 65513,
"templateRefresh": 86400,
"collectors": [
{
"vpn": "10",
"address": "10.0.0.1",
"port": 9912,
"transport": "transport_tcp",
"sourceInterface": "ge0/1"
},
{
"vpn": "20",
"address": "10.0.0.1",
"port": 1025,
"transport": "transport_udp",
"sourceInterface": "GigabitEthernet0/0/1"
}
],
"protocol": "ipv4"
}
}
},
"QoS map definition": {
"description": "QoS map definition",
"value": {
"name": "Demo-QoS-Policy",
"type": "qosMap",
"description": "Demo-QoS-Policy",
"definition": {
"qosSchedulers": [
{
"queue": "0",
"bandwidthPercent": "75",
"bufferPercent": "75",
"burst": "15000",
"scheduling": "llq",
"drops": "tail-drop",
"classMapRef": ""
},
{
"queue": "7",
"bandwidthPercent": "25",
"bufferPercent": "25",
"scheduling": "wrr",
"drops": "red-drop",
"classMapRef": "4484c444-b956-4016-bd15-538b74fc2785"
}
]
}
}
},
"VPN-QoS map definition": {
"description": "VPN-QoS map definition",
"value": {
"name": "Demo-VPN-QoS-Policy",
"type": "vpnQosMap",
"description": "Demo-VPN-QoS-Policy",
"definition": {
"vpnQosSchedulers": [
{
"vpnListRef": "",
"bandwidthRate": "100000",
"shapingRate": "120000",
"childMapRef": ""
},
{
"childMapRef": ""
}
]
}
}
},
"Rewrite rule definition": {
"description": "Rewrite rule definition",
"value": {
"name": "Demo-Rewrite-Rule",
"type": "rewriteRule",
"description": "Demo-Rewrite-Rule",
"definition": {
"rules": [
{
"class": "4484c444-b956-4016-bd15-538b74fc2785",
"plp": "low",
"dscp": "46",
"layer2Cos": "2"
}
]
}
}
},
"Device access policy definition": {
"description": "Device access policy definition",
"value": {
"name": "Demo-DeviceAccess-Policy",
"type": "deviceaccesspolicy",
"description": "Demo-DeviceAccess-Policy",
"defaultAction": {
"type": "drop"
},
"sequences": [
{
"sequenceId": 1,
"sequenceName": "Device Access Control List",
"baseAction": "accept",
"sequenceType": "deviceaccesspolicy",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "destinationPort",
"value": "22"
},
{
"field": "sourceIp",
"value": "10.10.24.0/24"
},
{
"field": "sourcePort",
"value": "65000"
},
{
"field": "destinationIp",
"value": "10.10.10.1/32"
},
{
"field": "vpn",
"value": "10"
}
]
},
"actions": []
},
{
"sequenceId": 11,
"sequenceName": "Device Access Control List",
"baseAction": "drop",
"sequenceType": "deviceaccesspolicy",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "destinationPort",
"value": "161"
},
{
"field": "sourceDataPrefixList",
"ref": "6c2b7164-5de2-4775-938c-b443504324ab"
}
]
},
"actions": []
}
]
}
},
"vEdge route definition": {
"description": "vEdge route definition",
"value": {
"name": "Demo-Route-Policy",
"type": "vedgeRoute",
"description": "Demo-Route-Policy",
"defaultAction": {
"type": "reject"
},
"sequences": [
{
"sequenceId": 1,
"sequenceName": "Route",
"baseAction": "accept",
"sequenceType": "vedgeRoute",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "address",
"ref": "b5c4d764-20bc-4de3-9bac-52ef70f1186c"
},
{
"field": "asPath",
"ref": "79f8c180-1a23-4f09-800d-62652b571258"
},
{
"field": "community",
"matchFlag": "or",
"ref": "33de059b-27ec-4a83-be28-8985128381eb"
},
{
"field": "localPreference",
"value": "200"
},
{
"field": "metric",
"value": "100"
},
{
"field": "nextHop",
"ref": "b5c4d764-20bc-4de3-9bac-52ef70f1186c"
},
{
"field": "ompTag",
"value": "10"
},
{
"field": "affinity",
"value": "10"
},
{
"field": "origin",
"value": "igp"
},
{
"field": "ospfTag",
"value": "10"
},
{
"field": "peer",
"value": "10.0.0.1"
}
]
},
"actions": [
{
"type": "set",
"parameter": [
{
"field": "asPath",
"value": {
"exclude": "120 130",
"prepend": "65521 65521"
}
},
{
"field": "localPreference",
"value": "200"
},
{
"field": "metricType",
"value": "type1"
},
{
"field": "metric",
"value": "100"
},
{
"field": "nextHop",
"value": "10.0.0.1"
},
{
"field": "ompTag",
"value": "100"
},
{
"field": "weight",
"value": "200"
},
{
"field": "ospfTag",
"value": "122"
},
{
"field": "originator",
"value": "10.0.0.1"
},
{
"field": "origin",
"value": "igp"
},
{
"field": "community",
"value": "1000:10000"
}
]
}
]
}
]
}
},
"vSmart definition": {
"description": "vSmart definition",
"value": {
"policyDescription": "Demo-Centralized-Policy",
"policyType": "feature",
"policyName": "Demo-Centralized-Policy",
"policyDefinition": {
"assembly": [
{
"definitionId": "eb0daba9-7fc4-4f4f-bae7-cd958f81f863",
"type": "cflowd",
"entries": [
{
"siteLists": [
"5c58c36c-9cd6-468f-8434-ee6d5801c6ba",
"24747ccd-4f7f-4dfa-8800-34f565fb65b4"
]
}
]
},
{
"definitionId": "3e33fa50-a30d-4586-9d69-106121feaaf4",
"type": "data",
"entries": [
{
"direction": "service",
"siteLists": [
"5c58c36c-9cd6-468f-8434-ee6d5801c6ba",
"24747ccd-4f7f-4dfa-8800-34f565fb65b4"
],
"vpnLists": [
"cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"
]
}
]
},
{
"definitionId": "8b2e7c44-2666-48a7-87a0-36a43c2d003e",
"type": "appRoute",
"entries": [
{
"siteLists": [
"5c58c36c-9cd6-468f-8434-ee6d5801c6ba",
"24747ccd-4f7f-4dfa-8800-34f565fb65b4"
],
"vpnLists": [
"cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"
]
}
]
},
{
"definitionId": "1b76052e-1cb5-44b1-8e5e-4096cb261736",
"type": "vpnMembershipGroup"
},
{
"definitionId": "62960276-c797-41fd-bebb-c017fc752f4e",
"type": "hubAndSpoke"
}
]
},
"isPolicyActivated": false
}
},
"vEdge definition": {
"description": "vEdge definition",
"value": {
"policyDescription": "Demo-Local-Policy",
"policyType": "feature",
"policyName": "Demo-Local-Policy",
"policyDefinition": {
"assembly": [
{
"definitionId": "56283dcf-6dda-4831-bcd1-d9cf62d33fdc",
"type": "qosMap"
},
{
"definitionId": "a75ead1f-f6ab-4a80-af29-79b742b31c5c",
"type": "rewriteRule"
},
{
"definitionId": "555dd393-e7b6-4861-866f-f227f5f780b7",
"type": "deviceAccessPolicy"
},
{
"definitionId": "22655824-d0df-4a8b-9be0-9808938a0e6b",
"type": "vedgeRoute"
}
],
"settings": {
"flowVisibility": true,
"flowVisibilityIPv6": true,
"appVisibility": true,
"cloudQos": true,
"cloudQosServiceSide": true,
"implicitAclLogging": true,
"appVisibilityIPv6": true
}
},
"isPolicyActivated": false
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Task Id": {
"description": "Task Id",
"value": {
"definitionId": "00f718df-4f95-4363-8639-1fe855c9eb09"
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"get": {
"tags": [
"Configuration - SSL Decryption Policy Definition Builder"
],
"description": "Get policy definitions",
"operationId": "getDefinitions_ConfigurationSslDecryptionPolicyDefinitionBuilder_4103",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/definition/ssldecryption/bulk": {
"put": {
"tags": [
"Configuration - SSL Decryption Policy Definition Builder"
],
"description": "Create/Edit policy definitions in bulk",
"operationId": "savePolicyDefinitionInBulk_ConfigurationSslDecryptionPolicyDefinitionBuilder_4603",
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/definition/ssldecryption/multiple/{id}": {
"put": {
"tags": [
"Configuration - SSL Decryption Policy Definition Builder"
],
"description": "Edit multiple policy definitions",
"operationId": "editMultiplePolicyDefinition_ConfigurationSslDecryptionPolicyDefinitionBuilder_5503",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/definition/ssldecryption/preview": {
"post": {
"tags": [
"Configuration - SSL Decryption Policy Definition Builder"
],
"description": "Preview policy definition",
"operationId": "previewPolicyDefinition_ConfigurationSslDecryptionPolicyDefinitionBuilder_4904",
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/definition/ssldecryption/preview/{id}": {
"get": {
"tags": [
"Configuration - SSL Decryption Policy Definition Builder"
],
"description": "Preview policy definition",
"operationId": "previewPolicyDefinitionById_ConfigurationSslDecryptionPolicyDefinitionBuilder_5403",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/definition/ssldecryption/{id}": {
"get": {
"tags": [
"Configuration - SSL Decryption Policy Definition Builder"
],
"description": "Get a specific policy definitions",
"operationId": "getPolicyDefinition_ConfigurationSslDecryptionPolicyDefinitionBuilder_4603",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
},
"put": {
"tags": [
"Configuration - SSL Decryption Policy Definition Builder"
],
"description": "Edit a policy definitions",
"operationId": "editPolicyDefinition_ConfigurationSslDecryptionPolicyDefinitionBuilder_4603",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"ACL policy": {
"description": "ACL policy",
"value": {
"name": "Demo-ACL",
"type": "acl",
"description": "Demo-ACL",
"defaultAction": {
"type": "accept"
},
"sequences": [
{
"sequenceId": 1,
"sequenceName": "Access Control List",
"baseAction": "accept",
"sequenceType": "acl",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "dscp",
"value": "46"
},
{
"field": "protocol",
"value": "6"
}
]
},
"actions": [
{
"type": "class",
"parameter": {
"ref": "89d20034-7149-4492-b392-b5c4f7903235"
}
}
]
}
]
}
},
"ZBFW definition": {
"description": "ZBFW definition",
"value": {
"name": "Demo-ZBFW",
"type": "zoneBasedFW",
"description": "Demo-ZBFW",
"definition": {
"defaultAction": {
"type": "drop"
},
"sequences": [
{
"sequenceId": 1,
"sequenceName": "Demo-Rule-1",
"baseAction": "inspect",
"sequenceType": "zoneBasedFW",
"match": {
"entries": [
{
"field": "sourceDataPrefixList",
"ref": "ecbea5de-b200-4ff7-aa76-f537b5f858e9"
}
]
},
"actions": []
}
],
"entries": [
{
"sourceZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53",
"destinationZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53"
}
]
}
}
},
"IPS definition": {
"description": "IPS definition",
"value": {
"name": "Demo-IPS-Policy",
"type": "intrusionPrevention",
"description": "Testing",
"definition": {
"signatureSet": "security",
"inspectionMode": "detection",
"signatureWhiteList": {
"ref": "ad189f08-af06-4799-97d6-0a7c7409cb8d"
},
"logLevel": "error",
"logging": [],
"targetVpns": [
"10",
"20"
]
}
}
},
"URL filtering definition": {
"description": "URL filtering definition",
"value": {
"name": "Demo-URL-Filtering-Policy",
"type": "urlFiltering",
"description": "",
"definition": {
"webCategoriesAction": "block",
"webCategories": [
"auctions",
"bot-nets",
"news-and-media"
],
"webReputation": "moderate-risk",
"urlWhiteList": {
"ref": "c20e31fb-fcea-4f48-93e3-09d2c6492d8b"
},
"urlBlackList": {
"ref": "557ed432-6cf8-495b-a445-d340d4c6236e"
},
"blockPageAction": "text",
"blockPageContents": "Access to the requested page has been denied. Please contact your Network Administrator",
"enableAlerts": true,
"alerts": [
"blacklist",
"whitelist",
"categories-reputation"
],
"logging": [],
"targetVpns": [
"30"
]
}
}
},
"AMP definition": {
"description": "AMP definition",
"value": {
"name": "Demo-AMP-Policy",
"type": "advancedMalwareProtection",
"description": "",
"definition": {
"matchAllVpn": true,
"fileReputationCloudServer": "nam",
"fileReputationEstServer": "nam",
"fileReputationAlert": "critical",
"fileAnalysisCloudServer": "nam",
"fileAnalysisFileTypes": [
"pdf",
"ms-exe"
],
"fileAnalysisAlert": "critical",
"targetVpns": [
"10",
"20"
],
"fileAnalysisEnabled": true
}
}
},
"DNS definition": {
"description": "DNS definition",
"value": {
"name": "Demo-DNS-Policy",
"type": "DNSSecurity",
"description": "Testing",
"definition": {
"localDomainBypassList": {
"ref": "143f753f-8d51-4be6-805d-bc330f09982f"
},
"matchAllVpn": false,
"targetVpns": [
{
"vpns": [
"10"
],
"umbrellaDefault": false,
"childOrgId": "7999118",
"dnsServerIP": "10.10.10.1",
"localDomainBypassEnabled": true
}
],
"dnsCrypt": true,
"umbrellaData": {
"ref": "e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa"
}
}
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {
"masterTemplatesAffected": []
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"delete": {
"tags": [
"Configuration - SSL Decryption Policy Definition Builder"
],
"description": "Delete policy definition",
"operationId": "deletePolicyDefinition_ConfigurationSslDecryptionPolicyDefinitionBuilder_4606",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/definition/sslutdprofile": {
"get": {
"tags": [
"Configuration - SSL Decryption UTD Profile Definition"
],
"description": "Get policy definitions",
"operationId": "getDefinitions_ConfigurationSslDecryptionUtdProfileDefinition_4103",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
},
"post": {
"tags": [
"Configuration - SSL Decryption UTD Profile Definition"
],
"description": "Create policy definition",
"operationId": "createPolicyDefinition_ConfigurationSslDecryptionUtdProfileDefinition_4104",
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"ACL policy": {
"description": "ACL policy",
"value": {
"name": "Demo-ACL",
"type": "acl",
"description": "Demo-ACL",
"defaultAction": {
"type": "accept"
},
"sequences": [
{
"sequenceId": 1,
"sequenceName": "Access Control List",
"baseAction": "accept",
"sequenceType": "acl",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "dscp",
"value": "46"
}
]
},
"actions": [
{
"type": "class",
"parameter": {
"ref": "89d20034-7149-4492-b392-b5c4f7903235"
}
}
]
}
]
}
},
"ZBFW definition": {
"description": "ZBFW definition",
"value": {
"name": "Demo-ZBFW",
"type": "zoneBasedFW",
"description": "Demo-ZBFW",
"definition": {
"defaultAction": {
"type": "drop"
},
"sequences": [],
"entries": [
{
"sourceZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53",
"destinationZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53"
}
]
}
}
},
"IPS definition": {
"description": "IPS definition",
"value": {
"name": "Demo-IPS-Policy",
"type": "intrusionPrevention",
"description": "Testing",
"definition": {
"signatureSet": "security",
"inspectionMode": "detection",
"signatureWhiteList": {
"ref": "ad189f08-af06-4799-97d6-0a7c7409cb8d"
},
"logLevel": "error",
"logging": [],
"targetVpns": [
"10"
]
}
}
},
"URL filtering definition": {
"description": "URL filtering definition",
"value": {
"name": "Demo-URL-Filtering-Policy",
"type": "urlFiltering",
"description": "",
"definition": {
"webCategoriesAction": "block",
"webCategories": [
"auctions",
"bot-nets"
],
"webReputation": "moderate-risk",
"urlWhiteList": {
"ref": "c20e31fb-fcea-4f48-93e3-09d2c6492d8b"
},
"urlBlackList": {
"ref": "557ed432-6cf8-495b-a445-d340d4c6236e"
},
"blockPageAction": "text",
"blockPageContents": "Access to the requested page has been denied. Please contact your Network Administrator",
"enableAlerts": true,
"alerts": [
"blacklist",
"whitelist",
"categories-reputation"
],
"logging": [],
"targetVpns": [
"10",
"20"
]
}
}
},
"AMP definition": {
"description": "AMP definition",
"value": {
"name": "Demo-AMP-Policy",
"type": "advancedMalwareProtection",
"description": "",
"definition": {
"matchAllVpn": false,
"fileReputationCloudServer": "nam",
"fileReputationEstServer": "nam",
"fileReputationAlert": "critical",
"fileAnalysisCloudServer": "",
"fileAnalysisFileTypes": [],
"fileAnalysisAlert": "",
"targetVpns": [
"10",
"20"
]
}
}
},
"DNS definition": {
"description": "DNS definition",
"value": {
"name": "Demo-DNS-Policy",
"type": "DNSSecurity",
"description": "Testing",
"definition": {
"localDomainBypassList": {
"ref": "143f753f-8d51-4be6-805d-bc330f09982f"
},
"matchAllVpn": true,
"umbrellaDefault": true,
"childOrgId": "7999118",
"localDomainBypassEnabled": true,
"dnsCrypt": true,
"umbrellaData": {
"ref": "e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa"
}
}
}
},
"HubandSpoke definition": {
"description": "HubandSpoke definition",
"value": {
"name": "Demo-Hub-n-Spoke-Policy",
"type": "hubAndSpoke",
"description": "Demo-Hub-n-Spoke-Policy",
"definition": {
"vpnList": "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf",
"subDefinitions": [
{
"name": "My Hub-and-Spoke",
"equalPreference": false,
"advertiseTloc": true,
"spokes": [
{
"siteList": "5c58c36c-9cd6-468f-8434-ee6d5801c6ba",
"hubs": [
{
"siteList": "24747ccd-4f7f-4dfa-8800-34f565fb65b4",
"preference": "20",
"prefixLists": [
"b5c4d764-20bc-4de3-9bac-52ef70f1186c"
],
"ipv6PrefixLists": []
}
]
}
],
"tlocList": "1e97c258-4323-4754-9dc0-44e9656d43bf"
}
]
}
}
},
"VPN membership group definition": {
"description": "VPN membership group definition",
"value": {
"name": "Demo-VPN-Membership-Policy",
"type": "vpnMembershipGroup",
"description": "Demo-VPN-Membership-Policy",
"definition": {
"sites": [
{
"siteList": "24747ccd-4f7f-4dfa-8800-34f565fb65b4",
"vpnList": [
"cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"
]
},
{
"siteList": "5c58c36c-9cd6-468f-8434-ee6d5801c6ba",
"vpnList": [
"cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"
]
}
]
}
}
},
"AppRoute definition": {
"description": "AppRoute definition",
"value": {
"name": "Demo-AAR-Policy",
"type": "appRoute",
"description": "Demo-AAR-Policy",
"sequences": [
{
"sequenceId": 1,
"sequenceName": "App Route",
"sequenceType": "appRoute",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "appList",
"ref": "b6752dba-969b-46de-a7e7-da11910fb1bf"
},
{
"field": "dnsAppList",
"ref": "b6752dba-969b-46de-a7e7-da11910fb1bf"
},
{
"field": "dns",
"value": "request"
},
{
"field": "dscp",
"value": "46"
},
{
"field": "plp",
"value": "high"
},
{
"field": "protocol",
"value": "6"
},
{
"field": "sourceDataPrefixList",
"ref": "6c2b7164-5de2-4775-938c-b443504324ab"
},
{
"field": "sourcePort",
"value": "1025"
},
{
"field": "destinationDataPrefixList",
"ref": "6c2b7164-5de2-4775-938c-b443504324ab"
},
{
"field": "destinationPort",
"value": "65000"
}
]
},
"actions": [
{
"type": "backupSlaPreferredColor",
"parameter": "biz-internet"
},
{
"type": "count",
"parameter": "Demo-Counter"
},
{
"type": "log",
"parameter": ""
},
{
"type": "slaClass",
"parameter": [
{
"field": "name",
"ref": "46cea5a1-1570-4921-b87a-837d590eb37e"
},
{
"field": "preferredColor",
"value": "public-internet"
},
{
"field": "strict"
}
]
}
]
},
{
"sequenceId": 11,
"sequenceName": "App Route",
"sequenceType": "appRoute",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "saasAppList",
"ref": "1e6688ce-2d21-4d7a-9a93-ae6a8ebd4a06"
}
]
},
"actions": [
{
"type": "cloudSaas",
"parameter": ""
}
]
},
{
"sequenceId": 21,
"sequenceName": "App Route",
"sequenceType": "appRoute",
"sequenceIpType": "ipv6",
"match": {
"entries": [
{
"field": "dscp",
"value": "46"
},
{
"field": "protocol",
"value": "6"
},
{
"field": "sourceIpv6",
"value": "2001::/8"
},
{
"field": "sourcePort",
"value": "65000"
},
{
"field": "destinationIpv6",
"value": "2001::/8"
},
{
"field": "destinationPort",
"value": "65000"
}
]
},
"actions": [
{
"type": "backupSlaPreferredColor",
"parameter": "biz-internet"
},
{
"type": "count",
"parameter": "Demo-Counter"
},
{
"type": "log",
"parameter": ""
},
{
"type": "slaClass",
"parameter": [
{
"field": "name",
"ref": "46cea5a1-1570-4921-b87a-837d590eb37e"
},
{
"field": "preferredColor",
"value": "public-internet"
},
{
"field": "strict"
}
]
}
]
}
]
}
},
"Data policy definition": {
"description": "Data policy definition",
"value": {
"name": "Demo-Data-Policy",
"type": "data",
"description": "Demo-Data-Policy",
"defaultAction": {
"type": "drop"
},
"sequences": [
{
"sequenceId": 1,
"sequenceName": "Custom",
"baseAction": "accept",
"sequenceType": "data",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "appList",
"ref": "b6752dba-969b-46de-a7e7-da11910fb1bf"
},
{
"field": "dnsAppList",
"ref": "b6752dba-969b-46de-a7e7-da11910fb1bf"
},
{
"field": "dns",
"value": "response"
},
{
"field": "dscp",
"value": "46"
},
{
"field": "packetLength",
"value": "1504"
},
{
"field": "plp",
"value": "high"
},
{
"field": "protocol",
"value": "6"
},
{
"field": "sourceDataPrefixList",
"ref": "6c2b7164-5de2-4775-938c-b443504324ab"
},
{
"field": "sourcePort",
"value": "65000"
},
{
"field": "destinationIp",
"value": "10.0.0.0/12"
},
{
"field": "destinationPort",
"value": "65000"
},
{
"field": "tcp",
"value": "syn"
}
]
},
"actions": [
{
"type": "count",
"parameter": "Demo-Counter"
},
{
"type": "set",
"parameter": [
{
"field": "dscp",
"value": "34"
},
{
"field": "forwardingClass",
"value": "ef-class"
},
{
"field": "localTlocList",
"value": {
"color": "public-internet",
"restrict": "",
"encap": "ipsec"
}
},
{
"field": "nextHop",
"value": "10.0.0.1"
},
{
"field": "policer",
"ref": "ecf250c7-bef0-405b-8e74-4d67440cac90"
}
]
},
{
"type": "cflowd"
},
{
"type": "log",
"parameter": ""
},
{
"type": "nat",
"parameter": {
"field": "pool",
"value": "1"
}
},
{
"type": "redirectDns",
"parameter": {
"field": "dnsType",
"value": "umbrella"
}
}
]
},
{
"sequenceId": 11,
"sequenceName": "Custom",
"baseAction": "accept",
"sequenceType": "data",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "appList",
"ref": "b6752dba-969b-46de-a7e7-da11910fb1bf"
}
]
},
"actions": [
{
"type": "set",
"parameter": [
{
"field": "service",
"value": {
"type": "FW",
"vpn": "10",
"tloc": {
"ip": "10.0.0.1",
"color": "biz-internet",
"encap": "ipsec"
}
}
}
]
},
{
"type": "tcpOptimization",
"parameter": ""
},
{
"type": "lossProtect",
"parameter": "fecAdaptive"
},
{
"type": "lossProtectFec",
"parameter": "fecAdaptive"
},
{
"type": "sig",
"parameter": ""
}
]
}
]
}
},
"CFlowd definition": {
"description": "CFlowd definition",
"value": {
"name": "Demo-cflowd-Policy",
"type": "cflowd",
"description": "Demo-cflowd-Policy",
"definition": {
"flowActiveTimeout": 3600,
"flowInactiveTimeout": 3600,
"flowSamplingInterval": 65513,
"templateRefresh": 86400,
"collectors": [
{
"vpn": "10",
"address": "10.0.0.1",
"port": 9912,
"transport": "transport_tcp",
"sourceInterface": "ge0/1"
},
{
"vpn": "20",
"address": "10.0.0.1",
"port": 1025,
"transport": "transport_udp",
"sourceInterface": "GigabitEthernet0/0/1"
}
],
"protocol": "ipv4"
}
}
},
"QoS map definition": {
"description": "QoS map definition",
"value": {
"name": "Demo-QoS-Policy",
"type": "qosMap",
"description": "Demo-QoS-Policy",
"definition": {
"qosSchedulers": [
{
"queue": "0",
"bandwidthPercent": "75",
"bufferPercent": "75",
"burst": "15000",
"scheduling": "llq",
"drops": "tail-drop",
"classMapRef": ""
},
{
"queue": "7",
"bandwidthPercent": "25",
"bufferPercent": "25",
"scheduling": "wrr",
"drops": "red-drop",
"classMapRef": "4484c444-b956-4016-bd15-538b74fc2785"
}
]
}
}
},
"VPN-QoS map definition": {
"description": "VPN-QoS map definition",
"value": {
"name": "Demo-VPN-QoS-Policy",
"type": "vpnQosMap",
"description": "Demo-VPN-QoS-Policy",
"definition": {
"vpnQosSchedulers": [
{
"vpnListRef": "",
"bandwidthRate": "100000",
"shapingRate": "120000",
"childMapRef": ""
},
{
"childMapRef": ""
}
]
}
}
},
"Rewrite rule definition": {
"description": "Rewrite rule definition",
"value": {
"name": "Demo-Rewrite-Rule",
"type": "rewriteRule",
"description": "Demo-Rewrite-Rule",
"definition": {
"rules": [
{
"class": "4484c444-b956-4016-bd15-538b74fc2785",
"plp": "low",
"dscp": "46",
"layer2Cos": "2"
}
]
}
}
},
"Device access policy definition": {
"description": "Device access policy definition",
"value": {
"name": "Demo-DeviceAccess-Policy",
"type": "deviceaccesspolicy",
"description": "Demo-DeviceAccess-Policy",
"defaultAction": {
"type": "drop"
},
"sequences": [
{
"sequenceId": 1,
"sequenceName": "Device Access Control List",
"baseAction": "accept",
"sequenceType": "deviceaccesspolicy",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "destinationPort",
"value": "22"
},
{
"field": "sourceIp",
"value": "10.10.24.0/24"
},
{
"field": "sourcePort",
"value": "65000"
},
{
"field": "destinationIp",
"value": "10.10.10.1/32"
},
{
"field": "vpn",
"value": "10"
}
]
},
"actions": []
},
{
"sequenceId": 11,
"sequenceName": "Device Access Control List",
"baseAction": "drop",
"sequenceType": "deviceaccesspolicy",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "destinationPort",
"value": "161"
},
{
"field": "sourceDataPrefixList",
"ref": "6c2b7164-5de2-4775-938c-b443504324ab"
}
]
},
"actions": []
}
]
}
},
"vEdge route definition": {
"description": "vEdge route definition",
"value": {
"name": "Demo-Route-Policy",
"type": "vedgeRoute",
"description": "Demo-Route-Policy",
"defaultAction": {
"type": "reject"
},
"sequences": [
{
"sequenceId": 1,
"sequenceName": "Route",
"baseAction": "accept",
"sequenceType": "vedgeRoute",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "address",
"ref": "b5c4d764-20bc-4de3-9bac-52ef70f1186c"
},
{
"field": "asPath",
"ref": "79f8c180-1a23-4f09-800d-62652b571258"
},
{
"field": "community",
"matchFlag": "or",
"ref": "33de059b-27ec-4a83-be28-8985128381eb"
},
{
"field": "localPreference",
"value": "200"
},
{
"field": "metric",
"value": "100"
},
{
"field": "nextHop",
"ref": "b5c4d764-20bc-4de3-9bac-52ef70f1186c"
},
{
"field": "ompTag",
"value": "10"
},
{
"field": "affinity",
"value": "10"
},
{
"field": "origin",
"value": "igp"
},
{
"field": "ospfTag",
"value": "10"
},
{
"field": "peer",
"value": "10.0.0.1"
}
]
},
"actions": [
{
"type": "set",
"parameter": [
{
"field": "asPath",
"value": {
"exclude": "120 130",
"prepend": "65521 65521"
}
},
{
"field": "localPreference",
"value": "200"
},
{
"field": "metricType",
"value": "type1"
},
{
"field": "metric",
"value": "100"
},
{
"field": "nextHop",
"value": "10.0.0.1"
},
{
"field": "ompTag",
"value": "100"
},
{
"field": "weight",
"value": "200"
},
{
"field": "ospfTag",
"value": "122"
},
{
"field": "originator",
"value": "10.0.0.1"
},
{
"field": "origin",
"value": "igp"
},
{
"field": "community",
"value": "1000:10000"
}
]
}
]
}
]
}
},
"vSmart definition": {
"description": "vSmart definition",
"value": {
"policyDescription": "Demo-Centralized-Policy",
"policyType": "feature",
"policyName": "Demo-Centralized-Policy",
"policyDefinition": {
"assembly": [
{
"definitionId": "eb0daba9-7fc4-4f4f-bae7-cd958f81f863",
"type": "cflowd",
"entries": [
{
"siteLists": [
"5c58c36c-9cd6-468f-8434-ee6d5801c6ba",
"24747ccd-4f7f-4dfa-8800-34f565fb65b4"
]
}
]
},
{
"definitionId": "3e33fa50-a30d-4586-9d69-106121feaaf4",
"type": "data",
"entries": [
{
"direction": "service",
"siteLists": [
"5c58c36c-9cd6-468f-8434-ee6d5801c6ba",
"24747ccd-4f7f-4dfa-8800-34f565fb65b4"
],
"vpnLists": [
"cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"
]
}
]
},
{
"definitionId": "8b2e7c44-2666-48a7-87a0-36a43c2d003e",
"type": "appRoute",
"entries": [
{
"siteLists": [
"5c58c36c-9cd6-468f-8434-ee6d5801c6ba",
"24747ccd-4f7f-4dfa-8800-34f565fb65b4"
],
"vpnLists": [
"cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"
]
}
]
},
{
"definitionId": "1b76052e-1cb5-44b1-8e5e-4096cb261736",
"type": "vpnMembershipGroup"
},
{
"definitionId": "62960276-c797-41fd-bebb-c017fc752f4e",
"type": "hubAndSpoke"
}
]
},
"isPolicyActivated": false
}
},
"vEdge definition": {
"description": "vEdge definition",
"value": {
"policyDescription": "Demo-Local-Policy",
"policyType": "feature",
"policyName": "Demo-Local-Policy",
"policyDefinition": {
"assembly": [
{
"definitionId": "56283dcf-6dda-4831-bcd1-d9cf62d33fdc",
"type": "qosMap"
},
{
"definitionId": "a75ead1f-f6ab-4a80-af29-79b742b31c5c",
"type": "rewriteRule"
},
{
"definitionId": "555dd393-e7b6-4861-866f-f227f5f780b7",
"type": "deviceAccessPolicy"
},
{
"definitionId": "22655824-d0df-4a8b-9be0-9808938a0e6b",
"type": "vedgeRoute"
}
],
"settings": {
"flowVisibility": true,
"flowVisibilityIPv6": true,
"appVisibility": true,
"cloudQos": true,
"cloudQosServiceSide": true,
"implicitAclLogging": true,
"appVisibilityIPv6": true
}
},
"isPolicyActivated": false
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Task Id": {
"description": "Task Id",
"value": {
"definitionId": "00f718df-4f95-4363-8639-1fe855c9eb09"
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/definition/sslutdprofile/bulk": {
"put": {
"tags": [
"Configuration - SSL Decryption UTD Profile Definition"
],
"description": "Create/Edit policy definitions in bulk",
"operationId": "savePolicyDefinitionInBulk_ConfigurationSslDecryptionUtdProfileDefinition_4603",
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/definition/sslutdprofile/multiple/{id}": {
"put": {
"tags": [
"Configuration - SSL Decryption UTD Profile Definition"
],
"description": "Edit multiple policy definitions",
"operationId": "editMultiplePolicyDefinition_ConfigurationSslDecryptionUtdProfileDefinition_5503",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/definition/sslutdprofile/preview": {
"post": {
"tags": [
"Configuration - SSL Decryption UTD Profile Definition"
],
"description": "Preview policy definition",
"operationId": "previewPolicyDefinition_ConfigurationSslDecryptionUtdProfileDefinition_4904",
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/definition/sslutdprofile/preview/{id}": {
"get": {
"tags": [
"Configuration - SSL Decryption UTD Profile Definition"
],
"description": "Preview policy definition",
"operationId": "previewPolicyDefinitionById_ConfigurationSslDecryptionUtdProfileDefinition_5403",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/definition/sslutdprofile/{id}": {
"get": {
"tags": [
"Configuration - SSL Decryption UTD Profile Definition"
],
"description": "Get a specific policy definitions",
"operationId": "getPolicyDefinition_ConfigurationSslDecryptionUtdProfileDefinition_4603",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
},
"put": {
"tags": [
"Configuration - SSL Decryption UTD Profile Definition"
],
"description": "Edit a policy definitions",
"operationId": "editPolicyDefinition_ConfigurationSslDecryptionUtdProfileDefinition_4603",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"ACL policy": {
"description": "ACL policy",
"value": {
"name": "Demo-ACL",
"type": "acl",
"description": "Demo-ACL",
"defaultAction": {
"type": "accept"
},
"sequences": [
{
"sequenceId": 1,
"sequenceName": "Access Control List",
"baseAction": "accept",
"sequenceType": "acl",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "dscp",
"value": "46"
},
{
"field": "protocol",
"value": "6"
}
]
},
"actions": [
{
"type": "class",
"parameter": {
"ref": "89d20034-7149-4492-b392-b5c4f7903235"
}
}
]
}
]
}
},
"ZBFW definition": {
"description": "ZBFW definition",
"value": {
"name": "Demo-ZBFW",
"type": "zoneBasedFW",
"description": "Demo-ZBFW",
"definition": {
"defaultAction": {
"type": "drop"
},
"sequences": [
{
"sequenceId": 1,
"sequenceName": "Demo-Rule-1",
"baseAction": "inspect",
"sequenceType": "zoneBasedFW",
"match": {
"entries": [
{
"field": "sourceDataPrefixList",
"ref": "ecbea5de-b200-4ff7-aa76-f537b5f858e9"
}
]
},
"actions": []
}
],
"entries": [
{
"sourceZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53",
"destinationZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53"
}
]
}
}
},
"IPS definition": {
"description": "IPS definition",
"value": {
"name": "Demo-IPS-Policy",
"type": "intrusionPrevention",
"description": "Testing",
"definition": {
"signatureSet": "security",
"inspectionMode": "detection",
"signatureWhiteList": {
"ref": "ad189f08-af06-4799-97d6-0a7c7409cb8d"
},
"logLevel": "error",
"logging": [],
"targetVpns": [
"10",
"20"
]
}
}
},
"URL filtering definition": {
"description": "URL filtering definition",
"value": {
"name": "Demo-URL-Filtering-Policy",
"type": "urlFiltering",
"description": "",
"definition": {
"webCategoriesAction": "block",
"webCategories": [
"auctions",
"bot-nets",
"news-and-media"
],
"webReputation": "moderate-risk",
"urlWhiteList": {
"ref": "c20e31fb-fcea-4f48-93e3-09d2c6492d8b"
},
"urlBlackList": {
"ref": "557ed432-6cf8-495b-a445-d340d4c6236e"
},
"blockPageAction": "text",
"blockPageContents": "Access to the requested page has been denied. Please contact your Network Administrator",
"enableAlerts": true,
"alerts": [
"blacklist",
"whitelist",
"categories-reputation"
],
"logging": [],
"targetVpns": [
"30"
]
}
}
},
"AMP definition": {
"description": "AMP definition",
"value": {
"name": "Demo-AMP-Policy",
"type": "advancedMalwareProtection",
"description": "",
"definition": {
"matchAllVpn": true,
"fileReputationCloudServer": "nam",
"fileReputationEstServer": "nam",
"fileReputationAlert": "critical",
"fileAnalysisCloudServer": "nam",
"fileAnalysisFileTypes": [
"pdf",
"ms-exe"
],
"fileAnalysisAlert": "critical",
"targetVpns": [
"10",
"20"
],
"fileAnalysisEnabled": true
}
}
},
"DNS definition": {
"description": "DNS definition",
"value": {
"name": "Demo-DNS-Policy",
"type": "DNSSecurity",
"description": "Testing",
"definition": {
"localDomainBypassList": {
"ref": "143f753f-8d51-4be6-805d-bc330f09982f"
},
"matchAllVpn": false,
"targetVpns": [
{
"vpns": [
"10"
],
"umbrellaDefault": false,
"childOrgId": "7999118",
"dnsServerIP": "10.10.10.1",
"localDomainBypassEnabled": true
}
],
"dnsCrypt": true,
"umbrellaData": {
"ref": "e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa"
}
}
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {
"masterTemplatesAffected": []
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"delete": {
"tags": [
"Configuration - SSL Decryption UTD Profile Definition"
],
"description": "Delete policy definition",
"operationId": "deletePolicyDefinition_ConfigurationSslDecryptionUtdProfileDefinition_4606",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/definition/urlfiltering": {
"post": {
"tags": [
"Configuration - Policy URL Filtering Definition Builder"
],
"description": "Create policy definition",
"operationId": "createPolicyDefinition_ConfigurationPolicyUrlFilteringDefinitionBuilder_4004",
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"ACL policy": {
"description": "ACL policy",
"value": {
"name": "Demo-ACL",
"type": "acl",
"description": "Demo-ACL",
"defaultAction": {
"type": "accept"
},
"sequences": [
{
"sequenceId": 1,
"sequenceName": "Access Control List",
"baseAction": "accept",
"sequenceType": "acl",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "dscp",
"value": "46"
}
]
},
"actions": [
{
"type": "class",
"parameter": {
"ref": "89d20034-7149-4492-b392-b5c4f7903235"
}
}
]
}
]
}
},
"ZBFW definition": {
"description": "ZBFW definition",
"value": {
"name": "Demo-ZBFW",
"type": "zoneBasedFW",
"description": "Demo-ZBFW",
"definition": {
"defaultAction": {
"type": "drop"
},
"sequences": [],
"entries": [
{
"sourceZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53",
"destinationZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53"
}
]
}
}
},
"IPS definition": {
"description": "IPS definition",
"value": {
"name": "Demo-IPS-Policy",
"type": "intrusionPrevention",
"description": "Testing",
"definition": {
"signatureSet": "security",
"inspectionMode": "detection",
"signatureWhiteList": {
"ref": "ad189f08-af06-4799-97d6-0a7c7409cb8d"
},
"logLevel": "error",
"logging": [],
"targetVpns": [
"10"
]
}
}
},
"URL filtering definition": {
"description": "URL filtering definition",
"value": {
"name": "Demo-URL-Filtering-Policy",
"type": "urlFiltering",
"description": "",
"definition": {
"webCategoriesAction": "block",
"webCategories": [
"auctions",
"bot-nets"
],
"webReputation": "moderate-risk",
"urlWhiteList": {
"ref": "c20e31fb-fcea-4f48-93e3-09d2c6492d8b"
},
"urlBlackList": {
"ref": "557ed432-6cf8-495b-a445-d340d4c6236e"
},
"blockPageAction": "text",
"blockPageContents": "Access to the requested page has been denied. Please contact your Network Administrator",
"enableAlerts": true,
"alerts": [
"blacklist",
"whitelist",
"categories-reputation"
],
"logging": [],
"targetVpns": [
"10",
"20"
]
}
}
},
"AMP definition": {
"description": "AMP definition",
"value": {
"name": "Demo-AMP-Policy",
"type": "advancedMalwareProtection",
"description": "",
"definition": {
"matchAllVpn": false,
"fileReputationCloudServer": "nam",
"fileReputationEstServer": "nam",
"fileReputationAlert": "critical",
"fileAnalysisCloudServer": "",
"fileAnalysisFileTypes": [],
"fileAnalysisAlert": "",
"targetVpns": [
"10",
"20"
]
}
}
},
"DNS definition": {
"description": "DNS definition",
"value": {
"name": "Demo-DNS-Policy",
"type": "DNSSecurity",
"description": "Testing",
"definition": {
"localDomainBypassList": {
"ref": "143f753f-8d51-4be6-805d-bc330f09982f"
},
"matchAllVpn": true,
"umbrellaDefault": true,
"childOrgId": "7999118",
"localDomainBypassEnabled": true,
"dnsCrypt": true,
"umbrellaData": {
"ref": "e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa"
}
}
}
},
"HubandSpoke definition": {
"description": "HubandSpoke definition",
"value": {
"name": "Demo-Hub-n-Spoke-Policy",
"type": "hubAndSpoke",
"description": "Demo-Hub-n-Spoke-Policy",
"definition": {
"vpnList": "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf",
"subDefinitions": [
{
"name": "My Hub-and-Spoke",
"equalPreference": false,
"advertiseTloc": true,
"spokes": [
{
"siteList": "5c58c36c-9cd6-468f-8434-ee6d5801c6ba",
"hubs": [
{
"siteList": "24747ccd-4f7f-4dfa-8800-34f565fb65b4",
"preference": "20",
"prefixLists": [
"b5c4d764-20bc-4de3-9bac-52ef70f1186c"
],
"ipv6PrefixLists": []
}
]
}
],
"tlocList": "1e97c258-4323-4754-9dc0-44e9656d43bf"
}
]
}
}
},
"VPN membership group definition": {
"description": "VPN membership group definition",
"value": {
"name": "Demo-VPN-Membership-Policy",
"type": "vpnMembershipGroup",
"description": "Demo-VPN-Membership-Policy",
"definition": {
"sites": [
{
"siteList": "24747ccd-4f7f-4dfa-8800-34f565fb65b4",
"vpnList": [
"cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"
]
},
{
"siteList": "5c58c36c-9cd6-468f-8434-ee6d5801c6ba",
"vpnList": [
"cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"
]
}
]
}
}
},
"AppRoute definition": {
"description": "AppRoute definition",
"value": {
"name": "Demo-AAR-Policy",
"type": "appRoute",
"description": "Demo-AAR-Policy",
"sequences": [
{
"sequenceId": 1,
"sequenceName": "App Route",
"sequenceType": "appRoute",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "appList",
"ref": "b6752dba-969b-46de-a7e7-da11910fb1bf"
},
{
"field": "dnsAppList",
"ref": "b6752dba-969b-46de-a7e7-da11910fb1bf"
},
{
"field": "dns",
"value": "request"
},
{
"field": "dscp",
"value": "46"
},
{
"field": "plp",
"value": "high"
},
{
"field": "protocol",
"value": "6"
},
{
"field": "sourceDataPrefixList",
"ref": "6c2b7164-5de2-4775-938c-b443504324ab"
},
{
"field": "sourcePort",
"value": "1025"
},
{
"field": "destinationDataPrefixList",
"ref": "6c2b7164-5de2-4775-938c-b443504324ab"
},
{
"field": "destinationPort",
"value": "65000"
}
]
},
"actions": [
{
"type": "backupSlaPreferredColor",
"parameter": "biz-internet"
},
{
"type": "count",
"parameter": "Demo-Counter"
},
{
"type": "log",
"parameter": ""
},
{
"type": "slaClass",
"parameter": [
{
"field": "name",
"ref": "46cea5a1-1570-4921-b87a-837d590eb37e"
},
{
"field": "preferredColor",
"value": "public-internet"
},
{
"field": "strict"
}
]
}
]
},
{
"sequenceId": 11,
"sequenceName": "App Route",
"sequenceType": "appRoute",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "saasAppList",
"ref": "1e6688ce-2d21-4d7a-9a93-ae6a8ebd4a06"
}
]
},
"actions": [
{
"type": "cloudSaas",
"parameter": ""
}
]
},
{
"sequenceId": 21,
"sequenceName": "App Route",
"sequenceType": "appRoute",
"sequenceIpType": "ipv6",
"match": {
"entries": [
{
"field": "dscp",
"value": "46"
},
{
"field": "protocol",
"value": "6"
},
{
"field": "sourceIpv6",
"value": "2001::/8"
},
{
"field": "sourcePort",
"value": "65000"
},
{
"field": "destinationIpv6",
"value": "2001::/8"
},
{
"field": "destinationPort",
"value": "65000"
}
]
},
"actions": [
{
"type": "backupSlaPreferredColor",
"parameter": "biz-internet"
},
{
"type": "count",
"parameter": "Demo-Counter"
},
{
"type": "log",
"parameter": ""
},
{
"type": "slaClass",
"parameter": [
{
"field": "name",
"ref": "46cea5a1-1570-4921-b87a-837d590eb37e"
},
{
"field": "preferredColor",
"value": "public-internet"
},
{
"field": "strict"
}
]
}
]
}
]
}
},
"Data policy definition": {
"description": "Data policy definition",
"value": {
"name": "Demo-Data-Policy",
"type": "data",
"description": "Demo-Data-Policy",
"defaultAction": {
"type": "drop"
},
"sequences": [
{
"sequenceId": 1,
"sequenceName": "Custom",
"baseAction": "accept",
"sequenceType": "data",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "appList",
"ref": "b6752dba-969b-46de-a7e7-da11910fb1bf"
},
{
"field": "dnsAppList",
"ref": "b6752dba-969b-46de-a7e7-da11910fb1bf"
},
{
"field": "dns",
"value": "response"
},
{
"field": "dscp",
"value": "46"
},
{
"field": "packetLength",
"value": "1504"
},
{
"field": "plp",
"value": "high"
},
{
"field": "protocol",
"value": "6"
},
{
"field": "sourceDataPrefixList",
"ref": "6c2b7164-5de2-4775-938c-b443504324ab"
},
{
"field": "sourcePort",
"value": "65000"
},
{
"field": "destinationIp",
"value": "10.0.0.0/12"
},
{
"field": "destinationPort",
"value": "65000"
},
{
"field": "tcp",
"value": "syn"
}
]
},
"actions": [
{
"type": "count",
"parameter": "Demo-Counter"
},
{
"type": "set",
"parameter": [
{
"field": "dscp",
"value": "34"
},
{
"field": "forwardingClass",
"value": "ef-class"
},
{
"field": "localTlocList",
"value": {
"color": "public-internet",
"restrict": "",
"encap": "ipsec"
}
},
{
"field": "nextHop",
"value": "10.0.0.1"
},
{
"field": "policer",
"ref": "ecf250c7-bef0-405b-8e74-4d67440cac90"
}
]
},
{
"type": "cflowd"
},
{
"type": "log",
"parameter": ""
},
{
"type": "nat",
"parameter": {
"field": "pool",
"value": "1"
}
},
{
"type": "redirectDns",
"parameter": {
"field": "dnsType",
"value": "umbrella"
}
}
]
},
{
"sequenceId": 11,
"sequenceName": "Custom",
"baseAction": "accept",
"sequenceType": "data",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "appList",
"ref": "b6752dba-969b-46de-a7e7-da11910fb1bf"
}
]
},
"actions": [
{
"type": "set",
"parameter": [
{
"field": "service",
"value": {
"type": "FW",
"vpn": "10",
"tloc": {
"ip": "10.0.0.1",
"color": "biz-internet",
"encap": "ipsec"
}
}
}
]
},
{
"type": "tcpOptimization",
"parameter": ""
},
{
"type": "lossProtect",
"parameter": "fecAdaptive"
},
{
"type": "lossProtectFec",
"parameter": "fecAdaptive"
},
{
"type": "sig",
"parameter": ""
}
]
}
]
}
},
"CFlowd definition": {
"description": "CFlowd definition",
"value": {
"name": "Demo-cflowd-Policy",
"type": "cflowd",
"description": "Demo-cflowd-Policy",
"definition": {
"flowActiveTimeout": 3600,
"flowInactiveTimeout": 3600,
"flowSamplingInterval": 65513,
"templateRefresh": 86400,
"collectors": [
{
"vpn": "10",
"address": "10.0.0.1",
"port": 9912,
"transport": "transport_tcp",
"sourceInterface": "ge0/1"
},
{
"vpn": "20",
"address": "10.0.0.1",
"port": 1025,
"transport": "transport_udp",
"sourceInterface": "GigabitEthernet0/0/1"
}
],
"protocol": "ipv4"
}
}
},
"QoS map definition": {
"description": "QoS map definition",
"value": {
"name": "Demo-QoS-Policy",
"type": "qosMap",
"description": "Demo-QoS-Policy",
"definition": {
"qosSchedulers": [
{
"queue": "0",
"bandwidthPercent": "75",
"bufferPercent": "75",
"burst": "15000",
"scheduling": "llq",
"drops": "tail-drop",
"classMapRef": ""
},
{
"queue": "7",
"bandwidthPercent": "25",
"bufferPercent": "25",
"scheduling": "wrr",
"drops": "red-drop",
"classMapRef": "4484c444-b956-4016-bd15-538b74fc2785"
}
]
}
}
},
"VPN-QoS map definition": {
"description": "VPN-QoS map definition",
"value": {
"name": "Demo-VPN-QoS-Policy",
"type": "vpnQosMap",
"description": "Demo-VPN-QoS-Policy",
"definition": {
"vpnQosSchedulers": [
{
"vpnListRef": "",
"bandwidthRate": "100000",
"shapingRate": "120000",
"childMapRef": ""
},
{
"childMapRef": ""
}
]
}
}
},
"Rewrite rule definition": {
"description": "Rewrite rule definition",
"value": {
"name": "Demo-Rewrite-Rule",
"type": "rewriteRule",
"description": "Demo-Rewrite-Rule",
"definition": {
"rules": [
{
"class": "4484c444-b956-4016-bd15-538b74fc2785",
"plp": "low",
"dscp": "46",
"layer2Cos": "2"
}
]
}
}
},
"Device access policy definition": {
"description": "Device access policy definition",
"value": {
"name": "Demo-DeviceAccess-Policy",
"type": "deviceaccesspolicy",
"description": "Demo-DeviceAccess-Policy",
"defaultAction": {
"type": "drop"
},
"sequences": [
{
"sequenceId": 1,
"sequenceName": "Device Access Control List",
"baseAction": "accept",
"sequenceType": "deviceaccesspolicy",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "destinationPort",
"value": "22"
},
{
"field": "sourceIp",
"value": "10.10.24.0/24"
},
{
"field": "sourcePort",
"value": "65000"
},
{
"field": "destinationIp",
"value": "10.10.10.1/32"
},
{
"field": "vpn",
"value": "10"
}
]
},
"actions": []
},
{
"sequenceId": 11,
"sequenceName": "Device Access Control List",
"baseAction": "drop",
"sequenceType": "deviceaccesspolicy",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "destinationPort",
"value": "161"
},
{
"field": "sourceDataPrefixList",
"ref": "6c2b7164-5de2-4775-938c-b443504324ab"
}
]
},
"actions": []
}
]
}
},
"vEdge route definition": {
"description": "vEdge route definition",
"value": {
"name": "Demo-Route-Policy",
"type": "vedgeRoute",
"description": "Demo-Route-Policy",
"defaultAction": {
"type": "reject"
},
"sequences": [
{
"sequenceId": 1,
"sequenceName": "Route",
"baseAction": "accept",
"sequenceType": "vedgeRoute",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "address",
"ref": "b5c4d764-20bc-4de3-9bac-52ef70f1186c"
},
{
"field": "asPath",
"ref": "79f8c180-1a23-4f09-800d-62652b571258"
},
{
"field": "community",
"matchFlag": "or",
"ref": "33de059b-27ec-4a83-be28-8985128381eb"
},
{
"field": "localPreference",
"value": "200"
},
{
"field": "metric",
"value": "100"
},
{
"field": "nextHop",
"ref": "b5c4d764-20bc-4de3-9bac-52ef70f1186c"
},
{
"field": "ompTag",
"value": "10"
},
{
"field": "affinity",
"value": "10"
},
{
"field": "origin",
"value": "igp"
},
{
"field": "ospfTag",
"value": "10"
},
{
"field": "peer",
"value": "10.0.0.1"
}
]
},
"actions": [
{
"type": "set",
"parameter": [
{
"field": "asPath",
"value": {
"exclude": "120 130",
"prepend": "65521 65521"
}
},
{
"field": "localPreference",
"value": "200"
},
{
"field": "metricType",
"value": "type1"
},
{
"field": "metric",
"value": "100"
},
{
"field": "nextHop",
"value": "10.0.0.1"
},
{
"field": "ompTag",
"value": "100"
},
{
"field": "weight",
"value": "200"
},
{
"field": "ospfTag",
"value": "122"
},
{
"field": "originator",
"value": "10.0.0.1"
},
{
"field": "origin",
"value": "igp"
},
{
"field": "community",
"value": "1000:10000"
}
]
}
]
}
]
}
},
"vSmart definition": {
"description": "vSmart definition",
"value": {
"policyDescription": "Demo-Centralized-Policy",
"policyType": "feature",
"policyName": "Demo-Centralized-Policy",
"policyDefinition": {
"assembly": [
{
"definitionId": "eb0daba9-7fc4-4f4f-bae7-cd958f81f863",
"type": "cflowd",
"entries": [
{
"siteLists": [
"5c58c36c-9cd6-468f-8434-ee6d5801c6ba",
"24747ccd-4f7f-4dfa-8800-34f565fb65b4"
]
}
]
},
{
"definitionId": "3e33fa50-a30d-4586-9d69-106121feaaf4",
"type": "data",
"entries": [
{
"direction": "service",
"siteLists": [
"5c58c36c-9cd6-468f-8434-ee6d5801c6ba",
"24747ccd-4f7f-4dfa-8800-34f565fb65b4"
],
"vpnLists": [
"cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"
]
}
]
},
{
"definitionId": "8b2e7c44-2666-48a7-87a0-36a43c2d003e",
"type": "appRoute",
"entries": [
{
"siteLists": [
"5c58c36c-9cd6-468f-8434-ee6d5801c6ba",
"24747ccd-4f7f-4dfa-8800-34f565fb65b4"
],
"vpnLists": [
"cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"
]
}
]
},
{
"definitionId": "1b76052e-1cb5-44b1-8e5e-4096cb261736",
"type": "vpnMembershipGroup"
},
{
"definitionId": "62960276-c797-41fd-bebb-c017fc752f4e",
"type": "hubAndSpoke"
}
]
},
"isPolicyActivated": false
}
},
"vEdge definition": {
"description": "vEdge definition",
"value": {
"policyDescription": "Demo-Local-Policy",
"policyType": "feature",
"policyName": "Demo-Local-Policy",
"policyDefinition": {
"assembly": [
{
"definitionId": "56283dcf-6dda-4831-bcd1-d9cf62d33fdc",
"type": "qosMap"
},
{
"definitionId": "a75ead1f-f6ab-4a80-af29-79b742b31c5c",
"type": "rewriteRule"
},
{
"definitionId": "555dd393-e7b6-4861-866f-f227f5f780b7",
"type": "deviceAccessPolicy"
},
{
"definitionId": "22655824-d0df-4a8b-9be0-9808938a0e6b",
"type": "vedgeRoute"
}
],
"settings": {
"flowVisibility": true,
"flowVisibilityIPv6": true,
"appVisibility": true,
"cloudQos": true,
"cloudQosServiceSide": true,
"implicitAclLogging": true,
"appVisibilityIPv6": true
}
},
"isPolicyActivated": false
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Task Id": {
"description": "Task Id",
"value": {
"definitionId": "00f718df-4f95-4363-8639-1fe855c9eb09"
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"get": {
"tags": [
"Configuration - Policy URL Filtering Definition Builder"
],
"description": "Get policy definitions",
"operationId": "getDefinitions_ConfigurationPolicyUrlFilteringDefinitionBuilder_4003",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/definition/urlfiltering/bulk": {
"put": {
"tags": [
"Configuration - Policy URL Filtering Definition Builder"
],
"description": "Create/Edit policy definitions in bulk",
"operationId": "savePolicyDefinitionInBulk_ConfigurationPolicyUrlFilteringDefinitionBuilder_4503",
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/definition/urlfiltering/multiple/{id}": {
"put": {
"tags": [
"Configuration - Policy URL Filtering Definition Builder"
],
"description": "Edit multiple policy definitions",
"operationId": "editMultiplePolicyDefinition_ConfigurationPolicyUrlFilteringDefinitionBuilder_5403",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/definition/urlfiltering/preview": {
"post": {
"tags": [
"Configuration - Policy URL Filtering Definition Builder"
],
"description": "Preview policy definition",
"operationId": "previewPolicyDefinition_ConfigurationPolicyUrlFilteringDefinitionBuilder_4804",
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/definition/urlfiltering/preview/{id}": {
"get": {
"tags": [
"Configuration - Policy URL Filtering Definition Builder"
],
"description": "Preview policy definition",
"operationId": "previewPolicyDefinitionById_ConfigurationPolicyUrlFilteringDefinitionBuilder_5303",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/definition/urlfiltering/{id}": {
"get": {
"tags": [
"Configuration - Policy URL Filtering Definition Builder"
],
"description": "Get a specific policy definitions",
"operationId": "getPolicyDefinition_ConfigurationPolicyUrlFilteringDefinitionBuilder_4503",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
},
"put": {
"tags": [
"Configuration - Policy URL Filtering Definition Builder"
],
"description": "Edit a policy definitions",
"operationId": "editPolicyDefinition_ConfigurationPolicyUrlFilteringDefinitionBuilder_4503",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"ACL policy": {
"description": "ACL policy",
"value": {
"name": "Demo-ACL",
"type": "acl",
"description": "Demo-ACL",
"defaultAction": {
"type": "accept"
},
"sequences": [
{
"sequenceId": 1,
"sequenceName": "Access Control List",
"baseAction": "accept",
"sequenceType": "acl",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "dscp",
"value": "46"
},
{
"field": "protocol",
"value": "6"
}
]
},
"actions": [
{
"type": "class",
"parameter": {
"ref": "89d20034-7149-4492-b392-b5c4f7903235"
}
}
]
}
]
}
},
"ZBFW definition": {
"description": "ZBFW definition",
"value": {
"name": "Demo-ZBFW",
"type": "zoneBasedFW",
"description": "Demo-ZBFW",
"definition": {
"defaultAction": {
"type": "drop"
},
"sequences": [
{
"sequenceId": 1,
"sequenceName": "Demo-Rule-1",
"baseAction": "inspect",
"sequenceType": "zoneBasedFW",
"match": {
"entries": [
{
"field": "sourceDataPrefixList",
"ref": "ecbea5de-b200-4ff7-aa76-f537b5f858e9"
}
]
},
"actions": []
}
],
"entries": [
{
"sourceZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53",
"destinationZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53"
}
]
}
}
},
"IPS definition": {
"description": "IPS definition",
"value": {
"name": "Demo-IPS-Policy",
"type": "intrusionPrevention",
"description": "Testing",
"definition": {
"signatureSet": "security",
"inspectionMode": "detection",
"signatureWhiteList": {
"ref": "ad189f08-af06-4799-97d6-0a7c7409cb8d"
},
"logLevel": "error",
"logging": [],
"targetVpns": [
"10",
"20"
]
}
}
},
"URL filtering definition": {
"description": "URL filtering definition",
"value": {
"name": "Demo-URL-Filtering-Policy",
"type": "urlFiltering",
"description": "",
"definition": {
"webCategoriesAction": "block",
"webCategories": [
"auctions",
"bot-nets",
"news-and-media"
],
"webReputation": "moderate-risk",
"urlWhiteList": {
"ref": "c20e31fb-fcea-4f48-93e3-09d2c6492d8b"
},
"urlBlackList": {
"ref": "557ed432-6cf8-495b-a445-d340d4c6236e"
},
"blockPageAction": "text",
"blockPageContents": "Access to the requested page has been denied. Please contact your Network Administrator",
"enableAlerts": true,
"alerts": [
"blacklist",
"whitelist",
"categories-reputation"
],
"logging": [],
"targetVpns": [
"30"
]
}
}
},
"AMP definition": {
"description": "AMP definition",
"value": {
"name": "Demo-AMP-Policy",
"type": "advancedMalwareProtection",
"description": "",
"definition": {
"matchAllVpn": true,
"fileReputationCloudServer": "nam",
"fileReputationEstServer": "nam",
"fileReputationAlert": "critical",
"fileAnalysisCloudServer": "nam",
"fileAnalysisFileTypes": [
"pdf",
"ms-exe"
],
"fileAnalysisAlert": "critical",
"targetVpns": [
"10",
"20"
],
"fileAnalysisEnabled": true
}
}
},
"DNS definition": {
"description": "DNS definition",
"value": {
"name": "Demo-DNS-Policy",
"type": "DNSSecurity",
"description": "Testing",
"definition": {
"localDomainBypassList": {
"ref": "143f753f-8d51-4be6-805d-bc330f09982f"
},
"matchAllVpn": false,
"targetVpns": [
{
"vpns": [
"10"
],
"umbrellaDefault": false,
"childOrgId": "7999118",
"dnsServerIP": "10.10.10.1",
"localDomainBypassEnabled": true
}
],
"dnsCrypt": true,
"umbrellaData": {
"ref": "e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa"
}
}
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {
"masterTemplatesAffected": []
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"delete": {
"tags": [
"Configuration - Policy URL Filtering Definition Builder"
],
"description": "Delete policy definition",
"operationId": "deletePolicyDefinition_ConfigurationPolicyUrlFilteringDefinitionBuilder_4506",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/definition/vedgeroute": {
"get": {
"tags": [
"Configuration - Policy vEdge Route Definition Builder"
],
"description": "Get policy definitions",
"operationId": "getDefinitions_ConfigurationPolicyVedgeRouteDefinitionBuilder_3803",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Route Policy-read,Route Policy-write"
},
"post": {
"tags": [
"Configuration - Policy vEdge Route Definition Builder"
],
"description": "Create policy definition",
"operationId": "createPolicyDefinition_ConfigurationPolicyVedgeRouteDefinitionBuilder_3804",
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write,Route Policy-write"
}
},
"/template/policy/definition/vedgeroute/bulk": {
"put": {
"tags": [
"Configuration - Policy vEdge Route Definition Builder"
],
"description": "Create/Edit policy definitions in bulk",
"operationId": "savePolicyDefinitionInBulk_ConfigurationPolicyVedgeRouteDefinitionBuilder_4303",
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/definition/vedgeroute/multiple/{id}": {
"put": {
"tags": [
"Configuration - Policy vEdge Route Definition Builder"
],
"description": "Edit multiple policy definitions",
"operationId": "editMultiplePolicyDefinition_ConfigurationPolicyVedgeRouteDefinitionBuilder_5203",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/definition/vedgeroute/preview": {
"post": {
"tags": [
"Configuration - Policy vEdge Route Definition Builder"
],
"description": "Preview policy definition",
"operationId": "previewPolicyDefinition_ConfigurationPolicyVedgeRouteDefinitionBuilder_4604",
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/definition/vedgeroute/preview/{id}": {
"get": {
"tags": [
"Configuration - Policy vEdge Route Definition Builder"
],
"description": "Preview policy definition",
"operationId": "previewPolicyDefinitionById_ConfigurationPolicyVedgeRouteDefinitionBuilder_5103",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/definition/vedgeroute/{id}": {
"get": {
"tags": [
"Configuration - Policy vEdge Route Definition Builder"
],
"description": "Get a specific policy definitions",
"operationId": "getPolicyDefinition_ConfigurationPolicyVedgeRouteDefinitionBuilder_4303",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Route Policy-read,Route Policy-write"
},
"put": {
"tags": [
"Configuration - Policy vEdge Route Definition Builder"
],
"description": "Edit a policy definitions",
"operationId": "editPolicyDefinition_ConfigurationPolicyVedgeRouteDefinitionBuilder_4303",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write,Route Policy-write"
},
"delete": {
"tags": [
"Configuration - Policy vEdge Route Definition Builder"
],
"description": "Delete policy definition",
"operationId": "deletePolicyDefinition_ConfigurationPolicyVedgeRouteDefinitionBuilder_4306",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write,Route Policy-write"
}
},
"/template/policy/definition/vpnmembershipgroup": {
"post": {
"tags": [
"Configuration - Policy VPN Membership Group Definition Builder"
],
"description": "Create policy definition",
"operationId": "createPolicyDefinition_ConfigurationPolicyVpnMembershipGroupDefinitionBuilder_4604",
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Topology Policy-write,VPN Membership Policy-write"
},
"get": {
"tags": [
"Configuration - Policy VPN Membership Group Definition Builder"
],
"description": "Get policy definitions",
"operationId": "getDefinitions_ConfigurationPolicyVpnMembershipGroupDefinitionBuilder_4603",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,VPN Membership Policy-read,VPN Membership Policy-write"
}
},
"/template/policy/definition/vpnmembershipgroup/bulk": {
"put": {
"tags": [
"Configuration - Policy VPN Membership Group Definition Builder"
],
"description": "Create/Edit policy definitions in bulk",
"operationId": "savePolicyDefinitionInBulk_ConfigurationPolicyVpnMembershipGroupDefinitionBuilder_5103",
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/definition/vpnmembershipgroup/multiple/{id}": {
"put": {
"tags": [
"Configuration - Policy VPN Membership Group Definition Builder"
],
"description": "Edit multiple policy definitions",
"operationId": "editMultiplePolicyDefinition_ConfigurationPolicyVpnMembershipGroupDefinitionBuilder_6003",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/definition/vpnmembershipgroup/preview": {
"post": {
"tags": [
"Configuration - Policy VPN Membership Group Definition Builder"
],
"description": "Preview policy definition",
"operationId": "previewPolicyDefinition_ConfigurationPolicyVpnMembershipGroupDefinitionBuilder_5404",
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/definition/vpnmembershipgroup/preview/{id}": {
"get": {
"tags": [
"Configuration - Policy VPN Membership Group Definition Builder"
],
"description": "Preview policy definition",
"operationId": "previewPolicyDefinitionById_ConfigurationPolicyVpnMembershipGroupDefinitionBuilder_5903",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/definition/vpnmembershipgroup/{id}": {
"delete": {
"tags": [
"Configuration - Policy VPN Membership Group Definition Builder"
],
"description": "Delete policy definition",
"operationId": "deletePolicyDefinition_ConfigurationPolicyVpnMembershipGroupDefinitionBuilder_5106",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Topology Policy-write,VPN Membership Policy-write"
},
"get": {
"tags": [
"Configuration - Policy VPN Membership Group Definition Builder"
],
"description": "Get a specific policy definitions",
"operationId": "getPolicyDefinition_ConfigurationPolicyVpnMembershipGroupDefinitionBuilder_5103",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,VPN Membership Policy-read,VPN Membership Policy-write"
},
"put": {
"tags": [
"Configuration - Policy VPN Membership Group Definition Builder"
],
"description": "Edit a policy definitions",
"operationId": "editPolicyDefinition_ConfigurationPolicyVpnMembershipGroupDefinitionBuilder_5103",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Topology Policy-write,VPN Membership Policy-write"
}
},
"/template/policy/definition/vpnqosmap": {
"get": {
"tags": [
"Configuration - Policy VPN-Qos Map Definition Builder"
],
"description": "Get policy definitions",
"operationId": "getDefinitions_ConfigurationPolicyVpnQosMapDefinitionBuilder_3703",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,QoSMap Policy-read,QoSMap Policy-write,Policy Configuration-write"
},
"post": {
"tags": [
"Configuration - Policy VPN-Qos Map Definition Builder"
],
"description": "Create policy definition",
"operationId": "createPolicyDefinition_ConfigurationPolicyVpnQosMapDefinitionBuilder_3704",
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "QoSMap Policy-write,Policy Configuration-write"
}
},
"/template/policy/definition/vpnqosmap/bulk": {
"put": {
"tags": [
"Configuration - Policy VPN-Qos Map Definition Builder"
],
"description": "Create/Edit policy definitions in bulk",
"operationId": "savePolicyDefinitionInBulk_ConfigurationPolicyVpnQosMapDefinitionBuilder_4203",
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/definition/vpnqosmap/multiple/{id}": {
"put": {
"tags": [
"Configuration - Policy VPN-Qos Map Definition Builder"
],
"description": "Edit multiple policy definitions",
"operationId": "editMultiplePolicyDefinition_ConfigurationPolicyVpnQosMapDefinitionBuilder_5103",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/definition/vpnqosmap/preview": {
"post": {
"tags": [
"Configuration - Policy VPN-Qos Map Definition Builder"
],
"description": "Preview policy definition",
"operationId": "previewPolicyDefinition_ConfigurationPolicyVpnQosMapDefinitionBuilder_4504",
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/definition/vpnqosmap/preview/{id}": {
"get": {
"tags": [
"Configuration - Policy VPN-Qos Map Definition Builder"
],
"description": "Preview policy definition",
"operationId": "previewPolicyDefinitionById_ConfigurationPolicyVpnQosMapDefinitionBuilder_5003",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/definition/vpnqosmap/{id}": {
"get": {
"tags": [
"Configuration - Policy VPN-Qos Map Definition Builder"
],
"description": "Get a specific policy definitions",
"operationId": "getPolicyDefinition_ConfigurationPolicyVpnQosMapDefinitionBuilder_4203",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,QoSMap Policy-read,Policy Configuration-write,QoSMap Policy-write"
},
"delete": {
"tags": [
"Configuration - Policy VPN-Qos Map Definition Builder"
],
"description": "Delete policy definition",
"operationId": "deletePolicyDefinition_ConfigurationPolicyVpnQosMapDefinitionBuilder_4206",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "QoSMap Policy-write,Policy Configuration-write"
},
"put": {
"tags": [
"Configuration - Policy VPN-Qos Map Definition Builder"
],
"description": "Edit a policy definitions",
"operationId": "editPolicyDefinition_ConfigurationPolicyVpnQosMapDefinitionBuilder_4203",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "QoSMap Policy-write,Policy Configuration-write"
}
},
"/template/policy/definition/zonebasedfw": {
"get": {
"tags": [
"Configuration - Policy Zone Based Firewall Definition Builder"
],
"description": "Get policy definitions",
"operationId": "getDefinitions_ConfigurationPolicyZoneBasedFirewallDefinitionBuilder_3903",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
},
"post": {
"tags": [
"Configuration - Policy Zone Based Firewall Definition Builder"
],
"description": "Create policy definition",
"operationId": "createPolicyDefinition_ConfigurationPolicyZoneBasedFirewallDefinitionBuilder_3904",
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"ACL policy": {
"description": "ACL policy",
"value": {
"name": "Demo-ACL",
"type": "acl",
"description": "Demo-ACL",
"defaultAction": {
"type": "accept"
},
"sequences": [
{
"sequenceId": 1,
"sequenceName": "Access Control List",
"baseAction": "accept",
"sequenceType": "acl",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "dscp",
"value": "46"
}
]
},
"actions": [
{
"type": "class",
"parameter": {
"ref": "89d20034-7149-4492-b392-b5c4f7903235"
}
}
]
}
]
}
},
"ZBFW definition": {
"description": "ZBFW definition",
"value": {
"name": "Demo-ZBFW",
"type": "zoneBasedFW",
"description": "Demo-ZBFW",
"definition": {
"defaultAction": {
"type": "drop"
},
"sequences": [],
"entries": [
{
"sourceZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53",
"destinationZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53"
}
]
}
}
},
"IPS definition": {
"description": "IPS definition",
"value": {
"name": "Demo-IPS-Policy",
"type": "intrusionPrevention",
"description": "Testing",
"definition": {
"signatureSet": "security",
"inspectionMode": "detection",
"signatureWhiteList": {
"ref": "ad189f08-af06-4799-97d6-0a7c7409cb8d"
},
"logLevel": "error",
"logging": [],
"targetVpns": [
"10"
]
}
}
},
"URL filtering definition": {
"description": "URL filtering definition",
"value": {
"name": "Demo-URL-Filtering-Policy",
"type": "urlFiltering",
"description": "",
"definition": {
"webCategoriesAction": "block",
"webCategories": [
"auctions",
"bot-nets"
],
"webReputation": "moderate-risk",
"urlWhiteList": {
"ref": "c20e31fb-fcea-4f48-93e3-09d2c6492d8b"
},
"urlBlackList": {
"ref": "557ed432-6cf8-495b-a445-d340d4c6236e"
},
"blockPageAction": "text",
"blockPageContents": "Access to the requested page has been denied. Please contact your Network Administrator",
"enableAlerts": true,
"alerts": [
"blacklist",
"whitelist",
"categories-reputation"
],
"logging": [],
"targetVpns": [
"10",
"20"
]
}
}
},
"AMP definition": {
"description": "AMP definition",
"value": {
"name": "Demo-AMP-Policy",
"type": "advancedMalwareProtection",
"description": "",
"definition": {
"matchAllVpn": false,
"fileReputationCloudServer": "nam",
"fileReputationEstServer": "nam",
"fileReputationAlert": "critical",
"fileAnalysisCloudServer": "",
"fileAnalysisFileTypes": [],
"fileAnalysisAlert": "",
"targetVpns": [
"10",
"20"
]
}
}
},
"DNS definition": {
"description": "DNS definition",
"value": {
"name": "Demo-DNS-Policy",
"type": "DNSSecurity",
"description": "Testing",
"definition": {
"localDomainBypassList": {
"ref": "143f753f-8d51-4be6-805d-bc330f09982f"
},
"matchAllVpn": true,
"umbrellaDefault": true,
"childOrgId": "7999118",
"localDomainBypassEnabled": true,
"dnsCrypt": true,
"umbrellaData": {
"ref": "e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa"
}
}
}
},
"HubandSpoke definition": {
"description": "HubandSpoke definition",
"value": {
"name": "Demo-Hub-n-Spoke-Policy",
"type": "hubAndSpoke",
"description": "Demo-Hub-n-Spoke-Policy",
"definition": {
"vpnList": "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf",
"subDefinitions": [
{
"name": "My Hub-and-Spoke",
"equalPreference": false,
"advertiseTloc": true,
"spokes": [
{
"siteList": "5c58c36c-9cd6-468f-8434-ee6d5801c6ba",
"hubs": [
{
"siteList": "24747ccd-4f7f-4dfa-8800-34f565fb65b4",
"preference": "20",
"prefixLists": [
"b5c4d764-20bc-4de3-9bac-52ef70f1186c"
],
"ipv6PrefixLists": []
}
]
}
],
"tlocList": "1e97c258-4323-4754-9dc0-44e9656d43bf"
}
]
}
}
},
"VPN membership group definition": {
"description": "VPN membership group definition",
"value": {
"name": "Demo-VPN-Membership-Policy",
"type": "vpnMembershipGroup",
"description": "Demo-VPN-Membership-Policy",
"definition": {
"sites": [
{
"siteList": "24747ccd-4f7f-4dfa-8800-34f565fb65b4",
"vpnList": [
"cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"
]
},
{
"siteList": "5c58c36c-9cd6-468f-8434-ee6d5801c6ba",
"vpnList": [
"cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"
]
}
]
}
}
},
"AppRoute definition": {
"description": "AppRoute definition",
"value": {
"name": "Demo-AAR-Policy",
"type": "appRoute",
"description": "Demo-AAR-Policy",
"sequences": [
{
"sequenceId": 1,
"sequenceName": "App Route",
"sequenceType": "appRoute",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "appList",
"ref": "b6752dba-969b-46de-a7e7-da11910fb1bf"
},
{
"field": "dnsAppList",
"ref": "b6752dba-969b-46de-a7e7-da11910fb1bf"
},
{
"field": "dns",
"value": "request"
},
{
"field": "dscp",
"value": "46"
},
{
"field": "plp",
"value": "high"
},
{
"field": "protocol",
"value": "6"
},
{
"field": "sourceDataPrefixList",
"ref": "6c2b7164-5de2-4775-938c-b443504324ab"
},
{
"field": "sourcePort",
"value": "1025"
},
{
"field": "destinationDataPrefixList",
"ref": "6c2b7164-5de2-4775-938c-b443504324ab"
},
{
"field": "destinationPort",
"value": "65000"
}
]
},
"actions": [
{
"type": "backupSlaPreferredColor",
"parameter": "biz-internet"
},
{
"type": "count",
"parameter": "Demo-Counter"
},
{
"type": "log",
"parameter": ""
},
{
"type": "slaClass",
"parameter": [
{
"field": "name",
"ref": "46cea5a1-1570-4921-b87a-837d590eb37e"
},
{
"field": "preferredColor",
"value": "public-internet"
},
{
"field": "strict"
}
]
}
]
},
{
"sequenceId": 11,
"sequenceName": "App Route",
"sequenceType": "appRoute",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "saasAppList",
"ref": "1e6688ce-2d21-4d7a-9a93-ae6a8ebd4a06"
}
]
},
"actions": [
{
"type": "cloudSaas",
"parameter": ""
}
]
},
{
"sequenceId": 21,
"sequenceName": "App Route",
"sequenceType": "appRoute",
"sequenceIpType": "ipv6",
"match": {
"entries": [
{
"field": "dscp",
"value": "46"
},
{
"field": "protocol",
"value": "6"
},
{
"field": "sourceIpv6",
"value": "2001::/8"
},
{
"field": "sourcePort",
"value": "65000"
},
{
"field": "destinationIpv6",
"value": "2001::/8"
},
{
"field": "destinationPort",
"value": "65000"
}
]
},
"actions": [
{
"type": "backupSlaPreferredColor",
"parameter": "biz-internet"
},
{
"type": "count",
"parameter": "Demo-Counter"
},
{
"type": "log",
"parameter": ""
},
{
"type": "slaClass",
"parameter": [
{
"field": "name",
"ref": "46cea5a1-1570-4921-b87a-837d590eb37e"
},
{
"field": "preferredColor",
"value": "public-internet"
},
{
"field": "strict"
}
]
}
]
}
]
}
},
"Data policy definition": {
"description": "Data policy definition",
"value": {
"name": "Demo-Data-Policy",
"type": "data",
"description": "Demo-Data-Policy",
"defaultAction": {
"type": "drop"
},
"sequences": [
{
"sequenceId": 1,
"sequenceName": "Custom",
"baseAction": "accept",
"sequenceType": "data",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "appList",
"ref": "b6752dba-969b-46de-a7e7-da11910fb1bf"
},
{
"field": "dnsAppList",
"ref": "b6752dba-969b-46de-a7e7-da11910fb1bf"
},
{
"field": "dns",
"value": "response"
},
{
"field": "dscp",
"value": "46"
},
{
"field": "packetLength",
"value": "1504"
},
{
"field": "plp",
"value": "high"
},
{
"field": "protocol",
"value": "6"
},
{
"field": "sourceDataPrefixList",
"ref": "6c2b7164-5de2-4775-938c-b443504324ab"
},
{
"field": "sourcePort",
"value": "65000"
},
{
"field": "destinationIp",
"value": "10.0.0.0/12"
},
{
"field": "destinationPort",
"value": "65000"
},
{
"field": "tcp",
"value": "syn"
}
]
},
"actions": [
{
"type": "count",
"parameter": "Demo-Counter"
},
{
"type": "set",
"parameter": [
{
"field": "dscp",
"value": "34"
},
{
"field": "forwardingClass",
"value": "ef-class"
},
{
"field": "localTlocList",
"value": {
"color": "public-internet",
"restrict": "",
"encap": "ipsec"
}
},
{
"field": "nextHop",
"value": "10.0.0.1"
},
{
"field": "policer",
"ref": "ecf250c7-bef0-405b-8e74-4d67440cac90"
}
]
},
{
"type": "cflowd"
},
{
"type": "log",
"parameter": ""
},
{
"type": "nat",
"parameter": {
"field": "pool",
"value": "1"
}
},
{
"type": "redirectDns",
"parameter": {
"field": "dnsType",
"value": "umbrella"
}
}
]
},
{
"sequenceId": 11,
"sequenceName": "Custom",
"baseAction": "accept",
"sequenceType": "data",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "appList",
"ref": "b6752dba-969b-46de-a7e7-da11910fb1bf"
}
]
},
"actions": [
{
"type": "set",
"parameter": [
{
"field": "service",
"value": {
"type": "FW",
"vpn": "10",
"tloc": {
"ip": "10.0.0.1",
"color": "biz-internet",
"encap": "ipsec"
}
}
}
]
},
{
"type": "tcpOptimization",
"parameter": ""
},
{
"type": "lossProtect",
"parameter": "fecAdaptive"
},
{
"type": "lossProtectFec",
"parameter": "fecAdaptive"
},
{
"type": "sig",
"parameter": ""
}
]
}
]
}
},
"CFlowd definition": {
"description": "CFlowd definition",
"value": {
"name": "Demo-cflowd-Policy",
"type": "cflowd",
"description": "Demo-cflowd-Policy",
"definition": {
"flowActiveTimeout": 3600,
"flowInactiveTimeout": 3600,
"flowSamplingInterval": 65513,
"templateRefresh": 86400,
"collectors": [
{
"vpn": "10",
"address": "10.0.0.1",
"port": 9912,
"transport": "transport_tcp",
"sourceInterface": "ge0/1"
},
{
"vpn": "20",
"address": "10.0.0.1",
"port": 1025,
"transport": "transport_udp",
"sourceInterface": "GigabitEthernet0/0/1"
}
],
"protocol": "ipv4"
}
}
},
"QoS map definition": {
"description": "QoS map definition",
"value": {
"name": "Demo-QoS-Policy",
"type": "qosMap",
"description": "Demo-QoS-Policy",
"definition": {
"qosSchedulers": [
{
"queue": "0",
"bandwidthPercent": "75",
"bufferPercent": "75",
"burst": "15000",
"scheduling": "llq",
"drops": "tail-drop",
"classMapRef": ""
},
{
"queue": "7",
"bandwidthPercent": "25",
"bufferPercent": "25",
"scheduling": "wrr",
"drops": "red-drop",
"classMapRef": "4484c444-b956-4016-bd15-538b74fc2785"
}
]
}
}
},
"VPN-QoS map definition": {
"description": "VPN-QoS map definition",
"value": {
"name": "Demo-VPN-QoS-Policy",
"type": "vpnQosMap",
"description": "Demo-VPN-QoS-Policy",
"definition": {
"vpnQosSchedulers": [
{
"vpnListRef": "",
"bandwidthRate": "100000",
"shapingRate": "120000",
"childMapRef": ""
},
{
"childMapRef": ""
}
]
}
}
},
"Rewrite rule definition": {
"description": "Rewrite rule definition",
"value": {
"name": "Demo-Rewrite-Rule",
"type": "rewriteRule",
"description": "Demo-Rewrite-Rule",
"definition": {
"rules": [
{
"class": "4484c444-b956-4016-bd15-538b74fc2785",
"plp": "low",
"dscp": "46",
"layer2Cos": "2"
}
]
}
}
},
"Device access policy definition": {
"description": "Device access policy definition",
"value": {
"name": "Demo-DeviceAccess-Policy",
"type": "deviceaccesspolicy",
"description": "Demo-DeviceAccess-Policy",
"defaultAction": {
"type": "drop"
},
"sequences": [
{
"sequenceId": 1,
"sequenceName": "Device Access Control List",
"baseAction": "accept",
"sequenceType": "deviceaccesspolicy",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "destinationPort",
"value": "22"
},
{
"field": "sourceIp",
"value": "10.10.24.0/24"
},
{
"field": "sourcePort",
"value": "65000"
},
{
"field": "destinationIp",
"value": "10.10.10.1/32"
},
{
"field": "vpn",
"value": "10"
}
]
},
"actions": []
},
{
"sequenceId": 11,
"sequenceName": "Device Access Control List",
"baseAction": "drop",
"sequenceType": "deviceaccesspolicy",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "destinationPort",
"value": "161"
},
{
"field": "sourceDataPrefixList",
"ref": "6c2b7164-5de2-4775-938c-b443504324ab"
}
]
},
"actions": []
}
]
}
},
"vEdge route definition": {
"description": "vEdge route definition",
"value": {
"name": "Demo-Route-Policy",
"type": "vedgeRoute",
"description": "Demo-Route-Policy",
"defaultAction": {
"type": "reject"
},
"sequences": [
{
"sequenceId": 1,
"sequenceName": "Route",
"baseAction": "accept",
"sequenceType": "vedgeRoute",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "address",
"ref": "b5c4d764-20bc-4de3-9bac-52ef70f1186c"
},
{
"field": "asPath",
"ref": "79f8c180-1a23-4f09-800d-62652b571258"
},
{
"field": "community",
"matchFlag": "or",
"ref": "33de059b-27ec-4a83-be28-8985128381eb"
},
{
"field": "localPreference",
"value": "200"
},
{
"field": "metric",
"value": "100"
},
{
"field": "nextHop",
"ref": "b5c4d764-20bc-4de3-9bac-52ef70f1186c"
},
{
"field": "ompTag",
"value": "10"
},
{
"field": "affinity",
"value": "10"
},
{
"field": "origin",
"value": "igp"
},
{
"field": "ospfTag",
"value": "10"
},
{
"field": "peer",
"value": "10.0.0.1"
}
]
},
"actions": [
{
"type": "set",
"parameter": [
{
"field": "asPath",
"value": {
"exclude": "120 130",
"prepend": "65521 65521"
}
},
{
"field": "localPreference",
"value": "200"
},
{
"field": "metricType",
"value": "type1"
},
{
"field": "metric",
"value": "100"
},
{
"field": "nextHop",
"value": "10.0.0.1"
},
{
"field": "ompTag",
"value": "100"
},
{
"field": "weight",
"value": "200"
},
{
"field": "ospfTag",
"value": "122"
},
{
"field": "originator",
"value": "10.0.0.1"
},
{
"field": "origin",
"value": "igp"
},
{
"field": "community",
"value": "1000:10000"
}
]
}
]
}
]
}
},
"vSmart definition": {
"description": "vSmart definition",
"value": {
"policyDescription": "Demo-Centralized-Policy",
"policyType": "feature",
"policyName": "Demo-Centralized-Policy",
"policyDefinition": {
"assembly": [
{
"definitionId": "eb0daba9-7fc4-4f4f-bae7-cd958f81f863",
"type": "cflowd",
"entries": [
{
"siteLists": [
"5c58c36c-9cd6-468f-8434-ee6d5801c6ba",
"24747ccd-4f7f-4dfa-8800-34f565fb65b4"
]
}
]
},
{
"definitionId": "3e33fa50-a30d-4586-9d69-106121feaaf4",
"type": "data",
"entries": [
{
"direction": "service",
"siteLists": [
"5c58c36c-9cd6-468f-8434-ee6d5801c6ba",
"24747ccd-4f7f-4dfa-8800-34f565fb65b4"
],
"vpnLists": [
"cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"
]
}
]
},
{
"definitionId": "8b2e7c44-2666-48a7-87a0-36a43c2d003e",
"type": "appRoute",
"entries": [
{
"siteLists": [
"5c58c36c-9cd6-468f-8434-ee6d5801c6ba",
"24747ccd-4f7f-4dfa-8800-34f565fb65b4"
],
"vpnLists": [
"cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"
]
}
]
},
{
"definitionId": "1b76052e-1cb5-44b1-8e5e-4096cb261736",
"type": "vpnMembershipGroup"
},
{
"definitionId": "62960276-c797-41fd-bebb-c017fc752f4e",
"type": "hubAndSpoke"
}
]
},
"isPolicyActivated": false
}
},
"vEdge definition": {
"description": "vEdge definition",
"value": {
"policyDescription": "Demo-Local-Policy",
"policyType": "feature",
"policyName": "Demo-Local-Policy",
"policyDefinition": {
"assembly": [
{
"definitionId": "56283dcf-6dda-4831-bcd1-d9cf62d33fdc",
"type": "qosMap"
},
{
"definitionId": "a75ead1f-f6ab-4a80-af29-79b742b31c5c",
"type": "rewriteRule"
},
{
"definitionId": "555dd393-e7b6-4861-866f-f227f5f780b7",
"type": "deviceAccessPolicy"
},
{
"definitionId": "22655824-d0df-4a8b-9be0-9808938a0e6b",
"type": "vedgeRoute"
}
],
"settings": {
"flowVisibility": true,
"flowVisibilityIPv6": true,
"appVisibility": true,
"cloudQos": true,
"cloudQosServiceSide": true,
"implicitAclLogging": true,
"appVisibilityIPv6": true
}
},
"isPolicyActivated": false
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Task Id": {
"description": "Task Id",
"value": {
"definitionId": "00f718df-4f95-4363-8639-1fe855c9eb09"
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/definition/zonebasedfw/bulk": {
"put": {
"tags": [
"Configuration - Policy Zone Based Firewall Definition Builder"
],
"description": "Create/Edit policy definitions in bulk",
"operationId": "savePolicyDefinitionInBulk_ConfigurationPolicyZoneBasedFirewallDefinitionBuilder_4403",
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/definition/zonebasedfw/multiple/{id}": {
"put": {
"tags": [
"Configuration - Policy Zone Based Firewall Definition Builder"
],
"description": "Edit multiple policy definitions",
"operationId": "editMultiplePolicyDefinition_ConfigurationPolicyZoneBasedFirewallDefinitionBuilder_5303",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/definition/zonebasedfw/preview": {
"post": {
"tags": [
"Configuration - Policy Zone Based Firewall Definition Builder"
],
"description": "Preview policy definition",
"operationId": "previewPolicyDefinition_ConfigurationPolicyZoneBasedFirewallDefinitionBuilder_4704",
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/definition/zonebasedfw/preview/{id}": {
"get": {
"tags": [
"Configuration - Policy Zone Based Firewall Definition Builder"
],
"description": "Preview policy definition",
"operationId": "previewPolicyDefinitionById_ConfigurationPolicyZoneBasedFirewallDefinitionBuilder_5203",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/definition/zonebasedfw/{id}": {
"delete": {
"tags": [
"Configuration - Policy Zone Based Firewall Definition Builder"
],
"description": "Delete policy definition",
"operationId": "deletePolicyDefinition_ConfigurationPolicyZoneBasedFirewallDefinitionBuilder_4406",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"put": {
"tags": [
"Configuration - Policy Zone Based Firewall Definition Builder"
],
"description": "Edit a policy definitions",
"operationId": "editPolicyDefinition_ConfigurationPolicyZoneBasedFirewallDefinitionBuilder_4403",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy definition",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"ACL policy": {
"description": "ACL policy",
"value": {
"name": "Demo-ACL",
"type": "acl",
"description": "Demo-ACL",
"defaultAction": {
"type": "accept"
},
"sequences": [
{
"sequenceId": 1,
"sequenceName": "Access Control List",
"baseAction": "accept",
"sequenceType": "acl",
"sequenceIpType": "ipv4",
"match": {
"entries": [
{
"field": "dscp",
"value": "46"
},
{
"field": "protocol",
"value": "6"
}
]
},
"actions": [
{
"type": "class",
"parameter": {
"ref": "89d20034-7149-4492-b392-b5c4f7903235"
}
}
]
}
]
}
},
"ZBFW definition": {
"description": "ZBFW definition",
"value": {
"name": "Demo-ZBFW",
"type": "zoneBasedFW",
"description": "Demo-ZBFW",
"definition": {
"defaultAction": {
"type": "drop"
},
"sequences": [
{
"sequenceId": 1,
"sequenceName": "Demo-Rule-1",
"baseAction": "inspect",
"sequenceType": "zoneBasedFW",
"match": {
"entries": [
{
"field": "sourceDataPrefixList",
"ref": "ecbea5de-b200-4ff7-aa76-f537b5f858e9"
}
]
},
"actions": []
}
],
"entries": [
{
"sourceZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53",
"destinationZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53"
}
]
}
}
},
"IPS definition": {
"description": "IPS definition",
"value": {
"name": "Demo-IPS-Policy",
"type": "intrusionPrevention",
"description": "Testing",
"definition": {
"signatureSet": "security",
"inspectionMode": "detection",
"signatureWhiteList": {
"ref": "ad189f08-af06-4799-97d6-0a7c7409cb8d"
},
"logLevel": "error",
"logging": [],
"targetVpns": [
"10",
"20"
]
}
}
},
"URL filtering definition": {
"description": "URL filtering definition",
"value": {
"name": "Demo-URL-Filtering-Policy",
"type": "urlFiltering",
"description": "",
"definition": {
"webCategoriesAction": "block",
"webCategories": [
"auctions",
"bot-nets",
"news-and-media"
],
"webReputation": "moderate-risk",
"urlWhiteList": {
"ref": "c20e31fb-fcea-4f48-93e3-09d2c6492d8b"
},
"urlBlackList": {
"ref": "557ed432-6cf8-495b-a445-d340d4c6236e"
},
"blockPageAction": "text",
"blockPageContents": "Access to the requested page has been denied. Please contact your Network Administrator",
"enableAlerts": true,
"alerts": [
"blacklist",
"whitelist",
"categories-reputation"
],
"logging": [],
"targetVpns": [
"30"
]
}
}
},
"AMP definition": {
"description": "AMP definition",
"value": {
"name": "Demo-AMP-Policy",
"type": "advancedMalwareProtection",
"description": "",
"definition": {
"matchAllVpn": true,
"fileReputationCloudServer": "nam",
"fileReputationEstServer": "nam",
"fileReputationAlert": "critical",
"fileAnalysisCloudServer": "nam",
"fileAnalysisFileTypes": [
"pdf",
"ms-exe"
],
"fileAnalysisAlert": "critical",
"targetVpns": [
"10",
"20"
],
"fileAnalysisEnabled": true
}
}
},
"DNS definition": {
"description": "DNS definition",
"value": {
"name": "Demo-DNS-Policy",
"type": "DNSSecurity",
"description": "Testing",
"definition": {
"localDomainBypassList": {
"ref": "143f753f-8d51-4be6-805d-bc330f09982f"
},
"matchAllVpn": false,
"targetVpns": [
{
"vpns": [
"10"
],
"umbrellaDefault": false,
"childOrgId": "7999118",
"dnsServerIP": "10.10.10.1",
"localDomainBypassEnabled": true
}
],
"dnsCrypt": true,
"umbrellaData": {
"ref": "e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa"
}
}
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {
"masterTemplatesAffected": []
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"get": {
"tags": [
"Configuration - Policy Zone Based Firewall Definition Builder"
],
"description": "Get a specific policy definitions",
"operationId": "getPolicyDefinition_ConfigurationPolicyZoneBasedFirewallDefinitionBuilder_4403",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy definition": {
"description": "Policy definition",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/ise/identity/deleteAllLists": {
"delete": {
"tags": [
"Configuration - Ise Server"
],
"description": "Delete all lists of the specified list type",
"operationId": "deleteAllLists",
"requestBody": {
"description": "type of list",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "identity"
}
},
"description": "Body for deleteAllLists call, generic api for deleting all lists of a specified listType",
"$$ref": "#/components/schemas/DeleteAllListsBody"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "boolean"
},
"examples": {
"Delete All Lists": {
"description": "Delete All Lists",
"value": true
},
"Delete Some Or No Lists": {
"description": "Delete Some Or No Lists",
"value": false
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/ise/identity/referenced/{listType}": {
"get": {
"tags": [
"Configuration - Ise Server"
],
"description": "Get all referenced Lists",
"operationId": "getListReference",
"parameters": [
{
"name": "listType",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"description": {
"type": "string",
"example": "test"
},
"entries": {
"type": "array",
"items": {
"type": "object",
"properties": {
"userGroup": {
"type": "string",
"example": "SDWAN-IDENTITY.CISCO.COM/Users/Schema Admins"
}
},
"description": "list",
"$$ref": "#/components/schemas/Entry"
}
},
"infoTag": {
"type": "string"
},
"isActivatedByVsmart": {
"type": "boolean",
"example": false
},
"lastUpdated": {
"type": "integer",
"format": "int32",
"example": 1643067620
},
"listId": {
"type": "string",
"format": "uuid",
"example": "851cb243-d0da-4d7f-bdf9-124d979eadb9"
},
"name": {
"type": "string",
"example": "universal"
},
"owner": {
"type": "string",
"example": "admin"
},
"readOnly": {
"type": "boolean",
"example": false
},
"referenceCount": {
"type": "integer",
"format": "int32",
"example": 1
},
"references": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "0836d356-b89a-4fb9-abbc-1bb14d270ac8"
},
"type": {
"type": "string",
"example": "zoneBasedFW"
}
},
"description": "single policy where list is referenced",
"$$ref": "#/components/schemas/Reference"
}
},
"type": {
"type": "string",
"example": "identity"
},
"version": {
"type": "string",
"example": "0"
}
},
"description": "A single list and where it is referenced",
"$$ref": "#/components/schemas/ReferencedList"
}
},
"examples": {
"Referenced Lists Example": {
"description": "Referenced Lists Example",
"value": [
{
"listId": "851cb243-d0da-4d7f-bdf9-124d979eadb9",
"name": "corporate_users",
"type": "identity",
"description": "Corporate user identity list",
"entries": [
{
"userGroup": "CORP.CISCO.COM/Users/Domain Admins"
},
{
"userGroup": "CORP.CISCO.COM/Users/Security Admins"
}
],
"lastUpdated": 1643067620,
"owner": "admin",
"readOnly": false,
"version": "1",
"infoTag": "corporate-identity-v1",
"referenceCount": 2,
"references": [
{
"id": "0836d356-b89a-4fb9-abbc-1bb14d270ac8",
"type": "zoneBasedFW"
},
{
"id": "f7a2c4e1-3d5b-4c9a-8e7f-2b1a9c6d4e8f",
"type": "accessPolicy"
}
],
"isActivatedByVsmart": true
},
{
"listId": "a42f8e91-7c3d-4b2a-9e5f-6d8c1a4b7e9f",
"name": "guest_users",
"type": "identity",
"description": "Guest user identity list",
"entries": [
{
"userGroup": "GUEST.CISCO.COM/Users/Guest Users"
}
],
"lastUpdated": 1643068000,
"owner": "security_admin",
"readOnly": true,
"version": "0",
"infoTag": "guest-identity-default",
"referenceCount": 1,
"references": [
{
"id": "b8c9d2e3-4f5a-6b7c-8d9e-0f1a2b3c4d5e",
"type": "trafficPolicy"
}
],
"isActivatedByVsmart": false
}
]
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/ise/identity/sgt": {
"get": {
"tags": [
"Configuration - Ise Server"
],
"description": "Get trustsec Scalable Group Tags",
"operationId": "sgts",
"responses": {
"200": {
"description": "All Scalable Group Tags",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"securityGroups": {
"type": "array",
"items": {
"type": "object",
"properties": {
"description": {
"type": "string",
"example": "Any Security Group"
},
"id": {
"type": "string",
"example": "92bb1950-8c01-11e6-996c-525400b48521"
},
"name": {
"type": "string",
"example": "ANY"
},
"tag": {
"type": "integer",
"format": "int32",
"example": 65535
}
},
"$$ref": "#/components/schemas/SecurityGroup"
}
}
},
"description": "Security Groups Returned from ISE",
"$$ref": "#/components/schemas/SGTResponse"
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/ise/identity/usergroups": {
"post": {
"tags": [
"Configuration - Ise Server"
],
"description": "Get all identity user groups",
"operationId": "getIdentityUserGroups",
"requestBody": {
"description": "Get Users Groups from ISE associated with Active Directory Domain. Body can be an empty object or null to return all User Groups. For filtering a group must be specified, you cannot use a regex.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"filter": {
"type": "string",
"example": "Cert Publishers"
}
},
"$$ref": "#/components/schemas/UserGroupsBody"
},
"examples": {
"User Group Filter": {
"description": "User Group Filter",
"value": {
"filter": "Cert Publishers"
}
},
"User Group Filter Empty Braces": {
"description": "User Group Filter Empty Braces",
"value": {}
},
"User Group Filter No Entry": {
"description": "User Group Filter No Entry"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"ERSActiveDirectoryGroups": {
"type": "object",
"properties": {
"groups": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "b1.com/Builtin/Administrators"
},
"sid": {
"type": "string",
"example": "b1.com/S-1-5-32-544"
},
"type": {
"type": "string",
"example": "BUILTIN, DOMAIN LOCAL"
}
},
"$$ref": "#/components/schemas/UsergroupObject"
}
}
},
"$$ref": "#/components/schemas/ERSActiveDirectoryGroups"
}
},
"description": "Data Object for Users Groups call",
"$$ref": "#/components/schemas/UserGroupsDataObject"
},
"header": {
"type": "object",
"properties": {
"columns": {
"type": "object",
"example": {}
},
"fields": {
"type": "object",
"example": {}
},
"generatedOn": {
"type": "integer",
"format": "int32",
"example": 1643067620
},
"viewKeys": {
"type": "object",
"example": {}
}
},
"description": "Header for Response",
"$$ref": "#/components/schemas/HeaderObject"
}
},
"description": "User Groups Data from ISE active directory domain",
"$$ref": "#/components/schemas/UserGroupsResponse"
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/ise/identity/users": {
"post": {
"tags": [
"Configuration - Ise Server"
],
"description": "Get all identity users",
"operationId": "getIdentityUsers",
"requestBody": {
"description": "Get Users from ISE associated with Active Directory Domain. Body can be empty object or null to return all users. For filtering can be like the example with a regex or a specific user.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"filter": {
"type": "string"
}
},
"description": "Users body with regex filter for which users to retrieve from ISE",
"$$ref": "#/components/schemas/UsersBody"
},
"examples": {
"User Filter": {
"description": "User Filter",
"value": {
"filter": "admin"
}
},
"User Filter Wild Card": {
"description": "User Filter Wild Card",
"value": {
"filter": "a*"
}
},
"User Filter Empty Braces": {
"description": "User Filter Empty Braces",
"value": {}
},
"User Filter No Entry": {
"description": "User Filter No Entry"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"ERSActiveDirectoryUsers": {
"type": "object",
"properties": {
"users": {
"type": "array",
"items": {
"type": "object",
"properties": {
"adUserSamAccountName": {
"type": "string",
"example": "guests"
}
},
"description": "Object containing the users name",
"$$ref": "#/components/schemas/UserObject"
}
}
},
"$$ref": "#/components/schemas/ERSActiveDirectoryUsers"
}
},
"description": "Data Object for Users get call",
"$$ref": "#/components/schemas/UsersDataObject"
},
"header": {
"type": "object",
"properties": {
"columns": {
"type": "object",
"example": {}
},
"fields": {
"type": "object",
"example": {}
},
"generatedOn": {
"type": "integer",
"format": "int32",
"example": 1643067620
},
"viewKeys": {
"type": "object",
"example": {}
}
},
"description": "Header for Response",
"$$ref": "#/components/schemas/HeaderObject"
}
},
"description": "Users returned from ISE active directory domain",
"$$ref": "#/components/schemas/UsersResponse"
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/list": {
"get": {
"tags": [
"Configuration - Policy List Builder"
],
"description": "Get all policy lists",
"operationId": "getAllPolicyLists",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/list/app": {
"get": {
"tags": [
"Configuration - Policy Application List Builder"
],
"description": "Get policy lists",
"operationId": "getPolicyLists_ConfigurationPolicyApplicationListBuilder_2503",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"App Policy": {
"description": "App Policy",
"value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"
},
"Prefix List": {
"description": "Prefix List",
"value": {
"data": [
{
"listId": "8bc43c09-f72c-40b8-aa90-608c7005e607",
"name": "Example",
"type": "prefix",
"description": "Desc Not Required",
"entries": [
{
"ipPrefix": "10.0.0.0/24"
}
],
"lastUpdated": 1588178457305,
"owner": "admin",
"readOnly": false,
"version": "0",
"infoTag": "",
"referenceCount": 0,
"references": [],
"isActivatedByVsmart": false
}
]
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
},
"post": {
"tags": [
"Configuration - Policy Application List Builder"
],
"description": "Create policy list",
"operationId": "createPolicyList_ConfigurationPolicyApplicationListBuilder_2504",
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Zone list": {
"description": "Zone list",
"value": {
"name": "Demo-Zone",
"description": "Desc Not Required",
"type": "zone",
"entries": [
{
"vpn": "10"
}
]
}
},
"IPS list": {
"description": "IPS list",
"value": {
"name": "Demo-IPS-list",
"description": "Desc Not Required",
"type": "ipssignature",
"entries": [
{
"generatorId": "1111",
"signatureId": "4444"
}
]
}
},
"URL white list": {
"description": "URL white list",
"value": {
"name": "Demo-Whitelist",
"description": "Desc Not Required",
"type": "urlwhitelist",
"entries": [
{
"pattern": "https://www.youtube.com"
}
]
}
},
"URL black list": {
"description": "URL black list",
"value": {
"name": "Demo-Black-list",
"description": "Desc Not Required",
"type": "urlblacklist",
"entries": [
{
"pattern": "www.facebook.com"
}
]
}
},
"TG API key list": {
"description": "TG API key list",
"value": {
"name": "threatGridApiKeyList",
"description": "",
"type": "threatGridApiKey",
"entries": [
{
"region": "nam",
"apikey": "1234567"
},
{
"region": "eur",
"apikey": "1234567"
}
]
}
},
"Local domain list": {
"description": "Local domain list",
"value": {
"name": "Demo-Domain-Name-List",
"description": "Desc Not Required",
"type": "localdomain",
"entries": [
{
"nameServer": "cisco.com"
}
]
}
},
"Umbrella data list": {
"description": "Umbrella data list",
"value": {
"name": "umbrellaTokenList",
"description": "",
"type": "umbrellaData",
"entries": [
{
"apiKey": "abcd",
"secret": "12345",
"umbOrgId": "23405",
"token": "abcedabcedabcedabcedabcedabcedabcedabced"
}
]
}
},
"App family": {
"description": "App family",
"value": {
"name": "Demo-App-List",
"description": "Desc Not Required",
"type": "app",
"entries": [
{
"appFamily": "web"
},
{
"appFamily": "audio-video"
}
]
}
},
"App list": {
"description": "App list",
"value": {
"name": "Demo-App-List",
"description": "Desc Not Required",
"type": "app",
"entries": [
{
"app": "facebook"
},
{
"app": "netshow"
}
]
}
},
"Color list": {
"description": "Color list",
"value": {
"name": "Demo-Color-List",
"description": "Desc Not Required",
"type": "color",
"entries": [
{
"color": "biz-internet"
},
{
"color": "public-internet"
}
]
}
},
"Data prefix": {
"description": "Data prefix",
"value": {
"name": "Demo-Data-Prefix-List",
"description": "Desc Not Required",
"type": "dataprefix",
"entries": [
{
"ipPrefix": "10.1.0.0/16"
},
{
"ipPrefix": "10.2.0.0/16"
}
]
}
},
"Policer": {
"description": "Policer",
"value": {
"name": "Demo-Policer-list",
"description": "Desc Not Required",
"type": "policer",
"entries": [
{
"burst": "16000",
"exceed": "drop",
"rate": "10000"
}
]
}
},
"Prefix": {
"description": "Prefix",
"value": {
"name": "Demo-Prefix-list",
"description": "Desc Not Required",
"type": "prefix",
"entries": [
{
"ipPrefix": "10.0.0.0/12",
"le": "32"
}
]
}
},
"Site": {
"description": "Site",
"value": {
"name": "Demo-Site-List",
"description": "Desc Not Required",
"type": "site",
"listId": null,
"entries": [
{
"siteId": "100"
},
{
"siteId": "200"
},
{
"siteId": "300-500"
}
]
}
},
"Class": {
"description": "Class",
"value": {
"name": "Demo-Class-Map",
"description": "Desc Not Required",
"type": "class",
"entries": [
{
"queue": "4"
}
]
}
},
"App probe": {
"description": "App probe",
"value": {
"name": "Demo-Probe-Class",
"type": "appProbe",
"entries": [
{
"map": [
{
"color": "biz-internet",
"dscp": 46
},
{
"color": "public-internet",
"dscp": 20
}
],
"forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70"
}
]
}
},
"SLA": {
"description": "SLA",
"value": {
"name": "Demo-SLA-Class",
"description": "Desc Not Required",
"type": "sla",
"entries": [
{
"latency": "100",
"loss": "10",
"jitter": "10",
"appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d"
}
]
}
},
"TLOC": {
"description": "TLOC",
"value": {
"name": "Demo-TLOC-List",
"description": "Desc Not Required",
"type": "tloc",
"entries": [
{
"tloc": "10.1.1.1",
"color": "biz-internet",
"encap": "ipsec",
"preference": "10"
},
{
"tloc": "10.2.2.2",
"color": "biz-internet",
"encap": "ipsec",
"preference": "20"
}
]
}
},
"VPN": {
"description": "VPN",
"value": {
"name": "Demo-VPN-List",
"description": "Desc Not Required",
"type": "vpn",
"listId": null,
"entries": [
{
"vpn": "100"
},
{
"vpn": "200"
},
{
"vpn": "300-500"
}
]
}
},
"AS path": {
"description": "AS path",
"value": {
"name": "Demo-AS-Path-List",
"description": "Desc Not Required",
"type": "aspath",
"listId": null,
"entries": [
{
"asPath": "100"
},
{
"asPath": "200"
},
{
"asPath": "65002"
}
]
}
},
"Community": {
"description": "Community",
"value": {
"name": "Demo-Community-List",
"description": "Desc Not Required",
"type": "community",
"listId": null,
"entries": [
{
"community": "1000:10000"
}
]
}
},
"Ext community": {
"description": "Ext community",
"value": {
"name": "Demo-Extended-Community-List",
"description": "Desc Not Required",
"type": "extcommunity",
"listId": null,
"entries": [
{
"community": "rt 100:10"
}
]
}
},
"Mirror": {
"description": "Mirror",
"value": {
"name": "Demo-Mirror-List",
"description": "Desc Not Required",
"type": "mirror",
"entries": [
{
"remoteDest": "10.1.1.1",
"source": "20.1.1.1"
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Task Id": {
"description": "Task Id",
"value": {
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6"
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"delete": {
"tags": [
"Configuration - Policy Application List Builder"
],
"description": "Delete policy lists with specific info tag",
"operationId": "deletePolicyListsWithInfoTag_ConfigurationPolicyApplicationListBuilder_2506",
"parameters": [
{
"name": "infoTag",
"in": "query",
"description": "InfoTag",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/list/app/filtered": {
"get": {
"tags": [
"Configuration - Policy Application List Builder"
],
"description": "Get policy lists with specific info tag",
"operationId": "getPolicyListsWithInfoTag_ConfigurationPolicyApplicationListBuilder_3403",
"parameters": [
{
"name": "infoTag",
"in": "query",
"description": "InfoTag",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/list/app/preview": {
"post": {
"tags": [
"Configuration - Policy Application List Builder"
],
"description": "Preview a policy list based on the policy list type",
"operationId": "previewPolicyList_ConfigurationPolicyApplicationListBuilder_3304",
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy list": {
"description": "Policy list"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Preview policy list": {
"description": "Preview policy list",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/list/app/preview/{id}": {
"get": {
"tags": [
"Configuration - Policy Application List Builder"
],
"description": "Preview a specific policy list entry based on id provided",
"operationId": "previewPolicyListById_ConfigurationPolicyApplicationListBuilder_3803",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Preview policy list": {
"description": "Preview policy list",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/list/app/{id}": {
"get": {
"tags": [
"Configuration - Policy Application List Builder"
],
"description": "Get a specific policy list based on the id",
"operationId": "getListsById_ConfigurationPolicyApplicationListBuilder_3003",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy": {
"description": "Policy",
"value": {
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6",
"name": "Community",
"type": "community",
"description": "Desc Not Required",
"entries": [
{
"community": "1000:5000"
}
],
"lastUpdated": 1590184928436,
"owner": "admin",
"readOnly": false,
"version": "0",
"infoTag": "",
"referenceCount": 0,
"references": [],
"isActivatedByVsmart": false
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
},
"delete": {
"tags": [
"Configuration - Policy Application List Builder"
],
"description": "Delete policy list entry for a specific type of policy list",
"operationId": "deletePolicyList_ConfigurationPolicyApplicationListBuilder_3006",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"put": {
"tags": [
"Configuration - Policy Application List Builder"
],
"description": "Edit policy list entries for a specific type of policy list",
"operationId": "editPolicyList_ConfigurationPolicyApplicationListBuilder_3003",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": {
"name": "Community",
"description": "Desc Not Required",
"type": "community",
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6",
"entries": [
{
"community": "1000:8000"
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy": {
"description": "Policy",
"value": {
"masterTemplatesAffected": []
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/list/appprobe": {
"get": {
"tags": [
"Configuration - Policy App Probe Class List Builder"
],
"description": "Get policy lists",
"operationId": "getPolicyLists_ConfigurationPolicyAppProbeClassListBuilder_3003",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"App Policy": {
"description": "App Policy",
"value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"
},
"Prefix List": {
"description": "Prefix List",
"value": {
"data": [
{
"listId": "8bc43c09-f72c-40b8-aa90-608c7005e607",
"name": "Example",
"type": "prefix",
"description": "Desc Not Required",
"entries": [
{
"ipPrefix": "10.0.0.0/24"
}
],
"lastUpdated": 1588178457305,
"owner": "admin",
"readOnly": false,
"version": "0",
"infoTag": "",
"referenceCount": 0,
"references": [],
"isActivatedByVsmart": false
}
]
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
},
"delete": {
"tags": [
"Configuration - Policy App Probe Class List Builder"
],
"description": "Delete policy lists with specific info tag",
"operationId": "deletePolicyListsWithInfoTag_ConfigurationPolicyAppProbeClassListBuilder_3006",
"parameters": [
{
"name": "infoTag",
"in": "query",
"description": "InfoTag",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
},
"post": {
"tags": [
"Configuration - Policy App Probe Class List Builder"
],
"description": "Create policy list",
"operationId": "createPolicyList_ConfigurationPolicyAppProbeClassListBuilder_3004",
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Zone list": {
"description": "Zone list",
"value": {
"name": "Demo-Zone",
"description": "Desc Not Required",
"type": "zone",
"entries": [
{
"vpn": "10"
}
]
}
},
"IPS list": {
"description": "IPS list",
"value": {
"name": "Demo-IPS-list",
"description": "Desc Not Required",
"type": "ipssignature",
"entries": [
{
"generatorId": "1111",
"signatureId": "4444"
}
]
}
},
"URL white list": {
"description": "URL white list",
"value": {
"name": "Demo-Whitelist",
"description": "Desc Not Required",
"type": "urlwhitelist",
"entries": [
{
"pattern": "https://www.youtube.com"
}
]
}
},
"URL black list": {
"description": "URL black list",
"value": {
"name": "Demo-Black-list",
"description": "Desc Not Required",
"type": "urlblacklist",
"entries": [
{
"pattern": "www.facebook.com"
}
]
}
},
"TG API key list": {
"description": "TG API key list",
"value": {
"name": "threatGridApiKeyList",
"description": "",
"type": "threatGridApiKey",
"entries": [
{
"region": "nam",
"apikey": "1234567"
},
{
"region": "eur",
"apikey": "1234567"
}
]
}
},
"Local domain list": {
"description": "Local domain list",
"value": {
"name": "Demo-Domain-Name-List",
"description": "Desc Not Required",
"type": "localdomain",
"entries": [
{
"nameServer": "cisco.com"
}
]
}
},
"Umbrella data list": {
"description": "Umbrella data list",
"value": {
"name": "umbrellaTokenList",
"description": "",
"type": "umbrellaData",
"entries": [
{
"apiKey": "abcd",
"secret": "12345",
"umbOrgId": "23405",
"token": "abcedabcedabcedabcedabcedabcedabcedabced"
}
]
}
},
"App family": {
"description": "App family",
"value": {
"name": "Demo-App-List",
"description": "Desc Not Required",
"type": "app",
"entries": [
{
"appFamily": "web"
},
{
"appFamily": "audio-video"
}
]
}
},
"App list": {
"description": "App list",
"value": {
"name": "Demo-App-List",
"description": "Desc Not Required",
"type": "app",
"entries": [
{
"app": "facebook"
},
{
"app": "netshow"
}
]
}
},
"Color list": {
"description": "Color list",
"value": {
"name": "Demo-Color-List",
"description": "Desc Not Required",
"type": "color",
"entries": [
{
"color": "biz-internet"
},
{
"color": "public-internet"
}
]
}
},
"Data prefix": {
"description": "Data prefix",
"value": {
"name": "Demo-Data-Prefix-List",
"description": "Desc Not Required",
"type": "dataprefix",
"entries": [
{
"ipPrefix": "10.1.0.0/16"
},
{
"ipPrefix": "10.2.0.0/16"
}
]
}
},
"Policer": {
"description": "Policer",
"value": {
"name": "Demo-Policer-list",
"description": "Desc Not Required",
"type": "policer",
"entries": [
{
"burst": "16000",
"exceed": "drop",
"rate": "10000"
}
]
}
},
"Prefix": {
"description": "Prefix",
"value": {
"name": "Demo-Prefix-list",
"description": "Desc Not Required",
"type": "prefix",
"entries": [
{
"ipPrefix": "10.0.0.0/12",
"le": "32"
}
]
}
},
"Site": {
"description": "Site",
"value": {
"name": "Demo-Site-List",
"description": "Desc Not Required",
"type": "site",
"listId": null,
"entries": [
{
"siteId": "100"
},
{
"siteId": "200"
},
{
"siteId": "300-500"
}
]
}
},
"Class": {
"description": "Class",
"value": {
"name": "Demo-Class-Map",
"description": "Desc Not Required",
"type": "class",
"entries": [
{
"queue": "4"
}
]
}
},
"App probe": {
"description": "App probe",
"value": {
"name": "Demo-Probe-Class",
"type": "appProbe",
"entries": [
{
"map": [
{
"color": "biz-internet",
"dscp": 46
},
{
"color": "public-internet",
"dscp": 20
}
],
"forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70"
}
]
}
},
"SLA": {
"description": "SLA",
"value": {
"name": "Demo-SLA-Class",
"description": "Desc Not Required",
"type": "sla",
"entries": [
{
"latency": "100",
"loss": "10",
"jitter": "10",
"appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d"
}
]
}
},
"TLOC": {
"description": "TLOC",
"value": {
"name": "Demo-TLOC-List",
"description": "Desc Not Required",
"type": "tloc",
"entries": [
{
"tloc": "10.1.1.1",
"color": "biz-internet",
"encap": "ipsec",
"preference": "10"
},
{
"tloc": "10.2.2.2",
"color": "biz-internet",
"encap": "ipsec",
"preference": "20"
}
]
}
},
"VPN": {
"description": "VPN",
"value": {
"name": "Demo-VPN-List",
"description": "Desc Not Required",
"type": "vpn",
"listId": null,
"entries": [
{
"vpn": "100"
},
{
"vpn": "200"
},
{
"vpn": "300-500"
}
]
}
},
"AS path": {
"description": "AS path",
"value": {
"name": "Demo-AS-Path-List",
"description": "Desc Not Required",
"type": "aspath",
"listId": null,
"entries": [
{
"asPath": "100"
},
{
"asPath": "200"
},
{
"asPath": "65002"
}
]
}
},
"Community": {
"description": "Community",
"value": {
"name": "Demo-Community-List",
"description": "Desc Not Required",
"type": "community",
"listId": null,
"entries": [
{
"community": "1000:10000"
}
]
}
},
"Ext community": {
"description": "Ext community",
"value": {
"name": "Demo-Extended-Community-List",
"description": "Desc Not Required",
"type": "extcommunity",
"listId": null,
"entries": [
{
"community": "rt 100:10"
}
]
}
},
"Mirror": {
"description": "Mirror",
"value": {
"name": "Demo-Mirror-List",
"description": "Desc Not Required",
"type": "mirror",
"entries": [
{
"remoteDest": "10.1.1.1",
"source": "20.1.1.1"
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Task Id": {
"description": "Task Id",
"value": {
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6"
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/list/appprobe/filtered": {
"get": {
"tags": [
"Configuration - Policy App Probe Class List Builder"
],
"description": "Get policy lists with specific info tag",
"operationId": "getPolicyListsWithInfoTag_ConfigurationPolicyAppProbeClassListBuilder_3903",
"parameters": [
{
"name": "infoTag",
"in": "query",
"description": "InfoTag",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/list/appprobe/preview": {
"post": {
"tags": [
"Configuration - Policy App Probe Class List Builder"
],
"description": "Preview a policy list based on the policy list type",
"operationId": "previewPolicyList_ConfigurationPolicyAppProbeClassListBuilder_3804",
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy list": {
"description": "Policy list"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Preview policy list": {
"description": "Preview policy list",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/list/appprobe/preview/{id}": {
"get": {
"tags": [
"Configuration - Policy App Probe Class List Builder"
],
"description": "Preview a specific policy list entry based on id provided",
"operationId": "previewPolicyListById_ConfigurationPolicyAppProbeClassListBuilder_4303",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Preview policy list": {
"description": "Preview policy list",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/list/appprobe/{id}": {
"get": {
"tags": [
"Configuration - Policy App Probe Class List Builder"
],
"description": "Get a specific policy list based on the id",
"operationId": "getListsById_ConfigurationPolicyAppProbeClassListBuilder_3503",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy": {
"description": "Policy",
"value": {
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6",
"name": "Community",
"type": "community",
"description": "Desc Not Required",
"entries": [
{
"community": "1000:5000"
}
],
"lastUpdated": 1590184928436,
"owner": "admin",
"readOnly": false,
"version": "0",
"infoTag": "",
"referenceCount": 0,
"references": [],
"isActivatedByVsmart": false
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
},
"put": {
"tags": [
"Configuration - Policy App Probe Class List Builder"
],
"description": "Edit policy list entries for a specific type of policy list",
"operationId": "editPolicyList_ConfigurationPolicyAppProbeClassListBuilder_3503",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": {
"name": "Community",
"description": "Desc Not Required",
"type": "community",
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6",
"entries": [
{
"community": "1000:8000"
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy": {
"description": "Policy",
"value": {
"masterTemplatesAffected": []
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"delete": {
"tags": [
"Configuration - Policy App Probe Class List Builder"
],
"description": "Delete policy list entry for a specific type of policy list",
"operationId": "deletePolicyList_ConfigurationPolicyAppProbeClassListBuilder_3506",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/list/aspath": {
"get": {
"tags": [
"Configuration - Policy ASPath List Builder"
],
"description": "Get policy lists",
"operationId": "getPolicyLists_ConfigurationPolicyAspathListBuilder_2803",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"App Policy": {
"description": "App Policy",
"value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"
},
"Prefix List": {
"description": "Prefix List",
"value": {
"data": [
{
"listId": "8bc43c09-f72c-40b8-aa90-608c7005e607",
"name": "Example",
"type": "prefix",
"description": "Desc Not Required",
"entries": [
{
"ipPrefix": "10.0.0.0/24"
}
],
"lastUpdated": 1588178457305,
"owner": "admin",
"readOnly": false,
"version": "0",
"infoTag": "",
"referenceCount": 0,
"references": [],
"isActivatedByVsmart": false
}
]
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
},
"post": {
"tags": [
"Configuration - Policy ASPath List Builder"
],
"description": "Create policy list",
"operationId": "createPolicyList_ConfigurationPolicyAspathListBuilder_2804",
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Zone list": {
"description": "Zone list",
"value": {
"name": "Demo-Zone",
"description": "Desc Not Required",
"type": "zone",
"entries": [
{
"vpn": "10"
}
]
}
},
"IPS list": {
"description": "IPS list",
"value": {
"name": "Demo-IPS-list",
"description": "Desc Not Required",
"type": "ipssignature",
"entries": [
{
"generatorId": "1111",
"signatureId": "4444"
}
]
}
},
"URL white list": {
"description": "URL white list",
"value": {
"name": "Demo-Whitelist",
"description": "Desc Not Required",
"type": "urlwhitelist",
"entries": [
{
"pattern": "https://www.youtube.com"
}
]
}
},
"URL black list": {
"description": "URL black list",
"value": {
"name": "Demo-Black-list",
"description": "Desc Not Required",
"type": "urlblacklist",
"entries": [
{
"pattern": "www.facebook.com"
}
]
}
},
"TG API key list": {
"description": "TG API key list",
"value": {
"name": "threatGridApiKeyList",
"description": "",
"type": "threatGridApiKey",
"entries": [
{
"region": "nam",
"apikey": "1234567"
},
{
"region": "eur",
"apikey": "1234567"
}
]
}
},
"Local domain list": {
"description": "Local domain list",
"value": {
"name": "Demo-Domain-Name-List",
"description": "Desc Not Required",
"type": "localdomain",
"entries": [
{
"nameServer": "cisco.com"
}
]
}
},
"Umbrella data list": {
"description": "Umbrella data list",
"value": {
"name": "umbrellaTokenList",
"description": "",
"type": "umbrellaData",
"entries": [
{
"apiKey": "abcd",
"secret": "12345",
"umbOrgId": "23405",
"token": "abcedabcedabcedabcedabcedabcedabcedabced"
}
]
}
},
"App family": {
"description": "App family",
"value": {
"name": "Demo-App-List",
"description": "Desc Not Required",
"type": "app",
"entries": [
{
"appFamily": "web"
},
{
"appFamily": "audio-video"
}
]
}
},
"App list": {
"description": "App list",
"value": {
"name": "Demo-App-List",
"description": "Desc Not Required",
"type": "app",
"entries": [
{
"app": "facebook"
},
{
"app": "netshow"
}
]
}
},
"Color list": {
"description": "Color list",
"value": {
"name": "Demo-Color-List",
"description": "Desc Not Required",
"type": "color",
"entries": [
{
"color": "biz-internet"
},
{
"color": "public-internet"
}
]
}
},
"Data prefix": {
"description": "Data prefix",
"value": {
"name": "Demo-Data-Prefix-List",
"description": "Desc Not Required",
"type": "dataprefix",
"entries": [
{
"ipPrefix": "10.1.0.0/16"
},
{
"ipPrefix": "10.2.0.0/16"
}
]
}
},
"Policer": {
"description": "Policer",
"value": {
"name": "Demo-Policer-list",
"description": "Desc Not Required",
"type": "policer",
"entries": [
{
"burst": "16000",
"exceed": "drop",
"rate": "10000"
}
]
}
},
"Prefix": {
"description": "Prefix",
"value": {
"name": "Demo-Prefix-list",
"description": "Desc Not Required",
"type": "prefix",
"entries": [
{
"ipPrefix": "10.0.0.0/12",
"le": "32"
}
]
}
},
"Site": {
"description": "Site",
"value": {
"name": "Demo-Site-List",
"description": "Desc Not Required",
"type": "site",
"listId": null,
"entries": [
{
"siteId": "100"
},
{
"siteId": "200"
},
{
"siteId": "300-500"
}
]
}
},
"Class": {
"description": "Class",
"value": {
"name": "Demo-Class-Map",
"description": "Desc Not Required",
"type": "class",
"entries": [
{
"queue": "4"
}
]
}
},
"App probe": {
"description": "App probe",
"value": {
"name": "Demo-Probe-Class",
"type": "appProbe",
"entries": [
{
"map": [
{
"color": "biz-internet",
"dscp": 46
},
{
"color": "public-internet",
"dscp": 20
}
],
"forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70"
}
]
}
},
"SLA": {
"description": "SLA",
"value": {
"name": "Demo-SLA-Class",
"description": "Desc Not Required",
"type": "sla",
"entries": [
{
"latency": "100",
"loss": "10",
"jitter": "10",
"appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d"
}
]
}
},
"TLOC": {
"description": "TLOC",
"value": {
"name": "Demo-TLOC-List",
"description": "Desc Not Required",
"type": "tloc",
"entries": [
{
"tloc": "10.1.1.1",
"color": "biz-internet",
"encap": "ipsec",
"preference": "10"
},
{
"tloc": "10.2.2.2",
"color": "biz-internet",
"encap": "ipsec",
"preference": "20"
}
]
}
},
"VPN": {
"description": "VPN",
"value": {
"name": "Demo-VPN-List",
"description": "Desc Not Required",
"type": "vpn",
"listId": null,
"entries": [
{
"vpn": "100"
},
{
"vpn": "200"
},
{
"vpn": "300-500"
}
]
}
},
"AS path": {
"description": "AS path",
"value": {
"name": "Demo-AS-Path-List",
"description": "Desc Not Required",
"type": "aspath",
"listId": null,
"entries": [
{
"asPath": "100"
},
{
"asPath": "200"
},
{
"asPath": "65002"
}
]
}
},
"Community": {
"description": "Community",
"value": {
"name": "Demo-Community-List",
"description": "Desc Not Required",
"type": "community",
"listId": null,
"entries": [
{
"community": "1000:10000"
}
]
}
},
"Ext community": {
"description": "Ext community",
"value": {
"name": "Demo-Extended-Community-List",
"description": "Desc Not Required",
"type": "extcommunity",
"listId": null,
"entries": [
{
"community": "rt 100:10"
}
]
}
},
"Mirror": {
"description": "Mirror",
"value": {
"name": "Demo-Mirror-List",
"description": "Desc Not Required",
"type": "mirror",
"entries": [
{
"remoteDest": "10.1.1.1",
"source": "20.1.1.1"
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Task Id": {
"description": "Task Id",
"value": {
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6"
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"delete": {
"tags": [
"Configuration - Policy ASPath List Builder"
],
"description": "Delete policy lists with specific info tag",
"operationId": "deletePolicyListsWithInfoTag_ConfigurationPolicyAspathListBuilder_2806",
"parameters": [
{
"name": "infoTag",
"in": "query",
"description": "InfoTag",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/list/aspath/filtered": {
"get": {
"tags": [
"Configuration - Policy ASPath List Builder"
],
"description": "Get policy lists with specific info tag",
"operationId": "getPolicyListsWithInfoTag_ConfigurationPolicyAspathListBuilder_3703",
"parameters": [
{
"name": "infoTag",
"in": "query",
"description": "InfoTag",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/list/aspath/preview": {
"post": {
"tags": [
"Configuration - Policy ASPath List Builder"
],
"description": "Preview a policy list based on the policy list type",
"operationId": "previewPolicyList_ConfigurationPolicyAspathListBuilder_3604",
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy list": {
"description": "Policy list"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Preview policy list": {
"description": "Preview policy list",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/list/aspath/preview/{id}": {
"get": {
"tags": [
"Configuration - Policy ASPath List Builder"
],
"description": "Preview a specific policy list entry based on id provided",
"operationId": "previewPolicyListById_ConfigurationPolicyAspathListBuilder_4103",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Preview policy list": {
"description": "Preview policy list",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/list/aspath/{id}": {
"put": {
"tags": [
"Configuration - Policy ASPath List Builder"
],
"description": "Edit policy list entries for a specific type of policy list",
"operationId": "editPolicyList_ConfigurationPolicyAspathListBuilder_3303",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": {
"name": "Community",
"description": "Desc Not Required",
"type": "community",
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6",
"entries": [
{
"community": "1000:8000"
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy": {
"description": "Policy",
"value": {
"masterTemplatesAffected": []
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"delete": {
"tags": [
"Configuration - Policy ASPath List Builder"
],
"description": "Delete policy list entry for a specific type of policy list",
"operationId": "deletePolicyList_ConfigurationPolicyAspathListBuilder_3306",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"get": {
"tags": [
"Configuration - Policy ASPath List Builder"
],
"description": "Get a specific policy list based on the id",
"operationId": "getListsById_ConfigurationPolicyAspathListBuilder_3303",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy": {
"description": "Policy",
"value": {
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6",
"name": "Community",
"type": "community",
"description": "Desc Not Required",
"entries": [
{
"community": "1000:5000"
}
],
"lastUpdated": 1590184928436,
"owner": "admin",
"readOnly": false,
"version": "0",
"infoTag": "",
"referenceCount": 0,
"references": [],
"isActivatedByVsmart": false
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/list/class": {
"get": {
"tags": [
"Configuration - Policy Forwarding Class List Builder"
],
"description": "Get policy lists",
"operationId": "getPolicyLists_ConfigurationPolicyForwardingClassListBuilder_2703",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"App Policy": {
"description": "App Policy",
"value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"
},
"Prefix List": {
"description": "Prefix List",
"value": {
"data": [
{
"listId": "8bc43c09-f72c-40b8-aa90-608c7005e607",
"name": "Example",
"type": "prefix",
"description": "Desc Not Required",
"entries": [
{
"ipPrefix": "10.0.0.0/24"
}
],
"lastUpdated": 1588178457305,
"owner": "admin",
"readOnly": false,
"version": "0",
"infoTag": "",
"referenceCount": 0,
"references": [],
"isActivatedByVsmart": false
}
]
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
},
"delete": {
"tags": [
"Configuration - Policy Forwarding Class List Builder"
],
"description": "Delete policy lists with specific info tag",
"operationId": "deletePolicyListsWithInfoTag_ConfigurationPolicyForwardingClassListBuilder_2706",
"parameters": [
{
"name": "infoTag",
"in": "query",
"description": "InfoTag",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
},
"post": {
"tags": [
"Configuration - Policy Forwarding Class List Builder"
],
"description": "Create policy list",
"operationId": "createPolicyList_ConfigurationPolicyForwardingClassListBuilder_2704",
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Zone list": {
"description": "Zone list",
"value": {
"name": "Demo-Zone",
"description": "Desc Not Required",
"type": "zone",
"entries": [
{
"vpn": "10"
}
]
}
},
"IPS list": {
"description": "IPS list",
"value": {
"name": "Demo-IPS-list",
"description": "Desc Not Required",
"type": "ipssignature",
"entries": [
{
"generatorId": "1111",
"signatureId": "4444"
}
]
}
},
"URL white list": {
"description": "URL white list",
"value": {
"name": "Demo-Whitelist",
"description": "Desc Not Required",
"type": "urlwhitelist",
"entries": [
{
"pattern": "https://www.youtube.com"
}
]
}
},
"URL black list": {
"description": "URL black list",
"value": {
"name": "Demo-Black-list",
"description": "Desc Not Required",
"type": "urlblacklist",
"entries": [
{
"pattern": "www.facebook.com"
}
]
}
},
"TG API key list": {
"description": "TG API key list",
"value": {
"name": "threatGridApiKeyList",
"description": "",
"type": "threatGridApiKey",
"entries": [
{
"region": "nam",
"apikey": "1234567"
},
{
"region": "eur",
"apikey": "1234567"
}
]
}
},
"Local domain list": {
"description": "Local domain list",
"value": {
"name": "Demo-Domain-Name-List",
"description": "Desc Not Required",
"type": "localdomain",
"entries": [
{
"nameServer": "cisco.com"
}
]
}
},
"Umbrella data list": {
"description": "Umbrella data list",
"value": {
"name": "umbrellaTokenList",
"description": "",
"type": "umbrellaData",
"entries": [
{
"apiKey": "abcd",
"secret": "12345",
"umbOrgId": "23405",
"token": "abcedabcedabcedabcedabcedabcedabcedabced"
}
]
}
},
"App family": {
"description": "App family",
"value": {
"name": "Demo-App-List",
"description": "Desc Not Required",
"type": "app",
"entries": [
{
"appFamily": "web"
},
{
"appFamily": "audio-video"
}
]
}
},
"App list": {
"description": "App list",
"value": {
"name": "Demo-App-List",
"description": "Desc Not Required",
"type": "app",
"entries": [
{
"app": "facebook"
},
{
"app": "netshow"
}
]
}
},
"Color list": {
"description": "Color list",
"value": {
"name": "Demo-Color-List",
"description": "Desc Not Required",
"type": "color",
"entries": [
{
"color": "biz-internet"
},
{
"color": "public-internet"
}
]
}
},
"Data prefix": {
"description": "Data prefix",
"value": {
"name": "Demo-Data-Prefix-List",
"description": "Desc Not Required",
"type": "dataprefix",
"entries": [
{
"ipPrefix": "10.1.0.0/16"
},
{
"ipPrefix": "10.2.0.0/16"
}
]
}
},
"Policer": {
"description": "Policer",
"value": {
"name": "Demo-Policer-list",
"description": "Desc Not Required",
"type": "policer",
"entries": [
{
"burst": "16000",
"exceed": "drop",
"rate": "10000"
}
]
}
},
"Prefix": {
"description": "Prefix",
"value": {
"name": "Demo-Prefix-list",
"description": "Desc Not Required",
"type": "prefix",
"entries": [
{
"ipPrefix": "10.0.0.0/12",
"le": "32"
}
]
}
},
"Site": {
"description": "Site",
"value": {
"name": "Demo-Site-List",
"description": "Desc Not Required",
"type": "site",
"listId": null,
"entries": [
{
"siteId": "100"
},
{
"siteId": "200"
},
{
"siteId": "300-500"
}
]
}
},
"Class": {
"description": "Class",
"value": {
"name": "Demo-Class-Map",
"description": "Desc Not Required",
"type": "class",
"entries": [
{
"queue": "4"
}
]
}
},
"App probe": {
"description": "App probe",
"value": {
"name": "Demo-Probe-Class",
"type": "appProbe",
"entries": [
{
"map": [
{
"color": "biz-internet",
"dscp": 46
},
{
"color": "public-internet",
"dscp": 20
}
],
"forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70"
}
]
}
},
"SLA": {
"description": "SLA",
"value": {
"name": "Demo-SLA-Class",
"description": "Desc Not Required",
"type": "sla",
"entries": [
{
"latency": "100",
"loss": "10",
"jitter": "10",
"appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d"
}
]
}
},
"TLOC": {
"description": "TLOC",
"value": {
"name": "Demo-TLOC-List",
"description": "Desc Not Required",
"type": "tloc",
"entries": [
{
"tloc": "10.1.1.1",
"color": "biz-internet",
"encap": "ipsec",
"preference": "10"
},
{
"tloc": "10.2.2.2",
"color": "biz-internet",
"encap": "ipsec",
"preference": "20"
}
]
}
},
"VPN": {
"description": "VPN",
"value": {
"name": "Demo-VPN-List",
"description": "Desc Not Required",
"type": "vpn",
"listId": null,
"entries": [
{
"vpn": "100"
},
{
"vpn": "200"
},
{
"vpn": "300-500"
}
]
}
},
"AS path": {
"description": "AS path",
"value": {
"name": "Demo-AS-Path-List",
"description": "Desc Not Required",
"type": "aspath",
"listId": null,
"entries": [
{
"asPath": "100"
},
{
"asPath": "200"
},
{
"asPath": "65002"
}
]
}
},
"Community": {
"description": "Community",
"value": {
"name": "Demo-Community-List",
"description": "Desc Not Required",
"type": "community",
"listId": null,
"entries": [
{
"community": "1000:10000"
}
]
}
},
"Ext community": {
"description": "Ext community",
"value": {
"name": "Demo-Extended-Community-List",
"description": "Desc Not Required",
"type": "extcommunity",
"listId": null,
"entries": [
{
"community": "rt 100:10"
}
]
}
},
"Mirror": {
"description": "Mirror",
"value": {
"name": "Demo-Mirror-List",
"description": "Desc Not Required",
"type": "mirror",
"entries": [
{
"remoteDest": "10.1.1.1",
"source": "20.1.1.1"
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Task Id": {
"description": "Task Id",
"value": {
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6"
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/list/class/filtered": {
"get": {
"tags": [
"Configuration - Policy Forwarding Class List Builder"
],
"description": "Get policy lists with specific info tag",
"operationId": "getPolicyListsWithInfoTag_ConfigurationPolicyForwardingClassListBuilder_3603",
"parameters": [
{
"name": "infoTag",
"in": "query",
"description": "InfoTag",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/list/class/preview": {
"post": {
"tags": [
"Configuration - Policy Forwarding Class List Builder"
],
"description": "Preview a policy list based on the policy list type",
"operationId": "previewPolicyList_ConfigurationPolicyForwardingClassListBuilder_3504",
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy list": {
"description": "Policy list"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Preview policy list": {
"description": "Preview policy list",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/list/class/preview/{id}": {
"get": {
"tags": [
"Configuration - Policy Forwarding Class List Builder"
],
"description": "Preview a specific policy list entry based on id provided",
"operationId": "previewPolicyListById_ConfigurationPolicyForwardingClassListBuilder_4003",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Preview policy list": {
"description": "Preview policy list",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/list/class/{id}": {
"put": {
"tags": [
"Configuration - Policy Forwarding Class List Builder"
],
"description": "Edit policy list entries for a specific type of policy list",
"operationId": "editPolicyList_ConfigurationPolicyForwardingClassListBuilder_3203",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": {
"name": "Community",
"description": "Desc Not Required",
"type": "community",
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6",
"entries": [
{
"community": "1000:8000"
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy": {
"description": "Policy",
"value": {
"masterTemplatesAffected": []
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"get": {
"tags": [
"Configuration - Policy Forwarding Class List Builder"
],
"description": "Get a specific policy list based on the id",
"operationId": "getListsById_ConfigurationPolicyForwardingClassListBuilder_3203",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy": {
"description": "Policy",
"value": {
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6",
"name": "Community",
"type": "community",
"description": "Desc Not Required",
"entries": [
{
"community": "1000:5000"
}
],
"lastUpdated": 1590184928436,
"owner": "admin",
"readOnly": false,
"version": "0",
"infoTag": "",
"referenceCount": 0,
"references": [],
"isActivatedByVsmart": false
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
},
"delete": {
"tags": [
"Configuration - Policy Forwarding Class List Builder"
],
"description": "Delete policy list entry for a specific type of policy list",
"operationId": "deletePolicyList_ConfigurationPolicyForwardingClassListBuilder_3206",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/list/color": {
"get": {
"tags": [
"Configuration - Policy Color List Builder"
],
"description": "Get policy lists",
"operationId": "getPolicyLists_ConfigurationPolicyColorListBuilder_2703",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"App Policy": {
"description": "App Policy",
"value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"
},
"Prefix List": {
"description": "Prefix List",
"value": {
"data": [
{
"listId": "8bc43c09-f72c-40b8-aa90-608c7005e607",
"name": "Example",
"type": "prefix",
"description": "Desc Not Required",
"entries": [
{
"ipPrefix": "10.0.0.0/24"
}
],
"lastUpdated": 1588178457305,
"owner": "admin",
"readOnly": false,
"version": "0",
"infoTag": "",
"referenceCount": 0,
"references": [],
"isActivatedByVsmart": false
}
]
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
},
"post": {
"tags": [
"Configuration - Policy Color List Builder"
],
"description": "Create policy list",
"operationId": "createPolicyList_ConfigurationPolicyColorListBuilder_2704",
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Zone list": {
"description": "Zone list",
"value": {
"name": "Demo-Zone",
"description": "Desc Not Required",
"type": "zone",
"entries": [
{
"vpn": "10"
}
]
}
},
"IPS list": {
"description": "IPS list",
"value": {
"name": "Demo-IPS-list",
"description": "Desc Not Required",
"type": "ipssignature",
"entries": [
{
"generatorId": "1111",
"signatureId": "4444"
}
]
}
},
"URL white list": {
"description": "URL white list",
"value": {
"name": "Demo-Whitelist",
"description": "Desc Not Required",
"type": "urlwhitelist",
"entries": [
{
"pattern": "https://www.youtube.com"
}
]
}
},
"URL black list": {
"description": "URL black list",
"value": {
"name": "Demo-Black-list",
"description": "Desc Not Required",
"type": "urlblacklist",
"entries": [
{
"pattern": "www.facebook.com"
}
]
}
},
"TG API key list": {
"description": "TG API key list",
"value": {
"name": "threatGridApiKeyList",
"description": "",
"type": "threatGridApiKey",
"entries": [
{
"region": "nam",
"apikey": "1234567"
},
{
"region": "eur",
"apikey": "1234567"
}
]
}
},
"Local domain list": {
"description": "Local domain list",
"value": {
"name": "Demo-Domain-Name-List",
"description": "Desc Not Required",
"type": "localdomain",
"entries": [
{
"nameServer": "cisco.com"
}
]
}
},
"Umbrella data list": {
"description": "Umbrella data list",
"value": {
"name": "umbrellaTokenList",
"description": "",
"type": "umbrellaData",
"entries": [
{
"apiKey": "abcd",
"secret": "12345",
"umbOrgId": "23405",
"token": "abcedabcedabcedabcedabcedabcedabcedabced"
}
]
}
},
"App family": {
"description": "App family",
"value": {
"name": "Demo-App-List",
"description": "Desc Not Required",
"type": "app",
"entries": [
{
"appFamily": "web"
},
{
"appFamily": "audio-video"
}
]
}
},
"App list": {
"description": "App list",
"value": {
"name": "Demo-App-List",
"description": "Desc Not Required",
"type": "app",
"entries": [
{
"app": "facebook"
},
{
"app": "netshow"
}
]
}
},
"Color list": {
"description": "Color list",
"value": {
"name": "Demo-Color-List",
"description": "Desc Not Required",
"type": "color",
"entries": [
{
"color": "biz-internet"
},
{
"color": "public-internet"
}
]
}
},
"Data prefix": {
"description": "Data prefix",
"value": {
"name": "Demo-Data-Prefix-List",
"description": "Desc Not Required",
"type": "dataprefix",
"entries": [
{
"ipPrefix": "10.1.0.0/16"
},
{
"ipPrefix": "10.2.0.0/16"
}
]
}
},
"Policer": {
"description": "Policer",
"value": {
"name": "Demo-Policer-list",
"description": "Desc Not Required",
"type": "policer",
"entries": [
{
"burst": "16000",
"exceed": "drop",
"rate": "10000"
}
]
}
},
"Prefix": {
"description": "Prefix",
"value": {
"name": "Demo-Prefix-list",
"description": "Desc Not Required",
"type": "prefix",
"entries": [
{
"ipPrefix": "10.0.0.0/12",
"le": "32"
}
]
}
},
"Site": {
"description": "Site",
"value": {
"name": "Demo-Site-List",
"description": "Desc Not Required",
"type": "site",
"listId": null,
"entries": [
{
"siteId": "100"
},
{
"siteId": "200"
},
{
"siteId": "300-500"
}
]
}
},
"Class": {
"description": "Class",
"value": {
"name": "Demo-Class-Map",
"description": "Desc Not Required",
"type": "class",
"entries": [
{
"queue": "4"
}
]
}
},
"App probe": {
"description": "App probe",
"value": {
"name": "Demo-Probe-Class",
"type": "appProbe",
"entries": [
{
"map": [
{
"color": "biz-internet",
"dscp": 46
},
{
"color": "public-internet",
"dscp": 20
}
],
"forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70"
}
]
}
},
"SLA": {
"description": "SLA",
"value": {
"name": "Demo-SLA-Class",
"description": "Desc Not Required",
"type": "sla",
"entries": [
{
"latency": "100",
"loss": "10",
"jitter": "10",
"appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d"
}
]
}
},
"TLOC": {
"description": "TLOC",
"value": {
"name": "Demo-TLOC-List",
"description": "Desc Not Required",
"type": "tloc",
"entries": [
{
"tloc": "10.1.1.1",
"color": "biz-internet",
"encap": "ipsec",
"preference": "10"
},
{
"tloc": "10.2.2.2",
"color": "biz-internet",
"encap": "ipsec",
"preference": "20"
}
]
}
},
"VPN": {
"description": "VPN",
"value": {
"name": "Demo-VPN-List",
"description": "Desc Not Required",
"type": "vpn",
"listId": null,
"entries": [
{
"vpn": "100"
},
{
"vpn": "200"
},
{
"vpn": "300-500"
}
]
}
},
"AS path": {
"description": "AS path",
"value": {
"name": "Demo-AS-Path-List",
"description": "Desc Not Required",
"type": "aspath",
"listId": null,
"entries": [
{
"asPath": "100"
},
{
"asPath": "200"
},
{
"asPath": "65002"
}
]
}
},
"Community": {
"description": "Community",
"value": {
"name": "Demo-Community-List",
"description": "Desc Not Required",
"type": "community",
"listId": null,
"entries": [
{
"community": "1000:10000"
}
]
}
},
"Ext community": {
"description": "Ext community",
"value": {
"name": "Demo-Extended-Community-List",
"description": "Desc Not Required",
"type": "extcommunity",
"listId": null,
"entries": [
{
"community": "rt 100:10"
}
]
}
},
"Mirror": {
"description": "Mirror",
"value": {
"name": "Demo-Mirror-List",
"description": "Desc Not Required",
"type": "mirror",
"entries": [
{
"remoteDest": "10.1.1.1",
"source": "20.1.1.1"
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Task Id": {
"description": "Task Id",
"value": {
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6"
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"delete": {
"tags": [
"Configuration - Policy Color List Builder"
],
"description": "Delete policy lists with specific info tag",
"operationId": "deletePolicyListsWithInfoTag_ConfigurationPolicyColorListBuilder_2706",
"parameters": [
{
"name": "infoTag",
"in": "query",
"description": "InfoTag",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/list/color/filtered": {
"get": {
"tags": [
"Configuration - Policy Color List Builder"
],
"description": "Get policy lists with specific info tag",
"operationId": "getPolicyListsWithInfoTag_ConfigurationPolicyColorListBuilder_3603",
"parameters": [
{
"name": "infoTag",
"in": "query",
"description": "InfoTag",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/list/color/preview": {
"post": {
"tags": [
"Configuration - Policy Color List Builder"
],
"description": "Preview a policy list based on the policy list type",
"operationId": "previewPolicyList_ConfigurationPolicyColorListBuilder_3504",
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy list": {
"description": "Policy list"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Preview policy list": {
"description": "Preview policy list",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/list/color/preview/{id}": {
"get": {
"tags": [
"Configuration - Policy Color List Builder"
],
"description": "Preview a specific policy list entry based on id provided",
"operationId": "previewPolicyListById_ConfigurationPolicyColorListBuilder_4003",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Preview policy list": {
"description": "Preview policy list",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/list/color/{id}": {
"put": {
"tags": [
"Configuration - Policy Color List Builder"
],
"description": "Edit policy list entries for a specific type of policy list",
"operationId": "editPolicyList_ConfigurationPolicyColorListBuilder_3203",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": {
"name": "Community",
"description": "Desc Not Required",
"type": "community",
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6",
"entries": [
{
"community": "1000:8000"
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy": {
"description": "Policy",
"value": {
"masterTemplatesAffected": []
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"get": {
"tags": [
"Configuration - Policy Color List Builder"
],
"description": "Get a specific policy list based on the id",
"operationId": "getListsById_ConfigurationPolicyColorListBuilder_3203",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy": {
"description": "Policy",
"value": {
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6",
"name": "Community",
"type": "community",
"description": "Desc Not Required",
"entries": [
{
"community": "1000:5000"
}
],
"lastUpdated": 1590184928436,
"owner": "admin",
"readOnly": false,
"version": "0",
"infoTag": "",
"referenceCount": 0,
"references": [],
"isActivatedByVsmart": false
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
},
"delete": {
"tags": [
"Configuration - Policy Color List Builder"
],
"description": "Delete policy list entry for a specific type of policy list",
"operationId": "deletePolicyList_ConfigurationPolicyColorListBuilder_3206",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/list/community": {
"delete": {
"tags": [
"Configuration - Policy Community List Builder"
],
"description": "Delete policy lists with specific info tag",
"operationId": "deletePolicyListsWithInfoTag_ConfigurationPolicyCommunityListBuilder_3106",
"parameters": [
{
"name": "infoTag",
"in": "query",
"description": "InfoTag",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
},
"post": {
"tags": [
"Configuration - Policy Community List Builder"
],
"description": "Create policy list",
"operationId": "createPolicyList_ConfigurationPolicyCommunityListBuilder_3104",
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Zone list": {
"description": "Zone list",
"value": {
"name": "Demo-Zone",
"description": "Desc Not Required",
"type": "zone",
"entries": [
{
"vpn": "10"
}
]
}
},
"IPS list": {
"description": "IPS list",
"value": {
"name": "Demo-IPS-list",
"description": "Desc Not Required",
"type": "ipssignature",
"entries": [
{
"generatorId": "1111",
"signatureId": "4444"
}
]
}
},
"URL white list": {
"description": "URL white list",
"value": {
"name": "Demo-Whitelist",
"description": "Desc Not Required",
"type": "urlwhitelist",
"entries": [
{
"pattern": "https://www.youtube.com"
}
]
}
},
"URL black list": {
"description": "URL black list",
"value": {
"name": "Demo-Black-list",
"description": "Desc Not Required",
"type": "urlblacklist",
"entries": [
{
"pattern": "www.facebook.com"
}
]
}
},
"TG API key list": {
"description": "TG API key list",
"value": {
"name": "threatGridApiKeyList",
"description": "",
"type": "threatGridApiKey",
"entries": [
{
"region": "nam",
"apikey": "1234567"
},
{
"region": "eur",
"apikey": "1234567"
}
]
}
},
"Local domain list": {
"description": "Local domain list",
"value": {
"name": "Demo-Domain-Name-List",
"description": "Desc Not Required",
"type": "localdomain",
"entries": [
{
"nameServer": "cisco.com"
}
]
}
},
"Umbrella data list": {
"description": "Umbrella data list",
"value": {
"name": "umbrellaTokenList",
"description": "",
"type": "umbrellaData",
"entries": [
{
"apiKey": "abcd",
"secret": "12345",
"umbOrgId": "23405",
"token": "abcedabcedabcedabcedabcedabcedabcedabced"
}
]
}
},
"App family": {
"description": "App family",
"value": {
"name": "Demo-App-List",
"description": "Desc Not Required",
"type": "app",
"entries": [
{
"appFamily": "web"
},
{
"appFamily": "audio-video"
}
]
}
},
"App list": {
"description": "App list",
"value": {
"name": "Demo-App-List",
"description": "Desc Not Required",
"type": "app",
"entries": [
{
"app": "facebook"
},
{
"app": "netshow"
}
]
}
},
"Color list": {
"description": "Color list",
"value": {
"name": "Demo-Color-List",
"description": "Desc Not Required",
"type": "color",
"entries": [
{
"color": "biz-internet"
},
{
"color": "public-internet"
}
]
}
},
"Data prefix": {
"description": "Data prefix",
"value": {
"name": "Demo-Data-Prefix-List",
"description": "Desc Not Required",
"type": "dataprefix",
"entries": [
{
"ipPrefix": "10.1.0.0/16"
},
{
"ipPrefix": "10.2.0.0/16"
}
]
}
},
"Policer": {
"description": "Policer",
"value": {
"name": "Demo-Policer-list",
"description": "Desc Not Required",
"type": "policer",
"entries": [
{
"burst": "16000",
"exceed": "drop",
"rate": "10000"
}
]
}
},
"Prefix": {
"description": "Prefix",
"value": {
"name": "Demo-Prefix-list",
"description": "Desc Not Required",
"type": "prefix",
"entries": [
{
"ipPrefix": "10.0.0.0/12",
"le": "32"
}
]
}
},
"Site": {
"description": "Site",
"value": {
"name": "Demo-Site-List",
"description": "Desc Not Required",
"type": "site",
"listId": null,
"entries": [
{
"siteId": "100"
},
{
"siteId": "200"
},
{
"siteId": "300-500"
}
]
}
},
"Class": {
"description": "Class",
"value": {
"name": "Demo-Class-Map",
"description": "Desc Not Required",
"type": "class",
"entries": [
{
"queue": "4"
}
]
}
},
"App probe": {
"description": "App probe",
"value": {
"name": "Demo-Probe-Class",
"type": "appProbe",
"entries": [
{
"map": [
{
"color": "biz-internet",
"dscp": 46
},
{
"color": "public-internet",
"dscp": 20
}
],
"forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70"
}
]
}
},
"SLA": {
"description": "SLA",
"value": {
"name": "Demo-SLA-Class",
"description": "Desc Not Required",
"type": "sla",
"entries": [
{
"latency": "100",
"loss": "10",
"jitter": "10",
"appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d"
}
]
}
},
"TLOC": {
"description": "TLOC",
"value": {
"name": "Demo-TLOC-List",
"description": "Desc Not Required",
"type": "tloc",
"entries": [
{
"tloc": "10.1.1.1",
"color": "biz-internet",
"encap": "ipsec",
"preference": "10"
},
{
"tloc": "10.2.2.2",
"color": "biz-internet",
"encap": "ipsec",
"preference": "20"
}
]
}
},
"VPN": {
"description": "VPN",
"value": {
"name": "Demo-VPN-List",
"description": "Desc Not Required",
"type": "vpn",
"listId": null,
"entries": [
{
"vpn": "100"
},
{
"vpn": "200"
},
{
"vpn": "300-500"
}
]
}
},
"AS path": {
"description": "AS path",
"value": {
"name": "Demo-AS-Path-List",
"description": "Desc Not Required",
"type": "aspath",
"listId": null,
"entries": [
{
"asPath": "100"
},
{
"asPath": "200"
},
{
"asPath": "65002"
}
]
}
},
"Community": {
"description": "Community",
"value": {
"name": "Demo-Community-List",
"description": "Desc Not Required",
"type": "community",
"listId": null,
"entries": [
{
"community": "1000:10000"
}
]
}
},
"Ext community": {
"description": "Ext community",
"value": {
"name": "Demo-Extended-Community-List",
"description": "Desc Not Required",
"type": "extcommunity",
"listId": null,
"entries": [
{
"community": "rt 100:10"
}
]
}
},
"Mirror": {
"description": "Mirror",
"value": {
"name": "Demo-Mirror-List",
"description": "Desc Not Required",
"type": "mirror",
"entries": [
{
"remoteDest": "10.1.1.1",
"source": "20.1.1.1"
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Task Id": {
"description": "Task Id",
"value": {
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6"
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"get": {
"tags": [
"Configuration - Policy Community List Builder"
],
"description": "Get policy lists",
"operationId": "getPolicyLists_ConfigurationPolicyCommunityListBuilder_3103",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"App Policy": {
"description": "App Policy",
"value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"
},
"Prefix List": {
"description": "Prefix List",
"value": {
"data": [
{
"listId": "8bc43c09-f72c-40b8-aa90-608c7005e607",
"name": "Example",
"type": "prefix",
"description": "Desc Not Required",
"entries": [
{
"ipPrefix": "10.0.0.0/24"
}
],
"lastUpdated": 1588178457305,
"owner": "admin",
"readOnly": false,
"version": "0",
"infoTag": "",
"referenceCount": 0,
"references": [],
"isActivatedByVsmart": false
}
]
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/list/community/filtered": {
"get": {
"tags": [
"Configuration - Policy Community List Builder"
],
"description": "Get policy lists with specific info tag",
"operationId": "getPolicyListsWithInfoTag_ConfigurationPolicyCommunityListBuilder_4003",
"parameters": [
{
"name": "infoTag",
"in": "query",
"description": "InfoTag",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/list/community/preview": {
"post": {
"tags": [
"Configuration - Policy Community List Builder"
],
"description": "Preview a policy list based on the policy list type",
"operationId": "previewPolicyList_ConfigurationPolicyCommunityListBuilder_3904",
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy list": {
"description": "Policy list"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Preview policy list": {
"description": "Preview policy list",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/list/community/preview/{id}": {
"get": {
"tags": [
"Configuration - Policy Community List Builder"
],
"description": "Preview a specific policy list entry based on id provided",
"operationId": "previewPolicyListById_ConfigurationPolicyCommunityListBuilder_4403",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Preview policy list": {
"description": "Preview policy list",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/list/community/{id}": {
"delete": {
"tags": [
"Configuration - Policy Community List Builder"
],
"description": "Delete policy list entry for a specific type of policy list",
"operationId": "deletePolicyList_ConfigurationPolicyCommunityListBuilder_3606",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"get": {
"tags": [
"Configuration - Policy Community List Builder"
],
"description": "Get a specific policy list based on the id",
"operationId": "getListsById_ConfigurationPolicyCommunityListBuilder_3603",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy": {
"description": "Policy",
"value": {
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6",
"name": "Community",
"type": "community",
"description": "Desc Not Required",
"entries": [
{
"community": "1000:5000"
}
],
"lastUpdated": 1590184928436,
"owner": "admin",
"readOnly": false,
"version": "0",
"infoTag": "",
"referenceCount": 0,
"references": [],
"isActivatedByVsmart": false
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
},
"put": {
"tags": [
"Configuration - Policy Community List Builder"
],
"description": "Edit policy list entries for a specific type of policy list",
"operationId": "editPolicyList_ConfigurationPolicyCommunityListBuilder_3603",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": {
"name": "Community",
"description": "Desc Not Required",
"type": "community",
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6",
"entries": [
{
"community": "1000:8000"
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy": {
"description": "Policy",
"value": {
"masterTemplatesAffected": []
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/list/dataipv6prefix": {
"post": {
"tags": [
"Configuration - Policy Data IPV6 Prefix List Builder"
],
"description": "Create policy list",
"operationId": "createPolicyList_ConfigurationPolicyDataIpv6PrefixListBuilder_3604",
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Zone list": {
"description": "Zone list",
"value": {
"name": "Demo-Zone",
"description": "Desc Not Required",
"type": "zone",
"entries": [
{
"vpn": "10"
}
]
}
},
"IPS list": {
"description": "IPS list",
"value": {
"name": "Demo-IPS-list",
"description": "Desc Not Required",
"type": "ipssignature",
"entries": [
{
"generatorId": "1111",
"signatureId": "4444"
}
]
}
},
"URL white list": {
"description": "URL white list",
"value": {
"name": "Demo-Whitelist",
"description": "Desc Not Required",
"type": "urlwhitelist",
"entries": [
{
"pattern": "https://www.youtube.com"
}
]
}
},
"URL black list": {
"description": "URL black list",
"value": {
"name": "Demo-Black-list",
"description": "Desc Not Required",
"type": "urlblacklist",
"entries": [
{
"pattern": "www.facebook.com"
}
]
}
},
"TG API key list": {
"description": "TG API key list",
"value": {
"name": "threatGridApiKeyList",
"description": "",
"type": "threatGridApiKey",
"entries": [
{
"region": "nam",
"apikey": "1234567"
},
{
"region": "eur",
"apikey": "1234567"
}
]
}
},
"Local domain list": {
"description": "Local domain list",
"value": {
"name": "Demo-Domain-Name-List",
"description": "Desc Not Required",
"type": "localdomain",
"entries": [
{
"nameServer": "cisco.com"
}
]
}
},
"Umbrella data list": {
"description": "Umbrella data list",
"value": {
"name": "umbrellaTokenList",
"description": "",
"type": "umbrellaData",
"entries": [
{
"apiKey": "abcd",
"secret": "12345",
"umbOrgId": "23405",
"token": "abcedabcedabcedabcedabcedabcedabcedabced"
}
]
}
},
"App family": {
"description": "App family",
"value": {
"name": "Demo-App-List",
"description": "Desc Not Required",
"type": "app",
"entries": [
{
"appFamily": "web"
},
{
"appFamily": "audio-video"
}
]
}
},
"App list": {
"description": "App list",
"value": {
"name": "Demo-App-List",
"description": "Desc Not Required",
"type": "app",
"entries": [
{
"app": "facebook"
},
{
"app": "netshow"
}
]
}
},
"Color list": {
"description": "Color list",
"value": {
"name": "Demo-Color-List",
"description": "Desc Not Required",
"type": "color",
"entries": [
{
"color": "biz-internet"
},
{
"color": "public-internet"
}
]
}
},
"Data prefix": {
"description": "Data prefix",
"value": {
"name": "Demo-Data-Prefix-List",
"description": "Desc Not Required",
"type": "dataprefix",
"entries": [
{
"ipPrefix": "10.1.0.0/16"
},
{
"ipPrefix": "10.2.0.0/16"
}
]
}
},
"Policer": {
"description": "Policer",
"value": {
"name": "Demo-Policer-list",
"description": "Desc Not Required",
"type": "policer",
"entries": [
{
"burst": "16000",
"exceed": "drop",
"rate": "10000"
}
]
}
},
"Prefix": {
"description": "Prefix",
"value": {
"name": "Demo-Prefix-list",
"description": "Desc Not Required",
"type": "prefix",
"entries": [
{
"ipPrefix": "10.0.0.0/12",
"le": "32"
}
]
}
},
"Site": {
"description": "Site",
"value": {
"name": "Demo-Site-List",
"description": "Desc Not Required",
"type": "site",
"listId": null,
"entries": [
{
"siteId": "100"
},
{
"siteId": "200"
},
{
"siteId": "300-500"
}
]
}
},
"Class": {
"description": "Class",
"value": {
"name": "Demo-Class-Map",
"description": "Desc Not Required",
"type": "class",
"entries": [
{
"queue": "4"
}
]
}
},
"App probe": {
"description": "App probe",
"value": {
"name": "Demo-Probe-Class",
"type": "appProbe",
"entries": [
{
"map": [
{
"color": "biz-internet",
"dscp": 46
},
{
"color": "public-internet",
"dscp": 20
}
],
"forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70"
}
]
}
},
"SLA": {
"description": "SLA",
"value": {
"name": "Demo-SLA-Class",
"description": "Desc Not Required",
"type": "sla",
"entries": [
{
"latency": "100",
"loss": "10",
"jitter": "10",
"appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d"
}
]
}
},
"TLOC": {
"description": "TLOC",
"value": {
"name": "Demo-TLOC-List",
"description": "Desc Not Required",
"type": "tloc",
"entries": [
{
"tloc": "10.1.1.1",
"color": "biz-internet",
"encap": "ipsec",
"preference": "10"
},
{
"tloc": "10.2.2.2",
"color": "biz-internet",
"encap": "ipsec",
"preference": "20"
}
]
}
},
"VPN": {
"description": "VPN",
"value": {
"name": "Demo-VPN-List",
"description": "Desc Not Required",
"type": "vpn",
"listId": null,
"entries": [
{
"vpn": "100"
},
{
"vpn": "200"
},
{
"vpn": "300-500"
}
]
}
},
"AS path": {
"description": "AS path",
"value": {
"name": "Demo-AS-Path-List",
"description": "Desc Not Required",
"type": "aspath",
"listId": null,
"entries": [
{
"asPath": "100"
},
{
"asPath": "200"
},
{
"asPath": "65002"
}
]
}
},
"Community": {
"description": "Community",
"value": {
"name": "Demo-Community-List",
"description": "Desc Not Required",
"type": "community",
"listId": null,
"entries": [
{
"community": "1000:10000"
}
]
}
},
"Ext community": {
"description": "Ext community",
"value": {
"name": "Demo-Extended-Community-List",
"description": "Desc Not Required",
"type": "extcommunity",
"listId": null,
"entries": [
{
"community": "rt 100:10"
}
]
}
},
"Mirror": {
"description": "Mirror",
"value": {
"name": "Demo-Mirror-List",
"description": "Desc Not Required",
"type": "mirror",
"entries": [
{
"remoteDest": "10.1.1.1",
"source": "20.1.1.1"
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Task Id": {
"description": "Task Id",
"value": {
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6"
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"get": {
"tags": [
"Configuration - Policy Data IPV6 Prefix List Builder"
],
"description": "Get policy lists",
"operationId": "getPolicyLists_ConfigurationPolicyDataIpv6PrefixListBuilder_3603",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"App Policy": {
"description": "App Policy",
"value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"
},
"Prefix List": {
"description": "Prefix List",
"value": {
"data": [
{
"listId": "8bc43c09-f72c-40b8-aa90-608c7005e607",
"name": "Example",
"type": "prefix",
"description": "Desc Not Required",
"entries": [
{
"ipPrefix": "10.0.0.0/24"
}
],
"lastUpdated": 1588178457305,
"owner": "admin",
"readOnly": false,
"version": "0",
"infoTag": "",
"referenceCount": 0,
"references": [],
"isActivatedByVsmart": false
}
]
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
},
"delete": {
"tags": [
"Configuration - Policy Data IPV6 Prefix List Builder"
],
"description": "Delete policy lists with specific info tag",
"operationId": "deletePolicyListsWithInfoTag_ConfigurationPolicyDataIpv6PrefixListBuilder_3606",
"parameters": [
{
"name": "infoTag",
"in": "query",
"description": "InfoTag",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/list/dataipv6prefix/filtered": {
"get": {
"tags": [
"Configuration - Policy Data IPV6 Prefix List Builder"
],
"description": "Get policy lists with specific info tag",
"operationId": "getPolicyListsWithInfoTag_ConfigurationPolicyDataIpv6PrefixListBuilder_4503",
"parameters": [
{
"name": "infoTag",
"in": "query",
"description": "InfoTag",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/list/dataipv6prefix/preview": {
"post": {
"tags": [
"Configuration - Policy Data IPV6 Prefix List Builder"
],
"description": "Preview a policy list based on the policy list type",
"operationId": "previewPolicyList_ConfigurationPolicyDataIpv6PrefixListBuilder_4404",
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy list": {
"description": "Policy list"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Preview policy list": {
"description": "Preview policy list",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/list/dataipv6prefix/preview/{id}": {
"get": {
"tags": [
"Configuration - Policy Data IPV6 Prefix List Builder"
],
"description": "Preview a specific policy list entry based on id provided",
"operationId": "previewPolicyListById_ConfigurationPolicyDataIpv6PrefixListBuilder_4903",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Preview policy list": {
"description": "Preview policy list",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/list/dataipv6prefix/{id}": {
"put": {
"tags": [
"Configuration - Policy Data IPV6 Prefix List Builder"
],
"description": "Edit policy list entries for a specific type of policy list",
"operationId": "editPolicyList_ConfigurationPolicyDataIpv6PrefixListBuilder_4103",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": {
"name": "Community",
"description": "Desc Not Required",
"type": "community",
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6",
"entries": [
{
"community": "1000:8000"
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy": {
"description": "Policy",
"value": {
"masterTemplatesAffected": []
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"delete": {
"tags": [
"Configuration - Policy Data IPV6 Prefix List Builder"
],
"description": "Delete policy list entry for a specific type of policy list",
"operationId": "deletePolicyList_ConfigurationPolicyDataIpv6PrefixListBuilder_4106",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"get": {
"tags": [
"Configuration - Policy Data IPV6 Prefix List Builder"
],
"description": "Get a specific policy list based on the id",
"operationId": "getListsById_ConfigurationPolicyDataIpv6PrefixListBuilder_4103",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy": {
"description": "Policy",
"value": {
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6",
"name": "Community",
"type": "community",
"description": "Desc Not Required",
"entries": [
{
"community": "1000:5000"
}
],
"lastUpdated": 1590184928436,
"owner": "admin",
"readOnly": false,
"version": "0",
"infoTag": "",
"referenceCount": 0,
"references": [],
"isActivatedByVsmart": false
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/list/dataprefix": {
"get": {
"tags": [
"Configuration - Policy Data Prefix List Builder"
],
"description": "Get policy lists",
"operationId": "getPolicyLists_ConfigurationPolicyDataPrefixListBuilder_3203",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"App Policy": {
"description": "App Policy",
"value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"
},
"Prefix List": {
"description": "Prefix List",
"value": {
"data": [
{
"listId": "8bc43c09-f72c-40b8-aa90-608c7005e607",
"name": "Example",
"type": "prefix",
"description": "Desc Not Required",
"entries": [
{
"ipPrefix": "10.0.0.0/24"
}
],
"lastUpdated": 1588178457305,
"owner": "admin",
"readOnly": false,
"version": "0",
"infoTag": "",
"referenceCount": 0,
"references": [],
"isActivatedByVsmart": false
}
]
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
},
"post": {
"tags": [
"Configuration - Policy Data Prefix List Builder"
],
"description": "Create policy list",
"operationId": "createPolicyList_ConfigurationPolicyDataPrefixListBuilder_3204",
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Zone list": {
"description": "Zone list",
"value": {
"name": "Demo-Zone",
"description": "Desc Not Required",
"type": "zone",
"entries": [
{
"vpn": "10"
}
]
}
},
"IPS list": {
"description": "IPS list",
"value": {
"name": "Demo-IPS-list",
"description": "Desc Not Required",
"type": "ipssignature",
"entries": [
{
"generatorId": "1111",
"signatureId": "4444"
}
]
}
},
"URL white list": {
"description": "URL white list",
"value": {
"name": "Demo-Whitelist",
"description": "Desc Not Required",
"type": "urlwhitelist",
"entries": [
{
"pattern": "https://www.youtube.com"
}
]
}
},
"URL black list": {
"description": "URL black list",
"value": {
"name": "Demo-Black-list",
"description": "Desc Not Required",
"type": "urlblacklist",
"entries": [
{
"pattern": "www.facebook.com"
}
]
}
},
"TG API key list": {
"description": "TG API key list",
"value": {
"name": "threatGridApiKeyList",
"description": "",
"type": "threatGridApiKey",
"entries": [
{
"region": "nam",
"apikey": "1234567"
},
{
"region": "eur",
"apikey": "1234567"
}
]
}
},
"Local domain list": {
"description": "Local domain list",
"value": {
"name": "Demo-Domain-Name-List",
"description": "Desc Not Required",
"type": "localdomain",
"entries": [
{
"nameServer": "cisco.com"
}
]
}
},
"Umbrella data list": {
"description": "Umbrella data list",
"value": {
"name": "umbrellaTokenList",
"description": "",
"type": "umbrellaData",
"entries": [
{
"apiKey": "abcd",
"secret": "12345",
"umbOrgId": "23405",
"token": "abcedabcedabcedabcedabcedabcedabcedabced"
}
]
}
},
"App family": {
"description": "App family",
"value": {
"name": "Demo-App-List",
"description": "Desc Not Required",
"type": "app",
"entries": [
{
"appFamily": "web"
},
{
"appFamily": "audio-video"
}
]
}
},
"App list": {
"description": "App list",
"value": {
"name": "Demo-App-List",
"description": "Desc Not Required",
"type": "app",
"entries": [
{
"app": "facebook"
},
{
"app": "netshow"
}
]
}
},
"Color list": {
"description": "Color list",
"value": {
"name": "Demo-Color-List",
"description": "Desc Not Required",
"type": "color",
"entries": [
{
"color": "biz-internet"
},
{
"color": "public-internet"
}
]
}
},
"Data prefix": {
"description": "Data prefix",
"value": {
"name": "Demo-Data-Prefix-List",
"description": "Desc Not Required",
"type": "dataprefix",
"entries": [
{
"ipPrefix": "10.1.0.0/16"
},
{
"ipPrefix": "10.2.0.0/16"
}
]
}
},
"Policer": {
"description": "Policer",
"value": {
"name": "Demo-Policer-list",
"description": "Desc Not Required",
"type": "policer",
"entries": [
{
"burst": "16000",
"exceed": "drop",
"rate": "10000"
}
]
}
},
"Prefix": {
"description": "Prefix",
"value": {
"name": "Demo-Prefix-list",
"description": "Desc Not Required",
"type": "prefix",
"entries": [
{
"ipPrefix": "10.0.0.0/12",
"le": "32"
}
]
}
},
"Site": {
"description": "Site",
"value": {
"name": "Demo-Site-List",
"description": "Desc Not Required",
"type": "site",
"listId": null,
"entries": [
{
"siteId": "100"
},
{
"siteId": "200"
},
{
"siteId": "300-500"
}
]
}
},
"Class": {
"description": "Class",
"value": {
"name": "Demo-Class-Map",
"description": "Desc Not Required",
"type": "class",
"entries": [
{
"queue": "4"
}
]
}
},
"App probe": {
"description": "App probe",
"value": {
"name": "Demo-Probe-Class",
"type": "appProbe",
"entries": [
{
"map": [
{
"color": "biz-internet",
"dscp": 46
},
{
"color": "public-internet",
"dscp": 20
}
],
"forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70"
}
]
}
},
"SLA": {
"description": "SLA",
"value": {
"name": "Demo-SLA-Class",
"description": "Desc Not Required",
"type": "sla",
"entries": [
{
"latency": "100",
"loss": "10",
"jitter": "10",
"appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d"
}
]
}
},
"TLOC": {
"description": "TLOC",
"value": {
"name": "Demo-TLOC-List",
"description": "Desc Not Required",
"type": "tloc",
"entries": [
{
"tloc": "10.1.1.1",
"color": "biz-internet",
"encap": "ipsec",
"preference": "10"
},
{
"tloc": "10.2.2.2",
"color": "biz-internet",
"encap": "ipsec",
"preference": "20"
}
]
}
},
"VPN": {
"description": "VPN",
"value": {
"name": "Demo-VPN-List",
"description": "Desc Not Required",
"type": "vpn",
"listId": null,
"entries": [
{
"vpn": "100"
},
{
"vpn": "200"
},
{
"vpn": "300-500"
}
]
}
},
"AS path": {
"description": "AS path",
"value": {
"name": "Demo-AS-Path-List",
"description": "Desc Not Required",
"type": "aspath",
"listId": null,
"entries": [
{
"asPath": "100"
},
{
"asPath": "200"
},
{
"asPath": "65002"
}
]
}
},
"Community": {
"description": "Community",
"value": {
"name": "Demo-Community-List",
"description": "Desc Not Required",
"type": "community",
"listId": null,
"entries": [
{
"community": "1000:10000"
}
]
}
},
"Ext community": {
"description": "Ext community",
"value": {
"name": "Demo-Extended-Community-List",
"description": "Desc Not Required",
"type": "extcommunity",
"listId": null,
"entries": [
{
"community": "rt 100:10"
}
]
}
},
"Mirror": {
"description": "Mirror",
"value": {
"name": "Demo-Mirror-List",
"description": "Desc Not Required",
"type": "mirror",
"entries": [
{
"remoteDest": "10.1.1.1",
"source": "20.1.1.1"
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Task Id": {
"description": "Task Id",
"value": {
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6"
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"delete": {
"tags": [
"Configuration - Policy Data Prefix List Builder"
],
"description": "Delete policy lists with specific info tag",
"operationId": "deletePolicyListsWithInfoTag_ConfigurationPolicyDataPrefixListBuilder_3206",
"parameters": [
{
"name": "infoTag",
"in": "query",
"description": "InfoTag",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/list/dataprefix/filtered": {
"get": {
"tags": [
"Configuration - Policy Data Prefix List Builder"
],
"description": "Get policy lists with specific info tag",
"operationId": "getPolicyListsWithInfoTag_ConfigurationPolicyDataPrefixListBuilder_4103",
"parameters": [
{
"name": "infoTag",
"in": "query",
"description": "InfoTag",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/list/dataprefix/preview": {
"post": {
"tags": [
"Configuration - Policy Data Prefix List Builder"
],
"description": "Preview a policy list based on the policy list type",
"operationId": "previewPolicyList_ConfigurationPolicyDataPrefixListBuilder_4004",
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy list": {
"description": "Policy list"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Preview policy list": {
"description": "Preview policy list",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/list/dataprefix/preview/{id}": {
"get": {
"tags": [
"Configuration - Policy Data Prefix List Builder"
],
"description": "Preview a specific policy list entry based on id provided",
"operationId": "previewPolicyListById_ConfigurationPolicyDataPrefixListBuilder_4503",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Preview policy list": {
"description": "Preview policy list",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/list/dataprefix/{id}": {
"get": {
"tags": [
"Configuration - Policy Data Prefix List Builder"
],
"description": "Get a specific policy list based on the id",
"operationId": "getListsById_ConfigurationPolicyDataPrefixListBuilder_3703",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy": {
"description": "Policy",
"value": {
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6",
"name": "Community",
"type": "community",
"description": "Desc Not Required",
"entries": [
{
"community": "1000:5000"
}
],
"lastUpdated": 1590184928436,
"owner": "admin",
"readOnly": false,
"version": "0",
"infoTag": "",
"referenceCount": 0,
"references": [],
"isActivatedByVsmart": false
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
},
"put": {
"tags": [
"Configuration - Policy Data Prefix List Builder"
],
"description": "Edit policy list entries for a specific type of policy list",
"operationId": "editPolicyList_ConfigurationPolicyDataPrefixListBuilder_3703",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": {
"name": "Community",
"description": "Desc Not Required",
"type": "community",
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6",
"entries": [
{
"community": "1000:8000"
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy": {
"description": "Policy",
"value": {
"masterTemplatesAffected": []
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"delete": {
"tags": [
"Configuration - Policy Data Prefix List Builder"
],
"description": "Delete policy list entry for a specific type of policy list",
"operationId": "deletePolicyList_ConfigurationPolicyDataPrefixListBuilder_3706",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/list/dataprefixall": {
"get": {
"tags": [
"Configuration - Policy Data Prefix All Types Of Lists Builder"
],
"description": "Get policy lists for all data prefixes",
"operationId": "getListsForAllDataPrefixes",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
},
"post": {
"tags": [
"Configuration - Policy Data Prefix All Types Of Lists Builder"
],
"description": "Create policy list",
"operationId": "createPolicyList_ConfigurationPolicyDataPrefixAllTypesOfListsBuilder_3504",
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Zone list": {
"description": "Zone list",
"value": {
"name": "Demo-Zone",
"description": "Desc Not Required",
"type": "zone",
"entries": [
{
"vpn": "10"
}
]
}
},
"IPS list": {
"description": "IPS list",
"value": {
"name": "Demo-IPS-list",
"description": "Desc Not Required",
"type": "ipssignature",
"entries": [
{
"generatorId": "1111",
"signatureId": "4444"
}
]
}
},
"URL white list": {
"description": "URL white list",
"value": {
"name": "Demo-Whitelist",
"description": "Desc Not Required",
"type": "urlwhitelist",
"entries": [
{
"pattern": "https://www.youtube.com"
}
]
}
},
"URL black list": {
"description": "URL black list",
"value": {
"name": "Demo-Black-list",
"description": "Desc Not Required",
"type": "urlblacklist",
"entries": [
{
"pattern": "www.facebook.com"
}
]
}
},
"TG API key list": {
"description": "TG API key list",
"value": {
"name": "threatGridApiKeyList",
"description": "",
"type": "threatGridApiKey",
"entries": [
{
"region": "nam",
"apikey": "1234567"
},
{
"region": "eur",
"apikey": "1234567"
}
]
}
},
"Local domain list": {
"description": "Local domain list",
"value": {
"name": "Demo-Domain-Name-List",
"description": "Desc Not Required",
"type": "localdomain",
"entries": [
{
"nameServer": "cisco.com"
}
]
}
},
"Umbrella data list": {
"description": "Umbrella data list",
"value": {
"name": "umbrellaTokenList",
"description": "",
"type": "umbrellaData",
"entries": [
{
"apiKey": "abcd",
"secret": "12345",
"umbOrgId": "23405",
"token": "abcedabcedabcedabcedabcedabcedabcedabced"
}
]
}
},
"App family": {
"description": "App family",
"value": {
"name": "Demo-App-List",
"description": "Desc Not Required",
"type": "app",
"entries": [
{
"appFamily": "web"
},
{
"appFamily": "audio-video"
}
]
}
},
"App list": {
"description": "App list",
"value": {
"name": "Demo-App-List",
"description": "Desc Not Required",
"type": "app",
"entries": [
{
"app": "facebook"
},
{
"app": "netshow"
}
]
}
},
"Color list": {
"description": "Color list",
"value": {
"name": "Demo-Color-List",
"description": "Desc Not Required",
"type": "color",
"entries": [
{
"color": "biz-internet"
},
{
"color": "public-internet"
}
]
}
},
"Data prefix": {
"description": "Data prefix",
"value": {
"name": "Demo-Data-Prefix-List",
"description": "Desc Not Required",
"type": "dataprefix",
"entries": [
{
"ipPrefix": "10.1.0.0/16"
},
{
"ipPrefix": "10.2.0.0/16"
}
]
}
},
"Policer": {
"description": "Policer",
"value": {
"name": "Demo-Policer-list",
"description": "Desc Not Required",
"type": "policer",
"entries": [
{
"burst": "16000",
"exceed": "drop",
"rate": "10000"
}
]
}
},
"Prefix": {
"description": "Prefix",
"value": {
"name": "Demo-Prefix-list",
"description": "Desc Not Required",
"type": "prefix",
"entries": [
{
"ipPrefix": "10.0.0.0/12",
"le": "32"
}
]
}
},
"Site": {
"description": "Site",
"value": {
"name": "Demo-Site-List",
"description": "Desc Not Required",
"type": "site",
"listId": null,
"entries": [
{
"siteId": "100"
},
{
"siteId": "200"
},
{
"siteId": "300-500"
}
]
}
},
"Class": {
"description": "Class",
"value": {
"name": "Demo-Class-Map",
"description": "Desc Not Required",
"type": "class",
"entries": [
{
"queue": "4"
}
]
}
},
"App probe": {
"description": "App probe",
"value": {
"name": "Demo-Probe-Class",
"type": "appProbe",
"entries": [
{
"map": [
{
"color": "biz-internet",
"dscp": 46
},
{
"color": "public-internet",
"dscp": 20
}
],
"forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70"
}
]
}
},
"SLA": {
"description": "SLA",
"value": {
"name": "Demo-SLA-Class",
"description": "Desc Not Required",
"type": "sla",
"entries": [
{
"latency": "100",
"loss": "10",
"jitter": "10",
"appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d"
}
]
}
},
"TLOC": {
"description": "TLOC",
"value": {
"name": "Demo-TLOC-List",
"description": "Desc Not Required",
"type": "tloc",
"entries": [
{
"tloc": "10.1.1.1",
"color": "biz-internet",
"encap": "ipsec",
"preference": "10"
},
{
"tloc": "10.2.2.2",
"color": "biz-internet",
"encap": "ipsec",
"preference": "20"
}
]
}
},
"VPN": {
"description": "VPN",
"value": {
"name": "Demo-VPN-List",
"description": "Desc Not Required",
"type": "vpn",
"listId": null,
"entries": [
{
"vpn": "100"
},
{
"vpn": "200"
},
{
"vpn": "300-500"
}
]
}
},
"AS path": {
"description": "AS path",
"value": {
"name": "Demo-AS-Path-List",
"description": "Desc Not Required",
"type": "aspath",
"listId": null,
"entries": [
{
"asPath": "100"
},
{
"asPath": "200"
},
{
"asPath": "65002"
}
]
}
},
"Community": {
"description": "Community",
"value": {
"name": "Demo-Community-List",
"description": "Desc Not Required",
"type": "community",
"listId": null,
"entries": [
{
"community": "1000:10000"
}
]
}
},
"Ext community": {
"description": "Ext community",
"value": {
"name": "Demo-Extended-Community-List",
"description": "Desc Not Required",
"type": "extcommunity",
"listId": null,
"entries": [
{
"community": "rt 100:10"
}
]
}
},
"Mirror": {
"description": "Mirror",
"value": {
"name": "Demo-Mirror-List",
"description": "Desc Not Required",
"type": "mirror",
"entries": [
{
"remoteDest": "10.1.1.1",
"source": "20.1.1.1"
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Task Id": {
"description": "Task Id",
"value": {
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6"
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"delete": {
"tags": [
"Configuration - Policy Data Prefix All Types Of Lists Builder"
],
"description": "Delete policy lists with specific info tag",
"operationId": "deletePolicyListsWithInfoTag_ConfigurationPolicyDataPrefixAllTypesOfListsBuilder_3506",
"parameters": [
{
"name": "infoTag",
"in": "query",
"description": "InfoTag",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/list/dataprefixall/filtered": {
"get": {
"tags": [
"Configuration - Policy Data Prefix All Types Of Lists Builder"
],
"description": "Get policy lists with specific info tag",
"operationId": "getPolicyListsWithInfoTag_ConfigurationPolicyDataPrefixAllTypesOfListsBuilder_4403",
"parameters": [
{
"name": "infoTag",
"in": "query",
"description": "InfoTag",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/list/dataprefixall/preview": {
"post": {
"tags": [
"Configuration - Policy Data Prefix All Types Of Lists Builder"
],
"description": "Preview a policy list based on the policy list type",
"operationId": "previewPolicyList_ConfigurationPolicyDataPrefixAllTypesOfListsBuilder_4304",
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy list": {
"description": "Policy list"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Preview policy list": {
"description": "Preview policy list",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/list/dataprefixall/preview/{id}": {
"get": {
"tags": [
"Configuration - Policy Data Prefix All Types Of Lists Builder"
],
"description": "Preview a specific policy list entry based on id provided",
"operationId": "previewPolicyListById_ConfigurationPolicyDataPrefixAllTypesOfListsBuilder_4803",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Preview policy list": {
"description": "Preview policy list",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/list/dataprefixall/{id}": {
"delete": {
"tags": [
"Configuration - Policy Data Prefix All Types Of Lists Builder"
],
"description": "Delete policy list entry for a specific type of policy list",
"operationId": "deletePolicyList_ConfigurationPolicyDataPrefixAllTypesOfListsBuilder_4006",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"get": {
"tags": [
"Configuration - Policy Data Prefix All Types Of Lists Builder"
],
"description": "Get a specific policy list based on the id",
"operationId": "getListsById_ConfigurationPolicyDataPrefixAllTypesOfListsBuilder_4003",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy": {
"description": "Policy",
"value": {
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6",
"name": "Community",
"type": "community",
"description": "Desc Not Required",
"entries": [
{
"community": "1000:5000"
}
],
"lastUpdated": 1590184928436,
"owner": "admin",
"readOnly": false,
"version": "0",
"infoTag": "",
"referenceCount": 0,
"references": [],
"isActivatedByVsmart": false
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
},
"put": {
"tags": [
"Configuration - Policy Data Prefix All Types Of Lists Builder"
],
"description": "Edit policy list entries for a specific type of policy list",
"operationId": "editPolicyList_ConfigurationPolicyDataPrefixAllTypesOfListsBuilder_4003",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": {
"name": "Community",
"description": "Desc Not Required",
"type": "community",
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6",
"entries": [
{
"community": "1000:8000"
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy": {
"description": "Policy",
"value": {
"masterTemplatesAffected": []
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/list/dataprefixfqdn": {
"get": {
"tags": [
"Configuration - Policy Data Prefix and FQDN All Types Of Lists Builder"
],
"description": "Get lists for all all data-prefix(IPv4) and Fqdn lists",
"operationId": "getAllDataPrefixAndFQDNLists",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Data prefix and FQDN": {
"description": "Data prefix and FQDN",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
},
"post": {
"tags": [
"Configuration - Policy Data Prefix and FQDN All Types Of Lists Builder"
],
"description": "Create policy list",
"operationId": "createPolicyList_ConfigurationPolicyDataPrefixFqdnAllTypesOfListsBuilder_3604",
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Zone list": {
"description": "Zone list",
"value": {
"name": "Demo-Zone",
"description": "Desc Not Required",
"type": "zone",
"entries": [
{
"vpn": "10"
}
]
}
},
"IPS list": {
"description": "IPS list",
"value": {
"name": "Demo-IPS-list",
"description": "Desc Not Required",
"type": "ipssignature",
"entries": [
{
"generatorId": "1111",
"signatureId": "4444"
}
]
}
},
"URL white list": {
"description": "URL white list",
"value": {
"name": "Demo-Whitelist",
"description": "Desc Not Required",
"type": "urlwhitelist",
"entries": [
{
"pattern": "https://www.youtube.com"
}
]
}
},
"URL black list": {
"description": "URL black list",
"value": {
"name": "Demo-Black-list",
"description": "Desc Not Required",
"type": "urlblacklist",
"entries": [
{
"pattern": "www.facebook.com"
}
]
}
},
"TG API key list": {
"description": "TG API key list",
"value": {
"name": "threatGridApiKeyList",
"description": "",
"type": "threatGridApiKey",
"entries": [
{
"region": "nam",
"apikey": "1234567"
},
{
"region": "eur",
"apikey": "1234567"
}
]
}
},
"Local domain list": {
"description": "Local domain list",
"value": {
"name": "Demo-Domain-Name-List",
"description": "Desc Not Required",
"type": "localdomain",
"entries": [
{
"nameServer": "cisco.com"
}
]
}
},
"Umbrella data list": {
"description": "Umbrella data list",
"value": {
"name": "umbrellaTokenList",
"description": "",
"type": "umbrellaData",
"entries": [
{
"apiKey": "abcd",
"secret": "12345",
"umbOrgId": "23405",
"token": "abcedabcedabcedabcedabcedabcedabcedabced"
}
]
}
},
"App family": {
"description": "App family",
"value": {
"name": "Demo-App-List",
"description": "Desc Not Required",
"type": "app",
"entries": [
{
"appFamily": "web"
},
{
"appFamily": "audio-video"
}
]
}
},
"App list": {
"description": "App list",
"value": {
"name": "Demo-App-List",
"description": "Desc Not Required",
"type": "app",
"entries": [
{
"app": "facebook"
},
{
"app": "netshow"
}
]
}
},
"Color list": {
"description": "Color list",
"value": {
"name": "Demo-Color-List",
"description": "Desc Not Required",
"type": "color",
"entries": [
{
"color": "biz-internet"
},
{
"color": "public-internet"
}
]
}
},
"Data prefix": {
"description": "Data prefix",
"value": {
"name": "Demo-Data-Prefix-List",
"description": "Desc Not Required",
"type": "dataprefix",
"entries": [
{
"ipPrefix": "10.1.0.0/16"
},
{
"ipPrefix": "10.2.0.0/16"
}
]
}
},
"Policer": {
"description": "Policer",
"value": {
"name": "Demo-Policer-list",
"description": "Desc Not Required",
"type": "policer",
"entries": [
{
"burst": "16000",
"exceed": "drop",
"rate": "10000"
}
]
}
},
"Prefix": {
"description": "Prefix",
"value": {
"name": "Demo-Prefix-list",
"description": "Desc Not Required",
"type": "prefix",
"entries": [
{
"ipPrefix": "10.0.0.0/12",
"le": "32"
}
]
}
},
"Site": {
"description": "Site",
"value": {
"name": "Demo-Site-List",
"description": "Desc Not Required",
"type": "site",
"listId": null,
"entries": [
{
"siteId": "100"
},
{
"siteId": "200"
},
{
"siteId": "300-500"
}
]
}
},
"Class": {
"description": "Class",
"value": {
"name": "Demo-Class-Map",
"description": "Desc Not Required",
"type": "class",
"entries": [
{
"queue": "4"
}
]
}
},
"App probe": {
"description": "App probe",
"value": {
"name": "Demo-Probe-Class",
"type": "appProbe",
"entries": [
{
"map": [
{
"color": "biz-internet",
"dscp": 46
},
{
"color": "public-internet",
"dscp": 20
}
],
"forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70"
}
]
}
},
"SLA": {
"description": "SLA",
"value": {
"name": "Demo-SLA-Class",
"description": "Desc Not Required",
"type": "sla",
"entries": [
{
"latency": "100",
"loss": "10",
"jitter": "10",
"appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d"
}
]
}
},
"TLOC": {
"description": "TLOC",
"value": {
"name": "Demo-TLOC-List",
"description": "Desc Not Required",
"type": "tloc",
"entries": [
{
"tloc": "10.1.1.1",
"color": "biz-internet",
"encap": "ipsec",
"preference": "10"
},
{
"tloc": "10.2.2.2",
"color": "biz-internet",
"encap": "ipsec",
"preference": "20"
}
]
}
},
"VPN": {
"description": "VPN",
"value": {
"name": "Demo-VPN-List",
"description": "Desc Not Required",
"type": "vpn",
"listId": null,
"entries": [
{
"vpn": "100"
},
{
"vpn": "200"
},
{
"vpn": "300-500"
}
]
}
},
"AS path": {
"description": "AS path",
"value": {
"name": "Demo-AS-Path-List",
"description": "Desc Not Required",
"type": "aspath",
"listId": null,
"entries": [
{
"asPath": "100"
},
{
"asPath": "200"
},
{
"asPath": "65002"
}
]
}
},
"Community": {
"description": "Community",
"value": {
"name": "Demo-Community-List",
"description": "Desc Not Required",
"type": "community",
"listId": null,
"entries": [
{
"community": "1000:10000"
}
]
}
},
"Ext community": {
"description": "Ext community",
"value": {
"name": "Demo-Extended-Community-List",
"description": "Desc Not Required",
"type": "extcommunity",
"listId": null,
"entries": [
{
"community": "rt 100:10"
}
]
}
},
"Mirror": {
"description": "Mirror",
"value": {
"name": "Demo-Mirror-List",
"description": "Desc Not Required",
"type": "mirror",
"entries": [
{
"remoteDest": "10.1.1.1",
"source": "20.1.1.1"
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Task Id": {
"description": "Task Id",
"value": {
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6"
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"delete": {
"tags": [
"Configuration - Policy Data Prefix and FQDN All Types Of Lists Builder"
],
"description": "Delete policy lists with specific info tag",
"operationId": "deletePolicyListsWithInfoTag_ConfigurationPolicyDataPrefixFqdnAllTypesOfListsBuilder_3606",
"parameters": [
{
"name": "infoTag",
"in": "query",
"description": "InfoTag",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/list/dataprefixfqdn/filtered": {
"get": {
"tags": [
"Configuration - Policy Data Prefix and FQDN All Types Of Lists Builder"
],
"description": "Get policy lists with specific info tag",
"operationId": "getPolicyListsWithInfoTag_ConfigurationPolicyDataPrefixFqdnAllTypesOfListsBuilder_4503",
"parameters": [
{
"name": "infoTag",
"in": "query",
"description": "InfoTag",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/list/dataprefixfqdn/preview": {
"post": {
"tags": [
"Configuration - Policy Data Prefix and FQDN All Types Of Lists Builder"
],
"description": "Preview a policy list based on the policy list type",
"operationId": "previewPolicyList_ConfigurationPolicyDataPrefixFqdnAllTypesOfListsBuilder_4404",
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy list": {
"description": "Policy list"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Preview policy list": {
"description": "Preview policy list",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/list/dataprefixfqdn/preview/{id}": {
"get": {
"tags": [
"Configuration - Policy Data Prefix and FQDN All Types Of Lists Builder"
],
"description": "Preview a specific policy list entry based on id provided",
"operationId": "previewPolicyListById_ConfigurationPolicyDataPrefixFqdnAllTypesOfListsBuilder_4903",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Preview policy list": {
"description": "Preview policy list",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/list/dataprefixfqdn/{id}": {
"get": {
"tags": [
"Configuration - Policy Data Prefix and FQDN All Types Of Lists Builder"
],
"description": "Get a specific policy list based on the id",
"operationId": "getListsById_ConfigurationPolicyDataPrefixFqdnAllTypesOfListsBuilder_4103",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy": {
"description": "Policy",
"value": {
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6",
"name": "Community",
"type": "community",
"description": "Desc Not Required",
"entries": [
{
"community": "1000:5000"
}
],
"lastUpdated": 1590184928436,
"owner": "admin",
"readOnly": false,
"version": "0",
"infoTag": "",
"referenceCount": 0,
"references": [],
"isActivatedByVsmart": false
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
},
"delete": {
"tags": [
"Configuration - Policy Data Prefix and FQDN All Types Of Lists Builder"
],
"description": "Delete policy list entry for a specific type of policy list",
"operationId": "deletePolicyList_ConfigurationPolicyDataPrefixFqdnAllTypesOfListsBuilder_4106",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"put": {
"tags": [
"Configuration - Policy Data Prefix and FQDN All Types Of Lists Builder"
],
"description": "Edit policy list entries for a specific type of policy list",
"operationId": "editPolicyList_ConfigurationPolicyDataPrefixFqdnAllTypesOfListsBuilder_4103",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": {
"name": "Community",
"description": "Desc Not Required",
"type": "community",
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6",
"entries": [
{
"community": "1000:8000"
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy": {
"description": "Policy",
"value": {
"masterTemplatesAffected": []
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/list/expandedcommunity": {
"get": {
"tags": [
"Configuration - Policy Expanded Community List Builder"
],
"description": "Get policy lists",
"operationId": "getPolicyLists_ConfigurationPolicyExpEdCommunityListBuilder_3903",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"App Policy": {
"description": "App Policy",
"value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"
},
"Prefix List": {
"description": "Prefix List",
"value": {
"data": [
{
"listId": "8bc43c09-f72c-40b8-aa90-608c7005e607",
"name": "Example",
"type": "prefix",
"description": "Desc Not Required",
"entries": [
{
"ipPrefix": "10.0.0.0/24"
}
],
"lastUpdated": 1588178457305,
"owner": "admin",
"readOnly": false,
"version": "0",
"infoTag": "",
"referenceCount": 0,
"references": [],
"isActivatedByVsmart": false
}
]
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
},
"delete": {
"tags": [
"Configuration - Policy Expanded Community List Builder"
],
"description": "Delete policy lists with specific info tag",
"operationId": "deletePolicyListsWithInfoTag_ConfigurationPolicyExpEdCommunityListBuilder_3906",
"parameters": [
{
"name": "infoTag",
"in": "query",
"description": "InfoTag",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
},
"post": {
"tags": [
"Configuration - Policy Expanded Community List Builder"
],
"description": "Create policy list",
"operationId": "createPolicyList_ConfigurationPolicyExpEdCommunityListBuilder_3904",
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Zone list": {
"description": "Zone list",
"value": {
"name": "Demo-Zone",
"description": "Desc Not Required",
"type": "zone",
"entries": [
{
"vpn": "10"
}
]
}
},
"IPS list": {
"description": "IPS list",
"value": {
"name": "Demo-IPS-list",
"description": "Desc Not Required",
"type": "ipssignature",
"entries": [
{
"generatorId": "1111",
"signatureId": "4444"
}
]
}
},
"URL white list": {
"description": "URL white list",
"value": {
"name": "Demo-Whitelist",
"description": "Desc Not Required",
"type": "urlwhitelist",
"entries": [
{
"pattern": "https://www.youtube.com"
}
]
}
},
"URL black list": {
"description": "URL black list",
"value": {
"name": "Demo-Black-list",
"description": "Desc Not Required",
"type": "urlblacklist",
"entries": [
{
"pattern": "www.facebook.com"
}
]
}
},
"TG API key list": {
"description": "TG API key list",
"value": {
"name": "threatGridApiKeyList",
"description": "",
"type": "threatGridApiKey",
"entries": [
{
"region": "nam",
"apikey": "1234567"
},
{
"region": "eur",
"apikey": "1234567"
}
]
}
},
"Local domain list": {
"description": "Local domain list",
"value": {
"name": "Demo-Domain-Name-List",
"description": "Desc Not Required",
"type": "localdomain",
"entries": [
{
"nameServer": "cisco.com"
}
]
}
},
"Umbrella data list": {
"description": "Umbrella data list",
"value": {
"name": "umbrellaTokenList",
"description": "",
"type": "umbrellaData",
"entries": [
{
"apiKey": "abcd",
"secret": "12345",
"umbOrgId": "23405",
"token": "abcedabcedabcedabcedabcedabcedabcedabced"
}
]
}
},
"App family": {
"description": "App family",
"value": {
"name": "Demo-App-List",
"description": "Desc Not Required",
"type": "app",
"entries": [
{
"appFamily": "web"
},
{
"appFamily": "audio-video"
}
]
}
},
"App list": {
"description": "App list",
"value": {
"name": "Demo-App-List",
"description": "Desc Not Required",
"type": "app",
"entries": [
{
"app": "facebook"
},
{
"app": "netshow"
}
]
}
},
"Color list": {
"description": "Color list",
"value": {
"name": "Demo-Color-List",
"description": "Desc Not Required",
"type": "color",
"entries": [
{
"color": "biz-internet"
},
{
"color": "public-internet"
}
]
}
},
"Data prefix": {
"description": "Data prefix",
"value": {
"name": "Demo-Data-Prefix-List",
"description": "Desc Not Required",
"type": "dataprefix",
"entries": [
{
"ipPrefix": "10.1.0.0/16"
},
{
"ipPrefix": "10.2.0.0/16"
}
]
}
},
"Policer": {
"description": "Policer",
"value": {
"name": "Demo-Policer-list",
"description": "Desc Not Required",
"type": "policer",
"entries": [
{
"burst": "16000",
"exceed": "drop",
"rate": "10000"
}
]
}
},
"Prefix": {
"description": "Prefix",
"value": {
"name": "Demo-Prefix-list",
"description": "Desc Not Required",
"type": "prefix",
"entries": [
{
"ipPrefix": "10.0.0.0/12",
"le": "32"
}
]
}
},
"Site": {
"description": "Site",
"value": {
"name": "Demo-Site-List",
"description": "Desc Not Required",
"type": "site",
"listId": null,
"entries": [
{
"siteId": "100"
},
{
"siteId": "200"
},
{
"siteId": "300-500"
}
]
}
},
"Class": {
"description": "Class",
"value": {
"name": "Demo-Class-Map",
"description": "Desc Not Required",
"type": "class",
"entries": [
{
"queue": "4"
}
]
}
},
"App probe": {
"description": "App probe",
"value": {
"name": "Demo-Probe-Class",
"type": "appProbe",
"entries": [
{
"map": [
{
"color": "biz-internet",
"dscp": 46
},
{
"color": "public-internet",
"dscp": 20
}
],
"forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70"
}
]
}
},
"SLA": {
"description": "SLA",
"value": {
"name": "Demo-SLA-Class",
"description": "Desc Not Required",
"type": "sla",
"entries": [
{
"latency": "100",
"loss": "10",
"jitter": "10",
"appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d"
}
]
}
},
"TLOC": {
"description": "TLOC",
"value": {
"name": "Demo-TLOC-List",
"description": "Desc Not Required",
"type": "tloc",
"entries": [
{
"tloc": "10.1.1.1",
"color": "biz-internet",
"encap": "ipsec",
"preference": "10"
},
{
"tloc": "10.2.2.2",
"color": "biz-internet",
"encap": "ipsec",
"preference": "20"
}
]
}
},
"VPN": {
"description": "VPN",
"value": {
"name": "Demo-VPN-List",
"description": "Desc Not Required",
"type": "vpn",
"listId": null,
"entries": [
{
"vpn": "100"
},
{
"vpn": "200"
},
{
"vpn": "300-500"
}
]
}
},
"AS path": {
"description": "AS path",
"value": {
"name": "Demo-AS-Path-List",
"description": "Desc Not Required",
"type": "aspath",
"listId": null,
"entries": [
{
"asPath": "100"
},
{
"asPath": "200"
},
{
"asPath": "65002"
}
]
}
},
"Community": {
"description": "Community",
"value": {
"name": "Demo-Community-List",
"description": "Desc Not Required",
"type": "community",
"listId": null,
"entries": [
{
"community": "1000:10000"
}
]
}
},
"Ext community": {
"description": "Ext community",
"value": {
"name": "Demo-Extended-Community-List",
"description": "Desc Not Required",
"type": "extcommunity",
"listId": null,
"entries": [
{
"community": "rt 100:10"
}
]
}
},
"Mirror": {
"description": "Mirror",
"value": {
"name": "Demo-Mirror-List",
"description": "Desc Not Required",
"type": "mirror",
"entries": [
{
"remoteDest": "10.1.1.1",
"source": "20.1.1.1"
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Task Id": {
"description": "Task Id",
"value": {
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6"
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/list/expandedcommunity/filtered": {
"get": {
"tags": [
"Configuration - Policy Expanded Community List Builder"
],
"description": "Get policy lists with specific info tag",
"operationId": "getPolicyListsWithInfoTag_ConfigurationPolicyExpEdCommunityListBuilder_4803",
"parameters": [
{
"name": "infoTag",
"in": "query",
"description": "InfoTag",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/list/expandedcommunity/preview": {
"post": {
"tags": [
"Configuration - Policy Expanded Community List Builder"
],
"description": "Preview a policy list based on the policy list type",
"operationId": "previewPolicyList_ConfigurationPolicyExpEdCommunityListBuilder_4704",
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy list": {
"description": "Policy list"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Preview policy list": {
"description": "Preview policy list",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/list/expandedcommunity/preview/{id}": {
"get": {
"tags": [
"Configuration - Policy Expanded Community List Builder"
],
"description": "Preview a specific policy list entry based on id provided",
"operationId": "previewPolicyListById_ConfigurationPolicyExpEdCommunityListBuilder_5203",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Preview policy list": {
"description": "Preview policy list",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/list/expandedcommunity/{id}": {
"put": {
"tags": [
"Configuration - Policy Expanded Community List Builder"
],
"description": "Edit policy list entries for a specific type of policy list",
"operationId": "editPolicyList_ConfigurationPolicyExpEdCommunityListBuilder_4403",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": {
"name": "Community",
"description": "Desc Not Required",
"type": "community",
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6",
"entries": [
{
"community": "1000:8000"
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy": {
"description": "Policy",
"value": {
"masterTemplatesAffected": []
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"delete": {
"tags": [
"Configuration - Policy Expanded Community List Builder"
],
"description": "Delete policy list entry for a specific type of policy list",
"operationId": "deletePolicyList_ConfigurationPolicyExpEdCommunityListBuilder_4406",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"get": {
"tags": [
"Configuration - Policy Expanded Community List Builder"
],
"description": "Get a specific policy list based on the id",
"operationId": "getListsById_ConfigurationPolicyExpEdCommunityListBuilder_4403",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy": {
"description": "Policy",
"value": {
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6",
"name": "Community",
"type": "community",
"description": "Desc Not Required",
"entries": [
{
"community": "1000:5000"
}
],
"lastUpdated": 1590184928436,
"owner": "admin",
"readOnly": false,
"version": "0",
"infoTag": "",
"referenceCount": 0,
"references": [],
"isActivatedByVsmart": false
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/list/extcommunity": {
"get": {
"tags": [
"Configuration - Policy Extended Community List Builder"
],
"description": "Get policy lists",
"operationId": "getPolicyLists_ConfigurationPolicyExtendedCommunityListBuilder_3403",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"App Policy": {
"description": "App Policy",
"value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"
},
"Prefix List": {
"description": "Prefix List",
"value": {
"data": [
{
"listId": "8bc43c09-f72c-40b8-aa90-608c7005e607",
"name": "Example",
"type": "prefix",
"description": "Desc Not Required",
"entries": [
{
"ipPrefix": "10.0.0.0/24"
}
],
"lastUpdated": 1588178457305,
"owner": "admin",
"readOnly": false,
"version": "0",
"infoTag": "",
"referenceCount": 0,
"references": [],
"isActivatedByVsmart": false
}
]
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
},
"post": {
"tags": [
"Configuration - Policy Extended Community List Builder"
],
"description": "Create policy list",
"operationId": "createPolicyList_ConfigurationPolicyExtendedCommunityListBuilder_3404",
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Zone list": {
"description": "Zone list",
"value": {
"name": "Demo-Zone",
"description": "Desc Not Required",
"type": "zone",
"entries": [
{
"vpn": "10"
}
]
}
},
"IPS list": {
"description": "IPS list",
"value": {
"name": "Demo-IPS-list",
"description": "Desc Not Required",
"type": "ipssignature",
"entries": [
{
"generatorId": "1111",
"signatureId": "4444"
}
]
}
},
"URL white list": {
"description": "URL white list",
"value": {
"name": "Demo-Whitelist",
"description": "Desc Not Required",
"type": "urlwhitelist",
"entries": [
{
"pattern": "https://www.youtube.com"
}
]
}
},
"URL black list": {
"description": "URL black list",
"value": {
"name": "Demo-Black-list",
"description": "Desc Not Required",
"type": "urlblacklist",
"entries": [
{
"pattern": "www.facebook.com"
}
]
}
},
"TG API key list": {
"description": "TG API key list",
"value": {
"name": "threatGridApiKeyList",
"description": "",
"type": "threatGridApiKey",
"entries": [
{
"region": "nam",
"apikey": "1234567"
},
{
"region": "eur",
"apikey": "1234567"
}
]
}
},
"Local domain list": {
"description": "Local domain list",
"value": {
"name": "Demo-Domain-Name-List",
"description": "Desc Not Required",
"type": "localdomain",
"entries": [
{
"nameServer": "cisco.com"
}
]
}
},
"Umbrella data list": {
"description": "Umbrella data list",
"value": {
"name": "umbrellaTokenList",
"description": "",
"type": "umbrellaData",
"entries": [
{
"apiKey": "abcd",
"secret": "12345",
"umbOrgId": "23405",
"token": "abcedabcedabcedabcedabcedabcedabcedabced"
}
]
}
},
"App family": {
"description": "App family",
"value": {
"name": "Demo-App-List",
"description": "Desc Not Required",
"type": "app",
"entries": [
{
"appFamily": "web"
},
{
"appFamily": "audio-video"
}
]
}
},
"App list": {
"description": "App list",
"value": {
"name": "Demo-App-List",
"description": "Desc Not Required",
"type": "app",
"entries": [
{
"app": "facebook"
},
{
"app": "netshow"
}
]
}
},
"Color list": {
"description": "Color list",
"value": {
"name": "Demo-Color-List",
"description": "Desc Not Required",
"type": "color",
"entries": [
{
"color": "biz-internet"
},
{
"color": "public-internet"
}
]
}
},
"Data prefix": {
"description": "Data prefix",
"value": {
"name": "Demo-Data-Prefix-List",
"description": "Desc Not Required",
"type": "dataprefix",
"entries": [
{
"ipPrefix": "10.1.0.0/16"
},
{
"ipPrefix": "10.2.0.0/16"
}
]
}
},
"Policer": {
"description": "Policer",
"value": {
"name": "Demo-Policer-list",
"description": "Desc Not Required",
"type": "policer",
"entries": [
{
"burst": "16000",
"exceed": "drop",
"rate": "10000"
}
]
}
},
"Prefix": {
"description": "Prefix",
"value": {
"name": "Demo-Prefix-list",
"description": "Desc Not Required",
"type": "prefix",
"entries": [
{
"ipPrefix": "10.0.0.0/12",
"le": "32"
}
]
}
},
"Site": {
"description": "Site",
"value": {
"name": "Demo-Site-List",
"description": "Desc Not Required",
"type": "site",
"listId": null,
"entries": [
{
"siteId": "100"
},
{
"siteId": "200"
},
{
"siteId": "300-500"
}
]
}
},
"Class": {
"description": "Class",
"value": {
"name": "Demo-Class-Map",
"description": "Desc Not Required",
"type": "class",
"entries": [
{
"queue": "4"
}
]
}
},
"App probe": {
"description": "App probe",
"value": {
"name": "Demo-Probe-Class",
"type": "appProbe",
"entries": [
{
"map": [
{
"color": "biz-internet",
"dscp": 46
},
{
"color": "public-internet",
"dscp": 20
}
],
"forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70"
}
]
}
},
"SLA": {
"description": "SLA",
"value": {
"name": "Demo-SLA-Class",
"description": "Desc Not Required",
"type": "sla",
"entries": [
{
"latency": "100",
"loss": "10",
"jitter": "10",
"appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d"
}
]
}
},
"TLOC": {
"description": "TLOC",
"value": {
"name": "Demo-TLOC-List",
"description": "Desc Not Required",
"type": "tloc",
"entries": [
{
"tloc": "10.1.1.1",
"color": "biz-internet",
"encap": "ipsec",
"preference": "10"
},
{
"tloc": "10.2.2.2",
"color": "biz-internet",
"encap": "ipsec",
"preference": "20"
}
]
}
},
"VPN": {
"description": "VPN",
"value": {
"name": "Demo-VPN-List",
"description": "Desc Not Required",
"type": "vpn",
"listId": null,
"entries": [
{
"vpn": "100"
},
{
"vpn": "200"
},
{
"vpn": "300-500"
}
]
}
},
"AS path": {
"description": "AS path",
"value": {
"name": "Demo-AS-Path-List",
"description": "Desc Not Required",
"type": "aspath",
"listId": null,
"entries": [
{
"asPath": "100"
},
{
"asPath": "200"
},
{
"asPath": "65002"
}
]
}
},
"Community": {
"description": "Community",
"value": {
"name": "Demo-Community-List",
"description": "Desc Not Required",
"type": "community",
"listId": null,
"entries": [
{
"community": "1000:10000"
}
]
}
},
"Ext community": {
"description": "Ext community",
"value": {
"name": "Demo-Extended-Community-List",
"description": "Desc Not Required",
"type": "extcommunity",
"listId": null,
"entries": [
{
"community": "rt 100:10"
}
]
}
},
"Mirror": {
"description": "Mirror",
"value": {
"name": "Demo-Mirror-List",
"description": "Desc Not Required",
"type": "mirror",
"entries": [
{
"remoteDest": "10.1.1.1",
"source": "20.1.1.1"
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Task Id": {
"description": "Task Id",
"value": {
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6"
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"delete": {
"tags": [
"Configuration - Policy Extended Community List Builder"
],
"description": "Delete policy lists with specific info tag",
"operationId": "deletePolicyListsWithInfoTag_ConfigurationPolicyExtendedCommunityListBuilder_3406",
"parameters": [
{
"name": "infoTag",
"in": "query",
"description": "InfoTag",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/list/extcommunity/filtered": {
"get": {
"tags": [
"Configuration - Policy Extended Community List Builder"
],
"description": "Get policy lists with specific info tag",
"operationId": "getPolicyListsWithInfoTag_ConfigurationPolicyExtendedCommunityListBuilder_4303",
"parameters": [
{
"name": "infoTag",
"in": "query",
"description": "InfoTag",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/list/extcommunity/preview": {
"post": {
"tags": [
"Configuration - Policy Extended Community List Builder"
],
"description": "Preview a policy list based on the policy list type",
"operationId": "previewPolicyList_ConfigurationPolicyExtendedCommunityListBuilder_4204",
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy list": {
"description": "Policy list"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Preview policy list": {
"description": "Preview policy list",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/list/extcommunity/preview/{id}": {
"get": {
"tags": [
"Configuration - Policy Extended Community List Builder"
],
"description": "Preview a specific policy list entry based on id provided",
"operationId": "previewPolicyListById_ConfigurationPolicyExtendedCommunityListBuilder_4703",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Preview policy list": {
"description": "Preview policy list",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/list/extcommunity/{id}": {
"get": {
"tags": [
"Configuration - Policy Extended Community List Builder"
],
"description": "Get a specific policy list based on the id",
"operationId": "getListsById_ConfigurationPolicyExtendedCommunityListBuilder_3903",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy": {
"description": "Policy",
"value": {
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6",
"name": "Community",
"type": "community",
"description": "Desc Not Required",
"entries": [
{
"community": "1000:5000"
}
],
"lastUpdated": 1590184928436,
"owner": "admin",
"readOnly": false,
"version": "0",
"infoTag": "",
"referenceCount": 0,
"references": [],
"isActivatedByVsmart": false
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
},
"delete": {
"tags": [
"Configuration - Policy Extended Community List Builder"
],
"description": "Delete policy list entry for a specific type of policy list",
"operationId": "deletePolicyList_ConfigurationPolicyExtendedCommunityListBuilder_3906",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"put": {
"tags": [
"Configuration - Policy Extended Community List Builder"
],
"description": "Edit policy list entries for a specific type of policy list",
"operationId": "editPolicyList_ConfigurationPolicyExtendedCommunityListBuilder_3903",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": {
"name": "Community",
"description": "Desc Not Required",
"type": "community",
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6",
"entries": [
{
"community": "1000:8000"
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy": {
"description": "Policy",
"value": {
"masterTemplatesAffected": []
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/list/faxprotocol": {
"get": {
"tags": [
"Configuration - Policy Fax Protocol List Builder"
],
"description": "Get policy lists",
"operationId": "getPolicyLists_ConfigurationPolicyFaxProtocolListBuilder_3303",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"App Policy": {
"description": "App Policy",
"value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"
},
"Prefix List": {
"description": "Prefix List",
"value": {
"data": [
{
"listId": "8bc43c09-f72c-40b8-aa90-608c7005e607",
"name": "Example",
"type": "prefix",
"description": "Desc Not Required",
"entries": [
{
"ipPrefix": "10.0.0.0/24"
}
],
"lastUpdated": 1588178457305,
"owner": "admin",
"readOnly": false,
"version": "0",
"infoTag": "",
"referenceCount": 0,
"references": [],
"isActivatedByVsmart": false
}
]
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
},
"post": {
"tags": [
"Configuration - Policy Fax Protocol List Builder"
],
"description": "Create policy list",
"operationId": "createPolicyList_ConfigurationPolicyFaxProtocolListBuilder_3304",
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Zone list": {
"description": "Zone list",
"value": {
"name": "Demo-Zone",
"description": "Desc Not Required",
"type": "zone",
"entries": [
{
"vpn": "10"
}
]
}
},
"IPS list": {
"description": "IPS list",
"value": {
"name": "Demo-IPS-list",
"description": "Desc Not Required",
"type": "ipssignature",
"entries": [
{
"generatorId": "1111",
"signatureId": "4444"
}
]
}
},
"URL white list": {
"description": "URL white list",
"value": {
"name": "Demo-Whitelist",
"description": "Desc Not Required",
"type": "urlwhitelist",
"entries": [
{
"pattern": "https://www.youtube.com"
}
]
}
},
"URL black list": {
"description": "URL black list",
"value": {
"name": "Demo-Black-list",
"description": "Desc Not Required",
"type": "urlblacklist",
"entries": [
{
"pattern": "www.facebook.com"
}
]
}
},
"TG API key list": {
"description": "TG API key list",
"value": {
"name": "threatGridApiKeyList",
"description": "",
"type": "threatGridApiKey",
"entries": [
{
"region": "nam",
"apikey": "1234567"
},
{
"region": "eur",
"apikey": "1234567"
}
]
}
},
"Local domain list": {
"description": "Local domain list",
"value": {
"name": "Demo-Domain-Name-List",
"description": "Desc Not Required",
"type": "localdomain",
"entries": [
{
"nameServer": "cisco.com"
}
]
}
},
"Umbrella data list": {
"description": "Umbrella data list",
"value": {
"name": "umbrellaTokenList",
"description": "",
"type": "umbrellaData",
"entries": [
{
"apiKey": "abcd",
"secret": "12345",
"umbOrgId": "23405",
"token": "abcedabcedabcedabcedabcedabcedabcedabced"
}
]
}
},
"App family": {
"description": "App family",
"value": {
"name": "Demo-App-List",
"description": "Desc Not Required",
"type": "app",
"entries": [
{
"appFamily": "web"
},
{
"appFamily": "audio-video"
}
]
}
},
"App list": {
"description": "App list",
"value": {
"name": "Demo-App-List",
"description": "Desc Not Required",
"type": "app",
"entries": [
{
"app": "facebook"
},
{
"app": "netshow"
}
]
}
},
"Color list": {
"description": "Color list",
"value": {
"name": "Demo-Color-List",
"description": "Desc Not Required",
"type": "color",
"entries": [
{
"color": "biz-internet"
},
{
"color": "public-internet"
}
]
}
},
"Data prefix": {
"description": "Data prefix",
"value": {
"name": "Demo-Data-Prefix-List",
"description": "Desc Not Required",
"type": "dataprefix",
"entries": [
{
"ipPrefix": "10.1.0.0/16"
},
{
"ipPrefix": "10.2.0.0/16"
}
]
}
},
"Policer": {
"description": "Policer",
"value": {
"name": "Demo-Policer-list",
"description": "Desc Not Required",
"type": "policer",
"entries": [
{
"burst": "16000",
"exceed": "drop",
"rate": "10000"
}
]
}
},
"Prefix": {
"description": "Prefix",
"value": {
"name": "Demo-Prefix-list",
"description": "Desc Not Required",
"type": "prefix",
"entries": [
{
"ipPrefix": "10.0.0.0/12",
"le": "32"
}
]
}
},
"Site": {
"description": "Site",
"value": {
"name": "Demo-Site-List",
"description": "Desc Not Required",
"type": "site",
"listId": null,
"entries": [
{
"siteId": "100"
},
{
"siteId": "200"
},
{
"siteId": "300-500"
}
]
}
},
"Class": {
"description": "Class",
"value": {
"name": "Demo-Class-Map",
"description": "Desc Not Required",
"type": "class",
"entries": [
{
"queue": "4"
}
]
}
},
"App probe": {
"description": "App probe",
"value": {
"name": "Demo-Probe-Class",
"type": "appProbe",
"entries": [
{
"map": [
{
"color": "biz-internet",
"dscp": 46
},
{
"color": "public-internet",
"dscp": 20
}
],
"forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70"
}
]
}
},
"SLA": {
"description": "SLA",
"value": {
"name": "Demo-SLA-Class",
"description": "Desc Not Required",
"type": "sla",
"entries": [
{
"latency": "100",
"loss": "10",
"jitter": "10",
"appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d"
}
]
}
},
"TLOC": {
"description": "TLOC",
"value": {
"name": "Demo-TLOC-List",
"description": "Desc Not Required",
"type": "tloc",
"entries": [
{
"tloc": "10.1.1.1",
"color": "biz-internet",
"encap": "ipsec",
"preference": "10"
},
{
"tloc": "10.2.2.2",
"color": "biz-internet",
"encap": "ipsec",
"preference": "20"
}
]
}
},
"VPN": {
"description": "VPN",
"value": {
"name": "Demo-VPN-List",
"description": "Desc Not Required",
"type": "vpn",
"listId": null,
"entries": [
{
"vpn": "100"
},
{
"vpn": "200"
},
{
"vpn": "300-500"
}
]
}
},
"AS path": {
"description": "AS path",
"value": {
"name": "Demo-AS-Path-List",
"description": "Desc Not Required",
"type": "aspath",
"listId": null,
"entries": [
{
"asPath": "100"
},
{
"asPath": "200"
},
{
"asPath": "65002"
}
]
}
},
"Community": {
"description": "Community",
"value": {
"name": "Demo-Community-List",
"description": "Desc Not Required",
"type": "community",
"listId": null,
"entries": [
{
"community": "1000:10000"
}
]
}
},
"Ext community": {
"description": "Ext community",
"value": {
"name": "Demo-Extended-Community-List",
"description": "Desc Not Required",
"type": "extcommunity",
"listId": null,
"entries": [
{
"community": "rt 100:10"
}
]
}
},
"Mirror": {
"description": "Mirror",
"value": {
"name": "Demo-Mirror-List",
"description": "Desc Not Required",
"type": "mirror",
"entries": [
{
"remoteDest": "10.1.1.1",
"source": "20.1.1.1"
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Task Id": {
"description": "Task Id",
"value": {
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6"
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"delete": {
"tags": [
"Configuration - Policy Fax Protocol List Builder"
],
"description": "Delete policy lists with specific info tag",
"operationId": "deletePolicyListsWithInfoTag_ConfigurationPolicyFaxProtocolListBuilder_3306",
"parameters": [
{
"name": "infoTag",
"in": "query",
"description": "InfoTag",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/list/faxprotocol/filtered": {
"get": {
"tags": [
"Configuration - Policy Fax Protocol List Builder"
],
"description": "Get policy lists with specific info tag",
"operationId": "getPolicyListsWithInfoTag_ConfigurationPolicyFaxProtocolListBuilder_4203",
"parameters": [
{
"name": "infoTag",
"in": "query",
"description": "InfoTag",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/list/faxprotocol/preview": {
"post": {
"tags": [
"Configuration - Policy Fax Protocol List Builder"
],
"description": "Preview a policy list based on the policy list type",
"operationId": "previewPolicyList_ConfigurationPolicyFaxProtocolListBuilder_4104",
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy list": {
"description": "Policy list"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Preview policy list": {
"description": "Preview policy list",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/list/faxprotocol/preview/{id}": {
"get": {
"tags": [
"Configuration - Policy Fax Protocol List Builder"
],
"description": "Preview a specific policy list entry based on id provided",
"operationId": "previewPolicyListById_ConfigurationPolicyFaxProtocolListBuilder_4603",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Preview policy list": {
"description": "Preview policy list",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/list/faxprotocol/{id}": {
"put": {
"tags": [
"Configuration - Policy Fax Protocol List Builder"
],
"description": "Edit policy list entries for a specific type of policy list",
"operationId": "editPolicyList_ConfigurationPolicyFaxProtocolListBuilder_3803",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": {
"name": "Community",
"description": "Desc Not Required",
"type": "community",
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6",
"entries": [
{
"community": "1000:8000"
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy": {
"description": "Policy",
"value": {
"masterTemplatesAffected": []
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"get": {
"tags": [
"Configuration - Policy Fax Protocol List Builder"
],
"description": "Get a specific policy list based on the id",
"operationId": "getListsById_ConfigurationPolicyFaxProtocolListBuilder_3803",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy": {
"description": "Policy",
"value": {
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6",
"name": "Community",
"type": "community",
"description": "Desc Not Required",
"entries": [
{
"community": "1000:5000"
}
],
"lastUpdated": 1590184928436,
"owner": "admin",
"readOnly": false,
"version": "0",
"infoTag": "",
"referenceCount": 0,
"references": [],
"isActivatedByVsmart": false
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
},
"delete": {
"tags": [
"Configuration - Policy Fax Protocol List Builder"
],
"description": "Delete policy list entry for a specific type of policy list",
"operationId": "deletePolicyList_ConfigurationPolicyFaxProtocolListBuilder_3806",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/list/fqdn": {
"get": {
"tags": [
"Configuration - FQDN List Builder"
],
"description": "Get policy lists",
"operationId": "getPolicyLists_ConfigurationFqdnListBuilder_2603",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"App Policy": {
"description": "App Policy",
"value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"
},
"Prefix List": {
"description": "Prefix List",
"value": {
"data": [
{
"listId": "8bc43c09-f72c-40b8-aa90-608c7005e607",
"name": "Example",
"type": "prefix",
"description": "Desc Not Required",
"entries": [
{
"ipPrefix": "10.0.0.0/24"
}
],
"lastUpdated": 1588178457305,
"owner": "admin",
"readOnly": false,
"version": "0",
"infoTag": "",
"referenceCount": 0,
"references": [],
"isActivatedByVsmart": false
}
]
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
},
"post": {
"tags": [
"Configuration - FQDN List Builder"
],
"description": "Create policy list",
"operationId": "createPolicyList_ConfigurationFqdnListBuilder_2604",
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Zone list": {
"description": "Zone list",
"value": {
"name": "Demo-Zone",
"description": "Desc Not Required",
"type": "zone",
"entries": [
{
"vpn": "10"
}
]
}
},
"IPS list": {
"description": "IPS list",
"value": {
"name": "Demo-IPS-list",
"description": "Desc Not Required",
"type": "ipssignature",
"entries": [
{
"generatorId": "1111",
"signatureId": "4444"
}
]
}
},
"URL white list": {
"description": "URL white list",
"value": {
"name": "Demo-Whitelist",
"description": "Desc Not Required",
"type": "urlwhitelist",
"entries": [
{
"pattern": "https://www.youtube.com"
}
]
}
},
"URL black list": {
"description": "URL black list",
"value": {
"name": "Demo-Black-list",
"description": "Desc Not Required",
"type": "urlblacklist",
"entries": [
{
"pattern": "www.facebook.com"
}
]
}
},
"TG API key list": {
"description": "TG API key list",
"value": {
"name": "threatGridApiKeyList",
"description": "",
"type": "threatGridApiKey",
"entries": [
{
"region": "nam",
"apikey": "1234567"
},
{
"region": "eur",
"apikey": "1234567"
}
]
}
},
"Local domain list": {
"description": "Local domain list",
"value": {
"name": "Demo-Domain-Name-List",
"description": "Desc Not Required",
"type": "localdomain",
"entries": [
{
"nameServer": "cisco.com"
}
]
}
},
"Umbrella data list": {
"description": "Umbrella data list",
"value": {
"name": "umbrellaTokenList",
"description": "",
"type": "umbrellaData",
"entries": [
{
"apiKey": "abcd",
"secret": "12345",
"umbOrgId": "23405",
"token": "abcedabcedabcedabcedabcedabcedabcedabced"
}
]
}
},
"App family": {
"description": "App family",
"value": {
"name": "Demo-App-List",
"description": "Desc Not Required",
"type": "app",
"entries": [
{
"appFamily": "web"
},
{
"appFamily": "audio-video"
}
]
}
},
"App list": {
"description": "App list",
"value": {
"name": "Demo-App-List",
"description": "Desc Not Required",
"type": "app",
"entries": [
{
"app": "facebook"
},
{
"app": "netshow"
}
]
}
},
"Color list": {
"description": "Color list",
"value": {
"name": "Demo-Color-List",
"description": "Desc Not Required",
"type": "color",
"entries": [
{
"color": "biz-internet"
},
{
"color": "public-internet"
}
]
}
},
"Data prefix": {
"description": "Data prefix",
"value": {
"name": "Demo-Data-Prefix-List",
"description": "Desc Not Required",
"type": "dataprefix",
"entries": [
{
"ipPrefix": "10.1.0.0/16"
},
{
"ipPrefix": "10.2.0.0/16"
}
]
}
},
"Policer": {
"description": "Policer",
"value": {
"name": "Demo-Policer-list",
"description": "Desc Not Required",
"type": "policer",
"entries": [
{
"burst": "16000",
"exceed": "drop",
"rate": "10000"
}
]
}
},
"Prefix": {
"description": "Prefix",
"value": {
"name": "Demo-Prefix-list",
"description": "Desc Not Required",
"type": "prefix",
"entries": [
{
"ipPrefix": "10.0.0.0/12",
"le": "32"
}
]
}
},
"Site": {
"description": "Site",
"value": {
"name": "Demo-Site-List",
"description": "Desc Not Required",
"type": "site",
"listId": null,
"entries": [
{
"siteId": "100"
},
{
"siteId": "200"
},
{
"siteId": "300-500"
}
]
}
},
"Class": {
"description": "Class",
"value": {
"name": "Demo-Class-Map",
"description": "Desc Not Required",
"type": "class",
"entries": [
{
"queue": "4"
}
]
}
},
"App probe": {
"description": "App probe",
"value": {
"name": "Demo-Probe-Class",
"type": "appProbe",
"entries": [
{
"map": [
{
"color": "biz-internet",
"dscp": 46
},
{
"color": "public-internet",
"dscp": 20
}
],
"forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70"
}
]
}
},
"SLA": {
"description": "SLA",
"value": {
"name": "Demo-SLA-Class",
"description": "Desc Not Required",
"type": "sla",
"entries": [
{
"latency": "100",
"loss": "10",
"jitter": "10",
"appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d"
}
]
}
},
"TLOC": {
"description": "TLOC",
"value": {
"name": "Demo-TLOC-List",
"description": "Desc Not Required",
"type": "tloc",
"entries": [
{
"tloc": "10.1.1.1",
"color": "biz-internet",
"encap": "ipsec",
"preference": "10"
},
{
"tloc": "10.2.2.2",
"color": "biz-internet",
"encap": "ipsec",
"preference": "20"
}
]
}
},
"VPN": {
"description": "VPN",
"value": {
"name": "Demo-VPN-List",
"description": "Desc Not Required",
"type": "vpn",
"listId": null,
"entries": [
{
"vpn": "100"
},
{
"vpn": "200"
},
{
"vpn": "300-500"
}
]
}
},
"AS path": {
"description": "AS path",
"value": {
"name": "Demo-AS-Path-List",
"description": "Desc Not Required",
"type": "aspath",
"listId": null,
"entries": [
{
"asPath": "100"
},
{
"asPath": "200"
},
{
"asPath": "65002"
}
]
}
},
"Community": {
"description": "Community",
"value": {
"name": "Demo-Community-List",
"description": "Desc Not Required",
"type": "community",
"listId": null,
"entries": [
{
"community": "1000:10000"
}
]
}
},
"Ext community": {
"description": "Ext community",
"value": {
"name": "Demo-Extended-Community-List",
"description": "Desc Not Required",
"type": "extcommunity",
"listId": null,
"entries": [
{
"community": "rt 100:10"
}
]
}
},
"Mirror": {
"description": "Mirror",
"value": {
"name": "Demo-Mirror-List",
"description": "Desc Not Required",
"type": "mirror",
"entries": [
{
"remoteDest": "10.1.1.1",
"source": "20.1.1.1"
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Task Id": {
"description": "Task Id",
"value": {
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6"
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"delete": {
"tags": [
"Configuration - FQDN List Builder"
],
"description": "Delete policy lists with specific info tag",
"operationId": "deletePolicyListsWithInfoTag_ConfigurationFqdnListBuilder_2606",
"parameters": [
{
"name": "infoTag",
"in": "query",
"description": "InfoTag",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/list/fqdn/filtered": {
"get": {
"tags": [
"Configuration - FQDN List Builder"
],
"description": "Get policy lists with specific info tag",
"operationId": "getPolicyListsWithInfoTag_ConfigurationFqdnListBuilder_3503",
"parameters": [
{
"name": "infoTag",
"in": "query",
"description": "InfoTag",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/list/fqdn/preview": {
"post": {
"tags": [
"Configuration - FQDN List Builder"
],
"description": "Preview a policy list based on the policy list type",
"operationId": "previewPolicyList_ConfigurationFqdnListBuilder_3404",
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy list": {
"description": "Policy list"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Preview policy list": {
"description": "Preview policy list",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/list/fqdn/preview/{id}": {
"get": {
"tags": [
"Configuration - FQDN List Builder"
],
"description": "Preview a specific policy list entry based on id provided",
"operationId": "previewPolicyListById_ConfigurationFqdnListBuilder_3903",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Preview policy list": {
"description": "Preview policy list",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/list/fqdn/{id}": {
"put": {
"tags": [
"Configuration - FQDN List Builder"
],
"description": "Edit policy list entries for a specific type of policy list",
"operationId": "editPolicyList_ConfigurationFqdnListBuilder_3103",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": {
"name": "Community",
"description": "Desc Not Required",
"type": "community",
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6",
"entries": [
{
"community": "1000:8000"
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy": {
"description": "Policy",
"value": {
"masterTemplatesAffected": []
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"delete": {
"tags": [
"Configuration - FQDN List Builder"
],
"description": "Delete policy list entry for a specific type of policy list",
"operationId": "deletePolicyList_ConfigurationFqdnListBuilder_3106",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"get": {
"tags": [
"Configuration - FQDN List Builder"
],
"description": "Get a specific policy list based on the id",
"operationId": "getListsById_ConfigurationFqdnListBuilder_3103",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy": {
"description": "Policy",
"value": {
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6",
"name": "Community",
"type": "community",
"description": "Desc Not Required",
"entries": [
{
"community": "1000:5000"
}
],
"lastUpdated": 1590184928436,
"owner": "admin",
"readOnly": false,
"version": "0",
"infoTag": "",
"referenceCount": 0,
"references": [],
"isActivatedByVsmart": false
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/list/geolocation": {
"get": {
"tags": [
"Configuration - Policy Geo Location List Builder"
],
"description": "Get policy lists",
"operationId": "getPolicyLists_ConfigurationPolicyGeoLocationListBuilder_3303",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"App Policy": {
"description": "App Policy",
"value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"
},
"Prefix List": {
"description": "Prefix List",
"value": {
"data": [
{
"listId": "8bc43c09-f72c-40b8-aa90-608c7005e607",
"name": "Example",
"type": "prefix",
"description": "Desc Not Required",
"entries": [
{
"ipPrefix": "10.0.0.0/24"
}
],
"lastUpdated": 1588178457305,
"owner": "admin",
"readOnly": false,
"version": "0",
"infoTag": "",
"referenceCount": 0,
"references": [],
"isActivatedByVsmart": false
}
]
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
},
"post": {
"tags": [
"Configuration - Policy Geo Location List Builder"
],
"description": "Create policy list",
"operationId": "createPolicyList_ConfigurationPolicyGeoLocationListBuilder_3304",
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Zone list": {
"description": "Zone list",
"value": {
"name": "Demo-Zone",
"description": "Desc Not Required",
"type": "zone",
"entries": [
{
"vpn": "10"
}
]
}
},
"IPS list": {
"description": "IPS list",
"value": {
"name": "Demo-IPS-list",
"description": "Desc Not Required",
"type": "ipssignature",
"entries": [
{
"generatorId": "1111",
"signatureId": "4444"
}
]
}
},
"URL white list": {
"description": "URL white list",
"value": {
"name": "Demo-Whitelist",
"description": "Desc Not Required",
"type": "urlwhitelist",
"entries": [
{
"pattern": "https://www.youtube.com"
}
]
}
},
"URL black list": {
"description": "URL black list",
"value": {
"name": "Demo-Black-list",
"description": "Desc Not Required",
"type": "urlblacklist",
"entries": [
{
"pattern": "www.facebook.com"
}
]
}
},
"TG API key list": {
"description": "TG API key list",
"value": {
"name": "threatGridApiKeyList",
"description": "",
"type": "threatGridApiKey",
"entries": [
{
"region": "nam",
"apikey": "1234567"
},
{
"region": "eur",
"apikey": "1234567"
}
]
}
},
"Local domain list": {
"description": "Local domain list",
"value": {
"name": "Demo-Domain-Name-List",
"description": "Desc Not Required",
"type": "localdomain",
"entries": [
{
"nameServer": "cisco.com"
}
]
}
},
"Umbrella data list": {
"description": "Umbrella data list",
"value": {
"name": "umbrellaTokenList",
"description": "",
"type": "umbrellaData",
"entries": [
{
"apiKey": "abcd",
"secret": "12345",
"umbOrgId": "23405",
"token": "abcedabcedabcedabcedabcedabcedabcedabced"
}
]
}
},
"App family": {
"description": "App family",
"value": {
"name": "Demo-App-List",
"description": "Desc Not Required",
"type": "app",
"entries": [
{
"appFamily": "web"
},
{
"appFamily": "audio-video"
}
]
}
},
"App list": {
"description": "App list",
"value": {
"name": "Demo-App-List",
"description": "Desc Not Required",
"type": "app",
"entries": [
{
"app": "facebook"
},
{
"app": "netshow"
}
]
}
},
"Color list": {
"description": "Color list",
"value": {
"name": "Demo-Color-List",
"description": "Desc Not Required",
"type": "color",
"entries": [
{
"color": "biz-internet"
},
{
"color": "public-internet"
}
]
}
},
"Data prefix": {
"description": "Data prefix",
"value": {
"name": "Demo-Data-Prefix-List",
"description": "Desc Not Required",
"type": "dataprefix",
"entries": [
{
"ipPrefix": "10.1.0.0/16"
},
{
"ipPrefix": "10.2.0.0/16"
}
]
}
},
"Policer": {
"description": "Policer",
"value": {
"name": "Demo-Policer-list",
"description": "Desc Not Required",
"type": "policer",
"entries": [
{
"burst": "16000",
"exceed": "drop",
"rate": "10000"
}
]
}
},
"Prefix": {
"description": "Prefix",
"value": {
"name": "Demo-Prefix-list",
"description": "Desc Not Required",
"type": "prefix",
"entries": [
{
"ipPrefix": "10.0.0.0/12",
"le": "32"
}
]
}
},
"Site": {
"description": "Site",
"value": {
"name": "Demo-Site-List",
"description": "Desc Not Required",
"type": "site",
"listId": null,
"entries": [
{
"siteId": "100"
},
{
"siteId": "200"
},
{
"siteId": "300-500"
}
]
}
},
"Class": {
"description": "Class",
"value": {
"name": "Demo-Class-Map",
"description": "Desc Not Required",
"type": "class",
"entries": [
{
"queue": "4"
}
]
}
},
"App probe": {
"description": "App probe",
"value": {
"name": "Demo-Probe-Class",
"type": "appProbe",
"entries": [
{
"map": [
{
"color": "biz-internet",
"dscp": 46
},
{
"color": "public-internet",
"dscp": 20
}
],
"forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70"
}
]
}
},
"SLA": {
"description": "SLA",
"value": {
"name": "Demo-SLA-Class",
"description": "Desc Not Required",
"type": "sla",
"entries": [
{
"latency": "100",
"loss": "10",
"jitter": "10",
"appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d"
}
]
}
},
"TLOC": {
"description": "TLOC",
"value": {
"name": "Demo-TLOC-List",
"description": "Desc Not Required",
"type": "tloc",
"entries": [
{
"tloc": "10.1.1.1",
"color": "biz-internet",
"encap": "ipsec",
"preference": "10"
},
{
"tloc": "10.2.2.2",
"color": "biz-internet",
"encap": "ipsec",
"preference": "20"
}
]
}
},
"VPN": {
"description": "VPN",
"value": {
"name": "Demo-VPN-List",
"description": "Desc Not Required",
"type": "vpn",
"listId": null,
"entries": [
{
"vpn": "100"
},
{
"vpn": "200"
},
{
"vpn": "300-500"
}
]
}
},
"AS path": {
"description": "AS path",
"value": {
"name": "Demo-AS-Path-List",
"description": "Desc Not Required",
"type": "aspath",
"listId": null,
"entries": [
{
"asPath": "100"
},
{
"asPath": "200"
},
{
"asPath": "65002"
}
]
}
},
"Community": {
"description": "Community",
"value": {
"name": "Demo-Community-List",
"description": "Desc Not Required",
"type": "community",
"listId": null,
"entries": [
{
"community": "1000:10000"
}
]
}
},
"Ext community": {
"description": "Ext community",
"value": {
"name": "Demo-Extended-Community-List",
"description": "Desc Not Required",
"type": "extcommunity",
"listId": null,
"entries": [
{
"community": "rt 100:10"
}
]
}
},
"Mirror": {
"description": "Mirror",
"value": {
"name": "Demo-Mirror-List",
"description": "Desc Not Required",
"type": "mirror",
"entries": [
{
"remoteDest": "10.1.1.1",
"source": "20.1.1.1"
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Task Id": {
"description": "Task Id",
"value": {
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6"
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"delete": {
"tags": [
"Configuration - Policy Geo Location List Builder"
],
"description": "Delete policy lists with specific info tag",
"operationId": "deletePolicyListsWithInfoTag_ConfigurationPolicyGeoLocationListBuilder_3306",
"parameters": [
{
"name": "infoTag",
"in": "query",
"description": "InfoTag",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/list/geolocation/entries": {
"get": {
"tags": [
"Configuration - Policy Geo Location List Builder"
],
"description": "Get list of countries and continents for geo location",
"operationId": "getGeoLocationLists",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy": {
"description": "Policy",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/list/geolocation/filtered": {
"get": {
"tags": [
"Configuration - Policy Geo Location List Builder"
],
"description": "Get policy lists with specific info tag",
"operationId": "getPolicyListsWithInfoTag_ConfigurationPolicyGeoLocationListBuilder_4203",
"parameters": [
{
"name": "infoTag",
"in": "query",
"description": "InfoTag",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/list/geolocation/preview": {
"post": {
"tags": [
"Configuration - Policy Geo Location List Builder"
],
"description": "Preview a policy list based on the policy list type",
"operationId": "previewPolicyList_ConfigurationPolicyGeoLocationListBuilder_4104",
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy list": {
"description": "Policy list"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Preview policy list": {
"description": "Preview policy list",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/list/geolocation/preview/{id}": {
"get": {
"tags": [
"Configuration - Policy Geo Location List Builder"
],
"description": "Preview a specific policy list entry based on id provided",
"operationId": "previewPolicyListById_ConfigurationPolicyGeoLocationListBuilder_4603",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Preview policy list": {
"description": "Preview policy list",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/list/geolocation/{id}": {
"put": {
"tags": [
"Configuration - Policy Geo Location List Builder"
],
"description": "Edit policy list entries for a specific type of policy list",
"operationId": "editPolicyList_ConfigurationPolicyGeoLocationListBuilder_3803",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": {
"name": "Community",
"description": "Desc Not Required",
"type": "community",
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6",
"entries": [
{
"community": "1000:8000"
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy": {
"description": "Policy",
"value": {
"masterTemplatesAffected": []
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"get": {
"tags": [
"Configuration - Policy Geo Location List Builder"
],
"description": "Get a specific policy list based on the id",
"operationId": "getListsById_ConfigurationPolicyGeoLocationListBuilder_3803",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy": {
"description": "Policy",
"value": {
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6",
"name": "Community",
"type": "community",
"description": "Desc Not Required",
"entries": [
{
"community": "1000:5000"
}
],
"lastUpdated": 1590184928436,
"owner": "admin",
"readOnly": false,
"version": "0",
"infoTag": "",
"referenceCount": 0,
"references": [],
"isActivatedByVsmart": false
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
},
"delete": {
"tags": [
"Configuration - Policy Geo Location List Builder"
],
"description": "Delete policy list entry for a specific type of policy list",
"operationId": "deletePolicyList_ConfigurationPolicyGeoLocationListBuilder_3806",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/list/identity": {
"get": {
"tags": [
"Configuration - Policy Identity List Builder"
],
"description": "Get policy lists",
"operationId": "getPolicyLists_ConfigurationPolicyIdentityListBuilder_3003",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"App Policy": {
"description": "App Policy",
"value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"
},
"Prefix List": {
"description": "Prefix List",
"value": {
"data": [
{
"listId": "8bc43c09-f72c-40b8-aa90-608c7005e607",
"name": "Example",
"type": "prefix",
"description": "Desc Not Required",
"entries": [
{
"ipPrefix": "10.0.0.0/24"
}
],
"lastUpdated": 1588178457305,
"owner": "admin",
"readOnly": false,
"version": "0",
"infoTag": "",
"referenceCount": 0,
"references": [],
"isActivatedByVsmart": false
}
]
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
},
"delete": {
"tags": [
"Configuration - Policy Identity List Builder"
],
"description": "Delete policy lists with specific info tag",
"operationId": "deletePolicyListsWithInfoTag_ConfigurationPolicyIdentityListBuilder_3006",
"parameters": [
{
"name": "infoTag",
"in": "query",
"description": "InfoTag",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
},
"post": {
"tags": [
"Configuration - Policy Identity List Builder"
],
"description": "Create policy list",
"operationId": "createPolicyList_ConfigurationPolicyIdentityListBuilder_3004",
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Zone list": {
"description": "Zone list",
"value": {
"name": "Demo-Zone",
"description": "Desc Not Required",
"type": "zone",
"entries": [
{
"vpn": "10"
}
]
}
},
"IPS list": {
"description": "IPS list",
"value": {
"name": "Demo-IPS-list",
"description": "Desc Not Required",
"type": "ipssignature",
"entries": [
{
"generatorId": "1111",
"signatureId": "4444"
}
]
}
},
"URL white list": {
"description": "URL white list",
"value": {
"name": "Demo-Whitelist",
"description": "Desc Not Required",
"type": "urlwhitelist",
"entries": [
{
"pattern": "https://www.youtube.com"
}
]
}
},
"URL black list": {
"description": "URL black list",
"value": {
"name": "Demo-Black-list",
"description": "Desc Not Required",
"type": "urlblacklist",
"entries": [
{
"pattern": "www.facebook.com"
}
]
}
},
"TG API key list": {
"description": "TG API key list",
"value": {
"name": "threatGridApiKeyList",
"description": "",
"type": "threatGridApiKey",
"entries": [
{
"region": "nam",
"apikey": "1234567"
},
{
"region": "eur",
"apikey": "1234567"
}
]
}
},
"Local domain list": {
"description": "Local domain list",
"value": {
"name": "Demo-Domain-Name-List",
"description": "Desc Not Required",
"type": "localdomain",
"entries": [
{
"nameServer": "cisco.com"
}
]
}
},
"Umbrella data list": {
"description": "Umbrella data list",
"value": {
"name": "umbrellaTokenList",
"description": "",
"type": "umbrellaData",
"entries": [
{
"apiKey": "abcd",
"secret": "12345",
"umbOrgId": "23405",
"token": "abcedabcedabcedabcedabcedabcedabcedabced"
}
]
}
},
"App family": {
"description": "App family",
"value": {
"name": "Demo-App-List",
"description": "Desc Not Required",
"type": "app",
"entries": [
{
"appFamily": "web"
},
{
"appFamily": "audio-video"
}
]
}
},
"App list": {
"description": "App list",
"value": {
"name": "Demo-App-List",
"description": "Desc Not Required",
"type": "app",
"entries": [
{
"app": "facebook"
},
{
"app": "netshow"
}
]
}
},
"Color list": {
"description": "Color list",
"value": {
"name": "Demo-Color-List",
"description": "Desc Not Required",
"type": "color",
"entries": [
{
"color": "biz-internet"
},
{
"color": "public-internet"
}
]
}
},
"Data prefix": {
"description": "Data prefix",
"value": {
"name": "Demo-Data-Prefix-List",
"description": "Desc Not Required",
"type": "dataprefix",
"entries": [
{
"ipPrefix": "10.1.0.0/16"
},
{
"ipPrefix": "10.2.0.0/16"
}
]
}
},
"Policer": {
"description": "Policer",
"value": {
"name": "Demo-Policer-list",
"description": "Desc Not Required",
"type": "policer",
"entries": [
{
"burst": "16000",
"exceed": "drop",
"rate": "10000"
}
]
}
},
"Prefix": {
"description": "Prefix",
"value": {
"name": "Demo-Prefix-list",
"description": "Desc Not Required",
"type": "prefix",
"entries": [
{
"ipPrefix": "10.0.0.0/12",
"le": "32"
}
]
}
},
"Site": {
"description": "Site",
"value": {
"name": "Demo-Site-List",
"description": "Desc Not Required",
"type": "site",
"listId": null,
"entries": [
{
"siteId": "100"
},
{
"siteId": "200"
},
{
"siteId": "300-500"
}
]
}
},
"Class": {
"description": "Class",
"value": {
"name": "Demo-Class-Map",
"description": "Desc Not Required",
"type": "class",
"entries": [
{
"queue": "4"
}
]
}
},
"App probe": {
"description": "App probe",
"value": {
"name": "Demo-Probe-Class",
"type": "appProbe",
"entries": [
{
"map": [
{
"color": "biz-internet",
"dscp": 46
},
{
"color": "public-internet",
"dscp": 20
}
],
"forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70"
}
]
}
},
"SLA": {
"description": "SLA",
"value": {
"name": "Demo-SLA-Class",
"description": "Desc Not Required",
"type": "sla",
"entries": [
{
"latency": "100",
"loss": "10",
"jitter": "10",
"appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d"
}
]
}
},
"TLOC": {
"description": "TLOC",
"value": {
"name": "Demo-TLOC-List",
"description": "Desc Not Required",
"type": "tloc",
"entries": [
{
"tloc": "10.1.1.1",
"color": "biz-internet",
"encap": "ipsec",
"preference": "10"
},
{
"tloc": "10.2.2.2",
"color": "biz-internet",
"encap": "ipsec",
"preference": "20"
}
]
}
},
"VPN": {
"description": "VPN",
"value": {
"name": "Demo-VPN-List",
"description": "Desc Not Required",
"type": "vpn",
"listId": null,
"entries": [
{
"vpn": "100"
},
{
"vpn": "200"
},
{
"vpn": "300-500"
}
]
}
},
"AS path": {
"description": "AS path",
"value": {
"name": "Demo-AS-Path-List",
"description": "Desc Not Required",
"type": "aspath",
"listId": null,
"entries": [
{
"asPath": "100"
},
{
"asPath": "200"
},
{
"asPath": "65002"
}
]
}
},
"Community": {
"description": "Community",
"value": {
"name": "Demo-Community-List",
"description": "Desc Not Required",
"type": "community",
"listId": null,
"entries": [
{
"community": "1000:10000"
}
]
}
},
"Ext community": {
"description": "Ext community",
"value": {
"name": "Demo-Extended-Community-List",
"description": "Desc Not Required",
"type": "extcommunity",
"listId": null,
"entries": [
{
"community": "rt 100:10"
}
]
}
},
"Mirror": {
"description": "Mirror",
"value": {
"name": "Demo-Mirror-List",
"description": "Desc Not Required",
"type": "mirror",
"entries": [
{
"remoteDest": "10.1.1.1",
"source": "20.1.1.1"
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Task Id": {
"description": "Task Id",
"value": {
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6"
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/list/identity/filtered": {
"get": {
"tags": [
"Configuration - Policy Identity List Builder"
],
"description": "Get policy lists with specific info tag",
"operationId": "getPolicyListsWithInfoTag_ConfigurationPolicyIdentityListBuilder_3903",
"parameters": [
{
"name": "infoTag",
"in": "query",
"description": "InfoTag",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/list/identity/preview": {
"post": {
"tags": [
"Configuration - Policy Identity List Builder"
],
"description": "Preview a policy list based on the policy list type",
"operationId": "previewPolicyList_ConfigurationPolicyIdentityListBuilder_3804",
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy list": {
"description": "Policy list"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Preview policy list": {
"description": "Preview policy list",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/list/identity/preview/{id}": {
"get": {
"tags": [
"Configuration - Policy Identity List Builder"
],
"description": "Preview a specific policy list entry based on id provided",
"operationId": "previewPolicyListById_ConfigurationPolicyIdentityListBuilder_4303",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Preview policy list": {
"description": "Preview policy list",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/list/identity/{id}": {
"get": {
"tags": [
"Configuration - Policy Identity List Builder"
],
"description": "Get a specific policy list based on the id",
"operationId": "getListsById_ConfigurationPolicyIdentityListBuilder_3503",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy": {
"description": "Policy",
"value": {
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6",
"name": "Community",
"type": "community",
"description": "Desc Not Required",
"entries": [
{
"community": "1000:5000"
}
],
"lastUpdated": 1590184928436,
"owner": "admin",
"readOnly": false,
"version": "0",
"infoTag": "",
"referenceCount": 0,
"references": [],
"isActivatedByVsmart": false
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
},
"put": {
"tags": [
"Configuration - Policy Identity List Builder"
],
"description": "Edit policy list entries for a specific type of policy list",
"operationId": "editPolicyList_ConfigurationPolicyIdentityListBuilder_3503",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": {
"name": "Community",
"description": "Desc Not Required",
"type": "community",
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6",
"entries": [
{
"community": "1000:8000"
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy": {
"description": "Policy",
"value": {
"masterTemplatesAffected": []
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"delete": {
"tags": [
"Configuration - Policy Identity List Builder"
],
"description": "Delete policy list entry for a specific type of policy list",
"operationId": "deletePolicyList_ConfigurationPolicyIdentityListBuilder_3506",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/list/ipprefixall": {
"get": {
"tags": [
"Configuration - Policy Prefix for All Types of Lists Builder"
],
"description": "Get lists for all prefixes",
"operationId": "getListsForAllPrefixes",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Prefixes": {
"description": "Prefixes",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
},
"delete": {
"tags": [
"Configuration - Policy Prefix for All Types of Lists Builder"
],
"description": "Delete policy lists with specific info tag",
"operationId": "deletePolicyListsWithInfoTag_ConfigurationPolicyPrefixForAllTypesOfListsBuilder_3306",
"parameters": [
{
"name": "infoTag",
"in": "query",
"description": "InfoTag",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
},
"post": {
"tags": [
"Configuration - Policy Prefix for All Types of Lists Builder"
],
"description": "Create policy list",
"operationId": "createPolicyList_ConfigurationPolicyPrefixForAllTypesOfListsBuilder_3304",
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Zone list": {
"description": "Zone list",
"value": {
"name": "Demo-Zone",
"description": "Desc Not Required",
"type": "zone",
"entries": [
{
"vpn": "10"
}
]
}
},
"IPS list": {
"description": "IPS list",
"value": {
"name": "Demo-IPS-list",
"description": "Desc Not Required",
"type": "ipssignature",
"entries": [
{
"generatorId": "1111",
"signatureId": "4444"
}
]
}
},
"URL white list": {
"description": "URL white list",
"value": {
"name": "Demo-Whitelist",
"description": "Desc Not Required",
"type": "urlwhitelist",
"entries": [
{
"pattern": "https://www.youtube.com"
}
]
}
},
"URL black list": {
"description": "URL black list",
"value": {
"name": "Demo-Black-list",
"description": "Desc Not Required",
"type": "urlblacklist",
"entries": [
{
"pattern": "www.facebook.com"
}
]
}
},
"TG API key list": {
"description": "TG API key list",
"value": {
"name": "threatGridApiKeyList",
"description": "",
"type": "threatGridApiKey",
"entries": [
{
"region": "nam",
"apikey": "1234567"
},
{
"region": "eur",
"apikey": "1234567"
}
]
}
},
"Local domain list": {
"description": "Local domain list",
"value": {
"name": "Demo-Domain-Name-List",
"description": "Desc Not Required",
"type": "localdomain",
"entries": [
{
"nameServer": "cisco.com"
}
]
}
},
"Umbrella data list": {
"description": "Umbrella data list",
"value": {
"name": "umbrellaTokenList",
"description": "",
"type": "umbrellaData",
"entries": [
{
"apiKey": "abcd",
"secret": "12345",
"umbOrgId": "23405",
"token": "abcedabcedabcedabcedabcedabcedabcedabced"
}
]
}
},
"App family": {
"description": "App family",
"value": {
"name": "Demo-App-List",
"description": "Desc Not Required",
"type": "app",
"entries": [
{
"appFamily": "web"
},
{
"appFamily": "audio-video"
}
]
}
},
"App list": {
"description": "App list",
"value": {
"name": "Demo-App-List",
"description": "Desc Not Required",
"type": "app",
"entries": [
{
"app": "facebook"
},
{
"app": "netshow"
}
]
}
},
"Color list": {
"description": "Color list",
"value": {
"name": "Demo-Color-List",
"description": "Desc Not Required",
"type": "color",
"entries": [
{
"color": "biz-internet"
},
{
"color": "public-internet"
}
]
}
},
"Data prefix": {
"description": "Data prefix",
"value": {
"name": "Demo-Data-Prefix-List",
"description": "Desc Not Required",
"type": "dataprefix",
"entries": [
{
"ipPrefix": "10.1.0.0/16"
},
{
"ipPrefix": "10.2.0.0/16"
}
]
}
},
"Policer": {
"description": "Policer",
"value": {
"name": "Demo-Policer-list",
"description": "Desc Not Required",
"type": "policer",
"entries": [
{
"burst": "16000",
"exceed": "drop",
"rate": "10000"
}
]
}
},
"Prefix": {
"description": "Prefix",
"value": {
"name": "Demo-Prefix-list",
"description": "Desc Not Required",
"type": "prefix",
"entries": [
{
"ipPrefix": "10.0.0.0/12",
"le": "32"
}
]
}
},
"Site": {
"description": "Site",
"value": {
"name": "Demo-Site-List",
"description": "Desc Not Required",
"type": "site",
"listId": null,
"entries": [
{
"siteId": "100"
},
{
"siteId": "200"
},
{
"siteId": "300-500"
}
]
}
},
"Class": {
"description": "Class",
"value": {
"name": "Demo-Class-Map",
"description": "Desc Not Required",
"type": "class",
"entries": [
{
"queue": "4"
}
]
}
},
"App probe": {
"description": "App probe",
"value": {
"name": "Demo-Probe-Class",
"type": "appProbe",
"entries": [
{
"map": [
{
"color": "biz-internet",
"dscp": 46
},
{
"color": "public-internet",
"dscp": 20
}
],
"forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70"
}
]
}
},
"SLA": {
"description": "SLA",
"value": {
"name": "Demo-SLA-Class",
"description": "Desc Not Required",
"type": "sla",
"entries": [
{
"latency": "100",
"loss": "10",
"jitter": "10",
"appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d"
}
]
}
},
"TLOC": {
"description": "TLOC",
"value": {
"name": "Demo-TLOC-List",
"description": "Desc Not Required",
"type": "tloc",
"entries": [
{
"tloc": "10.1.1.1",
"color": "biz-internet",
"encap": "ipsec",
"preference": "10"
},
{
"tloc": "10.2.2.2",
"color": "biz-internet",
"encap": "ipsec",
"preference": "20"
}
]
}
},
"VPN": {
"description": "VPN",
"value": {
"name": "Demo-VPN-List",
"description": "Desc Not Required",
"type": "vpn",
"listId": null,
"entries": [
{
"vpn": "100"
},
{
"vpn": "200"
},
{
"vpn": "300-500"
}
]
}
},
"AS path": {
"description": "AS path",
"value": {
"name": "Demo-AS-Path-List",
"description": "Desc Not Required",
"type": "aspath",
"listId": null,
"entries": [
{
"asPath": "100"
},
{
"asPath": "200"
},
{
"asPath": "65002"
}
]
}
},
"Community": {
"description": "Community",
"value": {
"name": "Demo-Community-List",
"description": "Desc Not Required",
"type": "community",
"listId": null,
"entries": [
{
"community": "1000:10000"
}
]
}
},
"Ext community": {
"description": "Ext community",
"value": {
"name": "Demo-Extended-Community-List",
"description": "Desc Not Required",
"type": "extcommunity",
"listId": null,
"entries": [
{
"community": "rt 100:10"
}
]
}
},
"Mirror": {
"description": "Mirror",
"value": {
"name": "Demo-Mirror-List",
"description": "Desc Not Required",
"type": "mirror",
"entries": [
{
"remoteDest": "10.1.1.1",
"source": "20.1.1.1"
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Task Id": {
"description": "Task Id",
"value": {
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6"
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/list/ipprefixall/filtered": {
"get": {
"tags": [
"Configuration - Policy Prefix for All Types of Lists Builder"
],
"description": "Get policy lists with specific info tag",
"operationId": "getPolicyListsWithInfoTag_ConfigurationPolicyPrefixForAllTypesOfListsBuilder_4203",
"parameters": [
{
"name": "infoTag",
"in": "query",
"description": "InfoTag",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/list/ipprefixall/preview": {
"post": {
"tags": [
"Configuration - Policy Prefix for All Types of Lists Builder"
],
"description": "Preview a policy list based on the policy list type",
"operationId": "previewPolicyList_ConfigurationPolicyPrefixForAllTypesOfListsBuilder_4104",
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy list": {
"description": "Policy list"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Preview policy list": {
"description": "Preview policy list",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/list/ipprefixall/preview/{id}": {
"get": {
"tags": [
"Configuration - Policy Prefix for All Types of Lists Builder"
],
"description": "Preview a specific policy list entry based on id provided",
"operationId": "previewPolicyListById_ConfigurationPolicyPrefixForAllTypesOfListsBuilder_4603",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Preview policy list": {
"description": "Preview policy list",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/list/ipprefixall/{id}": {
"get": {
"tags": [
"Configuration - Policy Prefix for All Types of Lists Builder"
],
"description": "Get a specific policy list based on the id",
"operationId": "getListsById_ConfigurationPolicyPrefixForAllTypesOfListsBuilder_3803",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy": {
"description": "Policy",
"value": {
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6",
"name": "Community",
"type": "community",
"description": "Desc Not Required",
"entries": [
{
"community": "1000:5000"
}
],
"lastUpdated": 1590184928436,
"owner": "admin",
"readOnly": false,
"version": "0",
"infoTag": "",
"referenceCount": 0,
"references": [],
"isActivatedByVsmart": false
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
},
"put": {
"tags": [
"Configuration - Policy Prefix for All Types of Lists Builder"
],
"description": "Edit policy list entries for a specific type of policy list",
"operationId": "editPolicyList_ConfigurationPolicyPrefixForAllTypesOfListsBuilder_3803",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": {
"name": "Community",
"description": "Desc Not Required",
"type": "community",
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6",
"entries": [
{
"community": "1000:8000"
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy": {
"description": "Policy",
"value": {
"masterTemplatesAffected": []
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"delete": {
"tags": [
"Configuration - Policy Prefix for All Types of Lists Builder"
],
"description": "Delete policy list entry for a specific type of policy list",
"operationId": "deletePolicyList_ConfigurationPolicyPrefixForAllTypesOfListsBuilder_3806",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/list/ipssignature": {
"get": {
"tags": [
"Configuration - Policy IPS Signature List Builder"
],
"description": "Get policy lists",
"operationId": "getPolicyLists_ConfigurationPolicyIpsSignatureListBuilder_3403",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"App Policy": {
"description": "App Policy",
"value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"
},
"Prefix List": {
"description": "Prefix List",
"value": {
"data": [
{
"listId": "8bc43c09-f72c-40b8-aa90-608c7005e607",
"name": "Example",
"type": "prefix",
"description": "Desc Not Required",
"entries": [
{
"ipPrefix": "10.0.0.0/24"
}
],
"lastUpdated": 1588178457305,
"owner": "admin",
"readOnly": false,
"version": "0",
"infoTag": "",
"referenceCount": 0,
"references": [],
"isActivatedByVsmart": false
}
]
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
},
"post": {
"tags": [
"Configuration - Policy IPS Signature List Builder"
],
"description": "Create policy list",
"operationId": "createPolicyList_ConfigurationPolicyIpsSignatureListBuilder_3404",
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Zone list": {
"description": "Zone list",
"value": {
"name": "Demo-Zone",
"description": "Desc Not Required",
"type": "zone",
"entries": [
{
"vpn": "10"
}
]
}
},
"IPS list": {
"description": "IPS list",
"value": {
"name": "Demo-IPS-list",
"description": "Desc Not Required",
"type": "ipssignature",
"entries": [
{
"generatorId": "1111",
"signatureId": "4444"
}
]
}
},
"URL white list": {
"description": "URL white list",
"value": {
"name": "Demo-Whitelist",
"description": "Desc Not Required",
"type": "urlwhitelist",
"entries": [
{
"pattern": "https://www.youtube.com"
}
]
}
},
"URL black list": {
"description": "URL black list",
"value": {
"name": "Demo-Black-list",
"description": "Desc Not Required",
"type": "urlblacklist",
"entries": [
{
"pattern": "www.facebook.com"
}
]
}
},
"TG API key list": {
"description": "TG API key list",
"value": {
"name": "threatGridApiKeyList",
"description": "",
"type": "threatGridApiKey",
"entries": [
{
"region": "nam",
"apikey": "1234567"
},
{
"region": "eur",
"apikey": "1234567"
}
]
}
},
"Local domain list": {
"description": "Local domain list",
"value": {
"name": "Demo-Domain-Name-List",
"description": "Desc Not Required",
"type": "localdomain",
"entries": [
{
"nameServer": "cisco.com"
}
]
}
},
"Umbrella data list": {
"description": "Umbrella data list",
"value": {
"name": "umbrellaTokenList",
"description": "",
"type": "umbrellaData",
"entries": [
{
"apiKey": "abcd",
"secret": "12345",
"umbOrgId": "23405",
"token": "abcedabcedabcedabcedabcedabcedabcedabced"
}
]
}
},
"App family": {
"description": "App family",
"value": {
"name": "Demo-App-List",
"description": "Desc Not Required",
"type": "app",
"entries": [
{
"appFamily": "web"
},
{
"appFamily": "audio-video"
}
]
}
},
"App list": {
"description": "App list",
"value": {
"name": "Demo-App-List",
"description": "Desc Not Required",
"type": "app",
"entries": [
{
"app": "facebook"
},
{
"app": "netshow"
}
]
}
},
"Color list": {
"description": "Color list",
"value": {
"name": "Demo-Color-List",
"description": "Desc Not Required",
"type": "color",
"entries": [
{
"color": "biz-internet"
},
{
"color": "public-internet"
}
]
}
},
"Data prefix": {
"description": "Data prefix",
"value": {
"name": "Demo-Data-Prefix-List",
"description": "Desc Not Required",
"type": "dataprefix",
"entries": [
{
"ipPrefix": "10.1.0.0/16"
},
{
"ipPrefix": "10.2.0.0/16"
}
]
}
},
"Policer": {
"description": "Policer",
"value": {
"name": "Demo-Policer-list",
"description": "Desc Not Required",
"type": "policer",
"entries": [
{
"burst": "16000",
"exceed": "drop",
"rate": "10000"
}
]
}
},
"Prefix": {
"description": "Prefix",
"value": {
"name": "Demo-Prefix-list",
"description": "Desc Not Required",
"type": "prefix",
"entries": [
{
"ipPrefix": "10.0.0.0/12",
"le": "32"
}
]
}
},
"Site": {
"description": "Site",
"value": {
"name": "Demo-Site-List",
"description": "Desc Not Required",
"type": "site",
"listId": null,
"entries": [
{
"siteId": "100"
},
{
"siteId": "200"
},
{
"siteId": "300-500"
}
]
}
},
"Class": {
"description": "Class",
"value": {
"name": "Demo-Class-Map",
"description": "Desc Not Required",
"type": "class",
"entries": [
{
"queue": "4"
}
]
}
},
"App probe": {
"description": "App probe",
"value": {
"name": "Demo-Probe-Class",
"type": "appProbe",
"entries": [
{
"map": [
{
"color": "biz-internet",
"dscp": 46
},
{
"color": "public-internet",
"dscp": 20
}
],
"forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70"
}
]
}
},
"SLA": {
"description": "SLA",
"value": {
"name": "Demo-SLA-Class",
"description": "Desc Not Required",
"type": "sla",
"entries": [
{
"latency": "100",
"loss": "10",
"jitter": "10",
"appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d"
}
]
}
},
"TLOC": {
"description": "TLOC",
"value": {
"name": "Demo-TLOC-List",
"description": "Desc Not Required",
"type": "tloc",
"entries": [
{
"tloc": "10.1.1.1",
"color": "biz-internet",
"encap": "ipsec",
"preference": "10"
},
{
"tloc": "10.2.2.2",
"color": "biz-internet",
"encap": "ipsec",
"preference": "20"
}
]
}
},
"VPN": {
"description": "VPN",
"value": {
"name": "Demo-VPN-List",
"description": "Desc Not Required",
"type": "vpn",
"listId": null,
"entries": [
{
"vpn": "100"
},
{
"vpn": "200"
},
{
"vpn": "300-500"
}
]
}
},
"AS path": {
"description": "AS path",
"value": {
"name": "Demo-AS-Path-List",
"description": "Desc Not Required",
"type": "aspath",
"listId": null,
"entries": [
{
"asPath": "100"
},
{
"asPath": "200"
},
{
"asPath": "65002"
}
]
}
},
"Community": {
"description": "Community",
"value": {
"name": "Demo-Community-List",
"description": "Desc Not Required",
"type": "community",
"listId": null,
"entries": [
{
"community": "1000:10000"
}
]
}
},
"Ext community": {
"description": "Ext community",
"value": {
"name": "Demo-Extended-Community-List",
"description": "Desc Not Required",
"type": "extcommunity",
"listId": null,
"entries": [
{
"community": "rt 100:10"
}
]
}
},
"Mirror": {
"description": "Mirror",
"value": {
"name": "Demo-Mirror-List",
"description": "Desc Not Required",
"type": "mirror",
"entries": [
{
"remoteDest": "10.1.1.1",
"source": "20.1.1.1"
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Task Id": {
"description": "Task Id",
"value": {
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6"
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"delete": {
"tags": [
"Configuration - Policy IPS Signature List Builder"
],
"description": "Delete policy lists with specific info tag",
"operationId": "deletePolicyListsWithInfoTag_ConfigurationPolicyIpsSignatureListBuilder_3406",
"parameters": [
{
"name": "infoTag",
"in": "query",
"description": "InfoTag",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/list/ipssignature/filtered": {
"get": {
"tags": [
"Configuration - Policy IPS Signature List Builder"
],
"description": "Get policy lists with specific info tag",
"operationId": "getPolicyListsWithInfoTag_ConfigurationPolicyIpsSignatureListBuilder_4303",
"parameters": [
{
"name": "infoTag",
"in": "query",
"description": "InfoTag",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/list/ipssignature/preview": {
"post": {
"tags": [
"Configuration - Policy IPS Signature List Builder"
],
"description": "Preview a policy list based on the policy list type",
"operationId": "previewPolicyList_ConfigurationPolicyIpsSignatureListBuilder_4204",
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy list": {
"description": "Policy list"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Preview policy list": {
"description": "Preview policy list",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/list/ipssignature/preview/{id}": {
"get": {
"tags": [
"Configuration - Policy IPS Signature List Builder"
],
"description": "Preview a specific policy list entry based on id provided",
"operationId": "previewPolicyListById_ConfigurationPolicyIpsSignatureListBuilder_4703",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Preview policy list": {
"description": "Preview policy list",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/list/ipssignature/{id}": {
"get": {
"tags": [
"Configuration - Policy IPS Signature List Builder"
],
"description": "Get a specific policy list based on the id",
"operationId": "getListsById_ConfigurationPolicyIpsSignatureListBuilder_3903",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy": {
"description": "Policy",
"value": {
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6",
"name": "Community",
"type": "community",
"description": "Desc Not Required",
"entries": [
{
"community": "1000:5000"
}
],
"lastUpdated": 1590184928436,
"owner": "admin",
"readOnly": false,
"version": "0",
"infoTag": "",
"referenceCount": 0,
"references": [],
"isActivatedByVsmart": false
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
},
"put": {
"tags": [
"Configuration - Policy IPS Signature List Builder"
],
"description": "Edit policy list entries for a specific type of policy list",
"operationId": "editPolicyList_ConfigurationPolicyIpsSignatureListBuilder_3903",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": {
"name": "Community",
"description": "Desc Not Required",
"type": "community",
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6",
"entries": [
{
"community": "1000:8000"
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy": {
"description": "Policy",
"value": {
"masterTemplatesAffected": []
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"delete": {
"tags": [
"Configuration - Policy IPS Signature List Builder"
],
"description": "Delete policy list entry for a specific type of policy list",
"operationId": "deletePolicyList_ConfigurationPolicyIpsSignatureListBuilder_3906",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/list/ipv6prefix": {
"get": {
"tags": [
"Configuration - Policy IPv6 Prefix List Builder"
],
"description": "Get policy lists",
"operationId": "getPolicyLists_ConfigurationPolicyIpv6PrefixListBuilder_3203",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"App Policy": {
"description": "App Policy",
"value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"
},
"Prefix List": {
"description": "Prefix List",
"value": {
"data": [
{
"listId": "8bc43c09-f72c-40b8-aa90-608c7005e607",
"name": "Example",
"type": "prefix",
"description": "Desc Not Required",
"entries": [
{
"ipPrefix": "10.0.0.0/24"
}
],
"lastUpdated": 1588178457305,
"owner": "admin",
"readOnly": false,
"version": "0",
"infoTag": "",
"referenceCount": 0,
"references": [],
"isActivatedByVsmart": false
}
]
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
},
"post": {
"tags": [
"Configuration - Policy IPv6 Prefix List Builder"
],
"description": "Create policy list",
"operationId": "createPolicyList_ConfigurationPolicyIpv6PrefixListBuilder_3204",
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Zone list": {
"description": "Zone list",
"value": {
"name": "Demo-Zone",
"description": "Desc Not Required",
"type": "zone",
"entries": [
{
"vpn": "10"
}
]
}
},
"IPS list": {
"description": "IPS list",
"value": {
"name": "Demo-IPS-list",
"description": "Desc Not Required",
"type": "ipssignature",
"entries": [
{
"generatorId": "1111",
"signatureId": "4444"
}
]
}
},
"URL white list": {
"description": "URL white list",
"value": {
"name": "Demo-Whitelist",
"description": "Desc Not Required",
"type": "urlwhitelist",
"entries": [
{
"pattern": "https://www.youtube.com"
}
]
}
},
"URL black list": {
"description": "URL black list",
"value": {
"name": "Demo-Black-list",
"description": "Desc Not Required",
"type": "urlblacklist",
"entries": [
{
"pattern": "www.facebook.com"
}
]
}
},
"TG API key list": {
"description": "TG API key list",
"value": {
"name": "threatGridApiKeyList",
"description": "",
"type": "threatGridApiKey",
"entries": [
{
"region": "nam",
"apikey": "1234567"
},
{
"region": "eur",
"apikey": "1234567"
}
]
}
},
"Local domain list": {
"description": "Local domain list",
"value": {
"name": "Demo-Domain-Name-List",
"description": "Desc Not Required",
"type": "localdomain",
"entries": [
{
"nameServer": "cisco.com"
}
]
}
},
"Umbrella data list": {
"description": "Umbrella data list",
"value": {
"name": "umbrellaTokenList",
"description": "",
"type": "umbrellaData",
"entries": [
{
"apiKey": "abcd",
"secret": "12345",
"umbOrgId": "23405",
"token": "abcedabcedabcedabcedabcedabcedabcedabced"
}
]
}
},
"App family": {
"description": "App family",
"value": {
"name": "Demo-App-List",
"description": "Desc Not Required",
"type": "app",
"entries": [
{
"appFamily": "web"
},
{
"appFamily": "audio-video"
}
]
}
},
"App list": {
"description": "App list",
"value": {
"name": "Demo-App-List",
"description": "Desc Not Required",
"type": "app",
"entries": [
{
"app": "facebook"
},
{
"app": "netshow"
}
]
}
},
"Color list": {
"description": "Color list",
"value": {
"name": "Demo-Color-List",
"description": "Desc Not Required",
"type": "color",
"entries": [
{
"color": "biz-internet"
},
{
"color": "public-internet"
}
]
}
},
"Data prefix": {
"description": "Data prefix",
"value": {
"name": "Demo-Data-Prefix-List",
"description": "Desc Not Required",
"type": "dataprefix",
"entries": [
{
"ipPrefix": "10.1.0.0/16"
},
{
"ipPrefix": "10.2.0.0/16"
}
]
}
},
"Policer": {
"description": "Policer",
"value": {
"name": "Demo-Policer-list",
"description": "Desc Not Required",
"type": "policer",
"entries": [
{
"burst": "16000",
"exceed": "drop",
"rate": "10000"
}
]
}
},
"Prefix": {
"description": "Prefix",
"value": {
"name": "Demo-Prefix-list",
"description": "Desc Not Required",
"type": "prefix",
"entries": [
{
"ipPrefix": "10.0.0.0/12",
"le": "32"
}
]
}
},
"Site": {
"description": "Site",
"value": {
"name": "Demo-Site-List",
"description": "Desc Not Required",
"type": "site",
"listId": null,
"entries": [
{
"siteId": "100"
},
{
"siteId": "200"
},
{
"siteId": "300-500"
}
]
}
},
"Class": {
"description": "Class",
"value": {
"name": "Demo-Class-Map",
"description": "Desc Not Required",
"type": "class",
"entries": [
{
"queue": "4"
}
]
}
},
"App probe": {
"description": "App probe",
"value": {
"name": "Demo-Probe-Class",
"type": "appProbe",
"entries": [
{
"map": [
{
"color": "biz-internet",
"dscp": 46
},
{
"color": "public-internet",
"dscp": 20
}
],
"forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70"
}
]
}
},
"SLA": {
"description": "SLA",
"value": {
"name": "Demo-SLA-Class",
"description": "Desc Not Required",
"type": "sla",
"entries": [
{
"latency": "100",
"loss": "10",
"jitter": "10",
"appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d"
}
]
}
},
"TLOC": {
"description": "TLOC",
"value": {
"name": "Demo-TLOC-List",
"description": "Desc Not Required",
"type": "tloc",
"entries": [
{
"tloc": "10.1.1.1",
"color": "biz-internet",
"encap": "ipsec",
"preference": "10"
},
{
"tloc": "10.2.2.2",
"color": "biz-internet",
"encap": "ipsec",
"preference": "20"
}
]
}
},
"VPN": {
"description": "VPN",
"value": {
"name": "Demo-VPN-List",
"description": "Desc Not Required",
"type": "vpn",
"listId": null,
"entries": [
{
"vpn": "100"
},
{
"vpn": "200"
},
{
"vpn": "300-500"
}
]
}
},
"AS path": {
"description": "AS path",
"value": {
"name": "Demo-AS-Path-List",
"description": "Desc Not Required",
"type": "aspath",
"listId": null,
"entries": [
{
"asPath": "100"
},
{
"asPath": "200"
},
{
"asPath": "65002"
}
]
}
},
"Community": {
"description": "Community",
"value": {
"name": "Demo-Community-List",
"description": "Desc Not Required",
"type": "community",
"listId": null,
"entries": [
{
"community": "1000:10000"
}
]
}
},
"Ext community": {
"description": "Ext community",
"value": {
"name": "Demo-Extended-Community-List",
"description": "Desc Not Required",
"type": "extcommunity",
"listId": null,
"entries": [
{
"community": "rt 100:10"
}
]
}
},
"Mirror": {
"description": "Mirror",
"value": {
"name": "Demo-Mirror-List",
"description": "Desc Not Required",
"type": "mirror",
"entries": [
{
"remoteDest": "10.1.1.1",
"source": "20.1.1.1"
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Task Id": {
"description": "Task Id",
"value": {
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6"
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"delete": {
"tags": [
"Configuration - Policy IPv6 Prefix List Builder"
],
"description": "Delete policy lists with specific info tag",
"operationId": "deletePolicyListsWithInfoTag_ConfigurationPolicyIpv6PrefixListBuilder_3206",
"parameters": [
{
"name": "infoTag",
"in": "query",
"description": "InfoTag",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/list/ipv6prefix/filtered": {
"get": {
"tags": [
"Configuration - Policy IPv6 Prefix List Builder"
],
"description": "Get policy lists with specific info tag",
"operationId": "getPolicyListsWithInfoTag_ConfigurationPolicyIpv6PrefixListBuilder_4103",
"parameters": [
{
"name": "infoTag",
"in": "query",
"description": "InfoTag",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/list/ipv6prefix/preview": {
"post": {
"tags": [
"Configuration - Policy IPv6 Prefix List Builder"
],
"description": "Preview a policy list based on the policy list type",
"operationId": "previewPolicyList_ConfigurationPolicyIpv6PrefixListBuilder_4004",
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy list": {
"description": "Policy list"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Preview policy list": {
"description": "Preview policy list",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/list/ipv6prefix/preview/{id}": {
"get": {
"tags": [
"Configuration - Policy IPv6 Prefix List Builder"
],
"description": "Preview a specific policy list entry based on id provided",
"operationId": "previewPolicyListById_ConfigurationPolicyIpv6PrefixListBuilder_4503",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Preview policy list": {
"description": "Preview policy list",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/list/ipv6prefix/{id}": {
"get": {
"tags": [
"Configuration - Policy IPv6 Prefix List Builder"
],
"description": "Get a specific policy list based on the id",
"operationId": "getListsById_ConfigurationPolicyIpv6PrefixListBuilder_3703",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy": {
"description": "Policy",
"value": {
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6",
"name": "Community",
"type": "community",
"description": "Desc Not Required",
"entries": [
{
"community": "1000:5000"
}
],
"lastUpdated": 1590184928436,
"owner": "admin",
"readOnly": false,
"version": "0",
"infoTag": "",
"referenceCount": 0,
"references": [],
"isActivatedByVsmart": false
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
},
"delete": {
"tags": [
"Configuration - Policy IPv6 Prefix List Builder"
],
"description": "Delete policy list entry for a specific type of policy list",
"operationId": "deletePolicyList_ConfigurationPolicyIpv6PrefixListBuilder_3706",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"put": {
"tags": [
"Configuration - Policy IPv6 Prefix List Builder"
],
"description": "Edit policy list entries for a specific type of policy list",
"operationId": "editPolicyList_ConfigurationPolicyIpv6PrefixListBuilder_3703",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": {
"name": "Community",
"description": "Desc Not Required",
"type": "community",
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6",
"entries": [
{
"community": "1000:8000"
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy": {
"description": "Policy",
"value": {
"masterTemplatesAffected": []
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/list/localapp": {
"post": {
"tags": [
"Configuration - Policy Application List Builder"
],
"description": "Create policy list",
"operationId": "createPolicyList_ConfigurationPolicyApplicationListBuilder_3004",
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Zone list": {
"description": "Zone list",
"value": {
"name": "Demo-Zone",
"description": "Desc Not Required",
"type": "zone",
"entries": [
{
"vpn": "10"
}
]
}
},
"IPS list": {
"description": "IPS list",
"value": {
"name": "Demo-IPS-list",
"description": "Desc Not Required",
"type": "ipssignature",
"entries": [
{
"generatorId": "1111",
"signatureId": "4444"
}
]
}
},
"URL white list": {
"description": "URL white list",
"value": {
"name": "Demo-Whitelist",
"description": "Desc Not Required",
"type": "urlwhitelist",
"entries": [
{
"pattern": "https://www.youtube.com"
}
]
}
},
"URL black list": {
"description": "URL black list",
"value": {
"name": "Demo-Black-list",
"description": "Desc Not Required",
"type": "urlblacklist",
"entries": [
{
"pattern": "www.facebook.com"
}
]
}
},
"TG API key list": {
"description": "TG API key list",
"value": {
"name": "threatGridApiKeyList",
"description": "",
"type": "threatGridApiKey",
"entries": [
{
"region": "nam",
"apikey": "1234567"
},
{
"region": "eur",
"apikey": "1234567"
}
]
}
},
"Local domain list": {
"description": "Local domain list",
"value": {
"name": "Demo-Domain-Name-List",
"description": "Desc Not Required",
"type": "localdomain",
"entries": [
{
"nameServer": "cisco.com"
}
]
}
},
"Umbrella data list": {
"description": "Umbrella data list",
"value": {
"name": "umbrellaTokenList",
"description": "",
"type": "umbrellaData",
"entries": [
{
"apiKey": "abcd",
"secret": "12345",
"umbOrgId": "23405",
"token": "abcedabcedabcedabcedabcedabcedabcedabced"
}
]
}
},
"App family": {
"description": "App family",
"value": {
"name": "Demo-App-List",
"description": "Desc Not Required",
"type": "app",
"entries": [
{
"appFamily": "web"
},
{
"appFamily": "audio-video"
}
]
}
},
"App list": {
"description": "App list",
"value": {
"name": "Demo-App-List",
"description": "Desc Not Required",
"type": "app",
"entries": [
{
"app": "facebook"
},
{
"app": "netshow"
}
]
}
},
"Color list": {
"description": "Color list",
"value": {
"name": "Demo-Color-List",
"description": "Desc Not Required",
"type": "color",
"entries": [
{
"color": "biz-internet"
},
{
"color": "public-internet"
}
]
}
},
"Data prefix": {
"description": "Data prefix",
"value": {
"name": "Demo-Data-Prefix-List",
"description": "Desc Not Required",
"type": "dataprefix",
"entries": [
{
"ipPrefix": "10.1.0.0/16"
},
{
"ipPrefix": "10.2.0.0/16"
}
]
}
},
"Policer": {
"description": "Policer",
"value": {
"name": "Demo-Policer-list",
"description": "Desc Not Required",
"type": "policer",
"entries": [
{
"burst": "16000",
"exceed": "drop",
"rate": "10000"
}
]
}
},
"Prefix": {
"description": "Prefix",
"value": {
"name": "Demo-Prefix-list",
"description": "Desc Not Required",
"type": "prefix",
"entries": [
{
"ipPrefix": "10.0.0.0/12",
"le": "32"
}
]
}
},
"Site": {
"description": "Site",
"value": {
"name": "Demo-Site-List",
"description": "Desc Not Required",
"type": "site",
"listId": null,
"entries": [
{
"siteId": "100"
},
{
"siteId": "200"
},
{
"siteId": "300-500"
}
]
}
},
"Class": {
"description": "Class",
"value": {
"name": "Demo-Class-Map",
"description": "Desc Not Required",
"type": "class",
"entries": [
{
"queue": "4"
}
]
}
},
"App probe": {
"description": "App probe",
"value": {
"name": "Demo-Probe-Class",
"type": "appProbe",
"entries": [
{
"map": [
{
"color": "biz-internet",
"dscp": 46
},
{
"color": "public-internet",
"dscp": 20
}
],
"forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70"
}
]
}
},
"SLA": {
"description": "SLA",
"value": {
"name": "Demo-SLA-Class",
"description": "Desc Not Required",
"type": "sla",
"entries": [
{
"latency": "100",
"loss": "10",
"jitter": "10",
"appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d"
}
]
}
},
"TLOC": {
"description": "TLOC",
"value": {
"name": "Demo-TLOC-List",
"description": "Desc Not Required",
"type": "tloc",
"entries": [
{
"tloc": "10.1.1.1",
"color": "biz-internet",
"encap": "ipsec",
"preference": "10"
},
{
"tloc": "10.2.2.2",
"color": "biz-internet",
"encap": "ipsec",
"preference": "20"
}
]
}
},
"VPN": {
"description": "VPN",
"value": {
"name": "Demo-VPN-List",
"description": "Desc Not Required",
"type": "vpn",
"listId": null,
"entries": [
{
"vpn": "100"
},
{
"vpn": "200"
},
{
"vpn": "300-500"
}
]
}
},
"AS path": {
"description": "AS path",
"value": {
"name": "Demo-AS-Path-List",
"description": "Desc Not Required",
"type": "aspath",
"listId": null,
"entries": [
{
"asPath": "100"
},
{
"asPath": "200"
},
{
"asPath": "65002"
}
]
}
},
"Community": {
"description": "Community",
"value": {
"name": "Demo-Community-List",
"description": "Desc Not Required",
"type": "community",
"listId": null,
"entries": [
{
"community": "1000:10000"
}
]
}
},
"Ext community": {
"description": "Ext community",
"value": {
"name": "Demo-Extended-Community-List",
"description": "Desc Not Required",
"type": "extcommunity",
"listId": null,
"entries": [
{
"community": "rt 100:10"
}
]
}
},
"Mirror": {
"description": "Mirror",
"value": {
"name": "Demo-Mirror-List",
"description": "Desc Not Required",
"type": "mirror",
"entries": [
{
"remoteDest": "10.1.1.1",
"source": "20.1.1.1"
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Task Id": {
"description": "Task Id",
"value": {
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6"
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"get": {
"tags": [
"Configuration - Policy Application List Builder"
],
"description": "Get policy lists",
"operationId": "getPolicyLists_ConfigurationPolicyApplicationListBuilder_3003",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"App Policy": {
"description": "App Policy",
"value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"
},
"Prefix List": {
"description": "Prefix List",
"value": {
"data": [
{
"listId": "8bc43c09-f72c-40b8-aa90-608c7005e607",
"name": "Example",
"type": "prefix",
"description": "Desc Not Required",
"entries": [
{
"ipPrefix": "10.0.0.0/24"
}
],
"lastUpdated": 1588178457305,
"owner": "admin",
"readOnly": false,
"version": "0",
"infoTag": "",
"referenceCount": 0,
"references": [],
"isActivatedByVsmart": false
}
]
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
},
"delete": {
"tags": [
"Configuration - Policy Application List Builder"
],
"description": "Delete policy lists with specific info tag",
"operationId": "deletePolicyListsWithInfoTag_ConfigurationPolicyApplicationListBuilder_3006",
"parameters": [
{
"name": "infoTag",
"in": "query",
"description": "InfoTag",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/list/localapp/filtered": {
"get": {
"tags": [
"Configuration - Policy Application List Builder"
],
"description": "Get policy lists with specific info tag",
"operationId": "getPolicyListsWithInfoTag_ConfigurationPolicyApplicationListBuilder_3903",
"parameters": [
{
"name": "infoTag",
"in": "query",
"description": "InfoTag",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/list/localapp/preview": {
"post": {
"tags": [
"Configuration - Policy Application List Builder"
],
"description": "Preview a policy list based on the policy list type",
"operationId": "previewPolicyList_ConfigurationPolicyApplicationListBuilder_3804",
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy list": {
"description": "Policy list"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Preview policy list": {
"description": "Preview policy list",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/list/localapp/preview/{id}": {
"get": {
"tags": [
"Configuration - Policy Application List Builder"
],
"description": "Preview a specific policy list entry based on id provided",
"operationId": "previewPolicyListById_ConfigurationPolicyApplicationListBuilder_4303",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Preview policy list": {
"description": "Preview policy list",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/list/localapp/{id}": {
"delete": {
"tags": [
"Configuration - Policy Application List Builder"
],
"description": "Delete policy list entry for a specific type of policy list",
"operationId": "deletePolicyList_ConfigurationPolicyApplicationListBuilder_3506",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"put": {
"tags": [
"Configuration - Policy Application List Builder"
],
"description": "Edit policy list entries for a specific type of policy list",
"operationId": "editPolicyList_ConfigurationPolicyApplicationListBuilder_3503",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": {
"name": "Community",
"description": "Desc Not Required",
"type": "community",
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6",
"entries": [
{
"community": "1000:8000"
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy": {
"description": "Policy",
"value": {
"masterTemplatesAffected": []
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"get": {
"tags": [
"Configuration - Policy Application List Builder"
],
"description": "Get a specific policy list based on the id",
"operationId": "getListsById_ConfigurationPolicyApplicationListBuilder_3503",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy": {
"description": "Policy",
"value": {
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6",
"name": "Community",
"type": "community",
"description": "Desc Not Required",
"entries": [
{
"community": "1000:5000"
}
],
"lastUpdated": 1590184928436,
"owner": "admin",
"readOnly": false,
"version": "0",
"infoTag": "",
"referenceCount": 0,
"references": [],
"isActivatedByVsmart": false
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/list/localdomain": {
"get": {
"tags": [
"Configuration - Policy Local Domain Name List Builder"
],
"description": "Get policy lists",
"operationId": "getPolicyLists_ConfigurationPolicyLocalDomainNameListBuilder_3303",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"App Policy": {
"description": "App Policy",
"value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"
},
"Prefix List": {
"description": "Prefix List",
"value": {
"data": [
{
"listId": "8bc43c09-f72c-40b8-aa90-608c7005e607",
"name": "Example",
"type": "prefix",
"description": "Desc Not Required",
"entries": [
{
"ipPrefix": "10.0.0.0/24"
}
],
"lastUpdated": 1588178457305,
"owner": "admin",
"readOnly": false,
"version": "0",
"infoTag": "",
"referenceCount": 0,
"references": [],
"isActivatedByVsmart": false
}
]
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
},
"post": {
"tags": [
"Configuration - Policy Local Domain Name List Builder"
],
"description": "Create policy list",
"operationId": "createPolicyList_ConfigurationPolicyLocalDomainNameListBuilder_3304",
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Zone list": {
"description": "Zone list",
"value": {
"name": "Demo-Zone",
"description": "Desc Not Required",
"type": "zone",
"entries": [
{
"vpn": "10"
}
]
}
},
"IPS list": {
"description": "IPS list",
"value": {
"name": "Demo-IPS-list",
"description": "Desc Not Required",
"type": "ipssignature",
"entries": [
{
"generatorId": "1111",
"signatureId": "4444"
}
]
}
},
"URL white list": {
"description": "URL white list",
"value": {
"name": "Demo-Whitelist",
"description": "Desc Not Required",
"type": "urlwhitelist",
"entries": [
{
"pattern": "https://www.youtube.com"
}
]
}
},
"URL black list": {
"description": "URL black list",
"value": {
"name": "Demo-Black-list",
"description": "Desc Not Required",
"type": "urlblacklist",
"entries": [
{
"pattern": "www.facebook.com"
}
]
}
},
"TG API key list": {
"description": "TG API key list",
"value": {
"name": "threatGridApiKeyList",
"description": "",
"type": "threatGridApiKey",
"entries": [
{
"region": "nam",
"apikey": "1234567"
},
{
"region": "eur",
"apikey": "1234567"
}
]
}
},
"Local domain list": {
"description": "Local domain list",
"value": {
"name": "Demo-Domain-Name-List",
"description": "Desc Not Required",
"type": "localdomain",
"entries": [
{
"nameServer": "cisco.com"
}
]
}
},
"Umbrella data list": {
"description": "Umbrella data list",
"value": {
"name": "umbrellaTokenList",
"description": "",
"type": "umbrellaData",
"entries": [
{
"apiKey": "abcd",
"secret": "12345",
"umbOrgId": "23405",
"token": "abcedabcedabcedabcedabcedabcedabcedabced"
}
]
}
},
"App family": {
"description": "App family",
"value": {
"name": "Demo-App-List",
"description": "Desc Not Required",
"type": "app",
"entries": [
{
"appFamily": "web"
},
{
"appFamily": "audio-video"
}
]
}
},
"App list": {
"description": "App list",
"value": {
"name": "Demo-App-List",
"description": "Desc Not Required",
"type": "app",
"entries": [
{
"app": "facebook"
},
{
"app": "netshow"
}
]
}
},
"Color list": {
"description": "Color list",
"value": {
"name": "Demo-Color-List",
"description": "Desc Not Required",
"type": "color",
"entries": [
{
"color": "biz-internet"
},
{
"color": "public-internet"
}
]
}
},
"Data prefix": {
"description": "Data prefix",
"value": {
"name": "Demo-Data-Prefix-List",
"description": "Desc Not Required",
"type": "dataprefix",
"entries": [
{
"ipPrefix": "10.1.0.0/16"
},
{
"ipPrefix": "10.2.0.0/16"
}
]
}
},
"Policer": {
"description": "Policer",
"value": {
"name": "Demo-Policer-list",
"description": "Desc Not Required",
"type": "policer",
"entries": [
{
"burst": "16000",
"exceed": "drop",
"rate": "10000"
}
]
}
},
"Prefix": {
"description": "Prefix",
"value": {
"name": "Demo-Prefix-list",
"description": "Desc Not Required",
"type": "prefix",
"entries": [
{
"ipPrefix": "10.0.0.0/12",
"le": "32"
}
]
}
},
"Site": {
"description": "Site",
"value": {
"name": "Demo-Site-List",
"description": "Desc Not Required",
"type": "site",
"listId": null,
"entries": [
{
"siteId": "100"
},
{
"siteId": "200"
},
{
"siteId": "300-500"
}
]
}
},
"Class": {
"description": "Class",
"value": {
"name": "Demo-Class-Map",
"description": "Desc Not Required",
"type": "class",
"entries": [
{
"queue": "4"
}
]
}
},
"App probe": {
"description": "App probe",
"value": {
"name": "Demo-Probe-Class",
"type": "appProbe",
"entries": [
{
"map": [
{
"color": "biz-internet",
"dscp": 46
},
{
"color": "public-internet",
"dscp": 20
}
],
"forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70"
}
]
}
},
"SLA": {
"description": "SLA",
"value": {
"name": "Demo-SLA-Class",
"description": "Desc Not Required",
"type": "sla",
"entries": [
{
"latency": "100",
"loss": "10",
"jitter": "10",
"appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d"
}
]
}
},
"TLOC": {
"description": "TLOC",
"value": {
"name": "Demo-TLOC-List",
"description": "Desc Not Required",
"type": "tloc",
"entries": [
{
"tloc": "10.1.1.1",
"color": "biz-internet",
"encap": "ipsec",
"preference": "10"
},
{
"tloc": "10.2.2.2",
"color": "biz-internet",
"encap": "ipsec",
"preference": "20"
}
]
}
},
"VPN": {
"description": "VPN",
"value": {
"name": "Demo-VPN-List",
"description": "Desc Not Required",
"type": "vpn",
"listId": null,
"entries": [
{
"vpn": "100"
},
{
"vpn": "200"
},
{
"vpn": "300-500"
}
]
}
},
"AS path": {
"description": "AS path",
"value": {
"name": "Demo-AS-Path-List",
"description": "Desc Not Required",
"type": "aspath",
"listId": null,
"entries": [
{
"asPath": "100"
},
{
"asPath": "200"
},
{
"asPath": "65002"
}
]
}
},
"Community": {
"description": "Community",
"value": {
"name": "Demo-Community-List",
"description": "Desc Not Required",
"type": "community",
"listId": null,
"entries": [
{
"community": "1000:10000"
}
]
}
},
"Ext community": {
"description": "Ext community",
"value": {
"name": "Demo-Extended-Community-List",
"description": "Desc Not Required",
"type": "extcommunity",
"listId": null,
"entries": [
{
"community": "rt 100:10"
}
]
}
},
"Mirror": {
"description": "Mirror",
"value": {
"name": "Demo-Mirror-List",
"description": "Desc Not Required",
"type": "mirror",
"entries": [
{
"remoteDest": "10.1.1.1",
"source": "20.1.1.1"
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Task Id": {
"description": "Task Id",
"value": {
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6"
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"delete": {
"tags": [
"Configuration - Policy Local Domain Name List Builder"
],
"description": "Delete policy lists with specific info tag",
"operationId": "deletePolicyListsWithInfoTag_ConfigurationPolicyLocalDomainNameListBuilder_3306",
"parameters": [
{
"name": "infoTag",
"in": "query",
"description": "InfoTag",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/list/localdomain/filtered": {
"get": {
"tags": [
"Configuration - Policy Local Domain Name List Builder"
],
"description": "Get policy lists with specific info tag",
"operationId": "getPolicyListsWithInfoTag_ConfigurationPolicyLocalDomainNameListBuilder_4203",
"parameters": [
{
"name": "infoTag",
"in": "query",
"description": "InfoTag",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/list/localdomain/preview": {
"post": {
"tags": [
"Configuration - Policy Local Domain Name List Builder"
],
"description": "Preview a policy list based on the policy list type",
"operationId": "previewPolicyList_ConfigurationPolicyLocalDomainNameListBuilder_4104",
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy list": {
"description": "Policy list"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Preview policy list": {
"description": "Preview policy list",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/list/localdomain/preview/{id}": {
"get": {
"tags": [
"Configuration - Policy Local Domain Name List Builder"
],
"description": "Preview a specific policy list entry based on id provided",
"operationId": "previewPolicyListById_ConfigurationPolicyLocalDomainNameListBuilder_4603",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Preview policy list": {
"description": "Preview policy list",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/list/localdomain/{id}": {
"get": {
"tags": [
"Configuration - Policy Local Domain Name List Builder"
],
"description": "Get a specific policy list based on the id",
"operationId": "getListsById_ConfigurationPolicyLocalDomainNameListBuilder_3803",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy": {
"description": "Policy",
"value": {
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6",
"name": "Community",
"type": "community",
"description": "Desc Not Required",
"entries": [
{
"community": "1000:5000"
}
],
"lastUpdated": 1590184928436,
"owner": "admin",
"readOnly": false,
"version": "0",
"infoTag": "",
"referenceCount": 0,
"references": [],
"isActivatedByVsmart": false
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
},
"delete": {
"tags": [
"Configuration - Policy Local Domain Name List Builder"
],
"description": "Delete policy list entry for a specific type of policy list",
"operationId": "deletePolicyList_ConfigurationPolicyLocalDomainNameListBuilder_3806",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"put": {
"tags": [
"Configuration - Policy Local Domain Name List Builder"
],
"description": "Edit policy list entries for a specific type of policy list",
"operationId": "editPolicyList_ConfigurationPolicyLocalDomainNameListBuilder_3803",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": {
"name": "Community",
"description": "Desc Not Required",
"type": "community",
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6",
"entries": [
{
"community": "1000:8000"
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy": {
"description": "Policy",
"value": {
"masterTemplatesAffected": []
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/list/mediaprofile": {
"post": {
"tags": [
"Configuration - Policy Media Profile List Builder"
],
"description": "Create policy list",
"operationId": "createPolicyList_ConfigurationPolicyMediaProfileListBuilder_3404",
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Zone list": {
"description": "Zone list",
"value": {
"name": "Demo-Zone",
"description": "Desc Not Required",
"type": "zone",
"entries": [
{
"vpn": "10"
}
]
}
},
"IPS list": {
"description": "IPS list",
"value": {
"name": "Demo-IPS-list",
"description": "Desc Not Required",
"type": "ipssignature",
"entries": [
{
"generatorId": "1111",
"signatureId": "4444"
}
]
}
},
"URL white list": {
"description": "URL white list",
"value": {
"name": "Demo-Whitelist",
"description": "Desc Not Required",
"type": "urlwhitelist",
"entries": [
{
"pattern": "https://www.youtube.com"
}
]
}
},
"URL black list": {
"description": "URL black list",
"value": {
"name": "Demo-Black-list",
"description": "Desc Not Required",
"type": "urlblacklist",
"entries": [
{
"pattern": "www.facebook.com"
}
]
}
},
"TG API key list": {
"description": "TG API key list",
"value": {
"name": "threatGridApiKeyList",
"description": "",
"type": "threatGridApiKey",
"entries": [
{
"region": "nam",
"apikey": "1234567"
},
{
"region": "eur",
"apikey": "1234567"
}
]
}
},
"Local domain list": {
"description": "Local domain list",
"value": {
"name": "Demo-Domain-Name-List",
"description": "Desc Not Required",
"type": "localdomain",
"entries": [
{
"nameServer": "cisco.com"
}
]
}
},
"Umbrella data list": {
"description": "Umbrella data list",
"value": {
"name": "umbrellaTokenList",
"description": "",
"type": "umbrellaData",
"entries": [
{
"apiKey": "abcd",
"secret": "12345",
"umbOrgId": "23405",
"token": "abcedabcedabcedabcedabcedabcedabcedabced"
}
]
}
},
"App family": {
"description": "App family",
"value": {
"name": "Demo-App-List",
"description": "Desc Not Required",
"type": "app",
"entries": [
{
"appFamily": "web"
},
{
"appFamily": "audio-video"
}
]
}
},
"App list": {
"description": "App list",
"value": {
"name": "Demo-App-List",
"description": "Desc Not Required",
"type": "app",
"entries": [
{
"app": "facebook"
},
{
"app": "netshow"
}
]
}
},
"Color list": {
"description": "Color list",
"value": {
"name": "Demo-Color-List",
"description": "Desc Not Required",
"type": "color",
"entries": [
{
"color": "biz-internet"
},
{
"color": "public-internet"
}
]
}
},
"Data prefix": {
"description": "Data prefix",
"value": {
"name": "Demo-Data-Prefix-List",
"description": "Desc Not Required",
"type": "dataprefix",
"entries": [
{
"ipPrefix": "10.1.0.0/16"
},
{
"ipPrefix": "10.2.0.0/16"
}
]
}
},
"Policer": {
"description": "Policer",
"value": {
"name": "Demo-Policer-list",
"description": "Desc Not Required",
"type": "policer",
"entries": [
{
"burst": "16000",
"exceed": "drop",
"rate": "10000"
}
]
}
},
"Prefix": {
"description": "Prefix",
"value": {
"name": "Demo-Prefix-list",
"description": "Desc Not Required",
"type": "prefix",
"entries": [
{
"ipPrefix": "10.0.0.0/12",
"le": "32"
}
]
}
},
"Site": {
"description": "Site",
"value": {
"name": "Demo-Site-List",
"description": "Desc Not Required",
"type": "site",
"listId": null,
"entries": [
{
"siteId": "100"
},
{
"siteId": "200"
},
{
"siteId": "300-500"
}
]
}
},
"Class": {
"description": "Class",
"value": {
"name": "Demo-Class-Map",
"description": "Desc Not Required",
"type": "class",
"entries": [
{
"queue": "4"
}
]
}
},
"App probe": {
"description": "App probe",
"value": {
"name": "Demo-Probe-Class",
"type": "appProbe",
"entries": [
{
"map": [
{
"color": "biz-internet",
"dscp": 46
},
{
"color": "public-internet",
"dscp": 20
}
],
"forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70"
}
]
}
},
"SLA": {
"description": "SLA",
"value": {
"name": "Demo-SLA-Class",
"description": "Desc Not Required",
"type": "sla",
"entries": [
{
"latency": "100",
"loss": "10",
"jitter": "10",
"appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d"
}
]
}
},
"TLOC": {
"description": "TLOC",
"value": {
"name": "Demo-TLOC-List",
"description": "Desc Not Required",
"type": "tloc",
"entries": [
{
"tloc": "10.1.1.1",
"color": "biz-internet",
"encap": "ipsec",
"preference": "10"
},
{
"tloc": "10.2.2.2",
"color": "biz-internet",
"encap": "ipsec",
"preference": "20"
}
]
}
},
"VPN": {
"description": "VPN",
"value": {
"name": "Demo-VPN-List",
"description": "Desc Not Required",
"type": "vpn",
"listId": null,
"entries": [
{
"vpn": "100"
},
{
"vpn": "200"
},
{
"vpn": "300-500"
}
]
}
},
"AS path": {
"description": "AS path",
"value": {
"name": "Demo-AS-Path-List",
"description": "Desc Not Required",
"type": "aspath",
"listId": null,
"entries": [
{
"asPath": "100"
},
{
"asPath": "200"
},
{
"asPath": "65002"
}
]
}
},
"Community": {
"description": "Community",
"value": {
"name": "Demo-Community-List",
"description": "Desc Not Required",
"type": "community",
"listId": null,
"entries": [
{
"community": "1000:10000"
}
]
}
},
"Ext community": {
"description": "Ext community",
"value": {
"name": "Demo-Extended-Community-List",
"description": "Desc Not Required",
"type": "extcommunity",
"listId": null,
"entries": [
{
"community": "rt 100:10"
}
]
}
},
"Mirror": {
"description": "Mirror",
"value": {
"name": "Demo-Mirror-List",
"description": "Desc Not Required",
"type": "mirror",
"entries": [
{
"remoteDest": "10.1.1.1",
"source": "20.1.1.1"
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Task Id": {
"description": "Task Id",
"value": {
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6"
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"delete": {
"tags": [
"Configuration - Policy Media Profile List Builder"
],
"description": "Delete policy lists with specific info tag",
"operationId": "deletePolicyListsWithInfoTag_ConfigurationPolicyMediaProfileListBuilder_3406",
"parameters": [
{
"name": "infoTag",
"in": "query",
"description": "InfoTag",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
},
"get": {
"tags": [
"Configuration - Policy Media Profile List Builder"
],
"description": "Get policy lists",
"operationId": "getPolicyLists_ConfigurationPolicyMediaProfileListBuilder_3403",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"App Policy": {
"description": "App Policy",
"value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"
},
"Prefix List": {
"description": "Prefix List",
"value": {
"data": [
{
"listId": "8bc43c09-f72c-40b8-aa90-608c7005e607",
"name": "Example",
"type": "prefix",
"description": "Desc Not Required",
"entries": [
{
"ipPrefix": "10.0.0.0/24"
}
],
"lastUpdated": 1588178457305,
"owner": "admin",
"readOnly": false,
"version": "0",
"infoTag": "",
"referenceCount": 0,
"references": [],
"isActivatedByVsmart": false
}
]
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/list/mediaprofile/filtered": {
"get": {
"tags": [
"Configuration - Policy Media Profile List Builder"
],
"description": "Get policy lists with specific info tag",
"operationId": "getPolicyListsWithInfoTag_ConfigurationPolicyMediaProfileListBuilder_4303",
"parameters": [
{
"name": "infoTag",
"in": "query",
"description": "InfoTag",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/list/mediaprofile/preview": {
"post": {
"tags": [
"Configuration - Policy Media Profile List Builder"
],
"description": "Preview a policy list based on the policy list type",
"operationId": "previewPolicyList_ConfigurationPolicyMediaProfileListBuilder_4204",
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy list": {
"description": "Policy list"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Preview policy list": {
"description": "Preview policy list",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/list/mediaprofile/preview/{id}": {
"get": {
"tags": [
"Configuration - Policy Media Profile List Builder"
],
"description": "Preview a specific policy list entry based on id provided",
"operationId": "previewPolicyListById_ConfigurationPolicyMediaProfileListBuilder_4703",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Preview policy list": {
"description": "Preview policy list",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/list/mediaprofile/{id}": {
"delete": {
"tags": [
"Configuration - Policy Media Profile List Builder"
],
"description": "Delete policy list entry for a specific type of policy list",
"operationId": "deletePolicyList_ConfigurationPolicyMediaProfileListBuilder_3906",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"get": {
"tags": [
"Configuration - Policy Media Profile List Builder"
],
"description": "Get a specific policy list based on the id",
"operationId": "getListsById_ConfigurationPolicyMediaProfileListBuilder_3903",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy": {
"description": "Policy",
"value": {
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6",
"name": "Community",
"type": "community",
"description": "Desc Not Required",
"entries": [
{
"community": "1000:5000"
}
],
"lastUpdated": 1590184928436,
"owner": "admin",
"readOnly": false,
"version": "0",
"infoTag": "",
"referenceCount": 0,
"references": [],
"isActivatedByVsmart": false
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
},
"put": {
"tags": [
"Configuration - Policy Media Profile List Builder"
],
"description": "Edit policy list entries for a specific type of policy list",
"operationId": "editPolicyList_ConfigurationPolicyMediaProfileListBuilder_3903",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": {
"name": "Community",
"description": "Desc Not Required",
"type": "community",
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6",
"entries": [
{
"community": "1000:8000"
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy": {
"description": "Policy",
"value": {
"masterTemplatesAffected": []
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/list/mirror": {
"post": {
"tags": [
"Configuration - Policy Mirror List Builder"
],
"description": "Create policy list",
"operationId": "createPolicyList_ConfigurationPolicyMirrorListBuilder_2804",
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Zone list": {
"description": "Zone list",
"value": {
"name": "Demo-Zone",
"description": "Desc Not Required",
"type": "zone",
"entries": [
{
"vpn": "10"
}
]
}
},
"IPS list": {
"description": "IPS list",
"value": {
"name": "Demo-IPS-list",
"description": "Desc Not Required",
"type": "ipssignature",
"entries": [
{
"generatorId": "1111",
"signatureId": "4444"
}
]
}
},
"URL white list": {
"description": "URL white list",
"value": {
"name": "Demo-Whitelist",
"description": "Desc Not Required",
"type": "urlwhitelist",
"entries": [
{
"pattern": "https://www.youtube.com"
}
]
}
},
"URL black list": {
"description": "URL black list",
"value": {
"name": "Demo-Black-list",
"description": "Desc Not Required",
"type": "urlblacklist",
"entries": [
{
"pattern": "www.facebook.com"
}
]
}
},
"TG API key list": {
"description": "TG API key list",
"value": {
"name": "threatGridApiKeyList",
"description": "",
"type": "threatGridApiKey",
"entries": [
{
"region": "nam",
"apikey": "1234567"
},
{
"region": "eur",
"apikey": "1234567"
}
]
}
},
"Local domain list": {
"description": "Local domain list",
"value": {
"name": "Demo-Domain-Name-List",
"description": "Desc Not Required",
"type": "localdomain",
"entries": [
{
"nameServer": "cisco.com"
}
]
}
},
"Umbrella data list": {
"description": "Umbrella data list",
"value": {
"name": "umbrellaTokenList",
"description": "",
"type": "umbrellaData",
"entries": [
{
"apiKey": "abcd",
"secret": "12345",
"umbOrgId": "23405",
"token": "abcedabcedabcedabcedabcedabcedabcedabced"
}
]
}
},
"App family": {
"description": "App family",
"value": {
"name": "Demo-App-List",
"description": "Desc Not Required",
"type": "app",
"entries": [
{
"appFamily": "web"
},
{
"appFamily": "audio-video"
}
]
}
},
"App list": {
"description": "App list",
"value": {
"name": "Demo-App-List",
"description": "Desc Not Required",
"type": "app",
"entries": [
{
"app": "facebook"
},
{
"app": "netshow"
}
]
}
},
"Color list": {
"description": "Color list",
"value": {
"name": "Demo-Color-List",
"description": "Desc Not Required",
"type": "color",
"entries": [
{
"color": "biz-internet"
},
{
"color": "public-internet"
}
]
}
},
"Data prefix": {
"description": "Data prefix",
"value": {
"name": "Demo-Data-Prefix-List",
"description": "Desc Not Required",
"type": "dataprefix",
"entries": [
{
"ipPrefix": "10.1.0.0/16"
},
{
"ipPrefix": "10.2.0.0/16"
}
]
}
},
"Policer": {
"description": "Policer",
"value": {
"name": "Demo-Policer-list",
"description": "Desc Not Required",
"type": "policer",
"entries": [
{
"burst": "16000",
"exceed": "drop",
"rate": "10000"
}
]
}
},
"Prefix": {
"description": "Prefix",
"value": {
"name": "Demo-Prefix-list",
"description": "Desc Not Required",
"type": "prefix",
"entries": [
{
"ipPrefix": "10.0.0.0/12",
"le": "32"
}
]
}
},
"Site": {
"description": "Site",
"value": {
"name": "Demo-Site-List",
"description": "Desc Not Required",
"type": "site",
"listId": null,
"entries": [
{
"siteId": "100"
},
{
"siteId": "200"
},
{
"siteId": "300-500"
}
]
}
},
"Class": {
"description": "Class",
"value": {
"name": "Demo-Class-Map",
"description": "Desc Not Required",
"type": "class",
"entries": [
{
"queue": "4"
}
]
}
},
"App probe": {
"description": "App probe",
"value": {
"name": "Demo-Probe-Class",
"type": "appProbe",
"entries": [
{
"map": [
{
"color": "biz-internet",
"dscp": 46
},
{
"color": "public-internet",
"dscp": 20
}
],
"forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70"
}
]
}
},
"SLA": {
"description": "SLA",
"value": {
"name": "Demo-SLA-Class",
"description": "Desc Not Required",
"type": "sla",
"entries": [
{
"latency": "100",
"loss": "10",
"jitter": "10",
"appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d"
}
]
}
},
"TLOC": {
"description": "TLOC",
"value": {
"name": "Demo-TLOC-List",
"description": "Desc Not Required",
"type": "tloc",
"entries": [
{
"tloc": "10.1.1.1",
"color": "biz-internet",
"encap": "ipsec",
"preference": "10"
},
{
"tloc": "10.2.2.2",
"color": "biz-internet",
"encap": "ipsec",
"preference": "20"
}
]
}
},
"VPN": {
"description": "VPN",
"value": {
"name": "Demo-VPN-List",
"description": "Desc Not Required",
"type": "vpn",
"listId": null,
"entries": [
{
"vpn": "100"
},
{
"vpn": "200"
},
{
"vpn": "300-500"
}
]
}
},
"AS path": {
"description": "AS path",
"value": {
"name": "Demo-AS-Path-List",
"description": "Desc Not Required",
"type": "aspath",
"listId": null,
"entries": [
{
"asPath": "100"
},
{
"asPath": "200"
},
{
"asPath": "65002"
}
]
}
},
"Community": {
"description": "Community",
"value": {
"name": "Demo-Community-List",
"description": "Desc Not Required",
"type": "community",
"listId": null,
"entries": [
{
"community": "1000:10000"
}
]
}
},
"Ext community": {
"description": "Ext community",
"value": {
"name": "Demo-Extended-Community-List",
"description": "Desc Not Required",
"type": "extcommunity",
"listId": null,
"entries": [
{
"community": "rt 100:10"
}
]
}
},
"Mirror": {
"description": "Mirror",
"value": {
"name": "Demo-Mirror-List",
"description": "Desc Not Required",
"type": "mirror",
"entries": [
{
"remoteDest": "10.1.1.1",
"source": "20.1.1.1"
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Task Id": {
"description": "Task Id",
"value": {
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6"
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"delete": {
"tags": [
"Configuration - Policy Mirror List Builder"
],
"description": "Delete policy lists with specific info tag",
"operationId": "deletePolicyListsWithInfoTag_ConfigurationPolicyMirrorListBuilder_2806",
"parameters": [
{
"name": "infoTag",
"in": "query",
"description": "InfoTag",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
},
"get": {
"tags": [
"Configuration - Policy Mirror List Builder"
],
"description": "Get policy lists",
"operationId": "getPolicyLists_ConfigurationPolicyMirrorListBuilder_2803",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"App Policy": {
"description": "App Policy",
"value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"
},
"Prefix List": {
"description": "Prefix List",
"value": {
"data": [
{
"listId": "8bc43c09-f72c-40b8-aa90-608c7005e607",
"name": "Example",
"type": "prefix",
"description": "Desc Not Required",
"entries": [
{
"ipPrefix": "10.0.0.0/24"
}
],
"lastUpdated": 1588178457305,
"owner": "admin",
"readOnly": false,
"version": "0",
"infoTag": "",
"referenceCount": 0,
"references": [],
"isActivatedByVsmart": false
}
]
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/list/mirror/filtered": {
"get": {
"tags": [
"Configuration - Policy Mirror List Builder"
],
"description": "Get policy lists with specific info tag",
"operationId": "getPolicyListsWithInfoTag_ConfigurationPolicyMirrorListBuilder_3703",
"parameters": [
{
"name": "infoTag",
"in": "query",
"description": "InfoTag",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/list/mirror/preview": {
"post": {
"tags": [
"Configuration - Policy Mirror List Builder"
],
"description": "Preview a policy list based on the policy list type",
"operationId": "previewPolicyList_ConfigurationPolicyMirrorListBuilder_3604",
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy list": {
"description": "Policy list"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Preview policy list": {
"description": "Preview policy list",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/list/mirror/preview/{id}": {
"get": {
"tags": [
"Configuration - Policy Mirror List Builder"
],
"description": "Preview a specific policy list entry based on id provided",
"operationId": "previewPolicyListById_ConfigurationPolicyMirrorListBuilder_4103",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Preview policy list": {
"description": "Preview policy list",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/list/mirror/{id}": {
"get": {
"tags": [
"Configuration - Policy Mirror List Builder"
],
"description": "Get a specific policy list based on the id",
"operationId": "getListsById_ConfigurationPolicyMirrorListBuilder_3303",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy": {
"description": "Policy",
"value": {
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6",
"name": "Community",
"type": "community",
"description": "Desc Not Required",
"entries": [
{
"community": "1000:5000"
}
],
"lastUpdated": 1590184928436,
"owner": "admin",
"readOnly": false,
"version": "0",
"infoTag": "",
"referenceCount": 0,
"references": [],
"isActivatedByVsmart": false
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
},
"delete": {
"tags": [
"Configuration - Policy Mirror List Builder"
],
"description": "Delete policy list entry for a specific type of policy list",
"operationId": "deletePolicyList_ConfigurationPolicyMirrorListBuilder_3306",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"put": {
"tags": [
"Configuration - Policy Mirror List Builder"
],
"description": "Edit policy list entries for a specific type of policy list",
"operationId": "editPolicyList_ConfigurationPolicyMirrorListBuilder_3303",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": {
"name": "Community",
"description": "Desc Not Required",
"type": "community",
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6",
"entries": [
{
"community": "1000:8000"
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy": {
"description": "Policy",
"value": {
"masterTemplatesAffected": []
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/list/modempassthrough": {
"post": {
"tags": [
"Configuration - Policy Modem Passthrough List Builder"
],
"description": "Create policy list",
"operationId": "createPolicyList_ConfigurationPolicyModemPassthroughListBuilder_3804",
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Zone list": {
"description": "Zone list",
"value": {
"name": "Demo-Zone",
"description": "Desc Not Required",
"type": "zone",
"entries": [
{
"vpn": "10"
}
]
}
},
"IPS list": {
"description": "IPS list",
"value": {
"name": "Demo-IPS-list",
"description": "Desc Not Required",
"type": "ipssignature",
"entries": [
{
"generatorId": "1111",
"signatureId": "4444"
}
]
}
},
"URL white list": {
"description": "URL white list",
"value": {
"name": "Demo-Whitelist",
"description": "Desc Not Required",
"type": "urlwhitelist",
"entries": [
{
"pattern": "https://www.youtube.com"
}
]
}
},
"URL black list": {
"description": "URL black list",
"value": {
"name": "Demo-Black-list",
"description": "Desc Not Required",
"type": "urlblacklist",
"entries": [
{
"pattern": "www.facebook.com"
}
]
}
},
"TG API key list": {
"description": "TG API key list",
"value": {
"name": "threatGridApiKeyList",
"description": "",
"type": "threatGridApiKey",
"entries": [
{
"region": "nam",
"apikey": "1234567"
},
{
"region": "eur",
"apikey": "1234567"
}
]
}
},
"Local domain list": {
"description": "Local domain list",
"value": {
"name": "Demo-Domain-Name-List",
"description": "Desc Not Required",
"type": "localdomain",
"entries": [
{
"nameServer": "cisco.com"
}
]
}
},
"Umbrella data list": {
"description": "Umbrella data list",
"value": {
"name": "umbrellaTokenList",
"description": "",
"type": "umbrellaData",
"entries": [
{
"apiKey": "abcd",
"secret": "12345",
"umbOrgId": "23405",
"token": "abcedabcedabcedabcedabcedabcedabcedabced"
}
]
}
},
"App family": {
"description": "App family",
"value": {
"name": "Demo-App-List",
"description": "Desc Not Required",
"type": "app",
"entries": [
{
"appFamily": "web"
},
{
"appFamily": "audio-video"
}
]
}
},
"App list": {
"description": "App list",
"value": {
"name": "Demo-App-List",
"description": "Desc Not Required",
"type": "app",
"entries": [
{
"app": "facebook"
},
{
"app": "netshow"
}
]
}
},
"Color list": {
"description": "Color list",
"value": {
"name": "Demo-Color-List",
"description": "Desc Not Required",
"type": "color",
"entries": [
{
"color": "biz-internet"
},
{
"color": "public-internet"
}
]
}
},
"Data prefix": {
"description": "Data prefix",
"value": {
"name": "Demo-Data-Prefix-List",
"description": "Desc Not Required",
"type": "dataprefix",
"entries": [
{
"ipPrefix": "10.1.0.0/16"
},
{
"ipPrefix": "10.2.0.0/16"
}
]
}
},
"Policer": {
"description": "Policer",
"value": {
"name": "Demo-Policer-list",
"description": "Desc Not Required",
"type": "policer",
"entries": [
{
"burst": "16000",
"exceed": "drop",
"rate": "10000"
}
]
}
},
"Prefix": {
"description": "Prefix",
"value": {
"name": "Demo-Prefix-list",
"description": "Desc Not Required",
"type": "prefix",
"entries": [
{
"ipPrefix": "10.0.0.0/12",
"le": "32"
}
]
}
},
"Site": {
"description": "Site",
"value": {
"name": "Demo-Site-List",
"description": "Desc Not Required",
"type": "site",
"listId": null,
"entries": [
{
"siteId": "100"
},
{
"siteId": "200"
},
{
"siteId": "300-500"
}
]
}
},
"Class": {
"description": "Class",
"value": {
"name": "Demo-Class-Map",
"description": "Desc Not Required",
"type": "class",
"entries": [
{
"queue": "4"
}
]
}
},
"App probe": {
"description": "App probe",
"value": {
"name": "Demo-Probe-Class",
"type": "appProbe",
"entries": [
{
"map": [
{
"color": "biz-internet",
"dscp": 46
},
{
"color": "public-internet",
"dscp": 20
}
],
"forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70"
}
]
}
},
"SLA": {
"description": "SLA",
"value": {
"name": "Demo-SLA-Class",
"description": "Desc Not Required",
"type": "sla",
"entries": [
{
"latency": "100",
"loss": "10",
"jitter": "10",
"appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d"
}
]
}
},
"TLOC": {
"description": "TLOC",
"value": {
"name": "Demo-TLOC-List",
"description": "Desc Not Required",
"type": "tloc",
"entries": [
{
"tloc": "10.1.1.1",
"color": "biz-internet",
"encap": "ipsec",
"preference": "10"
},
{
"tloc": "10.2.2.2",
"color": "biz-internet",
"encap": "ipsec",
"preference": "20"
}
]
}
},
"VPN": {
"description": "VPN",
"value": {
"name": "Demo-VPN-List",
"description": "Desc Not Required",
"type": "vpn",
"listId": null,
"entries": [
{
"vpn": "100"
},
{
"vpn": "200"
},
{
"vpn": "300-500"
}
]
}
},
"AS path": {
"description": "AS path",
"value": {
"name": "Demo-AS-Path-List",
"description": "Desc Not Required",
"type": "aspath",
"listId": null,
"entries": [
{
"asPath": "100"
},
{
"asPath": "200"
},
{
"asPath": "65002"
}
]
}
},
"Community": {
"description": "Community",
"value": {
"name": "Demo-Community-List",
"description": "Desc Not Required",
"type": "community",
"listId": null,
"entries": [
{
"community": "1000:10000"
}
]
}
},
"Ext community": {
"description": "Ext community",
"value": {
"name": "Demo-Extended-Community-List",
"description": "Desc Not Required",
"type": "extcommunity",
"listId": null,
"entries": [
{
"community": "rt 100:10"
}
]
}
},
"Mirror": {
"description": "Mirror",
"value": {
"name": "Demo-Mirror-List",
"description": "Desc Not Required",
"type": "mirror",
"entries": [
{
"remoteDest": "10.1.1.1",
"source": "20.1.1.1"
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Task Id": {
"description": "Task Id",
"value": {
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6"
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"delete": {
"tags": [
"Configuration - Policy Modem Passthrough List Builder"
],
"description": "Delete policy lists with specific info tag",
"operationId": "deletePolicyListsWithInfoTag_ConfigurationPolicyModemPassthroughListBuilder_3806",
"parameters": [
{
"name": "infoTag",
"in": "query",
"description": "InfoTag",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
},
"get": {
"tags": [
"Configuration - Policy Modem Passthrough List Builder"
],
"description": "Get policy lists",
"operationId": "getPolicyLists_ConfigurationPolicyModemPassthroughListBuilder_3803",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"App Policy": {
"description": "App Policy",
"value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"
},
"Prefix List": {
"description": "Prefix List",
"value": {
"data": [
{
"listId": "8bc43c09-f72c-40b8-aa90-608c7005e607",
"name": "Example",
"type": "prefix",
"description": "Desc Not Required",
"entries": [
{
"ipPrefix": "10.0.0.0/24"
}
],
"lastUpdated": 1588178457305,
"owner": "admin",
"readOnly": false,
"version": "0",
"infoTag": "",
"referenceCount": 0,
"references": [],
"isActivatedByVsmart": false
}
]
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/list/modempassthrough/filtered": {
"get": {
"tags": [
"Configuration - Policy Modem Passthrough List Builder"
],
"description": "Get policy lists with specific info tag",
"operationId": "getPolicyListsWithInfoTag_ConfigurationPolicyModemPassthroughListBuilder_4703",
"parameters": [
{
"name": "infoTag",
"in": "query",
"description": "InfoTag",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/list/modempassthrough/preview": {
"post": {
"tags": [
"Configuration - Policy Modem Passthrough List Builder"
],
"description": "Preview a policy list based on the policy list type",
"operationId": "previewPolicyList_ConfigurationPolicyModemPassthroughListBuilder_4604",
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy list": {
"description": "Policy list"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Preview policy list": {
"description": "Preview policy list",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/list/modempassthrough/preview/{id}": {
"get": {
"tags": [
"Configuration - Policy Modem Passthrough List Builder"
],
"description": "Preview a specific policy list entry based on id provided",
"operationId": "previewPolicyListById_ConfigurationPolicyModemPassthroughListBuilder_5103",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Preview policy list": {
"description": "Preview policy list",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/list/modempassthrough/{id}": {
"get": {
"tags": [
"Configuration - Policy Modem Passthrough List Builder"
],
"description": "Get a specific policy list based on the id",
"operationId": "getListsById_ConfigurationPolicyModemPassthroughListBuilder_4303",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy": {
"description": "Policy",
"value": {
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6",
"name": "Community",
"type": "community",
"description": "Desc Not Required",
"entries": [
{
"community": "1000:5000"
}
],
"lastUpdated": 1590184928436,
"owner": "admin",
"readOnly": false,
"version": "0",
"infoTag": "",
"referenceCount": 0,
"references": [],
"isActivatedByVsmart": false
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
},
"delete": {
"tags": [
"Configuration - Policy Modem Passthrough List Builder"
],
"description": "Delete policy list entry for a specific type of policy list",
"operationId": "deletePolicyList_ConfigurationPolicyModemPassthroughListBuilder_4306",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"put": {
"tags": [
"Configuration - Policy Modem Passthrough List Builder"
],
"description": "Edit policy list entries for a specific type of policy list",
"operationId": "editPolicyList_ConfigurationPolicyModemPassthroughListBuilder_4303",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": {
"name": "Community",
"description": "Desc Not Required",
"type": "community",
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6",
"entries": [
{
"community": "1000:8000"
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy": {
"description": "Policy",
"value": {
"masterTemplatesAffected": []
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/list/policer": {
"get": {
"tags": [
"Configuration - Policy Policer Class List Builder"
],
"description": "Get policy lists",
"operationId": "getPolicyLists_ConfigurationPolicyPolicerClassListBuilder_2903",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"App Policy": {
"description": "App Policy",
"value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"
},
"Prefix List": {
"description": "Prefix List",
"value": {
"data": [
{
"listId": "8bc43c09-f72c-40b8-aa90-608c7005e607",
"name": "Example",
"type": "prefix",
"description": "Desc Not Required",
"entries": [
{
"ipPrefix": "10.0.0.0/24"
}
],
"lastUpdated": 1588178457305,
"owner": "admin",
"readOnly": false,
"version": "0",
"infoTag": "",
"referenceCount": 0,
"references": [],
"isActivatedByVsmart": false
}
]
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
},
"post": {
"tags": [
"Configuration - Policy Policer Class List Builder"
],
"description": "Create policy list",
"operationId": "createPolicyList_ConfigurationPolicyPolicerClassListBuilder_2904",
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Zone list": {
"description": "Zone list",
"value": {
"name": "Demo-Zone",
"description": "Desc Not Required",
"type": "zone",
"entries": [
{
"vpn": "10"
}
]
}
},
"IPS list": {
"description": "IPS list",
"value": {
"name": "Demo-IPS-list",
"description": "Desc Not Required",
"type": "ipssignature",
"entries": [
{
"generatorId": "1111",
"signatureId": "4444"
}
]
}
},
"URL white list": {
"description": "URL white list",
"value": {
"name": "Demo-Whitelist",
"description": "Desc Not Required",
"type": "urlwhitelist",
"entries": [
{
"pattern": "https://www.youtube.com"
}
]
}
},
"URL black list": {
"description": "URL black list",
"value": {
"name": "Demo-Black-list",
"description": "Desc Not Required",
"type": "urlblacklist",
"entries": [
{
"pattern": "www.facebook.com"
}
]
}
},
"TG API key list": {
"description": "TG API key list",
"value": {
"name": "threatGridApiKeyList",
"description": "",
"type": "threatGridApiKey",
"entries": [
{
"region": "nam",
"apikey": "1234567"
},
{
"region": "eur",
"apikey": "1234567"
}
]
}
},
"Local domain list": {
"description": "Local domain list",
"value": {
"name": "Demo-Domain-Name-List",
"description": "Desc Not Required",
"type": "localdomain",
"entries": [
{
"nameServer": "cisco.com"
}
]
}
},
"Umbrella data list": {
"description": "Umbrella data list",
"value": {
"name": "umbrellaTokenList",
"description": "",
"type": "umbrellaData",
"entries": [
{
"apiKey": "abcd",
"secret": "12345",
"umbOrgId": "23405",
"token": "abcedabcedabcedabcedabcedabcedabcedabced"
}
]
}
},
"App family": {
"description": "App family",
"value": {
"name": "Demo-App-List",
"description": "Desc Not Required",
"type": "app",
"entries": [
{
"appFamily": "web"
},
{
"appFamily": "audio-video"
}
]
}
},
"App list": {
"description": "App list",
"value": {
"name": "Demo-App-List",
"description": "Desc Not Required",
"type": "app",
"entries": [
{
"app": "facebook"
},
{
"app": "netshow"
}
]
}
},
"Color list": {
"description": "Color list",
"value": {
"name": "Demo-Color-List",
"description": "Desc Not Required",
"type": "color",
"entries": [
{
"color": "biz-internet"
},
{
"color": "public-internet"
}
]
}
},
"Data prefix": {
"description": "Data prefix",
"value": {
"name": "Demo-Data-Prefix-List",
"description": "Desc Not Required",
"type": "dataprefix",
"entries": [
{
"ipPrefix": "10.1.0.0/16"
},
{
"ipPrefix": "10.2.0.0/16"
}
]
}
},
"Policer": {
"description": "Policer",
"value": {
"name": "Demo-Policer-list",
"description": "Desc Not Required",
"type": "policer",
"entries": [
{
"burst": "16000",
"exceed": "drop",
"rate": "10000"
}
]
}
},
"Prefix": {
"description": "Prefix",
"value": {
"name": "Demo-Prefix-list",
"description": "Desc Not Required",
"type": "prefix",
"entries": [
{
"ipPrefix": "10.0.0.0/12",
"le": "32"
}
]
}
},
"Site": {
"description": "Site",
"value": {
"name": "Demo-Site-List",
"description": "Desc Not Required",
"type": "site",
"listId": null,
"entries": [
{
"siteId": "100"
},
{
"siteId": "200"
},
{
"siteId": "300-500"
}
]
}
},
"Class": {
"description": "Class",
"value": {
"name": "Demo-Class-Map",
"description": "Desc Not Required",
"type": "class",
"entries": [
{
"queue": "4"
}
]
}
},
"App probe": {
"description": "App probe",
"value": {
"name": "Demo-Probe-Class",
"type": "appProbe",
"entries": [
{
"map": [
{
"color": "biz-internet",
"dscp": 46
},
{
"color": "public-internet",
"dscp": 20
}
],
"forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70"
}
]
}
},
"SLA": {
"description": "SLA",
"value": {
"name": "Demo-SLA-Class",
"description": "Desc Not Required",
"type": "sla",
"entries": [
{
"latency": "100",
"loss": "10",
"jitter": "10",
"appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d"
}
]
}
},
"TLOC": {
"description": "TLOC",
"value": {
"name": "Demo-TLOC-List",
"description": "Desc Not Required",
"type": "tloc",
"entries": [
{
"tloc": "10.1.1.1",
"color": "biz-internet",
"encap": "ipsec",
"preference": "10"
},
{
"tloc": "10.2.2.2",
"color": "biz-internet",
"encap": "ipsec",
"preference": "20"
}
]
}
},
"VPN": {
"description": "VPN",
"value": {
"name": "Demo-VPN-List",
"description": "Desc Not Required",
"type": "vpn",
"listId": null,
"entries": [
{
"vpn": "100"
},
{
"vpn": "200"
},
{
"vpn": "300-500"
}
]
}
},
"AS path": {
"description": "AS path",
"value": {
"name": "Demo-AS-Path-List",
"description": "Desc Not Required",
"type": "aspath",
"listId": null,
"entries": [
{
"asPath": "100"
},
{
"asPath": "200"
},
{
"asPath": "65002"
}
]
}
},
"Community": {
"description": "Community",
"value": {
"name": "Demo-Community-List",
"description": "Desc Not Required",
"type": "community",
"listId": null,
"entries": [
{
"community": "1000:10000"
}
]
}
},
"Ext community": {
"description": "Ext community",
"value": {
"name": "Demo-Extended-Community-List",
"description": "Desc Not Required",
"type": "extcommunity",
"listId": null,
"entries": [
{
"community": "rt 100:10"
}
]
}
},
"Mirror": {
"description": "Mirror",
"value": {
"name": "Demo-Mirror-List",
"description": "Desc Not Required",
"type": "mirror",
"entries": [
{
"remoteDest": "10.1.1.1",
"source": "20.1.1.1"
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Task Id": {
"description": "Task Id",
"value": {
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6"
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"delete": {
"tags": [
"Configuration - Policy Policer Class List Builder"
],
"description": "Delete policy lists with specific info tag",
"operationId": "deletePolicyListsWithInfoTag_ConfigurationPolicyPolicerClassListBuilder_2906",
"parameters": [
{
"name": "infoTag",
"in": "query",
"description": "InfoTag",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/list/policer/filtered": {
"get": {
"tags": [
"Configuration - Policy Policer Class List Builder"
],
"description": "Get policy lists with specific info tag",
"operationId": "getPolicyListsWithInfoTag_ConfigurationPolicyPolicerClassListBuilder_3803",
"parameters": [
{
"name": "infoTag",
"in": "query",
"description": "InfoTag",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/list/policer/preview": {
"post": {
"tags": [
"Configuration - Policy Policer Class List Builder"
],
"description": "Preview a policy list based on the policy list type",
"operationId": "previewPolicyList_ConfigurationPolicyPolicerClassListBuilder_3704",
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy list": {
"description": "Policy list"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Preview policy list": {
"description": "Preview policy list",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/list/policer/preview/{id}": {
"get": {
"tags": [
"Configuration - Policy Policer Class List Builder"
],
"description": "Preview a specific policy list entry based on id provided",
"operationId": "previewPolicyListById_ConfigurationPolicyPolicerClassListBuilder_4203",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Preview policy list": {
"description": "Preview policy list",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/list/policer/{id}": {
"get": {
"tags": [
"Configuration - Policy Policer Class List Builder"
],
"description": "Get a specific policy list based on the id",
"operationId": "getListsById_ConfigurationPolicyPolicerClassListBuilder_3403",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy": {
"description": "Policy",
"value": {
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6",
"name": "Community",
"type": "community",
"description": "Desc Not Required",
"entries": [
{
"community": "1000:5000"
}
],
"lastUpdated": 1590184928436,
"owner": "admin",
"readOnly": false,
"version": "0",
"infoTag": "",
"referenceCount": 0,
"references": [],
"isActivatedByVsmart": false
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
},
"put": {
"tags": [
"Configuration - Policy Policer Class List Builder"
],
"description": "Edit policy list entries for a specific type of policy list",
"operationId": "editPolicyList_ConfigurationPolicyPolicerClassListBuilder_3403",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": {
"name": "Community",
"description": "Desc Not Required",
"type": "community",
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6",
"entries": [
{
"community": "1000:8000"
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy": {
"description": "Policy",
"value": {
"masterTemplatesAffected": []
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"delete": {
"tags": [
"Configuration - Policy Policer Class List Builder"
],
"description": "Delete policy list entry for a specific type of policy list",
"operationId": "deletePolicyList_ConfigurationPolicyPolicerClassListBuilder_3406",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/list/port": {
"get": {
"tags": [
"Configuration - Policy Port List Builder"
],
"description": "Get policy lists",
"operationId": "getPolicyLists_ConfigurationPolicyPortListBuilder_2603",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"App Policy": {
"description": "App Policy",
"value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"
},
"Prefix List": {
"description": "Prefix List",
"value": {
"data": [
{
"listId": "8bc43c09-f72c-40b8-aa90-608c7005e607",
"name": "Example",
"type": "prefix",
"description": "Desc Not Required",
"entries": [
{
"ipPrefix": "10.0.0.0/24"
}
],
"lastUpdated": 1588178457305,
"owner": "admin",
"readOnly": false,
"version": "0",
"infoTag": "",
"referenceCount": 0,
"references": [],
"isActivatedByVsmart": false
}
]
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
},
"post": {
"tags": [
"Configuration - Policy Port List Builder"
],
"description": "Create policy list",
"operationId": "createPolicyList_ConfigurationPolicyPortListBuilder_2604",
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Zone list": {
"description": "Zone list",
"value": {
"name": "Demo-Zone",
"description": "Desc Not Required",
"type": "zone",
"entries": [
{
"vpn": "10"
}
]
}
},
"IPS list": {
"description": "IPS list",
"value": {
"name": "Demo-IPS-list",
"description": "Desc Not Required",
"type": "ipssignature",
"entries": [
{
"generatorId": "1111",
"signatureId": "4444"
}
]
}
},
"URL white list": {
"description": "URL white list",
"value": {
"name": "Demo-Whitelist",
"description": "Desc Not Required",
"type": "urlwhitelist",
"entries": [
{
"pattern": "https://www.youtube.com"
}
]
}
},
"URL black list": {
"description": "URL black list",
"value": {
"name": "Demo-Black-list",
"description": "Desc Not Required",
"type": "urlblacklist",
"entries": [
{
"pattern": "www.facebook.com"
}
]
}
},
"TG API key list": {
"description": "TG API key list",
"value": {
"name": "threatGridApiKeyList",
"description": "",
"type": "threatGridApiKey",
"entries": [
{
"region": "nam",
"apikey": "1234567"
},
{
"region": "eur",
"apikey": "1234567"
}
]
}
},
"Local domain list": {
"description": "Local domain list",
"value": {
"name": "Demo-Domain-Name-List",
"description": "Desc Not Required",
"type": "localdomain",
"entries": [
{
"nameServer": "cisco.com"
}
]
}
},
"Umbrella data list": {
"description": "Umbrella data list",
"value": {
"name": "umbrellaTokenList",
"description": "",
"type": "umbrellaData",
"entries": [
{
"apiKey": "abcd",
"secret": "12345",
"umbOrgId": "23405",
"token": "abcedabcedabcedabcedabcedabcedabcedabced"
}
]
}
},
"App family": {
"description": "App family",
"value": {
"name": "Demo-App-List",
"description": "Desc Not Required",
"type": "app",
"entries": [
{
"appFamily": "web"
},
{
"appFamily": "audio-video"
}
]
}
},
"App list": {
"description": "App list",
"value": {
"name": "Demo-App-List",
"description": "Desc Not Required",
"type": "app",
"entries": [
{
"app": "facebook"
},
{
"app": "netshow"
}
]
}
},
"Color list": {
"description": "Color list",
"value": {
"name": "Demo-Color-List",
"description": "Desc Not Required",
"type": "color",
"entries": [
{
"color": "biz-internet"
},
{
"color": "public-internet"
}
]
}
},
"Data prefix": {
"description": "Data prefix",
"value": {
"name": "Demo-Data-Prefix-List",
"description": "Desc Not Required",
"type": "dataprefix",
"entries": [
{
"ipPrefix": "10.1.0.0/16"
},
{
"ipPrefix": "10.2.0.0/16"
}
]
}
},
"Policer": {
"description": "Policer",
"value": {
"name": "Demo-Policer-list",
"description": "Desc Not Required",
"type": "policer",
"entries": [
{
"burst": "16000",
"exceed": "drop",
"rate": "10000"
}
]
}
},
"Prefix": {
"description": "Prefix",
"value": {
"name": "Demo-Prefix-list",
"description": "Desc Not Required",
"type": "prefix",
"entries": [
{
"ipPrefix": "10.0.0.0/12",
"le": "32"
}
]
}
},
"Site": {
"description": "Site",
"value": {
"name": "Demo-Site-List",
"description": "Desc Not Required",
"type": "site",
"listId": null,
"entries": [
{
"siteId": "100"
},
{
"siteId": "200"
},
{
"siteId": "300-500"
}
]
}
},
"Class": {
"description": "Class",
"value": {
"name": "Demo-Class-Map",
"description": "Desc Not Required",
"type": "class",
"entries": [
{
"queue": "4"
}
]
}
},
"App probe": {
"description": "App probe",
"value": {
"name": "Demo-Probe-Class",
"type": "appProbe",
"entries": [
{
"map": [
{
"color": "biz-internet",
"dscp": 46
},
{
"color": "public-internet",
"dscp": 20
}
],
"forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70"
}
]
}
},
"SLA": {
"description": "SLA",
"value": {
"name": "Demo-SLA-Class",
"description": "Desc Not Required",
"type": "sla",
"entries": [
{
"latency": "100",
"loss": "10",
"jitter": "10",
"appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d"
}
]
}
},
"TLOC": {
"description": "TLOC",
"value": {
"name": "Demo-TLOC-List",
"description": "Desc Not Required",
"type": "tloc",
"entries": [
{
"tloc": "10.1.1.1",
"color": "biz-internet",
"encap": "ipsec",
"preference": "10"
},
{
"tloc": "10.2.2.2",
"color": "biz-internet",
"encap": "ipsec",
"preference": "20"
}
]
}
},
"VPN": {
"description": "VPN",
"value": {
"name": "Demo-VPN-List",
"description": "Desc Not Required",
"type": "vpn",
"listId": null,
"entries": [
{
"vpn": "100"
},
{
"vpn": "200"
},
{
"vpn": "300-500"
}
]
}
},
"AS path": {
"description": "AS path",
"value": {
"name": "Demo-AS-Path-List",
"description": "Desc Not Required",
"type": "aspath",
"listId": null,
"entries": [
{
"asPath": "100"
},
{
"asPath": "200"
},
{
"asPath": "65002"
}
]
}
},
"Community": {
"description": "Community",
"value": {
"name": "Demo-Community-List",
"description": "Desc Not Required",
"type": "community",
"listId": null,
"entries": [
{
"community": "1000:10000"
}
]
}
},
"Ext community": {
"description": "Ext community",
"value": {
"name": "Demo-Extended-Community-List",
"description": "Desc Not Required",
"type": "extcommunity",
"listId": null,
"entries": [
{
"community": "rt 100:10"
}
]
}
},
"Mirror": {
"description": "Mirror",
"value": {
"name": "Demo-Mirror-List",
"description": "Desc Not Required",
"type": "mirror",
"entries": [
{
"remoteDest": "10.1.1.1",
"source": "20.1.1.1"
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Task Id": {
"description": "Task Id",
"value": {
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6"
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"delete": {
"tags": [
"Configuration - Policy Port List Builder"
],
"description": "Delete policy lists with specific info tag",
"operationId": "deletePolicyListsWithInfoTag_ConfigurationPolicyPortListBuilder_2606",
"parameters": [
{
"name": "infoTag",
"in": "query",
"description": "InfoTag",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/list/port/filtered": {
"get": {
"tags": [
"Configuration - Policy Port List Builder"
],
"description": "Get policy lists with specific info tag",
"operationId": "getPolicyListsWithInfoTag_ConfigurationPolicyPortListBuilder_3503",
"parameters": [
{
"name": "infoTag",
"in": "query",
"description": "InfoTag",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/list/port/preview": {
"post": {
"tags": [
"Configuration - Policy Port List Builder"
],
"description": "Preview a policy list based on the policy list type",
"operationId": "previewPolicyList_ConfigurationPolicyPortListBuilder_3404",
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy list": {
"description": "Policy list"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Preview policy list": {
"description": "Preview policy list",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/list/port/preview/{id}": {
"get": {
"tags": [
"Configuration - Policy Port List Builder"
],
"description": "Preview a specific policy list entry based on id provided",
"operationId": "previewPolicyListById_ConfigurationPolicyPortListBuilder_3903",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Preview policy list": {
"description": "Preview policy list",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/list/port/{id}": {
"get": {
"tags": [
"Configuration - Policy Port List Builder"
],
"description": "Get a specific policy list based on the id",
"operationId": "getListsById_ConfigurationPolicyPortListBuilder_3103",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy": {
"description": "Policy",
"value": {
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6",
"name": "Community",
"type": "community",
"description": "Desc Not Required",
"entries": [
{
"community": "1000:5000"
}
],
"lastUpdated": 1590184928436,
"owner": "admin",
"readOnly": false,
"version": "0",
"infoTag": "",
"referenceCount": 0,
"references": [],
"isActivatedByVsmart": false
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
},
"put": {
"tags": [
"Configuration - Policy Port List Builder"
],
"description": "Edit policy list entries for a specific type of policy list",
"operationId": "editPolicyList_ConfigurationPolicyPortListBuilder_3103",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": {
"name": "Community",
"description": "Desc Not Required",
"type": "community",
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6",
"entries": [
{
"community": "1000:8000"
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy": {
"description": "Policy",
"value": {
"masterTemplatesAffected": []
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"delete": {
"tags": [
"Configuration - Policy Port List Builder"
],
"description": "Delete policy list entry for a specific type of policy list",
"operationId": "deletePolicyList_ConfigurationPolicyPortListBuilder_3106",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/list/preferredcolorgroup": {
"get": {
"tags": [
"Configuration - Preferred Color Group List Builder"
],
"description": "Get policy lists",
"operationId": "getPolicyLists_ConfigurationPreferredColorGroupListBuilder_4103",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"App Policy": {
"description": "App Policy",
"value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"
},
"Prefix List": {
"description": "Prefix List",
"value": {
"data": [
{
"listId": "8bc43c09-f72c-40b8-aa90-608c7005e607",
"name": "Example",
"type": "prefix",
"description": "Desc Not Required",
"entries": [
{
"ipPrefix": "10.0.0.0/24"
}
],
"lastUpdated": 1588178457305,
"owner": "admin",
"readOnly": false,
"version": "0",
"infoTag": "",
"referenceCount": 0,
"references": [],
"isActivatedByVsmart": false
}
]
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
},
"post": {
"tags": [
"Configuration - Preferred Color Group List Builder"
],
"description": "Create policy list",
"operationId": "createPolicyList_ConfigurationPreferredColorGroupListBuilder_4104",
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Zone list": {
"description": "Zone list",
"value": {
"name": "Demo-Zone",
"description": "Desc Not Required",
"type": "zone",
"entries": [
{
"vpn": "10"
}
]
}
},
"IPS list": {
"description": "IPS list",
"value": {
"name": "Demo-IPS-list",
"description": "Desc Not Required",
"type": "ipssignature",
"entries": [
{
"generatorId": "1111",
"signatureId": "4444"
}
]
}
},
"URL white list": {
"description": "URL white list",
"value": {
"name": "Demo-Whitelist",
"description": "Desc Not Required",
"type": "urlwhitelist",
"entries": [
{
"pattern": "https://www.youtube.com"
}
]
}
},
"URL black list": {
"description": "URL black list",
"value": {
"name": "Demo-Black-list",
"description": "Desc Not Required",
"type": "urlblacklist",
"entries": [
{
"pattern": "www.facebook.com"
}
]
}
},
"TG API key list": {
"description": "TG API key list",
"value": {
"name": "threatGridApiKeyList",
"description": "",
"type": "threatGridApiKey",
"entries": [
{
"region": "nam",
"apikey": "1234567"
},
{
"region": "eur",
"apikey": "1234567"
}
]
}
},
"Local domain list": {
"description": "Local domain list",
"value": {
"name": "Demo-Domain-Name-List",
"description": "Desc Not Required",
"type": "localdomain",
"entries": [
{
"nameServer": "cisco.com"
}
]
}
},
"Umbrella data list": {
"description": "Umbrella data list",
"value": {
"name": "umbrellaTokenList",
"description": "",
"type": "umbrellaData",
"entries": [
{
"apiKey": "abcd",
"secret": "12345",
"umbOrgId": "23405",
"token": "abcedabcedabcedabcedabcedabcedabcedabced"
}
]
}
},
"App family": {
"description": "App family",
"value": {
"name": "Demo-App-List",
"description": "Desc Not Required",
"type": "app",
"entries": [
{
"appFamily": "web"
},
{
"appFamily": "audio-video"
}
]
}
},
"App list": {
"description": "App list",
"value": {
"name": "Demo-App-List",
"description": "Desc Not Required",
"type": "app",
"entries": [
{
"app": "facebook"
},
{
"app": "netshow"
}
]
}
},
"Color list": {
"description": "Color list",
"value": {
"name": "Demo-Color-List",
"description": "Desc Not Required",
"type": "color",
"entries": [
{
"color": "biz-internet"
},
{
"color": "public-internet"
}
]
}
},
"Data prefix": {
"description": "Data prefix",
"value": {
"name": "Demo-Data-Prefix-List",
"description": "Desc Not Required",
"type": "dataprefix",
"entries": [
{
"ipPrefix": "10.1.0.0/16"
},
{
"ipPrefix": "10.2.0.0/16"
}
]
}
},
"Policer": {
"description": "Policer",
"value": {
"name": "Demo-Policer-list",
"description": "Desc Not Required",
"type": "policer",
"entries": [
{
"burst": "16000",
"exceed": "drop",
"rate": "10000"
}
]
}
},
"Prefix": {
"description": "Prefix",
"value": {
"name": "Demo-Prefix-list",
"description": "Desc Not Required",
"type": "prefix",
"entries": [
{
"ipPrefix": "10.0.0.0/12",
"le": "32"
}
]
}
},
"Site": {
"description": "Site",
"value": {
"name": "Demo-Site-List",
"description": "Desc Not Required",
"type": "site",
"listId": null,
"entries": [
{
"siteId": "100"
},
{
"siteId": "200"
},
{
"siteId": "300-500"
}
]
}
},
"Class": {
"description": "Class",
"value": {
"name": "Demo-Class-Map",
"description": "Desc Not Required",
"type": "class",
"entries": [
{
"queue": "4"
}
]
}
},
"App probe": {
"description": "App probe",
"value": {
"name": "Demo-Probe-Class",
"type": "appProbe",
"entries": [
{
"map": [
{
"color": "biz-internet",
"dscp": 46
},
{
"color": "public-internet",
"dscp": 20
}
],
"forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70"
}
]
}
},
"SLA": {
"description": "SLA",
"value": {
"name": "Demo-SLA-Class",
"description": "Desc Not Required",
"type": "sla",
"entries": [
{
"latency": "100",
"loss": "10",
"jitter": "10",
"appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d"
}
]
}
},
"TLOC": {
"description": "TLOC",
"value": {
"name": "Demo-TLOC-List",
"description": "Desc Not Required",
"type": "tloc",
"entries": [
{
"tloc": "10.1.1.1",
"color": "biz-internet",
"encap": "ipsec",
"preference": "10"
},
{
"tloc": "10.2.2.2",
"color": "biz-internet",
"encap": "ipsec",
"preference": "20"
}
]
}
},
"VPN": {
"description": "VPN",
"value": {
"name": "Demo-VPN-List",
"description": "Desc Not Required",
"type": "vpn",
"listId": null,
"entries": [
{
"vpn": "100"
},
{
"vpn": "200"
},
{
"vpn": "300-500"
}
]
}
},
"AS path": {
"description": "AS path",
"value": {
"name": "Demo-AS-Path-List",
"description": "Desc Not Required",
"type": "aspath",
"listId": null,
"entries": [
{
"asPath": "100"
},
{
"asPath": "200"
},
{
"asPath": "65002"
}
]
}
},
"Community": {
"description": "Community",
"value": {
"name": "Demo-Community-List",
"description": "Desc Not Required",
"type": "community",
"listId": null,
"entries": [
{
"community": "1000:10000"
}
]
}
},
"Ext community": {
"description": "Ext community",
"value": {
"name": "Demo-Extended-Community-List",
"description": "Desc Not Required",
"type": "extcommunity",
"listId": null,
"entries": [
{
"community": "rt 100:10"
}
]
}
},
"Mirror": {
"description": "Mirror",
"value": {
"name": "Demo-Mirror-List",
"description": "Desc Not Required",
"type": "mirror",
"entries": [
{
"remoteDest": "10.1.1.1",
"source": "20.1.1.1"
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Task Id": {
"description": "Task Id",
"value": {
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6"
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"delete": {
"tags": [
"Configuration - Preferred Color Group List Builder"
],
"description": "Delete policy lists with specific info tag",
"operationId": "deletePolicyListsWithInfoTag_ConfigurationPreferredColorGroupListBuilder_4106",
"parameters": [
{
"name": "infoTag",
"in": "query",
"description": "InfoTag",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/list/preferredcolorgroup/filtered": {
"get": {
"tags": [
"Configuration - Preferred Color Group List Builder"
],
"description": "Get policy lists with specific info tag",
"operationId": "getPolicyListsWithInfoTag_ConfigurationPreferredColorGroupListBuilder_5003",
"parameters": [
{
"name": "infoTag",
"in": "query",
"description": "InfoTag",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/list/preferredcolorgroup/preview": {
"post": {
"tags": [
"Configuration - Preferred Color Group List Builder"
],
"description": "Preview a policy list based on the policy list type",
"operationId": "previewPolicyList_ConfigurationPreferredColorGroupListBuilder_4904",
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy list": {
"description": "Policy list"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Preview policy list": {
"description": "Preview policy list",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/list/preferredcolorgroup/preview/{id}": {
"get": {
"tags": [
"Configuration - Preferred Color Group List Builder"
],
"description": "Preview a specific policy list entry based on id provided",
"operationId": "previewPolicyListById_ConfigurationPreferredColorGroupListBuilder_5403",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Preview policy list": {
"description": "Preview policy list",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/list/preferredcolorgroup/{id}": {
"put": {
"tags": [
"Configuration - Preferred Color Group List Builder"
],
"description": "Edit policy list entries for a specific type of policy list",
"operationId": "editPolicyList_ConfigurationPreferredColorGroupListBuilder_4603",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": {
"name": "Community",
"description": "Desc Not Required",
"type": "community",
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6",
"entries": [
{
"community": "1000:8000"
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy": {
"description": "Policy",
"value": {
"masterTemplatesAffected": []
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"get": {
"tags": [
"Configuration - Preferred Color Group List Builder"
],
"description": "Get a specific policy list based on the id",
"operationId": "getListsById_ConfigurationPreferredColorGroupListBuilder_4603",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy": {
"description": "Policy",
"value": {
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6",
"name": "Community",
"type": "community",
"description": "Desc Not Required",
"entries": [
{
"community": "1000:5000"
}
],
"lastUpdated": 1590184928436,
"owner": "admin",
"readOnly": false,
"version": "0",
"infoTag": "",
"referenceCount": 0,
"references": [],
"isActivatedByVsmart": false
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
},
"delete": {
"tags": [
"Configuration - Preferred Color Group List Builder"
],
"description": "Delete policy list entry for a specific type of policy list",
"operationId": "deletePolicyList_ConfigurationPreferredColorGroupListBuilder_4606",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/list/prefix": {
"post": {
"tags": [
"Configuration - Policy Prefix List Builder"
],
"description": "Create policy list",
"operationId": "createPolicyList_ConfigurationPolicyPrefixListBuilder_2804",
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Zone list": {
"description": "Zone list",
"value": {
"name": "Demo-Zone",
"description": "Desc Not Required",
"type": "zone",
"entries": [
{
"vpn": "10"
}
]
}
},
"IPS list": {
"description": "IPS list",
"value": {
"name": "Demo-IPS-list",
"description": "Desc Not Required",
"type": "ipssignature",
"entries": [
{
"generatorId": "1111",
"signatureId": "4444"
}
]
}
},
"URL white list": {
"description": "URL white list",
"value": {
"name": "Demo-Whitelist",
"description": "Desc Not Required",
"type": "urlwhitelist",
"entries": [
{
"pattern": "https://www.youtube.com"
}
]
}
},
"URL black list": {
"description": "URL black list",
"value": {
"name": "Demo-Black-list",
"description": "Desc Not Required",
"type": "urlblacklist",
"entries": [
{
"pattern": "www.facebook.com"
}
]
}
},
"TG API key list": {
"description": "TG API key list",
"value": {
"name": "threatGridApiKeyList",
"description": "",
"type": "threatGridApiKey",
"entries": [
{
"region": "nam",
"apikey": "1234567"
},
{
"region": "eur",
"apikey": "1234567"
}
]
}
},
"Local domain list": {
"description": "Local domain list",
"value": {
"name": "Demo-Domain-Name-List",
"description": "Desc Not Required",
"type": "localdomain",
"entries": [
{
"nameServer": "cisco.com"
}
]
}
},
"Umbrella data list": {
"description": "Umbrella data list",
"value": {
"name": "umbrellaTokenList",
"description": "",
"type": "umbrellaData",
"entries": [
{
"apiKey": "abcd",
"secret": "12345",
"umbOrgId": "23405",
"token": "abcedabcedabcedabcedabcedabcedabcedabced"
}
]
}
},
"App family": {
"description": "App family",
"value": {
"name": "Demo-App-List",
"description": "Desc Not Required",
"type": "app",
"entries": [
{
"appFamily": "web"
},
{
"appFamily": "audio-video"
}
]
}
},
"App list": {
"description": "App list",
"value": {
"name": "Demo-App-List",
"description": "Desc Not Required",
"type": "app",
"entries": [
{
"app": "facebook"
},
{
"app": "netshow"
}
]
}
},
"Color list": {
"description": "Color list",
"value": {
"name": "Demo-Color-List",
"description": "Desc Not Required",
"type": "color",
"entries": [
{
"color": "biz-internet"
},
{
"color": "public-internet"
}
]
}
},
"Data prefix": {
"description": "Data prefix",
"value": {
"name": "Demo-Data-Prefix-List",
"description": "Desc Not Required",
"type": "dataprefix",
"entries": [
{
"ipPrefix": "10.1.0.0/16"
},
{
"ipPrefix": "10.2.0.0/16"
}
]
}
},
"Policer": {
"description": "Policer",
"value": {
"name": "Demo-Policer-list",
"description": "Desc Not Required",
"type": "policer",
"entries": [
{
"burst": "16000",
"exceed": "drop",
"rate": "10000"
}
]
}
},
"Prefix": {
"description": "Prefix",
"value": {
"name": "Demo-Prefix-list",
"description": "Desc Not Required",
"type": "prefix",
"entries": [
{
"ipPrefix": "10.0.0.0/12",
"le": "32"
}
]
}
},
"Site": {
"description": "Site",
"value": {
"name": "Demo-Site-List",
"description": "Desc Not Required",
"type": "site",
"listId": null,
"entries": [
{
"siteId": "100"
},
{
"siteId": "200"
},
{
"siteId": "300-500"
}
]
}
},
"Class": {
"description": "Class",
"value": {
"name": "Demo-Class-Map",
"description": "Desc Not Required",
"type": "class",
"entries": [
{
"queue": "4"
}
]
}
},
"App probe": {
"description": "App probe",
"value": {
"name": "Demo-Probe-Class",
"type": "appProbe",
"entries": [
{
"map": [
{
"color": "biz-internet",
"dscp": 46
},
{
"color": "public-internet",
"dscp": 20
}
],
"forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70"
}
]
}
},
"SLA": {
"description": "SLA",
"value": {
"name": "Demo-SLA-Class",
"description": "Desc Not Required",
"type": "sla",
"entries": [
{
"latency": "100",
"loss": "10",
"jitter": "10",
"appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d"
}
]
}
},
"TLOC": {
"description": "TLOC",
"value": {
"name": "Demo-TLOC-List",
"description": "Desc Not Required",
"type": "tloc",
"entries": [
{
"tloc": "10.1.1.1",
"color": "biz-internet",
"encap": "ipsec",
"preference": "10"
},
{
"tloc": "10.2.2.2",
"color": "biz-internet",
"encap": "ipsec",
"preference": "20"
}
]
}
},
"VPN": {
"description": "VPN",
"value": {
"name": "Demo-VPN-List",
"description": "Desc Not Required",
"type": "vpn",
"listId": null,
"entries": [
{
"vpn": "100"
},
{
"vpn": "200"
},
{
"vpn": "300-500"
}
]
}
},
"AS path": {
"description": "AS path",
"value": {
"name": "Demo-AS-Path-List",
"description": "Desc Not Required",
"type": "aspath",
"listId": null,
"entries": [
{
"asPath": "100"
},
{
"asPath": "200"
},
{
"asPath": "65002"
}
]
}
},
"Community": {
"description": "Community",
"value": {
"name": "Demo-Community-List",
"description": "Desc Not Required",
"type": "community",
"listId": null,
"entries": [
{
"community": "1000:10000"
}
]
}
},
"Ext community": {
"description": "Ext community",
"value": {
"name": "Demo-Extended-Community-List",
"description": "Desc Not Required",
"type": "extcommunity",
"listId": null,
"entries": [
{
"community": "rt 100:10"
}
]
}
},
"Mirror": {
"description": "Mirror",
"value": {
"name": "Demo-Mirror-List",
"description": "Desc Not Required",
"type": "mirror",
"entries": [
{
"remoteDest": "10.1.1.1",
"source": "20.1.1.1"
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Task Id": {
"description": "Task Id",
"value": {
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6"
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"get": {
"tags": [
"Configuration - Policy Prefix List Builder"
],
"description": "Get policy lists",
"operationId": "getPolicyLists_ConfigurationPolicyPrefixListBuilder_2803",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"App Policy": {
"description": "App Policy",
"value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"
},
"Prefix List": {
"description": "Prefix List",
"value": {
"data": [
{
"listId": "8bc43c09-f72c-40b8-aa90-608c7005e607",
"name": "Example",
"type": "prefix",
"description": "Desc Not Required",
"entries": [
{
"ipPrefix": "10.0.0.0/24"
}
],
"lastUpdated": 1588178457305,
"owner": "admin",
"readOnly": false,
"version": "0",
"infoTag": "",
"referenceCount": 0,
"references": [],
"isActivatedByVsmart": false
}
]
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
},
"delete": {
"tags": [
"Configuration - Policy Prefix List Builder"
],
"description": "Delete policy lists with specific info tag",
"operationId": "deletePolicyListsWithInfoTag_ConfigurationPolicyPrefixListBuilder_2806",
"parameters": [
{
"name": "infoTag",
"in": "query",
"description": "InfoTag",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/list/prefix/filtered": {
"get": {
"tags": [
"Configuration - Policy Prefix List Builder"
],
"description": "Get policy lists with specific info tag",
"operationId": "getPolicyListsWithInfoTag_ConfigurationPolicyPrefixListBuilder_3703",
"parameters": [
{
"name": "infoTag",
"in": "query",
"description": "InfoTag",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/list/prefix/preview": {
"post": {
"tags": [
"Configuration - Policy Prefix List Builder"
],
"description": "Preview a policy list based on the policy list type",
"operationId": "previewPolicyList_ConfigurationPolicyPrefixListBuilder_3604",
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy list": {
"description": "Policy list"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Preview policy list": {
"description": "Preview policy list",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/list/prefix/preview/{id}": {
"get": {
"tags": [
"Configuration - Policy Prefix List Builder"
],
"description": "Preview a specific policy list entry based on id provided",
"operationId": "previewPolicyListById_ConfigurationPolicyPrefixListBuilder_4103",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Preview policy list": {
"description": "Preview policy list",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/list/prefix/{id}": {
"get": {
"tags": [
"Configuration - Policy Prefix List Builder"
],
"description": "Get a specific policy list based on the id",
"operationId": "getListsById_ConfigurationPolicyPrefixListBuilder_3303",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy": {
"description": "Policy",
"value": {
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6",
"name": "Community",
"type": "community",
"description": "Desc Not Required",
"entries": [
{
"community": "1000:5000"
}
],
"lastUpdated": 1590184928436,
"owner": "admin",
"readOnly": false,
"version": "0",
"infoTag": "",
"referenceCount": 0,
"references": [],
"isActivatedByVsmart": false
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
},
"delete": {
"tags": [
"Configuration - Policy Prefix List Builder"
],
"description": "Delete policy list entry for a specific type of policy list",
"operationId": "deletePolicyList_ConfigurationPolicyPrefixListBuilder_3306",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"put": {
"tags": [
"Configuration - Policy Prefix List Builder"
],
"description": "Edit policy list entries for a specific type of policy list",
"operationId": "editPolicyList_ConfigurationPolicyPrefixListBuilder_3303",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": {
"name": "Community",
"description": "Desc Not Required",
"type": "community",
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6",
"entries": [
{
"community": "1000:8000"
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy": {
"description": "Policy",
"value": {
"masterTemplatesAffected": []
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/list/protocolname": {
"post": {
"tags": [
"Configuration - Policy Protocol Name List Builder"
],
"description": "Create policy list",
"operationId": "createPolicyList_ConfigurationPolicyProtocolNameListBuilder_3404",
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Zone list": {
"description": "Zone list",
"value": {
"name": "Demo-Zone",
"description": "Desc Not Required",
"type": "zone",
"entries": [
{
"vpn": "10"
}
]
}
},
"IPS list": {
"description": "IPS list",
"value": {
"name": "Demo-IPS-list",
"description": "Desc Not Required",
"type": "ipssignature",
"entries": [
{
"generatorId": "1111",
"signatureId": "4444"
}
]
}
},
"URL white list": {
"description": "URL white list",
"value": {
"name": "Demo-Whitelist",
"description": "Desc Not Required",
"type": "urlwhitelist",
"entries": [
{
"pattern": "https://www.youtube.com"
}
]
}
},
"URL black list": {
"description": "URL black list",
"value": {
"name": "Demo-Black-list",
"description": "Desc Not Required",
"type": "urlblacklist",
"entries": [
{
"pattern": "www.facebook.com"
}
]
}
},
"TG API key list": {
"description": "TG API key list",
"value": {
"name": "threatGridApiKeyList",
"description": "",
"type": "threatGridApiKey",
"entries": [
{
"region": "nam",
"apikey": "1234567"
},
{
"region": "eur",
"apikey": "1234567"
}
]
}
},
"Local domain list": {
"description": "Local domain list",
"value": {
"name": "Demo-Domain-Name-List",
"description": "Desc Not Required",
"type": "localdomain",
"entries": [
{
"nameServer": "cisco.com"
}
]
}
},
"Umbrella data list": {
"description": "Umbrella data list",
"value": {
"name": "umbrellaTokenList",
"description": "",
"type": "umbrellaData",
"entries": [
{
"apiKey": "abcd",
"secret": "12345",
"umbOrgId": "23405",
"token": "abcedabcedabcedabcedabcedabcedabcedabced"
}
]
}
},
"App family": {
"description": "App family",
"value": {
"name": "Demo-App-List",
"description": "Desc Not Required",
"type": "app",
"entries": [
{
"appFamily": "web"
},
{
"appFamily": "audio-video"
}
]
}
},
"App list": {
"description": "App list",
"value": {
"name": "Demo-App-List",
"description": "Desc Not Required",
"type": "app",
"entries": [
{
"app": "facebook"
},
{
"app": "netshow"
}
]
}
},
"Color list": {
"description": "Color list",
"value": {
"name": "Demo-Color-List",
"description": "Desc Not Required",
"type": "color",
"entries": [
{
"color": "biz-internet"
},
{
"color": "public-internet"
}
]
}
},
"Data prefix": {
"description": "Data prefix",
"value": {
"name": "Demo-Data-Prefix-List",
"description": "Desc Not Required",
"type": "dataprefix",
"entries": [
{
"ipPrefix": "10.1.0.0/16"
},
{
"ipPrefix": "10.2.0.0/16"
}
]
}
},
"Policer": {
"description": "Policer",
"value": {
"name": "Demo-Policer-list",
"description": "Desc Not Required",
"type": "policer",
"entries": [
{
"burst": "16000",
"exceed": "drop",
"rate": "10000"
}
]
}
},
"Prefix": {
"description": "Prefix",
"value": {
"name": "Demo-Prefix-list",
"description": "Desc Not Required",
"type": "prefix",
"entries": [
{
"ipPrefix": "10.0.0.0/12",
"le": "32"
}
]
}
},
"Site": {
"description": "Site",
"value": {
"name": "Demo-Site-List",
"description": "Desc Not Required",
"type": "site",
"listId": null,
"entries": [
{
"siteId": "100"
},
{
"siteId": "200"
},
{
"siteId": "300-500"
}
]
}
},
"Class": {
"description": "Class",
"value": {
"name": "Demo-Class-Map",
"description": "Desc Not Required",
"type": "class",
"entries": [
{
"queue": "4"
}
]
}
},
"App probe": {
"description": "App probe",
"value": {
"name": "Demo-Probe-Class",
"type": "appProbe",
"entries": [
{
"map": [
{
"color": "biz-internet",
"dscp": 46
},
{
"color": "public-internet",
"dscp": 20
}
],
"forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70"
}
]
}
},
"SLA": {
"description": "SLA",
"value": {
"name": "Demo-SLA-Class",
"description": "Desc Not Required",
"type": "sla",
"entries": [
{
"latency": "100",
"loss": "10",
"jitter": "10",
"appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d"
}
]
}
},
"TLOC": {
"description": "TLOC",
"value": {
"name": "Demo-TLOC-List",
"description": "Desc Not Required",
"type": "tloc",
"entries": [
{
"tloc": "10.1.1.1",
"color": "biz-internet",
"encap": "ipsec",
"preference": "10"
},
{
"tloc": "10.2.2.2",
"color": "biz-internet",
"encap": "ipsec",
"preference": "20"
}
]
}
},
"VPN": {
"description": "VPN",
"value": {
"name": "Demo-VPN-List",
"description": "Desc Not Required",
"type": "vpn",
"listId": null,
"entries": [
{
"vpn": "100"
},
{
"vpn": "200"
},
{
"vpn": "300-500"
}
]
}
},
"AS path": {
"description": "AS path",
"value": {
"name": "Demo-AS-Path-List",
"description": "Desc Not Required",
"type": "aspath",
"listId": null,
"entries": [
{
"asPath": "100"
},
{
"asPath": "200"
},
{
"asPath": "65002"
}
]
}
},
"Community": {
"description": "Community",
"value": {
"name": "Demo-Community-List",
"description": "Desc Not Required",
"type": "community",
"listId": null,
"entries": [
{
"community": "1000:10000"
}
]
}
},
"Ext community": {
"description": "Ext community",
"value": {
"name": "Demo-Extended-Community-List",
"description": "Desc Not Required",
"type": "extcommunity",
"listId": null,
"entries": [
{
"community": "rt 100:10"
}
]
}
},
"Mirror": {
"description": "Mirror",
"value": {
"name": "Demo-Mirror-List",
"description": "Desc Not Required",
"type": "mirror",
"entries": [
{
"remoteDest": "10.1.1.1",
"source": "20.1.1.1"
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Task Id": {
"description": "Task Id",
"value": {
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6"
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"get": {
"tags": [
"Configuration - Policy Protocol Name List Builder"
],
"description": "Get policy lists",
"operationId": "getPolicyLists_ConfigurationPolicyProtocolNameListBuilder_3403",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"App Policy": {
"description": "App Policy",
"value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"
},
"Prefix List": {
"description": "Prefix List",
"value": {
"data": [
{
"listId": "8bc43c09-f72c-40b8-aa90-608c7005e607",
"name": "Example",
"type": "prefix",
"description": "Desc Not Required",
"entries": [
{
"ipPrefix": "10.0.0.0/24"
}
],
"lastUpdated": 1588178457305,
"owner": "admin",
"readOnly": false,
"version": "0",
"infoTag": "",
"referenceCount": 0,
"references": [],
"isActivatedByVsmart": false
}
]
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
},
"delete": {
"tags": [
"Configuration - Policy Protocol Name List Builder"
],
"description": "Delete policy lists with specific info tag",
"operationId": "deletePolicyListsWithInfoTag_ConfigurationPolicyProtocolNameListBuilder_3406",
"parameters": [
{
"name": "infoTag",
"in": "query",
"description": "InfoTag",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/list/protocolname/filtered": {
"get": {
"tags": [
"Configuration - Policy Protocol Name List Builder"
],
"description": "Get policy lists with specific info tag",
"operationId": "getPolicyListsWithInfoTag_ConfigurationPolicyProtocolNameListBuilder_4303",
"parameters": [
{
"name": "infoTag",
"in": "query",
"description": "InfoTag",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/list/protocolname/preview": {
"post": {
"tags": [
"Configuration - Policy Protocol Name List Builder"
],
"description": "Preview a policy list based on the policy list type",
"operationId": "previewPolicyList_ConfigurationPolicyProtocolNameListBuilder_4204",
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy list": {
"description": "Policy list"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Preview policy list": {
"description": "Preview policy list",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/list/protocolname/preview/{id}": {
"get": {
"tags": [
"Configuration - Policy Protocol Name List Builder"
],
"description": "Preview a specific policy list entry based on id provided",
"operationId": "previewPolicyListById_ConfigurationPolicyProtocolNameListBuilder_4703",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Preview policy list": {
"description": "Preview policy list",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/list/protocolname/{id}": {
"get": {
"tags": [
"Configuration - Policy Protocol Name List Builder"
],
"description": "Get a specific policy list based on the id",
"operationId": "getListsById_ConfigurationPolicyProtocolNameListBuilder_3903",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy": {
"description": "Policy",
"value": {
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6",
"name": "Community",
"type": "community",
"description": "Desc Not Required",
"entries": [
{
"community": "1000:5000"
}
],
"lastUpdated": 1590184928436,
"owner": "admin",
"readOnly": false,
"version": "0",
"infoTag": "",
"referenceCount": 0,
"references": [],
"isActivatedByVsmart": false
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
},
"put": {
"tags": [
"Configuration - Policy Protocol Name List Builder"
],
"description": "Edit policy list entries for a specific type of policy list",
"operationId": "editPolicyList_ConfigurationPolicyProtocolNameListBuilder_3903",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": {
"name": "Community",
"description": "Desc Not Required",
"type": "community",
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6",
"entries": [
{
"community": "1000:8000"
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy": {
"description": "Policy",
"value": {
"masterTemplatesAffected": []
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"delete": {
"tags": [
"Configuration - Policy Protocol Name List Builder"
],
"description": "Delete policy list entry for a specific type of policy list",
"operationId": "deletePolicyList_ConfigurationPolicyProtocolNameListBuilder_3906",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/list/region": {
"delete": {
"tags": [
"Configuration - Policy Region List Builder"
],
"description": "Delete policy lists with specific info tag",
"operationId": "deletePolicyListsWithInfoTag_ConfigurationPolicyRegionListBuilder_2806",
"parameters": [
{
"name": "infoTag",
"in": "query",
"description": "InfoTag",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
},
"post": {
"tags": [
"Configuration - Policy Region List Builder"
],
"description": "Create policy list",
"operationId": "createPolicyList_ConfigurationPolicyRegionListBuilder_2804",
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Zone list": {
"description": "Zone list",
"value": {
"name": "Demo-Zone",
"description": "Desc Not Required",
"type": "zone",
"entries": [
{
"vpn": "10"
}
]
}
},
"IPS list": {
"description": "IPS list",
"value": {
"name": "Demo-IPS-list",
"description": "Desc Not Required",
"type": "ipssignature",
"entries": [
{
"generatorId": "1111",
"signatureId": "4444"
}
]
}
},
"URL white list": {
"description": "URL white list",
"value": {
"name": "Demo-Whitelist",
"description": "Desc Not Required",
"type": "urlwhitelist",
"entries": [
{
"pattern": "https://www.youtube.com"
}
]
}
},
"URL black list": {
"description": "URL black list",
"value": {
"name": "Demo-Black-list",
"description": "Desc Not Required",
"type": "urlblacklist",
"entries": [
{
"pattern": "www.facebook.com"
}
]
}
},
"TG API key list": {
"description": "TG API key list",
"value": {
"name": "threatGridApiKeyList",
"description": "",
"type": "threatGridApiKey",
"entries": [
{
"region": "nam",
"apikey": "1234567"
},
{
"region": "eur",
"apikey": "1234567"
}
]
}
},
"Local domain list": {
"description": "Local domain list",
"value": {
"name": "Demo-Domain-Name-List",
"description": "Desc Not Required",
"type": "localdomain",
"entries": [
{
"nameServer": "cisco.com"
}
]
}
},
"Umbrella data list": {
"description": "Umbrella data list",
"value": {
"name": "umbrellaTokenList",
"description": "",
"type": "umbrellaData",
"entries": [
{
"apiKey": "abcd",
"secret": "12345",
"umbOrgId": "23405",
"token": "abcedabcedabcedabcedabcedabcedabcedabced"
}
]
}
},
"App family": {
"description": "App family",
"value": {
"name": "Demo-App-List",
"description": "Desc Not Required",
"type": "app",
"entries": [
{
"appFamily": "web"
},
{
"appFamily": "audio-video"
}
]
}
},
"App list": {
"description": "App list",
"value": {
"name": "Demo-App-List",
"description": "Desc Not Required",
"type": "app",
"entries": [
{
"app": "facebook"
},
{
"app": "netshow"
}
]
}
},
"Color list": {
"description": "Color list",
"value": {
"name": "Demo-Color-List",
"description": "Desc Not Required",
"type": "color",
"entries": [
{
"color": "biz-internet"
},
{
"color": "public-internet"
}
]
}
},
"Data prefix": {
"description": "Data prefix",
"value": {
"name": "Demo-Data-Prefix-List",
"description": "Desc Not Required",
"type": "dataprefix",
"entries": [
{
"ipPrefix": "10.1.0.0/16"
},
{
"ipPrefix": "10.2.0.0/16"
}
]
}
},
"Policer": {
"description": "Policer",
"value": {
"name": "Demo-Policer-list",
"description": "Desc Not Required",
"type": "policer",
"entries": [
{
"burst": "16000",
"exceed": "drop",
"rate": "10000"
}
]
}
},
"Prefix": {
"description": "Prefix",
"value": {
"name": "Demo-Prefix-list",
"description": "Desc Not Required",
"type": "prefix",
"entries": [
{
"ipPrefix": "10.0.0.0/12",
"le": "32"
}
]
}
},
"Site": {
"description": "Site",
"value": {
"name": "Demo-Site-List",
"description": "Desc Not Required",
"type": "site",
"listId": null,
"entries": [
{
"siteId": "100"
},
{
"siteId": "200"
},
{
"siteId": "300-500"
}
]
}
},
"Class": {
"description": "Class",
"value": {
"name": "Demo-Class-Map",
"description": "Desc Not Required",
"type": "class",
"entries": [
{
"queue": "4"
}
]
}
},
"App probe": {
"description": "App probe",
"value": {
"name": "Demo-Probe-Class",
"type": "appProbe",
"entries": [
{
"map": [
{
"color": "biz-internet",
"dscp": 46
},
{
"color": "public-internet",
"dscp": 20
}
],
"forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70"
}
]
}
},
"SLA": {
"description": "SLA",
"value": {
"name": "Demo-SLA-Class",
"description": "Desc Not Required",
"type": "sla",
"entries": [
{
"latency": "100",
"loss": "10",
"jitter": "10",
"appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d"
}
]
}
},
"TLOC": {
"description": "TLOC",
"value": {
"name": "Demo-TLOC-List",
"description": "Desc Not Required",
"type": "tloc",
"entries": [
{
"tloc": "10.1.1.1",
"color": "biz-internet",
"encap": "ipsec",
"preference": "10"
},
{
"tloc": "10.2.2.2",
"color": "biz-internet",
"encap": "ipsec",
"preference": "20"
}
]
}
},
"VPN": {
"description": "VPN",
"value": {
"name": "Demo-VPN-List",
"description": "Desc Not Required",
"type": "vpn",
"listId": null,
"entries": [
{
"vpn": "100"
},
{
"vpn": "200"
},
{
"vpn": "300-500"
}
]
}
},
"AS path": {
"description": "AS path",
"value": {
"name": "Demo-AS-Path-List",
"description": "Desc Not Required",
"type": "aspath",
"listId": null,
"entries": [
{
"asPath": "100"
},
{
"asPath": "200"
},
{
"asPath": "65002"
}
]
}
},
"Community": {
"description": "Community",
"value": {
"name": "Demo-Community-List",
"description": "Desc Not Required",
"type": "community",
"listId": null,
"entries": [
{
"community": "1000:10000"
}
]
}
},
"Ext community": {
"description": "Ext community",
"value": {
"name": "Demo-Extended-Community-List",
"description": "Desc Not Required",
"type": "extcommunity",
"listId": null,
"entries": [
{
"community": "rt 100:10"
}
]
}
},
"Mirror": {
"description": "Mirror",
"value": {
"name": "Demo-Mirror-List",
"description": "Desc Not Required",
"type": "mirror",
"entries": [
{
"remoteDest": "10.1.1.1",
"source": "20.1.1.1"
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Task Id": {
"description": "Task Id",
"value": {
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6"
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"get": {
"tags": [
"Configuration - Policy Region List Builder"
],
"description": "Get policy lists",
"operationId": "getPolicyLists_ConfigurationPolicyRegionListBuilder_2803",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"App Policy": {
"description": "App Policy",
"value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"
},
"Prefix List": {
"description": "Prefix List",
"value": {
"data": [
{
"listId": "8bc43c09-f72c-40b8-aa90-608c7005e607",
"name": "Example",
"type": "prefix",
"description": "Desc Not Required",
"entries": [
{
"ipPrefix": "10.0.0.0/24"
}
],
"lastUpdated": 1588178457305,
"owner": "admin",
"readOnly": false,
"version": "0",
"infoTag": "",
"referenceCount": 0,
"references": [],
"isActivatedByVsmart": false
}
]
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/list/region/filtered": {
"get": {
"tags": [
"Configuration - Policy Region List Builder"
],
"description": "Get policy lists with specific info tag",
"operationId": "getPolicyListsWithInfoTag_ConfigurationPolicyRegionListBuilder_3703",
"parameters": [
{
"name": "infoTag",
"in": "query",
"description": "InfoTag",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/list/region/preview": {
"post": {
"tags": [
"Configuration - Policy Region List Builder"
],
"description": "Preview a policy list based on the policy list type",
"operationId": "previewPolicyList_ConfigurationPolicyRegionListBuilder_3604",
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy list": {
"description": "Policy list"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Preview policy list": {
"description": "Preview policy list",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/list/region/preview/{id}": {
"get": {
"tags": [
"Configuration - Policy Region List Builder"
],
"description": "Preview a specific policy list entry based on id provided",
"operationId": "previewPolicyListById_ConfigurationPolicyRegionListBuilder_4103",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Preview policy list": {
"description": "Preview policy list",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/list/region/{id}": {
"put": {
"tags": [
"Configuration - Policy Region List Builder"
],
"description": "Edit policy list entries for a specific type of policy list",
"operationId": "editPolicyList_ConfigurationPolicyRegionListBuilder_3303",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": {
"name": "Community",
"description": "Desc Not Required",
"type": "community",
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6",
"entries": [
{
"community": "1000:8000"
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy": {
"description": "Policy",
"value": {
"masterTemplatesAffected": []
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"get": {
"tags": [
"Configuration - Policy Region List Builder"
],
"description": "Get a specific policy list based on the id",
"operationId": "getListsById_ConfigurationPolicyRegionListBuilder_3303",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy": {
"description": "Policy",
"value": {
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6",
"name": "Community",
"type": "community",
"description": "Desc Not Required",
"entries": [
{
"community": "1000:5000"
}
],
"lastUpdated": 1590184928436,
"owner": "admin",
"readOnly": false,
"version": "0",
"infoTag": "",
"referenceCount": 0,
"references": [],
"isActivatedByVsmart": false
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
},
"delete": {
"tags": [
"Configuration - Policy Region List Builder"
],
"description": "Delete policy list entry for a specific type of policy list",
"operationId": "deletePolicyList_ConfigurationPolicyRegionListBuilder_3306",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/list/scalablegrouptag": {
"get": {
"tags": [
"Configuration - Policy Scalable Group Tag List Builder"
],
"description": "Get policy lists",
"operationId": "getPolicyLists_ConfigurationPolicyScalableGroupTagListBuilder_3803",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"App Policy": {
"description": "App Policy",
"value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"
},
"Prefix List": {
"description": "Prefix List",
"value": {
"data": [
{
"listId": "8bc43c09-f72c-40b8-aa90-608c7005e607",
"name": "Example",
"type": "prefix",
"description": "Desc Not Required",
"entries": [
{
"ipPrefix": "10.0.0.0/24"
}
],
"lastUpdated": 1588178457305,
"owner": "admin",
"readOnly": false,
"version": "0",
"infoTag": "",
"referenceCount": 0,
"references": [],
"isActivatedByVsmart": false
}
]
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
},
"delete": {
"tags": [
"Configuration - Policy Scalable Group Tag List Builder"
],
"description": "Delete policy lists with specific info tag",
"operationId": "deletePolicyListsWithInfoTag_ConfigurationPolicyScalableGroupTagListBuilder_3806",
"parameters": [
{
"name": "infoTag",
"in": "query",
"description": "InfoTag",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
},
"post": {
"tags": [
"Configuration - Policy Scalable Group Tag List Builder"
],
"description": "Create policy list",
"operationId": "createPolicyList_ConfigurationPolicyScalableGroupTagListBuilder_3804",
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Zone list": {
"description": "Zone list",
"value": {
"name": "Demo-Zone",
"description": "Desc Not Required",
"type": "zone",
"entries": [
{
"vpn": "10"
}
]
}
},
"IPS list": {
"description": "IPS list",
"value": {
"name": "Demo-IPS-list",
"description": "Desc Not Required",
"type": "ipssignature",
"entries": [
{
"generatorId": "1111",
"signatureId": "4444"
}
]
}
},
"URL white list": {
"description": "URL white list",
"value": {
"name": "Demo-Whitelist",
"description": "Desc Not Required",
"type": "urlwhitelist",
"entries": [
{
"pattern": "https://www.youtube.com"
}
]
}
},
"URL black list": {
"description": "URL black list",
"value": {
"name": "Demo-Black-list",
"description": "Desc Not Required",
"type": "urlblacklist",
"entries": [
{
"pattern": "www.facebook.com"
}
]
}
},
"TG API key list": {
"description": "TG API key list",
"value": {
"name": "threatGridApiKeyList",
"description": "",
"type": "threatGridApiKey",
"entries": [
{
"region": "nam",
"apikey": "1234567"
},
{
"region": "eur",
"apikey": "1234567"
}
]
}
},
"Local domain list": {
"description": "Local domain list",
"value": {
"name": "Demo-Domain-Name-List",
"description": "Desc Not Required",
"type": "localdomain",
"entries": [
{
"nameServer": "cisco.com"
}
]
}
},
"Umbrella data list": {
"description": "Umbrella data list",
"value": {
"name": "umbrellaTokenList",
"description": "",
"type": "umbrellaData",
"entries": [
{
"apiKey": "abcd",
"secret": "12345",
"umbOrgId": "23405",
"token": "abcedabcedabcedabcedabcedabcedabcedabced"
}
]
}
},
"App family": {
"description": "App family",
"value": {
"name": "Demo-App-List",
"description": "Desc Not Required",
"type": "app",
"entries": [
{
"appFamily": "web"
},
{
"appFamily": "audio-video"
}
]
}
},
"App list": {
"description": "App list",
"value": {
"name": "Demo-App-List",
"description": "Desc Not Required",
"type": "app",
"entries": [
{
"app": "facebook"
},
{
"app": "netshow"
}
]
}
},
"Color list": {
"description": "Color list",
"value": {
"name": "Demo-Color-List",
"description": "Desc Not Required",
"type": "color",
"entries": [
{
"color": "biz-internet"
},
{
"color": "public-internet"
}
]
}
},
"Data prefix": {
"description": "Data prefix",
"value": {
"name": "Demo-Data-Prefix-List",
"description": "Desc Not Required",
"type": "dataprefix",
"entries": [
{
"ipPrefix": "10.1.0.0/16"
},
{
"ipPrefix": "10.2.0.0/16"
}
]
}
},
"Policer": {
"description": "Policer",
"value": {
"name": "Demo-Policer-list",
"description": "Desc Not Required",
"type": "policer",
"entries": [
{
"burst": "16000",
"exceed": "drop",
"rate": "10000"
}
]
}
},
"Prefix": {
"description": "Prefix",
"value": {
"name": "Demo-Prefix-list",
"description": "Desc Not Required",
"type": "prefix",
"entries": [
{
"ipPrefix": "10.0.0.0/12",
"le": "32"
}
]
}
},
"Site": {
"description": "Site",
"value": {
"name": "Demo-Site-List",
"description": "Desc Not Required",
"type": "site",
"listId": null,
"entries": [
{
"siteId": "100"
},
{
"siteId": "200"
},
{
"siteId": "300-500"
}
]
}
},
"Class": {
"description": "Class",
"value": {
"name": "Demo-Class-Map",
"description": "Desc Not Required",
"type": "class",
"entries": [
{
"queue": "4"
}
]
}
},
"App probe": {
"description": "App probe",
"value": {
"name": "Demo-Probe-Class",
"type": "appProbe",
"entries": [
{
"map": [
{
"color": "biz-internet",
"dscp": 46
},
{
"color": "public-internet",
"dscp": 20
}
],
"forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70"
}
]
}
},
"SLA": {
"description": "SLA",
"value": {
"name": "Demo-SLA-Class",
"description": "Desc Not Required",
"type": "sla",
"entries": [
{
"latency": "100",
"loss": "10",
"jitter": "10",
"appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d"
}
]
}
},
"TLOC": {
"description": "TLOC",
"value": {
"name": "Demo-TLOC-List",
"description": "Desc Not Required",
"type": "tloc",
"entries": [
{
"tloc": "10.1.1.1",
"color": "biz-internet",
"encap": "ipsec",
"preference": "10"
},
{
"tloc": "10.2.2.2",
"color": "biz-internet",
"encap": "ipsec",
"preference": "20"
}
]
}
},
"VPN": {
"description": "VPN",
"value": {
"name": "Demo-VPN-List",
"description": "Desc Not Required",
"type": "vpn",
"listId": null,
"entries": [
{
"vpn": "100"
},
{
"vpn": "200"
},
{
"vpn": "300-500"
}
]
}
},
"AS path": {
"description": "AS path",
"value": {
"name": "Demo-AS-Path-List",
"description": "Desc Not Required",
"type": "aspath",
"listId": null,
"entries": [
{
"asPath": "100"
},
{
"asPath": "200"
},
{
"asPath": "65002"
}
]
}
},
"Community": {
"description": "Community",
"value": {
"name": "Demo-Community-List",
"description": "Desc Not Required",
"type": "community",
"listId": null,
"entries": [
{
"community": "1000:10000"
}
]
}
},
"Ext community": {
"description": "Ext community",
"value": {
"name": "Demo-Extended-Community-List",
"description": "Desc Not Required",
"type": "extcommunity",
"listId": null,
"entries": [
{
"community": "rt 100:10"
}
]
}
},
"Mirror": {
"description": "Mirror",
"value": {
"name": "Demo-Mirror-List",
"description": "Desc Not Required",
"type": "mirror",
"entries": [
{
"remoteDest": "10.1.1.1",
"source": "20.1.1.1"
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Task Id": {
"description": "Task Id",
"value": {
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6"
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/list/scalablegrouptag/filtered": {
"get": {
"tags": [
"Configuration - Policy Scalable Group Tag List Builder"
],
"description": "Get policy lists with specific info tag",
"operationId": "getPolicyListsWithInfoTag_ConfigurationPolicyScalableGroupTagListBuilder_4703",
"parameters": [
{
"name": "infoTag",
"in": "query",
"description": "InfoTag",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/list/scalablegrouptag/preview": {
"post": {
"tags": [
"Configuration - Policy Scalable Group Tag List Builder"
],
"description": "Preview a policy list based on the policy list type",
"operationId": "previewPolicyList_ConfigurationPolicyScalableGroupTagListBuilder_4604",
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy list": {
"description": "Policy list"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Preview policy list": {
"description": "Preview policy list",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/list/scalablegrouptag/preview/{id}": {
"get": {
"tags": [
"Configuration - Policy Scalable Group Tag List Builder"
],
"description": "Preview a specific policy list entry based on id provided",
"operationId": "previewPolicyListById_ConfigurationPolicyScalableGroupTagListBuilder_5103",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Preview policy list": {
"description": "Preview policy list",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/list/scalablegrouptag/{id}": {
"delete": {
"tags": [
"Configuration - Policy Scalable Group Tag List Builder"
],
"description": "Delete policy list entry for a specific type of policy list",
"operationId": "deletePolicyList_ConfigurationPolicyScalableGroupTagListBuilder_4306",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"put": {
"tags": [
"Configuration - Policy Scalable Group Tag List Builder"
],
"description": "Edit policy list entries for a specific type of policy list",
"operationId": "editPolicyList_ConfigurationPolicyScalableGroupTagListBuilder_4303",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": {
"name": "Community",
"description": "Desc Not Required",
"type": "community",
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6",
"entries": [
{
"community": "1000:8000"
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy": {
"description": "Policy",
"value": {
"masterTemplatesAffected": []
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"get": {
"tags": [
"Configuration - Policy Scalable Group Tag List Builder"
],
"description": "Get a specific policy list based on the id",
"operationId": "getListsById_ConfigurationPolicyScalableGroupTagListBuilder_4303",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy": {
"description": "Policy",
"value": {
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6",
"name": "Community",
"type": "community",
"description": "Desc Not Required",
"entries": [
{
"community": "1000:5000"
}
],
"lastUpdated": 1590184928436,
"owner": "admin",
"readOnly": false,
"version": "0",
"infoTag": "",
"referenceCount": 0,
"references": [],
"isActivatedByVsmart": false
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/list/site": {
"delete": {
"tags": [
"Configuration - Policy Site List Builder"
],
"description": "Delete policy lists with specific info tag",
"operationId": "deletePolicyListsWithInfoTag_ConfigurationPolicySiteListBuilder_2606",
"parameters": [
{
"name": "infoTag",
"in": "query",
"description": "InfoTag",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
},
"get": {
"tags": [
"Configuration - Policy Site List Builder"
],
"description": "Get policy lists",
"operationId": "getPolicyLists_ConfigurationPolicySiteListBuilder_2603",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"App Policy": {
"description": "App Policy",
"value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"
},
"Prefix List": {
"description": "Prefix List",
"value": {
"data": [
{
"listId": "8bc43c09-f72c-40b8-aa90-608c7005e607",
"name": "Example",
"type": "prefix",
"description": "Desc Not Required",
"entries": [
{
"ipPrefix": "10.0.0.0/24"
}
],
"lastUpdated": 1588178457305,
"owner": "admin",
"readOnly": false,
"version": "0",
"infoTag": "",
"referenceCount": 0,
"references": [],
"isActivatedByVsmart": false
}
]
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
},
"post": {
"tags": [
"Configuration - Policy Site List Builder"
],
"description": "Create policy list",
"operationId": "createPolicyList_ConfigurationPolicySiteListBuilder_2604",
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Zone list": {
"description": "Zone list",
"value": {
"name": "Demo-Zone",
"description": "Desc Not Required",
"type": "zone",
"entries": [
{
"vpn": "10"
}
]
}
},
"IPS list": {
"description": "IPS list",
"value": {
"name": "Demo-IPS-list",
"description": "Desc Not Required",
"type": "ipssignature",
"entries": [
{
"generatorId": "1111",
"signatureId": "4444"
}
]
}
},
"URL white list": {
"description": "URL white list",
"value": {
"name": "Demo-Whitelist",
"description": "Desc Not Required",
"type": "urlwhitelist",
"entries": [
{
"pattern": "https://www.youtube.com"
}
]
}
},
"URL black list": {
"description": "URL black list",
"value": {
"name": "Demo-Black-list",
"description": "Desc Not Required",
"type": "urlblacklist",
"entries": [
{
"pattern": "www.facebook.com"
}
]
}
},
"TG API key list": {
"description": "TG API key list",
"value": {
"name": "threatGridApiKeyList",
"description": "",
"type": "threatGridApiKey",
"entries": [
{
"region": "nam",
"apikey": "1234567"
},
{
"region": "eur",
"apikey": "1234567"
}
]
}
},
"Local domain list": {
"description": "Local domain list",
"value": {
"name": "Demo-Domain-Name-List",
"description": "Desc Not Required",
"type": "localdomain",
"entries": [
{
"nameServer": "cisco.com"
}
]
}
},
"Umbrella data list": {
"description": "Umbrella data list",
"value": {
"name": "umbrellaTokenList",
"description": "",
"type": "umbrellaData",
"entries": [
{
"apiKey": "abcd",
"secret": "12345",
"umbOrgId": "23405",
"token": "abcedabcedabcedabcedabcedabcedabcedabced"
}
]
}
},
"App family": {
"description": "App family",
"value": {
"name": "Demo-App-List",
"description": "Desc Not Required",
"type": "app",
"entries": [
{
"appFamily": "web"
},
{
"appFamily": "audio-video"
}
]
}
},
"App list": {
"description": "App list",
"value": {
"name": "Demo-App-List",
"description": "Desc Not Required",
"type": "app",
"entries": [
{
"app": "facebook"
},
{
"app": "netshow"
}
]
}
},
"Color list": {
"description": "Color list",
"value": {
"name": "Demo-Color-List",
"description": "Desc Not Required",
"type": "color",
"entries": [
{
"color": "biz-internet"
},
{
"color": "public-internet"
}
]
}
},
"Data prefix": {
"description": "Data prefix",
"value": {
"name": "Demo-Data-Prefix-List",
"description": "Desc Not Required",
"type": "dataprefix",
"entries": [
{
"ipPrefix": "10.1.0.0/16"
},
{
"ipPrefix": "10.2.0.0/16"
}
]
}
},
"Policer": {
"description": "Policer",
"value": {
"name": "Demo-Policer-list",
"description": "Desc Not Required",
"type": "policer",
"entries": [
{
"burst": "16000",
"exceed": "drop",
"rate": "10000"
}
]
}
},
"Prefix": {
"description": "Prefix",
"value": {
"name": "Demo-Prefix-list",
"description": "Desc Not Required",
"type": "prefix",
"entries": [
{
"ipPrefix": "10.0.0.0/12",
"le": "32"
}
]
}
},
"Site": {
"description": "Site",
"value": {
"name": "Demo-Site-List",
"description": "Desc Not Required",
"type": "site",
"listId": null,
"entries": [
{
"siteId": "100"
},
{
"siteId": "200"
},
{
"siteId": "300-500"
}
]
}
},
"Class": {
"description": "Class",
"value": {
"name": "Demo-Class-Map",
"description": "Desc Not Required",
"type": "class",
"entries": [
{
"queue": "4"
}
]
}
},
"App probe": {
"description": "App probe",
"value": {
"name": "Demo-Probe-Class",
"type": "appProbe",
"entries": [
{
"map": [
{
"color": "biz-internet",
"dscp": 46
},
{
"color": "public-internet",
"dscp": 20
}
],
"forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70"
}
]
}
},
"SLA": {
"description": "SLA",
"value": {
"name": "Demo-SLA-Class",
"description": "Desc Not Required",
"type": "sla",
"entries": [
{
"latency": "100",
"loss": "10",
"jitter": "10",
"appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d"
}
]
}
},
"TLOC": {
"description": "TLOC",
"value": {
"name": "Demo-TLOC-List",
"description": "Desc Not Required",
"type": "tloc",
"entries": [
{
"tloc": "10.1.1.1",
"color": "biz-internet",
"encap": "ipsec",
"preference": "10"
},
{
"tloc": "10.2.2.2",
"color": "biz-internet",
"encap": "ipsec",
"preference": "20"
}
]
}
},
"VPN": {
"description": "VPN",
"value": {
"name": "Demo-VPN-List",
"description": "Desc Not Required",
"type": "vpn",
"listId": null,
"entries": [
{
"vpn": "100"
},
{
"vpn": "200"
},
{
"vpn": "300-500"
}
]
}
},
"AS path": {
"description": "AS path",
"value": {
"name": "Demo-AS-Path-List",
"description": "Desc Not Required",
"type": "aspath",
"listId": null,
"entries": [
{
"asPath": "100"
},
{
"asPath": "200"
},
{
"asPath": "65002"
}
]
}
},
"Community": {
"description": "Community",
"value": {
"name": "Demo-Community-List",
"description": "Desc Not Required",
"type": "community",
"listId": null,
"entries": [
{
"community": "1000:10000"
}
]
}
},
"Ext community": {
"description": "Ext community",
"value": {
"name": "Demo-Extended-Community-List",
"description": "Desc Not Required",
"type": "extcommunity",
"listId": null,
"entries": [
{
"community": "rt 100:10"
}
]
}
},
"Mirror": {
"description": "Mirror",
"value": {
"name": "Demo-Mirror-List",
"description": "Desc Not Required",
"type": "mirror",
"entries": [
{
"remoteDest": "10.1.1.1",
"source": "20.1.1.1"
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Task Id": {
"description": "Task Id",
"value": {
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6"
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/list/site/defaultsite": {
"post": {
"tags": [
"Configuration - Policy Site List Builder"
],
"description": "Create default site list for sites missing from centralized policy",
"operationId": "createDefaultSiteList",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Site list": {
"description": "Site list",
"value": {
"name": "Demo_site_list",
"description": "Desc Not Required",
"type": "site",
"listId": null,
"entries": [
{
"siteId": "200"
}
]
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy-read,Policy-write"
}
},
"/template/policy/list/site/filtered": {
"get": {
"tags": [
"Configuration - Policy Site List Builder"
],
"description": "Get policy lists with specific info tag",
"operationId": "getPolicyListsWithInfoTag_ConfigurationPolicySiteListBuilder_3503",
"parameters": [
{
"name": "infoTag",
"in": "query",
"description": "InfoTag",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/list/site/preview": {
"post": {
"tags": [
"Configuration - Policy Site List Builder"
],
"description": "Preview a policy list based on the policy list type",
"operationId": "previewPolicyList_ConfigurationPolicySiteListBuilder_3404",
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy list": {
"description": "Policy list"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Preview policy list": {
"description": "Preview policy list",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/list/site/preview/{id}": {
"get": {
"tags": [
"Configuration - Policy Site List Builder"
],
"description": "Preview a specific policy list entry based on id provided",
"operationId": "previewPolicyListById_ConfigurationPolicySiteListBuilder_3903",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Preview policy list": {
"description": "Preview policy list",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/list/site/{id}": {
"get": {
"tags": [
"Configuration - Policy Site List Builder"
],
"description": "Get a specific policy list based on the id",
"operationId": "getListsById_ConfigurationPolicySiteListBuilder_3103",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy": {
"description": "Policy",
"value": {
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6",
"name": "Community",
"type": "community",
"description": "Desc Not Required",
"entries": [
{
"community": "1000:5000"
}
],
"lastUpdated": 1590184928436,
"owner": "admin",
"readOnly": false,
"version": "0",
"infoTag": "",
"referenceCount": 0,
"references": [],
"isActivatedByVsmart": false
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
},
"delete": {
"tags": [
"Configuration - Policy Site List Builder"
],
"description": "Delete policy list entry for a specific type of policy list",
"operationId": "deletePolicyList_ConfigurationPolicySiteListBuilder_3106",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"put": {
"tags": [
"Configuration - Policy Site List Builder"
],
"description": "Edit policy list entries for a specific type of policy list",
"operationId": "editPolicyList_ConfigurationPolicySiteListBuilder_3103",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": {
"name": "Community",
"description": "Desc Not Required",
"type": "community",
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6",
"entries": [
{
"community": "1000:8000"
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy": {
"description": "Policy",
"value": {
"masterTemplatesAffected": []
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/list/sla": {
"post": {
"tags": [
"Configuration - Policy SLA Class List Builder"
],
"description": "Create policy list",
"operationId": "createPolicyList_ConfigurationPolicySlaClassListBuilder_2504",
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Zone list": {
"description": "Zone list",
"value": {
"name": "Demo-Zone",
"description": "Desc Not Required",
"type": "zone",
"entries": [
{
"vpn": "10"
}
]
}
},
"IPS list": {
"description": "IPS list",
"value": {
"name": "Demo-IPS-list",
"description": "Desc Not Required",
"type": "ipssignature",
"entries": [
{
"generatorId": "1111",
"signatureId": "4444"
}
]
}
},
"URL white list": {
"description": "URL white list",
"value": {
"name": "Demo-Whitelist",
"description": "Desc Not Required",
"type": "urlwhitelist",
"entries": [
{
"pattern": "https://www.youtube.com"
}
]
}
},
"URL black list": {
"description": "URL black list",
"value": {
"name": "Demo-Black-list",
"description": "Desc Not Required",
"type": "urlblacklist",
"entries": [
{
"pattern": "www.facebook.com"
}
]
}
},
"TG API key list": {
"description": "TG API key list",
"value": {
"name": "threatGridApiKeyList",
"description": "",
"type": "threatGridApiKey",
"entries": [
{
"region": "nam",
"apikey": "1234567"
},
{
"region": "eur",
"apikey": "1234567"
}
]
}
},
"Local domain list": {
"description": "Local domain list",
"value": {
"name": "Demo-Domain-Name-List",
"description": "Desc Not Required",
"type": "localdomain",
"entries": [
{
"nameServer": "cisco.com"
}
]
}
},
"Umbrella data list": {
"description": "Umbrella data list",
"value": {
"name": "umbrellaTokenList",
"description": "",
"type": "umbrellaData",
"entries": [
{
"apiKey": "abcd",
"secret": "12345",
"umbOrgId": "23405",
"token": "abcedabcedabcedabcedabcedabcedabcedabced"
}
]
}
},
"App family": {
"description": "App family",
"value": {
"name": "Demo-App-List",
"description": "Desc Not Required",
"type": "app",
"entries": [
{
"appFamily": "web"
},
{
"appFamily": "audio-video"
}
]
}
},
"App list": {
"description": "App list",
"value": {
"name": "Demo-App-List",
"description": "Desc Not Required",
"type": "app",
"entries": [
{
"app": "facebook"
},
{
"app": "netshow"
}
]
}
},
"Color list": {
"description": "Color list",
"value": {
"name": "Demo-Color-List",
"description": "Desc Not Required",
"type": "color",
"entries": [
{
"color": "biz-internet"
},
{
"color": "public-internet"
}
]
}
},
"Data prefix": {
"description": "Data prefix",
"value": {
"name": "Demo-Data-Prefix-List",
"description": "Desc Not Required",
"type": "dataprefix",
"entries": [
{
"ipPrefix": "10.1.0.0/16"
},
{
"ipPrefix": "10.2.0.0/16"
}
]
}
},
"Policer": {
"description": "Policer",
"value": {
"name": "Demo-Policer-list",
"description": "Desc Not Required",
"type": "policer",
"entries": [
{
"burst": "16000",
"exceed": "drop",
"rate": "10000"
}
]
}
},
"Prefix": {
"description": "Prefix",
"value": {
"name": "Demo-Prefix-list",
"description": "Desc Not Required",
"type": "prefix",
"entries": [
{
"ipPrefix": "10.0.0.0/12",
"le": "32"
}
]
}
},
"Site": {
"description": "Site",
"value": {
"name": "Demo-Site-List",
"description": "Desc Not Required",
"type": "site",
"listId": null,
"entries": [
{
"siteId": "100"
},
{
"siteId": "200"
},
{
"siteId": "300-500"
}
]
}
},
"Class": {
"description": "Class",
"value": {
"name": "Demo-Class-Map",
"description": "Desc Not Required",
"type": "class",
"entries": [
{
"queue": "4"
}
]
}
},
"App probe": {
"description": "App probe",
"value": {
"name": "Demo-Probe-Class",
"type": "appProbe",
"entries": [
{
"map": [
{
"color": "biz-internet",
"dscp": 46
},
{
"color": "public-internet",
"dscp": 20
}
],
"forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70"
}
]
}
},
"SLA": {
"description": "SLA",
"value": {
"name": "Demo-SLA-Class",
"description": "Desc Not Required",
"type": "sla",
"entries": [
{
"latency": "100",
"loss": "10",
"jitter": "10",
"appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d"
}
]
}
},
"TLOC": {
"description": "TLOC",
"value": {
"name": "Demo-TLOC-List",
"description": "Desc Not Required",
"type": "tloc",
"entries": [
{
"tloc": "10.1.1.1",
"color": "biz-internet",
"encap": "ipsec",
"preference": "10"
},
{
"tloc": "10.2.2.2",
"color": "biz-internet",
"encap": "ipsec",
"preference": "20"
}
]
}
},
"VPN": {
"description": "VPN",
"value": {
"name": "Demo-VPN-List",
"description": "Desc Not Required",
"type": "vpn",
"listId": null,
"entries": [
{
"vpn": "100"
},
{
"vpn": "200"
},
{
"vpn": "300-500"
}
]
}
},
"AS path": {
"description": "AS path",
"value": {
"name": "Demo-AS-Path-List",
"description": "Desc Not Required",
"type": "aspath",
"listId": null,
"entries": [
{
"asPath": "100"
},
{
"asPath": "200"
},
{
"asPath": "65002"
}
]
}
},
"Community": {
"description": "Community",
"value": {
"name": "Demo-Community-List",
"description": "Desc Not Required",
"type": "community",
"listId": null,
"entries": [
{
"community": "1000:10000"
}
]
}
},
"Ext community": {
"description": "Ext community",
"value": {
"name": "Demo-Extended-Community-List",
"description": "Desc Not Required",
"type": "extcommunity",
"listId": null,
"entries": [
{
"community": "rt 100:10"
}
]
}
},
"Mirror": {
"description": "Mirror",
"value": {
"name": "Demo-Mirror-List",
"description": "Desc Not Required",
"type": "mirror",
"entries": [
{
"remoteDest": "10.1.1.1",
"source": "20.1.1.1"
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Task Id": {
"description": "Task Id",
"value": {
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6"
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"delete": {
"tags": [
"Configuration - Policy SLA Class List Builder"
],
"description": "Delete policy lists with specific info tag",
"operationId": "deletePolicyListsWithInfoTag_ConfigurationPolicySlaClassListBuilder_2506",
"parameters": [
{
"name": "infoTag",
"in": "query",
"description": "InfoTag",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
},
"get": {
"tags": [
"Configuration - Policy SLA Class List Builder"
],
"description": "Get policy lists",
"operationId": "getPolicyLists_ConfigurationPolicySlaClassListBuilder_2503",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"App Policy": {
"description": "App Policy",
"value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"
},
"Prefix List": {
"description": "Prefix List",
"value": {
"data": [
{
"listId": "8bc43c09-f72c-40b8-aa90-608c7005e607",
"name": "Example",
"type": "prefix",
"description": "Desc Not Required",
"entries": [
{
"ipPrefix": "10.0.0.0/24"
}
],
"lastUpdated": 1588178457305,
"owner": "admin",
"readOnly": false,
"version": "0",
"infoTag": "",
"referenceCount": 0,
"references": [],
"isActivatedByVsmart": false
}
]
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/list/sla/filtered": {
"get": {
"tags": [
"Configuration - Policy SLA Class List Builder"
],
"description": "Get policy lists with specific info tag",
"operationId": "getPolicyListsWithInfoTag_ConfigurationPolicySlaClassListBuilder_3403",
"parameters": [
{
"name": "infoTag",
"in": "query",
"description": "InfoTag",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/list/sla/preview": {
"post": {
"tags": [
"Configuration - Policy SLA Class List Builder"
],
"description": "Preview a policy list based on the policy list type",
"operationId": "previewPolicyList_ConfigurationPolicySlaClassListBuilder_3304",
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy list": {
"description": "Policy list"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Preview policy list": {
"description": "Preview policy list",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/list/sla/preview/{id}": {
"get": {
"tags": [
"Configuration - Policy SLA Class List Builder"
],
"description": "Preview a specific policy list entry based on id provided",
"operationId": "previewPolicyListById_ConfigurationPolicySlaClassListBuilder_3803",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Preview policy list": {
"description": "Preview policy list",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/list/sla/{id}": {
"get": {
"tags": [
"Configuration - Policy SLA Class List Builder"
],
"description": "Get a specific policy list based on the id",
"operationId": "getListsById_ConfigurationPolicySlaClassListBuilder_3003",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy": {
"description": "Policy",
"value": {
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6",
"name": "Community",
"type": "community",
"description": "Desc Not Required",
"entries": [
{
"community": "1000:5000"
}
],
"lastUpdated": 1590184928436,
"owner": "admin",
"readOnly": false,
"version": "0",
"infoTag": "",
"referenceCount": 0,
"references": [],
"isActivatedByVsmart": false
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
},
"put": {
"tags": [
"Configuration - Policy SLA Class List Builder"
],
"description": "Edit policy list entries for a specific type of policy list",
"operationId": "editPolicyList_ConfigurationPolicySlaClassListBuilder_3003",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": {
"name": "Community",
"description": "Desc Not Required",
"type": "community",
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6",
"entries": [
{
"community": "1000:8000"
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy": {
"description": "Policy",
"value": {
"masterTemplatesAffected": []
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"delete": {
"tags": [
"Configuration - Policy SLA Class List Builder"
],
"description": "Delete policy list entry for a specific type of policy list",
"operationId": "deletePolicyList_ConfigurationPolicySlaClassListBuilder_3006",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/list/supervisorydisc": {
"get": {
"tags": [
"Configuration - Policy Supervisory Disc List Builder"
],
"description": "Get policy lists",
"operationId": "getPolicyLists_ConfigurationPolicySupervisoryDiscListBuilder_3703",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"App Policy": {
"description": "App Policy",
"value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"
},
"Prefix List": {
"description": "Prefix List",
"value": {
"data": [
{
"listId": "8bc43c09-f72c-40b8-aa90-608c7005e607",
"name": "Example",
"type": "prefix",
"description": "Desc Not Required",
"entries": [
{
"ipPrefix": "10.0.0.0/24"
}
],
"lastUpdated": 1588178457305,
"owner": "admin",
"readOnly": false,
"version": "0",
"infoTag": "",
"referenceCount": 0,
"references": [],
"isActivatedByVsmart": false
}
]
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
},
"post": {
"tags": [
"Configuration - Policy Supervisory Disc List Builder"
],
"description": "Create policy list",
"operationId": "createPolicyList_ConfigurationPolicySupervisoryDiscListBuilder_3704",
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Zone list": {
"description": "Zone list",
"value": {
"name": "Demo-Zone",
"description": "Desc Not Required",
"type": "zone",
"entries": [
{
"vpn": "10"
}
]
}
},
"IPS list": {
"description": "IPS list",
"value": {
"name": "Demo-IPS-list",
"description": "Desc Not Required",
"type": "ipssignature",
"entries": [
{
"generatorId": "1111",
"signatureId": "4444"
}
]
}
},
"URL white list": {
"description": "URL white list",
"value": {
"name": "Demo-Whitelist",
"description": "Desc Not Required",
"type": "urlwhitelist",
"entries": [
{
"pattern": "https://www.youtube.com"
}
]
}
},
"URL black list": {
"description": "URL black list",
"value": {
"name": "Demo-Black-list",
"description": "Desc Not Required",
"type": "urlblacklist",
"entries": [
{
"pattern": "www.facebook.com"
}
]
}
},
"TG API key list": {
"description": "TG API key list",
"value": {
"name": "threatGridApiKeyList",
"description": "",
"type": "threatGridApiKey",
"entries": [
{
"region": "nam",
"apikey": "1234567"
},
{
"region": "eur",
"apikey": "1234567"
}
]
}
},
"Local domain list": {
"description": "Local domain list",
"value": {
"name": "Demo-Domain-Name-List",
"description": "Desc Not Required",
"type": "localdomain",
"entries": [
{
"nameServer": "cisco.com"
}
]
}
},
"Umbrella data list": {
"description": "Umbrella data list",
"value": {
"name": "umbrellaTokenList",
"description": "",
"type": "umbrellaData",
"entries": [
{
"apiKey": "abcd",
"secret": "12345",
"umbOrgId": "23405",
"token": "abcedabcedabcedabcedabcedabcedabcedabced"
}
]
}
},
"App family": {
"description": "App family",
"value": {
"name": "Demo-App-List",
"description": "Desc Not Required",
"type": "app",
"entries": [
{
"appFamily": "web"
},
{
"appFamily": "audio-video"
}
]
}
},
"App list": {
"description": "App list",
"value": {
"name": "Demo-App-List",
"description": "Desc Not Required",
"type": "app",
"entries": [
{
"app": "facebook"
},
{
"app": "netshow"
}
]
}
},
"Color list": {
"description": "Color list",
"value": {
"name": "Demo-Color-List",
"description": "Desc Not Required",
"type": "color",
"entries": [
{
"color": "biz-internet"
},
{
"color": "public-internet"
}
]
}
},
"Data prefix": {
"description": "Data prefix",
"value": {
"name": "Demo-Data-Prefix-List",
"description": "Desc Not Required",
"type": "dataprefix",
"entries": [
{
"ipPrefix": "10.1.0.0/16"
},
{
"ipPrefix": "10.2.0.0/16"
}
]
}
},
"Policer": {
"description": "Policer",
"value": {
"name": "Demo-Policer-list",
"description": "Desc Not Required",
"type": "policer",
"entries": [
{
"burst": "16000",
"exceed": "drop",
"rate": "10000"
}
]
}
},
"Prefix": {
"description": "Prefix",
"value": {
"name": "Demo-Prefix-list",
"description": "Desc Not Required",
"type": "prefix",
"entries": [
{
"ipPrefix": "10.0.0.0/12",
"le": "32"
}
]
}
},
"Site": {
"description": "Site",
"value": {
"name": "Demo-Site-List",
"description": "Desc Not Required",
"type": "site",
"listId": null,
"entries": [
{
"siteId": "100"
},
{
"siteId": "200"
},
{
"siteId": "300-500"
}
]
}
},
"Class": {
"description": "Class",
"value": {
"name": "Demo-Class-Map",
"description": "Desc Not Required",
"type": "class",
"entries": [
{
"queue": "4"
}
]
}
},
"App probe": {
"description": "App probe",
"value": {
"name": "Demo-Probe-Class",
"type": "appProbe",
"entries": [
{
"map": [
{
"color": "biz-internet",
"dscp": 46
},
{
"color": "public-internet",
"dscp": 20
}
],
"forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70"
}
]
}
},
"SLA": {
"description": "SLA",
"value": {
"name": "Demo-SLA-Class",
"description": "Desc Not Required",
"type": "sla",
"entries": [
{
"latency": "100",
"loss": "10",
"jitter": "10",
"appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d"
}
]
}
},
"TLOC": {
"description": "TLOC",
"value": {
"name": "Demo-TLOC-List",
"description": "Desc Not Required",
"type": "tloc",
"entries": [
{
"tloc": "10.1.1.1",
"color": "biz-internet",
"encap": "ipsec",
"preference": "10"
},
{
"tloc": "10.2.2.2",
"color": "biz-internet",
"encap": "ipsec",
"preference": "20"
}
]
}
},
"VPN": {
"description": "VPN",
"value": {
"name": "Demo-VPN-List",
"description": "Desc Not Required",
"type": "vpn",
"listId": null,
"entries": [
{
"vpn": "100"
},
{
"vpn": "200"
},
{
"vpn": "300-500"
}
]
}
},
"AS path": {
"description": "AS path",
"value": {
"name": "Demo-AS-Path-List",
"description": "Desc Not Required",
"type": "aspath",
"listId": null,
"entries": [
{
"asPath": "100"
},
{
"asPath": "200"
},
{
"asPath": "65002"
}
]
}
},
"Community": {
"description": "Community",
"value": {
"name": "Demo-Community-List",
"description": "Desc Not Required",
"type": "community",
"listId": null,
"entries": [
{
"community": "1000:10000"
}
]
}
},
"Ext community": {
"description": "Ext community",
"value": {
"name": "Demo-Extended-Community-List",
"description": "Desc Not Required",
"type": "extcommunity",
"listId": null,
"entries": [
{
"community": "rt 100:10"
}
]
}
},
"Mirror": {
"description": "Mirror",
"value": {
"name": "Demo-Mirror-List",
"description": "Desc Not Required",
"type": "mirror",
"entries": [
{
"remoteDest": "10.1.1.1",
"source": "20.1.1.1"
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Task Id": {
"description": "Task Id",
"value": {
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6"
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"delete": {
"tags": [
"Configuration - Policy Supervisory Disc List Builder"
],
"description": "Delete policy lists with specific info tag",
"operationId": "deletePolicyListsWithInfoTag_ConfigurationPolicySupervisoryDiscListBuilder_3706",
"parameters": [
{
"name": "infoTag",
"in": "query",
"description": "InfoTag",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/list/supervisorydisc/filtered": {
"get": {
"tags": [
"Configuration - Policy Supervisory Disc List Builder"
],
"description": "Get policy lists with specific info tag",
"operationId": "getPolicyListsWithInfoTag_ConfigurationPolicySupervisoryDiscListBuilder_4603",
"parameters": [
{
"name": "infoTag",
"in": "query",
"description": "InfoTag",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/list/supervisorydisc/preview": {
"post": {
"tags": [
"Configuration - Policy Supervisory Disc List Builder"
],
"description": "Preview a policy list based on the policy list type",
"operationId": "previewPolicyList_ConfigurationPolicySupervisoryDiscListBuilder_4504",
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy list": {
"description": "Policy list"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Preview policy list": {
"description": "Preview policy list",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/list/supervisorydisc/preview/{id}": {
"get": {
"tags": [
"Configuration - Policy Supervisory Disc List Builder"
],
"description": "Preview a specific policy list entry based on id provided",
"operationId": "previewPolicyListById_ConfigurationPolicySupervisoryDiscListBuilder_5003",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Preview policy list": {
"description": "Preview policy list",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/list/supervisorydisc/{id}": {
"put": {
"tags": [
"Configuration - Policy Supervisory Disc List Builder"
],
"description": "Edit policy list entries for a specific type of policy list",
"operationId": "editPolicyList_ConfigurationPolicySupervisoryDiscListBuilder_4203",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": {
"name": "Community",
"description": "Desc Not Required",
"type": "community",
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6",
"entries": [
{
"community": "1000:8000"
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy": {
"description": "Policy",
"value": {
"masterTemplatesAffected": []
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"get": {
"tags": [
"Configuration - Policy Supervisory Disc List Builder"
],
"description": "Get a specific policy list based on the id",
"operationId": "getListsById_ConfigurationPolicySupervisoryDiscListBuilder_4203",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy": {
"description": "Policy",
"value": {
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6",
"name": "Community",
"type": "community",
"description": "Desc Not Required",
"entries": [
{
"community": "1000:5000"
}
],
"lastUpdated": 1590184928436,
"owner": "admin",
"readOnly": false,
"version": "0",
"infoTag": "",
"referenceCount": 0,
"references": [],
"isActivatedByVsmart": false
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
},
"delete": {
"tags": [
"Configuration - Policy Supervisory Disc List Builder"
],
"description": "Delete policy list entry for a specific type of policy list",
"operationId": "deletePolicyList_ConfigurationPolicySupervisoryDiscListBuilder_4206",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/list/tgapikey": {
"get": {
"tags": [
"Configuration - Policy Threat Grid Api Key List"
],
"description": "Get policy lists",
"operationId": "getPolicyLists_ConfigurationPolicyThreatGridApiKeyList_3003",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"App Policy": {
"description": "App Policy",
"value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"
},
"Prefix List": {
"description": "Prefix List",
"value": {
"data": [
{
"listId": "8bc43c09-f72c-40b8-aa90-608c7005e607",
"name": "Example",
"type": "prefix",
"description": "Desc Not Required",
"entries": [
{
"ipPrefix": "10.0.0.0/24"
}
],
"lastUpdated": 1588178457305,
"owner": "admin",
"readOnly": false,
"version": "0",
"infoTag": "",
"referenceCount": 0,
"references": [],
"isActivatedByVsmart": false
}
]
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
},
"delete": {
"tags": [
"Configuration - Policy Threat Grid Api Key List"
],
"description": "Delete policy lists with specific info tag",
"operationId": "deletePolicyListsWithInfoTag_ConfigurationPolicyThreatGridApiKeyList_3006",
"parameters": [
{
"name": "infoTag",
"in": "query",
"description": "InfoTag",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
},
"post": {
"tags": [
"Configuration - Policy Threat Grid Api Key List"
],
"description": "Create policy list",
"operationId": "createPolicyList_ConfigurationPolicyThreatGridApiKeyList_3004",
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Zone list": {
"description": "Zone list",
"value": {
"name": "Demo-Zone",
"description": "Desc Not Required",
"type": "zone",
"entries": [
{
"vpn": "10"
}
]
}
},
"IPS list": {
"description": "IPS list",
"value": {
"name": "Demo-IPS-list",
"description": "Desc Not Required",
"type": "ipssignature",
"entries": [
{
"generatorId": "1111",
"signatureId": "4444"
}
]
}
},
"URL white list": {
"description": "URL white list",
"value": {
"name": "Demo-Whitelist",
"description": "Desc Not Required",
"type": "urlwhitelist",
"entries": [
{
"pattern": "https://www.youtube.com"
}
]
}
},
"URL black list": {
"description": "URL black list",
"value": {
"name": "Demo-Black-list",
"description": "Desc Not Required",
"type": "urlblacklist",
"entries": [
{
"pattern": "www.facebook.com"
}
]
}
},
"TG API key list": {
"description": "TG API key list",
"value": {
"name": "threatGridApiKeyList",
"description": "",
"type": "threatGridApiKey",
"entries": [
{
"region": "nam",
"apikey": "1234567"
},
{
"region": "eur",
"apikey": "1234567"
}
]
}
},
"Local domain list": {
"description": "Local domain list",
"value": {
"name": "Demo-Domain-Name-List",
"description": "Desc Not Required",
"type": "localdomain",
"entries": [
{
"nameServer": "cisco.com"
}
]
}
},
"Umbrella data list": {
"description": "Umbrella data list",
"value": {
"name": "umbrellaTokenList",
"description": "",
"type": "umbrellaData",
"entries": [
{
"apiKey": "abcd",
"secret": "12345",
"umbOrgId": "23405",
"token": "abcedabcedabcedabcedabcedabcedabcedabced"
}
]
}
},
"App family": {
"description": "App family",
"value": {
"name": "Demo-App-List",
"description": "Desc Not Required",
"type": "app",
"entries": [
{
"appFamily": "web"
},
{
"appFamily": "audio-video"
}
]
}
},
"App list": {
"description": "App list",
"value": {
"name": "Demo-App-List",
"description": "Desc Not Required",
"type": "app",
"entries": [
{
"app": "facebook"
},
{
"app": "netshow"
}
]
}
},
"Color list": {
"description": "Color list",
"value": {
"name": "Demo-Color-List",
"description": "Desc Not Required",
"type": "color",
"entries": [
{
"color": "biz-internet"
},
{
"color": "public-internet"
}
]
}
},
"Data prefix": {
"description": "Data prefix",
"value": {
"name": "Demo-Data-Prefix-List",
"description": "Desc Not Required",
"type": "dataprefix",
"entries": [
{
"ipPrefix": "10.1.0.0/16"
},
{
"ipPrefix": "10.2.0.0/16"
}
]
}
},
"Policer": {
"description": "Policer",
"value": {
"name": "Demo-Policer-list",
"description": "Desc Not Required",
"type": "policer",
"entries": [
{
"burst": "16000",
"exceed": "drop",
"rate": "10000"
}
]
}
},
"Prefix": {
"description": "Prefix",
"value": {
"name": "Demo-Prefix-list",
"description": "Desc Not Required",
"type": "prefix",
"entries": [
{
"ipPrefix": "10.0.0.0/12",
"le": "32"
}
]
}
},
"Site": {
"description": "Site",
"value": {
"name": "Demo-Site-List",
"description": "Desc Not Required",
"type": "site",
"listId": null,
"entries": [
{
"siteId": "100"
},
{
"siteId": "200"
},
{
"siteId": "300-500"
}
]
}
},
"Class": {
"description": "Class",
"value": {
"name": "Demo-Class-Map",
"description": "Desc Not Required",
"type": "class",
"entries": [
{
"queue": "4"
}
]
}
},
"App probe": {
"description": "App probe",
"value": {
"name": "Demo-Probe-Class",
"type": "appProbe",
"entries": [
{
"map": [
{
"color": "biz-internet",
"dscp": 46
},
{
"color": "public-internet",
"dscp": 20
}
],
"forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70"
}
]
}
},
"SLA": {
"description": "SLA",
"value": {
"name": "Demo-SLA-Class",
"description": "Desc Not Required",
"type": "sla",
"entries": [
{
"latency": "100",
"loss": "10",
"jitter": "10",
"appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d"
}
]
}
},
"TLOC": {
"description": "TLOC",
"value": {
"name": "Demo-TLOC-List",
"description": "Desc Not Required",
"type": "tloc",
"entries": [
{
"tloc": "10.1.1.1",
"color": "biz-internet",
"encap": "ipsec",
"preference": "10"
},
{
"tloc": "10.2.2.2",
"color": "biz-internet",
"encap": "ipsec",
"preference": "20"
}
]
}
},
"VPN": {
"description": "VPN",
"value": {
"name": "Demo-VPN-List",
"description": "Desc Not Required",
"type": "vpn",
"listId": null,
"entries": [
{
"vpn": "100"
},
{
"vpn": "200"
},
{
"vpn": "300-500"
}
]
}
},
"AS path": {
"description": "AS path",
"value": {
"name": "Demo-AS-Path-List",
"description": "Desc Not Required",
"type": "aspath",
"listId": null,
"entries": [
{
"asPath": "100"
},
{
"asPath": "200"
},
{
"asPath": "65002"
}
]
}
},
"Community": {
"description": "Community",
"value": {
"name": "Demo-Community-List",
"description": "Desc Not Required",
"type": "community",
"listId": null,
"entries": [
{
"community": "1000:10000"
}
]
}
},
"Ext community": {
"description": "Ext community",
"value": {
"name": "Demo-Extended-Community-List",
"description": "Desc Not Required",
"type": "extcommunity",
"listId": null,
"entries": [
{
"community": "rt 100:10"
}
]
}
},
"Mirror": {
"description": "Mirror",
"value": {
"name": "Demo-Mirror-List",
"description": "Desc Not Required",
"type": "mirror",
"entries": [
{
"remoteDest": "10.1.1.1",
"source": "20.1.1.1"
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Task Id": {
"description": "Task Id",
"value": {
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6"
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/list/tgapikey/filtered": {
"get": {
"tags": [
"Configuration - Policy Threat Grid Api Key List"
],
"description": "Get policy lists with specific info tag",
"operationId": "getPolicyListsWithInfoTag_ConfigurationPolicyThreatGridApiKeyList_3903",
"parameters": [
{
"name": "infoTag",
"in": "query",
"description": "InfoTag",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/list/tgapikey/preview": {
"post": {
"tags": [
"Configuration - Policy Threat Grid Api Key List"
],
"description": "Preview a policy list based on the policy list type",
"operationId": "previewPolicyList_ConfigurationPolicyThreatGridApiKeyList_3804",
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy list": {
"description": "Policy list"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Preview policy list": {
"description": "Preview policy list",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/list/tgapikey/preview/{id}": {
"get": {
"tags": [
"Configuration - Policy Threat Grid Api Key List"
],
"description": "Preview a specific policy list entry based on id provided",
"operationId": "previewPolicyListById_ConfigurationPolicyThreatGridApiKeyList_4303",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Preview policy list": {
"description": "Preview policy list",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/list/tgapikey/{id}": {
"put": {
"tags": [
"Configuration - Policy Threat Grid Api Key List"
],
"description": "Edit policy list entries for a specific type of policy list",
"operationId": "editPolicyList_ConfigurationPolicyThreatGridApiKeyList_3503",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": {
"name": "Community",
"description": "Desc Not Required",
"type": "community",
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6",
"entries": [
{
"community": "1000:8000"
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy": {
"description": "Policy",
"value": {
"masterTemplatesAffected": []
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"delete": {
"tags": [
"Configuration - Policy Threat Grid Api Key List"
],
"description": "Delete policy list entry for a specific type of policy list",
"operationId": "deletePolicyList_ConfigurationPolicyThreatGridApiKeyList_3506",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"get": {
"tags": [
"Configuration - Policy Threat Grid Api Key List"
],
"description": "Get a specific policy list based on the id",
"operationId": "getListsById_ConfigurationPolicyThreatGridApiKeyList_3503",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy": {
"description": "Policy",
"value": {
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6",
"name": "Community",
"type": "community",
"description": "Desc Not Required",
"entries": [
{
"community": "1000:5000"
}
],
"lastUpdated": 1590184928436,
"owner": "admin",
"readOnly": false,
"version": "0",
"infoTag": "",
"referenceCount": 0,
"references": [],
"isActivatedByVsmart": false
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/list/tloc": {
"delete": {
"tags": [
"Configuration - Policy TLOC List Builder"
],
"description": "Delete policy lists with specific info tag",
"operationId": "deletePolicyListsWithInfoTag_ConfigurationPolicyTlocListBuilder_2606",
"parameters": [
{
"name": "infoTag",
"in": "query",
"description": "InfoTag",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
},
"get": {
"tags": [
"Configuration - Policy TLOC List Builder"
],
"description": "Get policy lists",
"operationId": "getPolicyLists_ConfigurationPolicyTlocListBuilder_2603",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"App Policy": {
"description": "App Policy",
"value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"
},
"Prefix List": {
"description": "Prefix List",
"value": {
"data": [
{
"listId": "8bc43c09-f72c-40b8-aa90-608c7005e607",
"name": "Example",
"type": "prefix",
"description": "Desc Not Required",
"entries": [
{
"ipPrefix": "10.0.0.0/24"
}
],
"lastUpdated": 1588178457305,
"owner": "admin",
"readOnly": false,
"version": "0",
"infoTag": "",
"referenceCount": 0,
"references": [],
"isActivatedByVsmart": false
}
]
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
},
"post": {
"tags": [
"Configuration - Policy TLOC List Builder"
],
"description": "Create policy list",
"operationId": "createPolicyList_ConfigurationPolicyTlocListBuilder_2604",
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Zone list": {
"description": "Zone list",
"value": {
"name": "Demo-Zone",
"description": "Desc Not Required",
"type": "zone",
"entries": [
{
"vpn": "10"
}
]
}
},
"IPS list": {
"description": "IPS list",
"value": {
"name": "Demo-IPS-list",
"description": "Desc Not Required",
"type": "ipssignature",
"entries": [
{
"generatorId": "1111",
"signatureId": "4444"
}
]
}
},
"URL white list": {
"description": "URL white list",
"value": {
"name": "Demo-Whitelist",
"description": "Desc Not Required",
"type": "urlwhitelist",
"entries": [
{
"pattern": "https://www.youtube.com"
}
]
}
},
"URL black list": {
"description": "URL black list",
"value": {
"name": "Demo-Black-list",
"description": "Desc Not Required",
"type": "urlblacklist",
"entries": [
{
"pattern": "www.facebook.com"
}
]
}
},
"TG API key list": {
"description": "TG API key list",
"value": {
"name": "threatGridApiKeyList",
"description": "",
"type": "threatGridApiKey",
"entries": [
{
"region": "nam",
"apikey": "1234567"
},
{
"region": "eur",
"apikey": "1234567"
}
]
}
},
"Local domain list": {
"description": "Local domain list",
"value": {
"name": "Demo-Domain-Name-List",
"description": "Desc Not Required",
"type": "localdomain",
"entries": [
{
"nameServer": "cisco.com"
}
]
}
},
"Umbrella data list": {
"description": "Umbrella data list",
"value": {
"name": "umbrellaTokenList",
"description": "",
"type": "umbrellaData",
"entries": [
{
"apiKey": "abcd",
"secret": "12345",
"umbOrgId": "23405",
"token": "abcedabcedabcedabcedabcedabcedabcedabced"
}
]
}
},
"App family": {
"description": "App family",
"value": {
"name": "Demo-App-List",
"description": "Desc Not Required",
"type": "app",
"entries": [
{
"appFamily": "web"
},
{
"appFamily": "audio-video"
}
]
}
},
"App list": {
"description": "App list",
"value": {
"name": "Demo-App-List",
"description": "Desc Not Required",
"type": "app",
"entries": [
{
"app": "facebook"
},
{
"app": "netshow"
}
]
}
},
"Color list": {
"description": "Color list",
"value": {
"name": "Demo-Color-List",
"description": "Desc Not Required",
"type": "color",
"entries": [
{
"color": "biz-internet"
},
{
"color": "public-internet"
}
]
}
},
"Data prefix": {
"description": "Data prefix",
"value": {
"name": "Demo-Data-Prefix-List",
"description": "Desc Not Required",
"type": "dataprefix",
"entries": [
{
"ipPrefix": "10.1.0.0/16"
},
{
"ipPrefix": "10.2.0.0/16"
}
]
}
},
"Policer": {
"description": "Policer",
"value": {
"name": "Demo-Policer-list",
"description": "Desc Not Required",
"type": "policer",
"entries": [
{
"burst": "16000",
"exceed": "drop",
"rate": "10000"
}
]
}
},
"Prefix": {
"description": "Prefix",
"value": {
"name": "Demo-Prefix-list",
"description": "Desc Not Required",
"type": "prefix",
"entries": [
{
"ipPrefix": "10.0.0.0/12",
"le": "32"
}
]
}
},
"Site": {
"description": "Site",
"value": {
"name": "Demo-Site-List",
"description": "Desc Not Required",
"type": "site",
"listId": null,
"entries": [
{
"siteId": "100"
},
{
"siteId": "200"
},
{
"siteId": "300-500"
}
]
}
},
"Class": {
"description": "Class",
"value": {
"name": "Demo-Class-Map",
"description": "Desc Not Required",
"type": "class",
"entries": [
{
"queue": "4"
}
]
}
},
"App probe": {
"description": "App probe",
"value": {
"name": "Demo-Probe-Class",
"type": "appProbe",
"entries": [
{
"map": [
{
"color": "biz-internet",
"dscp": 46
},
{
"color": "public-internet",
"dscp": 20
}
],
"forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70"
}
]
}
},
"SLA": {
"description": "SLA",
"value": {
"name": "Demo-SLA-Class",
"description": "Desc Not Required",
"type": "sla",
"entries": [
{
"latency": "100",
"loss": "10",
"jitter": "10",
"appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d"
}
]
}
},
"TLOC": {
"description": "TLOC",
"value": {
"name": "Demo-TLOC-List",
"description": "Desc Not Required",
"type": "tloc",
"entries": [
{
"tloc": "10.1.1.1",
"color": "biz-internet",
"encap": "ipsec",
"preference": "10"
},
{
"tloc": "10.2.2.2",
"color": "biz-internet",
"encap": "ipsec",
"preference": "20"
}
]
}
},
"VPN": {
"description": "VPN",
"value": {
"name": "Demo-VPN-List",
"description": "Desc Not Required",
"type": "vpn",
"listId": null,
"entries": [
{
"vpn": "100"
},
{
"vpn": "200"
},
{
"vpn": "300-500"
}
]
}
},
"AS path": {
"description": "AS path",
"value": {
"name": "Demo-AS-Path-List",
"description": "Desc Not Required",
"type": "aspath",
"listId": null,
"entries": [
{
"asPath": "100"
},
{
"asPath": "200"
},
{
"asPath": "65002"
}
]
}
},
"Community": {
"description": "Community",
"value": {
"name": "Demo-Community-List",
"description": "Desc Not Required",
"type": "community",
"listId": null,
"entries": [
{
"community": "1000:10000"
}
]
}
},
"Ext community": {
"description": "Ext community",
"value": {
"name": "Demo-Extended-Community-List",
"description": "Desc Not Required",
"type": "extcommunity",
"listId": null,
"entries": [
{
"community": "rt 100:10"
}
]
}
},
"Mirror": {
"description": "Mirror",
"value": {
"name": "Demo-Mirror-List",
"description": "Desc Not Required",
"type": "mirror",
"entries": [
{
"remoteDest": "10.1.1.1",
"source": "20.1.1.1"
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Task Id": {
"description": "Task Id",
"value": {
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6"
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/list/tloc/filtered": {
"get": {
"tags": [
"Configuration - Policy TLOC List Builder"
],
"description": "Get policy lists with specific info tag",
"operationId": "getPolicyListsWithInfoTag_ConfigurationPolicyTlocListBuilder_3503",
"parameters": [
{
"name": "infoTag",
"in": "query",
"description": "InfoTag",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/list/tloc/preview": {
"post": {
"tags": [
"Configuration - Policy TLOC List Builder"
],
"description": "Preview a policy list based on the policy list type",
"operationId": "previewPolicyList_ConfigurationPolicyTlocListBuilder_3404",
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy list": {
"description": "Policy list"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Preview policy list": {
"description": "Preview policy list",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/list/tloc/preview/{id}": {
"get": {
"tags": [
"Configuration - Policy TLOC List Builder"
],
"description": "Preview a specific policy list entry based on id provided",
"operationId": "previewPolicyListById_ConfigurationPolicyTlocListBuilder_3903",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Preview policy list": {
"description": "Preview policy list",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/list/tloc/{id}": {
"get": {
"tags": [
"Configuration - Policy TLOC List Builder"
],
"description": "Get a specific policy list based on the id",
"operationId": "getListsById_ConfigurationPolicyTlocListBuilder_3103",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy": {
"description": "Policy",
"value": {
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6",
"name": "Community",
"type": "community",
"description": "Desc Not Required",
"entries": [
{
"community": "1000:5000"
}
],
"lastUpdated": 1590184928436,
"owner": "admin",
"readOnly": false,
"version": "0",
"infoTag": "",
"referenceCount": 0,
"references": [],
"isActivatedByVsmart": false
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
},
"put": {
"tags": [
"Configuration - Policy TLOC List Builder"
],
"description": "Edit policy list entries for a specific type of policy list",
"operationId": "editPolicyList_ConfigurationPolicyTlocListBuilder_3103",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": {
"name": "Community",
"description": "Desc Not Required",
"type": "community",
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6",
"entries": [
{
"community": "1000:8000"
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy": {
"description": "Policy",
"value": {
"masterTemplatesAffected": []
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"delete": {
"tags": [
"Configuration - Policy TLOC List Builder"
],
"description": "Delete policy list entry for a specific type of policy list",
"operationId": "deletePolicyList_ConfigurationPolicyTlocListBuilder_3106",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/list/translationprofile": {
"get": {
"tags": [
"Configuration - Policy TranslationProfile List Builder"
],
"description": "Get policy lists",
"operationId": "getPolicyLists_ConfigurationPolicyTranslationprofileListBuilder_4003",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"App Policy": {
"description": "App Policy",
"value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"
},
"Prefix List": {
"description": "Prefix List",
"value": {
"data": [
{
"listId": "8bc43c09-f72c-40b8-aa90-608c7005e607",
"name": "Example",
"type": "prefix",
"description": "Desc Not Required",
"entries": [
{
"ipPrefix": "10.0.0.0/24"
}
],
"lastUpdated": 1588178457305,
"owner": "admin",
"readOnly": false,
"version": "0",
"infoTag": "",
"referenceCount": 0,
"references": [],
"isActivatedByVsmart": false
}
]
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
},
"post": {
"tags": [
"Configuration - Policy TranslationProfile List Builder"
],
"description": "Create policy list",
"operationId": "createPolicyList_ConfigurationPolicyTranslationprofileListBuilder_4004",
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Zone list": {
"description": "Zone list",
"value": {
"name": "Demo-Zone",
"description": "Desc Not Required",
"type": "zone",
"entries": [
{
"vpn": "10"
}
]
}
},
"IPS list": {
"description": "IPS list",
"value": {
"name": "Demo-IPS-list",
"description": "Desc Not Required",
"type": "ipssignature",
"entries": [
{
"generatorId": "1111",
"signatureId": "4444"
}
]
}
},
"URL white list": {
"description": "URL white list",
"value": {
"name": "Demo-Whitelist",
"description": "Desc Not Required",
"type": "urlwhitelist",
"entries": [
{
"pattern": "https://www.youtube.com"
}
]
}
},
"URL black list": {
"description": "URL black list",
"value": {
"name": "Demo-Black-list",
"description": "Desc Not Required",
"type": "urlblacklist",
"entries": [
{
"pattern": "www.facebook.com"
}
]
}
},
"TG API key list": {
"description": "TG API key list",
"value": {
"name": "threatGridApiKeyList",
"description": "",
"type": "threatGridApiKey",
"entries": [
{
"region": "nam",
"apikey": "1234567"
},
{
"region": "eur",
"apikey": "1234567"
}
]
}
},
"Local domain list": {
"description": "Local domain list",
"value": {
"name": "Demo-Domain-Name-List",
"description": "Desc Not Required",
"type": "localdomain",
"entries": [
{
"nameServer": "cisco.com"
}
]
}
},
"Umbrella data list": {
"description": "Umbrella data list",
"value": {
"name": "umbrellaTokenList",
"description": "",
"type": "umbrellaData",
"entries": [
{
"apiKey": "abcd",
"secret": "12345",
"umbOrgId": "23405",
"token": "abcedabcedabcedabcedabcedabcedabcedabced"
}
]
}
},
"App family": {
"description": "App family",
"value": {
"name": "Demo-App-List",
"description": "Desc Not Required",
"type": "app",
"entries": [
{
"appFamily": "web"
},
{
"appFamily": "audio-video"
}
]
}
},
"App list": {
"description": "App list",
"value": {
"name": "Demo-App-List",
"description": "Desc Not Required",
"type": "app",
"entries": [
{
"app": "facebook"
},
{
"app": "netshow"
}
]
}
},
"Color list": {
"description": "Color list",
"value": {
"name": "Demo-Color-List",
"description": "Desc Not Required",
"type": "color",
"entries": [
{
"color": "biz-internet"
},
{
"color": "public-internet"
}
]
}
},
"Data prefix": {
"description": "Data prefix",
"value": {
"name": "Demo-Data-Prefix-List",
"description": "Desc Not Required",
"type": "dataprefix",
"entries": [
{
"ipPrefix": "10.1.0.0/16"
},
{
"ipPrefix": "10.2.0.0/16"
}
]
}
},
"Policer": {
"description": "Policer",
"value": {
"name": "Demo-Policer-list",
"description": "Desc Not Required",
"type": "policer",
"entries": [
{
"burst": "16000",
"exceed": "drop",
"rate": "10000"
}
]
}
},
"Prefix": {
"description": "Prefix",
"value": {
"name": "Demo-Prefix-list",
"description": "Desc Not Required",
"type": "prefix",
"entries": [
{
"ipPrefix": "10.0.0.0/12",
"le": "32"
}
]
}
},
"Site": {
"description": "Site",
"value": {
"name": "Demo-Site-List",
"description": "Desc Not Required",
"type": "site",
"listId": null,
"entries": [
{
"siteId": "100"
},
{
"siteId": "200"
},
{
"siteId": "300-500"
}
]
}
},
"Class": {
"description": "Class",
"value": {
"name": "Demo-Class-Map",
"description": "Desc Not Required",
"type": "class",
"entries": [
{
"queue": "4"
}
]
}
},
"App probe": {
"description": "App probe",
"value": {
"name": "Demo-Probe-Class",
"type": "appProbe",
"entries": [
{
"map": [
{
"color": "biz-internet",
"dscp": 46
},
{
"color": "public-internet",
"dscp": 20
}
],
"forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70"
}
]
}
},
"SLA": {
"description": "SLA",
"value": {
"name": "Demo-SLA-Class",
"description": "Desc Not Required",
"type": "sla",
"entries": [
{
"latency": "100",
"loss": "10",
"jitter": "10",
"appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d"
}
]
}
},
"TLOC": {
"description": "TLOC",
"value": {
"name": "Demo-TLOC-List",
"description": "Desc Not Required",
"type": "tloc",
"entries": [
{
"tloc": "10.1.1.1",
"color": "biz-internet",
"encap": "ipsec",
"preference": "10"
},
{
"tloc": "10.2.2.2",
"color": "biz-internet",
"encap": "ipsec",
"preference": "20"
}
]
}
},
"VPN": {
"description": "VPN",
"value": {
"name": "Demo-VPN-List",
"description": "Desc Not Required",
"type": "vpn",
"listId": null,
"entries": [
{
"vpn": "100"
},
{
"vpn": "200"
},
{
"vpn": "300-500"
}
]
}
},
"AS path": {
"description": "AS path",
"value": {
"name": "Demo-AS-Path-List",
"description": "Desc Not Required",
"type": "aspath",
"listId": null,
"entries": [
{
"asPath": "100"
},
{
"asPath": "200"
},
{
"asPath": "65002"
}
]
}
},
"Community": {
"description": "Community",
"value": {
"name": "Demo-Community-List",
"description": "Desc Not Required",
"type": "community",
"listId": null,
"entries": [
{
"community": "1000:10000"
}
]
}
},
"Ext community": {
"description": "Ext community",
"value": {
"name": "Demo-Extended-Community-List",
"description": "Desc Not Required",
"type": "extcommunity",
"listId": null,
"entries": [
{
"community": "rt 100:10"
}
]
}
},
"Mirror": {
"description": "Mirror",
"value": {
"name": "Demo-Mirror-List",
"description": "Desc Not Required",
"type": "mirror",
"entries": [
{
"remoteDest": "10.1.1.1",
"source": "20.1.1.1"
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Task Id": {
"description": "Task Id",
"value": {
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6"
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"delete": {
"tags": [
"Configuration - Policy TranslationProfile List Builder"
],
"description": "Delete policy lists with specific info tag",
"operationId": "deletePolicyListsWithInfoTag_ConfigurationPolicyTranslationprofileListBuilder_4006",
"parameters": [
{
"name": "infoTag",
"in": "query",
"description": "InfoTag",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/list/translationprofile/filtered": {
"get": {
"tags": [
"Configuration - Policy TranslationProfile List Builder"
],
"description": "Get policy lists with specific info tag",
"operationId": "getPolicyListsWithInfoTag_ConfigurationPolicyTranslationprofileListBuilder_4903",
"parameters": [
{
"name": "infoTag",
"in": "query",
"description": "InfoTag",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/list/translationprofile/preview": {
"post": {
"tags": [
"Configuration - Policy TranslationProfile List Builder"
],
"description": "Preview a policy list based on the policy list type",
"operationId": "previewPolicyList_ConfigurationPolicyTranslationprofileListBuilder_4804",
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy list": {
"description": "Policy list"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Preview policy list": {
"description": "Preview policy list",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/list/translationprofile/preview/{id}": {
"get": {
"tags": [
"Configuration - Policy TranslationProfile List Builder"
],
"description": "Preview a specific policy list entry based on id provided",
"operationId": "previewPolicyListById_ConfigurationPolicyTranslationprofileListBuilder_5303",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Preview policy list": {
"description": "Preview policy list",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/list/translationprofile/{id}": {
"get": {
"tags": [
"Configuration - Policy TranslationProfile List Builder"
],
"description": "Get a specific policy list based on the id",
"operationId": "getListsById_ConfigurationPolicyTranslationprofileListBuilder_4503",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy": {
"description": "Policy",
"value": {
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6",
"name": "Community",
"type": "community",
"description": "Desc Not Required",
"entries": [
{
"community": "1000:5000"
}
],
"lastUpdated": 1590184928436,
"owner": "admin",
"readOnly": false,
"version": "0",
"infoTag": "",
"referenceCount": 0,
"references": [],
"isActivatedByVsmart": false
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
},
"put": {
"tags": [
"Configuration - Policy TranslationProfile List Builder"
],
"description": "Edit policy list entries for a specific type of policy list",
"operationId": "editPolicyList_ConfigurationPolicyTranslationprofileListBuilder_4503",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": {
"name": "Community",
"description": "Desc Not Required",
"type": "community",
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6",
"entries": [
{
"community": "1000:8000"
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy": {
"description": "Policy",
"value": {
"masterTemplatesAffected": []
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"delete": {
"tags": [
"Configuration - Policy TranslationProfile List Builder"
],
"description": "Delete policy list entry for a specific type of policy list",
"operationId": "deletePolicyList_ConfigurationPolicyTranslationprofileListBuilder_4506",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/list/translationrules": {
"post": {
"tags": [
"Configuration - Policy TranslationRules List Builder"
],
"description": "Create policy list",
"operationId": "createPolicyList_ConfigurationPolicyTranslationrulesListBuilder_3804",
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Zone list": {
"description": "Zone list",
"value": {
"name": "Demo-Zone",
"description": "Desc Not Required",
"type": "zone",
"entries": [
{
"vpn": "10"
}
]
}
},
"IPS list": {
"description": "IPS list",
"value": {
"name": "Demo-IPS-list",
"description": "Desc Not Required",
"type": "ipssignature",
"entries": [
{
"generatorId": "1111",
"signatureId": "4444"
}
]
}
},
"URL white list": {
"description": "URL white list",
"value": {
"name": "Demo-Whitelist",
"description": "Desc Not Required",
"type": "urlwhitelist",
"entries": [
{
"pattern": "https://www.youtube.com"
}
]
}
},
"URL black list": {
"description": "URL black list",
"value": {
"name": "Demo-Black-list",
"description": "Desc Not Required",
"type": "urlblacklist",
"entries": [
{
"pattern": "www.facebook.com"
}
]
}
},
"TG API key list": {
"description": "TG API key list",
"value": {
"name": "threatGridApiKeyList",
"description": "",
"type": "threatGridApiKey",
"entries": [
{
"region": "nam",
"apikey": "1234567"
},
{
"region": "eur",
"apikey": "1234567"
}
]
}
},
"Local domain list": {
"description": "Local domain list",
"value": {
"name": "Demo-Domain-Name-List",
"description": "Desc Not Required",
"type": "localdomain",
"entries": [
{
"nameServer": "cisco.com"
}
]
}
},
"Umbrella data list": {
"description": "Umbrella data list",
"value": {
"name": "umbrellaTokenList",
"description": "",
"type": "umbrellaData",
"entries": [
{
"apiKey": "abcd",
"secret": "12345",
"umbOrgId": "23405",
"token": "abcedabcedabcedabcedabcedabcedabcedabced"
}
]
}
},
"App family": {
"description": "App family",
"value": {
"name": "Demo-App-List",
"description": "Desc Not Required",
"type": "app",
"entries": [
{
"appFamily": "web"
},
{
"appFamily": "audio-video"
}
]
}
},
"App list": {
"description": "App list",
"value": {
"name": "Demo-App-List",
"description": "Desc Not Required",
"type": "app",
"entries": [
{
"app": "facebook"
},
{
"app": "netshow"
}
]
}
},
"Color list": {
"description": "Color list",
"value": {
"name": "Demo-Color-List",
"description": "Desc Not Required",
"type": "color",
"entries": [
{
"color": "biz-internet"
},
{
"color": "public-internet"
}
]
}
},
"Data prefix": {
"description": "Data prefix",
"value": {
"name": "Demo-Data-Prefix-List",
"description": "Desc Not Required",
"type": "dataprefix",
"entries": [
{
"ipPrefix": "10.1.0.0/16"
},
{
"ipPrefix": "10.2.0.0/16"
}
]
}
},
"Policer": {
"description": "Policer",
"value": {
"name": "Demo-Policer-list",
"description": "Desc Not Required",
"type": "policer",
"entries": [
{
"burst": "16000",
"exceed": "drop",
"rate": "10000"
}
]
}
},
"Prefix": {
"description": "Prefix",
"value": {
"name": "Demo-Prefix-list",
"description": "Desc Not Required",
"type": "prefix",
"entries": [
{
"ipPrefix": "10.0.0.0/12",
"le": "32"
}
]
}
},
"Site": {
"description": "Site",
"value": {
"name": "Demo-Site-List",
"description": "Desc Not Required",
"type": "site",
"listId": null,
"entries": [
{
"siteId": "100"
},
{
"siteId": "200"
},
{
"siteId": "300-500"
}
]
}
},
"Class": {
"description": "Class",
"value": {
"name": "Demo-Class-Map",
"description": "Desc Not Required",
"type": "class",
"entries": [
{
"queue": "4"
}
]
}
},
"App probe": {
"description": "App probe",
"value": {
"name": "Demo-Probe-Class",
"type": "appProbe",
"entries": [
{
"map": [
{
"color": "biz-internet",
"dscp": 46
},
{
"color": "public-internet",
"dscp": 20
}
],
"forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70"
}
]
}
},
"SLA": {
"description": "SLA",
"value": {
"name": "Demo-SLA-Class",
"description": "Desc Not Required",
"type": "sla",
"entries": [
{
"latency": "100",
"loss": "10",
"jitter": "10",
"appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d"
}
]
}
},
"TLOC": {
"description": "TLOC",
"value": {
"name": "Demo-TLOC-List",
"description": "Desc Not Required",
"type": "tloc",
"entries": [
{
"tloc": "10.1.1.1",
"color": "biz-internet",
"encap": "ipsec",
"preference": "10"
},
{
"tloc": "10.2.2.2",
"color": "biz-internet",
"encap": "ipsec",
"preference": "20"
}
]
}
},
"VPN": {
"description": "VPN",
"value": {
"name": "Demo-VPN-List",
"description": "Desc Not Required",
"type": "vpn",
"listId": null,
"entries": [
{
"vpn": "100"
},
{
"vpn": "200"
},
{
"vpn": "300-500"
}
]
}
},
"AS path": {
"description": "AS path",
"value": {
"name": "Demo-AS-Path-List",
"description": "Desc Not Required",
"type": "aspath",
"listId": null,
"entries": [
{
"asPath": "100"
},
{
"asPath": "200"
},
{
"asPath": "65002"
}
]
}
},
"Community": {
"description": "Community",
"value": {
"name": "Demo-Community-List",
"description": "Desc Not Required",
"type": "community",
"listId": null,
"entries": [
{
"community": "1000:10000"
}
]
}
},
"Ext community": {
"description": "Ext community",
"value": {
"name": "Demo-Extended-Community-List",
"description": "Desc Not Required",
"type": "extcommunity",
"listId": null,
"entries": [
{
"community": "rt 100:10"
}
]
}
},
"Mirror": {
"description": "Mirror",
"value": {
"name": "Demo-Mirror-List",
"description": "Desc Not Required",
"type": "mirror",
"entries": [
{
"remoteDest": "10.1.1.1",
"source": "20.1.1.1"
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Task Id": {
"description": "Task Id",
"value": {
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6"
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"get": {
"tags": [
"Configuration - Policy TranslationRules List Builder"
],
"description": "Get policy lists",
"operationId": "getPolicyLists_ConfigurationPolicyTranslationrulesListBuilder_3803",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"App Policy": {
"description": "App Policy",
"value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"
},
"Prefix List": {
"description": "Prefix List",
"value": {
"data": [
{
"listId": "8bc43c09-f72c-40b8-aa90-608c7005e607",
"name": "Example",
"type": "prefix",
"description": "Desc Not Required",
"entries": [
{
"ipPrefix": "10.0.0.0/24"
}
],
"lastUpdated": 1588178457305,
"owner": "admin",
"readOnly": false,
"version": "0",
"infoTag": "",
"referenceCount": 0,
"references": [],
"isActivatedByVsmart": false
}
]
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
},
"delete": {
"tags": [
"Configuration - Policy TranslationRules List Builder"
],
"description": "Delete policy lists with specific info tag",
"operationId": "deletePolicyListsWithInfoTag_ConfigurationPolicyTranslationrulesListBuilder_3806",
"parameters": [
{
"name": "infoTag",
"in": "query",
"description": "InfoTag",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/list/translationrules/filtered": {
"get": {
"tags": [
"Configuration - Policy TranslationRules List Builder"
],
"description": "Get policy lists with specific info tag",
"operationId": "getPolicyListsWithInfoTag_ConfigurationPolicyTranslationrulesListBuilder_4703",
"parameters": [
{
"name": "infoTag",
"in": "query",
"description": "InfoTag",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/list/translationrules/preview": {
"post": {
"tags": [
"Configuration - Policy TranslationRules List Builder"
],
"description": "Preview a policy list based on the policy list type",
"operationId": "previewPolicyList_ConfigurationPolicyTranslationrulesListBuilder_4604",
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy list": {
"description": "Policy list"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Preview policy list": {
"description": "Preview policy list",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/list/translationrules/preview/{id}": {
"get": {
"tags": [
"Configuration - Policy TranslationRules List Builder"
],
"description": "Preview a specific policy list entry based on id provided",
"operationId": "previewPolicyListById_ConfigurationPolicyTranslationrulesListBuilder_5103",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Preview policy list": {
"description": "Preview policy list",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/list/translationrules/{id}": {
"delete": {
"tags": [
"Configuration - Policy TranslationRules List Builder"
],
"description": "Delete policy list entry for a specific type of policy list",
"operationId": "deletePolicyList_ConfigurationPolicyTranslationrulesListBuilder_4306",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"put": {
"tags": [
"Configuration - Policy TranslationRules List Builder"
],
"description": "Edit policy list entries for a specific type of policy list",
"operationId": "editPolicyList_ConfigurationPolicyTranslationrulesListBuilder_4303",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": {
"name": "Community",
"description": "Desc Not Required",
"type": "community",
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6",
"entries": [
{
"community": "1000:8000"
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy": {
"description": "Policy",
"value": {
"masterTemplatesAffected": []
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"get": {
"tags": [
"Configuration - Policy TranslationRules List Builder"
],
"description": "Get a specific policy list based on the id",
"operationId": "getListsById_ConfigurationPolicyTranslationrulesListBuilder_4303",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy": {
"description": "Policy",
"value": {
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6",
"name": "Community",
"type": "community",
"description": "Desc Not Required",
"entries": [
{
"community": "1000:5000"
}
],
"lastUpdated": 1590184928436,
"owner": "admin",
"readOnly": false,
"version": "0",
"infoTag": "",
"referenceCount": 0,
"references": [],
"isActivatedByVsmart": false
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/list/trunkgroup": {
"get": {
"tags": [
"Configuration - Policy Trunk Group List Builder"
],
"description": "Get policy lists",
"operationId": "getPolicyLists_ConfigurationPolicyTrunkGroupListBuilder_3203",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"App Policy": {
"description": "App Policy",
"value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"
},
"Prefix List": {
"description": "Prefix List",
"value": {
"data": [
{
"listId": "8bc43c09-f72c-40b8-aa90-608c7005e607",
"name": "Example",
"type": "prefix",
"description": "Desc Not Required",
"entries": [
{
"ipPrefix": "10.0.0.0/24"
}
],
"lastUpdated": 1588178457305,
"owner": "admin",
"readOnly": false,
"version": "0",
"infoTag": "",
"referenceCount": 0,
"references": [],
"isActivatedByVsmart": false
}
]
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
},
"post": {
"tags": [
"Configuration - Policy Trunk Group List Builder"
],
"description": "Create policy list",
"operationId": "createPolicyList_ConfigurationPolicyTrunkGroupListBuilder_3204",
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Zone list": {
"description": "Zone list",
"value": {
"name": "Demo-Zone",
"description": "Desc Not Required",
"type": "zone",
"entries": [
{
"vpn": "10"
}
]
}
},
"IPS list": {
"description": "IPS list",
"value": {
"name": "Demo-IPS-list",
"description": "Desc Not Required",
"type": "ipssignature",
"entries": [
{
"generatorId": "1111",
"signatureId": "4444"
}
]
}
},
"URL white list": {
"description": "URL white list",
"value": {
"name": "Demo-Whitelist",
"description": "Desc Not Required",
"type": "urlwhitelist",
"entries": [
{
"pattern": "https://www.youtube.com"
}
]
}
},
"URL black list": {
"description": "URL black list",
"value": {
"name": "Demo-Black-list",
"description": "Desc Not Required",
"type": "urlblacklist",
"entries": [
{
"pattern": "www.facebook.com"
}
]
}
},
"TG API key list": {
"description": "TG API key list",
"value": {
"name": "threatGridApiKeyList",
"description": "",
"type": "threatGridApiKey",
"entries": [
{
"region": "nam",
"apikey": "1234567"
},
{
"region": "eur",
"apikey": "1234567"
}
]
}
},
"Local domain list": {
"description": "Local domain list",
"value": {
"name": "Demo-Domain-Name-List",
"description": "Desc Not Required",
"type": "localdomain",
"entries": [
{
"nameServer": "cisco.com"
}
]
}
},
"Umbrella data list": {
"description": "Umbrella data list",
"value": {
"name": "umbrellaTokenList",
"description": "",
"type": "umbrellaData",
"entries": [
{
"apiKey": "abcd",
"secret": "12345",
"umbOrgId": "23405",
"token": "abcedabcedabcedabcedabcedabcedabcedabced"
}
]
}
},
"App family": {
"description": "App family",
"value": {
"name": "Demo-App-List",
"description": "Desc Not Required",
"type": "app",
"entries": [
{
"appFamily": "web"
},
{
"appFamily": "audio-video"
}
]
}
},
"App list": {
"description": "App list",
"value": {
"name": "Demo-App-List",
"description": "Desc Not Required",
"type": "app",
"entries": [
{
"app": "facebook"
},
{
"app": "netshow"
}
]
}
},
"Color list": {
"description": "Color list",
"value": {
"name": "Demo-Color-List",
"description": "Desc Not Required",
"type": "color",
"entries": [
{
"color": "biz-internet"
},
{
"color": "public-internet"
}
]
}
},
"Data prefix": {
"description": "Data prefix",
"value": {
"name": "Demo-Data-Prefix-List",
"description": "Desc Not Required",
"type": "dataprefix",
"entries": [
{
"ipPrefix": "10.1.0.0/16"
},
{
"ipPrefix": "10.2.0.0/16"
}
]
}
},
"Policer": {
"description": "Policer",
"value": {
"name": "Demo-Policer-list",
"description": "Desc Not Required",
"type": "policer",
"entries": [
{
"burst": "16000",
"exceed": "drop",
"rate": "10000"
}
]
}
},
"Prefix": {
"description": "Prefix",
"value": {
"name": "Demo-Prefix-list",
"description": "Desc Not Required",
"type": "prefix",
"entries": [
{
"ipPrefix": "10.0.0.0/12",
"le": "32"
}
]
}
},
"Site": {
"description": "Site",
"value": {
"name": "Demo-Site-List",
"description": "Desc Not Required",
"type": "site",
"listId": null,
"entries": [
{
"siteId": "100"
},
{
"siteId": "200"
},
{
"siteId": "300-500"
}
]
}
},
"Class": {
"description": "Class",
"value": {
"name": "Demo-Class-Map",
"description": "Desc Not Required",
"type": "class",
"entries": [
{
"queue": "4"
}
]
}
},
"App probe": {
"description": "App probe",
"value": {
"name": "Demo-Probe-Class",
"type": "appProbe",
"entries": [
{
"map": [
{
"color": "biz-internet",
"dscp": 46
},
{
"color": "public-internet",
"dscp": 20
}
],
"forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70"
}
]
}
},
"SLA": {
"description": "SLA",
"value": {
"name": "Demo-SLA-Class",
"description": "Desc Not Required",
"type": "sla",
"entries": [
{
"latency": "100",
"loss": "10",
"jitter": "10",
"appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d"
}
]
}
},
"TLOC": {
"description": "TLOC",
"value": {
"name": "Demo-TLOC-List",
"description": "Desc Not Required",
"type": "tloc",
"entries": [
{
"tloc": "10.1.1.1",
"color": "biz-internet",
"encap": "ipsec",
"preference": "10"
},
{
"tloc": "10.2.2.2",
"color": "biz-internet",
"encap": "ipsec",
"preference": "20"
}
]
}
},
"VPN": {
"description": "VPN",
"value": {
"name": "Demo-VPN-List",
"description": "Desc Not Required",
"type": "vpn",
"listId": null,
"entries": [
{
"vpn": "100"
},
{
"vpn": "200"
},
{
"vpn": "300-500"
}
]
}
},
"AS path": {
"description": "AS path",
"value": {
"name": "Demo-AS-Path-List",
"description": "Desc Not Required",
"type": "aspath",
"listId": null,
"entries": [
{
"asPath": "100"
},
{
"asPath": "200"
},
{
"asPath": "65002"
}
]
}
},
"Community": {
"description": "Community",
"value": {
"name": "Demo-Community-List",
"description": "Desc Not Required",
"type": "community",
"listId": null,
"entries": [
{
"community": "1000:10000"
}
]
}
},
"Ext community": {
"description": "Ext community",
"value": {
"name": "Demo-Extended-Community-List",
"description": "Desc Not Required",
"type": "extcommunity",
"listId": null,
"entries": [
{
"community": "rt 100:10"
}
]
}
},
"Mirror": {
"description": "Mirror",
"value": {
"name": "Demo-Mirror-List",
"description": "Desc Not Required",
"type": "mirror",
"entries": [
{
"remoteDest": "10.1.1.1",
"source": "20.1.1.1"
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Task Id": {
"description": "Task Id",
"value": {
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6"
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"delete": {
"tags": [
"Configuration - Policy Trunk Group List Builder"
],
"description": "Delete policy lists with specific info tag",
"operationId": "deletePolicyListsWithInfoTag_ConfigurationPolicyTrunkGroupListBuilder_3206",
"parameters": [
{
"name": "infoTag",
"in": "query",
"description": "InfoTag",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/list/trunkgroup/filtered": {
"get": {
"tags": [
"Configuration - Policy Trunk Group List Builder"
],
"description": "Get policy lists with specific info tag",
"operationId": "getPolicyListsWithInfoTag_ConfigurationPolicyTrunkGroupListBuilder_4103",
"parameters": [
{
"name": "infoTag",
"in": "query",
"description": "InfoTag",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/list/trunkgroup/preview": {
"post": {
"tags": [
"Configuration - Policy Trunk Group List Builder"
],
"description": "Preview a policy list based on the policy list type",
"operationId": "previewPolicyList_ConfigurationPolicyTrunkGroupListBuilder_4004",
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy list": {
"description": "Policy list"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Preview policy list": {
"description": "Preview policy list",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/list/trunkgroup/preview/{id}": {
"get": {
"tags": [
"Configuration - Policy Trunk Group List Builder"
],
"description": "Preview a specific policy list entry based on id provided",
"operationId": "previewPolicyListById_ConfigurationPolicyTrunkGroupListBuilder_4503",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Preview policy list": {
"description": "Preview policy list",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/list/trunkgroup/{id}": {
"get": {
"tags": [
"Configuration - Policy Trunk Group List Builder"
],
"description": "Get a specific policy list based on the id",
"operationId": "getListsById_ConfigurationPolicyTrunkGroupListBuilder_3703",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy": {
"description": "Policy",
"value": {
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6",
"name": "Community",
"type": "community",
"description": "Desc Not Required",
"entries": [
{
"community": "1000:5000"
}
],
"lastUpdated": 1590184928436,
"owner": "admin",
"readOnly": false,
"version": "0",
"infoTag": "",
"referenceCount": 0,
"references": [],
"isActivatedByVsmart": false
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
},
"delete": {
"tags": [
"Configuration - Policy Trunk Group List Builder"
],
"description": "Delete policy list entry for a specific type of policy list",
"operationId": "deletePolicyList_ConfigurationPolicyTrunkGroupListBuilder_3706",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"put": {
"tags": [
"Configuration - Policy Trunk Group List Builder"
],
"description": "Edit policy list entries for a specific type of policy list",
"operationId": "editPolicyList_ConfigurationPolicyTrunkGroupListBuilder_3703",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": {
"name": "Community",
"description": "Desc Not Required",
"type": "community",
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6",
"entries": [
{
"community": "1000:8000"
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy": {
"description": "Policy",
"value": {
"masterTemplatesAffected": []
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/list/umbrelladata": {
"get": {
"tags": [
"Configuration - Policy Umbrella Data List Builder"
],
"description": "Get policy lists",
"operationId": "getPolicyLists_ConfigurationPolicyUmbrellaDataListBuilder_3403",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"App Policy": {
"description": "App Policy",
"value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"
},
"Prefix List": {
"description": "Prefix List",
"value": {
"data": [
{
"listId": "8bc43c09-f72c-40b8-aa90-608c7005e607",
"name": "Example",
"type": "prefix",
"description": "Desc Not Required",
"entries": [
{
"ipPrefix": "10.0.0.0/24"
}
],
"lastUpdated": 1588178457305,
"owner": "admin",
"readOnly": false,
"version": "0",
"infoTag": "",
"referenceCount": 0,
"references": [],
"isActivatedByVsmart": false
}
]
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
},
"post": {
"tags": [
"Configuration - Policy Umbrella Data List Builder"
],
"description": "Create policy list",
"operationId": "createPolicyList_ConfigurationPolicyUmbrellaDataListBuilder_3404",
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Zone list": {
"description": "Zone list",
"value": {
"name": "Demo-Zone",
"description": "Desc Not Required",
"type": "zone",
"entries": [
{
"vpn": "10"
}
]
}
},
"IPS list": {
"description": "IPS list",
"value": {
"name": "Demo-IPS-list",
"description": "Desc Not Required",
"type": "ipssignature",
"entries": [
{
"generatorId": "1111",
"signatureId": "4444"
}
]
}
},
"URL white list": {
"description": "URL white list",
"value": {
"name": "Demo-Whitelist",
"description": "Desc Not Required",
"type": "urlwhitelist",
"entries": [
{
"pattern": "https://www.youtube.com"
}
]
}
},
"URL black list": {
"description": "URL black list",
"value": {
"name": "Demo-Black-list",
"description": "Desc Not Required",
"type": "urlblacklist",
"entries": [
{
"pattern": "www.facebook.com"
}
]
}
},
"TG API key list": {
"description": "TG API key list",
"value": {
"name": "threatGridApiKeyList",
"description": "",
"type": "threatGridApiKey",
"entries": [
{
"region": "nam",
"apikey": "1234567"
},
{
"region": "eur",
"apikey": "1234567"
}
]
}
},
"Local domain list": {
"description": "Local domain list",
"value": {
"name": "Demo-Domain-Name-List",
"description": "Desc Not Required",
"type": "localdomain",
"entries": [
{
"nameServer": "cisco.com"
}
]
}
},
"Umbrella data list": {
"description": "Umbrella data list",
"value": {
"name": "umbrellaTokenList",
"description": "",
"type": "umbrellaData",
"entries": [
{
"apiKey": "abcd",
"secret": "12345",
"umbOrgId": "23405",
"token": "abcedabcedabcedabcedabcedabcedabcedabced"
}
]
}
},
"App family": {
"description": "App family",
"value": {
"name": "Demo-App-List",
"description": "Desc Not Required",
"type": "app",
"entries": [
{
"appFamily": "web"
},
{
"appFamily": "audio-video"
}
]
}
},
"App list": {
"description": "App list",
"value": {
"name": "Demo-App-List",
"description": "Desc Not Required",
"type": "app",
"entries": [
{
"app": "facebook"
},
{
"app": "netshow"
}
]
}
},
"Color list": {
"description": "Color list",
"value": {
"name": "Demo-Color-List",
"description": "Desc Not Required",
"type": "color",
"entries": [
{
"color": "biz-internet"
},
{
"color": "public-internet"
}
]
}
},
"Data prefix": {
"description": "Data prefix",
"value": {
"name": "Demo-Data-Prefix-List",
"description": "Desc Not Required",
"type": "dataprefix",
"entries": [
{
"ipPrefix": "10.1.0.0/16"
},
{
"ipPrefix": "10.2.0.0/16"
}
]
}
},
"Policer": {
"description": "Policer",
"value": {
"name": "Demo-Policer-list",
"description": "Desc Not Required",
"type": "policer",
"entries": [
{
"burst": "16000",
"exceed": "drop",
"rate": "10000"
}
]
}
},
"Prefix": {
"description": "Prefix",
"value": {
"name": "Demo-Prefix-list",
"description": "Desc Not Required",
"type": "prefix",
"entries": [
{
"ipPrefix": "10.0.0.0/12",
"le": "32"
}
]
}
},
"Site": {
"description": "Site",
"value": {
"name": "Demo-Site-List",
"description": "Desc Not Required",
"type": "site",
"listId": null,
"entries": [
{
"siteId": "100"
},
{
"siteId": "200"
},
{
"siteId": "300-500"
}
]
}
},
"Class": {
"description": "Class",
"value": {
"name": "Demo-Class-Map",
"description": "Desc Not Required",
"type": "class",
"entries": [
{
"queue": "4"
}
]
}
},
"App probe": {
"description": "App probe",
"value": {
"name": "Demo-Probe-Class",
"type": "appProbe",
"entries": [
{
"map": [
{
"color": "biz-internet",
"dscp": 46
},
{
"color": "public-internet",
"dscp": 20
}
],
"forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70"
}
]
}
},
"SLA": {
"description": "SLA",
"value": {
"name": "Demo-SLA-Class",
"description": "Desc Not Required",
"type": "sla",
"entries": [
{
"latency": "100",
"loss": "10",
"jitter": "10",
"appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d"
}
]
}
},
"TLOC": {
"description": "TLOC",
"value": {
"name": "Demo-TLOC-List",
"description": "Desc Not Required",
"type": "tloc",
"entries": [
{
"tloc": "10.1.1.1",
"color": "biz-internet",
"encap": "ipsec",
"preference": "10"
},
{
"tloc": "10.2.2.2",
"color": "biz-internet",
"encap": "ipsec",
"preference": "20"
}
]
}
},
"VPN": {
"description": "VPN",
"value": {
"name": "Demo-VPN-List",
"description": "Desc Not Required",
"type": "vpn",
"listId": null,
"entries": [
{
"vpn": "100"
},
{
"vpn": "200"
},
{
"vpn": "300-500"
}
]
}
},
"AS path": {
"description": "AS path",
"value": {
"name": "Demo-AS-Path-List",
"description": "Desc Not Required",
"type": "aspath",
"listId": null,
"entries": [
{
"asPath": "100"
},
{
"asPath": "200"
},
{
"asPath": "65002"
}
]
}
},
"Community": {
"description": "Community",
"value": {
"name": "Demo-Community-List",
"description": "Desc Not Required",
"type": "community",
"listId": null,
"entries": [
{
"community": "1000:10000"
}
]
}
},
"Ext community": {
"description": "Ext community",
"value": {
"name": "Demo-Extended-Community-List",
"description": "Desc Not Required",
"type": "extcommunity",
"listId": null,
"entries": [
{
"community": "rt 100:10"
}
]
}
},
"Mirror": {
"description": "Mirror",
"value": {
"name": "Demo-Mirror-List",
"description": "Desc Not Required",
"type": "mirror",
"entries": [
{
"remoteDest": "10.1.1.1",
"source": "20.1.1.1"
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Task Id": {
"description": "Task Id",
"value": {
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6"
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"delete": {
"tags": [
"Configuration - Policy Umbrella Data List Builder"
],
"description": "Delete policy lists with specific info tag",
"operationId": "deletePolicyListsWithInfoTag_ConfigurationPolicyUmbrellaDataListBuilder_3406",
"parameters": [
{
"name": "infoTag",
"in": "query",
"description": "InfoTag",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/list/umbrelladata/filtered": {
"get": {
"tags": [
"Configuration - Policy Umbrella Data List Builder"
],
"description": "Get policy lists with specific info tag",
"operationId": "getPolicyListsWithInfoTag_ConfigurationPolicyUmbrellaDataListBuilder_4303",
"parameters": [
{
"name": "infoTag",
"in": "query",
"description": "InfoTag",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/list/umbrelladata/preview": {
"post": {
"tags": [
"Configuration - Policy Umbrella Data List Builder"
],
"description": "Preview a policy list based on the policy list type",
"operationId": "previewPolicyList_ConfigurationPolicyUmbrellaDataListBuilder_4204",
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy list": {
"description": "Policy list"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Preview policy list": {
"description": "Preview policy list",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/list/umbrelladata/preview/{id}": {
"get": {
"tags": [
"Configuration - Policy Umbrella Data List Builder"
],
"description": "Preview a specific policy list entry based on id provided",
"operationId": "previewPolicyListById_ConfigurationPolicyUmbrellaDataListBuilder_4703",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Preview policy list": {
"description": "Preview policy list",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/list/umbrelladata/{id}": {
"get": {
"tags": [
"Configuration - Policy Umbrella Data List Builder"
],
"description": "Get a specific policy list based on the id",
"operationId": "getListsById_ConfigurationPolicyUmbrellaDataListBuilder_3903",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy": {
"description": "Policy",
"value": {
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6",
"name": "Community",
"type": "community",
"description": "Desc Not Required",
"entries": [
{
"community": "1000:5000"
}
],
"lastUpdated": 1590184928436,
"owner": "admin",
"readOnly": false,
"version": "0",
"infoTag": "",
"referenceCount": 0,
"references": [],
"isActivatedByVsmart": false
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
},
"put": {
"tags": [
"Configuration - Policy Umbrella Data List Builder"
],
"description": "Edit policy list entries for a specific type of policy list",
"operationId": "editPolicyList_ConfigurationPolicyUmbrellaDataListBuilder_3903",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": {
"name": "Community",
"description": "Desc Not Required",
"type": "community",
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6",
"entries": [
{
"community": "1000:8000"
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy": {
"description": "Policy",
"value": {
"masterTemplatesAffected": []
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"delete": {
"tags": [
"Configuration - Policy Umbrella Data List Builder"
],
"description": "Delete policy list entry for a specific type of policy list",
"operationId": "deletePolicyList_ConfigurationPolicyUmbrellaDataListBuilder_3906",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/list/urlblacklist": {
"get": {
"tags": [
"Configuration - Policy URL BlackList Builder"
],
"description": "Get policy lists",
"operationId": "getPolicyLists_ConfigurationPolicyUrlBlacklistBuilder_3403",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"App Policy": {
"description": "App Policy",
"value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"
},
"Prefix List": {
"description": "Prefix List",
"value": {
"data": [
{
"listId": "8bc43c09-f72c-40b8-aa90-608c7005e607",
"name": "Example",
"type": "prefix",
"description": "Desc Not Required",
"entries": [
{
"ipPrefix": "10.0.0.0/24"
}
],
"lastUpdated": 1588178457305,
"owner": "admin",
"readOnly": false,
"version": "0",
"infoTag": "",
"referenceCount": 0,
"references": [],
"isActivatedByVsmart": false
}
]
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
},
"delete": {
"tags": [
"Configuration - Policy URL BlackList Builder"
],
"description": "Delete policy lists with specific info tag",
"operationId": "deletePolicyListsWithInfoTag_ConfigurationPolicyUrlBlacklistBuilder_3406",
"parameters": [
{
"name": "infoTag",
"in": "query",
"description": "InfoTag",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
},
"post": {
"tags": [
"Configuration - Policy URL BlackList Builder"
],
"description": "Create policy list",
"operationId": "createPolicyList_ConfigurationPolicyUrlBlacklistBuilder_3404",
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Zone list": {
"description": "Zone list",
"value": {
"name": "Demo-Zone",
"description": "Desc Not Required",
"type": "zone",
"entries": [
{
"vpn": "10"
}
]
}
},
"IPS list": {
"description": "IPS list",
"value": {
"name": "Demo-IPS-list",
"description": "Desc Not Required",
"type": "ipssignature",
"entries": [
{
"generatorId": "1111",
"signatureId": "4444"
}
]
}
},
"URL white list": {
"description": "URL white list",
"value": {
"name": "Demo-Whitelist",
"description": "Desc Not Required",
"type": "urlwhitelist",
"entries": [
{
"pattern": "https://www.youtube.com"
}
]
}
},
"URL black list": {
"description": "URL black list",
"value": {
"name": "Demo-Black-list",
"description": "Desc Not Required",
"type": "urlblacklist",
"entries": [
{
"pattern": "www.facebook.com"
}
]
}
},
"TG API key list": {
"description": "TG API key list",
"value": {
"name": "threatGridApiKeyList",
"description": "",
"type": "threatGridApiKey",
"entries": [
{
"region": "nam",
"apikey": "1234567"
},
{
"region": "eur",
"apikey": "1234567"
}
]
}
},
"Local domain list": {
"description": "Local domain list",
"value": {
"name": "Demo-Domain-Name-List",
"description": "Desc Not Required",
"type": "localdomain",
"entries": [
{
"nameServer": "cisco.com"
}
]
}
},
"Umbrella data list": {
"description": "Umbrella data list",
"value": {
"name": "umbrellaTokenList",
"description": "",
"type": "umbrellaData",
"entries": [
{
"apiKey": "abcd",
"secret": "12345",
"umbOrgId": "23405",
"token": "abcedabcedabcedabcedabcedabcedabcedabced"
}
]
}
},
"App family": {
"description": "App family",
"value": {
"name": "Demo-App-List",
"description": "Desc Not Required",
"type": "app",
"entries": [
{
"appFamily": "web"
},
{
"appFamily": "audio-video"
}
]
}
},
"App list": {
"description": "App list",
"value": {
"name": "Demo-App-List",
"description": "Desc Not Required",
"type": "app",
"entries": [
{
"app": "facebook"
},
{
"app": "netshow"
}
]
}
},
"Color list": {
"description": "Color list",
"value": {
"name": "Demo-Color-List",
"description": "Desc Not Required",
"type": "color",
"entries": [
{
"color": "biz-internet"
},
{
"color": "public-internet"
}
]
}
},
"Data prefix": {
"description": "Data prefix",
"value": {
"name": "Demo-Data-Prefix-List",
"description": "Desc Not Required",
"type": "dataprefix",
"entries": [
{
"ipPrefix": "10.1.0.0/16"
},
{
"ipPrefix": "10.2.0.0/16"
}
]
}
},
"Policer": {
"description": "Policer",
"value": {
"name": "Demo-Policer-list",
"description": "Desc Not Required",
"type": "policer",
"entries": [
{
"burst": "16000",
"exceed": "drop",
"rate": "10000"
}
]
}
},
"Prefix": {
"description": "Prefix",
"value": {
"name": "Demo-Prefix-list",
"description": "Desc Not Required",
"type": "prefix",
"entries": [
{
"ipPrefix": "10.0.0.0/12",
"le": "32"
}
]
}
},
"Site": {
"description": "Site",
"value": {
"name": "Demo-Site-List",
"description": "Desc Not Required",
"type": "site",
"listId": null,
"entries": [
{
"siteId": "100"
},
{
"siteId": "200"
},
{
"siteId": "300-500"
}
]
}
},
"Class": {
"description": "Class",
"value": {
"name": "Demo-Class-Map",
"description": "Desc Not Required",
"type": "class",
"entries": [
{
"queue": "4"
}
]
}
},
"App probe": {
"description": "App probe",
"value": {
"name": "Demo-Probe-Class",
"type": "appProbe",
"entries": [
{
"map": [
{
"color": "biz-internet",
"dscp": 46
},
{
"color": "public-internet",
"dscp": 20
}
],
"forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70"
}
]
}
},
"SLA": {
"description": "SLA",
"value": {
"name": "Demo-SLA-Class",
"description": "Desc Not Required",
"type": "sla",
"entries": [
{
"latency": "100",
"loss": "10",
"jitter": "10",
"appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d"
}
]
}
},
"TLOC": {
"description": "TLOC",
"value": {
"name": "Demo-TLOC-List",
"description": "Desc Not Required",
"type": "tloc",
"entries": [
{
"tloc": "10.1.1.1",
"color": "biz-internet",
"encap": "ipsec",
"preference": "10"
},
{
"tloc": "10.2.2.2",
"color": "biz-internet",
"encap": "ipsec",
"preference": "20"
}
]
}
},
"VPN": {
"description": "VPN",
"value": {
"name": "Demo-VPN-List",
"description": "Desc Not Required",
"type": "vpn",
"listId": null,
"entries": [
{
"vpn": "100"
},
{
"vpn": "200"
},
{
"vpn": "300-500"
}
]
}
},
"AS path": {
"description": "AS path",
"value": {
"name": "Demo-AS-Path-List",
"description": "Desc Not Required",
"type": "aspath",
"listId": null,
"entries": [
{
"asPath": "100"
},
{
"asPath": "200"
},
{
"asPath": "65002"
}
]
}
},
"Community": {
"description": "Community",
"value": {
"name": "Demo-Community-List",
"description": "Desc Not Required",
"type": "community",
"listId": null,
"entries": [
{
"community": "1000:10000"
}
]
}
},
"Ext community": {
"description": "Ext community",
"value": {
"name": "Demo-Extended-Community-List",
"description": "Desc Not Required",
"type": "extcommunity",
"listId": null,
"entries": [
{
"community": "rt 100:10"
}
]
}
},
"Mirror": {
"description": "Mirror",
"value": {
"name": "Demo-Mirror-List",
"description": "Desc Not Required",
"type": "mirror",
"entries": [
{
"remoteDest": "10.1.1.1",
"source": "20.1.1.1"
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Task Id": {
"description": "Task Id",
"value": {
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6"
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/list/urlblacklist/filtered": {
"get": {
"tags": [
"Configuration - Policy URL BlackList Builder"
],
"description": "Get policy lists with specific info tag",
"operationId": "getPolicyListsWithInfoTag_ConfigurationPolicyUrlBlacklistBuilder_4303",
"parameters": [
{
"name": "infoTag",
"in": "query",
"description": "InfoTag",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/list/urlblacklist/preview": {
"post": {
"tags": [
"Configuration - Policy URL BlackList Builder"
],
"description": "Preview a policy list based on the policy list type",
"operationId": "previewPolicyList_ConfigurationPolicyUrlBlacklistBuilder_4204",
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy list": {
"description": "Policy list"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Preview policy list": {
"description": "Preview policy list",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/list/urlblacklist/preview/{id}": {
"get": {
"tags": [
"Configuration - Policy URL BlackList Builder"
],
"description": "Preview a specific policy list entry based on id provided",
"operationId": "previewPolicyListById_ConfigurationPolicyUrlBlacklistBuilder_4703",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Preview policy list": {
"description": "Preview policy list",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/list/urlblacklist/{id}": {
"put": {
"tags": [
"Configuration - Policy URL BlackList Builder"
],
"description": "Edit policy list entries for a specific type of policy list",
"operationId": "editPolicyList_ConfigurationPolicyUrlBlacklistBuilder_3903",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": {
"name": "Community",
"description": "Desc Not Required",
"type": "community",
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6",
"entries": [
{
"community": "1000:8000"
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy": {
"description": "Policy",
"value": {
"masterTemplatesAffected": []
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"get": {
"tags": [
"Configuration - Policy URL BlackList Builder"
],
"description": "Get a specific policy list based on the id",
"operationId": "getListsById_ConfigurationPolicyUrlBlacklistBuilder_3903",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy": {
"description": "Policy",
"value": {
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6",
"name": "Community",
"type": "community",
"description": "Desc Not Required",
"entries": [
{
"community": "1000:5000"
}
],
"lastUpdated": 1590184928436,
"owner": "admin",
"readOnly": false,
"version": "0",
"infoTag": "",
"referenceCount": 0,
"references": [],
"isActivatedByVsmart": false
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
},
"delete": {
"tags": [
"Configuration - Policy URL BlackList Builder"
],
"description": "Delete policy list entry for a specific type of policy list",
"operationId": "deletePolicyList_ConfigurationPolicyUrlBlacklistBuilder_3906",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/list/urlwhitelist": {
"post": {
"tags": [
"Configuration - Policy URL WhiteList Builder"
],
"description": "Create policy list",
"operationId": "createPolicyList_ConfigurationPolicyUrlWhitelistBuilder_3404",
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Zone list": {
"description": "Zone list",
"value": {
"name": "Demo-Zone",
"description": "Desc Not Required",
"type": "zone",
"entries": [
{
"vpn": "10"
}
]
}
},
"IPS list": {
"description": "IPS list",
"value": {
"name": "Demo-IPS-list",
"description": "Desc Not Required",
"type": "ipssignature",
"entries": [
{
"generatorId": "1111",
"signatureId": "4444"
}
]
}
},
"URL white list": {
"description": "URL white list",
"value": {
"name": "Demo-Whitelist",
"description": "Desc Not Required",
"type": "urlwhitelist",
"entries": [
{
"pattern": "https://www.youtube.com"
}
]
}
},
"URL black list": {
"description": "URL black list",
"value": {
"name": "Demo-Black-list",
"description": "Desc Not Required",
"type": "urlblacklist",
"entries": [
{
"pattern": "www.facebook.com"
}
]
}
},
"TG API key list": {
"description": "TG API key list",
"value": {
"name": "threatGridApiKeyList",
"description": "",
"type": "threatGridApiKey",
"entries": [
{
"region": "nam",
"apikey": "1234567"
},
{
"region": "eur",
"apikey": "1234567"
}
]
}
},
"Local domain list": {
"description": "Local domain list",
"value": {
"name": "Demo-Domain-Name-List",
"description": "Desc Not Required",
"type": "localdomain",
"entries": [
{
"nameServer": "cisco.com"
}
]
}
},
"Umbrella data list": {
"description": "Umbrella data list",
"value": {
"name": "umbrellaTokenList",
"description": "",
"type": "umbrellaData",
"entries": [
{
"apiKey": "abcd",
"secret": "12345",
"umbOrgId": "23405",
"token": "abcedabcedabcedabcedabcedabcedabcedabced"
}
]
}
},
"App family": {
"description": "App family",
"value": {
"name": "Demo-App-List",
"description": "Desc Not Required",
"type": "app",
"entries": [
{
"appFamily": "web"
},
{
"appFamily": "audio-video"
}
]
}
},
"App list": {
"description": "App list",
"value": {
"name": "Demo-App-List",
"description": "Desc Not Required",
"type": "app",
"entries": [
{
"app": "facebook"
},
{
"app": "netshow"
}
]
}
},
"Color list": {
"description": "Color list",
"value": {
"name": "Demo-Color-List",
"description": "Desc Not Required",
"type": "color",
"entries": [
{
"color": "biz-internet"
},
{
"color": "public-internet"
}
]
}
},
"Data prefix": {
"description": "Data prefix",
"value": {
"name": "Demo-Data-Prefix-List",
"description": "Desc Not Required",
"type": "dataprefix",
"entries": [
{
"ipPrefix": "10.1.0.0/16"
},
{
"ipPrefix": "10.2.0.0/16"
}
]
}
},
"Policer": {
"description": "Policer",
"value": {
"name": "Demo-Policer-list",
"description": "Desc Not Required",
"type": "policer",
"entries": [
{
"burst": "16000",
"exceed": "drop",
"rate": "10000"
}
]
}
},
"Prefix": {
"description": "Prefix",
"value": {
"name": "Demo-Prefix-list",
"description": "Desc Not Required",
"type": "prefix",
"entries": [
{
"ipPrefix": "10.0.0.0/12",
"le": "32"
}
]
}
},
"Site": {
"description": "Site",
"value": {
"name": "Demo-Site-List",
"description": "Desc Not Required",
"type": "site",
"listId": null,
"entries": [
{
"siteId": "100"
},
{
"siteId": "200"
},
{
"siteId": "300-500"
}
]
}
},
"Class": {
"description": "Class",
"value": {
"name": "Demo-Class-Map",
"description": "Desc Not Required",
"type": "class",
"entries": [
{
"queue": "4"
}
]
}
},
"App probe": {
"description": "App probe",
"value": {
"name": "Demo-Probe-Class",
"type": "appProbe",
"entries": [
{
"map": [
{
"color": "biz-internet",
"dscp": 46
},
{
"color": "public-internet",
"dscp": 20
}
],
"forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70"
}
]
}
},
"SLA": {
"description": "SLA",
"value": {
"name": "Demo-SLA-Class",
"description": "Desc Not Required",
"type": "sla",
"entries": [
{
"latency": "100",
"loss": "10",
"jitter": "10",
"appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d"
}
]
}
},
"TLOC": {
"description": "TLOC",
"value": {
"name": "Demo-TLOC-List",
"description": "Desc Not Required",
"type": "tloc",
"entries": [
{
"tloc": "10.1.1.1",
"color": "biz-internet",
"encap": "ipsec",
"preference": "10"
},
{
"tloc": "10.2.2.2",
"color": "biz-internet",
"encap": "ipsec",
"preference": "20"
}
]
}
},
"VPN": {
"description": "VPN",
"value": {
"name": "Demo-VPN-List",
"description": "Desc Not Required",
"type": "vpn",
"listId": null,
"entries": [
{
"vpn": "100"
},
{
"vpn": "200"
},
{
"vpn": "300-500"
}
]
}
},
"AS path": {
"description": "AS path",
"value": {
"name": "Demo-AS-Path-List",
"description": "Desc Not Required",
"type": "aspath",
"listId": null,
"entries": [
{
"asPath": "100"
},
{
"asPath": "200"
},
{
"asPath": "65002"
}
]
}
},
"Community": {
"description": "Community",
"value": {
"name": "Demo-Community-List",
"description": "Desc Not Required",
"type": "community",
"listId": null,
"entries": [
{
"community": "1000:10000"
}
]
}
},
"Ext community": {
"description": "Ext community",
"value": {
"name": "Demo-Extended-Community-List",
"description": "Desc Not Required",
"type": "extcommunity",
"listId": null,
"entries": [
{
"community": "rt 100:10"
}
]
}
},
"Mirror": {
"description": "Mirror",
"value": {
"name": "Demo-Mirror-List",
"description": "Desc Not Required",
"type": "mirror",
"entries": [
{
"remoteDest": "10.1.1.1",
"source": "20.1.1.1"
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Task Id": {
"description": "Task Id",
"value": {
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6"
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"get": {
"tags": [
"Configuration - Policy URL WhiteList Builder"
],
"description": "Get policy lists",
"operationId": "getPolicyLists_ConfigurationPolicyUrlWhitelistBuilder_3403",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"App Policy": {
"description": "App Policy",
"value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"
},
"Prefix List": {
"description": "Prefix List",
"value": {
"data": [
{
"listId": "8bc43c09-f72c-40b8-aa90-608c7005e607",
"name": "Example",
"type": "prefix",
"description": "Desc Not Required",
"entries": [
{
"ipPrefix": "10.0.0.0/24"
}
],
"lastUpdated": 1588178457305,
"owner": "admin",
"readOnly": false,
"version": "0",
"infoTag": "",
"referenceCount": 0,
"references": [],
"isActivatedByVsmart": false
}
]
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
},
"delete": {
"tags": [
"Configuration - Policy URL WhiteList Builder"
],
"description": "Delete policy lists with specific info tag",
"operationId": "deletePolicyListsWithInfoTag_ConfigurationPolicyUrlWhitelistBuilder_3406",
"parameters": [
{
"name": "infoTag",
"in": "query",
"description": "InfoTag",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/list/urlwhitelist/filtered": {
"get": {
"tags": [
"Configuration - Policy URL WhiteList Builder"
],
"description": "Get policy lists with specific info tag",
"operationId": "getPolicyListsWithInfoTag_ConfigurationPolicyUrlWhitelistBuilder_4303",
"parameters": [
{
"name": "infoTag",
"in": "query",
"description": "InfoTag",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/list/urlwhitelist/preview": {
"post": {
"tags": [
"Configuration - Policy URL WhiteList Builder"
],
"description": "Preview a policy list based on the policy list type",
"operationId": "previewPolicyList_ConfigurationPolicyUrlWhitelistBuilder_4204",
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy list": {
"description": "Policy list"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Preview policy list": {
"description": "Preview policy list",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/list/urlwhitelist/preview/{id}": {
"get": {
"tags": [
"Configuration - Policy URL WhiteList Builder"
],
"description": "Preview a specific policy list entry based on id provided",
"operationId": "previewPolicyListById_ConfigurationPolicyUrlWhitelistBuilder_4703",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Preview policy list": {
"description": "Preview policy list",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/list/urlwhitelist/{id}": {
"put": {
"tags": [
"Configuration - Policy URL WhiteList Builder"
],
"description": "Edit policy list entries for a specific type of policy list",
"operationId": "editPolicyList_ConfigurationPolicyUrlWhitelistBuilder_3903",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": {
"name": "Community",
"description": "Desc Not Required",
"type": "community",
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6",
"entries": [
{
"community": "1000:8000"
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy": {
"description": "Policy",
"value": {
"masterTemplatesAffected": []
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"delete": {
"tags": [
"Configuration - Policy URL WhiteList Builder"
],
"description": "Delete policy list entry for a specific type of policy list",
"operationId": "deletePolicyList_ConfigurationPolicyUrlWhitelistBuilder_3906",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"get": {
"tags": [
"Configuration - Policy URL WhiteList Builder"
],
"description": "Get a specific policy list based on the id",
"operationId": "getListsById_ConfigurationPolicyUrlWhitelistBuilder_3903",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy": {
"description": "Policy",
"value": {
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6",
"name": "Community",
"type": "community",
"description": "Desc Not Required",
"entries": [
{
"community": "1000:5000"
}
],
"lastUpdated": 1590184928436,
"owner": "admin",
"readOnly": false,
"version": "0",
"infoTag": "",
"referenceCount": 0,
"references": [],
"isActivatedByVsmart": false
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/list/vpn": {
"get": {
"tags": [
"Configuration - Policy VPN List Builder"
],
"description": "Get policy lists",
"operationId": "getPolicyLists_ConfigurationPolicyVpnListBuilder_2503",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"App Policy": {
"description": "App Policy",
"value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"
},
"Prefix List": {
"description": "Prefix List",
"value": {
"data": [
{
"listId": "8bc43c09-f72c-40b8-aa90-608c7005e607",
"name": "Example",
"type": "prefix",
"description": "Desc Not Required",
"entries": [
{
"ipPrefix": "10.0.0.0/24"
}
],
"lastUpdated": 1588178457305,
"owner": "admin",
"readOnly": false,
"version": "0",
"infoTag": "",
"referenceCount": 0,
"references": [],
"isActivatedByVsmart": false
}
]
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
},
"post": {
"tags": [
"Configuration - Policy VPN List Builder"
],
"description": "Create policy list",
"operationId": "createPolicyList_ConfigurationPolicyVpnListBuilder_2504",
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Zone list": {
"description": "Zone list",
"value": {
"name": "Demo-Zone",
"description": "Desc Not Required",
"type": "zone",
"entries": [
{
"vpn": "10"
}
]
}
},
"IPS list": {
"description": "IPS list",
"value": {
"name": "Demo-IPS-list",
"description": "Desc Not Required",
"type": "ipssignature",
"entries": [
{
"generatorId": "1111",
"signatureId": "4444"
}
]
}
},
"URL white list": {
"description": "URL white list",
"value": {
"name": "Demo-Whitelist",
"description": "Desc Not Required",
"type": "urlwhitelist",
"entries": [
{
"pattern": "https://www.youtube.com"
}
]
}
},
"URL black list": {
"description": "URL black list",
"value": {
"name": "Demo-Black-list",
"description": "Desc Not Required",
"type": "urlblacklist",
"entries": [
{
"pattern": "www.facebook.com"
}
]
}
},
"TG API key list": {
"description": "TG API key list",
"value": {
"name": "threatGridApiKeyList",
"description": "",
"type": "threatGridApiKey",
"entries": [
{
"region": "nam",
"apikey": "1234567"
},
{
"region": "eur",
"apikey": "1234567"
}
]
}
},
"Local domain list": {
"description": "Local domain list",
"value": {
"name": "Demo-Domain-Name-List",
"description": "Desc Not Required",
"type": "localdomain",
"entries": [
{
"nameServer": "cisco.com"
}
]
}
},
"Umbrella data list": {
"description": "Umbrella data list",
"value": {
"name": "umbrellaTokenList",
"description": "",
"type": "umbrellaData",
"entries": [
{
"apiKey": "abcd",
"secret": "12345",
"umbOrgId": "23405",
"token": "abcedabcedabcedabcedabcedabcedabcedabced"
}
]
}
},
"App family": {
"description": "App family",
"value": {
"name": "Demo-App-List",
"description": "Desc Not Required",
"type": "app",
"entries": [
{
"appFamily": "web"
},
{
"appFamily": "audio-video"
}
]
}
},
"App list": {
"description": "App list",
"value": {
"name": "Demo-App-List",
"description": "Desc Not Required",
"type": "app",
"entries": [
{
"app": "facebook"
},
{
"app": "netshow"
}
]
}
},
"Color list": {
"description": "Color list",
"value": {
"name": "Demo-Color-List",
"description": "Desc Not Required",
"type": "color",
"entries": [
{
"color": "biz-internet"
},
{
"color": "public-internet"
}
]
}
},
"Data prefix": {
"description": "Data prefix",
"value": {
"name": "Demo-Data-Prefix-List",
"description": "Desc Not Required",
"type": "dataprefix",
"entries": [
{
"ipPrefix": "10.1.0.0/16"
},
{
"ipPrefix": "10.2.0.0/16"
}
]
}
},
"Policer": {
"description": "Policer",
"value": {
"name": "Demo-Policer-list",
"description": "Desc Not Required",
"type": "policer",
"entries": [
{
"burst": "16000",
"exceed": "drop",
"rate": "10000"
}
]
}
},
"Prefix": {
"description": "Prefix",
"value": {
"name": "Demo-Prefix-list",
"description": "Desc Not Required",
"type": "prefix",
"entries": [
{
"ipPrefix": "10.0.0.0/12",
"le": "32"
}
]
}
},
"Site": {
"description": "Site",
"value": {
"name": "Demo-Site-List",
"description": "Desc Not Required",
"type": "site",
"listId": null,
"entries": [
{
"siteId": "100"
},
{
"siteId": "200"
},
{
"siteId": "300-500"
}
]
}
},
"Class": {
"description": "Class",
"value": {
"name": "Demo-Class-Map",
"description": "Desc Not Required",
"type": "class",
"entries": [
{
"queue": "4"
}
]
}
},
"App probe": {
"description": "App probe",
"value": {
"name": "Demo-Probe-Class",
"type": "appProbe",
"entries": [
{
"map": [
{
"color": "biz-internet",
"dscp": 46
},
{
"color": "public-internet",
"dscp": 20
}
],
"forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70"
}
]
}
},
"SLA": {
"description": "SLA",
"value": {
"name": "Demo-SLA-Class",
"description": "Desc Not Required",
"type": "sla",
"entries": [
{
"latency": "100",
"loss": "10",
"jitter": "10",
"appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d"
}
]
}
},
"TLOC": {
"description": "TLOC",
"value": {
"name": "Demo-TLOC-List",
"description": "Desc Not Required",
"type": "tloc",
"entries": [
{
"tloc": "10.1.1.1",
"color": "biz-internet",
"encap": "ipsec",
"preference": "10"
},
{
"tloc": "10.2.2.2",
"color": "biz-internet",
"encap": "ipsec",
"preference": "20"
}
]
}
},
"VPN": {
"description": "VPN",
"value": {
"name": "Demo-VPN-List",
"description": "Desc Not Required",
"type": "vpn",
"listId": null,
"entries": [
{
"vpn": "100"
},
{
"vpn": "200"
},
{
"vpn": "300-500"
}
]
}
},
"AS path": {
"description": "AS path",
"value": {
"name": "Demo-AS-Path-List",
"description": "Desc Not Required",
"type": "aspath",
"listId": null,
"entries": [
{
"asPath": "100"
},
{
"asPath": "200"
},
{
"asPath": "65002"
}
]
}
},
"Community": {
"description": "Community",
"value": {
"name": "Demo-Community-List",
"description": "Desc Not Required",
"type": "community",
"listId": null,
"entries": [
{
"community": "1000:10000"
}
]
}
},
"Ext community": {
"description": "Ext community",
"value": {
"name": "Demo-Extended-Community-List",
"description": "Desc Not Required",
"type": "extcommunity",
"listId": null,
"entries": [
{
"community": "rt 100:10"
}
]
}
},
"Mirror": {
"description": "Mirror",
"value": {
"name": "Demo-Mirror-List",
"description": "Desc Not Required",
"type": "mirror",
"entries": [
{
"remoteDest": "10.1.1.1",
"source": "20.1.1.1"
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Task Id": {
"description": "Task Id",
"value": {
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6"
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"delete": {
"tags": [
"Configuration - Policy VPN List Builder"
],
"description": "Delete policy lists with specific info tag",
"operationId": "deletePolicyListsWithInfoTag_ConfigurationPolicyVpnListBuilder_2506",
"parameters": [
{
"name": "infoTag",
"in": "query",
"description": "InfoTag",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/list/vpn/filtered": {
"get": {
"tags": [
"Configuration - Policy VPN List Builder"
],
"description": "Get policy lists with specific info tag",
"operationId": "getPolicyListsWithInfoTag_ConfigurationPolicyVpnListBuilder_3403",
"parameters": [
{
"name": "infoTag",
"in": "query",
"description": "InfoTag",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/list/vpn/preview": {
"post": {
"tags": [
"Configuration - Policy VPN List Builder"
],
"description": "Preview a policy list based on the policy list type",
"operationId": "previewPolicyList_ConfigurationPolicyVpnListBuilder_3304",
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy list": {
"description": "Policy list"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Preview policy list": {
"description": "Preview policy list",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/list/vpn/preview/{id}": {
"get": {
"tags": [
"Configuration - Policy VPN List Builder"
],
"description": "Preview a specific policy list entry based on id provided",
"operationId": "previewPolicyListById_ConfigurationPolicyVpnListBuilder_3803",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Preview policy list": {
"description": "Preview policy list",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/list/vpn/{id}": {
"get": {
"tags": [
"Configuration - Policy VPN List Builder"
],
"description": "Get a specific policy list based on the id",
"operationId": "getListsById_ConfigurationPolicyVpnListBuilder_3003",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy": {
"description": "Policy",
"value": {
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6",
"name": "Community",
"type": "community",
"description": "Desc Not Required",
"entries": [
{
"community": "1000:5000"
}
],
"lastUpdated": 1590184928436,
"owner": "admin",
"readOnly": false,
"version": "0",
"infoTag": "",
"referenceCount": 0,
"references": [],
"isActivatedByVsmart": false
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
},
"put": {
"tags": [
"Configuration - Policy VPN List Builder"
],
"description": "Edit policy list entries for a specific type of policy list",
"operationId": "editPolicyList_ConfigurationPolicyVpnListBuilder_3003",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": {
"name": "Community",
"description": "Desc Not Required",
"type": "community",
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6",
"entries": [
{
"community": "1000:8000"
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy": {
"description": "Policy",
"value": {
"masterTemplatesAffected": []
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"delete": {
"tags": [
"Configuration - Policy VPN List Builder"
],
"description": "Delete policy list entry for a specific type of policy list",
"operationId": "deletePolicyList_ConfigurationPolicyVpnListBuilder_3006",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/list/webex": {
"post": {
"tags": [
"Configuration - Policy List Builder"
],
"description": "TEMP-Create Webex policy lists",
"operationId": "createWebexPrefixLists_ConfigurationPolicyListBuilder_2704",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"deprecated": true
}
},
"/template/policy/list/webex/update": {
"post": {
"tags": [
"Configuration - Policy List Builder"
],
"description": "TEMP-Update Webex policy lists from Webex config",
"operationId": "createWebexPrefixLists_ConfigurationPolicyListBuilder_3404",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"deprecated": true
}
},
"/template/policy/list/zone": {
"post": {
"tags": [
"Configuration - Policy Zone List Builder"
],
"description": "Create policy list",
"operationId": "createPolicyList_ConfigurationPolicyZoneListBuilder_2604",
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Zone list": {
"description": "Zone list",
"value": {
"name": "Demo-Zone",
"description": "Desc Not Required",
"type": "zone",
"entries": [
{
"vpn": "10"
}
]
}
},
"IPS list": {
"description": "IPS list",
"value": {
"name": "Demo-IPS-list",
"description": "Desc Not Required",
"type": "ipssignature",
"entries": [
{
"generatorId": "1111",
"signatureId": "4444"
}
]
}
},
"URL white list": {
"description": "URL white list",
"value": {
"name": "Demo-Whitelist",
"description": "Desc Not Required",
"type": "urlwhitelist",
"entries": [
{
"pattern": "https://www.youtube.com"
}
]
}
},
"URL black list": {
"description": "URL black list",
"value": {
"name": "Demo-Black-list",
"description": "Desc Not Required",
"type": "urlblacklist",
"entries": [
{
"pattern": "www.facebook.com"
}
]
}
},
"TG API key list": {
"description": "TG API key list",
"value": {
"name": "threatGridApiKeyList",
"description": "",
"type": "threatGridApiKey",
"entries": [
{
"region": "nam",
"apikey": "1234567"
},
{
"region": "eur",
"apikey": "1234567"
}
]
}
},
"Local domain list": {
"description": "Local domain list",
"value": {
"name": "Demo-Domain-Name-List",
"description": "Desc Not Required",
"type": "localdomain",
"entries": [
{
"nameServer": "cisco.com"
}
]
}
},
"Umbrella data list": {
"description": "Umbrella data list",
"value": {
"name": "umbrellaTokenList",
"description": "",
"type": "umbrellaData",
"entries": [
{
"apiKey": "abcd",
"secret": "12345",
"umbOrgId": "23405",
"token": "abcedabcedabcedabcedabcedabcedabcedabced"
}
]
}
},
"App family": {
"description": "App family",
"value": {
"name": "Demo-App-List",
"description": "Desc Not Required",
"type": "app",
"entries": [
{
"appFamily": "web"
},
{
"appFamily": "audio-video"
}
]
}
},
"App list": {
"description": "App list",
"value": {
"name": "Demo-App-List",
"description": "Desc Not Required",
"type": "app",
"entries": [
{
"app": "facebook"
},
{
"app": "netshow"
}
]
}
},
"Color list": {
"description": "Color list",
"value": {
"name": "Demo-Color-List",
"description": "Desc Not Required",
"type": "color",
"entries": [
{
"color": "biz-internet"
},
{
"color": "public-internet"
}
]
}
},
"Data prefix": {
"description": "Data prefix",
"value": {
"name": "Demo-Data-Prefix-List",
"description": "Desc Not Required",
"type": "dataprefix",
"entries": [
{
"ipPrefix": "10.1.0.0/16"
},
{
"ipPrefix": "10.2.0.0/16"
}
]
}
},
"Policer": {
"description": "Policer",
"value": {
"name": "Demo-Policer-list",
"description": "Desc Not Required",
"type": "policer",
"entries": [
{
"burst": "16000",
"exceed": "drop",
"rate": "10000"
}
]
}
},
"Prefix": {
"description": "Prefix",
"value": {
"name": "Demo-Prefix-list",
"description": "Desc Not Required",
"type": "prefix",
"entries": [
{
"ipPrefix": "10.0.0.0/12",
"le": "32"
}
]
}
},
"Site": {
"description": "Site",
"value": {
"name": "Demo-Site-List",
"description": "Desc Not Required",
"type": "site",
"listId": null,
"entries": [
{
"siteId": "100"
},
{
"siteId": "200"
},
{
"siteId": "300-500"
}
]
}
},
"Class": {
"description": "Class",
"value": {
"name": "Demo-Class-Map",
"description": "Desc Not Required",
"type": "class",
"entries": [
{
"queue": "4"
}
]
}
},
"App probe": {
"description": "App probe",
"value": {
"name": "Demo-Probe-Class",
"type": "appProbe",
"entries": [
{
"map": [
{
"color": "biz-internet",
"dscp": 46
},
{
"color": "public-internet",
"dscp": 20
}
],
"forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70"
}
]
}
},
"SLA": {
"description": "SLA",
"value": {
"name": "Demo-SLA-Class",
"description": "Desc Not Required",
"type": "sla",
"entries": [
{
"latency": "100",
"loss": "10",
"jitter": "10",
"appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d"
}
]
}
},
"TLOC": {
"description": "TLOC",
"value": {
"name": "Demo-TLOC-List",
"description": "Desc Not Required",
"type": "tloc",
"entries": [
{
"tloc": "10.1.1.1",
"color": "biz-internet",
"encap": "ipsec",
"preference": "10"
},
{
"tloc": "10.2.2.2",
"color": "biz-internet",
"encap": "ipsec",
"preference": "20"
}
]
}
},
"VPN": {
"description": "VPN",
"value": {
"name": "Demo-VPN-List",
"description": "Desc Not Required",
"type": "vpn",
"listId": null,
"entries": [
{
"vpn": "100"
},
{
"vpn": "200"
},
{
"vpn": "300-500"
}
]
}
},
"AS path": {
"description": "AS path",
"value": {
"name": "Demo-AS-Path-List",
"description": "Desc Not Required",
"type": "aspath",
"listId": null,
"entries": [
{
"asPath": "100"
},
{
"asPath": "200"
},
{
"asPath": "65002"
}
]
}
},
"Community": {
"description": "Community",
"value": {
"name": "Demo-Community-List",
"description": "Desc Not Required",
"type": "community",
"listId": null,
"entries": [
{
"community": "1000:10000"
}
]
}
},
"Ext community": {
"description": "Ext community",
"value": {
"name": "Demo-Extended-Community-List",
"description": "Desc Not Required",
"type": "extcommunity",
"listId": null,
"entries": [
{
"community": "rt 100:10"
}
]
}
},
"Mirror": {
"description": "Mirror",
"value": {
"name": "Demo-Mirror-List",
"description": "Desc Not Required",
"type": "mirror",
"entries": [
{
"remoteDest": "10.1.1.1",
"source": "20.1.1.1"
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Task Id": {
"description": "Task Id",
"value": {
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6"
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"get": {
"tags": [
"Configuration - Policy Zone List Builder"
],
"description": "Get policy lists",
"operationId": "getPolicyLists_ConfigurationPolicyZoneListBuilder_2603",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"App Policy": {
"description": "App Policy",
"value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"
},
"Prefix List": {
"description": "Prefix List",
"value": {
"data": [
{
"listId": "8bc43c09-f72c-40b8-aa90-608c7005e607",
"name": "Example",
"type": "prefix",
"description": "Desc Not Required",
"entries": [
{
"ipPrefix": "10.0.0.0/24"
}
],
"lastUpdated": 1588178457305,
"owner": "admin",
"readOnly": false,
"version": "0",
"infoTag": "",
"referenceCount": 0,
"references": [],
"isActivatedByVsmart": false
}
]
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
},
"delete": {
"tags": [
"Configuration - Policy Zone List Builder"
],
"description": "Delete policy lists with specific info tag",
"operationId": "deletePolicyListsWithInfoTag_ConfigurationPolicyZoneListBuilder_2606",
"parameters": [
{
"name": "infoTag",
"in": "query",
"description": "InfoTag",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/list/zone/filtered": {
"get": {
"tags": [
"Configuration - Policy Zone List Builder"
],
"description": "Get policy lists with specific info tag",
"operationId": "getPolicyListsWithInfoTag_ConfigurationPolicyZoneListBuilder_3503",
"parameters": [
{
"name": "infoTag",
"in": "query",
"description": "InfoTag",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/list/zone/preview": {
"post": {
"tags": [
"Configuration - Policy Zone List Builder"
],
"description": "Preview a policy list based on the policy list type",
"operationId": "previewPolicyList_ConfigurationPolicyZoneListBuilder_3404",
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy list": {
"description": "Policy list"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Preview policy list": {
"description": "Preview policy list",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/list/zone/preview/{id}": {
"get": {
"tags": [
"Configuration - Policy Zone List Builder"
],
"description": "Preview a specific policy list entry based on id provided",
"operationId": "previewPolicyListById_ConfigurationPolicyZoneListBuilder_3903",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Preview policy list": {
"description": "Preview policy list",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
}
},
"/template/policy/list/zone/{id}": {
"get": {
"tags": [
"Configuration - Policy Zone List Builder"
],
"description": "Get a specific policy list based on the id",
"operationId": "getListsById_ConfigurationPolicyZoneListBuilder_3103",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy": {
"description": "Policy",
"value": {
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6",
"name": "Community",
"type": "community",
"description": "Desc Not Required",
"entries": [
{
"community": "1000:5000"
}
],
"lastUpdated": 1590184928436,
"owner": "admin",
"readOnly": false,
"version": "0",
"infoTag": "",
"referenceCount": 0,
"references": [],
"isActivatedByVsmart": false
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"
},
"delete": {
"tags": [
"Configuration - Policy Zone List Builder"
],
"description": "Delete policy list entry for a specific type of policy list",
"operationId": "deletePolicyList_ConfigurationPolicyZoneListBuilder_3106",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
},
"put": {
"tags": [
"Configuration - Policy Zone List Builder"
],
"description": "Edit policy list entries for a specific type of policy list",
"operationId": "editPolicyList_ConfigurationPolicyZoneListBuilder_3103",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy list",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy list": {
"description": "Policy list",
"value": {
"name": "Community",
"description": "Desc Not Required",
"type": "community",
"listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6",
"entries": [
{
"community": "1000:8000"
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy": {
"description": "Policy",
"value": {
"masterTemplatesAffected": []
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Policy Configuration-write"
}
},
"/template/policy/security": {
"get": {
"tags": [
"Configuration - Security Template Policy"
],
"description": "Generate template list",
"operationId": "generateSecurityTemplateList",
"parameters": [
{
"name": "mode",
"in": "query",
"description": "Mode",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Template list": {
"description": "Template list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
},
"post": {
"tags": [
"Configuration - Security Template Policy"
],
"description": "Create Template",
"operationId": "createSecurityTemplate",
"requestBody": {
"description": "Policy template",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy template": {
"description": "Policy template",
"value": {
"policyDescription": "Security Policy",
"policyType": "feature",
"policyName": "securitypolicy",
"policyUseCase": "guestAccess",
"policyDefinition": {
"assembly": [
{
"definitionId": "840f9d3e-b31d-48b6-8365-79b75ba206a9",
"type": "urlFiltering"
}
],
"settings": {
"logging": [
{
"vpn": "512",
"serverIP": "10.0.0.1"
}
],
"failureMode": "open"
}
},
"isPolicyActivated": false
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/security/definition/{policyId}": {
"get": {
"tags": [
"Configuration - Security Template Policy"
],
"description": "Get Template",
"operationId": "getSecurityTemplate",
"parameters": [
{
"name": "policyId",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy template": {
"description": "Policy template",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/security/devices": {
"get": {
"tags": [
"Configuration - Security Template Policy"
],
"description": "Get device list",
"operationId": "getSecurityPolicyDeviceList_ConfigurationSecurityTemplatePolicy_3303",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Device list": {
"description": "Device list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/security/devices/{policyId}": {
"get": {
"tags": [
"Configuration - Security Template Policy"
],
"description": "Get device list by Id",
"operationId": "getDeviceListById",
"parameters": [
{
"name": "policyId",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Device list": {
"description": "Device list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/security/staging/{policyId}": {
"put": {
"tags": [
"Configuration - Security Template Policy"
],
"description": "Edit Template",
"operationId": "editTemplateWithLenientLock",
"parameters": [
{
"name": "policyId",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "Policy template",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy template": {
"description": "Policy template"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Template": {
"description": "Template",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/security/summary": {
"get": {
"tags": [
"Configuration - Security Template Policy"
],
"description": "Generate security policy summary",
"operationId": "generateSecurityPolicySummary",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Security policy summary": {
"description": "Security policy summary",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/security/{deviceModel}": {
"get": {
"tags": [
"Configuration - Security Template Policy"
],
"description": "Get templates that map a device model",
"operationId": "getSecurityTemplatesForDevice",
"parameters": [
{
"name": "deviceModel",
"in": "path",
"description": "Device model",
"required": true,
"schema": {
"type": "object",
"properties": {
"deviceModel": {
"type": "string"
}
},
"description": "This is the valid DeviceModel ",
"$$ref": "#/components/schemas/DeviceModel"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Template": {
"description": "Template",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/security/{policyId}": {
"put": {
"tags": [
"Configuration - Security Template Policy"
],
"description": "Edit Template",
"operationId": "editSecurityTemplate",
"parameters": [
{
"name": "policyId",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy template",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy template": {
"description": "Policy template",
"value": {
"policyDescription": "Security Policy",
"policyType": "feature",
"policyName": "securitypolicy",
"policyUseCase": "guestAccess",
"policyDefinition": {
"assembly": [
{
"definitionId": "f41167bd-6948-42ff-bc06-94f450e43999",
"type": "zoneBasedFW"
},
{
"definitionId": "840f9d3e-b31d-48b6-8365-79b75ba206a9",
"type": "urlFiltering"
}
],
"settings": {
"zoneToNozoneInternet": "deny",
"logging": [
{
"vpn": "512",
"serverIP": "10.0.0.1"
}
],
"failureMode": "open"
}
},
"isPolicyActivated": false
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Template": {
"description": "Template",
"value": {
"masterTemplatesAffected": []
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
},
"delete": {
"tags": [
"Configuration - Security Template Policy"
],
"description": "Delete Template",
"operationId": "deleteSecurityTemplate",
"parameters": [
{
"name": "policyId",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/vedge": {
"post": {
"tags": [
"Configuration - vEdge Template Policy"
],
"description": "Create template",
"operationId": "createVEdgeTemplate",
"requestBody": {
"description": "Template policy",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Template policy": {
"description": "Template policy",
"value": {
"policyDescription": "Demo",
"policyType": "feature",
"policyName": "demo-policy",
"policyDefinition": {
"assembly": [
{
"definitionId": "b628d664-d4ec-428f-831c-aff2b688c54c",
"type": "vedgeRoute"
},
{
"definitionId": "e4b25c74-f594-49db-b78b-61bbb41464ba",
"type": "acl"
}
],
"settings": {
"appVisibility": true,
"logFrequency": 60
}
},
"isPolicyActivated": false
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy Id": {
"description": "Policy Id",
"value": {
"policyId": "f8efb9ed-7524-41ff-aa12-1b6635087ce1"
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
},
"get": {
"tags": [
"Configuration - vEdge Template Policy"
],
"description": "Get policy details",
"operationId": "generatePolicyTemplateList",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy template": {
"description": "Policy template",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/vedge/definition/{policyId}": {
"get": {
"tags": [
"Configuration - vEdge Template Policy"
],
"description": "Get template",
"operationId": "getVEdgeTemplate",
"parameters": [
{
"name": "policyId",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy template": {
"description": "Policy template",
"value": {
"data": [
{
"mastersAttached": 0,
"lastUpdatedBy": "admin",
"policyName": "AppVisibility",
"policyDefinition": "policy\n app-visibility\n flow-visibility\n!",
"policyDefinitionEdit": "policy\n app-visibility\n flow-visibility\n!",
"createdOn": 1505676829880,
"policyDescription": "Application Visibility Only",
"@rid": 481,
"policyId": "0b860b3a-9446-4c19-86f4-49699f4ed2c7",
"createdBy": "admin",
"devicesAttached": 0,
"lastUpdatedOn": 1505676829880,
"policyType": "cli"
},
{
"mastersAttached": 1,
"lastUpdatedBy": "admin",
"policyName": "BaselinePolicy",
"policyDefinition": {
"assembly": [
{
"definitionId": "48a7a27a-54e9-443b-a254-cc87ef13f3f5",
"type": "qosMap"
},
{
"definitionId": "dfe3891d-ee1f-44e1-ba84-caa2e5e9f128",
"type": "acl"
},
{
"definitionId": "7bdedee2-f87d-4f26-855b-4338b14716a1",
"type": "acl"
},
{
"definitionId": "e4b25c74-f594-49db-b78b-61bbb41464ba",
"type": "acl"
},
{
"definitionId": "b628d664-d4ec-428f-831c-aff2b688c54c",
"type": "vedgeRoute"
}
],
"settings": {
"appVisibility": true,
"cloudQos": true,
"cloudQosServiceSide": true,
"flowVisibility": true,
"logFrequency": 10
}
},
"policyDefinitionEdit": {
"assembly": [
{
"definitionId": "48a7a27a-54e9-443b-a254-cc87ef13f3f5",
"type": "qosMap"
},
{
"definitionId": "dfe3891d-ee1f-44e1-ba84-caa2e5e9f128",
"type": "acl"
},
{
"definitionId": "7bdedee2-f87d-4f26-855b-4338b14716a1",
"type": "acl"
},
{
"definitionId": "e4b25c74-f594-49db-b78b-61bbb41464ba",
"type": "acl"
},
{
"definitionId": "b628d664-d4ec-428f-831c-aff2b688c54c",
"type": "vedgeRoute"
}
],
"settings": {
"appVisibility": true,
"cloudQos": true,
"cloudQosServiceSide": true,
"flowVisibility": true,
"logFrequency": 10
}
},
"createdOn": 1548341101877,
"policyDescription": "Baseline dCloud Policy for all WAN Edge",
"@rid": 2095,
"policyId": "f73b285f-72eb-4f6d-865f-eae0e453bd8e",
"createdBy": "admin",
"devicesAttached": 2,
"policyType": "feature",
"lastUpdatedOn": 1548341101877
}
]
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/vedge/devices": {
"get": {
"tags": [
"Configuration - vEdge Template Policy"
],
"description": "Get device list",
"operationId": "getVEdgePolicyDeviceList",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Device list": {
"description": "Device list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/vedge/devices/{policyId}": {
"get": {
"tags": [
"Configuration - vEdge Template Policy"
],
"description": "Get device list by policy",
"operationId": "getDeviceListByPolicy",
"parameters": [
{
"name": "policyId",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Device list": {
"description": "Device list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/vedge/{policyId}": {
"put": {
"tags": [
"Configuration - vEdge Template Policy"
],
"description": "Edit template",
"operationId": "editVEdgeTemplate",
"parameters": [
{
"name": "policyId",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Template policy",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Template policy": {
"description": "Template policy",
"value": "{\n \"policyId\":\"8715a21d-9367-47ea-9bc6-e25163ed9513\",\n \"policyState\":\"edit\",\n \"mastersAttached\":2,\n \"lastUpdatedBy\":\"admin\",\n \"policyName\":\"LocalizedPolicyBaseline\",\n \"policyDefinition\": \"\"\n \"policyDefinitionEdit\":\"\"\n \"createdOn\":1548015105326,\n \"policyDescription\":\"Baseline Localized Policiy for dcloud\",\n \"@rid\":483,\n \"createdBy\":\"admin\",\n \"devicesAttached\":2,\n \"policyType\":\"cli\",\n \"lastUpdatedOn\":1548015105326\n}"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Template policy": {
"description": "Template policy",
"value": {
"masterTemplatesAffected": []
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
},
"delete": {
"tags": [
"Configuration - vEdge Template Policy"
],
"description": "Delete template",
"operationId": "deleteVEdgeTemplate",
"parameters": [
{
"name": "policyId",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/vedge/{resourceGroupName}/{policyId}": {
"post": {
"tags": [
"Configuration - vEdge Template Policy"
],
"description": "Change policy resource group",
"operationId": "changePolicyResourceGroup",
"parameters": [
{
"name": "policyId",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "resourceGroupName",
"in": "path",
"description": "Resrouce group name",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/voice": {
"post": {
"tags": [
"Configuration - Voice Template Policy"
],
"description": "Create Template",
"operationId": "createVoiceTemplate",
"requestBody": {
"description": "Policy template",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy template": {
"description": "Policy template",
"value": {
"policyDescription": "SIP dail peers",
"policyType": "feature",
"policyName": "SIPpolicy",
"policyDefinition": {
"assembly": [
{
"definitionId": "5557cab0-b8f7-43d6-97d5-2dc572007aac",
"type": "dialPeer",
"portType": "sipDialPeer"
}
]
}
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy Id": {
"description": "Policy Id",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
},
"get": {
"tags": [
"Configuration - Voice Template Policy"
],
"description": "Generate template list",
"operationId": "generateVoiceTemplateList",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Template list": {
"description": "Template list",
"value": {
"data": [
{
"lastUpdatedBy": "admin",
"mastersAttached": 0,
"policyName": "SIPpolicy",
"virtualApplicationTemplates": [],
"policyDefinition": {
"assembly": [
{
"definitionId": "5557cab0-b8f7-43d6-97d5-2dc572007aac",
"type": "dialPeer",
"portType": "sipDialPeer"
}
]
},
"policyDefinitionEdit": {
"assembly": [
{
"definitionId": "5557cab0-b8f7-43d6-97d5-2dc572007aac",
"type": "dialPeer",
"portType": "sipDialPeer"
}
]
},
"createdOn": 1590272854518,
"policyDescription": "SIP dail peers",
"policyUseCase": "custom",
"@rid": 1124,
"policyId": "87fed5e0-3b95-47a3-9dae-bed8b68562ed",
"createdBy": "admin",
"devicesAttached": 0,
"policyType": "feature",
"lastUpdatedOn": 1590272854518,
"supportedDevices": [
"vedge-C8300-2N2S-4T2X",
"vedge-C8200-1N-4T",
"vedge-C8200L-1N-4T",
"vedge-C8300-2N2S-6T",
"vedge-C8300-1N1S-4T2X",
"vedge-C8300-1N1S-6T",
"vedge-ISR-4451-X",
"vedge-ISR-4351",
"vedge-ISR-4461",
"vedge-ISR-4431",
"vedge-ISR-4321",
"vedge-ISR-4331"
]
}
]
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/voice/definition/{policyId}": {
"get": {
"tags": [
"Configuration - Voice Template Policy"
],
"description": "Get templates by policy Id",
"operationId": "getTemplateById",
"parameters": [
{
"name": "policyId",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy template": {
"description": "Policy template",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/voice/devices": {
"get": {
"tags": [
"Configuration - Voice Template Policy"
],
"description": "Get all device list",
"operationId": "getVoicePolicyDeviceList",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Device list": {
"description": "Device list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/voice/devices/{policyId}": {
"get": {
"tags": [
"Configuration - Voice Template Policy"
],
"description": "Get device list by policy Id",
"operationId": "getDeviceListByPolicyId",
"parameters": [
{
"name": "policyId",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Device list": {
"description": "Device list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/voice/summary": {
"get": {
"tags": [
"Configuration - Voice Template Policy"
],
"description": "Get templates that map a device model",
"operationId": "generateVoicePolicySummary",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Policy summary": {
"description": "Policy summary",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/voice/{deviceModel}": {
"get": {
"tags": [
"Configuration - Voice Template Policy"
],
"description": "Get templates that map a device model",
"operationId": "getVoiceTemplatesForDevice",
"parameters": [
{
"name": "deviceModel",
"in": "path",
"description": "Device model",
"required": true,
"schema": {
"type": "object",
"properties": {
"deviceModel": {
"type": "string"
}
},
"description": "This is the valid DeviceModel ",
"$$ref": "#/components/schemas/DeviceModel"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Template list": {
"description": "Template list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/voice/{policyId}": {
"put": {
"tags": [
"Configuration - Voice Template Policy"
],
"description": "Edit Template",
"operationId": "editVoiceTemplate",
"parameters": [
{
"name": "policyId",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Policy template",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy template": {
"description": "Policy template",
"value": {
"policyDescription": "SIP dail peers",
"policyType": "feature",
"policyName": "SIPpolicy",
"policyDefinition": {
"assembly": [
{
"definitionId": "5557cab0-b8f7-43d6-97d5-2dc572007aac",
"type": "dialPeer",
"portType": "sipDialPeer"
}
]
}
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy template": {
"description": "Policy template",
"value": {
"masterTemplatesAffected": []
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
},
"delete": {
"tags": [
"Configuration - Voice Template Policy"
],
"description": "Delete Template",
"operationId": "deleteVoiceTemplate",
"parameters": [
{
"name": "policyId",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/vsmart": {
"get": {
"tags": [
"Configuration - vSmart Template Policy"
],
"description": "Get all template vsmart policy list",
"operationId": "generateVSmartPolicyTemplateList",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Template vSmart policy list": {
"description": "Template vSmart policy list",
"value": {
"data": [
{
"policyVersion": "12282017T235740495",
"lastUpdatedBy": "admin",
"policyName": "StrictHub-n-Spoke",
"policyDefinition": {
"assembly": [
{
"definitionId": "207bd271-5008-4271-bd51-a58b14a8dd31",
"type": "vpnMembershipGroup"
},
{
"definitionId": "4ddd51c0-d8a4-4dff-8874-09c24742b518",
"type": "control",
"entries": [
{
"direction": "out",
"siteLists": [
"5d4384b7-b2ab-4d05-9e93-76851304092d"
]
}
]
},
{
"definitionId": "c41897b6-b17c-4a1c-b6d9-403af38ef418",
"type": "data",
"entries": [
{
"direction": "service",
"siteLists": [
"5d4384b7-b2ab-4d05-9e93-76851304092d"
],
"vpnLists": [
"f4955f7d-f7b1-4fb5-b0d5-365c40829c51"
]
}
]
}
]
},
"createdOn": 1514732091489,
"isPolicyActivated": false,
"policyDescription": "BFD/IPSec based Hub-n-Spoke Topology",
"@rid": 6,
"policyId": "a8205140-92d9-4688-a127-c70d5f1b93a5",
"createdBy": "admin",
"policyType": "feature",
"lastUpdatedOn": 1514732091489
},
{
"policyVersion": "12302017T143348286",
"lastUpdatedBy": "admin",
"policyName": "MultiTopologyPolicy",
"policyDefinition": {
"assembly": [
{
"definitionId": "a8390569-3aef-4f99-9e6f-678c21bf9dac",
"type": "vpnMembershipGroup"
},
{
"definitionId": "c41897b6-b17c-4a1c-b6d9-403af38ef418",
"type": "data",
"entries": [
{
"direction": "service",
"siteLists": [
"5d4384b7-b2ab-4d05-9e93-76851304092d"
],
"vpnLists": [
"f4955f7d-f7b1-4fb5-b0d5-365c40829c51"
]
}
]
},
{
"definitionId": "ce4afddc-3674-4d74-86f2-1005b15e22dc",
"type": "control",
"entries": [
{
"direction": "out",
"siteLists": [
"5d4384b7-b2ab-4d05-9e93-76851304092d"
]
}
]
}
]
},
"createdOn": 1514732164516,
"isPolicyActivated": false,
"policyDescription": "Multi-Topology Policy",
"@rid": 7,
"policyId": "45f0b251-bce6-4b6b-bb8c-de7dbf13ea0f",
"createdBy": "admin",
"policyType": "feature",
"lastUpdatedOn": 1514732164516
},
{
"policyVersion": "12312017T143840434",
"lastUpdatedBy": "admin",
"policyName": "MultiTopologyPlusFWInsertion",
"policyDefinition": {
"assembly": [
{
"definitionId": "1ded189f-4c6b-41cf-a686-655120fdf179",
"type": "vpnMembershipGroup"
},
{
"definitionId": "73096eaf-8bfe-43bd-a67a-9fcaaa2f8c38",
"type": "control",
"entries": [
{
"direction": "out",
"siteLists": [
"5d4384b7-b2ab-4d05-9e93-76851304092d"
]
}
]
},
{
"definitionId": "c41897b6-b17c-4a1c-b6d9-403af38ef418",
"type": "data",
"entries": [
{
"direction": "service",
"siteLists": [
"5d4384b7-b2ab-4d05-9e93-76851304092d"
],
"vpnLists": [
"f4955f7d-f7b1-4fb5-b0d5-365c40829c51"
]
}
]
}
]
},
"createdOn": 1514732296993,
"isPolicyActivated": false,
"policyDescription": "Adding FW for inter-branch communication in VPN 10",
"@rid": 8,
"policyId": "b33477d1-1ebc-4080-ba44-b89dbf14fef7",
"createdBy": "admin",
"policyType": "feature",
"lastUpdatedOn": 1514732296993
},
{
"policyVersion": "12312017T153128841",
"lastUpdatedBy": "admin",
"policyName": "MultiTopologyPlusACL",
"policyDefinition": {
"assembly": [
{
"definitionId": "968d1ce3-7ff7-4f97-8b69-01e4e06ecad2",
"type": "data",
"entries": [
{
"direction": "service",
"siteLists": [
"5d4384b7-b2ab-4d05-9e93-76851304092d"
],
"vpnLists": [
"19f53630-0ce6-4f6b-8e4f-6a527cd15ca4"
]
}
]
},
{
"definitionId": "ce4afddc-3674-4d74-86f2-1005b15e22dc",
"type": "control",
"entries": [
{
"direction": "out",
"siteLists": [
"5d4384b7-b2ab-4d05-9e93-76851304092d"
]
}
]
},
{
"definitionId": "c41897b6-b17c-4a1c-b6d9-403af38ef418",
"type": "data",
"entries": [
{
"direction": "service",
"siteLists": [
"5d4384b7-b2ab-4d05-9e93-76851304092d"
],
"vpnLists": [
"f4955f7d-f7b1-4fb5-b0d5-365c40829c51"
]
}
]
},
{
"definitionId": "a8390569-3aef-4f99-9e6f-678c21bf9dac",
"type": "vpnMembershipGroup"
}
]
},
"createdOn": 1514734542150,
"isPolicyActivated": false,
"policyDescription": "Application/ACL Policy for inter-branch traffic in VPN 20",
"@rid": 9,
"policyId": "7f156d32-537d-493f-9a7d-53d9e1f05a19",
"createdBy": "admin",
"policyType": "feature",
"lastUpdatedOn": 1514734542150
},
{
"policyVersion": "04092018T121824907",
"lastUpdatedBy": "admin",
"policyName": "MultiTopologyPlusAppRoute",
"policyDefinition": {
"assembly": [
{
"definitionId": "433db0fb-c89a-4642-a498-e3b9a257faef",
"type": "appRoute",
"entries": [
{
"siteLists": [
"5d4384b7-b2ab-4d05-9e93-76851304092d"
],
"vpnLists": [
"67c9a7e1-e1b2-4a31-bd7c-7d0bbf9b7bbb"
]
},
{
"siteLists": [
"1baf2339-97c0-43fb-98d2-285428a61820"
],
"vpnLists": [
"67c9a7e1-e1b2-4a31-bd7c-7d0bbf9b7bbb"
]
}
]
},
{
"definitionId": "ce4afddc-3674-4d74-86f2-1005b15e22dc",
"type": "control",
"entries": [
{
"direction": "out",
"siteLists": [
"5d4384b7-b2ab-4d05-9e93-76851304092d"
]
}
]
},
{
"definitionId": "c41897b6-b17c-4a1c-b6d9-403af38ef418",
"type": "data",
"entries": [
{
"direction": "service",
"siteLists": [
"5d4384b7-b2ab-4d05-9e93-76851304092d"
],
"vpnLists": [
"f4955f7d-f7b1-4fb5-b0d5-365c40829c51"
]
}
]
},
{
"definitionId": "a8390569-3aef-4f99-9e6f-678c21bf9dac",
"type": "vpnMembershipGroup"
}
]
},
"createdOn": 1514736045181,
"isPolicyActivated": false,
"policyDescription": "App Aware Routing Policy based on SLA",
"@rid": 10,
"policyId": "12df3ed9-6b1f-4b0a-91a2-377cefb8039f",
"createdBy": "admin",
"policyType": "feature",
"lastUpdatedOn": 1514736045181
},
{
"policyVersion": "06212018T190131728",
"lastUpdatedBy": "admin",
"policyName": "cflowd_policy",
"policyDefinition": "policy\ndata-policy cflowd-policy\n vpn-list vpn_10-20\n default-action accept\n !\n!\ncflowd-template lab-cflowd-template\n flow-inactive-timeout 10\n\n flow-active-timeout 60\n\n template-refresh 600\n collector vpn 10 address 198.18.133.34 port 2055 transport transport_udp\n!\nlists\n vpn-list vpn_10-20\n vpn 10-20\n !\n site-list cflowd-sites\n site-id 100-400\n !\n \n apply-policy\nsite-list cflowd-sites\n data-policy cflowd-policy all\n cflowd-template lab-cflowd-template",
"createdOn": 1530540307108,
"isPolicyActivated": false,
"policyDescription": "cflowd",
"@rid": 12,
"policyId": "1c865c35-05ac-43a7-a6ee-6328138cd1c4",
"createdBy": "admin",
"policyType": "cli",
"lastUpdatedOn": 1530540307108
},
{
"policyVersion": "02242019T10524417",
"lastUpdatedBy": "admin",
"policyName": "Hub-Spoke-Policy-PCI",
"policyDefinition": {
"assembly": [
{
"definitionId": "605fabbd-4c99-4be4-8842-aebb256f7010",
"type": "hubAndSpoke"
},
{
"definitionId": "c41897b6-b17c-4a1c-b6d9-403af38ef418",
"type": "data",
"entries": [
{
"direction": "service",
"siteLists": [
"5d4384b7-b2ab-4d05-9e93-76851304092d"
],
"vpnLists": [
"f4955f7d-f7b1-4fb5-b0d5-365c40829c51"
]
}
]
},
{
"definitionId": "207bd271-5008-4271-bd51-a58b14a8dd31",
"type": "vpnMembershipGroup"
}
]
},
"createdOn": 1551005623067,
"isPolicyActivated": false,
"policyDescription": "Enforce PCI VPN to be Hub and Spoke per corporate requirements",
"@rid": 1365,
"policyId": "67b2d453-671f-4eaf-b79a-d1c4c0069f1a",
"createdBy": "admin",
"policyType": "feature",
"lastUpdatedOn": 1551005623067
}
]
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
},
"post": {
"tags": [
"Configuration - vSmart Template Policy"
],
"description": "Create template for given policy",
"operationId": "createVSmartTemplate",
"requestBody": {
"description": "Template policy",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Template policy": {
"description": "Template policy",
"value": {
"policyDescription": "demoVPN",
"policyType": "feature",
"policyName": "demoVPN",
"policyDefinition": {
"assembly": [
{
"definitionId": "605fabbd-4c99-4be4-8842-aebb256f7010",
"type": "hubAndSpoke"
}
]
},
"isPolicyActivated": false
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Policy Id": {
"description": "Policy Id",
"value": {
"policyId": "05917007-14e4-42b0-9575-3d3d11f8a371"
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/vsmart/activate/central/{policyId}": {
"post": {
"tags": [
"Configuration - vSmart Template Policy"
],
"description": "Activate vsmart policy for a given policy id",
"operationId": "activatePolicyForCloudServices",
"parameters": [
{
"name": "policyId",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Template policy",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Template policy": {
"description": "Template policy"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Task Id": {
"description": "Task Id",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/vsmart/activate/{policyId}": {
"post": {
"tags": [
"Configuration - vSmart Template Policy"
],
"description": "Activate vsmart policy for a given policy id",
"operationId": "activatePolicy",
"parameters": [
{
"name": "policyId",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Template policy",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Activate policy": {
"description": "Activate policy",
"value": {
"isEdited": false
}
},
"Deactivate policy": {
"description": "Deactivate policy",
"value": {}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Task Id": {
"description": "Task Id",
"value": {
"id": "vsmart_policy_config-01242017T020647984"
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/vsmart/central/{policyId}": {
"put": {
"tags": [
"Configuration - vSmart Template Policy"
],
"description": "Edit template for given policy id to allow for multiple component edits",
"operationId": "editTemplateWithoutLockChecks",
"parameters": [
{
"name": "policyId",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Template policy",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Template policy": {
"description": "Template policy"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Template policy": {
"description": "Template policy",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/vsmart/connectivity/status": {
"get": {
"tags": [
"Configuration - vSmart Template Policy"
],
"description": "Check VSmart Connectivity Status",
"operationId": "checkVSmartConnectivityStatus",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Connectivity Status": {
"description": "Connectivity Status",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/vsmart/deactivate/{policyId}": {
"post": {
"tags": [
"Configuration - vSmart Template Policy"
],
"description": "Deactivate vsmart policy for a given policy id",
"operationId": "deActivatePolicy",
"parameters": [
{
"name": "policyId",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Task Id": {
"description": "Task Id",
"value": {
"id": "vsmart_policy_config-60851f10-d9f0-4f41-a27e-9eedbd1bae65"
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/vsmart/definition/{policyId}": {
"get": {
"tags": [
"Configuration - vSmart Template Policy"
],
"description": "Get template policy definition by policy id",
"operationId": "getTemplateByPolicyId",
"parameters": [
{
"name": "policyId",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Template vSmart policy": {
"description": "Template vSmart policy",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/vsmart/qosmos_nbar_migration_warning": {
"get": {
"tags": [
"Configuration - vSmart Template Policy"
],
"description": "Qosmos Nbar migration",
"operationId": "QosmosNbarMigrationWarning",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"NBAR list": {
"description": "NBAR list",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/policy/vsmart/{policyId}": {
"put": {
"tags": [
"Configuration - vSmart Template Policy"
],
"description": "Edit template for given policy id",
"operationId": "editVSmartTemplate",
"parameters": [
{
"name": "policyId",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Template policy",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Template policy": {
"description": "Template policy",
"value": {
"policyId": "1c865c35-05ac-43a7-a6ee-6328138cd1c4",
"policyState": "edit",
"policyVersion": "06212018T190131728",
"lastUpdatedBy": "admin",
"policyName": "cflowd_policy",
"policyDefinition": "policy\ndata-policy cflowd-policy\n vpn-list vpn_10-20\n default-action accept\n !\n!\ncflowd-template lab-cflowd-template\n flow-inactive-timeout 10\n\n flow-active-timeout 60\n\n template-refresh 600\n collector vpn 10 address 198.18.133.34 port 2055 transport transport_udp\n!\nlists\n vpn-list vpn_10-20\n vpn 10-20\n !\n site-list cflowd-sites\n site-id 100-400\n !\n \n apply-policy\nsite-list cflowd-sites\n data-policy cflowd-policy all\n cflowd-template lab-cflowd-template",
"createdOn": 1530540307108,
"isPolicyActivated": false,
"policyDescription": "cflowd",
"@rid": 12,
"createdBy": "admin",
"policyType": "cli",
"lastUpdatedOn": 1530540307108,
"isEdited": true
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"Template policy": {
"description": "Template policy",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
},
"delete": {
"tags": [
"Configuration - vSmart Template Policy"
],
"description": "Delete template for a given policy id",
"operationId": "deleteVSmartTemplate",
"parameters": [
{
"name": "policyId",
"in": "path",
"description": "Policy Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/template/security/encryptText/encrypt": {
"post": {
"tags": [
"Configuration - General Template"
],
"description": "Get Type 6 Encryptedd String for a given value",
"operationId": "getEncryptedString",
"requestBody": {
"description": "Type6 Encryption",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Encryption": {
"description": "Encryption",
"value": {
"inputString": "string "
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Encrypted String": {
"description": "Encrypted String",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Template Configuration-read,Template Deploy-read,Template Deploy-write"
}
},
"/topology/device": {
"get": {
"tags": [
"Configuration - Topology"
],
"description": "Create device topology",
"operationId": "createDeviceTopology",
"parameters": [
{
"name": "deviceId",
"in": "query",
"description": "Device Id list",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"deviceIp": {
"type": "string"
}
},
"description": "This is the valid DeviceIP",
"$$ref": "#/components/schemas/DeviceIP"
}
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Topology": {
"description": "Topology",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Device Monitoring-read"
}
},
"/topology/device/site/{siteId}": {
"get": {
"tags": [
"Configuration - Topology"
],
"description": "Get topology for a given site id",
"operationId": "getSiteTopology",
"parameters": [
{
"name": "siteId",
"in": "path",
"description": "Site Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Template Deploy-read,Template Deploy-write,System-read"
}
},
"/topology/monitor/site/{siteId}": {
"get": {
"tags": [
"Configuration - Topology"
],
"description": "Get topology monitor data for a given site id",
"operationId": "getSiteTopologyMonitorData",
"parameters": [
{
"name": "siteId",
"in": "path",
"description": "Site Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Site topology monitor": {
"description": "Site topology monitor",
"value": {
"data": [
{
"device-id": "C8K-9272137f-9fd1-424b-9f0e-8df10fe7dc88",
"device-health": "yellow",
"circuits": [
{
"color": "lte",
"system_ip": "172.16.255.14",
"circuit-health": "yellow",
"tunnels": [
{
"name": "172.16.255.14:lte-172.16.255.15:lte",
"health": "yellow",
"state": "Up",
"vqoe_score": 7
}
]
}
],
"if-speed": [
{
"interface": "GigabitEthernet1",
"count": 34,
"tx_kbps": 0,
"rx_kbps": 0
}
]
}
]
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Device Monitoring-read,Device Monitoring-write"
}
},
"/topology/physical": {
"get": {
"tags": [
"Configuration - Topology"
],
"description": "Create pysical topology",
"operationId": "createPhysicalTopology",
"parameters": [
{
"name": "deviceId",
"in": "query",
"description": "Device Id list",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"deviceIp": {
"type": "string"
}
},
"description": "This is the valid DeviceIP",
"$$ref": "#/components/schemas/DeviceIP"
}
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Topology": {
"description": "Topology",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Device Monitoring-read"
}
}
}
}