{ "openapi": "3.1.0", "info": { "title": "Others", "description": "Other APIs\nInclude APIs that do not belong to other categories", "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": "Administration - Audit Log" }, { "name": "CCI Authorization Service - CCI Registration" }, { "name": "CCI Authorization Service - CCI Token" }, { "name": "Certificate Management - Device" }, { "name": "Certificate Management - vManage" }, { "name": "Client - Security" }, { "name": "Client - UI" }, { "name": "Cloud Sourced Application Compliance" }, { "name": "Cloud Sourced Application Maintenance" }, { "name": "Cluster Management" }, { "name": "Colocation" }, { "name": "Compliance - Device Details" }, { "name": "Configuration - App Registry" }, { "name": "Configuration - Circuits" }, { "name": "Configuration - CloudExpress" }, { "name": "Configuration - Control Component Setting" }, { "name": "Configuration - Dashboard Status" }, { "name": "Configuration - Device Actions" }, { "name": "Configuration - Device Config History" }, { "name": "Configuration - Device Firmware Update" }, { "name": "Configuration - Device Inventory" }, { "name": "Configuration - Device SSL Proxy Certificate Management" }, { "name": "Configuration - Device Software Update" }, { "name": "Configuration - Disaster Recovery" }, { "name": "Configuration - Downloaded Images" }, { "name": "Configuration - Feature Certificate" }, { "name": "Configuration - Maintenance window flag" }, { "name": "Configuration - Multidomain Policy" }, { "name": "Configuration - Network Design" }, { "name": "Configuration - Network Design Templates" }, { "name": "Configuration - Policy App Registry" }, { "name": "Configuration - Secure Internet Gateway" }, { "name": "Configuration - Segments" }, { "name": "Configuration - Software Actions" }, { "name": "Configuration - Topology" }, { "name": "Device - Messaging" }, { "name": "Device - Network" }, { "name": "File based RealTime Data Collection - Device notification - File generation status" }, { "name": "File based RealTime Data Collection - Download Generated File" }, { "name": "File based RealTime Data Collection - Get Data Collection status for Device UUID" }, { "name": "File based RealTime Data Collection - Get Data Collection status for a Request UUID" }, { "name": "File based RealTime Data Collection - Get Supported Commands List for a Device UUID" }, { "name": "File based RealTime Data Collection - Initiate File Generation" }, { "name": "HSEC" }, { "name": "IDP Certificate Management" }, { "name": "IPS Signature - Comment" }, { "name": "IPS Signature - Custom Rule" }, { "name": "IPS Signature - Rule" }, { "name": "IPS Signature - Rule Group" }, { "name": "Jobs - Batch" }, { "name": "Kubernetes Services" }, { "name": "Licensing - Next Generation" }, { "name": "Locale" }, { "name": "MSLA" }, { "name": "Management" }, { "name": "Manual Onboard Device" }, { "name": "MultiCloud - Accounts" }, { "name": "MultiCloud - BranchConnect" }, { "name": "MultiCloud - CloudGateway" }, { "name": "MultiCloud - General" }, { "name": "MultiCloud - Global Settings" }, { "name": "MultiCloud - Mapping" }, { "name": "MultiCloud - Tagging" }, { "name": "Multitenant APIs - Provider" }, { "name": "Network Settings" }, { "name": "Overview - Cellular" }, { "name": "Overview - PPL" }, { "name": "Protocol Pack Compliance" }, { "name": "Protocol Pack Maintenance" }, { "name": "Real Time Monitoring - Raw Socket" }, { "name": "Real-Time Monitoring -LTE450 Cellular" }, { "name": "Resource - Pool" }, { "name": "Rules" }, { "name": "SD AVC - Reverse Migration" }, { "name": "SD AVC Cloud Connector" }, { "name": "SD AVC Domain-based App Rules" }, { "name": "SD AVC IP Address based App Rules" }, { "name": "SD AVC Webex App Rules" }, { "name": "SDAVC SaaS - Publish Tenants" }, { "name": "Scheduled Backup Restore" }, { "name": "Scheduled Report Management" }, { "name": "Secure Device OnBoarding - Provider Credentials" }, { "name": "Secure Device OnBoarding - SDO Token" }, { "name": "Secure Device Onboarding - Communication Plans" }, { "name": "Secure Device Onboarding - Rate Plans" }, { "name": "Setting - Dynamic Scheduler" }, { "name": "Smart License" }, { "name": "SmartLicensing - Licenses" }, { "name": "SmartLicensing - Sync EA Licenses" }, { "name": "SmartLicensing - Sync Licenses" }, { "name": "SmartLicensing - Templates" }, { "name": "System - Cloud Service CDNA" }, { "name": "System - Container" }, { "name": "System - Reverse Proxy" }, { "name": "Tenant Backup Restore" }, { "name": "Tenant Management" }, { "name": "Tenant Migration" }, { "name": "Utility - Configuration DB" }, { "name": "Utility - Logging" }, { "name": "Utility - OLAP DB" }, { "name": "Utility - Security" }, { "name": "Wani Recommendations" }, { "name": "Workflows - Controllers Upgrade" }, { "name": "developers" }, { "name": "url monitor" } ], "paths": { "/app-registry/app": { "get": { "tags": [ "Configuration - App Registry" ], "description": "Get All the App for the given conditions", "operationId": "getAllAppList", "parameters": [ { "name": "filterAttributeType", "in": "query", "schema": { "type": "string" } }, { "name": "filterAttributeValue", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "properties": { "empty": { "type": "boolean" } }, "items": { "type": "object" }, "$$ref": "#/components/schemas/ApplicationsResponseNoUUID" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/app-registry/app/bulk/endpoint": { "put": { "tags": [ "Configuration - App Registry" ], "description": "Edit App Details for multiple App uuids", "operationId": "editAppInBulkByUuid", "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": { "required": [ "_rid", "business_relevance", "common_family", "common_family_display", "common_name", "common_name_display", "nbar_family", "nbar_name", "qosmos_family", "qosmos_name", "traffic_class", "uuid" ], "type": "object", "properties": { "_rid": { "type": "string", "example": "0:PolicyAppListsNode:1675729045113:1700" }, "business_relevance": { "type": "string", "example": "business-irrelevant" }, "common_family": { "type": "string", "example": "web" }, "common_family_display": { "type": "string", "example": "Web" }, "common_name": { "type": "string", "example": "zulily" }, "common_name_display": { "type": "string", "example": "Zulily" }, "nbar_family": { "type": "string", "example": "web" }, "nbar_name": { "type": "string", "example": "zulily" }, "qosmos_family": { "type": "string", "example": "web" }, "qosmos_name": { "type": "string", "example": "zulily" }, "traffic_class": { "type": "string", "example": "transactional-data" }, "uuid": { "type": "string", "format": "uuid", "example": "345fa8c9-6115-434b-b1f7-2c1d97f09f91" } }, "$$ref": "#/components/schemas/PayloadItems" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/app-registry/app/category": { "get": { "tags": [ "Configuration - App Registry" ], "description": "Get the stats of all type of apps", "operationId": "getAppListCategory", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "properties": { "empty": { "type": "boolean" } }, "items": { "type": "object" }, "$$ref": "#/components/schemas/ApplicationsResponseNoUUID" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/app-registry/app/discoveredapps": { "get": { "tags": [ "Configuration - App Registry" ], "description": "Get All network discovered apps", "operationId": "getNetworkDiscoveredApps", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "properties": { "empty": { "type": "boolean" } }, "items": { "type": "object" }, "$$ref": "#/components/schemas/ApplicationsResponseNoUUID" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/app-registry/app/filtermap": { "get": { "tags": [ "Configuration - App Registry" ], "description": "Get all available filters for applist", "operationId": "getAttributeMappingForApps", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "Status": { "description": "Status", "value": { "data": [ { "applicationSource": [ "hardcoded" ], "applicationFamily": [ "instant-messaging", "game" ], "businessRelevance": [ "business-irrelevant", "business-relevant", "default" ], "trafficClass": [ "multimedia-conferencing", "network-control" ], "applicationList": [] } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/app-registry/app/kubernetesapps": { "get": { "tags": [ "Kubernetes Services" ], "description": "Obtain all services associated with clusters", "operationId": "getKubernetesServices", "parameters": [ { "name": "isCached", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "offset", "in": "query", "description": "Pagination offset", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "limit", "in": "query", "description": "Pagination limit", "schema": { "type": "integer", "format": "int32", "default": 0 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "clusterName": { "type": "string", "example": "someClusterName" }, "ip": { "type": "array", "items": { "type": "string" } }, "name": { "type": "string", "example": "serviceName" }, "namespace": { "type": "string", "example": "awsNamespace" }, "port": { "type": "array", "items": { "type": "string" } }, "protocol": { "type": "string", "example": "tcp" }, "serverName": { "type": "array", "items": { "type": "string" } } }, "$$ref": "#/components/schemas/DiscoveredServices" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/app-registry/application/{app-uuid}": { "get": { "tags": [ "Configuration - App Registry" ], "description": "Get app detail for particular App uuid", "operationId": "getAppByUuid", "parameters": [ { "name": "app-uuid", "in": "path", "description": "App uuid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "properties": { "empty": { "type": "boolean" } }, "items": { "type": "object" }, "$$ref": "#/components/schemas/ApplicationsResponseNoUUID" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/app-registry/applications": { "get": { "tags": [ "Configuration - Policy App Registry" ], "description": "Get All the App for the given conditions", "operationId": "getAppList", "parameters": [ { "name": "trafficClass", "in": "query", "description": "Traffic Class", "schema": { "type": "string" }, "example": "bulk-data" }, { "name": "businessRelevance", "in": "query", "description": "Business Relevance", "schema": { "type": "string" }, "example": "business-relevant" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "properties": { "empty": { "type": "boolean" } }, "items": { "type": "object" }, "$$ref": "#/components/schemas/ApplicationsResponseNoUUID" }, "examples": { "Example": { "description": "Example", "value": { "applications": [ { "nbar_family": "thin-client", "numericId": "1367", "common_family_display": "thin-client", "applicationFamily": "thin-client", "nbar_name": "synergy", "rootApplications": "[]", "uuid": "43d282db-5a56-444e-8ab9-26d4a43403e8", "@rid": 131, "common_family": "thin-client", "applicationGroup": "other", "appId": "13:379", "tenantId": "default", "traffic_class": "bulk-data", "business_relevance": "business-relevant", "common_name_display": "Synergy", "common_name": "synergy", "applicationSource": "inBuiltApps", "protocolPackVersion": "69.0" }, { "nbar_family": "database", "numericId": "1359", "common_family_display": "database", "applicationFamily": "database", "nbar_name": "oracle-bi", "rootApplications": "[]", "uuid": "2f1a776b-2fba-485e-af2a-0384ad6b0267", "@rid": 147, "common_family": "database", "applicationGroup": "oracle-group", "appId": "3:9703", "tenantId": "default", "traffic_class": "bulk-data", "business_relevance": "business-relevant", "common_name_display": "Oracle-bi", "common_name": "oracle-bi", "protocolPackVersion": "69.0", "applicationSource": "inBuiltApps" } ] }, "$$ref": "#/components/examples/ComViptelaVmanageServerSdavcAppregistryApiAppregistryapiResponseExampleGetappregistryappresp" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "Configuration - Policy App Registry" ], "description": "Edit App Details", "operationId": "editAppDetails", "requestBody": { "content": { "*/*": { "schema": { "type": "array", "items": { "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", "properties": { "empty": { "type": "boolean" } }, "items": { "type": "object" }, "$$ref": "#/components/schemas/ApplicationsResponseNoUUID" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/app-registry/applications/{appId}": { "put": { "tags": [ "Configuration - Policy App Registry" ], "description": "Edit App Details", "operationId": "editAppDetailsWithUUID", "parameters": [ { "name": "appId", "in": "path", "description": "appId", "required": true, "schema": { "type": "string" }, "example": "3fda54ed-3b92-49e5-b1e5-adec30bfd17f" } ], "requestBody": { "description": "Request body", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Example Value": { "description": "Example Value", "value": { "nbar_family": "file-server", "numericId": "1157", "common_family_display": "file-server", "applicationFamily": "file-server", "nbar_name": "zannet", "rootApplications": "[]", "uuid": "3fda54ed-3b92-49e5-b1e5-adec30bfd17f", "@rid": 110, "common_family": "file-server", "applicationGroup": "other", "tenantId": "default", "traffic_class": "bulk-data", "business_relevance": "default", "common_name_display": "Zannet123", "common_name": "zannet", "applicationSource": "inBuiltApps", "protocolPackVersion": "69.0" }, "$$ref": "#/components/examples/ComViptelaVmanageServerSdavcAppregistryApiAppregistryapiRequestExampleGetappregistryappidreq" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "required": [ "_rid", "business_relevance", "common_family", "common_family_display", "common_name", "common_name_display", "nbar_family", "nbar_name", "qosmos_family", "qosmos_name", "traffic_class", "uuid" ], "type": "object", "properties": { "_rid": { "type": "string", "example": "0:PolicyAppListsNode:1675729045113:1700" }, "business_relevance": { "type": "string", "example": "business-irrelevant" }, "common_family": { "type": "string", "example": "web" }, "common_family_display": { "type": "string", "example": "Web" }, "common_name": { "type": "string", "example": "zulily" }, "common_name_display": { "type": "string", "example": "Zulily" }, "nbar_family": { "type": "string", "example": "web" }, "nbar_name": { "type": "string", "example": "zulily" }, "qosmos_family": { "type": "string", "example": "web" }, "qosmos_name": { "type": "string", "example": "zulily" }, "traffic_class": { "type": "string", "example": "transactional-data" }, "uuid": { "type": "string", "format": "uuid", "example": "345fa8c9-6115-434b-b1f7-2c1d97f09f91" } }, "$$ref": "#/components/schemas/PayloadItems" }, "examples": { "Status": { "description": "Status", "value": { "type": "ok", "message": "{\"appId\": \"3fda54ed-3b92-49e5-b1e5-adec30bfd17f\"}" }, "$$ref": "#/components/examples/ComViptelaVmanageServerSdavcAppregistryApiAppregistryapiResponseExampleGetappregistryappidresp" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/app-registry/clusters": { "post": { "tags": [ "Kubernetes Services" ], "description": "Manually upload kubeConfig", "operationId": "postCluster", "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "Kubernetes Services" ], "description": "Obtain all clusters with associated cloud accounts", "operationId": "getKubernetesCluster", "parameters": [ { "name": "isCached", "in": "query", "schema": { "type": "boolean", "default": true } }, { "name": "offset", "in": "query", "description": "Pagination offset", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "limit", "in": "query", "description": "Pagination limit", "schema": { "type": "integer", "format": "int32", "default": 0 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "accountId": { "type": "string", "example": "awsAccountId" }, "accountName": { "type": "string", "example": "aws_account1" }, "accountType": { "type": "string", "example": "AWS" }, "discoveryStatus": { "type": "boolean", "example": true }, "expiration": { "type": "string", "example": "Dec 21, 2035" }, "name": { "type": "string", "example": "clusterName" } }, "$$ref": "#/components/schemas/ClusterProperties" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/app-registry/clusters/{id}": { "put": { "tags": [ "Kubernetes Services" ], "description": "Edit the discovery status of a cluster", "operationId": "editKubernetesCluster", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "enable or disable Cluster Discovery Status", "content": { "application/json": { "schema": { "type": "object", "properties": { "discoveryStatus": { "type": "boolean", "example": true } }, "$$ref": "#/components/schemas/PutProperties" } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "Kubernetes Services" ], "description": "Delete manually uploaded cluster", "operationId": "deleteKubernetesCluster", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/app-registry/saasfeed": { "get": { "tags": [ "Configuration - App Registry" ], "description": "Get All Saas feed details", "operationId": "getActiveSaasFeeds", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "Status": { "description": "Status", "value": { "data": [ { "appName": "AAAA", "status": "enable", "feedCount": 123, "feedId": "someId" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/app-registry/saasfeed/app/configure": { "put": { "tags": [ "Configuration - App Registry" ], "description": "Get All the App for the given conditions", "operationId": "disableorEnableSaasFeedForSelectedApp", "requestBody": { "description": "Onboard", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "onboarding-payload": { "description": "onboarding-payload", "value": [ { "feedId": "someId", "enable": true } ] } } } }, "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" } }, "/app-registry/saasfeed/app/{feedId}": { "get": { "tags": [ "Configuration - App Registry" ], "description": "Get All Saas feed details of a particular application", "operationId": "getAllSaasFeedForSelectedApp", "parameters": [ { "name": "feedId", "in": "path", "description": "Feed ID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "properties": { "empty": { "type": "boolean" } }, "items": { "type": "object" }, "$$ref": "#/components/schemas/ApplicationsResponseNoUUID" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/auditlog": { "post": { "tags": [ "Administration - Audit Log" ], "summary": "Get vManage Audit Log with post action", "description": "Get raw property data with post action", "operationId": "getRawPropertyData", "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Data aggregation query string": { "description": "Data aggregation query string", "value": { "query": { "condition": "AND", "rules": [ { "field": "entry_time", "operator": "last_n_hours", "type": "date", "value": [ "3" ] } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "required": [ "data", "header" ], "type": "object", "properties": { "data": { "type": "array", "items": { "required": [ "auditdetails", "entry_time", "logdeviceid", "logfeature", "logid", "logmessage", "logmodule", "loguser", "logusersrcip", "statcycletime", "tenant" ], "type": "object", "properties": { "auditdetails": { "type": "array", "items": { "type": "string" } }, "entry_time": { "type": "integer", "format": "int32", "example": 1659003590292 }, "id": { "type": "string", "example": "iWJRRIIBMbLIyWbe1qH" }, "logdeviceid": { "type": "string", "example": "172.16.255.22" }, "logfeature": { "type": "string", "example": "user" }, "logid": { "type": "string", "format": "uuid", "example": "918c6d64-729c-4304-b2c7-955a7c0e6a61" }, "logmessage": { "type": "string", "example": "Invalidated session due to server session idle time out for User: viptela-device-901d032c-0721-438e-82ba-1d429598d879" }, "logmodule": { "type": "string", "example": "user" }, "loguser": { "type": "string", "format": "uuid" }, "logusersrcip": { "type": "string", "example": "172.16.255.19" }, "statcycletime": { "type": "integer", "format": "int32", "example": 1659003590292 }, "tenant": { "type": "string", "example": "default" } }, "$$ref": "#/components/schemas/AuditLogEntry" } }, "header": { "type": "object", "properties": { "chart": { "type": "object", "properties": { "series": { "type": "array", "items": { "type": "string" } }, "title": { "type": "string" }, "xAxis": { "type": "array", "items": { "type": "string" } }, "xAxisLabel": { "type": "string" }, "yAxis": { "type": "array", "items": { "type": "string" } }, "yAxisLabel": { "type": "string" } }, "$$ref": "#/components/schemas/ChartObject" }, "columns": { "required": [ "dataType", "property", "title" ], "type": "object", "properties": { "dataType": { "type": "string", "example": "date" }, "displayFormat": { "type": "string", "example": "DD MMM YYYY h:mm:ss A z" }, "hideable": { "type": "boolean", "example": true }, "inputFormat": { "type": "string", "example": "unix-time" }, "isDisplay": { "type": "boolean", "example": true }, "minWidth": { "type": "integer", "format": "int32", "example": 300 }, "property": { "type": "string", "example": "entry_time" }, "title": { "type": "string", "example": "Timestamp" }, "width": { "type": "integer", "format": "int32", "example": 220 } }, "$$ref": "#/components/schemas/AuditLogHeaderColumns" }, "fields": { "type": "object", "properties": { "dataType": { "type": "string", "example": "date" }, "property": { "type": "string", "example": "entry_time" } }, "$$ref": "#/components/schemas/GetStatDataFields" }, "generatedOn": { "type": "integer", "format": "int32", "example": 1655622555494 }, "viewKeys": { "type": "object", "properties": { "preferenceKey": { "type": "string", "example": "grid-AuditLogView" }, "uniqueKey": { "type": "array", "items": { "type": "string" } } }, "$$ref": "#/components/schemas/AuditLogHeaderViewKeys" } }, "$$ref": "#/components/schemas/AuditLogHeader" } }, "$$ref": "#/components/schemas/GetAuditLogData" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "Administration - Audit Log" ], "summary": "Get vManage Audit Log", "description": "Get stat raw data", "operationId": "getStatDataRawAuditLogData", "parameters": [ { "name": "query", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "required": [ "data", "header" ], "type": "object", "properties": { "data": { "type": "array", "items": { "required": [ "auditdetails", "entry_time", "logdeviceid", "logfeature", "logid", "logmessage", "logmodule", "loguser", "logusersrcip", "statcycletime", "tenant" ], "type": "object", "properties": { "auditdetails": { "type": "array", "items": { "type": "string" } }, "entry_time": { "type": "integer", "format": "int32", "example": 1659003590292 }, "id": { "type": "string", "example": "iWJRRIIBMbLIyWbe1qH" }, "logdeviceid": { "type": "string", "example": "172.16.255.22" }, "logfeature": { "type": "string", "example": "user" }, "logid": { "type": "string", "format": "uuid", "example": "918c6d64-729c-4304-b2c7-955a7c0e6a61" }, "logmessage": { "type": "string", "example": "Invalidated session due to server session idle time out for User: viptela-device-901d032c-0721-438e-82ba-1d429598d879" }, "logmodule": { "type": "string", "example": "user" }, "loguser": { "type": "string", "format": "uuid" }, "logusersrcip": { "type": "string", "example": "172.16.255.19" }, "statcycletime": { "type": "integer", "format": "int32", "example": 1659003590292 }, "tenant": { "type": "string", "example": "default" } }, "$$ref": "#/components/schemas/AuditLogEntry" } }, "header": { "type": "object", "properties": { "chart": { "type": "object", "properties": { "series": { "type": "array", "items": { "type": "string" } }, "title": { "type": "string" }, "xAxis": { "type": "array", "items": { "type": "string" } }, "xAxisLabel": { "type": "string" }, "yAxis": { "type": "array", "items": { "type": "string" } }, "yAxisLabel": { "type": "string" } }, "$$ref": "#/components/schemas/ChartObject" }, "columns": { "required": [ "dataType", "property", "title" ], "type": "object", "properties": { "dataType": { "type": "string", "example": "date" }, "displayFormat": { "type": "string", "example": "DD MMM YYYY h:mm:ss A z" }, "hideable": { "type": "boolean", "example": true }, "inputFormat": { "type": "string", "example": "unix-time" }, "isDisplay": { "type": "boolean", "example": true }, "minWidth": { "type": "integer", "format": "int32", "example": 300 }, "property": { "type": "string", "example": "entry_time" }, "title": { "type": "string", "example": "Timestamp" }, "width": { "type": "integer", "format": "int32", "example": 220 } }, "$$ref": "#/components/schemas/AuditLogHeaderColumns" }, "fields": { "type": "object", "properties": { "dataType": { "type": "string", "example": "date" }, "property": { "type": "string", "example": "entry_time" } }, "$$ref": "#/components/schemas/GetStatDataFields" }, "generatedOn": { "type": "integer", "format": "int32", "example": 1655622555494 }, "viewKeys": { "type": "object", "properties": { "preferenceKey": { "type": "string", "example": "grid-AuditLogView" }, "uniqueKey": { "type": "array", "items": { "type": "string" } } }, "$$ref": "#/components/schemas/AuditLogHeaderViewKeys" } }, "$$ref": "#/components/schemas/AuditLogHeader" } }, "$$ref": "#/components/schemas/GetAuditLogData" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/auditlog/aggregation": { "post": { "tags": [ "Administration - Audit Log" ], "summary": "Get raw property data aggregated", "description": "Get raw property data aggregated with post action", "operationId": "getPostPropertyAggregationData", "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Data aggregation query string": { "description": "Data aggregation query string", "value": { "aggregation": { "histogram": { "interval": 30, "order": "asc", "property": "entry_time", "type": "minute" } }, "query": { "condition": "AND", "rules": [ { "field": "entry_time", "operator": "last_n_hours", "type": "date", "value": [ "3" ] } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "required": [ "header" ], "type": "object", "properties": { "data": { "type": "array", "items": { "required": [ "auditdetails", "entry_time", "logdeviceid", "logfeature", "logid", "logmessage", "logmodule", "loguser", "logusersrcip", "statcycletime", "tenant" ], "type": "object", "properties": { "auditdetails": { "type": "array", "items": { "type": "string" } }, "entry_time": { "type": "integer", "format": "int32", "example": 1659003590292 }, "id": { "type": "string", "example": "iWJRRIIBMbLIyWbe1qH" }, "logdeviceid": { "type": "string", "example": "172.16.255.22" }, "logfeature": { "type": "string", "example": "user" }, "logid": { "type": "string", "format": "uuid", "example": "918c6d64-729c-4304-b2c7-955a7c0e6a61" }, "logmessage": { "type": "string", "example": "Invalidated session due to server session idle time out for User: viptela-device-901d032c-0721-438e-82ba-1d429598d879" }, "logmodule": { "type": "string", "example": "user" }, "loguser": { "type": "string", "format": "uuid" }, "logusersrcip": { "type": "string", "example": "172.16.255.19" }, "statcycletime": { "type": "integer", "format": "int32", "example": 1659003590292 }, "tenant": { "type": "string", "example": "default" } }, "$$ref": "#/components/schemas/AuditLogEntry" } }, "entryTimeList": { "type": "array", "items": { "type": "string" } }, "header": { "type": "object", "properties": { "chart": { "type": "object", "properties": { "series": { "type": "array", "items": { "type": "string" } }, "title": { "type": "string" }, "xAxis": { "type": "array", "items": { "type": "string" } }, "xAxisLabel": { "type": "string" }, "yAxis": { "type": "array", "items": { "type": "string" } }, "yAxisLabel": { "type": "string" } }, "$$ref": "#/components/schemas/ChartObject" }, "columns": { "required": [ "dataType", "property", "title" ], "type": "object", "properties": { "dataType": { "type": "string", "example": "date" }, "displayFormat": { "type": "string", "example": "DD MMM YYYY h:mm:ss A z" }, "hideable": { "type": "boolean", "example": true }, "inputFormat": { "type": "string", "example": "unix-time" }, "isDisplay": { "type": "boolean", "example": true }, "minWidth": { "type": "integer", "format": "int32", "example": 300 }, "property": { "type": "string", "example": "entry_time" }, "title": { "type": "string", "example": "Timestamp" }, "width": { "type": "integer", "format": "int32", "example": 220 } }, "$$ref": "#/components/schemas/AuditLogHeaderColumns" }, "fields": { "type": "object", "properties": { "dataType": { "type": "string", "example": "date" }, "property": { "type": "string", "example": "entry_time" } }, "$$ref": "#/components/schemas/GetStatDataFields" }, "generatedOn": { "type": "integer", "format": "int32", "example": 1655622555494 }, "viewKeys": { "type": "object", "properties": { "preferenceKey": { "type": "string", "example": "grid-AuditLogView" }, "uniqueKey": { "type": "array", "items": { "type": "string" } } }, "$$ref": "#/components/schemas/AuditLogHeaderViewKeys" } }, "$$ref": "#/components/schemas/AuditLogHeader" } }, "$$ref": "#/components/schemas/GetAuditLogAggregation" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "Administration - Audit Log" ], "summary": "Get raw property data aggregated", "description": "Get raw property data aggregated", "operationId": "getPropertyAggregationData", "parameters": [ { "name": "query", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "required": [ "header" ], "type": "object", "properties": { "data": { "type": "array", "items": { "required": [ "auditdetails", "entry_time", "logdeviceid", "logfeature", "logid", "logmessage", "logmodule", "loguser", "logusersrcip", "statcycletime", "tenant" ], "type": "object", "properties": { "auditdetails": { "type": "array", "items": { "type": "string" } }, "entry_time": { "type": "integer", "format": "int32", "example": 1659003590292 }, "id": { "type": "string", "example": "iWJRRIIBMbLIyWbe1qH" }, "logdeviceid": { "type": "string", "example": "172.16.255.22" }, "logfeature": { "type": "string", "example": "user" }, "logid": { "type": "string", "format": "uuid", "example": "918c6d64-729c-4304-b2c7-955a7c0e6a61" }, "logmessage": { "type": "string", "example": "Invalidated session due to server session idle time out for User: viptela-device-901d032c-0721-438e-82ba-1d429598d879" }, "logmodule": { "type": "string", "example": "user" }, "loguser": { "type": "string", "format": "uuid" }, "logusersrcip": { "type": "string", "example": "172.16.255.19" }, "statcycletime": { "type": "integer", "format": "int32", "example": 1659003590292 }, "tenant": { "type": "string", "example": "default" } }, "$$ref": "#/components/schemas/AuditLogEntry" } }, "entryTimeList": { "type": "array", "items": { "type": "string" } }, "header": { "type": "object", "properties": { "chart": { "type": "object", "properties": { "series": { "type": "array", "items": { "type": "string" } }, "title": { "type": "string" }, "xAxis": { "type": "array", "items": { "type": "string" } }, "xAxisLabel": { "type": "string" }, "yAxis": { "type": "array", "items": { "type": "string" } }, "yAxisLabel": { "type": "string" } }, "$$ref": "#/components/schemas/ChartObject" }, "columns": { "required": [ "dataType", "property", "title" ], "type": "object", "properties": { "dataType": { "type": "string", "example": "date" }, "displayFormat": { "type": "string", "example": "DD MMM YYYY h:mm:ss A z" }, "hideable": { "type": "boolean", "example": true }, "inputFormat": { "type": "string", "example": "unix-time" }, "isDisplay": { "type": "boolean", "example": true }, "minWidth": { "type": "integer", "format": "int32", "example": 300 }, "property": { "type": "string", "example": "entry_time" }, "title": { "type": "string", "example": "Timestamp" }, "width": { "type": "integer", "format": "int32", "example": 220 } }, "$$ref": "#/components/schemas/AuditLogHeaderColumns" }, "fields": { "type": "object", "properties": { "dataType": { "type": "string", "example": "date" }, "property": { "type": "string", "example": "entry_time" } }, "$$ref": "#/components/schemas/GetStatDataFields" }, "generatedOn": { "type": "integer", "format": "int32", "example": 1655622555494 }, "viewKeys": { "type": "object", "properties": { "preferenceKey": { "type": "string", "example": "grid-AuditLogView" }, "uniqueKey": { "type": "array", "items": { "type": "string" } } }, "$$ref": "#/components/schemas/AuditLogHeaderViewKeys" } }, "$$ref": "#/components/schemas/AuditLogHeader" } }, "$$ref": "#/components/schemas/GetAuditLogAggregation" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/auditlog/doccount": { "post": { "tags": [ "Administration - Audit Log" ], "summary": "Get vManage Audit Log Doc count", "description": "Get response count of a query", "operationId": "getCountPost_AdministrationAuditLog_1804", "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Data aggregation query string": { "description": "Data aggregation query string", "value": { "query": { "condition": "AND", "rules": [ { "field": "entry_time", "operator": "last_n_hours", "type": "date", "value": [ "3" ] } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32", "example": 44 } }, "$$ref": "#/components/schemas/GetAuditLogDoccount" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "Administration - Audit Log" ], "summary": "Get vManage Audit Log Doc count", "description": "Get response count of a query", "operationId": "getCount_AdministrationAuditLog_1803", "parameters": [ { "name": "query", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32", "example": 44 } }, "$$ref": "#/components/schemas/GetAuditLogDoccount" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/auditlog/fields": { "get": { "tags": [ "Administration - Audit Log" ], "summary": "Get vManage Audit Log fields", "description": "Get fields and type", "operationId": "getStatDataFields_AdministrationAuditLog_1603", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "properties": { "empty": { "type": "boolean" } }, "items": { "type": "object", "properties": { "dataType": { "type": "string", "example": "date" }, "property": { "type": "string", "example": "entry_time" } }, "$$ref": "#/components/schemas/GetStatDataFields" }, "$$ref": "#/components/schemas/GetStatDataFieldArray" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/auditlog/page": { "get": { "tags": [ "Administration - Audit Log" ], "summary": "Get raw property data in bulk", "description": "Get raw property data in bulk", "operationId": "getStatBulkRawPropertyData", "parameters": [ { "name": "query", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "scrollId", "in": "query", "schema": { "type": "string" } }, { "name": "count", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "required": [ "data", "header" ], "type": "object", "properties": { "data": { "type": "array", "items": { "required": [ "auditdetails", "entry_time", "logdeviceid", "logfeature", "logid", "logmessage", "logmodule", "loguser", "logusersrcip", "statcycletime", "tenant" ], "type": "object", "properties": { "auditdetails": { "type": "array", "items": { "type": "string" } }, "entry_time": { "type": "integer", "format": "int32", "example": 1659003590292 }, "id": { "type": "string", "example": "iWJRRIIBMbLIyWbe1qH" }, "logdeviceid": { "type": "string", "example": "172.16.255.22" }, "logfeature": { "type": "string", "example": "user" }, "logid": { "type": "string", "format": "uuid", "example": "918c6d64-729c-4304-b2c7-955a7c0e6a61" }, "logmessage": { "type": "string", "example": "Invalidated session due to server session idle time out for User: viptela-device-901d032c-0721-438e-82ba-1d429598d879" }, "logmodule": { "type": "string", "example": "user" }, "loguser": { "type": "string", "format": "uuid" }, "logusersrcip": { "type": "string", "example": "172.16.255.19" }, "statcycletime": { "type": "integer", "format": "int32", "example": 1659003590292 }, "tenant": { "type": "string", "example": "default" } }, "$$ref": "#/components/schemas/AuditLogEntry" } }, "header": { "type": "object", "properties": { "chart": { "type": "object", "properties": { "series": { "type": "array", "items": { "type": "string" } }, "title": { "type": "string" }, "xAxis": { "type": "array", "items": { "type": "string" } }, "xAxisLabel": { "type": "string" }, "yAxis": { "type": "array", "items": { "type": "string" } }, "yAxisLabel": { "type": "string" } }, "$$ref": "#/components/schemas/ChartObject" }, "columns": { "required": [ "dataType", "property", "title" ], "type": "object", "properties": { "dataType": { "type": "string", "example": "date" }, "displayFormat": { "type": "string", "example": "DD MMM YYYY h:mm:ss A z" }, "hideable": { "type": "boolean", "example": true }, "inputFormat": { "type": "string", "example": "unix-time" }, "isDisplay": { "type": "boolean", "example": true }, "minWidth": { "type": "integer", "format": "int32", "example": 300 }, "property": { "type": "string", "example": "entry_time" }, "title": { "type": "string", "example": "Timestamp" }, "width": { "type": "integer", "format": "int32", "example": 220 } }, "$$ref": "#/components/schemas/AuditLogHeaderColumns" }, "fields": { "type": "object", "properties": { "dataType": { "type": "string", "example": "date" }, "property": { "type": "string", "example": "entry_time" } }, "$$ref": "#/components/schemas/GetStatDataFields" }, "generatedOn": { "type": "integer", "format": "int32", "example": 1655622555494 }, "viewKeys": { "type": "object", "properties": { "preferenceKey": { "type": "string", "example": "grid-AuditLogView" }, "uniqueKey": { "type": "array", "items": { "type": "string" } } }, "$$ref": "#/components/schemas/AuditLogHeaderViewKeys" } }, "$$ref": "#/components/schemas/AuditLogHeader" } }, "$$ref": "#/components/schemas/GetAuditLogData" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Administration - Audit Log" ], "summary": "Get raw property data in bulk", "description": "Get raw property data in bulk with post action", "operationId": "getPostStatBulkRawPropertyData", "parameters": [ { "name": "scrollId", "in": "query", "schema": { "type": "string" } }, { "name": "count", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Data aggregation query string": { "description": "Data aggregation query string", "value": { "query": { "condition": "AND", "rules": [ { "field": "entry_time", "operator": "last_n_hours", "type": "date", "value": [ "3" ] } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "required": [ "data", "header" ], "type": "object", "properties": { "data": { "type": "array", "items": { "required": [ "auditdetails", "entry_time", "logdeviceid", "logfeature", "logid", "logmessage", "logmodule", "loguser", "logusersrcip", "statcycletime", "tenant" ], "type": "object", "properties": { "auditdetails": { "type": "array", "items": { "type": "string" } }, "entry_time": { "type": "integer", "format": "int32", "example": 1659003590292 }, "id": { "type": "string", "example": "iWJRRIIBMbLIyWbe1qH" }, "logdeviceid": { "type": "string", "example": "172.16.255.22" }, "logfeature": { "type": "string", "example": "user" }, "logid": { "type": "string", "format": "uuid", "example": "918c6d64-729c-4304-b2c7-955a7c0e6a61" }, "logmessage": { "type": "string", "example": "Invalidated session due to server session idle time out for User: viptela-device-901d032c-0721-438e-82ba-1d429598d879" }, "logmodule": { "type": "string", "example": "user" }, "loguser": { "type": "string", "format": "uuid" }, "logusersrcip": { "type": "string", "example": "172.16.255.19" }, "statcycletime": { "type": "integer", "format": "int32", "example": 1659003590292 }, "tenant": { "type": "string", "example": "default" } }, "$$ref": "#/components/schemas/AuditLogEntry" } }, "header": { "type": "object", "properties": { "chart": { "type": "object", "properties": { "series": { "type": "array", "items": { "type": "string" } }, "title": { "type": "string" }, "xAxis": { "type": "array", "items": { "type": "string" } }, "xAxisLabel": { "type": "string" }, "yAxis": { "type": "array", "items": { "type": "string" } }, "yAxisLabel": { "type": "string" } }, "$$ref": "#/components/schemas/ChartObject" }, "columns": { "required": [ "dataType", "property", "title" ], "type": "object", "properties": { "dataType": { "type": "string", "example": "date" }, "displayFormat": { "type": "string", "example": "DD MMM YYYY h:mm:ss A z" }, "hideable": { "type": "boolean", "example": true }, "inputFormat": { "type": "string", "example": "unix-time" }, "isDisplay": { "type": "boolean", "example": true }, "minWidth": { "type": "integer", "format": "int32", "example": 300 }, "property": { "type": "string", "example": "entry_time" }, "title": { "type": "string", "example": "Timestamp" }, "width": { "type": "integer", "format": "int32", "example": 220 } }, "$$ref": "#/components/schemas/AuditLogHeaderColumns" }, "fields": { "type": "object", "properties": { "dataType": { "type": "string", "example": "date" }, "property": { "type": "string", "example": "entry_time" } }, "$$ref": "#/components/schemas/GetStatDataFields" }, "generatedOn": { "type": "integer", "format": "int32", "example": 1655622555494 }, "viewKeys": { "type": "object", "properties": { "preferenceKey": { "type": "string", "example": "grid-AuditLogView" }, "uniqueKey": { "type": "array", "items": { "type": "string" } } }, "$$ref": "#/components/schemas/AuditLogHeaderViewKeys" } }, "$$ref": "#/components/schemas/AuditLogHeader" } }, "$$ref": "#/components/schemas/GetAuditLogData" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/auditlog/query/fields": { "get": { "tags": [ "Administration - Audit Log" ], "summary": "Get vManage Audit Log query fields", "description": "Get query fields", "operationId": "getStatQueryFields_AdministrationAuditLog_2203", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "properties": { "empty": { "type": "boolean" } }, "items": { "required": [ "dataType", "isRequired", "multiSelect", "name", "property" ], "type": "object", "properties": { "dataType": { "type": "string", "example": "date" }, "fieldData": { "type": "object", "properties": { "type": { "type": "string", "example": "dateList" } }, "$$ref": "#/components/schemas/GetStatQueryFieldsFieldData" }, "isRequired": { "type": "boolean", "example": true }, "multiSelect": { "type": "boolean", "example": true }, "name": { "type": "string", "example": "vmanage.server.auditlog.auditLogTime" }, "options": { "type": "array", "items": { "required": [ "key", "value" ], "type": "object", "properties": { "enableDateFields": { "type": "boolean", "example": true }, "isSelected": { "type": "boolean", "example": true }, "key": { "type": "string", "example": "last_1_hour" }, "number": { "type": "string", "example": "1" }, "value": { "type": "string", "example": "Last 1 hour" } }, "$$ref": "#/components/schemas/GetStatQueryFieldOptions" } }, "property": { "type": "string", "example": "entry_time" } }, "$$ref": "#/components/schemas/GetStatQueryFields" }, "$$ref": "#/components/schemas/GetStatQueryFieldArray" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/auditlog/severity": { "get": { "tags": [ "Administration - Audit Log" ], "summary": "Get vManage Audit Log", "description": "Get audit logs for last 3 hours", "operationId": "generateAuditLog", "parameters": [ { "name": "query", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "sortBy", "in": "query", "schema": { "pattern": "^[a-zA-Z-_]+$", "type": "string" } }, { "name": "sortOrder", "in": "query", "schema": { "type": "string", "enum": [ "asc", "ASC", "Asc", "desc", "DESC", "Desc" ] } }, { "name": "site-id", "in": "query", "schema": { "pattern": "^[0-9]+$", "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "required": [ "data", "header" ], "type": "object", "properties": { "data": { "type": "array", "items": { "required": [ "auditdetails", "entry_time", "logdeviceid", "logfeature", "logid", "logmessage", "logmodule", "loguser", "logusersrcip", "statcycletime", "tenant" ], "type": "object", "properties": { "auditdetails": { "type": "array", "items": { "type": "string" } }, "entry_time": { "type": "integer", "format": "int32", "example": 1659003590292 }, "id": { "type": "string", "example": "iWJRRIIBMbLIyWbe1qH" }, "logdeviceid": { "type": "string", "example": "172.16.255.22" }, "logfeature": { "type": "string", "example": "user" }, "logid": { "type": "string", "format": "uuid", "example": "918c6d64-729c-4304-b2c7-955a7c0e6a61" }, "logmessage": { "type": "string", "example": "Invalidated session due to server session idle time out for User: viptela-device-901d032c-0721-438e-82ba-1d429598d879" }, "logmodule": { "type": "string", "example": "user" }, "loguser": { "type": "string", "format": "uuid" }, "logusersrcip": { "type": "string", "example": "172.16.255.19" }, "statcycletime": { "type": "integer", "format": "int32", "example": 1659003590292 }, "tenant": { "type": "string", "example": "default" } }, "$$ref": "#/components/schemas/AuditLogEntry" } }, "header": { "type": "object", "properties": { "chart": { "type": "object", "properties": { "series": { "type": "array", "items": { "type": "string" } }, "title": { "type": "string" }, "xAxis": { "type": "array", "items": { "type": "string" } }, "xAxisLabel": { "type": "string" }, "yAxis": { "type": "array", "items": { "type": "string" } }, "yAxisLabel": { "type": "string" } }, "$$ref": "#/components/schemas/ChartObject" }, "columns": { "required": [ "dataType", "property", "title" ], "type": "object", "properties": { "dataType": { "type": "string", "example": "date" }, "displayFormat": { "type": "string", "example": "DD MMM YYYY h:mm:ss A z" }, "hideable": { "type": "boolean", "example": true }, "inputFormat": { "type": "string", "example": "unix-time" }, "isDisplay": { "type": "boolean", "example": true }, "minWidth": { "type": "integer", "format": "int32", "example": 300 }, "property": { "type": "string", "example": "entry_time" }, "title": { "type": "string", "example": "Timestamp" }, "width": { "type": "integer", "format": "int32", "example": 220 } }, "$$ref": "#/components/schemas/AuditLogHeaderColumns" }, "fields": { "type": "object", "properties": { "dataType": { "type": "string", "example": "date" }, "property": { "type": "string", "example": "entry_time" } }, "$$ref": "#/components/schemas/GetStatDataFields" }, "generatedOn": { "type": "integer", "format": "int32", "example": 1655622555494 }, "viewKeys": { "type": "object", "properties": { "preferenceKey": { "type": "string", "example": "grid-AuditLogView" }, "uniqueKey": { "type": "array", "items": { "type": "string" } } }, "$$ref": "#/components/schemas/AuditLogHeaderViewKeys" } }, "$$ref": "#/components/schemas/AuditLogHeader" }, "total_records": { "type": "integer", "format": "int32", "example": 2 } }, "$$ref": "#/components/schemas/GetAuditLogBySeverity" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/auditlog/severity/summary": { "get": { "tags": [ "Administration - Audit Log" ], "summary": "Get vManage Audit Log Histogram", "description": "Get audit log severity histogram", "operationId": "getAuditSeverityCustomHistogram", "parameters": [ { "name": "query", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "description": "data list", "example": [ "MEGAPORT", "EQUINIX", "ATT" ], "items": { "type": "string", "description": "data", "example": "MEGAPORT" } } }, "$$ref": "#/components/schemas/InlineResponse200" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/backup/backupinfo": { "delete": { "tags": [ "Scheduled Backup Restore" ], "summary": "Deletes a local database operation", "description": "Delete all or a specific backup file stored in vManage", "operationId": "deleteSchduledBackup", "parameters": [ { "name": "taskId", "in": "query", "schema": { "pattern": "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}", "type": "string" } }, { "name": "backupInfoId", "in": "query", "schema": { "pattern": "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}", "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "required": [ "code", "details", "message" ], "type": "object", "properties": { "code": { "type": "string", "description": "Error code associated with the error event" }, "details": { "type": "string", "description": "Error message details" }, "message": { "type": "string", "description": "Error message title" } }, "description": "error message", "$$ref": "#/components/schemas/Model400ErrorError" } }, "$$ref": "#/components/schemas/Model400Error" } } } }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/backup/backupinfo/{localBackupInfoId}": { "get": { "tags": [ "Scheduled Backup Restore" ], "summary": "Get a localBackupInfo record by localBackupInfoId", "description": "Get details of database backup task for given localBackupInfo object", "operationId": "getLocalBackupInfo", "parameters": [ { "name": "localBackupInfoId", "in": "path", "required": true, "schema": { "pattern": "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}", "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "backupState": { "pattern": "^(SCHEDULED|IN_PROGRESS|CONFIG_DB_BACKUP_SUCCESS|CONFIG_DB_BACKUP_FAILED|STATS_DB_EXPORT_SUCCESS|STATS_DB_EXPORT_FAILED|CONFIG_DB_CONSISTENCY_CHECK_FAILED|LEADER_SUCCESS|ALL_SUCCESS|FAILURE|DELETED)$", "type": "string", "description": "Current stage of database backup workflow. This could be [SCHEDULED/IN_PROGRESS/CONFIG_DB_BACKUP_SUCCESS/CONFIG_DB_BACKUP_FAILED/STATS_DB_EXPORT_SUCCESS/STATS_DB_EXPORT_FAILED/CONFIG_DB_CONSISTENCY_CHECK_FAILED/LEADER_SUCCESS/ALL_SUCCESS/FAILURE/DELETED]", "example": "IN_PROGRESS" }, "backupType": { "pattern": "^(SCHEDULED|ON_DEMAND)$", "type": "string", "description": "Type of backup. This could be [SCHEDULED/ON_DEMAND]", "example": "ON_DEMAND" }, "createTime": { "type": "integer", "description": "Epoch timestamp", "format": "int64", "example": 1650994911131 }, "destination": { "type": "object", "properties": { "backupDest": { "pattern": "^(LOCAL|S3|SFTP|AZURE)$", "type": "string", "description": "Storage type. This could be [LOCAL/S3/SFTP/AZURE]", "example": "LOCAL" }, "backupDir": { "pattern": "^(?:\\/|\\w:)?(?:[\\\\\\/][\\w\\-\\s]+)*(?:[\\\\\\/])?$", "type": "string", "description": "Location where the database backup file on a storage type. ", "example": "/opt/data/backup/scheduledbackup/" }, "backupStorageInGB": { "minimum": 1, "type": "integer", "description": "Size of the database backup allowed to the stored at a backup destination", "format": "int32", "example": 10 }, "backupTTLInDays": { "minimum": 1, "type": "integer", "description": "Time to live for a database backup copy in the backup destination in days", "format": "int32", "example": 30 }, "numOfReplica": { "minimum": 1, "type": "integer", "description": "Number of replicas of the database backup file", "format": "int32", "example": 2 }, "vmVersion": { "pattern": "^\\d+(\\.\\d+)*$", "type": "string", "description": "vManage software version against which the database backup was taken", "example": "20.9" } }, "$$ref": "#/components/schemas/LocalDestination" }, "downloadURL": { "pattern": "^\\/dataservice\\/tenantbackup\\/download\\/\\d+\\/backup_\\d+_\\d{6}-\\d{6}\\.tar\\.gz$", "type": "string", "description": "Destination to download database backup from", "example": "/dataservice/tenantbackup/download/1570057020772/backup_1570057020772_100919-181838.tar.gz" }, "followerIpAddressList": { "maxItems": 2147483647, "minItems": 1, "type": "array", "description": "List of vManage servers IP address who are running in follower mode", "example": [ "10.0.105.38", "10.0.105.39" ], "items": { "type": "string", "description": "List of vManage servers IP address who are running in follower mode", "example": [ "10.0.105.38", "10.0.105.39" ] } }, "localBackupInfoId": { "pattern": "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}", "type": "string", "description": "A unique UUID per database back up request", "example": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454" }, "scheduleId": { "pattern": "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}", "type": "string", "description": "A unique UUID for scheduled database backup task", "example": "9b08dce2-d33f-11ec-9d64-0242ac120002" }, "srcIpAddress": { "pattern": "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "description": "IP address of the source vmanage server for database backup", "example": "10.0.105.32" }, "taskId": { "pattern": "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}", "type": "string", "description": "Unique task Id for a given database backup task", "example": "f81ee476-d33f-11ec-9d64-0242ac120002" }, "taskName": { "pattern": "^[a-zA-Z0-9 _\\-\\\\\\/]+$", "type": "string", "description": "Task name in human readable format", "example": "Schedule backup on 6/1/2022" } }, "description": "List of all local backup info objects in the system", "$$ref": "#/components/schemas/LocalBackupInfo" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "required": [ "code", "details", "message" ], "type": "object", "properties": { "code": { "type": "string", "description": "Error code associated with the error event" }, "details": { "type": "string", "description": "Error message details" }, "message": { "type": "string", "description": "Error message title" } }, "description": "error message", "$$ref": "#/components/schemas/Model400ErrorError" } }, "$$ref": "#/components/schemas/Model400Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "required": [ "code", "details", "message" ], "type": "object", "properties": { "code": { "type": "string", "description": "Error code associated with the error event" }, "details": { "type": "string", "description": "Error message details" }, "message": { "type": "string", "description": "Error message title" } }, "description": "error message", "$$ref": "#/components/schemas/Model400ErrorError" } }, "$$ref": "#/components/schemas/Model400Error" } } } }, "500": { "description": "Internal Server Error" } } } }, "/backup/download/{path}": { "get": { "tags": [ "Scheduled Backup Restore" ], "summary": "Download the database backup file", "description": "Download a Backup File that is already stored in vManage", "operationId": "downloadBackupFile", "parameters": [ { "name": "path", "in": "path", "required": true, "schema": { "pattern": "^(ond|sched)_([a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})_\\d{6}-\\d{6}\\.tar\\.gz$", "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/backup/export": { "post": { "tags": [ "Scheduled Backup Restore" ], "summary": "Issues database backup request", "description": "Trigger a backup of configuration database and statstics database and store it in vManage", "operationId": "exportBackup", "requestBody": { "description": "backup request information", "content": { "application/json": { "schema": { "type": "object", "properties": { "backupState": { "pattern": "^(SCHEDULED|IN_PROGRESS|CONFIG_DB_BACKUP_SUCCESS|CONFIG_DB_BACKUP_FAILED|STATS_DB_EXPORT_SUCCESS|STATS_DB_EXPORT_FAILED|CONFIG_DB_CONSISTENCY_CHECK_FAILED|LEADER_SUCCESS|ALL_SUCCESS|FAILURE|DELETED)$", "type": "string", "description": "Current stage of database backup workflow. This could be [SCHEDULED/IN_PROGRESS/CONFIG_DB_BACKUP_SUCCESS/CONFIG_DB_BACKUP_FAILED/STATS_DB_EXPORT_SUCCESS/STATS_DB_EXPORT_FAILED/CONFIG_DB_CONSISTENCY_CHECK_FAILED/LEADER_SUCCESS/ALL_SUCCESS/FAILURE/DELETED]", "example": "IN_PROGRESS" }, "backupType": { "pattern": "^(SCHEDULED|ON_DEMAND)$", "type": "string", "description": "Type of backup. This could be [SCHEDULED/ON_DEMAND]", "example": "ON_DEMAND" }, "createTime": { "type": "integer", "description": "Epoch timestamp", "format": "int64", "example": 1650994911131 }, "destination": { "type": "object", "properties": { "backupDest": { "pattern": "^(LOCAL|S3|SFTP|AZURE)$", "type": "string", "description": "Storage type. This could be [LOCAL/S3/SFTP/AZURE]", "example": "LOCAL" }, "backupDir": { "pattern": "^(?:\\/|\\w:)?(?:[\\\\\\/][\\w\\-\\s]+)*(?:[\\\\\\/])?$", "type": "string", "description": "Location where the database backup file on a storage type. ", "example": "/opt/data/backup/scheduledbackup/" }, "backupStorageInGB": { "minimum": 1, "type": "integer", "description": "Size of the database backup allowed to the stored at a backup destination", "format": "int32", "example": 10 }, "backupTTLInDays": { "minimum": 1, "type": "integer", "description": "Time to live for a database backup copy in the backup destination in days", "format": "int32", "example": 30 }, "numOfReplica": { "minimum": 1, "type": "integer", "description": "Number of replicas of the database backup file", "format": "int32", "example": 2 }, "vmVersion": { "pattern": "^\\d+(\\.\\d+)*$", "type": "string", "description": "vManage software version against which the database backup was taken", "example": "20.9" } }, "$$ref": "#/components/schemas/LocalDestination" }, "downloadURL": { "pattern": "^\\/dataservice\\/tenantbackup\\/download\\/\\d+\\/backup_\\d+_\\d{6}-\\d{6}\\.tar\\.gz$", "type": "string", "description": "Destination to download database backup from", "example": "/dataservice/tenantbackup/download/1570057020772/backup_1570057020772_100919-181838.tar.gz" }, "followerIpAddressList": { "maxItems": 2147483647, "minItems": 1, "type": "array", "description": "List of vManage servers IP address who are running in follower mode", "example": [ "10.0.105.38", "10.0.105.39" ], "items": { "type": "string", "description": "List of vManage servers IP address who are running in follower mode", "example": [ "10.0.105.38", "10.0.105.39" ] } }, "localBackupInfoId": { "pattern": "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}", "type": "string", "description": "A unique UUID per database back up request", "example": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454" }, "scheduleId": { "pattern": "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}", "type": "string", "description": "A unique UUID for scheduled database backup task", "example": "9b08dce2-d33f-11ec-9d64-0242ac120002" }, "srcIpAddress": { "pattern": "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "description": "IP address of the source vmanage server for database backup", "example": "10.0.105.32" }, "taskId": { "pattern": "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}", "type": "string", "description": "Unique task Id for a given database backup task", "example": "f81ee476-d33f-11ec-9d64-0242ac120002" }, "taskName": { "pattern": "^[a-zA-Z0-9 _\\-\\\\\\/]+$", "type": "string", "description": "Task name in human readable format", "example": "Schedule backup on 6/1/2022" } }, "description": "List of all local backup info objects in the system", "$$ref": "#/components/schemas/LocalBackupInfo" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "description": "data list", "example": [ "MEGAPORT", "EQUINIX", "ATT" ], "items": { "type": "string", "description": "data", "example": "MEGAPORT" } } }, "$$ref": "#/components/schemas/InlineResponse200" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "required": [ "code", "details", "message" ], "type": "object", "properties": { "code": { "type": "string", "description": "Error code associated with the error event" }, "details": { "type": "string", "description": "Error message details" }, "message": { "type": "string", "description": "Error message title" } }, "description": "error message", "$$ref": "#/components/schemas/Model400ErrorError" } }, "$$ref": "#/components/schemas/Model400Error" } } } }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/backup/list": { "get": { "tags": [ "Scheduled Backup Restore" ], "summary": "Get list of all database backup requests", "description": "List all backup files of a tenant stored in vManage", "operationId": "listBackup", "parameters": [ { "name": "size", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "backupList": { "type": "array", "description": "List of all local backup info objects in the system", "items": { "type": "object", "properties": { "backupState": { "pattern": "^(SCHEDULED|IN_PROGRESS|CONFIG_DB_BACKUP_SUCCESS|CONFIG_DB_BACKUP_FAILED|STATS_DB_EXPORT_SUCCESS|STATS_DB_EXPORT_FAILED|CONFIG_DB_CONSISTENCY_CHECK_FAILED|LEADER_SUCCESS|ALL_SUCCESS|FAILURE|DELETED)$", "type": "string", "description": "Current stage of database backup workflow. This could be [SCHEDULED/IN_PROGRESS/CONFIG_DB_BACKUP_SUCCESS/CONFIG_DB_BACKUP_FAILED/STATS_DB_EXPORT_SUCCESS/STATS_DB_EXPORT_FAILED/CONFIG_DB_CONSISTENCY_CHECK_FAILED/LEADER_SUCCESS/ALL_SUCCESS/FAILURE/DELETED]", "example": "IN_PROGRESS" }, "backupType": { "pattern": "^(SCHEDULED|ON_DEMAND)$", "type": "string", "description": "Type of backup. This could be [SCHEDULED/ON_DEMAND]", "example": "ON_DEMAND" }, "createTime": { "type": "integer", "description": "Epoch timestamp", "format": "int64", "example": 1650994911131 }, "destination": { "type": "object", "properties": { "backupDest": { "pattern": "^(LOCAL|S3|SFTP|AZURE)$", "type": "string", "description": "Storage type. This could be [LOCAL/S3/SFTP/AZURE]", "example": "LOCAL" }, "backupDir": { "pattern": "^(?:\\/|\\w:)?(?:[\\\\\\/][\\w\\-\\s]+)*(?:[\\\\\\/])?$", "type": "string", "description": "Location where the database backup file on a storage type. ", "example": "/opt/data/backup/scheduledbackup/" }, "backupStorageInGB": { "minimum": 1, "type": "integer", "description": "Size of the database backup allowed to the stored at a backup destination", "format": "int32", "example": 10 }, "backupTTLInDays": { "minimum": 1, "type": "integer", "description": "Time to live for a database backup copy in the backup destination in days", "format": "int32", "example": 30 }, "numOfReplica": { "minimum": 1, "type": "integer", "description": "Number of replicas of the database backup file", "format": "int32", "example": 2 }, "vmVersion": { "pattern": "^\\d+(\\.\\d+)*$", "type": "string", "description": "vManage software version against which the database backup was taken", "example": "20.9" } }, "$$ref": "#/components/schemas/LocalDestination" }, "downloadURL": { "pattern": "^\\/dataservice\\/tenantbackup\\/download\\/\\d+\\/backup_\\d+_\\d{6}-\\d{6}\\.tar\\.gz$", "type": "string", "description": "Destination to download database backup from", "example": "/dataservice/tenantbackup/download/1570057020772/backup_1570057020772_100919-181838.tar.gz" }, "followerIpAddressList": { "maxItems": 2147483647, "minItems": 1, "type": "array", "description": "List of vManage servers IP address who are running in follower mode", "example": [ "10.0.105.38", "10.0.105.39" ], "items": { "type": "string", "description": "List of vManage servers IP address who are running in follower mode", "example": [ "10.0.105.38", "10.0.105.39" ] } }, "localBackupInfoId": { "pattern": "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}", "type": "string", "description": "A unique UUID per database back up request", "example": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454" }, "scheduleId": { "pattern": "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}", "type": "string", "description": "A unique UUID for scheduled database backup task", "example": "9b08dce2-d33f-11ec-9d64-0242ac120002" }, "srcIpAddress": { "pattern": "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "description": "IP address of the source vmanage server for database backup", "example": "10.0.105.32" }, "taskId": { "pattern": "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}", "type": "string", "description": "Unique task Id for a given database backup task", "example": "f81ee476-d33f-11ec-9d64-0242ac120002" }, "taskName": { "pattern": "^[a-zA-Z0-9 _\\-\\\\\\/]+$", "type": "string", "description": "Task name in human readable format", "example": "Schedule backup on 6/1/2022" } }, "description": "List of all local backup info objects in the system", "$$ref": "#/components/schemas/LocalBackupInfo" } } }, "$$ref": "#/components/schemas/LocalBackupListResult" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "required": [ "code", "details", "message" ], "type": "object", "properties": { "code": { "type": "string", "description": "Error code associated with the error event" }, "details": { "type": "string", "description": "Error message details" }, "message": { "type": "string", "description": "Error message title" } }, "description": "error message", "$$ref": "#/components/schemas/Model400ErrorError" } }, "$$ref": "#/components/schemas/Model400Error" } } } }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/cci/authorize": { "post": { "tags": [ "CCI Authorization Service - CCI Registration" ], "summary": "Login into CCI", "description": "Login into CCI ", "operationId": "cciAuthorize", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "device_code": { "type": "string", "example": "9ba46528-d48f-4c32-a8e4-7abd04a0de60" }, "expires_in": { "type": "integer", "format": "int32", "example": 600 }, "interval": { "type": "integer", "format": "int32", "example": 5 }, "user_code": { "type": "string", "example": "GJZVMNNG" }, "verification_uri": { "type": "string", "example": "https://id.cisco.com/activate" }, "verification_uri_complete": { "type": "string", "example": "https://id.cisco.com/activate?user_code=GJZVMNNG" } }, "$$ref": "#/components/schemas/CciAuthorizeResponse" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/cci/token": { "post": { "tags": [ "CCI Authorization Service - CCI Token" ], "summary": "Get CCI token after Complete CCI Login", "description": "Get CCI token after Complete CCI Login ", "operationId": "cciToken", "parameters": [ { "name": "device_code", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "access_token": { "type": "string", "example": "eyJraWQiOiJKYlVHQ0luVkk1Y2lDY1NUeTBLdlF0QVZoZVRwaV9FME9HUGg2ZkR6Szl3IiwiYWxnIjoiUlMyNTYifQ.eyJ2ZXIiOjEsImp0aSI6IkFULk1EMzFJWndLOEJXSGxweHpiSzU0MXhtQ3gzakllTGZvY1pGZ2Ntb1BxcDgub2FyMjZ3bGQ0NjVsa0JuV0E1ZDciLCJpc3MiOiJodHRwczovL2lkLmNpc2NvLmNvbS9vYXV0aDIvZGVmYXVsdCIsImF1ZCI6ImFwaTovL2RlZmF1bHQiLCJpYXQiOjE3MjA5NjYzMjQsImV4cCI6MTcyMDk2OTkyNCwiY2lkIjoiYTAzNjZmODYtMWRkMi00NmVlLWI1ZmQtZTE4MTgwYWJjYWUyIiwidWlkIjoiMDB1ZHo5MjV4T2VuMm54WVk1ZDYiLCJzY3AiOlsib2ZmbGluZV9hY2Nlc3MiLCJwcm9maWxlIiwib3BlbmlkIl0sImF1dGhfdGltZSI6MTcyMDk2NjI5MSwic3ViIjoic2hpcGh1YW5AY2lzY28uY29tIiwidGVuYW50X25hbWUiOiJjaXNjbyIsImxhc3RfbmFtZSI6Ikh1YW5nIiwicHJlZmVycmVkX3VzZXJuYW1lIjoiZWNiMDQ3NmMtZjNlYi00ODYyLWI3ZmUtODM2NDRlNmNhOGFmIiwiY2NvaWQiOiJzaGlwaHVhbiIsImdpdmVuX25hbWUiOiJTaGlwaW5nIiwiYWNjZXNzX2xldmVsIjo0LCJmdWxsX25hbWUiOiJTaGlwaW5nIEh1YW5nIiwiZW1haWxfYWRkcmVzcyI6InNoaXBodWFuQGNpc2NvLmNvbSIsImZlZGVyYXRlZF9pZCI6InNoaXBodWFuIiwiYXpwIjoiYTAzNjZmODYtMWRkMi00NmVlLWI1ZmQtZTE4MTgwYWJjYWUyIiwiZmFtaWx5X25hbWUiOiJIdWFuZyIsImZpcnN0X25hbWUiOiJTaGlwaW5nIn0.NksdwO3YQflT-6bd53oQ6Rpxqzkbbkw5y9Ooc4xfUMn2KdlJON_5t_Ve336zUBlmxhcyioNwBiAMe09VnBFQr9ROkNw2omfngqQIAZH9QmvKs0YdJr63e4f8l0b1HU6YnB7WaGHnbfIN_s-Y3PfzOyTTVofgsNqLcVdAsB5pqfPn_Ze3sHtZuLqo8xdtau5_aQ4utaVQF13r1ir2mBqag-BD8JjheranncJv28BaYaMG8EeX3bnQUAj3mZbA0Mu8coO83sAdK3RkpnCXXMemq8QQbScYphExMGTF5U-_DtUtn9-XaI7sLOS6AC0-b9mREg9oV2hceemGwoaQYtKp5Q" }, "expires_in": { "type": "integer", "format": "int32", "example": 3600 }, "id_token": { "type": "string", "example": "eyJraWQiOiJKYlVHQ0luVkk1Y2lDY1NUeTBLdlF0QVZoZVRwaV9FME9HUGg2ZkR6Szl3IiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiIwMHVkejkyNXhPZW4ybnhZWTVkNiIsIm5hbWUiOiJTaGlwaW5nIEh1YW5nIiwidmVyIjoxLCJpc3MiOiJodHRwczovL2lkLmNpc2NvLmNvbS9vYXV0aDIvZGVmYXVsdCIsImF1ZCI6ImEwMzY2Zjg2LTFkZDItNDZlZS1iNWZkLWUxODE4MGFiY2FlMiIsImlhdCI6MTcyMDk2NjMyNCwiZXhwIjoxNzIwOTY5OTI0LCJqdGkiOiJJRC5sbEJlZXBKRWFCR3h4b25UOVMtcC1TNG1xWnY4TWVNRnhWa2hqX1RkWjJvIiwiYW1yIjpbInB3ZCJdLCJpZHAiOiIwb2Fqb3Fkd2pZRjFDZEdKdjVkNiIsInByZWZlcnJlZF91c2VybmFtZSI6InNoaXBodWFuQGNpc2NvLmNvbSIsImF1dGhfdGltZSI6MTcyMDk2NjI5MSwiYXRfaGFzaCI6IkRMT0FELXpLb3lZTlNOdGRXTHlkalEiLCJhY2Nlc3NfbGV2ZWwiOjQsImNvdW50cnkiOiJVUyIsInRlbmFudF9uYW1lIjoiY2lzY28iLCJmZWRlcmF0ZWRfaWQiOiJzaGlwaHVhbiIsImVtYWlsX2FkZHJlc3MiOiJzaGlwaHVhbkBjaXNjby5jb20iLCJmdWxsX25hbWUiOiJTaGlwaW5nIEh1YW5nIiwiUGVybWlzc2lvbk5hbWUiOiJPdGhlcnMiLCJsYXN0X25hbWUiOiJIdWFuZyIsImNvbXBhbnkiOiJDaXNjbyBTeXN0ZW1zLCBJbmMuIiwiY2NvaWQiOiJzaGlwaHVhbiIsInRpdGxlIjoiU29mdHdhcmUgRW5naW5lZXJpbmcgVGVjaG5pY2FsIExlYWRlciIsImZpcnN0X25hbWUiOiJTaGlwaW5nIn0.Eo5vNGYbFlSdbBiAwrXhfFoYmxaNwv_2huFXuhdzUzG22gVFQYYjlQbzpQ0-CYYNUBLDH7Dpz424bPHtGSoeNhUwjrtIoSPwl2vFS2Rt6AFo8-hRXROINlqLCrTdfn61PIAolWjCBjseBZNIiVg8oFwxLqtg8HDJ7ipt2UwHCexPIDrlZc_mftT7ElRboIjEs2ypcaePvWfEJkRyhf-GHoDDZs-csDNpyjMS4Y5t9RgOVe5Cp23KCU6sSI5Olw18rrkD3S1mQMmjMD3MM6G2YVgAa1AENdeYQuhBe_Zq8qS3qJGAQ0W7otAQZyyLrXPso0WFrgn0eBn7fG26R7ZsMA" }, "refresh_token": { "type": "string", "example": "GIUCKHBb2AtkT2qW1IerD3yZm8uQdXsPawdBIAKOyVI" }, "scope": { "type": "string", "example": "offline_access profile openid" }, "token_type": { "type": "string", "example": "Bearer" } }, "$$ref": "#/components/schemas/CciToken" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/cdna/sense/{tag}": { "get": { "tags": [ "System - Cloud Service CDNA" ], "description": "Get Sense Service", "operationId": "getCdnaSenseService", "parameters": [ { "name": "tag", "in": "path", "required": true, "schema": { "pattern": "^[a-zA-Z0-9-]*$", "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "html": { "type": "string", "description": "Sense Post Contents", "example": "Documentation for Monitor Overview..." } }, "description": "Dna Sense Response", "$$ref": "#/components/schemas/DnaSenseResponse" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/cdna/server": { "get": { "tags": [ "System - Cloud Service CDNA" ], "description": "Get CDNA Server Details", "operationId": "getCdnaServer", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "type": "object", "properties": { "authToken": { "type": "string" }, "cdnaServerIP": { "type": "string" }, "cline_id": { "type": "string" }, "enrolled": { "type": "boolean" }, "lastUpdated": { "type": "string" }, "member_id": { "type": "string" }, "token_url": { "type": "string" } }, "description": "Enroll CDNA Server Response.", "$$ref": "#/components/schemas/EnrollOTPResponse" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "System - Cloud Service CDNA" ], "description": "Delete CDNA Server Details", "operationId": "deleteCdnaServer", "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "System - Cloud Service CDNA" ], "description": "Enroll CDNA Server with OTP", "operationId": "enrollCdnaServer", "requestBody": { "description": "CDNA OTP Details", "content": { "application/json": { "schema": { "required": [ "token" ], "type": "object", "properties": { "token": { "type": "string" } }, "$$ref": "#/components/schemas/EnrollOTPSettings" } } }, "required": true }, "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "type": "object", "properties": { "authToken": { "type": "string" }, "cdnaServerIP": { "type": "string" }, "cline_id": { "type": "string" }, "enrolled": { "type": "boolean" }, "lastUpdated": { "type": "string" }, "member_id": { "type": "string" }, "token_url": { "type": "string" } }, "description": "Enroll CDNA Server Response.", "$$ref": "#/components/schemas/EnrollOTPResponse" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/certificate/autorenewal/allowed": { "get": { "tags": [ "Certificate Management - Device" ], "summary": "Auto renewal allowed", "description": "Auto renewal allowed", "operationId": "getCertAutoRenewalAllowed", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "Autorenewal Status": { "description": "Autorenewal Status", "value": { "data": [ { "deviceType": "controller", "certType": "pki", "auto-renew": true, "reason": "" }, { "deviceType": "hardwareEdge", "certType": "onbox", "auto-renew": false, "reason": "not valid for onbox" }, { "deviceType": "softwareEdge", "certType": "pki", "auto-renew": false, "reason": "pki server not reachable" } ] }, "$$ref": "#/components/examples/ComViptelaVmanageServerCertificateapiResponseExampleGetcertautorenewalallowedresponse" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/certificate/certdetails": { "post": { "tags": [ "Certificate Management - Device" ], "summary": "get certificaate details", "description": "get certificaate details", "operationId": "getCertDetails", "requestBody": { "description": "Single certificate provided as string in a json formatted request body.", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "Cert Details Request": { "description": "Cert Details Request", "value": { "Certificate": "-----BEGIN CERTIFICATE-----\nMIIFpTCCA40CBHRyVY8wDQYJKoZIhvcNAQELBQAwVDELMAkGA1UEBhMCVVMxLTAr\n...\n...\n6EokqtrKZW8xA3FFYCdittx/l2XYCAr9M7UyqDNoptUHkrDhqT+IaDpheCTVIMqy\nGlv/VtcozeLj\n-----END CERTIFICATE-----" }, "$$ref": "#/components/examples/ComViptelaVmanageServerCertificateapiRequestExamplePostcertdetailsrequest" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "Post Certificate Details Response": { "description": "Post Certificate Details Response", "value": { "CommonName": "vedge-C8K-c27d3c9d-137c-4176-af73-e1afd8e8ccdf-3.viptela.com", "Issuer": "O=Cisco Systems, CN=c947b60a-4c42-48dc-a6f6-8395c17e0465, C=US", "Subject": "EMAILADDRESS=support@viptela.com, CN=vedge-C8K-c27d3c9d-137c-4176-af73-e1afd8e8ccdf-3.viptela.com, O=Cisco Systems, OU=vIPtela Inc Regression, L=San Jose, ST=California, C=US", "SerialNumber": "7472558F", "FingerPrint": "ff13a0524199c35fefbf1e4a497dc4fc7995d99c", "ExpirationDate": "Mon Jul 24 14:38:32 UTC 2034", "Certificate": "-----BEGIN CERTIFICATE-----\nMIIFpTCCA40CBHRyVY8wDQYJKoZIhvcNAQELBQAwVDELMAkGA1UEBhMCVVMxLTAr\n...\n...\n6EokqtrKZW8xA3FFYCdittx/l2XYCAr9M7UyqDNoptUHkrDhqT+IaDpheCTVIMqy\nGlv/VtcozeLj\n-----END CERTIFICATE-----" }, "$$ref": "#/components/examples/ComViptelaVmanageServerCertificateapiResponseExamplePostcertdetailsresponse" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/certificate/controller/bulkcsr": { "post": { "tags": [ "Certificate Management - Device" ], "summary": "Generate CSR for all controller", "description": "Generate CSR for all controller", "operationId": "generateCSRforAllController", "parameters": [ { "name": "csrKeyLength", "in": "query", "description": "Optional Parameter: CSR Key Length", "schema": { "type": "string" }, "examples": { "csrKeyLength": { "description": "csrKeyLength", "value": 4096 } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "Generate Bulk CSR Response": { "description": "Generate Bulk CSR Response", "value": { "status": "success", "Certificate already installed": [ { "uuid": "28fe6700-533c-405c-aa74-7d28fe918303", "deviceType": "vbond" }, { "uuid": "c947b60a-4c42-48dc-a6f6-8395c17e0465", "deviceType": "vmanage" }, { "uuid": "18793543-8e56-4bff-8b1a-f49d729192ec", "deviceType": "vsmart" } ], "Certificate being generated": [], "Certificate failed to be generated": [] }, "$$ref": "#/components/examples/ComViptelaVmanageServerCertificateapiResponseExamplePostcontrollerbulkcsrresponse" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/certificate/controller/certstatus": { "get": { "tags": [ "Certificate Management - Device" ], "summary": "invalidate the device", "description": "invalidate the device", "operationId": "getControllerCertStatus", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "Cert Status": { "description": "Cert Status", "value": { "status": "in_progress", "Certificate already installed": [ { "uuid": "4996ff01-f899-4cc7-91f7-6de2245e9a82", "deviceType": "vbond", "state": "Installed" }, { "uuid": "b9c1a398-3c9a-44b1-898f-e61054af0d53", "deviceType": "vmanage", "state": "vBond Updated" } ], "Certificate being generated": [ { "uuid": "ac5e4500-1825-4a47-9926-f1f447bf6547", "deviceType": "vsmart", "state": "CSR Generated" }, { "uuid": "c78289d6-8b78-4e7d-9d83-617e70e0956b", "deviceType": "vsmart", "state": "CSR Generated" } ], "Certificate failed to be generated": [] }, "$$ref": "#/components/examples/ComViptelaVmanageServerCertificateapiResponseExampleGetcontrollercertstatusresponse" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/certificate/controller/download/csr": { "post": { "tags": [ "Certificate Management - Device" ], "summary": "Download CSR", "description": "Download CSR for given controller devices", "operationId": "downloadControllerCSR", "requestBody": { "description": "List of controller devices", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "Device List": { "description": "Device List", "value": { "chassis-numbers": [ "233497bc-69f7-43fe-a389-28bb719fef14", "671457bc-69f7-43fe-a389-28bb719fef14", "812827bc-69f7-43fe-a389-28bb719fef14" ] }, "$$ref": "#/components/examples/ComViptelaVmanageServerCertificateapiRequestExamplePostcontrollerdownloadcsrrequest" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/certificate/csr/details": { "get": { "tags": [ "Certificate Management - Device" ], "summary": "Get CSR detail view", "description": "Get CSR detail view", "operationId": "getCSRViewRightMenus", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "CSR Details": { "description": "CSR Details", "value": { "header": {}, "data": [ { "name": "View CSR", "type": "certificate", "subtype": "view", "attributes": "CSRDetail", "newWindow": true, "multiSelect": false }, { "name": "View Certificate", "type": "certificate", "subtype": "viewCrt", "attributes": "certificate", "newWindow": true, "multiSelect": false }, { "name": "Generate CSR", "type": "certificate", "subtype": "generate", "attributes": "deviceIP", "newWindow": false, "multiSelect": false, "uri": "dataservice/certificate/generate/csr" }, { "name": "Reset RSA", "type": "certificate", "subtype": "reset", "attributes": "deviceIP", "newWindow": false, "multiSelect": false, "uri": "dataservice/certificate/regenerate/csr" }, { "name": "Edit", "type": "certificate", "subtype": "edit", "attributes": "deviceIP,username,password", "newWindow": false, "multiSelect": false, "uri": "dataservice/certificate/configuration" }, { "name": "Invalid", "type": "certificate", "subtype": "delete", "attributes": "deviceIP", "newWindow": false, "multiSelect": false, "uri": "dataservice/certificate/configuration" } ] }, "$$ref": "#/components/examples/ComViptelaVmanageServerCertificateapiResponseExampleGetcsrdetailsresponse" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/certificate/data/controller/list": { "get": { "tags": [ "Certificate Management - Device" ], "summary": "get controller certificate data", "description": "get controller certificate data", "operationId": "getCertificateControllerListData", "parameters": [ { "name": "requestID", "in": "query", "description": "Request ID parameter", "schema": { "type": "string" }, "examples": { "Empty": { "description": "Empty" }, "requestID": { "description": "requestID", "value": "d65f2b6c-c00a-4432-a87d-d2b6269b01b3" } } }, { "name": "dataObject", "in": "query", "description": "Device property as DataObject parameter", "schema": { "type": "string" }, "examples": { "Empty": { "description": "Empty" }, "UUID": { "description": "UUID", "value": "uuid" }, "Reachability": { "description": "Reachability", "value": "reachability" }, "CSR": { "description": "CSR", "value": "CSR" } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "properties": { "empty": { "type": "boolean" } }, "items": { "type": "string" }, "$$ref": "#/components/schemas/CertificateChain" }, "examples": { "Certificate Data Response": { "description": "Certificate Data Response", "value": { "header": { "columns": [ { "title": "State", "property": "certInstallStatus", "display": "iconAndToolTip", "iconProperty": "certInstallStatus", "toolTipProperty": "certInstallStatus", "hideable": false, "icon": [ { "key": "CSR Generated", "value": "images/certStates/csr-generated.png", "displayKey": "CSR Generated" }, { "key": "CSR Generation Error", "value": "images/certStates/csr-failed.png", "displayKey": "CSR Failed" }, { "key": "Certificate Installation Error", "value": "images/certStates/cert-install-failed.png", "displayKey": "Certificate Installation Failed" }, { "key": "Installed", "value": "images/certStates/cert-installed.png", "displayKey": "Certificate Installed" } ], "width": 40, "minWidth": 40, "dataType": "string" }, { "title": "Operation Status", "property": "state", "colorProperty": "globalState", "color": [ { "key": "Error", "value": "ef5350" } ], "width": 130, "dataType": "string" }, { "title": "Controller Type", "property": "deviceType", "display": "keyvalue", "keyvalueProperty": "deviceType", "hideable": false, "keyvalue": [ { "key": "vsmart", "value": "Controller" }, { "key": "vbond", "value": "Validator" }, { "key": "vmanage", "value": "Manager" }, { "key": "vedge", "value": "WAN Edge" } ], "width": 120, "dataType": "string" }, { "title": "Site Name", "property": "site-name", "hideable": true, "width": 100, "dataType": "string" }, { "title": "Hostname", "property": "host-name", "hideable": true, "width": 100, "dataType": "string" }, { "title": "Config Locked", "property": "device-lock", "visible": true, "width": 80, "dataType": "boolean" }, { "title": "Managed By", "property": "managed-by", "visible": true, "headerTooltip": "This field indicates whether device is being managed by a Configuration-Group, Template, or it is Unmanaged i.e. not managed by either of them. Note: A device that is Unlocked but, managed by a Configuration-Group will become locked again when the Configuration-Group is deployed back to the device.", "width": 160, "dataType": "string" }, { "title": "Device Status", "property": "configStatusMessage", "display": "syncDiffChecker", "visible": true, "minWidth": 150, "dataType": "string" }, { "title": "System IP", "property": "system-ip", "hideable": false, "width": 120, "dataType": "ipv4" }, { "title": "Certificate Serial", "property": "serialNumber", "width": 150, "dataType": "string" }, { "title": "Scheduled renewal date", "property": "certScheduledDate", "width": 100, "dataType": "string" }, { "title": "Certificate Expiration Date", "property": "expirationDate", "width": 100, "dataType": "string" }, { "title": "UUID", "property": "uuid", "width": 270, "dataType": "string" } ], "fields": [ { "property": "certInstallStatus", "dataType": "string", "display": "iconAndToolTip" }, { "property": "state", "dataType": "string" }, { "property": "deviceType", "dataType": "string", "display": "keyvalue" }, { "property": "site-name", "dataType": "string" }, { "property": "host-name", "dataType": "string" }, { "property": "device-lock", "dataType": "boolean" }, { "property": "managed-by", "dataType": "string" }, { "property": "configStatusMessage", "dataType": "string", "display": "syncDiffChecker" }, { "property": "system-ip", "dataType": "ipv4" }, { "property": "serialNumber", "dataType": "string" }, { "property": "certScheduledDate", "dataType": "string" }, { "property": "expirationDate", "dataType": "string" }, { "property": "uuid", "dataType": "string" } ], "viewKeys": { "uniqueKey": [ "chasisNumber" ], "preferenceKey": "grid-certificateControllerDataList" }, "modelNameMapping": { "vAnalytics": "Analytics", "vSmart": "Controller", "vManage": "Manager", "Cloud OnRamp": "Cloud onRamp", "vBond": "Validator" } }, "data": [ { "configuredSiteId": "9", "configuredSystemIP": "10.0.9.1", "deviceType": "vbond", "serialNumber": "3924B97C98E06138F90130FD01DAC5AA0513AE18", "ncsDeviceName": "vbond-2dadd49a-0283-427e-a4c8-f64268796d4f", "configStatusMessage": "In Sync", "templateApplyLog": [ "[7-Oct-2024 3:46:37 UTC] Sync-from successful" ], "uuid": "2dadd49a-0283-427e-a4c8-f64268796d4f", "managementSystemIP": "10.0.9.1", "templateStatus": "Success", "chasisNumber": "2dadd49a-0283-427e-a4c8-f64268796d4f", "configStatusMessageDetails": "", "configOperationMode": "cli", "deviceModel": "vedge-cloud", "deviceState": "READY", "validity": "valid", "platformFamily": "vedge-x86", "hardwareVedge": false, "username": "--", "rootCertHash": "4d910d5dfc928f8b562dfbad4415cdc8bc23b624", "rsaKey4096Compatible": true, "state": "Installed", "globalState": "normal", "valid": "valid", "requestTokenID": "a974fea8-802f-46a2-9ce8-67b5790ef58e", "expirationDate": "Oct 05 03:34:34 2034 GMT", "expirationDateLong": 2043632074000, "deviceIP": "10.0.9.1", "activity": [ "Installed" ], "certInstallStatus": "Installed", "personality": "vbond", "expirationStatus": "normal", "uploadSource": "Auto Discovered", "timeRemainingForExpiration": 315309023525, "solution": "common", "site-id": "9", "host-name": "vb1", "system-ip": "10.0.9.1", "vbond": "10.1.1.9", "vmanageConnectionState": "connected", "local-system-ip": "10.0.9.1", "availableVersions": [], "defaultVersion": "20.17.999-3991", "reachability": "reachable", "version": "20.17.999-3991", "uptime-date": 1728272100000, "model_sku": "None", "lastupdated": 1728325410908, "vmanage-system-ip": "10.0.9.1", "sp-organization-name": "Acme", "organization-name": "Acme", "certScheduledRenewal": "-1", "certScheduledDate": "-1", "lifeCycleRequired": true, "hardwareCertSerialNumber": "NA", "subjectSerialNumber": "NA", "resourceGroup": "global", "id": "NA", "tags": [], "draftMode": "Disabled", "site-name": "SITE_9", "device-lock": "No", "managed-by": "Unmanaged" }, { "configuredSiteId": "10", "configuredSystemIP": "10.0.10.3", "deviceType": "vmanage", "serialNumber": "06B61E554850F7EA85991291D3D1640FE6E68F2A", "ncsDeviceName": "vmanage-03d9aa5c-4899-4858-8ad3-24223d838066", "configStatusMessage": "In Sync", "templateApplyLog": [ "[7-Oct-2024 18:23:13 UTC] Sync-from successful" ], "uuid": "03d9aa5c-4899-4858-8ad3-24223d838066", "managementSystemIP": "10.0.10.3", "templateStatus": "Success", "chasisNumber": "03d9aa5c-4899-4858-8ad3-24223d838066", "configStatusMessageDetails": "", "configOperationMode": "cli", "deviceModel": "vmanage", "deviceState": "READY", "validity": "valid", "platformFamily": "vmanage", "hardwareVedge": false, "username": "--", "rootCertHash": "4d910d5dfc928f8b562dfbad4415cdc8bc23b624", "rsaKey4096Compatible": true, "CSR": "vm", "CSRDetail": "-----BEGIN CERTIFICATE REQUEST-----\nMIICpDCCAYwCAQAwXzELMAkGA1UEBhMCVVMxCzAJBgNVBAgMAkNBMREwDwYDVQQH\nDAhTYW4gSm9zZTENMAsGA1UECwwEQWNtZTEUMBIGA1UECgwLdklQdGVsYSBJbmMx\nCzAJBgNVBAMMAnZtMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArTxK\noEBYTeKUJUioaJP+YqtIomwH0UMkObWOuk5g5B/2Kcp3xc75W+bJQZPymWTyYB3v\njQnNblUMElLGRlry/3FIPXLnVwO4uFnsNOxYZwO3VnaOwsUgwza8wezxwos6mqX2\nsPIIzNPES5CmjseJ2CIponJyh+xEUViBHK8Z+9zMO1uH8OtK1fnoHgeoJ7x2FC19\nqx5isu/SLEYmvOZ0Bn9u01nYuIoZHpW8mAQ18s1NLXI3w16tV90eWcU8IcqXoq0x\nXoskY+2qCVBsy/WFDfOhKzZQ//rJjNcaUy6uNKSOFwI9Ym8PWMUxDF698HuD7G8X\nf6ax79B0BLLuxp/qFQIDAQABoAAwDQYJKoZIhvcNAQELBQADggEBAGcqfifBc6HF\nqWNQy2piZvyapjaWltgkZm9BLcyKcFi9F9HEwlMrKibngnbGLJdSCSP29zQcAJ+x\n4ZcsLUM2vipf/3qIDFe8Y1VbcTrfPpyGz3k+uNgJOd3Y3kq46LCg5y88vOxfOU9s\nvZki3v0v4Aei6IqhE4jBQjXjX6T1dP8VFrFZtm7RlV8OCFzoSrO8KAr1mKH+LcMz\nFcDZ1Awb8mPzSa9W+wt+GfE9lVzK0uJHcMJ7mCfduXEBYLu5crxCuRbm7OlE124e\neURCz9mnlHxnYyd/nvVPb/0ViK50hcvOpRkL0nGVUuXJSR74TgY75t/XVJG2LvNw\n85Bplw5ktAs=\n-----END CERTIFICATE REQUEST-----", "certificateDetail": "-----BEGIN CERTIFICATE-----\nMIIDRTCCAi0CFAa2HlVIUPfqhZkSkdPRZA/m5o8qMA0GCSqGSIb3DQEBCwUAMF8x\nCzAJBgNVBAYTAlVTMQswCQYDVQQIDAJDQTERMA8GA1UEBwwIU2FuIEpvc2UxDTAL\nBgNVBAsMBEFjbWUxFDASBgNVBAoMC3ZJUHRlbGEgSW5jMQswCQYDVQQDDAJjYTAe\nFw0yNDEwMDcwMzM0MzRaFw0zNDEwMDUwMzM0MzRaMF8xCzAJBgNVBAYTAlVTMQsw\nCQYDVQQIDAJDQTERMA8GA1UEBwwIU2FuIEpvc2UxDTALBgNVBAsMBEFjbWUxFDAS\nBgNVBAoMC3ZJUHRlbGEgSW5jMQswCQYDVQQDDAJ2bTCCASIwDQYJKoZIhvcNAQEB\nBQADggEPADCCAQoCggEBAK08SqBAWE3ilCVIqGiT/mKrSKJsB9FDJDm1jrpOYOQf\n9inKd8XO+VvmyUGT8plk8mAd740JzW5VDBJSxkZa8v9xSD1y51cDuLhZ7DTsWGcD\nt1Z2jsLFIMM2vMHs8cKLOpql9rDyCMzTxEuQpo7HidgiKaJycofsRFFYgRyvGfvc\nzDtbh/DrStX56B4HqCe8dhQtfaseYrLv0ixGJrzmdAZ/btNZ2LiKGR6VvJgENfLN\nTS1yN8NerVfdHlnFPCHKl6KtMV6LJGPtqglQbMv1hQ3zoSs2UP/6yYzXGlMurjSk\njhcCPWJvD1jFMQxevfB7g+xvF3+mse/QdASy7saf6hUCAwEAATANBgkqhkiG9w0B\nAQsFAAOCAQEAHdmD6PKZdmxPvjXiaXf6n2j7VPKlP3AYVc/MZbi9QZml5f9hkmiE\nswueFrL6cXIuxc/f3hL7dgUR9hZgmiYmRIQPB5Y1oTVBvponDe1k6ScsdqHpEzTo\n0hRPGV9AQsKClfYiNOTXptrcNTNY5MnqW5oO4pwbSdoSM/iAupIgFFYQjBXQhb2x\n4QMx8BTU/eJDpt2pzXqQh1Rd1obBodFyJSg71QrWWuf3jCnV7FuZHDZOEl0b4OI3\nWz0iMdGwezhHqZtXv6p2lsUi2MInCe5Qi6TzfoNeyF5kks53iEBaJFZSmBH6RIbq\n5WonkNVwLXYF0CrR/x+Qk+h7bEYfABSy4g==\n-----END CERTIFICATE-----", "state": "vBond Updated", "globalState": "normal", "valid": "valid", "requestTokenID": "a50836c2-0f1e-4e98-a6cc-6876047b88ea", "expirationDate": "Oct 05 03:34:34 2034 GMT", "expirationDateLong": 2043632074000, "deviceIP": "10.0.10.3", "activity": [ "vBond Updated" ], "certInstallStatus": "Installed", "servicePersonality": "all", "personality": "vmanage", "expirationStatus": "normal", "uploadSource": "Auto Discovered", "timeRemainingForExpiration": 315309023525, "solution": "common", "site-id": "10", "host-name": "vm", "system-ip": "10.0.10.3", "vbond": "vb.acme.local", "vmanageConnectionState": "connected", "local-system-ip": "10.0.10.3", "availableVersions": [], "defaultVersion": "20.17.999-3991", "reachability": "reachable", "version": "20.17.999-3991", "uptime-date": 1728272040000, "model_sku": "None", "lastupdated": 1728325431653, "vmanage-system-ip": "10.0.10.3", "domain-id": "0", "sp-organization-name": "Acme", "organization-name": "Acme", "certScheduledRenewal": "-1", "certScheduledDate": "-1", "lifeCycleRequired": false, "hardwareCertSerialNumber": "NA", "subjectSerialNumber": "NA", "resourceGroup": "global", "id": "NA", "tags": [], "draftMode": "Disabled", "site-name": "SITE_10", "device-lock": "No", "managed-by": "Unmanaged" }, { "configuredSiteId": "9", "configuredSystemIP": "10.0.9.2", "deviceType": "vsmart", "serialNumber": "3BA49C60C51FA260D3A10106258E7719E9B3446B", "ncsDeviceName": "vsmart-5563d766-8e13-49f2-87d9-39e3bd7e2c98", "configStatusMessage": "In Sync", "templateApplyLog": [ "[7-Oct-2024 3:46:41 UTC] Sync-from successful" ], "uuid": "5563d766-8e13-49f2-87d9-39e3bd7e2c98", "managementSystemIP": "10.0.9.2", "templateStatus": "Success", "chasisNumber": "5563d766-8e13-49f2-87d9-39e3bd7e2c98", "configStatusMessageDetails": "", "configOperationMode": "cli", "deviceModel": "vsmart", "deviceState": "READY", "validity": "valid", "platformFamily": "vsmart", "hardwareVedge": false, "username": "--", "rootCertHash": "4d910d5dfc928f8b562dfbad4415cdc8bc23b624", "rsaKey4096Compatible": true, "state": "vBond Updated", "globalState": "normal", "valid": "valid", "requestTokenID": "9fe50252-9793-4961-859b-c830376fa12c", "expirationDate": "Oct 05 03:34:34 2034 GMT", "expirationDateLong": 2043632074000, "deviceIP": "10.0.9.2", "activity": [ "vBond Updated" ], "certInstallStatus": "Installed", "personality": "vsmart", "expirationStatus": "normal", "uploadSource": "Auto Discovered", "timeRemainingForExpiration": 315309023525, "region-id": [], "solution": "sdwan", "site-id": "9", "host-name": "vs1", "system-ip": "10.0.9.2", "vbond": "vb.acme.local", "vmanageConnectionState": "connected", "policy-template-name": "", "policy-template-version": "", "local-system-ip": "10.0.9.2", "availableVersions": [], "defaultVersion": "20.17.999-3991", "reachability": "reachable", "version": "20.17.999-3991", "uptime-date": 1728272100000, "model_sku": "None", "lastupdated": 1728325439186, "vmanage-system-ip": "10.0.9.2", "domain-id": "1", "sp-organization-name": "Acme", "organization-name": "Acme", "certScheduledRenewal": "-1", "certScheduledDate": "-1", "lifeCycleRequired": false, "hardwareCertSerialNumber": "NA", "subjectSerialNumber": "NA", "resourceGroup": "global", "id": "NA", "tags": [], "draftMode": "Disabled", "site-name": "SITE_9", "device-lock": "No", "managed-by": "Unmanaged" } ] }, "$$ref": "#/components/examples/ComViptelaVmanageServerCertificateapiResponseExampleGetcertcontrollerlistdataresponse" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/certificate/data/vedge/list": { "get": { "tags": [ "Certificate Management - Device" ], "summary": "get vEdge certificate data", "description": "get vEdge certificate data", "operationId": "getCertificateVedgeListData", "parameters": [ { "name": "model", "in": "query", "description": "Device Model", "schema": { "type": "string" }, "examples": { "Empty": { "description": "Empty" }, "C8000v": { "description": "C8000v", "value": "C8000v" }, "ASR1002-HX": { "description": "ASR1002-HX", "value": "ASR1002-HX" }, "C8300-1N1S-4T2X": { "description": "C8300-1N1S-4T2X", "value": "C8300-1N1S-4T2X" } } }, { "name": "state", "in": "query", "description": "Certificate State", "schema": { "type": "string" }, "examples": { "Empty": { "description": "Empty" }, "Token Generated": { "description": "Token Generated", "value": "tokengenerated" }, "Bootstrap Config Generated": { "description": "Bootstrap Config Generated", "value": "bootstrapconfiggenerated" }, "CSR Generated": { "description": "CSR Generated", "value": "csrgenerated" }, "CSR Failed": { "description": "CSR Failed", "value": "csrfailed" }, "Certificate Installed": { "description": "Certificate Installed", "value": "certinstalled" }, "Certificate Installation Failed": { "description": "Certificate Installation Failed", "value": "certinstallfailed" }, "Certificate serial number pushed to controllers": { "description": "Certificate serial number pushed to controllers", "value": "certserialpushedtocontrollers" } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "Vedge Data Response": { "description": "Vedge Data Response", "value": { "header": { "columns": [ { "title": "State", "property": "vedgeCertificateState", "display": "iconAndToolTip", "iconProperty": "vedgeCertificateState", "toolTipProperty": "vedgeCertificateState", "hideable": false, "icon": [ { "key": "tokengenerated", "value": "images/certStates/token-generated.png", "displayKey": "Token Generated" }, { "key": "bootstrapconfiggenerated", "value": "images/certStates/bootstrap-config-generated.png", "displayKey": "Bootstrap Configuration Generated" }, { "key": "csrgenerated", "value": "images/certStates/csr-generated.png", "displayKey": "CSR Generated" }, { "key": "csrfailed", "value": "images/certStates/csr-failed.png", "displayKey": "CSR Failed" }, { "key": "certinstallfailed", "value": "images/certStates/cert-install-failed.png", "displayKey": "Certificate Installation Failed" }, { "key": "certinstalled", "value": "images/certStates/cert-installed.png", "displayKey": "Certificate Installed" } ], "width": 40, "minWidth": 40, "dataType": "string" }, { "title": "Chassis Number", "property": "chasisNumber", "hideable": false, "width": 270, "dataType": "string" }, { "title": "Site Name", "property": "site-name", "hideable": true, "width": 100, "dataType": "string" }, { "title": "Hostname", "property": "host-name", "hideable": true, "width": 100, "dataType": "string" }, { "title": "Tags", "property": "tags", "display": "toggle", "actionColumn": true, "visible": true, "minWidth": 100, "dataType": "string" }, { "title": "Config Locked", "property": "device-lock", "visible": true, "width": 80, "dataType": "boolean" }, { "title": "Managed By", "property": "managed-by", "visible": true, "headerTooltip": "This field indicates whether device is being managed by a Configuration-Group, Template, or it is Unmanaged i.e. not managed by either of them. Note: A device that is Unlocked but, managed by a Configuration-Group will become locked again when the Configuration-Group is deployed back to the device.", "width": 160, "dataType": "string" }, { "title": "Device Status", "property": "configStatusMessage", "display": "syncDiffChecker", "visible": true, "minWidth": 150, "dataType": "string" }, { "title": "Version", "property": "version", "visible": true, "width": 150, "dataType": "string" }, { "title": "Reachability", "property": "reachability", "hideable": true, "visible": true, "dataType": "string" }, { "title": "Certificate Expiration Date", "property": "expirationDate", "width": 100, "dataType": "string" }, { "title": "Scheduled renewal date", "property": "certScheduledDate", "width": 100, "dataType": "string" } ], "fields": [ { "property": "vedgeCertificateState", "dataType": "string", "display": "iconAndToolTip" }, { "property": "chasisNumber", "dataType": "string" }, { "property": "site-name", "dataType": "string" }, { "property": "host-name", "dataType": "string" }, { "property": "tags", "dataType": "string", "display": "toggle" }, { "property": "device-lock", "dataType": "boolean" }, { "property": "managed-by", "dataType": "string" }, { "property": "configStatusMessage", "dataType": "string", "display": "syncDiffChecker" }, { "property": "version", "dataType": "string" }, { "property": "reachability", "dataType": "string" }, { "property": "expirationDate", "dataType": "string" }, { "property": "certScheduledDate", "dataType": "string" } ], "viewKeys": { "uniqueKey": [ "chasisNumber" ], "preferenceKey": "grid-certificateVEdgeDataList" }, "modelNameMapping": { "vAnalytics": "Analytics", "vSmart": "Controller", "vManage": "Manager", "Cloud OnRamp": "Cloud onRamp", "vBond": "Validator" } }, "data": [ { "configuredSiteId": "2", "configuredSystemIP": "10.0.1.2", "deviceType": "vedge", "serialNumber": "79C44D216FF5988E98673D6F51F421A7D2034B79", "ncsDeviceName": "vedge-C8K-ca3dbf94-f29c-415d-bf3a-4d803dc86f84", "configStatusMessage": "In Sync", "templateApplyLog": [ "[7-Oct-2024 3:46:52 UTC] Sync-from successful" ], "uuid": "C8K-ca3dbf94-f29c-415d-bf3a-4d803dc86f84", "managementSystemIP": "10.0.1.2", "templateStatus": "Success", "chasisNumber": "C8K-ca3dbf94-f29c-415d-bf3a-4d803dc86f84", "configStatusMessageDetails": "", "configOperationMode": "cli", "deviceModel": "vedge-C8000V", "deviceState": "READY", "validity": "valid", "platformFamily": "c8000v", "hardwareVedge": false, "username": "--", "rootCertHash": "4d910d5dfc928f8b562dfbad4415cdc8bc23b624", "rsaKey4096Compatible": true, "deviceIP": "10.0.1.2", "personality": "vedge", "uploadSource": "Auto Discovered", "region-id": [], "solution": "sdwan", "site-id": "2", "host-name": "ce1", "system-ip": "10.0.1.2", "vbond": "vb.acme.local", "vmanageConnectionState": "connected", "local-system-ip": "10.0.1.2", "availableVersions": [], "defaultVersion": "17.17.01.0.209545", "reachability": "reachable", "version": "17.17.01.0.209545", "uptime-date": 1728272400000, "model_sku": "None", "lastupdated": 1728320117432, "vmanage-system-ip": "10.0.1.2", "domain-id": "1", "sp-organization-name": "Acme", "organization-name": "Acme", "certScheduledRenewal": "-1", "certScheduledDate": "-1", "lifeCycleRequired": true, "vedgeCertificateState": "certinstalled", "expirationDate": "NA", "hardwareCertSerialNumber": "NA", "subjectSerialNumber": "NA", "resourceGroup": "global", "id": "NA", "tags": [], "draftMode": "Disabled", "site-name": "SITE_2", "device-lock": "No", "managed-by": "Unmanaged" }, { "configuredSiteId": "1", "configuredSystemIP": "10.0.1.1", "deviceType": "vedge", "serialNumber": "0ABF7384D3163E0A53768D374F4A8F22AA49EEF8", "ncsDeviceName": "vedge-064f10fb-e795-45ed-9290-27f20b47a03b", "configStatusMessage": "In Sync", "templateApplyLog": [ "[7-Oct-2024 3:46:32 UTC] Sync-from successful" ], "uuid": "064f10fb-e795-45ed-9290-27f20b47a03b", "managementSystemIP": "10.0.1.1", "templateStatus": "Success", "chasisNumber": "064f10fb-e795-45ed-9290-27f20b47a03b", "configStatusMessageDetails": "", "configOperationMode": "cli", "deviceModel": "vedge-cloud", "deviceState": "READY", "validity": "valid", "platformFamily": "vedge-x86", "hardwareVedge": false, "username": "--", "rootCertHash": "4d910d5dfc928f8b562dfbad4415cdc8bc23b624", "rsaKey4096Compatible": false, "deviceIP": "10.0.1.1", "personality": "vedge", "uploadSource": "Auto Discovered", "region-id": [], "solution": "sdwan", "site-id": "1", "host-name": "ve1", "system-ip": "10.0.1.1", "vbond": "vb.acme.local", "vmanageConnectionState": "connected", "local-system-ip": "10.0.1.1", "availableVersions": [], "defaultVersion": "20.9.6-862", "reachability": "reachable", "version": "20.9.6-862", "uptime-date": 1728272040000, "model_sku": "None", "lastupdated": 1728320114735, "vmanage-system-ip": "10.0.1.1", "domain-id": "1", "sp-organization-name": "Acme", "organization-name": "Acme", "certScheduledRenewal": "-1", "certScheduledDate": "-1", "lifeCycleRequired": true, "vedgeCertificateState": "certinstalled", "expirationDate": "NA", "hardwareCertSerialNumber": "NA", "subjectSerialNumber": "NA", "resourceGroup": "global", "id": "NA", "tags": [], "draftMode": "Disabled", "site-name": "SITE_1", "device-lock": "No", "managed-by": "Unmanaged" } ] }, "$$ref": "#/components/examples/ComViptelaVmanageServerCertificateapiResponseExampleGetcertvedgelistdataresponse" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/certificate/device/details": { "get": { "tags": [ "Certificate Management - Device" ], "summary": "Get device detail view", "description": "Get device detail view", "operationId": "getDeviceViewRightMenus", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "Device Details": { "description": "Device Details", "value": { "header": {}, "data": [ { "name": "Edit accountInfo", "type": "certificate", "subtype": "edit", "attributes": "deviceIP,username,password", "newWindow": false, "multiSelect": false, "uri": "dataservice/certificate/configuration" }, { "name": "Delete", "type": "certificate", "subtype": "delete", "attributes": "deviceIP", "newWindow": false, "multiSelect": false, "uri": "dataservice/certificate/configuration" } ] }, "$$ref": "#/components/examples/ComViptelaVmanageServerCertificateapiResponseExampleGetdevicedetailsresponse" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/certificate/device/invalidate": { "post": { "tags": [ "Certificate Management - Device" ], "summary": "invalidate the device", "description": "invalidate the device", "operationId": "invalidateDevice", "requestBody": { "description": "Device UUID", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Payload": { "description": "Payload", "value": { "chasisNumber": "C8K-f4423f04-355b-4c22-b6de-76f8d3e651b4", "deviceIP": "172.16.255.15" }, "$$ref": "#/components/examples/ComViptelaVmanageServerCertificateapiRequestExamplePostdeviceinvalidaterequest" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "Task ID": { "description": "Task ID", "value": { "id": "b2b7525d-b68e-4ac3-962a-49d521352272" }, "$$ref": "#/components/examples/ComViptelaVmanageServerCertificateapiResponseExamplePostdeviceinvalidateresponse" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/certificate/device/list": { "get": { "tags": [ "Certificate Management - Device" ], "summary": "get device list", "description": "get device list", "operationId": "getDevicesList", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "Device List": { "description": "Device List", "value": { "header": { "columns": [ { "title": "Device IP", "property": "deviceIP", "dataType": "ipv4" }, { "title": "Device type", "property": "deviceType", "display": "keyvalue", "keyvalueProperty": "deviceType", "keyvalue": [ { "key": "vsmart", "value": "vSmart" }, { "key": "vbond", "value": "vBond" }, { "key": "vmanage", "value": "vManage" }, { "key": "vedge", "value": "WAN Edge" } ], "dataType": "string" }, { "title": "Username", "property": "username", "dataType": "string" }, { "title": "Password", "property": "password", "dataType": "string" } ], "fields": [ { "property": "deviceIP", "dataType": "ipv4" }, { "property": "deviceType", "dataType": "string", "display": "keyvalue" }, { "property": "username", "dataType": "string" }, { "property": "password", "dataType": "string" } ], "viewKeys": { "uniqueKey": [], "preferenceKey": "grid-deviceList" }, "modelNameMapping": { "vAnalytics": "Analytics", "vSmart": "Controller", "vManage": "Manager", "Cloud OnRamp": "Cloud onRamp", "vBond": "Validator" } }, "data": [ { "configuredSystemIP": "172.16.255.26", "deviceType": "vbond", "serialNumber": "12345984", "ncsDeviceName": "vbond-4996ff01-f899-4cc7-91f7-6de2245e9a82", "configStatusMessage": "In Sync", "templateApplyLog": [ "[5-Jun-2024 10:50:31 UTC] Sync-from successful" ], "uuid": "4996ff01-f899-4cc7-91f7-6de2245e9a82", "managementSystemIP": "172.16.255.26", "templateStatus": "Success", "chasisNumber": "4996ff01-f899-4cc7-91f7-6de2245e9a82", "configStatusMessageDetails": "", "configOperationMode": "cli", "deviceModel": "vedge-cloud", "deviceState": "READY", "validity": "valid", "platformFamily": "vedge-x86", "hardwareVedge": false, "username": "--", "rootCertHash": "9d291b7674ea8fe9b98d440b82df7627b040d691", "state": "Installed", "globalState": "normal", "valid": "valid", "requestTokenID": "af515aba-bf25-4dcc-bd89-4befc088a0f6", "expirationDate": "Jun 05 10:01:14 2025 GMT", "expirationDateLong": 1749117674000, "deviceIP": "172.16.255.26", "activity": [ "Installed" ], "state_vedgeList": "Sync", "certInstallStatus": "Installed", "personality": "vbond", "expirationStatus": "normal", "uploadSource": "Auto Discovered", "timeRemainingForExpiration": 31155712243, "solution": "common", "host-name": "vm16", "system-ip": "172.16.255.26", "vbond": "10.0.12.26", "vmanageConnectionState": "connected", "local-system-ip": "172.16.255.26", "availableVersions": [], "defaultVersion": "20.15.0-72", "reachability": "reachable", "version": "20.15.0-72", "uptime-date": 1717581000000, "model_sku": "None", "lastupdated": 1718044157324, "vmanage-system-ip": "172.16.255.26", "sp-organization-name": "vIPtela Inc Regression", "organization-name": "vIPtela Inc Regression", "lifeCycleRequired": true, "hardwareCertSerialNumber": "NA", "subjectSerialNumber": "NA", "resourceGroup": "global", "id": "NA", "tags": [], "draftMode": "Disabled", "device-lock": "No", "managed-by": "Unmanaged" }, { "configuredSiteId": "100", "configuredSystemIP": "172.16.255.21", "deviceType": "vedge", "serialNumber": "12345981", "ncsDeviceName": "vedge-41e0bb86-6328-49be-88ad-87c70c1d4406", "configStatusMessage": "In Sync", "templateApplyLog": [ "[5-Jun-2024 10:57:02 UTC] Sync-from successful" ], "uuid": "41e0bb86-6328-49be-88ad-87c70c1d4406", "managementSystemIP": "172.16.255.21", "templateStatus": "Success", "chasisNumber": "41e0bb86-6328-49be-88ad-87c70c1d4406", "configStatusMessageDetails": "", "configOperationMode": "cli", "deviceModel": "vedge-cloud", "deviceState": "READY", "validity": "valid", "platformFamily": "vedge-x86", "hardwareVedge": false, "username": "--", "rootCertHash": "9d291b7674ea8fe9b98d440b82df7627b040d691", "deviceIP": "172.16.255.21", "personality": "vedge", "uploadSource": "Auto Discovered", "region-id": [], "solution": "sdwan", "site-id": "100", "host-name": "vm11", "system-ip": "172.16.255.21", "vbond": "vbond", "vmanageConnectionState": "connected", "local-system-ip": "172.16.255.21", "availableVersions": [], "defaultVersion": "20.9.5-802", "reachability": "reachable", "version": "20.9.5-802", "uptime-date": 1717580940000, "model_sku": "None", "lastupdated": 1718044934590, "vmanage-system-ip": "172.16.255.21", "domain-id": "1", "sp-organization-name": "vIPtela Inc Regression", "organization-name": "vIPtela Inc Regression", "lifeCycleRequired": true, "vedgeCertificateState": "certinstalled", "expirationDate": "NA", "hardwareCertSerialNumber": "NA", "subjectSerialNumber": "NA", "resourceGroup": "global", "id": "NA", "tags": [], "draftMode": "Disabled", "site-name": "SITE_100", "device-lock": "No", "managed-by": "Unmanaged" }, { "configuredSiteId": "100", "configuredSystemIP": "172.16.255.11", "deviceType": "vedge", "serialNumber": "12345979", "ncsDeviceName": "vedge-6b09a9b9-e242-4a65-8bed-0ff500e0c0a4", "configStatusMessage": "In Sync", "templateApplyLog": [ "[5-Jun-2024 10:57:04 UTC] Sync-from successful" ], "uuid": "6b09a9b9-e242-4a65-8bed-0ff500e0c0a4", "managementSystemIP": "172.16.255.11", "templateStatus": "Success", "chasisNumber": "6b09a9b9-e242-4a65-8bed-0ff500e0c0a4", "configStatusMessageDetails": "", "configOperationMode": "cli", "deviceModel": "vedge-cloud", "deviceState": "READY", "validity": "valid", "platformFamily": "vedge-x86", "hardwareVedge": false, "username": "--", "rootCertHash": "9d291b7674ea8fe9b98d440b82df7627b040d691", "deviceIP": "172.16.255.11", "personality": "vedge", "uploadSource": "Auto Discovered", "region-id": [], "solution": "sdwan", "site-id": "100", "host-name": "vm1", "system-ip": "172.16.255.11", "vbond": "vbond", "vmanageConnectionState": "connected", "local-system-ip": "172.16.255.11", "availableVersions": [], "defaultVersion": "20.9.5-802", "reachability": "reachable", "version": "20.9.5-802", "uptime-date": 1717580940000, "model_sku": "None", "lastupdated": 1718044934642, "vmanage-system-ip": "172.16.255.11", "domain-id": "1", "sp-organization-name": "vIPtela Inc Regression", "organization-name": "vIPtela Inc Regression", "lifeCycleRequired": true, "vedgeCertificateState": "certinstalled", "expirationDate": "NA", "hardwareCertSerialNumber": "NA", "subjectSerialNumber": "NA", "resourceGroup": "global", "id": "NA", "tags": [], "draftMode": "Disabled", "site-name": "SITE_100", "device-lock": "No", "managed-by": "Unmanaged" }, { "configuredSiteId": "600", "configuredSystemIP": "172.16.255.16", "deviceType": "vedge", "serialNumber": "12345989", "ncsDeviceName": "vedge-5ac9b75d-7e8d-4e19-9664-8f3746eefe22", "configStatusMessage": "In Sync", "templateApplyLog": [ "[5-Jun-2024 10:58:31 UTC] Sync-from successful" ], "uuid": "5ac9b75d-7e8d-4e19-9664-8f3746eefe22", "managementSystemIP": "172.16.255.16", "templateStatus": "Success", "chasisNumber": "5ac9b75d-7e8d-4e19-9664-8f3746eefe22", "configStatusMessageDetails": "", "configOperationMode": "cli", "deviceModel": "vedge-cloud", "deviceState": "READY", "validity": "valid", "platformFamily": "vedge-x86", "hardwareVedge": false, "username": "--", "rootCertHash": "9d291b7674ea8fe9b98d440b82df7627b040d691", "deviceIP": "172.16.255.16", "personality": "vedge", "uploadSource": "Auto Discovered", "region-id": [], "solution": "sdwan", "site-id": "600", "host-name": "vm6", "system-ip": "172.16.255.16", "vbond": "vbond", "vmanageConnectionState": "connected", "local-system-ip": "172.16.255.16", "availableVersions": [], "defaultVersion": "20.9.5-802", "reachability": "reachable", "version": "20.9.5-802", "uptime-date": 1717581000000, "model_sku": "None", "lastupdated": 1718044934684, "vmanage-system-ip": "172.16.255.16", "domain-id": "1", "sp-organization-name": "vIPtela Inc Regression", "organization-name": "vIPtela Inc Regression", "lifeCycleRequired": true, "vedgeCertificateState": "certinstalled", "expirationDate": "NA", "hardwareCertSerialNumber": "NA", "subjectSerialNumber": "NA", "resourceGroup": "global", "id": "NA", "tags": [], "draftMode": "Disabled", "site-name": "SITE_600", "device-lock": "No", "managed-by": "Unmanaged" }, { "configuredSiteId": "400", "configuredSystemIP": "172.16.255.14", "deviceType": "vedge", "serialNumber": "12345987", "ncsDeviceName": "vedge-20d50c50-84bf-497b-a6ba-00b9b465719b", "configStatusMessage": "In Sync", "templateApplyLog": [ "[5-Jun-2024 10:52:33 UTC] Sync-from successful" ], "uuid": "20d50c50-84bf-497b-a6ba-00b9b465719b", "managementSystemIP": "172.16.255.14", "templateStatus": "Success", "chasisNumber": "20d50c50-84bf-497b-a6ba-00b9b465719b", "configStatusMessageDetails": "", "configOperationMode": "cli", "deviceModel": "vedge-cloud", "deviceState": "READY", "validity": "valid", "platformFamily": "vedge-x86", "hardwareVedge": false, "username": "--", "rootCertHash": "9d291b7674ea8fe9b98d440b82df7627b040d691", "deviceIP": "172.16.255.14", "personality": "vedge", "uploadSource": "Auto Discovered", "region-id": [], "solution": "sdwan", "site-id": "400", "host-name": "vm4", "system-ip": "172.16.255.14", "vbond": "vbond", "vmanageConnectionState": "connected", "local-system-ip": "172.16.255.14", "availableVersions": [], "defaultVersion": "20.9.5-802", "reachability": "reachable", "version": "20.9.5-802", "uptime-date": 1717581000000, "model_sku": "None", "lastupdated": 1718044934557, "vmanage-system-ip": "172.16.255.14", "domain-id": "1", "sp-organization-name": "vIPtela Inc Regression", "organization-name": "vIPtela Inc Regression", "lifeCycleRequired": true, "vedgeCertificateState": "certinstalled", "expirationDate": "NA", "hardwareCertSerialNumber": "NA", "subjectSerialNumber": "NA", "resourceGroup": "global", "id": "NA", "tags": [], "draftMode": "Disabled", "site-name": "SITE_400", "device-lock": "No", "managed-by": "Unmanaged" }, { "configuredSiteId": "500", "configuredSystemIP": "172.16.255.15", "deviceType": "vedge", "serialNumber": "ACC7F622", "ncsDeviceName": "vedge-C8K-f4423f04-355b-4c22-b6de-76f8d3e651b4", "configStatusMessage": "In Sync", "templateApplyLog": [ "[5-Jun-2024 10:57:33 UTC] Sync-from successful" ], "uuid": "C8K-f4423f04-355b-4c22-b6de-76f8d3e651b4", "managementSystemIP": "172.16.255.15", "templateStatus": "Success", "chasisNumber": "C8K-f4423f04-355b-4c22-b6de-76f8d3e651b4", "configStatusMessageDetails": "", "configOperationMode": "cli", "deviceModel": "vedge-C8000V", "deviceState": "READY", "validity": "staging", "platformFamily": "c8000v", "hardwareVedge": false, "username": "--", "vedgeCertificateState": "certinstalled", "vedgeCSR": "-----BEGIN CERTIFICATE REQUEST-----\nMIIFWjCCA0ICAQAwgdkxCzAJBgNVBAYTAlVTMRMwEQYDVQQIEwpDYWxpZm9ybmlh\nMREwDwYDVQQHEwhTYW4gSm9zZTEfMB0GA1UECxMWdklQdGVsYSBJbmMgUmVncmVz\nc2lvbjEWMBQGA1UEChMNQ2lzY28gU3lzdGVtczFFMEMGA1UEAxM8dmVkZ2UtQzhL\nLWY0NDIzZjA0LTM1NWItNGMyMi1iNmRlLTc2ZjhkM2U2NTFiNC0yLnZpcHRlbGEu\nY29tMSIwIAYJKoZIhvcNAQkBFhNzdXBwb3J0QHZpcHRlbGEuY29tMIICIjANBgkq\nhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEAsecU6s4Vozo0jsGH24mLuvt3H+PQ9yK/\noYGPoPQaULTV1f3TpAjvIyr1FXMZw5b2hVeHEQaNNFJm/7T2FAY2kbIeQ2Cvbno4\ny5H8aAYKBor95LlXVG5bS+UdB4rCFm4/EfQvoZ4FNT38IYisYMxEfXShrmyRWIJw\na3cm3OIZRy8SoG/Lnotffk1/v46dC+lRN4R7aFCAw8iIMdgj+aL+qEAK2LquSrmT\nN6Wv+bCnWxR6avcumVKmCcDSUnVkFbECynKQ41OA99qbR7BsLrOnjcMwkbwylBK4\ngZByF5k4QIxA9pUhudONyLgm3BVmN5uzz9wF2K6H2GblB0eoTvdkNsw7vfnlCdrA\n9Ttj7/jzGk9BVHrJz+pFLUgzJxQjuwsgI6nyzY0/s+mvHAErjpMM7LaXtYplixA3\nZAiZ4hEgCiltbBxTsdk59+uEE+TiV8KF5+61HiKGhte7aTVitti28Iu4H6dJHST3\nwUbpofdAg+zBrrLREZZ+T6/6zJC2+L3Up3qSH+vTx92U2F5Fm06/WrB7J6r02T2K\nJBF6oVy2+WmbH9KwZiIs6YDYX//xG/7Yz90fc9vvKougg6sMbiDdu70DCmS80nBc\npthQpZLrSmZjuLxCtqES5ZFIZVD94Z+emtV3xzWaJqijbNfdVD8yFfZ7FlWquBD9\ndIampyLmRHUCAwEAAaA7MDkGCSqGSIb3DQEJDjEsMCowCQYDVR0TBAIwADAdBgNV\nHQ4EFgQUDaA3QY5i1gaNN7S0XoTAjuHkxRcwDQYJKoZIhvcNAQELBQADggIBAG6b\nFUGtsnbkgq6pyyKbsKDTIWnT/SkVCgvfsp4ZfoMhzjV3A8vLqAwoymJUdlHnHtsa\namLUKNdkHaPyQ3JDTzKuuyTso0ZdlkEsWENXh/CtSbk9buVmO75HyWgwvrvIE9h3\nJ2E3RUKdGX4H3fsR0HDVnF/T9r8WOzpFaRqMrA5wdJEbV9mIM7St01SWnFlLxYg0\nbYKAgIzS1kfkH6fE3OPjl65OsPUinvJ0w0DVj0f7Sv6sK4Eh5jeM8ldfgXvlNS/x\nHEV0Ui2+Md0nhibpwxuNwa5LC8P5Xj7Bk7dBjvH5Ij/n7gNto1qaipG/2cw7tx07\naZDca9Dn+wBM7e8ngTkyRi9PEzId5K+CaW3AMhcLb5g3K8nU21rhvK5Ui7irsYi7\ng2mJ/qGWaQ5aByFWVq/SxSM+/moIsVekXwu449DuJSYOdEP3B9OZOVGVJW2TUFNp\nZoUKO+twdiUBJf3QHxGOpgb9AUqrerPPwvJlyc62vkwaZEAwFFT1qyh6i7dGnO3y\nRpXHt6N+a/4l76IJywtbSUsLUKHZJbm0R3qJpVDfnWjzJr0H5NoKPDrcwpnnFMi1\ns95rUV0rvbn1WfmEBd8UAHNnI0/D3nUeSEb3En/ZVcwYqiIXsdniBdUhi5nu1tp0\nb1LcHdhlVZ8+v2/2AwJmNuwMMJ9lbTA53eiq4M0b\n-----END CERTIFICATE REQUEST-----", "vedgeCSRCommonName": "vedge-C8K-f4423f04-355b-4c22-b6de-76f8d3e651b4-2.viptela.com", "rootCertHash": "9d291b7674ea8fe9b98d440b82df7627b040d691", "state": "Installed", "globalState": "normal", "expirationDate": "Jun 08 18:24:32 2034 UTC", "expirationDateLong": 2033403872000, "deviceIP": "172.16.255.15", "activity": [ "[10-Jun-2024 18:24:31 UTC] CSR Generated" ], "certInstallStatus": "Installed", "personality": "vedge", "expirationStatus": "normal", "uploadSource": "Auto Discovered", "region-id": [], "solution": "sdwan", "site-id": "500", "host-name": "vm5", "system-ip": "172.16.255.15", "vbond": "vbond", "vmanageConnectionState": "connected", "local-system-ip": "172.16.255.15", "availableVersions": [], "defaultVersion": "17.15.01.0.1138", "reachability": "reachable", "version": "17.15.01.0.1138", "uptime-date": 1717581240000, "model_sku": "None", "lastupdated": 1718044960772, "vmanage-system-ip": "172.16.255.15", "domain-id": "1", "sp-organization-name": "vIPtela Inc Regression", "organization-name": "vIPtela Inc Regression", "lifeCycleRequired": true, "hardwareCertSerialNumber": "NA", "subjectSerialNumber": "NA", "resourceGroup": "global", "id": "NA", "tags": [], "draftMode": "Disabled", "site-name": "SITE_500", "device-lock": "No", "managed-by": "Unmanaged" }, { "configuredSiteId": "200", "configuredSystemIP": "172.16.255.22", "deviceType": "vmanage", "serialNumber": "12345982", "ncsDeviceName": "vmanage-b9c1a398-3c9a-44b1-898f-e61054af0d53", "configStatusMessage": "In Sync", "templateApplyLog": [ "[5-Jun-2024 19:24:39 UTC] Sync-from successful" ], "uuid": "b9c1a398-3c9a-44b1-898f-e61054af0d53", "managementSystemIP": "0.0.0.0", "templateStatus": "Success", "chasisNumber": "b9c1a398-3c9a-44b1-898f-e61054af0d53", "configStatusMessageDetails": "", "configOperationMode": "cli", "deviceModel": "vmanage", "deviceState": "READY", "validity": "valid", "platformFamily": "vmanage", "hardwareVedge": false, "username": "--", "rootCertHash": "9d291b7674ea8fe9b98d440b82df7627b040d691", "CSR": "vmanage-b9c1a398-3c9a-44b1-898f-e61054af0d53-0.viptela.com", "CSRDetail": "-----BEGIN CERTIFICATE REQUEST-----\nMIIFWDCCA0ACAQAwgdcxCzAJBgNVBAYTAlVTMRMwEQYDVQQIEwpDYWxpZm9ybmlh\nMREwDwYDVQQHEwhTYW4gSm9zZTEfMB0GA1UECxMWdklQdGVsYSBJbmMgUmVncmVz\nc2lvbjEWMBQGA1UEChMNQ2lzY28gU3lzdGVtczFDMEEGA1UEAxM6dm1hbmFnZS1i\nOWMxYTM5OC0zYzlhLTQ0YjEtODk4Zi1lNjEwNTRhZjBkNTMtMC52aXB0ZWxhLmNv\nbTEiMCAGCSqGSIb3DQEJARYTc3VwcG9ydEB2aXB0ZWxhLmNvbTCCAiIwDQYJKoZI\nhvcNAQEBBQADggIPADCCAgoCggIBAL1wL+bOdUCDQlPDDf9Q1L69hgHaFFC146OS\n9rbrhOgUtx597GCfI/tAs1cNwQhK8SB4cqu81AYtaGAtx/G9YbqiHOzvlPrptq+l\nXSjDvd9zQ3n4dkpNqdrh0Xe9XVZLnDTFEU2N9XhW8MUgtogH61y3nYBZq1/3Hq5s\n4ol2Kf5mJrgJSqDiyAPXQ+ro5+LgNk2453LC3PdU60E5bGzUwmCp1yPDIJIMLv7X\nFdAxmKV6uRhQZ7nMy1PEf9y64r308v+sEH1dOAfss2vHgj5EdYAYlzxTwsLAGVQU\nF2oOINjGgb+ck+PhCoUnOlShuFNk/Dh8OVIxKG2G/eBFOlL6W1n+bqFyUir6tpPU\nRJS1Wvg5pemYQulOAhE5Tpd2NNo+vyS8qjvovzoz+RfkG/4X3au/sdbyqgpwBJ5T\n8g7JOptr0Cm+HFrFbjO2QDFxO2SMrFqp32VGVcKm7sq4/wwrUm2rtYyKkaLKEHtJ\nj0keBeLcH/ECWaVJaJZeIvkZcrHcq2p1VKvtU1VXqxM/r0cV1A0Aj0A+WVQd8riJ\nmDV8Xs80sh93aDEi1O7qSypCmp5/FGRHg/A0gczfFTujIKVYFR89AJZsNDV0isSG\n11TkGldS1Oer5z/INsQmOmoZfdc5oM7CwTfDsJsmbtc0sMwsPHSyHGps8TxKCTIo\nhEybO99tAgMBAAGgOzA5BgkqhkiG9w0BCQ4xLDAqMAkGA1UdEwQCMAAwHQYDVR0O\nBBYEFOKAD4L167hyM2euFepYF63R0qe9MA0GCSqGSIb3DQEBCwUAA4ICAQC2GCcv\nG/+QyLKgrQgnzM8msnr1B6ZJGqwfHh/IgAoXhwQuc24sQX6kFuU8Ii8bJIZo5w+9\nXDy3ofLHAGCVmCNgsydeDpl1XpRoSjVTN9kXwKPQffgydipgwQq2/qPv//msXBSc\nNlKpyExtz6Ak8iGlrCg6wA/JRdL0ZSP8Ul4xlChgrBRYhBGB9qtZmD2xLafVpEfU\nfLduwWDWuGtYuQsil/fr56QPselH+lQEVGij5YY7mZNMbTrAbNEfuEbt5LjCOCvU\n8RfnW884VmodTW47OsTbLq2NaNZZmvIGHCQCqBVHFPJF1oSqpP5ttexqB0WLSi1M\nnNnIImTPDsoPwoFqZCIlpbmwmsvQCqssUsIeE3XiE09cUBO0Bfl9ZVBMmKRG+uMy\n/pC1ekaN8iTi62w8I0epu5tCoZZlMRnoXvmPf171iV8uH3I1aV6rGpk+xR1qx818\nftUPGFo7ic/c7qeUIw3m53Q/5oe+8LrL5sMHu2Tb2e7cgdyFeCYTxBZL3yPiti5m\n5ZDbm+jxF4IHw3VZMbk2LLnGx2tGkGJAjLL4BNq+UNFzi/T0p2KYbIqVXdRHq7Ts\nSHPTSs3L4mQ7hU7lfbycidcPT27Itn0ujcRVVt3+RQEN3IFb0JLdVmFgxmZWCDw4\nM9hnrkP6AaRdF3bIIPKqLZGumhFYGjoALed+eQ==\n-----END CERTIFICATE REQUEST-----", "certificateDetail": "-----BEGIN CERTIFICATE-----\nMIIEzDCCA7QCBBI0WYIwDQYJKoZIhvcNAQELBQAwgaAxCzAJBgNVBAYTAlVTMRMw\nEQYDVQQIEwpDYWxpZm9ybmlhMREwDwYDVQQHEwhTYW4gSm9zZTEVMBMGA1UECxMM\ndklQdGVsYSBUZXN0MRQwEgYDVQQKEwt2SVB0ZWxhIEluYzEiMCAGCSqGSIb3DQEJ\nARYTc2FudG9zaEB2aXB0ZWxhLmNvbTEYMBYGA1UEAxMPdmlwdGVsYS50ZXN0YmVk\nMB4XDTI0MDYwNTEwMDEwMFoXDTI1MDYwNTEwMDEwMFowgbMxETAPBgNVBAcTCFNh\nbiBKb3NlMQswCQYDVQQGEwJVUzETMBEGA1UECBMKQ2FsaWZvcm5pYTEWMBQGA1UE\nChMNQ2lzY28gU3lzdGVtczEfMB0GA1UECxMWdklQdGVsYSBJbmMgUmVncmVzc2lv\nbjFDMEEGA1UEAxM6dm1hbmFnZS1iOWMxYTM5OC0zYzlhLTQ0YjEtODk4Zi1lNjEw\nNTRhZjBkNTMtMC52aXB0ZWxhLmNvbTCCAiIwDQYJKoZIhvcNAQEBBQADggIPADCC\nAgoCggIBAL1wL+bOdUCDQlPDDf9Q1L69hgHaFFC146OS9rbrhOgUtx597GCfI/tA\ns1cNwQhK8SB4cqu81AYtaGAtx/G9YbqiHOzvlPrptq+lXSjDvd9zQ3n4dkpNqdrh\n0Xe9XVZLnDTFEU2N9XhW8MUgtogH61y3nYBZq1/3Hq5s4ol2Kf5mJrgJSqDiyAPX\nQ+ro5+LgNk2453LC3PdU60E5bGzUwmCp1yPDIJIMLv7XFdAxmKV6uRhQZ7nMy1PE\nf9y64r308v+sEH1dOAfss2vHgj5EdYAYlzxTwsLAGVQUF2oOINjGgb+ck+PhCoUn\nOlShuFNk/Dh8OVIxKG2G/eBFOlL6W1n+bqFyUir6tpPURJS1Wvg5pemYQulOAhE5\nTpd2NNo+vyS8qjvovzoz+RfkG/4X3au/sdbyqgpwBJ5T8g7JOptr0Cm+HFrFbjO2\nQDFxO2SMrFqp32VGVcKm7sq4/wwrUm2rtYyKkaLKEHtJj0keBeLcH/ECWaVJaJZe\nIvkZcrHcq2p1VKvtU1VXqxM/r0cV1A0Aj0A+WVQd8riJmDV8Xs80sh93aDEi1O7q\nSypCmp5/FGRHg/A0gczfFTujIKVYFR89AJZsNDV0isSG11TkGldS1Oer5z/INsQm\nOmoZfdc5oM7CwTfDsJsmbtc0sMwsPHSyHGps8TxKCTIohEybO99tAgMBAAEwDQYJ\nKoZIhvcNAQELBQADggEBAMHgRtjukf9B++NcGLCxHc9oYva/tf1frBZF//AnIVeB\nzp12l0IvKWEVYxP4PTxYM6wJvtQ/pGfTyS9Vj5Cve4Di7qaAV8Z6Yh3W2nwhqU9v\nRoGraPyWPDSP+T0F5DKaUsqLX/eZhLHAJzZrb2l+cxW6dJ8Fk73AbtL3ce2uhPyn\nbewIqpp6P3M9aEXTyjLjd7b40MkFmlachB6K9W3wBD1VCPvRemrtqxjwA8HFe+IB\nbjtVDKA4qt87PBkIGe3wUnZPFPQAQylP9goEkRQeYeflxfsORmfAvzTYVSE3s4X6\nwwoFAFex+vrl4meXszrSx9k6Z/9MX7XuKocp7F3U9B4=\n-----END CERTIFICATE-----", "state": "vBond Updated", "globalState": "normal", "valid": "valid", "requestTokenID": "495c2bc5-59e9-4902-94e8-3a30fb0a335a", "expirationDate": "Jun 05 10:01:00 2025 GMT", "expirationDateLong": 1749117660000, "deviceIP": "172.16.255.22", "activity": [ "vBond Updated" ], "state_vedgeList": "Sync", "certInstallStatus": "Installed", "org": "vIPtela Inc Regression", "servicePersonality": "all", "personality": "vmanage", "expirationStatus": "normal", "timeRemainingForExpiration": 31155698243, "solution": "common", "site-id": "200", "host-name": "vm12", "system-ip": "172.16.255.22", "vbond": "vbond", "vmanageConnectionState": "connected", "local-system-ip": "172.16.255.22", "availableVersions": [], "defaultVersion": "20.15.0-72", "reachability": "reachable", "version": "20.15.0-72", "uptime-date": 1717581240000, "model_sku": "None", "lastupdated": 1718044936506, "vmanage-system-ip": "172.16.255.22", "domain-id": "0", "sp-organization-name": "vIPtela Inc Regression", "organization-name": "vIPtela Inc Regression", "lifeCycleRequired": false, "hardwareCertSerialNumber": "NA", "subjectSerialNumber": "NA", "resourceGroup": "global", "id": "NA", "tags": [], "draftMode": "Disabled", "site-name": "SITE_200", "device-lock": "No", "managed-by": "Unmanaged" }, { "configuredSiteId": "200", "configuredSystemIP": "172.16.255.20", "deviceType": "vsmart", "serialNumber": "12345980", "ncsDeviceName": "vsmart-ac5e4500-1825-4a47-9926-f1f447bf6547", "configStatusMessage": "In Sync", "templateApplyLog": [ "[5-Jun-2024 10:52:30 UTC] Sync-from successful" ], "uuid": "ac5e4500-1825-4a47-9926-f1f447bf6547", "managementSystemIP": "172.16.255.20", "templateStatus": "Success", "chasisNumber": "ac5e4500-1825-4a47-9926-f1f447bf6547", "configStatusMessageDetails": "", "configOperationMode": "cli", "deviceModel": "vsmart", "deviceState": "READY", "validity": "valid", "platformFamily": "vsmart", "hardwareVedge": false, "username": "--", "deviceCSR": "-----BEGIN CERTIFICATE REQUEST-----\nMIIFVzCCAz8CAQAwgdYxCzAJBgNVBAYTAlVTMRMwEQYDVQQIEwpDYWxpZm9ybmlh\nMREwDwYDVQQHEwhTYW4gSm9zZTEfMB0GA1UECxMWdklQdGVsYSBJbmMgUmVncmVz\nc2lvbjEWMBQGA1UEChMNQ2lzY28gU3lzdGVtczFCMEAGA1UEAxM5dnNtYXJ0LWFj\nNWU0NTAwLTE4MjUtNGE0Ny05OTI2LWYxZjQ0N2JmNjU0Ny00LnZpcHRlbGEuY29t\nMSIwIAYJKoZIhvcNAQkBFhNzdXBwb3J0QHZpcHRlbGEuY29tMIICIjANBgkqhkiG\n9w0BAQEFAAOCAg8AMIICCgKCAgEAwP78InDVuqDltQmoSZDRbknLmuTS2UqkgePS\nB4KO4RkJtT5bK4myLqFfxXBUjjOREwxl5xykN8kMwYb22iglEBltxbOqGf26pMN9\nF130XaVrQDOLuRbTOFkGDOwlKcLGlu6CzJ2n+QVR+5i9mlfRxgwlg+y7xcz/3HEI\nJX1BxABb1XI50jRr94CrlIiR1QoW/tdGOnsdfKmwq70m4TrIa/wd0N5hksUAB56D\nrUkObMrfTLNe2mTcVSluqVzD2IFYooBs0ici0v10yubDjhccA8+sWfFK3SKSRoMs\nNX3SDWO0OZZcHkVNb3wXNYwMuajr04Wpr8lzsZXrC/E5xYA6WMyeD9QiyAqNAKlV\nFTgwbR6/5H5CurvpGpIELMe05oDNVLnbgznfUaprDgV9HRKebYfbPs6Mo1rn21fn\nvt/8Pmi/1JHagW243SHpgQG0JF15nfHKTAdQLVpttpAPW9sWmrqcsmDQVNBeKjVd\nM7HdZCsG6Z2pezGNX0HQ29el920axPKykO+u9k5ZDT7cPdXyFEJkMOBk9i0kIyGU\nTDXZRKKfAFoUky5LewiAyuUcQ6AYNGVd+9Ggp5uzdg6diB7deS38XvcmpkabtwcZ\nv27/xgPhLrEdvP+VucocSV1gM/CyF8/+ce17nq0vZkI9S2Dubpq1qk36x64AO04o\nFFOZ2q8CAwEAAaA7MDkGCSqGSIb3DQEJDjEsMCowCQYDVR0TBAIwADAdBgNVHQ4E\nFgQU+rJs6xy2mZHlUVrPTWKAt5QhRfYwDQYJKoZIhvcNAQELBQADggIBAAju5c2E\nbnp55SmJqCLOJkgV1aWYMVJFV+5NmT5aPHQcr80HYDA4//cj+ABKCf8xxnnZfuqk\nsADhARTH8BxPTKQ2FYKIaZiIwlQ8vh9jb3JcKUAcqs1yrwSoemYTzUJpZ6JIu9XT\nw7G7dj0IEaJPYvul8D0LJjpW++6bARTqox1LRx6PUvlQKh2SYvUZP+H24xFxG4Ha\n9rnLGMyxEvriRjr3DkJDSiFehDQSZeBqfunP5mZdhURg8a0MR7ZcwBenJGLrvGqR\nLguCsHT1Y75kUOJf6pH/fqN+4cBrkW4x9FWfEu4ZL8koGhrJjsat8ypPheIqZ5Uz\nTH0Wc2IHlVyA5ex+sFJ59q0qh3+qa5TBNewHpyq6So8Kh9V5n3KrmnAjP/7t8+y3\nGeO0bMr1MjVKCWrp4jHma8xvW27ZWu3QBv3LD5iS9GXP/iVIFAsDsm5l7G0MFZMF\nzvlOFktgy78ENziFzGhauSM0+zrFfWAsMEPkPM3RGXT/UsY89gKx+Q/E3L+AyF0h\n6Lx/0w1qEQv+XtbFjM3GNvNE/iuAyn40/oDPmEP3fPlHkfyBRsxDd/a0DZQHaL47\nmxjr/dC7wNOsO1FN02/hav9laYFAY9AqJeqdHXuTVAm7PElAZnZx6+HnxzNrhJSw\nA+JRUuAJreZpuMfEU/U/gEF4ETavwAfjStLb\n-----END CERTIFICATE REQUEST-----", "deviceCSRCommonName": "vsmart-ac5e4500-1825-4a47-9926-f1f447bf6547-4.viptela.com", "rootCertHash": "9d291b7674ea8fe9b98d440b82df7627b040d691", "state": "CSR Generated", "globalState": "normal", "valid": "valid", "requestTokenID": "b38e49c6-a5a6-4895-a2dc-f5859cb92c2c", "expirationDate": "Jun 05 10:00:56 2025 GMT", "expirationDateLong": 1749117656000, "deviceIP": "172.16.255.20", "activity": [ "[10-Jun-2024 18:32:42 UTC] CSR Generated" ], "state_vedgeList": "Sync", "certInstallStatus": "Installed", "personality": "vsmart", "expirationStatus": "normal", "uploadSource": "Auto Discovered", "timeRemainingForExpiration": 31155694243, "region-id": [], "solution": "sdwan", "site-id": "200", "host-name": "vm10", "system-ip": "172.16.255.20", "vbond": "vbond", "vmanageConnectionState": "connected", "policy-template-name": "", "policy-template-version": "", "local-system-ip": "172.16.255.20", "availableVersions": [], "defaultVersion": "20.15.0-72", "reachability": "reachable", "version": "20.15.0-72", "uptime-date": 1717581000000, "model_sku": "None", "lastupdated": 1718044932764, "vmanage-system-ip": "172.16.255.20", "domain-id": "1", "sp-organization-name": "vIPtela Inc Regression", "organization-name": "vIPtela Inc Regression", "lifeCycleRequired": false, "hardwareCertSerialNumber": "NA", "subjectSerialNumber": "NA", "resourceGroup": "global", "id": "NA", "tags": [], "draftMode": "Disabled", "site-name": "SITE_200", "device-lock": "No", "managed-by": "Unmanaged" }, { "configuredSiteId": "100", "configuredSystemIP": "172.16.255.19", "deviceType": "vsmart", "serialNumber": "1234", "oldSerialNumber": "{\"serialNumber\":\"1234\",\"validity\":\"valid\",\"deviceEnterpriseCertificate\":\"-----BEGIN CERTIFICATE-----\\nMIIGhDCCBGygAwIBAgICEjUwDQYJKoZIhvcNAQELBQAwgZAxCzAJBgNVBAYTAlVT\\nMRMwEQYDVQQIDApDYWxpZm9ybmlhMREwDwYDVQQHDAhTYW4gSm9zZTEOMAwGA1UE\\nCwwFTGFiQ0ExFDASBgNVBAoMC1ZpcHRlbGEgTExDMSAwHgYJKoZIhvcNAQkBFhFz\\ndXBwb3J0QGxhYmNhLmNvbTERMA8GA1UEAwwITGFiQ0EgQ0EwHhcNMjQwNjA1MTg1\\nMTI5WhcNMjUwNjA1MTg1MTI5WjCBwzELMAkGA1UEBhMCVVMxEzARBgNVBAgTCkNh\\nbGlmb3JuaWExFjAUBgNVBAoTDUNpc2NvIFN5c3RlbXMxHzAdBgNVBAsTFnZJUHRl\\nbGEgSW5jIFJlZ3Jlc3Npb24xQjBABgNVBAMTOXZzbWFydC1jNzgyODlkNi04Yjc4\\nLTRlN2QtOWQ4My02MTdlNzBlMDk1NmItMS52aXB0ZWxhLmNvbTEiMCAGCSqGSIb3\\nDQEJARYTc3VwcG9ydEB2aXB0ZWxhLmNvbTCCAiIwDQYJKoZIhvcNAQEBBQADggIP\\nADCCAgoCggIBAJ4JxIe0hxP5mNUeGrgkkqQ8Gvw1gdRpYC6hlY5360ybUinA/CWy\\n4TTm1H9BNzaYLi1cOd7bGMk3iAISbgULdLO3SH6QpkZdkPBiJcp2mBerwKiNSZ9x\\nSb7W5PGToep4yPoIUf13ASG97V5/GkSQJYpouxoXDJlhjZ5W15csshPduJH5iOij\\nAAR0XyytsVMCfFSIIZZKLYoJFkOfNokrW1ybb+dyrXI40SGgxeyLCV8EmyLcWrAB\\n4ziY2snJYhP5o7XmEu4YrIq1NyHpxwms4kMf7hzCODU9IBXjIodpWF1oXyPyYctP\\nRZvUh8VWWjcgQx0IlBybTsaD6Zr4BMX2JVBdMkvOSHvRNwH5IAjCH8fy35rWE2rr\\nM4XYqBGhEmAtSPmEsbxRPc1ffOy9GSz3jmKvUI9rnblLnQq1oNttpCKHbUPeEimO\\nUEDrHSHKBmd1ugkXPC10/5SYt1J6ordXLEPVVzMwujtL0HmhNAB5/XUd5TotUh+O\\nlc+jHG/UEm0P5zeD6OpqJshZ1Jz9YF1Vsd96YJEufBd5sZol0qyk1D23j4rqxF9t\\ngNaKMPTyBCvRTPR6Ce7/hzQrxP0RxKXELKxBYRxFb7Tl5zkbnCykB10Tfb1gblr/\\neFlUtxJHSBOBrM6IkOZBBYkuXYaoZCgPUy0c48sgvvJ8SlsCNF8DVyTZAgMBAAGj\\ngbIwga8wDwYDVR0TAQH/BAUwAwIBADARBglghkgBhvhCAQEEBAMCBeAwCwYDVR0P\\nBAQDAgXgMDwGA1UdJQQ1MDMGCCsGAQUFBwMBBggrBgEFBQcDAgYIKwYBBQUHAwMG\\nCCsGAQUFBwMEBgkrBgEEAQkVAgcwHQYDVR0OBBYEFBgHSKM9PTHfb1lEvTeEtGj+\\nw0NGMB8GA1UdIwQYMBaAFHNl4af93NNImjKlfNspypmYwZHvMA0GCSqGSIb3DQEB\\nCwUAA4ICAQCMo1XLxGvq0qgTKSvAoP25w8SCSbQwmw/tdIwSfg5p9aU6fY/nxCZs\\nSlJMBx13ykC0YRHFOwXf4ecoZyfx9YYV6+qWAk7kIkFc/9USDu2zAjyMsVCVa7ek\\neAvwb+ioiJN/6VrzZxrCyMRNAwzMJdmPI4K2QhnCv95jXUQqUVYQy8mFFeZj1ccf\\nZo1EQ3DPSrB8zK3DNDXMO5JhAfDTVmTrPJWIEhxkVOBvJylvzz5iBtTgnYSAdR1L\\naa6miri/siMkHn6wDmTK/3IP/wa92SKxUtPAeIErvNOwD9PYIusTNBV9ublWfUN4\\n+qNMZXB792p4VMe+NHokldseDQ53P75obtMy2piePblFb0LIqZ8wv/J3SCJLXDDN\\nzQCQiRy6WtQgIdQ5hOWec5eDjXRn8MZnSyTrXPCkZqdPCKkqxR7wMeuMhPqmnAMc\\nium6adRvxTqwtd4Afo8v6aisYvU3cY4ckgHCEE2nXc7gTbqq9DS4OT4pk3jJmQ8H\\nALp3ESuzlV6XP5an47u8K6qD0k29lS+mA+4MSbIkdgFGq0MpNV1xuobpiP5GV9Cy\\nLGmOcy8z15jt4JGN958OrkvBWnxLwIyXsu/tpm96M5BDMmpRYZ6IRqrL2gQmK+92\\nLNzLb+Pqol02wxwX5Ljw4+kALXLX4pEQW3vfcvAUaWChxzuHcy4HnQ==\\n-----END CERTIFICATE-----\\n\"}", "ncsDeviceName": "vsmart-c78289d6-8b78-4e7d-9d83-617e70e0956b", "configStatusMessage": "In Sync", "templateApplyLog": [ "[5-Jun-2024 10:52:32 UTC] Sync-from successful" ], "uuid": "c78289d6-8b78-4e7d-9d83-617e70e0956b", "managementSystemIP": "172.16.255.19", "templateStatus": "Success", "chasisNumber": "c78289d6-8b78-4e7d-9d83-617e70e0956b", "configStatusMessageDetails": "", "configOperationMode": "cli", "deviceModel": "vsmart", "deviceState": "READY", "validity": "invalid", "platformFamily": "vsmart", "hardwareVedge": false, "username": "--", "deviceCSR": "-----BEGIN CERTIFICATE REQUEST-----\nMIIFVzCCAz8CAQAwgdYxCzAJBgNVBAYTAlVTMRMwEQYDVQQIEwpDYWxpZm9ybmlh\nMREwDwYDVQQHEwhTYW4gSm9zZTEfMB0GA1UECxMWdklQdGVsYSBJbmMgUmVncmVz\nc2lvbjEWMBQGA1UEChMNQ2lzY28gU3lzdGVtczFCMEAGA1UEAxM5dnNtYXJ0LWM3\nODI4OWQ2LThiNzgtNGU3ZC05ZDgzLTYxN2U3MGUwOTU2Yi0yLnZpcHRlbGEuY29t\nMSIwIAYJKoZIhvcNAQkBFhNzdXBwb3J0QHZpcHRlbGEuY29tMIICIjANBgkqhkiG\n9w0BAQEFAAOCAg8AMIICCgKCAgEAngnEh7SHE/mY1R4auCSSpDwa/DWB1GlgLqGV\njnfrTJtSKcD8JbLhNObUf0E3NpguLVw53tsYyTeIAhJuBQt0s7dIfpCmRl2Q8GIl\nynaYF6vAqI1Jn3FJvtbk8ZOh6njI+ghR/XcBIb3tXn8aRJAlimi7GhcMmWGNnlbX\nlyyyE924kfmI6KMABHRfLK2xUwJ8VIghlkotigkWQ582iStbXJtv53KtcjjRIaDF\n7IsJXwSbItxasAHjOJjaycliE/mjteYS7hisirU3IenHCaziQx/uHMI4NT0gFeMi\nh2lYXWhfI/Jhy09Fm9SHxVZaNyBDHQiUHJtOxoPpmvgExfYlUF0yS85Ie9E3Afkg\nCMIfx/LfmtYTauszhdioEaESYC1I+YSxvFE9zV987L0ZLPeOYq9Qj2uduUudCrWg\n222kIodtQ94SKY5QQOsdIcoGZ3W6CRc8LXT/lJi3Unqit1csQ9VXMzC6O0vQeaE0\nAHn9dR3lOi1SH46Vz6Mcb9QSbQ/nN4Po6momyFnUnP1gXVWx33pgkS58F3mxmiXS\nrKTUPbePiurEX22A1oow9PIEK9FM9HoJ7v+HNCvE/RHEpcQsrEFhHEVvtOXnORuc\nLKQHXRN9vWBuWv94WVS3EkdIE4GszoiQ5kEFiS5dhqhkKA9TLRzjyyC+8nxKWwI0\nXwNXJNkCAwEAAaA7MDkGCSqGSIb3DQEJDjEsMCowCQYDVR0TBAIwADAdBgNVHQ4E\nFgQUGAdIoz09Md9vWUS9N4S0aP7DQ0YwDQYJKoZIhvcNAQELBQADggIBAF66zA4x\n2n2E/uhMCLl7vEnLnBTk6Lvi7VkjRc7a1ElmkXhhlb3vdPzkg/AXEl3aUpr5LzD7\nAwLoBD3cnR/WJTHKbgdZ3tt6TT3W5OM1T/O4zIJfmBKezg0YJ6gfCy3rN230yA8v\nt+VQWqCHIdFHraER86LXahFZ2ftJF3eJkx/1jE09ZMaa8nc59bv7Pkh3XEkjc0pD\n/SPVzUB1iV6e3dOS8qfyGFLycZet/NXLKJZ/WtDjhcwn3a2xEkNmxu/utWlRY/7e\nunKQLfPJeyp0tdy9VhmR5Sx2ugz6LktDuLwlaADC5QvOfq1HoGUMBrPWOsDGsi2u\nfMC1z42UTBRAhRdZT9+yW4zLYCs+6RLIyU1TMK1blKKMtK1GmpyhgEXofAfGRk/G\n0fZGDJz4tgd+87x9EqaJejP6kh2fquyJBVtgdjaNlPcVYFWHO+Baohyz02+sFXnr\nca1T6QlLHv21SKRJGlA4Jn4+RDSlU+ZF9L2qVJr4e8pQkFUxnpReRbcRYrbbsIvh\n3M7bEWN8pwhkNe+1MWOccxrG6pUhiGKNFX0WQk1qIR2X6Fiqzjjlw4m05PgEdVEK\nu2T6f1H5RMp/Jjv7MHTwkKbJDMNwT+A6ZsX9j12Ul0Zg0KikjmYhpbQSTS1I2yEY\ni4pQPhbIEE/4IgfEnRI7hGJgD3ma43N3+OD3\n-----END CERTIFICATE REQUEST-----", "deviceEnterpriseCertificate": "-----BEGIN CERTIFICATE-----\nMIIGhDCCBGygAwIBAgICEjUwDQYJKoZIhvcNAQELBQAwgZAxCzAJBgNVBAYTAlVT\nMRMwEQYDVQQIDApDYWxpZm9ybmlhMREwDwYDVQQHDAhTYW4gSm9zZTEOMAwGA1UE\nCwwFTGFiQ0ExFDASBgNVBAoMC1ZpcHRlbGEgTExDMSAwHgYJKoZIhvcNAQkBFhFz\ndXBwb3J0QGxhYmNhLmNvbTERMA8GA1UEAwwITGFiQ0EgQ0EwHhcNMjQwNjA1MTg1\nMTI5WhcNMjUwNjA1MTg1MTI5WjCBwzELMAkGA1UEBhMCVVMxEzARBgNVBAgTCkNh\nbGlmb3JuaWExFjAUBgNVBAoTDUNpc2NvIFN5c3RlbXMxHzAdBgNVBAsTFnZJUHRl\nbGEgSW5jIFJlZ3Jlc3Npb24xQjBABgNVBAMTOXZzbWFydC1jNzgyODlkNi04Yjc4\nLTRlN2QtOWQ4My02MTdlNzBlMDk1NmItMS52aXB0ZWxhLmNvbTEiMCAGCSqGSIb3\nDQEJARYTc3VwcG9ydEB2aXB0ZWxhLmNvbTCCAiIwDQYJKoZIhvcNAQEBBQADggIP\nADCCAgoCggIBAJ4JxIe0hxP5mNUeGrgkkqQ8Gvw1gdRpYC6hlY5360ybUinA/CWy\n4TTm1H9BNzaYLi1cOd7bGMk3iAISbgULdLO3SH6QpkZdkPBiJcp2mBerwKiNSZ9x\nSb7W5PGToep4yPoIUf13ASG97V5/GkSQJYpouxoXDJlhjZ5W15csshPduJH5iOij\nAAR0XyytsVMCfFSIIZZKLYoJFkOfNokrW1ybb+dyrXI40SGgxeyLCV8EmyLcWrAB\n4ziY2snJYhP5o7XmEu4YrIq1NyHpxwms4kMf7hzCODU9IBXjIodpWF1oXyPyYctP\nRZvUh8VWWjcgQx0IlBybTsaD6Zr4BMX2JVBdMkvOSHvRNwH5IAjCH8fy35rWE2rr\nM4XYqBGhEmAtSPmEsbxRPc1ffOy9GSz3jmKvUI9rnblLnQq1oNttpCKHbUPeEimO\nUEDrHSHKBmd1ugkXPC10/5SYt1J6ordXLEPVVzMwujtL0HmhNAB5/XUd5TotUh+O\nlc+jHG/UEm0P5zeD6OpqJshZ1Jz9YF1Vsd96YJEufBd5sZol0qyk1D23j4rqxF9t\ngNaKMPTyBCvRTPR6Ce7/hzQrxP0RxKXELKxBYRxFb7Tl5zkbnCykB10Tfb1gblr/\neFlUtxJHSBOBrM6IkOZBBYkuXYaoZCgPUy0c48sgvvJ8SlsCNF8DVyTZAgMBAAGj\ngbIwga8wDwYDVR0TAQH/BAUwAwIBADARBglghkgBhvhCAQEEBAMCBeAwCwYDVR0P\nBAQDAgXgMDwGA1UdJQQ1MDMGCCsGAQUFBwMBBggrBgEFBQcDAgYIKwYBBQUHAwMG\nCCsGAQUFBwMEBgkrBgEEAQkVAgcwHQYDVR0OBBYEFBgHSKM9PTHfb1lEvTeEtGj+\nw0NGMB8GA1UdIwQYMBaAFHNl4af93NNImjKlfNspypmYwZHvMA0GCSqGSIb3DQEB\nCwUAA4ICAQCMo1XLxGvq0qgTKSvAoP25w8SCSbQwmw/tdIwSfg5p9aU6fY/nxCZs\nSlJMBx13ykC0YRHFOwXf4ecoZyfx9YYV6+qWAk7kIkFc/9USDu2zAjyMsVCVa7ek\neAvwb+ioiJN/6VrzZxrCyMRNAwzMJdmPI4K2QhnCv95jXUQqUVYQy8mFFeZj1ccf\nZo1EQ3DPSrB8zK3DNDXMO5JhAfDTVmTrPJWIEhxkVOBvJylvzz5iBtTgnYSAdR1L\naa6miri/siMkHn6wDmTK/3IP/wa92SKxUtPAeIErvNOwD9PYIusTNBV9ublWfUN4\n+qNMZXB792p4VMe+NHokldseDQ53P75obtMy2piePblFb0LIqZ8wv/J3SCJLXDDN\nzQCQiRy6WtQgIdQ5hOWec5eDjXRn8MZnSyTrXPCkZqdPCKkqxR7wMeuMhPqmnAMc\nium6adRvxTqwtd4Afo8v6aisYvU3cY4ckgHCEE2nXc7gTbqq9DS4OT4pk3jJmQ8H\nALp3ESuzlV6XP5an47u8K6qD0k29lS+mA+4MSbIkdgFGq0MpNV1xuobpiP5GV9Cy\nLGmOcy8z15jt4JGN958OrkvBWnxLwIyXsu/tpm96M5BDMmpRYZ6IRqrL2gQmK+92\nLNzLb+Pqol02wxwX5Ljw4+kALXLX4pEQW3vfcvAUaWChxzuHcy4HnQ==\n-----END CERTIFICATE-----", "deviceCSRCommonName": "vsmart-c78289d6-8b78-4e7d-9d83-617e70e0956b-2.viptela.com", "rootCertHash": "9d291b7674ea8fe9b98d440b82df7627b040d691", "state": "CSR Generated", "globalState": "normal", "valid": "valid", "requestTokenID": "5631356f-f19c-42c0-bcaf-8e570db7de90", "expirationDate": "Jun 05 18:51:05 2025 GMT", "expirationDateLong": 1749149465000, "deviceIP": "172.16.255.19", "activity": [ "[10-Jun-2024 18:33:39 UTC] CSR Generated" ], "state_vedgeList": "Sync", "certInstallStatus": "Installed", "personality": "vsmart", "expirationStatus": "normal", "uploadSource": "Auto Discovered", "timeRemainingForExpiration": 31187503243, "region-id": [], "solution": "sdwan", "site-id": "100", "host-name": "vm9", "system-ip": "172.16.255.19", "vbond": "vbond", "vmanageConnectionState": "connected", "policy-template-name": "", "policy-template-version": "", "local-system-ip": "172.16.255.19", "availableVersions": [], "defaultVersion": "20.15.0-72", "reachability": "reachable", "version": "20.15.0-72", "uptime-date": 1717581060000, "model_sku": "None", "lastupdated": 1718044932936, "vmanage-system-ip": "172.16.255.19", "domain-id": "1", "sp-organization-name": "vIPtela Inc Regression", "organization-name": "vIPtela Inc Regression", "lifeCycleRequired": false, "hardwareCertSerialNumber": "NA", "subjectSerialNumber": "NA", "resourceGroup": "global", "id": "NA", "tags": [], "draftMode": "Disabled", "site-name": "SITE_100", "device-lock": "No", "managed-by": "Unmanaged" } ] }, "$$ref": "#/components/examples/ComViptelaVmanageServerCertificateapiResponseExampleGetdevicelistresponse" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/certificate/device/stage": { "post": { "tags": [ "Certificate Management - Device" ], "summary": "Stop data traffic to device", "description": "Stop data traffic to device", "operationId": "stageDevice", "requestBody": { "description": "Payload", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Payload": { "description": "Payload", "value": { "chasisNumber": "C8K-f4423f04-355b-4c22-b6de-76f8d3e651b4", "deviceIP": "172.16.255.15" }, "$$ref": "#/components/examples/ComViptelaVmanageServerCertificateapiRequestExamplePostdevicestagerequest" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "Task ID": { "description": "Task ID", "value": { "id": "b2b7525d-b68e-4ac3-962a-49d521352272" }, "$$ref": "#/components/examples/ComViptelaVmanageServerCertificateapiResponseExamplePostdevicestageresponse" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/certificate/enterprise/estclient/gencsr": { "post": { "tags": [ "Certificate Management - vManage" ], "summary": "Generate CSR of EST proxy client", "description": "Generate CSR of EST proxy client", "operationId": "enterpriseESTClientGenCSR", "requestBody": { "description": "Payload", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Gen CSR Payload": { "description": "Gen CSR Payload", "value": { "company_name": "abc", "org_unit": "abc", "org": "abc", "city": "abc", "state": "abc", "country": "IN", "email": "abc@cisco.com", "subject_alternative_name_dns": [ "" ], "subject_alternative_name_uri": [ "" ] }, "$$ref": "#/components/examples/ComViptelaVmanageServerCertificateapiRequestExamplePostenterpriseestclientgencsrrequest" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "Gen CSR Response": { "description": "Gen CSR Response", "value": { "status": "success", "csrDetails": "-----BEGIN CERTIFICATE REQUEST-----\nMIICtDCCAZwCAQAwUzEMMAoGA1UEAwwDYWJjMQswCQYDVQQGEwJJTjEMMAoGA1UE\nCAwDYWJjMQwwCgYDVQQHDANhYmMxDDAKBgNVBAoMA2FiYzEMMAoGA1UECwwDYWJj\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArnPatRDaE3Q2g5Y/JLRY\nWEdFPjgqMD1jBPiEYatPpKnn0Xd+bCidc5+OC+hboX8R8KZr55eii+3Li3PVXKKP\ndyOoJS+rn9NLE3fP+c9QFXBoALOdVG+GrxEHBHDvO92hHv9sRaI77WmHSw7kDf8J\nKmvuumaRbLHB1LukYkhx0wDy6HyKBvXwyIrdDdVH4izYQn6FqZcohYCBd4COLr3E\nDTaEjT7mJFS/mdNtowq6IPgnRV0eD1+Eusok1q2r3MKR+mvCdS9N2ps+ukss5Ryc\nYU7Wanq4HNpsWiC6neRvdFmPZNnipTDJhCqItsJEs5e4MkQTuLEA7aECJlxvzo4K\nHwIDAQABoBwwGgYJKoZIhvcNAQkOMQ0wCzAJBgNVHREEAjAAMA0GCSqGSIb3DQEB\nBQUAA4IBAQCtzk9qwB3KutcMdSeKGnJIg2emvvpcl2Myzk4xCk1Z2R/8VeC8R9Su\nJTBC62ptohWglAiePUMA284ieDnQYdg9BDQCJyK9Mi9dEcaa5u50XZkk9Xon5w9U\nCuwahOEDUm23RBCuXWfzZJA5Jj4oAu24Y0zIQFeUoUqsDO5GoBgrRPU3MxtCKu+J\n5xlYgvfLVDUAYvpQzGkiufbbJBSj49yidchQX9H/ub+qzLSl9sXv6eGiH7BRGVTD\ng8Yhk3ik0n8GZrtXep89utFRwL+oWwe2QpJR0WffL0eyyxegjkWkMhHkoCdHKVay\nvCiN1B07UUqgyR0Yya30Y4QL4Li6w/IS\n-----END CERTIFICATE REQUEST-----" }, "$$ref": "#/components/examples/ComViptelaVmanageServerCertificateapiResponseExamplePostenterpriseestclientgencsrresponse" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/certificate/enterprise/estclient/getcsr": { "get": { "tags": [ "Certificate Management - vManage" ], "summary": "Get generated CSR for EST proxy client", "description": "Get generated CSR for EST proxy client", "operationId": "enterpriseESTClientGetCSR", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "Success": { "description": "Success", "value": { "status": "success", "csrDetails": "-----BEGIN CERTIFICATE REQUEST-----\nMIICtDCCAZwCAQAwUzEMMAoGA1UEAwwDYWJjMQswCQYDVQQGEwJJTjEMMAoGA1UE\nCAwDYWJjMQwwCgYDVQQHDANhYmMxDDAKBgNVBAoMA2FiYzEMMAoGA1UECwwDYWJj\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArnPatRDaE3Q2g5Y/JLRY\nWEdFPjgqMD1jBPiEYatPpKnn0Xd+bCidc5+OC+hboX8R8KZr55eii+3Li3PVXKKP\ndyOoJS+rn9NLE3fP+c9QFXBoALOdVG+GrxEHBHDvO92hHv9sRaI77WmHSw7kDf8J\nKmvuumaRbLHB1LukYkhx0wDy6HyKBvXwyIrdDdVH4izYQn6FqZcohYCBd4COLr3E\nDTaEjT7mJFS/mdNtowq6IPgnRV0eD1+Eusok1q2r3MKR+mvCdS9N2ps+ukss5Ryc\nYU7Wanq4HNpsWiC6neRvdFmPZNnipTDJhCqItsJEs5e4MkQTuLEA7aECJlxvzo4K\nHwIDAQABoBwwGgYJKoZIhvcNAQkOMQ0wCzAJBgNVHREEAjAAMA0GCSqGSIb3DQEB\nBQUAA4IBAQCtzk9qwB3KutcMdSeKGnJIg2emvvpcl2Myzk4xCk1Z2R/8VeC8R9Su\nJTBC62ptohWglAiePUMA284ieDnQYdg9BDQCJyK9Mi9dEcaa5u50XZkk9Xon5w9U\nCuwahOEDUm23RBCuXWfzZJA5Jj4oAu24Y0zIQFeUoUqsDO5GoBgrRPU3MxtCKu+J\n5xlYgvfLVDUAYvpQzGkiufbbJBSj49yidchQX9H/ub+qzLSl9sXv6eGiH7BRGVTD\ng8Yhk3ik0n8GZrtXep89utFRwL+oWwe2QpJR0WffL0eyyxegjkWkMhHkoCdHKVay\nvCiN1B07UUqgyR0Yya30Y4QL4Li6w/IS\n-----END CERTIFICATE REQUEST-----" }, "$$ref": "#/components/examples/ComViptelaVmanageServerCertificateapiResponseExampleGetenterpriseestclientgetcsrresponse" }, "Not generated": { "description": "Not generated", "value": { "status": "not_generated" }, "$$ref": "#/components/examples/ComViptelaVmanageServerCertificateapiResponseExampleGetenterpriseestclientgetcsrfailedresponse" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/certificate/enterprise/estclient/install/signedCert": { "post": { "tags": [ "Certificate Management - vManage" ], "summary": "Install signed EST proxy client certificate", "description": "Install signed EST proxy client certificate", "operationId": "enterpriseESTClientInstallCertificate", "requestBody": { "description": "Certificate", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Certificate": { "description": "Certificate", "value": "-----BEGIN CERTIFICATE-----\n\n-----END CERTIFICATE-----", "$$ref": "#/components/examples/ComViptelaVmanageServerCertificateapiRequestExamplePostinstallsignedcertrequest" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "Task ID": { "description": "Task ID", "value": { "status": "success" }, "$$ref": "#/components/examples/ComViptelaVmanageServerCertificateapiResponseExamplePostenterpriseestclientinstallsignedcertresponse" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/certificate/forcesync/rootCert": { "post": { "tags": [ "Certificate Management - Device" ], "summary": "force Sync RootCert to all devices", "description": "force Sync RootCert to all devices", "operationId": "forceSyncRootCert", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "Task ID": { "description": "Task ID", "value": { "id": "b2b7525d-b68e-4ac3-962a-49d521352272" }, "$$ref": "#/components/examples/ComViptelaVmanageServerCertificateapiResponseExamplePostforcesyncrootcertresponse" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/certificate/generate/controller/csr/async": { "post": { "tags": [ "Certificate Management - Device" ], "summary": "generate asynchronously CSR on controller device", "description": "generate asynchronously CSR on controller device", "operationId": "generateCSRAsync", "requestBody": { "description": "Device IP", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Gen CSR": { "description": "Gen CSR", "value": { "deviceIP": "172.16.255.20", "resetRSA": false }, "$$ref": "#/components/examples/ComViptelaVmanageServerCertificateapiRequestExamplePostgeneratecsrrequest" }, "Reset RSA": { "description": "Reset RSA", "value": { "deviceIP": "10.0.9.2", "resetRSA": true, "credentials": [ { "uuid": "5563d766-8e13-49f2-87d9-39e3bd7e2c98", "deviceType": "Controller", "deviceIP": "10.1.1.11" } ] }, "$$ref": "#/components/examples/ComViptelaVmanageServerCertificateapiRequestExamplePostgeneratecsrrsarequest" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "Task ID": { "description": "Task ID", "value": { "id": "b2b7525d-b68e-4ac3-962a-49d521352272" }, "$$ref": "#/components/examples/ComViptelaVmanageServerCertificateapiResponseExamplePostgeneratecsrasyncresponse" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/certificate/generate/csr": { "post": { "tags": [ "Certificate Management - Device" ], "summary": "generate CSR on target device", "description": "get certificaate details", "operationId": "generateCSR", "requestBody": { "description": "Device IP", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Device IP": { "description": "Device IP", "value": { "deviceIP": "172.16.255.20", "resetRSA": false }, "$$ref": "#/components/examples/ComViptelaVmanageServerCertificateapiRequestExamplePostgeneratecsrrequest" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "Device List": { "description": "Device List", "value": { "header": { "columns": [ { "title": "Operation Status", "property": "state", "colorProperty": "globalState", "color": [ { "key": "Error", "value": "ef5350" } ], "width": 130, "dataType": "string" }, { "title": "Controller Type", "property": "deviceType", "display": "keyvalue", "keyvalueProperty": "deviceType", "hideable": false, "keyvalue": [ { "key": "vsmart", "value": "vSmart" }, { "key": "vbond", "value": "vBond" }, { "key": "vmanage", "value": "vManage" }, { "key": "vedge", "value": "WAN Edge" } ], "width": 120, "dataType": "string" }, { "title": "Hostname", "property": "host-name", "hideable": false, "width": 150, "dataType": "string" }, { "title": "System IP", "property": "system-ip", "hideable": false, "width": 120, "dataType": "ipv4" }, { "title": "Site ID", "property": "site-id", "width": 70, "dataType": "numberStr" }, { "title": "Certificate Serial", "property": "serialNumber", "width": 150, "dataType": "string" }, { "title": "Expiration Date", "property": "expirationDateLong", "displayFormat": "DD MMM YYYY h:mm:ss A z", "inputFormat": "unix-time", "colorProperty": "expirationStatus", "hideable": false, "color": [ { "key": "warning", "value": "ffb300" }, { "key": "invalid", "value": "ef5350" } ], "width": 200, "dataType": "date" }, { "title": "uuid", "property": "uuid", "hideable": false, "editable": false, "dataType": "string" }, { "title": "vEdge List Status", "property": "state_vedgeList", "minWidth": 80, "dataType": "string" }, { "title": "Device IP", "property": "deviceIP", "width": 120, "dataType": "ipv4" } ], "fields": [ { "property": "state", "dataType": "string" }, { "property": "deviceType", "dataType": "string", "display": "keyvalue" }, { "property": "certInstallStatus", "dataType": "string" }, { "property": "host-name", "dataType": "string" }, { "property": "system-ip", "dataType": "ipv4" }, { "property": "site-id", "dataType": "numberStr" }, { "property": "username", "dataType": "string" }, { "property": "password", "dataType": "string" }, { "property": "CSR", "dataType": "string" }, { "property": "CSRDetail", "dataType": "string" }, { "property": "CertificateDetail", "dataType": "string" }, { "property": "serialNumber", "dataType": "string" }, { "property": "expirationDate", "dataType": "string" }, { "property": "expirationDateLong", "dataType": "date" }, { "property": "valid", "dataType": "string" }, { "property": "errorDetail", "dataType": "string" }, { "property": "requestTokenID", "dataType": "string" }, { "property": "uuid", "dataType": "string" }, { "property": "state_vedgeList", "dataType": "string" }, { "property": "deviceIP", "dataType": "ipv4" }, { "property": "errorDetail_vedgelist", "dataType": "string" }, { "property": "activity", "dataType": "string" } ], "viewKeys": { "uniqueKey": [], "preferenceKey": "grid-Certificate" }, "modelNameMapping": { "vAnalytics": "Analytics", "vSmart": "Controller", "vManage": "Manager", "Cloud OnRamp": "Cloud onRamp", "vBond": "Validator" } }, "data": [ { "globalState": "normal", "discoveredDeviceVpns": [ "0", "512" ], "deviceConfigurationRfs": "no config \nconfig\n system\n host-name vm9\n system-ip 172.16.255.19\n site-id 100\n port-offset 9\n admin-tech-on-failure\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 priority debug\n !\n !\n ntp\n parent\n no enable\n stratum 5\n exit\n !\n !\n omp\n no shutdown\n filter-route\n no outbound affinity-group-preference\n no outbound tloc-color\n exit\n graceful-restart\n outbound-policy-caching\n timers\n holdtime 15\n graceful-restart-timer 120\n exit\n !\n vpn 0\n host vbond ip 10.0.12.26 2001:a0:c::1a\n interface eth0\n ip dhcp-client\n ipv6 dhcp-client\n no shutdown\n !\n interface eth1\n ip address 10.0.5.19/24\n tunnel-interface\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 stun\n !\n no shutdown\n !\n ip route 0.0.0.0/0 10.0.5.13\n !\n vpn 512\n interface eth2\n ip address 10.2.2.19/24\n no shutdown\n !\n !\n !\n!", "configStatusMessageDetails": "", "isPrestagingSupported": true, "oldSerialNumber": "{\"serialNumber\":\"1234\",\"validity\":\"valid\",\"deviceEnterpriseCertificate\":\"-----BEGIN CERTIFICATE-----\\nMIIGhDCCBGygAwIBAgICEjUwDQYJKoZIhvcNAQELBQAwgZAxCzAJBgNVBAYTAlVT\\nMRMwEQYDVQQIDApDYWxpZm9ybmlhMREwDwYDVQQHDAhTYW4gSm9zZTEOMAwGA1UE\\nCwwFTGFiQ0ExFDASBgNVBAoMC1ZpcHRlbGEgTExDMSAwHgYJKoZIhvcNAQkBFhFz\\ndXBwb3J0QGxhYmNhLmNvbTERMA8GA1UEAwwITGFiQ0EgQ0EwHhcNMjQwNjA1MTg1\\nMTI5WhcNMjUwNjA1MTg1MTI5WjCBwzELMAkGA1UEBhMCVVMxEzARBgNVBAgTCkNh\\nbGlmb3JuaWExFjAUBgNVBAoTDUNpc2NvIFN5c3RlbXMxHzAdBgNVBAsTFnZJUHRl\\nbGEgSW5jIFJlZ3Jlc3Npb24xQjBABgNVBAMTOXZzbWFydC1jNzgyODlkNi04Yjc4\\nLTRlN2QtOWQ4My02MTdlNzBlMDk1NmItMS52aXB0ZWxhLmNvbTEiMCAGCSqGSIb3\\nDQEJARYTc3VwcG9ydEB2aXB0ZWxhLmNvbTCCAiIwDQYJKoZIhvcNAQEBBQADggIP\\nADCCAgoCggIBAJ4JxIe0hxP5mNUeGrgkkqQ8Gvw1gdRpYC6hlY5360ybUinA/CWy\\n4TTm1H9BNzaYLi1cOd7bGMk3iAISbgULdLO3SH6QpkZdkPBiJcp2mBerwKiNSZ9x\\nSb7W5PGToep4yPoIUf13ASG97V5/GkSQJYpouxoXDJlhjZ5W15csshPduJH5iOij\\nAAR0XyytsVMCfFSIIZZKLYoJFkOfNokrW1ybb+dyrXI40SGgxeyLCV8EmyLcWrAB\\n4ziY2snJYhP5o7XmEu4YrIq1NyHpxwms4kMf7hzCODU9IBXjIodpWF1oXyPyYctP\\nRZvUh8VWWjcgQx0IlBybTsaD6Zr4BMX2JVBdMkvOSHvRNwH5IAjCH8fy35rWE2rr\\nM4XYqBGhEmAtSPmEsbxRPc1ffOy9GSz3jmKvUI9rnblLnQq1oNttpCKHbUPeEimO\\nUEDrHSHKBmd1ugkXPC10/5SYt1J6ordXLEPVVzMwujtL0HmhNAB5/XUd5TotUh+O\\nlc+jHG/UEm0P5zeD6OpqJshZ1Jz9YF1Vsd96YJEufBd5sZol0qyk1D23j4rqxF9t\\ngNaKMPTyBCvRTPR6Ce7/hzQrxP0RxKXELKxBYRxFb7Tl5zkbnCykB10Tfb1gblr/\\neFlUtxJHSBOBrM6IkOZBBYkuXYaoZCgPUy0c48sgvvJ8SlsCNF8DVyTZAgMBAAGj\\ngbIwga8wDwYDVR0TAQH/BAUwAwIBADARBglghkgBhvhCAQEEBAMCBeAwCwYDVR0P\\nBAQDAgXgMDwGA1UdJQQ1MDMGCCsGAQUFBwMBBggrBgEFBQcDAgYIKwYBBQUHAwMG\\nCCsGAQUFBwMEBgkrBgEEAQkVAgcwHQYDVR0OBBYEFBgHSKM9PTHfb1lEvTeEtGj+\\nw0NGMB8GA1UdIwQYMBaAFHNl4af93NNImjKlfNspypmYwZHvMA0GCSqGSIb3DQEB\\nCwUAA4ICAQCMo1XLxGvq0qgTKSvAoP25w8SCSbQwmw/tdIwSfg5p9aU6fY/nxCZs\\nSlJMBx13ykC0YRHFOwXf4ecoZyfx9YYV6+qWAk7kIkFc/9USDu2zAjyMsVCVa7ek\\neAvwb+ioiJN/6VrzZxrCyMRNAwzMJdmPI4K2QhnCv95jXUQqUVYQy8mFFeZj1ccf\\nZo1EQ3DPSrB8zK3DNDXMO5JhAfDTVmTrPJWIEhxkVOBvJylvzz5iBtTgnYSAdR1L\\naa6miri/siMkHn6wDmTK/3IP/wa92SKxUtPAeIErvNOwD9PYIusTNBV9ublWfUN4\\n+qNMZXB792p4VMe+NHokldseDQ53P75obtMy2piePblFb0LIqZ8wv/J3SCJLXDDN\\nzQCQiRy6WtQgIdQ5hOWec5eDjXRn8MZnSyTrXPCkZqdPCKkqxR7wMeuMhPqmnAMc\\nium6adRvxTqwtd4Afo8v6aisYvU3cY4ckgHCEE2nXc7gTbqq9DS4OT4pk3jJmQ8H\\nALp3ESuzlV6XP5an47u8K6qD0k29lS+mA+4MSbIkdgFGq0MpNV1xuobpiP5GV9Cy\\nLGmOcy8z15jt4JGN958OrkvBWnxLwIyXsu/tpm96M5BDMmpRYZ6IRqrL2gQmK+92\\nLNzLb+Pqol02wxwX5Ljw4+kALXLX4pEQW3vfcvAUaWChxzuHcy4HnQ==\\n-----END CERTIFICATE-----\\n\"}", "expirationStatus": "normal", "ztpUpgradeStatus": "Not Required", "uuid": "c78289d6-8b78-4e7d-9d83-617e70e0956b", "createdAt": "05 Jun 2024 10:50:37 UTC", "password": "--", "solution": "sdwan", "deviceConfigurationRfsXml": " vsmart-c78289d6-8b78-4e7d-9d83-617e70e0956b vm9 172.16.255.19 100 9 vIPtela Inc Regression vbond local radius tacacs basic system read interface read netadmin operator system read interface read policy read routing read security read tenantadmin admin $6$tebXK3g64oMdWjSp$kIbJ/qShDI4/eLQ0M8NLyCK7rlmsZAlnwGFqCVZc7rNlIE6f8O1Q6IuP4pHJinc8pSTNGAEYtoCAwDuAiGPF9/ debug 15 120 0 vbond 10.0.12.26 2001:a0:c::1a eth0 true true false eth1
10.0.5.19/24
 false 0.0.0.0/0
10.0.5.13
 512 eth2
10.2.2.19/24
 false ", "configOperationMode": "cli", "state": "CSR Generated", "deviceType": "vsmart", "serialNumber": "1234", "rootCertHash": "9d291b7674ea8fe9b98d440b82df7627b040d691", "deviceCSRCommonName": "vsmart-c78289d6-8b78-4e7d-9d83-617e70e0956b-2.viptela.com", "mrf-management-region": "no", "deviceConfiguration": "no config \nconfig\n system\n host-name vm9\n system-ip 172.16.255.19\n site-id 100\n port-offset 9\n admin-tech-on-failure\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 priority debug\n !\n !\n ntp\n parent\n no enable\n stratum 5\n exit\n !\n !\n omp\n no shutdown\n filter-route\n no outbound affinity-group-preference\n no outbound tloc-color\n exit\n graceful-restart\n outbound-policy-caching\n timers\n holdtime 15\n graceful-restart-timer 120\n exit\n !\n vpn 0\n host vbond ip 10.0.12.26 2001:a0:c::1a\n interface eth0\n ip dhcp-client\n ipv6 dhcp-client\n no shutdown\n !\n interface eth1\n ip address 10.0.5.19/24\n tunnel-interface\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 stun\n !\n no shutdown\n !\n ip route 0.0.0.0/0 10.0.5.13\n !\n vpn 512\n interface eth2\n ip address 10.2.2.19/24\n no shutdown\n !\n !\n !\n!", "quickConnectEligible": false, "managementSystemIP": "172.16.255.19", "state_vedgeList": "Sync", "deviceCSRGenTime": 1718044419286, "deviceLifeCycleNeeded": false, "volatileUUID": "c78289d6-8b78-4e7d-9d83-617e70e0956b", "deviceState": "READY", "expirationDateLong": 1749149465000, "timeRemainingForExpiration": 31187503243, "certInstallStatus": "Installed", "activity": [ "[10-Jun-2024 18:33:39 UTC] CSR Generated" ], "deviceConfigurationRfsXmlUpdatedTime": 1717584752151, "deviceCSR": "-----BEGIN CERTIFICATE REQUEST-----\nMIIFVzCCAz8CAQAwgdYxCzAJBgNVBAYTAlVTMRMwEQYDVQQIEwpDYWxpZm9ybmlh\nMREwDwYDVQQHEwhTYW4gSm9zZTEfMB0GA1UECxMWdklQdGVsYSBJbmMgUmVncmVz\nc2lvbjEWMBQGA1UEChMNQ2lzY28gU3lzdGVtczFCMEAGA1UEAxM5dnNtYXJ0LWM3\nODI4OWQ2LThiNzgtNGU3ZC05ZDgzLTYxN2U3MGUwOTU2Yi0yLnZpcHRlbGEuY29t\nMSIwIAYJKoZIhvcNAQkBFhNzdXBwb3J0QHZpcHRlbGEuY29tMIICIjANBgkqhkiG\n9w0BAQEFAAOCAg8AMIICCgKCAgEAngnEh7SHE/mY1R4auCSSpDwa/DWB1GlgLqGV\njnfrTJtSKcD8JbLhNObUf0E3NpguLVw53tsYyTeIAhJuBQt0s7dIfpCmRl2Q8GIl\nynaYF6vAqI1Jn3FJvtbk8ZOh6njI+ghR/XcBIb3tXn8aRJAlimi7GhcMmWGNnlbX\nlyyyE924kfmI6KMABHRfLK2xUwJ8VIghlkotigkWQ582iStbXJtv53KtcjjRIaDF\n7IsJXwSbItxasAHjOJjaycliE/mjteYS7hisirU3IenHCaziQx/uHMI4NT0gFeMi\nh2lYXWhfI/Jhy09Fm9SHxVZaNyBDHQiUHJtOxoPpmvgExfYlUF0yS85Ie9E3Afkg\nCMIfx/LfmtYTauszhdioEaESYC1I+YSxvFE9zV987L0ZLPeOYq9Qj2uduUudCrWg\n222kIodtQ94SKY5QQOsdIcoGZ3W6CRc8LXT/lJi3Unqit1csQ9VXMzC6O0vQeaE0\nAHn9dR3lOi1SH46Vz6Mcb9QSbQ/nN4Po6momyFnUnP1gXVWx33pgkS58F3mxmiXS\nrKTUPbePiurEX22A1oow9PIEK9FM9HoJ7v+HNCvE/RHEpcQsrEFhHEVvtOXnORuc\nLKQHXRN9vWBuWv94WVS3EkdIE4GszoiQ5kEFiS5dhqhkKA9TLRzjyyC+8nxKWwI0\nXwNXJNkCAwEAAaA7MDkGCSqGSIb3DQEJDjEsMCowCQYDVR0TBAIwADAdBgNVHQ4E\nFgQUGAdIoz09Md9vWUS9N4S0aP7DQ0YwDQYJKoZIhvcNAQELBQADggIBAF66zA4x\n2n2E/uhMCLl7vEnLnBTk6Lvi7VkjRc7a1ElmkXhhlb3vdPzkg/AXEl3aUpr5LzD7\nAwLoBD3cnR/WJTHKbgdZ3tt6TT3W5OM1T/O4zIJfmBKezg0YJ6gfCy3rN230yA8v\nt+VQWqCHIdFHraER86LXahFZ2ftJF3eJkx/1jE09ZMaa8nc59bv7Pkh3XEkjc0pD\n/SPVzUB1iV6e3dOS8qfyGFLycZet/NXLKJZ/WtDjhcwn3a2xEkNmxu/utWlRY/7e\nunKQLfPJeyp0tdy9VhmR5Sx2ugz6LktDuLwlaADC5QvOfq1HoGUMBrPWOsDGsi2u\nfMC1z42UTBRAhRdZT9+yW4zLYCs+6RLIyU1TMK1blKKMtK1GmpyhgEXofAfGRk/G\n0fZGDJz4tgd+87x9EqaJejP6kh2fquyJBVtgdjaNlPcVYFWHO+Baohyz02+sFXnr\nca1T6QlLHv21SKRJGlA4Jn4+RDSlU+ZF9L2qVJr4e8pQkFUxnpReRbcRYrbbsIvh\n3M7bEWN8pwhkNe+1MWOccxrG6pUhiGKNFX0WQk1qIR2X6Fiqzjjlw4m05PgEdVEK\nu2T6f1H5RMp/Jjv7MHTwkKbJDMNwT+A6ZsX9j12Ul0Zg0KikjmYhpbQSTS1I2yEY\ni4pQPhbIEE/4IgfEnRI7hGJgD3ma43N3+OD3\n-----END CERTIFICATE REQUEST-----", "discoveredDeviceInterfaces": [ "system", "eth3", "eth2", "eth1", "eth0" ], "ztpUpgradeAttemptedTimeStamp": 1717615467619, "platformFamily": "vsmart", "configuredSystemIP": "172.16.255.19", "templateStatus": "Success", "valid": "valid", "@rid": 2725, "personality": "vsmart", "hardwareVedge": false, "chasisNumber": "c78289d6-8b78-4e7d-9d83-617e70e0956b", "expirationDate": "Jun 05 18:51:05 2025 GMT", "deviceIP": "172.16.255.19", "uploadSource": "Auto Discovered", "deviceEnterpriseCertInstallTime": 1717613554712, "deviceEnterpriseCertificate": "-----BEGIN CERTIFICATE-----\nMIIGhDCCBGygAwIBAgICEjUwDQYJKoZIhvcNAQELBQAwgZAxCzAJBgNVBAYTAlVT\nMRMwEQYDVQQIDApDYWxpZm9ybmlhMREwDwYDVQQHDAhTYW4gSm9zZTEOMAwGA1UE\nCwwFTGFiQ0ExFDASBgNVBAoMC1ZpcHRlbGEgTExDMSAwHgYJKoZIhvcNAQkBFhFz\ndXBwb3J0QGxhYmNhLmNvbTERMA8GA1UEAwwITGFiQ0EgQ0EwHhcNMjQwNjA1MTg1\nMTI5WhcNMjUwNjA1MTg1MTI5WjCBwzELMAkGA1UEBhMCVVMxEzARBgNVBAgTCkNh\nbGlmb3JuaWExFjAUBgNVBAoTDUNpc2NvIFN5c3RlbXMxHzAdBgNVBAsTFnZJUHRl\nbGEgSW5jIFJlZ3Jlc3Npb24xQjBABgNVBAMTOXZzbWFydC1jNzgyODlkNi04Yjc4\nLTRlN2QtOWQ4My02MTdlNzBlMDk1NmItMS52aXB0ZWxhLmNvbTEiMCAGCSqGSIb3\nDQEJARYTc3VwcG9ydEB2aXB0ZWxhLmNvbTCCAiIwDQYJKoZIhvcNAQEBBQADggIP\nADCCAgoCggIBAJ4JxIe0hxP5mNUeGrgkkqQ8Gvw1gdRpYC6hlY5360ybUinA/CWy\n4TTm1H9BNzaYLi1cOd7bGMk3iAISbgULdLO3SH6QpkZdkPBiJcp2mBerwKiNSZ9x\nSb7W5PGToep4yPoIUf13ASG97V5/GkSQJYpouxoXDJlhjZ5W15csshPduJH5iOij\nAAR0XyytsVMCfFSIIZZKLYoJFkOfNokrW1ybb+dyrXI40SGgxeyLCV8EmyLcWrAB\n4ziY2snJYhP5o7XmEu4YrIq1NyHpxwms4kMf7hzCODU9IBXjIodpWF1oXyPyYctP\nRZvUh8VWWjcgQx0IlBybTsaD6Zr4BMX2JVBdMkvOSHvRNwH5IAjCH8fy35rWE2rr\nM4XYqBGhEmAtSPmEsbxRPc1ffOy9GSz3jmKvUI9rnblLnQq1oNttpCKHbUPeEimO\nUEDrHSHKBmd1ugkXPC10/5SYt1J6ordXLEPVVzMwujtL0HmhNAB5/XUd5TotUh+O\nlc+jHG/UEm0P5zeD6OpqJshZ1Jz9YF1Vsd96YJEufBd5sZol0qyk1D23j4rqxF9t\ngNaKMPTyBCvRTPR6Ce7/hzQrxP0RxKXELKxBYRxFb7Tl5zkbnCykB10Tfb1gblr/\neFlUtxJHSBOBrM6IkOZBBYkuXYaoZCgPUy0c48sgvvJ8SlsCNF8DVyTZAgMBAAGj\ngbIwga8wDwYDVR0TAQH/BAUwAwIBADARBglghkgBhvhCAQEEBAMCBeAwCwYDVR0P\nBAQDAgXgMDwGA1UdJQQ1MDMGCCsGAQUFBwMBBggrBgEFBQcDAgYIKwYBBQUHAwMG\nCCsGAQUFBwMEBgkrBgEEAQkVAgcwHQYDVR0OBBYEFBgHSKM9PTHfb1lEvTeEtGj+\nw0NGMB8GA1UdIwQYMBaAFHNl4af93NNImjKlfNspypmYwZHvMA0GCSqGSIb3DQEB\nCwUAA4ICAQCMo1XLxGvq0qgTKSvAoP25w8SCSbQwmw/tdIwSfg5p9aU6fY/nxCZs\nSlJMBx13ykC0YRHFOwXf4ecoZyfx9YYV6+qWAk7kIkFc/9USDu2zAjyMsVCVa7ek\neAvwb+ioiJN/6VrzZxrCyMRNAwzMJdmPI4K2QhnCv95jXUQqUVYQy8mFFeZj1ccf\nZo1EQ3DPSrB8zK3DNDXMO5JhAfDTVmTrPJWIEhxkVOBvJylvzz5iBtTgnYSAdR1L\naa6miri/siMkHn6wDmTK/3IP/wa92SKxUtPAeIErvNOwD9PYIusTNBV9ublWfUN4\n+qNMZXB792p4VMe+NHokldseDQ53P75obtMy2piePblFb0LIqZ8wv/J3SCJLXDDN\nzQCQiRy6WtQgIdQ5hOWec5eDjXRn8MZnSyTrXPCkZqdPCKkqxR7wMeuMhPqmnAMc\nium6adRvxTqwtd4Afo8v6aisYvU3cY4ckgHCEE2nXc7gTbqq9DS4OT4pk3jJmQ8H\nALp3ESuzlV6XP5an47u8K6qD0k29lS+mA+4MSbIkdgFGq0MpNV1xuobpiP5GV9Cy\nLGmOcy8z15jt4JGN958OrkvBWnxLwIyXsu/tpm96M5BDMmpRYZ6IRqrL2gQmK+92\nLNzLb+Pqol02wxwX5Ljw4+kALXLX4pEQW3vfcvAUaWChxzuHcy4HnQ==\n-----END CERTIFICATE-----", "deviceCSRGenTimeString": "Jun 10 18:33:39 2024 UTC", "ncsDeviceName": "vsmart-c78289d6-8b78-4e7d-9d83-617e70e0956b", "configStatusMessage": "In Sync", "requestTokenID": "5631356f-f19c-42c0-bcaf-8e570db7de90", "templateApplyLog": [ "[5-Jun-2024 10:52:32 UTC] Sync-from successful" ], "host-name": "vm9", "deviceDay0Configuration": "", "createdBy": "system", "tenantId": "default", "deviceEnterpriseCertInstallTimeStr": "Jun 05 18:52:34 2024 UTC", "mrf-migration-mode": "N/A", "region-id": [], "deviceModel": "vsmart", "validity": "invalid", "configuredSiteId": "100", "username": "--", "local-system-ip": "172.16.255.19", "system-ip": "172.16.255.19", "site-id": "100" } ] }, "$$ref": "#/components/examples/ComViptelaVmanageServerCertificateapiResponseExamplePostgeneratecsrresponse" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/certificate/generate/csr/bulk/controller/async": { "post": { "tags": [ "Certificate Management - Device" ], "summary": "generate asynchronously CSR on multiple devices", "description": "generate asynchronously CSR on multiple devices", "operationId": "generateCSRBulkControllerAsync", "requestBody": { "description": "Device IP", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Gen CSR": { "description": "Gen CSR", "value": { "device-list": [ { "deviceIP": "10.0.9.1", "keyLength": "2048", "resetRSA": false }, { "deviceIP": "10.0.9.2", "keyLength": "2048", "resetRSA": false } ], "schedule": false, "autoRenew": false }, "$$ref": "#/components/examples/ComViptelaVmanageServerCertificateapiRequestExamplePostgeneratebulkcsrrequest" }, "Reset RSA": { "description": "Reset RSA", "value": { "device-list": [ { "deviceIP": "10.0.9.1", "keyLength": "2048", "resetRSA": false }, { "deviceIP": "10.0.9.2", "keyLength": "2048", "resetRSA": true, "credentials": [ { "uuid": "5563d766-8e13-49f2-87d9-39e3bd7e2c98", "deviceType": "Controller", "deviceIP": "10.1.1.11" } ] } ], "schedule": false, "autoRenew": false }, "$$ref": "#/components/examples/ComViptelaVmanageServerCertificateapiRequestExamplePostgeneratebulkcsrrsarequest" }, "Gen CSR Schedule": { "description": "Gen CSR Schedule", "value": { "device-list": [ { "deviceIP": "10.0.9.1", "keyLength": "2048", "resetRSA": false }, { "deviceIP": "10.0.9.2", "keyLength": "2048", "resetRSA": false } ], "schedule": true, "autoRenew": false, "scheduleAt": 1729495932 }, "$$ref": "#/components/examples/ComViptelaVmanageServerCertificateapiRequestExamplePostgenerateschedulebulkcsrrequest" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "Task ID": { "description": "Task ID", "value": { "id": "b2b7525d-b68e-4ac3-962a-49d521352272" }, "$$ref": "#/components/examples/ComViptelaVmanageServerCertificateapiResponseExamplePostgeneratecsrasyncresponse" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/certificate/generate/csr/bulk/edge/async": { "post": { "tags": [ "Certificate Management - Device" ], "summary": "generate asynchronously CSR on multiple devices", "description": "generate asynchronously CSR on multiple devices", "operationId": "generateCSRBulkEdgeAsync", "requestBody": { "description": "Device IP", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Gen CSR": { "description": "Gen CSR", "value": { "device-list": [ { "deviceUUID": "C8K-d23e21e2-043a-4a38-8f18-ec37a092bb57", "keyLength": "2048" }, { "deviceUUID": "489abdc1-c21c-4d1d-aeb9-30a469d5ca49", "keyLength": "2048" } ], "schedule": false, "autoRenew": false }, "$$ref": "#/components/examples/ComViptelaVmanageServerCertificateapiRequestExamplePostgeneratebulkcsredgerequest" }, "Gen CSR Schedule": { "description": "Gen CSR Schedule", "value": { "device-list": [ { "deviceUUID": "C8K-d23e21e2-043a-4a38-8f18-ec37a092bb57", "keyLength": "2048" }, { "deviceUUID": "489abdc1-c21c-4d1d-aeb9-30a469d5ca49", "keyLength": "2048" } ], "schedule": true, "autoRenew": false, "scheduleAt": 1729495932 }, "$$ref": "#/components/examples/ComViptelaVmanageServerCertificateapiRequestExamplePostgenerateschedulebulkcsredgerequest" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "Task ID": { "description": "Task ID", "value": { "id": "b2b7525d-b68e-4ac3-962a-49d521352272" }, "$$ref": "#/components/examples/ComViptelaVmanageServerCertificateapiResponseExamplePostgeneratecsrasyncresponse" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/certificate/generate/enterprise/csr/vedge": { "post": { "tags": [ "Certificate Management - Device" ], "summary": "generate CSR on hardware WAN edge device", "description": "generate CSR on hardware WAN edge device", "operationId": "generateEnterpriseCSR", "requestBody": { "description": "Device UUID", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Device UUID": { "description": "Device UUID", "value": { "deviceUUID": "C8K-0b9056fd-296c-400e-936f-3dff4ef87db2" }, "$$ref": "#/components/examples/ComViptelaVmanageServerCertificateapiRequestExamplePostgenerateenterprisecsrrequest" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "Task ID": { "description": "Task ID", "value": { "id": "b2b7525d-b68e-4ac3-962a-49d521352272" }, "$$ref": "#/components/examples/ComViptelaVmanageServerCertificateapiResponseExamplePostgenerateenterprisecsrresponse" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/certificate/generate/wanedge/csr": { "post": { "tags": [ "Certificate Management - Device" ], "summary": "generate CSR on WAN edge device", "description": "generate CSR on WAN edge device", "operationId": "generateEdgeDeviceCSR", "requestBody": { "description": "Device UUID", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Device UUID": { "description": "Device UUID", "value": { "deviceUUID": "C8K-0b9056fd-296c-400e-936f-3dff4ef87db2" }, "$$ref": "#/components/examples/ComViptelaVmanageServerCertificateapiRequestExamplePostgeneratewanedgecsrrequest" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "Task ID": { "description": "Task ID", "value": { "id": "b2b7525d-b68e-4ac3-962a-49d521352272" }, "$$ref": "#/components/examples/ComViptelaVmanageServerCertificateapiResponseExamplePostgeneratewanedgecsrresponse" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/certificate/getDeviceData/signedCerts": { "post": { "tags": [ "Certificate Management - Device" ], "summary": "Get device data from signed certs", "description": "Get device data from signed cert in a single .pem file or .zip file", "operationId": "getDeviceDataFromSignedCerts", "requestBody": { "description": "Signed Cert", "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "data": { "type": "string", "example": { "controller": false, "chassis-numbers": [ "233497bc-69f7-43fe-a389-28bb719fef14", "C8K-f4423f04-355b-4c22-b6de-76f8d3e651b4", "C8K-0b9056fd-296c-400e-936f-3dff4ef87db2" ] } }, "file": { "type": "string", "format": "binary" } }, "$$ref": "#/components/schemas/DeviceDataUpload" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "Device List": { "description": "Device List", "value": { "chassis-numbers": [ "233497bc-69f7-43fe-a389-28bb719fef14", "C8K-f4423f04-355b-4c22-b6de-76f8d3e651b4", "C8K-0b9056fd-296c-400e-936f-3dff4ef87db2" ], "installCertFile": "uploadedSignedCertFile_17296929271503212635450938629.zip" }, "$$ref": "#/components/examples/ComViptelaVmanageServerCertificateapiResponseExamplePostuploadsingedcertsresponse" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/certificate/install/signedCert": { "post": { "tags": [ "Certificate Management - Device" ], "summary": "install Certificate", "description": "install Certificate", "operationId": "installCertificate", "requestBody": { "description": "Certificate", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Certificate": { "description": "Certificate", "value": "-----BEGIN CERTIFICATE-----\n\n-----END CERTIFICATE-----", "$$ref": "#/components/examples/ComViptelaVmanageServerCertificateapiRequestExamplePostinstallsignedcertrequest" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "Task ID": { "description": "Task ID", "value": { "id": "b2b7525d-b68e-4ac3-962a-49d521352272" }, "$$ref": "#/components/examples/ComViptelaVmanageServerCertificateapiResponseExamplePostinstallsignedcertresponse" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/certificate/install/upload/signedCerts": { "post": { "tags": [ "Certificate Management - Device" ], "summary": "Install signed certs", "description": "Install signed certs from a .pem or .zip file. File details are received by /certificate/getDeviceData/signedCerts API ", "operationId": "installBulkSignedCerts", "requestBody": { "description": "Device IP", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Upload Request": { "description": "Upload Request", "value": { "controller": false, "sendToControllers": true, "installCertFile": "uploadedSignedCertFile_17296929271503212635450938629.zip", "schedule": false }, "$$ref": "#/components/examples/ComViptelaVmanageServerCertificateapiRequestExamplePostinstallcertuploadrequest" }, "Upload Schedule Request": { "description": "Upload Schedule Request", "value": { "controller": false, "sendToControllers": true, "installCertFile": "uploadedSignedCertFile_17296929271503212635450938629.zip", "schedule": true, "scheduleAt": 1729495932 }, "$$ref": "#/components/examples/ComViptelaVmanageServerCertificateapiRequestExamplePostinstallcertuploadschedulerequest" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "Task Id": { "description": "Task Id", "value": { "id": "b2b7525d-b68e-4ac3-962a-49d521352272" }, "$$ref": "#/components/examples/ComViptelaVmanageServerCertificateapiResponseExamplePostinstallcontrolleruploadsingedcertsresponse" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/certificate/jks": { "put": { "tags": [ "Certificate Management - Device" ], "summary": "update JKS", "description": "update JKS", "operationId": "updateJks", "requestBody": { "description": "JSON payload with encoded JKS.", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "Put JKS Request": { "description": "Put JKS Request", "value": { "JKS": "/u3+7QAAAAIAAAACAAAAAQApbmlyYXYgYmFyb2RpYeKAmXMgc3ltYW50ZWMgY29ycG9yYXRpb24gaWQAAAFy8nXIUQAABQEwggT9MA4GCisGAQQBKgIRn6yzgohtfp0RpX2YzzjMs8cugTuOE4RhSt5CadsAW2XIMi+VP1zErOsGUV8JxcWEZWU5fuXcFemuWD9q6lB+8r1J+r24cTEPJc9rSvOTm6blXFtqkpJMgXiUri1pw08E2itwzinxFN5iDqPafkqQg1TJRhZ65+UjPwyrCaxanavXupoRlycyHhL3m3FIWDsVylHzfdVDLJnxUNuT5ItGMiRtwkeS2lLdgxZ9gZ/CAwDhrErf33YEEyJCSxagJ6uCP16P44/Nwy9n89lZoHA52gpikhStTJqDwiXkKOQAAf+tgrvKqxZRcUyGSMZoqGpuqCsxg5t8Tv/wc8iFaDZNDY81YjBBdkZxPPzpudQiwGx/CkTdfGbwC3jgLpqbnNF26QR7cRqD6EX0ztNVcj0VoRDHgaizBmIDCO0Z/hB9qP+hcnrfxNRNdIVWMyi1JhhTKqVmzUeGHlSI01YCePCKs46jTytSEBysoqjbufM4U8gI+1s8TJESC+eIIjrwtUeVc6573jwP+qtJYM2e2hbCH/DVNPGz8fjFmUMPcYpzYSPwS/iaNxKPuHs41XgvV2VFp4CUEA6kgB7SjE0csEJLWi55b+RWsMG0/WHzF2gE0tHtzQ82f98nG6xDLjzpRWCGHwPDzk5zkyaB4vAAXkIDjUUgQnMMFTTHLVEyGspJUhZBjl9C8tK8CCwA+t5lm4DRMxHVdU0EQ3YKrtCGQZt3sGgQel5Lfrhql80wILRzUE7Ipnb+Tj/WXovgchQupZEq5iCg0FZMp0dR4WOjWalwd5RCuutYnKbYaOCSyNDH/BunLRmSZmJMR5ayVddWS7Fww5SP2rtoCICuIgW30fcPp9QL0CcerD7Qiu4rEHoG6vxNQquVGTZYJkQ6kz68S28RLOAkwcyGog54i1uJ7HeOejax007VZ2M9oYP/indYovJT5lC3J4ddaXvzPgCvOedAIqz4zdmporWvfgFSvaWzuT7Mtv6a7SjvHzHnqWYiKMB1J1T9F8MA68zV3s3YkDmpLvubrAzD8pg7gcfoUqLLh8Ez0ncB8sfRhCDyQE6Y3H/uOxJHidXotAJF4rM9ye19YjvqV/kXY3aX4onm877XqQyv8AMzV8jJ00FuaRPN+asTlLwrmLxethCAjuRME4cYi+Wmu6FO09KZF4kE9W4o/G8sCT6OSR52G/6IylvR9lqUTAu7nRM+e4nAyZjWKB9lGDenOof3d0XzQMMa6otwS7sxkk8kZOs3DpmQSw2hEPb8p/afsv/2H1Z8NxM5W2NpDQIYQjFzNxNh/9uLxFIWGumvdsCLX5Og/rWiUUsWDFwCcnLhZWU5WvNZEXSuU+qF3/5agEE76x+S932h98cavlMjFvLZOC8sbSs0gvoUO8SJ1QHcJWBFIsfXFeQ5JQjGLdbNEqOx9Ts9B91GDYcWSKawpgIwjs+x9Wg5x67giytqma/SHENgP+lafPOqeEqE7QkzaVyQ0UvLjymqhJSMgQ7ut1fnfS3oaYsG1bW+qdLrhQ+uOmaW7BV2UTndQHAucD/AwedALMgh86DlHQ/yN6nVBrJq+XpCT9r+L3N9NE4WQAAAACAAVYLjUwOQAABHYwggRyMIIDWqADAgECAhBDsWW8p7NvXUDvGjLNvJmvMA0GCSqGSIb3DQEBCwUAMHExCzAJBgNVBAYTAlVTMR0wGwYDVQQKExRTeW1hbnRlYyBDb3Jwb3JhdGlvbjFDMEEGA1UEAxM6U3ltYW50ZWMgUHJpdmF0ZSBDbGFzcyAzIE1hbmFnZWQgUEtJIEFkbWluaXN0cmF0b3IgQ0EgLSBHNDAeFw0yMDA2MTkwMDAwMDBaFw0yMjA2MTkyMzU5NTlaMHMxFDASBgNVBAoUC3ZJUHRlbGEgSW5jMRQwEgYDVQQLFAtFWENFUFRJT04gMTEWMBQGA1UEAwwNTmlyYXYgQmFyb2RpYTEtMCsGCSqGSIb3DQEJARYedm1hbmFnZV9jZXJ0X2NlbnRyYWxAY2lzY28uY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAt2IXxYFSz9r9Y4pK3ILwaAMxKED7Q5oxo/0n8LXjTH+PHW4T9GyOLpQFMmJqH4Ll/cYVzyPVgiwMzLRUMvbLINMY4cHRjC8l3LQFrGfH5n1/fxynPfbw9HQ81W0W/MHYQ3zBwZ0KUuY45vbDFvKRASRIXU4CE6mP35tyLWs4tm0lckPIlZGuPWttrqY8q61QgFaDQUXzZq+h5dQT18GuynGWs8wL5/BQAwWZG2639P0z/u40WpDyUxOyZg3gOQ6W8fzVH1+8zA7oV1XRJKRqtpQKnn5err4NP/dEUWW6qJAMU7dbzyZnjNxKvdLzcKIr6pLCWwxiLWZtKTSqRgJN2QIDAQABo4IBAjCB/zAJBgNVHRMEAjAAMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAjBmBgNVHSAEXzBdMFsGC2CGSAGG+EUBBxcDMEwwIwYIKwYBBQUHAgEWF2h0dHBzOi8vZC5zeW1jYi5jb20vY3BzMCUGCCsGAQUFBwICMBkMF2h0dHBzOi8vZC5zeW1jYi5jb20vcnBhMB8GA1UdIwQYMBaAFAxb/+N+VYuM80j4fHxOuuEDD+KbMDAGCmCGSAGG+EUBBgsEIhYgNzU0N2IxMTJjZDU2MTlkMTlhYWY1NzE3NmU4YjYzZTcwEgYKYIZIAYb4RQEGDQQEAwIDCDANBgkqhkiG9w0BAQsFAAOCAQEACdkFj7D+2tf9URODYYERQuh6t4gsvsVtoH9ZBRQHKuiLeY1fp5E2v0W8WTnsu1c8qR7Z6/ewJNTwU2wPTa8MvUVC12iMFSowCI7KAKmPdIJ8rwEb10QNp6ByN3APMQVOUUyiAVp7HjsThewTVMzaTtbcYQenu3EYEiJVA0aJv7qKkLL68/5x8eAYglBkQ/dFHovXnxt8NFjUmEGhWGB+suRI2eD+vP/Xg+QqxguF5jlsii3XtsVrYvxAu9moctYzUuPBASWCCpVJIEmtmz0Kwf8ud6nmsomBQwV6/Q9aQ5L0BVuiHtCUkTuLDaHZgWvhOXLqJE3gwJ85YUBn8Q9teQAFWC41MDkAAATAMIIEvDCCA6SgAwIBAgIQGsHt0uGj0wM3qh3gp2Yv0zANBgkqhkiG9w0BAQsFADBYMQswCQYDVQQGEwJVUzEdMBsGA1UEChMUU3ltYW50ZWMgQ29ycG9yYXRpb24xKjAoBgNVBAMTIVN5bWFudGVjIENsYXNzIDMgSW50ZXJuYWwgUm9vdCBDQTAeFw0xNzAyMTYwMDAwMDBaFw0yNzAyMTUyMzU5NTlaMHExCzAJBgNVBAYTAlVTMR0wGwYDVQQKExRTeW1hbnRlYyBDb3Jwb3JhdGlvbjFDMEEGA1UEAxM6U3ltYW50ZWMgUHJpdmF0ZSBDbGFzcyAzIE1hbmFnZWQgUEtJIEFkbWluaXN0cmF0b3IgQ0EgLSBHNDCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAMq0/yur5he+zFapKP1Llg1UAxjau9lHdN2kOlFSaQcOoPWkCvQ2B2ObHdMgOHYdaerg2zv6c4l3T1lZJ2DLf0C2Y7KV7aMy8oFyPVvP+y3R2/GUeFSLDL6/RrD1TPinRoFDkHoafmZ1TIb+nPpu7U6k9dTK9ys2jPKwQjRpjNhbniFOqdAj6VBFfYEvxjPTBCj0v/WoGnmIi2Rowvn7RNbFY5/LyGemRqGohDSDRl0gPwu81Y+ZZVMEhIr3Y2ygJfVpso1w9gS8d7U5dhS+IxdIiJN2qFyFwmWII2d2JGOcBK72wm2dEiq22XEYD749BM1EEaRSlEDDVQFKeb+ddQcCAwEAAaOCAWcwggFjMBIGA1UdEwEB/wQIMAYBAf8CAQAwZwYDVR0gBGAwXjBcBgxghkgBhvhFAQcXAwIwTDAjBggrBgEFBQcCARYXaHR0cHM6Ly9kLnN5bWNiLmNvbS9jcHMwJQYIKwYBBQUHAgIwGRoXaHR0cHM6Ly9kLnN5bWNiLmNvbS9ycGEwaQYDVR0fBGIwYDBeoFygWoZYaHR0cDovL3BraS1jcmwuc3ltYXV0aC5jb20vb2ZmbGluZWNhL1N5bWFudGVjQ29ycG9yYXRpb25TeW1hbnRlY0NsYXNzM0ludGVybmFsUm9vdENBLmNybDAOBgNVHQ8BAf8EBAMCAQYwKQYDVR0RBCIwIKQeMBwxGjAYBgNVBAMTEVN5bWFudGVjUEtJLTItNzEzMB0GA1UdDgQWBBQMW//jflWLjPNI+Hx8TrrhAw/imzAfBgNVHSMEGDAWgBQ43ldCMc3kGDucsxVdeHqrRNprLjANBgkqhkiG9w0BAQsFAAOCAQEAduw7qMlGTpxl9q6ZcP5bSdrrF6RGuzHlxH+EantFhA2SK+k8erT1VH/QU0zKu79fc4msnfl4veiJ83ioWLKZcUMTa2BofR8VF09lPiUt8VU/RvDAGd/XD/qmvO7iR1OZL4AhxM7QIr3klLODXx/YxFcfZ5w4B14trWZ3BpmIxDpOJu+a7Na8OeeYCVOSSK2Yn0uVN8dZ4F0MfrehDtEShbOmREuFpsYpLIn0aQCI4G6C4aM9/fOOWE8zQ1iXPCb8RCKWL1L2c/TXH++y5i6EniZs01t88HwntoKjLO3GzuFMh0GBdie5yJpV/mO/9tF/gQyHktVdlzZnUEbt7MhWGQAAAAEAL3NocmV5YXMgaGVyYW5qYWzigJlzIHN5bWFudGVjIGNvcnBvcmF0aW9uIGlkICMzAAABZV2x+w8AAAT/MIIE+zAOBgorBgEEASoCEQEBBQAEggTn+lm5WIafr4+xy0wt1jT5/G51aNzawfShlLMDctrwhOP42A7VIFcWMHCRvPppX2KrZr0RHjIBzTOC0z+TLZExLADntTa2zJ8uMy/eDhJfgL3483TMzSsmund1B65PQ/iQiR5xvUA+TGnKQzMftRhn7Ohsw/wTOJTFS4IhVsS+n1RDjhppGn+jH9ciu/1rLNSqoSzXUO3nzYXA5D7HBRwmxT3HiY0k3QxqIWEtFsOAk3s0FG0xfJUg3blhIQGIKzLwNmsU/dHYVU2hH84B7ICa5sB74dC+IqoqMVix6NMsiTf0IMKTJM2XA/lwSHmc7W9jqs49nUqNC3CENv4Yd2KR4DhbPmkLrMwFxCeNZnjnWXMbw8Y56XuxCAg8B+uQGCxvqBZQ73+mjHr/mKtapVk+4sw0ZgiD9sW5lLN4PA6yj3sYxZNeI4tvr5/b6ac1C5NVHpkLe7ueB0ldHeT0oHbWxw1IMSpZCGlD+1PNimSL25afc/myDTHZNgPYWw+Lrks/jMQ5LCk+V56FAjW9thwNT2CN2WilBpgLWC+mSbh4aLp8ROgyogOfxWiPO5zzIdRTQ/EsUgZDGWoVc5yfa5fIKLKIg3EnK2TUYevL7xyl7EcDqmLkg+Zb7ZmRA0pTo2zO9Z2ZLlbj3nscrtS0o/EIglUh/n1upbFeyOV+ajNawBIA0+5XE9wWcAP3hfPXCBR6rVNdPJDxcpynDVhrS0ND66bSq60AxAjwMUnZ3CW2Y05EvOQdoeGSYc7xwUEVnnZRAVwc+QSE5WLNOUXt/2uQHJDbvbWGBrXrhHLD0mKnT5zCKv/PV0/k455lcq1s7Iuh3Pku/ZQ2Lla4v4azMvQhoMvusTAvLtBFQy89DZHlDEUq0glXHBW8trUfuF4FI8ZI/VmSXp4QCZlmiL1vtilqBR49L7CNgTnbRgcYoVpt3VLyTrlaQnA0TZgpBiMx/7oCn4J7HEh9vFx5CR06cqnnOxfJLt6p8spCCRdAoUWxXK4vSH68Xk7owjuBPbvUeAMQEwjeovtI69CF9Wjm0j/sFqzT/Y4yhC6BDtuXks/b45RidDZJ31jqC0wYrgwaPcnyJT/yXjyNB9WDhdrGa10GSNcq39Y4hLWtP4e8VzHYKvkYcFYpwfE0jh+iVFI502V6Um27DMR91xMwNRIwT8+B3K54wV5vK2QLveQ6Knjsc1Z1sBUOj6HnI9OWMexN5QgTIBjZW9HD5BODNdpDsBaGEdPeAik50TBdLdOPIS1APbgb0lMB1djYI+SNH+rhpJYzR6gt5xpZqd2XT9bmZQxA+SQO+J1IHjn1YBUZEB37QCh8sicO4cZbVehBpygjXahIW5KXsS5mx3l7i7GpX/PZocwrp+wTHisp+4rJyc0/lo3nWg5NMk+NcpkXKDFPG9PBYKf0N5V/7HpkUBioFJcVROgYqeOXqJCV/VGfaLRwSbsynE+wL4JN+M40Ve/g0MsUsJya4Uza9mClfL35bPX1TJ3WITYFR7WYTPTJf8FLkWY0TyAwWzqT59c9gouWGxP0WBgAcmItEJGCXr+JMjJ8Wycyp1gbuAlGRAp6oqNQ09hpDpZanNuvt0fe3nfFVRiA3Ij4HpTeGZQNeXBXGpK/o83eu5763ZFzXIKqO6Jngb24OrUNasAmlQP8k1mae1jdSrTRjSqJ1QAAAAIABVguNTA5AAAEbTCCBGkwggNRoAMCAQICEAUOD4w0YlP8eamYUJhfTsIwDQYJKoZIhvcNAQELBQAwcTELMAkGA1UEBhMCVVMxHTAbBgNVBAoTFFN5bWFudGVjIENvcnBvcmF0aW9uMUMwQQYDVQQDEzpTeW1hbnRlYyBQcml2YXRlIENsYXNzIDMgTWFuYWdlZCBQS0kgQWRtaW5pc3RyYXRvciBDQSAtIEc0MB4XDTE4MDgxNTAwMDAwMFoXDTIwMDgwOTIzNTk1OVowajEUMBIGA1UEChQLdklQdGVsYSBJbmMxFDASBgNVBAsUC0VYQ0VQVElPTiAxMRkwFwYDVQQDDBBTaHJleWFzIEhFcmFuamFsMSEwHwYJKoZIhvcNAQkBFhJzaGVyYW5qYUBjaXNjby5jb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDBn13gZ5xzJalWNKquXdkaItEFOQd7yC+DGfqkxAJ3eoEVN78DfeAh+p+yqbKgPwtrUqY3krJ2lsFhRi5Y7K9iuA54P7v/y/vOMa3LLxIbZVvr0Fl/4yzwhJvWY6DOxnv1Wd+a1mDJ5afCbVPHQD7jdNhL0msj3Dm3avQPSZS8PPw9nSAarXs0wV6Cz80aGBBSJ6nzAysBBkTcLMHGs93mJd3lamJPNFH4UZgc3dlf1xAcXSmE9q3bLiRXSjAfF4lInDZ/am66iYwRS+blxuMxIyEbnksSHFLnXB3AiMfvkGl7LWMmE0e34SxZpbQIe4ZYa/LDd+GEAoUIGAIHD13hAgMBAAGjggECMIH/MAkGA1UdEwQCMAAwDgYDVR0PAQH/BAQDAgeAMBMGA1UdJQQMMAoGCCsGAQUFBwMCMGYGA1UdIARfMF0wWwYLYIZIAYb4RQEHFwMwTDAjBggrBgEFBQcCARYXaHR0cHM6Ly9kLnN5bWNiLmNvbS9jcHMwJQYIKwYBBQUHAgIwGQwXaHR0cHM6Ly9kLnN5bWNiLmNvbS9ycGEwHwYDVR0jBBgwFoAUDFv/435Vi4zzSPh8fE664QMP4pswMAYKYIZIAYb4RQEGCwQiFiA3NTQ3YjExMmNkNTYxOWQxOWFhZjU3MTc2ZThiNjNlNzASBgpghkgBhvhFAQYNBAQDAgMIMA0GCSqGSIb3DQEBCwUAA4IBAQCH9zDFtmuhj2dhUAyzlBvpDW9uROb9dPHMwwSJvPSUIw5Ik2UcheCG3MiNx+6cEbSErApKFVjA4him5txBUlCpSiyoJadzYFU22iXvGQuvVAcHBTOjEv9Z5/Opx3vANxlxfux/+LybuVwUkvc8rdNxCkHaDmcQrOyZrz+WejvQ81D2+gN8+cmvrMV83v8DEDRlSFyNQBgf+iCbU2KWWLldLBJJj06NY2R3U01hj1sYgy/zdDUGHh+ijtzzCoMDcssB+i4UJylDCxhM0VLiEREj5ipe7HpcAVlm3dXV/AIxLORAKvyko3PYNcrLmSuC+OhuxTjVstT8qgEDWci856WVAAVYLjUwOQAABMAwggS8MIIDpKADAgECAhAawe3S4aPTAzeqHeCnZi/TMA0GCSqGSIb3DQEBCwUAMFgxCzAJBgNVBAYTAlVTMR0wGwYDVQQKExRTeW1hbnRlYyBDb3Jwb3JhdGlvbjEqMCgGA1UEAxMhU3ltYW50ZWMgQ2xhc3MgMyBJbnRlcm5hbCBSb290IENBMB4XDTE3MDIxNjAwMDAwMFoXDTI3MDIxNTIzNTk1OVowcTELMAkGA1UEBhMCVVMxHTAbBgNVBAoTFFN5bWFudGVjIENvcnBvcmF0aW9uMUMwQQYDVQQDEzpTeW1hbnRlYyBQcml2YXRlIENsYXNzIDMgTWFuYWdlZCBQS0kgQWRtaW5pc3RyYXRvciBDQSAtIEc0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAyrT/K6vmF77MVqko/UuWDVQDGNq72Ud03aQ6UVJpBw6g9aQK9DYHY5sd0yA4dh1p6uDbO/pziXdPWVknYMt/QLZjspXtozLygXI9W8/7LdHb8ZR4VIsMvr9GsPVM+KdGgUOQehp+ZnVMhv6c+m7tTqT11Mr3KzaM8rBCNGmM2FueIU6p0CPpUEV9gS/GM9MEKPS/9agaeYiLZGjC+ftE1sVjn8vIZ6ZGoaiENINGXSA/C7zVj5llUwSEivdjbKAl9WmyjXD2BLx3tTl2FL4jF0iIk3aoXIXCZYgjZ3YkY5wErvbCbZ0SKrbZcRgPvj0EzUQRpFKUQMNVAUp5v511BwIDAQABo4IBZzCCAWMwEgYDVR0TAQH/BAgwBgEB/wIBADBnBgNVHSAEYDBeMFwGDGCGSAGG+EUBBxcDAjBMMCMGCCsGAQUFBwIBFhdodHRwczovL2Quc3ltY2IuY29tL2NwczAlBggrBgEFBQcCAjAZGhdodHRwczovL2Quc3ltY2IuY29tL3JwYTBpBgNVHR8EYjBgMF6gXKBahlhodHRwOi8vcGtpLWNybC5zeW1hdXRoLmNvbS9vZmZsaW5lY2EvU3ltYW50ZWNDb3Jwb3JhdGlvblN5bWFudGVjQ2xhc3MzSW50ZXJuYWxSb290Q0EuY3JsMA4GA1UdDwEB/wQEAwIBBjApBgNVHREEIjAgpB4wHDEaMBgGA1UEAxMRU3ltYW50ZWNQS0ktMi03MTMwHQYDVR0OBBYEFAxb/+N+VYuM80j4fHxOuuEDD+KbMB8GA1UdIwQYMBaAFDjeV0IxzeQYO5yzFV14eqtE2msuMA0GCSqGSIb3DQEBCwUAA4IBAQB27DuoyUZOnGX2rplw/ltJ2usXpEa7MeXEf4Rqe0WEDZIr6Tx6tPVUf9BTTMq7v19ziayd+Xi96InzeKhYsplxQxNrYGh9HxUXT2U+JS3xVT9G8MAZ39cP+qa87uJHU5kvgCHEztAiveSUs4NfH9jEVx9nnDgHXi2tZncGmYjEOk4m75rs1rw555gJU5JIrZifS5U3x1ngXQx+t6EO0RKFs6ZES4WmxiksifRpAIjgboLhoz39845YTzNDWJc8JvxEIpYvUvZz9Ncf77LmLoSeJmzTW3zwfCe2gqMs7cbO4UyHQYF2J7nImlX+Y7/20X+BDIeS1V2XNmdQRu3syFYZEep0Wodg4egDlGy1HXuzbl72GTI=" }, "$$ref": "#/components/examples/ComViptelaVmanageServerCertificateapiRequestExamplePutjksrequest" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "Put JKS Response": { "description": "Put JKS Response", "value": { "saveResult": "SUCCESS", "errorMessage": "JKS updated" }, "$$ref": "#/components/examples/ComViptelaVmanageServerCertificateapiResponseExamplePutjksresponse" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/certificate/list/status": { "get": { "tags": [ "Certificate Management - Device" ], "summary": "get certificate data", "description": "get certificate data", "operationId": "getListStatus", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "properties": { "empty": { "type": "boolean" } }, "items": { "type": "string" }, "$$ref": "#/components/schemas/CertificateChain" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/certificate/mthub/list": { "get": { "tags": [ "Certificate Management - Device" ], "summary": "vSmart Mthub list", "description": "vSmart Mthub list", "operationId": "setvSmartMtHubList", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "properties": { "empty": { "type": "boolean" } }, "items": { "type": "string" }, "$$ref": "#/components/schemas/DeviceList" }, "examples": { "GET MTHub List Response": { "description": "GET MTHub List Response", "value": { "id": "d3ed4d03-6de3-4464-9e01-ee1b67aa7c7d" }, "$$ref": "#/components/examples/ComViptelaVmanageServerCertificateapiResponseExampleGetmthublistresponse" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/certificate/orgname/from-config": { "get": { "tags": [ "Certificate Management - vManage" ], "summary": "Get ORG Name from ConfD", "description": "Get ORG Name from ConfD", "operationId": "getOrgNameFromConfig", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "Org Name": { "description": "Org Name", "value": { "configured": true, "organization-name": "Cisco" }, "$$ref": "#/components/examples/ComViptelaVmanageServerCertificateapiResponseExampleGetorgnamefromconfig" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/certificate/pullDeviceList": { "post": { "tags": [ "Certificate Management - Device" ], "summary": "New pull device list", "description": "Pull device list", "operationId": "pullDeviceList", "requestBody": { "description": "Payload", "content": { "application/json": { "schema": { "type": "string" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/certificate/pullDeviceList/done": { "post": { "tags": [ "Certificate Management - Device" ], "summary": "Pull device list done", "description": "Pull device list done", "operationId": "pullDeviceListDone", "requestBody": { "description": "Payload", "content": { "application/json": { "schema": { "type": "string" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/certificate/quarantine/banner": { "get": { "tags": [ "Certificate Management - Device" ], "summary": "get quarantine banner data", "description": "get quarantine banner data", "operationId": "getQuarantineBanner", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "properties": { "empty": { "type": "boolean" } }, "items": { "type": "string" }, "$$ref": "#/components/schemas/DeviceList" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/certificate/record": { "get": { "tags": [ "Certificate Management - Device" ], "summary": "get device certificate data", "description": "get device certificate data", "operationId": "getCertificateData", "parameters": [ { "name": "requestID", "in": "query", "description": "Request ID parameter", "schema": { "type": "string" }, "examples": { "requestID": { "description": "requestID", "value": "d65f2b6c-c00a-4432-a87d-d2b6269b01b3" } } }, { "name": "dataObject", "in": "query", "description": "Device property as DataObject parameter", "schema": { "type": "string" }, "examples": { "UUID": { "description": "UUID", "value": "uuid" }, "Reachability": { "description": "Reachability", "value": "reachability" }, "CSR": { "description": "CSR", "value": "CSR" } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "properties": { "empty": { "type": "boolean" } }, "items": { "type": "string" }, "$$ref": "#/components/schemas/CertificateChain" }, "examples": { "Get Record Response": { "description": "Get Record Response", "value": { "header": { "columns": [ { "title": "Operation Status", "property": "state", "colorProperty": "globalState", "color": [ { "key": "Error", "value": "ef5350" } ], "width": 130, "dataType": "string" }, { "title": "Controller Type", "property": "deviceType", "display": "keyvalue", "keyvalueProperty": "deviceType", "hideable": false, "keyvalue": [ { "key": "vsmart", "value": "vSmart" }, { "key": "vbond", "value": "vBond" }, { "key": "vmanage", "value": "vManage" }, { "key": "vedge", "value": "WAN Edge" } ], "width": 120, "dataType": "string" }, { "title": "Hostname", "property": "host-name", "hideable": false, "width": 150, "dataType": "string" }, { "title": "System IP", "property": "system-ip", "hideable": false, "width": 120, "dataType": "ipv4" }, { "title": "Site ID", "property": "site-id", "width": 70, "dataType": "numberStr" }, { "title": "Certificate Serial", "property": "serialNumber", "width": 150, "dataType": "string" }, { "title": "Expiration Date", "property": "expirationDateLong", "displayFormat": "DD MMM YYYY h:mm:ss A z", "inputFormat": "unix-time", "colorProperty": "expirationStatus", "hideable": false, "color": [ { "key": "warning", "value": "ffb300" }, { "key": "invalid", "value": "ef5350" } ], "width": 200, "dataType": "date" }, { "title": "uuid", "property": "uuid", "hideable": false, "editable": false, "dataType": "string" }, { "title": "vEdge List Status", "property": "state_vedgeList", "minWidth": 80, "dataType": "string" }, { "title": "Device IP", "property": "deviceIP", "width": 120, "dataType": "ipv4" } ], "fields": [ { "property": "state", "dataType": "string" }, { "property": "deviceType", "dataType": "string", "display": "keyvalue" }, { "property": "certInstallStatus", "dataType": "string" }, { "property": "host-name", "dataType": "string" }, { "property": "system-ip", "dataType": "ipv4" }, { "property": "site-id", "dataType": "numberStr" }, { "property": "username", "dataType": "string" }, { "property": "password", "dataType": "string" }, { "property": "CSR", "dataType": "string" }, { "property": "CSRDetail", "dataType": "string" }, { "property": "CertificateDetail", "dataType": "string" }, { "property": "serialNumber", "dataType": "string" }, { "property": "expirationDate", "dataType": "string" }, { "property": "expirationDateLong", "dataType": "date" }, { "property": "valid", "dataType": "string" }, { "property": "errorDetail", "dataType": "string" }, { "property": "requestTokenID", "dataType": "string" }, { "property": "uuid", "dataType": "string" }, { "property": "state_vedgeList", "dataType": "string" }, { "property": "deviceIP", "dataType": "ipv4" }, { "property": "errorDetail_vedgelist", "dataType": "string" }, { "property": "activity", "dataType": "string" } ], "viewKeys": { "uniqueKey": [], "preferenceKey": "grid-Certificate" }, "modelNameMapping": { "vAnalytics": "Analytics", "vSmart": "Controller", "vManage": "Manager", "Cloud OnRamp": "Cloud onRamp", "vBond": "Validator" } }, "data": [ { "configuredSystemIP": "172.16.255.26", "deviceType": "vbond", "serialNumber": "1234570F", "ncsDeviceName": "vbond-340ee9f9-1f65-45b8-8ac4-373c6c328a69", "configStatusMessage": "In Sync", "templateApplyLog": [ "[5-Jun-2024 12:00:43 UTC] Sync-from successful" ], "uuid": "340ee9f9-1f65-45b8-8ac4-373c6c328a69", "managementSystemIP": "172.16.255.26", "templateStatus": "Success", "chasisNumber": "340ee9f9-1f65-45b8-8ac4-373c6c328a69", "configStatusMessageDetails": "", "configOperationMode": "cli", "deviceModel": "vedge-cloud", "deviceState": "READY", "validity": "valid", "platformFamily": "vedge-x86", "hardwareVedge": false, "username": "--", "rootCertHash": "de482f840e1d005291436e9f2d5d3e46c4a26e5c", "state": "Installed", "globalState": "normal", "valid": "valid", "requestTokenID": "dedcbb2a-6e6c-44e0-b934-ce7fe225528e", "expirationDate": "Jun 05 11:51:45 2025 GMT", "expirationDateLong": 1749124305000, "deviceIP": "172.16.255.26", "activity": [ "Installed" ], "certInstallStatus": "Installed", "personality": "vbond", "expirationStatus": "normal", "uploadSource": "Auto Discovered", "timeRemainingForExpiration": 31483095250, "solution": "common", "local-system-ip": "172.16.255.26", "system-ip": "172.16.255.26", "model_sku": "None", "host-name": "vm16", "sp-organization-name": "vIPtela Inc Regression", "version": "20.15.0-12", "vbond": "10.0.12.26", "vmanage-system-ip": "172.16.255.26", "vmanageConnectionState": "connected", "lastupdated": 1717644904626, "reachability": "reachable", "uptime-date": 1717586580000, "defaultVersion": "20.15.0-12", "organization-name": "vIPtela Inc Regression", "availableVersions": [], "lifeCycleRequired": true, "hardwareCertSerialNumber": "NA", "subjectSerialNumber": "NA", "resourceGroup": "global", "id": "NA", "tags": [], "draftMode": "Disabled", "device-lock": "No", "managed-by": "Unmanaged" }, { "configuredSiteId": "200", "configuredSystemIP": "172.16.255.22", "deviceType": "vmanage", "serialNumber": "1234570D", "ncsDeviceName": "vmanage-c1161cf1-3655-4595-bf3d-27cda3004c06", "configStatusMessage": "In Sync", "templateApplyLog": [ "[5-Jun-2024 20:34:54 PDT] Sync-from successful" ], "uuid": "c1161cf1-3655-4595-bf3d-27cda3004c06", "managementSystemIP": "0.0.0.0", "templateStatus": "Success", "chasisNumber": "c1161cf1-3655-4595-bf3d-27cda3004c06", "configStatusMessageDetails": "", "configOperationMode": "cli", "deviceModel": "vmanage", "deviceState": "READY", "validity": "valid", "platformFamily": "vmanage", "hardwareVedge": false, "username": "--", "rootCertHash": "de482f840e1d005291436e9f2d5d3e46c4a26e5c", "CSR": "vmanage-c1161cf1-3655-4595-bf3d-27cda3004c06-0.viptela.com", "CSRDetail": "-----BEGIN CERTIFICATE REQUEST-----\nMIIFWDCCA0ACAQAwgdcxCzAJBgNVBAYTAlVTMRMwEQYDVQQIEwpDYWxpZm9ybmlh\nMREwDwYDVQQHEwhTYW4gSm9zZTEfMB0GA1UECxMWdklQdGVsYSBJbmMgUmVncmVz\nc2lvbjEWMBQGA1UEChMNQ2lzY28gU3lzdGVtczFDMEEGA1UEAxM6dm1hbmFnZS1j\nMTE2MWNmMS0zNjU1LTQ1OTUtYmYzZC0yN2NkYTMwMDRjMDYtMC52aXB0ZWxhLmNv\nbTEiMCAGCSqGSIb3DQEJARYTc3VwcG9ydEB2aXB0ZWxhLmNvbTCCAiIwDQYJKoZI\nhvcNAQEBBQADggIPADCCAgoCggIBAKnV5Uy7YP7rjV1dvz12FTJomNsM3Fbye+VE\nCiEo2bMOqtTRqvm7VSB3EaULbZgPNw5TfFxEHlvYyuLjPi2n5e5cBOCnMmfDnI4F\n254EekrsYWwrjVPRCdSmSCIwdKAM7hMxtlt68NqAPrn2dBahFZFXEbVPo4QHwdg4\nNPjfY1g73/2pdQNCtGi1+ZaDqB805Eoivdj8+6VZhGp+pPCdHM9Jfmi8SaOu/kAD\np0R0D7SnGDkjnrAAvZbMUYmJ9V2mG0owmogE8DRy56BD7W0lA36K3T63rjU6Jq/8\nrdItymgJHmKee3NoztBUdkKkKR695SkLU+bJx2xv7c8zZuD7z4YEX1JBqyppq5vY\ncChaIlzcVAVMOhc2M4CQTCBwgk2hhucklzdVVmcHfIcIObFUVnu6qrT7v1Og7AvB\nHQIqr13hAbyKEG8ZXoztACTrjmWxrlKrpdzThRmpaOZODROs4zUDAgTrx0gmZ98h\nZQJ2YNyShS2v4h9FETXcUYH6yW616lXo5h3qB35Vrs0IKaWJLI8y5GRlSNpylqJS\n92wpvMD3yYJIgZ+6SzOk+opNnmL0HlUW9g3UWHawDYQTZNYiAonhTPYvACky3Tpb\n9PWqXWHzaxzq+pRuNbO0MfcjGXUQr4coFymb1oYYOn6+l1HBYAlDVj8PqUrlFqm8\nMSz5xaedAgMBAAGgOzA5BgkqhkiG9w0BCQ4xLDAqMAkGA1UdEwQCMAAwHQYDVR0O\nBBYEFFMWOUNr5K8j/GjjRZkAOenJpMDbMA0GCSqGSIb3DQEBCwUAA4ICAQBu7vXf\nfGBSYFri/UXPWUlnRLf4bvIo5iJVxt/PCw3+V681lCBfJp/cGo6uHKsOWJ4N84DH\nlmidgVUK2lYtI3NbRQJfeu20NhAX4wD4CPTIZHG5f5r06qgyS633og6D2ISddg5F\n+RpyVXfsYIBVT0MydVMrDT1PWOaq7dvJ18WaesWXWtAHorgees1wMBiXaWjHR7f2\n7x315QzHlEYEoO0JECkt0EBcwju1HLgJD3ow66NTi9CLu/RR+wSg31NpjlxK4is+\n8eh/GII2xJwwrxQ4eJv4Ogmt7FchbPQtDaezZu0L8BqJcvyWAv+KEGzRKXncxULM\n3edGVrEHH0NkRYUcK4WqN4z3fDPRcSt+1TwWelZhyR2FVT1xUp0/i8Lmbu1QU4Da\njTID1ixdGJdUpMVEuVwTTtqXN6Nf0oWsKOe06prX9xVTrCYVCqnsRroCSiVgkOAZ\nWFgnonUH9smzWnCZeLtb43rLihcdYoolC1xFvQcC9VspuVmSzpO/FM0v02mR4UnJ\nrWQZ+kDrbhPy7OldBEv1DdAEExVZkK1otO9AKRqGP6e8cMFL+Ui4D82Yh/TukQO2\nX9Z4S5T+wTu1txVUXWLwrnUd3mur8caXs13NeRpINIXPjHQf8G+zM/C2L9AZ1bVz\neN0u1l3WpURqBUmJj+9br8AqRURIikoWxA4SCQ==\n-----END CERTIFICATE REQUEST-----", "certificateDetail": "-----BEGIN CERTIFICATE-----\nMIIEmDCCA4ACBBI0Vw0wDQYJKoZIhvcNAQELBQAwbTELMAkGA1UEBhMCVVMxEzAR\nBgNVBAgMCkNhbGlmb3JuaWExETAPBgNVBAcMCFNhbiBKb3NlMRQwEgYDVQQKDAt2\nSVB0ZWxhIEluYzEgMB4GCSqGSIb3DQEJARYRbm9yZXBseUBjaXNjby5jb20wHhcN\nMjQwNjA1MTE1MTI1WhcNMjUwNjA1MTE1MTI1WjCBszERMA8GA1UEBxMIU2FuIEpv\nc2UxCzAJBgNVBAYTAlVTMRMwEQYDVQQIEwpDYWxpZm9ybmlhMRYwFAYDVQQKEw1D\naXNjbyBTeXN0ZW1zMR8wHQYDVQQLExZ2SVB0ZWxhIEluYyBSZWdyZXNzaW9uMUMw\nQQYDVQQDEzp2bWFuYWdlLWMxMTYxY2YxLTM2NTUtNDU5NS1iZjNkLTI3Y2RhMzAw\nNGMwNi0wLnZpcHRlbGEuY29tMIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKC\nAgEAqdXlTLtg/uuNXV2/PXYVMmiY2wzcVvJ75UQKISjZsw6q1NGq+btVIHcRpQtt\nmA83DlN8XEQeW9jK4uM+Lafl7lwE4KcyZ8OcjgXbngR6SuxhbCuNU9EJ1KZIIjB0\noAzuEzG2W3rw2oA+ufZ0FqEVkVcRtU+jhAfB2Dg0+N9jWDvf/al1A0K0aLX5loOo\nHzTkSiK92Pz7pVmEan6k8J0cz0l+aLxJo67+QAOnRHQPtKcYOSOesAC9lsxRiYn1\nXaYbSjCaiATwNHLnoEPtbSUDfordPreuNTomr/yt0i3KaAkeYp57c2jO0FR2QqQp\nHr3lKQtT5snHbG/tzzNm4PvPhgRfUkGrKmmrm9hwKFoiXNxUBUw6FzYzgJBMIHCC\nTaGG5ySXN1VWZwd8hwg5sVRWe7qqtPu/U6DsC8EdAiqvXeEBvIoQbxlejO0AJOuO\nZbGuUqul3NOFGalo5k4NE6zjNQMCBOvHSCZn3yFlAnZg3JKFLa/iH0URNdxRgfrJ\nbrXqVejmHeoHflWuzQgppYksjzLkZGVI2nKWolL3bCm8wPfJgkiBn7pLM6T6ik2e\nYvQeVRb2DdRYdrANhBNk1iICieFM9i8AKTLdOlv09apdYfNrHOr6lG41s7Qx9yMZ\ndRCvhygXKZvWhhg6fr6XUcFgCUNWPw+pSuUWqbwxLPnFp50CAwEAATANBgkqhkiG\n9w0BAQsFAAOCAQEAh83Rf2izgvRsaaK7bIPQzwSkcxyiPIan2ETfSSRZyJO4/0Hz\no6QU54HnOfxDvDvAYvaB0gv9sKiKG8vSJCglm7+RibdyOaHHCXepl4Bsk9InUKQD\nl+c/Gkdwlx6NwsDHAZ7JDAogE5Mcq2s2Zg28MQAfVPKt8ZNOTAY201dTmSiux0G2\nt9/V6DtyiWtJvSOZGXVzth3azRnnl3NHk9qv+jZN/suMXa6Ie3SEPnonececvOuU\nVpJ5nMe9gIh7vt/8HpIGjj+u810oylwQTDuZThAPo3YhIhSrJEll7QOZ1bzjK00e\nEn7qdGnmmN+WGjHANIfDga8/p0Q5SlPhpPkNfQ==\n-----END CERTIFICATE-----", "state": "vBond Updated", "globalState": "normal", "valid": "valid", "requestTokenID": "46fcfa6f-970b-4ac9-93ce-153a8efdedcb", "expirationDate": "Jun 05 11:51:25 2025 GMT", "expirationDateLong": 1749124285000, "deviceIP": "172.16.255.22", "activity": [ "vBond Updated" ], "state_vedgeList": "Sync", "certInstallStatus": "Installed", "servicePersonality": "all", "personality": "vmanage", "expirationStatus": "normal", "timeRemainingForExpiration": 31483075250, "solution": "common", "domain-id": "0", "local-system-ip": "172.16.255.22", "system-ip": "172.16.255.22", "model_sku": "None", "site-id": "200", "host-name": "vm12", "sp-organization-name": "vIPtela Inc Regression", "version": "20.15.0-12", "vbond": "10.0.12.26", "vmanage-system-ip": "172.16.255.22", "vmanageConnectionState": "connected", "lastupdated": 1717644911366, "reachability": "reachable", "uptime-date": 1717586940000, "defaultVersion": "20.15.0-12", "organization-name": "vIPtela Inc Regression", "availableVersions": [], "lifeCycleRequired": false, "hardwareCertSerialNumber": "NA", "subjectSerialNumber": "NA", "resourceGroup": "global", "id": "NA", "tags": [], "draftMode": "Disabled", "site-name": "SITE_200", "device-lock": "No", "managed-by": "Unmanaged" }, { "configuredSiteId": "100", "configuredSystemIP": "172.16.255.19", "deviceType": "vsmart", "serialNumber": "1234570A", "ncsDeviceName": "vsmart-8ebb56fd-aa0f-4e65-8f9e-6998f56ff40d", "configStatusMessage": "In Sync", "templateApplyLog": [ "[5-Jun-2024 12:03:00 UTC] Sync-from successful" ], "uuid": "8ebb56fd-aa0f-4e65-8f9e-6998f56ff40d", "managementSystemIP": "172.16.255.19", "templateStatus": "Success", "chasisNumber": "8ebb56fd-aa0f-4e65-8f9e-6998f56ff40d", "configStatusMessageDetails": "", "configOperationMode": "cli", "deviceModel": "vsmart", "deviceState": "READY", "validity": "valid", "platformFamily": "vsmart", "hardwareVedge": false, "username": "--", "rootCertHash": "de482f840e1d005291436e9f2d5d3e46c4a26e5c", "state": "vBond Updated", "globalState": "normal", "valid": "valid", "requestTokenID": "1f8cf805-6058-4811-80a3-7d6727f5b5ee", "expirationDate": "Jun 05 11:51:17 2025 GMT", "expirationDateLong": 1749124277000, "deviceIP": "172.16.255.19", "activity": [ "vBond Updated" ], "certInstallStatus": "Installed", "personality": "vsmart", "expirationStatus": "normal", "uploadSource": "Auto Discovered", "timeRemainingForExpiration": 31483067250, "region-id": [], "solution": "sdwan", "policy-template-version": "", "domain-id": "1", "policy-template-name": "", "local-system-ip": "172.16.255.19", "system-ip": "172.16.255.19", "model_sku": "None", "site-id": "100", "host-name": "vm9", "sp-organization-name": "vIPtela Inc Regression", "version": "20.15.0-12", "vbond": "10.0.12.26", "vmanage-system-ip": "172.16.255.19", "vmanageConnectionState": "connected", "lastupdated": 1717644906473, "reachability": "reachable", "uptime-date": 1717586580000, "defaultVersion": "20.15.0-12", "organization-name": "vIPtela Inc Regression", "availableVersions": [], "lifeCycleRequired": false, "hardwareCertSerialNumber": "NA", "subjectSerialNumber": "NA", "resourceGroup": "global", "id": "NA", "tags": [], "draftMode": "Disabled", "site-name": "SITE_100", "device-lock": "No", "managed-by": "Unmanaged" }, { "configuredSiteId": "200", "configuredSystemIP": "172.16.255.20", "deviceType": "vsmart", "serialNumber": "1234570B", "ncsDeviceName": "vsmart-5fa14c76-4b50-4b9a-9e44-803881c5172d", "configStatusMessage": "In Sync", "templateApplyLog": [ "[5-Jun-2024 12:02:52 UTC] Sync-from successful" ], "uuid": "5fa14c76-4b50-4b9a-9e44-803881c5172d", "managementSystemIP": "172.16.255.20", "templateStatus": "Success", "chasisNumber": "5fa14c76-4b50-4b9a-9e44-803881c5172d", "configStatusMessageDetails": "", "configOperationMode": "cli", "deviceModel": "vsmart", "deviceState": "READY", "validity": "valid", "platformFamily": "vsmart", "hardwareVedge": false, "username": "--", "rootCertHash": "de482f840e1d005291436e9f2d5d3e46c4a26e5c", "state": "vBond Updated", "globalState": "normal", "valid": "valid", "requestTokenID": "005c43b2-ab84-4407-991c-d3bf621a7c44", "expirationDate": "Jun 05 11:51:16 2025 GMT", "expirationDateLong": 1749124276000, "deviceIP": "172.16.255.20", "activity": [ "vBond Updated" ], "certInstallStatus": "Installed", "personality": "vsmart", "expirationStatus": "normal", "uploadSource": "Auto Discovered", "timeRemainingForExpiration": 31483066250, "region-id": [], "solution": "sdwan", "policy-template-version": "", "domain-id": "1", "policy-template-name": "", "local-system-ip": "172.16.255.20", "system-ip": "172.16.255.20", "model_sku": "None", "site-id": "200", "host-name": "vm10", "sp-organization-name": "vIPtela Inc Regression", "version": "20.15.0-12", "vbond": "10.0.12.26", "vmanage-system-ip": "172.16.255.20", "vmanageConnectionState": "connected", "lastupdated": 1717644906446, "reachability": "reachable", "uptime-date": 1717586520000, "defaultVersion": "20.15.0-12", "organization-name": "vIPtela Inc Regression", "availableVersions": [], "lifeCycleRequired": false, "hardwareCertSerialNumber": "NA", "subjectSerialNumber": "NA", "resourceGroup": "global", "id": "NA", "tags": [], "draftMode": "Disabled", "site-name": "SITE_200", "device-lock": "No", "managed-by": "Unmanaged" } ] }, "$$ref": "#/components/examples/ComViptelaVmanageServerCertificateapiResponseExampleGetrecordresponse" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/certificate/reschedule/certificate/job": { "post": { "tags": [ "Certificate Management - Device" ], "summary": "Re-schedule Certificate Job", "description": "Re-scehdule certificate job", "operationId": "reScheduleCertificateJob", "requestBody": { "description": "Device IP", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "ReSchedule Job": { "description": "ReSchedule Job", "value": { "id": "genCSREdge.23f2a46f1713-19c2d44e-6aec-43bd-95b2-fd349b37689d", "scheduleAt": "1731051346" }, "$$ref": "#/components/examples/ComViptelaVmanageServerCertificateapiRequestExamplePostreschedulecertificatejobrequest" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "Task ID": { "description": "Task ID", "value": { "id": "b2b7525d-b68e-4ac3-962a-49d521352272" }, "$$ref": "#/components/examples/ComViptelaVmanageServerCertificateapiResponseExamplePostgeneratecsrasyncresponse" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/certificate/reset/rsa": { "post": { "tags": [ "Certificate Management - Device" ], "summary": "resetRSA for controllers", "description": "resetRSA for controllers", "operationId": "resetRSA", "requestBody": { "description": "JSON payload with deviceIP details for rsa reset", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "Reset RSA Request": { "description": "Reset RSA Request", "value": { "deviceIP": "10.103.128.128" }, "$$ref": "#/components/examples/ComViptelaVmanageServerCertificateapiRequestExamplePostresetrsarequest" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "Post Reset RSA Response": { "description": "Post Reset RSA Response", "value": { "header": { "columns": [ { "title": "Operation Status", "property": "state", "colorProperty": "globalState", "color": [ { "key": "Error", "value": "ef5350" } ], "width": 130, "dataType": "string" }, { "title": "Controller Type", "property": "deviceType", "display": "keyvalue", "keyvalueProperty": "deviceType", "keyvalue": [ { "key": "vsmart", "value": "vSmart" }, { "key": "vbond", "value": "vBond" }, { "key": "vmanage", "value": "vManage" }, { "key": "vedge", "value": "WAN Edge" } ], "width": 120, "dataType": "string" }, { "title": "Hostname", "property": "host-name", "width": 150, "dataType": "string" }, { "title": "System IP", "property": "local-system-ip", "width": 120, "dataType": "ipv4" }, { "title": "Site ID", "property": "site-id", "width": 70, "dataType": "numberStr" }, { "title": "Certificate Serial", "property": "serialNumber", "width": 150, "dataType": "string" }, { "title": "Expiration Date", "property": "expirationDateLong", "displayFormat": "DD MMM YYYY h:mm:ss A z", "inputFormat": "unix-time", "colorProperty": "expirationStatus", "color": [ { "key": "warning", "value": "ffb300" }, { "key": "invalid", "value": "ef5350" } ], "width": 200, "dataType": "date" }, { "title": "uuid", "property": "uuid", "editable": false, "dataType": "string" }, { "title": "vEdge List Status", "property": "state_vedgeList", "minWidth": 80, "dataType": "string" }, { "title": "Device IP", "property": "deviceIP", "width": 120, "dataType": "ipv4" } ], "fields": [ { "property": "state", "dataType": "string" }, { "property": "deviceType", "dataType": "string", "display": "keyvalue" }, { "property": "certInstallStatus", "dataType": "string" }, { "property": "host-name", "dataType": "string" }, { "property": "system-ip", "dataType": "ipv4" }, { "property": "local-system-ip", "dataType": "ipv4" }, { "property": "site-id", "dataType": "numberStr" }, { "property": "username", "dataType": "string" }, { "property": "password", "dataType": "string" }, { "property": "CSR", "dataType": "string" }, { "property": "CSRDetail", "dataType": "string" }, { "property": "CertificateDetail", "dataType": "string" }, { "property": "serialNumber", "dataType": "string" }, { "property": "expirationDate", "dataType": "string" }, { "property": "expirationDateLong", "dataType": "date" }, { "property": "valid", "dataType": "string" }, { "property": "errorDetail", "dataType": "string" }, { "property": "requestTokenID", "dataType": "string" }, { "property": "uuid", "dataType": "string" }, { "property": "state_vedgeList", "dataType": "string" }, { "property": "deviceIP", "dataType": "ipv4" }, { "property": "errorDetail_vedgelist", "dataType": "string" }, { "property": "activity", "dataType": "string" } ], "viewKeys": { "uniqueKey": [], "preferenceKey": "grid-MultiTenantCertificate" }, "modelNameMapping": { "vAnalytics": "Analytics", "vSmart": "Controller", "vManage": "Manager", "Cloud OnRamp": "Cloud onRamp", "vBond": "Validator" } }, "data": [ { "globalState": "normal", "timeRemainingForExpiration": 31430997892, "certInstallStatus": "Installed", "activity": [ "[6-Jun-2024 5:23:36 UTC] CSR Generated" ], "expirationStatus": "normal", "deviceCSR": "-----BEGIN CERTIFICATE REQUEST-----\nMIIFTzCCAzcCAQAwgc4xCzAJBgNVBAYTAlVTMRMwEQYDVQQIEwpDYWxpZm9ybmlh\nMREwDwYDVQQHEwhTYW4gSm9zZTEYMBYGA1UECxMPRENBIEFVVCBWTUFOQUdFMRYw\nFAYDVQQKEw1DaXNjbyBTeXN0ZW1zMUEwPwYDVQQDEzh2Ym9uZC1iMzY4ZmYxYS02\nNDBjLTQ0NDAtOGY0ZC0xMzgwZWY4NmQ0ZTYtMi52aXB0ZWxhLmNvbTEiMCAGCSqG\nSIb3DQEJARYTc3VwcG9ydEB2aXB0ZWxhLmNvbTCCAiIwDQYJKoZIhvcNAQEBBQAD\nggIPADCCAgoCggIBAMzZeBy/9zMfvR0flv1Qz9YkXzZfyrksKE0GcWg6AV1XYzPS\nNGFg+iFsv+UV08LtMOXoAcUDDRAllWTU4Q4fvUKGnmdf6yHjM5+K0DeqY+dBVjRl\nFOc/rKN49WDIvn/6oQosg8R0soF3eWFiN2cBtyFvqTU9AQqBXWpNEhQOphC78oMV\nfMn9xr/Otex2ElJiVW+Uv10KNUhKj+NeKXx60kT89phmv8cWJZO6+iPqTn5DscqM\nfUBt0tEK2SC1BdR52oMGi9TMefEXT55NZtwEGF+oezuOMbdvNSvvRJ7SY8mKtOw7\nL/PFSLHpZi2gbaqpWT2D+h9Jr6osezNjHfufsywjxJi8BZcW3VAv0wW4qkfKXuMs\ncERHvbgGNqlSvYmef9BUU+bNMM+sIMFI4vTByQ4dyuHU2ETHjmonxY+jmb7zcL4T\nYgLbkGaDE/pp1lWCVscdV3MT1yyXClETn8zKlvnx3SrDJUyPfpvXN10nAHCtQDv9\nO1XgcWKa/OM4LTQkyBjQVx6Eje4W17MJ60pT/+bl4se+S8uiO7tyERY4lgvZK3mj\nQTP4+GEoZRUX5xuB/lEw7v65Q6QP+djGPlI4r180lIALS43kRiOCilbuEsVNgmjk\n6mnMYdDd46a6xSLyvnzu09IxLSR/R5moqKW+HSgL6pCEwLaU47CS6gdqjBR7AgMB\nAAGgOzA5BgkqhkiG9w0BCQ4xLDAqMAkGA1UdEwQCMAAwHQYDVR0OBBYEFCPwD3W9\nLSG8Y+Jzudu4CzH/caLUMA0GCSqGSIb3DQEBCwUAA4ICAQBhdnQWTJc9ceQCsahV\nJB2gBu+XVXNbQbktWuQubOTvyLJORu0UuU4Qn4Q34eYcIny74TvHsCvBDJZ8mRBZ\n3wVm+hB8LTRa80KYLLnCjCOthGH8fFZBnII20SnMLiP5kcLe/FWDOghlwTIpvMI2\nJfFerO5cuzd3orkPXFbHL8J6hpe0HXhIM1aNSn3M/1d87DA6vT5GYPzy0BLRb8Qo\nvARcoKSCgl/6tp6djR+3PaEPc3nRyUOX4Ucra9RE8J0SntjT1Y7OBaGBtT8zsaLc\nVHud1RPbI8v9nDK9ynxS7i04ukfGnuFVNXais9IgfPhzbHPig0gvrse5I6xtQfnO\n3XNi0Aod6ryxKj5jr9unYPzyBJBvnPJsfZboYHsQslYkbVVNRCGa1S2/GfxPhC6u\nobEdw5/0liP8h8KM87LhD98dctxYayqSPd5Tfqn60FfVWyNY1LaymsOJVYqFQrYx\nIO+4jXhAh/COu6wF6HlS8uQ/Ai7z1adYqQqQFpMor7uyEU/bKN+xfbS9zd7kyApN\nyNHTaDBE4GvYI0I2nidxHFOmW6eqf6PE2oEl5dQ1/sCvpJZUE7pQXT5UkvUnmiXJ\nWRnEEplhZUNkPBYmWuwarZlLN8I0YD70+5x7xRgfDel5TddQaWx6f+07GHcjvti3\nfx73e2hX4jagcPV3rDiqG7vmYw==\n-----END CERTIFICATE REQUEST-----", "uuid": "b368ff1a-640c-4440-8f4d-1380ef86d4e6", "certificateDetail": "-----BEGIN CERTIFICATE-----\nMIIEjzCCA3cCBBI0VxEwDQYJKoZIhvcNAQELBQAwbTELMAkGA1UEBhMCVVMxEzAR\nBgNVBAgMCkNhbGlmb3JuaWExETAPBgNVBAcMCFNhbiBKb3NlMRQwEgYDVQQKDAt2\nSVB0ZWxhIEluYzEgMB4GCSqGSIb3DQEJARYRbm9yZXBseUBjaXNjby5jb20wHhcN\nMjQwNjA0MDUyMTMwWhcNMjUwNjA0MDUyMTMwWjCBqjERMA8GA1UEBxMIU2FuIEpv\nc2UxCzAJBgNVBAYTAlVTMRMwEQYDVQQIEwpDYWxpZm9ybmlhMRYwFAYDVQQKEw1D\naXNjbyBTeXN0ZW1zMRgwFgYDVQQLEw9EQ0EgQVVUIFZNQU5BR0UxQTA/BgNVBAMT\nOHZib25kLWIzNjhmZjFhLTY0MGMtNDQ0MC04ZjRkLTEzODBlZjg2ZDRlNi0wLnZp\ncHRlbGEuY29tMIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEAvG3L3pvH\nmKQsLmC0wSWEKNa2Sk2ssdKCPShHW6gRV04KEAWnf3eOtoYTUwupNxBGAMbyFl4h\nJG2rDJQgdjWMq0iz3unyt27C9U47TdrRk6rA3o/+xkXZPpuNQslaUiNu8KZqHJ2o\nQS4XkNuoBRTTKbShROLa1CuNTlq2KUbgiVIiwAb5uQSN7nnqNW21xV2Oy3OtrwfZ\nGG3zmJdH+09VbS+rWSYZFtFYCz68Uc9I9jC1YnaNLGWGydstX3m7QRyzlbnQg0aj\ntTcpLM9MBrU4qbyGOqhk2iu4a+xXKsG1XCgQHcpSh2LV1wXOZMuAPJQqfY57H86v\n7aFywDyMZvftqvkaIWVGQ52RfHElpPt4kRrnvNIOtIe1WhPJncBTGVh6NIASIMTu\nA20BVwuHa1yNlLhyuB4WQwVOhiDw/4exbqNq9w0lzqPXajDY53sTHa+ULcBZm26Y\nnejQizOkrvmBPZqHcdk9QPL3MH8XdbsbOdP4lVVdbpmaZOGxM46u/AmpQTq9pUor\nfqnfsh+4Zbqi9v604B0P7iuv5HfKJpTSJLRdJ1H06mX/M+uduovN4TU2aDa6GR5F\nqgiZdHTH6B634Jh02CrtCftExFT1rliK9jbYWxn5R1U1yCLXTp5Q/1zdZoXmI6D3\nhA0Zf0PKQwL1QtJJeQvMNuHhOhHZz/H3hGUCAwEAATANBgkqhkiG9w0BAQsFAAOC\nAQEAimacxUFDKW2A5Ytes/Wt/MD0iS0BXeHvmRM29jAjnJKGZfLibUERZewTmfYT\nAJj2Ll6sB1uVlrvfcZCvGPxy9EW0AGoglWSdTZQHBNSFTAOIciXKCiVhyach/0eU\nm6j00QrfZn/NmwdpkY27mo/s0hGgE+44If6X2zPOUEpC/XdTVxbqoeI2YZfK33c8\nieuLk7+b0u5kYW+sYhsc2MXOnd8YDmHaRth5i8D9EDgkY0kt9V0q8FkUl/hcXFaL\nkYvgfh3Os1Yq3WgOg2uX2ehulf5UzhMB46BXo3yarpERiDarFJpPcP+M3/TfXnBB\nqla9scqUUK7SfExJ5PZ2ViBSSA==\n-----END CERTIFICATE-----", "platformFamily": "vedge-x86", "valid": "N/A", "createdAt": "04 Jun 2024 05:29:00 UTC", "password": "Cisco#123@Viptela", "@rid": 4421, "personality": "vedge", "chasisNumber": "b368ff1a-640c-4440-8f4d-1380ef86d4e6", "configOperationMode": "cli", "state": "CSR Generated", "expirationDate": "Jun 04 05:21:30 2025 GMT", "deviceType": "vbond", "deviceIP": "10.103.128.128", "CSR": "vbond-b368ff1a-640c-4440-8f4d-1380ef86d4e6-0.viptela.com", "serialNumber": "12345711", "rootCertHash": "392fb5cdc1dc4156d289359095185263b69b53c6", "deviceCSRGenTimeString": "Jun 06 05:23:36 2024 UTC", "ncsDeviceName": "vbond-b368ff1a-640c-4440-8f4d-1380ef86d4e6", "org": "DCA AUT VMANAGE", "deviceCSRCommonName": "vbond-b368ff1a-640c-4440-8f4d-1380ef86d4e6-2.viptela.com", "requestTokenID": "N/A", "CSRDetail": "-----BEGIN CERTIFICATE REQUEST-----\nMIIFTzCCAzcCAQAwgc4xCzAJBgNVBAYTAlVTMRMwEQYDVQQIEwpDYWxpZm9ybmlh\nMREwDwYDVQQHEwhTYW4gSm9zZTEYMBYGA1UECxMPRENBIEFVVCBWTUFOQUdFMRYw\nFAYDVQQKEw1DaXNjbyBTeXN0ZW1zMUEwPwYDVQQDEzh2Ym9uZC1iMzY4ZmYxYS02\nNDBjLTQ0NDAtOGY0ZC0xMzgwZWY4NmQ0ZTYtMC52aXB0ZWxhLmNvbTEiMCAGCSqG\nSIb3DQEJARYTc3VwcG9ydEB2aXB0ZWxhLmNvbTCCAiIwDQYJKoZIhvcNAQEBBQAD\nggIPADCCAgoCggIBALxty96bx5ikLC5gtMElhCjWtkpNrLHSgj0oR1uoEVdOChAF\np393jraGE1MLqTcQRgDG8hZeISRtqwyUIHY1jKtIs97p8rduwvVOO03a0ZOqwN6P\n/sZF2T6bjULJWlIjbvCmahydqEEuF5DbqAUU0ym0oUTi2tQrjU5atilG4IlSIsAG\n+bkEje556jVttcVdjstzra8H2Rht85iXR/tPVW0vq1kmGRbRWAs+vFHPSPYwtWJ2\njSxlhsnbLV95u0Ecs5W50INGo7U3KSzPTAa1OKm8hjqoZNoruGvsVyrBtVwoEB3K\nUodi1dcFzmTLgDyUKn2Oex/Or+2hcsA8jGb37ar5GiFlRkOdkXxxJaT7eJEa57zS\nDrSHtVoTyZ3AUxlYejSAEiDE7gNtAVcLh2tcjZS4crgeFkMFToYg8P+HsW6javcN\nJc6j12ow2Od7Ex2vlC3AWZtumJ3o0IszpK75gT2ah3HZPUDy9zB/F3W7GznT+JVV\nXW6ZmmThsTOOrvwJqUE6vaVKK36p37IfuGW6ovb+tOAdD+4rr+R3yiaU0iS0XSdR\n9Opl/zPrnbqLzeE1Nmg2uhkeRaoImXR0x+get+CYdNgq7Qn7RMRU9a5YivY22FsZ\n+UdVNcgi106eUP9c3WaF5iOg94QNGX9DykMC9ULSSXkLzDbh4ToR2c/x94RlAgMB\nAAGgOzA5BgkqhkiG9w0BCQ4xLDAqMAkGA1UdEwQCMAAwHQYDVR0OBBYEFGYy6dzR\nVv57KFup3rzrNNlSUvb/MA0GCSqGSIb3DQEBCwUAA4ICAQBckqAWr/QlzV8HUrQh\n1xE6fiI/zqnwfCy0lbgFbV33PiGxzB37Sv0EtaZi+8Ik68dbsNCADv9zx4LRnHeW\nyWh4/ndhoEgcs7B5yQOAAmtNkKkcQ7THw40QuoVabJIwgY94G3BLW4HnrexsWBoz\nXVD/4AznZo4LhOutMgfEzolbMR/2ptcXnuiFIXsozrUsLSmC4iWpj2emyuy7GjnA\nuv+GEBAkjUjp60LZBkx3W12jXvKNxPTOSyjlnpmviEJhNM7JmItpFJ1/YYsLtjny\n2zScPOwwHscKcg1M4MTyxkMIM1Hxp123x7iHybblAvYoaiyTRrPTPmlxz+yy/jwY\nCNuovYTAVXpZPHAGLZShyHVf+SBRSv4t6qsgpUhl0EsOjP0eA+uVJobowoZ/2GMH\nudmNbTS2NSO5c3w6p+Enal0L71Vf9zhscnHU2U/WihSW70hJRIOpXM/VpdsVQ5oy\ntxjdFJbCVfdPPDKZUFdcQb+XGDx7FWYmUz147odlKh65olZgTyi16/k1YUVpMcUi\nGWbARNRngWpeh74uU3039wyq99kUIy8QqLPppbrNdlSnuazNw2rU6SlH4zU5LlhA\ngoKvR2olCL3Gif+7irPdQ6jzr3R97baKgiYmwKQru/QYOFfY0ZgzW27wPFUVTZdg\nUyj7Zuv+tEwz/XL04KNpjiyd8g==\n-----END CERTIFICATE REQUEST-----", "quickConnectEligible": false, "managementSystemIP": "169.254.10.2", "deviceDay0Configuration": "", "state_vedgeList": "Sync", "deviceCSRGenTime": 1717651416963, "createdBy": "user", "tenantId": "57501bad-32a7-4f52-8f54-8547dcd7403e", "deviceModel": "vedge-cloud", "deviceState": "BRING_UP", "validity": "valid", "expirationDateLong": 1749014490000, "isMultiStepUpgradeSupported": true, "username": "admin" } ] }, "$$ref": "#/components/examples/ComViptelaVmanageServerCertificateapiResponseExamplePostresetrsaresponse" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/certificate/revoke/enterprise/certificate": { "post": { "tags": [ "Certificate Management - Device" ], "summary": "Revoking enterprise CSR for hardware vEdge", "description": "Revoking enterprise CSR for hardware vEdge", "operationId": "decommissionEnterpriseCSRForVedge", "requestBody": { "description": "JSON parameter with Device UUID", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "Revoke Enterprise Certificate Request": { "description": "Revoke Enterprise Certificate Request", "value": { "uuid": "bea4e788-6c70-4af1-b9d3-245d7d863fb2" }, "$$ref": "#/components/examples/ComViptelaVmanageServerCertificateapiRequestExamplePostrevokeenterprisecertificaterequest" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "Revoke Enterprise Certificate Response": { "description": "Revoke Enterprise Certificate Response", "value": { "id": "d3ed4d03-6de3-4464-9e01-ee1b67aa7c7d" }, "$$ref": "#/components/examples/ComViptelaVmanageServerCertificateapiResponseExamplePostrevokeenterprisecertificateresponse" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/certificate/rootcertchains": { "get": { "tags": [ "Certificate Management - Device" ], "summary": "get root cert chain", "description": "get root cert chain in the system", "operationId": "getRootCertChains", "parameters": [ { "name": "action", "in": "query", "description": "Action Parameter to fetch root cert chains", "required": true, "schema": { "type": "string" }, "examples": { "Verify": { "description": "Verify", "value": "verify" }, "Get": { "description": "Get", "value": "get" } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "properties": { "empty": { "type": "boolean" } }, "items": { "type": "string" }, "$$ref": "#/components/schemas/CertificateChain" }, "examples": { "Verify Action: Root Cert Chains Response": { "description": "Verify Action: Root Cert Chains Response", "value": { "verifyResult": "SUCCESS", "errorMessage": "All vManage node certificates are in root cert chain" }, "$$ref": "#/components/examples/ComViptelaVmanageServerCertificateapiResponseExampleGetrootcertchainsverifyactionresponse" }, "Get Action: Root Cert Chains Response": { "description": "Get Action: Root Cert Chains Response", "value": { "header": { "generatedOn": 1717692361704 }, "data": [ { "CommonName": "", "Issuer": "EMAILADDRESS=noreply@cisco.com, O=vIPtela Inc, L=San Jose, ST=California, C=US", "Subject": "EMAILADDRESS=noreply@cisco.com, O=vIPtela Inc, L=San Jose, ST=California, C=US", "SerialNumber": "000000", "FingerPrint": "1111111", "ExpirationDate": "Thu Feb 02 16:15:21 PST 2034", "Certificate": "-----BEGIN CERTIFICATE-----\nMIIDuzCCAqOgAwIBAgIUH6VYNd0QgmquUAB4XUv904/DLVcwDQYJKoZIhvcNAQEL\n...\n...\n1Hzz12pTu/P6mQxLlpf7wwAgCSeRuv9FqtG9zTzdnHcyv+NgmWJ4Jhk1aCdRZiI=\n-----END CERTIFICATE-----" }, { "CommonName": "Viptela SubCA", "Issuer": "CN=Internal Customer Root CA, O=Cisco, OU=Amazing", "Subject": "CN=Viptela SubCA, OU=Awesome, O=Cisco", "SerialNumber": "22222222", "FingerPrint": "333333333", "ExpirationDate": "Sat Aug 20 07:59:39 PDT 2050", "Certificate": "-----BEGIN CERTIFICATE-----\nMIIGgzCCBGugAwIBAgIJAbHPzE/pYgriMA0GCSqGSIb3DQEBCwUAMEcxETAPBgNV\n...\n...\nqjNuwGlGbykJmvgKTzCJNvR5ou1t6AGPZZrKTOh8CjRKiUawNtRV\n-----END CERTIFICATE-----" }, { "CommonName": "Internal Customer Root CA", "Issuer": "CN=Internal Customer Root CA, O=Cisco, OU=Amazing", "Subject": "CN=Internal Customer Root CA, O=Cisco, OU=Amazing", "SerialNumber": "4444444", "FingerPrint": "555555555", "ExpirationDate": "Sat Aug 20 07:59:40 PDT 2050", "Certificate": "-----BEGIN CERTIFICATE-----\nMIIFVTCCAz2gAwIBAgIJCZWli/nPSiuRMA0GCSqGSIb3DQEBCwUAMEcxETAPBgNV\n...\n...\n5Sk7lrpIwgJbGk5MioelArz+YFQCtSXIaXTRwHgJOvz3OBrDKMvk5jZfSQJcKVmm\nd6TPwUKXpgUZGoVSJF4yc+RrIWXYFUfBoQ==\n-----END CERTIFICATE-----" } ] }, "$$ref": "#/components/examples/ComViptelaVmanageServerCertificateapiResponseExampleGetrootcertchainsgetactionresponse" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "Certificate Management - Device" ], "summary": "update root cert chain", "description": "save root cert chain in the system", "operationId": "saveRootCertChain", "requestBody": { "description": "JSON payload with RootCertChain and Certificate details.", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "Root Cert Chain": { "description": "Root Cert Chain", "value": { "RootCertChain": [ { "Certificate": "-----BEGIN CERTIFICATE-----\nMIIDuzCCAqOgAwIBAgIUH6VYNd0QgmquUAB4XUv904/DLVcwDQYJKoZIhvcNAQEL\nBQAwbTELMAkGA1UEBhMCVVMxEzARBgNVBAgMCkNhbGlmb3JuaWExETAPBgNVBAcM\nCFNhbiBKb3NlMRQwEgYDVQQKDAt2SVB0ZWxhIEluYzEgMB4GCSqGSIb3DQEJARYR\nbm9yZXBseUBjaXNjby5jb20wHhcNMjQwMjA2MDAxNTIxWhcNMzQwMjAzMDAxNTIx\n...\n...\n...\n/4VdBMnQU6seHYGaYtnuPDqYQFppRB8uC8i/xNqblfpaw8HUzcuxVNjIk5cLVjzI\nk5sTq0ns3pvVi5XacNQtgLCLktqTVot89yx3+U8PphqOXk4ITMSNeyu3Tg/QjXGc\n1Hzz12pTu/P6mQxLlpf7wwAgCSeRuv9FqtG9zTzdnHcyv+NgmWJ4Jhk1aCdRZiI=\n-----END CERTIFICATE-----" } ] }, "$$ref": "#/components/examples/ComViptelaVmanageServerCertificateapiRequestExamplePutrootcertchainsrequest" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "Root Cert Chains Save Response": { "description": "Root Cert Chains Save Response", "value": { "saveResult": "SUCCESS", "errorMessage": "root cert has been saved and sent to all controllers" }, "$$ref": "#/components/examples/ComViptelaVmanageServerCertificateapiResponseExamplePutrootcertchainsresponse" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/certificate/rootcertificate": { "get": { "tags": [ "Certificate Management - Device" ], "summary": "Get device root certificate detail view", "description": "Get device root certificate detail view", "operationId": "getRootCertificate", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "properties": { "empty": { "type": "boolean" } }, "items": { "type": "string" }, "$$ref": "#/components/schemas/CertificateChain" }, "examples": { "Root Certificate Response": { "description": "Root Certificate Response", "value": { "rootcertificate": "-----BEGIN CERTIFICATE-----\nMIIG+zCCBOOgAwIBAgIUVGrBB5uvAc50vl/ZEQ0m6Xqh244wDQYJKoZIhvcNAQEL\nBQAwgZAxCzAJBgNVBAYTAlVTMRMwEQYDVQQIDApDYWxpZm9ybmlhMREwDwYDVQQH\nDAhTYW4gSm9zZTEOMAwGA1UECwwFTGFiQ0ExFDASBgNVBAoMC1ZpcHRlbGEgTExD\nMSAwHgYJKoZIhvcNAQkBFhFzdXBwb3J0QGxhYmNhLmNvbTERMA8GA1UEAwwITGFi\nQ0EgQ0EwHhcNMjMxMTI3MDkyMTIwWhcNMzMxMTI0MDkyMTIwWjCBkDELMAkGA1UE\n...\n...\n...\nzMd2hDPT7DC9wWFnD8lwRVACHQqxQmKr+1tWgaZJmZ4oVidA0rCUEWlS+PKM8F9W\nX7MIpoR0EWb0p4FzYVs3c/+MrtVDy2ekaojd27PhrP7Nc00gADmWmjAXXRK6RFHb\nXKYaXOK/co0/qIuTpE3XvuG9IxzuTL77G0VIpiXGwd9yZGEiGvPOmaHAfvIzmpSv\nwLKKmHnlnmQEgt5/cpg2R9rVl6L6LxGSRWtOinUatALjSJ7RgbeSlfAUR4jHIL3c\n6trUXHY9NGhCo1RN+F+8nLOBTYQ3oGOj\n-----END CERTIFICATE-----" }, "$$ref": "#/components/examples/ComViptelaVmanageServerCertificateapiResponseExampleGetrootcertificateresponse" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/certificate/rsakeylengthdefault": { "get": { "tags": [ "Certificate Management - Device" ], "summary": "Verify 2048-bit RSA key length on devices", "description": "Check if all devices in network use 2048-b RSA Key length for their device certs.", "operationId": "rsaKeyLength2048ForAllDevices", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "RSA Key Length Default": { "description": "RSA Key Length Default", "value": { "keyLength": "true" }, "$$ref": "#/components/examples/ComViptelaVmanageServerCertificateapiResponseExampleGetrsakeylengthdefaultresponse" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/certificate/save/vedge/list": { "post": { "tags": [ "Certificate Management - Device" ], "summary": "change VedgeList Validity", "description": "change VedgeList Validity", "operationId": "saveVEdgeList", "requestBody": { "description": "JSON payload with RootCertChain and Certificate details.", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "vEdge List": { "description": "vEdge List", "value": [ { "chasisNumber": "233497bc-69f7-43fe-a389-28bb719fef14", "validity": "valid", "sendToControllers": true } ], "$$ref": "#/components/examples/ComViptelaVmanageServerCertificateapiRequestExamplePostsavevedgelistrequest" }, "vEdge List with optional Serial Number parameter": { "description": "vEdge List with optional Serial Number parameter", "value": [ { "chasisNumber": "233497bc-69f7-43fe-a389-28bb719fef14", "validity": "valid", "serialNumber": "12345989", "sendToControllers": true } ], "$$ref": "#/components/examples/ComViptelaVmanageServerCertificateapiRequestExamplePostsavevedgelistoptionalparameterrequest" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "Save vEdge List Response": { "description": "Save vEdge List Response", "value": [ { "id": "bebb7f1a-7ef4-48f4-86bc-e349f11fe1d7", "sendToControllerId": "bebb7f1a-7ef4-48f4-86bc-e349f11fe1d7" } ], "$$ref": "#/components/examples/ComViptelaVmanageServerCertificateapiResponseExamplePostsavevedgelistresponse" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/certificate/stagingCert/status": { "post": { "tags": [ "Certificate Management - Device" ], "summary": "Status of staging certificate from edge device", "description": "Status of staging certificate from edge device", "operationId": "stagingCertificateStatus", "requestBody": { "description": "Payload", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Success Payload": { "description": "Success Payload", "value": { "chassisNumber": "C8K-f4423f04-355b-4c22-b6de-76f8d3e651b4", "deviceIP": "172.16.255.15", "status": "success" }, "$$ref": "#/components/examples/ComViptelaVmanageServerCertificateapiRequestExamplePoststagingcertificatesuccessrequest" }, "Failure Payload": { "description": "Failure Payload", "value": { "chassisNumber": "C8K-f4423f04-355b-4c22-b6de-76f8d3e651b4", "deviceIP": "172.16.255.15", "status": "failed" }, "$$ref": "#/components/examples/ComViptelaVmanageServerCertificateapiRequestExamplePoststagingcertificatefailurerequest" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "Staging Certificate Response": { "description": "Staging Certificate Response", "value": { "status": "success" }, "$$ref": "#/components/examples/ComViptelaVmanageServerCertificateapiResponseExamplePoststagingcertificateresponse" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/certificate/stats/detail": { "get": { "tags": [ "Certificate Management - Device" ], "summary": "Get certificate details", "description": "Get certificate details", "operationId": "getCertificateDetail", "parameters": [ { "name": "status", "in": "query", "description": "Certificate Status", "schema": { "type": "string" }, "examples": { "Normal": { "description": "Normal", "value": "normal" }, "Revoked": { "description": "Revoked", "value": "revoked" }, "Invalid": { "description": "Invalid", "value": "invalid" }, "Warning": { "description": "Warning", "value": "warning" }, "All": { "description": "All", "value": "all" }, "Null": { "description": "Null", "value": null } } }, { "name": "includeTenantvSmart", "in": "query", "description": "include tenant vSmart", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "properties": { "empty": { "type": "boolean" } }, "items": { "type": "string" }, "$$ref": "#/components/schemas/CertificateData" }, "examples": { "Stats Detail Response": { "description": "Stats Detail Response", "value": { "header": { "columns": [ { "title": "Controller Type", "property": "deviceType", "display": "keyvalue", "keyvalueProperty": "deviceType", "keyvalue": [ { "key": "vsmart", "value": "vSmart" }, { "key": "vbond", "value": "vBond" }, { "key": "vmanage", "value": "vManage" }, { "key": "vedge", "value": "WAN Edge" } ], "width": 120, "dataType": "string" }, { "title": "Hostname", "property": "host-name", "hideable": false, "dataType": "string" }, { "title": "System IP", "property": "local-system-ip", "hideable": false, "dataType": "ipv4" }, { "title": "Serial No", "property": "serialNumber", "dataType": "string" }, { "title": "Expiration Date", "property": "expirationDate", "hideable": false, "dataType": "string" }, { "title": "Expiration Status", "property": "expirationStatus", "dataType": "string" } ], "fields": [ { "property": "deviceType", "dataType": "string", "display": "keyvalue" }, { "property": "host-name", "dataType": "string" }, { "property": "local-system-ip", "dataType": "ipv4" }, { "property": "serialNumber", "dataType": "string" }, { "property": "expirationDate", "dataType": "string" }, { "property": "expirationStatus", "dataType": "string" } ], "viewKeys": { "uniqueKey": [], "preferenceKey": "grid-CertificateStatsDetail" }, "modelNameMapping": { "vAnalytics": "Analytics", "vSmart": "Controller", "vManage": "Manager", "Cloud OnRamp": "Cloud onRamp", "vBond": "Validator" } }, "data": [ { "configuredSystemIP": "172.16.255.26", "deviceType": "vbond", "serialNumber": "1234570F", "ncsDeviceName": "vbond-a612b6d5-1eb4-4e63-955e-078fed433dd7", "configStatusMessage": "In Sync", "templateApplyLog": [ "[14-May-2024 7:49:29 UTC] Sync-from successful" ], "uuid": "a612b6d5-1eb4-4e63-955e-078fed433dd7", "managementSystemIP": "0.0.0.0", "templateStatus": "Success", "chasisNumber": "a612b6d5-1eb4-4e63-955e-078fed433dd7", "configStatusMessageDetails": "", "configOperationMode": "cli", "deviceModel": "vedge-cloud", "deviceState": "READY", "validity": "valid", "platformFamily": "vedge-x86", "hardwareVedge": false, "username": "--", "rootCertHash": "9b4c84834b5c1ce7245f2043888107905e95b671", "CSR": "vbond-a612b6d5-1eb4-4e63-955e-078fed433dd7-0.viptela.com", "CSRDetail": "-----BEGIN CERTIFICATE REQUEST-----\nMIIFVjCCAz4CAQAwgdUxCzAJBgNVBAYTAlVTMRMwEQYDVQQIEwpDYWxpZm9ybmlh\nMREwDwYDVQQHEwhTYW4gSm9zZTEfMB0GA1UECxMWdklQdGVsYSBJbmMgUmVncmVz\nc2lvbjEWMBQGA1UEChMNQ2lzY28gU3lzdGVtczFBMD8GA1UEAxM4dmJvbmQtYTYx\nMmI2ZDUtMWViNC00ZTYzLTk1NWUtMDc4ZmVkNDMzZGQ3LTAudmlwdGVsYS5jb20x\nIjAgBgkqhkiG9w0BCQEWE3N1cHBvcnRAdmlwdGVsYS5jb20wggIiMA0GCSqGSIb3\nDQEBAQUAA4ICDwAwggIKAoICAQD6T7k7aKZX01YrtKklgXktI7g2NEU30U6+tgmf\nymOlZ7PwdFAVoNtM+VlC6NBzu20bzEfgeqoLh+jEfPBGQJKdIPw0PR6b3TgmM4Jy\niohlpYlm3la8ATRNAw/De49Q2NMV0CYHbbAxDYJ5LDISI+h+/SulkRBvnG/2T4Ca\nzAvj8pF9clYIUHQPJ054jtyO/vPI4i+NNEQ6FiUCeGLoeYCLonEkLtqkoTIxSAg9\nRjzGDRWxEzUyVrJ+gFEIYpH7EAC0pDL7cCa7hpOf0/Wd5K4jxfmoihSchsdSWt01\n+h3d5ZUvsNVu8vm8lmR7kc7TRDDJTw9zoFJXYTHdBGkBo2hjn0mspVlQOJytumtr\nL1ilxuAFJW1QNH8fjmD5jYNhUFE0UHQbAU4lFSJO5q5eoQrTdfHkgxhrRxbXMWqr\nFgsQohHD/hJEoQGInmwnWRKZUX1rJEmZU52QXnguWJ6Qaq25di+A0iPst1dHzIty\nWeLwkiUPvuXvzFwaqbGcaDxz0h/BiuBFOR90VyFY3Wu61s2I0BXbbcHNHwv3bizn\nCovHWMgAbTXtWJfohgs8ZydSvEjBa/Q0ZPKw7Uc8EVM373DpU+PXIcUaQAXssO4D\nq//Y9sNTAaQaHR05OTusxYozfjywzabf/FCqbHBFrfVhmYbTBqqEEwHdjU5fwHbx\n5dcYcQIDAQABoDswOQYJKoZIhvcNAQkOMSwwKjAJBgNVHRMEAjAAMB0GA1UdDgQW\nBBT3rCTZkrVvqhpyLjlUFr11d5cJWDANBgkqhkiG9w0BAQsFAAOCAgEA1NgAMSi5\n3K+krUgLjWKIp+AuLmrOoT0sWZckxM0VO+qEWekyFCuCSuTimclGatC8IF8KEHp/\nUDUMFgd/Gw+9799nQBAYh9TA9l8/itCiI5dCaHYr0rE22iLuFQNvqxQq9q8mGiPC\nJRnA9hpzAz3lM5Ux/QmXVRByTL4HAg9V0BrNqFYMqOsoWLNN+xYx+gXQ6hwuOiB9\n2f8nvgEn2ECcvLRIjoAUKhPShX5ljEhYFPtxG29e/ECcRyjGU3JLr4Qa//hHiVGC\n8jVu7MjWFeFBhx7XwhYZCaP6hCPUo+14bADV5F2+0fxmFQwhXiEZ5uDRIVacuDS5\n3lihqe5oEx5AkP7GM4KRytzZl5bjF1gxgt56TpFvUoBop52VQZWQof4DkhgJrEQ2\ngA5iInCj/+nJHulryfnMx15q8pkWzJAkyID3ZtcVzdpP0v98vxTXbSUi2G10mgT5\n6ktxnHLyV3WAsEg+SWEuVwbqPuaN8F8+Wvb/pHtCT8tTstnFch/CKKDlft1Zn9Vu\n38IJS6yDBgHb4BxM/sjIbRiAqHntnvxITR4yUwW2dvkTG36tY9qARt9VV3BjCUM6\nHC9fXvpu11C8wtR+W/Dpf6vf9hOBQIi5AhNivyvqTqZMGARPdyH22QE8PbYvae8i\nuPO8ujInOuYeQEkpCJJ7O4r+uhDCZ96XQUk=\n-----END CERTIFICATE REQUEST-----", "certificateDetail": "-----BEGIN CERTIFICATE-----\nMIIEljCCA34CBBI0Vw8wDQYJKoZIhvcNAQELBQAwbTELMAkGA1UEBhMCVVMxEzAR\nBgNVBAgMCkNhbGlmb3JuaWExETAPBgNVBAcMCFNhbiBKb3NlMRQwEgYDVQQKDAt2\nSVB0ZWxhIEluYzEgMB4GCSqGSIb3DQEJARYRbm9yZXBseUBjaXNjby5jb20wHhcN\nMjQwNTE0MDczNzU5WhcNMjUwNTE0MDczNzU5WjCBsTERMA8GA1UEBxMIU2FuIEpv\nc2UxCzAJBgNVBAYTAlVTMRMwEQYDVQQIEwpDYWxpZm9ybmlhMRYwFAYDVQQKEw1D\naXNjbyBTeXN0ZW1zMR8wHQYDVQQLExZ2SVB0ZWxhIEluYyBSZWdyZXNzaW9uMUEw\nPwYDVQQDEzh2Ym9uZC1hNjEyYjZkNS0xZWI0LTRlNjMtOTU1ZS0wNzhmZWQ0MzNk\nZDctMC52aXB0ZWxhLmNvbTCCAiIwDQYJKoZIhvcNAQEBBQADggIPADCCAgoCggIB\nAPpPuTtoplfTViu0qSWBeS0juDY0RTfRTr62CZ/KY6Vns/B0UBWg20z5WULo0HO7\nbRvMR+B6qguH6MR88EZAkp0g/DQ9HpvdOCYzgnKKiGWliWbeVrwBNE0DD8N7j1DY\n0xXQJgdtsDENgnksMhIj6H79K6WREG+cb/ZPgJrMC+PykX1yVghQdA8nTniO3I7+\n88jiL400RDoWJQJ4Yuh5gIuicSQu2qShMjFICD1GPMYNFbETNTJWsn6AUQhikfsQ\nALSkMvtwJruGk5/T9Z3kriPF+aiKFJyGx1Ja3TX6Hd3llS+w1W7y+byWZHuRztNE\nMMlPD3OgUldhMd0EaQGjaGOfSaylWVA4nK26a2svWKXG4AUlbVA0fx+OYPmNg2FQ\nUTRQdBsBTiUVIk7mrl6hCtN18eSDGGtHFtcxaqsWCxCiEcP+EkShAYiebCdZEplR\nfWskSZlTnZBeeC5YnpBqrbl2L4DSI+y3V0fMi3JZ4vCSJQ++5e/MXBqpsZxoPHPS\nH8GK4EU5H3RXIVjda7rWzYjQFdttwc0fC/duLOcKi8dYyABtNe1Yl+iGCzxnJ1K8\nSMFr9DRk8rDtRzwRUzfvcOlT49chxRpABeyw7gOr/9j2w1MBpBodHTk5O6zFijN+\nPLDNpt/8UKpscEWt9WGZhtMGqoQTAd2NTl/AdvHl1xhxAgMBAAEwDQYJKoZIhvcN\nAQELBQADggEBAHxwQtoPVqKSughnviX6VLx5t4DGmYcPaJd36UlfkWzLKd4QByFx\nJbmAbkAZiauJcieXNdsPSPoiyg3bOnVgFXXrO//ZNpq0Z9bJi1i41ip3Kvv4Mi40\ngI8ZGVdniAceXBjNcxp8yqSmXqZ1FgF9UrvQ4Il+I9JlTAXNyGXxtVOcQxzYvL8G\nIr6dJPjcDnavJIKGl2910GRnyYnZrMXX/mq+ouev2l+EfVHbGTJlujz4LkHTwEWo\ne0Q5X6YxF6yZnFl87SdUBJ5Y9Pcu8S6WNFHFLVjj9sCbXhtbcA18+U8aYXn9Ml2T\n0Zp5Q8HWv1vCUrjuvUNGZwoyRJcYaRF1j6M=\n-----END CERTIFICATE-----", "state": "Installed", "globalState": "normal", "valid": "valid", "requestTokenID": "e5dbbddb-cd38-4ad0-be74-c0cc2f1b2cc9", "expirationDate": "May 14 07:37:59 2025 GMT", "expirationDateLong": 1747208279000, "deviceIP": "172.16.255.26", "activity": [ "Installed" ], "state_vedgeList": "Sync", "certInstallStatus": "Installed", "org": "vIPtela Inc Regression", "personality": "vbond", "expirationStatus": "normal", "timeRemainingForExpiration": 29724618454, "solution": "common", "host-name": "vm16", "system-ip": "172.16.255.26", "vbond": "10.0.12.26", "vmanageConnectionState": "connected", "local-system-ip": "172.16.255.26", "availableVersions": [], "defaultVersion": "20.15.0-12", "reachability": "reachable", "version": "20.15.0-12", "uptime-date": 1715669280000, "model_sku": "None", "lastupdated": 1717387842211, "vmanage-system-ip": "172.16.255.26", "sp-organization-name": "vIPtela Inc Regression", "organization-name": "vIPtela Inc Regression", "lifeCycleRequired": true, "hardwareCertSerialNumber": "NA", "subjectSerialNumber": "NA", "resourceGroup": "global", "id": "NA", "tags": [], "draftMode": "Disabled", "device-lock": "No", "managed-by": "Unmanaged" }, { "configuredSiteId": "600", "configuredSystemIP": "172.16.255.33", "deviceType": "vedge", "serialNumber": "12345710", "ncsDeviceName": "vedge-C8K-47056d0c-1d98-40e6-8fb6-7be44a5130c6", "configStatusMessage": "In Sync", "templateApplyLog": [ "[14-May-2024 7:55:34 UTC] Sync-from successful" ], "uuid": "C8K-47056d0c-1d98-40e6-8fb6-7be44a5130c6", "managementSystemIP": "172.16.255.33", "templateStatus": "Success", "chasisNumber": "C8K-47056d0c-1d98-40e6-8fb6-7be44a5130c6", "configStatusMessageDetails": "", "configOperationMode": "cli", "deviceModel": "vedge-C8000V", "deviceState": "READY", "validity": "valid", "platformFamily": "c8000v", "hardwareVedge": false, "username": "--", "rootCertHash": "9b4c84834b5c1ce7245f2043888107905e95b671", "deviceIP": "172.16.255.33", "personality": "vedge", "uploadSource": "Auto Discovered", "region-id": [], "solution": "sdwan", "site-id": "600", "host-name": "vm33", "system-ip": "172.16.255.33", "vbond": "vbond", "vmanageConnectionState": "connected", "local-system-ip": "172.16.255.33", "availableVersions": [], "defaultVersion": "17.15.01.0.459", "reachability": "reachable", "version": "17.15.01.0.459", "uptime-date": 1716547980000, "model_sku": "None", "lastupdated": 1717387848813, "vmanage-system-ip": "172.16.255.33", "domain-id": "1", "sp-organization-name": "vIPtela Inc Regression", "organization-name": "vIPtela Inc Regression", "lifeCycleRequired": true, "vedgeCertificateState": "certinstalled", "expirationDate": "NA", "hardwareCertSerialNumber": "NA", "subjectSerialNumber": "NA", "resourceGroup": "global", "id": "NA", "tags": [], "draftMode": "Disabled", "site-name": "SITE_600", "device-lock": "No", "managed-by": "Unmanaged" }, { "configuredHostname": "vm5", "configuredSiteId": "500", "configuredSystemIP": "172.16.255.15", "deviceType": "vedge", "serialNumber": "12345707", "ncsDeviceName": "vedge-C8K-a8a46ff4-0419-45bf-828d-198f831f8818", "configStatusMessage": "In Sync", "templateApplyLog": [ "[17-May-2024 5:28:20 UTC] Sync-from successful" ], "uuid": "C8K-a8a46ff4-0419-45bf-828d-198f831f8818", "managementSystemIP": "172.16.255.15", "templateStatus": "Success", "chasisNumber": "C8K-a8a46ff4-0419-45bf-828d-198f831f8818", "configStatusMessageDetails": "", "configOperationMode": "cli", "deviceModel": "vedge-C8000V", "deviceState": "READY", "validity": "valid", "platformFamily": "c8000v", "hardwareVedge": false, "username": "--", "rootCertHash": "9b4c84834b5c1ce7245f2043888107905e95b671", "deviceIP": "172.16.255.15", "personality": "vedge", "uploadSource": "Auto Discovered", "region-id": [], "solution": "sdwan", "site-id": "500", "host-name": "vm5", "system-ip": "172.16.255.15", "vbond": "vbond", "vmanageConnectionState": "connected", "local-system-ip": "172.16.255.15", "availableVersions": [], "defaultVersion": "17.15.01.0.459", "reachability": "reachable", "version": "17.15.01.0.459", "uptime-date": 1715669460000, "model_sku": "None", "lastupdated": 1717387247558, "vmanage-system-ip": "172.16.255.15", "domain-id": "1", "sp-organization-name": "vIPtela Inc Regression", "organization-name": "vIPtela Inc Regression", "lifeCycleRequired": true, "vedgeCertificateState": "certinstalled", "expirationDate": "NA", "hardwareCertSerialNumber": "NA", "subjectSerialNumber": "NA", "resourceGroup": "global", "id": "NA", "tags": [], "draftMode": "Disabled", "site-name": "SITE_500", "device-lock": "No", "managed-by": "Unmanaged" }, { "configuredSiteId": "300", "configuredSystemIP": "172.16.255.14", "deviceType": "vedge", "serialNumber": "12345706", "ncsDeviceName": "vedge-C8K-d18826d6-8b0a-4d86-ae64-2999c249d1d4", "configStatusMessage": "In Sync", "templateApplyLog": [ "[14-May-2024 10:28:59 UTC] Sync-from successful" ], "uuid": "C8K-d18826d6-8b0a-4d86-ae64-2999c249d1d4", "managementSystemIP": "172.16.255.14", "templateStatus": "Success", "chasisNumber": "C8K-d18826d6-8b0a-4d86-ae64-2999c249d1d4", "configStatusMessageDetails": "", "configOperationMode": "cli", "deviceModel": "vedge-C8000V-SD-ROUTING", "deviceState": "READY", "validity": "valid", "platformFamily": "c8000v", "hardwareVedge": false, "username": "--", "rootCertHash": "9b4c84834b5c1ce7245f2043888107905e95b671", "deviceIP": "172.16.255.14", "personality": "vedge", "uploadSource": "Auto Discovered", "region-id": [], "solution": "sd-routing", "site-id": "300", "host-name": "vm4", "system-ip": "172.16.255.14", "vbond": "vbond", "vmanageConnectionState": "connected", "local-system-ip": "172.16.255.14", "availableVersions": [], "defaultVersion": "17.15.01.0.459", "reachability": "reachable", "version": "17.15.01.0.459", "uptime-date": 1717376040000, "model_sku": "None", "lastupdated": 1717376181781, "domain-id": "1", "sp-organization-name": "vIPtela Inc Regression", "organization-name": "vIPtela Inc Regression", "lifeCycleRequired": true, "vedgeCertificateState": "certinstalled", "expirationDate": "NA", "hardwareCertSerialNumber": "NA", "subjectSerialNumber": "NA", "resourceGroup": "global", "id": "NA", "tags": [], "draftMode": "Disabled", "site-name": "SITE_300", "device-lock": "No", "managed-by": "Unmanaged" }, { "configuredSiteId": "400", "configuredSystemIP": "172.16.255.16", "deviceType": "vedge", "serialNumber": "12345708", "ncsDeviceName": "vedge-C8K-982b4863-b9ae-49c6-9bb5-f01d1fc8a053", "configStatusMessage": "In Sync", "templateApplyLog": [ "[14-May-2024 10:29:20 UTC] Sync-from successful" ], "uuid": "C8K-982b4863-b9ae-49c6-9bb5-f01d1fc8a053", "managementSystemIP": "172.16.255.16", "templateStatus": "Success", "chasisNumber": "C8K-982b4863-b9ae-49c6-9bb5-f01d1fc8a053", "configStatusMessageDetails": "", "configOperationMode": "cli", "deviceModel": "vedge-C8000V-SD-ROUTING", "deviceState": "READY", "validity": "valid", "platformFamily": "c8000v", "hardwareVedge": false, "username": "--", "rootCertHash": "9b4c84834b5c1ce7245f2043888107905e95b671", "deviceIP": "172.16.255.16", "personality": "vedge", "uploadSource": "Auto Discovered", "region-id": [], "solution": "sd-routing", "site-id": "400", "host-name": "vm6", "system-ip": "172.16.255.16", "vbond": "vbond", "vmanageConnectionState": "connected", "local-system-ip": "172.16.255.16", "availableVersions": [], "defaultVersion": "17.15.01.0.459", "reachability": "reachable", "version": "17.15.01.0.459", "uptime-date": 1716974340000, "model_sku": "None", "lastupdated": 1717364398912, "domain-id": "1", "sp-organization-name": "vIPtela Inc Regression", "organization-name": "vIPtela Inc Regression", "lifeCycleRequired": true, "vedgeCertificateState": "certinstalled", "expirationDate": "NA", "hardwareCertSerialNumber": "NA", "subjectSerialNumber": "NA", "resourceGroup": "global", "id": "NA", "tags": [], "draftMode": "Disabled", "site-name": "SITE_400", "device-lock": "No", "managed-by": "Unmanaged" }, { "configuredSiteId": "100", "configuredSystemIP": "172.16.255.21", "deviceType": "vedge", "serialNumber": "1234570D", "ncsDeviceName": "vedge-C8K-07e20cea-85f4-4d83-a205-fc2f4b756f86", "configStatusMessage": "In Sync", "templateApplyLog": [ "[14-May-2024 10:29:12 UTC] Sync-from successful" ], "uuid": "C8K-07e20cea-85f4-4d83-a205-fc2f4b756f86", "managementSystemIP": "172.16.255.21", "templateStatus": "Success", "chasisNumber": "C8K-07e20cea-85f4-4d83-a205-fc2f4b756f86", "configStatusMessageDetails": "", "configOperationMode": "cli", "deviceModel": "vedge-C8000V-SD-ROUTING", "deviceState": "READY", "validity": "valid", "platformFamily": "c8000v", "hardwareVedge": false, "username": "--", "rootCertHash": "9b4c84834b5c1ce7245f2043888107905e95b671", "deviceIP": "172.16.255.21", "personality": "vedge", "uploadSource": "Auto Discovered", "region-id": [], "solution": "sd-routing", "site-id": "100", "host-name": "vm11", "system-ip": "172.16.255.21", "vbond": "vbond", "vmanageConnectionState": "connected", "local-system-ip": "172.16.255.21", "availableVersions": [], "defaultVersion": "17.15.01.0.459", "reachability": "reachable", "version": "17.15.01.0.459", "uptime-date": 1715672160000, "model_sku": "None", "lastupdated": 1717387247033, "domain-id": "1", "sp-organization-name": "vIPtela Inc Regression", "organization-name": "vIPtela Inc Regression", "lifeCycleRequired": true, "vedgeCertificateState": "certinstalled", "expirationDate": "NA", "hardwareCertSerialNumber": "NA", "subjectSerialNumber": "NA", "resourceGroup": "global", "id": "NA", "tags": [], "draftMode": "Disabled", "site-name": "SITE_100", "device-lock": "No", "managed-by": "Unmanaged" }, { "configuredSiteId": "100", "configuredSystemIP": "172.16.255.11", "deviceType": "vedge", "serialNumber": "12345703", "ncsDeviceName": "vedge-C8K-52d10fd3-f5f5-4408-be78-7e7d92bd40e4", "configStatusMessage": "In Sync", "templateApplyLog": [ "[14-May-2024 10:29:05 UTC] Sync-from successful" ], "uuid": "C8K-52d10fd3-f5f5-4408-be78-7e7d92bd40e4", "managementSystemIP": "172.16.255.11", "templateStatus": "Success", "chasisNumber": "C8K-52d10fd3-f5f5-4408-be78-7e7d92bd40e4", "configStatusMessageDetails": "", "configOperationMode": "cli", "deviceModel": "vedge-C8000V-SD-ROUTING", "deviceState": "READY", "validity": "valid", "platformFamily": "c8000v", "hardwareVedge": false, "username": "--", "rootCertHash": "9b4c84834b5c1ce7245f2043888107905e95b671", "deviceIP": "172.16.255.11", "personality": "vedge", "uploadSource": "Auto Discovered", "region-id": [], "solution": "sd-routing", "site-id": "100", "host-name": "vm1", "system-ip": "172.16.255.11", "vbond": "vbond", "vmanageConnectionState": "connected", "local-system-ip": "172.16.255.11", "availableVersions": [], "defaultVersion": "17.15.01.0.459", "reachability": "reachable", "version": "17.15.01.0.459", "uptime-date": 1715672100000, "model_sku": "None", "lastupdated": 1717387847100, "domain-id": "1", "sp-organization-name": "vIPtela Inc Regression", "organization-name": "vIPtela Inc Regression", "lifeCycleRequired": true, "vedgeCertificateState": "certinstalled", "expirationDate": "NA", "hardwareCertSerialNumber": "NA", "subjectSerialNumber": "NA", "resourceGroup": "global", "id": "NA", "tags": [], "draftMode": "Disabled", "site-name": "SITE_100", "device-lock": "No", "managed-by": "Unmanaged" }, { "configuredSiteId": "200", "configuredSystemIP": "172.16.255.22", "deviceType": "vmanage", "serialNumber": "1234570E", "ncsDeviceName": "vmanage-daec9167-6376-4bca-a2dd-0cc396f82b04", "configStatusMessage": "In Sync", "templateApplyLog": [ "[15-May-2024 2:12:42 UTC] Sync-from successful" ], "uuid": "daec9167-6376-4bca-a2dd-0cc396f82b04", "managementSystemIP": "0.0.0.0", "templateStatus": "Success", "chasisNumber": "daec9167-6376-4bca-a2dd-0cc396f82b04", "configStatusMessageDetails": "", "configOperationMode": "cli", "deviceModel": "vmanage", "deviceState": "READY", "validity": "valid", "platformFamily": "vmanage", "hardwareVedge": false, "username": "--", "rootCertHash": "9b4c84834b5c1ce7245f2043888107905e95b671", "CSR": "vmanage-daec9167-6376-4bca-a2dd-0cc396f82b04-0.viptela.com", "CSRDetail": "-----BEGIN CERTIFICATE REQUEST-----\nMIIFWDCCA0ACAQAwgdcxCzAJBgNVBAYTAlVTMRMwEQYDVQQIEwpDYWxpZm9ybmlh\nMREwDwYDVQQHEwhTYW4gSm9zZTEfMB0GA1UECxMWdklQdGVsYSBJbmMgUmVncmVz\nc2lvbjEWMBQGA1UEChMNQ2lzY28gU3lzdGVtczFDMEEGA1UEAxM6dm1hbmFnZS1k\nYWVjOTE2Ny02Mzc2LTRiY2EtYTJkZC0wY2MzOTZmODJiMDQtMC52aXB0ZWxhLmNv\nbTEiMCAGCSqGSIb3DQEJARYTc3VwcG9ydEB2aXB0ZWxhLmNvbTCCAiIwDQYJKoZI\nhvcNAQEBBQADggIPADCCAgoCggIBAKvk1+5NjRQP6Am6yyIPcn31Yt8/pBIgNfy2\nIC0C65Fmc1BU34SS5iazpOf7ImuBRCE8vBR+VyvedNdMyxZvu2KYE6XL/xcj6UtI\nAKQQoJ8NFD6S2LCw6YhP5IT1FsvX+56wGo0+heH+NSUjVOrxMSJBzzuUMKQud7DN\njEGuva4qAnG1oXMhm+AYduEw0Luui0G/huV/MURzEzuCsF9XwmKbhSQNi3Lr+TZM\n1Ck+GEJ+KS+mzhKGVuCjmmy4fOr5f3szXiZYVHx1FhYe20cmGN2CTdz9Nc1CJ5QY\nDYIU4zUtS9PwF1RAnwGUTCyjTn1TEruXLNUYV5/KjBHqoMbQZ/mKjB2vbBVrHXJS\n5AyH6T99+AYSuVRw+XzW1NIEGU/6QoGOrR0j9YghIyCqKznEMRMFzj1WwNTuqTtk\nA5MlQd5fNZyffBZVTrmhAwAqHEfQyEOs/noizM3sekAHqD3azoeAeXgVVVyt5fh0\nZSeZdchq+Ittpw+TR1miAWfQV+izzIYRz8+kpxRYEnVlfY27D6Rc8fpFO4sYHPL9\n1DhP8hvNIHEgQLM4vBLxoxmIcPe8KYyaWQx2mD6Wahwc427qUcCO1L+p8YUReKr3\nTR20Eie4sjbgGp4deCKcB5ZcKq0EgzgiffOlXgUCB7zrqWJ5IYZkZaZ//3pet0wY\ncTr4sxsRAgMBAAGgOzA5BgkqhkiG9w0BCQ4xLDAqMAkGA1UdEwQCMAAwHQYDVR0O\nBBYEFC7D6H/CVxw/XUmCXGBKiK9cPYeNMA0GCSqGSIb3DQEBCwUAA4ICAQBR68S/\nN27sOhKsfWe/GtCIK9z+amkPNzGIiXBTit8KwToHYXYCR0e1Ybe5qFz+HEPFy9sY\nX6ASTftmzc1N1z8hMOXnt8XkSOPoEGk2W6ysVEe1KYtgVQ2QfKx42ObGvnBZjhoj\nZT4tVTFnhNm32y771RWQMcBeZ+dSyszcKOlNTO1Q4X9J5qeb6b5n2jHiZpxTbMVV\nl/MPgmjg9jj1O8SGffQ7Zdjp87sOKmKCpJmi7hlZmBPt4sYfkDsnLyaeX5Y2CpFJ\nNRibtsxjGcMpdULssEniOV2kXdjwMdCbqTSzdAolPA8SiSsUeb9tE4WlrAjpoxPM\nk0girflUjqbTlkTozVj+f+7m21XJ04/kTgJyGkwUHxo84uhRgUFVZ3fu3CCMBeN/\n/wUXS2uq3IEMCVNRO6xhpeyeG+q0N9uW/gl5J62RBXLbOmCEZDxXVpCmzWNqKes3\nl8riaQO+GGhXQ9hdGAh4WmaQKrCrVdJxTYMssKNFoePsx3Q/GDXgU2tG0+4GFl8u\n5PgPZjZ6nirYH2cYWnAzoEW1gfTQeLFT/0h5BVPZKTd+//v3ATF+EIOm8ubKnbMm\nkOEKVxK70XLw73xR+wcr9xoY2uqn5yA04GB8Db9X0CNDeJxyyI2KVZ7nyPJt9qlG\ncwpRtewKuyuOFjL8mGz4SJQi19qLO0ba/L4IVw==\n-----END CERTIFICATE REQUEST-----", "certificateDetail": "-----BEGIN CERTIFICATE-----\nMIIEmDCCA4ACBBI0Vw4wDQYJKoZIhvcNAQELBQAwbTELMAkGA1UEBhMCVVMxEzAR\nBgNVBAgMCkNhbGlmb3JuaWExETAPBgNVBAcMCFNhbiBKb3NlMRQwEgYDVQQKDAt2\nSVB0ZWxhIEluYzEgMB4GCSqGSIb3DQEJARYRbm9yZXBseUBjaXNjby5jb20wHhcN\nMjQwNTE0MDczNzU4WhcNMjUwNTE0MDczNzU4WjCBszERMA8GA1UEBxMIU2FuIEpv\nc2UxCzAJBgNVBAYTAlVTMRMwEQYDVQQIEwpDYWxpZm9ybmlhMRYwFAYDVQQKEw1D\naXNjbyBTeXN0ZW1zMR8wHQYDVQQLExZ2SVB0ZWxhIEluYyBSZWdyZXNzaW9uMUMw\nQQYDVQQDEzp2bWFuYWdlLWRhZWM5MTY3LTYzNzYtNGJjYS1hMmRkLTBjYzM5NmY4\nMmIwNC0wLnZpcHRlbGEuY29tMIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKC\nAgEAq+TX7k2NFA/oCbrLIg9yffVi3z+kEiA1/LYgLQLrkWZzUFTfhJLmJrOk5/si\na4FEITy8FH5XK95010zLFm+7YpgTpcv/FyPpS0gApBCgnw0UPpLYsLDpiE/khPUW\ny9f7nrAajT6F4f41JSNU6vExIkHPO5QwpC53sM2MQa69rioCcbWhcyGb4Bh24TDQ\nu66LQb+G5X8xRHMTO4KwX1fCYpuFJA2Lcuv5NkzUKT4YQn4pL6bOEoZW4KOabLh8\n6vl/ezNeJlhUfHUWFh7bRyYY3YJN3P01zUInlBgNghTjNS1L0/AXVECfAZRMLKNO\nfVMSu5cs1RhXn8qMEeqgxtBn+YqMHa9sFWsdclLkDIfpP334BhK5VHD5fNbU0gQZ\nT/pCgY6tHSP1iCEjIKorOcQxEwXOPVbA1O6pO2QDkyVB3l81nJ98FlVOuaEDACoc\nR9DIQ6z+eiLMzex6QAeoPdrOh4B5eBVVXK3l+HRlJ5l1yGr4i22nD5NHWaIBZ9BX\n6LPMhhHPz6SnFFgSdWV9jbsPpFzx+kU7ixgc8v3UOE/yG80gcSBAszi8EvGjGYhw\n97wpjJpZDHaYPpZqHBzjbupRwI7Uv6nxhRF4qvdNHbQSJ7iyNuAanh14IpwHllwq\nrQSDOCJ986VeBQIHvOupYnkhhmRlpn//el63TBhxOvizGxECAwEAATANBgkqhkiG\n9w0BAQsFAAOCAQEAilifmfhB6yoNFUMV82ws5CdQfWydTM2Nr+iMkBP4tp1bTYuX\noTbZzEtuQ/FKqqpD+OMldQTesYt3Mk/x5pjrHq5h2tTICYPqDX4QrZqamvXnpv25\n2NkqBCO1dHR5Ig2711VquHnTmkkDdPRVeAXaHz8+9XKFatC7nrRikigQq2nT+hak\nAGXWciy1fC/JWBV4dpJxvsbleVFrzgEf/Rilcy4dC/ubIHarnIi9adbFvRA3Jr9X\nYgpUGsggEU9A8zetwxFfsuDCLH/Y+marjaVZHZt9eIdiRKAsHEI8O+yHky9bnax/\nyuyQPoQocXbZt0ppE4NSZ4dkfvQVTDGCDj46KA==\n-----END CERTIFICATE-----", "state": "vBond Updated", "globalState": "normal", "valid": "valid", "requestTokenID": "75a1dc55-48a8-4330-abbd-fef95421dc24", "expirationDate": "May 14 07:37:58 2025 GMT", "expirationDateLong": 1747208278000, "deviceIP": "172.16.255.22", "activity": [ "vBond Updated" ], "state_vedgeList": "Sync", "certInstallStatus": "Installed", "servicePersonality": "all", "personality": "vmanage", "expirationStatus": "normal", "timeRemainingForExpiration": 29724617454, "solution": "common", "site-id": "200", "host-name": "vm12", "system-ip": "172.16.255.22", "vbond": "vbond", "vmanageConnectionState": "connected", "local-system-ip": "172.16.255.22", "availableVersions": [], "defaultVersion": "20.15.0-12", "reachability": "reachable", "version": "20.15.0-12", "uptime-date": 1715670480000, "model_sku": "None", "lastupdated": 1716954423854, "vmanage-system-ip": "172.16.255.22", "domain-id": "0", "sp-organization-name": "vIPtela Inc Regression", "organization-name": "vIPtela Inc Regression", "lifeCycleRequired": false, "hardwareCertSerialNumber": "NA", "subjectSerialNumber": "NA", "resourceGroup": "global", "id": "NA", "tags": [], "draftMode": "Disabled", "site-name": "SITE_200", "device-lock": "No", "managed-by": "Unmanaged" }, { "configuredSiteId": "200", "configuredSystemIP": "172.16.255.20", "deviceType": "vsmart", "serialNumber": "1234570C", "ncsDeviceName": "vsmart-e70dfee9-14fa-45b1-8f71-16e7ffd280b0", "configStatusMessage": "In Sync", "templateApplyLog": [ "[14-May-2024 7:55:15 UTC] Sync-from successful" ], "uuid": "e70dfee9-14fa-45b1-8f71-16e7ffd280b0", "managementSystemIP": "172.16.255.20", "templateStatus": "Success", "chasisNumber": "e70dfee9-14fa-45b1-8f71-16e7ffd280b0", "configStatusMessageDetails": "", "configOperationMode": "cli", "deviceModel": "vsmart", "deviceState": "READY", "validity": "valid", "platformFamily": "vsmart", "hardwareVedge": false, "username": "--", "rootCertHash": "9b4c84834b5c1ce7245f2043888107905e95b671", "state": "vBond Updated", "globalState": "normal", "valid": "valid", "requestTokenID": "8e63576a-e8f3-4916-9c35-fb0d6cd01c5b", "expirationDate": "May 14 07:37:59 2025 GMT", "expirationDateLong": 1747208279000, "deviceIP": "172.16.255.20", "activity": [ "vBond Updated" ], "certInstallStatus": "Installed", "personality": "vsmart", "expirationStatus": "normal", "uploadSource": "Auto Discovered", "timeRemainingForExpiration": 29724618454, "region-id": [], "solution": "sdwan", "site-id": "200", "host-name": "vm10", "system-ip": "172.16.255.20", "vbond": "vbond", "vmanageConnectionState": "connected", "policy-template-name": "", "policy-template-version": "", "local-system-ip": "172.16.255.20", "availableVersions": [], "defaultVersion": "20.15.0-12", "reachability": "reachable", "version": "20.15.0-12", "uptime-date": 1715669280000, "model_sku": "None", "lastupdated": 1717387842261, "vmanage-system-ip": "172.16.255.20", "domain-id": "1", "sp-organization-name": "vIPtela Inc Regression", "organization-name": "vIPtela Inc Regression", "lifeCycleRequired": false, "hardwareCertSerialNumber": "NA", "subjectSerialNumber": "NA", "resourceGroup": "global", "id": "NA", "tags": [], "draftMode": "Disabled", "site-name": "SITE_200", "device-lock": "No", "managed-by": "Unmanaged" }, { "configuredSiteId": "200", "configuredSystemIP": "172.16.255.19", "deviceType": "vsmart", "serialNumber": "1234570B", "ncsDeviceName": "vsmart-7b1046fa-e0fa-4108-8733-70bae545c775", "configStatusMessage": "In Sync", "templateApplyLog": [ "[14-May-2024 7:55:14 UTC] Sync-from successful" ], "uuid": "7b1046fa-e0fa-4108-8733-70bae545c775", "managementSystemIP": "172.16.255.19", "templateStatus": "Success", "chasisNumber": "7b1046fa-e0fa-4108-8733-70bae545c775", "configStatusMessageDetails": "", "configOperationMode": "cli", "deviceModel": "vsmart", "deviceState": "READY", "validity": "valid", "platformFamily": "vsmart", "hardwareVedge": false, "username": "--", "rootCertHash": "9b4c84834b5c1ce7245f2043888107905e95b671", "state": "vBond Updated", "globalState": "normal", "valid": "valid", "requestTokenID": "e71df9cc-e60b-4f40-b857-284685d2d932", "expirationDate": "May 14 07:37:59 2025 GMT", "expirationDateLong": 1747208279000, "deviceIP": "172.16.255.19", "activity": [ "vBond Updated" ], "certInstallStatus": "Installed", "personality": "vsmart", "expirationStatus": "normal", "uploadSource": "Auto Discovered", "timeRemainingForExpiration": 29724618454, "region-id": [], "solution": "sdwan", "site-id": "200", "host-name": "vm9", "system-ip": "172.16.255.19", "vbond": "vbond", "vmanageConnectionState": "connected", "policy-template-name": "", "policy-template-version": "", "local-system-ip": "172.16.255.19", "availableVersions": [], "defaultVersion": "20.15.0-12", "reachability": "reachable", "version": "20.15.0-12", "uptime-date": 1715669280000, "model_sku": "None", "lastupdated": 1717387841989, "vmanage-system-ip": "172.16.255.19", "domain-id": "1", "sp-organization-name": "vIPtela Inc Regression", "organization-name": "vIPtela Inc Regression", "lifeCycleRequired": false, "hardwareCertSerialNumber": "NA", "subjectSerialNumber": "NA", "resourceGroup": "global", "id": "NA", "tags": [], "draftMode": "Disabled", "site-name": "SITE_200", "device-lock": "No", "managed-by": "Unmanaged" } ] }, "$$ref": "#/components/examples/ComViptelaVmanageServerCertificateapiResponseExampleGetstatsdetailresponse" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/certificate/stats/summary": { "get": { "tags": [ "Certificate Management - Device" ], "summary": "Get certificate expiration status", "description": "Get certificate expiration status", "operationId": "getCertificateStats", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "properties": { "empty": { "type": "boolean" } }, "items": { "type": "string" }, "$$ref": "#/components/schemas/DeviceList" }, "examples": { "Stats Summary Response": { "description": "Stats Summary Response", "value": { "header": { "columns": [ { "title": "Warning", "property": "warning", "dataType": "string" }, { "title": "Invalid", "property": "invalid", "dataType": "string" } ], "fields": [ { "property": "warning", "dataType": "string" }, { "property": "invalid", "dataType": "string" } ], "viewKeys": { "uniqueKey": [], "preferenceKey": "grid-CertificateSummary" }, "modelNameMapping": { "vAnalytics": "Analytics", "vSmart": "Controller", "vManage": "Manager", "Cloud OnRamp": "Cloud onRamp", "vBond": "Validator" } }, "data": [ { "invalid": 0, "warning": 0, "revoked": 0 } ] }, "$$ref": "#/components/examples/ComViptelaVmanageServerCertificateapiResponseExampleGetstatssummaryresponse" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/certificate/syncvbond": { "get": { "tags": [ "Certificate Management - Device" ], "summary": "sync vManage UUID to all vBond", "description": "sync vManage UUID to all vBond", "operationId": "syncvBond", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "Sync vBond Response": { "description": "Sync vBond Response", "value": { "syncvBond": "done" }, "$$ref": "#/components/examples/ComViptelaVmanageServerCertificateapiResponseExampleGetsyncvbondresponse" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/certificate/tokengeneratedlist": { "get": { "tags": [ "Certificate Management - Device" ], "summary": "get token generated list", "description": "get token generated list", "operationId": "getTokenList", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "Token Generated List Response": { "description": "Token Generated List Response", "value": { "header": { "columns": [ { "title": "Tags", "property": "tags", "display": "toggle", "hideable": true, "actionColumn": true, "minWidth": 250, "dataType": "string" }, { "title": "Configuration Group", "property": "configGroupName", "display": "toggle", "hideable": true, "actionColumn": true, "minWidth": 250, "dataType": "string" }, { "title": "State", "property": "vedgeCertificateState", "display": "iconAndToolTip", "iconProperty": "vedgeCertificateState", "toolTipProperty": "vedgeCertificateState", "hideable": false, "icon": [ { "key": "tokengenerated", "value": "images/certStates/token-generated.png", "displayKey": "Token Generated" }, { "key": "bootstrapconfiggenerated", "value": "images/certStates/bootstrap-config-generated.png", "displayKey": "Bootstrap Configuration Generated" }, { "key": "csrgenerated", "value": "images/certStates/csr-generated.png", "displayKey": "CSR Generated" }, { "key": "csrfailed", "value": "images/certStates/csr-failed.png", "displayKey": "CSR Failed" }, { "key": "certinstallfailed", "value": "images/certStates/cert-install-failed.png", "displayKey": "Certificate Installation Failed" }, { "key": "certinstalled", "value": "images/certStates/cert-installed.png", "displayKey": "Certificate Installed" } ], "width": 40, "minWidth": 40, "dataType": "string" }, { "title": "Device Model", "property": "deviceModel", "display": "keyvalue", "keyvalueProperty": "deviceModel", "hideable": false, "minWidth": 120, "dataType": "string" }, { "title": "Chassis Number", "property": "chasisNumber", "hideable": false, "width": 270, "dataType": "string" }, { "title": "Serial No./Token", "property": "serialNumber", "width": 100, "dataType": "string" }, { "title": "Enterprise Cert Serial No", "property": "hardwareCertSerialNumber", "width": 100, "dataType": "string" }, { "title": "Certificate Expiration Date", "property": "expirationDate", "width": 100, "dataType": "string" }, { "title": "Subject SUDI serial #", "property": "subjectSerialNumber", "hideable": true, "width": 100, "dataType": "string" }, { "title": "Hostname", "property": "host-name", "hideable": true, "width": 100, "dataType": "string" }, { "title": "System IP", "property": "deviceIP", "hideable": true, "width": 125, "dataType": "ipv4" }, { "title": "IP Address", "property": "local-system-ip", "hideable": true, "width": 125, "dataType": "ipv4" }, { "title": "Validate", "property": "validity", "display": "toggle", "hideable": true, "actionColumn": true, "minWidth": 250, "dataType": "string" } ], "fields": [ { "property": "tags", "dataType": "string", "display": "toggle" }, { "property": "configGroupName", "dataType": "string", "display": "toggle" }, { "property": "vedgeCertificateState", "dataType": "string", "display": "iconAndToolTip" }, { "property": "deviceModel", "dataType": "string", "display": "keyvalue" }, { "property": "chasisNumber", "dataType": "string" }, { "property": "serialNumber", "dataType": "string" }, { "property": "hardwareCertSerialNumber", "dataType": "string" }, { "property": "expirationDate", "dataType": "string" }, { "property": "subjectSerialNumber", "dataType": "string" }, { "property": "host-name", "dataType": "string" }, { "property": "deviceIP", "dataType": "ipv4" }, { "property": "local-system-ip", "dataType": "ipv4" }, { "property": "validity", "dataType": "string", "display": "toggle" } ], "viewKeys": { "uniqueKey": [ "chasisNumber" ], "preferenceKey": "grid-quickConnectVEdgeList" }, "modelNameMapping": { "vAnalytics": "Analytics", "vSmart": "Controller", "vManage": "Manager", "Cloud OnRamp": "Cloud onRamp", "vBond": "Validator" } }, "data": [ { "configGroupName": "", "configGroupId": "", "tags": [], "serialNumber": "No certificate installed", "chasisNumber": "C8K-00006dde-185a-41de-bebe-e389549bfe98", "deviceModel": "vedge-C8000V" }, { "configGroupName": "", "configGroupId": "", "tags": [], "serialNumber": "No certificate installed", "chasisNumber": "C8K-0000361a-7463-4549-9861-a6c72b6f3ab8", "deviceModel": "vedge-C8000V" } ] }, "$$ref": "#/components/examples/ComViptelaVmanageServerCertificateapiResponseExampleGettokengeneratedlist" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/certificate/update/controller/validity": { "post": { "tags": [ "Certificate Management - Device" ], "summary": "Update Controller validity", "description": "Update Controller(vSmart) validity to all devices", "operationId": "updateControllerValidity", "requestBody": { "description": "Device details", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "Device details": { "description": "Device details", "value": { "deviceList": [ { "uuid": "76db6b8b-5a37-4aca-8b30-398f60e15b74", "validity": "config-init" }, { "uuid": "c8a23307-ca50-4e68-8335-3d48f65fbe82", "validity": "valid" } ], "sendToControllers": true }, "$$ref": "#/components/examples/ComViptelaVmanageServerCertificateapiRequestExamplePostupdatecontrollervalidity" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "Certificate Response": { "description": "Certificate Response", "value": { "id": "34af96f7-c1fe-4122-a6d9-7f733adefe28" }, "$$ref": "#/components/examples/ComViptelaVmanageServerCertificateapiResponseExamplePostvsmartlistresponse" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/certificate/vedge": { "get": { "tags": [ "Certificate Management - Device" ], "summary": "get device installed cert", "description": "get device installed cert", "operationId": "getInstalledCert", "parameters": [ { "name": "uuid", "in": "query", "description": "UUID param to fetch installed certificate", "required": true, "schema": { "type": "string" }, "examples": { "uuid": { "description": "uuid", "value": "18559db6-0883-4268-bda7-27d2c872537a" } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "properties": { "empty": { "type": "boolean" } }, "items": { "type": "object", "properties": { "certificate": { "type": "string", "example": "-----BEGIN CERTIFICATE----- ... -----END CERTIFICATE-----" }, "signerVmanageUUID": { "type": "string" } }, "$$ref": "#/components/schemas/InstalledCertsInner" }, "$$ref": "#/components/schemas/InstalledCerts" }, "examples": { "Get Vedge Certificate Response": { "description": "Get Vedge Certificate Response", "value": { "header": { "generatedOn": 1722341899659 }, "data": [ { "certificate": "-----BEGIN CERTIFICATE-----\nMIIFpTCCA40CBHRyVY8wDQYJKoZIhvcNAQELBQAwVDELMAkGA1UEBhMCVVMxLTAr\n...\n6EokqtrKZW8xA3FFYCdittx/l2XYCAr9M7UyqDNoptUHkrDhqT+IaDpheCTVIMqy\nGlv/VtcozeLj\n-----END CERTIFICATE-----", "signerVmanageUUID": "c947b60a-4c42-48dc-a6f6-8395c17e0465" } ] }, "$$ref": "#/components/examples/ComViptelaVmanageServerCertificateapiResponseExampleGetvedgeresponse" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/certificate/vedge/csr": { "get": { "tags": [ "Certificate Management - Device" ], "summary": "get device CSR", "description": "get device CSR", "operationId": "getvEdgeCSR", "parameters": [ { "name": "uuid", "in": "query", "description": "UUID param to fetch installed CSR", "required": true, "schema": { "type": "string" }, "examples": { "uuid": { "description": "uuid", "value": "18559db6-0883-4268-bda7-27d2c872537a" } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "Get Vedge CSR Response": { "description": "Get Vedge CSR Response", "value": { "Certificate Signing Request": "-----BEGIN CERTIFICATE REQUEST-----\nMIIFWjCCA0ICAQAwgdkxCzAJBgNVBAYTAlVTMRMwEQYDVQQIEwpDYWxpZm9ybmlh\n...\n...\nTiiwhWPo+x5Ub/iRG7czJkD5SXhe5bdFel5w3hTw\n-----END CERTIFICATE REQUEST-----" }, "$$ref": "#/components/examples/ComViptelaVmanageServerCertificateapiResponseExampleGetvedgecsrresponse" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/certificate/vedge/download/csr": { "post": { "tags": [ "Certificate Management - Device" ], "summary": "Download CSR", "description": "Download CSR for given edge devives", "operationId": "downloadVedgeCSR", "requestBody": { "description": "List of edge devices", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "Device List": { "description": "Device List", "value": { "chassis-numbers": [ "233497bc-69f7-43fe-a389-28bb719fef14", "C8K-f4423f04-355b-4c22-b6de-76f8d3e651b4", "C8K-0b9056fd-296c-400e-936f-3dff4ef87db2" ] }, "$$ref": "#/components/examples/ComViptelaVmanageServerCertificateapiRequestExamplePostvedgedownloadcsrrequest" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/certificate/vedge/list": { "get": { "tags": [ "Certificate Management - Device" ], "summary": "get vEdge list", "description": "get vEdge list", "operationId": "getvEdgeList", "parameters": [ { "name": "model", "in": "query", "description": "Device Model", "schema": { "type": "string" }, "examples": { "C8000v": { "description": "C8000v", "value": "vedge-C8000V" }, "vEdge Cloud": { "description": "vEdge Cloud", "value": "vedge-cloud" }, "ASR1002-HX": { "description": "ASR1002-HX", "value": "ASR1002-HX" }, "C8300-1N1S-4T2X": { "description": "C8300-1N1S-4T2X", "value": "C8300-1N1S-4T2X" } } }, { "name": "state", "in": "query", "description": "Certificate State", "schema": { "type": "string" }, "examples": { "Token Generated": { "description": "Token Generated", "value": "tokengenerated" }, "Bootstrap Config Generated": { "description": "Bootstrap Config Generated", "value": "bootstrapconfiggenerated" }, "CSR Generated": { "description": "CSR Generated", "value": "csrgenerated" }, "CSR Failed": { "description": "CSR Failed", "value": "csrfailed" }, "Certificate Installed": { "description": "Certificate Installed", "value": "certinstalled" }, "Certificate Installation Failed": { "description": "Certificate Installation Failed", "value": "certinstallfailed" }, "Certificate serial number pushed to controllers": { "description": "Certificate serial number pushed to controllers", "value": "certserialpushedtocontrollers" } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "Vedge List Response": { "description": "Vedge List Response", "value": { "header": { "columns": [ { "title": "State", "property": "vedgeCertificateState", "display": "iconAndToolTip", "iconProperty": "vedgeCertificateState", "toolTipProperty": "vedgeCertificateState", "hideable": false, "icon": [ { "key": "tokengenerated", "value": "images/certStates/token-generated.png", "displayKey": "Token Generated" }, { "key": "bootstrapconfiggenerated", "value": "images/certStates/bootstrap-config-generated.png", "displayKey": "Bootstrap Configuration Generated" }, { "key": "csrgenerated", "value": "images/certStates/csr-generated.png", "displayKey": "CSR Generated" }, { "key": "csrfailed", "value": "images/certStates/csr-failed.png", "displayKey": "CSR Failed" }, { "key": "certinstallfailed", "value": "images/certStates/cert-install-failed.png", "displayKey": "Certificate Installation Failed" }, { "key": "certinstalled", "value": "images/certStates/cert-installed.png", "displayKey": "Certificate Installed" } ], "width": 40, "minWidth": 40, "dataType": "string" }, { "title": "Device Model", "property": "deviceModel", "display": "keyvalue", "keyvalueProperty": "deviceModel", "hideable": false, "minWidth": 120, "dataType": "string" }, { "title": "Chassis Number", "property": "chasisNumber", "hideable": false, "width": 270, "dataType": "string" }, { "title": "Serial No./Token", "property": "serialNumber", "width": 100, "dataType": "string" }, { "title": "Enterprise Cert Serial No", "property": "hardwareCertSerialNumber", "width": 100, "dataType": "string" }, { "title": "Certificate Expiration Date", "property": "expirationDate", "width": 100, "dataType": "string" }, { "title": "Subject SUDI serial #", "property": "subjectSerialNumber", "hideable": true, "width": 100, "dataType": "string" }, { "title": "Hostname", "property": "host-name", "hideable": true, "width": 100, "dataType": "string" }, { "title": "System IP", "property": "local-system-ip", "hideable": true, "width": 125, "dataType": "ipv4" }, { "title": "Validate", "property": "validity", "display": "toggle", "hideable": true, "actionColumn": true, "minWidth": 250, "dataType": "string" } ], "fields": [ { "property": "vedgeCertificateState", "dataType": "string", "display": "iconAndToolTip" }, { "property": "deviceModel", "dataType": "string", "display": "keyvalue" }, { "property": "chasisNumber", "dataType": "string" }, { "property": "serialNumber", "dataType": "string" }, { "property": "hardwareCertSerialNumber", "dataType": "string" }, { "property": "expirationDate", "dataType": "string" }, { "property": "subjectSerialNumber", "dataType": "string" }, { "property": "host-name", "dataType": "string" }, { "property": "local-system-ip", "dataType": "ipv4" }, { "property": "validity", "dataType": "string", "display": "toggle" } ], "viewKeys": { "uniqueKey": [ "chasisNumber" ], "preferenceKey": "grid-certificateVEdgeList" }, "modelNameMapping": { "vAnalytics": "Analytics", "vSmart": "Controller", "vManage": "Manager", "Cloud OnRamp": "Cloud onRamp", "vBond": "Validator" } }, "data": [ { "configuredSiteId": "17902064", "configuredSystemIP": "79.2.1.64", "deviceType": "vedge", "serialNumber": "No certificate installed", "ncsDeviceName": "vedge-C8K-0003fa42-952c-4a66-8d26-4d8fa18e0e27", "configStatusMessage": "In Sync", "templateApplyLog": [ "[23-May-2024 13:43:30 UTC] Sync-from successful" ], "uuid": "C8K-0003fa42-952c-4a66-8d26-4d8fa18e0e27", "managementSystemIP": "79.2.1.64", "templateStatus": "Success", "chasisNumber": "C8K-0003fa42-952c-4a66-8d26-4d8fa18e0e27", "configStatusMessageDetails": "", "configOperationMode": "cli", "deviceModel": "vedge-C8000V", "deviceState": "READY", "validity": "valid", "platformFamily": "c8000v", "hardwareVedge": false, "username": "--", "rootCertHash": "65ef79171aada3c7bd008fc889aaee56db5005c4", "deviceIP": "79.2.1.64", "personality": "vedge", "uploadSource": "Auto Discovered", "solution": "sdwan", "site-id": "17902064", "host-name": "03f_c8kv-SIM-9_2", "system-ip": "79.2.1.64", "vbond": "vbond", "vmanageConnectionState": "connected", "local-system-ip": "79.2.1.64", "availableVersions": [], "defaultVersion": "17.13.01.230723.181895", "reachability": "unreachable", "version": "17.13.01.230723.181895", "lastupdated": 1716471820491, "vmanage-system-ip": "79.2.1.64", "organization-name": "vmng_scale_ind", "lifeCycleRequired": true, "vedgeCertificateState": "certinstalled", "expirationDate": "NA", "hardwareCertSerialNumber": "NA", "subjectSerialNumber": "NA", "certInstallStatus": "Not Installed", "resourceGroup": "global", "id": "NA", "tags": [], "draftMode": "Disabled", "site-name": "SITE_17902064", "device-lock": "No", "managed-by": "Unmanaged" }, { "configuredSiteId": "17404071", "configuredSystemIP": "74.4.1.71", "deviceType": "vedge", "serialNumber": "No certificate installed", "ncsDeviceName": "vedge-C8K-000464eb-86ec-4bb0-948e-7f8b7e8595a5", "configStatusMessage": "In Sync", "templateApplyLog": [ "[23-May-2024 13:50:45 UTC] Sync-from successful" ], "uuid": "C8K-000464eb-86ec-4bb0-948e-7f8b7e8595a5", "managementSystemIP": "74.4.1.71", "templateStatus": "Success", "chasisNumber": "C8K-000464eb-86ec-4bb0-948e-7f8b7e8595a5", "configStatusMessageDetails": "", "configOperationMode": "cli", "deviceModel": "vedge-C8000V", "deviceState": "READY", "validity": "valid", "platformFamily": "c8000v", "hardwareVedge": false, "username": "--", "rootCertHash": "65ef79171aada3c7bd008fc889aaee56db5005c4", "deviceIP": "74.4.1.71", "personality": "vedge", "uploadSource": "Auto Discovered", "solution": "sdwan", "site-id": "17404071", "host-name": "046_c8kv-SIM-4_04", "system-ip": "74.4.1.71", "vbond": "vbond", "vmanageConnectionState": "connected", "local-system-ip": "74.4.1.71", "availableVersions": [], "defaultVersion": "17.13.01.230723.181895", "reachability": "unreachable", "version": "17.13.01.230723.181895", "lastupdated": 1716472255905, "vmanage-system-ip": "74.4.1.71", "organization-name": "vmng_scale_ind", "lifeCycleRequired": true, "vedgeCertificateState": "certinstalled", "expirationDate": "NA", "hardwareCertSerialNumber": "NA", "subjectSerialNumber": "NA", "certInstallStatus": "Not Installed", "resourceGroup": "global", "id": "NA", "tags": [], "draftMode": "Disabled", "site-name": "SITE_17404071", "device-lock": "No", "managed-by": "Unmanaged" } ] }, "$$ref": "#/components/examples/ComViptelaVmanageServerCertificateapiResponseExampleGetvedgelistresponse" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Certificate Management - Device" ], "summary": "Save vEdge list (send to controller)", "description": "Save vEdge list (send to controller)", "operationId": "setvEdgeList", "parameters": [ { "name": "action", "in": "query", "description": "Action Type", "schema": { "type": "string" }, "examples": { "Save": { "description": "Save", "value": "save" }, "Verify": { "description": "Verify", "value": "verify" }, "Get": { "description": "Get", "value": "get" }, "Push": { "description": "Push", "value": "push" } } } ], "requestBody": { "description": "Required only for save action", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "Vedge List": { "description": "Vedge List", "value": [ { "chasisNumber": "C8K-000080dc-9592-4da6-b0b2-f3a4d5ea9e0e", "serialNumber": "30772D8A24FBF87F", "validity": "valid", "sendToControllers": true }, { "chasisNumber": "C8K-00033cd6-d24e-483a-a54c-774c69150abd", "serialNumber": "A2E6E7CB4E92F149", "validity": "valid", "sendToControllers": true } ], "$$ref": "#/components/examples/ComViptelaVmanageServerCertificateapiRequestExamplePostvedgelistsaverequest" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "Vedge List Push Response": { "description": "Vedge List Push Response", "value": { "id": "e9dd944a-32c3-4b13-b504-54ed1a95e128", "sendToControllerId": "e9dd944a-32c3-4b13-b504-54ed1a95e128" }, "$$ref": "#/components/examples/ComViptelaVmanageServerCertificateapiResponseExamplePostvedgelistpushresponse" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/certificate/view": { "get": { "tags": [ "Certificate Management - Device" ], "summary": "Get certificate UI view", "description": "Get certificate UI view", "operationId": "getView", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "Certificate UI View Response": { "description": "Certificate UI View Response", "value": { "name": "certificateViewUI", "data": [ { "name": "Controller", "uri": "dataservice/certificate/record", "refresh": "30", "detail": "dataservice/certificate/csr/details" }, { "name": "vEdge List", "uri": "dataservice/certificate/vedge/list", "refresh": "30" }, { "name": "History", "uri": "dataservice/certificate/history", "refresh": "30" } ] }, "$$ref": "#/components/examples/ComViptelaVmanageServerCertificateapiResponseExampleGetcertificateviewresponse" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/certificate/vmanage/selfsignedcert": { "get": { "tags": [ "Certificate Management - Device" ], "summary": "get vManage self signed cert", "description": "get vManage self signed cert", "operationId": "getSelfSignedCert", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "Vmanage Self Signed Cert Response": { "description": "Vmanage Self Signed Cert Response", "value": { "SelfSignedCert": "-----BEGIN CERTIFICATE-----MIIFNjCCAx6gAwIBAgIEBCYCJzANBgkqhkiG9w0BAQsFADBUMQswCQYDVQQGEwJVUzEtMCsGA1UEAwwkMjlmNzVlMDUtOTUyYy00YmJmLWIzYjYtNGEzY2NlOWVmNTQ1MRYwFAYDVQQKDA1DaXNjbyBTeXN0ZW1zMB4XDTI0MDUyMjA4MjkyNVoXDTM0MDUyMTA4MjkyNVowVDELMAkGA1UEBhMCVVMxLTArBgNVBAMMJDI5Zjc1ZTA1LTk1MmMtNGJiZi1iM2I2LTRhM2NjZTllZjU0NTEWMBQGA1UECgwNQ2lzY28gU3lzdGVtczCCAiIwDQYJKoZIhvcNAQEBBQADggIPADCCAgoCggIBAL+aAZ1DY7FMbtacdAy3dsZ6GRTaCiXBJHCgnjsTl4ZKMU/BwNlBPqHTouCdDpUngg28ZTwpFY9YQ2PvpFUUSiY/8yxYj6aikA7YbxHqNF6V8sic4wOpo4br4HZ5JCL4BvjnobXvqXzo6MXEU9gJtBNOUcohya3HAvZd8FW1dCkFpbR0eBhk1t1sQanh8zuo+iYNZmfqAeM6PilyO+1B/ecRMrexlN4kqSqmrqRLvNForuyY0uDZVI2nYw/mrtbaUlhiB3+yl6W98X3S2J+j9xxQMQAXrBqG+niI6H02fK1eQv74VOrTOtEY0IQHHPnBWkJtXbwH3NA45EYtVoK1YfkIWoyP9c88EZwbefZHzF4PnTUjUuCBFCVrru1kZwls28YsJ6hezmKhjO99nOHWmJLsf7DVd4UUnwiEF/pfdC9hbJuaW3V1nIqNokWbRo3cctG8fUHA5yo6+6WmQO47VPye0tHTxAtgmzFuCTdbgZkUwqDzPdNc8t0kEBqTCPZ8ihngDyzUQKlP3ZA7sQ0UPOt4LEWpNM0+whHy++cj4lf20kk/GIDQsIlkhqU2AL3JeajCTlosnimJ4gn3LVI5NiwA/vltdyVQFp1hZPsD1EWHye5zTpFUXjHgzOTxdxrCj3G6lRa5oNByir/Di4lKondbAHqeDfOS8sdgp3Kw1RDPAgMBAAGjEDAOMAwGA1UdEwQFMAMBAf8wDQYJKoZIhvcNAQELBQADggIBAII5aPPwcL8yG0+EMZw4dbxLQPOtZGFKmzGcfQ21zi1OXzPLPHr8Nz15dEd0YAs3tWWUj9zKIJ48BQCg0D5gizUwH1RPAVuLTRkgOSKrBiXW2McksP74lbzFPpOIzDHy7+Le5KLpEF4osYpeieRaiqKHDI7ch9tZW6ib3/wHlG+AFTjePR2b3iTBRCdK5xcyW3w11gNf8tLbWK1Uih2nzTFt715H9NzKHsoOTKv02d1NQc3jb+LWBE0mzn2prpxl1UWcVdz/tsn7KbKXgpuBRpHkE77vfoOuL6GVT/H7oGobjbHjXj4d4AifiMygKnQmPOlD9MTsLiykYf2lfw9qliwwPsthKVbbbeBJKaYCypWb9zZsznsDAoZqMyrXlxeQQ5z6ApEC75MrmJq7CqLJNx5pyqVqND3O5yTiKeZsje6ROnO52Teq+uHrOoH4G1ZXRepoK/iCRpr0jphBJ6Jv2HjZGL8LfzajMQ3D7b9dPpchTgWr4PzQ9XEr+u5mpjtDqdO1YPUD74QKNgMbhfpSayTa0VS6qm/06ttLa7nF8IeYc9ufYqjI3gjV9kF2Pwv+Z7L8z6VTM7jWZQpGrSTcihUlynmo2v6bAyCQVRU6t2Yk2BEQyiZC75GB2nxqv0rMtKDZ9SIe+n6iS08Fr+9qQPPZfVVRyYqAEI5+2LROAMvt-----END CERTIFICATE-----" }, "$$ref": "#/components/examples/ComViptelaVmanageServerCertificateapiResponseExampleGetvmanageselfsignedcertresponse" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/certificate/vsmart/list": { "post": { "tags": [ "Certificate Management - Device" ], "summary": "save vSmart List(handleSendToVbond)", "description": "save vSmart List(handleSendToVbond)", "operationId": "setvSmartList", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "Certificate Response": { "description": "Certificate Response", "value": { "id": "34af96f7-c1fe-4122-a6d9-7f733adefe28" }, "$$ref": "#/components/examples/ComViptelaVmanageServerCertificateapiResponseExamplePostvsmartlistresponse" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "Certificate Management - Device" ], "summary": "get vSmart list", "description": "get vSmart list", "operationId": "getvSmartList", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "Vsmart List Response": { "description": "Vsmart List Response", "value": { "header": { "columns": {}, "fields": {}, "viewKeys": {}, "modelNameMapping": { "vAnalytics": "Analytics", "vSmart": "Controller", "vManage": "Manager", "Cloud OnRamp": "Cloud onRamp", "vBond": "Validator" } }, "data": [ { "configuredSiteId": "110", "configuredSystemIP": "10.10.10.10", "deviceType": "vbond", "serialNumber": "5196E08F57FB48A6", "ncsDeviceName": "vbond-55f86ac6-e14e-40bd-bc8e-009d24d85f99", "configStatusMessage": "In Sync", "templateApplyLog": [ "[23-May-2024 13:50:54 UTC] Sync-from successful" ], "uuid": "55f86ac6-e14e-40bd-bc8e-009d24d85f99", "managementSystemIP": "0.0.0.0", "templateStatus": "Success", "chasisNumber": "55f86ac6-e14e-40bd-bc8e-009d24d85f99", "configStatusMessageDetails": "", "configOperationMode": "cli", "deviceModel": "vedge-cloud", "deviceState": "READY", "validity": "valid", "platformFamily": "vedge-x86", "hardwareVedge": false, "username": "--", "rootCertHash": "65ef79171aada3c7bd008fc889aaee56db5005c4", "CSR": "viptela.testbed", "CSRDetail": "-----BEGIN CERTIFICATE REQUEST-----\nMIIDIzCCAgsCAQAwgaIxCzAJBgNVBAYTAlVTMRMwEQYDVQQIDApDYWxpZm9ybmlh\nMREwDwYDVQQHDAhTYW4gSm9zZTEXMBUGA1UECwwOdm1uZ19zY2FsZV9pbmQxFDAS\nBgNVBAoMC3ZJUHRlbGEgSW5jMRgwFgYDVQQDDA92aXB0ZWxhLnRlc3RiZWQxIjAg\nBgkqhkiG9w0BCQEWE3NhbnRvc2hAdmlwdGVsYS5jb20wggEiMA0GCSqGSIb3DQEB\nAQUAA4IBDwAwggEKAoIBAQC1d7RapQe9c+JSP5tRld+SE4RIRde9LplnOxGirMAN\n5DWhS2Kc901U0oiy26i3LFda/3IaA3dzk3+II5HBCt5KEhTWY0jpiuuSC//RQOLs\nszgXsQu7ZlIf+nxP1B/G8Twg2qT1npV0+2sfH5YY0ToFZpf7ye/oX8LxLK7EcqKZ\nRJargW71ix414hgSCOlN3tGRd1BK4zNAkmSuLN5eesXiirQFEKN3fGigX2ZAZSdO\nKUEeD0u1xsoHf/1nO3ekajXeSaH3nZy+5pu55zFjeLyEZTxi+pj/TpqWZI6AXAkd\nwpxkwd/ChAMZl5DafMnlagPq7AYh/vvOAvOqynP9278nAgMBAAGgOzA5BgkqhkiG\n9w0BCQ4xLDAqMAkGA1UdEwQCMAAwHQYDVR0OBBYEFDd5ZSBNg2BMAUfrHyrOh6G1\nR642MA0GCSqGSIb3DQEBCwUAA4IBAQBlvhRjwIryCrEC9hsnvOXv1KHw++voAwxL\nQ/uiM6bomzcf/eU7bPsERp6Irqq9hm6AH8SX3fcTWmQBUX9pR2AcjUuOntfFovfk\n1MaWCGWccv5/F0wa05rKxzS/cm+YgPllBusuVgkVP9TUc5ks6bpb+E0Lo/m4mr7q\ntytpqY/ye6SGDFOUTyu7oJPmhL29xFzGGO8/a/lv1Y2JWdL05lj2pdVcf0AFY1nv\nwRjR8qNAdaOjVhVhhcwavvsdLlne0TDjHi2H9WLCYuF2mdWCJHRF+amSVZ/vtYKT\n5M/HMowKJsdhd8e+m0/ZXdH8DiEon88BBipj5H1inpBP0bDSe/8D\n-----END CERTIFICATE REQUEST-----", "certificateDetail": "-----BEGIN CERTIFICATE-----\nMIIDpTCCAo0CCFGW4I9X+0imMA0GCSqGSIb3DQEBCwUAMIGGMQswCQYDVQQGEwJV\nUzETMBEGA1UECBMKQ2FsaWZvcm5pYTERMA8GA1UEBxMIU2FuIEpvc2UxFTATBgNV\nBAsTDHZJUHRlbGEgVGVzdDEUMBIGA1UEChMLdklQdGVsYSBJbmMxIjAgBgkqhkiG\n9w0BCQEWE3NhbnRvc2hAdmlwdGVsYS5jb20wHhcNMjMwNTIyMTcwODUyWhcNMzQw\nNTE5MTcwODUyWjCBojELMAkGA1UEBhMCVVMxEzARBgNVBAgMCkNhbGlmb3JuaWEx\nETAPBgNVBAcMCFNhbiBKb3NlMRcwFQYDVQQLDA52bW5nX3NjYWxlX2luZDEUMBIG\nA1UECgwLdklQdGVsYSBJbmMxGDAWBgNVBAMMD3ZpcHRlbGEudGVzdGJlZDEiMCAG\nCSqGSIb3DQEJARYTc2FudG9zaEB2aXB0ZWxhLmNvbTCCASIwDQYJKoZIhvcNAQEB\nBQADggEPADCCAQoCggEBALV3tFqlB71z4lI/m1GV35IThEhF170umWc7EaKswA3k\nNaFLYpz3TVTSiLLbqLcsV1r/choDd3OTf4gjkcEK3koSFNZjSOmK65IL/9FA4uyz\nOBexC7tmUh/6fE/UH8bxPCDapPWelXT7ax8flhjROgVml/vJ7+hfwvEsrsRyoplE\nlquBbvWLHjXiGBII6U3e0ZF3UErjM0CSZK4s3l56xeKKtAUQo3d8aKBfZkBlJ04p\nQR4PS7XGygd//Wc7d6RqNd5JofednL7mm7nnMWN4vIRlPGL6mP9OmpZkjoBcCR3C\nnGTB38KEAxmXkNp8yeVqA+rsBiH++84C86rKc/3bvycCAwEAATANBgkqhkiG9w0B\nAQsFAAOCAQEAMGHa0Q7Stz58Rw2FFNXtwjEuotBSbjdhTeh6EmsWov+qZH63//uO\njQLlFG/n7sLXNHFv5ohXY274JlhxJ5fCiOp9c6r+IcU+nbr3e/fzIIGYKEBg4hs9\nMyiLN5D+dimcIDoYhY3MMOR4pY2B68ND6qK0IPGnSkYEQdf74H7+/FPoqYfqebCx\nBvH6SmlETLG2AquawNhmQEiK4+OBf0V+u26Krk+vbm+Pk7x9Ilz7fU5qhILGCIb7\nAv+F0Bp3aiHDF8fW1dIHO0HUtkmBFlBC3xyiEY/0/b8mldo5JoNJAWW9IsLggwro\nxHeX0M2EwbJ8d1xed3izQK4NyiAjB7J+MA==\n-----END CERTIFICATE-----", "state": "Installed", "globalState": "normal", "valid": "valid", "requestTokenID": "d729d58e-eccb-47fb-868a-e0200a6751c9", "expirationDate": "May 19 17:08:52 2034 GMT", "expirationDateLong": 2031671332000, "deviceIP": "10.10.10.10", "activity": [ "Installed" ], "state_vedgeList": "Sync", "certInstallStatus": "Installed", "org": "vmng_scale_ind", "personality": "vbond", "expirationStatus": "normal", "timeRemainingForExpiration": 314269584088, "solution": "common", "site-id": "110", "host-name": "rk-cluster_vbond", "system-ip": "10.10.10.10", "vbond": "70.70.70.100", "vmanageConnectionState": "connected", "local-system-ip": "10.10.10.10", "availableVersions": [], "defaultVersion": "20.13.0-18", "reachability": "reachable", "version": "20.13.0-18", "uptime-date": 1716453180000, "model_sku": "None", "lastupdated": 1717444306004, "vmanage-system-ip": "10.10.10.10", "sp-organization-name": "vmng_scale_ind", "organization-name": "vmng_scale_ind", "lifeCycleRequired": true, "hardwareCertSerialNumber": "NA", "subjectSerialNumber": "NA", "resourceGroup": "global", "id": "NA", "tags": [], "draftMode": "Disabled", "site-name": "SITE_110", "device-lock": "No", "managed-by": "Unmanaged" }, { "configuredSiteId": "101", "configuredSystemIP": "1.1.1.1", "deviceType": "vmanage", "serialNumber": "DAB94D5D4E992349", "ncsDeviceName": "vmanage-a0721e2e-c55b-41c8-8ee0-01e48a1f4cba", "configStatusMessage": "In Sync", "templateApplyLog": [ "[1-Jun-2024 7:43:40 UTC] Sync-from successful" ], "uuid": "a0721e2e-c55b-41c8-8ee0-01e48a1f4cba", "managementSystemIP": "1.1.1.1", "templateStatus": "Success", "chasisNumber": "a0721e2e-c55b-41c8-8ee0-01e48a1f4cba", "configStatusMessageDetails": "", "configOperationMode": "cli", "deviceModel": "vmanage", "deviceState": "READY", "validity": "valid", "platformFamily": "vmanage", "hardwareVedge": false, "username": "--", "rootCertHash": "65ef79171aada3c7bd008fc889aaee56db5005c4", "CSR": "viptela.testbed", "CSRDetail": "-----BEGIN CERTIFICATE REQUEST-----\nMIIDIzCCAgsCAQAwgaIxCzAJBgNVBAYTAlVTMRMwEQYDVQQIDApDYWxpZm9ybmlh\nMREwDwYDVQQHDAhTYW4gSm9zZTEXMBUGA1UECwwOdm1uZ19zY2FsZV9pbmQxFDAS\nBgNVBAoMC3ZJUHRlbGEgSW5jMRgwFgYDVQQDDA92aXB0ZWxhLnRlc3RiZWQxIjAg\nBgkqhkiG9w0BCQEWE3NhbnRvc2hAdmlwdGVsYS5jb20wggEiMA0GCSqGSIb3DQEB\nAQUAA4IBDwAwggEKAoIBAQDCieIKVr2dsjZ36IVbjT831hYchHzjoi4xtZ4qawzy\n8EedgDK0Q8EkAODGSNbfduDmJbO3BPPMib+Moo0pdZi7nofCvEphGSh/EJ5HRAbd\nF4t8e5OtS50b3bOonN4hmdP6aLxj97TEjENLKCCFRuTrVRIxcvjnNOMh9m/DMzRp\nSA2jsSqvJj27Vc4saG/Tg2C/ahmoI7UCYWLLHU6FNnnzi3MLUCG0qWePL1gyrqOj\nm8G0zpAI1JQRQMyO+66Aba8Q0/XBUyfKk/XyBGyp8AvMor780ldQmF/iUshznrFJ\nshmgbs0WH9nfCEWGT1yDE6xslMg2sVZWPgGhjh45TgelAgMBAAGgOzA5BgkqhkiG\n9w0BCQ4xLDAqMAkGA1UdEwQCMAAwHQYDVR0OBBYEFMi+Mv7j/Im7TU6P3SFQnZZO\nELJ4MA0GCSqGSIb3DQEBCwUAA4IBAQCoHsKgjOgr8PN/6BNUnLMSjZ1aaRx96pvo\nP36V0UPpSN/HlfzCDOM/wm4AGqpXsPytnwhXh/9A+xNOLiBmOjq2lxwl3K9jx06v\n/9Prkg8ED1SYTV8TNQ+KkJxw5wqxmFB0c9p96VIRe3WznDCJKuRpd2Dn+VuhqtTJ\nfYC3/HnNqU3PiEX9It1Ui/JvB9Hy5OKJQLK2UgzMoWFpA0J9hUAtnX+32ZciskCr\nHzTDuJVgvV5SxUaooXULprQ3z7wc/iHu0CYa9t0mvnrsBnhl6cUmjDmAlLYA3CJ9\nsEqDosMPyIWc8CSDEcV0eN/7/vW0RvorjPc+1dWRTBBXbbDthEqq\n-----END CERTIFICATE REQUEST-----", "certificateDetail": "-----BEGIN CERTIFICATE-----\nMIIDpjCCAo4CCQDauU1dTpkjSTANBgkqhkiG9w0BAQsFADCBhjELMAkGA1UEBhMC\nVVMxEzARBgNVBAgTCkNhbGlmb3JuaWExETAPBgNVBAcTCFNhbiBKb3NlMRUwEwYD\nVQQLEwx2SVB0ZWxhIFRlc3QxFDASBgNVBAoTC3ZJUHRlbGEgSW5jMSIwIAYJKoZI\nhvcNAQkBFhNzYW50b3NoQHZpcHRlbGEuY29tMB4XDTIzMDUyMjE3MDg1MFoXDTM0\nMDUxOTE3MDg1MFowgaIxCzAJBgNVBAYTAlVTMRMwEQYDVQQIDApDYWxpZm9ybmlh\nMREwDwYDVQQHDAhTYW4gSm9zZTEXMBUGA1UECwwOdm1uZ19zY2FsZV9pbmQxFDAS\nBgNVBAoMC3ZJUHRlbGEgSW5jMRgwFgYDVQQDDA92aXB0ZWxhLnRlc3RiZWQxIjAg\nBgkqhkiG9w0BCQEWE3NhbnRvc2hAdmlwdGVsYS5jb20wggEiMA0GCSqGSIb3DQEB\nAQUAA4IBDwAwggEKAoIBAQDCieIKVr2dsjZ36IVbjT831hYchHzjoi4xtZ4qawzy\n8EedgDK0Q8EkAODGSNbfduDmJbO3BPPMib+Moo0pdZi7nofCvEphGSh/EJ5HRAbd\nF4t8e5OtS50b3bOonN4hmdP6aLxj97TEjENLKCCFRuTrVRIxcvjnNOMh9m/DMzRp\nSA2jsSqvJj27Vc4saG/Tg2C/ahmoI7UCYWLLHU6FNnnzi3MLUCG0qWePL1gyrqOj\nm8G0zpAI1JQRQMyO+66Aba8Q0/XBUyfKk/XyBGyp8AvMor780ldQmF/iUshznrFJ\nshmgbs0WH9nfCEWGT1yDE6xslMg2sVZWPgGhjh45TgelAgMBAAEwDQYJKoZIhvcN\nAQELBQADggEBAHz2EX4LyW6qOmHA7oRBBYhAycaSe7yaSdvfEIbkx0peinAnDlej\nVCIPDfNDuSAqkGmuEnf62I6ISEdTKAzDX/g1539qAmtzU1kt/WNdTt8LuVU45O55\nSJK+yb+AARdocujOTDuO1ZdN3FUjYL7gMs+KJ8q53o+CA7aRSt/Itn0cEt5Q2BWF\ndR7RU+1nmIgjMJEFRZrTt4lTdKyg8ZGHGxFc6eLuXvvTBx5HOTSgIC77NJ0NnvuA\ntrX2Pmffu8+WvYJ9Dl0xiQoHS361y3XBKNwgY2n8R7UBPU4aVYJ8WbXQgWiYHmlD\nwS8vII9IbEUbef9sPqL5hW3sTA+inGchgSM=\n-----END CERTIFICATE-----", "state": "vBond Updated", "globalState": "normal", "valid": "valid", "requestTokenID": "9abee880-3bfd-43a2-a337-79b424aa91fe", "expirationDate": "May 19 17:08:50 2034 GMT", "expirationDateLong": 2031671330000, "deviceIP": "1.1.1.1", "activity": [ "vBond Updated" ], "state_vedgeList": "Sync", "certInstallStatus": "Installed", "servicePersonality": "all", "personality": "vmanage", "expirationStatus": "normal", "uploadSource": "Auto Discovered", "timeRemainingForExpiration": 314269582088, "solution": "common", "site-id": "101", "host-name": "rk-cluster_vmanage-1", "system-ip": "1.1.1.1", "vbond": "vbond", "vmanageConnectionState": "connected", "local-system-ip": "1.1.1.1", "availableVersions": [ "20.15.999-3588", "20.16.999-3693" ], "defaultVersion": "20.15.999-3588", "reachability": "reachable", "version": "20.15.0-77", "uptime-date": 1717150500000, "model_sku": "None", "lastupdated": 1717406751085, "vmanage-system-ip": "1.1.1.1", "domain-id": "0", "sp-organization-name": "vmng_scale_ind", "organization-name": "vmng_scale_ind", "lifeCycleRequired": false, "hardwareCertSerialNumber": "NA", "subjectSerialNumber": "NA", "resourceGroup": "global", "id": "NA", "tags": [], "draftMode": "Disabled", "site-name": "SITE_101", "device-lock": "No", "managed-by": "Unmanaged" }, { "configuredSiteId": "103", "configuredSystemIP": "3.3.3.3", "deviceType": "vmanage", "serialNumber": "830936A1DB70CB0A", "ncsDeviceName": "vmanage-99102a89-c019-4ab0-bc46-4b3ddb3143e7", "configStatusMessage": "In Sync", "templateApplyLog": [ "[1-Jun-2024 7:48:03 UTC] Sync-from successful" ], "uuid": "99102a89-c019-4ab0-bc46-4b3ddb3143e7", "managementSystemIP": "3.3.3.3", "templateStatus": "Success", "chasisNumber": "99102a89-c019-4ab0-bc46-4b3ddb3143e7", "configStatusMessageDetails": "", "configOperationMode": "cli", "deviceModel": "vmanage", "deviceState": "READY", "validity": "valid", "platformFamily": "vmanage", "hardwareVedge": false, "username": "--", "rootCertHash": "65ef79171aada3c7bd008fc889aaee56db5005c4", "CSR": "viptela.testbed", "CSRDetail": "-----BEGIN CERTIFICATE REQUEST-----\nMIIDIzCCAgsCAQAwgaIxCzAJBgNVBAYTAlVTMRMwEQYDVQQIDApDYWxpZm9ybmlh\nMREwDwYDVQQHDAhTYW4gSm9zZTEXMBUGA1UECwwOdm1uZ19zY2FsZV9pbmQxFDAS\nBgNVBAoMC3ZJUHRlbGEgSW5jMRgwFgYDVQQDDA92aXB0ZWxhLnRlc3RiZWQxIjAg\nBgkqhkiG9w0BCQEWE3NhbnRvc2hAdmlwdGVsYS5jb20wggEiMA0GCSqGSIb3DQEB\nAQUAA4IBDwAwggEKAoIBAQCfgqeLd6uhhJO3d9A8wTyXzsUKrWr41ePsaR6z9AmJ\nnKiOLjNIHf4/W1JZZs6BqsekXjWDRMKuHfsJwzcyaf3SdKrAYHN9eoDhBCFWR5yK\na5pRhpaLbAPQmBqjQ8ToIxU/NAX9ql8RTFai18q4AYNL7s3wn6wArTDBEqERpI/K\nfEd88Sx2TmLb6kUcKTynA3mhwFMFKg2sVn8oWVwdvAwTFNVnqYv2Ij+Qnb3OAE93\nglcvu9SZCpKBvxtRwL/63v+WN/zOKPqoG8tRDTtWWvTnYhUbTEJu41w/ITHy9bfb\nBhVG/dTptLkRTdZ/0yxpvLX362b7TaveXt+OGlGlLSCnAgMBAAGgOzA5BgkqhkiG\n9w0BCQ4xLDAqMAkGA1UdEwQCMAAwHQYDVR0OBBYEFNxuQlGrQcRY2hR9Yx+YaXgC\n+IRIMA0GCSqGSIb3DQEBCwUAA4IBAQBbYG7a7n/KjEqroiaUAVtPwAhVMjlw3LDc\nvpNTnGyyuE+N9nSjj1Uwvi2XLQUaXgJK6+kTy0PepoC/T/eGxzx4pbFuJM0rqp0w\nVYaGnWp4BUGjTxSfEJ7CgfD60QsXJA/CQJVxyED2AG6xfTkIdyfRoew7r2ka09Bw\n2bBHJdJxsbaIwzzL+DnxgqG/VtbSAJ+LgDEBUH4Pj+6KSjakr2A8XHn7BBWkEgvF\nR/mbNXkLiu3IKrbGpNx/UZ4hTv5kHSdM7tZsjszJGeMzcW8buUJ3kQuyFwEkSKKA\nQy0SazO0TAWy0XzOiKnd0AzYVO9K7DYLBvDT36IZALb5p9Z+Y/pX\n-----END CERTIFICATE REQUEST-----", "certificateDetail": "-----BEGIN CERTIFICATE-----\nMIIDpjCCAo4CCQCDCTah23DLCjANBgkqhkiG9w0BAQsFADCBhjELMAkGA1UEBhMC\nVVMxEzARBgNVBAgTCkNhbGlmb3JuaWExETAPBgNVBAcTCFNhbiBKb3NlMRUwEwYD\nVQQLEwx2SVB0ZWxhIFRlc3QxFDASBgNVBAoTC3ZJUHRlbGEgSW5jMSIwIAYJKoZI\nhvcNAQkBFhNzYW50b3NoQHZpcHRlbGEuY29tMB4XDTIzMDUyMjE3MDg1MVoXDTM0\nMDUxOTE3MDg1MVowgaIxCzAJBgNVBAYTAlVTMRMwEQYDVQQIDApDYWxpZm9ybmlh\nMREwDwYDVQQHDAhTYW4gSm9zZTEXMBUGA1UECwwOdm1uZ19zY2FsZV9pbmQxFDAS\nBgNVBAoMC3ZJUHRlbGEgSW5jMRgwFgYDVQQDDA92aXB0ZWxhLnRlc3RiZWQxIjAg\nBgkqhkiG9w0BCQEWE3NhbnRvc2hAdmlwdGVsYS5jb20wggEiMA0GCSqGSIb3DQEB\nAQUAA4IBDwAwggEKAoIBAQCfgqeLd6uhhJO3d9A8wTyXzsUKrWr41ePsaR6z9AmJ\nnKiOLjNIHf4/W1JZZs6BqsekXjWDRMKuHfsJwzcyaf3SdKrAYHN9eoDhBCFWR5yK\na5pRhpaLbAPQmBqjQ8ToIxU/NAX9ql8RTFai18q4AYNL7s3wn6wArTDBEqERpI/K\nfEd88Sx2TmLb6kUcKTynA3mhwFMFKg2sVn8oWVwdvAwTFNVnqYv2Ij+Qnb3OAE93\nglcvu9SZCpKBvxtRwL/63v+WN/zOKPqoG8tRDTtWWvTnYhUbTEJu41w/ITHy9bfb\nBhVG/dTptLkRTdZ/0yxpvLX362b7TaveXt+OGlGlLSCnAgMBAAEwDQYJKoZIhvcN\nAQELBQADggEBAKFGdA5UoFKQW1gnCEvf93tdXCW2vfq4mxBGfjXu1KqOFhO+WY5L\nMGbAwmMLErJ3ed7DS4XoPA9q0f7zJz75yWWvN2eIt/1TgAetRHaJALdTEfRiQRmj\nmpKsFH0YRdUUf5FIGhmMTCFgyVPJlRfSnZp7yH2Q1s5YfaCCo/19QLDdoWsPo6V/\nAcOydissaY63fAWvrg9CB9mJTSBZBGckdCCm0H7s4/mf4lviOlHkd3/tAm+C2DXY\nPjtrUvPCfNsYOwsfT7HAqf8u9XOtKof3PYLkJJECLXueewvTiyv6Pvo4ORB8QqIz\ny2J1O+gJEG2IUDck9CCebziL7sr+YE16H/w=\n-----END CERTIFICATE-----", "state": "vBond Updated", "globalState": "normal", "valid": "valid", "requestTokenID": "512a156d-e4fc-46f8-96aa-26eb5d1f438e", "expirationDate": "May 19 17:08:51 2034 GMT", "expirationDateLong": 2031671331000, "deviceIP": "3.3.3.3", "activity": [ "vBond Updated" ], "state_vedgeList": "Sync", "certInstallStatus": "Installed", "servicePersonality": "all", "personality": "vmanage", "expirationStatus": "normal", "uploadSource": "Auto Discovered", "timeRemainingForExpiration": 314269583088, "solution": "common", "site-id": "103", "host-name": "rk-cluster_vmanage-3", "system-ip": "3.3.3.3", "vbond": "vbond", "vmanageConnectionState": "connected", "local-system-ip": "3.3.3.3", "availableVersions": [ "20.15.999-3588", "20.16.999-3693" ], "defaultVersion": "20.15.999-3588", "reachability": "reachable", "version": "20.15.0-77", "uptime-date": 1717150620000, "model_sku": "None", "lastupdated": 1717228092028, "vmanage-system-ip": "3.3.3.3", "domain-id": "0", "sp-organization-name": "vmng_scale_ind", "organization-name": "vmng_scale_ind", "lifeCycleRequired": false, "hardwareCertSerialNumber": "NA", "subjectSerialNumber": "NA", "resourceGroup": "global", "id": "NA", "tags": [], "draftMode": "Disabled", "site-name": "SITE_103", "device-lock": "No", "managed-by": "Unmanaged" }, { "configuredSiteId": "102", "configuredSystemIP": "2.2.2.2", "deviceType": "vmanage", "serialNumber": "345805101937F7B5", "ncsDeviceName": "vmanage-29f75e05-952c-4bbf-b3b6-4a3cce9ef545", "configStatusMessage": "In Sync", "templateApplyLog": [ "[3-Jun-2024 4:31:59 UTC] Sync-from successful" ], "uuid": "29f75e05-952c-4bbf-b3b6-4a3cce9ef545", "managementSystemIP": "2.2.2.2", "templateStatus": "Success", "chasisNumber": "29f75e05-952c-4bbf-b3b6-4a3cce9ef545", "configStatusMessageDetails": "", "configOperationMode": "cli", "deviceModel": "vmanage", "deviceState": "READY", "validity": "valid", "platformFamily": "vmanage", "hardwareVedge": false, "username": "--", "rootCertHash": "65ef79171aada3c7bd008fc889aaee56db5005c4", "CSR": "viptela.testbed", "CSRDetail": "-----BEGIN CERTIFICATE REQUEST-----\nMIIDIzCCAgsCAQAwgaIxCzAJBgNVBAYTAlVTMRMwEQYDVQQIDApDYWxpZm9ybmlh\nMREwDwYDVQQHDAhTYW4gSm9zZTEXMBUGA1UECwwOdm1uZ19zY2FsZV9pbmQxFDAS\nBgNVBAoMC3ZJUHRlbGEgSW5jMRgwFgYDVQQDDA92aXB0ZWxhLnRlc3RiZWQxIjAg\nBgkqhkiG9w0BCQEWE3NhbnRvc2hAdmlwdGVsYS5jb20wggEiMA0GCSqGSIb3DQEB\nAQUAA4IBDwAwggEKAoIBAQC09VbMZODJi6FH5m+NnDQyMldXlA/cFIPr+Fk0WlUD\nB9ufXsgivrm/TaAgyv/a6zXH2E3g47Y12V0j6AJ6Dm/trB+b6WjTAQFGGR6at6Nr\nPUkwkFm2//xy2nKFVqHUgwp8SZCSXf3M22U+brTeMCXWPxO8gQ8BhD9/R42Hnid2\nZvm9qbvKfy2Y7aU6bk8hkzkyJZBaATMwCiObYOXqqqr7WLK/IMIYuMg/o7n/FMbJ\nMTPuQ7jAMvYSXUlH5FJnVKAil/+JuC+iI8z7+kqLnVLeFObzIqr8hkCaKfgKWRgl\nh7OCtvNcv39X7uQabUI22AMvztHmcl9+XeKQcFKuyVBFAgMBAAGgOzA5BgkqhkiG\n9w0BCQ4xLDAqMAkGA1UdEwQCMAAwHQYDVR0OBBYEFJ5vXX/vYtILdFx6igqsnYBd\nEGSfMA0GCSqGSIb3DQEBCwUAA4IBAQAPO+sXkVdtjx4Wh4ef3c4IWcfWb/MRJjjk\nsGUn0sL1ieYSvWPGkkQSZTqwSNb18JLVJTwKSGADGlZp0VRWzarea06E9yACkqP2\nfjBV3I1qWzwdj8Rq4DqLrQde/ZKYqHRs3BW+fjrBiVJn/0EUzXK2wh/Buy/qDmYz\ncVu+g5J7G5zbjG56ZxFV6UmrYPsD7QWSgikmLIFrWy/bE1dykPURruxVVaJ56CyB\nRnijINSTGVa7aPio8LT0aQkE4soKxAcZ0Ed9w5lHMvZoJa2wv6twSOK0BbAoN6bg\nTqtEw+HwnDbfGjsL2qA35teRG9cFTNUyU8xhdfspop8qtFJjoC13\n-----END CERTIFICATE REQUEST-----", "certificateDetail": "-----BEGIN CERTIFICATE-----\nMIIDpTCCAo0CCDRYBRAZN/e1MA0GCSqGSIb3DQEBCwUAMIGGMQswCQYDVQQGEwJV\nUzETMBEGA1UECBMKQ2FsaWZvcm5pYTERMA8GA1UEBxMIU2FuIEpvc2UxFTATBgNV\nBAsTDHZJUHRlbGEgVGVzdDEUMBIGA1UEChMLdklQdGVsYSBJbmMxIjAgBgkqhkiG\n9w0BCQEWE3NhbnRvc2hAdmlwdGVsYS5jb20wHhcNMjMwNTIyMTcwODUxWhcNMzQw\nNTE5MTcwODUxWjCBojELMAkGA1UEBhMCVVMxEzARBgNVBAgMCkNhbGlmb3JuaWEx\nETAPBgNVBAcMCFNhbiBKb3NlMRcwFQYDVQQLDA52bW5nX3NjYWxlX2luZDEUMBIG\nA1UECgwLdklQdGVsYSBJbmMxGDAWBgNVBAMMD3ZpcHRlbGEudGVzdGJlZDEiMCAG\nCSqGSIb3DQEJARYTc2FudG9zaEB2aXB0ZWxhLmNvbTCCASIwDQYJKoZIhvcNAQEB\nBQADggEPADCCAQoCggEBALT1Vsxk4MmLoUfmb42cNDIyV1eUD9wUg+v4WTRaVQMH\n259eyCK+ub9NoCDK/9rrNcfYTeDjtjXZXSPoAnoOb+2sH5vpaNMBAUYZHpq3o2s9\nSTCQWbb//HLacoVWodSDCnxJkJJd/czbZT5utN4wJdY/E7yBDwGEP39HjYeeJ3Zm\n+b2pu8p/LZjtpTpuTyGTOTIlkFoBMzAKI5tg5eqqqvtYsr8gwhi4yD+juf8Uxskx\nM+5DuMAy9hJdSUfkUmdUoCKX/4m4L6IjzPv6SoudUt4U5vMiqvyGQJop+ApZGCWH\ns4K281y/f1fu5BptQjbYAy/O0eZyX35d4pBwUq7JUEUCAwEAATANBgkqhkiG9w0B\nAQsFAAOCAQEAatWN1otSveT8jbVhlYiITo1NXwkwHF+0BKL0gOuIH9sd9tGN4DNA\nkAXpMkej9w3nggNqDCpl/SLAbumJFwsZ0i80h2YxFKCleS5kdW40EDHlL8DKQXh2\nuh6eGQ6LGKOSCFciCmJh8B3gkfeedFYKoAtO50RjK1xBfbE1kTaC1gZoxCP4eHWQ\nHA3besGya5MKlUgV1ynp7XQ95Pu+YgJqEisvF9tvT3WMzMpIM1mZUVj3dPGi63ea\n3+LXXPfsO2vHdZBqhCXgMf1oPHNxKKyYjZvBm8a4q6KIhG0e6elrs22PzAdT8SYG\nZnTaFuEDuR2KF2wTA0b9cBqtCEZzyAq+Ug==\n-----END CERTIFICATE-----", "state": "vBond Updated", "globalState": "normal", "valid": "valid", "requestTokenID": "801c3d24-5d88-4cb3-87f5-2bdf8ba7ad2a", "expirationDate": "May 19 17:08:51 2034 GMT", "expirationDateLong": 2031671331000, "deviceIP": "2.2.2.2", "activity": [ "vBond Updated" ], "state_vedgeList": "Sync", "certInstallStatus": "Installed", "servicePersonality": "all", "personality": "vmanage", "expirationStatus": "normal", "uploadSource": "Auto Discovered", "timeRemainingForExpiration": 314269583088, "solution": "common", "site-id": "102", "host-name": "rk-cluster_vmanage-2", "system-ip": "2.2.2.2", "vbond": "vbond", "vmanageConnectionState": "connected", "local-system-ip": "2.2.2.2", "availableVersions": [ "20.15.999-3588", "20.16.999-3693" ], "defaultVersion": "20.15.999-3588", "reachability": "reachable", "version": "20.15.0-77", "uptime-date": 1717150140000, "model_sku": "None", "lastupdated": 1717406320352, "vmanage-system-ip": "2.2.2.2", "domain-id": "0", "sp-organization-name": "vmng_scale_ind", "organization-name": "vmng_scale_ind", "lifeCycleRequired": false, "hardwareCertSerialNumber": "NA", "subjectSerialNumber": "NA", "resourceGroup": "global", "id": "NA", "tags": [], "draftMode": "Disabled", "site-name": "SITE_102", "device-lock": "No", "managed-by": "Unmanaged" }, { "configuredSiteId": "104", "configuredSystemIP": "4.4.4.4", "deviceType": "vsmart", "serialNumber": "50C3EB73A9D05BD4", "ncsDeviceName": "vsmart-37ee489a-12d6-4ac1-9c7c-022a11a274d6", "configStatusMessage": "In Sync", "templateApplyLog": [ "[23-May-2024 13:54:58 UTC] Sync-from successful" ], "uuid": "37ee489a-12d6-4ac1-9c7c-022a11a274d6", "managementSystemIP": "0.0.0.0", "templateStatus": "Success", "chasisNumber": "37ee489a-12d6-4ac1-9c7c-022a11a274d6", "configStatusMessageDetails": "", "configOperationMode": "cli", "deviceModel": "vsmart", "deviceState": "READY", "validity": "valid", "platformFamily": "vsmart", "hardwareVedge": false, "username": "--", "rootCertHash": "65ef79171aada3c7bd008fc889aaee56db5005c4", "CSR": "viptela.testbed", "CSRDetail": "-----BEGIN CERTIFICATE REQUEST-----\nMIIDIzCCAgsCAQAwgaIxCzAJBgNVBAYTAlVTMRMwEQYDVQQIDApDYWxpZm9ybmlh\nMREwDwYDVQQHDAhTYW4gSm9zZTEXMBUGA1UECwwOdm1uZ19zY2FsZV9pbmQxFDAS\nBgNVBAoMC3ZJUHRlbGEgSW5jMRgwFgYDVQQDDA92aXB0ZWxhLnRlc3RiZWQxIjAg\nBgkqhkiG9w0BCQEWE3NhbnRvc2hAdmlwdGVsYS5jb20wggEiMA0GCSqGSIb3DQEB\nAQUAA4IBDwAwggEKAoIBAQDl/rm66yXRwRy28XBArc+hogupLy7IsRji5QTRNK2n\nBQCbNv6Xv8Evg4D3yAFpWfFnZkir4du1uv32A2/djEJ2Pvt8xAOxAqVdbzkcFRX2\niqA7LSyZFGHxFlkLYCniq9PLYccQmKmOH2OHRVltrl23Idh1orDxVGG90Aa2X3xJ\nk/OeYDyoyGObOx/y7jaofXEqqA/WWS+ySYS+YwgN9kLwXA65F/EjiORdBA6Snp4E\nZS0lahXEs3lkrRsWFxptGLmAkSRHCmy9CjTGgvUV7Ai/jFZLixp2OfxhD4tFFOFy\n0W5j0adJfuNgfMVV2ol9t1XuBPn0wn1DH6QxbaSHL41PAgMBAAGgOzA5BgkqhkiG\n9w0BCQ4xLDAqMAkGA1UdEwQCMAAwHQYDVR0OBBYEFNHyAto6YSTHtVNIwIL4n1Fw\nBt8XMA0GCSqGSIb3DQEBCwUAA4IBAQBIx+yAx9dCvIHUwgJrea0swR2DFFxvnGRk\nscPSTCUUDRZSgO28NgcnEkBaylhUZmmJk+qkyVZyw3iRCijGuiqlGFZM0CzfPgKg\nSoiVpHeZPz2lwbL48ftr1b/k5xZ3kh8TRRVBCYIvkgNRnB1e3670wi+CLHL3ny5Z\n6Ao8shmK0oM8IUdK4L7IWOwNIFi9uvCLZVEnVl+uUhNbypGwRXMihpUb8OSSmihO\nvS6EXrT7uQFs6y6DygH1vY3haAuyMbqySKlKT+p9nXrLPVlXSM99/B40iYLSHfu0\n5nodCjZdJcwGhSTN18y7ewMKMqg8mGrRqNUNQJOiHWDDVThdoS0h\n-----END CERTIFICATE REQUEST-----", "certificateDetail": "-----BEGIN CERTIFICATE-----\nMIIDpTCCAo0CCFDD63Op0FvUMA0GCSqGSIb3DQEBCwUAMIGGMQswCQYDVQQGEwJV\nUzETMBEGA1UECBMKQ2FsaWZvcm5pYTERMA8GA1UEBxMIU2FuIEpvc2UxFTATBgNV\nBAsTDHZJUHRlbGEgVGVzdDEUMBIGA1UEChMLdklQdGVsYSBJbmMxIjAgBgkqhkiG\n9w0BCQEWE3NhbnRvc2hAdmlwdGVsYS5jb20wHhcNMjMwNTIyMTcwODUxWhcNMzQw\nNTE5MTcwODUxWjCBojELMAkGA1UEBhMCVVMxEzARBgNVBAgMCkNhbGlmb3JuaWEx\nETAPBgNVBAcMCFNhbiBKb3NlMRcwFQYDVQQLDA52bW5nX3NjYWxlX2luZDEUMBIG\nA1UECgwLdklQdGVsYSBJbmMxGDAWBgNVBAMMD3ZpcHRlbGEudGVzdGJlZDEiMCAG\nCSqGSIb3DQEJARYTc2FudG9zaEB2aXB0ZWxhLmNvbTCCASIwDQYJKoZIhvcNAQEB\nBQADggEPADCCAQoCggEBAOX+ubrrJdHBHLbxcECtz6GiC6kvLsixGOLlBNE0racF\nAJs2/pe/wS+DgPfIAWlZ8WdmSKvh27W6/fYDb92MQnY++3zEA7ECpV1vORwVFfaK\noDstLJkUYfEWWQtgKeKr08thxxCYqY4fY4dFWW2uXbch2HWisPFUYb3QBrZffEmT\n855gPKjIY5s7H/LuNqh9cSqoD9ZZL7JJhL5jCA32QvBcDrkX8SOI5F0EDpKengRl\nLSVqFcSzeWStGxYXGm0YuYCRJEcKbL0KNMaC9RXsCL+MVkuLGnY5/GEPi0UU4XLR\nbmPRp0l+42B8xVXaiX23Ve4E+fTCfUMfpDFtpIcvjU8CAwEAATANBgkqhkiG9w0B\nAQsFAAOCAQEAf26xJsaqrVkpbwrfLV94ahrJTYfRaYka8VDPXzm93W3h+XpXYlBE\n2WhAqypS6QYUMD9dMtEKOgHErbIdMO+q9pf/S+aC12l7Pe7PoU9cJ3NXRywOzfm+\n7CDFqy+i4vfsvus38hD5pLD/xh6ncX78/FQJJKpe4VvvIDDaNhZGIWRShr6ILJ4M\nG2hs8vAk1/W2uFvSiOCplrkL/afGqI/4OSTEYO8GzuGQyBgCxSA5/cO1WqmfazSB\nZfMKY7WvNrWpCy7eNsIEnionavfKopCpVGw5MdeZlEYUqpekmsu9+BxM+J/hfN4m\nNaznDWwgykCTwpNt+KOqZDYqY1eC+2FQgA==\n-----END CERTIFICATE-----", "state": "vBond Updated", "globalState": "normal", "valid": "valid", "requestTokenID": "edf568be-8703-4c90-9e83-f551bef1c937", "expirationDate": "May 19 17:08:51 2034 GMT", "expirationDateLong": 2031671331000, "deviceIP": "4.4.4.4", "activity": [ "vBond Updated" ], "state_vedgeList": "Sync", "certInstallStatus": "Installed", "org": "vmng_scale_ind", "personality": "vsmart", "expirationStatus": "normal", "timeRemainingForExpiration": 314269583088, "region-id": [], "solution": "sdwan", "site-id": "104", "host-name": "rk-cluster_vsmart-1", "system-ip": "4.4.4.4", "vbond": "vbond", "vmanageConnectionState": "connected", "policy-template-name": "", "policy-template-version": "", "local-system-ip": "4.4.4.4", "availableVersions": [], "defaultVersion": "20.13.0-18", "reachability": "reachable", "version": "20.13.0-18", "uptime-date": 1716453180000, "model_sku": "None", "lastupdated": 1717465025640, "vmanage-system-ip": "4.4.4.4", "domain-id": "1", "sp-organization-name": "vmng_scale_ind", "organization-name": "vmng_scale_ind", "lifeCycleRequired": false, "hardwareCertSerialNumber": "NA", "subjectSerialNumber": "NA", "resourceGroup": "global", "id": "NA", "tags": [], "draftMode": "Disabled", "site-name": "SITE_104", "device-lock": "No", "managed-by": "Unmanaged" }, { "configuredSiteId": "105", "configuredSystemIP": "5.5.5.5", "deviceType": "vsmart", "serialNumber": "C7B8786D95CF81D2", "ncsDeviceName": "vsmart-2f6e3473-2fbb-4b40-82d6-3ac11c33ec68", "configStatusMessage": "In Sync", "templateApplyLog": [ "[23-May-2024 13:54:58 UTC] Sync-from successful" ], "uuid": "2f6e3473-2fbb-4b40-82d6-3ac11c33ec68", "managementSystemIP": "0.0.0.0", "templateStatus": "Success", "chasisNumber": "2f6e3473-2fbb-4b40-82d6-3ac11c33ec68", "configStatusMessageDetails": "", "configOperationMode": "cli", "deviceModel": "vsmart", "deviceState": "READY", "validity": "valid", "platformFamily": "vsmart", "hardwareVedge": false, "username": "--", "rootCertHash": "65ef79171aada3c7bd008fc889aaee56db5005c4", "CSR": "viptela.testbed", "CSRDetail": "-----BEGIN CERTIFICATE REQUEST-----\nMIIDIzCCAgsCAQAwgaIxCzAJBgNVBAYTAlVTMRMwEQYDVQQIDApDYWxpZm9ybmlh\nMREwDwYDVQQHDAhTYW4gSm9zZTEXMBUGA1UECwwOdm1uZ19zY2FsZV9pbmQxFDAS\nBgNVBAoMC3ZJUHRlbGEgSW5jMRgwFgYDVQQDDA92aXB0ZWxhLnRlc3RiZWQxIjAg\nBgkqhkiG9w0BCQEWE3NhbnRvc2hAdmlwdGVsYS5jb20wggEiMA0GCSqGSIb3DQEB\nAQUAA4IBDwAwggEKAoIBAQC9u5nkBY7uaDSXcHLw3OE1wLEoZy/p/REGjqY+Shro\ndaSu4cVSbD//J8H4ehYNNPdtMAuUrfQO8l2tRDBrSvrycEgG7pGIommHsqQRFcgP\nDe2fCl25sBPPi+96k6neYU96IkwWrOwAuhiP4loUZze0gbT1ALZ+GcadFYvxJgl0\nTnFZxmxP7shCFqRKC1vd2/aOqGv2Chnjo2nQkf989HyMdzZb/+M1VX4+vRQOO2L+\nPkwQX9FjueVTqAG8NvzNC2MRAmtLFe9YgQlpFWNdidY3dhRp/SM09ibaewzUtzMX\nNa91eT+VAq9QbQHoJIV70DhJKQlV8zSnkpeHusXKsl93AgMBAAGgOzA5BgkqhkiG\n9w0BCQ4xLDAqMAkGA1UdEwQCMAAwHQYDVR0OBBYEFN2UZw0glTAdyfPSsk/vplZB\n3j9AMA0GCSqGSIb3DQEBCwUAA4IBAQCzJsUDyt5BiVuCkiyfgvoKse58NtkV2AYR\n3jwbMlnTaroNMFyiq9RldO4enfsjWj8y49NI1P475nzgJmLyD7rU839uEvTbt71X\nuyExWpS3+7XuAwkX6qALd77c52KBL0FOnGiH98EKd+Y51LqVsQC/vop/JmYoReiS\nZr0rdnlnhGMIbGDr3Ku4rdfEPH3VWUq70DgfxpTM3x+TBO9+5YM/wOMVLMpK1Qt7\nUzR+30Cz1WNrG2msUDsowfrLM/KeE9BR897QqqV/C6T9UO0QYHo91nLrT34XYZbC\nqhpX8IeNi8PJvrAbOVwV/Fan+jteWslWH5SrA6HKonJxupk8qBk/\n-----END CERTIFICATE REQUEST-----", "certificateDetail": "-----BEGIN CERTIFICATE-----\nMIIDpjCCAo4CCQDHuHhtlc+B0jANBgkqhkiG9w0BAQsFADCBhjELMAkGA1UEBhMC\nVVMxEzARBgNVBAgTCkNhbGlmb3JuaWExETAPBgNVBAcTCFNhbiBKb3NlMRUwEwYD\nVQQLEwx2SVB0ZWxhIFRlc3QxFDASBgNVBAoTC3ZJUHRlbGEgSW5jMSIwIAYJKoZI\nhvcNAQkBFhNzYW50b3NoQHZpcHRlbGEuY29tMB4XDTIzMDUyMjE3MDg1MVoXDTM0\nMDUxOTE3MDg1MVowgaIxCzAJBgNVBAYTAlVTMRMwEQYDVQQIDApDYWxpZm9ybmlh\nMREwDwYDVQQHDAhTYW4gSm9zZTEXMBUGA1UECwwOdm1uZ19zY2FsZV9pbmQxFDAS\nBgNVBAoMC3ZJUHRlbGEgSW5jMRgwFgYDVQQDDA92aXB0ZWxhLnRlc3RiZWQxIjAg\nBgkqhkiG9w0BCQEWE3NhbnRvc2hAdmlwdGVsYS5jb20wggEiMA0GCSqGSIb3DQEB\nAQUAA4IBDwAwggEKAoIBAQC9u5nkBY7uaDSXcHLw3OE1wLEoZy/p/REGjqY+Shro\ndaSu4cVSbD//J8H4ehYNNPdtMAuUrfQO8l2tRDBrSvrycEgG7pGIommHsqQRFcgP\nDe2fCl25sBPPi+96k6neYU96IkwWrOwAuhiP4loUZze0gbT1ALZ+GcadFYvxJgl0\nTnFZxmxP7shCFqRKC1vd2/aOqGv2Chnjo2nQkf989HyMdzZb/+M1VX4+vRQOO2L+\nPkwQX9FjueVTqAG8NvzNC2MRAmtLFe9YgQlpFWNdidY3dhRp/SM09ibaewzUtzMX\nNa91eT+VAq9QbQHoJIV70DhJKQlV8zSnkpeHusXKsl93AgMBAAEwDQYJKoZIhvcN\nAQELBQADggEBAHxeTz6Qmkp5aItBG2plV7Sur67NERNLuDYPppxknIsEtMdbyrIZ\nf6drn5lF2LEfCVZpsNu09pLo5pyks9/s4kFwnq5SjCoijFB6hn50S9J1nPW3frTx\nICfWfT+3mBG2Q9hT3s8ydNlO8jfLGUci1mX9600kDER7UqWa+WI+qtqd8imxqT9t\n9DZztYlhjd9NEpH5gwpD0VK34d4InjkANRL/SvGok+wCiOgfURAwViuCpELSvUQ5\n4fvuRpnL4fWIdF96rOBCB8/l/isPLJUceedWxHumOE5Cxkjk69Bq9/Xe6c67PoVC\no2XNyECYKxYrcBHaFxWEIs03G0fNpdmQlE0=\n-----END CERTIFICATE-----", "state": "vBond Updated", "globalState": "normal", "valid": "valid", "requestTokenID": "ae9939ba-d0df-424a-a847-add34d9eb786", "expirationDate": "May 19 17:08:51 2034 GMT", "expirationDateLong": 2031671331000, "deviceIP": "5.5.5.5", "activity": [ "vBond Updated" ], "state_vedgeList": "Sync", "certInstallStatus": "Installed", "org": "vmng_scale_ind", "personality": "vsmart", "expirationStatus": "normal", "timeRemainingForExpiration": 314269583088, "region-id": [], "solution": "sdwan", "site-id": "105", "host-name": "rk-cluster_vsmart-2", "system-ip": "5.5.5.5", "vbond": "vbond", "vmanageConnectionState": "connected", "policy-template-name": "", "policy-template-version": "", "local-system-ip": "5.5.5.5", "availableVersions": [], "defaultVersion": "20.13.0-18", "reachability": "reachable", "version": "20.13.0-18", "uptime-date": 1716453300000, "model_sku": "None", "lastupdated": 1717455074763, "vmanage-system-ip": "5.5.5.5", "domain-id": "1", "sp-organization-name": "vmng_scale_ind", "organization-name": "vmng_scale_ind", "lifeCycleRequired": false, "hardwareCertSerialNumber": "NA", "subjectSerialNumber": "NA", "resourceGroup": "global", "id": "NA", "tags": [], "draftMode": "Disabled", "site-name": "SITE_105", "device-lock": "No", "managed-by": "Unmanaged" }, { "configuredSiteId": "106", "configuredSystemIP": "6.6.6.6", "deviceType": "vsmart", "serialNumber": "1F07DA35DB67BC0B", "ncsDeviceName": "vsmart-cfaa98ea-1fc2-46a7-88c6-9a49a3039a9b", "configStatusMessage": "In Sync", "templateApplyLog": [ "[23-May-2024 13:54:50 UTC] Sync-from successful" ], "uuid": "cfaa98ea-1fc2-46a7-88c6-9a49a3039a9b", "managementSystemIP": "0.0.0.0", "templateStatus": "Success", "chasisNumber": "cfaa98ea-1fc2-46a7-88c6-9a49a3039a9b", "configStatusMessageDetails": "", "configOperationMode": "cli", "deviceModel": "vsmart", "deviceState": "READY", "validity": "valid", "platformFamily": "vsmart", "hardwareVedge": false, "username": "--", "rootCertHash": "65ef79171aada3c7bd008fc889aaee56db5005c4", "CSR": "viptela.testbed", "CSRDetail": "-----BEGIN CERTIFICATE REQUEST-----\nMIIDIzCCAgsCAQAwgaIxCzAJBgNVBAYTAlVTMRMwEQYDVQQIDApDYWxpZm9ybmlh\nMREwDwYDVQQHDAhTYW4gSm9zZTEXMBUGA1UECwwOdm1uZ19zY2FsZV9pbmQxFDAS\nBgNVBAoMC3ZJUHRlbGEgSW5jMRgwFgYDVQQDDA92aXB0ZWxhLnRlc3RiZWQxIjAg\nBgkqhkiG9w0BCQEWE3NhbnRvc2hAdmlwdGVsYS5jb20wggEiMA0GCSqGSIb3DQEB\nAQUAA4IBDwAwggEKAoIBAQCY2/Q5f4jbPvClfBhMvtcbgoMxNmhuAL3bqIA+aySy\n4y5C5JxPFHIwJ3J/65LAvoTTZ3VMhTJwiRD9JF4koBw1UhKrDnScSAHlzMXd/CeE\n4ZWVsvhWwa1aCXSh26bvEFWxPphAr2leqBdY0fItZbjR8C3QvfIzWggVdegTi5JU\nc3mlhzdxLSvgzB5uxzkGDHgpud+SWLVaBEySwPQpOh+n+FC1tQUPy6mPLsGYlTZm\nOt1tQEz4h0cX3p5w4dMsk91WM8ElhTXje2WBuqvGQsK3OAZqf/EAQequqLsFBR/2\nrOJUMJqw921RRCXzmSFGQUbS2BCy5M8nCufff88XII7xAgMBAAGgOzA5BgkqhkiG\n9w0BCQ4xLDAqMAkGA1UdEwQCMAAwHQYDVR0OBBYEFKRynhODdnNBrp3bnWZZVGl4\nhIqtMA0GCSqGSIb3DQEBCwUAA4IBAQCDRZ+a2kBD7Yjaypq2JUxusY5Xdz43EoxL\nvWNd0l194vVf1zAnvCxFdztOut/951Vz/w4SympwsVtQU415IgM+25p9c6gBiBIZ\nyPdIEfJYYwJBp4v+PujhfnSfBc7P/LiqswQWXM+jEaPfiKSoHDWKLCLUOBeewHNy\nlyRii/i4iCj3o+Cy4w9YTB+f5AGz9klHteq0FzoPyYPLMzHSJaWD9ZMHE3w4/jCr\n4WZVJ13+TP4N94ucIBLbULtvDZ+KCy4P/Vm7hy68rNP7EPCOk+WHzA4xaI2IbycP\nGlA/zZN5ytqxX988QvIzVwGJbt1KD8+N8BEARSJdcx0lCR08juCs\n-----END CERTIFICATE REQUEST-----", "certificateDetail": "-----BEGIN CERTIFICATE-----\nMIIDpTCCAo0CCB8H2jXbZ7wLMA0GCSqGSIb3DQEBCwUAMIGGMQswCQYDVQQGEwJV\nUzETMBEGA1UECBMKQ2FsaWZvcm5pYTERMA8GA1UEBxMIU2FuIEpvc2UxFTATBgNV\nBAsTDHZJUHRlbGEgVGVzdDEUMBIGA1UEChMLdklQdGVsYSBJbmMxIjAgBgkqhkiG\n9w0BCQEWE3NhbnRvc2hAdmlwdGVsYS5jb20wHhcNMjMwNTIyMTcwODUyWhcNMzQw\nNTE5MTcwODUyWjCBojELMAkGA1UEBhMCVVMxEzARBgNVBAgMCkNhbGlmb3JuaWEx\nETAPBgNVBAcMCFNhbiBKb3NlMRcwFQYDVQQLDA52bW5nX3NjYWxlX2luZDEUMBIG\nA1UECgwLdklQdGVsYSBJbmMxGDAWBgNVBAMMD3ZpcHRlbGEudGVzdGJlZDEiMCAG\nCSqGSIb3DQEJARYTc2FudG9zaEB2aXB0ZWxhLmNvbTCCASIwDQYJKoZIhvcNAQEB\nBQADggEPADCCAQoCggEBAJjb9Dl/iNs+8KV8GEy+1xuCgzE2aG4AvduogD5rJLLj\nLkLknE8UcjAncn/rksC+hNNndUyFMnCJEP0kXiSgHDVSEqsOdJxIAeXMxd38J4Th\nlZWy+FbBrVoJdKHbpu8QVbE+mECvaV6oF1jR8i1luNHwLdC98jNaCBV16BOLklRz\neaWHN3EtK+DMHm7HOQYMeCm535JYtVoETJLA9Ck6H6f4ULW1BQ/LqY8uwZiVNmY6\n3W1ATPiHRxfennDh0yyT3VYzwSWFNeN7ZYG6q8ZCwrc4Bmp/8QBB6q6ouwUFH/as\n4lQwmrD3bVFEJfOZIUZBRtLYELLkzycK599/zxcgjvECAwEAATANBgkqhkiG9w0B\nAQsFAAOCAQEApkUXPGuAmqggIsyB15Hp2DYIsTpuDMOPfiQTGeLWSpkph5jKeO9u\n+AXexhj/p8Lwptp+1wjGTdSZQW+KZswpfkSntun9kYIb6PFAmriv3YG8n8qBeRdP\n6SeXwFRSLPBCE5QtmC7b4gTnjXC8slJlrXgtp0EfuQOmWQy2K+jDY0CnLRccD7U1\nduDd/ykJ/pKioRoDLuPqK2KT0m1YXYFrNvGdRCO9imyKxz8WyQddh10cfbpwgJ9w\nFDh32xPyuChAHZ3S9AiofBX7X2geIyCjx9kqB2oBHjNDYoR8aLCfUIuK76BnOC0L\nQYEe5vVc/jGLV1EOffqatfNHG04Qb7zlfA==\n-----END CERTIFICATE-----", "state": "vBond Updated", "globalState": "normal", "valid": "valid", "requestTokenID": "dcd1a76b-26b0-4c4c-938b-1a4a4d0e8eb2", "expirationDate": "May 19 17:08:52 2034 GMT", "expirationDateLong": 2031671332000, "deviceIP": "6.6.6.6", "activity": [ "vBond Updated" ], "state_vedgeList": "Sync", "certInstallStatus": "Installed", "org": "vmng_scale_ind", "personality": "vsmart", "expirationStatus": "normal", "timeRemainingForExpiration": 314269584088, "region-id": [], "solution": "sdwan", "site-id": "106", "host-name": "rk-cluster_vsmart-3", "system-ip": "6.6.6.6", "vbond": "vbond", "vmanageConnectionState": "connected", "policy-template-name": "", "policy-template-version": "", "local-system-ip": "6.6.6.6", "availableVersions": [], "defaultVersion": "20.13.0-18", "reachability": "reachable", "version": "20.13.0-18", "uptime-date": 1716453600000, "model_sku": "None", "lastupdated": 1717483861689, "vmanage-system-ip": "6.6.6.6", "domain-id": "1", "sp-organization-name": "vmng_scale_ind", "organization-name": "vmng_scale_ind", "lifeCycleRequired": false, "hardwareCertSerialNumber": "NA", "subjectSerialNumber": "NA", "resourceGroup": "global", "id": "NA", "tags": [], "draftMode": "Disabled", "site-name": "SITE_106", "device-lock": "No", "managed-by": "Unmanaged" } ] }, "$$ref": "#/components/examples/ComViptelaVmanageServerCertificateapiResponseExampleGetvsmartlistresponse" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/certificate/{uuid}": { "delete": { "tags": [ "Certificate Management - Device" ], "summary": "invalid device", "description": "invalid device", "operationId": "deleteConfiguration", "parameters": [ { "name": "uuid", "in": "path", "description": "Device UUID", "required": true, "schema": { "type": "string" }, "examples": { "uuid": { "description": "uuid", "value": "18559db6-0883-4268-bda7-27d2c872537a" } } }, { "name": "replaceController", "in": "query", "description": "Boolean value to indicate replacing controller", "schema": { "type": "boolean" }, "examples": { "replace controller true": { "description": "replace controller true", "value": true }, "replace controller false": { "description": "replace controller false", "value": false } } }, { "name": "deviceId", "in": "query", "description": "vSmart Device ID when replace controller is true", "required": true, "schema": { "type": "string" }, "examples": { "vSmart device ID": { "description": "vSmart device ID", "value": "18559db6-0883-4268-bda7-27d2c872537a" } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "Delete UUID Response": { "description": "Delete UUID Response", "value": { "id": "48b9439f-a849-4fd5-9373-2b5f838d9b71" }, "$$ref": "#/components/examples/ComViptelaVmanageServerCertificateapiResponseExampleDeleteuuidresponse" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/client/server": { "get": { "tags": [ "Client - UI" ], "summary": "Get vManage server information", "description": "Get vManage server information", "operationId": "createServerInfo_ClientUi_1403", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "CSRFToken": { "type": "string", "example": "1BCE77AF0B88D97E3B922CE81315D61982FA5D5EC37874116320B4FDE43D9E8BA561E2907718618A1E75BF0E29B247101E11" }, "VsessionId": { "type": "string", "example": "ZGVmYXVsdA==" }, "capabilities": { "type": "array", "items": { "type": "string" } }, "cloudx": { "type": "string", "example": "off" }, "description": { "type": "string" }, "disableFullConfigPush": { "type": "boolean", "example": false }, "enableServerEvents": { "type": "boolean", "example": true }, "externalUser": { "type": "boolean", "example": false }, "generalTemplate": { "type": "boolean", "example": true }, "isRbacVpnUser": { "type": "boolean", "example": false }, "isSamlUser": { "type": "boolean", "example": false }, "isUiAllowed": { "type": "boolean", "example": false }, "locale": { "type": "string", "example": "en_US" }, "platformVersion": { "type": "string", "example": "20.13.999-2952" }, "reverseproxy": { "type": "string", "example": "off" }, "roles": { "type": "array", "items": { "type": "string" } }, "server": { "type": "string", "example": "vm12" }, "tenancyMode": { "type": "string", "example": "SingleTenant" }, "tenantId": { "type": "string", "example": "default" }, "user": { "type": "string", "example": "admin" }, "userMode": { "type": "string", "example": "tenant" }, "viewMode": { "type": "string", "example": "tenant" }, "vmanageMode": { "type": "string", "example": "default" }, "vpns": { "type": "array", "items": { "type": "string" } } }, "$$ref": "#/components/schemas/ClientServerResponseData" }, "header": { "type": "object", "properties": { "generatedOn": { "type": "integer", "format": "int32", "example": 1689221609561 } }, "$$ref": "#/components/schemas/ClientServerResponseHeader" } }, "$$ref": "#/components/schemas/ClientServerInfoResponse" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/client/token": { "get": { "tags": [ "Client - Security" ], "summary": "Get CSRF token", "description": "Get CSRF token", "operationId": "getCsrfToken", "parameters": [ { "name": "json", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string", "example": "1BCE77AF0B88D97E3B922CE81315D61982FA5D5EC37874116320B4FDE43D9E8BA561E2907718618A1E75BF0E29B247101E11" } }, "$$ref": "#/components/schemas/ClientTokenResponse" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/cloudservices/app/webex": { "put": { "tags": [ "Configuration - CloudExpress" ], "description": "Day N- Update Webex App", "operationId": "enableWebex_ConfigurationCloudexpress_2403", "requestBody": { "description": "Cloudx apps and vpns", "content": { "application/json": { "schema": { "type": "object" } } }, "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" }, "delete": { "tags": [ "Configuration - CloudExpress" ], "description": "deleteWebexPrefixLists", "operationId": "deleteWebexPrefixLists", "requestBody": { "description": "TMP-Cloudx apps and vpns", "content": { "application/json": { "schema": { "type": "object" } } } }, "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" }, "post": { "tags": [ "Configuration - CloudExpress" ], "description": "Add Webex App", "operationId": "enableWebex_ConfigurationCloudexpress_2404", "requestBody": { "description": "Cloudx apps and vpns", "content": { "application/json": { "schema": { "type": "object" } } }, "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" } }, "/clusterManagement/clusterLocked": { "get": { "tags": [ "Cluster Management" ], "description": "Check whether cluster is locked


Note: In a multitenant vManage system, this API is only available in the Provider view.", "operationId": "checkIfClusterLocked", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Cluster lock": { "description": "Cluster lock", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/clusterManagement/clusterworkflow/version": { "get": { "tags": [ "Cluster Management" ], "description": "List vManages in the cluster


Note: In a multitenant vManage system, this API is only available in the Provider view.", "operationId": "getClusterWorkflowVersion", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "clusterV2Enabled": { "description": "clusterV2Enabled", "value": "True" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/clusterManagement/configure": { "post": { "tags": [ "Cluster Management" ], "description": "Configure vManage


Note: In a multitenant vManage system, this API is only available in the Provider view.", "operationId": "configureVmanage", "requestBody": { "description": "vManage server config", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "vManage server config": { "description": "vManage server config", "value": {} } } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/clusterManagement/connectedDevices/{vmanageIP}": { "get": { "tags": [ "Cluster Management" ], "description": "Get connected device for vManage


Note: In a multitenant vManage system, this API is only available in the Provider view.", "operationId": "getConnectedDevices", "parameters": [ { "name": "vmanageIP", "in": "path", "description": "vManage IP", "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" } } } }, "/clusterManagement/health/details": { "get": { "tags": [ "Cluster Management" ], "description": "Get cluster health check details


Note: In a multitenant vManage system, this API is only available in the Provider view.", "operationId": "healthDetails", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Cluster health check detail": { "description": "Cluster health check detail", "value": {} } } } } }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/clusterManagement/health/status": { "get": { "tags": [ "Cluster Management" ], "description": "Get cluster health check details


Note: In a multitenant vManage system, this API is only available in the Provider view.", "operationId": "healthStatusInfo", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Cluster health status info": { "description": "Cluster health status info", "value": {} } } } } }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/clusterManagement/health/summary": { "get": { "tags": [ "Cluster Management" ], "description": "Get cluster health check summary


Note: In a multitenant vManage system, this API is only available in the Provider view.", "operationId": "healthSummary", "parameters": [ { "name": "isCached", "in": "query", "description": "Flag to enable cached result", "schema": { "type": "boolean", "default": false } }, { "name": "site-id", "in": "query", "description": "Optional site ID to filter devices", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Cluster health check summary": { "description": "Cluster health check summary", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/clusterManagement/host/health/status": { "get": { "tags": [ "Cluster Management" ], "description": "Get vManage cluster health check details


Note: In a multitenant vManage system, this API is only available in the Provider view.", "operationId": "hostHealthStatus", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "vManage cluster health status info": { "description": "vManage cluster health status info", "value": {} } } } } }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/clusterManagement/iplist/{vmanageID}": { "get": { "tags": [ "Cluster Management" ], "description": "Get configured IP addresses


Note: In a multitenant vManage system, this API is only available in the Provider view.", "operationId": "getConfiguredIPList", "parameters": [ { "name": "vmanageID", "in": "path", "description": "vManage Id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "vManage IP list": { "description": "vManage IP list", "value": [] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/clusterManagement/isready": { "get": { "tags": [ "Cluster Management" ], "description": "Is cluster ready


Note: In a multitenant vManage system, this API is only available in the Provider view.", "operationId": "isClusterReady", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Cluster state": { "description": "Cluster state", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true } }, "/clusterManagement/list": { "get": { "tags": [ "Cluster Management" ], "description": "List vManages in the cluster


Note: In a multitenant vManage system, this API is only available in the Provider view.", "operationId": "listVmanages", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "vManage server": { "description": "vManage server", "value": [] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/clusterManagement/nodeProperties": { "get": { "tags": [ "Cluster Management" ], "description": "Get properties of vManage being added to cluster


Note: In a multitenant vManage system, this API is only available in the Provider view.", "operationId": "nodeProperties", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "vManage cluster properties": { "description": "vManage cluster properties", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/clusterManagement/remove": { "post": { "tags": [ "Cluster Management" ], "description": "Remove vManage from cluster


Note: In a multitenant vManage system, this API is only available in the Provider view.", "operationId": "removeVmanage", "requestBody": { "description": "vManage server info", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "vManage server info": { "description": "vManage server info", "value": {} } } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/clusterManagement/replicateAndRebalance": { "put": { "tags": [ "Cluster Management" ], "description": "Initiate replication and rebalance of kafka topics


Note: In a multitenant vManage system, this API is only available in the Provider view.", "operationId": "performReplicationAndRebalanceOfKafkaPartitions", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Kafka topics rebalance status": { "description": "Kafka topics rebalance status", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/clusterManagement/setup": { "put": { "tags": [ "Cluster Management" ], "description": "Update vManage cluster info


Note: In a multitenant vManage system, this API is only available in the Provider view.", "operationId": "editVmanage", "requestBody": { "description": "vManage cluster config", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "vManage cluster config": { "description": "vManage cluster config", "value": "{\n \"vmanageID\":\"0\",\n \"deviceIP\u201d:\u201d10.0.1.38\u201d,\n \"username\":\"admin\",\n \"password\u201d:\u201dpassword\u201d,\n \"persona\":\"COMPUTE_AND_DATA\",\n \"services\":{\n \"container-manager\":{\n \"server\":false\n }\n }\n}" } } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Cluster Management" ], "description": "Add vManage to cluster", "operationId": "addVmanage", "requestBody": { "description": "vManage cluster config", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "vManage cluster config": { "description": "vManage cluster config", "value": { "deviceIP": "10.0.1.200", "username": "admin", "password": "password", "genCSR": false, "persona": "COMPUTE_AND_DATA", "services": { "container-manager": { "server": false } } } } } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/clusterManagement/tenancy/mode": { "get": { "tags": [ "Cluster Management" ], "description": "Get vManage tenancy mode


Note: In a multitenant vManage system, this API is only available in the Provider view.", "operationId": "getTenancyMode", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "vManage tenancy mode": { "description": "vManage tenancy mode", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Cluster Management" ], "description": "Update vManage tenancy mode", "operationId": "setTenancyMode", "requestBody": { "description": "Tenancy mode setting", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Tenancy mode": { "description": "Tenancy mode", "value": {} } } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/clusterManagement/tenantList": { "get": { "tags": [ "Cluster Management" ], "description": "Get tenant list


Note: In a multitenant vManage system, this API is only available in the Provider view.", "operationId": "getTenantsList", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "Tenant": { "description": "Tenant", "value": [] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/clusterManagement/userCreds": { "post": { "tags": [ "Cluster Management" ], "description": "Add or update user credentials for cluster operations


Note: In a multitenant vManage system, this API is only available in the Provider view.", "operationId": "addOrUpdateUserCredentials", "requestBody": { "description": "User credential", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "User credential": { "description": "User credential", "value": {} } } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/clusterManagement/vManage/details/{vmanageIP}": { "get": { "tags": [ "Cluster Management" ], "description": "Get vManage detail


Note: In a multitenant vManage system, this API is only available in the Provider view.", "operationId": "getVManageDetails", "parameters": [ { "name": "vmanageIP", "in": "path", "description": "vManage IP", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "vManage detail": { "description": "vManage detail", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/clusterManagement/{tenantId}/connectedDevices/{vmanageIP}": { "get": { "tags": [ "Cluster Management" ], "description": "Get connected device for vManage for a tenant


Note: In a multitenant vManage system, this API is only available in the Provider view.", "operationId": "getConnectedDevicesPerTenant", "parameters": [ { "name": "tenantId", "in": "path", "description": "Tenant Id", "required": true, "schema": { "type": "string" } }, { "name": "vmanageIP", "in": "path", "description": "vManage IP", "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" } } } }, "/colocation/monitor/device/vnf": { "get": { "tags": [ "Colocation" ], "description": "List all VNF attached with Device", "operationId": "getvnfByDeviceId", "parameters": [ { "name": "deviceId", "in": "query", "required": true, "schema": { "type": "object", "properties": { "deviceUuid": { "type": "string", "example": "C8K-f9f4a977-be6c-47f7-b3b2-10e916bb24db" } }, "description": "This is valid DeviceUuid", "$$ref": "#/components/schemas/DeviceUuid" } } ], "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true } }, "/colocation/monitor/vnf/action": { "post": { "tags": [ "Colocation" ], "description": "To do VNF actions such as start, stop and restart", "operationId": "vnfActions", "parameters": [ { "name": "vmName", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "action", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "deviceId", "in": "query", "schema": { "type": "object", "properties": { "deviceUuid": { "type": "string", "example": "C8K-f9f4a977-be6c-47f7-b3b2-10e916bb24db" } }, "description": "This is valid DeviceUuid", "$$ref": "#/components/schemas/DeviceUuid" } } ], "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true } }, "/colocation/monitor/vnf/alarms": { "get": { "tags": [ "Colocation" ], "description": "Get event detail of VNF", "operationId": "getVNFEventsCountDetail", "parameters": [ { "name": "user_group", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true } }, "/colocation/monitor/vnf/alarms/count": { "get": { "tags": [ "Colocation" ], "description": "Get alarm count of VNF", "operationId": "getVNFAlarmCount", "parameters": [ { "name": "user_group", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true } }, "/colocation/monitor/vnf/events": { "get": { "tags": [ "Colocation" ], "description": "Get event detail of VNF", "operationId": "getVNFEventsDetail", "parameters": [ { "name": "vnfName", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true } }, "/colocation/monitor/vnf/interface": { "get": { "tags": [ "Colocation" ], "description": "Get interface detail of VNF", "operationId": "getVNFInterfaceDetail", "parameters": [ { "name": "vnfName", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "deviceIp", "in": "query", "schema": { "type": "object", "properties": { "deviceIp": { "type": "string" } }, "description": "This is the valid DeviceIP", "$$ref": "#/components/schemas/DeviceIP" } }, { "name": "deviceClass", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true } }, "/device/action/cancel": { "post": { "tags": [ "Configuration - Device Actions" ], "description": "Cancel tasks", "operationId": "processCancelTask", "requestBody": { "description": "Request body", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Example Value": { "description": "Example Value", "value": { "action": "cancel", "devices": [ { "processId": "software_install-xyz", "deviceIP": "172.16.255.21", "deviceId": "13cf949c-9192-4c5d-8096-12c41fbd366d" } ], "deviceType": "vedge" }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceactionDeviceactionapiRequestExampleCancel" } } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/device/action/changepartition": { "get": { "tags": [ "Configuration - Device Actions" ], "description": "Get change partition information", "operationId": "generateChangePartitionInfo", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "array", "items": { "type": "object", "properties": { "deviceIp": { "type": "string" } }, "description": "This is the valid DeviceIP", "$$ref": "#/components/schemas/DeviceIP" } }, "example": [ "172.16.255.15" ] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Example": { "description": "Example", "value": { "data": [ { "availableVersions": [ "string" ], "host-name": "vm1", "system-ip": "172.16.255.11", "personality": "vedge", "site-id": "100", "uuid": "0fd462aa-f885-44e4-8b7e-843b5aa4040b", "device-type": "vedge", "version": "20.10.999-1966", "uptime-date": "1652858640000", "device-model": "vedge-cloud", "platform": "x86_64", "reachability": "reachable" } ] }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceactionDeviceactionapiResponseExampleGetchangepartitionresp" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Configuration - Device Actions" ], "description": "Process change partition operation", "operationId": "processChangePartition", "requestBody": { "description": "Request body for Process change partition operation", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Example Value": { "description": "Example Value", "value": { "action": "changepartition", "devices": [ { "version": "20.3.0", "deviceIP": "172.16.51.1", "deviceId": "52fe5cd3-ec3d-4141-92e4-0c31d0e0347a" } ], "deviceType": "vedge" }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceactionDeviceactionapiRequestExamplePostchangepartitionreq" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Example Value": { "description": "Example Value", "value": { "id": "change_partition-99b8ebd5-c8cf-439b-8504-2f80b0b75b73" }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceactionDeviceactionapiResponseExamplePostchangepartitionresp" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/device/action/deactivate": { "get": { "tags": [ "Configuration - Device Actions" ], "description": "Get deactivate partition information", "operationId": "generateDeactivateInfo", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "array", "items": { "type": "object", "properties": { "deviceIp": { "type": "string" } }, "description": "This is the valid DeviceIP", "$$ref": "#/components/schemas/DeviceIP" } }, "example": [ "172.16.255.15" ] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "availableVersions": { "type": "array", "example": [], "items": { "type": "string", "example": [] } }, "device-model": { "type": "string", "example": "vedge-C8000V" }, "device-type": { "type": "string", "example": "vedge" }, "host-name": { "type": "string", "example": "vm5" }, "personality": { "type": "string", "example": "vedge" }, "platform": { "type": "string", "example": "x86_64" }, "reachability": { "type": "string", "example": "reachable" }, "site-id": { "type": "string", "example": "500" }, "system-ip": { "type": "string", "example": "172.16.255.15" }, "uptime-date": { "type": "string", "example": "1686317760000" }, "uuid": { "type": "string", "example": "C8K-a06af989-6a80-472d-ac0f-ed5560b5068b" }, "version": { "type": "string", "example": "17.13.01.0.180213" } }, "$$ref": "#/components/schemas/GenerateDeactivateInfoData" } } }, "$$ref": "#/components/schemas/GenerateDeactivateInfo" }, "examples": { "Get deactivate partition information example": { "description": "Get deactivate partition information example", "value": { "data": [ { "availableVersions": [], "host-name": "vm5", "system-ip": "172.16.255.15", "personality": "vedge", "site-id": "500", "uuid": "C8K-a06af989-6a80-472d-ac0f-ed5560b5068b", "device-type": "vedge", "version": "17.13.01.0.180213", "uptime-date": "1686317760000", "device-model": "vedge-C8000V", "platform": "x86_64", "reachability": "reachable" } ] }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceactionDeviceactionapiResponseExampleGetdeactivateresp" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Software Upgrade-read,Software Upgrade-write,Software Upgrade > Edge-write,Software Upgrade > Edge-read,Software Upgrade > Controller-write,Software Upgrade > Controller-read" }, "post": { "tags": [ "Configuration - Device Actions" ], "description": "Process deactivate operation for smu image", "operationId": "processDeactivateSmu", "requestBody": { "description": "Device smu image deactivate request", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Device deactivate request": { "description": "Device deactivate request", "value": { "action": "deactivate", "devices": [ { "version": "20.3.0", "deviceIP": "172.16.51.1", "deviceId": "52fe5cd3-ec3d-4141-92e4-0c31d0e0347a" }, { "version": "20.3.0", "deviceIP": "172.16.51.2", "deviceId": "4d4507df-29b4-4f68-9129-36cfa4528847" } ], "deviceType": "vedge" }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceactionDeviceactionapiRequestExamplePostdeactivatereq" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Task Id": { "description": "Task Id", "value": { "id": "deactivate-01232017T154359940" }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceactionDeviceactionapiResponseExamplePostdeactivateresp" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Software Upgrade-write,Software Upgrade > Edge-write,Software Upgrade > Controller-write" } }, "/device/action/defaultpartition": { "post": { "tags": [ "Configuration - Device Actions" ], "description": "Process marking default partition operation", "operationId": "processDefaultPartition", "requestBody": { "description": "Request body for Process marking default partition operation", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Example Value": { "description": "Example Value", "value": { "action": "defaultpartition", "devices": [ { "version": "99.99.999-2499", "deviceIP": "172.16.255.16", "deviceId": "13cf949c-9192-4c5d-8096-12c41fbd366d" } ], "deviceType": "vedge" }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceactionDeviceactionapiRequestExamplePostdefaultpartitionreq" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Example": { "description": "Example", "value": { "id": "default_partition-99b8ebd5-c8cf-439b-8504-2f80b0b75b73" }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceactionDeviceactionapiResponseExamplePostdefaultpartitionresp" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/device/action/filter/vpn": { "get": { "tags": [ "Configuration - Device Actions" ], "description": "Get filter VPN list", "operationId": "createFilterVPNList", "parameters": [ { "name": "site-id", "in": "query", "description": "site-id", "schema": { "type": "string" }, "example": 500 }, { "name": "deviceId", "in": "query", "description": "deviceId", "schema": { "type": "string" }, "example": "172.16.255.14" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "vedge": { "type": "array", "items": { "type": "string" } }, "vsmart": { "type": "array", "items": { "type": "string" } } }, "$$ref": "#/components/schemas/CreateFilterVPNList" }, "examples": { "Example": { "description": "Example", "value": { "vedge": [ "1", "65528", "65530", "65529" ], "vsmart": [] }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceactionDeviceactionapiResponseExampleFiltervpnresp" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Software Upgrade-read,RBAC VPN-read,Software Upgrade > Edge-read,Software Upgrade > Controller-read" } }, "/device/action/firmware": { "post": { "tags": [ "Configuration - Device Firmware Update" ], "description": "Upload firmware image package", "operationId": "processFirmwareImage", "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true, "x-roles-required": "admin,Software Upgrade-write,Software Upgrade > Controller-write,Software Upgrade > Edge-write" }, "get": { "tags": [ "Configuration - Device Firmware Update" ], "description": "Get list of firmware images in the repository", "operationId": "getFirmwareImages", "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true, "x-roles-required": "Software Upgrade-read,Software Upgrade > Edge-read,Software Upgrade > Controller-read" } }, "/device/action/firmware-upgrade": { "post": { "tags": [ "Configuration - Device Firmware Update" ], "description": "Eemote firmware on device", "operationId": "remoteFirmwareImageUpgrade", "requestBody": { "description": "Request body", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Example Value": { "description": "Example Value", "value": { "action": "firmwareupgrade", "actionName": "firmware_upgrade", "actionStart": "Tue Apr 02 2024 09:10:13 UTC", "actionStartMillis": 1712029213, "actionEnd": "Tue Apr 02 2024 12:10:13 UTC", "actionEndMillis": 1712040013, "timeZone": "UTC", "input": { "data": [ { "family": "Teleworker", "version": "875d4845-df12-4fdf-91f6-b73c601b2c3f", "remoteServerId": "192448a2-36bd-4f50-af04-03b428cd5a8f" } ], "versionType": "remote" }, "devices": [ { "deviceIP": "172.16.255.15", "deviceId": "C8K-5c2ed42c-b47e-4155-8000-11c2ddd1f63d" } ], "deviceType": "vedge", "firmwareType": "cellular" }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceactionSoftwarepackageFirmwareFirmwareupgradeapiRequestExamplePostfirmwareupgradereq" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "action": { "type": "string", "example": "firmwareupgrade" }, "actionEnd": { "type": "string", "example": "Wed Jan 12 03:00:00 IST 2023" }, "actionEndMillis": { "type": "integer", "format": "int32", "example": 1641936600000 }, "actionName": { "type": "string", "example": "firmware_upgrade" }, "actionStart": { "type": "string", "example": "Tue Jan 11 23:00:00 IST 2023" }, "actionStartMillis": { "type": "integer", "format": "int32", "example": 1641922200000 }, "deviceType": { "type": "string", "example": "vedge" }, "devices": { "type": "array", "items": { "type": "object", "properties": { "deviceIP": { "type": "string", "example": "40.1.1.1" }, "deviceId": { "type": "string", "example": "CG113-4GW6B-KWC254402PM" } }, "$$ref": "#/components/schemas/FirmwareImageRemoteUpgradeDevices" } }, "firmwareType": { "type": "string", "description": "Type of firmware. Supported values: cellular, cellular_lte_450, wifi", "example": "cellular" }, "input": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "family": { "type": "string", "example": "Teleworker" }, "remoteServerId": { "type": "string", "example": "192448a2-36bd-4f50-af04-03b428cd5a8f" }, "version": { "type": "string", "example": "875d4845-df12-4fdf-91f6-b73c601b2c3f" } }, "$$ref": "#/components/schemas/FirmwareImageRemoteUpgradeInputData" } }, "versionType": { "type": "string", "example": "remote" } }, "$$ref": "#/components/schemas/FirmwareImageRemoteUpgradeInput" }, "timeZone": { "type": "string", "example": "Asia/Kolkata" } }, "$$ref": "#/components/schemas/FirmwareImageRemoteUpgrade" }, "examples": { "Example": { "description": "Example", "value": { "id": "firmware_upgrade-e841dbae-13c2-49b9-9d0f-d5415eaed7f7" }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceactionSoftwarepackageFirmwareFirmwareupgradeapiResponseExamplePostfirmwareupgraderesp" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/device/action/firmware-upgrade/devices": { "get": { "tags": [ "Configuration - Device Firmware Update" ], "description": "firmware supported devices", "operationId": "getFirmwareDevices", "parameters": [ { "name": "firmwareType", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "description": { "type": "string", "example": "Firmware Image Path" }, "filePath": { "type": "string", "example": "/home/admin/" }, "remoteServerId": { "type": "string", "example": "f7ae1f4b-9900-424f-92ca-22d2231f55dc" }, "versionId": { "type": "string", "example": "9917f2ad-c152-406b-87cc-a3b251d0e1a8" } }, "$$ref": "#/components/schemas/ProcessGetFirmwareRemoteImageReq" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/device/action/firmware-upgrade/remote": { "get": { "tags": [ "Configuration - Device Firmware Update" ], "description": "firmware remote image package", "operationId": "getFirmwareRemoteImage", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "description": { "type": "string", "example": "Firmware Image Path" }, "filePath": { "type": "string", "example": "/home/admin/" }, "remoteServerId": { "type": "string", "example": "f7ae1f4b-9900-424f-92ca-22d2231f55dc" }, "versionId": { "type": "string", "example": "9917f2ad-c152-406b-87cc-a3b251d0e1a8" } }, "$$ref": "#/components/schemas/ProcessGetFirmwareRemoteImageReq" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Configuration - Device Firmware Update" ], "description": "firmware remote image package", "operationId": "processFirmwareRemoteImage", "requestBody": { "description": "Request body", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Example Value": { "description": "Example Value", "value": { "data": [ { "remoteServers": [ "9d72ca05-f2dc-4816-b612-bff3ce1b81f6" ], "filePath": "/home/admin/testdummynew" } ] }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceactionSoftwarepackageFirmwareFirmwareupgradeapiRequestExamplePostfirmwareupgraderemotereq" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "filePath": { "type": "string", "example": "/home/admin/" }, "remoteServerId": { "type": "string", "example": "f7ae1f4b-9900-424f-92ca-22d2231f55dc" } }, "$$ref": "#/components/schemas/ProcessFirmwareRemoteImageReq" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/device/action/firmware-upgrade/remote/{versionId}": { "put": { "tags": [ "Configuration - Device Software Update" ], "description": "Download software package file", "operationId": "editFirmwareUpgardeRemoteImage", "parameters": [ { "name": "versionId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "e683117a-b38f-4980-a411-6c9c6293a9fc" } ], "requestBody": { "description": "Request body", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Example Value": { "description": "Example Value", "value": { "remoteServers": [ "eef0003f-560c-4165-92f3-9590553ce68a" ], "filePath": "/firmwareTest123" }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceactionSoftwarepackageFirmwareFirmwareupgradeapiRequestExamplePutfirmwareupgraderemotereq" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/octet-stream": { "schema": { "type": "object", "properties": { "description": { "type": "string", "example": "Firmware Image Path" }, "filePath": { "type": "string", "example": "/home/admin/" }, "remoteServerId": { "type": "string", "example": "f7ae1f4b-9900-424f-92ca-22d2231f55dc" }, "versionId": { "type": "string", "example": "9917f2ad-c152-406b-87cc-a3b251d0e1a8" } }, "$$ref": "#/components/schemas/ProcessGetFirmwareRemoteImageReq" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/device/action/firmware-upgrade/{versionId}": { "delete": { "tags": [ "Configuration - Device Software Update" ], "description": "Download software package file", "operationId": "deleteFirmwareUpgardeRemoteImage", "parameters": [ { "name": "versionId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "e683117a-b38f-4980-a411-6c9c6293a9fc" } ], "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/device/action/firmware/activate": { "post": { "tags": [ "Configuration - Device Firmware Update" ], "description": "Activate firmware on device", "operationId": "activateFirmwareImage", "requestBody": { "content": { "application/json": { "schema": { "type": "string" } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true, "x-roles-required": "admin,Software Upgrade-write,Software Upgrade > Controller-write,Software Upgrade > Edge-write" } }, "/device/action/firmware/devices": { "get": { "tags": [ "Configuration - Device Firmware Update" ], "description": "Get list of devices that support firmware upgrade", "operationId": "getDevicesFWUpgrade", "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true, "x-roles-required": "Software Upgrade-read,Software Upgrade > Edge-read,Software Upgrade > Controller-read" } }, "/device/action/firmware/install": { "post": { "tags": [ "Configuration - Device Firmware Update" ], "description": "Install firmware on device", "operationId": "installFirmwareImage", "requestBody": { "content": { "application/json": { "schema": { "type": "string" } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true, "x-roles-required": "admin,Software Upgrade-write,Software Upgrade > Controller-write,Software Upgrade > Edge-write" } }, "/device/action/firmware/remove": { "post": { "tags": [ "Configuration - Device Firmware Update" ], "description": "Remove firmware on device", "operationId": "removeFirmwareImage", "requestBody": { "content": { "application/json": { "schema": { "type": "string" } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true, "x-roles-required": "admin,Software Upgrade-write,Software Upgrade > Controller-write,Software Upgrade > Edge-write" } }, "/device/action/firmware/{versionId}": { "get": { "tags": [ "Configuration - Device Firmware Update" ], "description": "Get firmware image details for a given version", "operationId": "getFirmwareImageDetails", "parameters": [ { "name": "versionId", "in": "path", "description": "Firmware image version", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true, "x-roles-required": "Software Upgrade-read,Software Upgrade > Edge-read,Software Upgrade > Controller-read" }, "delete": { "tags": [ "Configuration - Device Firmware Update" ], "description": "Delete firmware image package", "operationId": "deleteFirmwareImage", "parameters": [ { "name": "versionId", "in": "path", "description": "Firmware image version", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true, "x-roles-required": "admin,Software Upgrade-write,Software Upgrade > Controller-write,Software Upgrade > Edge-write" } }, "/device/action/image-download": { "post": { "tags": [ "Configuration - Device Actions" ], "description": "Intitate image download on the given device.", "operationId": "initiateImageDownload", "requestBody": { "description": "Request body to Intitate image download on the given device", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Example Value": { "description": "Example Value", "value": { "action": "image-download", "actionName": "Test", "actionStart": "Tue Jan 11 23:00:00 IST 2022", "actionStartMillis": 1641922200000, "actionEnd": "Wed Jan 12 03:00:00 IST 2022", "actionEndMillis": 1641936600000, "timeZone": "Asia/Kolkata", "actionTimeoutMins": 30, "input": { "data": [ { "family": "c800v", "version": "875d4845-df12-4fdf-91f6-b73c601b2c3f", "remoteServerId": "192448a2-36bd-4f50-af04-03b428cd5a8f" } ], "versionType": "remote" }, "devices": [ { "deviceIP": "40.1.1.1", "deviceId": "C8K-60c01ff3-1405-428f-93e9-f1606d22968e" } ], "deviceType": "vedge" }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceactionDeviceactionapiRequestExampleImagedownload" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Example": { "description": "Example", "value": { "task_id": "default_partition-01112017T159951140" }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceactionDeviceactionapiResponseExampleImagedownloadresp" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/device/action/image-remove": { "post": { "tags": [ "Configuration - Device Actions" ], "description": "Process remove software image operation", "operationId": "processRemoveSoftwareImage", "requestBody": { "description": "Request body - Process remove software image operation", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Example Value": { "description": "Example Value", "value": { "action": "image-remove", "devices": [ { "deviceIP": "172.16.255.21", "deviceId": "2b24a7be-077c-48f7-873f-47573986d148", "images": [ "viptela-20.4.2-x86_64.tar.gz" ] } ], "deviceType": "vedge" }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceactionDeviceactionapiRequestExampleImageremove" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Example": { "description": "Example", "value": { "id": "image_remove-0a58029a-db1d-4d82-9400-3c867c8be533" }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceactionDeviceactionapiResponseExampleImageremoveresp" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/device/action/install": { "post": { "tags": [ "Configuration - Device Actions" ], "description": "Process an installation operation", "operationId": "processInstall", "requestBody": { "description": "Request body", "content": { "application/json": { "schema": { "required": [ "action" ], "type": "object", "properties": { "action": { "type": "string", "example": "install" }, "actionEnd": { "type": "string", "description": "Scheduled time for the action to end.", "example": "Wed Nov 06 2024 15:27:32" }, "actionEndMillis": { "type": "integer", "description": "Scheduled time in EPHOC millis for the action to end.", "format": "int32", "example": 1730887052000 }, "actionStart": { "type": "string", "description": "Scheduled time for the action to start.", "example": "Wed Nov 06 2024 11:27:32" }, "actionStartMillis": { "type": "integer", "description": "Scheduled time in EPHOC millis for the action to start.", "format": "int32", "example": 1730872652000 }, "deviceType": { "type": "string", "example": "vedge" }, "devices": { "type": "array", "items": { "required": [ "deviceIP", "deviceId" ], "type": "object", "properties": { "deviceIP": { "type": "string", "description": "Device IP address.", "example": "172.16.255.14" }, "deviceId": { "type": "string", "description": "Device ID.", "example": "2f876a33-9944-450a-91ee-f1f80eb68348" } }, "$$ref": "#/components/schemas/ProcessInstallReqDevices" } }, "input": { "required": [ "data", "vEdgeVPN", "vSmartVPN", "versionType" ], "type": "object", "properties": { "data": { "type": "array", "description": "Device action input data.", "items": { "required": [ "family", "version" ], "type": "object", "properties": { "family": { "type": "string", "description": "Platform family of the software image.", "example": "c800v" }, "version": { "type": "string", "description": "Version of the software image.", "example": "17.17.01.0.209664.1728238032" }, "versionId": { "type": "string", "description": "Version id of the software image.", "example": "824ac3d6-7d2a-4dfa-8a8b-e6e5bc64acb8" } }, "description": "Device action input data.", "$$ref": "#/components/schemas/ProcessInstallReqInputData" } }, "reboot": { "type": "boolean", "example": false }, "sync": { "type": "boolean", "example": true }, "vEdgeVPN": { "type": "integer", "description": "VPN id of the vEdge.", "format": "int32", "example": 0 }, "vSmartVPN": { "type": "integer", "description": "VPN id of the vSmart.", "format": "int32", "example": 0 }, "versionType": { "type": "string", "description": "Version type of the software image.", "example": "vmanage" } }, "$$ref": "#/components/schemas/ProcessInstallReqInput" }, "timeZone": { "type": "string", "description": "Scheduled time zone for the action.", "example": "UTC" } }, "$$ref": "#/components/schemas/ProcessInstallReq" }, "examples": { "Example Value": { "description": "Example Value", "value": { "action": "install", "input": { "vEdgeVPN": 0, "vSmartVPN": 0, "data": [ { "family": "c8000v", "version": "17.17.01.0.209664.1728238032", "versionId": "824ac3d6-7d2a-4dfa-8a8b-e6e5bc64acb8" } ], "versionType": "vmanage", "reboot": false, "sync": true }, "devices": [ { "deviceIP": "172.16.255.14", "deviceId": "2f876a33-9944-450a-91ee-f1f80eb68348" } ], "deviceType": "vedge" }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceactionDeviceactionapiRequestExampleInstall" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Task Id": { "description": "Task Id", "value": { "id": "software_install-01232017T154359940" }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceactionDeviceactionapiResponseExampleInstallresppost" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "Configuration - Device Actions" ], "description": "Generate install info", "operationId": "generateInstallInfo", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "array", "items": { "type": "object", "properties": { "deviceIp": { "type": "string" } }, "description": "This is the valid DeviceIP", "$$ref": "#/components/schemas/DeviceIP" } }, "example": [ "172.16.255.15" ] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Example": { "description": "Example", "value": { "data": [ { "device-model": "vedge-cloud", "device-os": "next", "local-system-ip": "172.16.255.11", "system-ip": "172.16.255.11", "site-id": "100", "downloadedImages": [ "string" ], "uuid": "0fd462aa-f885-44e4-8b7e-843b5aa4040b", "platform": "x86_64", "isScheduleUpgradeSupported": true, "personality": "vedge", "device-type": "vedge", "reachability": "reachable", "availableVersions": [ "string" ], "downloadedServices": [ "string" ], "availableServices": [ "string" ], "host-name": "vm1", "version": "20.10.999-1966", "uptime-date": 1652858640000, "isMultiStepUpgradeSupported": true, "defaultVersion": "20.10.999-1966" } ] }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceactionDeviceactionapiResponseExampleInstallrespget" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/device/action/install/devices/{deviceType}": { "get": { "tags": [ "Configuration - Device Actions" ], "description": "Get list of installed devices", "operationId": "generateDeviceList", "parameters": [ { "name": "deviceType", "in": "path", "description": "Device type", "required": true, "schema": { "type": "string" }, "example": "vmanage" }, { "name": "groupId", "in": "query", "description": "groupId", "schema": { "type": "string" }, "example": "all" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "example": { "device-model": "vmanage", "device-os": "next", "local-system-ip": "172.16.255.22", "system-ip": "172.16.255.22", "site-id": "200", "uuid": "b642c56f-c899-4ca4-a3d6-d915e0660f9a", "platform": "x86_64", "isScheduleUpgradeSupported": false, "personality": "vmanage", "device-type": "vmanage", "reachability": "reachable", "availableVersions": [], "host-name": "vm12", "version": "20.13.999-2846", "layoutLevel": 1, "uptime-date": 1683523320000, "isMultiStepUpgradeSupported": false, "defaultVersion": "20.13.999-2846", "platformFamily": "vmanage", "current-partition": "20.13.999-2846" }, "items": { "type": "object", "properties": { "availableVersions": { "type": "array", "items": { "type": "string" } }, "current-partition": { "type": "string" }, "defaultVersion": { "type": "string" }, "device-model": { "type": "string" }, "device-os": { "type": "string" }, "device-type": { "type": "string" }, "host-name": { "type": "string" }, "isMultiStepUpgradeSupported": { "type": "boolean" }, "isScheduleUpgradeSupported": { "type": "boolean" }, "layoutLevel": { "type": "integer", "format": "int32" }, "local-system-ip": { "type": "string" }, "personality": { "type": "string" }, "platform": { "type": "string" }, "platformFamily": { "type": "string" }, "reachability": { "type": "string" }, "site-id": { "type": "string" }, "system-ip": { "type": "string" }, "uptime-date": { "type": "integer", "format": "int32" }, "uuid": { "type": "string" }, "version": { "type": "string" } }, "example": { "device-model": "vmanage", "device-os": "next", "local-system-ip": "172.16.255.22", "system-ip": "172.16.255.22", "site-id": "200", "uuid": "b642c56f-c899-4ca4-a3d6-d915e0660f9a", "platform": "x86_64", "isScheduleUpgradeSupported": false, "personality": "vmanage", "device-type": "vmanage", "reachability": "reachable", "availableVersions": [], "host-name": "vm12", "version": "20.13.999-2846", "layoutLevel": 1, "uptime-date": 1683523320000, "isMultiStepUpgradeSupported": false, "defaultVersion": "20.13.999-2846", "platformFamily": "vmanage", "current-partition": "20.13.999-2846" }, "$$ref": "#/components/schemas/GenerateDeviceListData" } } }, "$$ref": "#/components/schemas/GenerateDeviceList" }, "examples": { "Example": { "description": "Example", "value": { "data": { "device-model": "vmanage", "device-os": "next", "local-system-ip": "172.16.255.22", "system-ip": "172.16.255.22", "site-id": "200", "uuid": "b642c56f-c899-4ca4-a3d6-d915e0660f9a", "platform": "x86_64", "isScheduleUpgradeSupported": false, "personality": "vmanage", "device-type": "vmanage", "reachability": "reachable", "availableVersions": [], "host-name": "vm12", "version": "20.13.999-2846", "layoutLevel": 1, "uptime-date": 1683523320000, "isMultiStepUpgradeSupported": false, "defaultVersion": "20.13.999-2846", "platformFamily": "vmanage", "current-partition": "20.13.999-2846" } }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceactionDeviceactionapiResponseExampleGetinstalldevicesresp" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Software Upgrade-read,Software Upgrade-write,Settings-read,vmanage-http-stream,Software Upgrade > Edge-write,Software Upgrade > Edge-read,Software Upgrade > Controller-write,Software Upgrade > Controller-read" } }, "/device/action/list": { "get": { "tags": [ "Configuration - Device Actions" ], "description": "Get device action list", "operationId": "generateDeviceActionList", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "properties": { "empty": { "type": "boolean" } }, "items": { "type": "object", "properties": { "isCancelEnabled": { "type": "boolean" }, "isParallelExecutionEnabled": { "type": "boolean" }, "name": { "type": "string" } }, "$$ref": "#/components/schemas/GenerateDeviceActionListInner" }, "$$ref": "#/components/schemas/GenerateDeviceActionList" }, "examples": { "Example": { "description": "Example", "value": [ { "name": "Migrate shared templates", "isCancelEnabled": false, "isParallelExecutionEnabled": false }, { "name": "Multicloud - Create Gateway", "isCancelEnabled": false, "isParallelExecutionEnabled": false }, { "name": "Scheduled Export Backup", "isCancelEnabled": false, "isParallelExecutionEnabled": false }, { "name": "Deploy topology group to vSmarts", "isCancelEnabled": false, "isParallelExecutionEnabled": false } ], "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceactionDeviceactionapiResponseExampleList" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Software Upgrade-read,Software Upgrade-write,Software Upgrade > Edge-write,Software Upgrade > Edge-read,Software Upgrade > Controller-write,Software Upgrade > Controller-read" } }, "/device/action/lxcactivate": { "post": { "tags": [ "Configuration - Device Actions" ], "description": "Process an activation operation", "operationId": "processLxcActivate", "requestBody": { "description": "Activation request payload", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Activation Operation": { "description": "Activation Operation", "value": { "action": "lxc_activate", "deviceType": "vedge", "devices": [ { "deviceIP": "172.16.255.15", "deviceId": "C8K-61b9f39d-a5ef-402f-a395-ae6d6d49dda6", "installImages": [ { "networkFunctionType": "app-hosting", "versionTypeName": "UTD-Snort-Feature", "versionName": "1.13.6_SV3.1.55.0_XEmain" } ], "vEdgeVPN": 0, "versionType": "vmanage" } ], "input": { "vEdgeVPN": 0, "versionType": "vmanage" } }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceactionDeviceactionapiRequestExampleLxcactivate" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Task Id": { "description": "Task Id", "value": { "id": "lxc_activate-e03208d5-2c4b-492b-a10a-961bcd826f21" }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceactionDeviceactionapiResponseExampleLxcactivate" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Software Upgrade-write,Software Upgrade > Edge-write,Software Upgrade > Controller-write" } }, "/device/action/lxcdelete": { "post": { "tags": [ "Configuration - Device Actions" ], "description": "Process a delete operation", "operationId": "processLxcDelete", "requestBody": { "description": "Delete request payload", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Delete Operation": { "description": "Delete Operation", "value": { "action": "lxc_delete", "deviceType": "vedge", "devices": [ { "deviceIP": "172.16.255.15", "deviceId": "C8K-61b9f39d-a5ef-402f-a395-ae6d6d49dda6", "installImages": [ { "networkFunctionType": "app-hosting", "versionTypeName": "UTD-Snort-Feature", "versionName": "1.13.6_SV3.1.55.0_XEmain" } ] } ] }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceactionDeviceactionapiRequestExampleLxcdelete" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Task Id": { "description": "Task Id", "value": { "id": "lxc_delete-cd3f7f8c-d7ef-47e6-9eee-c66d78a5dbde" }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceactionDeviceactionapiResponseExampleLxcdelete" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Software Upgrade-write,Software Upgrade > Edge-write,Software Upgrade > Controller-write" } }, "/device/action/lxcinstall": { "post": { "tags": [ "Configuration - Device Actions" ], "description": "Process an installation operation", "operationId": "processLxcInstall", "requestBody": { "description": "Installation request payload", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Installation Operation": { "description": "Installation Operation", "value": {} } } } }, "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": "Software Upgrade-write,Software Upgrade > Edge-write,Software Upgrade > Controller-write" } }, "/device/action/lxcreload": { "post": { "tags": [ "Configuration - Device Actions" ], "description": "Process a reload operation", "operationId": "processLxcReload", "requestBody": { "description": "Reload request payload", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Reload Operation": { "description": "Reload Operation", "value": {} } } } }, "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": "Software Upgrade-write,Software Upgrade > Edge-write,Software Upgrade > Controller-write" } }, "/device/action/lxcreset": { "post": { "tags": [ "Configuration - Device Actions" ], "description": "Process a reset operation", "operationId": "processLxcReset", "requestBody": { "description": "Reset request payload", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Reset Operation": { "description": "Reset Operation", "value": {} } } } }, "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": "Software Upgrade-write,Software Upgrade > Edge-write,Software Upgrade > Controller-write" } }, "/device/action/lxcupgrade": { "post": { "tags": [ "Configuration - Device Actions" ], "description": "Process an upgrade operation", "operationId": "processLxcUpgrade", "requestBody": { "description": "Upgrade request payload", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Upgrade Operation": { "description": "Upgrade Operation", "value": { "action": "lxc_upgrade", "deviceType": "vedge", "devices": [ { "deviceIP": "172.16.255.15", "deviceId": "C8K-61b9f39d-a5ef-402f-a395-ae6d6d49dda6", "installImages": [ { "remoteServerId": "b07865e0-29c4-4e46-b1ab-90e7a268eae", "networkFunctionType": "app-hosting", "versionTypeName": "UTD-Snort-Feature", "versionName": "1.13.6_SV3.1.55.0_XEmain" } ] } ], "input": { "vEdgeVPN": 0, "versionType": "vmanage" } }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceactionDeviceactionapiRequestExampleLxcupgrade" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Task Id": { "description": "Task Id", "value": { "id": "lxc_upgrade-c3a06c6f-af96-4861-986d-04c6000c3d6f" }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceactionDeviceactionapiResponseExampleLxcupgrade" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Software Upgrade-write,Software Upgrade > Edge-write,Software Upgrade > Controller-write" } }, "/device/action/reboot": { "post": { "tags": [ "Configuration - Device Actions" ], "description": "Process a reboot operation", "operationId": "processReboot", "requestBody": { "description": "Device reboot request payload", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Device reboot request": { "description": "Device reboot request", "value": { "action": "reboot", "deviceType": "vedge", "devices": [ { "deviceIP": "172.16.255.11", "deviceId": "6ace13f8-fded-4669-994a-a100b84b14dd" } ] }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceactionDeviceactionapiRequestExamplePostrebootreq" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "reboot-01232017T154359940" } }, "$$ref": "#/components/schemas/TaskId" }, "examples": { "Task Id": { "description": "Task Id", "value": { "id": "reboot-01232017T154359940" }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceactionDeviceactionapiResponseExamplePostrebootresp" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Reboot-write,Device Reboot > Edge-write,Device Reboot > Controller-write" }, "get": { "tags": [ "Configuration - Device Actions" ], "description": "Get device reboot information", "operationId": "generateRebootInfo", "parameters": [ { "name": "deviceId", "in": "query", "description": "Device Id", "required": true, "schema": { "type": "array", "items": { "type": "object", "properties": { "deviceIp": { "type": "string" } }, "description": "This is the valid DeviceIP", "$$ref": "#/components/schemas/DeviceIP" } }, "example": [ "172.16.255.15" ] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "Device list": { "description": "Device list", "value": { "header": { "generatedOn": 1717612477967, "viewKeys": { "uniqueKey": [], "preferenceKey": "grid-DeviceActionReboot" }, "columns": [ { "title": "Hostname", "property": "host-name", "display": "iconAndText", "iconProperty": "device-type", "hideable": false, "icon": [ { "key": "vmanage", "value": "images/vmanage_table.png" }, { "key": "vedge", "value": "images/vedge_table.png" }, { "key": "vedge-vbond", "value": "images/vedge-vbond_table.png" }, { "key": "vsmart", "value": "images/vsmart_table.png" }, { "key": "vbond", "value": "images/vbond_table.png" } ], "minWidth": 110, "dataType": "string" }, { "title": "System IP", "property": "local-system-ip", "hideable": false, "width": 110, "minWidth": 130, "dataType": "ipv4" }, { "title": "Chassis Number", "property": "uuid", "hideable": false, "minWidth": 200, "dataType": "string" }, { "title": "Site ID", "property": "site-id", "width": 100, "minWidth": 70, "dataType": "number" }, { "title": "Device Model", "property": "device-model", "display": "multiColumns", "hideable": false, "width": 120, "dataType": "deviceModel" }, { "title": "Reachability", "property": "reachability", "colorProperty": "reachability", "hideable": false, "color": [ { "key": "reachable", "value": "616161" }, { "key": "unreachable", "value": "ef5350" }, { "key": "auth-failed", "value": "ffb300" } ], "width": 110, "dataType": "string" }, { "title": "Available Services", "property": "availableServices", "hideable": false, "minWidth": 140, "dataType": "array" }, { "title": "Up Since", "property": "uptime-date", "displayFormat": "DD MMM YYYY h:mm:ss A z", "inputFormat": "unix-time", "width": 230, "dataType": "date" } ], "fields": [ { "property": "host-name", "dataType": "string", "display": "iconAndText" }, { "property": "system-ip", "dataType": "ipv4" }, { "property": "local-system-ip", "dataType": "ipv4" }, { "property": "uuid", "dataType": "string" }, { "property": "site-id", "dataType": "number" }, { "property": "device-model", "dataType": "deviceModel", "display": "multiColumns" }, { "property": "reachability", "dataType": "string" }, { "property": "availableServices", "dataType": "array" }, { "property": "uptime-date", "dataType": "date" } ] }, "data": [ { "device-model": "vedge-cloud", "device-os": "next", "local-system-ip": "172.16.255.16", "availableServices": [], "system-ip": "172.16.255.16", "host-name": "vm6", "site-id": "600", "uuid": "970b3f78-a713-49e4-890d-beffe5db7dd0", "version": "20.9.5-801", "platform": "x86_64", "personality": "vedge", "device-type": "vedge", "reachability": "reachable", "uptime-date": 1717393860000 } ] }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceactionDeviceactionapiResponseExampleGetrebootresp" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Reboot-read,Device Reboot-write,Device Reboot > Edge-read,Device Reboot > Edge-write,Device Reboot > Controller-read" } }, "/device/action/reboot/devices/{deviceType}": { "get": { "tags": [ "Configuration - Device Actions" ], "description": "Get list of rebooted devices", "operationId": "generateRebootDeviceList", "parameters": [ { "name": "deviceType", "in": "path", "description": "Device type", "required": true, "schema": { "type": "string" }, "example": "vedge" }, { "name": "groupId", "in": "query", "description": "groupId", "required": true, "schema": { "type": "string" }, "example": "all" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "availableServices": { "type": "array", "example": [], "items": { "type": "string", "example": [] } }, "device-model": { "type": "string", "example": "vsmart" }, "device-os": { "type": "string", "example": "next" }, "device-type": { "type": "string", "example": "vsmart" }, "host-name": { "type": "string", "example": "vm10" }, "layoutLevel": { "type": "integer", "format": "int32", "example": 2 }, "local-system-ip": { "type": "string", "example": "172.16.255.20" }, "personality": { "type": "string", "example": "vsmart" }, "platform": { "type": "string", "example": "x86_64" }, "reachability": { "type": "string", "example": "reachable" }, "site-id": { "type": "string", "example": "200" }, "system-ip": { "type": "string", "example": "172.16.255.20" }, "uptime-date": { "type": "integer", "format": "int32", "example": 1683651060000 }, "uuid": { "type": "string", "example": "3ee91f17-fc89-4d25-9e31-684e823d5eba" }, "version": { "type": "string", "example": "20.13.999-2847" } }, "$$ref": "#/components/schemas/GenerateRebootDeviceListData" } } }, "$$ref": "#/components/schemas/GenerateRebootDeviceList" }, "examples": { "Example": { "description": "Example", "value": { "data": [ { "device-model": "vsmart", "device-os": "next", "local-system-ip": "172.16.255.20", "system-ip": "172.16.255.20", "host-name": "vm10", "site-id": "200", "uuid": "3ee91f17-fc89-4d25-9e31-684e823d5eba", "version": "20.13.999-2847", "platform": "x86_64", "layoutLevel": 2, "personality": "vsmart", "device-type": "vsmart", "reachability": "reachable", "uptime-date": 1683651060000, "availableServices": [] } ] }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceactionDeviceactionapiResponseExampleGetrebootdevicesresp" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Reboot-read,Device Reboot-write,Device Reboot > Edge-read,Device Reboot > Edge-write,Device Reboot > Controller-read" } }, "/device/action/rediscover": { "get": { "tags": [ "Configuration - Device Actions" ], "description": "Get rediscover operation information", "operationId": "generateRediscoverInfo", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "board-serial": { "type": "string", "example": "12345982" }, "certificate-validity": { "type": "string", "example": "Valid" }, "connectedVManages": { "type": "array", "items": { "type": "string" } }, "controlConnections": { "type": "string", "example": "8" }, "device-groups": { "type": "array", "items": { "type": "string" } }, "device-model": { "type": "string", "example": "vmanage" }, "device-os": { "type": "string", "example": "next" }, "device-type": { "type": "string", "example": "vmanage" }, "deviceId": { "type": "string", "example": "172.16.255.22" }, "domain-id": { "type": "string", "example": "0" }, "host-name": { "type": "string", "example": "vm12" }, "isDeviceGeoData": { "type": "boolean", "example": false }, "lastupdated": { "type": "integer", "format": "int32", "example": 1683524985013 }, "latitude": { "type": "string", "example": "37.666684" }, "layoutLevel": { "type": "integer", "format": "int32", "example": 1 }, "local-system-ip": { "type": "string", "example": "172.16.255.22" }, "longitude": { "type": "string", "example": "-122.777023" }, "max-controllers": { "type": "string", "example": "0" }, "model_sku": { "type": "string", "example": "None" }, "personality": { "type": "string", "example": "vmanage" }, "platform": { "type": "string", "example": "x86_64" }, "reachability": { "type": "string", "example": "reachable" }, "site-id": { "type": "string", "example": "200" }, "state": { "type": "string", "example": "green" }, "state_description": { "type": "string", "example": "All daemons up" }, "status": { "type": "string", "example": "normal" }, "statusOrder": { "type": "integer", "format": "int32", "example": 4 }, "system-ip": { "type": "string", "example": "172.16.255.22" }, "testbed_mode": { "type": "boolean", "example": true }, "timezone": { "type": "string", "example": "UTC" }, "total_cpu_count": { "type": "string", "example": "4" }, "uptime-date": { "type": "integer", "format": "int32", "example": 1683523320000 }, "uuid": { "type": "string", "example": "b642c56f-c899-4ca4-a3d6-d915e0660f9a" }, "validity": { "type": "string", "example": "valid" }, "version": { "type": "string", "example": "20.13.999-2846" } }, "$$ref": "#/components/schemas/GenerateRediscoverInfoData" } } }, "$$ref": "#/components/schemas/GenerateRediscoverInfo" }, "examples": { "Example": { "description": "Example", "value": { "data": [ { "deviceId": "172.16.255.22", "system-ip": "172.16.255.22", "host-name": "vm12", "reachability": "reachable", "status": "normal", "personality": "vmanage", "device-type": "vmanage", "timezone": "UTC", "device-groups": [ "No groups" ], "lastupdated": 1683524985013, "domain-id": "0", "board-serial": "12345982", "certificate-validity": "Valid", "max-controllers": "0", "uuid": "b642c56f-c899-4ca4-a3d6-d915e0660f9a", "controlConnections": "8", "device-model": "vmanage", "version": "20.13.999-2846", "connectedVManages": [ "172.16.255.22" ], "site-id": "200", "latitude": "37.666684", "longitude": "-122.777023", "isDeviceGeoData": false, "platform": "x86_64", "uptime-date": 1683523320000, "statusOrder": 4, "device-os": "next", "validity": "valid", "state": "green", "state_description": "All daemons up", "model_sku": "None", "local-system-ip": "172.16.255.22", "total_cpu_count": "4", "testbed_mode": true, "layoutLevel": 1 } ] }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceactionDeviceactionapiResponseExampleGetrediscoverresp" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Tools-read,Tools-write" }, "post": { "tags": [ "Configuration - Device Actions" ], "description": "Rediscover device", "operationId": "reDiscoverDevices", "requestBody": { "description": "Rediscover device request payload", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Rediscover device request": { "description": "Rediscover device request", "value": { "action": "rediscover", "devices": [ { "deviceId": "CSR-940ad679-a16a-48ea-9920-16278597d98e", "deviceIP": "10.3.0.1" } ] }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceactionDeviceactionapiRequestExamplePostrediscoverreq" } } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-write,Tools-write" } }, "/device/action/rediscoverall": { "post": { "tags": [ "Configuration - Device Actions" ], "description": "Rediscover all devices", "operationId": "reDiscoverAllDevice", "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-write,Tools-write" } }, "/device/action/remote-server": { "get": { "tags": [ "Configuration - Software Actions" ], "description": "Get list of remote servers", "operationId": "getRemoteServerList", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Configuration - Software Actions" ], "description": "Add a new remote server entry.", "operationId": "addRemoteServer", "requestBody": { "description": "Request body for Add a new remote server entry.", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Example Value": { "description": "Example Value", "value": { "remoteServerName": "test", "remoteServerUrl": "1.1.1.1", "remoteServerProtocol": "SCP", "remoteServerPort": 22, "remoteServerVPN": 0, "remoteServerUser": "vtest", "imageLocationPrefix": "/", "remoteServerPassword": "v1ptela0212" }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceactionDeviceactionremoteserverapiRequestExamplePostremoteserver" } } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/device/action/remote-server/{id}": { "get": { "tags": [ "Configuration - Software Actions" ], "description": "Get remote server for the specified ID", "operationId": "getRemoteServerById", "parameters": [ { "name": "id", "in": "path", "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" } } }, "delete": { "tags": [ "Configuration - Software Actions" ], "description": "Delete remote server for the specified ID", "operationId": "deleteRemoteServer", "parameters": [ { "name": "id", "in": "path", "description": "remoteServerId", "required": true, "schema": { "type": "string" }, "example": "f7ae1f4b-9900-424f-92ca-22d2231f55dc" } ], "requestBody": { "description": "Request body for Add a new remote server entry.", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Example Value": { "description": "Example Value", "value": {}, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceactionDeviceactionremoteserverapiRequestExampleDeleteremoteserver" } } } } }, "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "Configuration - Software Actions" ], "description": "Update remote server for the specified ID", "operationId": "updateRemoteServer", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "string" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/device/action/removepartition": { "get": { "tags": [ "Configuration - Device Actions" ], "description": "Get remove partition information", "operationId": "generateRemovePartitionInfo", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "array", "items": { "type": "object", "properties": { "deviceIp": { "type": "string" } }, "description": "This is the valid DeviceIP", "$$ref": "#/components/schemas/DeviceIP" } }, "example": [ "172.16.255.15" ] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "availableVersions": { "type": "array", "example": [], "items": { "type": "string", "example": [] } }, "device-model": { "type": "string", "example": "vmanage" }, "device-type": { "type": "string", "example": "vmanage" }, "host-name": { "type": "string", "example": "vm12" }, "personality": { "type": "string", "example": "vmanage" }, "platform": { "type": "string", "example": "x86_64" }, "reachability": { "type": "string", "example": "reachable" }, "site-id": { "type": "string", "example": "200" }, "system-ip": { "type": "string", "example": "172.16.255.22" }, "uptime-date": { "type": "string", "example": "1686317760000" }, "uuid": { "type": "string", "example": "eb4c84bd-5da6-4adc-8ba5-21360549da74" }, "version": { "type": "string", "example": "20.13.999-2912" } }, "$$ref": "#/components/schemas/GenerateRemovePartitionInfoData" } } }, "$$ref": "#/components/schemas/GenerateRemovePartitionInfo" }, "examples": { "Example": { "description": "Example", "value": { "data": [ { "availableVersions": [], "host-name": "vm12", "system-ip": "172.16.255.22", "personality": "vmanage", "site-id": "200", "uuid": "eb4c84bd-5da6-4adc-8ba5-21360549da74", "device-type": "vmanage", "version": "20.13.999-2912", "uptime-date": "1686317760000", "device-model": "vmanage", "platform": "x86_64", "reachability": "reachable" } ] }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceactionDeviceactionapiResponseExampleGetremovepartition" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Software Upgrade-read,Software Upgrade-write,Software Upgrade > Edge-write,Software Upgrade > Edge-read,Software Upgrade > Controller-write,Software Upgrade > Controller-read" }, "post": { "tags": [ "Configuration - Device Actions" ], "description": "Process remove partition operation", "operationId": "processRemovePartition", "requestBody": { "description": "Device remove partition request payload", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Device remove partition request": { "description": "Device remove partition request", "value": { "action": "removepartition", "devices": [ { "deviceIP": "172.16.255.11", "deviceId": "6ace13f8-fded-4669-994a-a100b84b14dd", "version": [ "20.1.1", "20.3.1" ] }, { "deviceIP": "172.16.255.21", "deviceId": "bedf3db0-c9c9-439d-b5fe-0edf09c2f33f", "version": [ "20.1.1" ] } ], "deviceType": "vedge" }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceactionDeviceactionapiRequestExamplePostremovepartitionreq" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Task Id": { "description": "Task Id", "value": { "id": "delete_partition-2762efba-c37d-4dd2-bbca-9d910ca27325" }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceactionDeviceactionapiResponseExamplePostremovepartitionresp" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Software Upgrade-write,Software Upgrade > Edge-write,Software Upgrade > Controller-write" } }, "/device/action/security/amp/apikey/{uuid}": { "delete": { "tags": [ "Configuration - Device Actions" ], "description": "Process amp api key deletion operation", "operationId": "processDeleteAmpApiKey", "parameters": [ { "name": "uuid", "in": "path", "description": "Uuid", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "AMP API key deletion request": { "description": "AMP API key deletion request", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Software Upgrade-write,Software Upgrade > Edge-write,Software Upgrade > Controller-write" } }, "/device/action/security/amp/rekey": { "post": { "tags": [ "Configuration - Device Actions" ], "description": "Process amp api re-key operation", "operationId": "processAmpApiReKey", "requestBody": { "description": "AMP API re-key request payload", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "AMP API re-key request": { "description": "AMP API re-key request", "value": {} } } } }, "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": "Software Upgrade-write,Software Upgrade > Edge-write,Software Upgrade > Controller-write" } }, "/device/action/security/apikey/{uuid}": { "get": { "tags": [ "Configuration - Device Actions" ], "description": "Get API key from device", "operationId": "testApiKey", "parameters": [ { "name": "uuid", "in": "path", "description": "Device uuid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "API key": { "description": "API key", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Software Upgrade-read,Software Upgrade-write,Settings-read,Software Upgrade > Edge-write,Software Upgrade > Edge-read,Software Upgrade > Controller-write,Software Upgrade > Controller-read" } }, "/device/action/security/devices/{policyType}": { "get": { "tags": [ "Configuration - Device Actions" ], "description": "Get list of devices by security policy type", "operationId": "generateSecurityDevicesList", "parameters": [ { "name": "policyType", "in": "path", "description": "Policy type", "required": true, "schema": { "type": "string", "enum": [ "zoneBasedFW", "intrusionPrevention", "urlFiltering", "advancedMalwareProtection", "dnsSecurity", "sslDecryption" ] } }, { "name": "groupId", "in": "query", "description": "Group Id", "required": true, "schema": { "type": "object", "properties": { "groupId": { "type": "string" } }, "description": "This is the valid GroupId", "$$ref": "#/components/schemas/GroupId" } } ], "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" } }, "deprecated": true, "x-roles-required": "Software Upgrade-read,Software Upgrade-write,Settings-read,Security-read,Security-read,Security-write,Software Upgrade > Edge-write,Software Upgrade > Edge-read,Software Upgrade > Controller-write,Software Upgrade > Controller-read" } }, "/device/action/software": { "get": { "tags": [ "Configuration - Software Actions" ], "description": "Get software images", "operationId": "findSoftwareImages", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Example": { "description": "Example", "value": { "data": [ { "availableFiles": "[isr4200-universalk9_ias.17.09.01.0.155356_V17_9_0_8.SSA.bin]", "versionType": "vmanage", "versionTypeName": "software", "imagePropertiesJson": "", "networkFunctionType": "ROUTER", "updatedOn": 1653647407050, "versionName": "17.09.01.0.155356.1646904830", "platformFamily": [ "isr4200" ], "smuCompatibleVersion": "17.09.01.0.155356", "versionIdMap": "{isr4200-universalk9_ias.17.09.01.0.155356_V17_9_0_8.SSA.bin=39db1b51-7b82-4616-8767-404b5b9a197a}", "versionId": "a6a9ce11-e23d-4c88-88f4-e166b69e1493", "systemPropertiesXml": "", "@rid": 615, "availableSmuVersions": [ "" ], "vnfPropertiesJson": "", "cwVersion": "17.09.01", "vendor": "Cisco", "controllerVersionName": "20.9.x", "fileNameMap": "{isr4200-ucmk9.17.09.01.0.155356.1646904830.SSA.bin=isr4200-universalk9_ias.17.09.01.0.155356_V17_9_0_8.SSA.bin}", "arch": "x86_64", "imageType": "software", "versionURL": "http://:8080/software/package/" } ] }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceactionInstallpackageurlapiResponseExampleGetsoftware" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Configuration - Software Actions" ], "description": "Create software image URL", "operationId": "createImageURL", "requestBody": { "description": "Request body", "content": { "application/json": { "schema": { "required": [ "fileName", "remoteServerId" ], "type": "object", "properties": { "cwVersion": { "type": "string", "description": "Software image version.", "example": "17.17.01.0.210058" }, "fileName": { "type": "string", "description": "Software image file name.", "example": "abc.bin" }, "isPatch": { "type": "boolean", "example": false }, "platformfamily": { "type": "string", "description": "Software image platform family.", "example": "c8000v" }, "remoteServerId": { "type": "string", "description": "Remote server id to fetch the image from. ", "example": "9ef53f4a-388d-4b3d-90b6-d94038ecb9ed" } }, "$$ref": "#/components/schemas/CreateImageURL" }, "examples": { "Example Value": { "description": "Example Value", "value": { "remoteServerId": "9ef53f4a-388d-4b3d-90b6-d94038ecb9ed", "fileName": "abc.bin", "platformFamily": "c8000v", "cwVersion": "17.17.01.0.210058" }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceactionInstallpackageurlapiRequestExamplePostsoftware" } } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/device/action/software/imageProperties/{versionId}": { "get": { "tags": [ "Configuration - Software Actions" ], "description": "Get Image Properties", "operationId": "getImageProperties", "parameters": [ { "name": "versionId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "08d56e2f-10ee-452d-bd41-c375915cf7d7" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "imagePropertiesJson": { "type": "object", "properties": { "image_properties": { "type": "object", "properties": { "applicationDescription": { "type": "string", "example": "Unified Threat Defense" }, "applicationMaxInstances": { "type": "number", "example": 1 }, "applicationVendor": { "type": "string", "example": "Cisco Systems, Inc." }, "arch": { "type": "string", "example": "aarch64" }, "imageType": { "type": "string", "example": "lxc" }, "name": { "type": "string", "example": "UTD-Snort-Feature" }, "version": { "type": "string", "example": "1.13.5_SV3.1.55.0_XEmain" }, "vnf_type": { "type": "string", "example": "app-hosting" } }, "$$ref": "#/components/schemas/GetImagePropertiesImagePropertiesJsonImageProperties" } }, "$$ref": "#/components/schemas/GetImagePropertiesImagePropertiesJson" } }, "$$ref": "#/components/schemas/GetImagePropertiesData" } } }, "$$ref": "#/components/schemas/GetImageProperties" }, "examples": { "Image properties": { "description": "Image properties", "value": { "data": [ { "imagePropertiesJson": { "image_properties": { "applicationMaxInstances": 1, "applicationDescription": "Unified Threat Defense", "name": "UTD-Snort-Feature", "applicationVendor": "Cisco Systems, Inc.", "arch": "aarch64", "vnf_type": "app-hosting", "version": "1.13.5_SV3.1.55.0_XEmain", "imageType": "lxc" } } } ] }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceactionInstallpackageurlapiResponseExampleGetimageproperties" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/device/action/software/images": { "get": { "tags": [ "Configuration - Software Actions" ], "description": "Get software images", "operationId": "findSoftwareImagesWithFilters", "parameters": [ { "name": "imageType", "in": "query", "description": "imageType", "required": true, "schema": { "type": "array", "items": { "type": "object", "properties": { "image": { "type": "string" } }, "description": "This is the valid Image type ", "$$ref": "#/components/schemas/Image" } }, "example": [ "software" ] }, { "name": "vnfType", "in": "query", "description": "vnfType", "schema": { "type": "string" }, "example": "ROUTER" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Example": { "description": "Example", "value": { "data": [ { "availableFiles": "isr4200-universalk9_ias.17.09.01.0.155356_V17_9_0_8.SSA.bin", "versionTypeName": "software", "versionName": "17.09.01.0.155356.1646904830", "platformFamily": [ "isr4200" ], "smuCompatibleVersion": "17.09.01.0.155356", "vendor": "Cisco", "imageType": "software", "versionType": "vmanage", "networkFunctionType": "ROUTER", "updatedOn": 1653647407050, "versionIdMap": "{isr4200-universalk9_ias.17.09.01.0.155356_V17_9_0_8.SSA.bin=39db1b51-7b82-4616-8767-404b5b9a197a}", "versionId": "39db1b51-7b82-4616-8767-404b5b9a197a", "availableSmuVersions": [ "string" ], "controllerVersionName": "20.9.x", "fileNameMap": "{isr4200-ucmk9.17.09.01.0.155356.1646904830.SSA.bin=isr4200-universalk9_ias.17.09.01.0.155356_V17_9_0_8.SSA.bin}", "arch": "x86_64", "versionURL": "http://:8080/software/package/" } ] }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceactionInstallpackageurlapiResponseExampleGetsoftwareimages" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/device/action/software/package": { "post": { "tags": [ "Configuration - Device Software Update" ], "description": "Install software package", "operationId": "installPkg", "requestBody": { "description": "software Package File", "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } }, "$$ref": "#/components/schemas/InstallPkg" } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/device/action/software/package/imageCount": { "get": { "tags": [ "Configuration - Device Software Update" ], "description": "Number of software image presented in vManage repository", "operationId": "getUploadImagesCount", "parameters": [ { "name": "imageType", "in": "query", "description": "imageType", "schema": { "type": "array", "items": { "type": "string", "default": "software" } }, "example": [ "software" ] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Example": { "description": "Example", "value": { "imageCount": 20 }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceactionSoftwarepackageInstallpackagefileapiResponseExampleImagecount" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/device/action/software/package/signature/{utdsignature}": { "get": { "tags": [ "Configuration - Device Software Update" ], "summary": "Get list of Utd images", "description": "Get list of Utd images ", "operationId": "generateUtdImageData", "parameters": [ { "name": "utdsignature", "in": "path", "description": "utdsignature", "required": true, "schema": { "type": "string", "enum": [ "utdsignature" ] }, "example": "utdsignature" }, { "name": "type", "in": "query", "required": true, "schema": { "type": "string" }, "example": "all" } ], "responses": { "200": { "description": "Get list of Utd images", "content": { "application/json": { "schema": { "type": "object", "properties": { "applicationVendor": { "type": "string" }, "applicationVendorVendor": { "type": "string", "writeOnly": true }, "arch": { "type": "string" }, "controllerVersion": { "type": "string" }, "cwVersion": { "type": "string" }, "description": { "type": "string" }, "displayChecksum": { "type": "string" }, "displayChecksumType": { "type": "string" }, "displayChecksumValidity": { "type": "string" }, "family": { "type": "array", "items": { "type": "string" } }, "fileEntries": { "type": "object", "additionalProperties": { "type": "string" } }, "fileName": { "type": "string" }, "fileSizeStr": { "type": "string" }, "fileSizebyte": { "type": "string" }, "fileSource": { "type": "string" }, "imagePropertiesJson": { "type": "string" }, "imageType": { "type": "string", "enum": [ "ImageType{type='software'}", "ImageType{type='container'}", "ImageType{type='lxc'}", "ImageType{type='virtualmachine'}", "ImageType{type='virtualmachine-diskimg'}", "ImageType{type='virtualmachine-scaffold'}", "ImageType{type='utdsignature'}", "ImageType{type='utdsignatureips'}", "ImageType{type='utdsignaturecustom'}", "ImageType{type='utdsignatureoverride'}", "ImageType{type='waas'}", "ImageType{type='dockertype'}", "ImageType{type='firmware'}", "ImageType{type='rumreport'}", "ImageType{type='licensefile'}", "ImageType{type='ackfile'}", "ImageType{type='na'}" ] }, "imageTypeName": { "type": "string" }, "isSmu": { "type": "boolean" }, "md5Checksum": { "type": "string" }, "metadata": { "type": "object", "properties": { "allProperties": { "type": "object", "additionalProperties": { "type": "object" } } }, "$$ref": "#/components/schemas/ImageMetadata" }, "networkFunctionType": { "type": "string" }, "platformFamily": { "type": "string" }, "remoteServerId": { "type": "string" }, "remoteServers": { "type": "string" }, "sha256Checksum": { "type": "string" }, "sha512Checksum": { "type": "string" }, "smuCompatibleWith": { "type": "string" }, "smuDefectId": { "type": "string" }, "smuDescription": { "type": "string" }, "smuType": { "type": "string" }, "storageData": { "type": "string" }, "systemPropertiesXml": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "tempImagePath": { "type": "string" }, "updatedFileName": { "type": "string" }, "version": { "type": "string" }, "versionTypeName": { "type": "string" }, "vnfPropertiesJson": { "type": "string" } }, "$$ref": "#/components/schemas/ImageData" }, "examples": { "Example": { "description": "Example", "value": { "header": { "generatedOn": 1719798772630 }, "data": [ { "versionType": "remote", "versionTypeName": "pkg", "description": "UTD Image", "networkFunctionType": "app-hosting", "updatedOn": 1718956223450, "versionName": "31670", "versionId": "b678683a-9581-4978-ae44-bcb814cb9fba", "remoteServers": "[{\"remoteServerId\":\"eef0003f-560c-4165-92f3-9590553ce68a\",\"imageRelativePath\":\"\"}]", "fileSizeStr": "null", "name": "UTD-STD-SIGNATURE-31670-28-S.pkg", "imageType": "utdsignatureips" }, { "versionType": "remote", "versionTypeName": "txt", "description": "UTD Image", "networkFunctionType": "app-hosting", "updatedOn": 1718956283492, "versionName": "-", "versionId": "f2e63288-c279-42a0-bc88-0b333b10fd57", "remoteServers": "[{\"remoteServerId\":\"eef0003f-560c-4165-92f3-9590553ce68a\",\"imageRelativePath\":\"\"}]", "fileSizeStr": "null", "name": "Custom.txt", "imageType": "utdsignaturecustom" } ] }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceactionSoftwarepackageInstallpackagefileapiResponseExampleUtdimagedata" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/device/action/software/package/utdsignature/{type}/mode/auto": { "post": { "tags": [ "Configuration - Device Software Update" ], "summary": "add Utd remote image", "description": "add Utd remote image ", "operationId": "addUtdRemoteImage", "parameters": [ { "name": "type", "in": "path", "required": true, "schema": { "type": "string" }, "example": "custom" } ], "requestBody": { "description": "Request body", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Example Value": { "description": "Example Value", "value": { "enableRemoteServer": true, "fileName": "custom. txt", "remoteServers": [ { "remoteServerId": "17ecd0f0-40de-4fc2-b76d-99672c570d71", "imageRelativePath": "dre1. tar.gz" }, { "remoteServerId": "5d7e260e-c14a-4f88-9f6e-efef7a88d6fa", "imageRelativePath": "dre1. tar.gz" } ] }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceactionSoftwarepackageInstallpackagefileapiRequestExampleUtdsignaturecustomautoreq" } } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/device/action/software/package/utdsignature/{type}/mode/manual": { "post": { "tags": [ "Configuration - Device Software Update" ], "summary": "upload Utd image", "description": "upload Utd image", "operationId": "uploadUtdImage", "parameters": [ { "name": "type", "in": "path", "required": true, "schema": { "type": "string" }, "example": "ips" } ], "requestBody": { "description": "Utd image File", "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } }, "$$ref": "#/components/schemas/InstallPkg" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/device/action/software/package/{fileName}": { "get": { "tags": [ "Configuration - Device Software Update" ], "description": "Download software package file", "operationId": "downloadPackageFile", "parameters": [ { "name": "fileName", "in": "path", "description": "software package file name", "required": true, "schema": { "type": "string" }, "example": "c8000v-universalk9.17.15.01.0.198014_V17_15_0_1.SSA.bin" }, { "name": "imageType", "in": "query", "schema": { "type": "string", "default": "software" } } ], "responses": { "200": { "description": "Success", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" }, "examples": { "Example": { "description": "Example", "value": "FIREWALL_CiscoASAvVirtualFirewallMT_scaffold_9.13.1-MT_csr-scaff.tar.gz", "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceactionSoftwarepackageInstallpackagefileapiResponseExampleFilename" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/device/action/software/package/{imageType}": { "post": { "tags": [ "Configuration - Device Software Update" ], "description": "Install software image package", "operationId": "processSoftwareImage", "parameters": [ { "name": "imageType", "in": "path", "required": true, "schema": { "type": "string" }, "example": "software" } ], "requestBody": { "description": "image File", "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } }, "$$ref": "#/components/schemas/InstallPkg" } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/device/action/software/package/{versionId}/metadata": { "get": { "tags": [ "Configuration - Device Software Update" ], "description": "Update Package Metadata", "operationId": "getImageMetadata", "parameters": [ { "name": "versionId", "in": "path", "description": "versionId", "required": true, "schema": { "type": "string" }, "example": "760c1198-1595-4ad2-b911-cec12e4da7b3" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Example": { "description": "Example", "value": { "vendor": "cisco", "checksumType": "SHA-256", "checksum": "", "description": "description", "networkFunctionType": "ROUTER", "versionName": "x.y.z", "imageType": "virtualmachine-diskimg", "tags": [ "string" ] }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceactionSoftwarepackageInstallpackagefileapiResponseExampleGetversionid" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "Configuration - Device Software Update" ], "description": "Update Package Metadata", "operationId": "editImageMetadata", "parameters": [ { "name": "versionId", "in": "path", "description": "versionId", "required": true, "schema": { "type": "string" }, "example": "760c1198-1595-4ad2-b911-cec12e4da7b3" } ], "requestBody": { "description": "Request body to Update Package Metadata", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Example Value": { "description": "Example Value", "value": { "description": "description", "networkFunctionType": "ROUTER", "versionName": "x.y.z", "vendor": "cisco", "checksumType": "SHA-256", "checksum": "", "tags": [ "string" ] }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceactionSoftwarepackageInstallpackagefileapiRequestExamplePutversionid" } } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/device/action/software/platformfamily": { "get": { "tags": [ "Configuration - Software Actions" ], "description": "Get Supported platform Family", "operationId": "findSupportedPlatformFamily", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { " Supported platform Family": { "description": " Supported platform Family", "value": [ "ir1101", "c8000aes", "isr4400", "c8000aep", "Teleworker", "asr1000", "asr1001x", "c1100", "isr4200", "isr4300", "c8000be", "isr1100be", "c8100", "c8k30aes", "asr1000rpx86", "c1100tg", "ir1800", "isrv", "c8000v", "c8k30be", "cg", "asr1002x", "csr1000v", "isr4400v2", "NFVIS-SDWAN-BRANCH", "c6300", "ir8340", "ir8100" ], "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceactionInstallpackageurlapiResponseExampleGetplatformfamily" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/device/action/software/remoteserver/{versionId}": { "get": { "tags": [ "Configuration - Software Actions" ], "description": "Get Image Remote Server Details", "operationId": "getImageRemoteServer", "parameters": [ { "name": "versionId", "in": "path", "description": "Version", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Remote Server Details": { "description": "Remote Server Details", "value": { "remoteServers": [ { "remoteServerId": "6d22e7fb-335c-4f93-a756-f2d5fa815e03", "ImageRelativePath": "/images" }, { "remoteServerId": "6d22e7fb-335c-4f93-a756-f2d5fa815e14", "ImageRelativePath": "/images/virtualImages" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Software Upgrade-read,Software Upgrade-write,Software Upgrade > Edge-write,Software Upgrade > Edge-read,Software Upgrade > Controller-write,Software Upgrade > Controller-read" }, "put": { "tags": [ "Configuration - Software Actions" ], "description": "Update Image Remote Server Details", "operationId": "editImageRemoteServer", "parameters": [ { "name": "versionId", "in": "path", "description": "Image ID", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Update image remote server details", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Update image remote server details": { "description": "Update image remote server details", "value": { "remoteServers": [ { "remoteServerId": "6d22e7fb-335c-4f93-a756-f2d5fa815e03", "ImageRelativePath": "/images" }, { "remoteServerId": "6d22e7fb-335c-4f93-a756-f2d5fa815e14", "ImageRelativePath": "/images/virtualImages" } ] } } } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "admin,Software Upgrade-write,Software Upgrade > Edge-write,Software Upgrade > Controller-write" } }, "/device/action/software/vedge/version": { "get": { "tags": [ "Configuration - Software Actions" ], "description": "Get vEdge software version", "operationId": "findVEdgeSoftwareVersion", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "version": { "type": "string", "example": "17.12.01.0.177566.1681743991" }, "versionId": { "type": "string", "example": "a35a640d-2414-4923-a2c4-02bbd37bf2ad" } }, "$$ref": "#/components/schemas/FindVEdgeSoftwareVersionData" } } }, "$$ref": "#/components/schemas/FindVEdgeSoftwareVersion" }, "examples": { "vEdge software version": { "description": "vEdge software version", "value": { "data": [ { "versionId": "a35a640d-2414-4923-a2c4-02bbd37bf2ad", "version": "17.12.01.0.177566.1681743991" } ] }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceactionInstallpackageurlapiResponseExampleVedgeversion" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/device/action/software/version": { "get": { "tags": [ "Configuration - Software Actions" ], "description": "Get software version", "operationId": "findSoftwareVersion", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "version": { "type": "string", "example": "17.12.01.0.177566.1681743991" } }, "$$ref": "#/components/schemas/FindSoftwareVersionData" } } }, "$$ref": "#/components/schemas/FindSoftwareVersion" }, "examples": { "Software version": { "description": "Software version", "value": { "data": [ { "version": "17.12.01.0.177566.1681743991" } ] }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceactionInstallpackageurlapiResponseExampleVersion" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/device/action/software/vnfproperties/{versionId}": { "get": { "tags": [ "Configuration - Software Actions" ], "description": "Get VNF Properties", "operationId": "getVnfProperties", "parameters": [ { "name": "versionId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "c9a1bf09-1060-4c82-a9e8-745159ddfc1d" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "vnfPropertiesJson": { "type": "object", "properties": { "vnfProperties": { "type": "object", "properties": { "applicationDescription": { "type": "string", "example": "Unified Threat Defense" }, "applicationMaxInstances": { "type": "number", "example": 1 }, "applicationVendor": { "type": "string", "example": "Cisco Systems, Inc." }, "arch": { "type": "string", "example": "x86_64" }, "imageType": { "type": "string", "example": "lxc" }, "name": { "type": "string", "example": "UTD-Snort-Feature" }, "version": { "type": "string", "example": "1.13.1_SV3.1.55.0_XEmain" }, "vnf_type": { "type": "string", "example": "app-hosting" } }, "$$ref": "#/components/schemas/GetVnfPropertiesVnfPropertiesJsonVnfProperties" } }, "$$ref": "#/components/schemas/GetVnfPropertiesVnfPropertiesJson" } }, "$$ref": "#/components/schemas/GetVnfPropertiesData" } } }, "$$ref": "#/components/schemas/GetVnfProperties" }, "examples": { "VNF properties": { "description": "VNF properties", "value": { "data": [ { "vnfPropertiesJson": { "vnfProperties": { "applicationMaxInstances": 1, "applicationDescription": "Unified Threat Defense", "name": "UTD-Snort-Feature", "applicationVendor": "Cisco Systems, Inc.", "arch": "x86_64", "vnf_type": "app-hosting", "version": "1.13.1_SV3.1.55.0_XEmain", "imageType": "lxc" } } } ] }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceactionInstallpackageurlapiResponseExampleVnfproperties" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/device/action/software/ztp/version": { "get": { "tags": [ "Configuration - Software Actions" ], "description": "Get ZTP software version", "operationId": "findZtpSoftwareVersion", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "vEdge software version": { "description": "vEdge software version", "value": { "data": [ { "platformFamily": "ir1101", "versions": [ { "remoteServerId": "213577b2-ee6f-47b3-8c19-e6ebdf6dc8f1", "imageLocationPrefix": "/", "remoteServerName": "local_ftp", "remoteServerVPN": "0", "remoteServerPort": "21", "remoteServerProtocol": "FTP", "remoteServerUrl": "1.1.1.1", "name": "cba.bin", "versionId": "831bfa08-d7f8-447f-8919-c9ccda5e1e8c", "versionType": "remote" } ] }, { "platformFamily": "vedge-mips", "versions": [] }, { "platformFamily": "c8000aes", "versions": [] }, { "platformFamily": "isr4400", "versions": [] }, { "platformFamily": "c8000aep", "versions": [] }, { "platformFamily": "Teleworker", "versions": [] }, { "platformFamily": "asr1001x", "versions": [] }, { "platformFamily": "asr1000", "versions": [] }, { "platformFamily": "c1100", "versions": [] }, { "platformFamily": "isr4200", "versions": [ { "versionId": "a6a9ce11-e23d-4c88-88f4-e166b69e1493", "version": "17.09.01.0.155356.1646904830", "versionType": "vmanage" } ] }, { "platformFamily": "c8000be", "versions": [] }, { "platformFamily": "isr4300", "versions": [] }, { "platformFamily": "isr1100be", "versions": [] }, { "platformFamily": "asr1000rpx86", "versions": [] }, { "platformFamily": "ir1800", "versions": [] }, { "platformFamily": "isrv", "versions": [ { "versionId": "56ffdd15-414d-4d8a-b76a-8b242e8983d0", "version": "17.09.01.0.153019.1643527674" } ] }, { "platformFamily": "c8000v", "versions": [ { "versionId": "56ffdd15-414d-4d8a-b76a-8b242e8983d0", "version": "17.09.01.0.153019.1643527674" } ] }, { "platformFamily": "cg", "versions": [] }, { "platformFamily": "vedge-x86", "versions": [] }, { "platformFamily": "csr1000v", "versions": [ { "versionId": "56ffdd15-414d-4d8a-b76a-8b242e8983d0", "version": "17.09.01.0.153019.1643527674" } ] }, { "platformFamily": "asr1002x", "versions": [] }, { "platformFamily": "isr4400v2", "versions": [] }, { "platformFamily": "c6300", "versions": [] }, { "platformFamily": "ir8340", "versions": [] }, { "platformFamily": "ir8100", "versions": [] } ] }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceactionInstallpackageurlapiResponseExampleZtpversion" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/device/action/software/{versionId}": { "delete": { "tags": [ "Configuration - Software Actions" ], "description": "Delete software image URL", "operationId": "deleteImageURL", "parameters": [ { "name": "versionId", "in": "path", "description": "Version", "required": true, "schema": { "type": "string" }, "example": "08d56e2f-10ee-452d-bd41-c375915cf7d7" } ], "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "Configuration - Software Actions" ], "description": "Update software image URL", "operationId": "updateImageURL", "parameters": [ { "name": "versionId", "in": "path", "description": "Version", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Update software image request payload", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Update software image request": { "description": "Update software image request", "value": {} } } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true, "x-roles-required": "admin,Software Upgrade-write,Software Upgrade > Edge-write,Software Upgrade > Controller-write" } }, "/device/action/startmonitor": { "get": { "tags": [ "Configuration - Device Actions" ], "description": "Triggers global monitoring thread", "operationId": "triggerPendingTasksMonitoring", "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Software Upgrade-read,Software Upgrade-write,Software Upgrade > Edge-write,Software Upgrade > Edge-read,Software Upgrade > Controller-write,Software Upgrade > Controller-read" } }, "/device/action/status/cancel/{processId}": { "post": { "tags": [ "Configuration - Dashboard Status" ], "description": "Bulk cancel task status", "operationId": "cancelPendingTasks", "parameters": [ { "name": "processId", "in": "path", "description": "Process Id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/device/action/status/clean": { "get": { "tags": [ "Configuration - Dashboard Status" ], "description": "Delete task and status vertex", "operationId": "cleanStatus", "parameters": [ { "name": "cleanStatus", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true } }, "/device/action/status/clear": { "delete": { "tags": [ "Configuration - Dashboard Status" ], "description": "Delete status of action", "operationId": "deleteStatus", "parameters": [ { "name": "processId", "in": "query", "description": "Process Id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/device/action/status/mw": { "get": { "tags": [ "Configuration - Maintenance window flag" ], "description": "Get status of maintenance window for vManage upgrade flag", "operationId": "getMaintenanceWindowFlag", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Get maintenance window flag": { "description": "Get maintenance window flag", "value": { "mw": true } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Configuration - Maintenance window flag" ], "description": "Update maintenance window flag", "operationId": "updateMaintenanceWindowFlag", "requestBody": { "description": "Update maintenance window flag", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Update maintenance window flag": { "description": "Update maintenance window flag", "value": { "mw": true } } } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/device/action/status/tasks": { "get": { "tags": [ "Configuration - Dashboard Status" ], "description": "Find running tasks", "operationId": "findRunningTasks", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "description": "data list", "example": [ "MEGAPORT", "EQUINIX", "ATT" ], "items": { "type": "string", "description": "data", "example": "MEGAPORT" } } }, "$$ref": "#/components/schemas/InlineResponse200" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/device/action/status/tasks/activeCount": { "get": { "tags": [ "Configuration - Dashboard Status" ], "description": "Get active task count", "operationId": "getActiveTaskCount", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "tasks": { "type": "string", "example": "123" } }, "description": "List of tasks", "$$ref": "#/components/schemas/DeviceTaskStatus" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/device/action/status/tasks/clean": { "get": { "tags": [ "Configuration - Dashboard Status" ], "description": "Delete task and status vertex", "operationId": "getCleanStatus", "parameters": [ { "name": "processId", "in": "query", "description": "Process Id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "tasks": { "type": "string", "example": "123" } }, "description": "List of tasks", "$$ref": "#/components/schemas/DeviceTaskStatus" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/device/action/status/{processId}": { "get": { "tags": [ "Configuration - Dashboard Status" ], "description": "Find status of action", "operationId": "findStatus", "parameters": [ { "name": "processId", "in": "path", "description": "processId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "tasks": { "type": "string", "example": "123" } }, "description": "List of tasks", "$$ref": "#/components/schemas/DeviceTaskStatus" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/device/action/test/ioxconfig/{deviceIP}": { "get": { "tags": [ "Configuration - Device Actions" ], "description": "testIoxConfig", "operationId": "testIoxConfig", "parameters": [ { "name": "deviceIP", "in": "path", "description": "Device IP", "required": true, "schema": { "type": "object", "properties": { "deviceIp": { "type": "string" } }, "description": "This is the valid DeviceIP", "$$ref": "#/components/schemas/DeviceIP" } } ], "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true, "x-roles-required": "Software Upgrade-read,Software Upgrade-write,Software Upgrade > Edge-write,Software Upgrade > Edge-read,Software Upgrade > Controller-write,Software Upgrade > Controller-read" } }, "/device/action/uniquevpnlist": { "post": { "tags": [ "Configuration - Device Actions" ], "description": "Create unique VPN list", "operationId": "createUniqueVPNList", "requestBody": { "description": "Device IPs", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Device IPs": { "description": "Device IPs", "value": { "deviceId": [ "172.16.255.14" ] }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceactionDeviceactionapiRequestExampleUniquevpnlistreq" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "Example": { "description": "Example", "value": { "vedge": [ 512, 0, 65528, 65529 ], "vsmart": [] }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceactionDeviceactionapiResponseExampleUniquevpnlistresp" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Software Upgrade-read,Software Upgrade > Edge-read,Software Upgrade > Controller-read" } }, "/device/action/vnfinstall": { "post": { "tags": [ "Configuration - Device Actions" ], "description": "Process an installation operation", "operationId": "processVnfInstall", "requestBody": { "description": "Installation request payload", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Installation Operation": { "description": "Installation Operation", "value": {} } } } }, "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": "Software Upgrade-write,Software Upgrade > Edge-write,Software Upgrade > Controller-write" } }, "/device/action/vpn": { "get": { "tags": [ "Configuration - Device Actions" ], "description": "Create VPN list", "operationId": "createVPNList", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "vedge": { "type": "array", "items": { "type": "string" } }, "vsmart": { "type": "array", "items": { "type": "string" } } }, "$$ref": "#/components/schemas/CreateVPNList" }, "examples": { "Example": { "description": "Example", "value": { "vedge": [ "0", "1", "512", "65528", "65530" ], "vsmart": [ "0", "512" ] }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceactionDeviceactionapiResponseExampleVpnresp" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" } }, "/device/action/ztp/upgrade": { "get": { "tags": [ "Configuration - Device Actions" ], "description": "Get ZTP upgrade configuration", "operationId": "getZTPUpgradeConfig", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Example Value": { "description": "Example Value", "value": { "0": { "versionId": "-", "platformFamily": "ir1101", "enableUpgrade": false, "versionName": "" } }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceactionDeviceactionapiResponseExampleGetztpupgraderesp" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Configuration - Device Actions" ], "description": "Process ZTP upgrade configuration setting", "operationId": "postprocessZTPUpgradeConfigSetting", "requestBody": { "description": "Request body for ZTP upgrade configuration setting", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Example Value": { "description": "Example Value", "value": { "data": [ { "enableUpgrade": false, "platformFamily": "ir1101" }, { "enableUpgrade": false, "platformFamily": "vedge-mips" }, { "enableUpgrade": false, "platformFamily": "c8000aes" }, { "enableUpgrade": false, "platformFamily": "isr4400" }, { "enableUpgrade": false, "platformFamily": "c8000aep" }, { "enableUpgrade": false, "platformFamily": "Teleworker" }, { "enableUpgrade": false, "platformFamily": "asr1001x" } ] }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceactionDeviceactionapiRequestExamplePostztpupgradereq" } } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/device/action/ztp/upgrade/setting": { "post": { "tags": [ "Configuration - Device Actions" ], "description": "Process ZTP upgrade configuration setting", "operationId": "processZTPUpgradeConfigSetting", "requestBody": { "description": "Request body for ZTP upgrade configuration setting", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Example Value": { "description": "Example Value", "value": { "data": [ { "enableUpgrade": false, "platformFamily": "ir1101" }, { "enableUpgrade": false, "platformFamily": "vedge-mips" }, { "enableUpgrade": false, "platformFamily": "c8000aes" }, { "enableUpgrade": false, "platformFamily": "isr4400" }, { "enableUpgrade": false, "platformFamily": "c8000aep" }, { "enableUpgrade": false, "platformFamily": "Teleworker" }, { "enableUpgrade": false, "platformFamily": "asr1001x" } ] }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceactionDeviceactionapiRequestExamplePostztpupgradesettingreq" } } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "Configuration - Device Actions" ], "description": "Get ZTP upgrade configuration setting", "operationId": "getZTPUpgradeConfigSetting", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Example Value": { "description": "Example Value", "value": { "0": { "versionId": "-", "platformFamily": "ir1101", "enableUpgrade": false, "versionName": "" } }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceactionDeviceactionapiResponseExampleGetztpupgraderesp" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/device/autonomousversion": { "get": { "tags": [ "developers" ], "summary": "Get Software version from device", "description": "Get Software version from device", "operationId": "getAutonomousSoftwareVersion", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string" }, "example": "172.16.255.15" } ], "responses": { "200": { "description": "Software version from device", "content": { "application/json": { "schema": { "required": [ "activeVersion", "lastupdated", "vdevice-dataKey", "vdevice-host-name", "vdevice-name" ], "type": "object", "properties": { "activeVersion": { "type": "string", "example": "17.12.01.0.169449" }, "lastupdated": { "type": "number", "example": 1674025491478 }, "vdevice-dataKey": { "type": "string", "example": "172.16.255.11-" }, "vdevice-host-name": { "type": "string", "example": "vm1" }, "vdevice-name": { "type": "string", "example": "172.16.255.11" } }, "$$ref": "#/components/schemas/SoftwareVersion" }, "examples": { "Example": { "description": "Example", "value": "vdevice-dataKey:\"172.16.255.11-\" activeVersion:\"17.12.01.0.169449\" vdevice-host-name:\"vm1\" lastupdated:1674025491478 vdevice-name:\"172.16.255.11\"", "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceSoftwareAutonomoussoftwareapiResponseExampleGetautonomousversion" } } } } }, "400": { "description": "Bad Request" } } } }, "/device/bytenants": { "get": { "tags": [ "Compliance - Device Details" ], "description": "Gets devices and sites for all tenants", "operationId": "getTenantsDevicesAndSites", "parameters": [ { "name": "tenant", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "default": { "description": "default response", "content": { "application/json": {} } } }, "x-roles-required": "Device Monitoring-read" } }, "/device/cellular/counter": { "get": { "tags": [ "Overview - Cellular" ], "description": "Cellular count dashlet", "operationId": "cellularCountDashlet", "parameters": [ { "name": "type", "in": "query", "description": "type", "schema": { "type": "string", "enum": [ "rat", "product", "carrier" ] } }, { "name": "lastNHours", "in": "query", "description": "last N Hours", "schema": { "type": "string", "enum": [ "1", "3", "6", "12", "24" ] } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "active": { "type": "integer", "format": "int32", "example": 1 }, "carrier": { "type": "string", "example": "ATT" }, "product": { "type": "string", "example": "NIMs" }, "rat": { "type": "string", "example": "4G" }, "standby": { "type": "integer", "format": "int32", "example": 2 } }, "$$ref": "#/components/schemas/CellularCount" } }, "examples": { "count by rat": { "description": "count by rat", "value": [ { "rat": "4G", "standby": 0, "active": 2 } ], "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceCellularCellularrestfulresourceResponseExampleCellularcountbyrat" }, "count by carrier": { "description": "count by carrier", "value": [ { "carrier": "ATT", "standby": 0, "active": 1 }, { "carrier": "Verizon", "standby": 0, "active": 1 } ], "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceCellularCellularrestfulresourceResponseExampleCellularcountbycarrier" }, "count by product": { "description": "count by product", "value": [ { "product": "Network Interface Modules (NIMs)", "standby": 0, "active": 2 } ], "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceCellularCellularrestfulresourceResponseExampleCellularcountbyproduct" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read,Device Monitoring-write" } }, "/device/cellular/dataUsage": { "get": { "tags": [ "Overview - Cellular" ], "description": "Cellular DataUsage Dashlet", "operationId": "dataUsage", "parameters": [ { "name": "lastNHours", "in": "query", "description": "last N hours", "schema": { "type": "string", "enum": [ "1", "3", "6", "12", "24" ] } }, { "name": "drillDown", "in": "query", "description": "drill down", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "CARRIER_NAME": { "type": "object", "properties": { "carrierName": { "type": "string", "example": "Verizon" }, "deviceList": { "type": "array", "items": { "type": "object", "properties": { "activeSim": { "type": "string", "example": "0" }, "carrier": { "type": "string", "example": "vedge" }, "deviceType": { "type": "string", "example": "vedge" }, "hostName": { "type": "string", "example": "vedge" }, "ifName": { "type": "string", "example": "vedge" }, "linkUpTime": { "type": "string", "example": "0" }, "localSystemIp": { "type": "string", "example": "0" }, "model": { "type": "string", "example": "vedge" }, "product": { "type": "string", "example": "0" }, "rat": { "type": "string", "example": "vedge" }, "slot": { "type": "string", "example": "0" }, "systemIp": { "type": "string", "example": "0" }, "totalKbs": { "type": "integer", "format": "int32", "example": 0 }, "uuid": { "type": "string", "example": "vedge" } }, "$$ref": "#/components/schemas/CellularDeviceDetail" } }, "monthUsage": { "type": "object", "properties": { "carrierName": { "type": "string", "example": "Verizon" }, "deviceList": { "type": "array", "items": { "type": "object", "properties": { "activeSim": { "type": "string", "example": "0" }, "carrier": { "type": "string", "example": "vedge" }, "deviceType": { "type": "string", "example": "vedge" }, "hostName": { "type": "string", "example": "vedge" }, "ifName": { "type": "string", "example": "vedge" }, "linkUpTime": { "type": "string", "example": "0" }, "localSystemIp": { "type": "string", "example": "0" }, "model": { "type": "string", "example": "vedge" }, "product": { "type": "string", "example": "0" }, "rat": { "type": "string", "example": "vedge" }, "slot": { "type": "string", "example": "0" }, "systemIp": { "type": "string", "example": "0" }, "totalKbs": { "type": "integer", "format": "int32", "example": 0 }, "uuid": { "type": "string", "example": "vedge" } }, "$$ref": "#/components/schemas/CellularDeviceDetail" } }, "totalUsage": { "type": "integer", "format": "int32", "example": 2262628 } }, "$$ref": "#/components/schemas/CellularDataUsageDetailsItem" }, "oneDayUsage": { "type": "object", "properties": { "carrierName": { "type": "string", "example": "Verizon" }, "deviceList": { "type": "array", "items": { "type": "object", "properties": { "activeSim": { "type": "string", "example": "0" }, "carrier": { "type": "string", "example": "vedge" }, "deviceType": { "type": "string", "example": "vedge" }, "hostName": { "type": "string", "example": "vedge" }, "ifName": { "type": "string", "example": "vedge" }, "linkUpTime": { "type": "string", "example": "0" }, "localSystemIp": { "type": "string", "example": "0" }, "model": { "type": "string", "example": "vedge" }, "product": { "type": "string", "example": "0" }, "rat": { "type": "string", "example": "vedge" }, "slot": { "type": "string", "example": "0" }, "systemIp": { "type": "string", "example": "0" }, "totalKbs": { "type": "integer", "format": "int32", "example": 0 }, "uuid": { "type": "string", "example": "vedge" } }, "$$ref": "#/components/schemas/CellularDeviceDetail" } }, "totalUsage": { "type": "integer", "format": "int32", "example": 2262628 } }, "$$ref": "#/components/schemas/CellularDataUsageDetailsItem" }, "threeMonthUsage": { "type": "object", "properties": { "carrierName": { "type": "string", "example": "Verizon" }, "deviceList": { "type": "array", "items": { "type": "object", "properties": { "activeSim": { "type": "string", "example": "0" }, "carrier": { "type": "string", "example": "vedge" }, "deviceType": { "type": "string", "example": "vedge" }, "hostName": { "type": "string", "example": "vedge" }, "ifName": { "type": "string", "example": "vedge" }, "linkUpTime": { "type": "string", "example": "0" }, "localSystemIp": { "type": "string", "example": "0" }, "model": { "type": "string", "example": "vedge" }, "product": { "type": "string", "example": "0" }, "rat": { "type": "string", "example": "vedge" }, "slot": { "type": "string", "example": "0" }, "systemIp": { "type": "string", "example": "0" }, "totalKbs": { "type": "integer", "format": "int32", "example": 0 }, "uuid": { "type": "string", "example": "vedge" } }, "$$ref": "#/components/schemas/CellularDeviceDetail" } }, "totalUsage": { "type": "integer", "format": "int32", "example": 2262628 } }, "$$ref": "#/components/schemas/CellularDataUsageDetailsItem" }, "totalUsage": { "type": "integer", "format": "int32", "example": 2262627 }, "weekUsage": { "type": "object", "properties": { "carrierName": { "type": "string", "example": "Verizon" }, "deviceList": { "type": "array", "items": { "type": "object", "properties": { "activeSim": { "type": "string", "example": "0" }, "carrier": { "type": "string", "example": "vedge" }, "deviceType": { "type": "string", "example": "vedge" }, "hostName": { "type": "string", "example": "vedge" }, "ifName": { "type": "string", "example": "vedge" }, "linkUpTime": { "type": "string", "example": "0" }, "localSystemIp": { "type": "string", "example": "0" }, "model": { "type": "string", "example": "vedge" }, "product": { "type": "string", "example": "0" }, "rat": { "type": "string", "example": "vedge" }, "slot": { "type": "string", "example": "0" }, "systemIp": { "type": "string", "example": "0" }, "totalKbs": { "type": "integer", "format": "int32", "example": 0 }, "uuid": { "type": "string", "example": "vedge" } }, "$$ref": "#/components/schemas/CellularDeviceDetail" } }, "totalUsage": { "type": "integer", "format": "int32", "example": 2262628 } }, "$$ref": "#/components/schemas/CellularDataUsageDetailsItem" } }, "$$ref": "#/components/schemas/CellularDataUsageDetails" }, "details": { "type": "array", "items": { "type": "object", "properties": { "carrierName": { "type": "string", "example": "Verizon" }, "totalUsage": { "type": "integer", "format": "int32", "example": 2262627 } }, "$$ref": "#/components/schemas/CellularDataUsageBasicItem" } } }, "$$ref": "#/components/schemas/CellularDataUsage" } }, "examples": { "Cellular dataUsage basic": { "description": "Cellular dataUsage basic", "value": { "details": [ { "carrierName": "ATT", "totalUsage": 0 }, { "carrierName": "Verizon", "totalUsage": 60 } ] }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceCellularCellularrestfulresourceResponseExampleCellulardatausagebasic" }, "Cellular dataUsage detail": { "description": "Cellular dataUsage detail", "value": { "ATT": { "monthUsage": { "carrierName": "ATT", "deviceList": [ { "deviceType": "vedge", "activeSim": "0", "hostName": "C8300-Vivek1-Slot1", "product": "Network Interface Modules (NIMs)", "rat": "4G", "linkUpTime": "4679", "ifName": "Cellular0/1/0", "slot": "1", "uuid": "C8300-1N1S-6T-FDO2402A01W", "totalKbs": 0, "carrier": "ATT", "localSystemIp": "1.1.1.218", "model": "C8300-1N1S-6T", "systemIp": "1.1.1.218" } ], "totalUsage": 0 }, "carrierName": "ATT", "weekUsage": { "carrierName": "ATT", "deviceList": [ { "deviceType": "vedge", "activeSim": "0", "hostName": "C8300-Vivek1-Slot1", "product": "Network Interface Modules (NIMs)", "rat": "4G", "linkUpTime": "4679", "ifName": "Cellular0/1/0", "slot": "1", "uuid": "C8300-1N1S-6T-FDO2402A01W", "totalKbs": 0, "carrier": "ATT", "localSystemIp": "1.1.1.218", "model": "C8300-1N1S-6T", "systemIp": "1.1.1.218" } ], "totalUsage": 0 }, "deviceList": [ { "deviceType": "vedge", "activeSim": "0", "hostName": "C8300-Vivek1-Slot1", "product": "Network Interface Modules (NIMs)", "rat": "4G", "linkUpTime": "4679", "ifName": "Cellular0/1/0", "slot": "1", "uuid": "C8300-1N1S-6T-FDO2402A01W", "totalKbs": 0, "carrier": "ATT", "localSystemIp": "1.1.1.218", "model": "C8300-1N1S-6T", "systemIp": "1.1.1.218" } ], "oneDayUsage": { "carrierName": "ATT", "deviceList": [ { "deviceType": "vedge", "activeSim": "0", "hostName": "C8300-Vivek1-Slot1", "product": "Network Interface Modules (NIMs)", "rat": "4G", "linkUpTime": "4679", "ifName": "Cellular0/1/0", "slot": "1", "uuid": "C8300-1N1S-6T-FDO2402A01W", "totalKbs": 0, "carrier": "ATT", "localSystemIp": "1.1.1.218", "model": "C8300-1N1S-6T", "systemIp": "1.1.1.218" } ], "totalUsage": 0 }, "totalUsage": 0, "threeMonthUsage": { "carrierName": "ATT", "deviceList": [ { "deviceType": "vedge", "activeSim": "0", "hostName": "C8300-Vivek1-Slot1", "product": "Network Interface Modules (NIMs)", "rat": "4G", "linkUpTime": "4679", "ifName": "Cellular0/1/0", "slot": "1", "uuid": "C8300-1N1S-6T-FDO2402A01W", "totalKbs": 0, "carrier": "ATT", "localSystemIp": "1.1.1.218", "model": "C8300-1N1S-6T", "systemIp": "1.1.1.218" } ], "totalUsage": 0 } }, "Verizon": { "monthUsage": { "carrierName": "Verizon", "deviceList": [ { "deviceType": "vedge", "activeSim": "0", "hostName": "C8300-Vivek1-Slot2", "product": "Network Interface Modules (NIMs)", "rat": "4G", "linkUpTime": "9530", "ifName": "Cellular0/2/0", "slot": "2", "uuid": "C8300-1N1S-6T-FDO2402A01W", "totalKbs": 65811, "carrier": "Verizon", "localSystemIp": "1.1.1.218", "model": "C8300-1N1S-6T", "systemIp": "1.1.1.218" } ], "totalUsage": 65811 }, "carrierName": "Verizon", "weekUsage": { "carrierName": "Verizon", "deviceList": [ { "deviceType": "vedge", "activeSim": "0", "hostName": "C8300-Vivek1-Slot2", "product": "Network Interface Modules (NIMs)", "rat": "4G", "linkUpTime": "9530", "ifName": "Cellular0/2/0", "slot": "2", "uuid": "C8300-1N1S-6T-FDO2402A01W", "totalKbs": 15244, "carrier": "Verizon", "localSystemIp": "1.1.1.218", "model": "C8300-1N1S-6T", "systemIp": "1.1.1.218" } ], "totalUsage": 15244 }, "deviceList": [ { "deviceType": "vedge", "activeSim": "0", "hostName": "C8300-Vivek1-Slot2", "product": "Network Interface Modules (NIMs)", "rat": "4G", "linkUpTime": "14210", "ifName": "Cellular0/2/0", "slot": "2", "uuid": "C8300-1N1S-6T-FDO2402A01W", "totalKbs": 62, "carrier": "Verizon", "localSystemIp": "1.1.1.218", "model": "C8300-1N1S-6T", "systemIp": "1.1.1.218" } ], "oneDayUsage": { "carrierName": "Verizon", "deviceList": [ { "deviceType": "vedge", "activeSim": "0", "hostName": "C8300-Vivek1-Slot2", "product": "Network Interface Modules (NIMs)", "rat": "4G", "linkUpTime": "14210", "ifName": "Cellular0/2/0", "slot": "2", "uuid": "C8300-1N1S-6T-FDO2402A01W", "totalKbs": 1855, "carrier": "Verizon", "localSystemIp": "1.1.1.218", "model": "C8300-1N1S-6T", "systemIp": "1.1.1.218" } ], "totalUsage": 1855 }, "totalUsage": 62, "threeMonthUsage": { "carrierName": "Verizon", "deviceList": [ { "deviceType": "vedge", "activeSim": "0", "hostName": "C8300-Vivek1-Slot2", "product": "Network Interface Modules (NIMs)", "rat": "4G", "linkUpTime": "9530", "ifName": "Cellular0/2/0", "slot": "2", "uuid": "C8300-1N1S-6T-FDO2402A01W", "totalKbs": 187349, "carrier": "Verizon", "localSystemIp": "1.1.1.218", "model": "C8300-1N1S-6T", "systemIp": "1.1.1.218" } ], "totalUsage": 187349 } } }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceCellularCellularrestfulresourceResponseExampleCellulardatausagedrilldown" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read,Device Monitoring-write" } }, "/device/cellular/details": { "get": { "tags": [ "Overview - Cellular" ], "description": "Cellular count dashlet details", "operationId": "cellularCountDashletDetails", "parameters": [ { "name": "lastNHours", "in": "query", "description": "last N hours", "schema": { "type": "string", "enum": [ "1", "3", "6", "12", "24" ] } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "pageInfo": { "type": "object", "properties": { "details": { "type": "array", "items": { "type": "object", "properties": { "activeSim": { "type": "string", "example": "0" }, "carrier": { "type": "string", "example": "vedge" }, "deviceType": { "type": "string", "example": "vedge" }, "hostName": { "type": "string", "example": "vedge" }, "ifName": { "type": "string", "example": "vedge" }, "linkUpTime": { "type": "string", "example": "0" }, "localSystemIp": { "type": "string", "example": "0" }, "model": { "type": "string", "example": "vedge" }, "product": { "type": "string", "example": "0" }, "rat": { "type": "string", "example": "vedge" }, "slot": { "type": "string", "example": "0" }, "systemIp": { "type": "string", "example": "0" }, "totalKbs": { "type": "integer", "format": "int32", "example": 0 }, "uuid": { "type": "string", "example": "vedge" } }, "$$ref": "#/components/schemas/CellularDeviceDetail" } } }, "$$ref": "#/components/schemas/CellularPageInfo" } }, "$$ref": "#/components/schemas/CellularDetail" } }, "examples": { "Cellular details list": { "description": "Cellular details list", "value": { "pageInfo": { "details": [ { "deviceType": "vedge", "hostName": "C8300-Vivek1-Slot2", "activeSim": "0", "product": "Network Interface Modules (NIMs)", "rat": "4G", "linkUpTime": "14453", "ifName": "Cellular0/2/0", "slot": "2", "uuid": "C8300-1N1S-6T-FDO2402A01W", "totalKbs": 74, "carrier": "Verizon", "localSystemIp": "1.1.1.218", "model": "C8300-1N1S-6T", "systemIp": "1.1.1.218" }, { "deviceType": "vedge", "hostName": "C8300-Vivek1-Slot1", "activeSim": "0", "product": "Network Interface Modules (NIMs)", "rat": "4G", "linkUpTime": "4922", "ifName": "Cellular0/1/0", "slot": "1", "uuid": "C8300-1N1S-6T-FDO2402A01W", "totalKbs": 0, "carrier": "ATT", "localSystemIp": "1.1.1.218", "model": "C8300-1N1S-6T", "systemIp": "1.1.1.218" } ] } }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceCellularCellularrestfulresourceResponseExampleCellulardetails" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read,Device Monitoring-write" } }, "/device/cellular/health": { "get": { "tags": [ "Overview - Cellular" ], "description": "Cellular Health Dashlet", "operationId": "cellularHealthDashlet", "parameters": [ { "name": "type", "in": "query", "description": "type", "schema": { "type": "string", "enum": [ "rat", "carrier" ] } }, { "name": "lastNHours", "in": "query", "description": "last N hours", "schema": { "type": "string", "enum": [ "1", "3", "6", "12", "24" ] } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "carrier": { "type": "string", "example": "ATT" }, "excellent": { "type": "integer", "format": "int32", "example": 2 }, "fair": { "type": "integer", "format": "int32", "example": 1 }, "good": { "type": "integer", "format": "int32", "example": 3 }, "poor": { "type": "integer", "format": "int32", "example": 0 }, "rat": { "type": "string", "example": "4G" } }, "$$ref": "#/components/schemas/CellularHealth" } }, "examples": { "Carrier health": { "description": "Carrier health", "value": [ { "carrier": "ATT", "excellent": 0, "poor": 0, "fair": 1, "good": 0 }, { "carrier": "Verizon", "excellent": 0, "poor": 0, "fair": 0, "good": 1 } ], "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceCellularCellularrestfulresourceResponseExampleCellularhealthbycarrier" }, "Rat health": { "description": "Rat health", "value": [ { "rat": "LTE", "excellent": 0, "poor": 0, "fair": 1, "good": 1 } ], "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceCellularCellularrestfulresourceResponseExampleCellularhealthbyrat" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read,Device Monitoring-write" } }, "/device/compliance": { "get": { "tags": [ "Compliance - Device Details" ], "description": "Get compliance information for devices", "operationId": "getComplianceDetails", "parameters": [ { "name": "offset", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 25 } }, { "name": "deviceType", "in": "query", "description": "deviceType example: vedge", "schema": { "type": "array", "items": { "type": "string", "example": [ "vedge" ] } } }, { "name": "status", "in": "query", "schema": { "type": "array", "example": [ "RED" ], "items": { "type": "string", "example": [ "RED" ] } } }, { "name": "type", "in": "query", "schema": { "type": "array", "example": [ "vedge" ], "items": { "type": "string", "example": [ "vedge" ] } } }, { "name": "sort_by", "in": "query", "schema": { "type": "string" }, "example": "host-name" }, { "name": "order_by", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ] }, "example": "asc" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32", "example": 9 }, "devices": { "type": "array", "items": { "type": "object", "properties": { "checkList": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string", "example": "Device is LTS - 1" }, "status": { "type": "string", "example": "GREEN" }, "type": { "type": "string", "example": "SOFTWARE_COMPLIANCE_CHECK" } }, "$$ref": "#/components/schemas/DeviceCheckList" } }, "deviceDetails": { "type": "object", "properties": { "chassis-Number": { "type": "string", "example": "390b3f83-ffc2-4081-9881-4c41bc8665e8" }, "current-version": { "type": "string", "example": "20.12.1" }, "device-type": { "type": "string", "example": "vedge" }, "host-name": { "type": "string", "example": "vm1" }, "local-system-ip": { "type": "string", "example": "172.168.0.1" }, "personality": { "type": "string", "example": "vedge" }, "reachability": { "type": "string", "example": "reachable" }, "site-id": { "type": "string", "example": "500" }, "site-name": { "type": "string", "example": "SITE_500" }, "system-ip": { "type": "string", "example": "172.168.0.1" }, "uuid": { "type": "string", "example": "390b3f83-ffc2-4081-9881-4c41bc8665e8" } }, "$$ref": "#/components/schemas/DeviceApiDetails" }, "status": { "type": "string", "example": "GREEN" } }, "$$ref": "#/components/schemas/DeviceComplianceApiData" } } }, "$$ref": "#/components/schemas/DeviceComplianceApiResponse" }, "examples": { "Example": { "description": "Example", "value": { "count": 9, "devices": [ { "deviceDetails": { "local-system-ip": "172.168.0.1", "system-ip": "172.168.0.1", "site-id": "500", "site-name": "SITE_500", "host-name": "vm1", "uuid": "390b3f83-ffc2-4081-9881-4c41bc8665e8", "chassis-Number": "390b3f83-ffc2-4081-9881-4c41bc8665e8", "reachability": "reachable", "device-type": "vedge", "personality": "vedge", "current-version": "20.12.1" }, "checkList": [ { "type": "SOFTWARE_COMPLIANCE_CHECK", "status": "GREEN", "message": "Device is LTS - 1" } ], "status": "GREEN" } ] }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceCommonDeviceapiResponseExampleGetcompliance" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/device/compliance/summary": { "get": { "tags": [ "Compliance - Device Details" ], "description": "Get compliance summary for devices", "operationId": "getComplianceSummary", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "checkList": { "type": "array", "items": { "type": "object", "properties": { "controllerCount": { "type": "integer", "format": "int32", "example": 3 }, "type": { "type": "string", "example": "SOFTWARE_COMPLIANCE_CHECK" }, "vEdgeCount": { "type": "integer", "format": "int32", "example": 2 } }, "$$ref": "#/components/schemas/DeviceComplianceCheckListData" } } }, "$$ref": "#/components/schemas/DeviceComplianceSummaryResponse" }, "examples": { "Example": { "description": "Example", "value": { "checkList": [ { "type": "SOFTWARE_COMPLIANCE_CHECK", "controllerCount": 3, "vEdgeCount": 2 } ] }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceCommonDeviceapiResponseExampleGetcompliancesummary" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/device/downloadedImages": { "get": { "tags": [ "Configuration - Downloaded Images" ], "description": "Get images list from device", "operationId": "createSoftwareList", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "Software list": { "description": "Software list", "value": { "data": [ { "vdevice-dataKey": "169.254.10.10-", "vdevice-name": "169.254.10.10", "lastupdated": 1644801887912, "downloadedImages": [], "vdevice-host-name": "vm3" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write" } }, "/device/file-based/data-collection/all-statuses/{deviceUUID}": { "get": { "tags": [ "File based RealTime Data Collection - Get Data Collection status for Device UUID" ], "description": "Get Data Collection status for given Device UUID", "operationId": "getDataCollectionStatusForDevice", "parameters": [ { "name": "deviceUUID", "in": "path", "description": "Device UUID", "required": true, "schema": { "type": "string" }, "example": "C8K-5e87e5c3-0923-4364-a729-d65d40298d76" } ], "responses": { "200": { "description": "All data collection statuses for given device", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "All data collection statuses for given device": { "description": "All data collection statuses for given device", "value": [ { "deviceUUID": "C8K-10a453ab-e30b-4476-aa98-bc5ded7298ee", "deviceSystemIP": "172.16.255.15", "collectionSubStatus": "file-downloaded-to-vmanage", "statsCommand": "advertised-routes", "requestEndTime": 1661066092631, "requestUUID": "5fe0ec18-6da3-471f-aad7-03fc94b08a83", "requestStartTime": "1661065501749", "requestedFileFormat": "csv-file", "detailedMessage": "Successfully downloaded file from device", "collectionMainStatus": "success", "lastStateChangedTime": 1661066092544, "stateChangeLogs": [ { "changeTime": 1661066092544, "detailedMessage": "Successfully downloaded file from device", "state": "file-downloaded-to-vmanage" }, { "changeTime": 1661066087249, "detailedMessage": "Published to destination vManage for Downloading generated file", "state": "publised-for-file-download" }, { "changeTime": 1661066087031, "detailedMessage": "Device generated file", "state": "file-generated" }, { "changeTime": 1661065506807, "detailedMessage": "RPC sent to Device for file generation", "state": "device-notified" }, { "changeTime": 1661065501797, "detailedMessage": "Published to destination vManage for sending RPC request", "state": "publised-for-rpc-request" } ] }, { "deviceUUID": "C8K-10a453ab-e30b-4476-aa98-bc5ded7298ee", "deviceSystemIP": "172.16.255.15", "collectionSubStatus": "file-downloaded-to-vmanage", "statsCommand": "advertised-routes", "requestEndTime": 1661066092631, "requestUUID": "893456sdf-6da3-471f-aad7-03fc94b08a83", "requestStartTime": "16610656756789", "requestedFileFormat": "json-file", "detailedMessage": "Successfully downloaded file from device", "collectionMainStatus": "success", "lastStateChangedTime": 1661066092544, "stateChangeLogs": [ { "changeTime": 1661066092544, "detailedMessage": "Successfully downloaded file from device", "state": "file-downloaded-to-vmanage" }, { "changeTime": 1661066087249, "detailedMessage": "Published to destination vManage for Downloading generated file", "state": "publised-for-file-download" }, { "changeTime": 1661066087031, "detailedMessage": "Device generated file", "state": "file-generated" }, { "changeTime": 1661065506807, "detailedMessage": "RPC sent to Device for file generation", "state": "device-notified" }, { "changeTime": 1661065501797, "detailedMessage": "Published to destination vManage for sending RPC request", "state": "publised-for-rpc-request" } ] } ], "$$ref": "#/components/examples/ComViptelaVmanageServerFilebasedRealtimeDatacollectionDatacollectionapiResponseExampleAllstatuses200" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "errorMessage": { "type": "string", "description": "Message about bad request or parameters errors" }, "errorType": { "type": "string", "description": "Type of error" }, "operation": { "type": "string", "description": "Operation title" } }, "$$ref": "#/components/schemas/HttpError" }, "examples": { "400 - Bad Request or Parameters": { "description": "400 - Bad Request or Parameters", "value": { "operation": "Initiate file generation", "errorType": "Invalid Payload or Parameter(s)", "errorMessage": "Empty/Invalid Device IP" }, "$$ref": "#/components/examples/ComViptelaVmanageServerFilebasedRealtimeDatacollectionDatacollectionapiResponseExampleAllstatuses400" } } } } }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "errorMessage": { "type": "string", "description": "Message about bad request or parameters errors" }, "errorType": { "type": "string", "description": "Type of error" }, "operation": { "type": "string", "description": "Operation title" } }, "$$ref": "#/components/schemas/HttpError" }, "examples": { "500 - Internal Server Error": { "description": "500 - Internal Server Error", "value": { "operation": "Download generated file for UUID : b81467bb-9827-46a0-8db8-f742d4d91c0a", "errorType": "General or Internal Error", "errorMessage": "Data Collection state is in-progress, Cannot download file at this moment" }, "$$ref": "#/components/examples/ComViptelaVmanageServerFilebasedRealtimeDatacollectionDatacollectionapiResponseExampleAllstatuses500" } } } } } }, "x-roles-required": "System-read,System-write" } }, "/device/file-based/data-collection/download/{requestUUID}": { "get": { "tags": [ "File based RealTime Data Collection - Download Generated File" ], "description": "Download generated file", "operationId": "downloadGeneratedFile", "parameters": [ { "name": "requestUUID", "in": "path", "description": "request UUID", "required": true, "schema": { "type": "string" }, "example": "c04aadac-6efb-4cfd-8cbd-0fc47e00e931" } ], "responses": { "200": { "description": "Generates file" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "errorMessage": { "type": "string", "description": "Message about bad request or parameters errors" }, "errorType": { "type": "string", "description": "Type of error" }, "operation": { "type": "string", "description": "Operation title" } }, "$$ref": "#/components/schemas/HttpError" }, "examples": { "400 - Bad Requests": { "description": "400 - Bad Requests", "value": { "operation": "Inititate file generation", "errorType": "Invalid Payload or Parameter(s)", "errorMessage": "Empty/Invalid Device IP" }, "$$ref": "#/components/examples/ComViptelaVmanageServerFilebasedRealtimeDatacollectionDatacollectionapiResponseExampleDownload" } } } } }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "errorMessage": { "type": "string", "description": "Message about bad request or parameters errors" }, "errorType": { "type": "string", "description": "Type of error" }, "operation": { "type": "string", "description": "Operation title" } }, "$$ref": "#/components/schemas/HttpError" }, "examples": { "500 - Internal Server Error": { "description": "500 - Internal Server Error", "value": { "operation": "Download generated file for UUID : b81467bb-9827-46a0-8db8-f742d4d91c0a", "errorType": "General or Internal Error", "errorMessage": "Data Collection state is in-progress, Cannot download file at this moment" }, "$$ref": "#/components/examples/ComViptelaVmanageServerFilebasedRealtimeDatacollectionDatacollectionapiResponseExampleDownload500" } } } } } }, "x-roles-required": "System-read,System-write" } }, "/device/file-based/data-collection/file-generation-status": { "post": { "tags": [ "File based RealTime Data Collection - Device notification - File generation status" ], "description": "Device notify when file is ready and vManage has to download them", "operationId": "handleFileGenerationStatusResponseFromDevice", "requestBody": { "description": "File generation status notification payload", "content": { "application/json": { "schema": { "required": [ "detailedMessage", "status", "transactionId" ], "type": "object", "properties": { "checksum": { "type": "string", "description": "MD5 checksum value of the file" }, "detailedMessage": { "type": "string", "description": "Success or Failure reason in detail" }, "fileName": { "type": "string", "description": "Full path of the generated file" }, "status": { "type": "string" }, "transactionId": { "type": "string", "description": "Transaction Id sent in the file generation RPC" } }, "$$ref": "#/components/schemas/HandleFileGenerationStatusNotificationRequest" }, "examples": { "Successful file generation status payload": { "description": "Successful file generation status payload", "value": { "transactionId": "94e2a016-6b21-83d2-b6163c55ccd3%3cd2a8f8-8fce-63a6894ea555", "status": "success", "fileName": "/tmp/json/audit/audit_advertised_2022-09-19_13:54:34.csv", "checksum": "3534534563454532788799807", "detailedMessage": "Successfully generated file" }, "$$ref": "#/components/examples/ComViptelaVmanageServerFilebasedRealtimeDatacollectionDatacollectionapiRequestExampleFilegenerationsuccessreq" }, "Failed file generation status payload": { "description": "Failed file generation status payload", "value": { "transactionId": "94e2a016-6b21-83d2-b6163c55ccd3%3cd2a8f8-8fce-63a6894ea555", "status": "failed", "detailedMessage": "File generation failed due to no space left" }, "$$ref": "#/components/examples/ComViptelaVmanageServerFilebasedRealtimeDatacollectionDatacollectionapiRequestExampleFilegenerationfailurereq" } } } }, "required": true }, "responses": { "200": { "description": "File generation status accepted" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "errorMessage": { "type": "string", "description": "Message about bad request or parameters errors" }, "errorType": { "type": "string", "description": "Type of error" }, "operation": { "type": "string", "description": "Operation title" } }, "$$ref": "#/components/schemas/HttpError" }, "examples": { "400 - Bad Request or Parameters": { "description": "400 - Bad Request or Parameters", "value": { "operation": "Inititate file generation", "errorType": "Invalid Payload or Parameter(s)", "errorMessage": "Empty/Invalid Device IP" }, "$$ref": "#/components/examples/ComViptelaVmanageServerFilebasedRealtimeDatacollectionDatacollectionapiResponseExampleFilegeneration400" } } } } }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "errorMessage": { "type": "string", "description": "Message about bad request or parameters errors" }, "errorType": { "type": "string", "description": "Type of error" }, "operation": { "type": "string", "description": "Operation title" } }, "$$ref": "#/components/schemas/HttpError" }, "examples": { "500 - Internal Server Error": { "description": "500 - Internal Server Error", "value": { "operation": "Download generated file for UUID : b81467bb-9827-46a0-8db8-f742d4d91c0a", "errorType": "General or Internal Error", "errorMessage": "Data Collection state is in-progress, Cannot download file at this momemnt" }, "$$ref": "#/components/examples/ComViptelaVmanageServerFilebasedRealtimeDatacollectionDatacollectionapiResponseExampleFilegeneration500" } } } } } }, "x-roles-required": "vmanage-http-stream,System-read,System-write" } }, "/device/file-based/data-collection/initiate-file-generation": { "post": { "tags": [ "File based RealTime Data Collection - Initiate File Generation" ], "description": "Request device to prepare realtime collection data in required file format", "operationId": "initiateFileGenerationRequestToDevice", "requestBody": { "description": "Initiate file generation payload", "content": { "application/json": { "schema": { "required": [ "deviceUUID", "requestedFileFormat", "statsCommand" ], "type": "object", "properties": { "deviceUUID": { "type": "string", "description": "UUID of the device" }, "requestedFileFormat": { "type": "string" }, "statsCommand": { "type": "string" } }, "$$ref": "#/components/schemas/InitiateFileGenerationRequest" }, "examples": { "Initiate File Generation - OMP Routes Advertised in CSV Format": { "description": "Initiate File Generation - OMP Routes Advertised in CSV Format", "value": { "deviceUUID": "C8K-abf1808c-21c0-4612-a062-5afc29f8bc02", "statsCommand": "advertised-routes", "requestedFileFormat": "csv-file" }, "$$ref": "#/components/examples/ComViptelaVmanageServerFilebasedRealtimeDatacollectionDatacollectionapiRequestExampleInitiatefilegenerationcsv" }, "Initiate File Generation - OMP Routes Received in JSON Format": { "description": "Initiate File Generation - OMP Routes Received in JSON Format", "value": { "deviceUUID": "C8K-abf1808c-21c0-4612-a062-5afc29f8bc02", "statsCommand": "received-routes", "requestedFileFormat": "json-file" }, "$$ref": "#/components/examples/ComViptelaVmanageServerFilebasedRealtimeDatacollectionDatacollectionapiRequestExampleInitiatefilegenerationjson" } } } }, "required": true }, "responses": { "200": { "description": "Response for file generation request", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "Data Collection information": { "description": "Data Collection information", "value": { "deviceUUID": "C8K-abf1808c-21c0-4612-a062-5afc29f8bc02", "requestedFileFormat": "csv-file", "statsCommand": "advertised-routes", "uuid": "b81467bb-9827-46a0-8db8-f742d4d91c0a" }, "$$ref": "#/components/examples/ComViptelaVmanageServerFilebasedRealtimeDatacollectionDatacollectionapiResponseExampleInitiatefilegeneration200" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "errorMessage": { "type": "string", "description": "Message about bad request or parameters errors" }, "errorType": { "type": "string", "description": "Type of error" }, "operation": { "type": "string", "description": "Operation title" } }, "$$ref": "#/components/schemas/HttpError" }, "examples": { "400 - Bad Request or Parameters": { "description": "400 - Bad Request or Parameters", "value": { "operation": "Inititate file generation", "errorType": "Invalid Payload or Parameter(s)", "errorMessage": "Empty/Invalid Device IP" }, "$$ref": "#/components/examples/ComViptelaVmanageServerFilebasedRealtimeDatacollectionDatacollectionapiResponseExampleInitiatefilegeneration400" } } } } }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "errorMessage": { "type": "string", "description": "Message about bad request or parameters errors" }, "errorType": { "type": "string", "description": "Type of error" }, "operation": { "type": "string", "description": "Operation title" } }, "$$ref": "#/components/schemas/HttpError" }, "examples": { "500 - Internal Server Error": { "description": "500 - Internal Server Error", "value": { "operation": "Download generated file for UUID : b81467bb-9827-46a0-8db8-f742d4d91c0a", "errorType": "General or Internal Error", "errorMessage": "Data Collection state is in-progress, Cannot download file at this momemnt" }, "$$ref": "#/components/examples/ComViptelaVmanageServerFilebasedRealtimeDatacollectionDatacollectionapiResponseExampleInitiatefilegeneration500" } } } } } }, "x-roles-required": "System-read,System-write" } }, "/device/file-based/data-collection/status/{requestUUID}": { "get": { "tags": [ "File based RealTime Data Collection - Get Data Collection status for a Request UUID" ], "description": "Get Data Collection status for given Request UUID", "operationId": "getDataCollectionStatusForUUID", "parameters": [ { "name": "requestUUID", "in": "path", "description": "request UUID", "required": true, "schema": { "type": "string" }, "example": "c04aadac-6efb-4cfd-8cbd-0fc47e00e931" } ], "responses": { "200": { "description": "Data collection status for given UUID", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "Data collection status for given UUID": { "description": "Data collection status for given UUID", "value": { "deviceUUID": "C8K-10a453ab-e30b-4476-aa98-bc5ded7298ee", "deviceSystemIP": "172.16.255.15", "collectionSubStatus": "file-downloaded-to-vmanage", "statsCommand": "advertised-routes", "requestEndTime": 1661066092631, "requestUUID": "5fe0ec18-6da3-471f-aad7-03fc94b08a83", "requestStartTime": "1661065501749", "requestedFileFormat": "csv-file", "detailedMessage": "Successfully downloaded file from device", "collectionMainStatus": "success", "lastStateChangedTime": 1661066092544, "stateChangeLogs": [ { "changeTime": 1661066092544, "detailedMessage": "Successfully downloaded file from device", "state": "file-downloaded-to-vmanage" }, { "changeTime": 1661066087249, "detailedMessage": "Published to destination vManage for Downloading generated file", "state": "publised-for-file-download" }, { "changeTime": 1661066087031, "detailedMessage": "Device generated file", "state": "file-generated" }, { "changeTime": 1661065506807, "detailedMessage": "RPC sent to Device for file generation", "state": "device-notified" }, { "changeTime": 1661065501797, "detailedMessage": "Published to destination vManage for sending RPC request", "state": "publised-for-rpc-request" } ] }, "$$ref": "#/components/examples/ComViptelaVmanageServerFilebasedRealtimeDatacollectionDatacollectionapiResponseExampleStatus200" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "errorMessage": { "type": "string", "description": "Message about bad request or parameters errors" }, "errorType": { "type": "string", "description": "Type of error" }, "operation": { "type": "string", "description": "Operation title" } }, "$$ref": "#/components/schemas/HttpError" }, "examples": { "400 - Bad Request or Parameters": { "description": "400 - Bad Request or Parameters", "value": { "operation": "Initiate file generation", "errorType": "Invalid Payload or Parameter(s)", "errorMessage": "Empty/Invalid Device IP" }, "$$ref": "#/components/examples/ComViptelaVmanageServerFilebasedRealtimeDatacollectionDatacollectionapiResponseExampleStatus400" } } } } }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "errorMessage": { "type": "string", "description": "Message about bad request or parameters errors" }, "errorType": { "type": "string", "description": "Type of error" }, "operation": { "type": "string", "description": "Operation title" } }, "$$ref": "#/components/schemas/HttpError" }, "examples": { "500 - Internal Server Error": { "description": "500 - Internal Server Error", "value": { "operation": "Download generated file for UUID : b81467bb-9827-46a0-8db8-f742d4d91c0a", "errorType": "General or Internal Error", "errorMessage": "Data Collection state is in-progress, Cannot download file at this moment" }, "$$ref": "#/components/examples/ComViptelaVmanageServerFilebasedRealtimeDatacollectionDatacollectionapiResponseExampleStatus500" } } } } } }, "x-roles-required": "System-read,System-write" } }, "/device/file-based/data-collection/supported-commands/{deviceUUID}": { "get": { "tags": [ "File based RealTime Data Collection - Get Supported Commands List for a Device UUID" ], "description": "Get Supported Command list for given Device UUID", "operationId": "getSupportedCommandsList", "parameters": [ { "name": "deviceUUID", "in": "path", "description": "Device UUID", "required": true, "schema": { "type": "string" }, "example": "C8K-5e87e5c3-0923-4364-a729-d65d40298d76" } ], "responses": { "200": { "description": "Supported Command list for given Device", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "Response for Device with Supported Commands": { "description": "Response for Device with Supported Commands", "value": [ { "options": [ "csv-file", "json-file" ], "command": "OMP Advertised Routes" }, { "options": [ "csv-file", "json-file" ], "command": "OMP Received Routes" } ], "$$ref": "#/components/examples/ComViptelaVmanageServerFilebasedRealtimeDatacollectionDatacollectionapiResponseExampleSupportedCommands200" }, "Response for Device with No Supported Commands": { "description": "Response for Device with No Supported Commands", "value": {} } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "errorMessage": { "type": "string", "description": "Message about bad request or parameters errors" }, "errorType": { "type": "string", "description": "Type of error" }, "operation": { "type": "string", "description": "Operation title" } }, "$$ref": "#/components/schemas/HttpError" }, "examples": { "400 - Bad Request or Parameters": { "description": "400 - Bad Request or Parameters", "value": { "operation": "Initiate file generation", "errorType": "Invalid Payload or Parameter(s)", "errorMessage": "Empty/Invalid Device IP" }, "$$ref": "#/components/examples/ComViptelaVmanageServerFilebasedRealtimeDatacollectionDatacollectionapiResponseExampleSupportedCommands400" } } } } }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "errorMessage": { "type": "string", "description": "Message about bad request or parameters errors" }, "errorType": { "type": "string", "description": "Type of error" }, "operation": { "type": "string", "description": "Operation title" } }, "$$ref": "#/components/schemas/HttpError" }, "examples": { "500 - Internal Server Error": { "description": "500 - Internal Server Error", "value": { "operation": "Download generated file for UUID : b81467bb-9827-46a0-8db8-f742d4d91c0a", "errorType": "General or Internal Error", "errorMessage": "Data Collection state is in-progress, Cannot download file at this moment" }, "$$ref": "#/components/examples/ComViptelaVmanageServerFilebasedRealtimeDatacollectionDatacollectionapiResponseExampleSupportedCommands500" } } } } } }, "x-roles-required": "System-read,System-write" } }, "/device/history": { "get": { "tags": [ "Configuration - Device Config History" ], "description": "Get stats raw data", "operationId": "getStatDataRawData_ConfigurationDeviceConfigHistory_1503", "parameters": [ { "name": "query", "in": "query", "description": "Query string", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] }, "aggregation": { "metrics": [ { "property": "latency", "type": "avg" } ] } } }, { "name": "page", "in": "query", "description": "page number", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "pageSize", "in": "query", "description": "page size", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "sortBy", "in": "query", "description": "sort by(emp:entry_time)", "schema": { "pattern": "^[a-zA-Z-_]+$", "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "remote_color": "3g", "fec_re": 0, "vqoe_score": 10, "device_model": "vedge-cloud", "latency": 1, "tx_octets": 0, "dst_ip": "10.0.101.2", "local_color": "lte", "src_ip": "10.1.14.14", "sla_class_names": "None", "loss": 0, "total": 600, "tx_pkts": 0, "fec_tx": 0, "rx_octets": 0, "statcycletime": 1589075400056, "state": "Up", "local_system_ip": "172.16.255.14", "tenant": "default", "entry_time": 1589073792008, "loss_percentage": 0, "rx_pkts": 0, "vmanage_system_ip": "172.16.255.14", "fec_rx": 0, "src_port": 12380, "jitter": 1, "remote_system_ip": "172.16.255.11", "vdevice_name": "172.16.255.14", "proto": "IPSEC", "vip_idx": 190, "dst_port": 12366, "name": "172.16.255.14:lte-172.16.255.11:3g", "sla_class_list": "0", "tunnel_color": "3g:lte", "host_name": "vm4", "id": "4OBG_HEB_JLsavezVUfr" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" }, "post": { "tags": [ "Configuration - Device Config History" ], "description": "Get stats raw data", "operationId": "getStatsRawData_ConfigurationDeviceConfigHistory_1504", "parameters": [ { "name": "page", "in": "query", "description": "page number", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "pageSize", "in": "query", "description": "page size", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "sortBy", "in": "query", "description": "sort by", "schema": { "pattern": "^[a-zA-Z-_]+$", "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "sort order", "schema": { "type": "string" } } ], "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Stats query string": { "description": "Stats query string", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] }, "aggregation": { "field": [ { "property": "name", "sequence": 1 }, { "property": "proto", "sequence": 2 } ], "histogram": { "property": "entry_time", "type": "minute", "interval": 30, "order": "asc" }, "metrics": [ { "property": "latency", "type": "avg" }, { "property": "loss", "type": "avg" }, { "property": "loss_percentage", "type": "avg" }, { "property": "vqoe_score", "type": "avg" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "remote_color": "lte", "fec_re": 0, "vqoe_score": 10, "device_model": "vedge-cloud", "latency": 1, "tx_octets": 0, "dst_ip": "10.0.106.1", "local_color": "lte", "src_ip": "10.1.15.15", "sla_class_names": "test_sla_class", "loss": 0, "total": 600, "tx_pkts": 0, "fec_tx": 0, "rx_octets": 0, "statcycletime": 1589075400052, "state": "Up", "local_system_ip": "172.16.255.15", "tenant": "default", "entry_time": 1589073783045, "loss_percentage": 0, "rx_pkts": 0, "vmanage_system_ip": "172.16.255.15", "fec_rx": 0, "src_port": 12366, "jitter": 1, "remote_system_ip": "172.16.255.16", "vdevice_name": "172.16.255.15", "proto": "IPSEC", "vip_idx": 351, "dst_port": 12386, "name": "172.16.255.15:lte-172.16.255.16:lte", "sla_class_list": "0,1", "tunnel_color": "lte:lte", "host_name": "vm5", "id": "IuBG_HEB_JLsavezVkiZ" } ], "pageInfo": { "startTime": "1589073783045", "endTime": "1589072535795", "count": 15 } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" } }, "/device/history/aggregation": { "post": { "tags": [ "Configuration - Device Config History" ], "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", "operationId": "getPostAggregationDataByQuery_ConfigurationDeviceConfigHistory_2704", "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "query string": {} } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "query string": {} } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default,dca" }, "get": { "tags": [ "Configuration - Device Config History" ], "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", "operationId": "getAggregationDataByQuery_ConfigurationDeviceConfigHistory_2703", "parameters": [ { "name": "query", "in": "query", "description": "Query filter", "schema": { "type": "string" }, "examples": { "query string": {} } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "query string": {} } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" } }, "/device/history/config": { "get": { "tags": [ "Configuration - Device Config History" ], "description": "Get device config history", "operationId": "getLastThousandConfigList", "parameters": [ { "name": "deviceId", "in": "query", "description": "Device Id", "required": true, "schema": { "type": "string" } }, { "name": "query", "in": "query", "description": "Query filter", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Device config history": { "description": "Device config history", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Template Configuration-read,Config Group-read,Policy Group-read" } }, "/device/history/config/diff/list": { "get": { "tags": [ "Configuration - Device Config History" ], "description": "Get diff of two configs", "operationId": "getConfigDiff", "parameters": [ { "name": "config_id1", "in": "query", "description": "Config Id one", "required": true, "schema": { "type": "string" } }, { "name": "config_id2", "in": "query", "description": "Config Id two", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Device config": { "description": "Device config", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Template Configuration-read,Config Group-read,Policy Group-read" } }, "/device/history/config/{config_id}": { "get": { "tags": [ "Configuration - Device Config History" ], "description": "Get device config", "operationId": "getDeviceConfig", "parameters": [ { "name": "config_id", "in": "path", "description": "Config Id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Device config": { "description": "Device config", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Template Configuration-read,Config Group-read,Policy Group-read" } }, "/device/history/csv": { "get": { "tags": [ "Configuration - Device Config History" ], "description": "Get raw data with optional query as CSV", "operationId": "getStatDataRawDataAsCSV_ConfigurationDeviceConfigHistory_1903", "parameters": [ { "name": "query", "in": "query", "description": "Query string", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } ], "responses": { "200": { "description": "Success", "content": { "text/csv": { "schema": { "type": "string" }, "examples": { "Search result in csv format": { "description": "Search result in csv format", "value": "blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" } }, "/device/history/doccount": { "get": { "tags": [ "Configuration - Device Config History" ], "description": "Get response count of a query", "operationId": "getCount_ConfigurationDeviceConfigHistory_2403", "parameters": [ { "name": "query", "in": "query", "description": "Query", "required": true, "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query result count": { "description": "Query result count", "value": { "count": 17193 } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Configuration - Device Config History" ], "description": "Get response count of a query", "operationId": "getCountPost_ConfigurationDeviceConfigHistory_2404", "requestBody": { "description": "Query", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query": { "description": "Query", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query result count": { "description": "Query result count", "value": { "count": 9642 } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/device/history/fields": { "get": { "tags": [ "Configuration - Device Config History" ], "description": "Get fields and type", "operationId": "getStatDataFields_ConfigurationDeviceConfigHistory_2203", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "example": [ { "dataType": "string", "property": "mac" }, { "dataType": "string", "property": "vap" }, { "dataType": "number", "property": "rssi" }, { "dataType": "string", "property": "mode" }, { "dataType": "number", "property": "bandwidth" }, { "dataType": "string", "property": "data_security" }, { "dataType": "number", "property": "rx_rate" }, { "dataType": "string", "property": "assoc_time" }, { "dataType": "date", "property": "entry_time" }, { "dataType": "date", "property": "statcycletime" }, { "dataType": "string", "property": "ssid" }, { "dataType": "number", "property": "vip_idx" }, { "dataType": "date", "property": "vip_time" }, { "dataType": "string", "property": "vdevice_name" }, { "dataType": "string", "property": "host_name" }, { "dataType": "string", "property": "device_model" } ] } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/device/history/page": { "get": { "tags": [ "Configuration - Device Config History" ], "description": "Get stats raw data", "operationId": "getStatsPaginationRawData_ConfigurationDeviceConfigHistory_2003", "parameters": [ { "name": "query", "in": "query", "description": "Query string", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } }, { "name": "scrollId", "in": "query", "description": "ES scroll Id", "schema": { "type": "string" }, "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" }, { "name": "count", "in": "query", "description": "Result size", "schema": { "type": "integer", "format": "int64" }, "example": 10 } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "mem_used": 19407626240, "disk_avail": 9305948160, "device_model": "vmanage", "mem_cached": 6740430848, "mem_util": 0.59, "min1_avg": 0.92, "disk_used": 5789007872, "statcycletime": 1647394800045, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647393870251, "runningp": 0, "cpu_user": 8.63, "cpu_idle_new": 88.14, "vip_time": 1647393870252, "min15_avg": 1.08, "totalp": 2427, "cpu_idle": 88.14, "mem_buffers": 892911616, "cpu_system": 3.23, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.07, "cpu_min1_avg": 0.115, "mem_free": 5716930560, "vdevice_name": "172.16.255.201", "vip_idx": 82, "cpu_min15_avg": 0.135, "system_ip": "172.16.255.201", "cpu_user_new": 8.63, "cpu_system_new": 3.23, "host_name": "vm201", "cpu_min5_avg": 0.13375, "id": "4YphkH8BPIGvVbrdtzXi" }, { "mem_used": 19534016512, "disk_avail": 9304268800, "device_model": "vmanage", "mem_cached": 6747897856, "mem_util": 0.6, "min1_avg": 1.14, "disk_used": 5790687232, "statcycletime": 1647394800046, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647394110479, "runningp": 0, "cpu_user": 5.53, "cpu_idle_new": 91.49, "vip_time": 1647394110479, "min15_avg": 1.1, "totalp": 2323, "cpu_idle": 91.49, "mem_buffers": 902213632, "cpu_system": 2.97, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.14, "cpu_min1_avg": 0.1425, "mem_free": 5573771264, "vdevice_name": "172.16.255.201", "vip_idx": 86, "cpu_min15_avg": 0.1375, "system_ip": "172.16.255.201", "cpu_user_new": 5.53, "cpu_system_new": 2.97, "host_name": "vm201", "cpu_min5_avg": 0.1425, "id": "5YphkH8BPIGvVbrdtzXi" } ], "pageInfo": { "startTime": "1647394800045", "endTime": "1647394800047", "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==", "hasMoreData": true, "count": 2, "totalCount": 11140 } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" }, "post": { "tags": [ "Configuration - Device Config History" ], "description": "Get stats raw data", "operationId": "getPostStatsPaginationRawData_ConfigurationDeviceConfigHistory_2004", "parameters": [ { "name": "scrollId", "in": "query", "description": "ES scroll Id", "schema": { "type": "string" }, "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" }, { "name": "count", "in": "query", "description": "Result size", "schema": { "type": "integer", "format": "int64" }, "example": 10 } ], "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Stats query string": { "description": "Stats query string", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "mem_used": 19407626240, "disk_avail": 9305948160, "device_model": "vmanage", "mem_cached": 6740430848, "mem_util": 0.59, "min1_avg": 0.92, "disk_used": 5789007872, "statcycletime": 1647394800045, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647393870251, "runningp": 0, "cpu_user": 8.63, "cpu_idle_new": 88.14, "vip_time": 1647393870252, "min15_avg": 1.08, "totalp": 2427, "cpu_idle": 88.14, "mem_buffers": 892911616, "cpu_system": 3.23, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.07, "cpu_min1_avg": 0.115, "mem_free": 5716930560, "vdevice_name": "172.16.255.201", "vip_idx": 82, "cpu_min15_avg": 0.135, "system_ip": "172.16.255.201", "cpu_user_new": 8.63, "cpu_system_new": 3.23, "host_name": "vm201", "cpu_min5_avg": 0.13375, "id": "4YphkH8BPIGvVbrdtzXi" }, { "mem_used": 19534016512, "disk_avail": 9304268800, "device_model": "vmanage", "mem_cached": 6747897856, "mem_util": 0.6, "min1_avg": 1.14, "disk_used": 5790687232, "statcycletime": 1647394800046, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647394110479, "runningp": 0, "cpu_user": 5.53, "cpu_idle_new": 91.49, "vip_time": 1647394110479, "min15_avg": 1.1, "totalp": 2323, "cpu_idle": 91.49, "mem_buffers": 902213632, "cpu_system": 2.97, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.14, "cpu_min1_avg": 0.1425, "mem_free": 5573771264, "vdevice_name": "172.16.255.201", "vip_idx": 86, "cpu_min15_avg": 0.1375, "system_ip": "172.16.255.201", "cpu_user_new": 5.53, "cpu_system_new": 2.97, "host_name": "vm201", "cpu_min5_avg": 0.1425, "id": "5YphkH8BPIGvVbrdtzXi" } ], "pageInfo": { "startTime": "1647394800045", "endTime": "1647394800047", "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==", "hasMoreData": true, "count": 2, "totalCount": 11140 } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" } }, "/device/history/query/fields": { "get": { "tags": [ "Configuration - Device Config History" ], "description": "Get query fields", "operationId": "getStatQueryFields_ConfigurationDeviceConfigHistory_2803", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query result count": { "description": "Query result count", "value": { "data": [ { "property": "entry_time", "name": "Event Time", "isRequired": true, "dataType": "date", "fieldData": { "type": "dateList" }, "options": [ { "key": "last_1_hour", "value": "Last 1 hour", "number": "1", "enableDateFields": false }, { "key": "last_3_hours", "value": "Last 3 hours", "number": "3", "enableDateFields": false }, { "key": "last_6_hours", "value": "Last 6 hours", "number": "6", "enableDateFields": false }, { "key": "last_12_hours", "value": "Last 12 hours", "number": "12", "enableDateFields": false }, { "key": "last_24_hours", "value": "Last 24 hours", "number": "24", "enableDateFields": false, "isSelected": true }, { "key": "last_168_hours", "value": "Last 7 days", "number": "168", "enableDateFields": false }, { "key": "custom", "value": "Custom", "enableDateFields": true } ] }, { "property": "vdevice_name", "name": "Device name", "isRequired": true, "multiSelect": false, "dataType": "string" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/device/lte450Cellular/hardware": { "get": { "tags": [ "Real-Time Monitoring -LTE450 Cellular" ], "description": "Get LTE450 cellular hardware list from device", "operationId": "createHardwareList_RealTimeMonitoringLte450Cellular_3103", "parameters": [ { "name": "deviceId", "in": "query", "description": "Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "Cellular LTE450 hardware list": { "description": "Cellular LTE450 hardware list", "value": [ { "free-ram": "59212", "vdevice-name": "172.16.255.102", "mgmt-ipv4-addr": "192.168.200.1", "hw-wd-ctr": "0", "modem-mac": "00:00:00:00:00:00", "pim-mac": "fc:c2:3d:31:36:61", "sys-time": "2012-01-02T02:14:59+00:00", "modem-fw-ver": "0.3.4.1/ML620EUV12_RELEASE_20230424", "pim-sn": "50030301535", "vdevice-host-name": "ir1101_blr1", "uptime": "94488", "pim-temp": "50.5", "if-name": "GigabitEthernet0/1/0", "vdevice-dataKey": "172.16.255.102", "modem-hw-ver": "ML620EU", "pim-hw-ver": "IPS-701-V3", "modem-wd-ctr": "0", "lastupdated": 1739882248933, "modem-temp": "48.0", "free-disk": "83180", "pim-fw-ver": "IPS701-v1.2.10-Secured", "mgmt-ipv6-addr": "fd00:ffff:c0:a8c8::1" } ] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Interface-read,Interface-write" } }, "/device/lte450Cellular/network": { "get": { "tags": [ "Real-Time Monitoring -LTE450 Cellular" ], "description": "Get LTE450 cellular network list from device", "operationId": "createNetworkList_RealTimeMonitoringLte450Cellular_3003", "parameters": [ { "name": "deviceId", "in": "query", "description": "Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "Cellular LTE450 network list": { "description": "Cellular LTE450 network list", "value": [ { "cell-id": "0", "tx-power": "0", "conn-time": "0", "apn2-ipv4-addr": "0.0.0.0", "apn3-ipv4-addr": "0.0.0.0", "lte-rx-chan": "0", "vdevice-name": "172.16.255.102", "apn1-ipv4-addr": "0.0.0.0", "conn-status": "conn-status-initializing", "current-download": "0.0", "vdevice-host-name": "ir1101_blr1", "cereg": "0", "if-name": "GigabitEthernet0/1/0", "iccid": "00000000000000000000", "lte-tx-chan": "0", "vdevice-dataKey": "172.16.255.102", "apn3-ipv6-addr": "::", "current-upload": "0.0", "pci": "0", "imei": "***************", "lastupdated": 1739879891307, "apn2-ipv6-addr": "::", "band": "0", "apn1-ipv6-addr": "::" } ] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Interface-read,Interface-write" } }, "/device/lte450Cellular/radio": { "get": { "tags": [ "Real-Time Monitoring -LTE450 Cellular" ], "description": "Get LTE450 cellular radio list from device", "operationId": "createRadioList_RealTimeMonitoringLte450Cellular_2803", "parameters": [ { "name": "deviceId", "in": "query", "description": "Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "Cellular LTE450 radio list": { "description": "Cellular LTE450 radio list", "value": [ { "aux-rssi": "0", "rssi": "0", "main-rssi": "0", "vdevice-name": "172.16.255.102", "aux-rsrp": "0", "rsrp": "0", "vdevice-host-name": "ir1101_blr1", "sinr": "0", "if-name": "GigabitEthernet0/1/0", "vdevice-dataKey": "172.16.255.102", "rsrq": "0", "lastupdated": 1739882151645, "main-rsrp": "0" } ] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Interface-read,Interface-write" } }, "/device/ppl/dashlet": { "get": { "tags": [ "Overview - PPL" ], "description": "PPL dashlet", "operationId": "pplDashlet", "parameters": [ { "name": "orderBy", "in": "query", "description": "orderBy", "schema": { "type": "string", "enum": [ "candidateTunnel", "ooo_severity", "mem_usage" ] } }, { "name": "filter", "in": "query", "description": "filter", "schema": { "type": "string", "enum": [ "highSegment", "mediumSegment", "lowSegment" ] } }, { "name": "lastNHours", "in": "query", "description": "last N Hours", "schema": { "type": "string", "enum": [ "1", "3", "6", "12", "24" ] } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "dashLetList": { "type": "array", "items": { "type": "object", "properties": { "memoryUsage": { "type": "number", "format": "double" }, "numCtg": { "type": "integer", "format": "int64" }, "oooSeverity": { "type": "number", "format": "double" }, "previousMemoryUsage": { "type": "number", "format": "double" }, "previousNumCtg": { "type": "integer", "format": "int64" }, "previousOooSeverity": { "type": "number", "format": "double" }, "receiverSysIp": { "type": "string" }, "segment": { "type": "string" }, "senderSysIp": { "type": "string" } }, "$$ref": "#/components/schemas/PPLDashLet" } }, "high": { "type": "integer", "format": "int64" }, "low": { "type": "integer", "format": "int64" }, "medium": { "type": "integer", "format": "int64" }, "totalSegment": { "type": "integer", "format": "int64" } }, "$$ref": "#/components/schemas/PPLDashLetSummary" } }, "examples": { "count by candidateTunnel": { "description": "count by candidateTunnel", "value": { "data": { "high": 0, "low": 0, "totalSegment": 0, "medium": 0, "dashLetList": [] } }, "$$ref": "#/components/examples/ComViptelaVmanageServerDevicePplPplapiResponseExamplePplbycandidatetunnel" }, "count by ooo_severity": { "description": "count by ooo_severity", "value": { "data": { "high": 0, "low": 1, "totalSegment": 1, "medium": 0, "dashLetList": [ { "previousMemoryUsage": 0, "memoryUsage": 0, "senderSysIp": "172.16.255.16", "previousNumCtg": 0, "numCtg": 0, "oooSeverity": 0, "receiverSysIp": "172.16.255.15", "previousOooSeverity": 0 } ] } }, "$$ref": "#/components/examples/ComViptelaVmanageServerDevicePplPplapiResponseExamplePplbyoooseverity" }, "count by mem_usage": { "description": "count by mem_usage", "value": { "data": { "high": 0, "low": 1, "totalSegment": 1, "medium": 0, "dashLetList": [ { "previousMemoryUsage": 0, "memoryUsage": 0, "senderSysIp": "172.16.255.16", "previousNumCtg": 0, "numCtg": 0, "oooSeverity": 0, "receiverSysIp": "172.16.255.15", "previousOooSeverity": 0 } ] } }, "$$ref": "#/components/examples/ComViptelaVmanageServerDevicePplPplapiResponseExamplePplbyoooseverity" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read,Device Monitoring-write" } }, "/device/ppl/detailList": { "get": { "tags": [ "Overview - PPL" ], "description": "PPL detail list", "operationId": "detailList", "parameters": [ { "name": "lastNHours", "in": "query", "description": "last N Hours", "schema": { "type": "string", "enum": [ "1", "3", "6", "12", "24" ] } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "memUSage": { "type": "number", "format": "double" }, "numCtg": { "type": "integer", "format": "int64" }, "oooSev": { "type": "number", "format": "double" }, "receiverSysIp": { "type": "string" }, "senderSysIp": { "type": "string" } }, "$$ref": "#/components/schemas/PPLDetail" } }, "examples": { "PPL detail list": { "description": "PPL detail list", "value": [ { "carrier": "ATT", "standby": 0, "active": 1 }, { "carrier": "Verizon", "standby": 0, "active": 1 } ], "$$ref": "#/components/examples/ComViptelaVmanageServerDevicePplPplapiResponseExamplePpldetaillist" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read,Device Monitoring-write" } }, "/device/ppl/segmentDetail": { "get": { "tags": [ "Overview - PPL" ], "description": "PPL segment detail", "operationId": "segmentDetail", "parameters": [ { "name": "lastNHours", "in": "query", "description": "last N Hours", "schema": { "type": "string", "enum": [ "1", "3", "6", "12", "24" ] } }, { "name": "localSystemIp", "in": "query", "description": "Sender System Ip", "schema": { "type": "string" } }, { "name": "remoteSystemIp", "in": "query", "description": "Receiver System Ip", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "memUSage": { "type": "number", "format": "double" }, "numCtg": { "type": "integer", "format": "int64" }, "oooSev": { "type": "number", "format": "double" }, "receiverSysIp": { "type": "string" }, "senderSysIp": { "type": "string" } }, "$$ref": "#/components/schemas/PPLDetail" } }, "examples": { "PPL segment detail": { "description": "PPL segment detail", "value": [ { "carrier": "ATT", "standby": 0, "active": 1 }, { "carrier": "Verizon", "standby": 0, "active": 1 } ], "$$ref": "#/components/examples/ComViptelaVmanageServerDevicePplPplapiResponseExamplePplsegmentdetail" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read,Device Monitoring-write" } }, "/device/rawsocket/tcp-session": { "get": { "tags": [ "Real Time Monitoring - Raw Socket" ], "summary": "Get TCP session", "description": "Get TCP session", "operationId": "getTcpSession", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "TCP Session": { "description": "TCP Session", "value": { "data": [ { "async-line": "0/2/0", "destination-ip": "192.168.1.1", "destination-port": 8080, "tty": "50", "vrf": "vrf1", "idle-timeout": 300, "mode": "active", "local-ip": "10.0.0.1", "local-port": 12345, "socket": "socket1", "start-time": "2023-10-05T14:48:00Z", "last-active-time": "2023-10-05T15:00:00Z" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write" } }, "/device/rawsocket/tcp-session-local": { "get": { "tags": [ "Real Time Monitoring - Raw Socket" ], "summary": "Get TCP session local", "description": "Get TCP session local", "operationId": "getTcpSessionLocal", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "TCP Session Local": { "description": "TCP Session Local", "value": { "data": [ { "async-line": "0/2/0", "destination-ip": "192.168.1.1", "destination-port": 8080, "tty": "50", "local-ip": "10.0.0.1", "local-port": 12345, "state": "active" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write" } }, "/device/rawsocket/tcp-statistics": { "get": { "tags": [ "Real Time Monitoring - Raw Socket" ], "summary": "Get TCP statistics", "description": "Get TCP statistics", "operationId": "getTcpStatistics", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "TCP Statistics": { "description": "TCP Statistics", "value": { "data": [ { "async-line": "0/2/0", "tty": "50", "vrf": "vrf1", "num-sessions": 4, "tcp-in-bytes": 1500, "tcp-out-bytes": 1600, "tcp-to-tty-frames": 50, "tty-to-tcp-frames": 45 } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write" } }, "/device/rawsocket/udp-session": { "get": { "tags": [ "Real Time Monitoring - Raw Socket" ], "summary": "Get UDP session", "description": "Get UDP session", "operationId": "getUdpSession", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "UDP Session": { "description": "UDP Session", "value": { "data": [ { "async-line": "0/2/0", "destination-ip": "192.168.1.1", "destination-port": 8080, "tty": "50", "vrf": "vrf1", "idle-timeout": 300, "mode": "active", "local-ip": "10.0.0.1", "local-port": 12345, "socket": "socket1", "start-time": "2023-10-05T14:48:00Z", "last-active-time": "2023-10-05T15:00:00Z" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write" } }, "/device/rawsocket/udp-session-local": { "get": { "tags": [ "Real Time Monitoring - Raw Socket" ], "summary": "Get UDP session local", "description": "Get UDP session local", "operationId": "getUdpSessionLocal", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "UDP Session Local": { "description": "UDP Session Local", "value": { "data": [ { "async-line": "0/2/0", "destination-ip": "192.168.1.1", "destination-port": 8080, "tty": "50", "local-ip": "10.0.0.1", "local-port": 12345, "state": "active" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write" } }, "/device/rawsocket/udp-statistics": { "get": { "tags": [ "Real Time Monitoring - Raw Socket" ], "summary": "Get UDP statistics", "description": "Get UDP statistics", "operationId": "getUdpStatistics", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "UDP Statistics": { "description": "UDP Statistics", "value": { "data": [ { "async-line": "0/2/0", "tty": "50", "vrf": "vrf1", "num-sessions": 5, "udp-in-bytes": 1024, "udp-out-bytes": 2048, "udp-to-tty-frames": 30, "tty-to-udp-frames": 25 } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write" } }, "/disasterrecovery/activate": { "post": { "tags": [ "Configuration - Disaster Recovery" ], "description": "Activate cluster to start working as primary", "operationId": "activate", "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" } } } }, "/disasterrecovery/clusterInfo": { "get": { "tags": [ "Configuration - Disaster Recovery" ], "description": "Get disaster recovery cluster info", "operationId": "getClusterInfo", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "DR cluster info": { "description": "DR cluster info", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Disaster Recovery-read,Disaster Recovery-write" } }, "/disasterrecovery/dbrestorestatus": { "get": { "tags": [ "Configuration - Disaster Recovery" ], "description": "Config-db restore status", "operationId": "getConfigDBRestoreStatus", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "Config-db Restore Status": { "description": "Config-db Restore Status", "value": { "currentState": "DOWNLOADING" } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/disasterrecovery/deleteLocalDataCenter": { "post": { "tags": [ "Configuration - Disaster Recovery" ], "description": "Delete local data center", "operationId": "deleteLocalDC", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Request status": { "description": "Request status", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Disaster Recovery-write" } }, "/disasterrecovery/deleteRemoteDataCenter": { "post": { "tags": [ "Configuration - Disaster Recovery" ], "description": "Delete data center", "operationId": "deleteDC", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Request status": { "description": "Request status", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/disasterrecovery/deleteRemoteDrDetails": { "post": { "tags": [ "Configuration - Disaster Recovery" ], "description": "Delete data center", "operationId": "deleteDr", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Request status": { "description": "Request status", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/disasterrecovery/deregister": { "post": { "tags": [ "Configuration - Disaster Recovery" ], "description": "Delete disaster recovery", "operationId": "delete", "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": "Disaster Recovery-write" } }, "/disasterrecovery/details": { "get": { "tags": [ "Configuration - Disaster Recovery" ], "description": "Get disaster recovery details", "operationId": "getDetails", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "DR details": { "description": "DR details", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Disaster Recovery-read,Disaster Recovery-write" } }, "/disasterrecovery/drstatus": { "get": { "tags": [ "Configuration - Disaster Recovery" ], "description": "Disaster recovery status", "operationId": "getDisasterRecoveryStatus", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "DR status": { "description": "DR status", "value": [] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/disasterrecovery/history": { "get": { "tags": [ "Configuration - Disaster Recovery" ], "description": "Get disaster recovery switchover history", "operationId": "getHistory", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "DR switchover history": { "description": "DR switchover history", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Disaster Recovery-read,Disaster Recovery-write" } }, "/disasterrecovery/localLatestHistory": { "get": { "tags": [ "Configuration - Disaster Recovery" ], "description": "Get disaster recovery local switchover history", "operationId": "getLocalHistory", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "DR local switchover history": { "description": "DR local switchover history", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Disaster Recovery-read,Disaster Recovery-write" } }, "/disasterrecovery/localdc": { "get": { "tags": [ "Configuration - Disaster Recovery" ], "description": "Get data center details", "operationId": "getLocalDataCenterState", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "Datacenters detail": { "description": "Datacenters detail", "value": [ { "dcName": "DC1 (Primary)", "nodes": [ { "hostName": "vm12", "deviceIP": "10.0.105.32", "state": "UP" } ] }, { "dcName": "DC2", "nodes": [ { "hostName": "vm18", "deviceIP": "10.0.105.38", "state": "UP" } ] } ] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Disaster Recovery-read,Disaster Recovery-write" } }, "/disasterrecovery/password": { "post": { "tags": [ "Configuration - Disaster Recovery" ], "description": "Update data centers and vBonds passwords for disaster recovery", "operationId": "update_ConfigurationDisasterRecovery_2604", "requestBody": { "description": "Datacenter/vBond password update request", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Datacenter/vBond password update request": { "description": "Datacenter/vBond password update request", "value": { "dataCenters": [] } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "DR setting updated": { "description": "DR setting updated", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Disaster Recovery-write" } }, "/disasterrecovery/pause": { "post": { "tags": [ "Configuration - Disaster Recovery" ], "description": "Pause DR", "operationId": "pauseDR", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Request Status": { "description": "Request Status", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Disaster Recovery-write" } }, "/disasterrecovery/pauseLocalArbitrator": { "post": { "tags": [ "Configuration - Disaster Recovery" ], "description": "Pause DR for Local Arbitrator", "operationId": "pauseLocalArbitrator", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Request Status": { "description": "Request Status", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Disaster Recovery-write" } }, "/disasterrecovery/pauseLocalDC": { "post": { "tags": [ "Configuration - Disaster Recovery" ], "description": "Pause DR for Local datacenter", "operationId": "pauseLocalDCForDR", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Request Status": { "description": "Request Status", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Disaster Recovery-write" } }, "/disasterrecovery/pauseLocalReplication": { "post": { "tags": [ "Configuration - Disaster Recovery" ], "description": "Pause DR replication for Local datacenter", "operationId": "pauseLocalDCReplication", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Request Status": { "description": "Request Status", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "admin" } }, "/disasterrecovery/pausereplication": { "post": { "tags": [ "Configuration - Disaster Recovery" ], "description": "Pause DR data replication", "operationId": "disasterRecoveryPauseReplication", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Request Status": { "description": "Request Status", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true, "x-roles-required": "Disaster Recovery-write" } }, "/disasterrecovery/register": { "put": { "tags": [ "Configuration - Disaster Recovery" ], "description": "Update data centers for disaster recovery", "operationId": "update_ConfigurationDisasterRecovery_2603", "requestBody": { "description": "Datacenter registration request", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Datacenter registration request": { "description": "Datacenter registration request", "value": { "dataCenters": [] } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "DR setting updated": { "description": "DR setting updated", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Disaster Recovery-write" }, "post": { "tags": [ "Configuration - Disaster Recovery" ], "description": "Register data centers for disaster recovery", "operationId": "register", "requestBody": { "description": "Datacenter registration request", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Datacenter registration request": { "description": "Datacenter registration request", "value": {} } } } }, "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": "Disaster Recovery-write" } }, "/disasterrecovery/remoteDcState": { "get": { "tags": [ "Configuration - Disaster Recovery" ], "description": "Gets remote data center member state", "operationId": "getRemoteDCMembersState", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "Remote DC member details": { "description": "Remote DC member details", "value": [] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Disaster Recovery-read,Disaster Recovery-write" } }, "/disasterrecovery/schedule": { "get": { "tags": [ "Configuration - Disaster Recovery" ], "description": "Get disaster recovery local replication schedule", "operationId": "getDisasterRecoveryLocalReplicationSchedule", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "DR replication schedule": { "description": "DR replication schedule", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Disaster Recovery-read,Disaster Recovery-write" } }, "/disasterrecovery/status": { "get": { "tags": [ "Configuration - Disaster Recovery" ], "description": "Get disaster recovery status", "operationId": "getdrStatus", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "DR status": { "description": "DR status", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Disaster Recovery-read,Disaster Recovery-write,Template Deploy-read,Template Deploy-write" } }, "/disasterrecovery/unpause": { "post": { "tags": [ "Configuration - Disaster Recovery" ], "description": "Unpause DR", "operationId": "unpauseDR", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Request Status": { "description": "Request Status", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Disaster Recovery-write" } }, "/disasterrecovery/unpauseLocalArbitrator": { "post": { "tags": [ "Configuration - Disaster Recovery" ], "description": "Unpause DR for Local Arbitrator", "operationId": "unpauseLocalArbitrator", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Request Status": { "description": "Request Status", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Disaster Recovery-write" } }, "/disasterrecovery/unpauseLocalDC": { "post": { "tags": [ "Configuration - Disaster Recovery" ], "description": "Unpause DR for Local datacenter", "operationId": "unpauseLocalDCForDR", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Request Status": { "description": "Request Status", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Disaster Recovery-write" } }, "/disasterrecovery/unpauseLocalReplication": { "post": { "tags": [ "Configuration - Disaster Recovery" ], "description": "Unpause DR replication for local datacenter", "operationId": "unpauseLocalDCReplication", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Request Status": { "description": "Request Status", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "admin" } }, "/disasterrecovery/unpausereplication": { "post": { "tags": [ "Configuration - Disaster Recovery" ], "description": "Un-Pause DR data replication", "operationId": "disasterRecoveryUnPauseReplication", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Request Status": { "description": "Request Status", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true, "x-roles-required": "Disaster Recovery-write" } }, "/disasterrecovery/updateDRConfigOnArbitrator": { "post": { "tags": [ "Configuration - Disaster Recovery" ], "description": "Update arbitrator with primary and secondary states cluster", "operationId": "updateDrState", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Request status": { "description": "Request status", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/disasterrecovery/updateReplicationCheckEnabled": { "put": { "tags": [ "Configuration - Disaster Recovery" ], "description": "Update replicationCheckEnabled Flag used in DR replication", "operationId": "updateReplicationCheckEnabled", "requestBody": { "description": "Datacenter registration request", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "replicationCheckEnabled": { "description": "replicationCheckEnabled", "value": true } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "DR setting updated": { "description": "DR setting updated", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Disaster Recovery-write" } }, "/disasterrecovery/usernames": { "get": { "tags": [ "Configuration - Disaster Recovery" ], "description": "Fetch data centers and vBonds usernames for disaster recovery", "operationId": "get", "requestBody": { "description": "Datacenter/vBond password update request", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Datacenter/vBond password update request": { "description": "Datacenter/vBond password update request", "value": {} } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "DR setting updated": { "description": "DR setting updated", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Disaster Recovery-write" } }, "/featurecertificate/certificate": { "get": { "tags": [ "Configuration - Feature Certificate" ], "description": "Get feature cert from cEdge device


Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view.", "operationId": "getDeviceCertificate", "parameters": [ { "name": "deviceId", "in": "query", "description": "Device Id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Device feature cert": { "description": "Device feature cert", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Certificates-write" }, "put": { "tags": [ "Configuration - Feature Certificate" ], "description": "Upload feature cert for cEdge device


Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view.", "operationId": "installFeatureCertificate", "requestBody": { "description": "Install feature cert request for cEdge", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Feature cert request": { "description": "Feature cert 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" } }, "x-roles-required": "Certificates-write" } }, "/featurecertificate/devicecsr": { "put": { "tags": [ "Configuration - Feature Certificate" ], "description": "Create CSR for cEdge device


Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view.", "operationId": "genDeviceCsr", "requestBody": { "description": "CSR request for cEdge", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "CSR request": { "description": "CSR 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" } }, "x-roles-required": "Certificates-write" }, "get": { "tags": [ "Configuration - Feature Certificate" ], "description": "Get CSR from cEdge device


Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view.", "operationId": "getDeviceCsr", "parameters": [ { "name": "deviceId", "in": "query", "description": "Device Id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Device CSR": { "description": "Device CSR", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Certificates-write" } }, "/featurecertificate/revoke": { "put": { "tags": [ "Configuration - Feature Certificate" ], "description": "Revoke feature cert from cEdge device


Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view.", "operationId": "revokeFeatureCertificate", "requestBody": { "description": "Revoking feature cert request for cEdge", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Revoking feature cert request": { "description": "Revoking feature cert 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" } }, "x-roles-required": "Certificates-write" } }, "/featurecertificate/syslogconfig": { "get": { "tags": [ "Configuration - Feature Certificate" ], "description": "Get Feature CA state


Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view.", "operationId": "getFeatureCaState", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Feature CA state": { "description": "Feature CA state", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Certificates-write" } }, "/hsec/devices": { "get": { "tags": [ "HSEC" ], "description": "Retrieve list of devices which are valid for fetch of HSEC license", "operationId": "fetchDeviceDetails", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "properties": { "empty": { "type": "boolean" } }, "items": { "type": "object", "properties": { "configuredSystemIP": { "type": "string", "example": "172.16.255.15" }, "deviceModel": { "type": "string", "example": "vedge-C8000V" }, "hostName": { "type": "string", "example": "hostname" }, "hsecLicenseStatus": { "type": "string", "example": "assigned" }, "isHsecSupported": { "type": "boolean", "example": true }, "reachability": { "type": "string", "example": "reachability" }, "tag": { "type": "string", "example": "regid.2020-10.com.cisco.DSTACK_T2_A,1.0_b072e613-aa2c-4ed0-ab46-ae91ddc7dfb5" }, "uuid": { "type": "string", "example": "C8K-a9d1a657-790a-40d6-a9bd-a55751e73340" } }, "$$ref": "#/components/schemas/GetHSECDevicesPayloadInner" }, "$$ref": "#/components/schemas/GetHSECInstallDevicesPayload" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/hsec/devices/install": { "get": { "tags": [ "HSEC" ], "description": "Retrieve list of devices which has HSEC fetched", "operationId": "InstallDeviceDetails", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "properties": { "empty": { "type": "boolean" } }, "items": { "type": "object", "properties": { "configuredSystemIP": { "type": "string", "example": "172.16.255.15" }, "deviceModel": { "type": "string", "example": "vedge-C8000V" }, "hostName": { "type": "string", "example": "hostname" }, "hsecLicenseStatus": { "type": "string", "example": "assigned" }, "isHsecSupported": { "type": "boolean", "example": true }, "reachability": { "type": "string", "example": "reachability" }, "tag": { "type": "string", "example": "regid.2020-10.com.cisco.DSTACK_T2_A,1.0_b072e613-aa2c-4ed0-ab46-ae91ddc7dfb5" }, "uuid": { "type": "string", "example": "C8K-a9d1a657-790a-40d6-a9bd-a55751e73340" } }, "$$ref": "#/components/schemas/GetHSECDevicesPayloadInner" }, "$$ref": "#/components/schemas/GetHSECInstallDevicesPayload" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/hsec/download": { "post": { "tags": [ "HSEC" ], "description": "Download SLAC Request file for CSSM", "operationId": "downloadSlacRequestFile", "requestBody": { "description": "Device List", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Device": { "description": "Device", "value": {} } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Device": { "description": "Device", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "admin,Software Upgrade-write" } }, "/hsec/fetchaccounts": { "get": { "tags": [ "HSEC" ], "description": "Authenticate User and Sync Licenses", "operationId": "fetchSAVAAccounts", "parameters": [ { "name": "username", "in": "query", "schema": { "type": "string" } }, { "name": "pwd", "in": "query", "schema": { "type": "string" } }, { "name": "mode", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "account_id": { "type": "string", "example": "276200" }, "name": { "type": "string", "example": "testaccount3.viptela.com" }, "virtual_accounts": { "type": "array", "items": { "type": "object", "properties": { "default": { "type": "boolean", "example": false }, "name": { "type": "string", "example": "703805" }, "virtual_account_id": { "type": "string", "example": "713850" } }, "$$ref": "#/components/schemas/SmartLicensingfetchAccountsRespVirtualAccounts" } } }, "$$ref": "#/components/schemas/SmartLicensingfetchAccountsResp" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true }, "post": { "tags": [ "HSEC" ], "description": "Authenticate User and Sync Licenses", "operationId": "fetchAccounts_Hsec_1904", "requestBody": { "description": "Hsec License sync request payload", "content": { "application/json": { "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": "object", "properties": { "account_id": { "type": "string", "example": "276200" }, "name": { "type": "string", "example": "testaccount3.viptela.com" }, "virtual_accounts": { "type": "array", "items": { "type": "object", "properties": { "default": { "type": "boolean", "example": false }, "name": { "type": "string", "example": "703805" }, "virtual_account_id": { "type": "string", "example": "713850" } }, "$$ref": "#/components/schemas/SmartLicensingfetchAccountsRespVirtualAccounts" } } }, "$$ref": "#/components/schemas/SmartLicensingfetchAccountsResp" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/hsec/testbedMode": { "get": { "tags": [ "HSEC" ], "description": "Return testbed mode information staging or production", "operationId": "testbedMode", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "isStaging": { "type": "boolean", "example": false } }, "$$ref": "#/components/schemas/TestbedMode" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/idpcertificate": { "get": { "tags": [ "IDP Certificate Management" ], "summary": "Retrieves IDP Certificate Details", "description": "Retrieves IDP Certificate Details", "operationId": "getCertificateDetails", "parameters": [ { "name": "download", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "IDP Certificate Details Response": { "description": "IDP Certificate Details Response", "value": { "company_name": "abc", "org_unit": "abc", "org": "abc", "location": "abc", "state": "abc", "country": "US", "signerType": "self-signed", "notBefore": 1755626328000, "notAfter": 1913392728000, "certificateDetails": "-----BEGIN CERTIFICATE-----\nMIIDrjCCApagAwIBAgIgABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890abcdefghij\nDQYJKoZIhvcNAQELBQAwgYoxDDAKBgNVBAYTA1VTQTELMAkGA1UECBMCYWJJMQ0w\nCwYDVQQHEwRhYmMxDDAKBgNVBAoTA2FiYzEMMAoGA1UECxMDYWJjMQwwCgYDVQQD\nEwNhYmMwHhcNMjUwODE5MTc1ODQ4WhcNMzAwODE5MTc1ODQ4WjCBijEMMAoGA1UE\nBhMDVVNBMQswCQYDVQQIEwJhYmMxDTALBgNVBAcTBGFiYzEMMAoGA1UEChMDYWJj\nMQwwCgYDVQQLEwNhYmMxDDAKBgNVBAMTA2FiYzCCASIwDQYJKoZIhvcNAQEBBQAD\nggEPADCCAQoCggEBAOJMznFNHIxnXok2yaV3Ll3qhrCjHJcm5fPPtFwweub3rWoY\nDD/1hXfpcD1T59uJGqq2JO9kMEvTuHLoe2+J9WWGo+W21iPICpSfIBMcrNar20i4\naYaID5N5ehRbd/GBkxRdUcpZKPLMkB0wFjU4XGB642LInxA6RLCpX+gyu3ytJ4Dl\n8sIWLCSwwiiKYuLEGF6XEDXhfcYZ/F4TmsJOMcCypcw40hsoeQzb0W2oXPBSsj5x\nx4bZm/YFDBcb1yex+QhpXYN3WGEWLMuYSM29m1et9gLynfBsdn3aB278r/Xgyvq5\nkcz6FdZoBpIw/ZhRuCy8Enx3ro5iAYGNFqZdQc8CAwEAATANBgkqhkiG9w0BAQsF\nAAOCAQEAGGNk/Gi02xb/U6+T9eRwWko12RPKQwirwt4N78/ToRS5yI0IxwND/Rtp\nvcdVp7QqQXFoyLgyll7k8fch7R1AfKPzVKiefkHwOz+rBsiVWeRouaziwT3HlEYF\nm57xcIdfAdcemSQ1JkvivrgO7+cyr2vr75AbeZiEvzTML8w5Qy7AsTHeB9NpzwEo\nfUa0blHeuPtt6i95WuJQgLyld3soi2IPLXKQb6skTaKhQgC5KWBS6FaziMibmcvt\nN4UrZbDfCO0yu+Hhutybpztw6l/U9fytiq2NrnCiUAQ9Hpmm4TJZuerAb2NX620F\nDL9Ha0wKNaTxSKRPP+t89Z+5VV1lwg==\n-----END CERTIFICATE-----", "validity": "Valid" }, "$$ref": "#/components/examples/ComViptelaVmanageServerIdpcertificateapiResponseExampleGetidpcertificateresponse" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Settings-read" } }, "/idpcertificate/CSR": { "put": { "tags": [ "IDP Certificate Management" ], "summary": "Generate Certificate Signing Request for IDP Certificate", "description": "Generate Certificate Signing Request for IDP Certificate", "operationId": "renewCSR", "requestBody": { "description": "IDP Certificate configuration", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "IDP Certificate Request": { "description": "IDP Certificate Request", "value": { "company_name": "abc", "org_unit": "abc", "org": "abc", "location": "abc", "state": "abc", "country": "US", "email": "abc@cisco.com", "subject_alternative_name_dns": [ "www.example.com" ], "rsa_key_length": "2048" }, "$$ref": "#/components/examples/ComViptelaVmanageServerIdpcertificateapiRequestExamplePostidpcsrrequest" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "IDP Certificate Response": { "description": "IDP Certificate Response", "value": { "id": "12345678-1234-1234-1234-123456789abc" }, "$$ref": "#/components/examples/ComViptelaVmanageServerIdpcertificateapiResponseExamplePostidpcsrresponse" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Settings-write" }, "post": { "tags": [ "IDP Certificate Management" ], "summary": "Generate Certificate Signing Request for IDP Certificate", "description": "Generate Certificate Signing Request for IDP Certificate", "operationId": "genCSR", "requestBody": { "description": "IDP Certificate configuration", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "IDP Certificate Request": { "description": "IDP Certificate Request", "value": { "company_name": "abc", "org_unit": "abc", "org": "abc", "location": "abc", "state": "abc", "country": "US", "email": "abc@cisco.com", "subject_alternative_name_dns": [ "www.example.com" ], "rsa_key_length": "2048" }, "$$ref": "#/components/examples/ComViptelaVmanageServerIdpcertificateapiRequestExamplePostidpcsrrequest" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "IDP Certificate Response": { "description": "IDP Certificate Response", "value": { "id": "12345678-1234-1234-1234-123456789abc" }, "$$ref": "#/components/examples/ComViptelaVmanageServerIdpcertificateapiResponseExamplePostidpcsrresponse" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Settings-write" }, "get": { "tags": [ "IDP Certificate Management" ], "summary": "Obtain Certificate Signing Request", "description": "Retrieve Certificate Signing Request Generated for IDP Certificate", "operationId": "getCSR_IdpCertificateManagement_1903", "parameters": [ { "name": "withParam", "in": "query", "schema": { "type": "boolean" } }, { "name": "download", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "IDP CSR Response": { "description": "IDP CSR Response", "value": "-----BEGIN CERTIFICATE REQUEST-----\nMIICyzCCAbMCAQAwgYQxCzAJBgNVBAYTAlVTMQwwCgYDVQQIDANhYmMxDDAKBgNV\nBAcMA2FiYzEMMAoGA1UECgwDYWJjMQwwCgYDVQQLDANhYmMxDDAKBgNVBAMMA2Fi\nYzEfMB0GCSqGSIb3DQEJARYQYWJjQGNpc2NvLmNvbTAJBgNVBAYTAlVTMB0GA1UE\nAwwWd3d3LmV4YW1wbGUuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKC\nAQEA1234567890abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUV\nWXYZ1234567890abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWX\nYZ1234567890abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ\n1234567890abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234\n567890abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890\nabcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890abcdef\nghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890abcdefghij\nklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890abcdefghijklmn\nopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZwIDAQABoAAwDQYJKoZIhvcNAQEL\nBQADggEBAKqGSIb3DQEBAQUAA4GNADCBiQKBgQC/1234567890abcdefghijklmn\nopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890abcdefghijklmnop\nqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890abcdefghijklmnopqr\nstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZwIDAQAB\n-----END CERTIFICATE REQUEST-----", "$$ref": "#/components/examples/ComViptelaVmanageServerIdpcertificateapiResponseExampleGetidpcsrresponse" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Settings-read" } }, "/idpcertificate/renew": { "post": { "tags": [ "IDP Certificate Management" ], "summary": "Renew IDP self-signed certificate", "description": "Renew IDP certificate for Self-Signed Certificates only", "operationId": "renewIDPCertificate", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "Renew IDP Certificate Response": { "description": "Renew IDP Certificate Response", "value": { "success": "IDP certificate renewed successfully" }, "$$ref": "#/components/examples/ComViptelaVmanageServerIdpcertificateapiResponseExamplePostrenewidpcertresponse" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Settings-write" } }, "/idpcertificate/signed": { "post": { "tags": [ "IDP Certificate Management" ], "summary": "Import a signed IDP certificate", "description": "Import a signed IDP certificate for SSO Configuration", "operationId": "importIDPCertificate", "requestBody": { "description": "IDP Certificate configuration", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Import IDP Certificate Request": { "description": "Import IDP Certificate Request", "value": "-----BEGIN CERTIFICATE-----\nMIIDhDCCAmwCCQCcDeb1sPMdpjANBgkqhkiG9w0BAQsFADCBhjELMAkGA1UEBhMC\nVVMxEzARBgNVBAgTCkNhbGlmb3JuaWExETAPBgNVBAcTCFNhbiBKb3NlMRUwEwYD\nVQQLEwx2SVB0ZWxhIFRlc3QxFDASBgNVBAoTC3ZJUHRlbGEgSW5jMSIwIAYJKoZI\nhvcNAQkBFhNzYW50b3NoQHZpcHRlbGEuY29tMB4XDTIzMDYwMzE1MDM1MFoXDTM0\nMDUzMTE1MDM1MFowgYAxFzAVBgNVBAMMDnZtbmdfc2NhbGVfaW5kMQswCQYDVQQG\nEwJJTjESMBAGA1UECAwJS2FybmF0YWthMRIwEAYDVQQHDAlCYW5nYWxvcmUxFzAV\nBgNVBAoMDnZtbmdfc2NhbGVfaW5kMRcwFQYDVQQLDA52bW5nX3NjYWxlX2luZDCC\nASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAL9ZSFCz5JKuUUobW6sjela8\nXJa3BwJpza8GjALlYiseVW93vAI3cgn90pO/eXETG5e8EEj8/N3HTqIgbpcooHTf\nUuzfwjIXR5FWlbaDLsJEAXVDFiv3MDtGQ/RtFrrw49OBtlhAG3AmEkaMZ63dOksQ\nv5y9wu0XfDoLmkg0q47NlJ682j2KjcsLud68Vn6y7OWmzk8B2ErV3SP4dwpaDzic\n0BfOdn5oSXX+wGKpbJ0n5hCuwDreyDpsO5jJ5UYr1eUpvH4Sj2llli/n+7BOjLCT\n3Jy9RXotiajSxx1k0sNYuajcWw5qxzGAJes9R4fPqBSvKq/G3Lyc4tinwBOWLEMC\nAwEAATANBgkqhkiG9w0BAQsFAAOCAQEAjr1EajpucmaQmwHb+J531NxivLzhVxlu\n3F+Bklo4JLxoo/2CImjuE3X5NNed5qj4v1zgjPPxSSyOGcbXreiodXOSRsGpb6+I\n7AlPZRboS52Y6Zigwnw8HIBCINMkII2wNVY+gYJzFPg58UJobdedx7qNS+Pyu6W3\navGXOGXEREzAqzE5WP+csV/5Too62EwAV3cT3vElpdE3kASHzNFJfbu9xctrQHeF\njxOweOjsbMuikOSyRaYJqs0H4gQcP2Vyb9i+unHvPGKZruhFLsGdIxNq/FPv5cMx\naNH3W/qegrUYlcdeCH6zRxXRJSTxy1f7114TMP039Zhphd0O6gNVrA==\n-----END CERTIFICATE-----", "$$ref": "#/components/examples/ComViptelaVmanageServerIdpcertificateapiRequestExamplePostsignedrequest" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "Import IDP Certificate Response": { "description": "Import IDP Certificate Response", "value": { "certificateDetails": "-----BEGIN CERTIFICATE-----\nMIIG4TCCBUmgAwIBAgILEav/rOZdXZnl1C0wDQYJKoZIhvcNAQELBQAwWjELMAkG\nA1UEBhMCREUxETAPBgNVBAoMCE9wZW5YUEtJMQwwCgYDVQQLDANQS0kxKjAoBgNV\nBAMMIU9wZW5YUEtJIERlbW8gSXNzdWluZyBDQSAyMDI0MDUyMTAeFw0yNTA4MTkx\nNzQ3MThaFw0yNjA4MTkxNzQ3MThaMGUxEzARBgoJkiaJk/IsZAEZFgNvcmcxGDAW\nBgoJkiaJk/IsZAEZFghPcGVuWFBLSTEfMB0GCgmSJomT8ixkARkWD1Rlc3QgRGVw\nbG95bWVudDETMBEGA1UEAwwKTWFudWFsRGVtbzCCAiIwDQYJKoZIhvcNAQEBBQAD\nggIPADCCAgoCggIBAOJ6VWxMO5nFdDq17IuEopS2kJ7SM3hnC9+rewEaqKBCDYJz\nFSwsQkyPMFNIFIXM5gIMCksgXkPiRRiBAzfwBL/WUjLn2GWCr7Oc9QVz+vbzBdvN\nRwDeCGZF2KiyGrP/EUiw9tS+uGA8WkQTF0Lxyc6EjHJo7hhAEA4zSezS4WM+GcV8\n36JLFLGBr7IcMcP8I1mwAsVZyy/5sGAwbA5DOP/v6SaAPOud3kxnyN+ghg7EnOIW\nO3f1nl5KC5bvDQku3GBISQxgPXXjFWnQ2b1eV7IxQcnYRKyzXmgxlYpaTWZ1eLaP\nZ6rjjF61ycptqtzW62AXyXhm6XcOKSIEu/M+oam3FSZWmryGiwMJd0edNOwyzsy4\nem6/NuRKpG0fWpawpm4X8DZHaVZM2anydWfGIUCcB2NyUoRJDf27sj9eF4Wj7qeX\nFlwW9dpc6iuVpBFiZVlx4paLxPbCJCrOep6Th/g1QoAoADRhj3S+ebsEXldODIwB\narYuw2B/BQfbuOYK+AuokNo9GksLhfFs+pw/AHWCVVcjzu0vKtoP95kW0kWyDW77\n7EXBdx9p8Yz5XyS97796lp2Yi0sWxyoBk7HefrQgZGBCERzNn71W0xoBWqj0Hayh\nJLX+fVihi6sa8Ha+6ehA2rO0RyDetkh2lnwwU0kXSsOLbNujYlMn5VwYv+EjAgMB\nAAGjggIbMIICFzCBhwYIKwYBBQUHAQEEezB5MFEGCCsGAQUFBzAChkVodHRwOi8v\ncGtpLmV4YW1wbGUuY29tL2Rvd25sb2FkL09wZW5YUEtJX0RlbW9fSXNzdWluZ19D\nQV8yMDI0MDUyMS5jZXIwJAYIKwYBBQUHMAGGGGh0dHA6Ly9vY3NwLmV4YW1wbGUu\nY29tLzAfBgNVHSMEGDAWgBRMcgN7qrDOHw63zUTVilGJaA+LhDAMBgNVHRMBAf8E\nAjAAMFYGA1UdHwRPME0wS6BJoEeGRWh0dHA6Ly9wa2kuZXhhbXBsZS5jb20vZG93\nbmxvYWQvT3BlblhQS0lfRGVtb19Jc3N1aW5nX0NBXzIwMjQwNTIxLmNybDATBgNV\nHSUEDDAKBggrBgEFBQcDATAOBgNVHQ8BAf8EBAMCBaAwgagGA1UdIASBoDCBnTCB\nmgYDKgMEMIGSMCsGCCsGAQUFBwIBFh9odHRwOi8vcGtpLmV4YW1wbGUuY29tL2Nw\ncy5odG1sMCsGCCsGAQUFBwIBFh9odHRwOi8vcGtpLmV4YW1wbGUuY29tL2Nwcy5o\ndG1sMDYGCCsGAQUFBwICMCoaKFRoaXMgaXMgYSBjb21tZW50IGZvciBwb2xpY3kg\nb2lkIDEuMi4zLjQwFQYDVR0RBA4wDIIKZnJ1aXRzLmNvbTAdBgNVHQ4EFgQUjNFy\nbcX06vuUovxNWhi4RylWXPAwDQYJKoZIhvcNAQELBQADggGBAA7f2sTv4lRNj9dn\n2XqEzEsYkT2aGNKlWFb1cOt036sIRrpKcuFMP/YaFVQ7nuzRQsEJq5ho01vGl9Ei\nN72KE3WxhzXOZb59cU5fjRPZT4ib3oELtbWJvFOpZt/jlxJz0D2FUBx25uGjrVtv\nMH+YTYDmHx2kXuHJ7594n5ZXAsixuOWyJw2KRIFyWkQ9zI1n+pyP5hSi4myKJmy7\nozYoAQ6abqQxoJJ0pgyH9vu4fBz1elnfKCxjU2gBMtO2MnyHSKb6thsVrdvCR5Wi\nySGrAtB/UmwXoO6+4cW7Yhjibv+de/tcgR9T8nUuJoY62WDYqHRTw9eIyYHi73bI\naKGFUmeV0XimrtTsznvlaHNuGlh/ly3p2jzz5EN4CBSVgBgNw07wtGcFPfCPOw4J\n24AeJz9cd6jHHbEzmpwgLF+Omd99GjdKRMtKwinpwBGFJpYAPjF214VF4aFsT8TS\nJ5HqsCFqpoYc1msMy5LxzM5twANEnEyaZtK03Sjumr3bWDY06A==\n-----END CERTIFICATE-----" }, "$$ref": "#/components/examples/ComViptelaVmanageServerIdpcertificateapiResponseExamplePostsignedresponse" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Settings-write" } }, "/jobs/batch": { "post": { "tags": [ "Jobs - Batch" ], "description": "Batch processing multiple REST API calls", "operationId": "batchExecute", "requestBody": { "description": "Payload for executing multiple APIs", "content": { "application/json": { "schema": { "required": [ "data" ], "type": "object", "properties": { "auditLog": { "type": "string", "description": "AuditLog feature" }, "data": { "type": "array", "description": "payload for a REST API", "items": { "type": "object", "properties": { "description": { "type": "string", "description": "API description" }, "method": { "type": "string", "description": "HTTP Method", "enum": [ "POST", "PUT", "GET", "DELETE" ] }, "payload": { "type": "object", "description": "JSON Payload for a REST API call" }, "uri": { "type": "string", "example": "/dataservice/settings/configuration/proxyHttpServer" } }, "description": "payload for a REST API", "$$ref": "#/components/schemas/BatchFlowData" } }, "description": { "type": "string", "description": "Workflow description" }, "jobkey": { "type": "string", "description": "Job Key" }, "name": { "type": "string", "description": "Workflow name" } }, "description": "Input to multiple REST API calls", "$$ref": "#/components/schemas/BatchFlow" }, "examples": { "Batched API calls": { "description": "Batched API calls", "value": "{\n \"data\": [\n {\n \"uri\": \"/dataservice/settings/configuration/proxyHttpServer\",\n \"method\": \"POST\",\n \"payload\": {\n \"proxy\": true,\n \"proxyIp\": \"64.102.255.47\",\n \"proxyPort\": \"80\",\n \"NoProxyList\": \"169.254.8.1|::1|localhost|127.0.0.1\"\n }\n },\n {\n \"uri\": \"/dataservice/settings/configuration/proxyHttpServer\",\n \"method\": \"PUT\",\n \"payload\": {\n \"proxy\": true,\n \"proxyIp\": \"64.102.255.47\",\n \"proxyPort\": \"80\",\n \"NoProxyList\": \"169.254.6.1|::1|localhost|127.0.0.1\"\n }\n }\n ],\n}" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "Batch API Response": { "description": "Batch API Response" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/localization/supportedLocales": { "get": { "tags": [ "Locale" ], "description": "Get Supported locales", "operationId": "getSupportedLocales", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "Status": { "description": "Status", "value": "{\n \"locales\": [\n {\n \"code\": \"en_US\",\n \"displayName\": \"English (US)\"\n },\n {\n \"code\": \"fr_CA\",\n \"displayName\": \"French (Canadian)\"\n }\n {\n \"code\": \"ja_JP\",\n \"displayName\": \"Japanese (Japan)\"\n }\n ]\n}" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "admin" } }, "/management/category": { "get": { "tags": [ "Management" ], "description": "Get vManage resource category", "operationId": "getCategory", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "vManage resource category": { "description": "vManage resource category", "value": {} } } } } }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/management/vManageResourceUtilization": { "get": { "tags": [ "Management" ], "description": "Get vManage resource utilization", "operationId": "getvManageResourceUtilization", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "vManage resource utilization": { "description": "vManage resource utilization", "value": {} } } } } }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/mdp/attachDevices/{nmsId}": { "put": { "tags": [ "Configuration - Multidomain Policy" ], "description": "Edit attached devices", "operationId": "updateAttachedDevices", "parameters": [ { "name": "nmsId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "deviceList", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "devices": { "description": "devices", "value": {} } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Status": { "description": "Status", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "Configuration - Multidomain Policy" ], "description": "Retrieve MDP attached devices", "operationId": "getMappedDevices", "parameters": [ { "name": "nmsId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "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" } } }, "post": { "tags": [ "Configuration - Multidomain Policy" ], "description": "Share devices with MDP", "operationId": "attachDevices", "parameters": [ { "name": "nmsId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "deviceList", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Devices": { "description": "Devices", "value": {} } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Status": { "description": "Status", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/mdp/detachDevices/{nmsId}": { "post": { "tags": [ "Configuration - Multidomain Policy" ], "description": "Disconnect devices from mpd controller", "operationId": "detachDevices", "parameters": [ { "name": "nmsId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "deviceList", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Onboard": { "description": "Onboard", "value": {} } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Status": { "description": "Status", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/mdp/devices/{nmsId}": { "get": { "tags": [ "Configuration - Multidomain Policy" ], "description": "Retrieve MDP supported devices", "operationId": "getDevices_ConfigurationMultidomainPolicy_2003", "parameters": [ { "name": "nmsId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "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" } } } }, "/mdp/disconnect/{nmsId}": { "get": { "tags": [ "Configuration - Multidomain Policy" ], "description": "disconnect from mpd controller", "operationId": "disconnectMDP", "parameters": [ { "name": "nmsId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "status": { "description": "status", "value": [] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "admin" } }, "/mdp/onboard": { "post": { "tags": [ "Configuration - Multidomain Policy" ], "description": "Start MDP onboarding operation", "operationId": "onboardMDP", "requestBody": { "description": "Onboard", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "onboarding-payload": { "description": "onboarding-payload", "value": { "controllerUUID": "fc335c24-fb30-46bb-81ff-fda84264eb58", "name": "sdwane2e", "description": "sdwan24", "requestStream": "request-sdwane2e-fc335c24-fb30-46bb-81ff-fda84264eb58", "responseStream": "response-sdwane2e-fc335c24-fb30-46bb-81ff-fda84264eb58", "otp": "CB3313CD-0FE1-BAF3-6DFE-D4F797C35BF0", "uri": "10.10.10.1:24038" } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "nmsId": { "description": "nmsId", "value": { "nmsId": "fc335c24-fb30-46bb-81ff-fda84264eb58" } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "admin" } }, "/mdp/onboard/status": { "get": { "tags": [ "Configuration - Multidomain Policy" ], "description": "Get MDP onboarding status", "operationId": "getOnboardingPayload", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "Status": { "description": "Status", "value": { "status": "completed" } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "admin" } }, "/mdp/onboard/{nmsId}": { "put": { "tags": [ "Configuration - Multidomain Policy" ], "description": "update MDP onboarding document", "operationId": "updateOnboardingPayload", "parameters": [ { "name": "nmsId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Onboard", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "onboarding-payload": { "description": "onboarding-payload", "value": { "controllerUUID": "fc335c24-fb30-46bb-81ff-fda84264eb58", "name": "sdwane2e", "description": "sdwan24", "requestStream": "request-sdwane2e-fc335c24-fb30-46bb-81ff-fda84264eb58", "responseStream": "response-sdwane2e-fc335c24-fb30-46bb-81ff-fda84264eb58", "otp": "CB3313CD-0FE1-BAF3-6DFE-D4F797C35BF0", "uri": "10.10.10.1:24038" } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "nmsId": { "description": "nmsId", "value": { "nmsId": "fc335c24-fb30-46bb-81ff-fda84264eb58" } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "admin" }, "delete": { "tags": [ "Configuration - Multidomain Policy" ], "description": "offboard the mdp application", "operationId": "deleteOnboardingPayload", "parameters": [ { "name": "nmsId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "admin" } }, "/mdp/policies/mdpconfig": { "put": { "tags": [ "Configuration - Multidomain Policy" ], "description": "Add internal policy from Manager", "operationId": "addInternalPolicy", "requestBody": { "description": "addInternalPolicy", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "mdpConfig-payload": { "description": "mdpConfig-payload", "value": { "controllerUUID": "fc335c24-fb30-46bb-81ff-fda84264eb58", "name": "sdwane2e", "description": "sdwan24", "requestStream": "request-sdwane2e-fc335c24-fb30-46bb-81ff-fda84264eb58", "responseStream": "response-sdwane2e-fc335c24-fb30-46bb-81ff-fda84264eb58", "otp": "CB3313CD-0FE1-BAF3-6DFE-D4F797C35BF0", "uri": "10.10.10.1:24038" } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "deviceId": { "description": "deviceId", "value": { "deviceId": "fc335c24-fb30-46bb-81ff-fda84264eb58" } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "admin" } }, "/mdp/policies/mdpconfig/{deviceId}": { "get": { "tags": [ "Configuration - Multidomain Policy" ], "description": "Retrieve MDP ConfigObject", "operationId": "getMdpConfig", "parameters": [ { "name": "deviceId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "MdpConfig": { "description": "MdpConfig", "value": [] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/mdp/policies/{nmsId}": { "get": { "tags": [ "Configuration - Multidomain Policy" ], "description": "Retrieve MDP policies", "operationId": "getPolicies", "parameters": [ { "name": "nmsId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "Policies": { "description": "Policies", "value": [] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "Configuration - Multidomain Policy" ], "description": "update policy status", "operationId": "updatePolicyStatus", "parameters": [ { "name": "nmsId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "policyList", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "policies": { "description": "policies", "value": {} } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Status": { "description": "Status", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/messaging/device/vmanage": { "get": { "tags": [ "Device - Messaging" ], "description": "Create device vManage connection list", "operationId": "createDeviceVmanageConnectionList", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "deviceIP": { "type": "string", "example": "172.16.255.26" }, "vmanages": { "type": "array", "items": { "type": "string" } } }, "$$ref": "#/components/schemas/MessagingResp" } }, "examples": { "Connection list": { "description": "Connection list", "value": [ { "deviceIP": "172.16.255.26", "vmanages": [ "172.16.255.22" ] } ] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/monitor/sdavccloudconnector/domain": { "get": { "tags": [ "SD AVC Domain-based App Rules" ], "description": "Get SD AVC App Rules based on Domain for O365", "operationId": "getCloudConnectorDomainAppRules", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "SD AVC App Rules based on Domain for O365": { "description": "SD AVC App Rules based on Domain for O365", "value": { "header": { "generatedOn": "1717196694387", "viewKeys": { "uniqueKey": [], "preferenceKey": "grid-M365Domains" }, "columns": [ { "title": "Application Name", "property": "appName", "dataType": "string" }, { "title": "Domain", "property": "domainName", "dataType": "string" }, { "title": "Service Area", "property": "serviceArea", "dataType": "string" }, { "title": "Service Instance", "property": "serviceInstance", "dataType": "string" }, { "title": "Allow or Optimize", "property": "allowOrOptimize", "dataType": "string" }, { "title": "Updated By", "property": "updatedBy", "dataType": "string" }, { "title": "Last Updated", "property": "lastUpdated", "displayFormat": "DD MMM YYYY h:mm:ss A z", "inputFormat": "unix-time", "dataType": "date" } ], "fields": [ { "property": "appName", "dataType": "string" }, { "property": "domainName", "dataType": "string" }, { "property": "serviceArea", "dataType": "string" }, { "property": "serviceInstance", "dataType": "string" }, { "property": "allowOrOptimize", "dataType": "string" }, { "property": "updatedBy", "dataType": "string" }, { "property": "lastUpdated", "dataType": "string" } ] }, "data": [ { "appName": "windows-azure", "domainName": "informationprotection.azure.com", "serviceInstance": "worldwide", "serviceArea": "common" }, { "appName": "ms-services", "domainName": "dc.services.visualstudio.com", "serviceInstance": "worldwide", "serviceArea": "common" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/monitor/sdavccloudconnector/ipaddress": { "get": { "tags": [ "SD AVC IP Address based App Rules" ], "description": "Get SD AVC App Rules based on IP Address for O365", "operationId": "getCloudConnectorIpAddressAppRules", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "SD AVC App Rules based on IP Address for O365": { "description": "SD AVC App Rules based on IP Address for O365", "value": { "header": { "generatedOn": "1717197416346", "viewKeys": { "uniqueKey": [], "preferenceKey": "grid-M365IPAddresses" }, "columns": [ { "title": "Application Name", "property": "appName", "dataType": "string" }, { "title": "IP Address", "property": "ip", "dataType": "string" }, { "title": "Port", "property": "port", "dataType": "string" }, { "title": "L4 Protocol", "property": "l4Protocol", "dataType": "string" }, { "title": "Service Area", "property": "serviceArea", "dataType": "string" }, { "title": "Allow or Optimize", "property": "allowOrOptimize", "dataType": "string" }, { "title": "Service Instance", "property": "serviceInstance", "dataType": "string" }, { "title": "Updated By", "property": "updatedBy", "dataType": "string" }, { "title": "Last Updated", "property": "lastUpdated", "displayFormat": "DD MMM YYYY h:mm:ss A z", "inputFormat": "unix-time", "dataType": "date" } ], "fields": [ { "property": "appName", "dataType": "string" }, { "property": "ip", "dataType": "string" }, { "property": "port", "dataType": "string" }, { "property": "l4Protocol", "dataType": "string" }, { "property": "serviceArea", "dataType": "string" }, { "property": "allowOrOptimize", "dataType": "string" }, { "property": "serviceInstance", "dataType": "string" }, { "property": "updatedBy", "dataType": "string" }, { "property": "lastUpdated", "dataType": "date" } ] }, "data": [ { "appName": "ms-services", "ip": "101.28.252.0/24", "port": "N/A", "l4Protocol": "TCP", "serviceInstance": "china", "serviceArea": "common", "allowOrOptimize": "allow" }, { "appName": "share-point", "ip": "104.146.128.0/17", "port": "N/A", "l4Protocol": "TCP", "serviceInstance": "worldwide", "serviceArea": "sharepoint", "allowOrOptimize": "optimize" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/monitor/sdavccloudconnector/webex": { "get": { "tags": [ "SD AVC Webex App Rules" ], "description": "Get SD AVC App Rules for Webex", "operationId": "getWebexAppData", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "SD AVC App Rules for Webex": { "description": "SD AVC App Rules for Webex", "value": { "header": { "generatedOn": "1717197352724", "viewKeys": { "uniqueKey": [], "preferenceKey": "grid-Webex" }, "columns": [ { "title": "Application Name", "property": "appName", "dataType": "string" }, { "title": "Service Area", "property": "serviceArea", "dataType": "string" }, { "title": "IP Address", "property": "ip", "dataType": "string" }, { "title": "Port", "property": "port", "dataType": "string" }, { "title": "L4 Protocol", "property": "l4Protocol", "dataType": "string" }, { "title": "Quality of Service", "property": "qos", "dataType": "string" }, { "title": "Primary or Fallback", "property": "primaryOrFallback", "dataType": "string" }, { "title": "Region", "property": "region", "dataType": "string" }, { "title": "Updated By", "property": "updatedBy", "dataType": "string" }, { "title": "Last Updated", "property": "lastUpdated", "displayFormat": "DD MMM YYYY h:mm:ss A z", "inputFormat": "unix-time", "dataType": "date" } ], "fields": [ { "property": "appName", "dataType": "string" }, { "property": "serviceArea", "dataType": "string" }, { "property": "ip", "dataType": "string" }, { "property": "port", "dataType": "string" }, { "property": "l4Protocol", "dataType": "string" }, { "property": "qos", "dataType": "string" }, { "property": "primaryOrFallback", "dataType": "string" }, { "property": "region", "dataType": "string" }, { "property": "updatedBy", "dataType": "string" }, { "property": "lastUpdated", "dataType": "date" } ] }, "data": [ { "appName": "webex-meeting", "ip": "114.29.192.0/19", "port": "N/A", "l4Protocol": "TCP", "serviceArea": "meetings", "qos": "default", "primaryOrFallback": "default" }, { "appName": "webex-meeting", "ip": "128.177.36.0/24", "port": "19560-65535", "l4Protocol": "UDP", "serviceArea": "calling", "qos": "optimizemedia", "primaryOrFallback": "default" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/msla/assignLicenses": { "post": { "tags": [ "SmartLicensing - Licenses" ], "description": "Assign msla licenses to devices", "operationId": "assignMslaLicensesToDevices", "requestBody": { "description": "List of devices for assigning licenses", "content": { "application/json": { "schema": { "type": "object", "properties": { "baseLicense": { "type": "object", "properties": { "billing_type": { "type": "string", "example": "PREPAID" }, "license_type": { "type": "string", "example": "DEMO" }, "saId": { "type": "string", "example": "316449" }, "subscription_id": { "type": "string", "example": "2425252522" }, "tag": { "type": "string", "example": "regid.2020-10.com.cisco.DSTACK_T0_P,1.0_5446d77e-a22d-4343-a9f9-cefb53116b22" }, "vaId": { "type": "string", "example": "703805" } }, "$$ref": "#/components/schemas/AssignMslaLicensesBaseLicense" }, "tenantLicense": { "type": "array", "items": { "type": "object", "properties": { "billing_type": { "type": "string", "example": "PREPAID" }, "count": { "type": "integer", "format": "int32", "example": 4 }, "license_type": { "type": "string", "example": "TERM" }, "saId": { "type": "string", "example": "316448" }, "subscription_id": { "type": "string", "example": "6376389267" }, "tag": { "type": "string", "example": "regid.2020-10.com.cisco.DSTACK_T0_P,1.0_5446d77e-a22d-4343-a9f9-cefb53116b22" }, "vaId": { "type": "string", "example": "702544" } }, "$$ref": "#/components/schemas/AssignMslaLicensesTenantLicense" } }, "uuid": { "type": "array", "items": { "type": "string" } } }, "$$ref": "#/components/schemas/AssignMslaLicenses" } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/msla/devices": { "put": { "tags": [ "MSLA" ], "description": "Release licenses assigned to the devices", "operationId": "releaseLicenses_Msla_1303", "requestBody": { "description": "List of devices for unassigning licenses", "content": { "application/json": { "schema": { "type": "object", "properties": { "devices": { "type": "array", "description": "List of device UUIDs", "items": { "type": "string", "description": "List of device UUIDs" } } }, "$$ref": "#/components/schemas/ReleaseLicensesRequest" } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "MSLA" ], "description": "Retrieve list of devices and their subscription information", "operationId": "getMSLADevices_Msla_1303", "parameters": [ { "name": "site-id", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "License_status": { "type": "string", "example": "subscribed" }, "UUID": { "type": "string", "example": "d8ac4576-7085-4d51-a6a1-f09600755677" }, "configuredSystemIP": { "type": "string", "example": "172.16.254.3" }, "deviceModel": { "type": "string", "example": "vedge-cloud" }, "hostName": { "type": "string", "example": "vm4" }, "hsecCompatible": { "type": "string", "example": "No" }, "hsecStatus": { "type": "string", "example": "-" }, "licenseType": { "type": "string", "example": "prepaid" }, "licenses": { "type": "array", "items": { "type": "string" } }, "msla": { "type": "string", "example": "false" }, "saAccount": { "type": "string", "example": "316448" }, "saNamme": { "type": "string", "example": "testaccount1.viptela.com" }, "subscription_id": { "type": "array", "items": { "type": "string" } }, "tag": { "type": "array", "items": { "type": "string" } }, "templateName": { "type": "string", "example": "t1" }, "vaAccount": { "type": "array", "items": { "type": "string" } }, "vaName": { "type": "string", "example": "vManage_SDWAN_01" } }, "$$ref": "#/components/schemas/GetSingleMslaDevicePayload" } } }, "$$ref": "#/components/schemas/GetMslaDevicesPayload" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/msla/devices/{uuid}": { "get": { "tags": [ "SmartLicensing - Licenses" ], "description": "Get licenses associated to device", "operationId": "getLicenseByUuid_SmartlicensingLicenses_2003", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "properties": { "empty": { "type": "boolean" } }, "items": { "type": "object", "properties": { "billing_model": { "type": "string", "example": "committed" }, "billing_type": { "type": "string", "example": "PREPAID" }, "display_name": { "type": "string", "example": "Routing DNA Advantage: Tier 2" }, "end_date": { "type": "string", "example": "2025-Nov-08" }, "inUse": { "type": "string", "example": "4" }, "license_category": { "type": "string", "example": "regular" }, "license_type": { "type": "string", "example": "TERM" }, "saname": { "type": "string", "example": "testaccount1.viptela.com" }, "start_date": { "type": "string", "example": "2023-Aug-29" }, "subscription_id": { "type": "string", "example": "SR100446" }, "tag": { "type": "string", "example": "regid.2020-10.com.cisco.DSTACK_T2_A,1.0_b072e613-aa2c-4ed0-ab46-ae91ddc7dfb5" }, "vaname": { "type": "string", "example": "DEFAULT" } }, "$$ref": "#/components/schemas/GetDeviceLicensesInner" }, "$$ref": "#/components/schemas/GetDeviceLicenses" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/msla/licenses": { "get": { "tags": [ "SmartLicensing - Licenses" ], "description": "Get all the licenses", "operationId": "getMslaLicenses", "parameters": [ { "name": "uuid", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "properties": { "empty": { "type": "boolean" } }, "items": { "type": "object", "properties": { "available": { "type": "string", "example": "30" }, "billing_type": { "type": "string", "example": "prepaid" }, "display_name": { "type": "string", "example": "Routing DNA Premier: Tier 3" }, "end_date": { "type": "string", "example": "024-Feb-25" }, "inUse": { "type": "string", "example": "5" }, "license_category": { "type": "string", "example": "Tenant" }, "saname": { "type": "string", "example": "testaccount1.viptela.com" }, "subscription_id": { "type": "string", "example": "77823882922" }, "tag": { "type": "string", "example": "regid.2020-10.com.cisco.DSTACK_T3_P,1.0_4fbf7891-fdee-4b78-9d70-696b260ef347" }, "vaname": { "type": "string", "example": "DEFAULT" } }, "$$ref": "#/components/schemas/MslaLicensesInner" }, "$$ref": "#/components/schemas/MslaLicenses" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/msla/licenses/compliance": { "get": { "tags": [ "MSLA" ], "description": "Retrieve list of devices and their subscription information", "operationId": "getLicensesCompliance", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "Status": { "description": "Status", "value": { "data": { "complianceStatus": [ { "complianceStatus": "compliant", "reason": "sync complete" }, { "complianceStatus": "Out Of Compliance", "reason": "unassignedDevice" } ], "status": "Out Of Compliance" } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/msla/licenses/sync": { "post": { "tags": [ "MSLA" ], "description": "Retrieve MSLA subscription/licenses", "operationId": "syncLicenses_Msla_1904", "requestBody": { "description": "Sync license", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Sync license": { "description": "Sync license", "value": {} } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Subscription license": { "description": "Subscription license", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true, "x-roles-required": "License Management-write" } }, "/msla/monitoring/licensedDeviceCount": { "get": { "tags": [ "SmartLicensing - Licenses" ], "description": "Get licenses associated to device", "operationId": "getDeviceDetailsForDashboard", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/msla/monitoring/licensedDistributionDetails": { "get": { "tags": [ "SmartLicensing - Licenses" ], "description": "Get all license distribution", "operationId": "getLicenseDistributionDetails", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "object", "properties": { "display_name": { "type": "string", "example": "somename" }, "lastUpdated": { "type": "string", "example": "1706830360239" }, "tag": { "type": "string", "example": "regid.2020-10.com.cisco.DSTACK_T0_P,1.0_5446d77e-a22d-4343-a9f9-cefb53116b22" }, "totalDevices": { "type": "integer", "format": "int32", "example": 1 }, "totalLicense": { "type": "integer", "format": "int32", "example": 1 } }, "$$ref": "#/components/schemas/LicenseDistributionResult" } }, "$$ref": "#/components/schemas/LicenseDistribution" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/msla/monitoring/packagingDistributionDetails": { "get": { "tags": [ "SmartLicensing - Licenses" ], "description": "Get all license distribution", "operationId": "getPackagingDistributionDetails", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "availableCssm": { "type": "integer", "format": "int32", "example": 1 }, "license": { "type": "string", "example": "Routing DNA Advantage: Tier 0" }, "usedCssm": { "type": "string", "example": "33" }, "usedVmanage": { "type": "integer", "format": "int32", "example": 1 } }, "$$ref": "#/components/schemas/PackagingDistributionData" } }, "$$ref": "#/components/schemas/PackagingDistribution" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/msla/template": { "get": { "tags": [ "MSLA" ], "description": "Retrieve all MSLA template", "operationId": "getAllTemplate", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Subscription": { "description": "Subscription", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true, "x-roles-required": "License Management-read" } }, "/msla/template/licenses": { "post": { "tags": [ "MSLA" ], "description": "Retrieve MSLA subscription/licenses", "operationId": "getSubscriptions_Msla_2304", "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": "object" }, "examples": { "Subscription": { "description": "Subscription", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true, "x-roles-required": "License Management-write" } }, "/msla/va/License": { "get": { "tags": [ "MSLA" ], "description": "Retrieve MSLA subscription/licenses", "operationId": "getSubscriptions_Msla_1603", "parameters": [ { "name": "virtual_account_id", "in": "query", "description": "virtual_account_id", "schema": { "type": "string" } }, { "name": "licenseType", "in": "query", "description": "licenseType", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Subscription": { "description": "Subscription", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true, "x-roles-required": "License Management-read" } }, "/multicloud/accounts": { "get": { "tags": [ "MultiCloud - Accounts" ], "description": "Obtain all accounts for all clouds", "operationId": "getAllCloudAccounts", "parameters": [ { "name": "cloudType", "in": "query", "description": "Multicloud provider type", "schema": { "type": "string" } }, { "name": "cloudGatewayEnabled", "in": "query", "description": "Multicloud cloud gateway enabled", "schema": { "pattern": "^(true|false)$", "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "accountId": { "type": "string" }, "accountName": { "type": "string" }, "clientEmail": { "type": "string" }, "cloudGatewayEnabled": { "type": "boolean" }, "cloudType": { "type": "string" }, "credType": { "type": "string" }, "description": { "type": "string" }, "gcpBillingId": { "type": "string" }, "privateKeyId": { "type": "string" }, "regionList": { "type": "string" }, "serviceDiscoveryEnabled": { "type": "boolean" } }, "$$ref": "#/components/schemas/GetAccounts" } }, "examples": { "GCP Account Details": { "description": "GCP Account Details", "value": "[\n {\n \"accountName\": \"pp-gcp\",\n \"clientEmail\": \"pp@gcpClientEmail.com\",\n \"regionList\": {\n \"value\": [\n \"asia-east1\",\n \"asia-east2\",\n \"asia-northeast1\",\n \"asia-northeast2\",\n \"asia-northeast3\",\n \"asia-south1\",\n \"asia-south2\",\n \"asia-southeast1\",\n \"asia-southeast2\",\n \"australia-southeast1\",\n \"australia-southeast2\",\n \"europe-central2\",\n \"europe-north1\",\n \"europe-southwest1\",\n \"europe-west1\",\n \"europe-west2\",\n \"europe-west3\",\n \"europe-west4\",\n \"europe-west6\",\n \"europe-west8\",\n \"europe-west9\",\n \"northamerica-northeast1\",\n \"northamerica-northeast2\",\n \"southamerica-east1\",\n \"southamerica-west1\",\n \"us-central1\",\n \"us-east1\",\n \"us-east4\",\n \"us-east5\",\n \"us-west1\",\n \"us-west2\",\n \"us-west3\",\n \"us-west4\"\n ]\n },\n \"description\": \"pp-individual\",\n \"serviceDiscoveryEnabled\": false,\n \"accountId\": \"gcp-pp-nprd\",\n \"gcpBillingId\": \"\",\n \"cloudGatewayEnabled\": true,\n \"credType\": \"GCP\",\n \"cloudType\": \"GCP\",\n \"privateKeyId\": \"123456\", \n \"accountIdDescription\": \"Project Id\",\n }\n]" }, "Aws Account Details": { "description": "Aws Account Details", "value": "[\n{\n \"accountName\": \"pp-aws\",\n \"regionList\": {\n \"value\": [\n \"af-south-1\",\n \"eu-north-1\",\n \"ap-south-1\",\n \"eu-west-3\",\n \"eu-west-2\",\n \"eu-south-1\",\n \"eu-west-1\",\n \"ap-northeast-3\",\n \"ap-northeast-2\",\n \"me-south-1\",\n \"ap-northeast-1\",\n \"sa-east-1\",\n \"ca-central-1\",\n \"ap-east-1\",\n \"ap-southeast-1\",\n \"ap-southeast-2\",\n \"eu-central-1\",\n \"ap-southeast-3\",\n \"us-east-1\",\n \"us-east-2\",\n \"us-west-1\",\n \"us-west-2\"\n ]\n },\n \"description\": \"AWS account - pp-individual\",\n \"serviceDiscoveryEnabled\": false,\n \"accountId\": \"aws-pp-nprd\",\n \"cloudGatewayEnabled\": true,\n \"credType\": \"AWS_KEY\",\n \"cloudType\": \"AWS\"\n \"accountIdDescription\": \"\",\n }\n]" }, "Aws GovCloud Account Details": { "description": "Aws GovCloud Account Details", "value": "[\n{\n \"accountName\": \"pp-awsGovCloud\",\n \"regionList\": {\n \"value\": [\n \"us-gov-west-1\",\n \"us-gov-east-1\"\n ]\n },\n \"description\": \"AWS govCloud account - pp-individual\",\n \"serviceDiscoveryEnabled\": false,\n \"accountId\": \"awsGovCloud-pp-nprd-68636\",\n \"cloudGatewayEnabled\": true,\n \"credType\": \"AWS_KEY\",\n \"cloudType\": \"AWS_GOVCLOUD\"\n \"accountIdDescription\": \"\",\n }\n]" }, "Azure Account Details": { "description": "Azure Account Details", "value": [ { "accountName": "pp-azure", "regionList": { "value": [ "eastus", "eastus2", "southcentralus", "westus2", "westus3", "australiaeast", "southeastasia", "northeurope", "swedencentral", "uksouth", "westeurope", "centralus", "southafricanorth", "centralindia", "eastasia", "japaneast", "koreacentral", "canadacentral", "francecentral", "germanywestcentral", "norwayeast", "switzerlandnorth", "brazilsouth", "eastus2euap", "centralusstage", "eastusstage", "eastus2stage", "northcentralusstage", "southcentralusstage", "westusstage", "westus2stage", "asia", "asiapacific", "australia", "brazil", "canada", "europe", "france", "germany", "global", "india", "japan", "korea", "norway", "southafrica", "switzerland", "uae", "uk", "unitedstates", "unitedstateseuap", "eastasiastage", "southeastasiastage", "northcentralus", "westus", "jioindiawest", "uaenorth", "centraluseuap", "westcentralus", "southafricawest", "australiacentral", "australiacentral2", "australiasoutheast", "japanwest", "jioindiacentral", "koreasouth", "southindia", "westindia", "canadaeast", "francesouth", "germanynorth", "norwaywest", "switzerlandwest", "ukwest", "uaecentral", "brazilsoutheast" ] }, "description": "Azure account - pp-individual", "serviceDiscoveryEnabled": false, "discoverAllVnetsInTenantEnabled": false, "accountId": "azure-pp-nprd-68636", "accountIdDescription": "Subscription Id", "gcpBillingId": "", "cloudGatewayEnabled": true, "credType": "AZURE", "cloudType": "AZURE" } ] }, "Azure GovCloud Account Details": { "description": "Azure GovCloud Account Details", "value": [ { "accountName": "pp-awsGovCloud", "regionList": { "value": [ "usgovvirginia", "global", "usgovarizona", "usdodcentral", "usdodeast", "usgoviowa", "usgovtexas" ] }, "description": "Azure govCloud account - pp-individual", "serviceDiscoveryEnabled": false, "discoverAllVnetsInTenantEnabled": false, "accountIdDescription": "Subscription Id", "cloudGatewayEnabled": true, "credType": "AZURE_KEY", "cloudType": "AZURE_GOVCLOUD" } ] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "MultiCloud - Accounts" ], "description": "Add Cloud Account", "operationId": "validateAccountAdd", "requestBody": { "description": "Payloads for updating Cloud Gateway based on CloudType", "content": { "application/json": { "schema": { "required": [ "accountName", "azureCredentials", "cloudType", "gcpCredentials" ], "type": "object", "properties": { "accountId": { "type": "string" }, "accountName": { "maxLength": 255, "minLength": 1, "type": "string" }, "awsIamCredentials": { "required": [ "externalId", "roleArn" ], "type": "object", "properties": { "externalId": { "type": "string" }, "roleArn": { "type": "string" } }, "$$ref": "#/components/schemas/AwsIamCredentials" }, "awsKeyCredentials": { "required": [ "apiKey", "secretKey" ], "type": "object", "properties": { "apiKey": { "type": "string" }, "secretKey": { "type": "string" } }, "$$ref": "#/components/schemas/AwsKeyCredentials" }, "azureCredentials": { "required": [ "clientId", "cloudTenantId", "secretKey" ], "type": "object", "properties": { "clientId": { "pattern": "^[a-zA-Z0-9\\-]*$", "type": "string" }, "cloudTenantId": { "pattern": "^[a-zA-Z0-9\\-]*$", "type": "string" }, "secretKey": { "type": "string" }, "subscriptionId": { "pattern": "^[a-zA-Z0-9\\-]*$", "type": "string" } }, "$$ref": "#/components/schemas/AzureCredentials" }, "cloudGatewayEnabled": { "pattern": "^(true|false)$", "type": "string" }, "cloudType": { "type": "string" }, "description": { "maxLength": 1024, "minLength": 0, "pattern": "^[a-zA-Z0-9_./\\-\\s]*$", "type": "string" }, "discoverAllVnetsInTenantEnabled": { "pattern": "^(true|false)$", "type": "string" }, "gcpBillingId": { "pattern": "^[a-zA-Z0-9_./\\-\\s]+$", "type": "string" }, "gcpCredentials": { "required": [ "auth_provider_x509_cert_url", "auth_uri", "client_email", "client_id", "client_x509_cert_url", "private_key", "private_key_id", "project_id", "token_uri", "type" ], "type": "object", "properties": { "auth_provider_x509_cert_url": { "type": "string" }, "auth_uri": { "type": "string" }, "client_email": { "type": "string" }, "client_id": { "type": "string" }, "client_x509_cert_url": { "type": "string" }, "private_key": { "type": "string" }, "private_key_id": { "type": "string" }, "project_id": { "type": "string" }, "token_uri": { "type": "string" }, "type": { "type": "string" } }, "$$ref": "#/components/schemas/GcpCredentials" }, "kubernetesDiscoveryEnabled": { "pattern": "^(true|false)$", "type": "string" }, "serviceDiscoveryEnabled": { "pattern": "^(true|false)$", "type": "string" } }, "$$ref": "#/components/schemas/PostAccounts" }, "examples": { "GCP Add Account request": { "description": "GCP Add Account request", "value": [ { "accountName": "pp-gcp", "cloudGatewayEnabled": true, "cloudType": "GCP", "description": "pp-test", "gcpCredentials": { "value": { "auth_provider_x509_cert_url": "https://www.googleapis.com/test", "auth_uri": "https://accounts.google.com/test", "client_email": "gcp-pp@gcp.com", "client_id": "1234", "client_x509_cert_url": "https://www.googleapis.com/test", "private_key": "REDACTED_PRIVATE_KEY_EXAMPLE", "private_key_id": "45678", "project_id": "gcp-ppp-21471", "token_uri": "https://oauth2.googleapis.com/test", "type": "service_account" } }, "serviceDiscoveryEnabled": false } ] }, "AWS Iam/AWS Iam GovCloud Add Account request": { "description": "AWS Iam/AWS Iam GovCloud Add Account request", "value": [ { "cloudType": "AWS", "accountName": "aws_acct_102", "description": "aws_acct_102 desc", "awsIamCredentials": { "roleArn": "arn101", "externalId": "ext101" } } ] }, "AWS key/AWS key GovCloud Add Account request": { "description": "AWS key/AWS key GovCloud Add Account request", "value": [ { "cloudType": "AWS", "accountName": "aws_acct_102", "description": "aws_acct_102 desc", "awsKeyCredentials": { "apiKey": "key102", "secretKey": "skey102" }, "cloudGatewayEnabled": "true" } ] }, "Azure/Azure GovCloud Add Account request": { "description": "Azure/Azure GovCloud Add Account request", "value": [ { "cloudType": "AZURE", "accountName": "azure_acct_102", "description": "azure_acct_102 desc", "azureCredentials": { "subscriptionId": "sub103", "secretKey": "skey103", "clientId": "clientid103", "cloudTenantId": "clienttenant103" }, "cloudGatewayEnabled": "true", "azO365Enabled": "true" } ] } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "accountId": { "type": "string" }, "accountName": { "type": "string" }, "cloudType": { "type": "string" }, "regionList": { "type": "string" } }, "$$ref": "#/components/schemas/PostAccountsResponse" }, "examples": { "GCP Account Details": { "description": "GCP Account Details", "value": "[\n {\n \"accountName\": \"pp-gcp\",\n \"clientEmail\": \"pp@gcpClientEmail.com\",\n \"regionList\": {\n \"value\": [\n \"asia-east1\",\n \"asia-east2\",\n \"asia-northeast1\",\n \"asia-northeast2\",\n \"asia-northeast3\",\n \"asia-south1\",\n \"asia-south2\",\n \"asia-southeast1\",\n \"asia-southeast2\",\n \"australia-southeast1\",\n \"australia-southeast2\",\n \"europe-central2\",\n \"europe-north1\",\n \"europe-southwest1\",\n \"europe-west1\",\n \"europe-west2\",\n \"europe-west3\",\n \"europe-west4\",\n \"europe-west6\",\n \"europe-west8\",\n \"europe-west9\",\n \"northamerica-northeast1\",\n \"northamerica-northeast2\",\n \"southamerica-east1\",\n \"southamerica-west1\",\n \"us-central1\",\n \"us-east1\",\n \"us-east4\",\n \"us-east5\",\n \"us-west1\",\n \"us-west2\",\n \"us-west3\",\n \"us-west4\"\n ]\n },\n \"description\": \"pp-individual\",\n \"serviceDiscoveryEnabled\": false,\n \"accountId\": \"gcp-pp-nprd\",\n \"gcpBillingId\": \"\",\n \"cloudGatewayEnabled\": true,\n \"credType\": \"GCP\",\n \"cloudType\": \"GCP\",\n \"privateKeyId\": \"123456\", \n \"accountIdDescription\": \"Project Id\",\n }\n]" }, "Aws Account Details": { "description": "Aws Account Details", "value": "[\n{\n \"accountName\": \"pp-aws\",\n \"regionList\": {\n \"value\": [\n \"af-south-1\",\n \"eu-north-1\",\n \"ap-south-1\",\n \"eu-west-3\",\n \"eu-west-2\",\n \"eu-south-1\",\n \"eu-west-1\",\n \"ap-northeast-3\",\n \"ap-northeast-2\",\n \"me-south-1\",\n \"ap-northeast-1\",\n \"sa-east-1\",\n \"ca-central-1\",\n \"ap-east-1\",\n \"ap-southeast-1\",\n \"ap-southeast-2\",\n \"eu-central-1\",\n \"ap-southeast-3\",\n \"us-east-1\",\n \"us-east-2\",\n \"us-west-1\",\n \"us-west-2\"\n ]\n },\n \"description\": \"AWS account - pp-individual\",\n \"serviceDiscoveryEnabled\": false,\n \"accountId\": \"aws-pp-nprd\",\n \"cloudGatewayEnabled\": true,\n \"credType\": \"AWS_KEY\",\n \"cloudType\": \"AWS\"\n \"accountIdDescription\": \"\",\n }\n]" }, "Aws GovCloud Account Details": { "description": "Aws GovCloud Account Details", "value": "[\n{\n \"accountName\": \"pp-awsGovCloud\",\n \"regionList\": {\n \"value\": [\n \"us-gov-west-1\",\n \"us-gov-east-1\"\n ]\n },\n \"description\": \"AWS govCloud account - pp-individual\",\n \"serviceDiscoveryEnabled\": false,\n \"accountId\": \"awsGovCloud-pp-nprd-68636\",\n \"cloudGatewayEnabled\": true,\n \"credType\": \"AWS_KEY\",\n \"cloudType\": \"AWS_GOVCLOUD\"\n \"accountIdDescription\": \"\",\n }\n]" }, "Azure Account Details": { "description": "Azure Account Details", "value": [ { "accountName": "pp-azure", "regionList": { "value": [ "eastus", "eastus2", "southcentralus", "westus2", "westus3", "australiaeast", "southeastasia", "northeurope", "swedencentral", "uksouth", "westeurope", "centralus", "southafricanorth", "centralindia", "eastasia", "japaneast", "koreacentral", "canadacentral", "francecentral", "germanywestcentral", "norwayeast", "switzerlandnorth", "brazilsouth", "eastus2euap", "centralusstage", "eastusstage", "eastus2stage", "northcentralusstage", "southcentralusstage", "westusstage", "westus2stage", "asia", "asiapacific", "australia", "brazil", "canada", "europe", "france", "germany", "global", "india", "japan", "korea", "norway", "southafrica", "switzerland", "uae", "uk", "unitedstates", "unitedstateseuap", "eastasiastage", "southeastasiastage", "northcentralus", "westus", "jioindiawest", "uaenorth", "centraluseuap", "westcentralus", "southafricawest", "australiacentral", "australiacentral2", "australiasoutheast", "japanwest", "jioindiacentral", "koreasouth", "southindia", "westindia", "canadaeast", "francesouth", "germanynorth", "norwaywest", "switzerlandwest", "ukwest", "uaecentral", "brazilsoutheast" ] }, "description": "Azure account - pp-individual", "serviceDiscoveryEnabled": false, "discoverAllVnetsInTenantEnabled": false, "accountId": "azure-pp-nprd-68636", "accountIdDescription": "Subscription Id", "gcpBillingId": "", "cloudGatewayEnabled": true, "credType": "AZURE", "cloudType": "AZURE" } ] }, "Azure GovCloud Account Details": { "description": "Azure GovCloud Account Details", "value": [ { "accountName": "pp-awsGovCloud", "regionList": { "value": [ "usgovvirginia", "global", "usgovarizona", "usdodcentral", "usdodeast", "usgoviowa", "usgovtexas" ] }, "description": "Azure govCloud account - pp-individual", "serviceDiscoveryEnabled": false, "discoverAllVnetsInTenantEnabled": false, "accountIdDescription": "Subscription Id", "cloudGatewayEnabled": true, "credType": "AZURE_KEY", "cloudType": "AZURE_GOVCLOUD" } ] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/accounts/{accountId}": { "delete": { "tags": [ "MultiCloud - Accounts" ], "description": "Obtain all accounts for all clouds", "operationId": "deleteAccount", "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "MultiCloud - Accounts" ], "description": "Obtain all accounts for all clouds", "operationId": "getCloudAccountDetails", "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "accountId": { "type": "string" }, "accountName": { "type": "string" }, "clientEmail": { "type": "string" }, "cloudGatewayEnabled": { "type": "boolean" }, "cloudType": { "type": "string" }, "credType": { "type": "string" }, "description": { "type": "string" }, "gcpBillingId": { "type": "string" }, "privateKeyId": { "type": "string" }, "regionList": { "type": "string" }, "serviceDiscoveryEnabled": { "type": "boolean" } }, "$$ref": "#/components/schemas/GetAccounts" }, "examples": { "GCP Account Details": { "description": "GCP Account Details", "value": "[\n {\n \"accountName\": \"pp-gcp\",\n \"clientEmail\": \"pp@gcpClientEmail.com\",\n \"regionList\": {\n \"value\": [\n \"asia-east1\",\n \"asia-east2\",\n \"asia-northeast1\",\n \"asia-northeast2\",\n \"asia-northeast3\",\n \"asia-south1\",\n \"asia-south2\",\n \"asia-southeast1\",\n \"asia-southeast2\",\n \"australia-southeast1\",\n \"australia-southeast2\",\n \"europe-central2\",\n \"europe-north1\",\n \"europe-southwest1\",\n \"europe-west1\",\n \"europe-west2\",\n \"europe-west3\",\n \"europe-west4\",\n \"europe-west6\",\n \"europe-west8\",\n \"europe-west9\",\n \"northamerica-northeast1\",\n \"northamerica-northeast2\",\n \"southamerica-east1\",\n \"southamerica-west1\",\n \"us-central1\",\n \"us-east1\",\n \"us-east4\",\n \"us-east5\",\n \"us-west1\",\n \"us-west2\",\n \"us-west3\",\n \"us-west4\"\n ]\n },\n \"description\": \"pp-individual\",\n \"serviceDiscoveryEnabled\": false,\n \"accountId\": \"gcp-pp-nprd\",\n \"gcpBillingId\": \"\",\n \"cloudGatewayEnabled\": true,\n \"credType\": \"GCP\",\n \"cloudType\": \"GCP\",\n \"privateKeyId\": \"123456\", \n \"accountIdDescription\": \"Project Id\",\n }\n]" }, "Aws Account Details": { "description": "Aws Account Details", "value": "[\n{\n \"accountName\": \"pp-aws\",\n \"regionList\": {\n \"value\": [\n \"af-south-1\",\n \"eu-north-1\",\n \"ap-south-1\",\n \"eu-west-3\",\n \"eu-west-2\",\n \"eu-south-1\",\n \"eu-west-1\",\n \"ap-northeast-3\",\n \"ap-northeast-2\",\n \"me-south-1\",\n \"ap-northeast-1\",\n \"sa-east-1\",\n \"ca-central-1\",\n \"ap-east-1\",\n \"ap-southeast-1\",\n \"ap-southeast-2\",\n \"eu-central-1\",\n \"ap-southeast-3\",\n \"us-east-1\",\n \"us-east-2\",\n \"us-west-1\",\n \"us-west-2\"\n ]\n },\n \"description\": \"AWS account - pp-individual\",\n \"serviceDiscoveryEnabled\": false,\n \"accountId\": \"aws-pp-nprd\",\n \"cloudGatewayEnabled\": true,\n \"credType\": \"AWS_KEY\",\n \"cloudType\": \"AWS\"\n \"accountIdDescription\": \"\",\n }\n]" }, "Aws GovCloud Account Details": { "description": "Aws GovCloud Account Details", "value": "[\n{\n \"accountName\": \"pp-awsGovCloud\",\n \"regionList\": {\n \"value\": [\n \"us-gov-west-1\",\n \"us-gov-east-1\"\n ]\n },\n \"description\": \"AWS govCloud account - pp-individual\",\n \"serviceDiscoveryEnabled\": false,\n \"accountId\": \"awsGovCloud-pp-nprd-68636\",\n \"cloudGatewayEnabled\": true,\n \"credType\": \"AWS_KEY\",\n \"cloudType\": \"AWS_GOVCLOUD\"\n \"accountIdDescription\": \"\",\n }\n]" }, "Azure Account Details": { "description": "Azure Account Details", "value": [ { "accountName": "pp-azure", "regionList": { "value": [ "eastus", "eastus2", "southcentralus", "westus2", "westus3", "australiaeast", "southeastasia", "northeurope", "swedencentral", "uksouth", "westeurope", "centralus", "southafricanorth", "centralindia", "eastasia", "japaneast", "koreacentral", "canadacentral", "francecentral", "germanywestcentral", "norwayeast", "switzerlandnorth", "brazilsouth", "eastus2euap", "centralusstage", "eastusstage", "eastus2stage", "northcentralusstage", "southcentralusstage", "westusstage", "westus2stage", "asia", "asiapacific", "australia", "brazil", "canada", "europe", "france", "germany", "global", "india", "japan", "korea", "norway", "southafrica", "switzerland", "uae", "uk", "unitedstates", "unitedstateseuap", "eastasiastage", "southeastasiastage", "northcentralus", "westus", "jioindiawest", "uaenorth", "centraluseuap", "westcentralus", "southafricawest", "australiacentral", "australiacentral2", "australiasoutheast", "japanwest", "jioindiacentral", "koreasouth", "southindia", "westindia", "canadaeast", "francesouth", "germanynorth", "norwaywest", "switzerlandwest", "ukwest", "uaecentral", "brazilsoutheast" ] }, "description": "Azure account - pp-individual", "serviceDiscoveryEnabled": false, "discoverAllVnetsInTenantEnabled": false, "accountId": "azure-pp-nprd-68636", "accountIdDescription": "Subscription Id", "gcpBillingId": "", "cloudGatewayEnabled": true, "credType": "AZURE", "cloudType": "AZURE" } ] }, "Azure GovCloud Account Details": { "description": "Azure GovCloud Account Details", "value": [ { "accountName": "pp-awsGovCloud", "regionList": { "value": [ "usgovvirginia", "global", "usgovarizona", "usdodcentral", "usdodeast", "usgoviowa", "usgovtexas" ] }, "description": "Azure govCloud account - pp-individual", "serviceDiscoveryEnabled": false, "discoverAllVnetsInTenantEnabled": false, "accountIdDescription": "Subscription Id", "cloudGatewayEnabled": true, "credType": "AZURE_KEY", "cloudType": "AZURE_GOVCLOUD" } ] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "MultiCloud - Accounts" ], "description": "Obtain all accounts for all clouds", "operationId": "updateAccount", "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Payloads for updating Cloud Gateway based on CloudType", "content": { "application/json": { "schema": { "required": [ "accountId", "accountName", "cloudType" ], "type": "object", "properties": { "accountId": { "type": "string" }, "accountName": { "maxLength": 255, "minLength": 1, "type": "string" }, "cloudGatewayEnabled": { "pattern": "^(true|false)$", "type": "string" }, "cloudType": { "type": "string" }, "description": { "maxLength": 1024, "minLength": 0, "pattern": "^[a-zA-Z0-9_./\\-\\s]*$", "type": "string" }, "discoverAllVnetsInTenantEnabled": { "pattern": "^(true|false)$", "type": "string" }, "gcpBillingId": { "type": "string" }, "kubernetesDiscoveryEnabled": { "pattern": "^(true|false)$", "type": "string" }, "serviceDiscoveryEnabled": { "pattern": "^(true|false)$", "type": "string" } }, "$$ref": "#/components/schemas/PutAccounts" }, "examples": { "GCP Update Account request": { "description": "GCP Update Account request", "value": { "accountName": "priypat3-gcp-01", "description": "priypat3-individual", "serviceDiscoveryEnabled": false, "accountId": "gcp-priypat3gcp01-nprd-68636", "gcpBillingId": "", "cloudGatewayEnabled": true, "cloudType": "GCP" } }, "AWS/AWS GovCloud Update Account request": { "description": "AWS/AWS GovCloud Update Account request", "value": { "accountId": "123aws", "accountName": "pp-aws", "cloudGatewayEnabled": "true", "cloudType": "AWS", "description": "pp-aws" } }, "Azure/Azure GovCloud Update Account request": { "description": "Azure/Azure GovCloud Update Account request", "value": { "accountId": "123abcc", "accountName": "pp-azure", "cloudGatewayEnabled": "true", "cloudType": "AZURE", "description": "pp-azure" } } } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/accounts/{accountId}/credentials": { "put": { "tags": [ "MultiCloud - Accounts" ], "description": "Update Cloud Account Credentials", "operationId": "validateAccountUpdateCredentials", "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Payloads for updating Cloud Gateway based on CloudType", "content": { "application/json": { "schema": { "required": [ "accountName", "azureCredentials", "cloudType", "gcpCredentials" ], "type": "object", "properties": { "accountId": { "type": "string" }, "accountName": { "maxLength": 255, "minLength": 1, "type": "string" }, "awsIamCredentials": { "required": [ "externalId", "roleArn" ], "type": "object", "properties": { "externalId": { "type": "string" }, "roleArn": { "type": "string" } }, "$$ref": "#/components/schemas/AwsIamCredentials" }, "awsKeyCredentials": { "required": [ "apiKey", "secretKey" ], "type": "object", "properties": { "apiKey": { "type": "string" }, "secretKey": { "type": "string" } }, "$$ref": "#/components/schemas/AwsKeyCredentials" }, "azureCredentials": { "required": [ "clientId", "cloudTenantId", "secretKey" ], "type": "object", "properties": { "clientId": { "pattern": "^[a-zA-Z0-9\\-]*$", "type": "string" }, "cloudTenantId": { "pattern": "^[a-zA-Z0-9\\-]*$", "type": "string" }, "secretKey": { "type": "string" }, "subscriptionId": { "pattern": "^[a-zA-Z0-9\\-]*$", "type": "string" } }, "$$ref": "#/components/schemas/AzureCredentials" }, "cloudGatewayEnabled": { "pattern": "^(true|false)$", "type": "string" }, "cloudType": { "type": "string" }, "description": { "maxLength": 1024, "minLength": 0, "pattern": "^[a-zA-Z0-9_./\\-\\s]*$", "type": "string" }, "discoverAllVnetsInTenantEnabled": { "pattern": "^(true|false)$", "type": "string" }, "gcpBillingId": { "pattern": "^[a-zA-Z0-9_./\\-\\s]+$", "type": "string" }, "gcpCredentials": { "required": [ "auth_provider_x509_cert_url", "auth_uri", "client_email", "client_id", "client_x509_cert_url", "private_key", "private_key_id", "project_id", "token_uri", "type" ], "type": "object", "properties": { "auth_provider_x509_cert_url": { "type": "string" }, "auth_uri": { "type": "string" }, "client_email": { "type": "string" }, "client_id": { "type": "string" }, "client_x509_cert_url": { "type": "string" }, "private_key": { "type": "string" }, "private_key_id": { "type": "string" }, "project_id": { "type": "string" }, "token_uri": { "type": "string" }, "type": { "type": "string" } }, "$$ref": "#/components/schemas/GcpCredentials" }, "kubernetesDiscoveryEnabled": { "pattern": "^(true|false)$", "type": "string" }, "serviceDiscoveryEnabled": { "pattern": "^(true|false)$", "type": "string" } }, "$$ref": "#/components/schemas/PostAccounts" }, "examples": { "GCP Update Account request": { "description": "GCP Update Account request", "value": [ { "accountName": "pp-gcp", "cloudGatewayEnabled": true, "cloudType": "GCP", "description": "pp-test", "gcpCredentials": { "value": { "auth_provider_x509_cert_url": "https://www.googleapis.com/test", "auth_uri": "https://accounts.google.com/test", "client_email": "gcp-pp@gcp.com", "client_id": "1234", "client_x509_cert_url": "https://www.googleapis.com/test", "private_key": "REDACTED_PRIVATE_KEY_EXAMPLE", "private_key_id": "45678", "project_id": "gcp-ppp-21471", "token_uri": "https://oauth2.googleapis.com/test", "type": "service_account" } }, "serviceDiscoveryEnabled": false } ] }, "AWS Iam/AWS Iam GovCloud Update Account request": { "description": "AWS Iam/AWS Iam GovCloud Update Account request", "value": [ { "cloudType": "AWS", "accountName": "aws_acct_102", "description": "aws_acct_102 desc", "awsIamCredentials": { "roleArn": "arn101", "externalId": "ext101" } } ] }, "AWS key/AWS key GovCloud Update Account request": { "description": "AWS key/AWS key GovCloud Update Account request", "value": [ { "cloudType": "AWS", "accountName": "aws_acct_102", "description": "aws_acct_102 desc", "awsKeyCredentials": { "apiKey": "key102", "secretKey": "skey102" }, "cloudGatewayEnabled": "true" } ] }, "Azure/Azure GovCloud Update Account request": { "description": "Azure/Azure GovCloud Update Account request", "value": [ { "cloudType": "AZURE", "accountName": "azure_acct_102", "description": "azure_acct_102 desc", "azureCredentials": { "subscriptionId": "sub103", "secretKey": "skey103", "clientId": "clientid103", "cloudTenantId": "clienttenant103" }, "cloudGatewayEnabled": "true", "azO365Enabled": "true" } ] } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "accountId": { "type": "string" }, "accountName": { "type": "string" }, "cloudType": { "type": "string" }, "regionList": { "type": "string" } }, "$$ref": "#/components/schemas/PostAccountsResponse" }, "examples": { "GCP Account Details": { "description": "GCP Account Details", "value": "[\n {\n \"accountName\": \"pp-gcp\",\n \"clientEmail\": \"pp@gcpClientEmail.com\",\n \"regionList\": {\n \"value\": [\n \"asia-east1\",\n \"asia-east2\",\n \"asia-northeast1\",\n \"asia-northeast2\",\n \"asia-northeast3\",\n \"asia-south1\",\n \"asia-south2\",\n \"asia-southeast1\",\n \"asia-southeast2\",\n \"australia-southeast1\",\n \"australia-southeast2\",\n \"europe-central2\",\n \"europe-north1\",\n \"europe-southwest1\",\n \"europe-west1\",\n \"europe-west2\",\n \"europe-west3\",\n \"europe-west4\",\n \"europe-west6\",\n \"europe-west8\",\n \"europe-west9\",\n \"northamerica-northeast1\",\n \"northamerica-northeast2\",\n \"southamerica-east1\",\n \"southamerica-west1\",\n \"us-central1\",\n \"us-east1\",\n \"us-east4\",\n \"us-east5\",\n \"us-west1\",\n \"us-west2\",\n \"us-west3\",\n \"us-west4\"\n ]\n },\n \"description\": \"pp-individual\",\n \"serviceDiscoveryEnabled\": false,\n \"accountId\": \"gcp-pp-nprd\",\n \"gcpBillingId\": \"\",\n \"cloudGatewayEnabled\": true,\n \"credType\": \"GCP\",\n \"cloudType\": \"GCP\",\n \"privateKeyId\": \"123456\", \n \"accountIdDescription\": \"Project Id\",\n }\n]" }, "Aws Account Details": { "description": "Aws Account Details", "value": "[\n{\n \"accountName\": \"pp-aws\",\n \"regionList\": {\n \"value\": [\n \"af-south-1\",\n \"eu-north-1\",\n \"ap-south-1\",\n \"eu-west-3\",\n \"eu-west-2\",\n \"eu-south-1\",\n \"eu-west-1\",\n \"ap-northeast-3\",\n \"ap-northeast-2\",\n \"me-south-1\",\n \"ap-northeast-1\",\n \"sa-east-1\",\n \"ca-central-1\",\n \"ap-east-1\",\n \"ap-southeast-1\",\n \"ap-southeast-2\",\n \"eu-central-1\",\n \"ap-southeast-3\",\n \"us-east-1\",\n \"us-east-2\",\n \"us-west-1\",\n \"us-west-2\"\n ]\n },\n \"description\": \"AWS account - pp-individual\",\n \"serviceDiscoveryEnabled\": false,\n \"accountId\": \"aws-pp-nprd\",\n \"cloudGatewayEnabled\": true,\n \"credType\": \"AWS_KEY\",\n \"cloudType\": \"AWS\"\n \"accountIdDescription\": \"\",\n }\n]" }, "Aws GovCloud Account Details": { "description": "Aws GovCloud Account Details", "value": "[\n{\n \"accountName\": \"pp-awsGovCloud\",\n \"regionList\": {\n \"value\": [\n \"us-gov-west-1\",\n \"us-gov-east-1\"\n ]\n },\n \"description\": \"AWS govCloud account - pp-individual\",\n \"serviceDiscoveryEnabled\": false,\n \"accountId\": \"awsGovCloud-pp-nprd-68636\",\n \"cloudGatewayEnabled\": true,\n \"credType\": \"AWS_KEY\",\n \"cloudType\": \"AWS_GOVCLOUD\"\n \"accountIdDescription\": \"\",\n }\n]" }, "Azure Account Details": { "description": "Azure Account Details", "value": [ { "accountName": "pp-azure", "regionList": { "value": [ "eastus", "eastus2", "southcentralus", "westus2", "westus3", "australiaeast", "southeastasia", "northeurope", "swedencentral", "uksouth", "westeurope", "centralus", "southafricanorth", "centralindia", "eastasia", "japaneast", "koreacentral", "canadacentral", "francecentral", "germanywestcentral", "norwayeast", "switzerlandnorth", "brazilsouth", "eastus2euap", "centralusstage", "eastusstage", "eastus2stage", "northcentralusstage", "southcentralusstage", "westusstage", "westus2stage", "asia", "asiapacific", "australia", "brazil", "canada", "europe", "france", "germany", "global", "india", "japan", "korea", "norway", "southafrica", "switzerland", "uae", "uk", "unitedstates", "unitedstateseuap", "eastasiastage", "southeastasiastage", "northcentralus", "westus", "jioindiawest", "uaenorth", "centraluseuap", "westcentralus", "southafricawest", "australiacentral", "australiacentral2", "australiasoutheast", "japanwest", "jioindiacentral", "koreasouth", "southindia", "westindia", "canadaeast", "francesouth", "germanynorth", "norwaywest", "switzerlandwest", "ukwest", "uaecentral", "brazilsoutheast" ] }, "description": "Azure account - pp-individual", "serviceDiscoveryEnabled": false, "discoverAllVnetsInTenantEnabled": false, "accountId": "azure-pp-nprd-68636", "accountIdDescription": "Subscription Id", "gcpBillingId": "", "cloudGatewayEnabled": true, "credType": "AZURE", "cloudType": "AZURE" } ] }, "Azure GovCloud Account Details": { "description": "Azure GovCloud Account Details", "value": [ { "accountName": "pp-awsGovCloud", "regionList": { "value": [ "usgovvirginia", "global", "usgovarizona", "usdodcentral", "usdodeast", "usgoviowa", "usgovtexas" ] }, "description": "Azure govCloud account - pp-individual", "serviceDiscoveryEnabled": false, "discoverAllVnetsInTenantEnabled": false, "accountIdDescription": "Subscription Id", "cloudGatewayEnabled": true, "credType": "AZURE_KEY", "cloudType": "AZURE_GOVCLOUD" } ] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/audit": { "post": { "tags": [ "MultiCloud - General" ], "description": "Call an audit", "operationId": "audit", "requestBody": { "description": "Audit", "content": { "application/json": { "schema": { "required": [ "cloudType" ], "type": "object", "properties": { "cloudType": { "pattern": "^[a-zA-Z_]+$", "type": "string" }, "issuesToSync": { "maxItems": 2147483647, "minItems": 1, "type": "array", "items": { "required": [ "name", "region", "reportType" ], "type": "object", "properties": { "name": { "type": "string" }, "region": { "pattern": "^[a-zA-Z0-9_./\\-]+$", "type": "string" }, "reportType": { "type": "string" } }, "$$ref": "#/components/schemas/AuditFixIssuesToSync" } }, "region": { "pattern": "^[a-zA-Z0-9_./\\-]+$", "type": "string" } }, "$$ref": "#/components/schemas/AuditFix" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "6c723f65-9106-4f43-9d2b-a033a39353b3" } }, "description": "Task id for polling status", "$$ref": "#/components/schemas/Taskid" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "MultiCloud - General" ], "description": "Call an audit with dry run", "operationId": "auditDryRun", "parameters": [ { "name": "cloudType", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "AWS", "AWS_GOVCLOUD", "AZURE", "AZURE_GOVCLOUD", "GCP" ] } }, { "name": "cloudRegion", "in": "query", "schema": { "pattern": "^[a-zA-Z0-9_./\\-]+$", "type": "string" } }, { "name": "refresh", "in": "query", "schema": { "pattern": "^(true|false)$", "type": "string", "default": "true" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "In Sync": { "description": "In Sync", "value": { "auditStatus": "IN_SYNC", "canFix": true, "auditReport": [] } }, "Out Of Sync": { "description": "Out Of Sync", "value": { "auditStatus": "OUT_OF_SYNC", "canFix": true, "auditReport": [ { "status": "IN_SYNC", "reportType": "GCR", "region": "us-west1", "name": "S2C_GCR", "details": [] }, { "status": "IN_SYNC", "reportType": "GCR", "region": "us-west1", "name": "S2S_GCR", "details": [] }, { "status": "IN_SYNC", "reportType": "CGW_ROUTER", "region": "global", "details": [] }, { "status": "IN_SYNC", "reportType": "HOSTVPC", "region": "global", "details": [] }, { "status": "IN_SYNC", "reportType": "NCC_HUB", "region": "global", "name": "s2c-hub", "details": [] }, { "status": "OUT_OF_SYNC_DRY_RUN", "reportType": "NCC_HUB", "region": "global", "name": "s2s-hub", "details": [ "Spoke s2s-spoke in region us-west1 is missing." ] }, { "status": "IN_SYNC", "reportType": "MAPPING", "details": [] } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/cloudgateway": { "post": { "tags": [ "MultiCloud - CloudGateway" ], "description": "Create cloud gateway", "operationId": "createCgw", "requestBody": { "description": "Payloads for updating Cloud Gateway based on CloudType", "content": { "application/json": { "schema": { "required": [ "accountId", "azureProperties", "cloudGatewayName", "cloudType" ], "type": "object", "properties": { "accountId": { "type": "string" }, "awsCwanProperties": { "type": "object", "properties": { "coreNetworkEdgeId": { "type": "string", "description": "Refers to AWS site id within the core network" }, "coreNetworkEdgeSource": { "type": "string", "enum": [ "aws", "tvpcOnly", "toBeCreated" ] }, "coreNetworkId": { "type": "string" }, "coreNetworkSource": { "type": "string", "enum": [ "aws", "tvpcOnly", "toBeCreated" ] } }, "description": "Used in AWS/AWS Govcloud CGW creation. Null if type is TGW based", "$$ref": "#/components/schemas/CloudGatewayPostAwsCwanProperties" }, "awsTgwProperties": { "type": "object", "properties": { "tgwConnections": { "type": "array", "properties": { "empty": { "type": "boolean" } }, "description": "Defines a list of TGW connections. Null if tgwSource is not aws", "items": { "type": "object", "properties": { "conn": { "type": "string" }, "tgwRouteTableId": { "type": "string" }, "vpnId": { "type": "string" } }, "description": "Defines a list of TGW connections. Null if tgwSource is not aws", "$$ref": "#/components/schemas/TgwConnectionsInner" } }, "tgwId": { "type": "string" }, "tgwSource": { "type": "string", "enum": [ "aws", "tvpcOnly", "toBeCreated" ] } }, "description": "Used in AWS/AWS Govcloud CGW creation. Null if type is cloudwan based", "$$ref": "#/components/schemas/CloudGatewayPostAwsTgwProperties" }, "azureProperties": { "required": [ "resourceGroupName", "resourceGroupSource", "vhubName", "vhubSource", "vwanName", "vwanSource" ], "type": "object", "properties": { "nvaSource": { "type": "string" }, "resourceGroupName": { "pattern": "^[a-zA-Z0-9_/\\\\\\-]+$", "type": "string" }, "resourceGroupSource": { "type": "string" }, "vhubName": { "pattern": "^[a-zA-Z0-9_/\\\\\\-]+$", "type": "string" }, "vhubResourceGroupAccountId": { "type": "string" }, "vhubResourceGroupName": { "pattern": "^[a-zA-Z0-9_/\\\\\\-]+$", "type": "string" }, "vhubResourceGroupSource": { "type": "string" }, "vhubSource": { "type": "string" }, "vpnGatewaySource": { "type": "string" }, "vwanName": { "pattern": "^[a-zA-Z0-9_/\\\\\\-]+$", "type": "string" }, "vwanSource": { "type": "string" } }, "description": "Used in Azure/Azure GovCloud CGW creation", "$$ref": "#/components/schemas/CloudGatewayPostAzureProperties" }, "cloudGatewayMode": { "pattern": "^(sdwan|sd-routing)$", "type": "string" }, "cloudGatewayName": { "maxLength": 255, "minLength": 1, "type": "string" }, "cloudGatewaySolution": { "pattern": "^[a-zA-Z_]+$", "type": "string" }, "cloudGatewayTag": { "pattern": "^[a-zA-Z0-9_./\\\\\\-]+$", "type": "string" }, "cloudType": { "type": "string" }, "configGroupSettings": { "type": "object", "properties": { "configGroupId": { "pattern": "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}", "type": "string" }, "configGroupName": { "pattern": "^[a-zA-Z0-9_/\\\\\\-]+$", "type": "string" } }, "description": "Used in Azure/Azure GovCloud CGW creation", "$$ref": "#/components/schemas/CloudGatewayPostConfigGroupSettings" }, "description": { "maxLength": 1024, "minLength": 0, "pattern": "^[a-zA-Z0-9_./\\-\\s]*$", "type": "string" }, "devices": { "type": "array", "items": { "type": "string" } }, "mrfRouterRole": { "pattern": "^(edge|border)$", "type": "string" }, "region": { "pattern": "^[a-zA-Z0-9_./\\-]+$", "type": "string" }, "s2sPermitted": { "pattern": "^(true|false)$", "type": "string" }, "settings": { "type": "object", "properties": { "cloudGatewaySolution": { "pattern": "^[a-zA-Z_]*$", "type": "string" }, "cloudType": { "pattern": "^[a-zA-Z_]*$", "type": "string" }, "instanceSize": { "pattern": "^[a-zA-Z0-9_./\\-]*$", "type": "string" }, "ipSubnetPool": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(?:\\.(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3}\\/(?:3[0-2]|[0-2]?[0-9]))(?:\\s*,\\s*(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(?:\\.(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3}\\/(?:3[0-2]|[0-2]?[0-9]))*$", "type": "string" }, "name": { "pattern": "^[a-zA-Z_]*$", "type": "string" }, "networkTier": { "pattern": "^[a-zA-Z0-9_./\\-]*$", "type": "string", "description": "Used for GCP Custom settings" }, "skuScaleUnit": { "pattern": "^[0-9]*$", "type": "string", "description": "Used for Azure/Azure GovCloud Custom settings" }, "softwareImageId": { "pattern": "^[a-zA-Z0-9_./\\-\\s]*$", "type": "string" }, "tunnelCount": { "pattern": "^[0-9]*$", "type": "string", "description": "Tunnel Count for AWS Connect based and branch connect" } }, "$$ref": "#/components/schemas/AllOfcloudGatewayPostSettings" }, "siteName": { "pattern": "^[a-zA-Z0-9_./\\\\\\-]+$", "type": "string" }, "sshKeyName": { "pattern": "^[a-zA-Z0-9_./\\\\\\-]+$", "type": "string" } }, "$$ref": "#/components/schemas/CloudGatewayPost" }, "examples": { "GCP CGW Create request": { "description": "GCP CGW Create request", "value": { "accountId": "gcp-project-nprd-312512", "cloudType": "GCP", "region": "us-west4", "cloudGatewayName": "gcp-test", "devices": [ "C8K-2F69B355-2B3D-2801-EB48-F44789422299", "C8K-53349F28-AB44-70C5-260B-096581250519" ], "description": "GCP post request", "s2sPermitted": false, "mrfRouterRole": "border", "siteName": "SITE_1", "configGroupSettings": { "configGroupName": "CG_1", "configGroupId": "d0846e2c-a977-46fa-8acb-0e387a30eadf" } } }, "AWS/AWS GovCloud CGW create request": { "description": "AWS/AWS GovCloud CGW create request", "value": { "accountId": "238112874124", "cloudType": "AWS", "region": "us-east-1", "cloudGatewayName": "aws-test", "devices": [ "C8K-2F69B355-2B3D-2801-EB48-F44789422299", "C8K-53349F28-AB44-70C5-260B-096581250519" ], "description": "AWS/AWS_GOVCLOUD post request", "mrfRouterRole": "border", "siteName": "SITE_1", "configGroupSettings": { "configGroupName": "CG_1", "configGroupId": "d0846e2c-a977-46fa-8acb-0e387a30eadf" } } }, "Azure/Azure GovCloud CGW create request": { "description": "Azure/Azure GovCloud CGW create request", "value": { "accountId": "81k99acb9-1a58-b3b6-214f-840623g789a0", "cloudType": "AZURE", "region": "westus2", "cloudGatewayName": "azure-test", "mrfRouterRole": "border", "siteName": "SITE_1", "devices": [ "C8K-2F69B355-2B3D-2801-EB48-F44789422299 C8K-53349F28-AB44-70C5-260B-096581250519" ], "description": "AZURE/AZURE_GOVCLOUD post request", "azureProperties": { "resourceGroupName": "azureTestRGP", "resourceGroupSource": "azure", "vwanName": "azureTestVwan", "vwanSource": "azure", "vhubName": "azureTestVhub", "vhubSource": "toBeCreated", "nvaSource": "toBeCreated" }, "configGroupSettings": { "configGroupName": "CG_1", "configGroupId": "d0846e2c-a977-46fa-8acb-0e387a30eadf" } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "6c723f65-9106-4f43-9d2b-a033a39353b3" } }, "description": "Task id for polling status", "$$ref": "#/components/schemas/Taskid" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "MultiCloud - CloudGateway" ], "description": "Get cloud gateways", "operationId": "getCgws", "parameters": [ { "name": "cloudType", "in": "query", "description": "Multicloud provider type", "schema": { "type": "string" } }, { "name": "accountId", "in": "query", "description": "Multicloud account id", "schema": { "type": "string" } }, { "name": "region", "in": "query", "description": "Multicloud region", "schema": { "pattern": "^[a-zA-Z0-9_./\\-]+$", "type": "string" } }, { "name": "cloudGatewayName", "in": "query", "description": "Multicloud cloud gateway name", "schema": { "maxLength": 255, "minLength": 1, "type": "string" } }, { "name": "connectivityState", "in": "query", "description": "Multicloud connectivity state", "schema": { "pattern": "^[a-zA-Z_./\\\\\\-\\s]+$", "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "accountId": { "type": "string" }, "accountName": { "type": "string" }, "cloudGatewayId": { "type": "string" }, "cloudGatewayName": { "type": "string" }, "cloudType": { "type": "string" }, "customSettings": { "type": "boolean" }, "description": { "type": "string" }, "region": { "type": "string" }, "status": { "type": "string" } }, "$$ref": "#/components/schemas/CloudGatewayListResponse" } }, "examples": { "Azure Cgw list": { "description": "Azure Cgw list", "value": [ { "resourceGroupName": "azure-rgp", "cloudGatewayName": "az-test", "accountName": "ramL", "devices": [ "C8K-2F69B355-2B3D-2801-EB48-F44789422299", "C8K-53349F28-AB44-70C5-260B-096581250519" ], "virtualRouterAsn": "65515", "vhubName": "az-test", "description": "", "vwanName": "azure-vwan", "connectivityStateUpdateTs": 1655141135729, "accountId": "8b188c39-f358-4db6-a44f-84068541233a", "cloudGatewayId": "/subscriptions/8b188c39-f358-4db6-a44f-84068541233a0/resourceGroups/test-resource-group/providers/Microsoft.Network/virtualHubs/az-test", "vhubId": "/subscriptions/8b188c39-f358-4db6-a44f-84068541233a0/resourceGroups/test-resource-group/providers/Microsoft.Network/virtualHubs/az-test", "cloudType": "AZURE", "customSettings": false, "region": "westus2", "connectivityState": "initialized", "cloudGatewaySolution": "vhub", "settings": { "softwareImageId": "17.6.01", "skuScaleUnit": 2, "ipSubnetPool": "10.0.0.0/16", "instanceSize": 2 }, "status": "normal", "vpns": [], "connectedSites": 1 } ] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/cloudgateway/availabilityZones": { "get": { "tags": [ "MultiCloud - CloudGateway" ], "description": "Discover AWS availability zones", "operationId": "getAvailabilityZones", "parameters": [ { "name": "cloudType", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "AWS", "AWS_GOVCLOUD" ] } }, { "name": "accountId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "region", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "AttachmentId": { "type": "string", "example": "tgw-12345" } }, "$$ref": "#/components/schemas/TgwAttachmentsListResponse" } }, "examples": { "Discover AWS availability zones": { "description": "Discover AWS availability zones", "value": [ { "zoneId": "usw2-az2", "zoneName": "us-west-2" } ] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/cloudgateway/config-group": { "post": { "tags": [ "MultiCloud - CloudGateway" ], "summary": "Create cloud gateway config group", "description": "API to initiate a config group creation for a cloud gateway.", "operationId": "createCloudGatewayConfigGroup", "parameters": [ { "name": "cloudType", "in": "query", "description": "Multicloud provider type", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Request Payload for Multicloud Gateway Config Group Creation", "content": { "application/json": { "schema": { "required": [ "configGroupName" ], "type": "object", "properties": { "configGroupName": { "pattern": "^[a-zA-Z0-9_/\\\\\\-]+$", "type": "string" }, "configGroupSolution": { "pattern": "^(sdwan|sd-routing)$", "type": "string" } }, "$$ref": "#/components/schemas/MultiCloudGatewaysConfiggroupBody" }, "examples": { "Cloud Gateway Config Group Creation": { "description": "Cloud Gateway Config Group Creation", "value": { "configGroupName": "CGW_Config_Group", "configGroupSolution": "sdwan" } } } } }, "required": true }, "responses": { "200": { "description": "Accepted", "content": { "application/json": { "schema": { "type": "object", "properties": { "createdBy": { "type": "string" }, "createdOn": { "type": "number" }, "description": { "type": "string" }, "devices": { "type": "array", "items": { "type": "string" } }, "fullConfigCli": { "type": "boolean" }, "id": { "type": "string" }, "iosConfigCli": { "type": "boolean" }, "lastUpdatedBy": { "type": "string" }, "lastUpdatedOn": { "type": "number" }, "name": { "type": "string" }, "numberOfDevices": { "type": "integer", "format": "int32" }, "numberOfDevicesUpToDate": { "type": "integer", "format": "int32" }, "origin": { "type": "string" }, "profiles": { "type": "array", "items": { "type": "object", "properties": { "createdBy": { "type": "string" }, "createdOn": { "type": "number" }, "description": { "type": "string" }, "id": { "type": "string" }, "lastUpdatedBy": { "type": "string" }, "lastUpdatedOn": { "type": "number" }, "name": { "type": "string" }, "profileParcelCount": { "type": "string" }, "solution": { "type": "string" }, "type": { "type": "string" } }, "$$ref": "#/components/schemas/PostCgwConfigGroupResponseProfiles" } }, "solution": { "type": "string" }, "source": { "type": "string" }, "state": { "type": "string" }, "topology": { "type": "string" }, "version": { "type": "integer", "format": "int32" } }, "$$ref": "#/components/schemas/PostCgwConfigGroupResponse" }, "examples": { "Cloud Gateway Config Group Creation Response": { "description": "Cloud Gateway Config Group Creation Response", "value": { "id": "9f4bb392-8255-46cd-a849-1aea7ccbad9a", "name": "test_cg", "description": "test_cg Config Group", "source": "MULTICLOUD_AZURE", "solution": "sdwan", "lastUpdatedBy": "system", "lastUpdatedOn": 1712732936141, "createdBy": "system", "createdOn": 1712732936141, "profiles": [ { "id": "5329eb9c-084e-40da-ad17-3304c1922634", "name": "test_cg_AZURE_transport", "solution": "sdwan", "type": "transport", "description": null, "lastUpdatedBy": "system", "lastUpdatedOn": 1712732936112, "createdBy": "system", "createdOn": 1712732935034, "profileParcelCount": 2 }, { "id": "e578e626-3517-4bcc-b802-aecc4a7e85ba", "name": "test_cg_AZURE_system", "solution": "sdwan", "type": "system", "description": null, "lastUpdatedBy": "system", "lastUpdatedOn": 1712732935020, "createdBy": "system", "createdOn": 1712732931425, "profileParcelCount": 9 } ], "version": 1, "state": null, "devices": [], "numberOfDevices": 0, "numberOfDevicesUpToDate": 0, "origin": "user", "topology": null, "fullConfigCli": false, "iosConfigCli": false } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/cloudgateway/nvaSecurityRules/{cloudGatewayName}": { "get": { "tags": [ "MultiCloud - CloudGateway" ], "description": "Get NVA Security Rules", "operationId": "getNvaSecurityRules", "parameters": [ { "name": "cloudGatewayName", "in": "path", "description": "Multicloud cloud gateway name", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "accountId": { "type": "string", "example": "112948124124" }, "accountName": { "type": "string", "example": "test_account_name" }, "cloudType": { "type": "string", "example": "AZURE" }, "expirationTime": { "type": "string", "example": "6/10/2022 6:12:36 PM UTC" }, "nvaId": { "type": "string", "example": "/subscriptions/112948124124/resourceGroups/test-resource-group/providers/Microsoft.Network/networkVirtualAppliances/CiscoSdwanV2-nva-399bdf13-65e9-4177-876b-d125bee704d6" }, "resourceGroupName": { "type": "string", "example": "test-resource-group" }, "ruleName": { "type": "string", "example": "test_rule" }, "securityRulesList": { "type": "object", "properties": { "securityRulesList": { "type": "array", "items": { "required": [ "destinationPortRange", "protocol", "sourceAddressPrefix" ], "type": "object", "properties": { "destinationPortRange": { "pattern": "^\\d+$", "type": "string", "example": "22" }, "protocol": { "pattern": "^(TCP|UDP)$", "type": "string", "example": "TCP" }, "sourceAddressPrefix": { "pattern": "^(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(?:\\.(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3}\\/(?:3[0-2]|[0-2]?[0-9])$", "type": "string", "example": "192.168.1.1/32" } }, "$$ref": "#/components/schemas/NvaRulesListRequestSecurityRulesList" } } }, "$$ref": "#/components/schemas/NvaRulesListRequest" } }, "$$ref": "#/components/schemas/NvaRulesResponse" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "MultiCloud - CloudGateway" ], "description": "Update NVA Security Rules", "operationId": "updateNvaSecurityRules", "parameters": [ { "name": "cloudGatewayName", "in": "path", "required": true, "schema": { "pattern": "^[\\w.-]{1,128}$", "type": "string" } } ], "requestBody": { "description": "Update NVA security Rules", "content": { "application/json": { "schema": { "type": "object", "properties": { "securityRulesList": { "type": "array", "items": { "required": [ "destinationPortRange", "protocol", "sourceAddressPrefix" ], "type": "object", "properties": { "destinationPortRange": { "pattern": "^\\d+$", "type": "string", "example": "22" }, "protocol": { "pattern": "^(TCP|UDP)$", "type": "string", "example": "TCP" }, "sourceAddressPrefix": { "pattern": "^(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(?:\\.(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3}\\/(?:3[0-2]|[0-2]?[0-9])$", "type": "string", "example": "192.168.1.1/32" } }, "$$ref": "#/components/schemas/NvaRulesListRequestSecurityRulesList" } } }, "$$ref": "#/components/schemas/NvaRulesListRequest" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "6c723f65-9106-4f43-9d2b-a033a39353b3" } }, "description": "Task id for polling status", "$$ref": "#/components/schemas/Taskid" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/cloudgateway/nvas": { "get": { "tags": [ "MultiCloud - CloudGateway" ], "description": "Discover Azure Network Virtual Appliances", "operationId": "getAzureNetworkVirtualAppliances", "parameters": [ { "name": "cloudType", "in": "query", "required": true, "schema": { "pattern": "^[a-zA-Z_]+$", "type": "string" } }, { "name": "accountId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "region", "in": "query", "required": true, "schema": { "pattern": "^[a-zA-Z0-9_./\\-]+$", "type": "string" } }, { "name": "resourceGroupName", "in": "query", "required": true, "schema": { "pattern": "^[\\w.-]{1,128}$", "type": "string" } }, { "name": "resourceGroupSource", "in": "query", "required": true, "schema": { "pattern": "^[a-zA-Z_]+$", "type": "string" } }, { "name": "vhubName", "in": "query", "required": true, "schema": { "pattern": "^[\\w.-]{1,128}$", "type": "string" } }, { "name": "vhubSource", "in": "query", "required": true, "schema": { "pattern": "^[a-zA-Z_]+$", "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "nvaId": { "type": "string", "example": "/subscriptions/8b188c39-f358-4db6-a44f-84068541233a0/resourceGroups/test-resource-group/providers/Microsoft.Network/networkVirtualAppliances/CiscoSdwanV2-nva-f383f40c-d07e-41be-bbc7-aa7abbfbf7fc" }, "nvaName": { "type": "string", "example": "CiscoSdwanV2-nva-f383f40c-d07e-41be-bbc7-aa7abbfbf7fc" }, "source": { "type": "string", "example": "vManage" }, "uuids": { "type": "array", "example": [ "C8K-2F69B355-2B3D-2801-EB48-F44789422299", "C8K-10A9ACE8-2283-B45A-4E3A-23DFA39DBEF9" ], "items": { "type": "string", "example": [ "C8K-2F69B355-2B3D-2801-EB48-F44789422299", "C8K-10A9ACE8-2283-B45A-4E3A-23DFA39DBEF9" ] } } }, "$$ref": "#/components/schemas/NvasResponse" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/cloudgateway/nvasku": { "get": { "tags": [ "MultiCloud - CloudGateway" ], "description": "Get Azure NVA SKUs", "operationId": "getAzureNvaSkuResources", "parameters": [ { "name": "cloudType", "in": "query", "description": "Multicloud provider type", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "accountId": { "type": "string", "example": "112948124124" }, "accountName": { "type": "string", "example": "test_account_name" }, "cloudType": { "type": "string", "example": "AZURE" }, "nvaSkuId": { "type": "string", "example": "ciscosdwan" }, "nvaSkuName": { "type": "string", "example": "ciscosdwan" }, "scaleValueList": { "type": "array", "items": { "type": "object", "properties": { "instanceCount": { "type": "integer", "format": "int32" }, "instanceType": { "type": "string" }, "scaleUnit": { "type": "string" } }, "$$ref": "#/components/schemas/NvaSkuListResponseScaleValueList" } }, "versionList": { "type": "array", "items": { "type": "string" } } }, "$$ref": "#/components/schemas/NvaSkuListResponse" }, "examples": { "NVA Skus": { "description": "NVA Skus", "value": [ { "accountId": "112948124124", "accountName": "test_account_name", "cloudType": "AZURE", "nvaSkuId": "ciscosdwan", "nvaSkuName": "ciscosdwan", "versionList": [ [ "17.4.20201218", "17.6.01", "17.7.01" ] ], "scaleValueList": [ [ { "scaleUnit": 10, "instanceType": "Standard_D4_v2", "instanceCount": 2 }, { "scaleUnit": 2, "instanceType": "Standard_D4_v2", "instanceCount": 2 }, { "scaleUnit": 4, "instanceType": "Standard_D4_v2", "instanceCount": 2 } ] ] } ] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/cloudgateway/resource": { "get": { "tags": [ "MultiCloud - CloudGateway" ], "description": "Discover Resource of CGW", "operationId": "getCgwOrgResources", "parameters": [ { "name": "cloudGatewayName", "in": "query", "description": "Multicloud cloud gateway name", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "creationDate": { "type": "string" }, "details": { "type": "object", "properties": { "devices": { "type": "array", "items": { "type": "object", "properties": { "publicIp": { "type": "string" }, "uuid": { "type": "string" } }, "$$ref": "#/components/schemas/CgwResourceResponseDetailsDevices" } }, "vhubName": { "type": "string" }, "virtualRouterAsn": { "type": "string" }, "vwanName": { "type": "string" } }, "$$ref": "#/components/schemas/CgwResourceResponseDetails" }, "esourceId": { "type": "string" }, "resourceType": { "type": "string" } }, "$$ref": "#/components/schemas/CgwResourceResponse" } }, "examples": { "Get CGW Resource": { "description": "Get CGW Resource", "value": { "resourceType": "CGW", "resourceId": "/subscriptions/9b188cb9-f358-4db6-a44f-8406854789a0/resourceGroups/uxtestrg", "creationDate": "Not-Available", "details": { "vwanName": "uxabc", "vhubName": "AzureCGW", "devices": [ { "uuid": "C8K-f64c775a-f93a-4c6b-ac54-57448bdc304b", "publicIp": "[1.2.193.149]" }, { "uuid": "C8K-f64ca-f93a-4c6b-ac54-57448bdc304b", "publicIp": "[13.78.223.149]" } ], "virtualRouterAsn": "65275" } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/cloudgateway/resourceGroups": { "get": { "tags": [ "MultiCloud - CloudGateway" ], "description": "Discover Azure Resource Groups", "operationId": "getAzureResourceGroups", "parameters": [ { "name": "cloudType", "in": "query", "description": "Multicloud provider type", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "query", "description": "Multicloud account id", "schema": { "type": "string" } }, { "name": "discoverAllResourceGroups", "in": "query", "description": "Flag to get all resources group", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "resourceGroupId": { "type": "string", "example": "/subscriptions/8b188c39-f358-4db6-a44f-84068541233a0/resourceGroups/test-resource-group" }, "source": { "type": "string", "example": "azureStored" } }, "$$ref": "#/components/schemas/ResourceGroupsResponse" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/cloudgateway/tgw/Attachments": { "get": { "tags": [ "MultiCloud - CloudGateway" ], "description": "Discover AWS brownfield TGW Attachments", "operationId": "getAwsTgwAttachments", "parameters": [ { "name": "cloudType", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "AWS", "AWS_GOVCLOUD" ] } }, { "name": "accountId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "region", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "tgwId", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "AttachmentId": { "type": "string", "example": "tgw-12345" } }, "$$ref": "#/components/schemas/TgwAttachmentsListResponse" } }, "examples": { "Discover AWS brownfield TGW Attachments": { "description": "Discover AWS brownfield TGW Attachments", "value": "[\n {\n \"attachmentId\": \"tgw-12345\",\n \"attachmentName\": \"test-attachment\"\n \"attachmentType\": \"vpc\"\n }\n]" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/cloudgateway/tgw/RouteTables": { "get": { "tags": [ "MultiCloud - CloudGateway" ], "description": "Discover AWS brownfield TGW route tables", "operationId": "getAwsTgwRouteTables", "parameters": [ { "name": "cloudType", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "AWS", "AWS_GOVCLOUD" ] } }, { "name": "accountId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "region", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "tgwId", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "AttachmentId": { "type": "string", "example": "rt-12345" } }, "$$ref": "#/components/schemas/TgwRouteTablesListResponse" } }, "examples": { "Discover AWS brownfield TGW route tables": { "description": "Discover AWS brownfield TGW route tables", "value": [ { "routeTableId": "rt-12345", "routeTableName": "test-rt" } ] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/cloudgateway/tgws": { "get": { "tags": [ "MultiCloud - CloudGateway" ], "description": "Discover AWS brownfield TGWs", "operationId": "getAwsTgws", "parameters": [ { "name": "cloudType", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "AWS", "AWS_GOVCLOUD" ] } }, { "name": "accountId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "region", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "tgwId": { "type": "string", "example": "tgw-12345" }, "tgwName": { "type": "string", "example": "tgw-test" } }, "$$ref": "#/components/schemas/TgwsListResponse" } }, "examples": { "Discovered AWS brownfield TGWs": { "description": "Discovered AWS brownfield TGWs", "value": [ { "tgwId": "tgw-12345", "tgwName": "tgw-test" } ] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/cloudgateway/vhubs": { "get": { "tags": [ "MultiCloud - CloudGateway" ], "description": "Discover Azure Virtual HUBs", "operationId": "getAzureVirtualHubs", "parameters": [ { "name": "cloudType", "in": "query", "required": true, "schema": { "pattern": "^[a-zA-Z_]+$", "type": "string" } }, { "name": "accountId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "region", "in": "query", "required": true, "schema": { "pattern": "^[a-zA-Z0-9_./\\-]+$", "type": "string" } }, { "name": "resourceGroupName", "in": "query", "required": true, "schema": { "pattern": "^[\\w.-]{1,128}$", "type": "string" } }, { "name": "resourceGroupSource", "in": "query", "required": true, "schema": { "pattern": "^[a-zA-Z_]+$", "type": "string" } }, { "name": "vwanName", "in": "query", "required": true, "schema": { "pattern": "^[\\w.-]{1,128}$", "type": "string" } }, { "name": "vwanSource", "in": "query", "required": true, "schema": { "pattern": "^[a-zA-Z_]+$", "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "source": { "type": "string", "example": "vManage" }, "vhubId": { "type": "string", "example": "/subscriptions/8b188c39-f358-4db6-a44f-84068541233a0/resourceGroups/test-resource-group/providers/Microsoft.Network/virtualHubs/cgw-test" }, "vhubName": { "type": "string", "example": "cgw-test" } }, "$$ref": "#/components/schemas/VhubsListResponse" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/cloudgateway/vnetsNoofAttached": { "get": { "tags": [ "MultiCloud - CloudGateway" ], "description": "Discover Azure Virtual HUBs", "operationId": "getAzureVirtualVnetsAttached", "parameters": [ { "name": "cloudType", "in": "query", "description": "Multicloud provider type", "required": true, "schema": { "type": "string" } }, { "name": "cloudGatewayName", "in": "query", "required": true, "schema": { "maxLength": 1024, "minLength": 1, "pattern": "^[a-zA-Z0-9_./\\-]+$", "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "isVnetAttached": { "type": "boolean", "example": true } }, "$$ref": "#/components/schemas/IsVnetAttached" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/cloudgateway/vpn-gateways": { "get": { "tags": [ "MultiCloud - CloudGateway" ], "description": "Discover Azure Vpn Gateways", "operationId": "getAzureVpnGateways", "parameters": [ { "name": "cloudType", "in": "query", "required": true, "schema": { "pattern": "^[a-zA-Z_]+$", "type": "string" } }, { "name": "accountId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "region", "in": "query", "required": true, "schema": { "pattern": "^[a-zA-Z0-9_./\\-]+$", "type": "string" } }, { "name": "resourceGroupName", "in": "query", "required": true, "schema": { "pattern": "^[\\w.-]{1,128}$", "type": "string" } }, { "name": "resourceGroupSource", "in": "query", "required": true, "schema": { "pattern": "^[a-zA-Z_]+$", "type": "string" } }, { "name": "vhubName", "in": "query", "required": true, "schema": { "pattern": "^[\\w.-]{1,128}$", "type": "string" } }, { "name": "vhubSource", "in": "query", "required": true, "schema": { "pattern": "^[a-zA-Z_]+$", "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "source": { "type": "string", "example": "vManage" }, "vpnGatewayId": { "type": "string", "example": "/subscriptions/9b188cb9-f358-4db6-a44f-8406854789a0/resourceGroups/azureTestRGP8/providers/Microsoft.Network/virtualHubs/azureTestVhub2" }, "vpnGatewayName": { "type": "string", "example": "vpn-gateway-azure-east-2" } }, "$$ref": "#/components/schemas/VpnGatewayResponse" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/cloudgateway/vwans": { "get": { "tags": [ "MultiCloud - CloudGateway" ], "description": "Discover Azure Virtual WANS", "operationId": "getAzureVirtualWans", "parameters": [ { "name": "cloudType", "in": "query", "required": true, "schema": { "pattern": "^[a-zA-Z_]+$", "type": "string" } }, { "name": "accountId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "resourceGroupName", "in": "query", "required": true, "schema": { "pattern": "^[\\w.-]{1,128}$", "type": "string" } }, { "name": "resourceGroupSource", "in": "query", "required": true, "schema": { "pattern": "^[a-zA-Z_]+$", "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "source": { "type": "string", "example": "vmanage" }, "vwanId": { "type": "string", "example": "/subscriptions/8b188c39-f358-4db6-a44f-84068541233a0/resourceGroups/test-resource-group/providers/Microsoft.Network/virtualWans/test-vwan" }, "vwanName": { "type": "string", "example": "test-vwan" } }, "$$ref": "#/components/schemas/VwanListResponse" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/cloudgateway/{cloudGatewayName}": { "get": { "tags": [ "MultiCloud - CloudGateway" ], "description": "Get cloud gateway by name", "operationId": "getCgwDetails", "parameters": [ { "name": "cloudGatewayName", "in": "path", "description": "Multicloud cloud gateway name", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "accountId": { "type": "string" }, "cloudGatewayId": { "type": "string" }, "cloudGatewayMode": { "type": "string", "description": "Only applicable to AWS/AWS_GOVCLOUD CloudTypes" }, "cloudGatewayName": { "type": "string" }, "cloudGatewaySolution": { "type": "string" }, "cloudProviderASN": { "type": "integer", "description": "CGW details relevant to AWS/AWS_GOVCLOUD", "format": "int32" }, "cloudProviderMgmtReference": { "type": "string", "description": "CGW details relevant to AWS/AWS_GOVCLOUD" }, "cloudType": { "type": "string" }, "connectedSites": { "type": "integer", "format": "int32" }, "connectivityState": { "type": "string" }, "connectivityStateUpdateTs": { "type": "number" }, "customSettings": { "type": "boolean" }, "description": { "type": "string" }, "devices": { "type": "array", "items": { "type": "string" } }, "mrfRouterRole": { "type": "string" }, "region": { "type": "string" }, "resourceGroupName": { "type": "string", "description": "CGW details relevant to AZURE/AZURE_GOVCLOUD CloudTypes" }, "routeTableCount": { "type": "string", "description": "CGW details relevant to AWS/AWS_GOVCLOUD" }, "s2sPermitted": { "type": "boolean", "description": "Only applicable to GCP CloudGateways" }, "settings": { "type": "object", "properties": { "cloudGatewaySolution": { "pattern": "^[a-zA-Z_]*$", "type": "string" }, "cloudType": { "pattern": "^[a-zA-Z_]*$", "type": "string" }, "instanceSize": { "pattern": "^[a-zA-Z0-9_./\\-]*$", "type": "string" }, "ipSubnetPool": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(?:\\.(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3}\\/(?:3[0-2]|[0-2]?[0-9]))(?:\\s*,\\s*(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(?:\\.(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3}\\/(?:3[0-2]|[0-2]?[0-9]))*$", "type": "string" }, "name": { "pattern": "^[a-zA-Z_]*$", "type": "string" }, "networkTier": { "pattern": "^[a-zA-Z0-9_./\\-]*$", "type": "string", "description": "Used for GCP Custom settings" }, "skuScaleUnit": { "pattern": "^[0-9]*$", "type": "string", "description": "Used for Azure/Azure GovCloud Custom settings" }, "softwareImageId": { "pattern": "^[a-zA-Z0-9_./\\-\\s]*$", "type": "string" }, "tunnelCount": { "pattern": "^[0-9]*$", "type": "string", "description": "Tunnel Count for AWS Connect based and branch connect" } }, "$$ref": "#/components/schemas/CustomSettings" }, "siteName": { "type": "string" }, "status": { "type": "string" }, "tunnelCidrBlocks": { "type": "array", "description": "CGW details relevant to AWS/AWS_GOVCLOUD", "items": { "type": "object", "description": "CGW details relevant to AWS/AWS_GOVCLOUD" } }, "tunnels": { "type": "array", "properties": { "empty": { "type": "boolean" } }, "description": "CGW details relevant to AWS/AWS_GOVCLOUD", "items": { "type": "object", "properties": { "acceptedRouteCount": { "type": "integer", "format": "int32" }, "lastStatusChangeTimestamp": { "type": "string" }, "outerIpAddr": { "type": "string" }, "status": { "type": "string" }, "statusMessage": { "type": "string" }, "tunnelId": { "type": "string" }, "tunnelInnerIp": { "type": "array", "items": { "type": "string" } } }, "description": "CGW details relevant to AWS/AWS_GOVCLOUD", "$$ref": "#/components/schemas/TunnelsInner" } }, "vhubName": { "type": "string", "description": "CGW details relevant to AZURE/AZURE_GOVCLOUD CloudTypes" }, "virtualRouterAsn": { "type": "string", "description": "CGW details relevant to AZURE/AZURE_GOVCLOUD CloudTypes" }, "vpns": { "type": "array", "items": { "type": "string" } }, "vwanName": { "type": "string", "description": "CGW details relevant to AZURE/AZURE_GOVCLOUD CloudTypes" } }, "$$ref": "#/components/schemas/CloudGatewayAdjusted" }, "examples": { "Get GCP CGW ": { "description": "Get GCP CGW ", "value": { "cloudGatewayName": "gcp-test", "accountName": "gcp-dev", "devices": [ "C8K-4B68E23F-B24F-EDE8-05DD-B36EAA14C9C1", "C8K-0D92AF4F-EA3C-3D40-4781-BD5B4112B05B", "C8K-10A9ACE8-2283-B45A-4E3A-23DFA39DBEF9" ], "description": "", "cloudProviderMgmtReference": "NA", "connectivityStateUpdateTs": 1654905819730, "s2sPermitted": true, "accountId": "gcp-project-nprd-31900", "cloudProviderAsn": 0, "sshKeyName": "", "tunnelCidrBlocks": [], "cloudGatewayId": "s2c-hub-gcp-test, s2s-hub-gcp-test", "cloudType": "GCP", "customSettings": true, "cloudGatewaySolution": "gcp", "region": "us-west4", "connectivityState": "Successful", "routeTableCount": "NA", "settings": { "softwareImageId": "cisco-c8k-17-05-01a-cisco-public", "instanceSize": "n1-standard-4", "ipSubnetPool": "10.0.0.0/16", "networkTier": "STANDARD" }, "status": "error", "vpns": [ { "vpnId": "9" } ], "connectedSites": 0, "tunnels": [ { "tunnelId": "C8K-10A9ACE8-2283-B45A-4E3A-23DFA39DBEF9::9", "status": "DOWN", "statusMessage": "NotAvailable", "outerIpAddr": "NotAvailable", "acceptedRouteCount": 0, "lastStatusChangeTimestamp": "NotAvailable" }, { "tunnelId": "C8K-0D92AF4F-EA3C-3D40-4781-BD5B4112B05B::9", "status": "DOWN", "statusMessage": "NotAvailable", "outerIpAddr": "NotAvailable", "acceptedRouteCount": 0, "lastStatusChangeTimestamp": "NotAvailable" }, { "tunnelId": "C8K-4B68E23F-B24F-EDE8-05DD-B36EAA14C9C1::9", "status": "DOWN", "statusMessage": "NotAvailable", "outerIpAddr": "NotAvailable", "acceptedRouteCount": 0, "lastStatusChangeTimestamp": "NotAvailable" } ] } }, "Get AWS/AWS GovCloud CGW ": { "description": "Get AWS/AWS GovCloud CGW ", "value": { "cloudGatewayName": "aws-test", "accountName": "aws-dev", "devices": [ "C8K-BF4B09D2-1C07-8634-753D-5DE2F5D6B15C", "C8K-C516558F-45CA-3486-38FD-5D0306E05999" ], "description": "", "cloudProviderMgmtReference": "", "connectivityStateUpdateTs": 1655144961158, "accountId": "759589527992", "cloudProviderAsn": 64520, "tunnelCidrBlocks": [], "cloudGatewayId": "tgw-0b6ac1173825c3663", "cloudType": "AWS", "customSettings": true, "cloudGatewaySolution": "tgw_tvpc", "region": "us-east-1", "connectivityState": "Successful", "routeTableCount": "2", "settings": { "softwareImageId": "Cisco-C8K-17.04.01a-42cb6e93-8d9d-490b-a73c-e3e56077ffd1-ami-012fee29ab1f5f2c3.4", "instanceSize": "c5.large", "ipSubnetPool": "11.0.0.0/16" }, "status": "normal", "vpns": [ { "vpnId": "9" } ], "connectedSites": 2, "tunnels": [ { "tunnelId": "C8K-C516558F-45CA-3486-38FD-5D0306E05999::9", "tunnelInnerIps": [ "169.254.0.12/30", "169.254.0.16/30" ], "status": "DOWN", "statusMessage": "NotAvailable", "outerIpAddr": "NotAvailable", "acceptedRouteCount": 0, "lastStatusChangeTimestamp": "NotAvailable" }, { "tunnelId": "C8K-BF4B09D2-1C07-8634-753D-5DE2F5D6B15C::9", "tunnelInnerIps": [ "169.254.0.4/30", "169.254.0.8/30" ], "status": "DOWN", "statusMessage": "NotAvailable", "outerIpAddr": "NotAvailable", "acceptedRouteCount": 0, "lastStatusChangeTimestamp": "NotAvailable" } ] } }, "Get Azure/Azure GovCloud CGW": { "description": "Get Azure/Azure GovCloud CGW", "value": { "resourceGroupName": "azure-rgp", "cloudGatewayName": "az-test", "accountName": "ramL", "devices": [ "C8K-2F69B355-2B3D-2801-EB48-F44789422299", "C8K-53349F28-AB44-70C5-260B-096581250519" ], "virtualRouterAsn": "65515", "vhubName": "az-test", "description": "", "vwanName": "azure-vwan", "connectivityStateUpdateTs": 1655141135729, "accountId": "8b188c39-f358-4db6-a44f-84068541233a", "cloudGatewayId": "/subscriptions/8b188c39-f358-4db6-a44f-84068541233a0/resourceGroups/test-resource-group/providers/Microsoft.Network/virtualHubs/az-test", "vhubId": "/subscriptions/8b188c39-f358-4db6-a44f-84068541233a0/resourceGroups/test-resource-group/providers/Microsoft.Network/virtualHubs/az-test", "cloudType": "AZURE", "customSettings": false, "region": "westus2", "connectivityState": "initialized", "cloudGatewaySolution": "vhub", "settings": { "softwareImageId": "17.6.01", "skuScaleUnit": 2, "ipSubnetPool": "10.0.0.0/16", "instanceSize": 2 }, "status": "normal", "vpns": [], "connectedSites": 1 } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "MultiCloud - CloudGateway" ], "description": "Update cloud gateway", "operationId": "updateCgw", "parameters": [ { "name": "cloudGatewayName", "in": "path", "required": true, "schema": { "pattern": "^[\\w.-]{1,128}$", "type": "string" } } ], "requestBody": { "description": "Payloads for updating Cloud Gateway based on CloudType", "content": { "application/json": { "schema": { "required": [ "accountId", "cloudGatewayName", "cloudType", "region", "resourceGroupName", "vhubId" ], "type": "object", "properties": { "accountId": { "type": "string" }, "awsTgwProperties": { "type": "object", "properties": { "disconnectTgw": { "type": "boolean" }, "tgwConnections": { "type": "array", "properties": { "empty": { "type": "boolean" } }, "description": "Defines a list of TGW connections. Null if tgwSource is not aws", "items": { "type": "object", "properties": { "conn": { "type": "string" }, "tgwRouteTableId": { "type": "string" }, "vpnId": { "type": "string" } }, "description": "Defines a list of TGW connections. Null if tgwSource is not aws", "$$ref": "#/components/schemas/TgwConnectionsInner" } }, "tgwId": { "type": "string" }, "tgwSource": { "type": "string", "enum": [ "aws", "tvpcOnly", "toBeCreated" ] } }, "description": "Used in AWS brownfield CGW creation", "$$ref": "#/components/schemas/UpdateCgwAwsTgwProperties" }, "cloudGatewayName": { "pattern": "^[\\w.-]{1,128}$", "type": "string" }, "cloudType": { "pattern": "^[a-zA-Z_]+$", "type": "string" }, "description": { "type": "string" }, "deviceChanges": { "type": "object", "properties": { "devicesAdded": { "type": "array", "items": { "type": "string" } }, "devicesDeleted": { "type": "array", "items": { "type": "string" } } }, "description": "Used for GCP updateCgw", "$$ref": "#/components/schemas/UpdateCgwDeviceChanges" }, "devices": { "type": "array", "description": "Used for AZURE updateCgw", "items": { "type": "string", "description": "Used for AZURE updateCgw" } }, "mrfRouterRole": { "pattern": "^(border|edge)$", "type": "string" }, "region": { "pattern": "^[a-zA-Z0-9_./\\-]+$", "type": "string" }, "resourceGroupName": { "pattern": "^[\\w.-]{1,128}$", "type": "string", "description": "Used for AZURE updateCgw" }, "s2sPermitted": { "pattern": "^(true|false)$", "type": "string", "description": "Used for GCP updateCgw" }, "settings": { "type": "object", "properties": { "cloudGatewaySolution": { "pattern": "^[a-zA-Z_]*$", "type": "string" }, "cloudType": { "pattern": "^[a-zA-Z_]*$", "type": "string" }, "instanceSize": { "pattern": "^[a-zA-Z0-9_./\\-]*$", "type": "string" }, "ipSubnetPool": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(?:\\.(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3}\\/(?:3[0-2]|[0-2]?[0-9]))(?:\\s*,\\s*(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(?:\\.(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3}\\/(?:3[0-2]|[0-2]?[0-9]))*$", "type": "string" }, "name": { "pattern": "^[a-zA-Z_]*$", "type": "string" }, "networkTier": { "pattern": "^[a-zA-Z0-9_./\\-]*$", "type": "string", "description": "Used for GCP Custom settings" }, "skuScaleUnit": { "pattern": "^[0-9]*$", "type": "string", "description": "Used for Azure/Azure GovCloud Custom settings" }, "softwareImageId": { "pattern": "^[a-zA-Z0-9_./\\-\\s]*$", "type": "string" }, "tunnelCount": { "pattern": "^[0-9]*$", "type": "string", "description": "Tunnel Count for AWS Connect based and branch connect" } }, "$$ref": "#/components/schemas/AllOfupdateCgwSettings" }, "vhubId": { "type": "string", "description": "Used for AZURE updateCgw" } }, "$$ref": "#/components/schemas/UpdateCgw" }, "examples": { "GCP CGW CGW update": { "description": "GCP CGW CGW update", "value": { "cloudType": "GCP", "accountId": "gcp-project-nprd-31900", "region": "us-west4", "s2sPermitted": true, "mrfRouterRole": "border", "deviceChanges": { "devicesAdded": [ "C8K-10A9ACE8-2283-B45A-4E3A-23DFA39DBEF9" ], "devicesDeleted": [] } } }, "AWS/AWS GovCloud CGW update": { "description": "AWS/AWS GovCloud CGW update", "value": { "cloudType": "AWS", "mrfRouterRole": "border", "settings": { "tunnelCount": 3 } } }, "AZURE/AZURE GovCloud CGW update": { "description": "AZURE/AZURE GovCloud CGW update", "value": { "cloudType": "AZURE", "accountId": "8b188c39-f358-4db6-a44f-84068541233a", "region": "westus2", "cloudGatewayName": "az-test", "mrfRouterRole": "border", "devices": [ "C8K-2F69B355-2B3D-2801-EB48-F44789422299", "C8K-D4821270-27FF-A1B0-B902-12A321E3A550" ], "description": "", "resourceGroupName": "test-resource-group", "vhubId": "/subscriptions/8b188c39-f358-4db6-a44f-84068541233a0/resourceGroups/test-resource-group/providers/Microsoft.Network/virtualHubs/az-test", "settings": { "cloudType": "AZURE", "name": "AZURE_CUSTOM_SETTINGS", "ipSubnetPool": "10.0.0.0/16", "skuScaleUnit": 4, "softwareImageId": "17.6.01" } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "6c723f65-9106-4f43-9d2b-a033a39353b3" } }, "description": "Task id for polling status", "$$ref": "#/components/schemas/Taskid" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "MultiCloud - CloudGateway" ], "description": "Delete cloud gateway", "operationId": "deleteCgw", "parameters": [ { "name": "cloudGatewayName", "in": "path", "description": "Multicloud cloud gateway name", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } }, { "name": "deleteAllResources", "in": "query", "schema": { "pattern": "^(true|false)$", "type": "string", "default": "true" } }, { "name": "deleteVhubResourceGroup", "in": "query", "schema": { "pattern": "^(true|false)$", "type": "string", "default": "true" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "6c723f65-9106-4f43-9d2b-a033a39353b3" } }, "description": "Task id for polling status", "$$ref": "#/components/schemas/Taskid" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/cloudgateway/{cloudGatewayName}/site": { "get": { "tags": [ "MultiCloud - BranchConnect" ], "description": "Get sites attached to CGW", "operationId": "getCgwAttachedSites", "parameters": [ { "name": "cloudGatewayName", "in": "path", "description": "Name of Cloud Gateway to attach site", "required": true, "schema": { "pattern": "^[\\w.-]{1,128}$", "type": "string" } }, { "name": "systemIp", "in": "query", "description": "System Ip of Branch Device", "schema": { "pattern": "^((([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\\p{N}\\p{L}]+)?)((\\s)(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\\p{N}\\p{L}]+)?)?$", "type": "string" } }, { "name": "siteId", "in": "query", "description": "Site Id", "schema": { "pattern": "^\\d+$", "type": "string" } }, { "name": "color", "in": "query", "description": "color", "schema": { "pattern": "^(default|mpls|metro-ethernet|biz-internet|public-internet|lte|3g|red|green|blue|gold|silver|bronze|custom1|custom2|custom3|private1|private2|private3|private4|private5|private6)$", "type": "string" } }, { "name": "vpnTunnelStatus", "in": "query", "description": "Tunnel status of device", "schema": { "pattern": "^(true|false)$", "type": "string" } }, { "name": "solution", "in": "query", "description": "Solution of branch device", "schema": { "pattern": "^(sdwan|sd-routing)$", "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "acceleratedVpn": { "type": "boolean" }, "aggTunnelStatus": { "type": "string" }, "attached": { "type": "boolean" }, "color": { "type": "string" }, "hostname": { "type": "string" }, "interface": { "type": "string" }, "preferredInterface": { "type": "boolean", "example": true }, "privateIp": { "type": "string" }, "publicIp": { "type": "string" }, "siteId": { "type": "string" }, "systemIp": { "type": "string" }, "tunnelCount": { "type": "number" }, "tunnels": { "type": "array", "properties": { "empty": { "type": "boolean" } }, "description": "CGW details relevant to AWS/AWS_GOVCLOUD", "items": { "type": "object", "properties": { "acceptedRouteCount": { "type": "integer", "format": "int32" }, "lastStatusChangeTimestamp": { "type": "string" }, "outerIpAddr": { "type": "string" }, "status": { "type": "string" }, "statusMessage": { "type": "string" }, "tunnelId": { "type": "string" }, "tunnelInnerIp": { "type": "array", "items": { "type": "string" } } }, "description": "CGW details relevant to AWS/AWS_GOVCLOUD", "$$ref": "#/components/schemas/TunnelsInner" } }, "uuid": { "type": "string" } }, "$$ref": "#/components/schemas/GetSitesResponse" }, "examples": { "Sites": { "description": "Sites", "value": { "uuid": "C8K-a165f574-e75e-11ec-8fea-0242ac120002", "siteId": "10", "hostname": "Branch-10", "systemIp": "1.1.1.10", "interface": "GigabitEthernet2", "color": "red", "privateIp": "10.11.2.248", "publicIp": "3.109.26.54", "attached": true } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "MultiCloud - BranchConnect" ], "description": "Detach sites from cloud gateway", "operationId": "detachSites_MulticloudBranchconnect_4806", "parameters": [ { "name": "cloudGatewayName", "in": "path", "description": "Name of Cloud Gateway to attach site", "required": true, "schema": { "pattern": "^[\\w.-]{1,128}$", "type": "string" } } ], "requestBody": { "description": "Site Information", "content": { "application/json": { "schema": { "type": "array", "properties": { "empty": { "type": "boolean" } }, "items": { "required": [ "siteId", "systemIp" ], "type": "object", "properties": { "color": { "pattern": "^(default|mpls|metro-ethernet|biz-internet|public-internet|lte|3g|red|green|blue|gold|silver|bronze|custom1|custom2|custom3|private1|private2|private3|private4|private5|private6)$", "type": "string", "example": "red" }, "interface": { "type": "string", "example": "GigabitEthernet1" }, "siteId": { "pattern": "^\\d+$", "type": "string", "example": "578" }, "solution": { "pattern": "^(sdwan|sd-routing)$", "type": "string", "example": "sd-routing" }, "systemIp": { "pattern": "^((([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\\p{N}\\p{L}]+)?)((\\s)(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\\p{N}\\p{L}]+)?)?$", "type": "string", "example": "1.1.1.178" } }, "$$ref": "#/components/schemas/DetachSitesRequestPayloadInner" }, "$$ref": "#/components/schemas/DetachSitesRequestPayload" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "6c723f65-9106-4f43-9d2b-a033a39353b3" } }, "description": "Task id for polling status", "$$ref": "#/components/schemas/Taskid" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "MultiCloud - BranchConnect" ], "description": "Attach sites to Cloud Gateway", "operationId": "attachSites", "parameters": [ { "name": "cloudGatewayName", "in": "path", "description": "Name of Cloud Gateway to attach site", "required": true, "schema": { "pattern": "^[\\w.-]{1,128}$", "type": "string" } } ], "requestBody": { "description": "Site Information", "content": { "application/json": { "schema": { "type": "array", "properties": { "empty": { "type": "boolean" } }, "items": { "required": [ "color", "siteId", "solution", "systemIp", "tunnelCount" ], "type": "object", "properties": { "acceleratedVpn": { "pattern": "^(true|false)$", "type": "string" }, "color": { "pattern": "^(default|mpls|metro-ethernet|biz-internet|public-internet|lte|3g|red|green|blue|gold|silver|bronze|custom1|custom2|custom3|private1|private2|private3|private4|private5|private6)$", "type": "string" }, "interface": { "type": "string", "example": "GigabitEthernet1" }, "preferredInterface": { "pattern": "^[a-zA-Z0-9]*$", "type": "string", "example": "true" }, "publicIp": { "pattern": "^((([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\\p{N}\\p{L}]+)?)((\\s)(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\\p{N}\\p{L}]+)?)?$", "type": "string", "example": "18.219.1.221" }, "siteId": { "pattern": "^\\d+$", "type": "string" }, "solution": { "pattern": "^(sdwan|sd-routing)$", "type": "string", "description": "Multicloud Branch Connect Solution type", "example": "sd-routing" }, "systemIp": { "pattern": "^((([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\\p{N}\\p{L}]+)?)((\\s)(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\\p{N}\\p{L}]+)?)?$", "type": "string" }, "tunnelCount": { "pattern": "^[1-8]$", "type": "string", "example": "4" } }, "$$ref": "#/components/schemas/AttachSitesRequestPayloadInner" }, "$$ref": "#/components/schemas/AttachSitesRequestPayload" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "6c723f65-9106-4f43-9d2b-a033a39353b3" } }, "description": "Task id for polling status", "$$ref": "#/components/schemas/Taskid" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "MultiCloud - BranchConnect" ], "description": "Update tunnel scaling and accelerated vpn parameter for a branch endpoint", "operationId": "tunnelScaling", "parameters": [ { "name": "cloudGatewayName", "in": "path", "description": "Name of Cloud Gateway to attach site", "required": true, "schema": { "pattern": "^[\\w.-]{1,128}$", "type": "string" } } ], "requestBody": { "description": "Site Information", "content": { "application/json": { "schema": { "required": [ "cloudType" ], "type": "object", "properties": { "branchEndpoints": { "type": "array", "items": { "required": [ "acceleratedVpn", "cloudType", "color", "siteId", "systemIp", "tunnelCount" ], "type": "object", "properties": { "acceleratedVpn": { "pattern": "^(true|false)$", "type": "string" }, "cloudType": { "pattern": "^[a-zA-Z_]+$", "type": "string", "example": "AWS" }, "color": { "pattern": "^(default|mpls|metro-ethernet|biz-internet|public-internet|lte|3g|red|green|blue|gold|silver|bronze|custom1|custom2|custom3|private1|private2|private3|private4|private5|private6)$", "type": "string", "example": "red" }, "hostName": { "type": "string", "example": "test_device" }, "interface": { "type": "string", "example": "GigabitEthernet1" }, "preferredInterface": { "pattern": "^[a-zA-Z0-9]*$", "type": "string", "example": "true" }, "publicIp": { "pattern": "^((([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\\p{N}\\p{L}]+)?)((\\s)(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\\p{N}\\p{L}]+)?)?$", "type": "string", "example": "3.129.232.5" }, "siteId": { "pattern": "^\\d+$", "type": "string", "example": "578" }, "solution": { "pattern": "^(sdwan|sd-routing)$", "type": "string", "example": "sd-routing" }, "status": { "type": "string", "example": "unavailable" }, "systemIp": { "pattern": "^((([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\\p{N}\\p{L}]+)?)((\\s)(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\\p{N}\\p{L}]+)?)?$", "type": "string", "example": "1.1.1.178" }, "tunnelCount": { "pattern": "^[1-8]$", "type": "string", "example": "4" }, "uuid": { "type": "string", "example": "C8K-b78a317a-0d6c-4023-9690-8559d6ac803d" } }, "$$ref": "#/components/schemas/TunnelScalingRequestPayloadBranchEndpoints" } }, "cloudType": { "pattern": "^[a-zA-Z_]+$", "type": "string", "example": "AWS" } }, "$$ref": "#/components/schemas/TunnelScalingRequestPayload" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "6c723f65-9106-4f43-9d2b-a033a39353b3" } }, "description": "Task id for polling status", "$$ref": "#/components/schemas/Taskid" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/cloudgateway/{cloudType}/gateways/device-chassis-numbers": { "get": { "tags": [ "MultiCloud - CloudGateway" ], "summary": "Get cloud gateway devices by config ID.", "description": "API to retrieve available devices or devices associated to a config group.", "operationId": "getAvailableDevicesOrByCGId_MulticloudCloudgateway_6803", "parameters": [ { "name": "cloudType", "in": "path", "description": "Multicloud provider type", "required": true, "schema": { "type": "string" } }, { "name": "config-group-id", "in": "query", "description": "Multicloud config group id", "schema": { "pattern": "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}", "type": "string" } }, { "name": "device-solution-type", "in": "query", "description": "Multicloud device solution type", "schema": { "pattern": "^(sdwan|sd-routing)$", "type": "string" } } ], "responses": { "200": { "description": "Accepted", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "data": { "type": "array", "description": "data list", "example": [ "MEGAPORT", "EQUINIX", "ATT" ], "items": { "type": "string", "description": "data", "example": "MEGAPORT" } } }, "$$ref": "#/components/schemas/InlineResponse200" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/cloudgateways/{cloudType}": { "get": { "tags": [ "MultiCloud - CloudGateway" ], "description": "Get sites with connectivity to the cloud by cloud type", "operationId": "getCloudGateways", "parameters": [ { "name": "cloudType", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "AWS", "AWS_GOVCLOUD", "AZURE", "AZURE_GOVCLOUD", "GCP" ] } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "accountId": { "type": "string" }, "accountName": { "type": "string" }, "cloudGatewayId": { "type": "string" }, "cloudGatewayName": { "type": "string" }, "cloudType": { "type": "string" }, "customSettings": { "type": "boolean" }, "description": { "type": "string" }, "region": { "type": "string" }, "status": { "type": "string" } }, "$$ref": "#/components/schemas/CloudGatewayListResponse" } }, "examples": { " List of CGWs per cloudType ": { "description": " List of CGWs per cloudType ", "value": [ { "cloudGatewayName": "gcp-test", "cloudGatewayId": "s2c-hub-gcptest, s2s-hub-gcptest", "description": "", "cloudType": "GCP", "accountId": "gcp-project-nprd-31900", "accountName": "gcp-dev", "region": "us-west2", "customSettings": true, "status": "normal" }, { "cloudGatewayName": "gcp-test-west-4", "cloudGatewayId": "s2c-hub-gcptest, s2s-hub-gcptest", "description": "", "cloudType": "GCP", "accountId": "gcp-project-nprd-3190", "accountName": "gcp-dev", "region": "us-west4", "customSettings": true, "status": "normal" } ] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/cloudgatewaysetting/{cloudGatewayName}": { "get": { "tags": [ "MultiCloud - CloudGateway" ], "description": "Get cloud gateway custom setting by cloud gateway name", "operationId": "getCgwCustomSettingDetails", "parameters": [ { "name": "cloudGatewayName", "in": "path", "required": true, "schema": { "pattern": "^[\\w.-]{1,128}$", "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "cloudGatewaySolution": { "pattern": "^[a-zA-Z_]*$", "type": "string" }, "cloudType": { "pattern": "^[a-zA-Z_]*$", "type": "string" }, "instanceSize": { "pattern": "^[a-zA-Z0-9_./\\-]*$", "type": "string" }, "ipSubnetPool": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(?:\\.(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3}\\/(?:3[0-2]|[0-2]?[0-9]))(?:\\s*,\\s*(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(?:\\.(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3}\\/(?:3[0-2]|[0-2]?[0-9]))*$", "type": "string" }, "name": { "pattern": "^[a-zA-Z_]*$", "type": "string" }, "networkTier": { "pattern": "^[a-zA-Z0-9_./\\-]*$", "type": "string", "description": "Used for GCP Custom settings" }, "skuScaleUnit": { "pattern": "^[0-9]*$", "type": "string", "description": "Used for Azure/Azure GovCloud Custom settings" }, "softwareImageId": { "pattern": "^[a-zA-Z0-9_./\\-\\s]*$", "type": "string" }, "tunnelCount": { "pattern": "^[0-9]*$", "type": "string", "description": "Tunnel Count for AWS Connect based and branch connect" } }, "$$ref": "#/components/schemas/CustomSettings" }, "examples": { "GCP Custom Custom Settings": { "description": "GCP Custom Custom Settings", "value": { "cloudType": "GCP", "instanceSize": "n1-standard-4", "cgwCustomSettingName": "GCP_CUSTOM_SETTING_gcp-test", "networkTier": "STANDARD", "ipSubnetPool": "10.0.0.0/16", "softwareImageId": "cisco-c8k-17-05-01a-cisco-public" } }, "AWS/AWS_GOVCLOUD Custom Settings": { "description": "AWS/AWS_GOVCLOUD Custom Settings", "value": { "cloudType": "AWS", "ipSubnetPool": "10.0.0.0/16", "instanceSize": "c5.large", "cgwCustomSettingName": "AWS_CUSTOM_SETTING_aws-test", "softwareImageId": "Cisco-C8K-17.04.01a-42cb6e93-8d9d-490b-a73c-e3e56077ffd1-ami-012fee29ab1f5f2c3.4" } }, "AZURE/AZURE_GOVCLOUD Custom Settings": { "description": "AZURE/AZURE_GOVCLOUD Custom Settings", "value": { "cloudType": "AZURE", "ipSubnetPool": "10.0.0.0/16", "skuScaleUnit": 2, "cgwCustomSettingName": "AZURE_CUSTOM_SETTING_azure-test", "softwareImageId": "17.6.01" } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/cloudgatewaytype": { "get": { "tags": [ "MultiCloud - CloudGateway" ], "description": "Get cloud gateway types for specified cloudType", "operationId": "getCgwTypes", "parameters": [ { "name": "cloudType", "in": "query", "schema": { "type": "string", "enum": [ "AWS", "AWS_GOVCLOUD", "AZURE", "AZURE_GOVCLOUD", "GCP" ] } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/connected-sites/{cloudType}": { "get": { "tags": [ "MultiCloud - General" ], "description": "Get sites with connectivity to the cloud by cloud type", "operationId": "getCloudConnectedSites_MulticloudGeneral_3903", "parameters": [ { "name": "cloudType", "in": "path", "required": true, "schema": { "pattern": "^[a-zA-Z_]+$", "type": "string" } }, { "name": "cloudGatewayName", "in": "query", "schema": { "pattern": "^[\\w.-]{1,128}$", "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "bfdSessions": { "type": "integer", "format": "int32" }, "bfdSessionsUp": { "type": "integer", "format": "int32" }, "device-model": { "type": "string" }, "device-type": { "type": "string" }, "host-name": { "type": "string" }, "lastUpdated": { "type": "number" }, "local-system-ip": { "type": "string" }, "reachability": { "type": "string" }, "site-id": { "type": "string" }, "status": { "type": "string" }, "statusBfd": { "type": "string" }, "system-ip": { "type": "string" }, "uuid": { "type": "string" }, "version": { "type": "string" } }, "$$ref": "#/components/schemas/ConnectedSitesResponse" }, "examples": { "Connected Device list": { "description": "Connected Device list", "value": [ { "uuid": "C8K-CA0D4066-0011-5A4E-D2F9-0F5E77BE2091", "host-name": "gcp2", "system-ip": "6.6.2.2", "local-system-ip": "6.6.2.2", "site-id": "5", "device-model": "vedge-C8000V", "device-type": "vedge", "reachability": "reachable", "lastupdated": 1655169353069, "version": "17.06.02.0.2786", "bfdSessionsUp": 2, "bfdSessions": 4, "status": "normal", "statusBfd": "warning" }, { "uuid": "C8K-A24CE0EB-D7D4-6920-0129-F7BAB204252C", "host-name": "gcp1", "system-ip": "6.6.1.1", "local-system-ip": "6.6.1.1", "site-id": "5", "device-model": "vedge-C8000V", "device-type": "vedge", "reachability": "reachable", "lastupdated": 1655166680400, "version": "17.06.02.0.2786", "bfdSessionsUp": 2, "bfdSessions": 4, "status": "normal", "statusBfd": "warning" }, { "uuid": "C8K-D4821270-27FF-A1B0-B902-12A321E3A550", "host-name": "az1", "system-ip": "5.1.5.5", "local-system-ip": "5.1.5.5", "site-id": "5", "device-model": "vedge-C8000V", "device-type": "vedge", "reachability": "reachable", "lastupdated": 1655170239795, "version": "17.06.01a.0.298", "bfdSessionsUp": 2, "bfdSessions": 4, "status": "normal", "statusBfd": "warning" }, { "uuid": "C8K-2F69B355-2B3D-2801-EB48-F44789422299", "host-name": "az2", "system-ip": "5.6.6.6", "local-system-ip": "5.6.6.6", "site-id": "6", "device-model": "vedge-C8000V", "device-type": "vedge", "reachability": "reachable", "lastupdated": 1655170234517, "version": "17.06.01a.0.298", "bfdSessionsUp": 2, "bfdSessions": 4, "status": "normal", "statusBfd": "warning" } ] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/corenetworkpolicy": { "get": { "tags": [ "MultiCloud - General" ], "description": "Get AWS Cloudwan core network policy", "operationId": "getCwanCoreNetworkPolicy", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "changeSetState": { "type": "string", "example": "EXECUTION_SUCCEEDED" }, "coreNetworkId": { "type": "string", "example": "core-network-0008d82310d17b86b" }, "createdAt": { "type": "string", "example": "Dec.16, 2022 04:16 UTC" }, "description": { "type": "string", "example": "Core Network Policy" }, "policyAlias": { "type": "string", "example": "LIVE, LATEST" }, "policyData": { "type": "string", "example": "StringifiedJsonPolicyData" }, "policyVersionId": { "type": "number", "example": 19 } }, "$$ref": "#/components/schemas/CoreNetworkPolicyResponse" }, "examples": { "Core Network Policy Response": { "description": "Core Network Policy Response", "value": "{\n\"coreNetworkId\": \"core-network-0008d82310d17b86b\",\n\"policyVersionId\": 19, \n\"policyAlias\": \"LIVE, LATEST\",\n\"description\": \"Core Network Policy\",\n\"createdAt\": \"Dec.16, 2022 04:16 UTC\",\n\"changeSetState\": \"EXECUTION_SUCCEEDED\",\n\"policyData\": { \"version\": \"2021.12\" }\" \n}" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/device": { "get": { "tags": [ "MultiCloud - General" ], "description": "Get available WAN edge devices", "operationId": "getWanDevices", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "configuredHostName": { "type": "string", "example": "aws-test2" }, "configuredSystemIp": { "type": "string", "example": "9.1.1.2" }, "deviceModel": { "type": "string", "example": "vedge-C8000V" }, "isPaygUuid": { "type": "boolean", "example": false }, "uuid": { "type": "string", "example": "C8K-4B68E23F-B24F-EDE8-05DD-B36EAA14C9C1" } }, "$$ref": "#/components/schemas/WanEdgeDevicesResponse" }, "examples": { "List of available WAN devices": { "description": "List of available WAN devices", "value": [ { "configuredHostname": "aws-test2", "deviceModel": "vedge-C8000V", "uuid": "C8K-4B68E23F-B24F-EDE8-05DD-B36EAA14C9C1", "configuredSystemIP": "9.1.1.3", "isPaygUuid": false }, { "configuredHostname": "aws-test", "deviceModel": "vedge-C8000V", "uuid": "C8K-1FCEF03D-1091-497B-3BA1-7FD24C4CE957", "configuredSystemIP": "9.1.1.2", "isPaygUuid": false } ] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/devices/{cloudType}": { "get": { "tags": [ "MultiCloud - General" ], "description": "Get cloud devices by cloud type", "operationId": "getCloudDevices_MulticloudGeneral_3103", "parameters": [ { "name": "cloudType", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "AWS", "AWS_GOVCLOUD", "AZURE", "AZURE_GOVCLOUD", "GCP" ] } }, { "name": "cloudGatewayName", "in": "query", "schema": { "pattern": "^[\\w.-]{1,128}$", "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "cloudGatewayName": { "type": "string" }, "configStatusMessage": { "type": "string" }, "configuredSystemIP": { "type": "string" }, "device-model": { "type": "string" }, "device-type": { "type": "string" }, "host-name": { "type": "string" }, "lastUpdated": { "type": "number" }, "local-system-ip": { "type": "string" }, "reachability": { "type": "string" }, "site-id": { "type": "string" }, "status": { "type": "string" }, "system-ip": { "type": "string" }, "uptime-date": { "type": "number" }, "uuid": { "type": "string" }, "version": { "type": "string" } }, "$$ref": "#/components/schemas/DeviceInfoExtendedResponse" }, "examples": { "Device list for cloudType": { "description": "Device list for cloudType", "value": [ { "cloudGatewayName": "az-test", "uuid": "C8K-2F69B355-2B3D-2801-EB48-F44789422299", "host-name": "az2", "system-ip": "5.6.6.6", "local-system-ip": "5.6.6.6", "site-id": "6", "configuredSystemIP": "5.6.6.6", "device-model": "vedge-C8000V", "device-type": "vedge", "configStatusMessage": "Out of Sync", "reachability": "reachable", "version": "17.06.01a.0.298", "lastupdated": 1655168711688, "uptime-date": 1655165580000, "status": "normal" }, { "cloudGatewayName": "az-test", "uuid": "C8K-D4821270-27FF-A1B0-B902-12A321E3A550", "host-name": "az1", "system-ip": "5.1.5.5", "local-system-ip": "5.1.5.5", "site-id": "5", "configuredSystemIP": "5.1.5.5", "device-model": "vedge-C8000V", "device-type": "vedge", "configStatusMessage": "In Sync", "reachability": "reachable", "version": "17.06.01a.0.298", "lastupdated": 1655168712505, "uptime-date": 1655164800000, "status": "normal" } ] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/hostvpc": { "get": { "tags": [ "MultiCloud - Tagging" ], "description": "Get all Host VPCs", "operationId": "getHostVpcs", "parameters": [ { "name": "cloudType", "in": "query", "description": "Multicloud provider type", "required": true, "schema": { "type": "string" } }, { "name": "accountIds", "in": "query", "description": "Multicloud cloud gateway enabled", "schema": { "type": "string" } }, { "name": "region", "in": "query", "schema": { "maxLength": 1024, "minLength": 1, "pattern": "^[a-zA-Z0-9_./\\-]+$", "type": "string" } }, { "name": "untagged", "in": "query", "description": "Multicloud cloud gateway enabled", "schema": { "pattern": "^(true|false)$", "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "required": [ "accountId", "cloudType", "hostVpcId", "region", "vnetId" ], "type": "object", "properties": { "accountId": { "type": "string" }, "accountName": { "type": "string" }, "cloudTenantId": { "pattern": "^[a-zA-Z0-9_./\\-]+$", "type": "string", "description": "Used for Azure and Azure GovCloud cloud types" }, "cloudType": { "type": "string" }, "hostVpcId": { "pattern": "^[a-zA-Z0-9_./\\-]+$", "type": "string", "description": "Used for AWS, AWS GovCloud and GCP cloud types" }, "hostVpcName": { "pattern": "^[a-zA-Z0-9_/\\-]*$", "type": "string", "description": "Used for AWS, AWS GovCloud and GCP cloud types" }, "region": { "pattern": "^[a-zA-Z0-9_./\\-]+$", "type": "string" }, "resourceGroups": { "pattern": "^[a-zA-Z0-9_./\\-]+$", "type": "string", "description": "Used for Azure and Azure GovCloud cloud types" }, "vnetId": { "pattern": "^[a-zA-Z0-9_./\\-]+$", "type": "string", "description": "Used for Azure and Azure GovCloud cloud types" }, "vnetKey": { "pattern": "^[a-zA-Z0-9_./\\-]+$", "type": "string", "description": "Used for Azure and Azure GovCloud cloud types" }, "vpcName": { "pattern": "^[a-zA-Z0-9_/\\-]*$", "type": "string", "description": "Used for Azure and Azure GovCloud cloud types" } }, "$$ref": "#/components/schemas/HostVpcsResponse" } }, "examples": { "AWS VPCs": { "description": "AWS VPCs", "value": [ { "accountId": "999293417507", "accountName": "test-aws-account", "region": "us-west-2", "cloudType": "AWS", "hostVpcId": "vpc-0fd1fbce44f9db86b", "hostVpcName": "test-vpc-1" } ] }, "Azure VNETs": { "description": "Azure VNETs", "value": [ { "accountId": "9e222d34-9f20-4a2f-9c01-e507193dabb", "accountName": "test-azure-account", "region": "us-west-2", "cloudType": "AZURE", "vnetId": "/subscriptions/9e222d34-9f20-4a2f-9c01-e507193dabb4/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-vnet-1", "vnetKey": "9e222d34-9f20-4a2f-9c01-e507193dabb4/test-rg/test-vnet-1", "resourceGroups": "test-rg" } ] }, "GCP VPCs": { "description": "GCP VPCs", "value": [ { "accountId": "gcp-test-1234", "accountName": "test-gcp-account", "region": "us-west-3", "cloudType": "GCP", "hostVpcId": "8360972143511967399", "hostVpcName": "test-vpc-3" } ] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/hostvpc/tags": { "get": { "tags": [ "MultiCloud - Tagging" ], "description": "Get VPC Tags", "operationId": "getVpcTags", "parameters": [ { "name": "cloudType", "in": "query", "description": "Multicloud provider type", "schema": { "type": "string" } }, { "name": "region", "in": "query", "schema": { "maxLength": 1024, "minLength": 1, "pattern": "^[a-zA-Z0-9_./\\-]+$", "type": "string" } }, { "name": "tagName", "in": "query", "schema": { "maxLength": 1024, "minLength": 1, "pattern": "^[a-zA-Z0-9_./\\-]+$", "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "required": [ "accountId", "cloudType", "hostVpcId", "region", "vnetId" ], "type": "object", "properties": { "accountId": { "type": "string" }, "accountName": { "type": "string" }, "cloudTenantId": { "pattern": "^[a-zA-Z0-9_./\\-]+$", "type": "string", "description": "Used for Azure and Azure GovCloud cloud types" }, "cloudType": { "type": "string" }, "hostVpcId": { "pattern": "^[a-zA-Z0-9_./\\-]+$", "type": "string", "description": "Used for AWS, AWS GovCloud and GCP cloud types" }, "hostVpcName": { "pattern": "^[a-zA-Z0-9_/\\-]*$", "type": "string", "description": "Used for AWS, AWS GovCloud and GCP cloud types" }, "region": { "pattern": "^[a-zA-Z0-9_./\\-]+$", "type": "string" }, "resourceGroups": { "pattern": "^[a-zA-Z0-9_./\\-]+$", "type": "string", "description": "Used for Azure and Azure GovCloud cloud types" }, "tag": { "type": "string" }, "vnetId": { "pattern": "^[a-zA-Z0-9_./\\-]+$", "type": "string", "description": "Used for Azure and Azure GovCloud cloud types" }, "vnetKey": { "pattern": "^[a-zA-Z0-9_./\\-]+$", "type": "string", "description": "Used for Azure and Azure GovCloud cloud types" }, "vpcName": { "pattern": "^[a-zA-Z0-9_/\\-]*$", "type": "string", "description": "Used for Azure and Azure GovCloud cloud types" } }, "$$ref": "#/components/schemas/HostVpcTagResponse" } }, "examples": { "AWS VPC Tags": { "description": "AWS VPC Tags", "value": [ { "accountId": "999293417507", "accountName": "test-aws-account", "region": "us-west-2", "cloudType": "AWS", "hostVpcId": "vpc-0fd1fbce44f9db86b", "hostVpcName": "test-vpc-1", "tag": "test-tag" } ] }, "Azure VNET Tags": { "description": "Azure VNET Tags", "value": [ { "accountId": "9e222d34-9f20-4a2f-9c01-e507193dabb", "accountName": "test-azure-account", "region": "us-west-2", "cloudType": "AZURE", "vnetId": "/subscriptions/9e222d34-9f20-4a2f-9c01-e507193dabb4/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-vnet-1", "vnetKey": "9e222d34-9f20-4a2f-9c01-e507193dabb4/test-rg/test-vnet-1", "resourceGroups": "test-rg", "tag": "test-tag", "interconnectTag": "No" } ] }, "GCP VPC Tags": { "description": "GCP VPC Tags", "value": [ { "accountId": "gcp-test-1234", "accountName": "test-gcp-account", "region": "us-west-3", "cloudType": "GCP", "hostVpcId": "8360972143511967399", "hostVpcName": "test-vpc-3", "tag": "test-tag", "interconnectTag": "No" } ] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "MultiCloud - Tagging" ], "description": "Edit VPCs for a Tag", "operationId": "editTag", "requestBody": { "description": "Payload for updating VPCs for a Tag", "content": { "application/json": { "schema": { "type": "object", "properties": { "hostVpcs": { "type": "array", "description": "Used for AWS, AWS GovCloud and GCP cloud types", "items": { "required": [ "accountId", "cloudType", "hostVpcId", "region", "vnetId" ], "type": "object", "properties": { "accountId": { "type": "string" }, "accountName": { "type": "string" }, "cgwAttachment": { "pattern": "^[\\w.-]{1,128}$", "type": "string" }, "cgwAutoAttachmentFlag": { "type": "boolean" }, "cloudTenantId": { "pattern": "^[a-zA-Z0-9_./\\-]+$", "type": "string", "description": "Used for Azure and Azure GovCloud cloud types" }, "cloudType": { "type": "string" }, "hostVpcId": { "pattern": "^[a-zA-Z0-9_./\\-]+$", "type": "string", "description": "Used for AWS, AWS GovCloud and GCP cloud types" }, "hostVpcName": { "pattern": "^[a-zA-Z0-9_/\\-]*$", "type": "string", "description": "Used for AWS, AWS GovCloud and GCP cloud types" }, "id": { "pattern": "^[a-zA-Z0-9_./\\-]+$", "type": "string" }, "interconnectTag": { "pattern": "^(Yes|No)$", "type": "string" }, "label": { "pattern": "^[a-zA-Z0-9_./\\-]+$", "type": "string" }, "region": { "pattern": "^[a-zA-Z0-9_./\\-]+$", "type": "string" }, "resourceGroups": { "pattern": "^[a-zA-Z0-9_./\\-]+$", "type": "string", "description": "Used for Azure and Azure GovCloud cloud types" }, "tag": { "pattern": "^[a-zA-Z0-9_./\\-]+$", "type": "string" }, "vnetId": { "pattern": "^[a-zA-Z0-9_./\\-]+$", "type": "string", "description": "Used for Azure and Azure GovCloud cloud types" }, "vnetKey": { "pattern": "^[a-zA-Z0-9_./\\-]+$", "type": "string", "description": "Used for Azure and Azure GovCloud cloud types" }, "vpcName": { "pattern": "^[a-zA-Z0-9_/\\-]*$", "type": "string", "description": "Used for Azure and Azure GovCloud cloud types" } }, "description": "Used for AWS, AWS GovCloud and GCP cloud types", "$$ref": "#/components/schemas/AllOfhostVpcTagPutHostVpcsItems" } }, "interconnectTag": { "type": "boolean" }, "tagName": { "type": "string" }, "vnets": { "type": "array", "description": "Used for Azure and Azure GovCloud cloud types", "items": { "required": [ "accountId", "cloudType", "hostVpcId", "region", "vnetId" ], "type": "object", "properties": { "accountId": { "type": "string" }, "accountName": { "type": "string" }, "cgwAttachment": { "pattern": "^[\\w.-]{1,128}$", "type": "string" }, "cgwAutoAttachmentFlag": { "type": "boolean" }, "cloudTenantId": { "pattern": "^[a-zA-Z0-9_./\\-]+$", "type": "string", "description": "Used for Azure and Azure GovCloud cloud types" }, "cloudType": { "type": "string" }, "hostVpcId": { "pattern": "^[a-zA-Z0-9_./\\-]+$", "type": "string", "description": "Used for AWS, AWS GovCloud and GCP cloud types" }, "hostVpcName": { "pattern": "^[a-zA-Z0-9_/\\-]*$", "type": "string", "description": "Used for AWS, AWS GovCloud and GCP cloud types" }, "id": { "pattern": "^[a-zA-Z0-9_./\\-]+$", "type": "string" }, "interconnectTag": { "pattern": "^(Yes|No)$", "type": "string" }, "label": { "pattern": "^[a-zA-Z0-9_./\\-]+$", "type": "string" }, "region": { "pattern": "^[a-zA-Z0-9_./\\-]+$", "type": "string" }, "resourceGroups": { "pattern": "^[a-zA-Z0-9_./\\-]+$", "type": "string", "description": "Used for Azure and Azure GovCloud cloud types" }, "tag": { "pattern": "^[a-zA-Z0-9_./\\-]+$", "type": "string" }, "vnetId": { "pattern": "^[a-zA-Z0-9_./\\-]+$", "type": "string", "description": "Used for Azure and Azure GovCloud cloud types" }, "vnetKey": { "pattern": "^[a-zA-Z0-9_./\\-]+$", "type": "string", "description": "Used for Azure and Azure GovCloud cloud types" }, "vpcName": { "pattern": "^[a-zA-Z0-9_/\\-]*$", "type": "string", "description": "Used for Azure and Azure GovCloud cloud types" } }, "description": "Used for Azure and Azure GovCloud cloud types", "$$ref": "#/components/schemas/AllOfhostVpcTagPutVnetsItems" } } }, "$$ref": "#/components/schemas/HostVpcTagPut" }, "examples": { "Edit AWS Tag": { "description": "Edit AWS Tag", "value": { "tagName": "test-tag", "interconnectTag": false, "hostVpcs": [ { "accountId": "999293417507", "accountName": "test-aws-account", "region": "us-west-2", "cloudType": "AWS", "hostVpcId": "vpc-0fd1fbce44f9db86b", "hostVpcName": "test-vpc-1", "id": "vpc-0fd1fbce44f9db86b", "label": "vpc-0fd1fbce44f9db86b", "interconnectTag": "No" }, { "accountId": "999293417507", "accountName": "test-aws-account", "region": "us-west-2", "cloudType": "AWS", "hostVpcId": "vpc-089a6f8af08dacbf1", "hostVpcName": "test-vpc-2", "id": "vpc-089a6f8af08dacbf1", "label": "vpc-089a6f8af08dacbf1", "interconnectTag": "No" } ] } }, "Edit Azure Tag": { "description": "Edit Azure Tag", "value": { "tagName": "test-azure-tag", "interconnectTag": false, "vnets": [ { "accountId": "9e222d34-9f20-4a2f-9c01-e507193dabb", "accountName": "test-azure-account", "region": "us-west-2", "cloudType": "AZURE", "vnetId": "/subscriptions/9e222d34-9f20-4a2f-9c01-e507193dabb4/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-vnet-1", "vnetKey": "9e222d34-9f20-4a2f-9c01-e507193dabb4/test-rg/test-vnet-1", "vpcName": "test-vnet-1", "resourceGroups": "test-rg", "id": "/subscriptions/9e222d34-9f20-4a2f-9c01-e507193dabb4/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-vnet-1", "label": "9e222d34-9f20-4a2f-9c01-e507193dabb4/test-rg/test-vnet-1", "interconnectTag": "No", "tag": "test-azure-tag" }, { "accountId": "9e222d34-9f20-4a2f-9c01-e507193dabb", "accountName": "test-azure-account", "region": "us-west-2", "cloudType": "AZURE", "vnetId": "/subscriptions/9e222d34-9f20-4a2f-9c01-e507193dabb4/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-vnet-2", "vnetKey": "9e222d34-9f20-4a2f-9c01-e507193dabb4/test-rg/test-vnet-2", "vpcName": "test-vnet-2", "resourceGroups": "test-rg", "id": "/subscriptions/9e222d34-9f20-4a2f-9c01-e507193dabb4/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-vnet-2", "label": "9e222d34-9f20-4a2f-9c01-e507193dabb4/test-rg/test-vnet-2", "interconnectTag": "No", "tag": "test-azure-tag" } ] } }, "Edit GCP Tag": { "description": "Edit GCP Tag", "value": { "tagName": "test-gcp-tag", "interconnectTag": false, "hostVpcs": [ { "accountId": "gcp-test-1234", "accountName": "test-gcp-account", "region": "us-west-3", "cloudType": "GCP", "hostVpcId": "8360972143511967399", "hostVpcName": "test-vpc-3", "tag": "test-tag", "interconnectTag": "No", "id": "8360972143511967399", "label": "8360972143511967399" }, { "accountId": "gcp-test-1234", "accountName": "test-gcp-account", "region": "us-west-3", "cloudType": "GCP", "hostVpcId": "2261865283189378184", "hostVpcName": "test-vpc-4", "tag": "test-tag", "interconnectTag": "No", "id": "2261865283189378184", "label": "2261865283189378184" } ] } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "6c723f65-9106-4f43-9d2b-a033a39353b3" } }, "description": "Task id for polling status", "$$ref": "#/components/schemas/Taskid" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "MultiCloud - Tagging" ], "description": "Tag a VPC", "operationId": "hostVpcTagging", "requestBody": { "description": "Payload for tagging a VPC", "content": { "application/json": { "schema": { "type": "object", "properties": { "hostVpcs": { "type": "array", "description": "Used for AWS, AWS GovCloud and GCP cloud types", "items": { "required": [ "accountId", "cloudType", "hostVpcId", "region", "vnetId" ], "type": "object", "properties": { "accountId": { "type": "string" }, "accountName": { "type": "string" }, "cloudTenantId": { "pattern": "^[a-zA-Z0-9_./\\-]+$", "type": "string", "description": "Used for Azure and Azure GovCloud cloud types" }, "cloudType": { "type": "string" }, "hostVpcId": { "pattern": "^[a-zA-Z0-9_./\\-]+$", "type": "string", "description": "Used for AWS, AWS GovCloud and GCP cloud types" }, "hostVpcName": { "pattern": "^[a-zA-Z0-9_/\\-]*$", "type": "string", "description": "Used for AWS, AWS GovCloud and GCP cloud types" }, "id": { "pattern": "^[a-zA-Z0-9_./\\-]+$", "type": "string" }, "label": { "pattern": "^[a-zA-Z0-9_./\\-]+$", "type": "string" }, "region": { "pattern": "^[a-zA-Z0-9_./\\-]+$", "type": "string" }, "resourceGroups": { "pattern": "^[a-zA-Z0-9_./\\-]+$", "type": "string", "description": "Used for Azure and Azure GovCloud cloud types" }, "vnetId": { "pattern": "^[a-zA-Z0-9_./\\-]+$", "type": "string", "description": "Used for Azure and Azure GovCloud cloud types" }, "vnetKey": { "pattern": "^[a-zA-Z0-9_./\\-]+$", "type": "string", "description": "Used for Azure and Azure GovCloud cloud types" }, "vpcName": { "pattern": "^[a-zA-Z0-9_/\\-]*$", "type": "string", "description": "Used for Azure and Azure GovCloud cloud types" } }, "description": "Used for AWS, AWS GovCloud and GCP cloud types", "$$ref": "#/components/schemas/AllOfhostVpcTagPostHostVpcsItems" } }, "interconnectTag": { "type": "boolean" }, "tagName": { "type": "string" }, "vnets": { "type": "array", "description": "Used for Azure and Azure GovCloud cloud types", "items": { "required": [ "accountId", "cloudType", "hostVpcId", "region", "vnetId" ], "type": "object", "properties": { "accountId": { "type": "string" }, "accountName": { "type": "string" }, "cgwAttachment": { "pattern": "^[\\w.-]{1,128}$", "type": "string" }, "cgwAutoAttachmentFlag": { "type": "boolean" }, "cloudTenantId": { "pattern": "^[a-zA-Z0-9_./\\-]+$", "type": "string", "description": "Used for Azure and Azure GovCloud cloud types" }, "cloudType": { "type": "string" }, "hostVpcId": { "pattern": "^[a-zA-Z0-9_./\\-]+$", "type": "string", "description": "Used for AWS, AWS GovCloud and GCP cloud types" }, "hostVpcName": { "pattern": "^[a-zA-Z0-9_/\\-]*$", "type": "string", "description": "Used for AWS, AWS GovCloud and GCP cloud types" }, "id": { "pattern": "^[a-zA-Z0-9_./\\-]+$", "type": "string" }, "label": { "pattern": "^[a-zA-Z0-9_./\\-]+$", "type": "string" }, "region": { "pattern": "^[a-zA-Z0-9_./\\-]+$", "type": "string" }, "resourceGroups": { "pattern": "^[a-zA-Z0-9_./\\-]+$", "type": "string", "description": "Used for Azure and Azure GovCloud cloud types" }, "vnetId": { "pattern": "^[a-zA-Z0-9_./\\-]+$", "type": "string", "description": "Used for Azure and Azure GovCloud cloud types" }, "vnetKey": { "pattern": "^[a-zA-Z0-9_./\\-]+$", "type": "string", "description": "Used for Azure and Azure GovCloud cloud types" }, "vpcName": { "pattern": "^[a-zA-Z0-9_/\\-]*$", "type": "string", "description": "Used for Azure and Azure GovCloud cloud types" } }, "description": "Used for Azure and Azure GovCloud cloud types", "$$ref": "#/components/schemas/AllOfhostVpcTagPostVnetsItems" } } }, "$$ref": "#/components/schemas/HostVpcTagPost" }, "examples": { "Tag an AWS VPC": { "description": "Tag an AWS VPC", "value": { "tagName": "test-tag", "interconnectTag": false, "hostVpcs": [ { "accountId": "999293417507", "accountName": "test-aws-account", "region": "us-west-2", "cloudType": "AWS", "hostVpcId": "vpc-0fd1fbce44f9db86b", "hostVpcName": "test-vpc-1", "id": "vpc-0fd1fbce44f9db86b", "label": "vpc-0fd1fbce44f9db86b" } ] } }, "Tag an Azure VNET": { "description": "Tag an Azure VNET", "value": { "tagName": "test-azure-tag", "interconnectTag": false, "vnets": [ { "accountId": "9e222d34-9f20-4a2f-9c01-e507193dabb", "accountName": "test-azure-account", "region": "us-west-2", "cloudType": "AZURE", "vnetId": "/subscriptions/9e222d34-9f20-4a2f-9c01-e507193dabb4/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-vnet-1", "vnetKey": "9e222d34-9f20-4a2f-9c01-e507193dabb4/test-rg/test-vnet-1", "vpcName": "test-vnet-1", "resourceGroups": "test-rg", "id": "/subscriptions/9e222d34-9f20-4a2f-9c01-e507193dabb4/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-vnet-1", "label": "9e222d34-9f20-4a2f-9c01-e507193dabb4/test-rg/test-vnet-1" } ] } }, "Tag a GCP VPC": { "description": "Tag a GCP VPC", "value": { "tagName": "test-gcp-tag", "interconnectTag": false, "hostVpcs": [ { "accountId": "gcp-test-1234", "accountName": "test-gcp-account", "region": "us-west-3", "cloudType": "GCP", "hostVpcId": "8360972143511967399", "hostVpcName": "test-vpc-3", "tag": "test-tag", "interconnectTag": "No", "id": "8360972143511967399", "label": "8360972143511967399" } ] } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "6c723f65-9106-4f43-9d2b-a033a39353b3" } }, "description": "Task id for polling status", "$$ref": "#/components/schemas/Taskid" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/hostvpc/tags/rebalanceVnets": { "post": { "tags": [ "MultiCloud - Tagging" ], "description": "Tag a VPC", "operationId": "rebalanceVnets", "parameters": [ { "name": "cloudType", "in": "query", "description": "Multicloud provider type", "required": true, "schema": { "type": "string" } }, { "name": "region", "in": "query", "required": true, "schema": { "maxLength": 1024, "minLength": 1, "pattern": "^[a-zA-Z0-9_./\\-]+$", "type": "string" } }, { "name": "tagName", "in": "query", "required": true, "schema": { "maxLength": 1024, "minLength": 1, "pattern": "^[a-zA-Z0-9_./\\-]+$", "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "6c723f65-9106-4f43-9d2b-a033a39353b3" } }, "description": "Task id for polling status", "$$ref": "#/components/schemas/Taskid" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/hostvpc/tags/{tagName}": { "delete": { "tags": [ "MultiCloud - Tagging" ], "description": "Delete a Tag", "operationId": "unTag", "parameters": [ { "name": "tagName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "6c723f65-9106-4f43-9d2b-a033a39353b3" } }, "description": "Task id for polling status", "$$ref": "#/components/schemas/Taskid" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/instancesize": { "get": { "tags": [ "MultiCloud - Global Settings" ], "description": "Get Transit VPC supported size", "operationId": "getSupportedInstanceSize", "parameters": [ { "name": "cloudType", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "AWS", "AWS_GOVCLOUD", "AZURE", "AZURE_GOVCLOUD", "GCP" ] } }, { "name": "accountId", "in": "query", "schema": { "type": "string" } }, { "name": "cloudRegion", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "size": { "type": "string", "example": "n1-standard-4" }, "spec": { "type": "string", "example": "n1-standard-4 (4 vCPU)" } }, "$$ref": "#/components/schemas/InstanceSizeResponse" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/interfacecolor": { "get": { "tags": [ "MultiCloud - BranchConnect" ], "description": "Get WAN interface colors", "operationId": "getWanInterfaceColors", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "array", "properties": { "empty": { "type": "boolean" } }, "items": { "type": "string" }, "$$ref": "#/components/schemas/InterfaceColorResponse" } }, "examples": { "Interface Colors": { "description": "Interface Colors", "value": [ "default", "red", "green" ] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/map": { "post": { "tags": [ "MultiCloud - Mapping" ], "description": "Enable Mapping for cloudType", "operationId": "processMapping", "requestBody": { "description": "Payloads for enable mapping", "content": { "application/json": { "schema": { "required": [ "cloudType" ], "type": "object", "properties": { "cloudType": { "pattern": "^[a-zA-Z_]+$", "type": "string" }, "connMatrix": { "maxItems": 2147483647, "minItems": 1, "type": "array", "items": { "required": [ "conn", "destId", "destType", "srcId", "srcType" ], "type": "object", "properties": { "conn": { "type": "string" }, "destId": { "type": "string" }, "destType": { "type": "string" }, "mapped": { "type": "array", "items": { "type": "object", "properties": { "cgwAttachment": { "type": "string" }, "cloudType": { "type": "string" }, "destId": { "type": "string" }, "destRegion": { "type": "string" }, "destTag": { "type": "string" }, "destType": { "type": "string" }, "region": { "type": "string" }, "sourceRegion": { "type": "string" }, "sourceTag": { "type": "string" }, "srcId": { "type": "string" }, "srcType": { "type": "string" }, "tunnelId": { "type": "string" } }, "$$ref": "#/components/schemas/PostMapRequestMapped" } }, "outstandingMapping": { "type": "array", "items": { "type": "object", "properties": { "cgwAttachment": { "type": "string" }, "cloudType": { "type": "string" }, "destId": { "type": "string" }, "destRegion": { "type": "string" }, "destTag": { "type": "string" }, "destType": { "type": "string" }, "region": { "type": "string" }, "sourceRegion": { "type": "string" }, "sourceTag": { "type": "string" }, "srcId": { "type": "string" }, "srcType": { "type": "string" }, "tunnelId": { "type": "string" } }, "$$ref": "#/components/schemas/PostMapRequestMapped" } }, "srcId": { "type": "string" }, "srcType": { "type": "string" }, "tgwRouteTableId": { "type": "string" }, "unmapped": { "type": "array", "items": { "type": "object", "properties": { "cgwAttachment": { "type": "string" }, "cloudType": { "type": "string" }, "destId": { "type": "string" }, "destRegion": { "type": "string" }, "destTag": { "type": "string" }, "destType": { "type": "string" }, "region": { "type": "string" }, "sourceRegion": { "type": "string" }, "sourceTag": { "type": "string" }, "srcId": { "type": "string" }, "srcType": { "type": "string" }, "tunnelId": { "type": "string" } }, "$$ref": "#/components/schemas/PostMapRequestMapped" } } }, "$$ref": "#/components/schemas/PostMapRequestConnMatrix" } } }, "$$ref": "#/components/schemas/PostMapRequest" }, "examples": { "Post Map": { "description": "Post Map", "value": { "cloudType": "GCP", "connMatrix": [ { "conn": "enabled", "destId": "tag1", "destType": "tag", "srcId": "100", "srcType": "vpn" }, { "conn": "enabled", "destId": "vpn", "destType": "tag", "srcId": "100", "srcType": "tag" } ] } }, "Post UnMap": { "description": "Post UnMap", "value": { "cloudType": "GCP", "connMatrix": [ { "conn": "disabled", "destId": "tag1", "destType": "tag", "mapped": [], "outstandingMapping": [], "srcId": "100", "srcType": "vpn", "unmapped": [ { "cloudType": "GCP", "destId": "3889358374498280098", "destRegion": "global", "destTag": "tag1", "destType": "vpc", "sourceRegion": "us-west1", "srcId": "100", "srcType": "vpn", "tunnelId": "C8K-011df81d-760e-47e2-b930-cc8eaaff773d::100" }, { "cloudType": "GCP", "destId": "3889358374498280098", "destRegion": "global", "destTag": "tag1", "destType": "vpc", "sourceRegion": "us-west1", "srcId": "100", "srcType": "vpn", "tunnelId": "C8K-6c832624-b47c-491e-bd95-b5b4b86981ec::100" } ] }, { "conn": "disabled", "destId": "100", "destType": "vpn", "srcId": "tag1", "srcType": "tag" } ] } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "6c723f65-9106-4f43-9d2b-a033a39353b3" } }, "description": "Task id for polling status", "$$ref": "#/components/schemas/Taskid" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "MultiCloud - Mapping" ], "description": "Get Mapping details for cloudType", "operationId": "getMappingMatrix", "parameters": [ { "name": "cloudType", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "AWS", "AWS_GOVCLOUD", "AZURE", "AZURE_GOVCLOUD", "GCP" ] } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "conn": { "type": "string" }, "destId": { "type": "string" }, "destType": { "type": "string" }, "srcId": { "type": "string" }, "srcType": { "type": "string" }, "tgwRouteTableId": { "type": "string" } }, "$$ref": "#/components/schemas/GetMapResponse" } }, "examples": { "Get map Response": { "description": "Get map Response", "value": [ { "srcType": "vpn", "srcId": "140", "destType": "tag", "destId": "A14-sf-oregon-test-50", "conn": "enabled" }, { "srcType": "tag", "srcId": "140", "destType": "vpn", "destId": "A14-sf-oregon-test-50", "conn": "enabled" } ] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/map/defaults": { "get": { "tags": [ "MultiCloud - Mapping" ], "description": "Get default mapping values", "operationId": "getDefaultMappingValues", "parameters": [ { "name": "cloudType", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "AWS", "AWS_GOVCLOUD", "AZURE", "AZURE_GOVCLOUD", "GCP" ] } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "conn": { "type": "string", "example": "enabled" }, "connType": { "type": "string", "example": "Intra" }, "destType": { "type": "string", "example": "vpn" }, "editable": { "type": "boolean", "example": false }, "srcType": { "type": "string", "example": "vpn" } }, "$$ref": "#/components/schemas/MapDefaults" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/map/status": { "get": { "tags": [ "MultiCloud - Mapping" ], "description": "Get mapping status", "operationId": "getMappingStatus", "parameters": [ { "name": "cloudType", "in": "query", "description": "Multicloud provider type", "required": true, "schema": { "type": "string" } }, { "name": "region", "in": "query", "schema": { "maxLength": 1024, "minLength": 1, "pattern": "^[a-zA-Z0-9_./\\-]+$", "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "destId": { "type": "string" }, "destType": { "type": "string" }, "mapped": { "type": "array", "items": { "type": "object", "properties": { "cloudType": { "type": "string" }, "destId": { "type": "string" }, "destRegion": { "type": "string" }, "destType": { "type": "string" }, "sourceRegion": { "type": "string" }, "sourceTag": { "type": "string" }, "srcId": { "type": "string" }, "srcType": { "type": "string" }, "tgwRouteTableId": { "type": "string" }, "tunnelId": { "type": "string" } }, "$$ref": "#/components/schemas/MapStatusMapped" } }, "outstandingMapping": { "type": "string" }, "srcId": { "type": "string" }, "srcType": { "type": "string" }, "tgwRouteTableId": { "type": "string" }, "unmapped": { "type": "string" } }, "$$ref": "#/components/schemas/MapStatus" } }, "examples": { "Get Map Status": { "description": "Get Map Status", "value": { "srcType": "tag", "srcId": "tag1", "destType": "vpn", "destId": "100", "mapped": [ { "srcType": "vpc", "srcId": "4382130894513720959", "destType": "vpn", "destId": "100", "tunnelId": "C8K-5DE8FBB3-B624-1929-22C0-0C55E7DD6858::100", "destRegion": "us-west3", "sourceTag": "tag2", "sourceRegion": "global", "cloudType": "GCP" }, { "srcType": "vpc", "srcId": "4382120894513720959", "destType": "vpn", "destId": "100", "tunnelId": "C8K-8FBB3-B624-1929-22C0-0C55E7DD6858::100", "destRegion": "us-west3", "sourceTag": "tag2", "sourceRegion": "global", "cloudType": "GCP" }, { "srcType": "cgw", "srcId": "tgw-0433b98d56b802ff6", "destType": "vpn", "destId": "100", "tunnelId": "C8K-8FBB3-B624-1929-22C0-0C55E7DD6858::100", "destRegion": "us-west3", "sourceTag": "", "sourceRegion": "global", "cloudType": "AWS" } ], "outstandingMapping": [], "unmapped": [] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/map/summary": { "get": { "tags": [ "MultiCloud - Mapping" ], "description": "Get mapping summary", "operationId": "getMappingSummary", "parameters": [ { "name": "cloudType", "in": "query", "schema": { "type": "string", "enum": [ "AWS", "AWS_GOVCLOUD", "AZURE", "AZURE_GOVCLOUD", "GCP" ] } }, { "name": "vpnTunnelStatus", "in": "query", "schema": { "pattern": "^(true|false)$", "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "Account ID": { "type": "object", "properties": { "Site To Cloud NCC Hub Name": { "type": "string" }, "Site To Cloud NCC Spoke Name": { "type": "string" }, "Site To Cloud Primary GCR Name": { "type": "string" }, "Site To Cloud VPC ID": { "type": "string" }, "Site To Cloud VPC Name": { "type": "string" }, "Site To Site NCC Hub Name": { "type": "string" }, "Site To Site VPC ID": { "type": "string" }, "Site To Site VPC Name": { "type": "string" }, "WAN VPC ID": { "type": "string" }, "WAN VPC Name": { "type": "string" } }, "$$ref": "#/components/schemas/MapSummaryAccountID" }, "Azure Virtual WAN Hub ID": { "type": "string" }, "accountName": { "type": "string" }, "additionalDetails": { "type": "string" }, "cloudGatewayName": { "type": "string" }, "cloudGatewaySolution": { "type": "string" }, "cloudProviderMgmtReference": { "type": "string" }, "cloudType": { "type": "string" }, "connectedSites": { "type": "integer", "format": "int32" }, "connectivityState": { "type": "string" }, "connectivityStateUpdateTs": { "type": "string" }, "devices": { "type": "array", "items": { "type": "object", "properties": { "reachability": { "type": "string" }, "systemIp": { "type": "string" }, "uuid": { "type": "string" } }, "$$ref": "#/components/schemas/MapSummaryDevices" } }, "hostVpcs": { "type": "object", "properties": { "accountId": { "type": "string" }, "hostVpcId": { "type": "string" }, "tag": { "type": "string" } }, "$$ref": "#/components/schemas/MapSummaryHostVpcs" }, "operState": { "type": "string" }, "region": { "type": "string" }, "status": { "type": "string" }, "tags": { "type": "object", "properties": { "tag": { "type": "string" } }, "$$ref": "#/components/schemas/MapSummaryTags" }, "tgwRouteTableId": { "type": "string" }, "tunnels": { "type": "array", "items": { "type": "object", "properties": { "acceptedRouteCount": { "type": "integer", "format": "int32" }, "lastStatusChangeTimestamp": { "type": "string" }, "outerIpAddr": { "type": "string" }, "status": { "type": "string" }, "statusMessage": { "type": "string" }, "tunnelId": { "type": "string" } }, "$$ref": "#/components/schemas/MapSummaryTunnels" } }, "vpns": { "type": "object", "properties": { "vpnId": { "type": "string" } }, "$$ref": "#/components/schemas/MapSummaryVpns" } }, "$$ref": "#/components/schemas/MapSummary" } }, "examples": { "Get GCP Map Summary": { "description": "Get GCP Map Summary", "value": { "region": "us-west2", "accountName": "pp-acc", "cloudType": "GCP", "cloudGatewayName": "cgw1-gcp", "cloudGatewaySolution": "gcp", "cloudProviderMgmtReference": "NA", "connectivityState": "Successful", "connectivityStateUpdateTs": "1660614410162", "additionalDetails": [ { "Account ID": "gcp-abc-10202" }, { "WAN VPC Name": "wan-209overlayfi" }, { "Site To Cloud VPC Name": "s2c-209overlayfi" }, { "Site To Site VPC Name": "s2s-209overlayfi" }, { "WAN VPC ID": "5949753400137042430" }, { "Site To Cloud VPC ID": "4899470889371257287" }, { "Site To Site VPC ID": "3797334272073222570" }, { "Site To Cloud Primary GCR Name": "s2c-cr-cgw1-gcp-209overlayfi-0" }, { "Site To Cloud NCC Spoke Name": "cgw1-gcp-209overlayfi-s2c-spoke" }, { "Site To Cloud NCC Hub Name": "s2c-hub-209overlayfi" }, { "Site To Site NCC Hub Name": "s2s-hub-209overlayfi" } ], "devices": [ { "uuid": "C8K-5DE8FBB3-B624-1929-22C0-0C55E7DD6858", "systemIp": "101.1.1.9", "reachability": "reachable" }, { "uuid": "C8K-4ABB877C-519B-5186-B271-5698961952F4", "systemIp": "101.1.1.7", "reachability": "reachable" }, { "uuid": "C8K-495C4EB7-0813-01F2-06E1-2BFBE1C15965", "systemIp": "101.1.1.6", "reachability": "reachable" } ], "status": "normal,", "connectedSites": "1,", "vpns": [ { "vpnId": "100" } ], "tunnels": [ { "tunnelId": "C8K-5DE8FBB3-B624-1929-22C0-0C55E7DD6858::100", "status": "UP", "statusMessage": "", "outerIpAddr": "10.0.0.42", "acceptedRouteCount": 0, "lastStatusChangeTimestamp": "NotAvailable" }, { "tunnelId": "C8K-4ABB877C-519B-5186-B271-5698961952F4::100", "status": "UP", "statusMessage": "", "outerIpAddr": "10.0.0.40", "acceptedRouteCount": 0, "lastStatusChangeTimestamp": "NotAvailable" } ], "tags": [ { "tag": "tag1" } ], "hostVpcs": [ { "hostVpcId": "4382130894513720959", "accountId": "gcp-pp-nprd-10202", "tag": "tag1" }, { "hostVpcId": "5752708641463555655", "accountId": "gcp-pp-nprd-10202", "tag": "tag1" } ], "operState": "" } }, "Get AWS Map Summary": { "description": "Get AWS Map Summary", "value": { "region": "us-west-1", "accountName": "sdwan-pp", "cloudType": "AWS", "cloudGatewayName": "awstest", "cloudGatewaySolution": "tgw_tvpc", "cloudProviderMgmtReference": "arn:aws:networkma380167:global-network", "connectivityState": "Successful", "connectivityStateUpdateTs": "1661542265017", "additionalDetails": [ { "Account ID": "845888380167" }, { "Transit Gateway ID": "tgw-0dd6167696ff9" }, { "TGW Route Table Count": "2" }, { "Transit VPC ID": "vpc-09f7ce0e792d78e73" }, { "Transit VPC Name": "awscgwtest" } ], "devices": [ { "uuid": "C8K-09f782-bc71-4f91-9673-cfeea2f8f235", "systemIp": "203.1.1.1", "reachability": "reachable" } ], "status": "normal", "connectedSites": 1, "vpns": [ { "vpnId": "100" } ], "tunnels": [ { "tunnelId": "C8K-09f76182-bc71-4f91-9673-cfeea2f8f235::100", "tunnelInnerIps": [ "169.254.0.76/30", "169.254.0.80/30" ], "status": "DOWN", "statusMessage": "IPSEC IS DOWN", "outerIpAddr": "52.53.91.70", "acceptedRouteCount": 0, "lastStatusChangeTimestamp": "1660986000" } ], "tags": [ { "tag": "tagtest" } ], "hostVpcs": [ { "hostVpcId": "vpc-0445ecc99eecdf", "accountId": "845888380167", "tag": "tagtest" } ], "operState": "" } }, "Get Azure Map Summary": { "description": "Get Azure Map Summary", "value": { "region": "westcentralus", "accountName": "pp-azure", "cloudType": "AZURE", "cloudGatewayName": "AzureCGW", "connectivityState": "Successful", "connectivityStateUpdateTs": "16606410162", "additionalDetails": [ { "Account ID": "aws-pp-nprd-10202" }, { "WAN VPC Name": "wan-209overlayfi" }, { "Site To Cloud VPC Name": "s2c-209overlayfi" }, { "Site To Site VPC Name": "s2s-209overlayfi" }, { "WAN VPC ID": "5949753400137042430" }, { "Site To Cloud VPC ID": "4899470889371257287" }, { "Site To Site VPC ID": "3797334272073222570" }, { "Site To Cloud Primary GCR Name": "s2c-cr-cgw1-gcp-209overlayfi-0" }, { "Site To Cloud NCC Spoke Name": "cgw1-gcp-209overlayfi-s2c-spoke" }, { "Site To Cloud NCC Hub Name": "s2c-hub-209overlayfi" }, { "Site To Site NCC Hub Name": "s2s-hub-209overlayfi" } ], "devices": [ { "uuid": "C8K-5DE8FBB3-B624-1929-22C0-0C55E7DD6858", "systemIp": "101.1.1.9", "reachability": "reachable" }, { "status": "normal" }, { "connectedSites": 1 } ], "vpns": [ { "vpnId": "100" } ], "tunnels": [ { "tunnelId": "C8K-5DE8FBB3-B624-1929-22C0-0C55E7DD6858::100", "status": "UP", "statusMessage": "", "outerIpAddr": "10.0.0.42", "acceptedRouteCount": 0, "lastStatusChangeTimestamp": "NotAvailable" } ], "tags": [ { "tag": "tag1" } ], "hostVpcs": [ { "hostVpcId": "4382130894513720959", "accountId": "gcp-shabshargcp-nprd-10202", "tag": "tag1" } ], "operState": "" } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/map/tags": { "get": { "tags": [ "MultiCloud - Mapping" ], "description": "Get cloud gateway types for specified cloudType", "operationId": "getMappingTags", "parameters": [ { "name": "cloudType", "in": "query", "schema": { "type": "string", "enum": [ "AWS", "AWS_GOVCLOUD", "AZURE", "AZURE_GOVCLOUD", "GCP" ] } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "tag": { "type": "string", "example": "test-tag" } }, "$$ref": "#/components/schemas/TagsResponse" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/map/vpns": { "get": { "tags": [ "MultiCloud - Mapping" ], "description": "Get default mapping values", "operationId": "getMappingVpns", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "a0b3f15d-a4e6-4e1d-86f9-8936284dbe1b" }, "referenceCount": { "type": "integer", "format": "int32", "example": 0 }, "segmentId": { "type": "string", "example": "10" }, "segmentName": { "type": "string", "example": "vpn10" }, "solution": { "type": "string", "example": "sd-routing" } }, "description": "List of vpns for MultiCloud", "$$ref": "#/components/schemas/MapVpnsResponse" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/mapping/{cloudType}": { "get": { "tags": [ "MultiCloud - Mapping" ], "description": "Get associated mappings to the CGW", "operationId": "getCgwAssociatedMappings", "parameters": [ { "name": "cloudType", "in": "path", "description": "Multicloud provider type", "required": true, "schema": { "type": "string" } }, { "name": "cloudGatewayName", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "siteUuid", "in": "query", "schema": { "pattern": "^[a-zA-Z0-9\\-]*$", "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "accountName": { "type": "string", "example": "awsTest" }, "hostVpcId": { "type": "string", "example": "vpc-0638351a9efaf77e9" }, "hostVpcName": { "type": "string", "description": "Returned for AWS/AWS_GOVCLOUD/GCP", "example": "vpc-0638351a9efaf77e9" }, "tag": { "type": "string", "example": "test-tag-aws" }, "tunnelCount": { "type": "integer", "description": "Returned for AWS/AWS_GOVCLOUD/GCP", "format": "int32", "example": 6 }, "vpnId": { "type": "string", "example": "10" } }, "$$ref": "#/components/schemas/CgwVpnsResponse" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/pushCgwConfig": { "post": { "tags": [ "MultiCloud - CloudGateway" ], "description": "Push configuration to devices of CGW", "operationId": "pushCgwCfg", "requestBody": { "description": "Push configuration to devices of CGW", "content": { "application/json": { "schema": { "required": [ "cloudGatewayName", "cloudType" ], "type": "object", "properties": { "cloudGatewayName": { "pattern": "^[\\w.-]{1,128}$", "type": "string", "example": "cgw-test" }, "cloudType": { "pattern": "^[a-zA-Z_]+$", "type": "string", "example": "GCP" } }, "$$ref": "#/components/schemas/PushCgwConfig" }, "examples": { "Push Cgw Config to devices": { "description": "Push Cgw Config to devices", "value": { "cloudGatewayName": "cgw-test", "cloudType": "GCP" } }, "Post UnMap": { "description": "Post UnMap", "value": { "cloudType": "GCP", "connMatrix": [ { "conn": "disabled", "destId": "tag1", "destType": "tag", "mapped": [], "outstandingMapping": [], "srcId": "100", "srcType": "vpn", "unmapped": [ { "cloudType": "GCP", "destId": "3889358374498280098", "destRegion": "global", "destTag": "tag1", "destType": "vpc", "sourceRegion": "us-west1", "srcId": "100", "srcType": "vpn", "tunnelId": "C8K-011df81d-760e-47e2-b930-cc8eaaff773d::100" }, { "cloudType": "GCP", "destId": "3889358374498280098", "destRegion": "global", "destTag": "tag1", "destType": "vpc", "sourceRegion": "us-west1", "srcId": "100", "srcType": "vpn", "tunnelId": "C8K-6c832624-b47c-491e-bd95-b5b4b86981ec::100" } ] }, { "conn": "disabled", "destId": "100", "destType": "vpn", "srcId": "tag1", "srcType": "tag" } ] } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "6c723f65-9106-4f43-9d2b-a033a39353b3" } }, "description": "Task id for polling status", "$$ref": "#/components/schemas/Taskid" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/regions": { "get": { "tags": [ "MultiCloud - General" ], "description": "Obtain all supported Cloud Service Provider (CSP) types", "operationId": "getCloudRegions", "parameters": [ { "name": "cloudType", "in": "query", "schema": { "type": "string", "enum": [ "AWS", "AWS_GOVCLOUD", "AZURE", "AZURE_GOVCLOUD", "GCP" ] } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "cloudType": { "type": "string" }, "regionList": { "type": "string" } }, "$$ref": "#/components/schemas/GetRegions" } }, "examples": { "GCP Regions": { "description": "GCP Regions", "value": [ { "cloudType": "GCP", "regionList": { "value": [ "asia-east1", "asia-east2", "asia-northeast1", "asia-northeast2", "asia-northeast3", "asia-south1", "asia-south2", "asia-southeast1", "asia-southeast2", "australia-southeast1", "australia-southeast2", "europe-central2", "europe-north1", "europe-southwest1", "europe-west1", "europe-west2", "europe-west3", "europe-west4", "europe-west6", "europe-west8", "europe-west9", "northamerica-northeast1", "northamerica-northeast2", "southamerica-east1", "southamerica-west1", "us-central1", "us-east1", "us-east4", "us-east5", "us-west1", "us-west2", "us-west3", "us-west4" ] } } ] }, "Aws Regions": { "description": "Aws Regions", "value": [ { "cloudType": "AWS", "regionList": { "value": [ "af-south-1", "eu-north-1", "ap-south-1", "eu-west-3", "eu-west-2", "eu-south-1", "eu-west-1", "ap-northeast-3", "ap-northeast-2", "me-south-1", "ap-northeast-1", "sa-east-1", "ca-central-1", "ap-east-1", "ap-southeast-1", "ap-southeast-2", "eu-central-1", "ap-southeast-3", "us-east-1", "us-east-2", "us-west-1", "us-west-2" ] } } ] }, "Aws GovCloud Regions": { "description": "Aws GovCloud Regions", "value": [ { "cloudType": "AWS_GOVCLOUD", "regionList": { "value": [ "us-gov-west-1", "us-gov-east-1" ] } } ] }, "Azure Regions": { "description": "Azure Regions", "value": [ { "cloudType": "AZURE", "regionList": { "value": [ "eastus", "eastus2", "southcentralus", "westus2", "westus3", "australiaeast", "southeastasia", "northeurope", "swedencentral", "uksouth", "westeurope", "centralus", "southafricanorth", "centralindia", "eastasia", "japaneast", "koreacentral", "canadacentral", "francecentral", "germanywestcentral", "norwayeast", "switzerlandnorth", "brazilsouth", "eastus2euap", "centralusstage", "eastusstage", "eastus2stage", "northcentralusstage", "southcentralusstage", "westusstage", "westus2stage", "asia", "asiapacific", "australia", "brazil", "canada", "europe", "france", "germany", "global", "india", "japan", "korea", "norway", "southafrica", "switzerland", "uae", "uk", "unitedstates", "unitedstateseuap", "eastasiastage", "southeastasiastage", "northcentralus", "westus", "jioindiawest", "uaenorth", "centraluseuap", "westcentralus", "southafricawest", "australiacentral", "australiacentral2", "australiasoutheast", "japanwest", "jioindiacentral", "koreasouth", "southindia", "westindia", "canadaeast", "francesouth", "germanynorth", "norwaywest", "switzerlandwest", "ukwest", "uaecentral", "brazilsoutheast" ] } } ] }, "Azure GovCloud Regions": { "description": "Azure GovCloud Regions", "value": [ { "cloudType": "AZURE_GOVCLOUD", "regionList": { "value": [ "usgovvirginia", "global", "usgovarizona", "usdodcentral", "usdodeast", "usgoviowa", "usgovtexas" ] } } ] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/settings/global": { "get": { "tags": [ "MultiCloud - Global Settings" ], "description": "Get global settings", "operationId": "getGlobalSettings", "parameters": [ { "name": "cloudType", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "AWS", "AWS_GOVCLOUD", "AZURE", "AZURE_GOVCLOUD", "GCP" ] } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "required": [ "cgwBgpAsnOffset", "cloudGatewaySolution", "cloudType", "instanceSize", "ipSubnetPool", "orgBgpAsn", "skuScaleUnit", "softwareImageId" ], "type": "object", "properties": { "accountId": { "type": "string", "description": "Used for AWS/AWS GovCloud Global settings" }, "cgwBgpAsnOffset": { "pattern": "^[0-9]+$", "type": "string", "description": "Used for GCP, AWS and AWS GovCloud Global settings" }, "cloudGatewaySolution": { "pattern": "^[a-zA-Z_]+$", "type": "string" }, "cloudType": { "type": "string" }, "enableAutoCorrect": { "pattern": "^(true|false)$", "type": "string" }, "enableDefRouteAdvertize": { "pattern": "^(true|false)$", "type": "string", "description": "Used for Azure Global settings" }, "enableMonitoring": { "pattern": "^(true|false)$", "type": "string", "description": "Used for Azure Global settings" }, "enablePeriodicAudit": { "pattern": "^(true|false)$", "type": "string" }, "instanceSize": { "pattern": "^[a-zA-Z0-9_./\\-]+$", "type": "string", "description": "Used for GCP, AWS and AWS GovCloud Global settings" }, "intraTagComm": { "pattern": "^(true|false)$", "type": "string" }, "ipSubnetPool": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(?:\\.(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3}\\/(?:3[0-2]|[0-2]?[0-9]))(?:\\s*,\\s*(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(?:\\.(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3}\\/(?:3[0-2]|[0-2]?[0-9]))*$", "type": "string" }, "mapTvpc": { "pattern": "^(true|false)$", "type": "string", "description": "Used for GCP, AWS and AWS GovCloud Global settings" }, "multicloudSystemSettings": { "type": "object", "properties": { "enableMonitoring": { "type": "boolean", "writeOnly": true }, "useConfigurationGroup": { "pattern": "^(true|false)$", "type": "string", "description": "Enable or disable Configuration Group for Gateways" } }, "$$ref": "#/components/schemas/MulticloudSystemSettings" }, "name": { "pattern": "^[a-zA-Z_]+$", "type": "string" }, "networkTier": { "pattern": "^[a-zA-Z0-9_./\\-]+$", "type": "string", "description": "Used for GCP Global settings" }, "orgBgpAsn": { "pattern": "^[0-9]+$", "type": "string", "description": "Used for GCP, Azure and Azure GovCloud Global settings" }, "policyManagement": { "pattern": "^(true|false)$", "type": "string", "description": "Used for GCP Global settings" }, "programDefaultRoute": { "pattern": "^(true|false)$", "type": "string", "description": "Used for AWS/AWS GovCloud Global settings" }, "region": { "pattern": "^[a-zA-Z0-9_./\\-]+$", "type": "string", "description": "Used for AWS/AWS GovCloud Global settings" }, "serviceDirPollTimer": { "pattern": "^[0-9]+$", "type": "string", "description": "Used for GCP Global settings" }, "skuScaleUnit": { "pattern": "^[0-9]+$", "type": "string", "description": "Used for Azure/Azure GovCloud Global settings" }, "softwareImageId": { "pattern": "^[a-zA-Z0-9_./\\-\\s]+$", "type": "string" }, "tunnelCount": { "pattern": "^[0-9]+$", "type": "string", "description": "Used for AWS/AWS GovCloud Global settings" }, "tunnelType": { "pattern": "^(ipsec|gre)$", "type": "string", "description": "Used for GCP, AWS and AWS GovCloud Global settings" } }, "$$ref": "#/components/schemas/GlobalSettings" }, "examples": { "GCP Global settings": { "description": "GCP Global settings", "value": { "cloudGatewaySolution": "gcp", "cloudType": "GCP", "name": "GCP_GLOBAL_SETTING", "enableAutoCorrect": true, "enablePeriodicAudit": true, "softwareImageId": "cisco-c8k-17-07-01a-cisco-public", "instanceSize": "n1-standard-4", "intraTagComm": true, "ipSubnetPool": "10.0.0.0/16", "cgwBgpAsnOffset": 64520, "mapTvpc": true, "networkTier": "STANDARD", "orgBgpAsn": 64530, "policyManagement": false, "serviceDirPollTimer": 1200, "tunnelType": "ipsec", "multicloudSystemSettings": { "useConfigurationGroup": true } } }, "Aws Global settings": { "description": "Aws Global settings", "value": { "cloudGatewaySolution": "tgw_tvpc", "cloudType": "AWS", "name": "AWS_GLOBAL_SETTING", "enableAutoCorrect": true, "enablePeriodicAudit": true, "softwareImageId": "Cisco-C8K-17.05.01a-42cb6e93-8d9d-490b-a73c-e3e56077ffd1", "instanceSize": "c5.xlarge", "intraTagComm": true, "ipSubnetPool": "10.0.0.0/16", "accountId": "999293417507", "cgwBgpAsnOffset": 64520, "mapTvpc": true, "programDefaultRoute": true, "region": "us-west-1", "tunnelType": "ipsec", "tunnelCount": 1, "multicloudSystemSettings": { "useConfigurationGroup": true } } }, "Aws GovCloud Global settings": { "description": "Aws GovCloud Global settings", "value": { "cloudGatewaySolution": "tgw_tvpc", "cloudType": "AWS_GOVCLOUD", "name": "AWS__GOVCLOUD_GLOBAL_SETTING", "enableAutoCorrect": true, "enablePeriodicAudit": true, "softwareImageId": "Cisco-C8K-17.05.01a-42cb6e93-8d9d-490b-a73c-e3e56077ffd1", "instanceSize": "c5.large", "intraTagComm": true, "ipSubnetPool": "10.0.0.0/16", "accountId": "not available", "cgwBgpAsnOffset": 64520, "mapTvpc": true, "programDefaultRoute": true, "region": "us-gov-west-1", "tunnelType": "ipsec", "tunnelCount": 1, "multicloudSystemSettings": { "useConfigurationGroup": true } } }, "Azure Global settings": { "description": "Azure Global settings", "value": { "cloudGatewaySolution": "vhub", "cloudType": "AZURE", "name": "AZURE_GLOBAL_SETTING", "enableAutoCorrect": true, "enablePeriodicAudit": false, "intraTagComm": false, "ipSubnetPool": "21.0.0.0/16", "softwareImageId": "17.7.01", "orgBgpAsn": 64512, "skuScaleUnit": 2, "enableDefRouteAdvertize": false, "enableMonitoring": false, "multicloudSystemSettings": { "useConfigurationGroup": true } } }, "Azure GovCloud Global settings": { "description": "Azure GovCloud Global settings", "value": { "cloudGatewaySolution": "vhub", "cloudType": "AZURE_GOVCLOUD", "name": "AZURE__GOVCLOUD_GLOBAL_SETTING", "enableAutoCorrect": true, "enablePeriodicAudit": false, "intraTagComm": false, "ipSubnetPool": "21.0.0.0/16", "softwareImageId": "17.7.01", "orgBgpAsn": 64512, "skuScaleUnit": 4, "multicloudSystemSettings": { "useConfigurationGroup": true } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "MultiCloud - Global Settings" ], "description": "Update global settings", "operationId": "updateGlobalSettings", "requestBody": { "description": "Payload for updating Global Settings based on CloudType", "content": { "application/json": { "schema": { "required": [ "cgwBgpAsnOffset", "cloudGatewaySolution", "cloudType", "instanceSize", "ipSubnetPool", "orgBgpAsn", "skuScaleUnit", "softwareImageId" ], "type": "object", "properties": { "accountId": { "type": "string", "description": "Used for AWS/AWS GovCloud Global settings" }, "cgwBgpAsnOffset": { "pattern": "^[0-9]+$", "type": "string", "description": "Used for GCP, AWS and AWS GovCloud Global settings" }, "cloudGatewaySolution": { "pattern": "^[a-zA-Z_]+$", "type": "string" }, "cloudType": { "type": "string" }, "enableAutoCorrect": { "pattern": "^(true|false)$", "type": "string" }, "enableDefRouteAdvertize": { "pattern": "^(true|false)$", "type": "string", "description": "Used for Azure Global settings" }, "enableMonitoring": { "pattern": "^(true|false)$", "type": "string", "description": "Used for Azure Global settings" }, "enablePeriodicAudit": { "pattern": "^(true|false)$", "type": "string" }, "instanceSize": { "pattern": "^[a-zA-Z0-9_./\\-]+$", "type": "string", "description": "Used for GCP, AWS and AWS GovCloud Global settings" }, "intraTagComm": { "pattern": "^(true|false)$", "type": "string" }, "ipSubnetPool": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(?:\\.(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3}\\/(?:3[0-2]|[0-2]?[0-9]))(?:\\s*,\\s*(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(?:\\.(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3}\\/(?:3[0-2]|[0-2]?[0-9]))*$", "type": "string" }, "mapTvpc": { "pattern": "^(true|false)$", "type": "string", "description": "Used for GCP, AWS and AWS GovCloud Global settings" }, "multicloudSystemSettings": { "type": "object", "properties": { "enableMonitoring": { "type": "boolean", "writeOnly": true }, "useConfigurationGroup": { "pattern": "^(true|false)$", "type": "string", "description": "Enable or disable Configuration Group for Gateways" } }, "$$ref": "#/components/schemas/MulticloudSystemSettings" }, "name": { "pattern": "^[a-zA-Z_]+$", "type": "string" }, "networkTier": { "pattern": "^[a-zA-Z0-9_./\\-]+$", "type": "string", "description": "Used for GCP Global settings" }, "orgBgpAsn": { "pattern": "^[0-9]+$", "type": "string", "description": "Used for GCP, Azure and Azure GovCloud Global settings" }, "policyManagement": { "pattern": "^(true|false)$", "type": "string", "description": "Used for GCP Global settings" }, "programDefaultRoute": { "pattern": "^(true|false)$", "type": "string", "description": "Used for AWS/AWS GovCloud Global settings" }, "region": { "pattern": "^[a-zA-Z0-9_./\\-]+$", "type": "string", "description": "Used for AWS/AWS GovCloud Global settings" }, "serviceDirPollTimer": { "pattern": "^[0-9]+$", "type": "string", "description": "Used for GCP Global settings" }, "skuScaleUnit": { "pattern": "^[0-9]+$", "type": "string", "description": "Used for Azure/Azure GovCloud Global settings" }, "softwareImageId": { "pattern": "^[a-zA-Z0-9_./\\-\\s]+$", "type": "string" }, "tunnelCount": { "pattern": "^[0-9]+$", "type": "string", "description": "Used for AWS/AWS GovCloud Global settings" }, "tunnelType": { "pattern": "^(ipsec|gre)$", "type": "string", "description": "Used for GCP, AWS and AWS GovCloud Global settings" } }, "$$ref": "#/components/schemas/GlobalSettings" }, "examples": { "GCP Global settings": { "description": "GCP Global settings", "value": { "cloudGatewaySolution": "gcp", "cloudType": "GCP", "name": "GCP_GLOBAL_SETTING", "enableAutoCorrect": true, "enablePeriodicAudit": true, "softwareImageId": "cisco-c8k-17-07-01a-cisco-public", "instanceSize": "n1-standard-4", "intraTagComm": true, "ipSubnetPool": "10.0.0.0/16", "cgwBgpAsnOffset": 64520, "mapTvpc": true, "networkTier": "STANDARD", "orgBgpAsn": 64530, "policyManagement": false, "serviceDirPollTimer": 1200, "tunnelType": "ipsec", "multicloudSystemSettings": { "useConfigurationGroup": true } } }, "Aws Global settings": { "description": "Aws Global settings", "value": { "cloudGatewaySolution": "tgw_tvpc", "cloudType": "AWS", "name": "AWS_GLOBAL_SETTING", "enableAutoCorrect": true, "enablePeriodicAudit": true, "softwareImageId": "Cisco-C8K-17.05.01a-42cb6e93-8d9d-490b-a73c-e3e56077ffd1", "instanceSize": "c5.xlarge", "intraTagComm": true, "ipSubnetPool": "10.0.0.0/16", "accountId": "999293417507", "cgwBgpAsnOffset": 64520, "mapTvpc": true, "programDefaultRoute": true, "region": "us-west-1", "tunnelType": "ipsec", "tunnelCount": 1, "multicloudSystemSettings": { "useConfigurationGroup": true } } }, "Aws GovCloud Global settings": { "description": "Aws GovCloud Global settings", "value": { "cloudGatewaySolution": "tgw_tvpc", "cloudType": "AWS_GOVCLOUD", "name": "AWS__GOVCLOUD_GLOBAL_SETTING", "enableAutoCorrect": true, "enablePeriodicAudit": true, "softwareImageId": "Cisco-C8K-17.05.01a-42cb6e93-8d9d-490b-a73c-e3e56077ffd1", "instanceSize": "c5.large", "intraTagComm": true, "ipSubnetPool": "10.0.0.0/16", "accountId": "not available", "cgwBgpAsnOffset": 64520, "mapTvpc": true, "programDefaultRoute": true, "region": "us-gov-west-1", "tunnelType": "ipsec", "tunnelCount": 1, "multicloudSystemSettings": { "useConfigurationGroup": true } } }, "Azure Global settings": { "description": "Azure Global settings", "value": { "cloudGatewaySolution": "vhub", "cloudType": "AZURE", "name": "AZURE_GLOBAL_SETTING", "enableAutoCorrect": true, "enablePeriodicAudit": false, "intraTagComm": false, "ipSubnetPool": "21.0.0.0/16", "softwareImageId": "17.7.01", "orgBgpAsn": 64512, "skuScaleUnit": 2, "enableDefRouteAdvertize": false, "enableMonitoring": false, "multicloudSystemSettings": { "useConfigurationGroup": true } } }, "Azure GovCloud Global settings": { "description": "Azure GovCloud Global settings", "value": { "cloudGatewaySolution": "vhub", "cloudType": "AZURE_GOVCLOUD", "name": "AZURE__GOVCLOUD_GLOBAL_SETTING", "enableAutoCorrect": true, "enablePeriodicAudit": false, "intraTagComm": false, "ipSubnetPool": "21.0.0.0/16", "softwareImageId": "17.7.01", "orgBgpAsn": 64512, "skuScaleUnit": 4, "multicloudSystemSettings": { "useConfigurationGroup": true } } } } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "MultiCloud - Global Settings" ], "description": "Add global settings", "operationId": "addGlobalSettings", "requestBody": { "description": "Responses for get Global Settings based CloudType", "content": { "application/json": { "schema": { "required": [ "cgwBgpAsnOffset", "cloudGatewaySolution", "cloudType", "instanceSize", "ipSubnetPool", "orgBgpAsn", "skuScaleUnit", "softwareImageId" ], "type": "object", "properties": { "accountId": { "type": "string", "description": "Used for AWS/AWS GovCloud Global settings" }, "cgwBgpAsnOffset": { "pattern": "^[0-9]+$", "type": "string", "description": "Used for GCP, AWS and AWS GovCloud Global settings" }, "cloudGatewaySolution": { "pattern": "^[a-zA-Z_]+$", "type": "string" }, "cloudType": { "type": "string" }, "enableAutoCorrect": { "pattern": "^(true|false)$", "type": "string" }, "enableDefRouteAdvertize": { "pattern": "^(true|false)$", "type": "string", "description": "Used for Azure Global settings" }, "enableMonitoring": { "pattern": "^(true|false)$", "type": "string", "description": "Used for Azure Global settings" }, "enablePeriodicAudit": { "pattern": "^(true|false)$", "type": "string" }, "instanceSize": { "pattern": "^[a-zA-Z0-9_./\\-]+$", "type": "string", "description": "Used for GCP, AWS and AWS GovCloud Global settings" }, "intraTagComm": { "pattern": "^(true|false)$", "type": "string" }, "ipSubnetPool": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(?:\\.(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3}\\/(?:3[0-2]|[0-2]?[0-9]))(?:\\s*,\\s*(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(?:\\.(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3}\\/(?:3[0-2]|[0-2]?[0-9]))*$", "type": "string" }, "mapTvpc": { "pattern": "^(true|false)$", "type": "string", "description": "Used for GCP, AWS and AWS GovCloud Global settings" }, "multicloudSystemSettings": { "type": "object", "properties": { "enableMonitoring": { "type": "boolean", "writeOnly": true }, "useConfigurationGroup": { "pattern": "^(true|false)$", "type": "string", "description": "Enable or disable Configuration Group for Gateways" } }, "$$ref": "#/components/schemas/MulticloudSystemSettings" }, "name": { "pattern": "^[a-zA-Z_]+$", "type": "string" }, "networkTier": { "pattern": "^[a-zA-Z0-9_./\\-]+$", "type": "string", "description": "Used for GCP Global settings" }, "orgBgpAsn": { "pattern": "^[0-9]+$", "type": "string", "description": "Used for GCP, Azure and Azure GovCloud Global settings" }, "policyManagement": { "pattern": "^(true|false)$", "type": "string", "description": "Used for GCP Global settings" }, "programDefaultRoute": { "pattern": "^(true|false)$", "type": "string", "description": "Used for AWS/AWS GovCloud Global settings" }, "region": { "pattern": "^[a-zA-Z0-9_./\\-]+$", "type": "string", "description": "Used for AWS/AWS GovCloud Global settings" }, "serviceDirPollTimer": { "pattern": "^[0-9]+$", "type": "string", "description": "Used for GCP Global settings" }, "skuScaleUnit": { "pattern": "^[0-9]+$", "type": "string", "description": "Used for Azure/Azure GovCloud Global settings" }, "softwareImageId": { "pattern": "^[a-zA-Z0-9_./\\-\\s]+$", "type": "string" }, "tunnelCount": { "pattern": "^[0-9]+$", "type": "string", "description": "Used for AWS/AWS GovCloud Global settings" }, "tunnelType": { "pattern": "^(ipsec|gre)$", "type": "string", "description": "Used for GCP, AWS and AWS GovCloud Global settings" } }, "$$ref": "#/components/schemas/GlobalSettings" }, "examples": { "GCP Global settings": { "description": "GCP Global settings", "value": { "cloudGatewaySolution": "gcp", "cloudType": "GCP", "name": "GCP_GLOBAL_SETTING", "enableAutoCorrect": true, "enablePeriodicAudit": true, "softwareImageId": "cisco-c8k-17-07-01a-cisco-public", "instanceSize": "n1-standard-4", "intraTagComm": true, "ipSubnetPool": "10.0.0.0/16", "cgwBgpAsnOffset": 64520, "mapTvpc": true, "networkTier": "STANDARD", "orgBgpAsn": 64530, "policyManagement": false, "serviceDirPollTimer": 1200, "tunnelType": "ipsec", "multicloudSystemSettings": { "useConfigurationGroup": true } } }, "Aws Global settings": { "description": "Aws Global settings", "value": { "cloudGatewaySolution": "tgw_tvpc", "cloudType": "AWS", "name": "AWS_GLOBAL_SETTING", "enableAutoCorrect": true, "enablePeriodicAudit": true, "softwareImageId": "Cisco-C8K-17.05.01a-42cb6e93-8d9d-490b-a73c-e3e56077ffd1", "instanceSize": "c5.xlarge", "intraTagComm": true, "ipSubnetPool": "10.0.0.0/16", "accountId": "999293417507", "cgwBgpAsnOffset": 64520, "mapTvpc": true, "programDefaultRoute": true, "region": "us-west-1", "tunnelType": "ipsec", "tunnelCount": 1, "multicloudSystemSettings": { "useConfigurationGroup": true } } }, "Aws GovCloud Global settings": { "description": "Aws GovCloud Global settings", "value": { "cloudGatewaySolution": "tgw_tvpc", "cloudType": "AWS_GOVCLOUD", "name": "AWS__GOVCLOUD_GLOBAL_SETTING", "enableAutoCorrect": true, "enablePeriodicAudit": true, "softwareImageId": "Cisco-C8K-17.05.01a-42cb6e93-8d9d-490b-a73c-e3e56077ffd1", "instanceSize": "c5.large", "intraTagComm": true, "ipSubnetPool": "10.0.0.0/16", "accountId": "not available", "cgwBgpAsnOffset": 64520, "mapTvpc": true, "programDefaultRoute": true, "region": "us-gov-west-1", "tunnelType": "ipsec", "tunnelCount": 1, "multicloudSystemSettings": { "useConfigurationGroup": true } } }, "Azure Global settings": { "description": "Azure Global settings", "value": { "cloudGatewaySolution": "vhub", "cloudType": "AZURE", "name": "AZURE_GLOBAL_SETTING", "enableAutoCorrect": true, "enablePeriodicAudit": false, "intraTagComm": false, "ipSubnetPool": "21.0.0.0/16", "softwareImageId": "17.7.01", "orgBgpAsn": 64512, "skuScaleUnit": 2, "enableDefRouteAdvertize": false, "enableMonitoring": false, "multicloudSystemSettings": { "useConfigurationGroup": true } } }, "Azure GovCloud Global settings": { "description": "Azure GovCloud Global settings", "value": { "cloudGatewaySolution": "vhub", "cloudType": "AZURE_GOVCLOUD", "name": "AZURE__GOVCLOUD_GLOBAL_SETTING", "enableAutoCorrect": true, "enablePeriodicAudit": false, "intraTagComm": false, "ipSubnetPool": "21.0.0.0/16", "softwareImageId": "17.7.01", "orgBgpAsn": 64512, "skuScaleUnit": 4, "multicloudSystemSettings": { "useConfigurationGroup": true } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "6c723f65-9106-4f43-9d2b-a033a39353b3" } }, "description": "Task id for polling status", "$$ref": "#/components/schemas/Taskid" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/site": { "get": { "tags": [ "MultiCloud - BranchConnect" ], "description": "Get available sites", "operationId": "getSites", "parameters": [ { "name": "color", "in": "query", "description": "color", "schema": { "pattern": "^(?:(default|mpls|metro-ethernet|biz-internet|public-internet|lte|3g|red|green|blue|gold|silver|bronze|custom1|custom2|custom3|private1|private2|private3|private4|private5|private6)(,(default|mpls|metro-ethernet|biz-internet|public-internet|lte|3g|red|green|blue|gold|silver|bronze|custom1|custom2|custom3|private1|private2|private3|private4|private5|private6))*)?$", "type": "string" } }, { "name": "attached", "in": "query", "description": "Get attached Sites", "schema": { "pattern": "^(true|false)$", "type": "string" } }, { "name": "solution", "in": "query", "description": "Solution of branch device", "schema": { "pattern": "^(sdwan|sd-routing)$", "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "acceleratedVpn": { "type": "boolean" }, "aggTunnelStatus": { "type": "string" }, "attached": { "type": "boolean" }, "color": { "type": "string" }, "hostname": { "type": "string" }, "interface": { "type": "string" }, "preferredInterface": { "type": "boolean", "example": true }, "privateIp": { "type": "string" }, "publicIp": { "type": "string" }, "siteId": { "type": "string" }, "systemIp": { "type": "string" }, "tunnelCount": { "type": "number" }, "tunnels": { "type": "array", "properties": { "empty": { "type": "boolean" } }, "description": "CGW details relevant to AWS/AWS_GOVCLOUD", "items": { "type": "object", "properties": { "acceptedRouteCount": { "type": "integer", "format": "int32" }, "lastStatusChangeTimestamp": { "type": "string" }, "outerIpAddr": { "type": "string" }, "status": { "type": "string" }, "statusMessage": { "type": "string" }, "tunnelId": { "type": "string" }, "tunnelInnerIp": { "type": "array", "items": { "type": "string" } } }, "description": "CGW details relevant to AWS/AWS_GOVCLOUD", "$$ref": "#/components/schemas/TunnelsInner" } }, "uuid": { "type": "string" } }, "$$ref": "#/components/schemas/GetSitesResponse" }, "examples": { "Sites": { "description": "Sites", "value": { "uuid": "C8K-a165f574-e75e-11ec-8fea-0242ac120002", "siteId": "10", "hostname": "Branch-10", "systemIp": "1.1.1.10", "interface": "GigabitEthernet2", "color": "red", "privateIp": "10.11.2.248", "publicIp": "3.109.26.54", "attached": true } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/sshkeys": { "get": { "tags": [ "MultiCloud - General" ], "description": "Get ssh keyList for cloud type", "operationId": "getSshKeyList", "parameters": [ { "name": "cloudType", "in": "query", "required": true, "schema": { "pattern": "^[a-zA-Z_]+$", "type": "string" } }, { "name": "accountId", "in": "query", "required": true, "schema": { "pattern": "^\\d+$", "type": "string" } }, { "name": "cloudRegion", "in": "query", "required": true, "schema": { "pattern": "^[a-zA-Z0-9_./\\-]+$", "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "sshKeyName": { "type": "string" } }, "$$ref": "#/components/schemas/SshKeyList" } }, "examples": { "sshKeyList": { "description": "sshKeyList", "value": [ { "sshKeyName": "pp-newkp-oregon" }, { "sshKeyName": "pp-newkp-oregon-2" } ] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/statistics/interface/aggregation": { "post": { "tags": [ "MultiCloud - General" ], "description": "Get aggregated data based on input query and filter. The data can be filtered on time and other unique parameters based upon necessity and intended usage", "operationId": "getPostAggregationDataByQuery_MulticloudGeneral_4404", "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Stats Query String": { "description": "Stats Query String", "value": { "query": { "field": "latency", "type": "long", "value": [ "1" ], "operator": "greater" }, "fields": [ "latency" ], "aggregation": { "metrics": [ { "property": "latency", "type": "avg" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "edgeBillingAccountInfoList": { "type": "array", "items": { "type": "object", "properties": { "edgeBillingAccountId": { "type": "string", "description": "Interconnect billing account Id", "example": "12345" }, "edgeBillingAccountName": { "type": "string", "description": "Interconnect billing account name", "example": "Cisco IC" } }, "description": "Interconnect billing account Information", "$$ref": "#/components/schemas/InterconnectBillingAccountInfo" } } }, "$$ref": "#/components/schemas/InlineResponse2001" }, "examples": { "Aggregated Search Result": { "description": "Aggregated Search Result", "value": { "data": [ { "latency": 0.6404125644631974 } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/swimages": { "get": { "tags": [ "MultiCloud - Global Settings" ], "description": "Get software image list", "operationId": "getSupportedSoftwareImageList", "parameters": [ { "name": "cloudType", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "AWS", "AWS_GOVCLOUD", "AZURE", "AZURE_GOVCLOUD", "GCP" ] } }, { "name": "accountId", "in": "query", "schema": { "type": "string" } }, { "name": "cloudRegion", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "deviceModel": { "type": "string", "example": "vedge-C8000V" }, "displayName": { "type": "string", "example": "C8000v 17.04.01b" }, "isPaygImage": { "type": "boolean", "example": false }, "softwareImageId": { "type": "string", "example": "Cisco-C8k-17.04.01b-42cb6e93-8d9d-490b-a73c-e3e56077ffd1" }, "version": { "type": "string", "example": "17.04.01b" } }, "$$ref": "#/components/schemas/SwImagesResponse" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/telemetry": { "post": { "tags": [ "MultiCloud - General" ], "description": "Reports telemetry data", "operationId": "telemetry", "requestBody": { "description": "telemetry", "content": { "application/json": { "schema": { "required": [ "cloudType" ], "type": "object", "properties": { "cgwList": { "maxItems": 2147483647, "minItems": 1, "type": "array", "items": { "type": "string" } }, "cloudType": { "pattern": "[aA][zZ][uU][rR][eE]$", "type": "string", "example": "AZURE" } }, "$$ref": "#/components/schemas/TelemetryRequests" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "6c723f65-9106-4f43-9d2b-a033a39353b3" } }, "description": "Task id for polling status", "$$ref": "#/components/schemas/Taskid" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/tunnels/{cloudType}": { "get": { "tags": [ "MultiCloud - CloudGateway" ], "description": "Get the tunnels for cloudType", "operationId": "getTunnelNames", "parameters": [ { "name": "cloudType", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "AWS", "AWS_GOVCLOUD", "AZURE", "AZURE_GOVCLOUD", "GCP" ] } }, { "name": "cloudGatewayName", "in": "query", "required": true, "schema": { "pattern": "^[\\w.-]{1,128}$", "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "Private IP": { "type": "array", "items": { "type": "object", "properties": { "hostname": { "type": "string" }, "tunnels": { "type": "string" } }, "$$ref": "#/components/schemas/GetTunnelsResponsePrivateIP" } } }, "$$ref": "#/components/schemas/GetTunnelsResponse" } }, "examples": { "Get Tunnels": { "description": "Get Tunnels", "value": { "101.1.1.9": { "hostname": "gcp1109", "tunnels": [ "GigabitEthernet2" ] }, "101.1.1.7": { "hostname": "gcp1107", "tunnels": [ "GigabitEthernet2" ] } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/types": { "get": { "tags": [ "MultiCloud - General" ], "description": "Obtain all supported Cloud Service Provider (CSP) types", "operationId": "getCloudTypes", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "List of CloudTypes": { "description": "List of CloudTypes", "value": [ "AWS", "AWS_GOVCLOUD", "GCP", "AZURE", "AZURE_GOVCLOUD" ] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/widget": { "get": { "tags": [ "MultiCloud - General" ], "description": "Get All cloud widgets", "operationId": "getAllCloudWidgets", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "properties": { "empty": { "type": "boolean" } }, "items": { "type": "object", "properties": { "cgwDeviceSiteIds": { "type": "array", "items": { "type": "string" } }, "cgwDeviceStatus": { "type": "object", "properties": { "count": { "type": "number" }, "name": { "type": "string" }, "statusList": { "type": "array", "items": { "type": "object", "properties": { "count": { "type": "number" }, "message": { "type": "string" }, "name": { "type": "string" }, "status": { "type": "string" } }, "$$ref": "#/components/schemas/WidgetStatusStatusList" } }, "unreachableCount": { "type": "number" } }, "$$ref": "#/components/schemas/AllOfcloudWidgetCgwDeviceStatus" }, "cgwSitesStatus": { "type": "object", "properties": { "count": { "type": "number" }, "name": { "type": "string" }, "statusList": { "type": "array", "items": { "type": "object", "properties": { "count": { "type": "number" }, "message": { "type": "string" }, "name": { "type": "string" }, "status": { "type": "string" } }, "$$ref": "#/components/schemas/WidgetStatusStatusList" } } }, "$$ref": "#/components/schemas/WidgetStatus" }, "cgwStatus": { "type": "object", "properties": { "count": { "type": "number" }, "name": { "type": "string" }, "statusList": { "type": "array", "items": { "type": "object", "properties": { "count": { "type": "number" }, "message": { "type": "string" }, "name": { "type": "string" }, "status": { "type": "string" } }, "$$ref": "#/components/schemas/WidgetStatusStatusList" } } }, "$$ref": "#/components/schemas/WidgetStatus" }, "cloudGatewaySolution": { "type": "string" }, "cloudType": { "type": "string" }, "numAccounts": { "type": "number" }, "numTags": { "type": "number" }, "numTunnels": { "type": "number" }, "numVpcs": { "type": "number" }, "numVpns": { "type": "number" } }, "$$ref": "#/components/schemas/CloudWidget" }, "$$ref": "#/components/schemas/Widgets" }, "examples": { "Widgets": { "description": "Widgets", "value": { "cloudType": "AWS", "cgwStatus": { "name": "Cloud Gateway", "count": 0, "statusList": [ { "name": "Cloud Gateway", "count": 0, "status": "normal", "message": "Cloud Gateways" }, { "name": "Cloud Gateway", "count": 0, "status": "warning", "message": "Cloud Gateways with warning" }, { "name": "Cloud Gateway", "count": 0, "status": "error", "message": "Cloud Gateways with error" } ] }, "cgwDeviceStatus": { "name": "Cloud Gateway Device", "count": 0, "unreachableCount": 0, "statusList": [ { "name": "Cloud Gateway Device", "count": 0, "status": "normal", "message": "Cloud Gateway devices" }, { "name": "Cloud Gateway Device", "count": 0, "status": "error", "message": "Cloud Gateway devices with errors" } ] }, "cgwSitesStatus": { "name": "Cloud Gateway Sites", "count": 0, "statusList": [ { "name": "Cloud Gateway Sites", "count": 0, "status": "error", "message": "Cloud Gateway Sites with error" }, { "name": "Cloud Gateway Sites", "count": 0, "status": "warning", "message": "Cloud Gateway Sites with warning" }, { "name": "Cloud Gateway Sites", "count": 0, "status": "normal", "message": "Cloud Gateway Sites" } ] }, "cloudGatewaySolution": "tgw_tvpc", "numAccounts": 0, "numVpns": 0, "numTags": 0, "numVpcs": 0, "numTunnels": 0, "cgwDeviceSiteIds": [] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/widget/{cloudType}": { "get": { "tags": [ "MultiCloud - General" ], "description": "Get cloud widget by cloud type", "operationId": "getCloudWidget", "parameters": [ { "name": "cloudType", "in": "path", "required": true, "schema": { "pattern": "^[a-zA-Z_]+$", "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "cgwDeviceSiteIds": { "type": "array", "items": { "type": "string" } }, "cgwDeviceStatus": { "type": "object", "properties": { "count": { "type": "number" }, "name": { "type": "string" }, "statusList": { "type": "array", "items": { "type": "object", "properties": { "count": { "type": "number" }, "message": { "type": "string" }, "name": { "type": "string" }, "status": { "type": "string" } }, "$$ref": "#/components/schemas/WidgetStatusStatusList" } }, "unreachableCount": { "type": "number" } }, "$$ref": "#/components/schemas/AllOfcloudWidgetCgwDeviceStatus" }, "cgwSitesStatus": { "type": "object", "properties": { "count": { "type": "number" }, "name": { "type": "string" }, "statusList": { "type": "array", "items": { "type": "object", "properties": { "count": { "type": "number" }, "message": { "type": "string" }, "name": { "type": "string" }, "status": { "type": "string" } }, "$$ref": "#/components/schemas/WidgetStatusStatusList" } } }, "$$ref": "#/components/schemas/WidgetStatus" }, "cgwStatus": { "type": "object", "properties": { "count": { "type": "number" }, "name": { "type": "string" }, "statusList": { "type": "array", "items": { "type": "object", "properties": { "count": { "type": "number" }, "message": { "type": "string" }, "name": { "type": "string" }, "status": { "type": "string" } }, "$$ref": "#/components/schemas/WidgetStatusStatusList" } } }, "$$ref": "#/components/schemas/WidgetStatus" }, "cloudGatewaySolution": { "type": "string" }, "cloudType": { "type": "string" }, "numAccounts": { "type": "number" }, "numTags": { "type": "number" }, "numTunnels": { "type": "number" }, "numVpcs": { "type": "number" }, "numVpns": { "type": "number" } }, "$$ref": "#/components/schemas/CloudWidget" }, "examples": { "Widget": { "description": "Widget", "value": { "cloudType": "AWS", "cgwStatus": { "name": "Cloud Gateway", "count": 0, "statusList": [ { "name": "Cloud Gateway", "count": 0, "status": "normal", "message": "Cloud Gateways" }, { "name": "Cloud Gateway", "count": 0, "status": "warning", "message": "Cloud Gateways with warning" }, { "name": "Cloud Gateway", "count": 0, "status": "error", "message": "Cloud Gateways with error" } ] }, "cgwDeviceStatus": { "name": "Cloud Gateway Device", "count": 0, "unreachableCount": 0, "statusList": [ { "name": "Cloud Gateway Device", "count": 0, "status": "normal", "message": "Cloud Gateway devices" }, { "name": "Cloud Gateway Device", "count": 0, "status": "error", "message": "Cloud Gateway devices with errors" } ] }, "cgwSitesStatus": { "name": "Cloud Gateway Sites", "count": 0, "statusList": [ { "name": "Cloud Gateway Sites", "count": 0, "status": "error", "message": "Cloud Gateway Sites with error" }, { "name": "Cloud Gateway Sites", "count": 0, "status": "warning", "message": "Cloud Gateway Sites with warning" }, { "name": "Cloud Gateway Sites", "count": 0, "status": "normal", "message": "Cloud Gateway Sites" } ] }, "cloudGatewaySolution": "tgw_tvpc", "numAccounts": 0, "numVpns": 0, "numTags": 0, "numVpcs": 0, "numTunnels": 0, "cgwDeviceSiteIds": [] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/{cloudType}/config-group/{config-group-id}/topology": { "get": { "tags": [ "MultiCloud - General" ], "summary": "Get Multicloud topology.", "description": "API to retrieve current Multicloud MultiCloud topology for the Config Group.", "operationId": "getMultiCloudConfigGroupTopology", "parameters": [ { "name": "cloudType", "in": "path", "required": true, "schema": { "pattern": "^[a-zA-Z_]+$", "type": "string" } }, { "name": "config-group-id", "in": "path", "required": true, "schema": { "pattern": "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}", "type": "string" } } ], "responses": { "200": { "description": "MultiCloud Config-Group Topology Response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "description": "data list", "example": [ "MEGAPORT", "EQUINIX", "ATT" ], "items": { "type": "string", "description": "data", "example": "MEGAPORT" } } }, "$$ref": "#/components/schemas/InlineResponse200" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "MultiCloud - General" ], "summary": "Update Multicloud topology for the Config Group.", "description": "API to update current MultiCloud topology for the Config Group.", "operationId": "updateMultiCloudConfigGroupTopology", "parameters": [ { "name": "cloudType", "in": "path", "required": true, "schema": { "pattern": "^[a-zA-Z_]+$", "type": "string" } }, { "name": "config-group-id", "in": "path", "required": true, "schema": { "pattern": "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}", "type": "string" } } ], "responses": { "200": { "description": "MultiCloud Config-Group Topology Response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "description": "data list", "example": [ "MEGAPORT", "EQUINIX", "ATT" ], "items": { "type": "string", "description": "data", "example": "MEGAPORT" } } }, "$$ref": "#/components/schemas/InlineResponse200" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/network/connectionssummary": { "get": { "tags": [ "Device - Network" ], "description": "Retrieve vManage control status", "operationId": "getVmanageControlStatus", "parameters": [ { "name": "isCached", "in": "query", "description": "Is cached flag", "schema": { "type": "boolean", "default": false } }, { "name": "vpnId", "in": "query", "description": "VPN Id", "schema": { "type": "array", "items": { "type": "object", "properties": { "vpn": { "type": "string" } }, "description": "This is the valid list of VPN-IDs", "$$ref": "#/components/schemas/VPNID" } } }, { "name": "site-id", "in": "query", "description": "Optional site ID to filter devices", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "vManage control status": { "description": "vManage control status", "value": { "data": [ { "name": "vSmart", "count": 2, "detailsURL": "/dataservice/device/reachable?personality=vsmart", "status": "error", "statusList": [ { "name": "vSmart", "status": "error", "message": "Number of devices down", "detailsURL": "/dataservice/device/unreachable?personality=vsmart", "count": 0 } ] }, { "name": "WAN Edge", "count": 5, "detailsURL": "/dataservice/device/reachable?personality=vedge", "status": "error", "statusList": [ { "name": "vEdge", "status": "error", "message": "Number of devices down", "detailsURL": "/dataservice/device/unreachable?personality=vedge", "count": 0 } ] }, { "name": "vBond", "count": 1, "detailsURL": "/dataservice/device/reachable?personality=vbond", "status": "error", "statusList": [ { "name": "vBond", "status": "error", "message": "Number of devices down", "detailsURL": "/dataservice/device/unreachable?personality=vbond", "count": 0 } ] } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default,RBAC VPN-read" } }, "/network/issues/rebootcount": { "get": { "tags": [ "Device - Network" ], "description": "Retrieve reboot count", "operationId": "getRebootCount", "parameters": [ { "name": "isCached", "in": "query", "description": "Is cached flag", "required": true, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Reboot count": { "description": "Reboot count", "value": { "data": [ { "type": "Reboot count", "name": "Reboot", "showTitle": false, "count": 3, "detailView": "dialog", "detailsURL": "dataservice/device/reboothistory/details", "status": "error" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" } }, "/network/issues/summary": { "get": { "tags": [ "Device - Network" ], "description": "Retrieve network issues summary", "operationId": "getNetworkIssuesSummary", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Network issues": { "description": "Network issues", "value": { "data": [ { "type": "Status summary", "name": "Status summary", "showTitle": false, "count": 3, "detailView": "dialog", "statusList": [ { "status": "Crashes", "name": "Crashes", "detailView": "dialog", "detailsURL": "dataservice/device/crashlog/details", "color": "fa7c7d", "icon": "images/device/device-error.png", "count": 0 }, { "status": "Reboots", "name": "Reboots", "detailView": "dialog", "detailsURL": "dataservice/device/reboothistory/details", "color": "f2ce60", "icon": "images/device/device-warning.png", "count": 3 }, { "status": "Hardware errors", "name": "Hardware errors", "detailView": "dialog", "detailsURL": "dataservice/device/hardware/errors", "color": "f2ce60", "icon": "images/device/device-warning.png", "count": 0 } ] } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read,System-read" } }, "/network/status": { "get": { "tags": [ "Device - Network" ], "description": "Retrieve network status summary", "operationId": "getNetworkStatusSummary", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "Network status": { "description": "Network status", "value": { "header": { "generatedOn": 1635483849920 }, "data": [ { "type": "vSmart", "name": "vSmart", "image": "images/vsmart.png", "count": 3, "detailView": "dialog", "detailsURL": "/dataservice/device?personality=vsmart", "statusList": [ { "status": "error", "name": "Error", "detailView": "dialog", "detailsURL": "/dataservice/device?personality=vsmart&status=error", "color": "fa7c7d", "icon": "images/device/device-error.png", "count": 0 }, { "status": "warning", "name": "Warning", "detailView": "dialog", "detailsURL": "/dataservice/device?personality=vsmart&status=warning", "color": "f2ce60", "icon": "images/device/device-warning.png", "count": 0 }, { "status": "normal", "name": "Normal", "detailView": "dialog", "detailsURL": "/dataservice/device?personality=vsmart&status=normal", "color": "b0e276", "icon": "images/device/device-normal.png", "count": 3 }, { "status": "new", "name": "Discovered device", "detailView": "dialog", "detailsURL": "/dataservice/device?personality=vsmart&status=new", "color": "7c8afa", "icon": "images/device/device-new.png", "count": 0 } ] } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read,System-read" } }, "/networkdesign": { "get": { "tags": [ "Configuration - Network Design" ], "description": "Get existing network design", "operationId": "getNetworkDesign", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Network design": { "description": "Network design", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true, "x-roles-required": "Template Configuration-read,Template Configuration-write,Template Deploy-read,Template Deploy-write" }, "put": { "tags": [ "Configuration - Network Design" ], "description": "Edit network segment", "operationId": "editNetworkDesign", "parameters": [ { "name": "id", "in": "query", "description": "Id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Network design payload", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "User": { "description": "User", "value": {} } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Network design template": { "description": "Network design template", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true, "x-roles-required": "Template Configuration-write,Device Inventory > Edge-write" }, "post": { "tags": [ "Configuration - Network Design" ], "description": "Create network design", "operationId": "createNetworkDesign", "requestBody": { "description": "Network design payload", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "User": { "description": "User", "value": { "dc": [ { "name": "DC4", "segments": [ "c952c18b-30b3-4f0b-b985-494693d7adfb" ], "deviceProfiles": [ { "deviceProfileName": "ASR1001", "deviceModel": "vedge-ASR-1001-X", "deviceTemplateID": "", "deviceProfileId": "", "circuits": [ "07dce48b-3c7d-46c0-ac91-36f0d64d61e7" ] } ] } ], "showDeviceProfileHelpText": true, "globalParameters": [ { "templateType": "aaa", "gTemplateClass": "vedge", "isUsed": false }, { "templateType": "cisco_snmp", "gTemplateClass": "cedge", "isUsed": false }, { "templateType": "omp-vedge", "gTemplateClass": "vedge", "isUsed": false }, { "templateType": "banner", "gTemplateClass": "vedge", "isUsed": false }, { "templateType": "ntp", "gTemplateClass": "vedge", "isUsed": false }, { "templateType": "snmp", "gTemplateClass": "vedge", "isUsed": false }, { "templateType": "cisco_bfd", "gTemplateClass": "cedge", "isUsed": false }, { "templateType": "cisco_ntp", "gTemplateClass": "cedge", "isUsed": false }, { "templateType": "cedge_global", "gTemplateClass": "cedge", "isUsed": false }, { "templateType": "cisco_logging", "gTemplateClass": "cedge", "isUsed": false }, { "templateType": "bfd-vedge", "gTemplateClass": "vedge", "isUsed": false }, { "templateType": "cedge_aaa", "gTemplateClass": "cedge", "isUsed": false }, { "templateType": "logging", "gTemplateClass": "vedge", "isUsed": false }, { "templateType": "cisco_omp", "gTemplateClass": "cedge", "isUsed": false }, { "templateType": "cisco_banner", "gTemplateClass": "cedge", "isUsed": false } ], "customizedProfiles": [] } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Template Id": { "description": "Template Id", "value": { "id": "07c1e0a1-d28a-4372-b819-0f1ab5fc8e39" } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true, "x-roles-required": "Template Configuration-write" } }, "/networkdesign/attachment": { "post": { "tags": [ "Configuration - Network Design" ], "description": "Attach network design", "operationId": "pushNetworkDesign", "requestBody": { "description": "Device template", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Device template": { "description": "Device 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" } }, "deprecated": true, "x-roles-required": "Template Deploy-write" } }, "/networkdesign/circuit": { "get": { "tags": [ "Configuration - Circuits" ], "description": "Get network circuits", "operationId": "getCircuits", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Network circuits": { "description": "Network circuits", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true }, "post": { "tags": [ "Configuration - Circuits" ], "description": "Create network circuits", "operationId": "createCircuit", "requestBody": { "description": "Network circuit", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Network circuit": { "description": "Network circuit", "value": { "type": "private", "color": "biz-internet" } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Network circuit Id": { "description": "Network circuit Id", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true } }, "/networkdesign/circuit/{id}": { "delete": { "tags": [ "Configuration - Circuits" ], "description": "Delete network circuits", "operationId": "deleteCircuit", "parameters": [ { "name": "id", "in": "path", "description": "Id", "required": true, "schema": { "pattern": "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}", "type": "string" } } ], "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true } }, "/networkdesign/global/parameters": { "get": { "tags": [ "Configuration - Network Design" ], "description": "Get global parameter templates", "operationId": "getGlobalParameters", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Global parameters": { "description": "Global parameters", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true, "x-roles-required": "Template Configuration-read,Template Configuration-write,Template Deploy-read,Template Deploy-write" } }, "/networkdesign/global/template/{templateId}": { "get": { "tags": [ "Configuration - Network Design Templates" ], "description": "Get global template", "operationId": "getGlobalTemplate", "parameters": [ { "name": "templateId", "in": "path", "description": "Template Id", "required": true, "schema": { "pattern": "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}", "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Network design template": { "description": "Network design template", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true, "x-roles-required": "Template Configuration-read,Template Deploy-read,Policy Configuration-read" }, "put": { "tags": [ "Configuration - Network Design Templates" ], "description": "Edit global template", "operationId": "editGlobalTemplate", "parameters": [ { "name": "templateId", "in": "path", "description": "Template Id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Global template", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Network design template": { "description": "Network design template" } } } }, "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,Policy Configuration-write" } }, "/networkdesign/lock/edit": { "post": { "tags": [ "Configuration - Network Design" ], "description": "Acquire edit lock", "operationId": "acquireEditLock", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Lock Id": { "description": "Lock Id", "value": { "id": "nd_edit-96c1ff5a-44fa-4316-ad15-cc820347f7d3" } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true, "x-roles-required": "Template Configuration-write" } }, "/networkdesign/mytest/{name}": { "get": { "tags": [ "Configuration - Network Design" ], "description": "Get all device templates for this feature template", "operationId": "runMyTest", "parameters": [ { "name": "name", "in": "path", "description": "Test bane", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Device template": { "description": "Device template", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true, "x-roles-required": "Template Configuration-read,Template Configuration-write,Template Deploy-read,Template Deploy-write" } }, "/networkdesign/profile/attachment/{profileId}": { "post": { "tags": [ "Configuration - Network Design" ], "description": "Attach to device profile", "operationId": "pushDeviceProfileTemplate", "parameters": [ { "name": "profileId", "in": "path", "description": "Device profile Id", "required": true, "schema": { "pattern": "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}", "type": "string" } } ], "requestBody": { "description": "Device template", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Device template": { "description": "Device template", "value": {} } } } }, "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": "Template Deploy-write" } }, "/networkdesign/profile/feature": { "get": { "tags": [ "Configuration - Network Design Templates" ], "description": "Generate device profile template list", "operationId": "getDeviceProfileFeatureTemplateList", "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" } }, "deprecated": true, "x-roles-required": "Template Configuration-read,Template Deploy-read,Policy Configuration-read" } }, "/networkdesign/profile/lock/{profileId}": { "post": { "tags": [ "Configuration - Network Design" ], "description": "Get the service profile config for a given device profile id", "operationId": "acquireAttachLock", "parameters": [ { "name": "profileId", "in": "path", "description": "Device profile 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": "Template Deploy-write" } }, "/networkdesign/profile/status": { "get": { "tags": [ "Configuration - Network Design" ], "description": "Get device profile configuration status", "operationId": "getDeviceProfileConfigStatus", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Device config status": { "description": "Device config status", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true, "x-roles-required": "Template Configuration-read,Template Configuration-write,Template Deploy-read,Template Deploy-write" } }, "/networkdesign/profile/status/{profileId}": { "get": { "tags": [ "Configuration - Network Design" ], "description": "Get device profile configuration status by profile Id", "operationId": "getDeviceProfileConfigStatusByProfileId", "parameters": [ { "name": "profileId", "in": "path", "description": "Device profile Id", "required": true, "schema": { "pattern": "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}", "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Device config status": { "description": "Device config status", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true, "x-roles-required": "Template Configuration-read,Template Configuration-write,Template Deploy-read,Template Deploy-write" } }, "/networkdesign/profile/task/count": { "get": { "tags": [ "Configuration - Network Design" ], "description": "Get device profile configuration task count", "operationId": "getDeviceProfileTaskCount", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Device config task count": { "description": "Device config task count", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true, "x-roles-required": "Template Configuration-read,Template Configuration-write,Template Deploy-read,Template Deploy-write" } }, "/networkdesign/profile/task/status": { "get": { "tags": [ "Configuration - Network Design" ], "description": "Get device profile configuration task status", "operationId": "getDeviceProfileTaskStatus", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Device config task status": { "description": "Device config task status", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true, "x-roles-required": "Template Configuration-read,Template Configuration-write,Template Deploy-read,Template Deploy-write" } }, "/networkdesign/profile/task/status/{profileId}": { "get": { "tags": [ "Configuration - Network Design" ], "description": "Get device profile configuration status by profile Id", "operationId": "getDeviceProfileTaskStatusByProfileId", "parameters": [ { "name": "profileId", "in": "path", "description": "Device profile Id", "required": true, "schema": { "pattern": "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}", "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Device config task status": { "description": "Device config task status", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true, "x-roles-required": "Template Configuration-read,Template Configuration-write,Template Deploy-read,Template Deploy-write" } }, "/networkdesign/profile/template": { "get": { "tags": [ "Configuration - Network Design Templates" ], "description": "Generate profile template list", "operationId": "generateProfileTemplateList", "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" } }, "deprecated": true, "x-roles-required": "Template Configuration-read,Template Deploy-read,Template Deploy-write" } }, "/networkdesign/profile/template/{templateId}": { "put": { "tags": [ "Configuration - Network Design Templates" ], "description": "Edit device profile template", "operationId": "editDeviceProfileTemplate", "parameters": [ { "name": "templateId", "in": "path", "description": "Template Id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Global template", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Device profile template": { "description": "Device profile template" } } } }, "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,Policy Configuration-write" }, "get": { "tags": [ "Configuration - Network Design Templates" ], "description": "Get device profile template", "operationId": "getDeviceProfileTemplate", "parameters": [ { "name": "templateId", "in": "path", "description": "Template Id", "required": true, "schema": { "pattern": "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}", "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Device profile template": { "description": "Device profile template", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true, "x-roles-required": "Template Configuration-read,Template Deploy-read,Policy Configuration-read" } }, "/networkdesign/serviceProfileConfig/{profileId}": { "get": { "tags": [ "Configuration - Network Design" ], "description": "Get the service profile config for a given device profile id", "operationId": "getServiceProfileConfig", "parameters": [ { "name": "profileId", "in": "path", "description": "Device profile Id", "required": true, "schema": { "type": "string" } }, { "name": "deviceModel", "in": "query", "description": "Device model", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Device profile": { "description": "Device profile", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true, "x-roles-required": "Template Configuration-read,Template Configuration-write,Template Deploy-read,Template Deploy-write" } }, "/onboard/delete-devices": { "post": { "tags": [ "Manual Onboard Device" ], "summary": "Delete Manual Onboard Device details", "description": "Delete Manual Onboard Device details", "operationId": "deleteDevices", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "devices": { "type": "array", "items": { "type": "string" } } }, "$$ref": "#/components/schemas/DeleteDetails" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "properties": { "empty": { "type": "boolean" } }, "items": { "type": "object", "properties": { "host": { "type": "string", "example": "172.16.255.11" }, "reason": { "type": "string", "example": "Software install task is in progress or scheduled for this device" } }, "$$ref": "#/components/schemas/DeleteResponseInner" }, "$$ref": "#/components/schemas/DeleteResponse" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/onboard/details": { "post": { "tags": [ "Manual Onboard Device" ], "summary": "Add Manual Onboard Device details", "description": "Add Manual Onboard Device details", "operationId": "addDevices", "requestBody": { "description": "On board Device details", "content": { "application/json": { "schema": { "required": [ "devices" ], "type": "object", "properties": { "devices": { "maxItems": 2147483647, "minItems": 1, "type": "array", "description": "Device list to onboard", "items": { "required": [ "host", "password", "username", "wan" ], "type": "object", "properties": { "device_uuid": { "type": "string", "description": "device uuid/chassis number", "example": "C8K-4facbd05-855b-45f0-af2f-c844af179bd6" }, "enable_password": { "type": "string", "description": "enable password", "example": "admin" }, "host": { "pattern": "((^\\s*((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))\\s*$)|(^\\s*((([0-9a-f]{1,4}:){7}([0-9a-f]{1,4}|:))|(([0-9a-f]{1,4}:){6}(:[0-9a-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9a-f]{1,4}:){5}(((:[0-9a-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9a-f]{1,4}:){4}(((:[0-9a-f]{1,4}){1,3})|((:[0-9a-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9a-f]{1,4}:){3}(((:[0-9a-f]{1,4}){1,4})|((:[0-9a-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9a-f]{1,4}:){2}(((:[0-9a-f]{1,4}){1,5})|((:[0-9a-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9a-f]{1,4}:){1}(((:[0-9a-f]{1,4}){1,6})|((:[0-9a-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9a-f]{1,4}){1,7})|((:[0-9a-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))(%.+)?\\s*$))", "type": "string", "description": "host ip", "example": "1.1.1.1" }, "local_file_name": { "type": "string", "description": "local file name", "example": "c8000v-universalk9.17.12.01.0.175851.SSA.bin" }, "password": { "type": "string", "description": "ssh password", "example": "admin" }, "remote_server_file_name": { "type": "string", "description": "remote server file name", "example": "c8000v-universalk9.17.12.01.0.175851.SSA.bin" }, "remote_server_id": { "type": "string", "description": "remote server Id", "example": "56a32849-aafb-4703-8887-ba64c0394835" }, "username": { "type": "string", "description": "ssh username", "example": "admin" }, "wan": { "maxLength": 32, "minLength": 3, "pattern": "(Cellular|Dialer|Ethernet|FastEthernet|FiftyGigabitEthernet|FiveGigabitEthernet|FortyGigabitEthernet|FourHundredGigE|GigabitEthernet|HundredGigE|Loopback|Multilink|Port-channel|Serial|TenGigabitEthernet|Tunnel|TwentyFiveGigE|TwentyFiveGigabitEthernet|TwoGigabitEthernet|TwoHundredGigE|Vlan|Wlan-GigabitEthernet)([0-9]*(. ?[1-9][0-9]*)*|[0-9/]+|[0-9]+/[0-9]+/[0-9]+:[0-9]+|[0-9]+/[0-9]+/[0-9]+|[0-9]+/[0-9]+|[0-9]+)", "type": "string", "description": "WAN interface name", "example": "GigabitEthernet1" } }, "description": "Device list to onboard", "$$ref": "#/components/schemas/DeviceDetails" } } }, "$$ref": "#/components/schemas/DeviceDetailsData" } } }, "required": true }, "responses": { "201": { "description": "item created" }, "400": { "description": "Bad Request" }, "409": { "description": "an existing item already exists" } } } }, "/onboard/devices": { "get": { "tags": [ "Manual Onboard Device" ], "summary": "GET Manual Onboard Device details", "description": "GET Manual Onboard Device details", "operationId": "getDevices_ManualOnboardDevice_1603", "parameters": [ { "name": "status", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "properties": { "empty": { "type": "boolean" } }, "items": { "required": [ "devices" ], "type": "object", "properties": { "devices": { "maxItems": 2147483647, "minItems": 1, "type": "array", "description": "Device list to onboard", "items": { "required": [ "host", "password", "username", "wan" ], "type": "object", "properties": { "device_uuid": { "type": "string", "description": "device uuid/chassis number", "example": "C8K-4facbd05-855b-45f0-af2f-c844af179bd6" }, "enable_password": { "type": "string", "description": "enable password", "example": "admin" }, "host": { "pattern": "((^\\s*((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))\\s*$)|(^\\s*((([0-9a-f]{1,4}:){7}([0-9a-f]{1,4}|:))|(([0-9a-f]{1,4}:){6}(:[0-9a-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9a-f]{1,4}:){5}(((:[0-9a-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9a-f]{1,4}:){4}(((:[0-9a-f]{1,4}){1,3})|((:[0-9a-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9a-f]{1,4}:){3}(((:[0-9a-f]{1,4}){1,4})|((:[0-9a-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9a-f]{1,4}:){2}(((:[0-9a-f]{1,4}){1,5})|((:[0-9a-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9a-f]{1,4}:){1}(((:[0-9a-f]{1,4}){1,6})|((:[0-9a-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9a-f]{1,4}){1,7})|((:[0-9a-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))(%.+)?\\s*$))", "type": "string", "description": "host ip", "example": "1.1.1.1" }, "local_file_name": { "type": "string", "description": "local file name", "example": "c8000v-universalk9.17.12.01.0.175851.SSA.bin" }, "password": { "type": "string", "description": "ssh password", "example": "admin" }, "remote_server_file_name": { "type": "string", "description": "remote server file name", "example": "c8000v-universalk9.17.12.01.0.175851.SSA.bin" }, "remote_server_id": { "type": "string", "description": "remote server Id", "example": "56a32849-aafb-4703-8887-ba64c0394835" }, "username": { "type": "string", "description": "ssh username", "example": "admin" }, "wan": { "maxLength": 32, "minLength": 3, "pattern": "(Cellular|Dialer|Ethernet|FastEthernet|FiftyGigabitEthernet|FiveGigabitEthernet|FortyGigabitEthernet|FourHundredGigE|GigabitEthernet|HundredGigE|Loopback|Multilink|Port-channel|Serial|TenGigabitEthernet|Tunnel|TwentyFiveGigE|TwentyFiveGigabitEthernet|TwoGigabitEthernet|TwoHundredGigE|Vlan|Wlan-GigabitEthernet)([0-9]*(. ?[1-9][0-9]*)*|[0-9/]+|[0-9]+/[0-9]+/[0-9]+:[0-9]+|[0-9]+/[0-9]+/[0-9]+|[0-9]+/[0-9]+|[0-9]+)", "type": "string", "description": "WAN interface name", "example": "GigabitEthernet1" } }, "description": "Device list to onboard", "$$ref": "#/components/schemas/DeviceDetails" } } }, "$$ref": "#/components/schemas/DeviceDetailsData" }, "$$ref": "#/components/schemas/Details" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Manual Onboard Device" ], "summary": "Manual Onboard added Device details", "description": "Manual Onboard added Device details", "operationId": "manualOnboardDevices", "requestBody": { "description": "On board Devices", "content": { "application/json": { "schema": { "required": [ "devices" ], "type": "object", "properties": { "devices": { "maxItems": 2147483647, "minItems": 1, "type": "array", "description": "Device list to onboard", "items": { "required": [ "host", "password", "username", "wan" ], "type": "object", "properties": { "device_uuid": { "type": "string", "description": "device uuid/chassis number", "example": "C8K-4facbd05-855b-45f0-af2f-c844af179bd6" }, "enable_password": { "type": "string", "description": "enable password", "example": "admin" }, "host": { "pattern": "((^\\s*((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))\\s*$)|(^\\s*((([0-9a-f]{1,4}:){7}([0-9a-f]{1,4}|:))|(([0-9a-f]{1,4}:){6}(:[0-9a-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9a-f]{1,4}:){5}(((:[0-9a-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9a-f]{1,4}:){4}(((:[0-9a-f]{1,4}){1,3})|((:[0-9a-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9a-f]{1,4}:){3}(((:[0-9a-f]{1,4}){1,4})|((:[0-9a-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9a-f]{1,4}:){2}(((:[0-9a-f]{1,4}){1,5})|((:[0-9a-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9a-f]{1,4}:){1}(((:[0-9a-f]{1,4}){1,6})|((:[0-9a-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9a-f]{1,4}){1,7})|((:[0-9a-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))(%.+)?\\s*$))", "type": "string", "description": "host ip", "example": "1.1.1.1" }, "local_file_name": { "type": "string", "description": "local file name", "example": "c8000v-universalk9.17.12.01.0.175851.SSA.bin" }, "password": { "type": "string", "description": "ssh password", "example": "admin" }, "remote_server_file_name": { "type": "string", "description": "remote server file name", "example": "c8000v-universalk9.17.12.01.0.175851.SSA.bin" }, "remote_server_id": { "type": "string", "description": "remote server Id", "example": "56a32849-aafb-4703-8887-ba64c0394835" }, "username": { "type": "string", "description": "ssh username", "example": "admin" }, "wan": { "maxLength": 32, "minLength": 3, "pattern": "(Cellular|Dialer|Ethernet|FastEthernet|FiftyGigabitEthernet|FiveGigabitEthernet|FortyGigabitEthernet|FourHundredGigE|GigabitEthernet|HundredGigE|Loopback|Multilink|Port-channel|Serial|TenGigabitEthernet|Tunnel|TwentyFiveGigE|TwentyFiveGigabitEthernet|TwoGigabitEthernet|TwoHundredGigE|Vlan|Wlan-GigabitEthernet)([0-9]*(. ?[1-9][0-9]*)*|[0-9/]+|[0-9]+/[0-9]+/[0-9]+:[0-9]+|[0-9]+/[0-9]+/[0-9]+|[0-9]+/[0-9]+|[0-9]+)", "type": "string", "description": "WAN interface name", "example": "GigabitEthernet1" } }, "description": "Device list to onboard", "$$ref": "#/components/schemas/DeviceDetails" } } }, "$$ref": "#/components/schemas/DeviceDetailsData" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Task Id": { "description": "Task Id", "value": { "parentTaskId": "sd_routing_device_onboard-6f1fafdf-3389-457e-b6a6-f756f1644efa" } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/policy/wani/recommendation/process": { "post": { "tags": [ "Wani Recommendations" ], "summary": "Apply recommendation to a centralized policy", "description": "Applies recommendations to a centralized policy ", "operationId": "applyWaniRecommendation", "parameters": [ { "name": "key", "in": "query", "description": "Key from vAnalytics to retrieve recommendation json", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "required": [ "notValidRecommendationIds", "notValidSites", "processId", "waniPolicyId" ], "type": "object", "properties": { "notValidRecommendationIds": { "type": "string", "example": "abc, xyz" }, "notValidSites": { "type": "string", "example": "200" }, "processId": { "type": "string", "example": "vsmart_policy_config-8978b772-183d-424e-b9ac-e633b8ffe516" }, "waniPolicyId": { "type": "string", "format": "uuid", "example": "083b83e4-165d-45a8-947e-ba141d9129a2" } }, "$$ref": "#/components/schemas/ApplyRecommendationRes" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/resourcepool/resource/vpn": { "get": { "tags": [ "Resource - Pool" ], "description": "Get tenant device vpn resource", "operationId": "getResources", "parameters": [ { "name": "tenantId", "in": "query", "description": "Tenant Organization Name", "required": true, "schema": { "type": "string" } }, { "name": "tenantVpn", "in": "query", "description": "Tenant Vpn Number", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Resources": { "description": "Resources", "value": { "resourcePoolDataType": "vpn", "tenantId": "Tenant Organization Name", "tenantVpn": 2, "deviceVpn": 1 } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "Resource - Pool" ], "description": "Delete tenant device vpn and release the resource", "operationId": "deleteResources", "parameters": [ { "name": "tenantId", "in": "query", "description": "Tenant Organization Name", "required": true, "schema": { "type": "string" } }, { "name": "tenantVpn", "in": "query", "description": "Tenant Vpn Number", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "Resource - Pool" ], "description": "Create Vpn resource pool and return tenant device vpn", "operationId": "createResources", "requestBody": { "description": "create resources from resource pool", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Resources": { "description": "Resources", "value": "{\n \"resourcePoolDataType\": \"vpn\",\n \"tenantId\": \"Tenant Organization Name\",\n \"tenantVpn\": 2,\n} " } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Resources": { "description": "Resources", "value": { "resourcePoolDataType": "vpn", "tenantId": "Tenant Organization Name", "tenantVpn": 2, "deviceVpn": 1 } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/restore/import": { "post": { "tags": [ "Scheduled Backup Restore" ], "description": "Submit a previously backed up file and import the data and apply it to the configuraion database", "operationId": "importScheduledBackup", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Task status": { "description": "Task status", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/restore/remoteimport": { "post": { "tags": [ "Scheduled Backup Restore" ], "description": "Remote import backup from a remote URL and import the data and apply it to the configuraion database", "operationId": "remoteImportBackup", "requestBody": { "description": "ImportBackupInfo Payload", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "ImportBackupInfo Payload": { "description": "ImportBackupInfo Payload", "value": { "importName": "import 20.15 vmanage release", "srcHost": "10.0.105.32", "description": "optional description here", "backupSrcUrl": "https://10.0.105.32:8443/scheduled/backupdata/ondemand_f34d0b2f-a079-40ce-b2f5-192d068bd136_070220-234236.tar.gz", "user": "admin", "password": "password" } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Task status": { "description": "Task status", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/schedule/create": { "post": { "tags": [ "Scheduled Backup Restore" ], "description": "create backup scheduler config-db and statstics database with startDateTime and persist to config-db", "operationId": "scheduleBackup", "requestBody": { "description": "schedule request information", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Stats setting": { "description": "Stats setting", "value": { "scheduleName": "testScheduleName", "destination": { "backupDest": "local", "vmVersion": "20.15", "backupDir": "/backup", "backupTTLInDays": 20, "backupStorageInGB": 30, "numOfReplica": 1 }, "status": "ACTIVE", "startDateTime": 1709032922321, "endDateTime": 1709464622321, "backupDurationInHour": 5, "backup_storage": 300, "retryCount": 3, "numOfReplica": 2 } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Task status": { "description": "Task status", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/schedule/list": { "get": { "tags": [ "Scheduled Backup Restore" ], "description": "Get a schedule record for backup by scheduler id", "operationId": "listSchedules", "parameters": [ { "name": "limit", "in": "query", "description": "size", "schema": { "minimum": 1, "type": "integer", "format": "int64", "default": 100 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Get backup schedule ": { "description": "Get backup schedule ", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/schedule/{schedulerId}": { "get": { "tags": [ "Scheduled Backup Restore" ], "description": "Get a schedule record for backup by scheduler id", "operationId": "getScheduleRecordForBackup", "parameters": [ { "name": "schedulerId", "in": "path", "description": "scheduler id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Get backup schedule ": { "description": "Get backup schedule ", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "Scheduled Backup Restore" ], "description": "Delete a schedule record for backup in vManage by scheduler id", "operationId": "deleteSchedule", "parameters": [ { "name": "schedulerId", "in": "path", "description": "scheduler id", "required": true, "schema": { "pattern": "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}", "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Delete backup scheduler job ": { "description": "Delete backup scheduler job ", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/sdavc/cloud-sourced": { "get": { "tags": [ "Cloud Sourced Application Maintenance" ], "description": "returns all cloud sourced application", "operationId": "getExtendedApplications", "parameters": [ { "name": "offset", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "sortBy", "in": "query", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "schema": { "type": "string" } }, { "name": "applicationFamily", "in": "query", "schema": { "type": "string" } }, { "name": "applicationGroup", "in": "query", "schema": { "type": "string" } }, { "name": "trafficClass", "in": "query", "schema": { "type": "string" } }, { "name": "businessRelevance", "in": "query", "schema": { "type": "string" } }, { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "appName", "in": "query", "schema": { "type": "string" } }, { "name": "source", "in": "query", "schema": { "type": "string" } }, { "name": "searchKeyword", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "All cloud sourced applications", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32", "example": 1 }, "data": { "type": "array", "items": { "type": "object", "properties": { "L3L4": { "type": "array", "items": { "type": "object", "properties": { "clearIndex": { "type": "integer", "format": "int32", "example": 0 }, "ipAddresses": { "type": "array", "example": "10.1.1.1", "items": { "type": "string", "example": "10.1.1.1" } }, "l4Protocol": { "type": "string", "example": "TCP" }, "ports": { "type": "array", "example": 80, "items": { "type": "integer", "format": "int32", "example": 80 } } }, "$$ref": "#/components/schemas/L3L4" } }, "appName": { "type": "string", "example": "nordvpn" }, "applicationFamily": { "type": "string", "example": "other" }, "applicationGroup": { "type": "string", "example": "other" }, "businessRelevance": { "type": "string", "example": "business-irrelevant" }, "cloud-sourced": { "type": "string" }, "commonName": { "type": "string", "example": "nordvpn" }, "id": { "type": "string", "example": "6567" }, "serverNames": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "example": "nord-apps.com" } }, "$$ref": "#/components/schemas/ServerName" } }, "sourceCategory": { "type": "string", "example": "SaaS" }, "status": { "type": "string", "example": "new" }, "trafficClass": { "type": "string", "example": "transactional-data" }, "uuid": { "type": "string", "example": "16e37dfb-2538-4f19-be5b-88fe99ae4c4e" } }, "$$ref": "#/components/schemas/ApplicationDetails" } }, "lastUpdateOn": { "type": "integer", "format": "int64", "example": 4233672632786387 } }, "$$ref": "#/components/schemas/GetExtendedApplicationResponse" } } } }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "Cloud Sourced Application Maintenance" ], "operationId": "saveExtendedApplications", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "appName": { "type": "string", "example": "nordvpn" } }, "$$ref": "#/components/schemas/ApplicationRequestDetails" } }, "selectAll": { "type": "boolean", "example": false }, "updateNetwork": { "type": "boolean", "example": false } }, "$$ref": "#/components/schemas/SaveExtendedApplicationRequest" } } }, "required": true }, "responses": { "200": { "description": "success response message", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "request processed successfully" }, "success": { "type": "boolean", "example": true } }, "$$ref": "#/components/schemas/DefaultSuccessResponse" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" } } } }, "/sdavc/cloud-sourced/apply/status/{uuid}": { "get": { "tags": [ "Cloud Sourced Application Maintenance" ], "description": "Get cloud sourced apply task status", "operationId": "getDeviceComplianceStatus_CloudSourcedApplicationMaintenance_4003", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Scheduled Response": { "description": "Scheduled Response", "value": { "uuid": "2f48cc13-a19e-4d62-8273-ea25896a6ecc", "status": "scheduled", "message": "Task scheduled" } }, "In Progress Response": { "description": "In Progress Response", "value": { "uuid": "2f48cc13-a19e-4d62-8273-ea25896a6ecc", "status": "in_progress", "message": "Task is in progress" } }, "Success Response": { "description": "Success Response", "value": { "uuid": "2f48cc13-a19e-4d62-8273-ea25896a6ecc", "status": "success", "message": "Success" } }, "Failure Response": { "description": "Failure Response", "value": { "uuid": "2f48cc13-a19e-4d62-8273-ea25896a6ecc", "status": "failure", "message": "Task Failed" } }, "Not Started Response": { "description": "Not Started Response", "value": { "uuid": "2f48cc13-a19e-4d62-8273-ea25896a6ecc", "status": "not_started", "message": "The task has not started yet" } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "500 - Internal Server Error": { "description": "500 - Internal Server Error", "value": { "error": { "message": "", "code": "PP0018", "details": "" } } } } } } } } } }, "/sdavc/cloud-sourced/approve": { "post": { "tags": [ "Cloud Sourced Application Maintenance" ], "operationId": "approveExtendedApplications", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "appName": { "type": "string", "example": "nordvpn" } }, "$$ref": "#/components/schemas/ApplicationRequestDetails" } }, "selectAll": { "type": "boolean", "example": false } }, "$$ref": "#/components/schemas/ExtendedApplicationRequestData" } } }, "required": true }, "responses": { "200": { "description": "success response message", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "request processed successfully" }, "success": { "type": "boolean", "example": true } }, "$$ref": "#/components/schemas/DefaultSuccessResponse" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" } } } }, "/sdavc/cloud-sourced/compliance": { "post": { "tags": [ "Cloud Sourced Application Compliance" ], "operationId": "complianceWithExtendedApplications", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "appName": { "type": "string", "example": "nordvpn" } }, "$$ref": "#/components/schemas/ApplicationRequestDetails" } }, "selectAll": { "type": "boolean", "example": false } }, "$$ref": "#/components/schemas/ExtendedApplicationRequestData" } } }, "required": true }, "responses": { "200": { "description": "all policy compliance data with selected cloud sourced apps", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32", "example": 1 }, "data": { "type": "array", "items": { "type": "object", "properties": { "appList": { "type": "object", "properties": { "createdBy": { "type": "string", "example": "admin" }, "id": { "type": "string", "example": "c8a4164a-4778-4a7e-8d93-45f78f387010" }, "name": { "type": "string", "example": "my_app_list" }, "type": { "type": "string", "example": "app-list" }, "version": { "type": "string", "example": "UX 2.0" } }, "$$ref": "#/components/schemas/AppListDetails" }, "applications": { "type": "array", "items": { "type": "object", "properties": { "newApplications": { "type": "array", "items": { "type": "string" } }, "oldApplications": { "type": "array", "items": { "type": "string" } } }, "$$ref": "#/components/schemas/PolicyComplianceApplications" } }, "policy": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "c8a4164a-4778-4a7e-8d93-45f78f387011" }, "name": { "type": "string", "example": "policy1" }, "type": { "type": "string", "example": "security" }, "version": { "type": "string", "example": "UX 2.0" } }, "$$ref": "#/components/schemas/PolicyDetails" } } }, "$$ref": "#/components/schemas/PolicyComplianceDetails" } } }, "$$ref": "#/components/schemas/PolicyComplianceResponse" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" } } } }, "/sdavc/cloud-sourced/compliance/application": { "post": { "tags": [ "Cloud Sourced Application Compliance" ], "operationId": "applicationComplianceWithExtendedApplications", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "appName": { "type": "string", "example": "nordvpn" } }, "$$ref": "#/components/schemas/ApplicationRequestDetails" } }, "selectAll": { "type": "boolean", "example": false } }, "$$ref": "#/components/schemas/ExtendedApplicationRequestData" } } }, "required": true }, "responses": { "200": { "description": "all policy compliance data with selected cloud sourced apps", "content": { "application/json": { "schema": { "type": "object", "properties": { "applicationLists": { "uniqueItems": true, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "policies": { "uniqueItems": true, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" } }, "$$ref": "#/components/schemas/Policy" } }, "type": { "type": "string" } }, "$$ref": "#/components/schemas/ApplicationList" } }, "id": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" } }, "$$ref": "#/components/schemas/Application" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" } } } }, "/sdavc/cloudconnector": { "put": { "tags": [ "SD AVC Cloud Connector" ], "description": "Disable SD_AVC Cloud Connector", "operationId": "disableCloudConnector", "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": { "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": "Template Deploy-read,Template Deploy-write,Policy Configuration-read,Policy Configuration-write,Policy Deploy-read,Policy Deploy-write" }, "get": { "tags": [ "SD AVC Cloud Connector" ], "description": "Get SD_AVC Cloud Connector Config", "operationId": "getCloudConnector", "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": "Template Deploy-read,Template Deploy-write,Policy Configuration-read,Policy Configuration-write,Policy Deploy-read,Policy Deploy-write" }, "post": { "tags": [ "SD AVC Cloud Connector" ], "description": "Enable SD_AVC Cloud Connector", "operationId": "enableCloudConnector", "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": { "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": "Template Deploy-read,Template Deploy-write,Policy Configuration-read,Policy Configuration-write,Policy Deploy-read,Policy Deploy-write" } }, "/sdavc/cloudconnector/status": { "get": { "tags": [ "SD AVC Cloud Connector" ], "description": "Get SD_AVC Cloud Connector Status", "operationId": "getCloudConnectorStatus", "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": "Template Deploy-read,Template Deploy-write,Policy Configuration-read,Policy Configuration-write,Policy Deploy-read,Policy Deploy-write" } }, "/sdavc/customapps": { "get": { "tags": [ "System - Container" ], "description": "Displays the user-defined applications", "operationId": "getCustomApp", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "Custom applications": { "description": "Custom applications", "value": [] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Template Deploy-read,Template Deploy-write,Policy Configuration-read,Policy Configuration-write,Policy Deploy-read,Policy Deploy-write" } }, "/sdavc/protocol-pack": { "get": { "tags": [ "Protocol Pack Maintenance" ], "description": "Get all protocol packs details", "operationId": "getAllProtocolPacks", "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Response": { "description": "Response", "value": [ { "file-name": "pp-adv-cat8k-179.1a-46-64.0.0.pack", "version": "64.0.0", "device-version": "179.1a", "nbar-engine-version": "46", "device-model": "cat8k", "license-type": "adv", "is-latest": false, "is-upload-confirmed-by-user": true, "numeric-version": 64, "uploaded-by-user-name": "system-uploaded", "system-pack-type": "base", "upload-source": "system-uploaded", "last-updated-time": 1706824339984, "created-time": 1706293228793, "upload-confirmed-time": 1706293228847 }, { "file-name": "pp-adv-cat8k-1712.1a-49-68.0.0.pack", "version": "68.0.0", "device-version": "1712.1a", "nbar-engine-version": "49", "device-model": "cat8k", "license-type": "adv", "is-latest": true, "is-upload-confirmed-by-user": true, "numeric-version": 68, "uploaded-by-user-name": "system-uploaded", "system-pack-type": "default", "upload-source": "system-uploaded", "last-updated-time": 1706824341120, "created-time": 1706293230093, "upload-confirmed-time": 1706293230158 }, { "file-name": "pp-adv-cat8k-179.1a-46-68.0.0.pack", "version": "68.0.0", "device-version": "179.1a", "nbar-engine-version": "46", "device-model": "cat8k", "license-type": "adv", "is-latest": true, "is-upload-confirmed-by-user": true, "numeric-version": 68, "uploaded-by-user-name": "system-uploaded", "system-pack-type": "default", "upload-source": "system-uploaded", "last-updated-time": 1706824343168, "created-time": 1706293231384, "upload-confirmed-time": 1706293231430 } ] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/sdavc/protocol-pack/base": { "get": { "tags": [ "Protocol Pack Maintenance" ], "description": "Get all base protocol pack details", "operationId": "getBaseSystemPack", "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Response": { "description": "Response", "value": [ { "file-name": "pp-adv-cat8k-179.1a-46-64.0.0.pack", "version": "64.0.0", "device-version": "179.1a", "nbar-engine-version": "46", "device-model": "cat8k", "license-type": "adv", "is-latest": false, "is-upload-confirmed-by-user": true, "numeric-version": 64, "uploaded-by-user-name": "system-uploaded", "system-pack-type": "base", "upload-source": "system-uploaded", "last-updated-time": 1706824339984, "created-time": 1706293228793, "upload-confirmed-time": 1706293228847 } ] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "500 - Internal Error": { "description": "500 - Internal Error", "value": { "error": { "message": "", "code": "PP0006", "details": "" } } } } } } } } } }, "/sdavc/protocol-pack/compliance/all-devices": { "get": { "tags": [ "Protocol Pack Compliance" ], "description": "Get all device compliance details", "operationId": "getAllSDAVCDevice", "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Response": { "description": "Response", "value": { "devices": [ { "uuid": "C8K-3657252c-96a4-4e4c-8860-270dec1f07d7", "hostName": "vm1", "siteId": "100", "systemIp": "172.16.255.11", "deviceModel": "vedge-C8000V", "softwareVersion": "17.12.03.0.3419", "currentProtocolPackVersion": 68, "currentProtocolPackName": "pp-adv-cat8k-1712.1a-49-68.0.0.pack", "lastUpgradeStatus": "Success", "lastUpgradeStatusMessage": null, "isCompatible": true, "isAVCEnabled": true, "isDeviceReachable": true } ], "count": 1 } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/sdavc/protocol-pack/compliance/application": { "get": { "tags": [ "Protocol Pack Compliance" ], "description": "Get default application name compliance details", "operationId": "getDefaultApplicationComplianceDetails", "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Empty Response": { "description": "Empty Response", "value": [] }, "Application Name Compliance": { "description": "Application Name Compliance", "value": [ { "id": "18f77d59-d79d-4529-9030-a78fd8c9b666", "name": "rhapsody", "type": "inBuiltApps", "applicationLists": [ { "id": "1c03f3d3-fa3a-40e1-8036-30b7a4c78e82", "name": "ux_1_0_sec_app_list_3", "type": "localApp", "policies": [ { "id": "40df04c6-b141-4a08-8424-a6f87ace50e2", "name": "ux_1_0_sec_pol_3", "type": "security-policy" }, { "id": "987e7cd3-b5e6-4dc9-8a49-45b462252985", "name": "ux_1_0_unified_sec_pol_1", "type": "security-policy" } ] }, { "id": "dd6cc450-8d47-43d3-8dc5-0f8ef1b2a760", "name": "ux_1_0_aar_app_list_4", "type": "app", "policies": [] } ] }, { "id": "a4c55d06-2390-4e73-9706-dec5df977567", "name": "ipcd", "type": "inBuiltApps", "applicationLists": [] } ] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "500 - Internal Error": { "description": "500 - Internal Error", "value": { "error": { "message": "", "code": "PP0016", "details": "" } } } } } } } } } }, "/sdavc/protocol-pack/compliance/application/initiate-compliance": { "post": { "tags": [ "Protocol Pack Compliance" ], "description": "Initiate application name compliance task", "operationId": "initiateApplicationComplianceCheck", "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Task Scheduled Response": { "description": "Task Scheduled Response", "value": { "uuid": "e4f18388-8ce8-41c3-be0e-3cf867caf17c", "status": "scheduled", "message": "Task scheduled" } }, "Task In Progress Response": { "description": "Task In Progress Response", "value": { "uuid": "e4f18388-8ce8-41c3-be0e-3cf867caf17c", "status": "in_progress", "message": "Task is in progress" } }, "Task Success Response": { "description": "Task Success Response", "value": { "uuid": "e4f18388-8ce8-41c3-be0e-3cf867caf17c", "status": "success", "message": "Success" } }, "Task Failed Response": { "description": "Task Failed Response", "value": { "uuid": "e4f18388-8ce8-41c3-be0e-3cf867caf17c", "status": "failure", "message": "Task Failed" } }, "Not Started Response": { "description": "Not Started Response", "value": { "uuid": "e4f18388-8ce8-41c3-be0e-3cf867caf17c", "status": "not_started", "message": "The task has not started yet" } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "500 - Internal Error": { "description": "500 - Internal Error", "value": { "error": { "message": "", "code": "PP0017", "details": "" } } } } } } } } } }, "/sdavc/protocol-pack/compliance/application/is-compliance-detected": { "get": { "tags": [ "Protocol Pack Compliance" ], "description": "Check if there is any Application Compliance detected in the system", "operationId": "isApplicationComplianceDetected", "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "If Compliance Detected": { "description": "If Compliance Detected", "value": { "complianceDetected": true } }, "If Compliance Not Detected": { "description": "If Compliance Not Detected", "value": { "complianceDetected": false } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "500 - Internal Error": { "description": "500 - Internal Error", "value": { "error": { "message": "", "code": "PP0016", "details": "" } } } } } } } } } }, "/sdavc/protocol-pack/compliance/application/status/{uuid}": { "get": { "tags": [ "Protocol Pack Compliance" ], "description": "Get application name compliance task status", "operationId": "getApplicationComplianceStatus", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Scheduled Response": { "description": "Scheduled Response", "value": { "uuid": "2f48cc13-a19e-4d62-8273-ea25896a6ecc", "status": "scheduled", "message": "Task scheduled" } }, "In Progress Response": { "description": "In Progress Response", "value": { "uuid": "2f48cc13-a19e-4d62-8273-ea25896a6ecc", "status": "in_progress", "message": "Task is in progress" } }, "Success Response": { "description": "Success Response", "value": { "uuid": "2f48cc13-a19e-4d62-8273-ea25896a6ecc", "status": "success", "message": "Success" } }, "Failure Response": { "description": "Failure Response", "value": { "uuid": "2f48cc13-a19e-4d62-8273-ea25896a6ecc", "status": "failure", "message": "Task Failed" } }, "Not Started Response": { "description": "Not Started Response", "value": { "uuid": "2f48cc13-a19e-4d62-8273-ea25896a6ecc", "status": "not_started", "message": "The task has not started yet" } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "500 - Internal Error": { "description": "500 - Internal Error", "value": { "error": { "message": "", "code": "PP0016", "details": "" } } } } } } } } } }, "/sdavc/protocol-pack/compliance/application/{uuid}": { "get": { "tags": [ "Protocol Pack Compliance" ], "description": "Get application name compliance details for given task uuid", "operationId": "getApplicationComplianceDetails", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Empty Response": { "description": "Empty Response", "value": [] }, "Application Name Compliance": { "description": "Application Name Compliance", "value": [ { "id": "18f77d59-d79d-4529-9030-a78fd8c9b666", "name": "rhapsody", "type": "inBuiltApps", "applicationLists": [ { "id": "1c03f3d3-fa3a-40e1-8036-30b7a4c78e82", "name": "ux_1_0_sec_app_list_3", "type": "localApp", "policies": [ { "id": "40df04c6-b141-4a08-8424-a6f87ace50e2", "name": "ux_1_0_sec_pol_3", "type": "security-policy" }, { "id": "987e7cd3-b5e6-4dc9-8a49-45b462252985", "name": "ux_1_0_unified_sec_pol_1", "type": "security-policy" } ] }, { "id": "dd6cc450-8d47-43d3-8dc5-0f8ef1b2a760", "name": "ux_1_0_aar_app_list_4", "type": "app", "policies": [] } ] }, { "id": "a4c55d06-2390-4e73-9706-dec5df977567", "name": "ipcd", "type": "inBuiltApps", "applicationLists": [] } ] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "500 - Internal Error": { "description": "500 - Internal Error", "value": { "error": { "message": "", "code": "PP0016", "details": "" } } } } } } } } } }, "/sdavc/protocol-pack/compliance/custom-application": { "get": { "tags": [ "Protocol Pack Compliance" ], "description": "Get All Custom Applications", "operationId": "getCustomApplicationList", "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Response": { "description": "Response", "value": { "applications": [ { "applicationName": "custom-app-1", "applicationNumericId": "2502", "applicationSDAVCId": null }, { "applicationName": "custom-app-2", "applicationNumericId": "3547", "applicationSDAVCId": null }, { "applicationName": "custom-app-3", "applicationNumericId": "3658", "applicationSDAVCId": null } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "500 - Internal Error": { "description": "500 - Internal Error", "value": { "error": { "message": "", "code": "PP0014", "details": "" } } } } } } } } } }, "/sdavc/protocol-pack/compliance/device/noncompliant": { "post": { "tags": [ "Protocol Pack Compliance" ], "description": "Get all non compliant devices for given protocol pack and selected device or entire network", "operationId": "getNonCompliantDevicesForProtocolPack_ProtocolPackCompliance_5104", "requestBody": { "description": "Request Payload", "content": { "application/json": { "schema": { "type": "object", "properties": { "devices": { "type": "array", "items": { "type": "string" } }, "protocolPackName": { "type": "string" } }, "$$ref": "#/components/schemas/CompliantDeviceRequest" }, "examples": { "All Devices and selective protocol pack": { "description": "All Devices and selective protocol pack", "value": { "devices": [], "protocolPackName": "pp-adv-cat8k-1712.1a-49-68.0.0.pack" } }, "All Devices and Default Protocol Pack": { "description": "All Devices and Default Protocol Pack", "value": { "devices": [], "protocolPackName": null } }, "Selective Devices and Selective Protocol Pack": { "description": "Selective Devices and Selective Protocol Pack", "value": { "devices": [ "172.16.255.11", "172.16.255.12" ], "protocolPackName": "pp-adv-cat8k-1712.1a-49-68.0.0.pack" } }, "Selective Devices and Default Protocol Pack": { "description": "Selective Devices and Default Protocol Pack", "value": { "devices": [ "172.16.255.11", "172.16.255.12" ], "protocolPackName": null } } } } }, "required": true }, "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Response": { "description": "Response", "value": { "devices": [ { "uuid": "C8K-3657252c-96a4-4e4c-8860-270dec1f07d7", "hostName": "vm1", "siteId": "100", "systemIp": "172.16.255.11", "deviceModel": "vedge-C8000V", "softwareVersion": "17.12.03.0.3419", "currentProtocolPackVersion": 68, "currentProtocolPackName": "pp-adv-cat8k-1712.1a-49-68.0.0.pack", "lastUpgradeStatus": "Success", "lastUpgradeStatusMessage": null, "isCompatible": true, "isAVCEnabled": true, "isDeviceReachable": true } ], "count": 1 } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "500 - Internal Server Error": { "description": "500 - Internal Server Error", "value": { "error": { "message": "", "code": "PP0015", "details": "" } } } } } } } } } }, "/sdavc/protocol-pack/compliance/device/noncompliant/{protocolPackName}": { "get": { "tags": [ "Protocol Pack Compliance" ], "description": "Get all non compliant devices for given protocol pack", "operationId": "getNonCompliantDevicesForProtocolPack_ProtocolPackCompliance_7003", "parameters": [ { "name": "protocolPackName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Response": { "description": "Response", "value": { "devices": [ { "uuid": "C8K-3657252c-96a4-4e4c-8860-270dec1f07d7", "hostName": "vm1", "siteId": "100", "systemIp": "172.16.255.11", "deviceModel": "vedge-C8000V", "softwareVersion": "17.12.03.0.3419", "currentProtocolPackVersion": 68, "currentProtocolPackName": "pp-adv-cat8k-1712.1a-49-68.0.0.pack", "lastUpgradeStatus": "Success", "lastUpgradeStatusMessage": null, "isCompatible": true, "isAVCEnabled": true, "isDeviceReachable": true } ], "count": 1 } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "500 - Internal Server Error": { "description": "500 - Internal Server Error", "value": { "error": { "message": "", "code": "PP0015", "details": "" } } } } } } } } } }, "/sdavc/protocol-pack/compliance/device/status/{uuid}": { "get": { "tags": [ "Protocol Pack Compliance" ], "description": "Get device compliance task status", "operationId": "getDeviceComplianceStatus_ProtocolPackCompliance_5203", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Scheduled Response": { "description": "Scheduled Response", "value": { "uuid": "2f48cc13-a19e-4d62-8273-ea25896a6ecc", "status": "scheduled", "message": "Task scheduled" } }, "In Progress Response": { "description": "In Progress Response", "value": { "uuid": "2f48cc13-a19e-4d62-8273-ea25896a6ecc", "status": "in_progress", "message": "Task is in progress" } }, "Success Response": { "description": "Success Response", "value": { "uuid": "2f48cc13-a19e-4d62-8273-ea25896a6ecc", "status": "success", "message": "Success" } }, "Failure Response": { "description": "Failure Response", "value": { "uuid": "2f48cc13-a19e-4d62-8273-ea25896a6ecc", "status": "failure", "message": "Task Failed" } }, "Not Started Response": { "description": "Not Started Response", "value": { "uuid": "2f48cc13-a19e-4d62-8273-ea25896a6ecc", "status": "not_started", "message": "The task has not started yet" } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "500 - Internal Server Error": { "description": "500 - Internal Server Error", "value": { "error": { "message": "", "code": "PP0010", "details": "" } } } } } } } } } }, "/sdavc/protocol-pack/compliance/initiate-device-compliance": { "post": { "tags": [ "Protocol Pack Compliance" ], "description": "Initiate device compliance task", "operationId": "initiateDeviceCompliance", "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Response": { "description": "Response", "value": { "taskExtraKey": "vIPtela Inc Regression", "uuid": "4840d575-25bf-4d05-9f44-017854e4457b", "status": "scheduled", "taskId": "sdavc_check_device_compliance-4840d575-25bf-4d05-9f44-017854e4457b", "message": "Check Device Compliances initiated for : vIPtela Inc Regression", "protocolPackName": "vIPtela Inc Regression" } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "500 - Internal Error": { "description": "500 - Internal Error", "value": { "error": { "message": "", "code": "PP0012", "details": "" } } } } } } } } } }, "/sdavc/protocol-pack/compliance/initiate-policy-compliance": { "post": { "tags": [ "Protocol Pack Compliance" ], "description": "Initiate policy compliance task", "operationId": "initiatePolicyCompliance", "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Response": { "description": "Response", "value": { "taskExtraKey": "68.0.0", "uuid": "860f1d98-2ede-4ff4-ae84-f6192d1aa2ac", "status": "scheduled", "taskId": "sdavc_check_policy_compliance-860f1d98-2ede-4ff4-ae84-f6192d1aa2ac", "message": "Check Policy Compliances initiated for : 68.0.0", "protocolPackName": "pp-adv-cat8k-179.1a-46-68.0.0.pack", "protocolPackVersion": "68.0.0", "initial-task-delay-in-second": 0 } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "500 - Internal Error": { "description": "500 - Internal Error", "value": { "error": { "message": "", "code": "PP0011", "details": "" } } } } } } } } } }, "/sdavc/protocol-pack/compliance/new-application/{deviceUUID}": { "get": { "tags": [ "Protocol Pack Compliance" ], "description": "Get New Application List for given Device UUID", "operationId": "getNewApplicationList", "parameters": [ { "name": "deviceUUID", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Response": { "description": "Response", "value": { "applications": [ { "applicationName": "ms-wudo", "applicationNumericId": "1304", "applicationSDAVCId": "13:1304" }, { "applicationName": "cisco-thousandeyes", "applicationNumericId": "1298", "applicationSDAVCId": "13:1298" }, { "applicationName": "kafka", "applicationNumericId": "1297", "applicationSDAVCId": "13:1297" }, { "applicationName": "code42-services", "applicationNumericId": "1301", "applicationSDAVCId": "13:1301" }, { "applicationName": "panasonic-ip-camera", "applicationNumericId": "1299", "applicationSDAVCId": "13:1299" }, { "applicationName": "telegram", "applicationNumericId": "1300", "applicationSDAVCId": "13:1300" }, { "applicationName": "mndp", "applicationNumericId": "1308", "applicationSDAVCId": "13:1308" }, { "applicationName": "ms-intune", "applicationNumericId": "1303", "applicationSDAVCId": "13:1303" }, { "applicationName": "ms-diagnostics", "applicationNumericId": "1302", "applicationSDAVCId": "13:1302" }, { "applicationName": "discord", "applicationNumericId": "1305", "applicationSDAVCId": "13:1305" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "500 - Internal Error": { "description": "500 - Internal Error", "value": { "error": { "message": "", "code": "PP0014", "details": "" } } } } } } } } } }, "/sdavc/protocol-pack/compliance/policy": { "get": { "tags": [ "Protocol Pack Compliance" ], "description": "Get all policy compliance details", "operationId": "getCompliancePolicy", "parameters": [ { "name": "offset", "in": "query", "description": "Starting position of records", "schema": { "type": "integer", "format": "int64" } }, { "name": "limit", "in": "query", "description": "Total records to query after offset", "schema": { "type": "integer", "format": "int64" } }, { "name": "protocolPackName", "in": "query", "description": "Protocol pack name", "schema": { "type": "string" } }, { "name": "oldApplicationSource", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Scheduled Response": { "description": "Scheduled Response", "value": { "data": [ { "appList": { "id": "7304764c-7741-4336-8def-451b173a8f21", "name": "app_fam", "createdBy": "createdBy", "version": "UX 2.0", "type": "app-list" }, "applications": [ { "oldApplications": [ "google-services" ], "newApplications": [ "google-translate", "google-maps" ] }, { "oldApplications": [ "ms-wudo" ], "newApplications": [ "ms-wudo-app-1" ] }, { "oldApplications": [ "http" ], "newApplications": [ "" ] }, { "oldApplications": [ "https" ], "newApplications": [ "" ] } ], "policy": [ { "id": "c4feefed-ef30-4d1c-82f2-702b5bc174e4", "name": "PG_bug", "version": "UX 2.0" }, { "id": "32f4c05c-d6db-4423-b7e1-cb9dcc87de5f", "name": "PG2", "version": "UX 2.0" } ], "updatedAt": 1706800337447 } ], "count": 1 } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "500 - Internal Server Error": { "description": "500 - Internal Server Error", "value": { "error": { "message": "", "code": "PP0013", "details": "" } } } } } } } } } }, "/sdavc/protocol-pack/compliance/policy/status/{uuid}": { "get": { "tags": [ "Protocol Pack Compliance" ], "description": "Get policy compliance status", "operationId": "getPolicyComplianceStatus", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Scheduled Response": { "description": "Scheduled Response", "value": { "uuid": "2f48cc13-a19e-4d62-8273-ea25896a6ecc", "status": "scheduled", "message": "Task scheduled" } }, "In Progress Response": { "description": "In Progress Response", "value": { "uuid": "2f48cc13-a19e-4d62-8273-ea25896a6ecc", "status": "in_progress", "message": "Task is in progress" } }, "Success Response": { "description": "Success Response", "value": { "uuid": "2f48cc13-a19e-4d62-8273-ea25896a6ecc", "status": "success", "message": "Success" } }, "Failure Response": { "description": "Failure Response", "value": { "uuid": "2f48cc13-a19e-4d62-8273-ea25896a6ecc", "status": "failure", "message": "Task Failed" } }, "Not Started Response": { "description": "Not Started Response", "value": { "uuid": "2f48cc13-a19e-4d62-8273-ea25896a6ecc", "status": "not_started", "message": "The task has not started yet" } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "500 - Internal Server Error": { "description": "500 - Internal Server Error", "value": { "error": { "message": "", "code": "PP0009", "details": "" } } } } } } } } } }, "/sdavc/protocol-pack/default": { "get": { "tags": [ "Protocol Pack Maintenance" ], "description": "Get all default protocol pack details", "operationId": "getDefaultSystemPack", "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Response": { "description": "Response", "value": [ { "file-name": "pp-adv-cat8k-1712.1a-49-68.0.0.pack", "version": "68.0.0", "device-version": "1712.1a", "nbar-engine-version": "49", "device-model": "cat8k", "license-type": "adv", "is-latest": true, "is-upload-confirmed-by-user": true, "numeric-version": 68, "uploaded-by-user-name": "system-uploaded", "system-pack-type": "default", "upload-source": "system-uploaded", "last-updated-time": 1706824341120, "created-time": 1706293230093, "upload-confirmed-time": 1706293230158 }, { "file-name": "pp-adv-cat8k-179.1a-46-68.0.0.pack", "version": "68.0.0", "device-version": "179.1a", "nbar-engine-version": "46", "device-model": "cat8k", "license-type": "adv", "is-latest": true, "is-upload-confirmed-by-user": true, "numeric-version": 68, "uploaded-by-user-name": "system-uploaded", "system-pack-type": "default", "upload-source": "system-uploaded", "last-updated-time": 1706824343168, "created-time": 1706293231384, "upload-confirmed-time": 1706293231430 } ] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "500 - Internal Error": { "description": "500 - Internal Error", "value": { "error": { "message": "", "code": "PP0006", "details": "" } } } } } } } } } }, "/sdavc/protocol-pack/latest": { "get": { "tags": [ "Protocol Pack Maintenance" ], "description": "Get current latest protocol pack details", "operationId": "getLatestSystemPack", "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Response": { "description": "Response", "value": { "file-name": "pp-adv-cat8k-179.1a-46-68.0.0.pack", "version": "68.0.0", "device-version": "179.1a", "nbar-engine-version": "46", "device-model": "cat8k", "license-type": "adv", "is-latest": true, "is-upload-confirmed-by-user": true, "numeric-version": 68, "uploaded-by-user-name": "system-uploaded", "system-pack-type": "default", "upload-source": "system-uploaded", "last-updated-time": 1706824343168, "created-time": 1706293231384, "upload-confirmed-time": 1706293231430 } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "500 - Internal Error": { "description": "500 - Internal Error", "value": { "error": { "message": "", "code": "PP0006", "details": "" } } } } } } } } } }, "/sdavc/protocol-pack/maintenance/upgrade": { "post": { "tags": [ "Protocol Pack Maintenance" ], "description": "Deploy protocol pack to devices", "operationId": "upgradeProtocolPack", "requestBody": { "description": "Request Payload", "content": { "application/json": { "schema": { "type": "object", "properties": { "autoUpgradeInCompatibleDevices": { "type": "boolean" }, "deviceSelectionType": { "type": "string", "enum": [ "entire-network", "selected-devices" ] }, "devices": { "type": "array", "items": { "type": "string" } }, "executionType": { "type": "string", "enum": [ "now", "later" ] }, "protocolPackType": { "type": "string", "enum": [ "selected-protocol-pack", "default-protocol-pack", "built-in-protocol-pack" ] }, "protocolPacks": { "type": "array", "items": { "type": "string" } }, "scheduleTime": { "type": "integer", "format": "int64" } }, "$$ref": "#/components/schemas/ProtocolPackUpgradeRequest" }, "examples": { "Selected Devices, selective protocol pack, scheduled now": { "description": "Selected Devices, selective protocol pack, scheduled now", "value": { "deviceSelectionType": "selected-devices", "scheduleTime": 0, "devices": [ "172.16.255.11" ], "executionType": "now", "protocolPacks": [ "pp-adv-cat8k-1712.1a-49-68.0.0.pack" ], "protocolPackType": "selected-protocol-pack" } }, "Selected Devices, default protocol pack, scheduled now": { "description": "Selected Devices, default protocol pack, scheduled now", "value": { "deviceSelectionType": "selected-devices", "scheduleTime": 0, "devices": [ "172.16.255.11" ], "executionType": "now", "protocolPacks": [], "protocolPackType": "default-protocol-pack" } }, "Selected Devices, built-in protocol pack, scheduled now": { "description": "Selected Devices, built-in protocol pack, scheduled now", "value": { "deviceSelectionType": "selected-devices", "scheduleTime": 0, "devices": [ "172.16.255.11" ], "executionType": "now", "protocolPacks": [], "protocolPackType": "built-in-protocol-pack" } }, "All Devices, selective protocol pack, scheduled now": { "description": "All Devices, selective protocol pack, scheduled now", "value": { "deviceSelectionType": "entire-network", "scheduleTime": 0, "devices": [], "executionType": "now", "protocolPacks": [ "pp-adv-cat8k-1712.1a-49-68.0.0.pack" ], "protocolPackType": "selected-protocol-pack" } }, "All Devices, default protocol pack, scheduled now": { "description": "All Devices, default protocol pack, scheduled now", "value": { "deviceSelectionType": "entire-network", "scheduleTime": 0, "devices": [], "executionType": "now", "protocolPacks": [], "protocolPackType": "default-protocol-pack" } }, "All Devices, selective protocol pack, scheduled now, with Auto Upgrade Flag Enabled": { "description": "All Devices, selective protocol pack, scheduled now, with Auto Upgrade Flag Enabled", "value": { "deviceSelectionType": "entire-network", "scheduleTime": 0, "devices": [], "executionType": "now", "autoUpgradeInCompatibleDevices": true, "protocolPacks": [ "pp-adv-cat8k-1712.1a-49-68.0.0.pack" ], "protocolPackType": "selected-protocol-pack" } }, "All Devices, selective protocol pack, scheduled now, with Auto Upgrade Flag Disabled": { "description": "All Devices, selective protocol pack, scheduled now, with Auto Upgrade Flag Disabled", "value": { "deviceSelectionType": "entire-network", "scheduleTime": 0, "devices": [], "executionType": "now", "autoUpgradeInCompatibleDevices": false, "protocolPacks": [ "pp-adv-cat8k-1712.1a-49-68.0.0.pack" ], "protocolPackType": "selected-protocol-pack" } }, "All Devices, built-in protocol pack, scheduled now": { "description": "All Devices, built-in protocol pack, scheduled now", "value": { "deviceSelectionType": "entire-network", "scheduleTime": 0, "devices": [], "executionType": "now", "protocolPacks": [], "protocolPackType": "built-in-protocol-pack" } }, "Scheduled Upgrade": { "description": "Scheduled Upgrade", "value": { "deviceSelectionType": "entire-network", "scheduleTime": 1706803770000, "devices": [], "executionType": "later", "protocolPacks": [], "protocolPackType": "default-protocol-pack" } } } } }, "required": true }, "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Response": { "description": "Response", "value": { "taskExtraKey": "vIPtela Inc Regression", "deployScheduleTime": 0, "protocolPackName": [ "pp-adv-cat8k-1712.1a-49-68.0.0.pack" ], "protocolPackNameSelectionType": "selected-protocol-pack", "uuid": "436201f9-c701-4556-8404-2adcde645d3f", "status": "scheduled", "taskId": "sdavc_deploy_protocol_pack_on_device-436201f9-c701-4556-8404-2adcde645d3f", "message": "Deploy Protocol Pack on Device initiated for : vIPtela Inc Regression", "segmentName": "vIPtela Inc Regression" } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "500 - Internal Error": { "description": "500 - Internal Error", "value": { "error": { "message": "", "code": "PP0001", "details": "" } } } } } } } } } }, "/sdavc/protocol-pack/maintenance/upgrade/cancel": { "post": { "tags": [ "Protocol Pack Maintenance" ], "description": "Cancel a Scheduled Deploy protocol pack job", "operationId": "cancelScheduledDeployJob", "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Response": { "description": "Response", "value": { "success": true, "message": "Task cancelled successfully" } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "500 - Internal Error": { "description": "500 - Internal Error", "value": { "error": { "message": "", "code": "PP0007", "details": "" } } } } } } } } } }, "/sdavc/protocol-pack/maintenance/upgrade/status": { "get": { "tags": [ "Protocol Pack Maintenance" ], "description": "Get active deploy job status", "operationId": "getDeployJobStatus_ProtocolPackMaintenance_4703", "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Scheduled Response": { "description": "Scheduled Response", "value": { "uuid": "2f48cc13-a19e-4d62-8273-ea25896a6ecc", "status": "scheduled", "message": "Task scheduled" } }, "In Progress Response": { "description": "In Progress Response", "value": { "uuid": "2f48cc13-a19e-4d62-8273-ea25896a6ecc", "status": "in_progress", "message": "Task is in progress" } }, "Success Response": { "description": "Success Response", "value": { "uuid": "2f48cc13-a19e-4d62-8273-ea25896a6ecc", "status": "success", "message": "Success" } }, "Failure Response": { "description": "Failure Response", "value": { "uuid": "2f48cc13-a19e-4d62-8273-ea25896a6ecc", "status": "failure", "message": "Task Failed" } }, "Not Started Response": { "description": "Not Started Response", "value": { "uuid": "2f48cc13-a19e-4d62-8273-ea25896a6ecc", "status": "not_started", "message": "The task has not started yet" } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "500 - Internal Error": { "description": "500 - Internal Error", "value": { "error": { "message": "", "code": "PP0008", "details": "" } } } } } } } } } }, "/sdavc/protocol-pack/maintenance/upgrade/status/{uuid}": { "get": { "tags": [ "Protocol Pack Maintenance" ], "description": "Get upgrade status for given Task UUID", "operationId": "getDeployJobStatus_ProtocolPackMaintenance_5403", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Scheduled Response": { "description": "Scheduled Response", "value": { "uuid": "2f48cc13-a19e-4d62-8273-ea25896a6ecc", "status": "scheduled", "message": "Task scheduled" } }, "In Progress Response": { "description": "In Progress Response", "value": { "uuid": "2f48cc13-a19e-4d62-8273-ea25896a6ecc", "status": "in_progress", "message": "Task is in progress" } }, "Success Response": { "description": "Success Response", "value": { "uuid": "2f48cc13-a19e-4d62-8273-ea25896a6ecc", "status": "success", "message": "Success" } }, "Failure Response": { "description": "Failure Response", "value": { "uuid": "2f48cc13-a19e-4d62-8273-ea25896a6ecc", "status": "failure", "message": "Task Failed" } }, "Not Started Response": { "description": "Not Started Response", "value": { "uuid": "2f48cc13-a19e-4d62-8273-ea25896a6ecc", "status": "not_started", "message": "The task has not started yet" } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "500 - Internal Error": { "description": "500 - Internal Error", "value": { "error": { "message": "", "code": "PP0008", "details": "" } } } } } } } } } }, "/sdavc/protocol-pack/maintenance/upload": { "post": { "tags": [ "Protocol Pack Maintenance" ], "description": "Upload protocol pack to SDAVC", "operationId": "uploadProtocolPack", "requestBody": { "description": "Protocol Pack File", "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } }, "$$ref": "#/components/schemas/ProtocolPackUploadRequest" } } }, "required": true }, "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Success Response": { "description": "Success Response", "value": [ { "taskExtraKey": "pp-adv-asr1k-176.1a-43-59.0.0.pack", "uuid": "5ace81e7-e002-449e-9449-677a2afa6a26", "status": "scheduled", "taskId": "sdavc_upload_protocol_pack_to_sdavc-5ace81e7-e002-449e-9449-677a2afa6a26", "message": "Upload Protocol Pack to SDAVC initiated for : pp-adv-asr1k-176.1a-43-59.0.0.pack", "protocolPackName": "pp-adv-asr1k-176.1a-43-59.0.0.pack", "actualUploadedFileName": "pp-adv-asr1k-176.1a-43-59.0.0.pack", "systemPackType": "", "device-compliance-status": {}, "policy-compliance-status": {} } ] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "500 - Internal Error": { "description": "500 - Internal Error", "value": { "error": { "message": "", "code": "PP0004", "details": "" } } } } } } } } } }, "/sdavc/protocol-pack/maintenance/upload/cancel/{uuid}": { "post": { "tags": [ "Protocol Pack Maintenance" ], "description": "Cancel or discard an uploaded protocol pack", "operationId": "cancelProtocolPackUpload", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Response": { "description": "Response", "value": { "success": true, "message": "Protocol pack upload cancelled successfully" } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "500 - Internal Error": { "description": "500 - Internal Error", "value": { "error": { "message": "", "code": "PP0002", "details": "" } } } } } } } } } }, "/sdavc/protocol-pack/maintenance/upload/confirm/{uuid}": { "post": { "tags": [ "Protocol Pack Maintenance" ], "description": "Confirm uploaded protocol pack", "operationId": "confirmProtocolPackUpload", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Response": { "description": "Response", "value": { "success": true, "message": "Protocol pack confirmed successfully" } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "500 - Internal Error": { "description": "500 - Internal Error", "value": { "error": { "message": "", "code": "PP0003", "details": "" } } } } } } } } } }, "/sdavc/protocol-pack/maintenance/upload/status/{uuid}": { "get": { "tags": [ "Protocol Pack Maintenance" ], "description": "Get protocol pack upload status", "operationId": "getProtocolPackUploadStatus", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Scheduled Response": { "description": "Scheduled Response", "value": { "uuid": "2f48cc13-a19e-4d62-8273-ea25896a6ecc", "status": "scheduled", "message": "Task scheduled" } }, "In Progress Response": { "description": "In Progress Response", "value": { "uuid": "2f48cc13-a19e-4d62-8273-ea25896a6ecc", "status": "in_progress", "message": "Task is in progress" } }, "Success Response": { "description": "Success Response", "value": { "uuid": "2f48cc13-a19e-4d62-8273-ea25896a6ecc", "status": "success", "message": "Success" } }, "Failure Response": { "description": "Failure Response", "value": { "uuid": "2f48cc13-a19e-4d62-8273-ea25896a6ecc", "status": "failure", "message": "Task Failed" } }, "Not Started Response": { "description": "Not Started Response", "value": { "uuid": "2f48cc13-a19e-4d62-8273-ea25896a6ecc", "status": "not_started", "message": "The task has not started yet" } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "500 - Internal Error": { "description": "500 - Internal Error", "value": { "error": { "message": "", "code": "PP0005", "details": "" } } } } } } } } } }, "/sdavc/protocol-pack/{protocolPackName}": { "delete": { "tags": [ "Protocol Pack Maintenance" ], "description": "Delete Protocol Pack", "operationId": "deleteProtocolPack", "parameters": [ { "name": "protocolPackName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Response": { "description": "Response", "value": { "success": true, "message": "Protocol pack deleted successfully" } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "examples": { "500 - Internal Error": { "description": "500 - Internal Error", "value": { "error": { "message": "", "code": "PP0002", "details": "" } } } } } } } } } }, "/sdavc/reverse-migration/custom-application/replay": { "post": { "tags": [ "SD AVC - Reverse Migration" ], "description": "Replay Custom Application to current SDAVC instance", "operationId": "replayCustomApplications", "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "OK Response": { "description": "OK Response", "value": { "task-id": "2f48cc13-a19e-4d62-8273-ea25896a6ecc", "status": "scheduled", "message": "Task scheduled" }, "$$ref": "#/components/examples/ComViptelaVmanageServerSdavcReverseMigrationResponseExamplesReplayCustomApplicationsOk" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "500 - Internal Server Error": { "description": "500 - Internal Server Error", "value": { "error": { "message": "", "code": "PP0015", "details": "" } }, "$$ref": "#/components/examples/ComViptelaVmanageServerSdavcReverseMigrationResponseExamples500" } } } } } } } }, "/sdavc/reverse-migration/custom-application/replay/status/{task-id}": { "get": { "tags": [ "SD AVC - Reverse Migration" ], "description": "Get Replay Custom Applications status for given Task UUID", "operationId": "replayCustomApplicationsStatus", "parameters": [ { "name": "task-id", "in": "path", "required": true, "schema": { "type": "string", "description": "Task Id got from Replay Request" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Scheduled Response": { "description": "Scheduled Response", "value": { "uuid": "2f48cc13-a19e-4d62-8273-ea25896a6ecc", "status": "scheduled", "message": "Task scheduled" }, "$$ref": "#/components/examples/ComViptelaVmanageServerSdavcReverseMigrationResponseExamplesScheduledResponse" }, "In Progress Response": { "description": "In Progress Response", "value": { "uuid": "2f48cc13-a19e-4d62-8273-ea25896a6ecc", "status": "in_progress", "message": "Task is in progress" }, "$$ref": "#/components/examples/ComViptelaVmanageServerSdavcReverseMigrationResponseExamplesInProgressResponse" }, "Success Response": { "description": "Success Response", "value": { "uuid": "7519de9f-cfb0-4372-be98-8acdea47fbd6", "status": "success", "message": "Successfully completed Synchronize Custom Applications with SDAVC task for vIPtela Inc Regression", "failed-list": [], "success-list": [ "test-Custom", "test2-Custom", "test3-Custom", "test4-Custom", "test5-Custom", "test6-Custom", "test7-Custom", "test8-Custom", "test9-Custom" ], "tenantId": "default", "process-task-id": "sdavc_custom_application_synchronizer-7519de9f-cfb0-4372-be98-8acdea47fbd6", "task-id": "7519de9f-cfb0-4372-be98-8acdea47fbd6", "synchronizer-status-type": "sdavc_custom_application_synchronizer", "timestamp": 1727712608340 }, "$$ref": "#/components/examples/ComViptelaVmanageServerSdavcReverseMigrationResponseExamplesCustomApplicationSuccessResponse" }, "Failure Response": { "description": "Failure Response", "value": { "uuid": "7519de9f-cfb0-4372-be98-8acdea47fbd6", "status": "failure", "message": "Error completing Synchronize Protocol Packs with SDAVC for vIPtela Inc Regression, Reason : Failed to upload one or more Protocol Packs", "failed-list": [ "test1-Custom", "test11-Custom", "test21-Custom", "test31-Custom" ], "success-list": [ "test2-Custom", "test12-Custom", "test22-Custom", "test32-Custom" ], "tenantId": "default", "process-task-id": "sdavc_custom_application_synchronizer-7519de9f-cfb0-4372-be98-8acdea47fbd6", "task-id": "7519de9f-cfb0-4372-be98-8acdea47fbd6", "synchronizer-status-type": "sdavc_custom_application_synchronizer", "timestamp": 1727727990218 }, "$$ref": "#/components/examples/ComViptelaVmanageServerSdavcReverseMigrationResponseExamplesFailedCustomApplicationReplayResponse" }, "Not Started Response": { "description": "Not Started Response", "value": { "uuid": "2f48cc13-a19e-4d62-8273-ea25896a6ecc", "status": "not_started", "message": "The task has not started yet" }, "$$ref": "#/components/examples/ComViptelaVmanageServerSdavcReverseMigrationResponseExamplesNotStartedResponse" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "500 - Internal Server Error": { "description": "500 - Internal Server Error", "value": { "error": { "message": "", "code": "PP0015", "details": "" } }, "$$ref": "#/components/examples/ComViptelaVmanageServerSdavcReverseMigrationResponseExamples500" } } } } } } } }, "/sdavc/reverse-migration/protocol-pack/replay": { "post": { "tags": [ "SD AVC - Reverse Migration" ], "description": "Replay Protocol Pack to current SDAVC instance", "operationId": "replayProtocolPacks", "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "OK Response": { "description": "OK Response", "value": { "task-id": "2f48cc13-a19e-4d62-8273-ea25896a6ecc", "status": "scheduled", "message": "Task scheduled" }, "$$ref": "#/components/examples/ComViptelaVmanageServerSdavcReverseMigrationResponseExamplesReplayProtocolPacksOk" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "500 - Internal Server Error": { "description": "500 - Internal Server Error", "value": { "error": { "message": "", "code": "PP0015", "details": "" } }, "$$ref": "#/components/examples/ComViptelaVmanageServerSdavcReverseMigrationResponseExamples500" } } } } } } } }, "/sdavc/reverse-migration/protocol-pack/replay/status/{task-id}": { "get": { "tags": [ "SD AVC - Reverse Migration" ], "description": "Get Replay Protocol Packs status for given Task UUID", "operationId": "replayProtocolPacksStatus", "parameters": [ { "name": "task-id", "in": "path", "required": true, "schema": { "type": "string", "description": "Task Id got from Replay Request" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Scheduled Response": { "description": "Scheduled Response", "value": { "uuid": "2f48cc13-a19e-4d62-8273-ea25896a6ecc", "status": "scheduled", "message": "Task scheduled" }, "$$ref": "#/components/examples/ComViptelaVmanageServerSdavcReverseMigrationResponseExamplesScheduledResponse" }, "In Progress Response": { "description": "In Progress Response", "value": { "uuid": "2f48cc13-a19e-4d62-8273-ea25896a6ecc", "status": "in_progress", "message": "Task is in progress" }, "$$ref": "#/components/examples/ComViptelaVmanageServerSdavcReverseMigrationResponseExamplesInProgressResponse" }, "Success Response": { "description": "Success Response", "value": { "uuid": "bc50de11-6f9d-4448-b356-f1b6bdfa93d0", "status": "success", "message": "Successfully uploaded Protocol Packs", "failed-list": [], "success-list": [ "pp-adv-cat8k-1712.1a-49-70.0.0.pack", "pp-adv-cat8k-179.1a-46-64.0.0.pack", "pp-adv-cat8k-179.1a-46-66.0.0.pack" ], "tenantId": "default", "process-task-id": "sdavc_protocol_pack_synchronizer-bc50de11-6f9d-4448-b356-f1b6bdfa93d0", "task-id": "bc50de11-6f9d-4448-b356-f1b6bdfa93d0", "synchronizer-status-type": "sdavc_protocol_pack_synchronizer", "timestamp": 1727727990218 }, "$$ref": "#/components/examples/ComViptelaVmanageServerSdavcReverseMigrationResponseExamplesProtocolPackSuccessResponse" }, "Failure Response": { "description": "Failure Response", "value": { "uuid": "bc50de11-6f9d-4448-b356-f1b6bdfa93d0", "status": "failure", "message": "Error completing Synchronize Protocol Packs with SDAVC for vIPtela Inc Regression, Reason : Failed to upload one or more Protocol Packs", "failed-list": [ "pp-adv-asr1k-179.1a-46-65.0.0.pack", "pp-adv-cat8k-1712.1a-49-68.0.0.pack", "pp-adv-cat8k-1712.1a-49-69.0.0.pack", "pp-adv-cat8k-1712.1a-49-71.0.0.pack", "pp-adv-cat8k-1715.1a-52-71.0.0.pack", "pp-adv-cat8k-176.1a-43-64.0.0.pack", "pp-adv-cat8k-179.1a-46-67.0.0.pack" ], "success-list": [ "pp-adv-cat8k-1712.1a-49-70.0.0.pack", "pp-adv-cat8k-179.1a-46-64.0.0.pack", "pp-adv-cat8k-179.1a-46-66.0.0.pack" ], "tenantId": "default", "process-task-id": "sdavc_protocol_pack_synchronizer-bc50de11-6f9d-4448-b356-f1b6bdfa93d0", "task-id": "bc50de11-6f9d-4448-b356-f1b6bdfa93d0", "synchronizer-status-type": "sdavc_protocol_pack_synchronizer", "timestamp": 1727727990218 }, "$$ref": "#/components/examples/ComViptelaVmanageServerSdavcReverseMigrationResponseExamplesFailedProtocolPackReplayResponse" }, "Not Started Response": { "description": "Not Started Response", "value": { "uuid": "2f48cc13-a19e-4d62-8273-ea25896a6ecc", "status": "not_started", "message": "The task has not started yet" }, "$$ref": "#/components/examples/ComViptelaVmanageServerSdavcReverseMigrationResponseExamplesNotStartedResponse" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "500 - Internal Server Error": { "description": "500 - Internal Server Error", "value": { "error": { "message": "", "code": "PP0015", "details": "" } }, "$$ref": "#/components/examples/ComViptelaVmanageServerSdavcReverseMigrationResponseExamples500" } } } } } } } }, "/sdavc/reverse-migration/validate": { "get": { "tags": [ "SD AVC - Reverse Migration" ], "description": "Validate Reverse Migration of Custom Application and Protocol Pack", "operationId": "validate", "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "All OK Response": { "description": "All OK Response", "value": { "custom-application-status": "ok", "custom-application-count": 10, "protocol-pack-status": "ok", "protocol-pack-needs-re-upload": [] }, "$$ref": "#/components/examples/ComViptelaVmanageServerSdavcReverseMigrationResponseExamplesValidateOk" }, "Protocol Pack re-upload required Response": { "description": "Protocol Pack re-upload required Response", "value": { "custom-application-status": "ok", "custom-application-count": 10, "protocol-pack-status": "not-ok", "protocol-pack-needs-re-upload": [ "pp-adv-cat8k-179.1a-46-64.0.0.pack", "pp-adv-cat8k-1712.1a-49-68.0.0.pack" ] }, "$$ref": "#/components/examples/ComViptelaVmanageServerSdavcReverseMigrationResponseExamplesValidateNotOk" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "500 - Internal Server Error": { "description": "500 - Internal Server Error", "value": { "error": { "message": "", "code": "PP0015", "details": "" } }, "$$ref": "#/components/examples/ComViptelaVmanageServerSdavcReverseMigrationResponseExamples500" } } } } } } } }, "/sdavc/saas/publish-tenants": { "post": { "tags": [ "SDAVC SaaS - Publish Tenants" ], "description": "Publish all Tenant Details to SDAVC SaaS", "operationId": "publishTenants", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Success response": { "description": "Success response", "value": { "status": "success" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "500 - Internal Server Error": { "description": "500 - Internal Server Error", "value": { "error": { "message": "Publishing tenant mappings to SDAVC SaaS failed.", "code": "PT0001", "details": "" } } } } } } }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/sdavc/test": { "post": { "tags": [ "System - Container" ], "description": "Test SD_AVC load balancer", "operationId": "testLoadBalancer", "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true, "x-roles-required": "Template Deploy-read,Template Deploy-write,Policy Configuration-read,Policy Configuration-write,Policy Deploy-read,Policy Deploy-write" } }, "/segment": { "get": { "tags": [ "Configuration - Segments" ], "description": "Get network segments", "operationId": "getSegments", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "Segment list": { "description": "Segment list", "value": { "data": [ { "segmentName": "Discovered_VPN_10", "segmentId": "10", "solution": "sdwan", "id": "c952c18b-30b3-4f0b-b985-494693d7adfb", "referenceCount": 2 }, { "segmentName": "Discovered_VPN_65529", "segmentId": "65529", "solution": "sdwan", "id": "5dd3f122-e52f-437e-b5e5-5ae94ad09cd6", "referenceCount": 0 }, { "segmentName": "Discovered_VPN_20", "segmentId": "20", "solution": "sd-routing", "id": "83b6309d-f61d-4ac5-9699-7d3c04a1caef", "referenceCount": 0 }, { "segmentName": "Discovered_VPN_40", "segmentId": "40", "solution": "sd-routing", "id": "64b30b74-08e2-4b4b-81ca-d019c7e452d5", "referenceCount": 1 } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Configuration - Segments" ], "description": "Create network segment", "operationId": "createSegment", "requestBody": { "description": "Network segment", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Network segment": { "description": "Network segment", "value": { "segmentName": "Discovered_VPN_80", "segmentId": "80", "solution": "sdwan" } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Task Id": { "description": "Task Id", "value": { "id": "bab577b9-e3c7-4385-abc1-d800dacb5f36" } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/segment/{id}": { "delete": { "tags": [ "Configuration - Segments" ], "description": "Delete network segment", "operationId": "deleteSegment", "parameters": [ { "name": "id", "in": "path", "description": "Segment Id", "required": true, "schema": { "pattern": "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}", "type": "string" } } ], "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "Configuration - Segments" ], "description": "Get network segment", "operationId": "getSegment", "parameters": [ { "name": "id", "in": "path", "description": "Segment Id", "required": true, "schema": { "pattern": "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}", "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "Segment list": { "description": "Segment list", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "Configuration - Segments" ], "description": "Edit network segment", "operationId": "editSegment", "parameters": [ { "name": "id", "in": "path", "description": "Segment Id", "required": true, "schema": { "pattern": "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}", "type": "string" } } ], "requestBody": { "description": "Network segment", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Network segment": { "description": "Network segment", "value": "{{\n \"segmentName\":\"Discovered_VPN_80\",\n \"segmentId\":\"90\",\n \"solution\":\"sdwan\",\n \"id\":\"bab577b9-e3c7-4385-abc1-d800dacb5f36\",\n \"referenceCount\":0\n}}" } } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/setting/configuration/webserver/certificate": { "get": { "tags": [ "Certificate Management - vManage" ], "summary": "Retrieves Signed Certificate Details", "description": "Retrieves Signed Certificate Details", "operationId": "showInfo", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "Web Server Certificate Response": { "description": "Web Server Certificate Response", "value": { "org_unit": "Cisco SD-WAN", "org": "Cisco Systems", "location": "Milpitas", "state": "CA", "country": "US", "company_name": "cisco.com", "notBefore": 1716453273000, "notAfter": 1811061273000, "certificateDetails": "[\n[\n Version: V3\n Subject: OU=Cisco SD-WAN, O=Cisco Systems, L=Milpitas, ST=CA, C=US, CN=cisco.com\n Signature Algorithm: SHA256withRSA, OID = 1.2.840.113549.1.1.11\n\n Key: Sun RSA public key, 2048 bits\n params: null\n modulus: 24415088922664979671266902719578448729590096123090308050409894246597037700826457468704530842642857210156719189053986929777579954182298529791833634799228627082206493387686427677536313110839238698248165839347164214877888890446621780244952412251221990595038507887048648188323999541630899482272693863504123774666852341902112064345683135475647894137312832136535446260038835674001216595312699436648811347882223942474007050591244735744391580907566490720180118367224323510481486966646378660911263056906871142696104218558212034525779150587185709393002825262227305564185461530730580791421717034120540280561841311367840663024203\n public exponent: 65537\n Validity: [From: Thu May 23 08:34:33 UTC 2024,\n To: Sun May 23 08:34:33 UTC 2027]\n Issuer: OU=Cisco SD-WAN, O=Cisco Systems, L=Milpitas, ST=CA, C=US, CN=cisco.com\n SerialNumber: [ 70e8ae87 ce97a5cd 24eb8b4a 1d79f4ca 3d6e6c6b]\n\nCertificate Extensions: 3\n[1]: ObjectId: 2.5.29.35 Criticality=false\nAuthorityKeyIdentifier [\nKeyIdentifier [\n0000: 15 4A 9F 50 00 1F A2 E7 E4 53 BB C4 96 B2 63 15 .J.P.....S....c.\n0010: 3C 74 CD ED L.g.....Dl\n00B0: A3 BA CC AA 9B 2D D9 04 71 C6 C7 47 1A CF 8C 1A .....-..q..G....\n00C0: AC C8 02 36 6F DD 16 6B 04 67 AE BF 03 05 C5 6C ...6o..k.g.....l\n00D0: 43 DC 4C D0 F3 CD 83 1C 5C B3 17 95 EC FA 2E 80 C.L.....\\.......\n00E0: D2 FA 62 81 A7 67 AF AF 8A 35 B2 E0 8E C9 B3 1E ..b..g...5......\n00F0: 58 12 7F B2 8F 54 83 56 42 A6 6B E1 39 B8 0A 49 X....T.VB.k.9..I\n\n]", "validity": "Valid" }, "$$ref": "#/components/examples/ComViptelaVmanageServerSettingapiResponseExampleGetwebservercertificateresponse" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Settings-read,dca" }, "put": { "tags": [ "Certificate Management - vManage" ], "summary": "Import a signed web server certificate", "description": "Import a signed web server certificate", "operationId": "importCertificate", "requestBody": { "description": "Web Server Certificate configuration", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Web Server Certificate Request": { "description": "Web Server Certificate Request", "value": "-----BEGIN CERTIFICATE-----\nMIIDhDCCAmwCCQCcDeb1sPMdpjANBgkqhkiG9w0BAQsFADCBhjELMAkGA1UEBhMC\nVVMxEzARBgNVBAgTCkNhbGlmb3JuaWExETAPBgNVBAcTCFNhbiBKb3NlMRUwEwYD\nVQQLEwx2SVB0ZWxhIFRlc3QxFDASBgNVBAoTC3ZJUHRlbGEgSW5jMSIwIAYJKoZI\nhvcNAQkBFhNzYW50b3NoQHZpcHRlbGEuY29tMB4XDTIzMDYwMzE1MDM1MFoXDTM0\nMDUzMTE1MDM1MFowgYAxFzAVBgNVBAMMDnZtbmdfc2NhbGVfaW5kMQswCQYDVQQG\nEwJJTjESMBAGA1UECAwJS2FybmF0YWthMRIwEAYDVQQHDAlCYW5nYWxvcmUxFzAV\nBgNVBAoMDnZtbmdfc2NhbGVfaW5kMRcwFQYDVQQLDA52bW5nX3NjYWxlX2luZDCC\nASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAL9ZSFCz5JKuUUobW6sjela8\nXJa3BwJpza8GjALlYiseVW93vAI3cgn90pO/eXETG5e8EEj8/N3HTqIgbpcooHTf\nUuzfwjIXR5FWlbaDLsJEAXVDFiv3MDtGQ/RtFrrw49OBtlhAG3AmEkaMZ63dOksQ\nv5y9wu0XfDoLmkg0q47NlJ682j2KjcsLud68Vn6y7OWmzk8B2ErV3SP4dwpaDzic\n0BfOdn5oSXX+wGKpbJ0n5hCuwDreyDpsO5jJ5UYr1eUpvH4Sj2llli/n+7BOjLCT\n3Jy9RXotiajSxx1k0sNYuajcWw5qxzGAJes9R4fPqBSvKq/G3Lyc4tinwBOWLEMC\nAwEAATANBgkqhkiG9w0BAQsFAAOCAQEAjr1EajpucmaQmwHb+J531NxivLzhVxlu\n3F+Bklo4JLxoo/2CImjuE3X5NNed5qj4v1zgjPPxSSyOGcbXreiodXOSRsGpb6+I\n7AlPZRboS52Y6Zigwnw8HIBCINMkII2wNVY+gYJzFPg58UJobdedx7qNS+Pyu6W3\navGXOGXEREzAqzE5WP+csV/5Too62EwAV3cT3vElpdE3kASHzNFJfbu9xctrQHeF\njxOweOjsbMuikOSyRaYJqs0H4gQcP2Vyb9i+unHvPGKZruhFLsGdIxNq/FPv5cMx\naNH3W/qegrUYlcdeCH6zRxXRJSTxy1f7114TMP039Zhphd0O6gNVrA==\n-----END CERTIFICATE-----", "$$ref": "#/components/examples/ComViptelaVmanageServerSettingapiRequestExamplePutwebservercertificaterequest" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "Web Server Certificate Response": { "description": "Web Server Certificate Response", "value": { "certificateDetails": "[\n[\n Version: V1\n Subject: OU=vmng_scale_ind, O=vmng_scale_ind, L=Bangalore, ST=Karnataka, C=IN, CN=vmng_scale_ind\n Signature Algorithm: SHA256withRSA, OID = 1.2.840.113549.1.1.11\n\n Key: Sun RSA public key, 2048 bits\n params: null\n modulus: 24155543081010666491409394023380679253122680778601796383855494877290567036851294649532947903502512148949137747965411702956028620652998659095890130433247893949793766734241156014006484814662929610619573362657269970917386638647513113592323387261234621120613330625805248590714250058390333902187045076542030949923447605099243054675098588656816214473046976503799476814975137571732365286577103115602090974885327456287119700641930853545850019624136710419292648007969922415482923961055123266248393248076331450596008061127664094168201756085094764933763470164620652670237031095864930773557728603890998822635409093442573492956227\n public exponent: 65537\n Validity: [From: Sat Jun 03 15:03:50 UTC 2023,\n To: Wed May 31 15:03:50 UTC 2034]\n Issuer: EMAILADDRESS=santosh@viptela.com, O=vIPtela Inc, OU=vIPtela Test, L=San Jose, ST=California, C=US\n SerialNumber: [ 9c0de6f5 b0f31da6]\n\n]\n Algorithm: [SHA256withRSA]\n Signature:\n0000: 8E BD 44 6A 3A 6E 72 66 90 9B 01 DB F8 9E 77 D4 ..Dj:nrf......w.\n0010: DC 62 BC BC E1 57 19 6E DC 5F 81 92 5A 38 24 BC .b...W.n._..Z8$.\n0020: 68 A3 FD 82 22 68 EE 13 75 F9 34 D7 9D E6 A8 F8 h...\"h..u.4.....\n0030: BF 5C E0 8C F3 F1 49 2C 8E 19 C6 D7 AD E8 A8 75 .\\....I,.......u\n0040: 73 92 46 C1 A9 6F AF 88 EC 09 4F 65 16 E8 4B 9D s.F..o....Oe..K.\n0050: 98 E9 98 A0 C2 7C 3C 1C 80 42 20 D3 24 20 8D B0 ......<..B .$ ..\n0060: 35 56 3E 81 82 73 14 F8 39 F1 42 68 6D D7 9D C7 5V>..s..9.Bhm...\n0070: BA 8D 4B E3 F2 BB A5 B7 6A F1 97 38 65 C4 44 4C ..K.....j..8e.DL\n0080: C0 AB 31 39 58 FF 9C B1 5F F9 4E 8A 3A D8 4C 00 ..19X..._.N.:.L.\n0090: 57 77 13 DE F1 25 A5 D1 37 90 04 87 CC D1 49 7D Ww...%..7.....I.\n00A0: BB BD C5 CB 6B 40 77 85 8F 13 B0 78 E8 EC 6C CB ....k@w....x..l.\n00B0: A2 90 E4 B2 45 A6 09 AA CD 07 E2 04 1C 3F 65 72 ....E........?er\n00C0: 6F D8 BE BA 71 EF 3C 62 99 AE E8 45 2E C1 9D 23 o...q.L.g.....Dl\n00B0: A3 BA CC AA 9B 2D D9 04 71 C6 C7 47 1A CF 8C 1A .....-..q..G....\n00C0: AC C8 02 36 6F DD 16 6B 04 67 AE BF 03 05 C5 6C ...6o..k.g.....l\n00D0: 43 DC 4C D0 F3 CD 83 1C 5C B3 17 95 EC FA 2E 80 C.L.....\\.......\n00E0: D2 FA 62 81 A7 67 AF AF 8A 35 B2 E0 8E C9 B3 1E ..b..g...5......\n00F0: 58 12 7F B2 8F 54 83 56 42 A6 6B E1 39 B8 0A 49 X....T.VB.k.9..I\n\n]" }, "$$ref": "#/components/examples/ComViptelaVmanageServerSettingapiResponseExampleGetwebservercertificategetcertificateresponse" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Settings-write" } }, "/setting/configuration/webserver/certificate/renew": { "post": { "tags": [ "Certificate Management - vManage" ], "summary": "Renew webserver cert", "description": "Renew Web Server Certificate", "operationId": "renewWebServerCertificate", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "Status": { "description": "Status", "value": { "success": "true" }, "$$ref": "#/components/examples/ComViptelaVmanageServerSettingapiResponseExamplePostrenewwebcertresponse" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/sig/datacenters/{type}/{tunneltype}": { "get": { "tags": [ "Configuration - Secure Internet Gateway" ], "description": "The API to get all sig data center for given provider type", "operationId": "getSigDynamicDataCenterList", "parameters": [ { "name": "type", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tunneltype", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "mapping": { "type": "array", "items": { "type": "object", "properties": { "CITY/COUNTRY": { "type": "string" }, "FQDN": { "type": "string" }, "IP": { "type": "string" } }, "$$ref": "#/components/schemas/MappingEntries" } }, "title": { "type": "string" } }, "$$ref": "#/components/schemas/GetDataCenters" }, "example": "{\n \"title\":\"Zscaler Data center locations\",\n \"mapping\":[\n {\n \"city/country\":\"Auckland, New Zealand\",\n \"IP\":\"147.161.216.40\"\n \"FQDN\":\"akl2-vpn.zscalerthree.net\"\n },\n {\n \"city/country\":\"Auckland, New Zealand\",\n \"IP\":\"147.161.216.41\"\n \"FQDN\":\"akl2-vpn.zscalerthree.net\"\n },\n {\n \"city/country\":\"Auckland, New Zealand\",\n \"IP\":\"147.161.216.42\"\n \"FQDN\":\"akl2-vpn.zscalerthree.net\"\n },\n {\n \"city/country\":\"Amsterdam, The Netherlands\",\n \"IP\":\"165.225.240.38\"\n \"FQDN\":\"ams2-vpn.zscalerthree.net\"\n },\n {\n \"city/country\":\"Beijing, China\",\n \"IP\":\"211.144.19.18\"\n \"FQDN\":\"bjs1-vpn.zscalerthree.net\"\n },\n ]" } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/sig/datacenters/{type}/{tunneltype}/{devicetype}": { "get": { "tags": [ "Configuration - Secure Internet Gateway" ], "description": "Get list of data centers for zscaler or umbrella", "operationId": "getSigDataCenterList", "parameters": [ { "name": "type", "in": "path", "description": "Provider type", "required": true, "schema": { "type": "string" } }, { "name": "tunneltype", "in": "path", "description": "Type of the tunnel ipsec/gre", "required": true, "schema": { "type": "string" } }, { "name": "devicetype", "in": "path", "description": "Type of the device vedge/cedge", "required": true, "schema": { "type": "string" } } ], "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": "Template Deploy-read,Template Deploy-write,Policy Configuration-read,Policy Configuration-write,Policy Deploy-read,Policy Deploy-write" } }, "/sig/sigGlobalCredentials/{featureTemplateType}": { "get": { "tags": [ "Configuration - Secure Internet Gateway" ], "description": "Get sig global credentials", "operationId": "getSigGlobalCredentials", "parameters": [ { "name": "featureTemplateType", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "umbrella": { "type": "object", "properties": { "api-key": { "type": "object", "properties": { "vipObjectType": { "type": "string", "example": "object" }, "vipType": { "type": "string", "example": "constant" }, "vipValue": { "type": "string", "example": "sdfsd" }, "vipVariableName": { "type": "string", "example": "system_api_key" } }, "description": "API secret information", "$$ref": "#/components/schemas/APIKey" }, "api-key-v2": { "type": "object", "properties": { "vipObjectType": { "type": "string", "example": "object" }, "vipType": { "type": "string", "example": "constant" }, "vipValue": { "type": "string", "example": "sdfsd" }, "vipVariableName": { "type": "string", "example": "system_api_key" } }, "description": "API secret information", "$$ref": "#/components/schemas/APIKey" }, "api-secret": { "type": "object", "properties": { "vipNeedsEncryption": { "type": "boolean", "example": true }, "vipObjectType": { "type": "string", "example": "object" }, "vipType": { "type": "string", "example": "constant" }, "vipValue": { "type": "string", "example": "$CRYPT_CLUSTER$0y3Eq1EFF5Hurtda/Z9eHQ==$gtnBC/bVtpuhWX5r905iYw==" }, "vipVariableName": { "type": "string", "example": "system_api_secret" } }, "description": "API key information", "$$ref": "#/components/schemas/APISecret" }, "api-secret-v2": { "type": "object", "properties": { "vipNeedsEncryption": { "type": "boolean", "example": true }, "vipObjectType": { "type": "string", "example": "object" }, "vipType": { "type": "string", "example": "constant" }, "vipValue": { "type": "string", "example": "$CRYPT_CLUSTER$0y3Eq1EFF5Hurtda/Z9eHQ==$gtnBC/bVtpuhWX5r905iYw==" }, "vipVariableName": { "type": "string", "example": "system_api_secret" } }, "description": "API key information", "$$ref": "#/components/schemas/APISecret" }, "org-id": { "type": "object", "properties": { "vipObjectType": { "type": "string", "example": "object" }, "vipType": { "type": "string", "example": "constant" }, "vipValue": { "type": "string", "example": "980" }, "vipVariableName": { "type": "string", "example": "system_org_id" } }, "description": "Org ID", "$$ref": "#/components/schemas/OrgID" } }, "description": "Umbrella object", "$$ref": "#/components/schemas/Umbrella" } }, "description": "Response from metaDataType API", "$$ref": "#/components/schemas/FeatureTemplateType" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/sig/umbrella/childOrg/{type}": { "get": { "tags": [ "Configuration - Secure Internet Gateway" ], "description": "Get the list of child org IDs given the type management or device ", "operationId": "getChildOrgs", "parameters": [ { "name": "type", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/signature-set/rule-group": { "post": { "tags": [ "IPS Signature - Rule Group" ], "summary": "create custom rule group", "operationId": "createRuleGroup", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "description": { "type": "string", "example": "its not a fast browser" }, "name": { "type": "string", "example": "IE" } }, "$$ref": "#/components/schemas/CreateRuleGroupRequestPayload" } } }, "required": true }, "responses": { "200": { "description": "success response message", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "c8a4164a-4778-4a7e-8d93-45f78f387010" }, "message": { "type": "string", "example": "request processed successfully" }, "success": { "type": "boolean", "example": true } }, "$$ref": "#/components/schemas/DefaultPostSuccessResponse" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" } } }, "get": { "tags": [ "IPS Signature - Rule Group" ], "summary": "fetch all custom rule group", "operationId": "getAllCustomRuleGroup", "responses": { "200": { "description": "success response message", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "category": { "type": "string", "example": "Local Groups" }, "description": { "type": "string", "example": "its not a fast browser" }, "displayName": { "type": "string", "example": "Internet Explorer" }, "id": { "type": "string", "example": "c8a4164a-4778-4a7e-8d93-45f78f387010" }, "name": { "type": "string", "example": "IE" } }, "$$ref": "#/components/schemas/GetCustomRuleGroupObject" } } }, "$$ref": "#/components/schemas/GetCustomRuleGroupResponse" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" } } } }, "/signature-set/{signatureSetId}/base/rule": { "get": { "tags": [ "IPS Signature - Rule" ], "summary": "Fetch all Base Rules", "operationId": "getAllBaseRules", "parameters": [ { "name": "signatureSetId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "schema": { "maximum": 100, "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "category", "in": "query", "schema": { "type": "string" } }, { "name": "group", "in": "query", "schema": { "type": "string" } }, { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "action", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "list of ips rules", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32" }, "data": { "type": "array", "items": { "type": "object", "properties": { "baseRuleAction": { "type": "string" }, "groups": { "type": "array", "items": { "type": "object", "properties": { "groupCategory": { "type": "string" }, "groupDisplayName": { "type": "string" }, "groupId": { "type": "string" }, "groupName": { "type": "string" } }, "$$ref": "#/components/schemas/RuleGroupObject" } }, "overriddenRuleAction": { "type": "string" }, "overriddenRuleGroupAction": { "type": "string" }, "ruleAction": { "type": "string" }, "ruleData": { "type": "string" }, "ruleGid": { "type": "string" }, "ruleId": { "type": "string" }, "ruleInfo": { "type": "string" }, "ruleReplace": { "type": "boolean" }, "ruleSid": { "type": "string" }, "securityLevel": { "type": "string" } }, "$$ref": "#/components/schemas/RuleResponse" } }, "metadata": { "type": "object", "properties": { "alert": { "type": "integer", "format": "int32" }, "disabled": { "type": "integer", "format": "int32" }, "drop": { "type": "integer", "format": "int32" }, "overridden": { "type": "integer", "format": "int32" }, "rewrite": { "type": "integer", "format": "int32" } }, "$$ref": "#/components/schemas/RuleMetadata" } }, "$$ref": "#/components/schemas/RulesResponse" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" } } } }, "/signature-set/{signatureSetId}/custom-rule": { "post": { "tags": [ "IPS Signature - Custom Rule" ], "summary": "create custom signature", "operationId": "createCustomSignature", "parameters": [ { "name": "signatureSetId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "associatedRuleGroups": { "type": "array", "items": { "type": "string" } }, "data": { "type": "string", "example": "alert tcp $EXTERNAL_NET $HTTP_PORTS -> $HOME_NET any ( msg:\"BROWSER-CHROME Apple Safari/Google Chrome Webkit memory corruption attempt\"; flow:to_client,established; file_data; content:\"|3C|dialog|20|style|3D 27|position|3A|relative|27 3E|\",fast_pattern,nocase; content:\"|3C|h|20|style|3D 27|outline|2D|style|3A|auto|27 3E|\"; metadata:policy max-detect-ips drop; service:http; reference:bugtraq,43078; reference:cve,2010-1813; classtype:attempted-user; sid:19005; rev:9; )" } }, "$$ref": "#/components/schemas/CreateCustomSignatureRequestPayload" } } }, "required": true }, "responses": { "200": { "description": "success response message", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "c8a4164a-4778-4a7e-8d93-45f78f387010" }, "message": { "type": "string", "example": "request processed successfully" }, "success": { "type": "boolean", "example": true } }, "$$ref": "#/components/schemas/DefaultPostSuccessResponse" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" } } } }, "/signature-set/{signatureSetId}/custom-rule/{ruleId}": { "put": { "tags": [ "IPS Signature - Custom Rule" ], "summary": "update custom signature", "operationId": "updateCustomSignature", "parameters": [ { "name": "signatureSetId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ruleId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "associatedRuleGroups": { "type": "array", "items": { "type": "string" } }, "data": { "type": "string", "example": "alert tcp $EXTERNAL_NET $HTTP_PORTS -> $HOME_NET any ( msg:\"BROWSER-CHROME Apple Safari/Google Chrome Webkit memory corruption attempt\"; flow:to_client,established; file_data; content:\"|3C|dialog|20|style|3D 27|position|3A|relative|27 3E|\",fast_pattern,nocase; content:\"|3C|h|20|style|3D 27|outline|2D|style|3A|auto|27 3E|\"; metadata:policy max-detect-ips drop; service:http; reference:bugtraq,43078; reference:cve,2010-1813; classtype:attempted-user; sid:19005; rev:9; )" } }, "$$ref": "#/components/schemas/CreateCustomSignatureRequestPayload" } } }, "required": true }, "responses": { "200": { "description": "success response message", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "request processed successfully" }, "success": { "type": "boolean", "example": true } }, "$$ref": "#/components/schemas/DefaultPutSuccessResponse" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" } } } }, "/signature-set/{signatureSetId}/metadata": { "get": { "tags": [ "IPS Signature - Rule" ], "summary": "Fetch Rule Action count", "operationId": "getRuleMetadata", "parameters": [ { "name": "signatureSetId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "category", "in": "query", "schema": { "type": "string" } }, { "name": "group", "in": "query", "schema": { "type": "string" } }, { "name": "type", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "ips rule related metadata", "content": { "application/json": { "schema": { "type": "object", "properties": { "alert": { "type": "integer", "format": "int32" }, "disabled": { "type": "integer", "format": "int32" }, "drop": { "type": "integer", "format": "int32" }, "overridden": { "type": "integer", "format": "int32" }, "rewrite": { "type": "integer", "format": "int32" } }, "$$ref": "#/components/schemas/RuleMetadata" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" } } } }, "/signature-set/{signatureSetId}/overridden/rule": { "get": { "tags": [ "IPS Signature - Rule" ], "summary": "Fetch all overridden Rules", "operationId": "getAllOverriddenRules", "parameters": [ { "name": "signatureSetId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "schema": { "maximum": 100, "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "onlyOverriddenRules", "in": "query", "required": true, "schema": { "type": "boolean", "default": false } }, { "name": "category", "in": "query", "schema": { "type": "string" } }, { "name": "group", "in": "query", "schema": { "type": "string" } }, { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "action", "in": "query", "schema": { "type": "string" } }, { "name": "onlyBaseRules", "in": "query", "required": true, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "list of ips rules", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32" }, "data": { "type": "array", "items": { "type": "object", "properties": { "baseRuleAction": { "type": "string" }, "groups": { "type": "array", "items": { "type": "object", "properties": { "groupCategory": { "type": "string" }, "groupDisplayName": { "type": "string" }, "groupId": { "type": "string" }, "groupName": { "type": "string" } }, "$$ref": "#/components/schemas/RuleGroupObject" } }, "overriddenRuleAction": { "type": "string" }, "overriddenRuleGroupAction": { "type": "string" }, "ruleAction": { "type": "string" }, "ruleData": { "type": "string" }, "ruleGid": { "type": "string" }, "ruleId": { "type": "string" }, "ruleInfo": { "type": "string" }, "ruleReplace": { "type": "boolean" }, "ruleSid": { "type": "string" }, "securityLevel": { "type": "string" } }, "$$ref": "#/components/schemas/RuleResponse" } }, "metadata": { "type": "object", "properties": { "alert": { "type": "integer", "format": "int32" }, "disabled": { "type": "integer", "format": "int32" }, "drop": { "type": "integer", "format": "int32" }, "overridden": { "type": "integer", "format": "int32" }, "rewrite": { "type": "integer", "format": "int32" } }, "$$ref": "#/components/schemas/RuleMetadata" } }, "$$ref": "#/components/schemas/RulesResponse" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" } } } }, "/signature-set/{signatureSetId}/rule-group/security-level": { "put": { "tags": [ "IPS Signature - Rule Group" ], "summary": "Edit rule group security level.", "operationId": "editRuleGroupSeclevel", "parameters": [ { "name": "signatureSetId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "ruleGroupId": { "type": "string", "example": "browser" }, "seclevel": { "type": "string", "example": "balanced" } }, "$$ref": "#/components/schemas/EditRuleGroupSeclevelObject" } } }, "$$ref": "#/components/schemas/EditRuleGroupSeclevelRequestPayload" } } }, "required": true }, "responses": { "200": { "description": "success response message", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "request processed successfully" }, "success": { "type": "boolean", "example": true } }, "$$ref": "#/components/schemas/DefaultPutSuccessResponse" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" } } } }, "/signature-set/{signatureSetId}/rule/action": { "put": { "tags": [ "IPS Signature - Rule" ], "summary": "edit action of a rule", "operationId": "editRuleAction", "parameters": [ { "name": "signatureSetId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "action": { "type": "string" }, "ruleId": { "type": "string" } }, "$$ref": "#/components/schemas/RuleActionOverride" } } }, "$$ref": "#/components/schemas/RuleActionOverrideRequest" } } }, "required": true }, "responses": { "200": { "description": "success response message", "content": { "application/json": { "schema": { "type": "object", "properties": { "failure-list": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "message": { "type": "string" } }, "$$ref": "#/components/schemas/ResponseMessage" } }, "success-list": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "message": { "type": "string" } }, "$$ref": "#/components/schemas/ResponseMessage" } } }, "$$ref": "#/components/schemas/RuleActionOverrideResponse" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" } } } }, "/signature-set/{signatureSetId}/rule/{ruleId}/comment": { "get": { "tags": [ "IPS Signature - Comment" ], "summary": "Fetch all comments on a rule", "operationId": "getCommentOnRule", "parameters": [ { "name": "signatureSetId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ruleId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "success response message", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "comment": { "type": "string" }, "createdOn": { "type": "integer", "format": "int64" }, "lastUpdatedOn": { "type": "integer", "format": "int64" }, "user": { "type": "string" }, "uuid": { "type": "string" } }, "$$ref": "#/components/schemas/RuleComment" } }, "ruleId": { "type": "string" }, "signatureId": { "type": "string" } }, "$$ref": "#/components/schemas/RuleCommentsResponse" } } } }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "IPS Signature - Comment" ], "summary": "Create comment on a rule", "operationId": "createCommentOnRule", "parameters": [ { "name": "signatureSetId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ruleId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "comment": { "type": "string" } }, "$$ref": "#/components/schemas/RuleCommentRequest" } } }, "required": true }, "responses": { "200": { "description": "success response message", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "ruleId": { "type": "string" }, "signatureSetId": { "type": "string" }, "success": { "type": "boolean" }, "uuid": { "type": "string" } }, "$$ref": "#/components/schemas/RuleCommentResponse" } } } }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "ruleId": { "type": "string" }, "signatureSetId": { "type": "string" }, "success": { "type": "boolean" }, "uuid": { "type": "string" } }, "$$ref": "#/components/schemas/RuleCommentResponse" } } } } } } }, "/signature-set/{signatureSetId}/rule/{ruleId}/comment/{commentId}": { "put": { "tags": [ "IPS Signature - Comment" ], "summary": "update comment on a rule", "operationId": "updateCommentOnRule", "parameters": [ { "name": "signatureSetId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ruleId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "commentId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "comment": { "type": "string" } }, "$$ref": "#/components/schemas/RuleCommentRequest" } } }, "required": true }, "responses": { "200": { "description": "success response message", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "ruleId": { "type": "string" }, "signatureSetId": { "type": "string" }, "success": { "type": "boolean" }, "uuid": { "type": "string" } }, "$$ref": "#/components/schemas/RuleCommentResponse" } } } }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "ruleId": { "type": "string" }, "signatureSetId": { "type": "string" }, "success": { "type": "boolean" }, "uuid": { "type": "string" } }, "$$ref": "#/components/schemas/RuleCommentResponse" } } } } } }, "delete": { "tags": [ "IPS Signature - Comment" ], "summary": "delete comment on a rule", "operationId": "deleteCommentOnRule", "parameters": [ { "name": "signatureSetId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ruleId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "commentId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "success response message", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "ruleId": { "type": "string" }, "signatureSetId": { "type": "string" }, "success": { "type": "boolean" }, "uuid": { "type": "string" } }, "$$ref": "#/components/schemas/RuleCommentResponse" } } } }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "ruleId": { "type": "string" }, "signatureSetId": { "type": "string" }, "success": { "type": "boolean" }, "uuid": { "type": "string" } }, "$$ref": "#/components/schemas/RuleCommentResponse" } } } } } } }, "/signature-set/{signatureSetId}/{type}/rule-group": { "get": { "tags": [ "IPS Signature - Rule Group" ], "summary": "Fetch IPS profile rule group data.", "description": "fetch rule group data for a ips profile", "operationId": "getRuleGroup", "parameters": [ { "name": "signatureSetId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "type", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "category", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "list of ips rule groups", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "category": { "type": "string", "example": "browser" }, "createdOn": { "type": "integer", "format": "int32", "example": 4233672632786387 }, "defaultSeclevel": { "type": "string", "example": "security" }, "name": { "type": "string", "example": "chrome" }, "ruleCount": { "type": "integer", "format": "int32", "example": 406 }, "ruleGroupId": { "type": "string", "example": "c8a4164a-4778-4a7e-8d93-45f78f387010" }, "seclevel": { "type": "string", "example": "balanced" }, "updatedOn": { "type": "integer", "format": "int32", "example": 4233672632786387 } }, "$$ref": "#/components/schemas/RuleGroupDetail" } } }, "$$ref": "#/components/schemas/GetRuleGroupResponse" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" } } } }, "/smartLicensing/authenticate": { "post": { "tags": [ "Smart License" ], "description": "authenticate user for sle", "operationId": "sleauthenticate", "requestBody": { "description": "Partner", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Partner": { "description": "Partner", "value": {} } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "data": { "description": "data", "value": "{{\"accessToken\":\"3QTD4madnNiu4q4c6YTmrprhAkvM\"}}" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/smartLicensing/fetchAccounts": { "get": { "tags": [ "Smart License" ], "description": "fetch sava for sle", "operationId": "fetchAccounts_SmartLicense_2903", "parameters": [ { "name": "mode", "in": "query", "description": "mode", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partner", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Partner": { "description": "Partner", "value": {} } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "account_id": { "type": "string", "example": "276200" }, "name": { "type": "string", "example": "testaccount3.viptela.com" }, "virtual_accounts": { "type": "array", "items": { "type": "object", "properties": { "default": { "type": "boolean", "example": false }, "name": { "type": "string", "example": "703805" }, "virtual_account_id": { "type": "string", "example": "713850" } }, "$$ref": "#/components/schemas/SmartLicensingfetchAccountsRespVirtualAccounts" } } }, "$$ref": "#/components/schemas/SmartLicensingfetchAccountsResp" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/smartLicensing/fetchAllSa": { "get": { "tags": [ "Smart License" ], "description": "fetch reports offline for sle", "operationId": "fetchReports_SmartLicense_2603", "requestBody": { "description": "Partner", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "SLE": { "description": "SLE", "value": {} } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Partner Id": { "description": "Partner Id", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/smartLicensing/fetchReportsForSa": { "get": { "tags": [ "Smart License" ], "description": "fetch reports offline for sle", "operationId": "fetchReports_SmartLicense_3303", "parameters": [ { "name": "saDomain", "in": "query", "description": "saDomain", "required": true, "schema": { "maxLength": 200, "minLength": 0, "pattern": "^[a-zA-Z0-9-.]+$", "type": "string" } }, { "name": "saId", "in": "query", "description": "saId", "required": true, "schema": { "maxLength": 20, "minLength": 0, "pattern": "^[0-9]+$", "type": "string" } } ], "requestBody": { "description": "Partner", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "SLE": { "description": "SLE", "value": {} } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Partner Id": { "description": "Partner Id", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/smartLicensing/getUserSettings": { "get": { "tags": [ "Smart License" ], "description": "get settings", "operationId": "getuserSettings", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Devices": { "description": "Devices", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true } }, "/smartLicensing/syncLicenses": { "post": { "tags": [ "Smart License" ], "description": "get all licenses for sa/va", "operationId": "syncLicenses_SmartLicense_2804", "requestBody": { "description": "Partner", "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "data": { "type": "string" }, "name": { "type": "string", "format": "binary" } }, "$$ref": "#/components/schemas/LicenseUplodFile" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "license": { "description": "license", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "deprecated": true, "x-roles-required": "admin,Software Upgrade-write" } }, "/software/compliance/ip/origin/check": { "post": { "tags": [ "Utility - Security" ], "description": "Block IP based on list", "operationId": "checkGivenIpList", "requestBody": { "description": "Device detail", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Device detail": { "description": "Device detail", "value": {} } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "IP validation status": { "description": "IP validation status", "value": [] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/sslproxy/certificate": { "get": { "tags": [ "Configuration - Device SSL Proxy Certificate Management" ], "description": "Get edge proxy certificate", "operationId": "getProxyCertOfEdge", "parameters": [ { "name": "deviceId", "in": "query", "description": "Device Id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Edge proxy certificate": { "description": "Edge proxy certificate", "value": { "enterpriseCA": true, "vManageRootCA": true } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Certificates-read,Certificates-write" }, "put": { "tags": [ "Configuration - Device SSL Proxy Certificate Management" ], "description": "Upload device certificate", "operationId": "updateCertificate", "requestBody": { "description": "Upload device certificate", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Upload device certificate": { "description": "Upload device certificate", "value": { "uuid": "C8K-2e556375-5d15-420b-aa4d-dd3e5072e585", "certificate": "-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----" } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Task Id": { "description": "Task Id", "value": "{id: \"210c2bc2-5423-4a6b-9269-22eaf058d774\"}" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Certificates-write" } }, "/sslproxy/certificate/wanedge/{deviceId}": { "post": { "tags": [ "Configuration - Device SSL Proxy Certificate Management" ], "description": "Add SSL proxy wan edge", "operationId": "addWANEdge", "parameters": [ { "name": "deviceId", "in": "path", "description": "Device Id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Cert state", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Cert state": { "description": "Cert state", "value": {} } } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Certificates-write" } }, "/sslproxy/certificates": { "post": { "tags": [ "Configuration - Device SSL Proxy Certificate Management" ], "description": "Upload device certificates", "operationId": "uploadCertificiates", "requestBody": { "description": "Certificate file", "content": { "multipart/form-data": { "schema": { "type": "object" }, "examples": { "Certificate file": { "description": "Certificate file" } } } }, "required": true }, "responses": { "200": { "description": "Success" }, "207": { "description": "Multi-status" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Certificates-write" } }, "/sslproxy/csr": { "get": { "tags": [ "Configuration - Device SSL Proxy Certificate Management" ], "description": "Get SSL proxy CSR", "operationId": "getSslProxyCSR", "parameters": [ { "name": "deviceId", "in": "query", "description": "device UUID", "required": true, "schema": { "type": "string", "example": "8d86d8b2-2239-402e-9fef-467f7bad3f2f" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "CSR": { "description": "CSR", "value": { "csr": [ { "hostCommonName": "vManageCA_vm12", "csr": "-----BEGIN NEW CERTIFICATE REQUEST-----\n...\n-----END NEW CERTIFICATE REQUEST-----", "last updated": "07 Apr 2022 07:56:17 UTC", "commonName": "vManageCA", "org": "Cisco System", "orgUnit": "Cisco System", "locality": "Shanghai", "state": "Shanghai", "country": "CN", "email": "name@cisco.com" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Certificates-read,Certificates-write" } }, "/sslproxy/devicecertificates": { "post": { "tags": [ "Configuration - Device SSL Proxy Certificate Management" ], "description": "Get certificate for all cEdges", "operationId": "getAllDeviceCertificates", "requestBody": { "description": "Device list", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Device list": { "description": "Device list", "value": [ { "uuid": "C8K-2e556375-5d15-420b-aa4d-dd3e5072e585" } ] } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Certificate": { "description": "Certificate", "value": "{ \"header\": { \"generatedOn\": 1650355912089 }, \"data\": [ { \"certificate\": \"-----BEGIN CERTIFICATE-----\\n...\\n-----END CERTIFICATE-----\", \"uuid\": \"C8K-2e556375-5d15-420b-aa4d-dd3e5072e585\" } ]}}" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Certificates-read,Certificates-write" } }, "/sslproxy/devicecsr": { "post": { "tags": [ "Configuration - Device SSL Proxy Certificate Management" ], "description": "Get CSR for all cEdges", "operationId": "getAllDeviceCSR", "requestBody": { "description": "Device list", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Device list": { "description": "Device list", "value": [ { "uuid": "C8K-2e556375-5d15-420b-aa4d-dd3e5072e585" } ] } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "CSR": { "description": "CSR", "value": { "header": { "generatedOn": 1650354738278 }, "data": [ { "csr": "-----BEGIN CERTIFICATE REQUEST-----\n...\n-----END CERTIFICATE REQUEST-----", "uuid": "C8K-2e556375-5d15-420b-aa4d-dd3e5072e585" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Certificates-read,Certificates-write" } }, "/sslproxy/generate/csr/sslproxy": { "post": { "tags": [ "Configuration - Device SSL Proxy Certificate Management" ], "description": "CSR request SSL proxy for edge", "operationId": "generateSslProxyCSR", "requestBody": { "description": "CSR request for edge", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "CSR request for edge": { "description": "CSR request for edge" } } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true, "x-roles-required": "Certificates-write" } }, "/sslproxy/generate/vmanage/csr": { "post": { "tags": [ "Configuration - Device SSL Proxy Certificate Management" ], "description": "Generate CSR", "operationId": "generateSSLProxyCSR", "requestBody": { "description": "CSR request", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "CSR request": { "description": "CSR request", "value": { "commonName": "vManageCA", "org": "Cisco System", "orgUnit": "Cisco System", "locality": "Shanghai", "state": "Shanghai", "country": "CN", "email": "name@cisco.com", "intermediateCA": "true" } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Task Id": { "description": "Task Id", "value": { "id": "ba6586b6-6caf-4eac-a6ae-ec4d57d0fe2c" } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Certificates-write" } }, "/sslproxy/list": { "get": { "tags": [ "Configuration - Device SSL Proxy Certificate Management" ], "description": "Get SSL proxy certificate list", "operationId": "getSslProxyList", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "Certificate list": { "description": "Certificate list", "value": [ { "deviceModel": "vedge-C8000V", "chasisNumber": "C8K-2e556375-5d15-420b-aa4d-dd3e5072e585", "configuredHostname": "vm5", "managementSystemIP": "172.16.255.15", "deviceSerialNumber": "12345712", "configuredSiteId": "500", "commonName": "C8K-2e556375-5d15-420b-aa4d-dd3e5072e585", "csr": "-----BEGIN CERTIFICATE REQUEST-----\n...\n-----END CERTIFICATE REQUEST-----", "serialNumber": "", "@rid": 1023, "last updated": "07 Apr 2022 09:07:34 UTC", "certificate": "-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----", "state": "CSR_GENERATED", "uuid": "C8K-2e556375-5d15-420b-aa4d-dd3e5072e585", "scep": false, "expirationDate": "Apr 08 09:07:34 2022 UTC", "hasCert": true, "hasCSR": true, "hasEnterpriseCert": false } ] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Certificates-read,Certificates-write" } }, "/sslproxy/renew": { "post": { "tags": [ "Configuration - Device SSL Proxy Certificate Management" ], "description": "Renew device certificate", "operationId": "renewCertificate", "requestBody": { "description": "Renew device certificate request", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Renew device certificate request": { "description": "Renew device certificate request", "value": { "uuid": "C8K-2e556375-5d15-420b-aa4d-dd3e5072e585" } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Task Id": { "description": "Task Id", "value": { "id": "0ed22d4e-ba07-4828-9bd6-f3ea9d281513" } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Certificates-write" } }, "/sslproxy/revoke": { "post": { "tags": [ "Configuration - Device SSL Proxy Certificate Management" ], "description": "Revoke device certificate", "operationId": "revokeCertificate", "requestBody": { "description": "Revoke device certificate request", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Revoke device certificate request": { "description": "Revoke device certificate request", "value": { "uuid": "C8K-2e556375-5d15-420b-aa4d-dd3e5072e585", "revokeReason": "Unspecified" } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Task Id": { "description": "Task Id", "value": { "id": "e23238cc-8b2f-49ed-9ce4-4c68c06fa6f4" } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Certificates-write" } }, "/sslproxy/revokerenew": { "post": { "tags": [ "Configuration - Device SSL Proxy Certificate Management" ], "description": "Revoke and renew device certificate", "operationId": "revokeRenewCertificate", "requestBody": { "description": "Revoke device certificate request", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Revoke and renew device certificate request": { "description": "Revoke and renew device certificate request", "value": { "uuid": "C8K-2e556375-5d15-420b-aa4d-dd3e5072e585", "revokeReason": "Unspecified" } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Task Id": { "description": "Task Id", "value": { "id": "e23238cc-8b2f-49ed-9ce4-4c68c06fa6f4" } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Certificates-write" } }, "/sslproxy/settings/certificate": { "get": { "tags": [ "Configuration - Device SSL Proxy Certificate Management" ], "description": "Get certificate state", "operationId": "getCertificateState", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Certificate State": { "description": "Certificate State", "value": { "enterpriseCA": false, "vManageRootCA": true } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Certificates-read,Certificates-write" } }, "/sslproxy/settings/enterprise/certificate": { "post": { "tags": [ "Configuration - Device SSL Proxy Certificate Management" ], "description": "Configure enterprise certificate", "operationId": "setEnterpriseCert", "requestBody": { "description": "Config enterprise certificate request", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Enterprise certificate request": { "description": "Enterprise certificate request", "value": { "scep": "false", "enterpriseRootCA": "-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----" } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Certificate": { "description": "Certificate", "value": { "scep": false, "last updated": "07 Apr 2022 03:45:59 UTC", "commonName": "OCSP-CA", "enterpriseRootCA": "-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----", "fingerprint": "db06d0f8799353eabbc47bb201321d54f5086289" } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Certificates-write" }, "get": { "tags": [ "Configuration - Device SSL Proxy Certificate Management" ], "description": "Get enterprise certificate", "operationId": "getEnterpriseCertificate", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Enterprise certificate": { "description": "Enterprise certificate", "value": { "scep": false, "last updated": "07 Apr 2022 03:45:59 UTC", "commonName": "OCSP-CA", "enterpriseRootCA": "-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----", "fingerprint": "db06d0f8799353eabbc47bb201321d54f5086289" } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Certificates-read,Certificates-write" } }, "/sslproxy/settings/enterprise/rootca": { "post": { "tags": [ "Configuration - Device SSL Proxy Certificate Management" ], "description": "Set vManage enterprise root certificate", "operationId": "setEnterpriseRootCaCert", "requestBody": { "description": "Set enterprise root CA request", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Enterprise root CA": { "description": "Enterprise root CA", "value": { "enterpriseRootCA": "-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----", "intermediateCA": "true" } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Enterprise root certificate": { "description": "Enterprise root certificate", "value": { "enterpriseRootCA": "-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----", "fingerprint": "db06d0f8799353eabbc47bb201321d54f5086289", "last updated": "07 Apr 2022 03:53:12 UTC" } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Certificates-write" }, "get": { "tags": [ "Configuration - Device SSL Proxy Certificate Management" ], "description": "Get vManage enterprise root certificate", "operationId": "getVManageEnterpriseRootCertificate", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Enterprise root certificate": { "description": "Enterprise root certificate", "value": { "enterpriseRootCA": "-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----", "fingerprint": "db06d0f8799353eabbc47bb201321d54f5086289", "last updated": "07 Apr 2022 03:53:12 UTC" } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Certificates-read,Certificates-write" } }, "/sslproxy/settings/vmanage/certificate": { "get": { "tags": [ "Configuration - Device SSL Proxy Certificate Management" ], "description": "Get vManage intermediate certificate", "operationId": "getvManageCertificate", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "vManage intermediate certificate": { "description": "vManage intermediate certificate", "value": { "header": { "generatedOn": 1649322823353 }, "data": [ { "vManageRootCA": "-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----", "hostCommonName": "vManageCA_vm12", "commonName": "vManageCA_vm12", "fingerprint": "fcb9c623aa9022354fecd95b1f355e1372802aeb", "last updated": "07 Apr 2022 07:56:17 UTC", "intermediateCA": "true" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Certificates-read,Certificates-write" }, "post": { "tags": [ "Configuration - Device SSL Proxy Certificate Management" ], "description": "Set vManage root certificate", "operationId": "setvManageintermediateCert", "requestBody": { "description": "Set vManage intermediate CA request", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "vManage intermediate CA": { "description": "vManage intermediate CA", "value": { "data": [ { "commonName": "vManageCA_vm12", "vManageRootCA": "-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----", "intermediateCA": "true" } ] } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "vManage intermediate certificate": { "description": "vManage intermediate certificate", "value": { "header": { "generatedOn": 1649318177975 }, "data": [ { "vManageRootCA": "-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----", "hostCommonName": "vManageCA_vm12", "commonName": "vManageCA_vm12", "fingerprint": "fcb9c623aa9022354fecd95b1f355e1372802aeb", "last updated": "07 Apr 2022 07:56:17 UTC", "intermediateCA": "true" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Certificates-write" } }, "/sslproxy/settings/vmanage/csr": { "get": { "tags": [ "Configuration - Device SSL Proxy Certificate Management" ], "description": "Get vManage CSR", "operationId": "getvManageCSR", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "vManage CSR": { "description": "vManage CSR", "value": { "csr": [ { "hostCommonName": "vManageCA_vm12", "csr": "-----BEGIN NEW CERTIFICATE REQUEST-----\n...\n-----END NEW CERTIFICATE REQUEST-----", "last updated": "07 Apr 2022 04:37:37 UTC", "commonName": "vManageCA", "org": "Cisco System", "orgUnit": "Cisco System", "locality": "Shanghai", "state": "Shanghai", "country": "CN", "email": "name@cisco.com" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Certificates-read,Certificates-write" } }, "/sslproxy/settings/vmanage/rootca": { "post": { "tags": [ "Configuration - Device SSL Proxy Certificate Management" ], "description": "Set vManage root certificate", "operationId": "setvManageRootCA", "requestBody": { "description": "Set vManage root CA request", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "vManage root CA": { "description": "vManage root CA", "value": { "commonName": "vManageRootCa", "org": "Cisco System", "orgUnit": "Cisco System", "locality": "Shanghai", "state": "Shanghai", "country": "CN", "validity": 10, "email": "name@cisco.com" } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "vManage root certificate": { "description": "vManage root certificate", "value": { "id": "4aa25a65-b65a-443c-9ebf-21d1dee0ed20" } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Certificates-write" }, "get": { "tags": [ "Configuration - Device SSL Proxy Certificate Management" ], "description": "Get vManage root certificate", "operationId": "getvManageRootCA", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "vManage root certificate": { "description": "vManage root certificate", "value": { "header": { "generatedOn": 1649300400918 }, "data": [ { "vManageRootCA": "...", "publickey": "-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----", "csr": "-----BEGIN NEW CERTIFICATE REQUEST-----\n...\n-----END NEW CERTIFICATE REQUEST-----", "hostCommonName": "vManageRootCa_vm12", "last updated": "07 Apr 2022 02:59:59 UTC", "uuid": "3a0733ad-3967-4f71-b4fc-a64c3f634366", "fingerprint": "1aef4396ce2c71e5df49c448a5eb49b488e9305b", "commonName": "vManageRootCa", "org": "Cisco System", "orgUnit": "Cisco System", "locality": "Shanghai", "state": "Shanghai", "country": "CN", "email": "name@cisco.com", "validity": "10" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Certificates-read,Certificates-write" } }, "/statistics/dynamic/collect": { "get": { "tags": [ "Setting - Dynamic Scheduler" ], "description": "Get statistics dynamic collection setting", "operationId": "getDynamicCollection", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "enabled": { "type": "boolean", "example": true } }, "$$ref": "#/components/schemas/DynamicSchedulerResponse" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "admin" }, "post": { "tags": [ "Setting - Dynamic Scheduler" ], "description": "Enable/Disable statistics dynamic collection", "operationId": "setDynamicCollection", "parameters": [ { "name": "enable", "in": "query", "required": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "admin" } }, "/system/device": { "post": { "tags": [ "Configuration - Device Inventory" ], "description": "Create new device


Note: In a multitenant vManage system, this API is only available in the Provider view 123.", "operationId": "createDevice", "requestBody": { "description": "Create device request", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Create device request": { "description": "Create device request", "value": { "deviceIP": "1.1.1.1", "username": "cisco", "password": "cisco", "personality": "vbond", "generateCSR": true, "genCsrParams": { "schedule": true, "scheduleAt": 1729495932, "autoRenew": false, "keyLength": "2048", "resetRSA": true } }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigSystemDeviceSystemdeviceapiRequestExampleSystemdevicegencsrparams" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Example Value": { "description": "Example Value", "value": { "uuid": "2250234c-5305-41f7-a0fe-b52fcbd92833" }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigSystemDeviceSystemdeviceapiResponseExampleDeviceaddresponse" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/system/device/bootstrap/device/{uuid}": { "get": { "tags": [ "Configuration - Device Inventory" ], "description": "Create vEdge device config", "operationId": "generateBootstrapConfigForVedge", "parameters": [ { "name": "uuid", "in": "path", "description": "Device UUID", "required": true, "schema": { "type": "string" }, "example": "ESR-6300-LIC-K9-FAUSTEST126" }, { "name": "configtype", "in": "query", "description": "configtype", "required": true, "schema": { "type": "string" }, "example": "cloudinit" }, { "name": "inclDefRootCert", "in": "query", "required": true, "schema": { "type": "boolean", "default": true } }, { "name": "version", "in": "query", "schema": { "type": "string", "default": "v1" } }, { "name": "wanif", "in": "query", "description": "wanif", "schema": { "type": "string" }, "example": "GigabitEthernet1" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "bootstrapConfig": { "type": "string", "example": "#cloud-config\\nvinitparam:\\n - uuid : ESR-6300-LIC-K9-FAUSTEST126\\n - vbond : 10.0.12.26\\n - org : vIPtela Inc Regression\\n" } }, "$$ref": "#/components/schemas/GenerateBootstrapConfigForVedge" }, "examples": { "Device bootstrap configuration": { "description": "Device bootstrap configuration", "value": { "bootstrapConfig": "#cloud-config\\ninitparam:\\n - uuid : ESR-6300-LIC-K9-FAUSTEST126\\n - vbond : 10.0.12.26\\n - org : vIPtela Inc Regression\\n" }, "$$ref": "#/components/examples/ComViptelaVmanageServerBootstrapDevicelifecycleapiResponseExampleGetbootstrapdevice" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/system/device/bootstrap/devices": { "post": { "tags": [ "Configuration - Device Inventory" ], "description": "Create bootstrap config for software vEdges", "operationId": "generateBootstrapConfigForVedges", "requestBody": { "description": "Request body for Device bootstrap configuration", "content": { "application/json": { "schema": { "type": "object", "properties": { "bootstrapConfigType": { "type": "string" }, "uuid": { "type": "array", "items": { "type": "string" } } }, "$$ref": "#/components/schemas/VEdgeBootstrapConfig" }, "examples": { "Example Value": { "description": "Example Value", "value": { "bootstrapConfig": "#cloud-config\\ninitparam:\\n - uuid : ESR-6300-LIC-K9-FAUSTEST126\\n - vbond : 10.0.12.26\\n - org : vIPtela Inc Regression\\n" }, "$$ref": "#/components/examples/ComViptelaVmanageServerBootstrapDevicelifecycleapiRequestExamplePostbootstrapdevices" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "b1af2563-cfa0-4ebb-989b-4d5e87f92d45" } }, "$$ref": "#/components/schemas/GenerateBootstrapConfigForVedgesResponse" }, "examples": { "Device bootstrap configuration": { "description": "Device bootstrap configuration", "value": { "id": "b1af2563-cfa0-4ebb-989b-4d5e87f92d45" }, "$$ref": "#/components/examples/ComViptelaVmanageServerBootstrapDevicelifecycleapiResponseExamplePostbootstrapdevicesresp" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/system/device/bootstrap/download/{id}": { "get": { "tags": [ "Configuration - Device Inventory" ], "description": "Download vEdge device config", "operationId": "getBootstrapConfigZip", "parameters": [ { "name": "id", "in": "path", "description": "id", "required": true, "schema": { "type": "string" }, "example": "b4d93025-cf37-41a5-a2a6-d9113ede034c" } ], "responses": { "200": { "description": "Success", "content": { "application/octet-stream": { "schema": { "type": "object", "properties": { "file": { "type": "string", "example": "binary" } }, "$$ref": "#/components/schemas/GetBootstrapConfigZip" }, "examples": { "Device bootstrap configuration": { "description": "Device bootstrap configuration", "value": { "file": "binary" }, "$$ref": "#/components/examples/ComViptelaVmanageServerBootstrapDevicelifecycleapiResponseExampleBootstrapdownloadid" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/system/device/bootstrap/generic/devices": { "get": { "tags": [ "Configuration - Device Inventory" ], "description": "Create bootstrap config for software vEdges", "operationId": "generateGenericBootstrapConfigForVedges", "parameters": [ { "name": "wanif", "in": "query", "description": "Device WAN interface", "schema": { "type": "string" }, "example": "GigabitEthernet1" }, { "name": "sdRoutingDevice", "in": "query", "description": "Flag indicating if this is SD-Routing device", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "b4d93025-cf37-41a5-a2a6-d9113ede034c" } }, "$$ref": "#/components/schemas/GenerateGenericBootstrapConfigForVedges" }, "examples": { "Task Id": { "description": "Task Id", "value": { "id": "236c21b2-4f1d-4961-82a9-9ac05df1c1c1" }, "$$ref": "#/components/examples/ComViptelaVmanageServerBootstrapDevicelifecycleapiResponseExampleBootstrapgenericdevices" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/system/device/claimDevices": { "post": { "tags": [ "Configuration - Device Inventory" ], "description": "Claim the selected unclaimed devices", "operationId": "claimDevices", "requestBody": { "description": "Claim device request", "content": { "application/json": { "schema": { "type": "object", "properties": { "chassis_list": { "type": "array", "items": { "type": "object", "properties": { "chassis-serial-number": { "type": "string", "example": "SSI130300YK" }, "configuredAaaUser": { "type": "array", "items": { "type": "string" } }, "device-model": { "type": "string", "example": "C8000v" }, "device-os": { "type": "string", "example": "next" }, "device-type": { "type": "string", "example": "vedge" }, "deviceId": { "type": "string", "example": "C8K-cfb84064-12e9-4f7c-b9d9-bf78ce4dfb5f" }, "devicesAttached": { "type": "integer", "format": "int32", "example": 0 }, "discoveredDeviceInterfaces": { "type": "array", "items": { "type": "string" } }, "host-name": { "type": "string", "example": "vm5" }, "loopback": { "type": "array", "items": { "type": "object", "properties": { "interfaceIP": { "type": "string", "example": "127.0.0.1" }, "interfaceName": { "type": "string", "example": "Loopback0" } }, "$$ref": "#/components/schemas/Loopback" } }, "personality": { "type": "string", "example": "vedge" }, "platform": { "type": "string", "example": "x86_64" }, "reachability": { "type": "string", "example": "reachable", "enum": [ "reachable", "unreachable" ] }, "registrationDate": { "type": "integer", "format": "int64", "example": 1590186370340 }, "serialNumber": { "type": "string", "example": "12345712" }, "site-id": { "type": "string", "example": "500" }, "state": { "type": "string", "example": "green" }, "status": { "type": "string", "example": "normal", "enum": [ "error", "warning", "normal", "new" ] }, "system-ip": { "type": "string", "example": "172.16.255.15" }, "templateStatus": { "type": "string", "example": "Success" }, "uuid": { "type": "string", "example": "C8K-cfb84064-12e9-4f7c-b9d9-bf78ce4dfb5f" }, "validity": { "type": "string", "example": "valid", "enum": [ "invalid", "staging", "valid", "prestaging" ] }, "version": { "type": "string", "example": "17.06.01.0.1422" }, "wanInterfaces": { "type": "array", "items": { "type": "string" } } }, "$$ref": "#/components/schemas/Device" } }, "organization": { "type": "string" }, "validityString": { "type": "string" } }, "$$ref": "#/components/schemas/ClaimDevicesRequest" }, "examples": { "Claim device request": { "description": "Claim device request", "value": { "organization": "srikann-viptela", "validityString": "valid", "chassis_list": [ { "chassis-number": "ISR4351/K9-FDO23070Y63", "serial-number": "383CB73", "subject-serial-number": "FDO23070Y63" } ] }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigSystemDeviceSystemdeviceapiRequestExampleClaimdevices" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "activityList": { "type": "string", "example": "[Number of vEdges uploaded successfully: 1, Uploaded vEdges (chassis Id, serial number): , - ISR4351/K9-FDO23070Y63, 383CB73]" }, "id": { "type": "string", "example": "7d77139d-5bed-4e82-8ea5-411a588a522e" }, "vedgeListUploadMsg": { "type": "string", "example": " of vEdges uploaded successfully: 1" }, "vedgeListUploadStatus": { "type": "string", "example": "vEdge list uploaded successfully" } }, "$$ref": "#/components/schemas/ClaimDevicesResponse" }, "examples": { "Claimed device info": { "description": "Claimed device info", "value": { "vedgeListUploadMsg": " of vEdges uploaded successfully: 1", "vedgeListUploadStatus": "vEdge list uploaded successfully", "id": "7d77139d-5bed-4e82-8ea5-411a588a522e", "activityList": "[Number of vEdges uploaded successfully: 1, Uploaded vEdges (chassis Id, serial number): , - ISR4351/K9-FDO23070Y63, 383CB73]" }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigSystemDeviceSystemdeviceapiResponseExampleClaimdevicesresp" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/system/device/controllers/vedge/status": { "get": { "tags": [ "Configuration - Device Inventory" ], "description": "Get controllers vEdge sync status", "operationId": "getControllerVEdgeSyncStatus_ConfigurationDeviceInventory_3903", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "vEdge status": { "description": "vEdge status", "value": { "data": { "totalControllers": 4, "ControllersOutOfSync": 1, "tenantList": [ { "tenant": "tenantName", "deviceType": "vedge", "chasisNumber": "71001c48-fdcf-4ac0-aaf3-ca4a20386a18", "serialNumber": "f0b1985ba82e4c4889c225c59ca9a878", "managementSystemIP": "172.18.47.115" } ] } }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigSystemDeviceSystemdeviceapiResponseExampleControllersvedgestatus" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" } }, "/system/device/decommission/{uuid}": { "put": { "tags": [ "Configuration - Device Inventory" ], "description": "Decomission vEdge device", "operationId": "decommissionVedgeCloud", "parameters": [ { "name": "uuid", "in": "path", "description": "Device uuid", "required": true, "schema": { "type": "string" }, "example": "C8K-f9f4a977-be6c-47f7-b3b2-10e916bb24db" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "b2afb474-f943-45b6-b673-f51b393ff924" } }, "$$ref": "#/components/schemas/DecommissionVedgeCloud" }, "examples": { "Task id": { "description": "Task id", "value": { "id": "b2afb474-f943-45b6-b673-f51b393ff924" }, "$$ref": "#/components/examples/ComViptelaVmanageServerBootstrapDevicelifecycleapiResponseExampleDecommissionuuid" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/system/device/devicesWithoutSubjectSudi": { "get": { "tags": [ "Configuration - Device Inventory" ], "description": "retrieve devices without subject sudi", "operationId": "devicesWithoutSubjectSudi", "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" } } } }, "/system/device/fileupload": { "post": { "tags": [ "Configuration - Device Inventory" ], "description": "Upload file to vEdge", "operationId": "formPost", "requestBody": { "description": "Request body for Upload file to vEdge", "content": { "multipart/form-data": { "schema": { "type": "object" }, "examples": { "Example Value": { "description": "Example Value", "value": { "data": { "validity": "valid", "upload": true }, "file": "binary" }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigSystemDeviceSystemdeviceapiRequestExampleFileupload" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "activityList": { "type": "string", "example": "[Number of vEdges uploaded successfully: 1, Uploaded vEdges (chassisId, serial number): , - ESR-6300-LIC-K9-FAUSTEST126, 030557201979336385BE]" }, "id": { "type": "string", "example": "b5091b8e-e5ea-4096-8e4c-f17d0d60f2dd" }, "vedgeListUploadMsg": { "type": "string", "example": "Number of vEdges uploaded successfully: 1" }, "vedgeListUploadStatus": { "type": "string", "example": "vEdge list uploaded successfully" } }, "$$ref": "#/components/schemas/FormPostResp" }, "examples": { "Example": { "description": "Example", "value": { "vedgeListUploadMsg": "Number of vEdges uploaded successfully: 1", "vedgeListUploadStatus": "vEdge list uploaded successfully", "id": "b5091b8e-e5ea-4096-8e4c-f17d0d60f2dd", "activityList": "[Number of vEdges uploaded successfully: 1, Uploaded vEdges (chassisId, serial number): , - ESR-6300-LIC-K9-FAUSTEST126, 030557201979336385BE]" }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigSystemDeviceSystemdeviceapiResponseExampleFileuploadresp" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/system/device/generate-payg": { "post": { "tags": [ "Configuration - Device Inventory" ], "description": "Authenticate vSmart user account", "operationId": "validateUser", "requestBody": { "description": "Request body", "content": { "multipart/form-data": { "schema": { "type": "object" }, "examples": { "Example Value": { "description": "Example Value", "value": { "numPaygDevices": 2, "validity": "invalid", "organization": "vIPtela Inc Regression" }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigSystemDeviceSystemdeviceapiRequestExampleGeneratepayg" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Example": { "description": "Example", "value": { "vedgeListAddMsg": "Number of PAYG vEdges added successfully: 2", "vedgeListAddStatus": "PAYG vEdge list added successfully", "id": "42ce4e4e-aaea-4dcd-9507-037ee42a06e5", "activityList": "[Number of PAYG vEdges added successfully: 2, Added PAYG vEdges (chassis Id, serial number): , - C8K-PAYG-b44-e6aa-4d42-a637-82fd74ec523b, 6573ef62902e447db063dab76613b2c3, - C8K-PAYG-083-f30e-40b5-80fe-55f401a4839b, aa82b3bb8cda48b7b3693bc70fd1a0bb]" }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigSystemDeviceSystemdeviceapiResponseExampleGeneratepaygresp" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Inventory-write,Device Inventory > Edge-write" } }, "/system/device/lifecycle/management/{uuid}": { "post": { "tags": [ "Configuration - Device Inventory" ], "description": "Set device lifecycle needed flag", "operationId": "setLifeCycle", "parameters": [ { "name": "uuid", "in": "path", "description": "Device uuid", "required": true, "schema": { "type": "string" }, "example": "0cee8b1d-1d2c-4c8b-a111-4b17ce9dd473" }, { "name": "enable", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "DeviceLifeCycleNeeded": { "type": "boolean", "example": false } }, "$$ref": "#/components/schemas/SetLifeCycle" }, "examples": { "Device lifecycle needed value": { "description": "Device lifecycle needed value", "value": { "DeviceLifeCycleNeeded": false }, "$$ref": "#/components/examples/ComViptelaVmanageServerBootstrapDevicelifecycleapiResponseExampleLifecyclemanagement" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/system/device/management/systemip": { "get": { "tags": [ "Configuration - Device Inventory" ], "description": "Get management system IP mapping", "operationId": "getManagementSystemIPInfo_ConfigurationDeviceInventory_3403", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "System IP mapping": { "description": "System IP mapping", "value": { "data": [ { "deviceType": "vbond", "serialNumber": "12345712", "managementSystemIP": "172.16.255.26", "chasisNumber": "b679806c-d107-4c2b-bc80-4665f1ab87a8" } ] }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigSystemDeviceSystemdeviceapiResponseExampleManagementsystemip" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" } }, "/system/device/migrateDevice/{uuid}": { "put": { "tags": [ "Configuration - Device Inventory" ], "description": "Migrate device software to vedge/cedge", "operationId": "migrateDevice", "parameters": [ { "name": "uuid", "in": "path", "description": "Device uuid", "required": true, "schema": { "type": "string" }, "example": "cad0e65b-86b5-48af-8c26-5a470ea68166" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Device migration result": { "description": "Device migration result", "value": {}, "$$ref": "#/components/examples/ComViptelaVmanageServerBootstrapDevicelifecycleapiResponseExampleMigratedevice" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/system/device/quickconnect/smartaccount/sync": { "post": { "tags": [ "Configuration - Device Inventory" ], "description": "Sync devices from Smart-Account", "operationId": "getSmartAccountDevices", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "accessToken": { "type": "string" }, "clientCredentials": { "type": "boolean" }, "env": { "type": "string" }, "organization_name": { "type": "string" }, "password": { "type": "string" }, "username": { "type": "string" }, "validity_string": { "type": "string" } }, "$$ref": "#/components/schemas/SmartAccountModel" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "processId": { "type": "string", "example": "c82d4877-dc04-4580-aedc-3a10166dab4d" } }, "$$ref": "#/components/schemas/SyncDevicesResp" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/system/device/reset/{uuid}": { "put": { "tags": [ "Configuration - Device Inventory" ], "description": "Reset vEdge device", "operationId": "resetVedgeCloud", "parameters": [ { "name": "uuid", "in": "path", "description": "Device uuid", "required": true, "schema": { "type": "string" }, "example": "cad0e65b-86b5-48af-8c26-5a470ea68166" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "36023ff2-42e9-4074-88d9-75bb995b1411" } }, "$$ref": "#/components/schemas/ResetVedgeCloud" }, "examples": { "Task id": { "description": "Task id", "value": { "id": "36023ff2-42e9-4074-88d9-75bb995b1411" }, "$$ref": "#/components/examples/ComViptelaVmanageServerBootstrapDevicelifecycleapiResponseExampleReset" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/system/device/rma/candidates/{deviceType}": { "get": { "tags": [ "Configuration - Device Inventory" ], "description": "Get RMA candidates by device type", "operationId": "getRMACandidates", "parameters": [ { "name": "deviceType", "in": "path", "description": "deviceType", "required": true, "schema": { "type": "string" }, "example": "controller" }, { "name": "uuid", "in": "query", "description": "uuid", "schema": { "type": "string" }, "example": "ec7af44a-8731-442d-9b5e-62f3dc407454" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "deviceIP": { "type": "string", "example": "172.16.255.19" }, "host-name": { "type": "string", "example": "vm-9" }, "managementSystemIP": { "type": "string", "example": "172.16.255.19" }, "uuid": { "type": "string", "example": "ec7af44a-8731-442d-9b5e-62f3dc407454" }, "validity": { "type": "string", "example": "valid" } }, "$$ref": "#/components/schemas/GetRMACandidates" }, "examples": { "Device type": { "description": "Device type", "value": { "uuid": "ec7af44a-8731-442d-9b5e-62f3dc407454", "deviceIP": "172.16.255.19", "validity": "valid", "managementSystemIP": "172.16.255.19", "host-name": "vm-9" }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigSystemDeviceSystemdeviceapiResponseExampleRmacandidates" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/system/device/rootcertchain/status": { "get": { "tags": [ "Configuration - Device Inventory" ], "description": "Get controllers vEdge sync status", "operationId": "getRootCertStatusAll", "parameters": [ { "name": "state", "in": "query", "description": "state", "required": true, "schema": { "type": "string" }, "example": "pending/done" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "lastUpdateTime": { "type": "string", "example": "2023-05-02 07:41:34" }, "rootCertMd5": { "type": "string", "example": "8b147197d6dbde1f89db5909c594d88b13a5c8bc" }, "rootCertStatus": { "type": "string", "example": "done" } }, "$$ref": "#/components/schemas/GetRootCertStatusAllData" } } }, "$$ref": "#/components/schemas/GetRootCertStatusAll" }, "examples": { "vEdge sync status": { "description": "vEdge sync status", "value": { "data": [ { "rootCertStatus": "done", "rootCertMd5": "8b147197d6dbde1f89db5909c594d88b13a5c8bc", "lastUpdateTime": "2023-05-02 07:41:34" } ] }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigSystemDeviceSystemdeviceapiResponseExampleRootcertchainstatus" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/system/device/selfsignedcert/iscreated": { "get": { "tags": [ "Configuration - Device Inventory" ], "description": "Whether self signed certificate created", "operationId": "checkSelfSignedCert_ConfigurationDeviceInventory_3903", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Self signed certificate created": { "description": "Self signed certificate created", "value": { "vedgeListUploadMsg": "Number of vEdges uploaded successfully: 1", "vedgeListUploadStatus": "vEdge list uploaded successfully", "id": "b5091b8e-e5ea-4096-8e4c-f17d0d60f2dd", "activityList": "[Number of vEdges uploaded successfully: 1, Uploaded vEdges (chassisId, serial number): , - ESR-6300-LIC-K9-FAUSTEST126, 030557201979336385BE]" }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigSystemDeviceSystemdeviceapiResponseExampleSelfsignedcertiscreated" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "admin" } }, "/system/device/smartaccount/authenticate": { "post": { "tags": [ "Configuration - Device Inventory" ], "description": "Authenticate vSmart user account", "operationId": "smartAccountAuthenticate", "requestBody": { "description": "Claim device request", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Smartaccount Authenticate Request": { "description": "Smartaccount Authenticate Request", "value": { "env": "staging", "organization_name": "srikann-viptela", "username": "srikann", "password": "******", "validity_string": "invalid" }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigSystemDeviceSystemdeviceapiRequestExampleSmartaccountauthenticate" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "accessToken": { "type": "string", "example": "V6tBFRhpCQkng5Ng7nTxn8WBiJRj" } }, "$$ref": "#/components/schemas/SmartAccountAuthenticateResponse" }, "examples": { "Access token": { "description": "Access token", "value": { "accessToken": "V6tBFRhpCQkng5Ng7nTxn8WBiJRj" }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigSystemDeviceSystemdeviceapiResponseExampleSmartaccountauthenticateresp" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/system/device/smartaccount/sync": { "post": { "tags": [ "Configuration - Device Inventory" ], "description": "Sync devices from Smart-Account", "operationId": "syncDevices", "requestBody": { "description": "Request body for Sync devices from Smart-Account", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Example Value": { "description": "Example Value", "value": { "username": "aryagarw@cisco.com", "password": "password", "validity_string": "invalid" }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigSystemDeviceSystemdeviceapiRequestExampleSmartaccountsync" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "processId": { "type": "string", "example": "c82d4877-dc04-4580-aedc-3a10166dab4d" } }, "$$ref": "#/components/schemas/SyncDevicesResp" }, "examples": { "Example Value": { "description": "Example Value", "value": { "processId": "c82d4877-dc04-4580-aedc-3a10166dab4d" }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigSystemDeviceSystemdeviceapiResponseExampleSmartaccountsyncresp" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/system/device/sync/rootcertchain": { "get": { "tags": [ "Configuration - Device Inventory" ], "description": "Sync root certificate", "operationId": "syncRootCertChain", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "syncRootCertChain": { "type": "string", "example": "done" } }, "$$ref": "#/components/schemas/SyncRootCertChain" }, "examples": { "Example": { "description": "Example", "value": { "syncRootCertChain": "done" }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigSystemDeviceSystemdeviceapiResponseExampleSyncrootcertchain" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/system/device/tenant/management/systemip": { "get": { "tags": [ "Configuration - Device Inventory" ], "description": "Get management system IP


Note: In a multitenant vManage system, this API is only available in the Provider view.", "operationId": "getTenantManagementSystemIPs", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "properties": { "empty": { "type": "boolean" } }, "items": { "type": "object", "properties": { "chasisNumber": { "type": "string", "example": "6a417181-11ba-4753-a68b-0e72440ebb49" }, "deviceType": { "type": "string", "example": "vsmart" }, "managementSystemIP": { "type": "string", "example": "169.254.10.6" }, "serialNumber": { "type": "string", "example": "12445B57" } }, "$$ref": "#/components/schemas/GetTenantManagementSystemIPsInner" }, "$$ref": "#/components/schemas/GetTenantManagementSystemIPs" }, "examples": { "System IP": { "description": "System IP", "value": [ { "deviceType": "vsmart", "serialNumber": "12445B57", "managementSystemIP": "169.254.10.6", "chasisNumber": "6a417181-11ba-4753-a68b-0e72440ebb49" } ], "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigSystemDeviceSystemdeviceapiResponseExampleTenantmanagementsystemip" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/system/device/type/{deviceCategory}": { "get": { "tags": [ "Configuration - Device Inventory" ], "description": "Get devices details", "operationId": "getCloudDockDataBasedOnDeviceType", "parameters": [ { "name": "deviceCategory", "in": "path", "description": "Device category", "required": true, "schema": { "type": "string", "enum": [ "vedges", "controllers" ] } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "Device info": { "description": "Device info", "value": [] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true, "x-roles-required": "Device Monitoring-read,dca" } }, "/system/device/type/{deviceCategory}/defaultConfig": { "get": { "tags": [ "Configuration - Device Inventory" ], "description": "Get devices default config", "operationId": "getCloudDockDefaultConfigBasedOnDeviceType", "parameters": [ { "name": "deviceCategory", "in": "path", "description": "Device category", "required": true, "schema": { "type": "string", "enum": [ "vedges", "controllers" ] } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "Device default config": { "description": "Device default config", "value": [] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true, "x-roles-required": "Device Monitoring-read,dca" } }, "/system/device/unclaimedDevices": { "get": { "tags": [ "Configuration - Device Inventory" ], "description": "Get list of all unclaimed devices", "operationId": "getAllUnclaimedDevices", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "@rid": { "type": "number", "example": 8168 }, "chassis-number": { "type": "string", "example": "ISR4351/K9-FDO23070Y63" }, "createTimeStamp": { "type": "number", "example": 1693223805135 }, "lastupdated": { "type": "number", "example": 1693223805106 }, "org": { "type": "string", "example": "srikann-viptela" }, "serial-number": { "type": "string", "example": "383CB73" }, "status": { "type": "string" }, "subject-serial-number": { "type": "string", "example": "FDO23070Y63" }, "vdevice-dataKey": { "type": "string", "example": "1.1.1.2-ISR4351/K9-FDO23070Y63" }, "vdevice-host-name": { "type": "string", "example": "vbond-ztp" }, "vdevice-name": { "type": "string", "example": "1.1.1.2" }, "vmanage-system-ip": { "type": "string", "example": "1.1.1.2" } }, "$$ref": "#/components/schemas/GetAllUnclaimedDevices" }, "examples": { "Device info": { "description": "Device info", "value": { "chassis-number": "ISR4351/K9-FDO23070Y63", "vdevice-name": "1.1.1.2", "serial-number": "383CB73", "org": "srikann-viptela", "createTimeStamp": 1693223805135, "subject-serial-number": "FDO23070Y63", "vdevice-host-name": "vbond-ztp", "vdevice-dataKey": "1.1.1.2-ISR4351/K9-FDO23070Y63", "@rid": 8168, "vmanage-system-ip": "1.1.1.2", "lastupdated": 1693223805106, "status": null }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigSystemDeviceSystemdeviceapiResponseExampleUnclaimeddevices" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/system/device/updateDeviceSubjectSUDI/{uuid}": { "put": { "tags": [ "Configuration - Device Inventory" ], "description": "update subject sudi value of given device uuid", "operationId": "updateDeviceSubjectSUDI", "parameters": [ { "name": "uuid", "in": "path", "description": "Device uuid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/system/device/vedgedetection": { "get": { "tags": [ "Configuration - Device Inventory" ], "description": "Check for Vedge Device Presence", "operationId": "checkvEdgeDevicePresence", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "vEdgeDevicePresent": { "type": "boolean" } }, "description": "data field", "$$ref": "#/components/schemas/VedgeCheckResponseData" }, "header": { "type": "object", "properties": { "columns": { "type": "array", "items": { "type": "object", "properties": { "actionColumn": { "type": "boolean" }, "arrayDataType": { "type": "string" }, "color": { "type": "object", "properties": { "key": { "type": "string" }, "property": { "type": "string" }, "value": { "type": "string" } }, "$$ref": "#/components/schemas/VedgeCheckResponseHeaderColumnsColor" }, "colorProperty": { "type": "string" }, "dataType": { "type": "string" }, "defaultPropertyKey": { "type": "string" }, "defaultPropertyValue": { "type": "string" }, "display": { "type": "string" }, "displayFormat": { "type": "string" }, "editable": { "type": "boolean" }, "hideable": { "type": "boolean" }, "hostValueType": { "type": "string" }, "icon": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": "string" } }, "$$ref": "#/components/schemas/VedgeCheckResponseHeaderColumnsKeyvalue" } }, "iconProperty": { "type": "string" }, "inputFormat": { "type": "string" }, "isLeftPinned": { "type": "boolean" }, "isPinned": { "type": "boolean" }, "keyvalue": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": "string" } }, "$$ref": "#/components/schemas/VedgeCheckResponseHeaderColumnsKeyvalue" } }, "keyvalueProperty": { "type": "string" }, "maxWidth": { "type": "integer", "format": "int32" }, "minWidth": { "type": "integer", "format": "int32" }, "prependedString": { "type": "boolean" }, "property": { "type": "string" }, "sort": { "type": "object", "properties": { "direction": { "type": "string" }, "priority": { "type": "integer", "format": "int32" } }, "$$ref": "#/components/schemas/VedgeCheckResponseHeaderColumnsSort" }, "title": { "type": "string" }, "toolTipProperty": { "type": "string" }, "visible": { "type": "boolean" }, "width": { "type": "integer", "format": "int32" } }, "$$ref": "#/components/schemas/VedgeCheckResponseHeaderColumns" } }, "fields": { "type": "array", "items": { "type": "object", "properties": { "dataType": { "type": "string", "description": "dataType field" }, "display": { "type": "string", "description": "display field" }, "property": { "type": "string", "description": "property field" } }, "$$ref": "#/components/schemas/VedgeCheckResponseHeaderFields" } }, "generatedOn": { "type": "integer", "format": "int64" }, "viewKeys": { "type": "object", "properties": { "uniqueKey": { "type": "array", "items": { "type": "string" } } }, "$$ref": "#/components/schemas/VedgeCheckResponseHeaderViewKeys" } }, "description": "header field", "$$ref": "#/components/schemas/VedgeCheckResponseHeader" } }, "$$ref": "#/components/schemas/VedgeCheckResponse" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/system/device/vmanagerootca/{uuid}": { "delete": { "tags": [ "Configuration - Device Inventory" ], "description": "Invalidate vManage root CA", "operationId": "invalidateVmanageRootCA", "parameters": [ { "name": "uuid", "in": "path", "description": "Device UUID", "required": true, "schema": { "type": "string" }, "example": "930633aa-f843-4dff-a2f0-664ca97df5ae" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "VmanageRootCAInvalidated": { "type": "string", "example": "true" } }, "$$ref": "#/components/schemas/InvalidateVmanageRootCA" }, "examples": { "Device info": { "description": "Device info", "value": { "VmanageRootCAInvalidated": true }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigSystemDeviceSystemdeviceapiResponseExampleVmanagerootca" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/system/device/{deviceCategory}": { "get": { "tags": [ "Configuration - Device Inventory" ], "description": "Get devices details. When {deviceCategory = controllers}, it returns vEdge sync status, vBond, vManage and vSmart. When {deviceCategory = vedges}, it returns all available vEdge routers", "operationId": "getDevicesDetails", "parameters": [ { "name": "deviceCategory", "in": "path", "description": "Device category", "required": true, "schema": { "type": "string" }, "example": "vedges" }, { "name": "model", "in": "query", "description": "Device model", "schema": { "type": "string", "enum": [ "vedge-cloud", "vedge-1000", "vedge-2000", "vedge-100", "vedge-ISR1100-4G", "vedge-ISR1100-4GLTE", "vedge-ISR1100X-4G", "vedge-ISR1100-6G", "vedge-ISR1100X-6G", "vedge-100-B", "vedge-100-WM", "vedge-100-M", "vEdge-5000", "vedge-CSR-1000v", "vedge-IR-1101", "vedge-IR-1821", "vedge-IR-1831", "vedge-IR-1833", "vedge-IR-1835", "vedge-IR-8140H", "vedge-IR8140H-P", "vedge-IR-8340", "vedge-ESR-6300", "vedge-ISR-4331", "vedge-ISR-4321", "vedge-ISR-4351", "vedge-ISR-4221", "vedge-ISR-4221X", "vedge-ISR-4431", "vedge-ISR-4451-X", "vedge-ASR-1001-HX", "vedge-ASR-1002-X", "vedge-ASR-1002-HX", "vedge-ASR-1006-X", "vedge-C1111-8P", "vedge-C1121X-8P", "vedge-C1111X-8P", "vedge-C1111-8PLTELAW", "vedge-C1111-8PLTEEA", "vedge-C1121-8PLTEPW", "vedge-C1111-8PLTELA", "vedge-C1117-4PLTEEA", "vedge-C1126X-8PLTEP", "vedge-C1127X-8PLTEP", "vedge-C1127X-8PMLTEP", "vedge-C1127-8PMLTEP", "vedge-C1117-4PLTELA", "vedge-ISRv", "vedge-C8000V", "vedge-ASR-1001-X", "vedge-C1111-4P", "vedge-C1101-4P", "vedge-C1101-4PLTEP", "vedge-C8500-12X4QC", "vedge-C8530-12X4QC", "vedge-C8570-G2", "vedge-C8500-12X", "vedge-C8530-12X", "vedge-C8550-G2", "vedge-C8530L-8S8X4Y", "vedge-C8475-G2", "vedge-C8530L-8S2X2Y", "vedge-C8455-G2", "vedge-C8330-1N1S-4M2X", "vedge-C8375-E-G2", "vedge-C8330-6TM4SX", "vedge-C8330-6TM4X", "vedge-C8351-G2", "vedge-C8330X-6TM4SX", "vedge-C8330X-6TM4X", "vedge-C8355-G2", "vedge-C8500L-8S4X", "vedge-C1111-8PW", "vedge-C1111-8PLTEEAW", "vedge-C1111-4PLTEEA", "vedge-C1101-4PLTEPW", "vedge-C1109-4PLTE2PW", "vedge-C1109-4PLTE2P", "vedge-C1121X-8PLTEP", "vedge-C1161X-8PLTEP", "vedge-C1113-8PMLTEEA", "vedge-C1111-4PLTELA,vedge-C1116-4P", "vedge-C1116-4PLTEEA", "vedge-C8151-CVAP-G2", "vedge-C8151-CVAI-G2", "vedge-C1117-4P", "vedge-C1117-4PM", "vedge-C1117-4PMLTEEA", "vsmart", "vmanage", "vbond", "vedge-ISR-4461", "vedge-C8300-1N1S-4T2X", "vedge-C8300-1N1S-6T", "vedge-C1100TG-1N24P32A", "vedge-C1100TGX-1N24P32A", "vedge-C1161X-8P", "vedge-C8300-2N2S-4T2X", "vedge-C8300-2N2S-6T", "vedge-C8200-1N-4T", "vedge-C8200L-1N-4T", "vedge-C1161-8P", "vedge-C8230X-1N-2M2X", "vedge-C8235-E-G2", "vedge-C8230-1N-2M2X", "vedge-C8231-E-G2", "vedge-C8230E-8TM2X", "vedge-C8231-G2", "vedge-C8230X-8M2X", "vedge-C8235-G2", "vedge-C8221-G2", "vedge-C8225-G2", "vedge-C1126-8PLTEP", "vedge-C1127-8PLTEP", "vedge-C1121-4P", "vedge-C1121-4PLTEP", "vedge-C1128-8PLTEP", "vedge-C1121X-8PLTEPW", "vedge-C1121-8PLTEP", "vedge-C1121-8P", "vedge-C1161-8PLTEP", "vedge-C1113-8PLTEEA", "vedge-C1131-8PW", "vedge-C1131X-8PW", "vedge-C1131-8PLTEPW", "vedge-C1131X-8PLTEPW", "vedge-C1113-8PLTEW", "vedge-C1111-4PW", "vedge-C1112-8P", "vedge-C1112-8PLTEEA", "vedge-C1112-8PLTEEAWE", "vedge-C1112-8PWE", "vedge-C1113-8P", "vedge-C1113-8PLTEEAW", "vedge-C1113-8PLTELA", "vedge-C1113-8PLTELAWZ", "vedge-C1113-8PM", "vedge-C1113-8PMWE", "vedge-C1113-8PW", "vedge-C1116-4PLTEEAWE", "vedge-C1116-4PWE", "vedge-C1117-4PLTEEAW", "vedge-C1117-4PLTELAWZ", "vedge-C1117-4PMLTEEAWE", "vedge-C1117-4PMWE", "vedge-C1117-4PW", "vedge-C1118-8P", "vedge-C1109-2PLTEGB", "vedge-C1109-2PLTEUS", "vedge-C1109-2PLTEVZ" ] }, "example": "vedge-cloud" }, { "name": "state", "in": "query", "description": "List of states", "schema": { "type": "array", "items": { "type": "object", "properties": { "certificateTypes": { "type": "string" } }, "description": "This is valid Certificate States ", "enum": [ "tokengenerated", "bootstrapconfiggenerated", "csrgenerated", "csrfailed", "certinstalled", "certinstallfailed" ], "$$ref": "#/components/schemas/CertificateStates" }, "enum": [ "tokengenerated", "bootstrapconfiggenerated", "csrgenerated", "csrfailed", "certinstalled", "certinstallfailed" ] }, "example": [ "certinstalled" ] }, { "name": "uuid", "in": "query", "description": "List of device uuid", "schema": { "type": "array", "items": { "type": "object", "properties": { "deviceUuid": { "type": "string", "example": "C8K-f9f4a977-be6c-47f7-b3b2-10e916bb24db" } }, "description": "This is valid DeviceUuid", "$$ref": "#/components/schemas/DeviceUuid" } }, "example": [ "C8K-5e87e5c3-0923-4364-a729-d65d40298d76" ] }, { "name": "deviceIP", "in": "query", "description": "List of device system IP", "schema": { "type": "array", "items": { "type": "object", "properties": { "deviceIp": { "type": "string" } }, "description": "This is the valid DeviceIP", "$$ref": "#/components/schemas/DeviceIP" } }, "example": [ "172.16.255.21" ] }, { "name": "validity", "in": "query", "description": "List of device validity", "schema": { "type": "array", "items": { "type": "object", "properties": { "certificateValidity": { "type": "string" } }, "description": "This is Certificate Validity ", "enum": [ "valid", "invalid", "staging" ], "$$ref": "#/components/schemas/CertificateValidity" }, "enum": [ "valid", "invalid", "staging" ] }, "example": [ "valid", "invalid", "staging" ] }, { "name": "family", "in": "query", "description": "The platform family to filter for", "schema": { "type": "string", "enum": [ "aon", "cedge" ] } }, { "name": "siteId", "in": "query", "description": "The Site Id to filter for", "schema": { "type": "integer", "format": "int64" }, "example": 400 }, { "name": "topology", "in": "query", "description": "The device topology to filter for", "schema": { "type": "string", "enum": [ "hub", "spoke" ] } }, { "name": "tag", "in": "query", "description": "The tag name to filter for", "schema": { "pattern": "^[^&<>! \"]{1,128}$", "type": "string" }, "example": "Tag1" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Example": { "description": "Example", "value": { "header": { "generatedOn": 1719777080038, "viewKeys": { "uniqueKey": [], "preferenceKey": "grid-vEdgeList" }, "columns": [ { "title": "Chassis Number", "property": "chasisNumber", "hideable": false, "visible": true, "width": 250, "dataType": "string" }, { "title": "Site Name", "property": "site-name", "visible": true, "width": 80, "dataType": "string" }, { "title": "Hostname", "property": "host-name", "hideable": true, "visible": true, "width": 150, "dataType": "string" }, { "title": "Tags", "property": "tags", "display": "toggle", "actionColumn": true, "visible": true, "minWidth": 100, "dataType": "string" }, { "title": "Config Locked", "property": "device-lock", "visible": true, "width": 80, "dataType": "boolean" }, { "title": "Managed By", "property": "managed-by", "visible": true, "headerTooltip": "This field indicates whether device is being managed by a Configuration-Group, Template, or it is Unmanaged i.e. not managed by either of them. Note: A device that is Unlocked but, managed by a Configuration-Group will become locked again when the Configuration-Group is deployed back to the device.", "width": 160, "dataType": "string" }, { "title": "Device Status", "property": "configStatusMessage", "display": "syncDiffChecker", "visible": true, "minWidth": 150, "dataType": "string" }, { "title": "Version", "property": "version", "visible": true, "width": 150, "dataType": "string" }, { "title": "Reachability", "property": "reachability", "hideable": true, "visible": true, "dataType": "string" }, { "title": "Site ID", "property": "site-id", "visible": false, "width": 70, "dataType": "numberStr" }, { "title": "Region ID", "property": "region-id", "visible": false, "width": 120, "dataType": "string" }, { "title": "Region Name", "property": "region-name", "visible": false, "width": 120, "dataType": "string" }, { "title": "Mode", "property": "configOperationMode", "display": "keyvalue", "keyvalueProperty": "configOperationMode", "visible": false, "keyvalue": [ { "key": "cli", "value": "CLI" }, { "key": "vmanage", "value": "vManage" } ], "width": 80, "dataType": "string" }, { "title": "view.certificate.clientViewVedgeList.assignedConfigGroup", "property": "name", "visible": false, "width": 150, "dataType": "string" }, { "title": "Assigned Template", "property": "template", "visible": false, "width": 150, "dataType": "string" }, { "title": "Device Model", "property": "deviceModel", "display": "keyvalue", "keyvalueProperty": "deviceModel", "visible": false, "minWidth": 120, "dataType": "string" }, { "title": "Draft Mode", "property": "draftMode", "visible": false, "width": 80, "dataType": "string" }, { "title": "Serial No./Token", "property": "serialNumber", "visible": false, "width": 150, "dataType": "string" }, { "title": "State", "property": "vedgeCertificateState", "display": "iconAndToolTip", "iconProperty": "vedgeCertificateState", "toolTipProperty": "vedgeCertificateState", "visible": false, "icon": [ { "key": "tokengenerated", "value": "images/certStates/token-generated.png", "displayKey": "Token Generated" }, { "key": "bootstrapconfiggenerated", "value": "images/certStates/bootstrap-config-generated.png", "displayKey": "Bootstrap Configuration Generated" }, { "key": "csrgenerated", "value": "images/certStates/csr-generated.png", "displayKey": "CSR Generated" }, { "key": "csrfailed", "value": "images/certStates/csr-failed.png", "displayKey": "CSR Failed" }, { "key": "certinstallfailed", "value": "images/certStates/cert-install-failed.png", "displayKey": "Certificate Installation Failed" }, { "key": "certinstalled", "value": "images/certStates/cert-installed.png", "displayKey": "Certificate Installed" } ], "width": 40, "dataType": "string" }, { "title": "Enterprise Cert Serial No", "property": "hardwareCertSerialNumber", "visible": false, "width": 100, "dataType": "string" }, { "title": "Certificate Expiration Date", "property": "expirationDate", "visible": false, "width": 100, "dataType": "string" }, { "title": "Subject SUDI serial #", "property": "subjectSerialNumber", "visible": false, "width": 100, "dataType": "string" }, { "title": "Validity", "property": "validity", "display": "toggle", "actionColumn": true, "visible": false, "minWidth": 100, "dataType": "string" }, { "title": "System IP ", "property": "local-system-ip", "hideable": true, "visible": false, "minWidth": 120, "dataType": "ipv4" }, { "title": "Configured System IP", "property": "configuredSystemIP", "hideable": true, "visible": false, "minWidth": 120, "dataType": "ipv4" }, { "title": "Upload Source", "property": "uploadSource", "display": "toggle", "actionColumn": true, "visible": false, "minWidth": 150, "dataType": "string" }, { "title": "Solution", "property": "solution", "visible": false, "minWidth": 150, "dataType": "string" } ], "fields": [ { "property": "chasisNumber", "dataType": "string" }, { "property": "site-name", "dataType": "string" }, { "property": "host-name", "dataType": "string" }, { "property": "tags", "dataType": "string", "display": "toggle" }, { "property": "device-lock", "dataType": "boolean" }, { "property": "managed-by", "dataType": "string" }, { "property": "configStatusMessage", "dataType": "string", "display": "syncDiffChecker" }, { "property": "version", "dataType": "string" }, { "property": "reachability", "dataType": "string" }, { "property": "deviceIP", "dataType": "ipv4" }, { "property": "site-id", "dataType": "numberStr" }, { "property": "region-id", "dataType": "string" }, { "property": "region-name", "dataType": "string" }, { "property": "configOperationMode", "dataType": "string", "display": "keyvalue" }, { "property": "name", "dataType": "string" }, { "property": "template", "dataType": "string" }, { "property": "deviceModel", "dataType": "string", "display": "keyvalue" }, { "property": "draftMode", "dataType": "string" }, { "property": "serialNumber", "dataType": "string" }, { "property": "vedgeCertificateState", "dataType": "string", "display": "iconAndToolTip" }, { "property": "hardwareCertSerialNumber", "dataType": "string" }, { "property": "expirationDate", "dataType": "string" }, { "property": "subjectSerialNumber", "dataType": "string" }, { "property": "validity", "dataType": "string", "display": "toggle" }, { "property": "local-system-ip", "dataType": "ipv4" }, { "property": "configuredSystemIP", "dataType": "ipv4" }, { "property": "vbond", "dataType": "ipv4" }, { "property": "uploadSource", "dataType": "string", "display": "toggle" }, { "property": "solution", "dataType": "string" } ] }, "data": [ { "configuredHostname": "vm11", "configuredSiteId": "100", "configuredSystemIP": "172.16.255.21", "deviceType": "vedge", "serialNumber": "12345712", "ncsDeviceName": "vedge-C8K-7676a621-a5e9-41ef-a9dd-d01782ff5834", "configStatusMessage": "In Sync", "templateApplyLog": [ "[14-Jun-2024 9:19:47 UTC] Deploying device with Config Group vm11_ConfigGroup", "[14-Jun-2024 9:19:47 UTC] Generating configuration", "[14-Jun-2024 9:19:49 UTC] Checking and creating device in Manager", "[14-Jun-2024 9:19:56 UTC] Device is online", "[14-Jun-2024 9:19:56 UTC] Updating device configuration in Manager", "[14-Jun-2024 9:19:56 UTC] Sending configuration to device", "[14-Jun-2024 9:20:01 UTC] Successfully notified device to pull configuration", "[14-Jun-2024 9:20:02 UTC] Device has pulled the configuration", "[14-Jun-2024 9:20:17 UTC] Device: Config applied successfully", "[14-Jun-2024 9:20:17 UTC] Config Group successfully deployed to device" ], "uuid": "C8K-7676a621-a5e9-41ef-a9dd-d01782ff5834", "managementSystemIP": "172.16.255.21", "templateStatus": "Success", "chasisNumber": "C8K-7676a621-a5e9-41ef-a9dd-d01782ff5834", "configStatusMessageDetails": "", "configOperationMode": "vmanage", "deviceModel": "vedge-C8000V", "deviceState": "READY", "validity": "valid", "platformFamily": "c8000v", "hardwareVedge": false, "username": "--", "rootCertHash": "4b31480c781ebc512ac3a3b6fd671f44d5b1f087", "deviceIP": "172.16.255.21", "personality": "vedge", "uploadSource": "Auto Discovered", "region-id": [], "addedByRule": false, "solution": "sdwan", "site-id": "100", "host-name": "vm11", "system-ip": "172.16.255.21", "vbond": "10.0.12.26", "vmanageConnectionState": "connected", "local-system-ip": "172.16.255.21", "availableVersions": [], "defaultVersion": "17.16.01.0.202649", "reachability": "reachable", "version": "17.16.01.0.202649", "uptime-date": 1718354640000, "model_sku": "None", "lastupdated": 1719751312724, "vmanage-system-ip": "172.16.255.21", "domain-id": "1", "sp-organization-name": "vIPtela Inc Regression", "organization-name": "vIPtela Inc Regression", "id": "9b7c6a63-e659-4192-a2a7-8a743cb3b878", "name": "vm11_ConfigGroup", "lifeCycleRequired": true, "vedgeCertificateState": "certinstalled", "expirationDate": "NA", "hardwareCertSerialNumber": "NA", "subjectSerialNumber": "NA", "resourceGroup": "global", "tags": [], "draftMode": "Disabled", "site-name": "SITE_100", "device-lock": "Yes", "managed-by": "Config-Group vm11_ConfigGroup" } ] }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigSystemDeviceSystemdeviceapiResponseExampleDevicecategoryresp" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default,dca,Device Inventory > Edge-read,Device Inventory > Controller-read" } }, "/system/device/{uuid}": { "put": { "tags": [ "Configuration - Device Inventory" ], "description": "Edit device", "operationId": "editDevice", "parameters": [ { "name": "uuid", "in": "path", "description": "Device UUID", "required": true, "schema": { "type": "string" }, "example": "5dfa7d1e-201e-4506-83d6-667a56d17a10" } ], "requestBody": { "description": "Edit device request", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Edit Device": { "description": "Edit Device", "value": { "deviceIP": "1.1.1.1", "username": "cisco", "password": "cisco", "personality": "vbond", "generateCSR": true }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigSystemDeviceSystemdeviceapiRequestExampleSystemdevice" } } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "Configuration - Device Inventory" ], "description": "Delete vEdges", "operationId": "deleteDevice_ConfigurationDeviceInventory_2106", "parameters": [ { "name": "uuid", "in": "path", "description": "Device uuid", "required": true, "schema": { "type": "string" }, "example": "930633aa-f843-4dff-a2f0-664ca97df5ae" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": "success" } }, "$$ref": "#/components/schemas/DeleteDevice" }, "examples": { "Example Value": { "description": "Example Value", "value": { "status": "success" }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigSystemDeviceSystemdeviceapiResponseExampleSystemdevicedeleteresp" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Inventory-write,Device Inventory > Edge-write" } }, "/system/device/{uuid}/unlock": { "post": { "tags": [ "Configuration - Device Inventory" ], "description": "Unlock device", "operationId": "unlockDevice", "parameters": [ { "name": "uuid", "in": "path", "description": "Device uuid", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Device config", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Device config": { "description": "Device 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" } }, "/system/reverseproxy/{uuid}": { "get": { "tags": [ "System - Reverse Proxy" ], "description": "Get reverse proxy IP/Port mappings for controller", "operationId": "getReverseProxyMappings", "parameters": [ { "name": "uuid", "in": "path", "description": "Device uuid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Device reverse proxy mappings": { "description": "Device reverse proxy mappings", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "System - Reverse Proxy" ], "description": "Create reverse proxy IP/Port mappings for controller", "operationId": "createReverseProxyMappings", "parameters": [ { "name": "uuid", "in": "path", "description": "Device uuid", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Device reverse proxy mappings", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Device reverse proxy mappings": { "description": "Device reverse proxy mappings", "value": {} } } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/tenant": { "post": { "tags": [ "Tenant Management", "Multitenant APIs - Provider" ], "description": "Create a new tenant in Multi-Tenant vManage


Note: In a multitenant vManage system, this API is only available in the Provider view.", "operationId": "createTenant", "requestBody": { "description": "Tenant model", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Tenant model": { "description": "Tenant model", "value": "{\n \"orgName\": \"fq-tenan1 - 19442\",\n \"subDomain\": \"tenant1-fq-dev-dev.viptela.info\",\n \"name\": \"fq-tenan1 - 19442\",\n \"desc\": \"fq-tenan1 - 19442\"\n \"wanEdgeForecast\": \"100\"\n}" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Tenant model": { "description": "Tenant model", "value": { "tenantId": "b22dad42-b889-4701-91bd-410a699e8522", "name": "fq-tenan1 - 19442", "desc": "fq-tenan1 - 19442", "orgName'": "fq-tenan1 - 19442", "subDomain": "tenant1-fq-dev-dev.viptela.info", "wanEdgeForecast": "100", "vBondAddress": "fq-cluster1-vb-dev.viptela.info", "vSmarts": [ "2d50c19b-a54a-48c6-b259-44628014534b", "1f0ceb7c-6943-43be-ad4f-4900c1850e69" ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true, "x-roles-required": "Tenant Management-write" }, "put": { "tags": [ "Tenant Management", "Multitenant APIs - Provider" ], "description": "Update tenants in Multi-Tenant vManage


Note: In a multitenant vManage system, this API is only available in the Provider view.", "operationId": "updateTenantBulk", "requestBody": { "description": "Tenant model", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Tenant model": { "description": "Tenant model", "value": "[\n {\n \"tenantId\": \"a239afa8-ea24-439d-8dea-62056508c2fb\",\n \"subDomain\": \"cherry.fruits.com\",\n \"desc\": \"This is Cherry\",\n \"wanEdgeForecast\": \"10\",\n \"edgeConnectorSystemIp\" : \"172.16.255.81\",\n \"edgeConnectorTunnelInterfaceName\" : \"Gigbit1\",\n \"tenantExternalServiceData\": [\n {\n \"serviceType\": \"notification\",\n \"isProviderManaged\": true,\n },\n {\n \"serviceType\": \"aaa\",\n \"isProviderManaged\": true,\n }\n {\n \"serviceType\": \"ise\",\n \"isProviderManaged\": true,\n }\n ]\n }\n {\n \"tenantId\": \"a239afa8-ea24-439d-8dea-62056508c2fc\",\n \"subDomain\": \"grape.fruits.com\",\n \"name\": \"Grape\",\n \"desc\": \"This is Grape\",\n \"wanEdgeForecast\": \"10\",\n \"edgeConnectorTunnelInterfaceName\" : \"Gigbit1\",\n \"edgeConnectorSystemIp\" : \"172.16.255.81\",\n \"tenantExternalServiceData\": []\n }\n]" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Tenant model": { "description": "Tenant model", "value": "[\n {\n \"tenantId\": \"a239afa8-ea24-439d-8dea-62056508c2fb\",\n \"orgName\": \"vIPtela Inc Regression-Cherry Inc\",\n \"subDomain\": \"cherry.fruits.com\",\n \"name\": \"Cherry\",\n \"desc\": \"This is Cherry\",\n \"wanEdgeForecast\": \"10\",\n \"vSmarts\": [\n \"2d50c19b-a54a-48c6-b259-44628014534b\",\n \"1f0ceb7c-6943-43be-ad4f-4900c1850e69\"\n ],\n \"edgeConnectorTunnelInterfaceName\" : \"Gigbit1\",\n \"tenantExternalServiceData\": [\n {\n \"serviceType\": \"notification\",\n \"isProviderManaged\": true,\n \"isServiceConnectorEnabled\": true,\n \"serviceConnectorSystemIp\": \"1.1.1.1\",\n \"serviceConnectorInterfaceName\": \"Gigabit1\"\n },\n {\n \"serviceType\": \"aaa\",\n \"isProviderManaged\": true,\n \"isServiceConnectorEnabled\": true,\n \"serviceConnectorSystemIp\": \"2.2.2.2\",\n \"serviceConnectorInterfaceName\": \"Higabit1\"\n }\n {\n \"serviceType\": \"ise\",\n \"isProviderManaged\": true,\n \"isServiceConnectorEnabled\": true,\n \"serviceConnectorSystemIp\": \"3.3.3.3\",\n \"serviceConnectorInterfaceName\": \"Gigabit1\"\n }\n ]\n }\n {\n \"tenantId\": \"a239afa8-ea24-439d-8dea-62056508c2fc\",\n \"orgName\": \"vIPtela Inc Regression-Grape Inc\",\n \"subDomain\": \"grape.fruits.com\",\n \"name\": \"Grape\",\n \"desc\": \"This is Grape\",\n \"wanEdgeForecast\": \"10\",\n \"vSmarts\": [\n \"2d50c19b-a54a-48c6-b259-44628014534b\",\n \"1f0ceb7c-6943-43be-ad4f-4900c1850e69\"\n ],\n \"edgeConnectorTunnelInterfaceName\" : \"Gigbit1\",\n \"tenantExternalServiceData\": []\n }\n]" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Tenant Management-write" }, "get": { "tags": [ "Tenant Management", "Multitenant APIs - Provider" ], "description": "Lists all the tenants on the vManage


Note: In a multitenant vManage system, this API is only available in the Provider view.", "operationId": "getAllTenants", "parameters": [ { "name": "deviceId", "in": "query", "description": "List all tenants associated with a vSmart or MTEdge", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "Tenant models": { "description": "Tenant models", "value": [] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Tenant Management-read,dca,Manage LI-read" } }, "/tenant/async": { "post": { "tags": [ "Tenant Management", "Multitenant APIs - Provider" ], "description": "Create a new tenant in Multi-Tenant vManage asynchronously


Note: In a multitenant vManage system, this API is only available in the Provider view.", "operationId": "createTenantAsync", "requestBody": { "description": "Tenant model", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Tenant model": { "description": "Tenant model", "value": "{\n \"orgName\": \"fq-tenan1 - 19442\",\n \"subDomain\": \"tenant1-fq-dev-dev.viptela.info\",\n \"name\": \"fq-tenan1 - 19442\",\n \"desc\": \"fq-tenan1 - 19442\"\n \"wanEdgeForecast\": \"100\"\n}" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Task Id": { "description": "Task Id", "value": { "id": "103c183b-5ae3-43bf-93d1-37ca341303b0" } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Tenant Management-write" } }, "/tenant/bulk/async": { "post": { "tags": [ "Tenant Management", "Multitenant APIs - Provider" ], "description": "Create multiple tenants on vManage asynchronously


Note: In a multitenant vManage system, this API is only available in the Provider view.", "operationId": "createTenantAsyncBulk", "requestBody": { "description": "Tenant model", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Tenant model": { "description": "Tenant model", "value": [ { "orgName": "fq-tenan1 - 19442", "subDomain": "tenant1-fq-dev-dev.viptela.info", "name": "fq-tenan1 - 19442", "desc": "fq-tenan1 - 19442", "wanEdgeForecast": "100" }, { "orgName": "fq-tenan2 - 19442", "subDomain": "tenant2-fq-dev-dev.viptela.info", "name": "fq-tenan2 - 19442", "desc": "fq-tenan2 - 19442", "wanEdgeForecast": "100", "vSmarts": [ "9cd565cc-16b8-47e7-9115-35e53bbc6848", "7efaa90d-5d80-4f18-adc0-54660250f0ce" ] } ] } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Task Id": { "description": "Task Id", "value": { "id": "103c183b-5ae3-43bf-93d1-37ca341303b0" } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Tenant Management-write" }, "delete": { "tags": [ "Tenant Management", "Multitenant APIs - Provider" ], "description": "Delete multiple tenants on vManage asynchronously


Note: In a multitenant vManage system, this API is only available in the Provider view.", "operationId": "deleteTenantAsyncBulk", "requestBody": { "description": "Tenant model", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Tenant model": { "description": "Tenant model", "value": { "password": "12345", "tenantIdList": [ "0f4f1c6e-47da-40c4-8517-9d1e918965d9", "6b7b23bf-5dba-4cca-a36c-1c3cc2254d68" ] } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Task Id": { "description": "Task Id", "value": { "id": "103c183b-5ae3-43bf-93d1-37ca341303b0" } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Tenant Management-write" } }, "/tenant/capacity": { "get": { "tags": [ "Tenant Management", "Multitenant APIs - Provider" ], "description": "List tenant hosting capacity of vManage and all the vSmarts


Note: In a multitenant vManage system, this API is only available in the Provider view.", "operationId": "getTenantHostingCapacity", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Tenant Hosting Capacity": { "description": "Tenant Hosting Capacity", "value": { "data": { "manager": { "totalTenantCapacity": 150, "currentTenantCount": 4, "availableTenantCapacity": 146, "totalDeviceCapacity": 7500, "currentDeviceForecast": 500, "availableDeviceCapacity": 7000 }, "controller": [ { "vSmartUuid": "d1733982-2249-433f-b615-0fd4bebf4a4e", "totalTenantCapacity": 24, "currentTenantCount": 0 }, { "vSmartUuid": "c5d058ec-33e6-48ca-b9d0-c28345d75a8d", "totalTenantCapacity": 24, "currentTenantCount": 4 }, { "vSmartUuid": "46bfc014-980e-4ef7-af8e-05d8d2ed2698", "totalTenantCapacity": 24, "currentTenantCount": 2 }, { "vSmartUuid": "24bb12ed-fa4e-4c1a-b495-e84a659173b3", "totalTenantCapacity": 24, "currentTenantCount": 2 } ] } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Tenant Management-read,dca" } }, "/tenant/vsmart": { "put": { "tags": [ "Tenant Management", "Multitenant APIs - Provider" ], "description": "Update placement of all tenants from source vSmart to destination vSmart


Note: In a multitenant vManage system, this API is only available in the Provider view.", "operationId": "relocateAllTenantsFromVsmart", "requestBody": { "description": "Tenant model", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "UpdateTenantvSmartModel": { "description": "UpdateTenantvSmartModel", "value": { "srcvSmartUuid": "UUID", "destvSmartUuid": "UUID" } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "Task Id": { "description": "Task Id", "value": { "id": "103c183b-5ae3-43bf-93d1-37ca341303b0" } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Tenant Management-write" }, "get": { "tags": [ "Tenant Management", "Multitenant APIs - Provider" ], "description": "Retrieve mapping of tenants to vSmarts


Note: In a multitenant vManage system, this API is only available in the Provider view.", "operationId": "getvSmartTenantMapping", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "vSmart tenant mapping": { "description": "vSmart tenant mapping", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Tenant Management-read,dca" } }, "/tenant/vsmart/capacity": { "get": { "tags": [ "Tenant Management", "Multitenant APIs - Provider" ], "description": "Lists all the vsmarts on the vManage and its tenant hosting capacity


Note: In a multitenant vManage system, this API is only available in the Provider view.", "operationId": "getvSmartTenantHostingCapacity", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "vSmart Capacity": { "description": "vSmart Capacity", "value": { "data": [ { "vSmartUuid": "6dbf3f8d-d537-4650-9200-154d8b98b302", "totalTenantCapacity": 24, "currentTenantCount": 2 }, { "vSmartUuid": "05aab9ac-44f7-4292-b8c5-2cc40f3afb5a", "totalTenantCapacity": 24, "currentTenantCount": 2 }, { "vSmartUuid": "b20b4468-7a5f-48f1-8ee6-f393afd3ac72", "totalTenantCapacity": 24, "currentTenantCount": 2 } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true, "x-roles-required": "Tenant Management-read,dca" } }, "/tenant/{tenantId}": { "get": { "tags": [ "Tenant Management", "Multitenant APIs - Provider" ], "description": "Get a tenant by Id


Note: In a multitenant vManage system, this API is only available in the Provider view.", "operationId": "getTenant", "parameters": [ { "name": "tenantId", "in": "path", "description": "Tenant Id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Tenant model": { "description": "Tenant model", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Tenant Management-read" }, "delete": { "tags": [ "Tenant Management", "Multitenant APIs - Provider" ], "description": "Delete tenant on vManage asynchronously


Note: In a multitenant vManage system, this API is only available in the Provider view.", "operationId": "deleteTenantAsync", "parameters": [ { "name": "tenantId", "in": "path", "description": "Tenant Id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Task Id": { "description": "Task Id", "value": { "id": "103c183b-5ae3-43bf-93d1-37ca341303b0" } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Tenant Management-write" }, "put": { "tags": [ "Tenant Management", "Multitenant APIs - Provider" ], "description": "Update a tenant in Multi-Tenant vManage


Note: In a multitenant vManage system, this API is only available in the Provider view.", "operationId": "updateTenant", "parameters": [ { "name": "tenantId", "in": "path", "description": "Tenant Id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Tenant model", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Tenant model": { "description": "Tenant model", "value": "{\n \"tenantId\": \"a239afa8-ea24-439d-8dea-62056508c2fb\",\n \"subDomain\": \"tenant1-fq-dev-dev.viptela.info\",\n \"desc\": \"fq-tenan1 - 19442\",\n \"wanEdgeForecast\": \"15\",\n \"controllerVisibilityEnable\": false,\n \"edgeConnectorSystemIp\": \"172.16.255.81\",\n \"edgeConnectorTunnelInterfaceName\": \"Gigbit1\",\n \"tenantExternalServiceData\": [\n {\n \"serviceType\": \"notification\",\n \"isProviderManaged\": true,\n },\n {\n \"serviceType\": \"aaa\",\n \"isProviderManaged\": true,\n }\n ]\n}" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Tenant model": { "description": "Tenant model", "value": { "tenantId": "a239afa8-ea24-439d-8dea-62056508c2fb", "desc": "fq-tenan1 - 19442", "orgName'": "fq-tenan1 - 19442", "subDomain": "tenant1-fq-dev-dev.viptela.info", "name": "fq-tenan1", "wanEdgeForecast": "15", "controllerVisibilityEnable": false, "vBondAddress": "fq-cluster1-vb-dev.viptela.info" } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Tenant Management-write" } }, "/tenant/{tenantId}/delete": { "post": { "tags": [ "Tenant Management", "Multitenant APIs - Provider" ], "description": "Delete a tenant by Id


Note: In a multitenant vManage system, this API is only available in the Provider view.", "operationId": "deleteTenant", "parameters": [ { "name": "tenantId", "in": "path", "description": "Tenant Id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Tenant model", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Tenant model": { "description": "Tenant model", "value": { "password": "password" } } } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true, "x-roles-required": "Tenant Management-write" } }, "/tenant/{tenantId}/switch": { "post": { "tags": [ "Tenant Management", "Multitenant APIs - Provider" ], "description": "Switch to a specific tenant


Note: In a multitenant vManage system, this API is only available in the Provider view.", "operationId": "switchTenant", "parameters": [ { "name": "tenantId", "in": "path", "description": "Tenant Id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "vSession model": { "description": "vSession model", "value": "{\n \u201cVSessionId\u201d: \u201cMTU0MTA4MDUwODM5OQ==\u201d\n}" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Tenant Management-read" } }, "/tenant/{tenantId}/vsessionid": { "post": { "tags": [ "Tenant Management", "Multitenant APIs - Provider" ], "description": "Get VSessionId for a specific tenant


Note: In a multitenant vManage system, this API is only available in the Provider view.", "operationId": "vSessionId", "parameters": [ { "name": "tenantId", "in": "path", "description": "Tenant Id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "vSession model": { "description": "vSession model", "value": "{\n \u201cVSessionId\u201d: \u201cMTU0MTA4MDUwODM5OQ==\u201d\n}" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Tenant Management-read,dca" } }, "/tenant/{tenantId}/vsmart": { "put": { "tags": [ "Tenant Management", "Multitenant APIs - Provider" ], "description": "Update placement of the Tenant from source vSmart to destination vSmart


Note: In a multitenant vManage system, this API is only available in the Provider view.", "operationId": "updateTenantvSmartPlacement", "parameters": [ { "name": "tenantId", "in": "path", "description": "Tenant Id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Tenant model", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "UpdateTenantvSmartModel": { "description": "UpdateTenantvSmartModel", "value": { "srcvSmartUuid": "UUID", "destvSmartUuid": "UUID" } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "Task Id": { "description": "Task Id", "value": { "id": "103c183b-5ae3-43bf-93d1-37ca341303b0" } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true, "x-roles-required": "Tenant Management-write" } }, "/tenant/{tenantId}/vsmarts": { "put": { "tags": [ "Tenant Management", "Multitenant APIs - Provider" ], "description": "Update placement of the tenant on vSmarts


Note: In a multitenant vManage system, this API is only available in the Provider view.", "operationId": "updateTenantvSmartsPlacement", "parameters": [ { "name": "tenantId", "in": "path", "description": "Tenant Id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Tenant model", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "UpdateTenantvSmartListModel": { "description": "UpdateTenantvSmartListModel", "value": { "addvSmartUuidList": [ "1a50c19b-a54a-48c6-b259-44628014534b", "2a50c19b-a54a-48c6-b259-44628014534b" ], "deletevSmartUuidList": [ "3a50c19b-a54a-48c6-b259-44628014534b", "4a50c19b-a54a-48c6-b259-44628014534b" ] } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "Task Id": { "description": "Task Id", "value": { "id": "103c183b-5ae3-43bf-93d1-37ca341303b0" } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Tenant Management-write" } }, "/tenantbackup/delete": { "delete": { "tags": [ "Tenant Backup Restore", "Multitenant APIs - Provider" ], "description": "Delete all or a specific backup file stored in vManage


Note: In a multitenant vManage system, this API is only available in the Provider view.", "operationId": "deleteTenantBackup", "parameters": [ { "name": "VSessionId", "in": "header", "description": "Tenant VSessionId (required only for provider user)", "schema": { "type": "string" } }, { "name": "fileName", "in": "query", "description": "File name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Deleted file list": { "description": "Deleted file list", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Tenant Management-write,Tenant Status-write" } }, "/tenantbackup/download/{path}": { "get": { "tags": [ "Tenant Backup Restore", "Multitenant APIs - Provider" ], "description": "Download a Backup File that is already stored in vManage", "operationId": "downloadExistingBackupFile", "parameters": [ { "name": "VSessionId", "in": "header", "description": "Tenant VSessionId (required only for provider user)", "schema": { "type": "string" } }, { "name": "path", "in": "path", "description": "File path", "required": true, "schema": { "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}\\/bkup_[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}_[0-9]{6}-[0-9]{6}_[0-9a-fA-F]{32}\\.tar\\.gz$", "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/octet-stream": { "schema": { "type": "object" }, "examples": { "Backup file stream": { "description": "Backup file stream" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Tenant Management-read,Tenant Management-write,Tenant Status-read,Tenant Status-write" } }, "/tenantbackup/export": { "get": { "tags": [ "Tenant Backup Restore", "Multitenant APIs - Provider" ], "description": "Trigger a backup of configuration database and store it in vManage", "operationId": "exportTenantBackup", "parameters": [ { "name": "VSessionId", "in": "header", "description": "Tenant VSessionId (required only for provider user)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Task status": { "description": "Task status", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Tenant Management-read,Tenant Management-write,Tenant Status-read,Tenant Status-write" } }, "/tenantbackup/import": { "post": { "tags": [ "Tenant Backup Restore", "Multitenant APIs - Provider" ], "description": "Submit a previously backed up file and import the data and apply it to the configuraion database


Note: In a multitenant vManage system, this API is only available in the Provider view.", "operationId": "importTenantBackup", "parameters": [ { "name": "VSessionId", "in": "header", "description": "Tenant VSessionId (required only for provider user)", "schema": { "type": "string" } } ], "requestBody": { "description": "Tenant data tar.gz file", "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } }, "$$ref": "#/components/schemas/ImportTenantData" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Task status": { "description": "Task status", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Tenant Management-write,Tenant Status-write" } }, "/tenantbackup/list": { "get": { "tags": [ "Tenant Backup Restore", "Multitenant APIs - Provider" ], "description": "List all backup files of a tenant stored in vManage", "operationId": "listTenantBackup", "parameters": [ { "name": "VSessionId", "in": "header", "description": "Tenant VSessionId (required only for provider user)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Backup file list": { "description": "Backup file list", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Tenant Management-read,Tenant Management-write,Tenant Status-read,Tenant Status-write" } }, "/tenantmigration/download/{path}": { "get": { "tags": [ "Tenant Migration" ], "description": "Download tenant data", "operationId": "downloadTenantData", "parameters": [ { "name": "path", "in": "path", "description": "File path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/octet-stream": { "schema": { "type": "object" }, "examples": { "Tenant data": { "description": "Tenant data", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "admin" } }, "/tenantmigration/export": { "post": { "tags": [ "Tenant Migration" ], "description": "Export tenant data", "operationId": "exportTenantData", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "desc": { "type": "string" }, "isDestinationOverlayMT": { "type": "boolean" }, "migrationKey": { "type": "string" }, "name": { "type": "string" }, "orgName": { "type": "string" }, "subDomain": { "type": "string" }, "wanEdgeForecast": { "type": "string" } }, "$$ref": "#/components/schemas/MigrateTenantModel" } } }, "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": "admin" } }, "/tenantmigration/import/{migrationKey}": { "post": { "tags": [ "Tenant Migration" ], "description": "Import tenant data", "operationId": "importTenantData", "parameters": [ { "name": "migrationKey", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Tenant data tar.gz file", "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } }, "$$ref": "#/components/schemas/ImportTenantData" } } }, "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": "admin" } }, "/tenantmigration/migrationToken": { "get": { "tags": [ "Tenant Migration" ], "description": "Get migration token", "operationId": "getMigrationToken", "parameters": [ { "name": "migrationId", "in": "query", "description": "Migration Id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Migration token": { "description": "Migration token", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "admin" } }, "/tenantmigration/networkMigration": { "get": { "tags": [ "Tenant Migration" ], "description": "Re-trigger network migration", "operationId": "reTriggerNetworkMigration", "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": "admin" }, "post": { "tags": [ "Tenant Migration" ], "description": "Migrate network", "operationId": "migrateNetwork", "requestBody": { "description": "Network migration", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Network migration": { "description": "Network migration", "value": {} } } } }, "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": "admin" } }, "/tenantstatus": { "get": { "tags": [ "Tenant Management", "Multitenant APIs - Provider" ], "description": "List all tenant status


Note: In a multitenant vManage system, this API is only available in the Provider view.", "operationId": "getAllTenantStatuses", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "Tenant status": { "description": "Tenant status", "value": [] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Tenant Management-read" } }, "/tenantstatus/force": { "post": { "tags": [ "Tenant Management", "Multitenant APIs - Provider" ], "description": "Force tenant status collection


Note: In a multitenant vManage system, this API is only available in the Provider view.", "operationId": "forceStatusCollection", "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Tenant Management-write" } }, "/topology": { "get": { "tags": [ "Configuration - Topology" ], "description": "Create full topology", "operationId": "createFullTopology", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "Topologies": { "description": "Topologies", "value": [] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" } }, "/url/monitor": { "get": { "tags": [ "url monitor" ], "summary": "List url monitoring information.", "description": "List url's with monitoring configuration and details about the current state of alarm.", "operationId": "getUrlMonitor", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "properties": { "empty": { "type": "boolean" } }, "items": { "type": "object", "properties": { "alarmRaised": { "type": "boolean", "example": true }, "threshold": { "type": "integer", "description": "VManage alarm is raised after reaching the threshold.", "format": "int32", "example": 20 }, "url": { "type": "string", "description": "url registered for monitoring requests.", "example": "/client/server/ready" } }, "$$ref": "#/components/schemas/UrlMonitoringInfoInner" }, "$$ref": "#/components/schemas/UrlMonitoringInfo" } } } }, "204": { "description": "No content" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "url monitor" ], "summary": "Create url monitor.", "description": "Monitor the url with specified configuration.", "operationId": "createUrlMonitor", "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "examples": { "URL Monitor Payload": { "description": "URL Monitor Payload", "value": { "threshold": 20, "url": "/client/server/ready" } } } } }, "required": true }, "responses": { "201": { "description": "url monitor created" }, "400": { "description": "Bad Request" } } }, "put": { "tags": [ "url monitor" ], "summary": "Update url monitor configuration", "description": "Update monitor configuration related to the url", "operationId": "updateUrlMonitor", "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "examples": { "URL Monitor Payload": { "description": "URL Monitor Payload", "value": { "threshold": 20, "url": "/client/server/ready" } } } } }, "required": true }, "responses": { "202": { "description": "Accepted" }, "400": { "description": "Bad Request" }, "404": { "description": "Not Found" } } }, "delete": { "tags": [ "url monitor" ], "summary": "Delete monitored url.", "description": "Delete an url which is already being monitored.", "operationId": "deleteUrlMonitor", "parameters": [ { "name": "url", "in": "query", "description": "url to delete", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "404": { "description": "Not Found" } } } }, "/util/configdb/metrics": { "get": { "tags": [ "Utility - Configuration DB" ], "summary": "Return the values of the specific metric", "description": "By passing in the appropriate metric, it will return the values of the respective metric within the timeframe provided ", "operationId": "returnMetric", "parameters": [ { "name": "metricName", "in": "query", "description": "Pass the metric name", "required": true, "schema": { "pattern": "^[a-zA-Z0-9._]*$", "type": "string" }, "example": "neo4j.bolt.connections_running" }, { "name": "startDate", "in": "query", "description": "Date in yyyy-MM-dd format or any Number format. If a number is passed, that will be the number of minutes. The start/end will be translated as and respectively.", "required": true, "schema": { "type": "string" }, "examples": { "yyyy-MM-dd": { "description": "yyyy-MM-dd", "value": "2022-11-20" }, "number (minutes)": { "description": "number (minutes)", "value": 10 } } }, { "name": "endDate", "in": "query", "description": "Date in yyyy-MM-dd format. The end date is given if data from multiple dates needs to be extracted. If single date data needed then endDate can be empty. endDate cannot be a previous date to the startDate.", "schema": { "type": "string" }, "example": "2022-11-23" }, { "name": "start", "in": "query", "description": "Start Time in HHMMSS format; Time in UTC timezone", "schema": { "pattern": "^(?:[01]\\d|2[0123])(?:[012345]\\d)(?:[012345]\\d)$", "type": "string" }, "example": 142430 }, { "name": "end", "in": "query", "description": "End Time in HHMMSS format; Time in UTC timezone", "schema": { "pattern": "^(?:[01]\\d|2[0123])(?:[012345]\\d)(?:[012345]\\d)$", "type": "string" }, "example": 235830 }, { "name": "pageNo", "in": "query", "description": "Page Number", "schema": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32", "default": 1 } }, { "name": "limit", "in": "query", "description": "The numbers of items to return on given Page Number", "schema": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32", "default": 500 } } ], "responses": { "200": { "description": "search results matching criteria", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "time": { "type": "string", "description": "timestamp in seconds", "example": "123344555" }, "value": { "type": "string", "description": "count/value for corresponding timestamp", "example": "718" } }, "$$ref": "#/components/schemas/MetricData" } }, "limit": { "type": "integer", "description": "limit given in reqeust. By default - 500", "format": "int64", "example": 50 }, "pageNo": { "type": "integer", "description": "Page Number given in request. By default - 1", "format": "int32", "example": 3 }, "recordsCurrentPage": { "type": "integer", "description": "Records present on the current page", "format": "int64", "example": 20 }, "totalPages": { "type": "integer", "description": "Total Pages calculates based on limit and totalRecords values", "format": "int32", "example": 3 }, "totalRecords": { "type": "integer", "description": "Total count of metrics records ignoring limit", "format": "int32", "example": 120 } }, "$$ref": "#/components/schemas/Neo4jMetricsResponse" } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/util/configdb/metrics/downloadfiles": { "get": { "tags": [ "Utility - Configuration DB" ], "summary": "Return the tar file consisting of metrics", "description": "By passing in the appropriate metric, date, start and end time, it will return a tar file consisting of all the metric files of the respective metric within the timeframe provided ", "operationId": "returnMetricFiles", "parameters": [ { "name": "metricName", "in": "query", "description": "Pass the metric name", "required": true, "schema": { "pattern": "^[a-zA-Z0-9._]*$", "type": "string" }, "example": "neo4j.bolt.connections_running" }, { "name": "startDate", "in": "query", "description": "Date in yyyy-MM-dd format or any Number format. If a number is passed, that will be the number of minutes. The start/end will be translated as and respectively.", "required": true, "schema": { "type": "string" }, "examples": { "yyyy-MM-dd": { "description": "yyyy-MM-dd", "value": "2022-11-20" }, "number (minutes)": { "description": "number (minutes)", "value": 10 } } }, { "name": "endDate", "in": "query", "description": "Date in yyyy-MM-dd format. The end date is given if data from multiple dates needs to be extracted. If single date data needed then endDate can be empty. endDate cannot be a previous date to the startDate.", "schema": { "type": "string" }, "example": "2022-11-23" }, { "name": "start", "in": "query", "description": "Start Time in HHMMSS format; Time in UTC timezone", "schema": { "pattern": "^(?:[01]\\d|2[0123])(?:[012345]\\d)(?:[012345]\\d)$", "type": "string" }, "example": 142430 }, { "name": "end", "in": "query", "description": "End Time in HHMMSS format; Time in UTC timezone", "schema": { "pattern": "^(?:[01]\\d|2[0123])(?:[012345]\\d)(?:[012345]\\d)$", "type": "string" }, "example": 235830 } ], "responses": { "200": { "description": "return tarball file matching criteria", "content": { "application/gzip": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/util/configdb/metrics/listmetrics": { "get": { "tags": [ "Utility - Configuration DB" ], "summary": "Provides the list of enabled metrics", "description": "Fetches the list of enabled metrics", "operationId": "getMetricsList", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/util/configdb/size": { "get": { "tags": [ "Utility - Configuration DB" ], "description": "Fetches the disk usage by configuration-db", "operationId": "getDBSizeOnFile", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/util/logfile/appserver": { "get": { "tags": [ "Utility - Logging" ], "description": "Lists content of log file. This API accepts content type as text/plain. It is mandatory to provide response content type. Any other content type would result in empty response.", "operationId": "listLogFileDetails", "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "object" }, "example": "14-Mar-2024 00:00:00,001 UTC INFO [] [vm12] [ClassName] (ThreadName) || test log message\n14-Mar-2024 00:00:00,002 UTC INFO [] [vm12] [ClassName] (ThreadName) || test log message 2\n14-Mar-2024 00:00:00,003 UTC INFO [] [vm12] [ClassName] (ThreadName) || test log message 3" } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/util/logfile/appserver/lastnlines": { "get": { "tags": [ "Utility - Logging" ], "description": "List last N lines of log file. This API accepts content type as text/plain. It is mandatory to provide response content type. Any other content type would result in empty response.", "operationId": "listVManageServerLogLastNLines", "parameters": [ { "name": "lines", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 100 } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "object" }, "example": "14-Mar-2024 00:00:00,001 UTC INFO [] [vm12] [ClassName] (ThreadName) || test log message\n14-Mar-2024 00:00:00,002 UTC INFO [] [vm12] [ClassName] (ThreadName) || test log message 2\n14-Mar-2024 00:00:00,003 UTC INFO [] [vm12] [ClassName] (ThreadName) || test log message 3" } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/util/logging/configurations": { "get": { "tags": [ "Utility - Logging" ], "description": "List logger configuration", "operationId": "listConfigurations", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "loggerName": { "type": "string", "example": "vmanage-server" }, "sizeLimit": { "type": "string", "example": "16MB" } }, "$$ref": "#/components/schemas/Configurations" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/util/logging/debuglog": { "post": { "tags": [ "Utility - Logging" ], "description": "Test whether logging works", "operationId": "debugLog", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "loggerName": { "type": "string" }, "logMessage": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true } }, "/util/logging/level": { "post": { "tags": [ "Utility - Logging" ], "description": "Set log level for logger", "operationId": "setLogLevel", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "loggerName": { "type": "string" }, "logLevel": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Set logger" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/util/logging/loggers": { "get": { "tags": [ "Utility - Logging" ], "description": "List loggers", "operationId": "listLoggers", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "isDebugEnabled": { "type": "boolean" }, "name": { "type": "string", "example": "com.cisco.example.package" } }, "$$ref": "#/components/schemas/Loggers" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/util/logging/updateConfiguration": { "post": { "tags": [ "Utility - Logging" ], "description": "Update logger configuration for rollover size and max file number", "operationId": "updateLoggerConfiguration", "parameters": [ { "name": "loggerName", "in": "query", "description": "Logger Configuration", "required": true, "schema": { "type": "string", "enum": [ "All", "vmanage-server", "vmanage-server-statistics", "vmanage-server-olap", "vmanage-server-deviceconfig-template", "vmanage-server-device-config" ] } }, { "name": "sizeLimit", "in": "query", "description": "File size, unit is MB, range (16 - 250)", "schema": { "maximum": 250, "minimum": 16, "type": "integer", "format": "int64" }, "example": 16 }, { "name": "reset", "in": "query", "description": "Reset to default", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Update Configuration" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/util/olapdb/migration/action/{action}": { "post": { "tags": [ "Utility - OLAP DB" ], "description": "Migration actions - start pause or restart migration", "operationId": "postStatsMigrationAction", "parameters": [ { "name": "action", "in": "path", "description": "Migration action", "required": true, "schema": { "type": "string", "enum": [ "WIPE-DATA" ] } } ], "responses": { "200": { "description": "default response", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "Successful response of WIPE-DATA": { "description": "Successful response of WIPE-DATA", "value": { "type": "ok", "message": "Clean up statistics-db data request sent successfully." } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/util/olapdb/migration/rangefrom": { "post": { "tags": [ "Utility - OLAP DB" ], "description": "Config migration historical data range from upgrade time in seconds. -1 to keep all.", "operationId": "postStatsMigrationRangeConfig", "requestBody": { "description": "Range from config", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "Configuration of rangefrom": { "description": "Configuration of rangefrom", "value": { "default": -1, "sitehealth": 1000001, "perfmon": 1000008, "interface": 1000005, "qos": 1000006, "sleofflinereport": 1000027, "alarm": 1000012, "tracker": 1000026, "deviceevent": 1000003, "ulogging": 1000017, "devicehealth": 1000000, "dpi": 1000015, "aggregatedapp": 1000007, "umts": 1000009, "art": 1000013, "auditlog": 1000011, "utd": 1000016, "fwall": 1000018, "umbrella": 1000019, "deviceconfiguration": 1000029, "eiolte": 1000022, "vnf": 1000020, "nwpi": 1000014, "devicesystemstatus": 1000004, "wlan": 1000021, "sdra": 1000024, "cloudx": 1000025, "approutestats": 1000002, "bridge": 1000010, "apphosting": 1000028, "speedtest": 1000023 } } } } }, "required": true }, "responses": { "200": { "description": "default response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true }, "get": { "tags": [ "Utility - OLAP DB" ], "description": "Get migration historical data range configuration from upgrade time", "operationId": "getStatsMigrationRangeConfig", "responses": { "200": { "description": "default response", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Configuration of rangefrom": { "description": "Configuration of rangefrom", "value": { "default": -1, "sitehealth": 1000001, "perfmon": 1000008, "interface": 1000005, "qos": 1000006, "sleofflinereport": 1000027, "alarm": 1000012, "tracker": 1000026, "deviceevent": 1000003, "ulogging": 1000017, "devicehealth": 1000000, "dpi": 1000015, "aggregatedapp": 1000007, "umts": 1000009, "art": 1000013, "auditlog": 1000011, "utd": 1000016, "fwall": 1000018, "umbrella": 1000019, "deviceconfiguration": 1000029, "eiolte": 1000022, "vnf": 1000020, "nwpi": 1000014, "devicesystemstatus": 1000004, "wlan": 1000021, "sdra": 1000024, "cloudx": 1000025, "approutestats": 1000002, "bridge": 1000010, "apphosting": 1000028, "speedtest": 1000023 } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true } }, "/util/olapdb/migration/settings": { "post": { "tags": [ "Utility - OLAP DB" ], "description": "Config generic settings", "operationId": "postStatsMigrationSettings", "requestBody": { "description": "generic settings", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "Settings example": { "description": "Settings example", "value": { "vol_threshold_start": 80, "vol_threshold_pause": 85, "max_auto_retry_count": 20, "stage1_max_threads_count_percentage_to_cpu_core": 65 } } } } }, "required": true }, "responses": { "200": { "description": "default response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true }, "get": { "tags": [ "Utility - OLAP DB" ], "description": "Get migration generic settings", "operationId": "getStatsMigrationSettings", "responses": { "200": { "description": "default response", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Settings example": { "description": "Settings example", "value": { "vol_threshold_start": 80, "vol_threshold_pause": 85, "max_auto_retry_count": 20, "stage1_max_threads_count_percentage_to_cpu_core": 65 } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true } }, "/util/olapdb/migration/statsdbinfo": { "get": { "tags": [ "Utility - OLAP DB" ], "description": "Get stats db table information", "operationId": "getStatsMigrationStatsDbInfo", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true } }, "/util/olapdb/migration/status": { "get": { "tags": [ "Utility - OLAP DB" ], "description": "Get migration status", "operationId": "getStatsMigrationStatus", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Status example": { "description": "Status example", "value": { "running_state": false, "cur_stage_info": { "stage": "DONE", "retries": 0 }, "migrate_exception_indices": [], "cleanup_exception_indices": [], "migrated_indices": [ "approutestatsstatistics_2023_10_17t12_22_42", "devicehealthstatistics_2023_10_17t12_24_14" ], "stats_db_info": { "total_count": 2884, "total_bytes": 1461800 }, "migrated_stats_docs": 2884, "vmanage_upgraded_timestamp": 1697547496112 } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true } }, "/v1/control-component/devices/settings/deploy": { "post": { "tags": [ "Configuration - Control Component Setting" ], "description": "Deploy control component settings to one or multiple control component devices", "operationId": "deployControlComponentSettingsToDevice", "requestBody": { "description": "Deploy settings to control components", "content": { "application/json": { "schema": { "required": [ "devices" ], "type": "object", "properties": { "devices": { "maxItems": 2147483647, "minItems": 1, "type": "array", "description": "Control Component device UUID list", "items": { "required": [ "id" ], "type": "object", "properties": { "id": { "pattern": "^[a-zA-Z0-9\\-/]+$", "type": "string", "description": "Control Component device UUID", "example": "48844743-8f58-4fff-845a-e54ec27340f5" } }, "description": "Control Component device UUID", "$$ref": "#/components/schemas/ControlComponentDeviceId" } } }, "description": "Deploy control component setting to multiple control component devices", "$$ref": "#/components/schemas/ControlComponentDeployRequest" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string", "description": "Task ID", "example": "deploy_control_component_setting-da0ca791-8a3f-4cec-9d14-f4102d6364a1" } }, "description": "Return the task ID for the deploy operation", "$$ref": "#/components/schemas/ControlComponentDeviceDeployResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "required": [ "error" ], "type": "object", "properties": { "error": { "required": [ "code", "details", "message", "type" ], "type": "object", "properties": { "code": { "type": "string", "description": "Internal error code", "example": "CCS0018" }, "details": { "type": "string", "description": "Error message detail", "example": "Unrecognized field user1" }, "message": { "type": "string", "description": "Error message summary", "example": "Invalid control component setting payload" }, "type": { "type": "string", "description": "Error message title", "example": "error" } }, "description": "Error response", "$$ref": "#/components/schemas/ErrorDetails" } }, "$$ref": "#/components/schemas/ErrorResponse" }, "examples": { "DeployControlComponentDeviceFailed": { "description": "DeployControlComponentDeviceFailed", "value": { "error": { "message": "Deploy control component setting to device failed", "code": "CCS0019", "details": "Device daaa0139-4572-4373-9fd9-f6620c1368e3 is already deploying in-progress", "type": "error" } }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigControlcomponentSettingResponseExampleDeploycontrolcomponentfailedresponse" } } } } }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Control Component Settings-write" } }, "/v1/control-component/devices/{deviceId}/settings": { "post": { "tags": [ "Configuration - Control Component Setting" ], "description": "Create device-specific settings for a specific control component. The deviceId can be obtained from the \"uuid\" field in the data returned by the API (GET /dataservice/certificate/data/controller/list)", "operationId": "createControlComponentDeviceSpecificSettings", "parameters": [ { "name": "deviceId", "in": "path", "description": "Control component device UUID", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "required": [ "system", "vpn" ], "type": "object", "properties": { "system": { "required": [ "hostName", "siteId", "systemIp" ], "type": "object", "properties": { "clock": { "required": [ "timezone" ], "type": "object", "properties": { "timezone": { "type": "string", "description": "Set the timezone", "example": "UTC", "enum": [ "Europe/Andorra", "Asia/Dubai", "Asia/Kabul", "America/Antigua", "America/Anguilla", "Europe/Tirane", "Asia/Yerevan", "Africa/Luanda", "Antarctica/McMurdo", "Antarctica/Rothera", "Antarctica/Palmer", "Antarctica/Mawson", "Antarctica/Davis", "Antarctica/Casey", "Antarctica/Vostok", "Antarctica/DumontDUrville", "Antarctica/Syowa", "America/Argentina/Buenos_Aires", "America/Argentina/Cordoba", "America/Argentina/Salta", "America/Argentina/Jujuy", "America/Argentina/Tucuman", "America/Argentina/Catamarca", "America/Argentina/La_Rioja", "America/Argentina/San_Juan", "America/Argentina/Mendoza", "America/Argentina/San_Luis", "America/Argentina/Rio_Gallegos", "America/Argentina/Ushuaia", "Pacific/Pago_Pago", "Europe/Vienna", "Australia/Lord_Howe", "Antarctica/Macquarie", "Australia/Hobart", "Australia/Currie", "Australia/Melbourne", "Australia/Sydney", "Australia/Broken_Hill", "Australia/Brisbane", "Australia/Lindeman", "Australia/Adelaide", "Australia/Darwin", "Australia/Perth", "Australia/Eucla", "America/Aruba", "Europe/Mariehamn", "Asia/Baku", "Europe/Sarajevo", "America/Barbados", "Asia/Dhaka", "Europe/Brussels", "Africa/Ouagadougou", "Europe/Sofia", "Asia/Bahrain", "Africa/Bujumbura", "Africa/Porto-Novo", "America/St_Barthelemy", "Atlantic/Bermuda", "Asia/Brunei", "America/La_Paz", "America/Kralendijk", "America/Noronha", "America/Belem", "America/Fortaleza", "America/Recife", "America/Araguaina", "America/Maceio", "America/Bahia", "America/Sao_Paulo", "America/Campo_Grande", "America/Cuiaba", "America/Santarem", "America/Porto_Velho", "America/Boa_Vista", "America/Manaus", "America/Eirunepe", "America/Rio_Branco", "America/Nassau", "Asia/Thimphu", "Africa/Gaborone", "Europe/Minsk", "America/Belize", "America/St_Johns", "America/Halifax", "America/Glace_Bay", "America/Moncton", "America/Goose_Bay", "America/Blanc-Sablon", "America/Toronto", "America/Nipigon", "America/Thunder_Bay", "America/Iqaluit", "America/Pangnirtung", "America/Resolute", "America/Atikokan", "America/Rankin_Inlet", "America/Winnipeg", "America/Rainy_River", "America/Regina", "America/Swift_Current", "America/Edmonton", "America/Cambridge_Bay", "America/Yellowknife", "America/Inuvik", "America/Creston", "America/Dawson_Creek", "America/Vancouver", "America/Whitehorse", "America/Dawson", "Indian/Cocos", "Africa/Kinshasa", "Africa/Lubumbashi", "Africa/Bangui", "Africa/Brazzaville", "Europe/Zurich", "Africa/Abidjan", "Pacific/Rarotonga", "America/Santiago", "Pacific/Easter", "Africa/Douala", "Asia/Shanghai", "Asia/Harbin", "Asia/Chongqing", "Asia/Urumqi", "Asia/Kashgar", "America/Bogota", "America/Costa_Rica", "America/Havana", "Atlantic/Cape_Verde", "America/Curacao", "Indian/Christmas", "Asia/Nicosia", "Europe/Prague", "Europe/Berlin", "Europe/Busingen", "Africa/Djibouti", "Europe/Copenhagen", "America/Dominica", "America/Santo_Domingo", "Africa/Algiers", "America/Guayaquil", "Pacific/Galapagos", "Europe/Tallinn", "Africa/Cairo", "Africa/El_Aaiun", "Africa/Asmara", "Europe/Madrid", "Africa/Ceuta", "Atlantic/Canary", "Africa/Addis_Ababa", "Europe/Helsinki", "Pacific/Fiji", "Atlantic/Stanley", "Pacific/Chuuk", "Pacific/Pohnpei", "Pacific/Kosrae", "Atlantic/Faroe", "Europe/Paris", "Africa/Libreville", "Europe/London", "America/Grenada", "Asia/Tbilisi", "America/Cayenne", "Europe/Guernsey", "Africa/Accra", "Europe/Gibraltar", "America/Godthab", "America/Danmarkshavn", "America/Scoresbysund", "America/Thule", "Africa/Banjul", "Africa/Conakry", "America/Guadeloupe", "Africa/Malabo", "Europe/Athens", "Atlantic/South_Georgia", "America/Guatemala", "Pacific/Guam", "Africa/Bissau", "America/Guyana", "Asia/Hong_Kong", "America/Tegucigalpa", "Europe/Zagreb", "America/Port-au-Prince", "Europe/Budapest", "Asia/Jakarta", "Asia/Pontianak", "Asia/Makassar", "Asia/Jayapura", "Europe/Dublin", "Asia/Jerusalem", "Europe/Isle_of_Man", "Asia/Kolkata", "Indian/Chagos", "Asia/Baghdad", "Asia/Tehran", "Atlantic/Reykjavik", "Europe/Rome", "Europe/Jersey", "America/Jamaica", "Asia/Amman", "Asia/Tokyo", "Africa/Nairobi", "Asia/Bishkek", "Asia/Phnom_Penh", "Pacific/Tarawa", "Pacific/Enderbury", "Pacific/Kiritimati", "Indian/Comoro", "America/St_Kitts", "Asia/Pyongyang", "Asia/Seoul", "Asia/Kuwait", "America/Cayman", "Asia/Almaty", "Asia/Qyzylorda", "Asia/Aqtobe", "Asia/Aqtau", "Asia/Oral", "Asia/Vientiane", "Asia/Beirut", "America/St_Lucia", "Europe/Vaduz", "Asia/Colombo", "Africa/Monrovia", "Africa/Maseru", "Europe/Vilnius", "Europe/Luxembourg", "Europe/Riga", "Africa/Tripoli", "Africa/Casablanca", "Europe/Monaco", "Europe/Chisinau", "Europe/Podgorica", "America/Marigot", "Indian/Antananarivo", "Pacific/Majuro", "Pacific/Kwajalein", "Europe/Skopje", "Africa/Bamako", "Asia/Rangoon", "Asia/Ulaanbaatar", "Asia/Hovd", "Asia/Choibalsan", "Asia/Macau", "Pacific/Saipan", "America/Martinique", "Africa/Nouakchott", "America/Montserrat", "Europe/Malta", "Indian/Mauritius", "Indian/Maldives", "Africa/Blantyre", "America/Mexico_City", "America/Cancun", "America/Merida", "America/Monterrey", "America/Matamoros", "America/Mazatlan", "America/Chihuahua", "America/Ojinaga", "America/Hermosillo", "America/Tijuana", "America/Santa_Isabel", "America/Bahia_Banderas", "Asia/Kuala_Lumpur", "Asia/Kuching", "Africa/Maputo", "Africa/Windhoek", "Pacific/Noumea", "Africa/Niamey", "Pacific/Norfolk", "Africa/Lagos", "America/Managua", "Europe/Amsterdam", "Europe/Oslo", "Asia/Kathmandu", "Pacific/Nauru", "Pacific/Niue", "Pacific/Auckland", "Pacific/Chatham", "Asia/Muscat", "America/Panama", "America/Lima", "Pacific/Tahiti", "Pacific/Marquesas", "Pacific/Gambier", "Pacific/Port_Moresby", "Asia/Manila", "Asia/Karachi", "Europe/Warsaw", "America/Miquelon", "Pacific/Pitcairn", "America/Puerto_Rico", "Asia/Gaza", "Asia/Hebron", "Europe/Lisbon", "Atlantic/Madeira", "Atlantic/Azores", "Pacific/Palau", "America/Asuncion", "Asia/Qatar", "Indian/Reunion", "Europe/Bucharest", "Europe/Belgrade", "Europe/Kaliningrad", "Europe/Moscow", "Europe/Volgograd", "Europe/Samara", "Asia/Yekaterinburg", "Asia/Omsk", "Asia/Novosibirsk", "Asia/Novokuznetsk", "Asia/Krasnoyarsk", "Asia/Irkutsk", "Asia/Yakutsk", "Asia/Khandyga", "Asia/Vladivostok", "Asia/Sakhalin", "Asia/Ust-Nera", "Asia/Magadan", "Asia/Kamchatka", "Asia/Anadyr", "Africa/Kigali", "Asia/Riyadh", "Pacific/Guadalcanal", "Indian/Mahe", "Africa/Khartoum", "Europe/Stockholm", "Asia/Singapore", "Atlantic/St_Helena", "Europe/Ljubljana", "Arctic/Longyearbyen", "Europe/Bratislava", "Africa/Freetown", "Europe/San_Marino", "Africa/Dakar", "Africa/Mogadishu", "America/Paramaribo", "Africa/Juba", "Africa/Sao_Tome", "America/El_Salvador", "America/Lower_Princes", "Asia/Damascus", "Africa/Mbabane", "America/Grand_Turk", "Africa/Ndjamena", "Indian/Kerguelen", "Africa/Lome", "Asia/Bangkok", "Asia/Dushanbe", "Pacific/Fakaofo", "Asia/Dili", "Asia/Ashgabat", "Africa/Tunis", "Pacific/Tongatapu", "Europe/Istanbul", "America/Port_of_Spain", "Pacific/Funafuti", "Asia/Taipei", "Africa/Dar_es_Salaam", "Europe/Kiev", "Europe/Uzhgorod", "Europe/Zaporozhye", "Europe/Simferopol", "Africa/Kampala", "Pacific/Johnston", "Pacific/Midway", "Pacific/Wake", "America/New_York", "America/Detroit", "America/Kentucky/Louisville", "America/Kentucky/Monticello", "America/Indiana/Indianapolis", "America/Indiana/Vincennes", "America/Indiana/Winamac", "America/Indiana/Marengo", "America/Indiana/Petersburg", "America/Indiana/Vevay", "America/Chicago", "America/Indiana/Tell_City", "America/Indiana/Knox", "America/Menominee", "America/North_Dakota/Center", "America/North_Dakota/New_Salem", "America/North_Dakota/Beulah", "America/Denver", "America/Boise", "America/Phoenix", "America/Los_Angeles", "America/Anchorage", "America/Juneau", "America/Sitka", "America/Yakutat", "America/Nome", "America/Adak", "America/Metlakatla", "Pacific/Honolulu", "America/Montevideo", "Asia/Samarkand", "Asia/Tashkent", "Europe/Vatican", "America/St_Vincent", "America/Caracas", "America/Tortola", "America/St_Thomas", "Asia/Ho_Chi_Minh", "Pacific/Efate", "Pacific/Wallis", "Pacific/Apia", "Asia/Aden", "Indian/Mayotte", "Africa/Johannesburg", "Africa/Lusaka", "Africa/Harare", "UTC" ], "default": "UTC" } }, "description": "Configure clock", "$$ref": "#/components/schemas/Clock" }, "description": { "pattern": "^[^<>]{1,32}$", "type": "string", "description": "Set a text description of the device", "example": "System settings" }, "deviceGroups": { "type": "array", "description": "Configure device groups", "items": { "type": "string", "description": "Configure device groups" } }, "gpsLocation": { "required": [ "latitude", "longitude" ], "type": "object", "properties": { "latitude": { "maximum": 90, "minimum": -90, "type": "number", "description": "Set the device\u2019s physical latitude", "example": 60 }, "longitude": { "maximum": 180, "minimum": -180, "type": "number", "description": "Set the device\u2019s physical longitude", "example": 60 } }, "description": "GPS latitude and longitude of the device", "$$ref": "#/components/schemas/GpsLocation" }, "hostName": { "pattern": "^[a-zA-Z0-9\\-_]{1,32}$", "type": "string", "description": "Set the hostname", "example": "vm12" }, "location": { "pattern": "^[^<>]{1,127}$", "type": "string", "description": "Set the location of the device", "example": "USA" }, "siteId": { "maximum": 4294967295, "minimum": 0, "type": "integer", "description": "Set the site ID", "format": "int64", "example": 100 }, "systemIp": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "Set the system IP address", "example": "102.2.3.2" }, "vbond": { "required": [ "address" ], "type": "object", "properties": { "address": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "Set the vBond IP address", "example": "10.0.12.22" } }, "$$ref": "#/components/schemas/Vbond" } }, "description": "System configuration for validator", "$$ref": "#/components/schemas/ValidatorSystemSetting" }, "vpn": { "required": [ "transport" ], "type": "object", "properties": { "management": { "required": [ "interface" ], "type": "object", "properties": { "dns": { "type": "object", "properties": { "dnsServerPrimary": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "Primary DNS server IPv4 or IPv6 Address", "example": "10.2.2.2" }, "dnsServerSecondary": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "Secondary DNS server IPv4 or IPv6 Address", "example": "10.2.2.3" }, "host": { "type": "array", "items": { "required": [ "hostname", "ip" ], "type": "object", "properties": { "hostname": { "pattern": "^[a-zA-Z0-9\\-_.]{1,64}$", "type": "string", "description": "Host name", "example": "vbond" }, "ip": { "maxItems": 64, "minItems": 1, "uniqueItems": true, "type": "array", "items": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "IP Address", "example": "10.1.1.1" } } }, "description": "Static host mapping", "$$ref": "#/components/schemas/DnsHostMapping" } } }, "description": "Configure DNS servers or static host mapping", "$$ref": "#/components/schemas/ControlComponentDnsSetting" }, "interface": { "maxItems": 2147483647, "minItems": 1, "type": "array", "items": { "required": [ "ifName" ], "type": "object", "properties": { "ifName": { "pattern": "^(?=.{1,32}$)(?:(ge0\\/\\d+(?:\\.\\d+)?|loopback\\d+|eth\\d+(?:\\.\\d+)?))$", "type": "string", "description": "Interface name eth<0-..> or eth<0-..>.vlanid or loopback when present", "example": "eth0" }, "ip": { "type": "object", "properties": { "address": { "pattern": "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\\/)([0-2]?[0-9]$|[3]?[0-2])$", "type": "string", "description": "Assign IPv4 address", "example": "10.0.1.1/24" }, "dhcpClient": { "type": "boolean", "description": "Enable DHCP", "example": false, "default": false }, "dhcpDistance": { "maximum": 65536, "minimum": 1, "type": "integer", "description": "Set administrative distance for DHCP default route", "format": "int32", "example": 1, "default": 1 } }, "description": "IPv4 address or DHCP", "$$ref": "#/components/schemas/IpConfig" }, "ipv6": { "type": "object", "properties": { "address": { "pattern": "((^\\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))(%.+)?\\s*(\\/)(\\b([0-9]{1,2}|1[01][0-9]|12[0-8])\\b)$))", "type": "string", "description": "Assign IPv6 address", "example": "2001:a0:64::20/64" }, "dhcpClient": { "type": "boolean", "description": "Enable DHCP", "example": false, "default": false }, "dhcpDistance": { "maximum": 65536, "minimum": 1, "type": "integer", "description": "Set administrative distance for DHCP default route", "format": "int32", "example": 1, "default": 1 }, "dhcpRapidCommit": { "type": "boolean", "description": "Enable DHCPv6 rapid commit", "example": false, "default": false } }, "description": "IPv6 address or DHCP", "$$ref": "#/components/schemas/Ipv6Config" }, "shutdown": { "type": "boolean", "description": "Administrative state", "example": false, "default": false } }, "description": "Interfaces configuration", "$$ref": "#/components/schemas/BaseInterfaceSetting" } }, "ipRoute": { "type": "object", "properties": { "route": { "type": "array", "items": { "required": [ "nextHop", "prefix" ], "type": "object", "properties": { "nextHop": { "maxItems": 2147483647, "minItems": 1, "type": "array", "items": { "required": [ "address" ], "type": "object", "properties": { "address": { "pattern": "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "description": "IPv4 Address", "example": "10.0.0.1" }, "distance": { "maximum": 255, "minimum": 1, "type": "integer", "description": "Administrative distance", "format": "int32", "example": 1, "default": 1 } }, "description": "IP gateway address", "$$ref": "#/components/schemas/NextHop" } }, "prefix": { "pattern": "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\\/)([0-2]?[0-9]$|[3]?[0-2])$", "type": "string", "description": "IPv4 Prefix", "example": "0.0.0.0/0" } }, "description": "Configure static routes", "$$ref": "#/components/schemas/StaticRoute" } } }, "description": "IP Route information", "$$ref": "#/components/schemas/IpRoute" }, "ipv6Route": { "type": "object", "properties": { "route": { "type": "array", "items": { "required": [ "nextHop", "prefix" ], "type": "object", "properties": { "nextHop": { "maxItems": 2147483647, "minItems": 1, "type": "array", "items": { "required": [ "address" ], "type": "object", "properties": { "address": { "pattern": "(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))", "type": "string", "description": "IPv6 Address", "example": "2001::1" }, "distance": { "maximum": 255, "minimum": 1, "type": "integer", "description": "Administrative distance", "format": "int32", "example": 1, "default": 1 } }, "description": "IP gateway address", "$$ref": "#/components/schemas/IPV6NextHop" } }, "prefix": { "pattern": "((^\\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))(%.+)?\\s*(\\/)(\\b([0-9]{1,2}|1[01][0-9]|12[0-8])\\b)$))", "type": "string", "description": "IPv6 Prefix", "example": "2001::/4" } }, "description": "Configure IPv6 static routes", "$$ref": "#/components/schemas/Ipv6StaticRoute" } } }, "description": "IPv6 Route information", "$$ref": "#/components/schemas/Ipv6Route" } }, "description": "Management VPN instance", "$$ref": "#/components/schemas/baseVpnInstanceBaseInterfaceSetting" }, "transport": { "required": [ "interface" ], "type": "object", "properties": { "dns": { "type": "object", "properties": { "dnsServerPrimary": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "Primary DNS server IPv4 or IPv6 Address", "example": "10.2.2.2" }, "dnsServerSecondary": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "Secondary DNS server IPv4 or IPv6 Address", "example": "10.2.2.3" }, "host": { "type": "array", "items": { "required": [ "hostname", "ip" ], "type": "object", "properties": { "hostname": { "pattern": "^[a-zA-Z0-9\\-_.]{1,64}$", "type": "string", "description": "Host name", "example": "vbond" }, "ip": { "maxItems": 64, "minItems": 1, "uniqueItems": true, "type": "array", "items": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "IP Address", "example": "10.1.1.1" } } }, "description": "Static host mapping", "$$ref": "#/components/schemas/DnsHostMapping" } } }, "description": "Configure DNS servers or static host mapping", "$$ref": "#/components/schemas/ControlComponentDnsSetting" }, "interface": { "maxItems": 2147483647, "minItems": 1, "type": "array", "items": { "required": [ "ifName" ], "type": "object", "properties": { "ifName": { "pattern": "^(?=.{1,32}$)(?:(ge0\\/\\d+(?:\\.\\d+)?|loopback\\d+|eth\\d+(?:\\.\\d+)?))$", "type": "string", "description": "Interface name eth<0-..> or eth<0-..>.vlanid or loopback when present", "example": "eth0" }, "ip": { "type": "object", "properties": { "address": { "pattern": "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\\/)([0-2]?[0-9]$|[3]?[0-2])$", "type": "string", "description": "Assign IPv4 address", "example": "10.0.1.1/24" }, "dhcpClient": { "type": "boolean", "description": "Enable DHCP", "example": false, "default": false }, "dhcpDistance": { "maximum": 65536, "minimum": 1, "type": "integer", "description": "Set administrative distance for DHCP default route", "format": "int32", "example": 1, "default": 1 } }, "description": "IPv4 address or DHCP", "$$ref": "#/components/schemas/IpConfig" }, "ipv6": { "type": "object", "properties": { "address": { "pattern": "((^\\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))(%.+)?\\s*(\\/)(\\b([0-9]{1,2}|1[01][0-9]|12[0-8])\\b)$))", "type": "string", "description": "Assign IPv6 address", "example": "2001:a0:64::20/64" }, "dhcpClient": { "type": "boolean", "description": "Enable DHCP", "example": false, "default": false }, "dhcpDistance": { "maximum": 65536, "minimum": 1, "type": "integer", "description": "Set administrative distance for DHCP default route", "format": "int32", "example": 1, "default": 1 }, "dhcpRapidCommit": { "type": "boolean", "description": "Enable DHCPv6 rapid commit", "example": false, "default": false } }, "description": "IPv6 address or DHCP", "$$ref": "#/components/schemas/Ipv6Config" }, "shutdown": { "type": "boolean", "description": "Administrative state", "example": false, "default": false }, "tunnelInterface": { "type": "object", "properties": { "allowService": { "type": "object", "properties": { "all": { "type": "boolean", "description": "Allow all traffic. Overrides all other allow-service options if allow-service all is set", "example": false, "default": false }, "dhcp": { "type": "boolean", "description": "Allow/Deny DHCP", "example": true, "default": true }, "dns": { "type": "boolean", "description": "Allow/Deny DNS", "example": true, "default": true }, "icmp": { "type": "boolean", "description": "Allow/Deny ICMP", "example": true, "default": true }, "netconf": { "type": "boolean", "description": "Allow/Deny NETCONF", "example": false, "default": false }, "ntp": { "type": "boolean", "description": "Allow/Deny NTP", "example": false, "default": false }, "sshd": { "type": "boolean", "description": "Allow/Deny SSH", "example": false, "default": false }, "stun": { "type": "boolean", "description": "Allow/Deny STUN", "example": false, "default": false } }, "description": "Set services allowed on the WAN interface", "$$ref": "#/components/schemas/AllowService" }, "color": { "type": "object", "properties": { "value": { "type": "string", "description": "Set color for TLOC", "example": "default", "enum": [ "default", "mpls", "metro-ethernet", "biz-internet", "public-internet", "lte", "3g", "red", "green", "blue", "gold", "silver", "bronze", "custom1", "custom2", "custom3", "private1", "private2", "private3", "private4", "private5", "private6" ], "default": "default" } }, "description": "Set color for TLOC", "$$ref": "#/components/schemas/Color" } }, "description": "Tunnel interface configuration", "$$ref": "#/components/schemas/TunnelInterface" } }, "description": "Interfaces configuration", "$$ref": "#/components/schemas/TransportInterfaceSetting" } }, "ipRoute": { "type": "object", "properties": { "route": { "type": "array", "items": { "required": [ "nextHop", "prefix" ], "type": "object", "properties": { "nextHop": { "maxItems": 2147483647, "minItems": 1, "type": "array", "items": { "required": [ "address" ], "type": "object", "properties": { "address": { "pattern": "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "description": "IPv4 Address", "example": "10.0.0.1" }, "distance": { "maximum": 255, "minimum": 1, "type": "integer", "description": "Administrative distance", "format": "int32", "example": 1, "default": 1 } }, "description": "IP gateway address", "$$ref": "#/components/schemas/NextHop" } }, "prefix": { "pattern": "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\\/)([0-2]?[0-9]$|[3]?[0-2])$", "type": "string", "description": "IPv4 Prefix", "example": "0.0.0.0/0" } }, "description": "Configure static routes", "$$ref": "#/components/schemas/StaticRoute" } } }, "description": "IP Route information", "$$ref": "#/components/schemas/IpRoute" }, "ipv6Route": { "type": "object", "properties": { "route": { "type": "array", "items": { "required": [ "nextHop", "prefix" ], "type": "object", "properties": { "nextHop": { "maxItems": 2147483647, "minItems": 1, "type": "array", "items": { "required": [ "address" ], "type": "object", "properties": { "address": { "pattern": "(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))", "type": "string", "description": "IPv6 Address", "example": "2001::1" }, "distance": { "maximum": 255, "minimum": 1, "type": "integer", "description": "Administrative distance", "format": "int32", "example": 1, "default": 1 } }, "description": "IP gateway address", "$$ref": "#/components/schemas/IPV6NextHop" } }, "prefix": { "pattern": "((^\\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))(%.+)?\\s*(\\/)(\\b([0-9]{1,2}|1[01][0-9]|12[0-8])\\b)$))", "type": "string", "description": "IPv6 Prefix", "example": "2001::/4" } }, "description": "Configure IPv6 static routes", "$$ref": "#/components/schemas/Ipv6StaticRoute" } } }, "description": "IPv6 Route information", "$$ref": "#/components/schemas/Ipv6Route" } }, "description": "Transport VPN instance", "$$ref": "#/components/schemas/baseVpnInstanceTransportInterfaceSetting" } }, "description": "Validator VPN setting", "$$ref": "#/components/schemas/ValidatorVpnSetting" } }, "description": "The payload for validator device specific settings", "$$ref": "#/components/schemas/ValidatorDeviceSpecificSetting" }, { "required": [ "system", "vpn" ], "type": "object", "properties": { "system": { "required": [ "hostName", "siteId", "systemIp" ], "type": "object", "properties": { "clock": { "required": [ "timezone" ], "type": "object", "properties": { "timezone": { "type": "string", "description": "Set the timezone", "example": "UTC", "enum": [ "Europe/Andorra", "Asia/Dubai", "Asia/Kabul", "America/Antigua", "America/Anguilla", "Europe/Tirane", "Asia/Yerevan", "Africa/Luanda", "Antarctica/McMurdo", "Antarctica/Rothera", "Antarctica/Palmer", "Antarctica/Mawson", "Antarctica/Davis", "Antarctica/Casey", "Antarctica/Vostok", "Antarctica/DumontDUrville", "Antarctica/Syowa", "America/Argentina/Buenos_Aires", "America/Argentina/Cordoba", "America/Argentina/Salta", "America/Argentina/Jujuy", "America/Argentina/Tucuman", "America/Argentina/Catamarca", "America/Argentina/La_Rioja", "America/Argentina/San_Juan", "America/Argentina/Mendoza", "America/Argentina/San_Luis", "America/Argentina/Rio_Gallegos", "America/Argentina/Ushuaia", "Pacific/Pago_Pago", "Europe/Vienna", "Australia/Lord_Howe", "Antarctica/Macquarie", "Australia/Hobart", "Australia/Currie", "Australia/Melbourne", "Australia/Sydney", "Australia/Broken_Hill", "Australia/Brisbane", "Australia/Lindeman", "Australia/Adelaide", "Australia/Darwin", "Australia/Perth", "Australia/Eucla", "America/Aruba", "Europe/Mariehamn", "Asia/Baku", "Europe/Sarajevo", "America/Barbados", "Asia/Dhaka", "Europe/Brussels", "Africa/Ouagadougou", "Europe/Sofia", "Asia/Bahrain", "Africa/Bujumbura", "Africa/Porto-Novo", "America/St_Barthelemy", "Atlantic/Bermuda", "Asia/Brunei", "America/La_Paz", "America/Kralendijk", "America/Noronha", "America/Belem", "America/Fortaleza", "America/Recife", "America/Araguaina", "America/Maceio", "America/Bahia", "America/Sao_Paulo", "America/Campo_Grande", "America/Cuiaba", "America/Santarem", "America/Porto_Velho", "America/Boa_Vista", "America/Manaus", "America/Eirunepe", "America/Rio_Branco", "America/Nassau", "Asia/Thimphu", "Africa/Gaborone", "Europe/Minsk", "America/Belize", "America/St_Johns", "America/Halifax", "America/Glace_Bay", "America/Moncton", "America/Goose_Bay", "America/Blanc-Sablon", "America/Toronto", "America/Nipigon", "America/Thunder_Bay", "America/Iqaluit", "America/Pangnirtung", "America/Resolute", "America/Atikokan", "America/Rankin_Inlet", "America/Winnipeg", "America/Rainy_River", "America/Regina", "America/Swift_Current", "America/Edmonton", "America/Cambridge_Bay", "America/Yellowknife", "America/Inuvik", "America/Creston", "America/Dawson_Creek", "America/Vancouver", "America/Whitehorse", "America/Dawson", "Indian/Cocos", "Africa/Kinshasa", "Africa/Lubumbashi", "Africa/Bangui", "Africa/Brazzaville", "Europe/Zurich", "Africa/Abidjan", "Pacific/Rarotonga", "America/Santiago", "Pacific/Easter", "Africa/Douala", "Asia/Shanghai", "Asia/Harbin", "Asia/Chongqing", "Asia/Urumqi", "Asia/Kashgar", "America/Bogota", "America/Costa_Rica", "America/Havana", "Atlantic/Cape_Verde", "America/Curacao", "Indian/Christmas", "Asia/Nicosia", "Europe/Prague", "Europe/Berlin", "Europe/Busingen", "Africa/Djibouti", "Europe/Copenhagen", "America/Dominica", "America/Santo_Domingo", "Africa/Algiers", "America/Guayaquil", "Pacific/Galapagos", "Europe/Tallinn", "Africa/Cairo", "Africa/El_Aaiun", "Africa/Asmara", "Europe/Madrid", "Africa/Ceuta", "Atlantic/Canary", "Africa/Addis_Ababa", "Europe/Helsinki", "Pacific/Fiji", "Atlantic/Stanley", "Pacific/Chuuk", "Pacific/Pohnpei", "Pacific/Kosrae", "Atlantic/Faroe", "Europe/Paris", "Africa/Libreville", "Europe/London", "America/Grenada", "Asia/Tbilisi", "America/Cayenne", "Europe/Guernsey", "Africa/Accra", "Europe/Gibraltar", "America/Godthab", "America/Danmarkshavn", "America/Scoresbysund", "America/Thule", "Africa/Banjul", "Africa/Conakry", "America/Guadeloupe", "Africa/Malabo", "Europe/Athens", "Atlantic/South_Georgia", "America/Guatemala", "Pacific/Guam", "Africa/Bissau", "America/Guyana", "Asia/Hong_Kong", "America/Tegucigalpa", "Europe/Zagreb", "America/Port-au-Prince", "Europe/Budapest", "Asia/Jakarta", "Asia/Pontianak", "Asia/Makassar", "Asia/Jayapura", "Europe/Dublin", "Asia/Jerusalem", "Europe/Isle_of_Man", "Asia/Kolkata", "Indian/Chagos", "Asia/Baghdad", "Asia/Tehran", "Atlantic/Reykjavik", "Europe/Rome", "Europe/Jersey", "America/Jamaica", "Asia/Amman", "Asia/Tokyo", "Africa/Nairobi", "Asia/Bishkek", "Asia/Phnom_Penh", "Pacific/Tarawa", "Pacific/Enderbury", "Pacific/Kiritimati", "Indian/Comoro", "America/St_Kitts", "Asia/Pyongyang", "Asia/Seoul", "Asia/Kuwait", "America/Cayman", "Asia/Almaty", "Asia/Qyzylorda", "Asia/Aqtobe", "Asia/Aqtau", "Asia/Oral", "Asia/Vientiane", "Asia/Beirut", "America/St_Lucia", "Europe/Vaduz", "Asia/Colombo", "Africa/Monrovia", "Africa/Maseru", "Europe/Vilnius", "Europe/Luxembourg", "Europe/Riga", "Africa/Tripoli", "Africa/Casablanca", "Europe/Monaco", "Europe/Chisinau", "Europe/Podgorica", "America/Marigot", "Indian/Antananarivo", "Pacific/Majuro", "Pacific/Kwajalein", "Europe/Skopje", "Africa/Bamako", "Asia/Rangoon", "Asia/Ulaanbaatar", "Asia/Hovd", "Asia/Choibalsan", "Asia/Macau", "Pacific/Saipan", "America/Martinique", "Africa/Nouakchott", "America/Montserrat", "Europe/Malta", "Indian/Mauritius", "Indian/Maldives", "Africa/Blantyre", "America/Mexico_City", "America/Cancun", "America/Merida", "America/Monterrey", "America/Matamoros", "America/Mazatlan", "America/Chihuahua", "America/Ojinaga", "America/Hermosillo", "America/Tijuana", "America/Santa_Isabel", "America/Bahia_Banderas", "Asia/Kuala_Lumpur", "Asia/Kuching", "Africa/Maputo", "Africa/Windhoek", "Pacific/Noumea", "Africa/Niamey", "Pacific/Norfolk", "Africa/Lagos", "America/Managua", "Europe/Amsterdam", "Europe/Oslo", "Asia/Kathmandu", "Pacific/Nauru", "Pacific/Niue", "Pacific/Auckland", "Pacific/Chatham", "Asia/Muscat", "America/Panama", "America/Lima", "Pacific/Tahiti", "Pacific/Marquesas", "Pacific/Gambier", "Pacific/Port_Moresby", "Asia/Manila", "Asia/Karachi", "Europe/Warsaw", "America/Miquelon", "Pacific/Pitcairn", "America/Puerto_Rico", "Asia/Gaza", "Asia/Hebron", "Europe/Lisbon", "Atlantic/Madeira", "Atlantic/Azores", "Pacific/Palau", "America/Asuncion", "Asia/Qatar", "Indian/Reunion", "Europe/Bucharest", "Europe/Belgrade", "Europe/Kaliningrad", "Europe/Moscow", "Europe/Volgograd", "Europe/Samara", "Asia/Yekaterinburg", "Asia/Omsk", "Asia/Novosibirsk", "Asia/Novokuznetsk", "Asia/Krasnoyarsk", "Asia/Irkutsk", "Asia/Yakutsk", "Asia/Khandyga", "Asia/Vladivostok", "Asia/Sakhalin", "Asia/Ust-Nera", "Asia/Magadan", "Asia/Kamchatka", "Asia/Anadyr", "Africa/Kigali", "Asia/Riyadh", "Pacific/Guadalcanal", "Indian/Mahe", "Africa/Khartoum", "Europe/Stockholm", "Asia/Singapore", "Atlantic/St_Helena", "Europe/Ljubljana", "Arctic/Longyearbyen", "Europe/Bratislava", "Africa/Freetown", "Europe/San_Marino", "Africa/Dakar", "Africa/Mogadishu", "America/Paramaribo", "Africa/Juba", "Africa/Sao_Tome", "America/El_Salvador", "America/Lower_Princes", "Asia/Damascus", "Africa/Mbabane", "America/Grand_Turk", "Africa/Ndjamena", "Indian/Kerguelen", "Africa/Lome", "Asia/Bangkok", "Asia/Dushanbe", "Pacific/Fakaofo", "Asia/Dili", "Asia/Ashgabat", "Africa/Tunis", "Pacific/Tongatapu", "Europe/Istanbul", "America/Port_of_Spain", "Pacific/Funafuti", "Asia/Taipei", "Africa/Dar_es_Salaam", "Europe/Kiev", "Europe/Uzhgorod", "Europe/Zaporozhye", "Europe/Simferopol", "Africa/Kampala", "Pacific/Johnston", "Pacific/Midway", "Pacific/Wake", "America/New_York", "America/Detroit", "America/Kentucky/Louisville", "America/Kentucky/Monticello", "America/Indiana/Indianapolis", "America/Indiana/Vincennes", "America/Indiana/Winamac", "America/Indiana/Marengo", "America/Indiana/Petersburg", "America/Indiana/Vevay", "America/Chicago", "America/Indiana/Tell_City", "America/Indiana/Knox", "America/Menominee", "America/North_Dakota/Center", "America/North_Dakota/New_Salem", "America/North_Dakota/Beulah", "America/Denver", "America/Boise", "America/Phoenix", "America/Los_Angeles", "America/Anchorage", "America/Juneau", "America/Sitka", "America/Yakutat", "America/Nome", "America/Adak", "America/Metlakatla", "Pacific/Honolulu", "America/Montevideo", "Asia/Samarkand", "Asia/Tashkent", "Europe/Vatican", "America/St_Vincent", "America/Caracas", "America/Tortola", "America/St_Thomas", "Asia/Ho_Chi_Minh", "Pacific/Efate", "Pacific/Wallis", "Pacific/Apia", "Asia/Aden", "Indian/Mayotte", "Africa/Johannesburg", "Africa/Lusaka", "Africa/Harare", "UTC" ], "default": "UTC" } }, "description": "Configure clock", "$$ref": "#/components/schemas/Clock" }, "controllerGroupId": { "maximum": 100, "minimum": 0, "type": "integer", "description": "Controller group id", "format": "int32", "example": 0, "default": 0 }, "description": { "pattern": "^[^<>]{1,32}$", "type": "string", "description": "Set a text description of the device", "example": "System settings" }, "deviceGroups": { "type": "array", "description": "Configure device groups", "items": { "type": "string", "description": "Configure device groups" } }, "gpsLocation": { "required": [ "latitude", "longitude" ], "type": "object", "properties": { "latitude": { "maximum": 90, "minimum": -90, "type": "number", "description": "Set the device\u2019s physical latitude", "example": 60 }, "longitude": { "maximum": 180, "minimum": -180, "type": "number", "description": "Set the device\u2019s physical longitude", "example": 60 } }, "description": "GPS latitude and longitude of the device", "$$ref": "#/components/schemas/GpsLocation" }, "hostName": { "pattern": "^[a-zA-Z0-9\\-_]{1,32}$", "type": "string", "description": "Set the hostname", "example": "vm12" }, "ipv6StrictControl": { "type": "boolean", "description": "Sets up a strict IPv6 control connection in a dual stack IP", "example": false, "default": false }, "location": { "pattern": "^[^<>]{1,127}$", "type": "string", "description": "Set the location of the device", "example": "USA" }, "overlayId": { "maximum": 4294967295, "minimum": 1, "type": "integer", "description": "Set the Overlay ID", "format": "int64", "example": 1, "default": 1 }, "region": { "type": "object", "properties": { "regionIdList": { "maxItems": 2147483647, "minItems": 1, "uniqueItems": true, "type": "array", "items": { "maximum": 63, "minimum": 0, "type": "integer", "description": "Configure a list of region ID", "format": "int32", "example": 0 } } }, "$$ref": "#/components/schemas/Region" }, "siteId": { "maximum": 4294967295, "minimum": 0, "type": "integer", "description": "Set the site ID", "format": "int64", "example": 100 }, "systemIp": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "Set the system IP address", "example": "102.2.3.2" } }, "description": "System configuration for controller", "$$ref": "#/components/schemas/ControllerSystemSetting" }, "vpn": { "required": [ "transport" ], "type": "object", "properties": { "management": { "required": [ "interface" ], "type": "object", "properties": { "dns": { "type": "object", "properties": { "dnsServerPrimary": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "Primary DNS server IPv4 or IPv6 Address", "example": "10.2.2.2" }, "dnsServerSecondary": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "Secondary DNS server IPv4 or IPv6 Address", "example": "10.2.2.3" }, "host": { "type": "array", "items": { "required": [ "hostname", "ip" ], "type": "object", "properties": { "hostname": { "pattern": "^[a-zA-Z0-9\\-_.]{1,64}$", "type": "string", "description": "Host name", "example": "vbond" }, "ip": { "maxItems": 64, "minItems": 1, "uniqueItems": true, "type": "array", "items": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "IP Address", "example": "10.1.1.1" } } }, "description": "Static host mapping", "$$ref": "#/components/schemas/DnsHostMapping" } } }, "description": "Configure DNS servers or static host mapping", "$$ref": "#/components/schemas/ControlComponentDnsSetting" }, "interface": { "maxItems": 2147483647, "minItems": 1, "type": "array", "items": { "required": [ "ifName" ], "type": "object", "properties": { "ifName": { "pattern": "^(?=.{1,32}$)(?:(ge0\\/\\d+(?:\\.\\d+)?|loopback\\d+|eth\\d+(?:\\.\\d+)?))$", "type": "string", "description": "Interface name eth<0-..> or eth<0-..>.vlanid or loopback when present", "example": "eth0" }, "ip": { "type": "object", "properties": { "address": { "pattern": "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\\/)([0-2]?[0-9]$|[3]?[0-2])$", "type": "string", "description": "Assign IPv4 address", "example": "10.0.1.1/24" }, "dhcpClient": { "type": "boolean", "description": "Enable DHCP", "example": false, "default": false }, "dhcpDistance": { "maximum": 65536, "minimum": 1, "type": "integer", "description": "Set administrative distance for DHCP default route", "format": "int32", "example": 1, "default": 1 } }, "description": "IPv4 address or DHCP", "$$ref": "#/components/schemas/IpConfig" }, "ipv6": { "type": "object", "properties": { "address": { "pattern": "((^\\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))(%.+)?\\s*(\\/)(\\b([0-9]{1,2}|1[01][0-9]|12[0-8])\\b)$))", "type": "string", "description": "Assign IPv6 address", "example": "2001:a0:64::20/64" }, "dhcpClient": { "type": "boolean", "description": "Enable DHCP", "example": false, "default": false }, "dhcpDistance": { "maximum": 65536, "minimum": 1, "type": "integer", "description": "Set administrative distance for DHCP default route", "format": "int32", "example": 1, "default": 1 }, "dhcpRapidCommit": { "type": "boolean", "description": "Enable DHCPv6 rapid commit", "example": false, "default": false } }, "description": "IPv6 address or DHCP", "$$ref": "#/components/schemas/Ipv6Config" }, "shutdown": { "type": "boolean", "description": "Administrative state", "example": false, "default": false } }, "description": "Interfaces configuration", "$$ref": "#/components/schemas/BaseInterfaceSetting" } }, "ipRoute": { "type": "object", "properties": { "route": { "type": "array", "items": { "required": [ "nextHop", "prefix" ], "type": "object", "properties": { "nextHop": { "maxItems": 2147483647, "minItems": 1, "type": "array", "items": { "required": [ "address" ], "type": "object", "properties": { "address": { "pattern": "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "description": "IPv4 Address", "example": "10.0.0.1" }, "distance": { "maximum": 255, "minimum": 1, "type": "integer", "description": "Administrative distance", "format": "int32", "example": 1, "default": 1 } }, "description": "IP gateway address", "$$ref": "#/components/schemas/NextHop" } }, "prefix": { "pattern": "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\\/)([0-2]?[0-9]$|[3]?[0-2])$", "type": "string", "description": "IPv4 Prefix", "example": "0.0.0.0/0" } }, "description": "Configure static routes", "$$ref": "#/components/schemas/StaticRoute" } } }, "description": "IP Route information", "$$ref": "#/components/schemas/IpRoute" }, "ipv6Route": { "type": "object", "properties": { "route": { "type": "array", "items": { "required": [ "nextHop", "prefix" ], "type": "object", "properties": { "nextHop": { "maxItems": 2147483647, "minItems": 1, "type": "array", "items": { "required": [ "address" ], "type": "object", "properties": { "address": { "pattern": "(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))", "type": "string", "description": "IPv6 Address", "example": "2001::1" }, "distance": { "maximum": 255, "minimum": 1, "type": "integer", "description": "Administrative distance", "format": "int32", "example": 1, "default": 1 } }, "description": "IP gateway address", "$$ref": "#/components/schemas/IPV6NextHop" } }, "prefix": { "pattern": "((^\\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))(%.+)?\\s*(\\/)(\\b([0-9]{1,2}|1[01][0-9]|12[0-8])\\b)$))", "type": "string", "description": "IPv6 Prefix", "example": "2001::/4" } }, "description": "Configure IPv6 static routes", "$$ref": "#/components/schemas/Ipv6StaticRoute" } } }, "description": "IPv6 Route information", "$$ref": "#/components/schemas/Ipv6Route" } }, "description": "Management VPN instance", "$$ref": "#/components/schemas/baseVpnInstanceBaseInterfaceSetting" }, "transport": { "required": [ "interface" ], "type": "object", "properties": { "dns": { "type": "object", "properties": { "dnsServerPrimary": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "Primary DNS server IPv4 or IPv6 Address", "example": "10.2.2.2" }, "dnsServerSecondary": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "Secondary DNS server IPv4 or IPv6 Address", "example": "10.2.2.3" }, "host": { "type": "array", "items": { "required": [ "hostname", "ip" ], "type": "object", "properties": { "hostname": { "pattern": "^[a-zA-Z0-9\\-_.]{1,64}$", "type": "string", "description": "Host name", "example": "vbond" }, "ip": { "maxItems": 64, "minItems": 1, "uniqueItems": true, "type": "array", "items": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "IP Address", "example": "10.1.1.1" } } }, "description": "Static host mapping", "$$ref": "#/components/schemas/DnsHostMapping" } } }, "description": "Configure DNS servers or static host mapping", "$$ref": "#/components/schemas/ControlComponentDnsSetting" }, "interface": { "maxItems": 2147483647, "minItems": 1, "type": "array", "items": { "required": [ "ifName" ], "type": "object", "properties": { "ifName": { "pattern": "^(?=.{1,32}$)(?:(ge0\\/\\d+(?:\\.\\d+)?|loopback\\d+|eth\\d+(?:\\.\\d+)?))$", "type": "string", "description": "Interface name eth<0-..> or eth<0-..>.vlanid or loopback when present", "example": "eth0" }, "ip": { "type": "object", "properties": { "address": { "pattern": "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\\/)([0-2]?[0-9]$|[3]?[0-2])$", "type": "string", "description": "Assign IPv4 address", "example": "10.0.1.1/24" }, "dhcpClient": { "type": "boolean", "description": "Enable DHCP", "example": false, "default": false }, "dhcpDistance": { "maximum": 65536, "minimum": 1, "type": "integer", "description": "Set administrative distance for DHCP default route", "format": "int32", "example": 1, "default": 1 } }, "description": "IPv4 address or DHCP", "$$ref": "#/components/schemas/IpConfig" }, "ipv6": { "type": "object", "properties": { "address": { "pattern": "((^\\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))(%.+)?\\s*(\\/)(\\b([0-9]{1,2}|1[01][0-9]|12[0-8])\\b)$))", "type": "string", "description": "Assign IPv6 address", "example": "2001:a0:64::20/64" }, "dhcpClient": { "type": "boolean", "description": "Enable DHCP", "example": false, "default": false }, "dhcpDistance": { "maximum": 65536, "minimum": 1, "type": "integer", "description": "Set administrative distance for DHCP default route", "format": "int32", "example": 1, "default": 1 }, "dhcpRapidCommit": { "type": "boolean", "description": "Enable DHCPv6 rapid commit", "example": false, "default": false } }, "description": "IPv6 address or DHCP", "$$ref": "#/components/schemas/Ipv6Config" }, "shutdown": { "type": "boolean", "description": "Administrative state", "example": false, "default": false }, "tunnelInterface": { "type": "object", "properties": { "allowService": { "type": "object", "properties": { "all": { "type": "boolean", "description": "Allow all traffic. Overrides all other allow-service options if allow-service all is set", "example": false, "default": false }, "dhcp": { "type": "boolean", "description": "Allow/Deny DHCP", "example": true, "default": true }, "dns": { "type": "boolean", "description": "Allow/Deny DNS", "example": true, "default": true }, "icmp": { "type": "boolean", "description": "Allow/Deny ICMP", "example": true, "default": true }, "netconf": { "type": "boolean", "description": "Allow/Deny NETCONF", "example": false, "default": false }, "ntp": { "type": "boolean", "description": "Allow/Deny NTP", "example": false, "default": false }, "sshd": { "type": "boolean", "description": "Allow/Deny SSH", "example": false, "default": false }, "stun": { "type": "boolean", "description": "Allow/Deny STUN", "example": false, "default": false } }, "description": "Set services allowed on the WAN interface", "$$ref": "#/components/schemas/AllowService" }, "color": { "type": "object", "properties": { "value": { "type": "string", "description": "Set color for TLOC", "example": "default", "enum": [ "default", "mpls", "metro-ethernet", "biz-internet", "public-internet", "lte", "3g", "red", "green", "blue", "gold", "silver", "bronze", "custom1", "custom2", "custom3", "private1", "private2", "private3", "private4", "private5", "private6" ], "default": "default" } }, "description": "Set color for TLOC", "$$ref": "#/components/schemas/Color" } }, "description": "Tunnel interface configuration", "$$ref": "#/components/schemas/TunnelInterface" } }, "description": "Interfaces configuration", "$$ref": "#/components/schemas/TransportInterfaceSetting" } }, "ipRoute": { "type": "object", "properties": { "route": { "type": "array", "items": { "required": [ "nextHop", "prefix" ], "type": "object", "properties": { "nextHop": { "maxItems": 2147483647, "minItems": 1, "type": "array", "items": { "required": [ "address" ], "type": "object", "properties": { "address": { "pattern": "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "description": "IPv4 Address", "example": "10.0.0.1" }, "distance": { "maximum": 255, "minimum": 1, "type": "integer", "description": "Administrative distance", "format": "int32", "example": 1, "default": 1 } }, "description": "IP gateway address", "$$ref": "#/components/schemas/NextHop" } }, "prefix": { "pattern": "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\\/)([0-2]?[0-9]$|[3]?[0-2])$", "type": "string", "description": "IPv4 Prefix", "example": "0.0.0.0/0" } }, "description": "Configure static routes", "$$ref": "#/components/schemas/StaticRoute" } } }, "description": "IP Route information", "$$ref": "#/components/schemas/IpRoute" }, "ipv6Route": { "type": "object", "properties": { "route": { "type": "array", "items": { "required": [ "nextHop", "prefix" ], "type": "object", "properties": { "nextHop": { "maxItems": 2147483647, "minItems": 1, "type": "array", "items": { "required": [ "address" ], "type": "object", "properties": { "address": { "pattern": "(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))", "type": "string", "description": "IPv6 Address", "example": "2001::1" }, "distance": { "maximum": 255, "minimum": 1, "type": "integer", "description": "Administrative distance", "format": "int32", "example": 1, "default": 1 } }, "description": "IP gateway address", "$$ref": "#/components/schemas/IPV6NextHop" } }, "prefix": { "pattern": "((^\\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))(%.+)?\\s*(\\/)(\\b([0-9]{1,2}|1[01][0-9]|12[0-8])\\b)$))", "type": "string", "description": "IPv6 Prefix", "example": "2001::/4" } }, "description": "Configure IPv6 static routes", "$$ref": "#/components/schemas/Ipv6StaticRoute" } } }, "description": "IPv6 Route information", "$$ref": "#/components/schemas/Ipv6Route" } }, "description": "Transport VPN instance", "$$ref": "#/components/schemas/baseVpnInstanceTransportInterfaceSetting" } }, "description": "Controller VPN setting", "$$ref": "#/components/schemas/ControllerVpnSetting" } }, "description": "The payload for controller device specific settings", "$$ref": "#/components/schemas/ControllerDeviceSpecificSetting" }, { "required": [ "system", "vpn" ], "type": "object", "properties": { "system": { "required": [ "hostName", "siteId", "systemIp" ], "type": "object", "properties": { "clock": { "required": [ "timezone" ], "type": "object", "properties": { "timezone": { "type": "string", "description": "Set the timezone", "example": "UTC", "enum": [ "Europe/Andorra", "Asia/Dubai", "Asia/Kabul", "America/Antigua", "America/Anguilla", "Europe/Tirane", "Asia/Yerevan", "Africa/Luanda", "Antarctica/McMurdo", "Antarctica/Rothera", "Antarctica/Palmer", "Antarctica/Mawson", "Antarctica/Davis", "Antarctica/Casey", "Antarctica/Vostok", "Antarctica/DumontDUrville", "Antarctica/Syowa", "America/Argentina/Buenos_Aires", "America/Argentina/Cordoba", "America/Argentina/Salta", "America/Argentina/Jujuy", "America/Argentina/Tucuman", "America/Argentina/Catamarca", "America/Argentina/La_Rioja", "America/Argentina/San_Juan", "America/Argentina/Mendoza", "America/Argentina/San_Luis", "America/Argentina/Rio_Gallegos", "America/Argentina/Ushuaia", "Pacific/Pago_Pago", "Europe/Vienna", "Australia/Lord_Howe", "Antarctica/Macquarie", "Australia/Hobart", "Australia/Currie", "Australia/Melbourne", "Australia/Sydney", "Australia/Broken_Hill", "Australia/Brisbane", "Australia/Lindeman", "Australia/Adelaide", "Australia/Darwin", "Australia/Perth", "Australia/Eucla", "America/Aruba", "Europe/Mariehamn", "Asia/Baku", "Europe/Sarajevo", "America/Barbados", "Asia/Dhaka", "Europe/Brussels", "Africa/Ouagadougou", "Europe/Sofia", "Asia/Bahrain", "Africa/Bujumbura", "Africa/Porto-Novo", "America/St_Barthelemy", "Atlantic/Bermuda", "Asia/Brunei", "America/La_Paz", "America/Kralendijk", "America/Noronha", "America/Belem", "America/Fortaleza", "America/Recife", "America/Araguaina", "America/Maceio", "America/Bahia", "America/Sao_Paulo", "America/Campo_Grande", "America/Cuiaba", "America/Santarem", "America/Porto_Velho", "America/Boa_Vista", "America/Manaus", "America/Eirunepe", "America/Rio_Branco", "America/Nassau", "Asia/Thimphu", "Africa/Gaborone", "Europe/Minsk", "America/Belize", "America/St_Johns", "America/Halifax", "America/Glace_Bay", "America/Moncton", "America/Goose_Bay", "America/Blanc-Sablon", "America/Toronto", "America/Nipigon", "America/Thunder_Bay", "America/Iqaluit", "America/Pangnirtung", "America/Resolute", "America/Atikokan", "America/Rankin_Inlet", "America/Winnipeg", "America/Rainy_River", "America/Regina", "America/Swift_Current", "America/Edmonton", "America/Cambridge_Bay", "America/Yellowknife", "America/Inuvik", "America/Creston", "America/Dawson_Creek", "America/Vancouver", "America/Whitehorse", "America/Dawson", "Indian/Cocos", "Africa/Kinshasa", "Africa/Lubumbashi", "Africa/Bangui", "Africa/Brazzaville", "Europe/Zurich", "Africa/Abidjan", "Pacific/Rarotonga", "America/Santiago", "Pacific/Easter", "Africa/Douala", "Asia/Shanghai", "Asia/Harbin", "Asia/Chongqing", "Asia/Urumqi", "Asia/Kashgar", "America/Bogota", "America/Costa_Rica", "America/Havana", "Atlantic/Cape_Verde", "America/Curacao", "Indian/Christmas", "Asia/Nicosia", "Europe/Prague", "Europe/Berlin", "Europe/Busingen", "Africa/Djibouti", "Europe/Copenhagen", "America/Dominica", "America/Santo_Domingo", "Africa/Algiers", "America/Guayaquil", "Pacific/Galapagos", "Europe/Tallinn", "Africa/Cairo", "Africa/El_Aaiun", "Africa/Asmara", "Europe/Madrid", "Africa/Ceuta", "Atlantic/Canary", "Africa/Addis_Ababa", "Europe/Helsinki", "Pacific/Fiji", "Atlantic/Stanley", "Pacific/Chuuk", "Pacific/Pohnpei", "Pacific/Kosrae", "Atlantic/Faroe", "Europe/Paris", "Africa/Libreville", "Europe/London", "America/Grenada", "Asia/Tbilisi", "America/Cayenne", "Europe/Guernsey", "Africa/Accra", "Europe/Gibraltar", "America/Godthab", "America/Danmarkshavn", "America/Scoresbysund", "America/Thule", "Africa/Banjul", "Africa/Conakry", "America/Guadeloupe", "Africa/Malabo", "Europe/Athens", "Atlantic/South_Georgia", "America/Guatemala", "Pacific/Guam", "Africa/Bissau", "America/Guyana", "Asia/Hong_Kong", "America/Tegucigalpa", "Europe/Zagreb", "America/Port-au-Prince", "Europe/Budapest", "Asia/Jakarta", "Asia/Pontianak", "Asia/Makassar", "Asia/Jayapura", "Europe/Dublin", "Asia/Jerusalem", "Europe/Isle_of_Man", "Asia/Kolkata", "Indian/Chagos", "Asia/Baghdad", "Asia/Tehran", "Atlantic/Reykjavik", "Europe/Rome", "Europe/Jersey", "America/Jamaica", "Asia/Amman", "Asia/Tokyo", "Africa/Nairobi", "Asia/Bishkek", "Asia/Phnom_Penh", "Pacific/Tarawa", "Pacific/Enderbury", "Pacific/Kiritimati", "Indian/Comoro", "America/St_Kitts", "Asia/Pyongyang", "Asia/Seoul", "Asia/Kuwait", "America/Cayman", "Asia/Almaty", "Asia/Qyzylorda", "Asia/Aqtobe", "Asia/Aqtau", "Asia/Oral", "Asia/Vientiane", "Asia/Beirut", "America/St_Lucia", "Europe/Vaduz", "Asia/Colombo", "Africa/Monrovia", "Africa/Maseru", "Europe/Vilnius", "Europe/Luxembourg", "Europe/Riga", "Africa/Tripoli", "Africa/Casablanca", "Europe/Monaco", "Europe/Chisinau", "Europe/Podgorica", "America/Marigot", "Indian/Antananarivo", "Pacific/Majuro", "Pacific/Kwajalein", "Europe/Skopje", "Africa/Bamako", "Asia/Rangoon", "Asia/Ulaanbaatar", "Asia/Hovd", "Asia/Choibalsan", "Asia/Macau", "Pacific/Saipan", "America/Martinique", "Africa/Nouakchott", "America/Montserrat", "Europe/Malta", "Indian/Mauritius", "Indian/Maldives", "Africa/Blantyre", "America/Mexico_City", "America/Cancun", "America/Merida", "America/Monterrey", "America/Matamoros", "America/Mazatlan", "America/Chihuahua", "America/Ojinaga", "America/Hermosillo", "America/Tijuana", "America/Santa_Isabel", "America/Bahia_Banderas", "Asia/Kuala_Lumpur", "Asia/Kuching", "Africa/Maputo", "Africa/Windhoek", "Pacific/Noumea", "Africa/Niamey", "Pacific/Norfolk", "Africa/Lagos", "America/Managua", "Europe/Amsterdam", "Europe/Oslo", "Asia/Kathmandu", "Pacific/Nauru", "Pacific/Niue", "Pacific/Auckland", "Pacific/Chatham", "Asia/Muscat", "America/Panama", "America/Lima", "Pacific/Tahiti", "Pacific/Marquesas", "Pacific/Gambier", "Pacific/Port_Moresby", "Asia/Manila", "Asia/Karachi", "Europe/Warsaw", "America/Miquelon", "Pacific/Pitcairn", "America/Puerto_Rico", "Asia/Gaza", "Asia/Hebron", "Europe/Lisbon", "Atlantic/Madeira", "Atlantic/Azores", "Pacific/Palau", "America/Asuncion", "Asia/Qatar", "Indian/Reunion", "Europe/Bucharest", "Europe/Belgrade", "Europe/Kaliningrad", "Europe/Moscow", "Europe/Volgograd", "Europe/Samara", "Asia/Yekaterinburg", "Asia/Omsk", "Asia/Novosibirsk", "Asia/Novokuznetsk", "Asia/Krasnoyarsk", "Asia/Irkutsk", "Asia/Yakutsk", "Asia/Khandyga", "Asia/Vladivostok", "Asia/Sakhalin", "Asia/Ust-Nera", "Asia/Magadan", "Asia/Kamchatka", "Asia/Anadyr", "Africa/Kigali", "Asia/Riyadh", "Pacific/Guadalcanal", "Indian/Mahe", "Africa/Khartoum", "Europe/Stockholm", "Asia/Singapore", "Atlantic/St_Helena", "Europe/Ljubljana", "Arctic/Longyearbyen", "Europe/Bratislava", "Africa/Freetown", "Europe/San_Marino", "Africa/Dakar", "Africa/Mogadishu", "America/Paramaribo", "Africa/Juba", "Africa/Sao_Tome", "America/El_Salvador", "America/Lower_Princes", "Asia/Damascus", "Africa/Mbabane", "America/Grand_Turk", "Africa/Ndjamena", "Indian/Kerguelen", "Africa/Lome", "Asia/Bangkok", "Asia/Dushanbe", "Pacific/Fakaofo", "Asia/Dili", "Asia/Ashgabat", "Africa/Tunis", "Pacific/Tongatapu", "Europe/Istanbul", "America/Port_of_Spain", "Pacific/Funafuti", "Asia/Taipei", "Africa/Dar_es_Salaam", "Europe/Kiev", "Europe/Uzhgorod", "Europe/Zaporozhye", "Europe/Simferopol", "Africa/Kampala", "Pacific/Johnston", "Pacific/Midway", "Pacific/Wake", "America/New_York", "America/Detroit", "America/Kentucky/Louisville", "America/Kentucky/Monticello", "America/Indiana/Indianapolis", "America/Indiana/Vincennes", "America/Indiana/Winamac", "America/Indiana/Marengo", "America/Indiana/Petersburg", "America/Indiana/Vevay", "America/Chicago", "America/Indiana/Tell_City", "America/Indiana/Knox", "America/Menominee", "America/North_Dakota/Center", "America/North_Dakota/New_Salem", "America/North_Dakota/Beulah", "America/Denver", "America/Boise", "America/Phoenix", "America/Los_Angeles", "America/Anchorage", "America/Juneau", "America/Sitka", "America/Yakutat", "America/Nome", "America/Adak", "America/Metlakatla", "Pacific/Honolulu", "America/Montevideo", "Asia/Samarkand", "Asia/Tashkent", "Europe/Vatican", "America/St_Vincent", "America/Caracas", "America/Tortola", "America/St_Thomas", "Asia/Ho_Chi_Minh", "Pacific/Efate", "Pacific/Wallis", "Pacific/Apia", "Asia/Aden", "Indian/Mayotte", "Africa/Johannesburg", "Africa/Lusaka", "Africa/Harare", "UTC" ], "default": "UTC" } }, "description": "Configure clock", "$$ref": "#/components/schemas/Clock" }, "description": { "pattern": "^[^<>]{1,32}$", "type": "string", "description": "Set a text description of the device", "example": "System settings" }, "deviceGroups": { "type": "array", "description": "Configure device groups", "items": { "type": "string", "description": "Configure device groups" } }, "gpsLocation": { "required": [ "latitude", "longitude" ], "type": "object", "properties": { "latitude": { "maximum": 90, "minimum": -90, "type": "number", "description": "Set the device\u2019s physical latitude", "example": 60 }, "longitude": { "maximum": 180, "minimum": -180, "type": "number", "description": "Set the device\u2019s physical longitude", "example": 60 } }, "description": "GPS latitude and longitude of the device", "$$ref": "#/components/schemas/GpsLocation" }, "hostName": { "pattern": "^[a-zA-Z0-9\\-_]{1,32}$", "type": "string", "description": "Set the hostname", "example": "vm12" }, "ipv6StrictControl": { "type": "boolean", "description": "Enable Dual Stack IPv6 Default", "example": false, "default": false }, "location": { "pattern": "^[^<>]{1,127}$", "type": "string", "description": "Set the location of the device", "example": "USA" }, "siteId": { "maximum": 4294967295, "minimum": 0, "type": "integer", "description": "Set the site ID", "format": "int64", "example": 100 }, "systemIp": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "Set the system IP address", "example": "102.2.3.2" } }, "description": "System configuration for manager", "$$ref": "#/components/schemas/ManagerSystemSetting" }, "vpn": { "required": [ "transport" ], "type": "object", "properties": { "management": { "required": [ "interface" ], "type": "object", "properties": { "dns": { "type": "object", "properties": { "dnsServerPrimary": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "Primary DNS server IPv4 or IPv6 Address", "example": "10.2.2.2" }, "dnsServerSecondary": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "Secondary DNS server IPv4 or IPv6 Address", "example": "10.2.2.3" }, "host": { "type": "array", "items": { "required": [ "hostname", "ip" ], "type": "object", "properties": { "hostname": { "pattern": "^[a-zA-Z0-9\\-_.]{1,64}$", "type": "string", "description": "Host name", "example": "vbond" }, "ip": { "maxItems": 64, "minItems": 1, "uniqueItems": true, "type": "array", "items": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "IP Address", "example": "10.1.1.1" } } }, "description": "Static host mapping", "$$ref": "#/components/schemas/DnsHostMapping" } } }, "description": "Configure DNS servers or static host mapping", "$$ref": "#/components/schemas/ControlComponentDnsSetting" }, "interface": { "maxItems": 2147483647, "minItems": 1, "type": "array", "items": { "required": [ "ifName" ], "type": "object", "properties": { "ifName": { "pattern": "^(?=.{1,32}$)(?:(ge0\\/\\d+(?:\\.\\d+)?|loopback\\d+|eth\\d+(?:\\.\\d+)?))$", "type": "string", "description": "Interface name eth<0-..> or eth<0-..>.vlanid or loopback when present", "example": "eth0" }, "ip": { "type": "object", "properties": { "address": { "pattern": "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\\/)([0-2]?[0-9]$|[3]?[0-2])$", "type": "string", "description": "Assign IPv4 address", "example": "10.0.1.1/24" }, "dhcpClient": { "type": "boolean", "description": "Enable DHCP", "example": false, "default": false }, "dhcpDistance": { "maximum": 65536, "minimum": 1, "type": "integer", "description": "Set administrative distance for DHCP default route", "format": "int32", "example": 1, "default": 1 } }, "description": "IPv4 address or DHCP", "$$ref": "#/components/schemas/IpConfig" }, "ipv6": { "type": "object", "properties": { "address": { "pattern": "((^\\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))(%.+)?\\s*(\\/)(\\b([0-9]{1,2}|1[01][0-9]|12[0-8])\\b)$))", "type": "string", "description": "Assign IPv6 address", "example": "2001:a0:64::20/64" }, "dhcpClient": { "type": "boolean", "description": "Enable DHCP", "example": false, "default": false }, "dhcpDistance": { "maximum": 65536, "minimum": 1, "type": "integer", "description": "Set administrative distance for DHCP default route", "format": "int32", "example": 1, "default": 1 }, "dhcpRapidCommit": { "type": "boolean", "description": "Enable DHCPv6 rapid commit", "example": false, "default": false } }, "description": "IPv6 address or DHCP", "$$ref": "#/components/schemas/Ipv6Config" }, "shutdown": { "type": "boolean", "description": "Administrative state", "example": false, "default": false } }, "description": "Interfaces configuration", "$$ref": "#/components/schemas/BaseInterfaceSetting" } }, "ipRoute": { "type": "object", "properties": { "route": { "type": "array", "items": { "required": [ "nextHop", "prefix" ], "type": "object", "properties": { "nextHop": { "maxItems": 2147483647, "minItems": 1, "type": "array", "items": { "required": [ "address" ], "type": "object", "properties": { "address": { "pattern": "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "description": "IPv4 Address", "example": "10.0.0.1" }, "distance": { "maximum": 255, "minimum": 1, "type": "integer", "description": "Administrative distance", "format": "int32", "example": 1, "default": 1 } }, "description": "IP gateway address", "$$ref": "#/components/schemas/NextHop" } }, "prefix": { "pattern": "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\\/)([0-2]?[0-9]$|[3]?[0-2])$", "type": "string", "description": "IPv4 Prefix", "example": "0.0.0.0/0" } }, "description": "Configure static routes", "$$ref": "#/components/schemas/StaticRoute" } } }, "description": "IP Route information", "$$ref": "#/components/schemas/IpRoute" }, "ipv6Route": { "type": "object", "properties": { "route": { "type": "array", "items": { "required": [ "nextHop", "prefix" ], "type": "object", "properties": { "nextHop": { "maxItems": 2147483647, "minItems": 1, "type": "array", "items": { "required": [ "address" ], "type": "object", "properties": { "address": { "pattern": "(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))", "type": "string", "description": "IPv6 Address", "example": "2001::1" }, "distance": { "maximum": 255, "minimum": 1, "type": "integer", "description": "Administrative distance", "format": "int32", "example": 1, "default": 1 } }, "description": "IP gateway address", "$$ref": "#/components/schemas/IPV6NextHop" } }, "prefix": { "pattern": "((^\\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))(%.+)?\\s*(\\/)(\\b([0-9]{1,2}|1[01][0-9]|12[0-8])\\b)$))", "type": "string", "description": "IPv6 Prefix", "example": "2001::/4" } }, "description": "Configure IPv6 static routes", "$$ref": "#/components/schemas/Ipv6StaticRoute" } } }, "description": "IPv6 Route information", "$$ref": "#/components/schemas/Ipv6Route" } }, "description": "Management VPN instance", "$$ref": "#/components/schemas/baseVpnInstanceBaseInterfaceSetting" }, "transport": { "required": [ "interface" ], "type": "object", "properties": { "dns": { "type": "object", "properties": { "dnsServerPrimary": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "Primary DNS server IPv4 or IPv6 Address", "example": "10.2.2.2" }, "dnsServerSecondary": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "Secondary DNS server IPv4 or IPv6 Address", "example": "10.2.2.3" }, "host": { "type": "array", "items": { "required": [ "hostname", "ip" ], "type": "object", "properties": { "hostname": { "pattern": "^[a-zA-Z0-9\\-_.]{1,64}$", "type": "string", "description": "Host name", "example": "vbond" }, "ip": { "maxItems": 64, "minItems": 1, "uniqueItems": true, "type": "array", "items": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "IP Address", "example": "10.1.1.1" } } }, "description": "Static host mapping", "$$ref": "#/components/schemas/DnsHostMapping" } } }, "description": "Configure DNS servers or static host mapping", "$$ref": "#/components/schemas/ControlComponentDnsSetting" }, "interface": { "maxItems": 2147483647, "minItems": 1, "type": "array", "items": { "required": [ "ifName" ], "type": "object", "properties": { "ifName": { "pattern": "^(?=.{1,32}$)(?:(ge0\\/\\d+(?:\\.\\d+)?|loopback\\d+|eth\\d+(?:\\.\\d+)?))$", "type": "string", "description": "Interface name eth<0-..> or eth<0-..>.vlanid or loopback when present", "example": "eth0" }, "ip": { "type": "object", "properties": { "address": { "pattern": "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\\/)([0-2]?[0-9]$|[3]?[0-2])$", "type": "string", "description": "Assign IPv4 address", "example": "10.0.1.1/24" }, "dhcpClient": { "type": "boolean", "description": "Enable DHCP", "example": false, "default": false }, "dhcpDistance": { "maximum": 65536, "minimum": 1, "type": "integer", "description": "Set administrative distance for DHCP default route", "format": "int32", "example": 1, "default": 1 } }, "description": "IPv4 address or DHCP", "$$ref": "#/components/schemas/IpConfig" }, "ipv6": { "type": "object", "properties": { "address": { "pattern": "((^\\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))(%.+)?\\s*(\\/)(\\b([0-9]{1,2}|1[01][0-9]|12[0-8])\\b)$))", "type": "string", "description": "Assign IPv6 address", "example": "2001:a0:64::20/64" }, "dhcpClient": { "type": "boolean", "description": "Enable DHCP", "example": false, "default": false }, "dhcpDistance": { "maximum": 65536, "minimum": 1, "type": "integer", "description": "Set administrative distance for DHCP default route", "format": "int32", "example": 1, "default": 1 }, "dhcpRapidCommit": { "type": "boolean", "description": "Enable DHCPv6 rapid commit", "example": false, "default": false } }, "description": "IPv6 address or DHCP", "$$ref": "#/components/schemas/Ipv6Config" }, "shutdown": { "type": "boolean", "description": "Administrative state", "example": false, "default": false }, "tunnelInterface": { "type": "object", "properties": { "allowService": { "type": "object", "properties": { "all": { "type": "boolean", "description": "Allow all traffic. Overrides all other allow-service options if allow-service all is set", "example": false, "default": false }, "dhcp": { "type": "boolean", "description": "Allow/Deny DHCP", "example": true, "default": true }, "dns": { "type": "boolean", "description": "Allow/Deny DNS", "example": true, "default": true }, "icmp": { "type": "boolean", "description": "Allow/Deny ICMP", "example": true, "default": true }, "netconf": { "type": "boolean", "description": "Allow/Deny NETCONF", "example": false, "default": false }, "ntp": { "type": "boolean", "description": "Allow/Deny NTP", "example": false, "default": false }, "sshd": { "type": "boolean", "description": "Allow/Deny SSH", "example": false, "default": false }, "stun": { "type": "boolean", "description": "Allow/Deny STUN", "example": false, "default": false } }, "description": "Set services allowed on the WAN interface", "$$ref": "#/components/schemas/AllowService" }, "color": { "type": "object", "properties": { "value": { "type": "string", "description": "Set color for TLOC", "example": "default", "enum": [ "default", "mpls", "metro-ethernet", "biz-internet", "public-internet", "lte", "3g", "red", "green", "blue", "gold", "silver", "bronze", "custom1", "custom2", "custom3", "private1", "private2", "private3", "private4", "private5", "private6" ], "default": "default" } }, "description": "Set color for TLOC", "$$ref": "#/components/schemas/Color" } }, "description": "Tunnel interface configuration", "$$ref": "#/components/schemas/TunnelInterface" } }, "description": "Interfaces configuration", "$$ref": "#/components/schemas/TransportInterfaceSetting" } }, "ipRoute": { "type": "object", "properties": { "route": { "type": "array", "items": { "required": [ "nextHop", "prefix" ], "type": "object", "properties": { "nextHop": { "maxItems": 2147483647, "minItems": 1, "type": "array", "items": { "required": [ "address" ], "type": "object", "properties": { "address": { "pattern": "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "description": "IPv4 Address", "example": "10.0.0.1" }, "distance": { "maximum": 255, "minimum": 1, "type": "integer", "description": "Administrative distance", "format": "int32", "example": 1, "default": 1 } }, "description": "IP gateway address", "$$ref": "#/components/schemas/NextHop" } }, "prefix": { "pattern": "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\\/)([0-2]?[0-9]$|[3]?[0-2])$", "type": "string", "description": "IPv4 Prefix", "example": "0.0.0.0/0" } }, "description": "Configure static routes", "$$ref": "#/components/schemas/StaticRoute" } } }, "description": "IP Route information", "$$ref": "#/components/schemas/IpRoute" }, "ipv6Route": { "type": "object", "properties": { "route": { "type": "array", "items": { "required": [ "nextHop", "prefix" ], "type": "object", "properties": { "nextHop": { "maxItems": 2147483647, "minItems": 1, "type": "array", "items": { "required": [ "address" ], "type": "object", "properties": { "address": { "pattern": "(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))", "type": "string", "description": "IPv6 Address", "example": "2001::1" }, "distance": { "maximum": 255, "minimum": 1, "type": "integer", "description": "Administrative distance", "format": "int32", "example": 1, "default": 1 } }, "description": "IP gateway address", "$$ref": "#/components/schemas/IPV6NextHop" } }, "prefix": { "pattern": "((^\\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))(%.+)?\\s*(\\/)(\\b([0-9]{1,2}|1[01][0-9]|12[0-8])\\b)$))", "type": "string", "description": "IPv6 Prefix", "example": "2001::/4" } }, "description": "Configure IPv6 static routes", "$$ref": "#/components/schemas/Ipv6StaticRoute" } } }, "description": "IPv6 Route information", "$$ref": "#/components/schemas/Ipv6Route" } }, "description": "Transport VPN instance", "$$ref": "#/components/schemas/baseVpnInstanceTransportInterfaceSetting" } }, "description": "Manager VPN setting", "$$ref": "#/components/schemas/ManagerVpnSetting" } }, "description": "The payload for manager device specific settings", "$$ref": "#/components/schemas/ManagerDeviceSpecificSetting" } ] }, "examples": { "CreateControllerDeviceSpecificSettingsExample": { "description": "CreateControllerDeviceSpecificSettingsExample", "value": { "system": { "systemIp": "172.16.255.20", "hostName": "Controller01", "description": "Controller 1", "siteId": 200, "location": "Shang hai", "systemTunnelMtu": 2000, "gpsLocation": { "latitude": 90, "longitude": 180 }, "clock": { "timezone": "Europe/Andorra" }, "deviceGroups": [ "group1" ], "overlayId": 3, "ipv6StrictControl": true, "controllerGroupId": 1 }, "vpn": { "transport": { "ipRoute": { "route": [ { "prefix": "0.0.0.0/0", "nextHop": [ { "address": "10.0.12.13", "distance": 1 } ] } ] }, "ipv6Route": { "route": [ { "prefix": "::/0", "nextHop": [ { "address": "2001:a0:c::d" } ] } ] }, "interface": [ { "ifName": "eth0", "ip": { "address": "10.0.1.30/24" }, "ipv6": { "address": "2001:a0:1::1e/64" }, "shutdown": false }, { "ifName": "eth1", "ip": { "address": "10.0.12.20/24" }, "ipv6": { "address": "2001:a0:c::14/64" }, "tunnelInterface": { "allowService": { "all": true, "dhcp": true, "dns": true, "icmp": true, "sshd": false, "netconf": false, "ntp": false, "stun": false } }, "shutdown": false } ] }, "management": { "interface": [ { "ifName": "eth2", "ip": { "address": "10.2.2.20/24" }, "ipv6": { "address": "2001:a2:2::14/64" }, "shutdown": false } ] } } }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigControlcomponentSettingRequestExampleCreatecontrollerdevicespecificsettings" }, "CreateValidatorDeviceSpecificSettingsExample": { "description": "CreateValidatorDeviceSpecificSettingsExample", "value": { "system": { "systemIp": "172.16.255.19", "hostName": "Validator01", "description": "Validator 1", "siteId": 100, "location": "Shang hai", "gpsLocation": { "latitude": 90, "longitude": 180 }, "clock": { "timezone": "Europe/Andorra" }, "deviceGroups": [ "group1" ], "vbond": { "address": "10.0.1.26" } }, "vpn": { "transport": { "ipRoute": { "route": [ { "prefix": "0.0.0.0/0", "nextHop": [ { "address": "10.0.5.13", "distance": 1 } ] } ] }, "ipv6Route": { "route": [ { "prefix": "::/0", "nextHop": [ { "address": "2001:a0:5::d" } ] } ] }, "interface": [ { "ifName": "eth0", "ip": { "address": "10.0.1.19/24" }, "ipv6": { "address": "2001:a0:1::13/64" }, "shutdown": false }, { "ifName": "eth1", "ip": { "address": "10.0.5.19/24" }, "ipv6": { "address": "2001:a0:5::13/64" }, "shutdown": false }, { "ifName": "eth3", "ip": { "address": "10.1.15.19/24" }, "ipv6": { "address": "2001:a1:f::13/64" }, "shutdown": false } ] }, "management": { "interface": [ { "ifName": "eth2", "ip": { "address": "10.2.2.19/24" }, "ipv6": { "address": "2001:a2:2::13/64" }, "shutdown": false } ] } } }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigControlcomponentSettingRequestExampleCreatevalidatordevicespecificsettings" }, "CreateManagerDeviceSpecificSettingsExample": { "description": "CreateManagerDeviceSpecificSettingsExample", "value": { "system": { "systemIp": "172.16.255.22", "hostName": "Manager01", "clock": { "timezone": "UTC" }, "siteId": 200, "ipv6StrictControl": false }, "vpn": { "transport": { "ipRoute": { "route": [ { "prefix": "0.0.0.0/0", "nextHop": [ { "address": "10.0.12.13", "distance": 1 } ] } ] }, "interface": [ { "ifName": "eth0", "ip": { "dhcpClient": true, "dhcpDistance": 1 }, "ipv6": { "dhcpClient": true, "dhcpDistance": 1, "dhcpRapidCommit": false }, "shutdown": false }, { "ifName": "eth1", "ip": { "address": "10.0.12.22/24" }, "shutdown": false, "tunnelInterface": { "color": { "value": "default" }, "allowService": { "all": false, "dhcp": true, "dns": true, "icmp": true, "sshd": false, "netconf": false, "ntp": false, "stun": false } } }, { "ifName": "eth2", "ip": { "address": "10.0.5.22/24" }, "shutdown": false }, { "ifName": "eth5", "ip": { "address": "10.0.105.32/24" }, "shutdown": false } ] }, "management": { "interface": [ { "ifName": "eth3", "ip": { "address": "10.2.4.22/24" }, "shutdown": false } ] } } }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigControlcomponentSettingRequestExampleCreatemanagerdevicespecificsettings" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "oneOf": [ { "required": [ "system", "vpn" ], "type": "object", "properties": { "system": { "required": [ "hostName", "siteId", "systemIp" ], "type": "object", "properties": { "clock": { "required": [ "timezone" ], "type": "object", "properties": { "timezone": { "type": "string", "description": "Set the timezone", "example": "UTC", "enum": [ "Europe/Andorra", "Asia/Dubai", "Asia/Kabul", "America/Antigua", "America/Anguilla", "Europe/Tirane", "Asia/Yerevan", "Africa/Luanda", "Antarctica/McMurdo", "Antarctica/Rothera", "Antarctica/Palmer", "Antarctica/Mawson", "Antarctica/Davis", "Antarctica/Casey", "Antarctica/Vostok", "Antarctica/DumontDUrville", "Antarctica/Syowa", "America/Argentina/Buenos_Aires", "America/Argentina/Cordoba", "America/Argentina/Salta", "America/Argentina/Jujuy", "America/Argentina/Tucuman", "America/Argentina/Catamarca", "America/Argentina/La_Rioja", "America/Argentina/San_Juan", "America/Argentina/Mendoza", "America/Argentina/San_Luis", "America/Argentina/Rio_Gallegos", "America/Argentina/Ushuaia", "Pacific/Pago_Pago", "Europe/Vienna", "Australia/Lord_Howe", "Antarctica/Macquarie", "Australia/Hobart", "Australia/Currie", "Australia/Melbourne", "Australia/Sydney", "Australia/Broken_Hill", "Australia/Brisbane", "Australia/Lindeman", "Australia/Adelaide", "Australia/Darwin", "Australia/Perth", "Australia/Eucla", "America/Aruba", "Europe/Mariehamn", "Asia/Baku", "Europe/Sarajevo", "America/Barbados", "Asia/Dhaka", "Europe/Brussels", "Africa/Ouagadougou", "Europe/Sofia", "Asia/Bahrain", "Africa/Bujumbura", "Africa/Porto-Novo", "America/St_Barthelemy", "Atlantic/Bermuda", "Asia/Brunei", "America/La_Paz", "America/Kralendijk", "America/Noronha", "America/Belem", "America/Fortaleza", "America/Recife", "America/Araguaina", "America/Maceio", "America/Bahia", "America/Sao_Paulo", "America/Campo_Grande", "America/Cuiaba", "America/Santarem", "America/Porto_Velho", "America/Boa_Vista", "America/Manaus", "America/Eirunepe", "America/Rio_Branco", "America/Nassau", "Asia/Thimphu", "Africa/Gaborone", "Europe/Minsk", "America/Belize", "America/St_Johns", "America/Halifax", "America/Glace_Bay", "America/Moncton", "America/Goose_Bay", "America/Blanc-Sablon", "America/Toronto", "America/Nipigon", "America/Thunder_Bay", "America/Iqaluit", "America/Pangnirtung", "America/Resolute", "America/Atikokan", "America/Rankin_Inlet", "America/Winnipeg", "America/Rainy_River", "America/Regina", "America/Swift_Current", "America/Edmonton", "America/Cambridge_Bay", "America/Yellowknife", "America/Inuvik", "America/Creston", "America/Dawson_Creek", "America/Vancouver", "America/Whitehorse", "America/Dawson", "Indian/Cocos", "Africa/Kinshasa", "Africa/Lubumbashi", "Africa/Bangui", "Africa/Brazzaville", "Europe/Zurich", "Africa/Abidjan", "Pacific/Rarotonga", "America/Santiago", "Pacific/Easter", "Africa/Douala", "Asia/Shanghai", "Asia/Harbin", "Asia/Chongqing", "Asia/Urumqi", "Asia/Kashgar", "America/Bogota", "America/Costa_Rica", "America/Havana", "Atlantic/Cape_Verde", "America/Curacao", "Indian/Christmas", "Asia/Nicosia", "Europe/Prague", "Europe/Berlin", "Europe/Busingen", "Africa/Djibouti", "Europe/Copenhagen", "America/Dominica", "America/Santo_Domingo", "Africa/Algiers", "America/Guayaquil", "Pacific/Galapagos", "Europe/Tallinn", "Africa/Cairo", "Africa/El_Aaiun", "Africa/Asmara", "Europe/Madrid", "Africa/Ceuta", "Atlantic/Canary", "Africa/Addis_Ababa", "Europe/Helsinki", "Pacific/Fiji", "Atlantic/Stanley", "Pacific/Chuuk", "Pacific/Pohnpei", "Pacific/Kosrae", "Atlantic/Faroe", "Europe/Paris", "Africa/Libreville", "Europe/London", "America/Grenada", "Asia/Tbilisi", "America/Cayenne", "Europe/Guernsey", "Africa/Accra", "Europe/Gibraltar", "America/Godthab", "America/Danmarkshavn", "America/Scoresbysund", "America/Thule", "Africa/Banjul", "Africa/Conakry", "America/Guadeloupe", "Africa/Malabo", "Europe/Athens", "Atlantic/South_Georgia", "America/Guatemala", "Pacific/Guam", "Africa/Bissau", "America/Guyana", "Asia/Hong_Kong", "America/Tegucigalpa", "Europe/Zagreb", "America/Port-au-Prince", "Europe/Budapest", "Asia/Jakarta", "Asia/Pontianak", "Asia/Makassar", "Asia/Jayapura", "Europe/Dublin", "Asia/Jerusalem", "Europe/Isle_of_Man", "Asia/Kolkata", "Indian/Chagos", "Asia/Baghdad", "Asia/Tehran", "Atlantic/Reykjavik", "Europe/Rome", "Europe/Jersey", "America/Jamaica", "Asia/Amman", "Asia/Tokyo", "Africa/Nairobi", "Asia/Bishkek", "Asia/Phnom_Penh", "Pacific/Tarawa", "Pacific/Enderbury", "Pacific/Kiritimati", "Indian/Comoro", "America/St_Kitts", "Asia/Pyongyang", "Asia/Seoul", "Asia/Kuwait", "America/Cayman", "Asia/Almaty", "Asia/Qyzylorda", "Asia/Aqtobe", "Asia/Aqtau", "Asia/Oral", "Asia/Vientiane", "Asia/Beirut", "America/St_Lucia", "Europe/Vaduz", "Asia/Colombo", "Africa/Monrovia", "Africa/Maseru", "Europe/Vilnius", "Europe/Luxembourg", "Europe/Riga", "Africa/Tripoli", "Africa/Casablanca", "Europe/Monaco", "Europe/Chisinau", "Europe/Podgorica", "America/Marigot", "Indian/Antananarivo", "Pacific/Majuro", "Pacific/Kwajalein", "Europe/Skopje", "Africa/Bamako", "Asia/Rangoon", "Asia/Ulaanbaatar", "Asia/Hovd", "Asia/Choibalsan", "Asia/Macau", "Pacific/Saipan", "America/Martinique", "Africa/Nouakchott", "America/Montserrat", "Europe/Malta", "Indian/Mauritius", "Indian/Maldives", "Africa/Blantyre", "America/Mexico_City", "America/Cancun", "America/Merida", "America/Monterrey", "America/Matamoros", "America/Mazatlan", "America/Chihuahua", "America/Ojinaga", "America/Hermosillo", "America/Tijuana", "America/Santa_Isabel", "America/Bahia_Banderas", "Asia/Kuala_Lumpur", "Asia/Kuching", "Africa/Maputo", "Africa/Windhoek", "Pacific/Noumea", "Africa/Niamey", "Pacific/Norfolk", "Africa/Lagos", "America/Managua", "Europe/Amsterdam", "Europe/Oslo", "Asia/Kathmandu", "Pacific/Nauru", "Pacific/Niue", "Pacific/Auckland", "Pacific/Chatham", "Asia/Muscat", "America/Panama", "America/Lima", "Pacific/Tahiti", "Pacific/Marquesas", "Pacific/Gambier", "Pacific/Port_Moresby", "Asia/Manila", "Asia/Karachi", "Europe/Warsaw", "America/Miquelon", "Pacific/Pitcairn", "America/Puerto_Rico", "Asia/Gaza", "Asia/Hebron", "Europe/Lisbon", "Atlantic/Madeira", "Atlantic/Azores", "Pacific/Palau", "America/Asuncion", "Asia/Qatar", "Indian/Reunion", "Europe/Bucharest", "Europe/Belgrade", "Europe/Kaliningrad", "Europe/Moscow", "Europe/Volgograd", "Europe/Samara", "Asia/Yekaterinburg", "Asia/Omsk", "Asia/Novosibirsk", "Asia/Novokuznetsk", "Asia/Krasnoyarsk", "Asia/Irkutsk", "Asia/Yakutsk", "Asia/Khandyga", "Asia/Vladivostok", "Asia/Sakhalin", "Asia/Ust-Nera", "Asia/Magadan", "Asia/Kamchatka", "Asia/Anadyr", "Africa/Kigali", "Asia/Riyadh", "Pacific/Guadalcanal", "Indian/Mahe", "Africa/Khartoum", "Europe/Stockholm", "Asia/Singapore", "Atlantic/St_Helena", "Europe/Ljubljana", "Arctic/Longyearbyen", "Europe/Bratislava", "Africa/Freetown", "Europe/San_Marino", "Africa/Dakar", "Africa/Mogadishu", "America/Paramaribo", "Africa/Juba", "Africa/Sao_Tome", "America/El_Salvador", "America/Lower_Princes", "Asia/Damascus", "Africa/Mbabane", "America/Grand_Turk", "Africa/Ndjamena", "Indian/Kerguelen", "Africa/Lome", "Asia/Bangkok", "Asia/Dushanbe", "Pacific/Fakaofo", "Asia/Dili", "Asia/Ashgabat", "Africa/Tunis", "Pacific/Tongatapu", "Europe/Istanbul", "America/Port_of_Spain", "Pacific/Funafuti", "Asia/Taipei", "Africa/Dar_es_Salaam", "Europe/Kiev", "Europe/Uzhgorod", "Europe/Zaporozhye", "Europe/Simferopol", "Africa/Kampala", "Pacific/Johnston", "Pacific/Midway", "Pacific/Wake", "America/New_York", "America/Detroit", "America/Kentucky/Louisville", "America/Kentucky/Monticello", "America/Indiana/Indianapolis", "America/Indiana/Vincennes", "America/Indiana/Winamac", "America/Indiana/Marengo", "America/Indiana/Petersburg", "America/Indiana/Vevay", "America/Chicago", "America/Indiana/Tell_City", "America/Indiana/Knox", "America/Menominee", "America/North_Dakota/Center", "America/North_Dakota/New_Salem", "America/North_Dakota/Beulah", "America/Denver", "America/Boise", "America/Phoenix", "America/Los_Angeles", "America/Anchorage", "America/Juneau", "America/Sitka", "America/Yakutat", "America/Nome", "America/Adak", "America/Metlakatla", "Pacific/Honolulu", "America/Montevideo", "Asia/Samarkand", "Asia/Tashkent", "Europe/Vatican", "America/St_Vincent", "America/Caracas", "America/Tortola", "America/St_Thomas", "Asia/Ho_Chi_Minh", "Pacific/Efate", "Pacific/Wallis", "Pacific/Apia", "Asia/Aden", "Indian/Mayotte", "Africa/Johannesburg", "Africa/Lusaka", "Africa/Harare", "UTC" ], "default": "UTC" } }, "description": "Configure clock", "$$ref": "#/components/schemas/Clock" }, "description": { "pattern": "^[^<>]{1,32}$", "type": "string", "description": "Set a text description of the device", "example": "System settings" }, "deviceGroups": { "type": "array", "description": "Configure device groups", "items": { "type": "string", "description": "Configure device groups" } }, "gpsLocation": { "required": [ "latitude", "longitude" ], "type": "object", "properties": { "latitude": { "maximum": 90, "minimum": -90, "type": "number", "description": "Set the device\u2019s physical latitude", "example": 60 }, "longitude": { "maximum": 180, "minimum": -180, "type": "number", "description": "Set the device\u2019s physical longitude", "example": 60 } }, "description": "GPS latitude and longitude of the device", "$$ref": "#/components/schemas/GpsLocation" }, "hostName": { "pattern": "^[a-zA-Z0-9\\-_]{1,32}$", "type": "string", "description": "Set the hostname", "example": "vm12" }, "location": { "pattern": "^[^<>]{1,127}$", "type": "string", "description": "Set the location of the device", "example": "USA" }, "siteId": { "maximum": 4294967295, "minimum": 0, "type": "integer", "description": "Set the site ID", "format": "int64", "example": 100 }, "systemIp": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "Set the system IP address", "example": "102.2.3.2" }, "vbond": { "required": [ "address" ], "type": "object", "properties": { "address": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "Set the vBond IP address", "example": "10.0.12.22" } }, "$$ref": "#/components/schemas/Vbond" } }, "description": "System configuration for validator", "$$ref": "#/components/schemas/ValidatorSystemSetting" }, "vpn": { "required": [ "transport" ], "type": "object", "properties": { "management": { "required": [ "interface" ], "type": "object", "properties": { "dns": { "type": "object", "properties": { "dnsServerPrimary": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "Primary DNS server IPv4 or IPv6 Address", "example": "10.2.2.2" }, "dnsServerSecondary": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "Secondary DNS server IPv4 or IPv6 Address", "example": "10.2.2.3" }, "host": { "type": "array", "items": { "required": [ "hostname", "ip" ], "type": "object", "properties": { "hostname": { "pattern": "^[a-zA-Z0-9\\-_.]{1,64}$", "type": "string", "description": "Host name", "example": "vbond" }, "ip": { "maxItems": 64, "minItems": 1, "uniqueItems": true, "type": "array", "items": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "IP Address", "example": "10.1.1.1" } } }, "description": "Static host mapping", "$$ref": "#/components/schemas/DnsHostMapping" } } }, "description": "Configure DNS servers or static host mapping", "$$ref": "#/components/schemas/ControlComponentDnsSetting" }, "interface": { "maxItems": 2147483647, "minItems": 1, "type": "array", "items": { "required": [ "ifName" ], "type": "object", "properties": { "ifName": { "pattern": "^(?=.{1,32}$)(?:(ge0\\/\\d+(?:\\.\\d+)?|loopback\\d+|eth\\d+(?:\\.\\d+)?))$", "type": "string", "description": "Interface name eth<0-..> or eth<0-..>.vlanid or loopback when present", "example": "eth0" }, "ip": { "type": "object", "properties": { "address": { "pattern": "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\\/)([0-2]?[0-9]$|[3]?[0-2])$", "type": "string", "description": "Assign IPv4 address", "example": "10.0.1.1/24" }, "dhcpClient": { "type": "boolean", "description": "Enable DHCP", "example": false, "default": false }, "dhcpDistance": { "maximum": 65536, "minimum": 1, "type": "integer", "description": "Set administrative distance for DHCP default route", "format": "int32", "example": 1, "default": 1 } }, "description": "IPv4 address or DHCP", "$$ref": "#/components/schemas/IpConfig" }, "ipv6": { "type": "object", "properties": { "address": { "pattern": "((^\\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))(%.+)?\\s*(\\/)(\\b([0-9]{1,2}|1[01][0-9]|12[0-8])\\b)$))", "type": "string", "description": "Assign IPv6 address", "example": "2001:a0:64::20/64" }, "dhcpClient": { "type": "boolean", "description": "Enable DHCP", "example": false, "default": false }, "dhcpDistance": { "maximum": 65536, "minimum": 1, "type": "integer", "description": "Set administrative distance for DHCP default route", "format": "int32", "example": 1, "default": 1 }, "dhcpRapidCommit": { "type": "boolean", "description": "Enable DHCPv6 rapid commit", "example": false, "default": false } }, "description": "IPv6 address or DHCP", "$$ref": "#/components/schemas/Ipv6Config" }, "shutdown": { "type": "boolean", "description": "Administrative state", "example": false, "default": false } }, "description": "Interfaces configuration", "$$ref": "#/components/schemas/BaseInterfaceSetting" } }, "ipRoute": { "type": "object", "properties": { "route": { "type": "array", "items": { "required": [ "nextHop", "prefix" ], "type": "object", "properties": { "nextHop": { "maxItems": 2147483647, "minItems": 1, "type": "array", "items": { "required": [ "address" ], "type": "object", "properties": { "address": { "pattern": "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "description": "IPv4 Address", "example": "10.0.0.1" }, "distance": { "maximum": 255, "minimum": 1, "type": "integer", "description": "Administrative distance", "format": "int32", "example": 1, "default": 1 } }, "description": "IP gateway address", "$$ref": "#/components/schemas/NextHop" } }, "prefix": { "pattern": "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\\/)([0-2]?[0-9]$|[3]?[0-2])$", "type": "string", "description": "IPv4 Prefix", "example": "0.0.0.0/0" } }, "description": "Configure static routes", "$$ref": "#/components/schemas/StaticRoute" } } }, "description": "IP Route information", "$$ref": "#/components/schemas/IpRoute" }, "ipv6Route": { "type": "object", "properties": { "route": { "type": "array", "items": { "required": [ "nextHop", "prefix" ], "type": "object", "properties": { "nextHop": { "maxItems": 2147483647, "minItems": 1, "type": "array", "items": { "required": [ "address" ], "type": "object", "properties": { "address": { "pattern": "(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))", "type": "string", "description": "IPv6 Address", "example": "2001::1" }, "distance": { "maximum": 255, "minimum": 1, "type": "integer", "description": "Administrative distance", "format": "int32", "example": 1, "default": 1 } }, "description": "IP gateway address", "$$ref": "#/components/schemas/IPV6NextHop" } }, "prefix": { "pattern": "((^\\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))(%.+)?\\s*(\\/)(\\b([0-9]{1,2}|1[01][0-9]|12[0-8])\\b)$))", "type": "string", "description": "IPv6 Prefix", "example": "2001::/4" } }, "description": "Configure IPv6 static routes", "$$ref": "#/components/schemas/Ipv6StaticRoute" } } }, "description": "IPv6 Route information", "$$ref": "#/components/schemas/Ipv6Route" } }, "description": "Management VPN instance", "$$ref": "#/components/schemas/baseVpnInstanceBaseInterfaceSetting" }, "transport": { "required": [ "interface" ], "type": "object", "properties": { "dns": { "type": "object", "properties": { "dnsServerPrimary": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "Primary DNS server IPv4 or IPv6 Address", "example": "10.2.2.2" }, "dnsServerSecondary": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "Secondary DNS server IPv4 or IPv6 Address", "example": "10.2.2.3" }, "host": { "type": "array", "items": { "required": [ "hostname", "ip" ], "type": "object", "properties": { "hostname": { "pattern": "^[a-zA-Z0-9\\-_.]{1,64}$", "type": "string", "description": "Host name", "example": "vbond" }, "ip": { "maxItems": 64, "minItems": 1, "uniqueItems": true, "type": "array", "items": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "IP Address", "example": "10.1.1.1" } } }, "description": "Static host mapping", "$$ref": "#/components/schemas/DnsHostMapping" } } }, "description": "Configure DNS servers or static host mapping", "$$ref": "#/components/schemas/ControlComponentDnsSetting" }, "interface": { "maxItems": 2147483647, "minItems": 1, "type": "array", "items": { "required": [ "ifName" ], "type": "object", "properties": { "ifName": { "pattern": "^(?=.{1,32}$)(?:(ge0\\/\\d+(?:\\.\\d+)?|loopback\\d+|eth\\d+(?:\\.\\d+)?))$", "type": "string", "description": "Interface name eth<0-..> or eth<0-..>.vlanid or loopback when present", "example": "eth0" }, "ip": { "type": "object", "properties": { "address": { "pattern": "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\\/)([0-2]?[0-9]$|[3]?[0-2])$", "type": "string", "description": "Assign IPv4 address", "example": "10.0.1.1/24" }, "dhcpClient": { "type": "boolean", "description": "Enable DHCP", "example": false, "default": false }, "dhcpDistance": { "maximum": 65536, "minimum": 1, "type": "integer", "description": "Set administrative distance for DHCP default route", "format": "int32", "example": 1, "default": 1 } }, "description": "IPv4 address or DHCP", "$$ref": "#/components/schemas/IpConfig" }, "ipv6": { "type": "object", "properties": { "address": { "pattern": "((^\\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))(%.+)?\\s*(\\/)(\\b([0-9]{1,2}|1[01][0-9]|12[0-8])\\b)$))", "type": "string", "description": "Assign IPv6 address", "example": "2001:a0:64::20/64" }, "dhcpClient": { "type": "boolean", "description": "Enable DHCP", "example": false, "default": false }, "dhcpDistance": { "maximum": 65536, "minimum": 1, "type": "integer", "description": "Set administrative distance for DHCP default route", "format": "int32", "example": 1, "default": 1 }, "dhcpRapidCommit": { "type": "boolean", "description": "Enable DHCPv6 rapid commit", "example": false, "default": false } }, "description": "IPv6 address or DHCP", "$$ref": "#/components/schemas/Ipv6Config" }, "shutdown": { "type": "boolean", "description": "Administrative state", "example": false, "default": false }, "tunnelInterface": { "type": "object", "properties": { "allowService": { "type": "object", "properties": { "all": { "type": "boolean", "description": "Allow all traffic. Overrides all other allow-service options if allow-service all is set", "example": false, "default": false }, "dhcp": { "type": "boolean", "description": "Allow/Deny DHCP", "example": true, "default": true }, "dns": { "type": "boolean", "description": "Allow/Deny DNS", "example": true, "default": true }, "icmp": { "type": "boolean", "description": "Allow/Deny ICMP", "example": true, "default": true }, "netconf": { "type": "boolean", "description": "Allow/Deny NETCONF", "example": false, "default": false }, "ntp": { "type": "boolean", "description": "Allow/Deny NTP", "example": false, "default": false }, "sshd": { "type": "boolean", "description": "Allow/Deny SSH", "example": false, "default": false }, "stun": { "type": "boolean", "description": "Allow/Deny STUN", "example": false, "default": false } }, "description": "Set services allowed on the WAN interface", "$$ref": "#/components/schemas/AllowService" }, "color": { "type": "object", "properties": { "value": { "type": "string", "description": "Set color for TLOC", "example": "default", "enum": [ "default", "mpls", "metro-ethernet", "biz-internet", "public-internet", "lte", "3g", "red", "green", "blue", "gold", "silver", "bronze", "custom1", "custom2", "custom3", "private1", "private2", "private3", "private4", "private5", "private6" ], "default": "default" } }, "description": "Set color for TLOC", "$$ref": "#/components/schemas/Color" } }, "description": "Tunnel interface configuration", "$$ref": "#/components/schemas/TunnelInterface" } }, "description": "Interfaces configuration", "$$ref": "#/components/schemas/TransportInterfaceSetting" } }, "ipRoute": { "type": "object", "properties": { "route": { "type": "array", "items": { "required": [ "nextHop", "prefix" ], "type": "object", "properties": { "nextHop": { "maxItems": 2147483647, "minItems": 1, "type": "array", "items": { "required": [ "address" ], "type": "object", "properties": { "address": { "pattern": "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "description": "IPv4 Address", "example": "10.0.0.1" }, "distance": { "maximum": 255, "minimum": 1, "type": "integer", "description": "Administrative distance", "format": "int32", "example": 1, "default": 1 } }, "description": "IP gateway address", "$$ref": "#/components/schemas/NextHop" } }, "prefix": { "pattern": "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\\/)([0-2]?[0-9]$|[3]?[0-2])$", "type": "string", "description": "IPv4 Prefix", "example": "0.0.0.0/0" } }, "description": "Configure static routes", "$$ref": "#/components/schemas/StaticRoute" } } }, "description": "IP Route information", "$$ref": "#/components/schemas/IpRoute" }, "ipv6Route": { "type": "object", "properties": { "route": { "type": "array", "items": { "required": [ "nextHop", "prefix" ], "type": "object", "properties": { "nextHop": { "maxItems": 2147483647, "minItems": 1, "type": "array", "items": { "required": [ "address" ], "type": "object", "properties": { "address": { "pattern": "(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))", "type": "string", "description": "IPv6 Address", "example": "2001::1" }, "distance": { "maximum": 255, "minimum": 1, "type": "integer", "description": "Administrative distance", "format": "int32", "example": 1, "default": 1 } }, "description": "IP gateway address", "$$ref": "#/components/schemas/IPV6NextHop" } }, "prefix": { "pattern": "((^\\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))(%.+)?\\s*(\\/)(\\b([0-9]{1,2}|1[01][0-9]|12[0-8])\\b)$))", "type": "string", "description": "IPv6 Prefix", "example": "2001::/4" } }, "description": "Configure IPv6 static routes", "$$ref": "#/components/schemas/Ipv6StaticRoute" } } }, "description": "IPv6 Route information", "$$ref": "#/components/schemas/Ipv6Route" } }, "description": "Transport VPN instance", "$$ref": "#/components/schemas/baseVpnInstanceTransportInterfaceSetting" } }, "description": "Validator VPN setting", "$$ref": "#/components/schemas/ValidatorVpnSetting" } }, "description": "The payload for validator device specific settings", "$$ref": "#/components/schemas/ValidatorDeviceSpecificSetting" }, { "required": [ "system", "vpn" ], "type": "object", "properties": { "system": { "required": [ "hostName", "siteId", "systemIp" ], "type": "object", "properties": { "clock": { "required": [ "timezone" ], "type": "object", "properties": { "timezone": { "type": "string", "description": "Set the timezone", "example": "UTC", "enum": [ "Europe/Andorra", "Asia/Dubai", "Asia/Kabul", "America/Antigua", "America/Anguilla", "Europe/Tirane", "Asia/Yerevan", "Africa/Luanda", "Antarctica/McMurdo", "Antarctica/Rothera", "Antarctica/Palmer", "Antarctica/Mawson", "Antarctica/Davis", "Antarctica/Casey", "Antarctica/Vostok", "Antarctica/DumontDUrville", "Antarctica/Syowa", "America/Argentina/Buenos_Aires", "America/Argentina/Cordoba", "America/Argentina/Salta", "America/Argentina/Jujuy", "America/Argentina/Tucuman", "America/Argentina/Catamarca", "America/Argentina/La_Rioja", "America/Argentina/San_Juan", "America/Argentina/Mendoza", "America/Argentina/San_Luis", "America/Argentina/Rio_Gallegos", "America/Argentina/Ushuaia", "Pacific/Pago_Pago", "Europe/Vienna", "Australia/Lord_Howe", "Antarctica/Macquarie", "Australia/Hobart", "Australia/Currie", "Australia/Melbourne", "Australia/Sydney", "Australia/Broken_Hill", "Australia/Brisbane", "Australia/Lindeman", "Australia/Adelaide", "Australia/Darwin", "Australia/Perth", "Australia/Eucla", "America/Aruba", "Europe/Mariehamn", "Asia/Baku", "Europe/Sarajevo", "America/Barbados", "Asia/Dhaka", "Europe/Brussels", "Africa/Ouagadougou", "Europe/Sofia", "Asia/Bahrain", "Africa/Bujumbura", "Africa/Porto-Novo", "America/St_Barthelemy", "Atlantic/Bermuda", "Asia/Brunei", "America/La_Paz", "America/Kralendijk", "America/Noronha", "America/Belem", "America/Fortaleza", "America/Recife", "America/Araguaina", "America/Maceio", "America/Bahia", "America/Sao_Paulo", "America/Campo_Grande", "America/Cuiaba", "America/Santarem", "America/Porto_Velho", "America/Boa_Vista", "America/Manaus", "America/Eirunepe", "America/Rio_Branco", "America/Nassau", "Asia/Thimphu", "Africa/Gaborone", "Europe/Minsk", "America/Belize", "America/St_Johns", "America/Halifax", "America/Glace_Bay", "America/Moncton", "America/Goose_Bay", "America/Blanc-Sablon", "America/Toronto", "America/Nipigon", "America/Thunder_Bay", "America/Iqaluit", "America/Pangnirtung", "America/Resolute", "America/Atikokan", "America/Rankin_Inlet", "America/Winnipeg", "America/Rainy_River", "America/Regina", "America/Swift_Current", "America/Edmonton", "America/Cambridge_Bay", "America/Yellowknife", "America/Inuvik", "America/Creston", "America/Dawson_Creek", "America/Vancouver", "America/Whitehorse", "America/Dawson", "Indian/Cocos", "Africa/Kinshasa", "Africa/Lubumbashi", "Africa/Bangui", "Africa/Brazzaville", "Europe/Zurich", "Africa/Abidjan", "Pacific/Rarotonga", "America/Santiago", "Pacific/Easter", "Africa/Douala", "Asia/Shanghai", "Asia/Harbin", "Asia/Chongqing", "Asia/Urumqi", "Asia/Kashgar", "America/Bogota", "America/Costa_Rica", "America/Havana", "Atlantic/Cape_Verde", "America/Curacao", "Indian/Christmas", "Asia/Nicosia", "Europe/Prague", "Europe/Berlin", "Europe/Busingen", "Africa/Djibouti", "Europe/Copenhagen", "America/Dominica", "America/Santo_Domingo", "Africa/Algiers", "America/Guayaquil", "Pacific/Galapagos", "Europe/Tallinn", "Africa/Cairo", "Africa/El_Aaiun", "Africa/Asmara", "Europe/Madrid", "Africa/Ceuta", "Atlantic/Canary", "Africa/Addis_Ababa", "Europe/Helsinki", "Pacific/Fiji", "Atlantic/Stanley", "Pacific/Chuuk", "Pacific/Pohnpei", "Pacific/Kosrae", "Atlantic/Faroe", "Europe/Paris", "Africa/Libreville", "Europe/London", "America/Grenada", "Asia/Tbilisi", "America/Cayenne", "Europe/Guernsey", "Africa/Accra", "Europe/Gibraltar", "America/Godthab", "America/Danmarkshavn", "America/Scoresbysund", "America/Thule", "Africa/Banjul", "Africa/Conakry", "America/Guadeloupe", "Africa/Malabo", "Europe/Athens", "Atlantic/South_Georgia", "America/Guatemala", "Pacific/Guam", "Africa/Bissau", "America/Guyana", "Asia/Hong_Kong", "America/Tegucigalpa", "Europe/Zagreb", "America/Port-au-Prince", "Europe/Budapest", "Asia/Jakarta", "Asia/Pontianak", "Asia/Makassar", "Asia/Jayapura", "Europe/Dublin", "Asia/Jerusalem", "Europe/Isle_of_Man", "Asia/Kolkata", "Indian/Chagos", "Asia/Baghdad", "Asia/Tehran", "Atlantic/Reykjavik", "Europe/Rome", "Europe/Jersey", "America/Jamaica", "Asia/Amman", "Asia/Tokyo", "Africa/Nairobi", "Asia/Bishkek", "Asia/Phnom_Penh", "Pacific/Tarawa", "Pacific/Enderbury", "Pacific/Kiritimati", "Indian/Comoro", "America/St_Kitts", "Asia/Pyongyang", "Asia/Seoul", "Asia/Kuwait", "America/Cayman", "Asia/Almaty", "Asia/Qyzylorda", "Asia/Aqtobe", "Asia/Aqtau", "Asia/Oral", "Asia/Vientiane", "Asia/Beirut", "America/St_Lucia", "Europe/Vaduz", "Asia/Colombo", "Africa/Monrovia", "Africa/Maseru", "Europe/Vilnius", "Europe/Luxembourg", "Europe/Riga", "Africa/Tripoli", "Africa/Casablanca", "Europe/Monaco", "Europe/Chisinau", "Europe/Podgorica", "America/Marigot", "Indian/Antananarivo", "Pacific/Majuro", "Pacific/Kwajalein", "Europe/Skopje", "Africa/Bamako", "Asia/Rangoon", "Asia/Ulaanbaatar", "Asia/Hovd", "Asia/Choibalsan", "Asia/Macau", "Pacific/Saipan", "America/Martinique", "Africa/Nouakchott", "America/Montserrat", "Europe/Malta", "Indian/Mauritius", "Indian/Maldives", "Africa/Blantyre", "America/Mexico_City", "America/Cancun", "America/Merida", "America/Monterrey", "America/Matamoros", "America/Mazatlan", "America/Chihuahua", "America/Ojinaga", "America/Hermosillo", "America/Tijuana", "America/Santa_Isabel", "America/Bahia_Banderas", "Asia/Kuala_Lumpur", "Asia/Kuching", "Africa/Maputo", "Africa/Windhoek", "Pacific/Noumea", "Africa/Niamey", "Pacific/Norfolk", "Africa/Lagos", "America/Managua", "Europe/Amsterdam", "Europe/Oslo", "Asia/Kathmandu", "Pacific/Nauru", "Pacific/Niue", "Pacific/Auckland", "Pacific/Chatham", "Asia/Muscat", "America/Panama", "America/Lima", "Pacific/Tahiti", "Pacific/Marquesas", "Pacific/Gambier", "Pacific/Port_Moresby", "Asia/Manila", "Asia/Karachi", "Europe/Warsaw", "America/Miquelon", "Pacific/Pitcairn", "America/Puerto_Rico", "Asia/Gaza", "Asia/Hebron", "Europe/Lisbon", "Atlantic/Madeira", "Atlantic/Azores", "Pacific/Palau", "America/Asuncion", "Asia/Qatar", "Indian/Reunion", "Europe/Bucharest", "Europe/Belgrade", "Europe/Kaliningrad", "Europe/Moscow", "Europe/Volgograd", "Europe/Samara", "Asia/Yekaterinburg", "Asia/Omsk", "Asia/Novosibirsk", "Asia/Novokuznetsk", "Asia/Krasnoyarsk", "Asia/Irkutsk", "Asia/Yakutsk", "Asia/Khandyga", "Asia/Vladivostok", "Asia/Sakhalin", "Asia/Ust-Nera", "Asia/Magadan", "Asia/Kamchatka", "Asia/Anadyr", "Africa/Kigali", "Asia/Riyadh", "Pacific/Guadalcanal", "Indian/Mahe", "Africa/Khartoum", "Europe/Stockholm", "Asia/Singapore", "Atlantic/St_Helena", "Europe/Ljubljana", "Arctic/Longyearbyen", "Europe/Bratislava", "Africa/Freetown", "Europe/San_Marino", "Africa/Dakar", "Africa/Mogadishu", "America/Paramaribo", "Africa/Juba", "Africa/Sao_Tome", "America/El_Salvador", "America/Lower_Princes", "Asia/Damascus", "Africa/Mbabane", "America/Grand_Turk", "Africa/Ndjamena", "Indian/Kerguelen", "Africa/Lome", "Asia/Bangkok", "Asia/Dushanbe", "Pacific/Fakaofo", "Asia/Dili", "Asia/Ashgabat", "Africa/Tunis", "Pacific/Tongatapu", "Europe/Istanbul", "America/Port_of_Spain", "Pacific/Funafuti", "Asia/Taipei", "Africa/Dar_es_Salaam", "Europe/Kiev", "Europe/Uzhgorod", "Europe/Zaporozhye", "Europe/Simferopol", "Africa/Kampala", "Pacific/Johnston", "Pacific/Midway", "Pacific/Wake", "America/New_York", "America/Detroit", "America/Kentucky/Louisville", "America/Kentucky/Monticello", "America/Indiana/Indianapolis", "America/Indiana/Vincennes", "America/Indiana/Winamac", "America/Indiana/Marengo", "America/Indiana/Petersburg", "America/Indiana/Vevay", "America/Chicago", "America/Indiana/Tell_City", "America/Indiana/Knox", "America/Menominee", "America/North_Dakota/Center", "America/North_Dakota/New_Salem", "America/North_Dakota/Beulah", "America/Denver", "America/Boise", "America/Phoenix", "America/Los_Angeles", "America/Anchorage", "America/Juneau", "America/Sitka", "America/Yakutat", "America/Nome", "America/Adak", "America/Metlakatla", "Pacific/Honolulu", "America/Montevideo", "Asia/Samarkand", "Asia/Tashkent", "Europe/Vatican", "America/St_Vincent", "America/Caracas", "America/Tortola", "America/St_Thomas", "Asia/Ho_Chi_Minh", "Pacific/Efate", "Pacific/Wallis", "Pacific/Apia", "Asia/Aden", "Indian/Mayotte", "Africa/Johannesburg", "Africa/Lusaka", "Africa/Harare", "UTC" ], "default": "UTC" } }, "description": "Configure clock", "$$ref": "#/components/schemas/Clock" }, "controllerGroupId": { "maximum": 100, "minimum": 0, "type": "integer", "description": "Controller group id", "format": "int32", "example": 0, "default": 0 }, "description": { "pattern": "^[^<>]{1,32}$", "type": "string", "description": "Set a text description of the device", "example": "System settings" }, "deviceGroups": { "type": "array", "description": "Configure device groups", "items": { "type": "string", "description": "Configure device groups" } }, "gpsLocation": { "required": [ "latitude", "longitude" ], "type": "object", "properties": { "latitude": { "maximum": 90, "minimum": -90, "type": "number", "description": "Set the device\u2019s physical latitude", "example": 60 }, "longitude": { "maximum": 180, "minimum": -180, "type": "number", "description": "Set the device\u2019s physical longitude", "example": 60 } }, "description": "GPS latitude and longitude of the device", "$$ref": "#/components/schemas/GpsLocation" }, "hostName": { "pattern": "^[a-zA-Z0-9\\-_]{1,32}$", "type": "string", "description": "Set the hostname", "example": "vm12" }, "ipv6StrictControl": { "type": "boolean", "description": "Sets up a strict IPv6 control connection in a dual stack IP", "example": false, "default": false }, "location": { "pattern": "^[^<>]{1,127}$", "type": "string", "description": "Set the location of the device", "example": "USA" }, "overlayId": { "maximum": 4294967295, "minimum": 1, "type": "integer", "description": "Set the Overlay ID", "format": "int64", "example": 1, "default": 1 }, "region": { "type": "object", "properties": { "regionIdList": { "maxItems": 2147483647, "minItems": 1, "uniqueItems": true, "type": "array", "items": { "maximum": 63, "minimum": 0, "type": "integer", "description": "Configure a list of region ID", "format": "int32", "example": 0 } } }, "$$ref": "#/components/schemas/Region" }, "siteId": { "maximum": 4294967295, "minimum": 0, "type": "integer", "description": "Set the site ID", "format": "int64", "example": 100 }, "systemIp": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "Set the system IP address", "example": "102.2.3.2" } }, "description": "System configuration for controller", "$$ref": "#/components/schemas/ControllerSystemSetting" }, "vpn": { "required": [ "transport" ], "type": "object", "properties": { "management": { "required": [ "interface" ], "type": "object", "properties": { "dns": { "type": "object", "properties": { "dnsServerPrimary": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "Primary DNS server IPv4 or IPv6 Address", "example": "10.2.2.2" }, "dnsServerSecondary": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "Secondary DNS server IPv4 or IPv6 Address", "example": "10.2.2.3" }, "host": { "type": "array", "items": { "required": [ "hostname", "ip" ], "type": "object", "properties": { "hostname": { "pattern": "^[a-zA-Z0-9\\-_.]{1,64}$", "type": "string", "description": "Host name", "example": "vbond" }, "ip": { "maxItems": 64, "minItems": 1, "uniqueItems": true, "type": "array", "items": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "IP Address", "example": "10.1.1.1" } } }, "description": "Static host mapping", "$$ref": "#/components/schemas/DnsHostMapping" } } }, "description": "Configure DNS servers or static host mapping", "$$ref": "#/components/schemas/ControlComponentDnsSetting" }, "interface": { "maxItems": 2147483647, "minItems": 1, "type": "array", "items": { "required": [ "ifName" ], "type": "object", "properties": { "ifName": { "pattern": "^(?=.{1,32}$)(?:(ge0\\/\\d+(?:\\.\\d+)?|loopback\\d+|eth\\d+(?:\\.\\d+)?))$", "type": "string", "description": "Interface name eth<0-..> or eth<0-..>.vlanid or loopback when present", "example": "eth0" }, "ip": { "type": "object", "properties": { "address": { "pattern": "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\\/)([0-2]?[0-9]$|[3]?[0-2])$", "type": "string", "description": "Assign IPv4 address", "example": "10.0.1.1/24" }, "dhcpClient": { "type": "boolean", "description": "Enable DHCP", "example": false, "default": false }, "dhcpDistance": { "maximum": 65536, "minimum": 1, "type": "integer", "description": "Set administrative distance for DHCP default route", "format": "int32", "example": 1, "default": 1 } }, "description": "IPv4 address or DHCP", "$$ref": "#/components/schemas/IpConfig" }, "ipv6": { "type": "object", "properties": { "address": { "pattern": "((^\\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))(%.+)?\\s*(\\/)(\\b([0-9]{1,2}|1[01][0-9]|12[0-8])\\b)$))", "type": "string", "description": "Assign IPv6 address", "example": "2001:a0:64::20/64" }, "dhcpClient": { "type": "boolean", "description": "Enable DHCP", "example": false, "default": false }, "dhcpDistance": { "maximum": 65536, "minimum": 1, "type": "integer", "description": "Set administrative distance for DHCP default route", "format": "int32", "example": 1, "default": 1 }, "dhcpRapidCommit": { "type": "boolean", "description": "Enable DHCPv6 rapid commit", "example": false, "default": false } }, "description": "IPv6 address or DHCP", "$$ref": "#/components/schemas/Ipv6Config" }, "shutdown": { "type": "boolean", "description": "Administrative state", "example": false, "default": false } }, "description": "Interfaces configuration", "$$ref": "#/components/schemas/BaseInterfaceSetting" } }, "ipRoute": { "type": "object", "properties": { "route": { "type": "array", "items": { "required": [ "nextHop", "prefix" ], "type": "object", "properties": { "nextHop": { "maxItems": 2147483647, "minItems": 1, "type": "array", "items": { "required": [ "address" ], "type": "object", "properties": { "address": { "pattern": "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "description": "IPv4 Address", "example": "10.0.0.1" }, "distance": { "maximum": 255, "minimum": 1, "type": "integer", "description": "Administrative distance", "format": "int32", "example": 1, "default": 1 } }, "description": "IP gateway address", "$$ref": "#/components/schemas/NextHop" } }, "prefix": { "pattern": "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\\/)([0-2]?[0-9]$|[3]?[0-2])$", "type": "string", "description": "IPv4 Prefix", "example": "0.0.0.0/0" } }, "description": "Configure static routes", "$$ref": "#/components/schemas/StaticRoute" } } }, "description": "IP Route information", "$$ref": "#/components/schemas/IpRoute" }, "ipv6Route": { "type": "object", "properties": { "route": { "type": "array", "items": { "required": [ "nextHop", "prefix" ], "type": "object", "properties": { "nextHop": { "maxItems": 2147483647, "minItems": 1, "type": "array", "items": { "required": [ "address" ], "type": "object", "properties": { "address": { "pattern": "(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))", "type": "string", "description": "IPv6 Address", "example": "2001::1" }, "distance": { "maximum": 255, "minimum": 1, "type": "integer", "description": "Administrative distance", "format": "int32", "example": 1, "default": 1 } }, "description": "IP gateway address", "$$ref": "#/components/schemas/IPV6NextHop" } }, "prefix": { "pattern": "((^\\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))(%.+)?\\s*(\\/)(\\b([0-9]{1,2}|1[01][0-9]|12[0-8])\\b)$))", "type": "string", "description": "IPv6 Prefix", "example": "2001::/4" } }, "description": "Configure IPv6 static routes", "$$ref": "#/components/schemas/Ipv6StaticRoute" } } }, "description": "IPv6 Route information", "$$ref": "#/components/schemas/Ipv6Route" } }, "description": "Management VPN instance", "$$ref": "#/components/schemas/baseVpnInstanceBaseInterfaceSetting" }, "transport": { "required": [ "interface" ], "type": "object", "properties": { "dns": { "type": "object", "properties": { "dnsServerPrimary": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "Primary DNS server IPv4 or IPv6 Address", "example": "10.2.2.2" }, "dnsServerSecondary": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "Secondary DNS server IPv4 or IPv6 Address", "example": "10.2.2.3" }, "host": { "type": "array", "items": { "required": [ "hostname", "ip" ], "type": "object", "properties": { "hostname": { "pattern": "^[a-zA-Z0-9\\-_.]{1,64}$", "type": "string", "description": "Host name", "example": "vbond" }, "ip": { "maxItems": 64, "minItems": 1, "uniqueItems": true, "type": "array", "items": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "IP Address", "example": "10.1.1.1" } } }, "description": "Static host mapping", "$$ref": "#/components/schemas/DnsHostMapping" } } }, "description": "Configure DNS servers or static host mapping", "$$ref": "#/components/schemas/ControlComponentDnsSetting" }, "interface": { "maxItems": 2147483647, "minItems": 1, "type": "array", "items": { "required": [ "ifName" ], "type": "object", "properties": { "ifName": { "pattern": "^(?=.{1,32}$)(?:(ge0\\/\\d+(?:\\.\\d+)?|loopback\\d+|eth\\d+(?:\\.\\d+)?))$", "type": "string", "description": "Interface name eth<0-..> or eth<0-..>.vlanid or loopback when present", "example": "eth0" }, "ip": { "type": "object", "properties": { "address": { "pattern": "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\\/)([0-2]?[0-9]$|[3]?[0-2])$", "type": "string", "description": "Assign IPv4 address", "example": "10.0.1.1/24" }, "dhcpClient": { "type": "boolean", "description": "Enable DHCP", "example": false, "default": false }, "dhcpDistance": { "maximum": 65536, "minimum": 1, "type": "integer", "description": "Set administrative distance for DHCP default route", "format": "int32", "example": 1, "default": 1 } }, "description": "IPv4 address or DHCP", "$$ref": "#/components/schemas/IpConfig" }, "ipv6": { "type": "object", "properties": { "address": { "pattern": "((^\\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))(%.+)?\\s*(\\/)(\\b([0-9]{1,2}|1[01][0-9]|12[0-8])\\b)$))", "type": "string", "description": "Assign IPv6 address", "example": "2001:a0:64::20/64" }, "dhcpClient": { "type": "boolean", "description": "Enable DHCP", "example": false, "default": false }, "dhcpDistance": { "maximum": 65536, "minimum": 1, "type": "integer", "description": "Set administrative distance for DHCP default route", "format": "int32", "example": 1, "default": 1 }, "dhcpRapidCommit": { "type": "boolean", "description": "Enable DHCPv6 rapid commit", "example": false, "default": false } }, "description": "IPv6 address or DHCP", "$$ref": "#/components/schemas/Ipv6Config" }, "shutdown": { "type": "boolean", "description": "Administrative state", "example": false, "default": false }, "tunnelInterface": { "type": "object", "properties": { "allowService": { "type": "object", "properties": { "all": { "type": "boolean", "description": "Allow all traffic. Overrides all other allow-service options if allow-service all is set", "example": false, "default": false }, "dhcp": { "type": "boolean", "description": "Allow/Deny DHCP", "example": true, "default": true }, "dns": { "type": "boolean", "description": "Allow/Deny DNS", "example": true, "default": true }, "icmp": { "type": "boolean", "description": "Allow/Deny ICMP", "example": true, "default": true }, "netconf": { "type": "boolean", "description": "Allow/Deny NETCONF", "example": false, "default": false }, "ntp": { "type": "boolean", "description": "Allow/Deny NTP", "example": false, "default": false }, "sshd": { "type": "boolean", "description": "Allow/Deny SSH", "example": false, "default": false }, "stun": { "type": "boolean", "description": "Allow/Deny STUN", "example": false, "default": false } }, "description": "Set services allowed on the WAN interface", "$$ref": "#/components/schemas/AllowService" }, "color": { "type": "object", "properties": { "value": { "type": "string", "description": "Set color for TLOC", "example": "default", "enum": [ "default", "mpls", "metro-ethernet", "biz-internet", "public-internet", "lte", "3g", "red", "green", "blue", "gold", "silver", "bronze", "custom1", "custom2", "custom3", "private1", "private2", "private3", "private4", "private5", "private6" ], "default": "default" } }, "description": "Set color for TLOC", "$$ref": "#/components/schemas/Color" } }, "description": "Tunnel interface configuration", "$$ref": "#/components/schemas/TunnelInterface" } }, "description": "Interfaces configuration", "$$ref": "#/components/schemas/TransportInterfaceSetting" } }, "ipRoute": { "type": "object", "properties": { "route": { "type": "array", "items": { "required": [ "nextHop", "prefix" ], "type": "object", "properties": { "nextHop": { "maxItems": 2147483647, "minItems": 1, "type": "array", "items": { "required": [ "address" ], "type": "object", "properties": { "address": { "pattern": "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "description": "IPv4 Address", "example": "10.0.0.1" }, "distance": { "maximum": 255, "minimum": 1, "type": "integer", "description": "Administrative distance", "format": "int32", "example": 1, "default": 1 } }, "description": "IP gateway address", "$$ref": "#/components/schemas/NextHop" } }, "prefix": { "pattern": "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\\/)([0-2]?[0-9]$|[3]?[0-2])$", "type": "string", "description": "IPv4 Prefix", "example": "0.0.0.0/0" } }, "description": "Configure static routes", "$$ref": "#/components/schemas/StaticRoute" } } }, "description": "IP Route information", "$$ref": "#/components/schemas/IpRoute" }, "ipv6Route": { "type": "object", "properties": { "route": { "type": "array", "items": { "required": [ "nextHop", "prefix" ], "type": "object", "properties": { "nextHop": { "maxItems": 2147483647, "minItems": 1, "type": "array", "items": { "required": [ "address" ], "type": "object", "properties": { "address": { "pattern": "(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))", "type": "string", "description": "IPv6 Address", "example": "2001::1" }, "distance": { "maximum": 255, "minimum": 1, "type": "integer", "description": "Administrative distance", "format": "int32", "example": 1, "default": 1 } }, "description": "IP gateway address", "$$ref": "#/components/schemas/IPV6NextHop" } }, "prefix": { "pattern": "((^\\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))(%.+)?\\s*(\\/)(\\b([0-9]{1,2}|1[01][0-9]|12[0-8])\\b)$))", "type": "string", "description": "IPv6 Prefix", "example": "2001::/4" } }, "description": "Configure IPv6 static routes", "$$ref": "#/components/schemas/Ipv6StaticRoute" } } }, "description": "IPv6 Route information", "$$ref": "#/components/schemas/Ipv6Route" } }, "description": "Transport VPN instance", "$$ref": "#/components/schemas/baseVpnInstanceTransportInterfaceSetting" } }, "description": "Controller VPN setting", "$$ref": "#/components/schemas/ControllerVpnSetting" } }, "description": "The payload for controller device specific settings", "$$ref": "#/components/schemas/ControllerDeviceSpecificSetting" }, { "required": [ "system", "vpn" ], "type": "object", "properties": { "system": { "required": [ "hostName", "siteId", "systemIp" ], "type": "object", "properties": { "clock": { "required": [ "timezone" ], "type": "object", "properties": { "timezone": { "type": "string", "description": "Set the timezone", "example": "UTC", "enum": [ "Europe/Andorra", "Asia/Dubai", "Asia/Kabul", "America/Antigua", "America/Anguilla", "Europe/Tirane", "Asia/Yerevan", "Africa/Luanda", "Antarctica/McMurdo", "Antarctica/Rothera", "Antarctica/Palmer", "Antarctica/Mawson", "Antarctica/Davis", "Antarctica/Casey", "Antarctica/Vostok", "Antarctica/DumontDUrville", "Antarctica/Syowa", "America/Argentina/Buenos_Aires", "America/Argentina/Cordoba", "America/Argentina/Salta", "America/Argentina/Jujuy", "America/Argentina/Tucuman", "America/Argentina/Catamarca", "America/Argentina/La_Rioja", "America/Argentina/San_Juan", "America/Argentina/Mendoza", "America/Argentina/San_Luis", "America/Argentina/Rio_Gallegos", "America/Argentina/Ushuaia", "Pacific/Pago_Pago", "Europe/Vienna", "Australia/Lord_Howe", "Antarctica/Macquarie", "Australia/Hobart", "Australia/Currie", "Australia/Melbourne", "Australia/Sydney", "Australia/Broken_Hill", "Australia/Brisbane", "Australia/Lindeman", "Australia/Adelaide", "Australia/Darwin", "Australia/Perth", "Australia/Eucla", "America/Aruba", "Europe/Mariehamn", "Asia/Baku", "Europe/Sarajevo", "America/Barbados", "Asia/Dhaka", "Europe/Brussels", "Africa/Ouagadougou", "Europe/Sofia", "Asia/Bahrain", "Africa/Bujumbura", "Africa/Porto-Novo", "America/St_Barthelemy", "Atlantic/Bermuda", "Asia/Brunei", "America/La_Paz", "America/Kralendijk", "America/Noronha", "America/Belem", "America/Fortaleza", "America/Recife", "America/Araguaina", "America/Maceio", "America/Bahia", "America/Sao_Paulo", "America/Campo_Grande", "America/Cuiaba", "America/Santarem", "America/Porto_Velho", "America/Boa_Vista", "America/Manaus", "America/Eirunepe", "America/Rio_Branco", "America/Nassau", "Asia/Thimphu", "Africa/Gaborone", "Europe/Minsk", "America/Belize", "America/St_Johns", "America/Halifax", "America/Glace_Bay", "America/Moncton", "America/Goose_Bay", "America/Blanc-Sablon", "America/Toronto", "America/Nipigon", "America/Thunder_Bay", "America/Iqaluit", "America/Pangnirtung", "America/Resolute", "America/Atikokan", "America/Rankin_Inlet", "America/Winnipeg", "America/Rainy_River", "America/Regina", "America/Swift_Current", "America/Edmonton", "America/Cambridge_Bay", "America/Yellowknife", "America/Inuvik", "America/Creston", "America/Dawson_Creek", "America/Vancouver", "America/Whitehorse", "America/Dawson", "Indian/Cocos", "Africa/Kinshasa", "Africa/Lubumbashi", "Africa/Bangui", "Africa/Brazzaville", "Europe/Zurich", "Africa/Abidjan", "Pacific/Rarotonga", "America/Santiago", "Pacific/Easter", "Africa/Douala", "Asia/Shanghai", "Asia/Harbin", "Asia/Chongqing", "Asia/Urumqi", "Asia/Kashgar", "America/Bogota", "America/Costa_Rica", "America/Havana", "Atlantic/Cape_Verde", "America/Curacao", "Indian/Christmas", "Asia/Nicosia", "Europe/Prague", "Europe/Berlin", "Europe/Busingen", "Africa/Djibouti", "Europe/Copenhagen", "America/Dominica", "America/Santo_Domingo", "Africa/Algiers", "America/Guayaquil", "Pacific/Galapagos", "Europe/Tallinn", "Africa/Cairo", "Africa/El_Aaiun", "Africa/Asmara", "Europe/Madrid", "Africa/Ceuta", "Atlantic/Canary", "Africa/Addis_Ababa", "Europe/Helsinki", "Pacific/Fiji", "Atlantic/Stanley", "Pacific/Chuuk", "Pacific/Pohnpei", "Pacific/Kosrae", "Atlantic/Faroe", "Europe/Paris", "Africa/Libreville", "Europe/London", "America/Grenada", "Asia/Tbilisi", "America/Cayenne", "Europe/Guernsey", "Africa/Accra", "Europe/Gibraltar", "America/Godthab", "America/Danmarkshavn", "America/Scoresbysund", "America/Thule", "Africa/Banjul", "Africa/Conakry", "America/Guadeloupe", "Africa/Malabo", "Europe/Athens", "Atlantic/South_Georgia", "America/Guatemala", "Pacific/Guam", "Africa/Bissau", "America/Guyana", "Asia/Hong_Kong", "America/Tegucigalpa", "Europe/Zagreb", "America/Port-au-Prince", "Europe/Budapest", "Asia/Jakarta", "Asia/Pontianak", "Asia/Makassar", "Asia/Jayapura", "Europe/Dublin", "Asia/Jerusalem", "Europe/Isle_of_Man", "Asia/Kolkata", "Indian/Chagos", "Asia/Baghdad", "Asia/Tehran", "Atlantic/Reykjavik", "Europe/Rome", "Europe/Jersey", "America/Jamaica", "Asia/Amman", "Asia/Tokyo", "Africa/Nairobi", "Asia/Bishkek", "Asia/Phnom_Penh", "Pacific/Tarawa", "Pacific/Enderbury", "Pacific/Kiritimati", "Indian/Comoro", "America/St_Kitts", "Asia/Pyongyang", "Asia/Seoul", "Asia/Kuwait", "America/Cayman", "Asia/Almaty", "Asia/Qyzylorda", "Asia/Aqtobe", "Asia/Aqtau", "Asia/Oral", "Asia/Vientiane", "Asia/Beirut", "America/St_Lucia", "Europe/Vaduz", "Asia/Colombo", "Africa/Monrovia", "Africa/Maseru", "Europe/Vilnius", "Europe/Luxembourg", "Europe/Riga", "Africa/Tripoli", "Africa/Casablanca", "Europe/Monaco", "Europe/Chisinau", "Europe/Podgorica", "America/Marigot", "Indian/Antananarivo", "Pacific/Majuro", "Pacific/Kwajalein", "Europe/Skopje", "Africa/Bamako", "Asia/Rangoon", "Asia/Ulaanbaatar", "Asia/Hovd", "Asia/Choibalsan", "Asia/Macau", "Pacific/Saipan", "America/Martinique", "Africa/Nouakchott", "America/Montserrat", "Europe/Malta", "Indian/Mauritius", "Indian/Maldives", "Africa/Blantyre", "America/Mexico_City", "America/Cancun", "America/Merida", "America/Monterrey", "America/Matamoros", "America/Mazatlan", "America/Chihuahua", "America/Ojinaga", "America/Hermosillo", "America/Tijuana", "America/Santa_Isabel", "America/Bahia_Banderas", "Asia/Kuala_Lumpur", "Asia/Kuching", "Africa/Maputo", "Africa/Windhoek", "Pacific/Noumea", "Africa/Niamey", "Pacific/Norfolk", "Africa/Lagos", "America/Managua", "Europe/Amsterdam", "Europe/Oslo", "Asia/Kathmandu", "Pacific/Nauru", "Pacific/Niue", "Pacific/Auckland", "Pacific/Chatham", "Asia/Muscat", "America/Panama", "America/Lima", "Pacific/Tahiti", "Pacific/Marquesas", "Pacific/Gambier", "Pacific/Port_Moresby", "Asia/Manila", "Asia/Karachi", "Europe/Warsaw", "America/Miquelon", "Pacific/Pitcairn", "America/Puerto_Rico", "Asia/Gaza", "Asia/Hebron", "Europe/Lisbon", "Atlantic/Madeira", "Atlantic/Azores", "Pacific/Palau", "America/Asuncion", "Asia/Qatar", "Indian/Reunion", "Europe/Bucharest", "Europe/Belgrade", "Europe/Kaliningrad", "Europe/Moscow", "Europe/Volgograd", "Europe/Samara", "Asia/Yekaterinburg", "Asia/Omsk", "Asia/Novosibirsk", "Asia/Novokuznetsk", "Asia/Krasnoyarsk", "Asia/Irkutsk", "Asia/Yakutsk", "Asia/Khandyga", "Asia/Vladivostok", "Asia/Sakhalin", "Asia/Ust-Nera", "Asia/Magadan", "Asia/Kamchatka", "Asia/Anadyr", "Africa/Kigali", "Asia/Riyadh", "Pacific/Guadalcanal", "Indian/Mahe", "Africa/Khartoum", "Europe/Stockholm", "Asia/Singapore", "Atlantic/St_Helena", "Europe/Ljubljana", "Arctic/Longyearbyen", "Europe/Bratislava", "Africa/Freetown", "Europe/San_Marino", "Africa/Dakar", "Africa/Mogadishu", "America/Paramaribo", "Africa/Juba", "Africa/Sao_Tome", "America/El_Salvador", "America/Lower_Princes", "Asia/Damascus", "Africa/Mbabane", "America/Grand_Turk", "Africa/Ndjamena", "Indian/Kerguelen", "Africa/Lome", "Asia/Bangkok", "Asia/Dushanbe", "Pacific/Fakaofo", "Asia/Dili", "Asia/Ashgabat", "Africa/Tunis", "Pacific/Tongatapu", "Europe/Istanbul", "America/Port_of_Spain", "Pacific/Funafuti", "Asia/Taipei", "Africa/Dar_es_Salaam", "Europe/Kiev", "Europe/Uzhgorod", "Europe/Zaporozhye", "Europe/Simferopol", "Africa/Kampala", "Pacific/Johnston", "Pacific/Midway", "Pacific/Wake", "America/New_York", "America/Detroit", "America/Kentucky/Louisville", "America/Kentucky/Monticello", "America/Indiana/Indianapolis", "America/Indiana/Vincennes", "America/Indiana/Winamac", "America/Indiana/Marengo", "America/Indiana/Petersburg", "America/Indiana/Vevay", "America/Chicago", "America/Indiana/Tell_City", "America/Indiana/Knox", "America/Menominee", "America/North_Dakota/Center", "America/North_Dakota/New_Salem", "America/North_Dakota/Beulah", "America/Denver", "America/Boise", "America/Phoenix", "America/Los_Angeles", "America/Anchorage", "America/Juneau", "America/Sitka", "America/Yakutat", "America/Nome", "America/Adak", "America/Metlakatla", "Pacific/Honolulu", "America/Montevideo", "Asia/Samarkand", "Asia/Tashkent", "Europe/Vatican", "America/St_Vincent", "America/Caracas", "America/Tortola", "America/St_Thomas", "Asia/Ho_Chi_Minh", "Pacific/Efate", "Pacific/Wallis", "Pacific/Apia", "Asia/Aden", "Indian/Mayotte", "Africa/Johannesburg", "Africa/Lusaka", "Africa/Harare", "UTC" ], "default": "UTC" } }, "description": "Configure clock", "$$ref": "#/components/schemas/Clock" }, "description": { "pattern": "^[^<>]{1,32}$", "type": "string", "description": "Set a text description of the device", "example": "System settings" }, "deviceGroups": { "type": "array", "description": "Configure device groups", "items": { "type": "string", "description": "Configure device groups" } }, "gpsLocation": { "required": [ "latitude", "longitude" ], "type": "object", "properties": { "latitude": { "maximum": 90, "minimum": -90, "type": "number", "description": "Set the device\u2019s physical latitude", "example": 60 }, "longitude": { "maximum": 180, "minimum": -180, "type": "number", "description": "Set the device\u2019s physical longitude", "example": 60 } }, "description": "GPS latitude and longitude of the device", "$$ref": "#/components/schemas/GpsLocation" }, "hostName": { "pattern": "^[a-zA-Z0-9\\-_]{1,32}$", "type": "string", "description": "Set the hostname", "example": "vm12" }, "ipv6StrictControl": { "type": "boolean", "description": "Enable Dual Stack IPv6 Default", "example": false, "default": false }, "location": { "pattern": "^[^<>]{1,127}$", "type": "string", "description": "Set the location of the device", "example": "USA" }, "siteId": { "maximum": 4294967295, "minimum": 0, "type": "integer", "description": "Set the site ID", "format": "int64", "example": 100 }, "systemIp": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "Set the system IP address", "example": "102.2.3.2" } }, "description": "System configuration for manager", "$$ref": "#/components/schemas/ManagerSystemSetting" }, "vpn": { "required": [ "transport" ], "type": "object", "properties": { "management": { "required": [ "interface" ], "type": "object", "properties": { "dns": { "type": "object", "properties": { "dnsServerPrimary": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "Primary DNS server IPv4 or IPv6 Address", "example": "10.2.2.2" }, "dnsServerSecondary": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "Secondary DNS server IPv4 or IPv6 Address", "example": "10.2.2.3" }, "host": { "type": "array", "items": { "required": [ "hostname", "ip" ], "type": "object", "properties": { "hostname": { "pattern": "^[a-zA-Z0-9\\-_.]{1,64}$", "type": "string", "description": "Host name", "example": "vbond" }, "ip": { "maxItems": 64, "minItems": 1, "uniqueItems": true, "type": "array", "items": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "IP Address", "example": "10.1.1.1" } } }, "description": "Static host mapping", "$$ref": "#/components/schemas/DnsHostMapping" } } }, "description": "Configure DNS servers or static host mapping", "$$ref": "#/components/schemas/ControlComponentDnsSetting" }, "interface": { "maxItems": 2147483647, "minItems": 1, "type": "array", "items": { "required": [ "ifName" ], "type": "object", "properties": { "ifName": { "pattern": "^(?=.{1,32}$)(?:(ge0\\/\\d+(?:\\.\\d+)?|loopback\\d+|eth\\d+(?:\\.\\d+)?))$", "type": "string", "description": "Interface name eth<0-..> or eth<0-..>.vlanid or loopback when present", "example": "eth0" }, "ip": { "type": "object", "properties": { "address": { "pattern": "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\\/)([0-2]?[0-9]$|[3]?[0-2])$", "type": "string", "description": "Assign IPv4 address", "example": "10.0.1.1/24" }, "dhcpClient": { "type": "boolean", "description": "Enable DHCP", "example": false, "default": false }, "dhcpDistance": { "maximum": 65536, "minimum": 1, "type": "integer", "description": "Set administrative distance for DHCP default route", "format": "int32", "example": 1, "default": 1 } }, "description": "IPv4 address or DHCP", "$$ref": "#/components/schemas/IpConfig" }, "ipv6": { "type": "object", "properties": { "address": { "pattern": "((^\\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))(%.+)?\\s*(\\/)(\\b([0-9]{1,2}|1[01][0-9]|12[0-8])\\b)$))", "type": "string", "description": "Assign IPv6 address", "example": "2001:a0:64::20/64" }, "dhcpClient": { "type": "boolean", "description": "Enable DHCP", "example": false, "default": false }, "dhcpDistance": { "maximum": 65536, "minimum": 1, "type": "integer", "description": "Set administrative distance for DHCP default route", "format": "int32", "example": 1, "default": 1 }, "dhcpRapidCommit": { "type": "boolean", "description": "Enable DHCPv6 rapid commit", "example": false, "default": false } }, "description": "IPv6 address or DHCP", "$$ref": "#/components/schemas/Ipv6Config" }, "shutdown": { "type": "boolean", "description": "Administrative state", "example": false, "default": false } }, "description": "Interfaces configuration", "$$ref": "#/components/schemas/BaseInterfaceSetting" } }, "ipRoute": { "type": "object", "properties": { "route": { "type": "array", "items": { "required": [ "nextHop", "prefix" ], "type": "object", "properties": { "nextHop": { "maxItems": 2147483647, "minItems": 1, "type": "array", "items": { "required": [ "address" ], "type": "object", "properties": { "address": { "pattern": "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "description": "IPv4 Address", "example": "10.0.0.1" }, "distance": { "maximum": 255, "minimum": 1, "type": "integer", "description": "Administrative distance", "format": "int32", "example": 1, "default": 1 } }, "description": "IP gateway address", "$$ref": "#/components/schemas/NextHop" } }, "prefix": { "pattern": "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\\/)([0-2]?[0-9]$|[3]?[0-2])$", "type": "string", "description": "IPv4 Prefix", "example": "0.0.0.0/0" } }, "description": "Configure static routes", "$$ref": "#/components/schemas/StaticRoute" } } }, "description": "IP Route information", "$$ref": "#/components/schemas/IpRoute" }, "ipv6Route": { "type": "object", "properties": { "route": { "type": "array", "items": { "required": [ "nextHop", "prefix" ], "type": "object", "properties": { "nextHop": { "maxItems": 2147483647, "minItems": 1, "type": "array", "items": { "required": [ "address" ], "type": "object", "properties": { "address": { "pattern": "(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))", "type": "string", "description": "IPv6 Address", "example": "2001::1" }, "distance": { "maximum": 255, "minimum": 1, "type": "integer", "description": "Administrative distance", "format": "int32", "example": 1, "default": 1 } }, "description": "IP gateway address", "$$ref": "#/components/schemas/IPV6NextHop" } }, "prefix": { "pattern": "((^\\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))(%.+)?\\s*(\\/)(\\b([0-9]{1,2}|1[01][0-9]|12[0-8])\\b)$))", "type": "string", "description": "IPv6 Prefix", "example": "2001::/4" } }, "description": "Configure IPv6 static routes", "$$ref": "#/components/schemas/Ipv6StaticRoute" } } }, "description": "IPv6 Route information", "$$ref": "#/components/schemas/Ipv6Route" } }, "description": "Management VPN instance", "$$ref": "#/components/schemas/baseVpnInstanceBaseInterfaceSetting" }, "transport": { "required": [ "interface" ], "type": "object", "properties": { "dns": { "type": "object", "properties": { "dnsServerPrimary": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "Primary DNS server IPv4 or IPv6 Address", "example": "10.2.2.2" }, "dnsServerSecondary": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "Secondary DNS server IPv4 or IPv6 Address", "example": "10.2.2.3" }, "host": { "type": "array", "items": { "required": [ "hostname", "ip" ], "type": "object", "properties": { "hostname": { "pattern": "^[a-zA-Z0-9\\-_.]{1,64}$", "type": "string", "description": "Host name", "example": "vbond" }, "ip": { "maxItems": 64, "minItems": 1, "uniqueItems": true, "type": "array", "items": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "IP Address", "example": "10.1.1.1" } } }, "description": "Static host mapping", "$$ref": "#/components/schemas/DnsHostMapping" } } }, "description": "Configure DNS servers or static host mapping", "$$ref": "#/components/schemas/ControlComponentDnsSetting" }, "interface": { "maxItems": 2147483647, "minItems": 1, "type": "array", "items": { "required": [ "ifName" ], "type": "object", "properties": { "ifName": { "pattern": "^(?=.{1,32}$)(?:(ge0\\/\\d+(?:\\.\\d+)?|loopback\\d+|eth\\d+(?:\\.\\d+)?))$", "type": "string", "description": "Interface name eth<0-..> or eth<0-..>.vlanid or loopback when present", "example": "eth0" }, "ip": { "type": "object", "properties": { "address": { "pattern": "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\\/)([0-2]?[0-9]$|[3]?[0-2])$", "type": "string", "description": "Assign IPv4 address", "example": "10.0.1.1/24" }, "dhcpClient": { "type": "boolean", "description": "Enable DHCP", "example": false, "default": false }, "dhcpDistance": { "maximum": 65536, "minimum": 1, "type": "integer", "description": "Set administrative distance for DHCP default route", "format": "int32", "example": 1, "default": 1 } }, "description": "IPv4 address or DHCP", "$$ref": "#/components/schemas/IpConfig" }, "ipv6": { "type": "object", "properties": { "address": { "pattern": "((^\\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))(%.+)?\\s*(\\/)(\\b([0-9]{1,2}|1[01][0-9]|12[0-8])\\b)$))", "type": "string", "description": "Assign IPv6 address", "example": "2001:a0:64::20/64" }, "dhcpClient": { "type": "boolean", "description": "Enable DHCP", "example": false, "default": false }, "dhcpDistance": { "maximum": 65536, "minimum": 1, "type": "integer", "description": "Set administrative distance for DHCP default route", "format": "int32", "example": 1, "default": 1 }, "dhcpRapidCommit": { "type": "boolean", "description": "Enable DHCPv6 rapid commit", "example": false, "default": false } }, "description": "IPv6 address or DHCP", "$$ref": "#/components/schemas/Ipv6Config" }, "shutdown": { "type": "boolean", "description": "Administrative state", "example": false, "default": false }, "tunnelInterface": { "type": "object", "properties": { "allowService": { "type": "object", "properties": { "all": { "type": "boolean", "description": "Allow all traffic. Overrides all other allow-service options if allow-service all is set", "example": false, "default": false }, "dhcp": { "type": "boolean", "description": "Allow/Deny DHCP", "example": true, "default": true }, "dns": { "type": "boolean", "description": "Allow/Deny DNS", "example": true, "default": true }, "icmp": { "type": "boolean", "description": "Allow/Deny ICMP", "example": true, "default": true }, "netconf": { "type": "boolean", "description": "Allow/Deny NETCONF", "example": false, "default": false }, "ntp": { "type": "boolean", "description": "Allow/Deny NTP", "example": false, "default": false }, "sshd": { "type": "boolean", "description": "Allow/Deny SSH", "example": false, "default": false }, "stun": { "type": "boolean", "description": "Allow/Deny STUN", "example": false, "default": false } }, "description": "Set services allowed on the WAN interface", "$$ref": "#/components/schemas/AllowService" }, "color": { "type": "object", "properties": { "value": { "type": "string", "description": "Set color for TLOC", "example": "default", "enum": [ "default", "mpls", "metro-ethernet", "biz-internet", "public-internet", "lte", "3g", "red", "green", "blue", "gold", "silver", "bronze", "custom1", "custom2", "custom3", "private1", "private2", "private3", "private4", "private5", "private6" ], "default": "default" } }, "description": "Set color for TLOC", "$$ref": "#/components/schemas/Color" } }, "description": "Tunnel interface configuration", "$$ref": "#/components/schemas/TunnelInterface" } }, "description": "Interfaces configuration", "$$ref": "#/components/schemas/TransportInterfaceSetting" } }, "ipRoute": { "type": "object", "properties": { "route": { "type": "array", "items": { "required": [ "nextHop", "prefix" ], "type": "object", "properties": { "nextHop": { "maxItems": 2147483647, "minItems": 1, "type": "array", "items": { "required": [ "address" ], "type": "object", "properties": { "address": { "pattern": "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "description": "IPv4 Address", "example": "10.0.0.1" }, "distance": { "maximum": 255, "minimum": 1, "type": "integer", "description": "Administrative distance", "format": "int32", "example": 1, "default": 1 } }, "description": "IP gateway address", "$$ref": "#/components/schemas/NextHop" } }, "prefix": { "pattern": "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\\/)([0-2]?[0-9]$|[3]?[0-2])$", "type": "string", "description": "IPv4 Prefix", "example": "0.0.0.0/0" } }, "description": "Configure static routes", "$$ref": "#/components/schemas/StaticRoute" } } }, "description": "IP Route information", "$$ref": "#/components/schemas/IpRoute" }, "ipv6Route": { "type": "object", "properties": { "route": { "type": "array", "items": { "required": [ "nextHop", "prefix" ], "type": "object", "properties": { "nextHop": { "maxItems": 2147483647, "minItems": 1, "type": "array", "items": { "required": [ "address" ], "type": "object", "properties": { "address": { "pattern": "(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))", "type": "string", "description": "IPv6 Address", "example": "2001::1" }, "distance": { "maximum": 255, "minimum": 1, "type": "integer", "description": "Administrative distance", "format": "int32", "example": 1, "default": 1 } }, "description": "IP gateway address", "$$ref": "#/components/schemas/IPV6NextHop" } }, "prefix": { "pattern": "((^\\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))(%.+)?\\s*(\\/)(\\b([0-9]{1,2}|1[01][0-9]|12[0-8])\\b)$))", "type": "string", "description": "IPv6 Prefix", "example": "2001::/4" } }, "description": "Configure IPv6 static routes", "$$ref": "#/components/schemas/Ipv6StaticRoute" } } }, "description": "IPv6 Route information", "$$ref": "#/components/schemas/Ipv6Route" } }, "description": "Transport VPN instance", "$$ref": "#/components/schemas/baseVpnInstanceTransportInterfaceSetting" } }, "description": "Manager VPN setting", "$$ref": "#/components/schemas/ManagerVpnSetting" } }, "description": "The payload for manager device specific settings", "$$ref": "#/components/schemas/ManagerDeviceSpecificSetting" } ] }, "examples": { "CreateControllerDeviceSpecificSettingsExample": { "description": "CreateControllerDeviceSpecificSettingsExample", "value": { "system": { "systemIp": "172.16.255.20", "hostName": "Controller01", "description": "Controller 1", "siteId": 200, "location": "Shang hai", "systemTunnelMtu": 2000, "gpsLocation": { "latitude": 90, "longitude": 180 }, "clock": { "timezone": "Europe/Andorra" }, "deviceGroups": [ "group1" ], "overlayId": 3, "ipv6StrictControl": true, "controllerGroupId": 1 }, "vpn": { "transport": { "ipRoute": { "route": [ { "prefix": "0.0.0.0/0", "nextHop": [ { "address": "10.0.12.13", "distance": 1 } ] } ] }, "ipv6Route": { "route": [ { "prefix": "::/0", "nextHop": [ { "address": "2001:a0:c::d" } ] } ] }, "interface": [ { "ifName": "eth0", "ip": { "address": "10.0.1.30/24" }, "ipv6": { "address": "2001:a0:1::1e/64" }, "shutdown": false }, { "ifName": "eth1", "ip": { "address": "10.0.12.20/24" }, "ipv6": { "address": "2001:a0:c::14/64" }, "tunnelInterface": { "allowService": { "all": true, "dhcp": true, "dns": true, "icmp": true, "sshd": false, "netconf": false, "ntp": false, "stun": false } }, "shutdown": false } ] }, "management": { "interface": [ { "ifName": "eth2", "ip": { "address": "10.2.2.20/24" }, "ipv6": { "address": "2001:a2:2::14/64" }, "shutdown": false } ] } } }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigControlcomponentSettingRequestExampleCreatecontrollerdevicespecificsettings" }, "CreateValidatorDeviceSpecificSettingsExample": { "description": "CreateValidatorDeviceSpecificSettingsExample", "value": { "system": { "systemIp": "172.16.255.19", "hostName": "Validator01", "description": "Validator 1", "siteId": 100, "location": "Shang hai", "gpsLocation": { "latitude": 90, "longitude": 180 }, "clock": { "timezone": "Europe/Andorra" }, "deviceGroups": [ "group1" ], "vbond": { "address": "10.0.1.26" } }, "vpn": { "transport": { "ipRoute": { "route": [ { "prefix": "0.0.0.0/0", "nextHop": [ { "address": "10.0.5.13", "distance": 1 } ] } ] }, "ipv6Route": { "route": [ { "prefix": "::/0", "nextHop": [ { "address": "2001:a0:5::d" } ] } ] }, "interface": [ { "ifName": "eth0", "ip": { "address": "10.0.1.19/24" }, "ipv6": { "address": "2001:a0:1::13/64" }, "shutdown": false }, { "ifName": "eth1", "ip": { "address": "10.0.5.19/24" }, "ipv6": { "address": "2001:a0:5::13/64" }, "shutdown": false }, { "ifName": "eth3", "ip": { "address": "10.1.15.19/24" }, "ipv6": { "address": "2001:a1:f::13/64" }, "shutdown": false } ] }, "management": { "interface": [ { "ifName": "eth2", "ip": { "address": "10.2.2.19/24" }, "ipv6": { "address": "2001:a2:2::13/64" }, "shutdown": false } ] } } }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigControlcomponentSettingRequestExampleCreatevalidatordevicespecificsettings" }, "CreateManagerDeviceSpecificSettingsExample": { "description": "CreateManagerDeviceSpecificSettingsExample", "value": { "system": { "systemIp": "172.16.255.22", "hostName": "Manager01", "clock": { "timezone": "UTC" }, "siteId": 200, "ipv6StrictControl": false }, "vpn": { "transport": { "ipRoute": { "route": [ { "prefix": "0.0.0.0/0", "nextHop": [ { "address": "10.0.12.13", "distance": 1 } ] } ] }, "interface": [ { "ifName": "eth0", "ip": { "dhcpClient": true, "dhcpDistance": 1 }, "ipv6": { "dhcpClient": true, "dhcpDistance": 1, "dhcpRapidCommit": false }, "shutdown": false }, { "ifName": "eth1", "ip": { "address": "10.0.12.22/24" }, "shutdown": false, "tunnelInterface": { "color": { "value": "default" }, "allowService": { "all": false, "dhcp": true, "dns": true, "icmp": true, "sshd": false, "netconf": false, "ntp": false, "stun": false } } }, { "ifName": "eth2", "ip": { "address": "10.0.5.22/24" }, "shutdown": false }, { "ifName": "eth5", "ip": { "address": "10.0.105.32/24" }, "shutdown": false } ] }, "management": { "interface": [ { "ifName": "eth3", "ip": { "address": "10.2.4.22/24" }, "shutdown": false } ] } } }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigControlcomponentSettingRequestExampleCreatemanagerdevicespecificsettings" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "required": [ "error" ], "type": "object", "properties": { "error": { "required": [ "code", "details", "message", "type" ], "type": "object", "properties": { "code": { "type": "string", "description": "Internal error code", "example": "CCS0018" }, "details": { "type": "string", "description": "Error message detail", "example": "Unrecognized field user1" }, "message": { "type": "string", "description": "Error message summary", "example": "Invalid control component setting payload" }, "type": { "type": "string", "description": "Error message title", "example": "error" } }, "description": "Error response", "$$ref": "#/components/schemas/ErrorDetails" } }, "$$ref": "#/components/schemas/ErrorResponse" }, "examples": { "InvalidControlComponentDeviceSpecificSettings": { "description": "InvalidControlComponentDeviceSpecificSettings", "value": { "error": { "message": "Invalid control component payload", "code": "CCS0018", "details": "vpn.transport.interfaces : required but missing; ", "type": "error" } }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigControlcomponentSettingResponseExampleCreatedevicespecificsettingsfailedresponse" } } } } }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Control Component Settings-write" }, "get": { "tags": [ "Configuration - Control Component Setting" ], "description": "Get the device-specific settings for a specific control component. The deviceId can be obtained from the \"uuid\" field in the data returned by the API (GET /dataservice/certificate/data/controller/list)", "operationId": "getControlComponentDeviceSpecificSettings", "parameters": [ { "name": "deviceId", "in": "path", "description": "Control component device UUID", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "oneOf": [ { "required": [ "createdBy", "createdOn", "payload" ], "type": "object", "properties": { "createdBy": { "type": "string", "description": "The user who created the controller device specific settings", "example": "admin" }, "createdOn": { "type": "integer", "description": "The timestamp when controller device specific settings are created", "format": "int64", "example": 1741315339238 }, "lastUpdatedBy": { "type": "string", "description": "The user who modified the controller device specific settings", "example": "admin" }, "lastUpdatedOn": { "type": "integer", "description": "The timestamp when controller device specific settings are modified", "format": "int64", "example": 1741315339240 }, "payload": { "required": [ "system", "vpn" ], "type": "object", "properties": { "system": { "required": [ "hostName", "siteId", "systemIp" ], "type": "object", "properties": { "clock": { "required": [ "timezone" ], "type": "object", "properties": { "timezone": { "type": "string", "description": "Set the timezone", "example": "UTC", "enum": [ "Europe/Andorra", "Asia/Dubai", "Asia/Kabul", "America/Antigua", "America/Anguilla", "Europe/Tirane", "Asia/Yerevan", "Africa/Luanda", "Antarctica/McMurdo", "Antarctica/Rothera", "Antarctica/Palmer", "Antarctica/Mawson", "Antarctica/Davis", "Antarctica/Casey", "Antarctica/Vostok", "Antarctica/DumontDUrville", "Antarctica/Syowa", "America/Argentina/Buenos_Aires", "America/Argentina/Cordoba", "America/Argentina/Salta", "America/Argentina/Jujuy", "America/Argentina/Tucuman", "America/Argentina/Catamarca", "America/Argentina/La_Rioja", "America/Argentina/San_Juan", "America/Argentina/Mendoza", "America/Argentina/San_Luis", "America/Argentina/Rio_Gallegos", "America/Argentina/Ushuaia", "Pacific/Pago_Pago", "Europe/Vienna", "Australia/Lord_Howe", "Antarctica/Macquarie", "Australia/Hobart", "Australia/Currie", "Australia/Melbourne", "Australia/Sydney", "Australia/Broken_Hill", "Australia/Brisbane", "Australia/Lindeman", "Australia/Adelaide", "Australia/Darwin", "Australia/Perth", "Australia/Eucla", "America/Aruba", "Europe/Mariehamn", "Asia/Baku", "Europe/Sarajevo", "America/Barbados", "Asia/Dhaka", "Europe/Brussels", "Africa/Ouagadougou", "Europe/Sofia", "Asia/Bahrain", "Africa/Bujumbura", "Africa/Porto-Novo", "America/St_Barthelemy", "Atlantic/Bermuda", "Asia/Brunei", "America/La_Paz", "America/Kralendijk", "America/Noronha", "America/Belem", "America/Fortaleza", "America/Recife", "America/Araguaina", "America/Maceio", "America/Bahia", "America/Sao_Paulo", "America/Campo_Grande", "America/Cuiaba", "America/Santarem", "America/Porto_Velho", "America/Boa_Vista", "America/Manaus", "America/Eirunepe", "America/Rio_Branco", "America/Nassau", "Asia/Thimphu", "Africa/Gaborone", "Europe/Minsk", "America/Belize", "America/St_Johns", "America/Halifax", "America/Glace_Bay", "America/Moncton", "America/Goose_Bay", "America/Blanc-Sablon", "America/Toronto", "America/Nipigon", "America/Thunder_Bay", "America/Iqaluit", "America/Pangnirtung", "America/Resolute", "America/Atikokan", "America/Rankin_Inlet", "America/Winnipeg", "America/Rainy_River", "America/Regina", "America/Swift_Current", "America/Edmonton", "America/Cambridge_Bay", "America/Yellowknife", "America/Inuvik", "America/Creston", "America/Dawson_Creek", "America/Vancouver", "America/Whitehorse", "America/Dawson", "Indian/Cocos", "Africa/Kinshasa", "Africa/Lubumbashi", "Africa/Bangui", "Africa/Brazzaville", "Europe/Zurich", "Africa/Abidjan", "Pacific/Rarotonga", "America/Santiago", "Pacific/Easter", "Africa/Douala", "Asia/Shanghai", "Asia/Harbin", "Asia/Chongqing", "Asia/Urumqi", "Asia/Kashgar", "America/Bogota", "America/Costa_Rica", "America/Havana", "Atlantic/Cape_Verde", "America/Curacao", "Indian/Christmas", "Asia/Nicosia", "Europe/Prague", "Europe/Berlin", "Europe/Busingen", "Africa/Djibouti", "Europe/Copenhagen", "America/Dominica", "America/Santo_Domingo", "Africa/Algiers", "America/Guayaquil", "Pacific/Galapagos", "Europe/Tallinn", "Africa/Cairo", "Africa/El_Aaiun", "Africa/Asmara", "Europe/Madrid", "Africa/Ceuta", "Atlantic/Canary", "Africa/Addis_Ababa", "Europe/Helsinki", "Pacific/Fiji", "Atlantic/Stanley", "Pacific/Chuuk", "Pacific/Pohnpei", "Pacific/Kosrae", "Atlantic/Faroe", "Europe/Paris", "Africa/Libreville", "Europe/London", "America/Grenada", "Asia/Tbilisi", "America/Cayenne", "Europe/Guernsey", "Africa/Accra", "Europe/Gibraltar", "America/Godthab", "America/Danmarkshavn", "America/Scoresbysund", "America/Thule", "Africa/Banjul", "Africa/Conakry", "America/Guadeloupe", "Africa/Malabo", "Europe/Athens", "Atlantic/South_Georgia", "America/Guatemala", "Pacific/Guam", "Africa/Bissau", "America/Guyana", "Asia/Hong_Kong", "America/Tegucigalpa", "Europe/Zagreb", "America/Port-au-Prince", "Europe/Budapest", "Asia/Jakarta", "Asia/Pontianak", "Asia/Makassar", "Asia/Jayapura", "Europe/Dublin", "Asia/Jerusalem", "Europe/Isle_of_Man", "Asia/Kolkata", "Indian/Chagos", "Asia/Baghdad", "Asia/Tehran", "Atlantic/Reykjavik", "Europe/Rome", "Europe/Jersey", "America/Jamaica", "Asia/Amman", "Asia/Tokyo", "Africa/Nairobi", "Asia/Bishkek", "Asia/Phnom_Penh", "Pacific/Tarawa", "Pacific/Enderbury", "Pacific/Kiritimati", "Indian/Comoro", "America/St_Kitts", "Asia/Pyongyang", "Asia/Seoul", "Asia/Kuwait", "America/Cayman", "Asia/Almaty", "Asia/Qyzylorda", "Asia/Aqtobe", "Asia/Aqtau", "Asia/Oral", "Asia/Vientiane", "Asia/Beirut", "America/St_Lucia", "Europe/Vaduz", "Asia/Colombo", "Africa/Monrovia", "Africa/Maseru", "Europe/Vilnius", "Europe/Luxembourg", "Europe/Riga", "Africa/Tripoli", "Africa/Casablanca", "Europe/Monaco", "Europe/Chisinau", "Europe/Podgorica", "America/Marigot", "Indian/Antananarivo", "Pacific/Majuro", "Pacific/Kwajalein", "Europe/Skopje", "Africa/Bamako", "Asia/Rangoon", "Asia/Ulaanbaatar", "Asia/Hovd", "Asia/Choibalsan", "Asia/Macau", "Pacific/Saipan", "America/Martinique", "Africa/Nouakchott", "America/Montserrat", "Europe/Malta", "Indian/Mauritius", "Indian/Maldives", "Africa/Blantyre", "America/Mexico_City", "America/Cancun", "America/Merida", "America/Monterrey", "America/Matamoros", "America/Mazatlan", "America/Chihuahua", "America/Ojinaga", "America/Hermosillo", "America/Tijuana", "America/Santa_Isabel", "America/Bahia_Banderas", "Asia/Kuala_Lumpur", "Asia/Kuching", "Africa/Maputo", "Africa/Windhoek", "Pacific/Noumea", "Africa/Niamey", "Pacific/Norfolk", "Africa/Lagos", "America/Managua", "Europe/Amsterdam", "Europe/Oslo", "Asia/Kathmandu", "Pacific/Nauru", "Pacific/Niue", "Pacific/Auckland", "Pacific/Chatham", "Asia/Muscat", "America/Panama", "America/Lima", "Pacific/Tahiti", "Pacific/Marquesas", "Pacific/Gambier", "Pacific/Port_Moresby", "Asia/Manila", "Asia/Karachi", "Europe/Warsaw", "America/Miquelon", "Pacific/Pitcairn", "America/Puerto_Rico", "Asia/Gaza", "Asia/Hebron", "Europe/Lisbon", "Atlantic/Madeira", "Atlantic/Azores", "Pacific/Palau", "America/Asuncion", "Asia/Qatar", "Indian/Reunion", "Europe/Bucharest", "Europe/Belgrade", "Europe/Kaliningrad", "Europe/Moscow", "Europe/Volgograd", "Europe/Samara", "Asia/Yekaterinburg", "Asia/Omsk", "Asia/Novosibirsk", "Asia/Novokuznetsk", "Asia/Krasnoyarsk", "Asia/Irkutsk", "Asia/Yakutsk", "Asia/Khandyga", "Asia/Vladivostok", "Asia/Sakhalin", "Asia/Ust-Nera", "Asia/Magadan", "Asia/Kamchatka", "Asia/Anadyr", "Africa/Kigali", "Asia/Riyadh", "Pacific/Guadalcanal", "Indian/Mahe", "Africa/Khartoum", "Europe/Stockholm", "Asia/Singapore", "Atlantic/St_Helena", "Europe/Ljubljana", "Arctic/Longyearbyen", "Europe/Bratislava", "Africa/Freetown", "Europe/San_Marino", "Africa/Dakar", "Africa/Mogadishu", "America/Paramaribo", "Africa/Juba", "Africa/Sao_Tome", "America/El_Salvador", "America/Lower_Princes", "Asia/Damascus", "Africa/Mbabane", "America/Grand_Turk", "Africa/Ndjamena", "Indian/Kerguelen", "Africa/Lome", "Asia/Bangkok", "Asia/Dushanbe", "Pacific/Fakaofo", "Asia/Dili", "Asia/Ashgabat", "Africa/Tunis", "Pacific/Tongatapu", "Europe/Istanbul", "America/Port_of_Spain", "Pacific/Funafuti", "Asia/Taipei", "Africa/Dar_es_Salaam", "Europe/Kiev", "Europe/Uzhgorod", "Europe/Zaporozhye", "Europe/Simferopol", "Africa/Kampala", "Pacific/Johnston", "Pacific/Midway", "Pacific/Wake", "America/New_York", "America/Detroit", "America/Kentucky/Louisville", "America/Kentucky/Monticello", "America/Indiana/Indianapolis", "America/Indiana/Vincennes", "America/Indiana/Winamac", "America/Indiana/Marengo", "America/Indiana/Petersburg", "America/Indiana/Vevay", "America/Chicago", "America/Indiana/Tell_City", "America/Indiana/Knox", "America/Menominee", "America/North_Dakota/Center", "America/North_Dakota/New_Salem", "America/North_Dakota/Beulah", "America/Denver", "America/Boise", "America/Phoenix", "America/Los_Angeles", "America/Anchorage", "America/Juneau", "America/Sitka", "America/Yakutat", "America/Nome", "America/Adak", "America/Metlakatla", "Pacific/Honolulu", "America/Montevideo", "Asia/Samarkand", "Asia/Tashkent", "Europe/Vatican", "America/St_Vincent", "America/Caracas", "America/Tortola", "America/St_Thomas", "Asia/Ho_Chi_Minh", "Pacific/Efate", "Pacific/Wallis", "Pacific/Apia", "Asia/Aden", "Indian/Mayotte", "Africa/Johannesburg", "Africa/Lusaka", "Africa/Harare", "UTC" ], "default": "UTC" } }, "description": "Configure clock", "$$ref": "#/components/schemas/Clock" }, "controllerGroupId": { "maximum": 100, "minimum": 0, "type": "integer", "description": "Controller group id", "format": "int32", "example": 0, "default": 0 }, "description": { "pattern": "^[^<>]{1,32}$", "type": "string", "description": "Set a text description of the device", "example": "System settings" }, "deviceGroups": { "type": "array", "description": "Configure device groups", "items": { "type": "string", "description": "Configure device groups" } }, "gpsLocation": { "required": [ "latitude", "longitude" ], "type": "object", "properties": { "latitude": { "maximum": 90, "minimum": -90, "type": "number", "description": "Set the device\u2019s physical latitude", "example": 60 }, "longitude": { "maximum": 180, "minimum": -180, "type": "number", "description": "Set the device\u2019s physical longitude", "example": 60 } }, "description": "GPS latitude and longitude of the device", "$$ref": "#/components/schemas/GpsLocation" }, "hostName": { "pattern": "^[a-zA-Z0-9\\-_]{1,32}$", "type": "string", "description": "Set the hostname", "example": "vm12" }, "ipv6StrictControl": { "type": "boolean", "description": "Sets up a strict IPv6 control connection in a dual stack IP", "example": false, "default": false }, "location": { "pattern": "^[^<>]{1,127}$", "type": "string", "description": "Set the location of the device", "example": "USA" }, "overlayId": { "maximum": 4294967295, "minimum": 1, "type": "integer", "description": "Set the Overlay ID", "format": "int64", "example": 1, "default": 1 }, "region": { "type": "object", "properties": { "regionIdList": { "maxItems": 2147483647, "minItems": 1, "uniqueItems": true, "type": "array", "items": { "maximum": 63, "minimum": 0, "type": "integer", "description": "Configure a list of region ID", "format": "int32", "example": 0 } } }, "$$ref": "#/components/schemas/Region" }, "siteId": { "maximum": 4294967295, "minimum": 0, "type": "integer", "description": "Set the site ID", "format": "int64", "example": 100 }, "systemIp": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "Set the system IP address", "example": "102.2.3.2" } }, "description": "System configuration for controller", "$$ref": "#/components/schemas/ControllerSystemSetting" }, "vpn": { "required": [ "transport" ], "type": "object", "properties": { "management": { "required": [ "interface" ], "type": "object", "properties": { "dns": { "type": "object", "properties": { "dnsServerPrimary": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "Primary DNS server IPv4 or IPv6 Address", "example": "10.2.2.2" }, "dnsServerSecondary": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "Secondary DNS server IPv4 or IPv6 Address", "example": "10.2.2.3" }, "host": { "type": "array", "items": { "required": [ "hostname", "ip" ], "type": "object", "properties": { "hostname": { "pattern": "^[a-zA-Z0-9\\-_.]{1,64}$", "type": "string", "description": "Host name", "example": "vbond" }, "ip": { "maxItems": 64, "minItems": 1, "uniqueItems": true, "type": "array", "items": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "IP Address", "example": "10.1.1.1" } } }, "description": "Static host mapping", "$$ref": "#/components/schemas/DnsHostMapping" } } }, "description": "Configure DNS servers or static host mapping", "$$ref": "#/components/schemas/ControlComponentDnsSetting" }, "interface": { "maxItems": 2147483647, "minItems": 1, "type": "array", "items": { "required": [ "ifName" ], "type": "object", "properties": { "ifName": { "pattern": "^(?=.{1,32}$)(?:(ge0\\/\\d+(?:\\.\\d+)?|loopback\\d+|eth\\d+(?:\\.\\d+)?))$", "type": "string", "description": "Interface name eth<0-..> or eth<0-..>.vlanid or loopback when present", "example": "eth0" }, "ip": { "type": "object", "properties": { "address": { "pattern": "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\\/)([0-2]?[0-9]$|[3]?[0-2])$", "type": "string", "description": "Assign IPv4 address", "example": "10.0.1.1/24" }, "dhcpClient": { "type": "boolean", "description": "Enable DHCP", "example": false, "default": false }, "dhcpDistance": { "maximum": 65536, "minimum": 1, "type": "integer", "description": "Set administrative distance for DHCP default route", "format": "int32", "example": 1, "default": 1 } }, "description": "IPv4 address or DHCP", "$$ref": "#/components/schemas/IpConfig" }, "ipv6": { "type": "object", "properties": { "address": { "pattern": "((^\\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))(%.+)?\\s*(\\/)(\\b([0-9]{1,2}|1[01][0-9]|12[0-8])\\b)$))", "type": "string", "description": "Assign IPv6 address", "example": "2001:a0:64::20/64" }, "dhcpClient": { "type": "boolean", "description": "Enable DHCP", "example": false, "default": false }, "dhcpDistance": { "maximum": 65536, "minimum": 1, "type": "integer", "description": "Set administrative distance for DHCP default route", "format": "int32", "example": 1, "default": 1 }, "dhcpRapidCommit": { "type": "boolean", "description": "Enable DHCPv6 rapid commit", "example": false, "default": false } }, "description": "IPv6 address or DHCP", "$$ref": "#/components/schemas/Ipv6Config" }, "shutdown": { "type": "boolean", "description": "Administrative state", "example": false, "default": false } }, "description": "Interfaces configuration", "$$ref": "#/components/schemas/BaseInterfaceSetting" } }, "ipRoute": { "type": "object", "properties": { "route": { "type": "array", "items": { "required": [ "nextHop", "prefix" ], "type": "object", "properties": { "nextHop": { "maxItems": 2147483647, "minItems": 1, "type": "array", "items": { "required": [ "address" ], "type": "object", "properties": { "address": { "pattern": "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "description": "IPv4 Address", "example": "10.0.0.1" }, "distance": { "maximum": 255, "minimum": 1, "type": "integer", "description": "Administrative distance", "format": "int32", "example": 1, "default": 1 } }, "description": "IP gateway address", "$$ref": "#/components/schemas/NextHop" } }, "prefix": { "pattern": "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\\/)([0-2]?[0-9]$|[3]?[0-2])$", "type": "string", "description": "IPv4 Prefix", "example": "0.0.0.0/0" } }, "description": "Configure static routes", "$$ref": "#/components/schemas/StaticRoute" } } }, "description": "IP Route information", "$$ref": "#/components/schemas/IpRoute" }, "ipv6Route": { "type": "object", "properties": { "route": { "type": "array", "items": { "required": [ "nextHop", "prefix" ], "type": "object", "properties": { "nextHop": { "maxItems": 2147483647, "minItems": 1, "type": "array", "items": { "required": [ "address" ], "type": "object", "properties": { "address": { "pattern": "(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))", "type": "string", "description": "IPv6 Address", "example": "2001::1" }, "distance": { "maximum": 255, "minimum": 1, "type": "integer", "description": "Administrative distance", "format": "int32", "example": 1, "default": 1 } }, "description": "IP gateway address", "$$ref": "#/components/schemas/IPV6NextHop" } }, "prefix": { "pattern": "((^\\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))(%.+)?\\s*(\\/)(\\b([0-9]{1,2}|1[01][0-9]|12[0-8])\\b)$))", "type": "string", "description": "IPv6 Prefix", "example": "2001::/4" } }, "description": "Configure IPv6 static routes", "$$ref": "#/components/schemas/Ipv6StaticRoute" } } }, "description": "IPv6 Route information", "$$ref": "#/components/schemas/Ipv6Route" } }, "description": "Management VPN instance", "$$ref": "#/components/schemas/baseVpnInstanceBaseInterfaceSetting" }, "transport": { "required": [ "interface" ], "type": "object", "properties": { "dns": { "type": "object", "properties": { "dnsServerPrimary": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "Primary DNS server IPv4 or IPv6 Address", "example": "10.2.2.2" }, "dnsServerSecondary": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "Secondary DNS server IPv4 or IPv6 Address", "example": "10.2.2.3" }, "host": { "type": "array", "items": { "required": [ "hostname", "ip" ], "type": "object", "properties": { "hostname": { "pattern": "^[a-zA-Z0-9\\-_.]{1,64}$", "type": "string", "description": "Host name", "example": "vbond" }, "ip": { "maxItems": 64, "minItems": 1, "uniqueItems": true, "type": "array", "items": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "IP Address", "example": "10.1.1.1" } } }, "description": "Static host mapping", "$$ref": "#/components/schemas/DnsHostMapping" } } }, "description": "Configure DNS servers or static host mapping", "$$ref": "#/components/schemas/ControlComponentDnsSetting" }, "interface": { "maxItems": 2147483647, "minItems": 1, "type": "array", "items": { "required": [ "ifName" ], "type": "object", "properties": { "ifName": { "pattern": "^(?=.{1,32}$)(?:(ge0\\/\\d+(?:\\.\\d+)?|loopback\\d+|eth\\d+(?:\\.\\d+)?))$", "type": "string", "description": "Interface name eth<0-..> or eth<0-..>.vlanid or loopback when present", "example": "eth0" }, "ip": { "type": "object", "properties": { "address": { "pattern": "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\\/)([0-2]?[0-9]$|[3]?[0-2])$", "type": "string", "description": "Assign IPv4 address", "example": "10.0.1.1/24" }, "dhcpClient": { "type": "boolean", "description": "Enable DHCP", "example": false, "default": false }, "dhcpDistance": { "maximum": 65536, "minimum": 1, "type": "integer", "description": "Set administrative distance for DHCP default route", "format": "int32", "example": 1, "default": 1 } }, "description": "IPv4 address or DHCP", "$$ref": "#/components/schemas/IpConfig" }, "ipv6": { "type": "object", "properties": { "address": { "pattern": "((^\\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))(%.+)?\\s*(\\/)(\\b([0-9]{1,2}|1[01][0-9]|12[0-8])\\b)$))", "type": "string", "description": "Assign IPv6 address", "example": "2001:a0:64::20/64" }, "dhcpClient": { "type": "boolean", "description": "Enable DHCP", "example": false, "default": false }, "dhcpDistance": { "maximum": 65536, "minimum": 1, "type": "integer", "description": "Set administrative distance for DHCP default route", "format": "int32", "example": 1, "default": 1 }, "dhcpRapidCommit": { "type": "boolean", "description": "Enable DHCPv6 rapid commit", "example": false, "default": false } }, "description": "IPv6 address or DHCP", "$$ref": "#/components/schemas/Ipv6Config" }, "shutdown": { "type": "boolean", "description": "Administrative state", "example": false, "default": false }, "tunnelInterface": { "type": "object", "properties": { "allowService": { "type": "object", "properties": { "all": { "type": "boolean", "description": "Allow all traffic. Overrides all other allow-service options if allow-service all is set", "example": false, "default": false }, "dhcp": { "type": "boolean", "description": "Allow/Deny DHCP", "example": true, "default": true }, "dns": { "type": "boolean", "description": "Allow/Deny DNS", "example": true, "default": true }, "icmp": { "type": "boolean", "description": "Allow/Deny ICMP", "example": true, "default": true }, "netconf": { "type": "boolean", "description": "Allow/Deny NETCONF", "example": false, "default": false }, "ntp": { "type": "boolean", "description": "Allow/Deny NTP", "example": false, "default": false }, "sshd": { "type": "boolean", "description": "Allow/Deny SSH", "example": false, "default": false }, "stun": { "type": "boolean", "description": "Allow/Deny STUN", "example": false, "default": false } }, "description": "Set services allowed on the WAN interface", "$$ref": "#/components/schemas/AllowService" }, "color": { "type": "object", "properties": { "value": { "type": "string", "description": "Set color for TLOC", "example": "default", "enum": [ "default", "mpls", "metro-ethernet", "biz-internet", "public-internet", "lte", "3g", "red", "green", "blue", "gold", "silver", "bronze", "custom1", "custom2", "custom3", "private1", "private2", "private3", "private4", "private5", "private6" ], "default": "default" } }, "description": "Set color for TLOC", "$$ref": "#/components/schemas/Color" } }, "description": "Tunnel interface configuration", "$$ref": "#/components/schemas/TunnelInterface" } }, "description": "Interfaces configuration", "$$ref": "#/components/schemas/TransportInterfaceSetting" } }, "ipRoute": { "type": "object", "properties": { "route": { "type": "array", "items": { "required": [ "nextHop", "prefix" ], "type": "object", "properties": { "nextHop": { "maxItems": 2147483647, "minItems": 1, "type": "array", "items": { "required": [ "address" ], "type": "object", "properties": { "address": { "pattern": "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "description": "IPv4 Address", "example": "10.0.0.1" }, "distance": { "maximum": 255, "minimum": 1, "type": "integer", "description": "Administrative distance", "format": "int32", "example": 1, "default": 1 } }, "description": "IP gateway address", "$$ref": "#/components/schemas/NextHop" } }, "prefix": { "pattern": "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\\/)([0-2]?[0-9]$|[3]?[0-2])$", "type": "string", "description": "IPv4 Prefix", "example": "0.0.0.0/0" } }, "description": "Configure static routes", "$$ref": "#/components/schemas/StaticRoute" } } }, "description": "IP Route information", "$$ref": "#/components/schemas/IpRoute" }, "ipv6Route": { "type": "object", "properties": { "route": { "type": "array", "items": { "required": [ "nextHop", "prefix" ], "type": "object", "properties": { "nextHop": { "maxItems": 2147483647, "minItems": 1, "type": "array", "items": { "required": [ "address" ], "type": "object", "properties": { "address": { "pattern": "(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))", "type": "string", "description": "IPv6 Address", "example": "2001::1" }, "distance": { "maximum": 255, "minimum": 1, "type": "integer", "description": "Administrative distance", "format": "int32", "example": 1, "default": 1 } }, "description": "IP gateway address", "$$ref": "#/components/schemas/IPV6NextHop" } }, "prefix": { "pattern": "((^\\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))(%.+)?\\s*(\\/)(\\b([0-9]{1,2}|1[01][0-9]|12[0-8])\\b)$))", "type": "string", "description": "IPv6 Prefix", "example": "2001::/4" } }, "description": "Configure IPv6 static routes", "$$ref": "#/components/schemas/Ipv6StaticRoute" } } }, "description": "IPv6 Route information", "$$ref": "#/components/schemas/Ipv6Route" } }, "description": "Transport VPN instance", "$$ref": "#/components/schemas/baseVpnInstanceTransportInterfaceSetting" } }, "description": "Controller VPN setting", "$$ref": "#/components/schemas/ControllerVpnSetting" } }, "description": "The payload for controller device specific settings", "$$ref": "#/components/schemas/ControllerDeviceSpecificSetting" } }, "$$ref": "#/components/schemas/QueryControllerDeviceSpecificSettingsResponse" }, { "required": [ "createdBy", "createdOn", "payload" ], "type": "object", "properties": { "createdBy": { "type": "string", "description": "The user who created the controller device specific settings", "example": "admin" }, "createdOn": { "type": "integer", "description": "The timestamp when controller device specific settings are created", "format": "int64", "example": 1741315339238 }, "lastUpdatedBy": { "type": "string", "description": "The user who modified the controller device specific settings", "example": "admin" }, "lastUpdatedOn": { "type": "integer", "description": "The timestamp when controller device specific settings are modified", "format": "int64", "example": 1741315339240 }, "payload": { "required": [ "system", "vpn" ], "type": "object", "properties": { "system": { "required": [ "hostName", "siteId", "systemIp" ], "type": "object", "properties": { "clock": { "required": [ "timezone" ], "type": "object", "properties": { "timezone": { "type": "string", "description": "Set the timezone", "example": "UTC", "enum": [ "Europe/Andorra", "Asia/Dubai", "Asia/Kabul", "America/Antigua", "America/Anguilla", "Europe/Tirane", "Asia/Yerevan", "Africa/Luanda", "Antarctica/McMurdo", "Antarctica/Rothera", "Antarctica/Palmer", "Antarctica/Mawson", "Antarctica/Davis", "Antarctica/Casey", "Antarctica/Vostok", "Antarctica/DumontDUrville", "Antarctica/Syowa", "America/Argentina/Buenos_Aires", "America/Argentina/Cordoba", "America/Argentina/Salta", "America/Argentina/Jujuy", "America/Argentina/Tucuman", "America/Argentina/Catamarca", "America/Argentina/La_Rioja", "America/Argentina/San_Juan", "America/Argentina/Mendoza", "America/Argentina/San_Luis", "America/Argentina/Rio_Gallegos", "America/Argentina/Ushuaia", "Pacific/Pago_Pago", "Europe/Vienna", "Australia/Lord_Howe", "Antarctica/Macquarie", "Australia/Hobart", "Australia/Currie", "Australia/Melbourne", "Australia/Sydney", "Australia/Broken_Hill", "Australia/Brisbane", "Australia/Lindeman", "Australia/Adelaide", "Australia/Darwin", "Australia/Perth", "Australia/Eucla", "America/Aruba", "Europe/Mariehamn", "Asia/Baku", "Europe/Sarajevo", "America/Barbados", "Asia/Dhaka", "Europe/Brussels", "Africa/Ouagadougou", "Europe/Sofia", "Asia/Bahrain", "Africa/Bujumbura", "Africa/Porto-Novo", "America/St_Barthelemy", "Atlantic/Bermuda", "Asia/Brunei", "America/La_Paz", "America/Kralendijk", "America/Noronha", "America/Belem", "America/Fortaleza", "America/Recife", "America/Araguaina", "America/Maceio", "America/Bahia", "America/Sao_Paulo", "America/Campo_Grande", "America/Cuiaba", "America/Santarem", "America/Porto_Velho", "America/Boa_Vista", "America/Manaus", "America/Eirunepe", "America/Rio_Branco", "America/Nassau", "Asia/Thimphu", "Africa/Gaborone", "Europe/Minsk", "America/Belize", "America/St_Johns", "America/Halifax", "America/Glace_Bay", "America/Moncton", "America/Goose_Bay", "America/Blanc-Sablon", "America/Toronto", "America/Nipigon", "America/Thunder_Bay", "America/Iqaluit", "America/Pangnirtung", "America/Resolute", "America/Atikokan", "America/Rankin_Inlet", "America/Winnipeg", "America/Rainy_River", "America/Regina", "America/Swift_Current", "America/Edmonton", "America/Cambridge_Bay", "America/Yellowknife", "America/Inuvik", "America/Creston", "America/Dawson_Creek", "America/Vancouver", "America/Whitehorse", "America/Dawson", "Indian/Cocos", "Africa/Kinshasa", "Africa/Lubumbashi", "Africa/Bangui", "Africa/Brazzaville", "Europe/Zurich", "Africa/Abidjan", "Pacific/Rarotonga", "America/Santiago", "Pacific/Easter", "Africa/Douala", "Asia/Shanghai", "Asia/Harbin", "Asia/Chongqing", "Asia/Urumqi", "Asia/Kashgar", "America/Bogota", "America/Costa_Rica", "America/Havana", "Atlantic/Cape_Verde", "America/Curacao", "Indian/Christmas", "Asia/Nicosia", "Europe/Prague", "Europe/Berlin", "Europe/Busingen", "Africa/Djibouti", "Europe/Copenhagen", "America/Dominica", "America/Santo_Domingo", "Africa/Algiers", "America/Guayaquil", "Pacific/Galapagos", "Europe/Tallinn", "Africa/Cairo", "Africa/El_Aaiun", "Africa/Asmara", "Europe/Madrid", "Africa/Ceuta", "Atlantic/Canary", "Africa/Addis_Ababa", "Europe/Helsinki", "Pacific/Fiji", "Atlantic/Stanley", "Pacific/Chuuk", "Pacific/Pohnpei", "Pacific/Kosrae", "Atlantic/Faroe", "Europe/Paris", "Africa/Libreville", "Europe/London", "America/Grenada", "Asia/Tbilisi", "America/Cayenne", "Europe/Guernsey", "Africa/Accra", "Europe/Gibraltar", "America/Godthab", "America/Danmarkshavn", "America/Scoresbysund", "America/Thule", "Africa/Banjul", "Africa/Conakry", "America/Guadeloupe", "Africa/Malabo", "Europe/Athens", "Atlantic/South_Georgia", "America/Guatemala", "Pacific/Guam", "Africa/Bissau", "America/Guyana", "Asia/Hong_Kong", "America/Tegucigalpa", "Europe/Zagreb", "America/Port-au-Prince", "Europe/Budapest", "Asia/Jakarta", "Asia/Pontianak", "Asia/Makassar", "Asia/Jayapura", "Europe/Dublin", "Asia/Jerusalem", "Europe/Isle_of_Man", "Asia/Kolkata", "Indian/Chagos", "Asia/Baghdad", "Asia/Tehran", "Atlantic/Reykjavik", "Europe/Rome", "Europe/Jersey", "America/Jamaica", "Asia/Amman", "Asia/Tokyo", "Africa/Nairobi", "Asia/Bishkek", "Asia/Phnom_Penh", "Pacific/Tarawa", "Pacific/Enderbury", "Pacific/Kiritimati", "Indian/Comoro", "America/St_Kitts", "Asia/Pyongyang", "Asia/Seoul", "Asia/Kuwait", "America/Cayman", "Asia/Almaty", "Asia/Qyzylorda", "Asia/Aqtobe", "Asia/Aqtau", "Asia/Oral", "Asia/Vientiane", "Asia/Beirut", "America/St_Lucia", "Europe/Vaduz", "Asia/Colombo", "Africa/Monrovia", "Africa/Maseru", "Europe/Vilnius", "Europe/Luxembourg", "Europe/Riga", "Africa/Tripoli", "Africa/Casablanca", "Europe/Monaco", "Europe/Chisinau", "Europe/Podgorica", "America/Marigot", "Indian/Antananarivo", "Pacific/Majuro", "Pacific/Kwajalein", "Europe/Skopje", "Africa/Bamako", "Asia/Rangoon", "Asia/Ulaanbaatar", "Asia/Hovd", "Asia/Choibalsan", "Asia/Macau", "Pacific/Saipan", "America/Martinique", "Africa/Nouakchott", "America/Montserrat", "Europe/Malta", "Indian/Mauritius", "Indian/Maldives", "Africa/Blantyre", "America/Mexico_City", "America/Cancun", "America/Merida", "America/Monterrey", "America/Matamoros", "America/Mazatlan", "America/Chihuahua", "America/Ojinaga", "America/Hermosillo", "America/Tijuana", "America/Santa_Isabel", "America/Bahia_Banderas", "Asia/Kuala_Lumpur", "Asia/Kuching", "Africa/Maputo", "Africa/Windhoek", "Pacific/Noumea", "Africa/Niamey", "Pacific/Norfolk", "Africa/Lagos", "America/Managua", "Europe/Amsterdam", "Europe/Oslo", "Asia/Kathmandu", "Pacific/Nauru", "Pacific/Niue", "Pacific/Auckland", "Pacific/Chatham", "Asia/Muscat", "America/Panama", "America/Lima", "Pacific/Tahiti", "Pacific/Marquesas", "Pacific/Gambier", "Pacific/Port_Moresby", "Asia/Manila", "Asia/Karachi", "Europe/Warsaw", "America/Miquelon", "Pacific/Pitcairn", "America/Puerto_Rico", "Asia/Gaza", "Asia/Hebron", "Europe/Lisbon", "Atlantic/Madeira", "Atlantic/Azores", "Pacific/Palau", "America/Asuncion", "Asia/Qatar", "Indian/Reunion", "Europe/Bucharest", "Europe/Belgrade", "Europe/Kaliningrad", "Europe/Moscow", "Europe/Volgograd", "Europe/Samara", "Asia/Yekaterinburg", "Asia/Omsk", "Asia/Novosibirsk", "Asia/Novokuznetsk", "Asia/Krasnoyarsk", "Asia/Irkutsk", "Asia/Yakutsk", "Asia/Khandyga", "Asia/Vladivostok", "Asia/Sakhalin", "Asia/Ust-Nera", "Asia/Magadan", "Asia/Kamchatka", "Asia/Anadyr", "Africa/Kigali", "Asia/Riyadh", "Pacific/Guadalcanal", "Indian/Mahe", "Africa/Khartoum", "Europe/Stockholm", "Asia/Singapore", "Atlantic/St_Helena", "Europe/Ljubljana", "Arctic/Longyearbyen", "Europe/Bratislava", "Africa/Freetown", "Europe/San_Marino", "Africa/Dakar", "Africa/Mogadishu", "America/Paramaribo", "Africa/Juba", "Africa/Sao_Tome", "America/El_Salvador", "America/Lower_Princes", "Asia/Damascus", "Africa/Mbabane", "America/Grand_Turk", "Africa/Ndjamena", "Indian/Kerguelen", "Africa/Lome", "Asia/Bangkok", "Asia/Dushanbe", "Pacific/Fakaofo", "Asia/Dili", "Asia/Ashgabat", "Africa/Tunis", "Pacific/Tongatapu", "Europe/Istanbul", "America/Port_of_Spain", "Pacific/Funafuti", "Asia/Taipei", "Africa/Dar_es_Salaam", "Europe/Kiev", "Europe/Uzhgorod", "Europe/Zaporozhye", "Europe/Simferopol", "Africa/Kampala", "Pacific/Johnston", "Pacific/Midway", "Pacific/Wake", "America/New_York", "America/Detroit", "America/Kentucky/Louisville", "America/Kentucky/Monticello", "America/Indiana/Indianapolis", "America/Indiana/Vincennes", "America/Indiana/Winamac", "America/Indiana/Marengo", "America/Indiana/Petersburg", "America/Indiana/Vevay", "America/Chicago", "America/Indiana/Tell_City", "America/Indiana/Knox", "America/Menominee", "America/North_Dakota/Center", "America/North_Dakota/New_Salem", "America/North_Dakota/Beulah", "America/Denver", "America/Boise", "America/Phoenix", "America/Los_Angeles", "America/Anchorage", "America/Juneau", "America/Sitka", "America/Yakutat", "America/Nome", "America/Adak", "America/Metlakatla", "Pacific/Honolulu", "America/Montevideo", "Asia/Samarkand", "Asia/Tashkent", "Europe/Vatican", "America/St_Vincent", "America/Caracas", "America/Tortola", "America/St_Thomas", "Asia/Ho_Chi_Minh", "Pacific/Efate", "Pacific/Wallis", "Pacific/Apia", "Asia/Aden", "Indian/Mayotte", "Africa/Johannesburg", "Africa/Lusaka", "Africa/Harare", "UTC" ], "default": "UTC" } }, "description": "Configure clock", "$$ref": "#/components/schemas/Clock" }, "description": { "pattern": "^[^<>]{1,32}$", "type": "string", "description": "Set a text description of the device", "example": "System settings" }, "deviceGroups": { "type": "array", "description": "Configure device groups", "items": { "type": "string", "description": "Configure device groups" } }, "gpsLocation": { "required": [ "latitude", "longitude" ], "type": "object", "properties": { "latitude": { "maximum": 90, "minimum": -90, "type": "number", "description": "Set the device\u2019s physical latitude", "example": 60 }, "longitude": { "maximum": 180, "minimum": -180, "type": "number", "description": "Set the device\u2019s physical longitude", "example": 60 } }, "description": "GPS latitude and longitude of the device", "$$ref": "#/components/schemas/GpsLocation" }, "hostName": { "pattern": "^[a-zA-Z0-9\\-_]{1,32}$", "type": "string", "description": "Set the hostname", "example": "vm12" }, "location": { "pattern": "^[^<>]{1,127}$", "type": "string", "description": "Set the location of the device", "example": "USA" }, "siteId": { "maximum": 4294967295, "minimum": 0, "type": "integer", "description": "Set the site ID", "format": "int64", "example": 100 }, "systemIp": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "Set the system IP address", "example": "102.2.3.2" }, "vbond": { "required": [ "address" ], "type": "object", "properties": { "address": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "Set the vBond IP address", "example": "10.0.12.22" } }, "$$ref": "#/components/schemas/Vbond" } }, "description": "System configuration for validator", "$$ref": "#/components/schemas/ValidatorSystemSetting" }, "vpn": { "required": [ "transport" ], "type": "object", "properties": { "management": { "required": [ "interface" ], "type": "object", "properties": { "dns": { "type": "object", "properties": { "dnsServerPrimary": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "Primary DNS server IPv4 or IPv6 Address", "example": "10.2.2.2" }, "dnsServerSecondary": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "Secondary DNS server IPv4 or IPv6 Address", "example": "10.2.2.3" }, "host": { "type": "array", "items": { "required": [ "hostname", "ip" ], "type": "object", "properties": { "hostname": { "pattern": "^[a-zA-Z0-9\\-_.]{1,64}$", "type": "string", "description": "Host name", "example": "vbond" }, "ip": { "maxItems": 64, "minItems": 1, "uniqueItems": true, "type": "array", "items": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "IP Address", "example": "10.1.1.1" } } }, "description": "Static host mapping", "$$ref": "#/components/schemas/DnsHostMapping" } } }, "description": "Configure DNS servers or static host mapping", "$$ref": "#/components/schemas/ControlComponentDnsSetting" }, "interface": { "maxItems": 2147483647, "minItems": 1, "type": "array", "items": { "required": [ "ifName" ], "type": "object", "properties": { "ifName": { "pattern": "^(?=.{1,32}$)(?:(ge0\\/\\d+(?:\\.\\d+)?|loopback\\d+|eth\\d+(?:\\.\\d+)?))$", "type": "string", "description": "Interface name eth<0-..> or eth<0-..>.vlanid or loopback when present", "example": "eth0" }, "ip": { "type": "object", "properties": { "address": { "pattern": "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\\/)([0-2]?[0-9]$|[3]?[0-2])$", "type": "string", "description": "Assign IPv4 address", "example": "10.0.1.1/24" }, "dhcpClient": { "type": "boolean", "description": "Enable DHCP", "example": false, "default": false }, "dhcpDistance": { "maximum": 65536, "minimum": 1, "type": "integer", "description": "Set administrative distance for DHCP default route", "format": "int32", "example": 1, "default": 1 } }, "description": "IPv4 address or DHCP", "$$ref": "#/components/schemas/IpConfig" }, "ipv6": { "type": "object", "properties": { "address": { "pattern": "((^\\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))(%.+)?\\s*(\\/)(\\b([0-9]{1,2}|1[01][0-9]|12[0-8])\\b)$))", "type": "string", "description": "Assign IPv6 address", "example": "2001:a0:64::20/64" }, "dhcpClient": { "type": "boolean", "description": "Enable DHCP", "example": false, "default": false }, "dhcpDistance": { "maximum": 65536, "minimum": 1, "type": "integer", "description": "Set administrative distance for DHCP default route", "format": "int32", "example": 1, "default": 1 }, "dhcpRapidCommit": { "type": "boolean", "description": "Enable DHCPv6 rapid commit", "example": false, "default": false } }, "description": "IPv6 address or DHCP", "$$ref": "#/components/schemas/Ipv6Config" }, "shutdown": { "type": "boolean", "description": "Administrative state", "example": false, "default": false } }, "description": "Interfaces configuration", "$$ref": "#/components/schemas/BaseInterfaceSetting" } }, "ipRoute": { "type": "object", "properties": { "route": { "type": "array", "items": { "required": [ "nextHop", "prefix" ], "type": "object", "properties": { "nextHop": { "maxItems": 2147483647, "minItems": 1, "type": "array", "items": { "required": [ "address" ], "type": "object", "properties": { "address": { "pattern": "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "description": "IPv4 Address", "example": "10.0.0.1" }, "distance": { "maximum": 255, "minimum": 1, "type": "integer", "description": "Administrative distance", "format": "int32", "example": 1, "default": 1 } }, "description": "IP gateway address", "$$ref": "#/components/schemas/NextHop" } }, "prefix": { "pattern": "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\\/)([0-2]?[0-9]$|[3]?[0-2])$", "type": "string", "description": "IPv4 Prefix", "example": "0.0.0.0/0" } }, "description": "Configure static routes", "$$ref": "#/components/schemas/StaticRoute" } } }, "description": "IP Route information", "$$ref": "#/components/schemas/IpRoute" }, "ipv6Route": { "type": "object", "properties": { "route": { "type": "array", "items": { "required": [ "nextHop", "prefix" ], "type": "object", "properties": { "nextHop": { "maxItems": 2147483647, "minItems": 1, "type": "array", "items": { "required": [ "address" ], "type": "object", "properties": { "address": { "pattern": "(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))", "type": "string", "description": "IPv6 Address", "example": "2001::1" }, "distance": { "maximum": 255, "minimum": 1, "type": "integer", "description": "Administrative distance", "format": "int32", "example": 1, "default": 1 } }, "description": "IP gateway address", "$$ref": "#/components/schemas/IPV6NextHop" } }, "prefix": { "pattern": "((^\\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))(%.+)?\\s*(\\/)(\\b([0-9]{1,2}|1[01][0-9]|12[0-8])\\b)$))", "type": "string", "description": "IPv6 Prefix", "example": "2001::/4" } }, "description": "Configure IPv6 static routes", "$$ref": "#/components/schemas/Ipv6StaticRoute" } } }, "description": "IPv6 Route information", "$$ref": "#/components/schemas/Ipv6Route" } }, "description": "Management VPN instance", "$$ref": "#/components/schemas/baseVpnInstanceBaseInterfaceSetting" }, "transport": { "required": [ "interface" ], "type": "object", "properties": { "dns": { "type": "object", "properties": { "dnsServerPrimary": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "Primary DNS server IPv4 or IPv6 Address", "example": "10.2.2.2" }, "dnsServerSecondary": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "Secondary DNS server IPv4 or IPv6 Address", "example": "10.2.2.3" }, "host": { "type": "array", "items": { "required": [ "hostname", "ip" ], "type": "object", "properties": { "hostname": { "pattern": "^[a-zA-Z0-9\\-_.]{1,64}$", "type": "string", "description": "Host name", "example": "vbond" }, "ip": { "maxItems": 64, "minItems": 1, "uniqueItems": true, "type": "array", "items": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "IP Address", "example": "10.1.1.1" } } }, "description": "Static host mapping", "$$ref": "#/components/schemas/DnsHostMapping" } } }, "description": "Configure DNS servers or static host mapping", "$$ref": "#/components/schemas/ControlComponentDnsSetting" }, "interface": { "maxItems": 2147483647, "minItems": 1, "type": "array", "items": { "required": [ "ifName" ], "type": "object", "properties": { "ifName": { "pattern": "^(?=.{1,32}$)(?:(ge0\\/\\d+(?:\\.\\d+)?|loopback\\d+|eth\\d+(?:\\.\\d+)?))$", "type": "string", "description": "Interface name eth<0-..> or eth<0-..>.vlanid or loopback when present", "example": "eth0" }, "ip": { "type": "object", "properties": { "address": { "pattern": "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\\/)([0-2]?[0-9]$|[3]?[0-2])$", "type": "string", "description": "Assign IPv4 address", "example": "10.0.1.1/24" }, "dhcpClient": { "type": "boolean", "description": "Enable DHCP", "example": false, "default": false }, "dhcpDistance": { "maximum": 65536, "minimum": 1, "type": "integer", "description": "Set administrative distance for DHCP default route", "format": "int32", "example": 1, "default": 1 } }, "description": "IPv4 address or DHCP", "$$ref": "#/components/schemas/IpConfig" }, "ipv6": { "type": "object", "properties": { "address": { "pattern": "((^\\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))(%.+)?\\s*(\\/)(\\b([0-9]{1,2}|1[01][0-9]|12[0-8])\\b)$))", "type": "string", "description": "Assign IPv6 address", "example": "2001:a0:64::20/64" }, "dhcpClient": { "type": "boolean", "description": "Enable DHCP", "example": false, "default": false }, "dhcpDistance": { "maximum": 65536, "minimum": 1, "type": "integer", "description": "Set administrative distance for DHCP default route", "format": "int32", "example": 1, "default": 1 }, "dhcpRapidCommit": { "type": "boolean", "description": "Enable DHCPv6 rapid commit", "example": false, "default": false } }, "description": "IPv6 address or DHCP", "$$ref": "#/components/schemas/Ipv6Config" }, "shutdown": { "type": "boolean", "description": "Administrative state", "example": false, "default": false }, "tunnelInterface": { "type": "object", "properties": { "allowService": { "type": "object", "properties": { "all": { "type": "boolean", "description": "Allow all traffic. Overrides all other allow-service options if allow-service all is set", "example": false, "default": false }, "dhcp": { "type": "boolean", "description": "Allow/Deny DHCP", "example": true, "default": true }, "dns": { "type": "boolean", "description": "Allow/Deny DNS", "example": true, "default": true }, "icmp": { "type": "boolean", "description": "Allow/Deny ICMP", "example": true, "default": true }, "netconf": { "type": "boolean", "description": "Allow/Deny NETCONF", "example": false, "default": false }, "ntp": { "type": "boolean", "description": "Allow/Deny NTP", "example": false, "default": false }, "sshd": { "type": "boolean", "description": "Allow/Deny SSH", "example": false, "default": false }, "stun": { "type": "boolean", "description": "Allow/Deny STUN", "example": false, "default": false } }, "description": "Set services allowed on the WAN interface", "$$ref": "#/components/schemas/AllowService" }, "color": { "type": "object", "properties": { "value": { "type": "string", "description": "Set color for TLOC", "example": "default", "enum": [ "default", "mpls", "metro-ethernet", "biz-internet", "public-internet", "lte", "3g", "red", "green", "blue", "gold", "silver", "bronze", "custom1", "custom2", "custom3", "private1", "private2", "private3", "private4", "private5", "private6" ], "default": "default" } }, "description": "Set color for TLOC", "$$ref": "#/components/schemas/Color" } }, "description": "Tunnel interface configuration", "$$ref": "#/components/schemas/TunnelInterface" } }, "description": "Interfaces configuration", "$$ref": "#/components/schemas/TransportInterfaceSetting" } }, "ipRoute": { "type": "object", "properties": { "route": { "type": "array", "items": { "required": [ "nextHop", "prefix" ], "type": "object", "properties": { "nextHop": { "maxItems": 2147483647, "minItems": 1, "type": "array", "items": { "required": [ "address" ], "type": "object", "properties": { "address": { "pattern": "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "description": "IPv4 Address", "example": "10.0.0.1" }, "distance": { "maximum": 255, "minimum": 1, "type": "integer", "description": "Administrative distance", "format": "int32", "example": 1, "default": 1 } }, "description": "IP gateway address", "$$ref": "#/components/schemas/NextHop" } }, "prefix": { "pattern": "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\\/)([0-2]?[0-9]$|[3]?[0-2])$", "type": "string", "description": "IPv4 Prefix", "example": "0.0.0.0/0" } }, "description": "Configure static routes", "$$ref": "#/components/schemas/StaticRoute" } } }, "description": "IP Route information", "$$ref": "#/components/schemas/IpRoute" }, "ipv6Route": { "type": "object", "properties": { "route": { "type": "array", "items": { "required": [ "nextHop", "prefix" ], "type": "object", "properties": { "nextHop": { "maxItems": 2147483647, "minItems": 1, "type": "array", "items": { "required": [ "address" ], "type": "object", "properties": { "address": { "pattern": "(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))", "type": "string", "description": "IPv6 Address", "example": "2001::1" }, "distance": { "maximum": 255, "minimum": 1, "type": "integer", "description": "Administrative distance", "format": "int32", "example": 1, "default": 1 } }, "description": "IP gateway address", "$$ref": "#/components/schemas/IPV6NextHop" } }, "prefix": { "pattern": "((^\\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))(%.+)?\\s*(\\/)(\\b([0-9]{1,2}|1[01][0-9]|12[0-8])\\b)$))", "type": "string", "description": "IPv6 Prefix", "example": "2001::/4" } }, "description": "Configure IPv6 static routes", "$$ref": "#/components/schemas/Ipv6StaticRoute" } } }, "description": "IPv6 Route information", "$$ref": "#/components/schemas/Ipv6Route" } }, "description": "Transport VPN instance", "$$ref": "#/components/schemas/baseVpnInstanceTransportInterfaceSetting" } }, "description": "Validator VPN setting", "$$ref": "#/components/schemas/ValidatorVpnSetting" } }, "description": "The payload for validator device specific settings", "$$ref": "#/components/schemas/ValidatorDeviceSpecificSetting" } }, "$$ref": "#/components/schemas/QueryValidatorDeviceSpecificSettingsResponse" }, { "required": [ "createdBy", "createdOn", "payload" ], "type": "object", "properties": { "createdBy": { "type": "string", "description": "The user who created the controller device specific settings", "example": "admin" }, "createdOn": { "type": "integer", "description": "The timestamp when controller device specific settings are created", "format": "int64", "example": 1741315339238 }, "lastUpdatedBy": { "type": "string", "description": "The user who modified the controller device specific settings", "example": "admin" }, "lastUpdatedOn": { "type": "integer", "description": "The timestamp when controller device specific settings are modified", "format": "int64", "example": 1741315339240 }, "payload": { "required": [ "system", "vpn" ], "type": "object", "properties": { "system": { "required": [ "hostName", "siteId", "systemIp" ], "type": "object", "properties": { "clock": { "required": [ "timezone" ], "type": "object", "properties": { "timezone": { "type": "string", "description": "Set the timezone", "example": "UTC", "enum": [ "Europe/Andorra", "Asia/Dubai", "Asia/Kabul", "America/Antigua", "America/Anguilla", "Europe/Tirane", "Asia/Yerevan", "Africa/Luanda", "Antarctica/McMurdo", "Antarctica/Rothera", "Antarctica/Palmer", "Antarctica/Mawson", "Antarctica/Davis", "Antarctica/Casey", "Antarctica/Vostok", "Antarctica/DumontDUrville", "Antarctica/Syowa", "America/Argentina/Buenos_Aires", "America/Argentina/Cordoba", "America/Argentina/Salta", "America/Argentina/Jujuy", "America/Argentina/Tucuman", "America/Argentina/Catamarca", "America/Argentina/La_Rioja", "America/Argentina/San_Juan", "America/Argentina/Mendoza", "America/Argentina/San_Luis", "America/Argentina/Rio_Gallegos", "America/Argentina/Ushuaia", "Pacific/Pago_Pago", "Europe/Vienna", "Australia/Lord_Howe", "Antarctica/Macquarie", "Australia/Hobart", "Australia/Currie", "Australia/Melbourne", "Australia/Sydney", "Australia/Broken_Hill", "Australia/Brisbane", "Australia/Lindeman", "Australia/Adelaide", "Australia/Darwin", "Australia/Perth", "Australia/Eucla", "America/Aruba", "Europe/Mariehamn", "Asia/Baku", "Europe/Sarajevo", "America/Barbados", "Asia/Dhaka", "Europe/Brussels", "Africa/Ouagadougou", "Europe/Sofia", "Asia/Bahrain", "Africa/Bujumbura", "Africa/Porto-Novo", "America/St_Barthelemy", "Atlantic/Bermuda", "Asia/Brunei", "America/La_Paz", "America/Kralendijk", "America/Noronha", "America/Belem", "America/Fortaleza", "America/Recife", "America/Araguaina", "America/Maceio", "America/Bahia", "America/Sao_Paulo", "America/Campo_Grande", "America/Cuiaba", "America/Santarem", "America/Porto_Velho", "America/Boa_Vista", "America/Manaus", "America/Eirunepe", "America/Rio_Branco", "America/Nassau", "Asia/Thimphu", "Africa/Gaborone", "Europe/Minsk", "America/Belize", "America/St_Johns", "America/Halifax", "America/Glace_Bay", "America/Moncton", "America/Goose_Bay", "America/Blanc-Sablon", "America/Toronto", "America/Nipigon", "America/Thunder_Bay", "America/Iqaluit", "America/Pangnirtung", "America/Resolute", "America/Atikokan", "America/Rankin_Inlet", "America/Winnipeg", "America/Rainy_River", "America/Regina", "America/Swift_Current", "America/Edmonton", "America/Cambridge_Bay", "America/Yellowknife", "America/Inuvik", "America/Creston", "America/Dawson_Creek", "America/Vancouver", "America/Whitehorse", "America/Dawson", "Indian/Cocos", "Africa/Kinshasa", "Africa/Lubumbashi", "Africa/Bangui", "Africa/Brazzaville", "Europe/Zurich", "Africa/Abidjan", "Pacific/Rarotonga", "America/Santiago", "Pacific/Easter", "Africa/Douala", "Asia/Shanghai", "Asia/Harbin", "Asia/Chongqing", "Asia/Urumqi", "Asia/Kashgar", "America/Bogota", "America/Costa_Rica", "America/Havana", "Atlantic/Cape_Verde", "America/Curacao", "Indian/Christmas", "Asia/Nicosia", "Europe/Prague", "Europe/Berlin", "Europe/Busingen", "Africa/Djibouti", "Europe/Copenhagen", "America/Dominica", "America/Santo_Domingo", "Africa/Algiers", "America/Guayaquil", "Pacific/Galapagos", "Europe/Tallinn", "Africa/Cairo", "Africa/El_Aaiun", "Africa/Asmara", "Europe/Madrid", "Africa/Ceuta", "Atlantic/Canary", "Africa/Addis_Ababa", "Europe/Helsinki", "Pacific/Fiji", "Atlantic/Stanley", "Pacific/Chuuk", "Pacific/Pohnpei", "Pacific/Kosrae", "Atlantic/Faroe", "Europe/Paris", "Africa/Libreville", "Europe/London", "America/Grenada", "Asia/Tbilisi", "America/Cayenne", "Europe/Guernsey", "Africa/Accra", "Europe/Gibraltar", "America/Godthab", "America/Danmarkshavn", "America/Scoresbysund", "America/Thule", "Africa/Banjul", "Africa/Conakry", "America/Guadeloupe", "Africa/Malabo", "Europe/Athens", "Atlantic/South_Georgia", "America/Guatemala", "Pacific/Guam", "Africa/Bissau", "America/Guyana", "Asia/Hong_Kong", "America/Tegucigalpa", "Europe/Zagreb", "America/Port-au-Prince", "Europe/Budapest", "Asia/Jakarta", "Asia/Pontianak", "Asia/Makassar", "Asia/Jayapura", "Europe/Dublin", "Asia/Jerusalem", "Europe/Isle_of_Man", "Asia/Kolkata", "Indian/Chagos", "Asia/Baghdad", "Asia/Tehran", "Atlantic/Reykjavik", "Europe/Rome", "Europe/Jersey", "America/Jamaica", "Asia/Amman", "Asia/Tokyo", "Africa/Nairobi", "Asia/Bishkek", "Asia/Phnom_Penh", "Pacific/Tarawa", "Pacific/Enderbury", "Pacific/Kiritimati", "Indian/Comoro", "America/St_Kitts", "Asia/Pyongyang", "Asia/Seoul", "Asia/Kuwait", "America/Cayman", "Asia/Almaty", "Asia/Qyzylorda", "Asia/Aqtobe", "Asia/Aqtau", "Asia/Oral", "Asia/Vientiane", "Asia/Beirut", "America/St_Lucia", "Europe/Vaduz", "Asia/Colombo", "Africa/Monrovia", "Africa/Maseru", "Europe/Vilnius", "Europe/Luxembourg", "Europe/Riga", "Africa/Tripoli", "Africa/Casablanca", "Europe/Monaco", "Europe/Chisinau", "Europe/Podgorica", "America/Marigot", "Indian/Antananarivo", "Pacific/Majuro", "Pacific/Kwajalein", "Europe/Skopje", "Africa/Bamako", "Asia/Rangoon", "Asia/Ulaanbaatar", "Asia/Hovd", "Asia/Choibalsan", "Asia/Macau", "Pacific/Saipan", "America/Martinique", "Africa/Nouakchott", "America/Montserrat", "Europe/Malta", "Indian/Mauritius", "Indian/Maldives", "Africa/Blantyre", "America/Mexico_City", "America/Cancun", "America/Merida", "America/Monterrey", "America/Matamoros", "America/Mazatlan", "America/Chihuahua", "America/Ojinaga", "America/Hermosillo", "America/Tijuana", "America/Santa_Isabel", "America/Bahia_Banderas", "Asia/Kuala_Lumpur", "Asia/Kuching", "Africa/Maputo", "Africa/Windhoek", "Pacific/Noumea", "Africa/Niamey", "Pacific/Norfolk", "Africa/Lagos", "America/Managua", "Europe/Amsterdam", "Europe/Oslo", "Asia/Kathmandu", "Pacific/Nauru", "Pacific/Niue", "Pacific/Auckland", "Pacific/Chatham", "Asia/Muscat", "America/Panama", "America/Lima", "Pacific/Tahiti", "Pacific/Marquesas", "Pacific/Gambier", "Pacific/Port_Moresby", "Asia/Manila", "Asia/Karachi", "Europe/Warsaw", "America/Miquelon", "Pacific/Pitcairn", "America/Puerto_Rico", "Asia/Gaza", "Asia/Hebron", "Europe/Lisbon", "Atlantic/Madeira", "Atlantic/Azores", "Pacific/Palau", "America/Asuncion", "Asia/Qatar", "Indian/Reunion", "Europe/Bucharest", "Europe/Belgrade", "Europe/Kaliningrad", "Europe/Moscow", "Europe/Volgograd", "Europe/Samara", "Asia/Yekaterinburg", "Asia/Omsk", "Asia/Novosibirsk", "Asia/Novokuznetsk", "Asia/Krasnoyarsk", "Asia/Irkutsk", "Asia/Yakutsk", "Asia/Khandyga", "Asia/Vladivostok", "Asia/Sakhalin", "Asia/Ust-Nera", "Asia/Magadan", "Asia/Kamchatka", "Asia/Anadyr", "Africa/Kigali", "Asia/Riyadh", "Pacific/Guadalcanal", "Indian/Mahe", "Africa/Khartoum", "Europe/Stockholm", "Asia/Singapore", "Atlantic/St_Helena", "Europe/Ljubljana", "Arctic/Longyearbyen", "Europe/Bratislava", "Africa/Freetown", "Europe/San_Marino", "Africa/Dakar", "Africa/Mogadishu", "America/Paramaribo", "Africa/Juba", "Africa/Sao_Tome", "America/El_Salvador", "America/Lower_Princes", "Asia/Damascus", "Africa/Mbabane", "America/Grand_Turk", "Africa/Ndjamena", "Indian/Kerguelen", "Africa/Lome", "Asia/Bangkok", "Asia/Dushanbe", "Pacific/Fakaofo", "Asia/Dili", "Asia/Ashgabat", "Africa/Tunis", "Pacific/Tongatapu", "Europe/Istanbul", "America/Port_of_Spain", "Pacific/Funafuti", "Asia/Taipei", "Africa/Dar_es_Salaam", "Europe/Kiev", "Europe/Uzhgorod", "Europe/Zaporozhye", "Europe/Simferopol", "Africa/Kampala", "Pacific/Johnston", "Pacific/Midway", "Pacific/Wake", "America/New_York", "America/Detroit", "America/Kentucky/Louisville", "America/Kentucky/Monticello", "America/Indiana/Indianapolis", "America/Indiana/Vincennes", "America/Indiana/Winamac", "America/Indiana/Marengo", "America/Indiana/Petersburg", "America/Indiana/Vevay", "America/Chicago", "America/Indiana/Tell_City", "America/Indiana/Knox", "America/Menominee", "America/North_Dakota/Center", "America/North_Dakota/New_Salem", "America/North_Dakota/Beulah", "America/Denver", "America/Boise", "America/Phoenix", "America/Los_Angeles", "America/Anchorage", "America/Juneau", "America/Sitka", "America/Yakutat", "America/Nome", "America/Adak", "America/Metlakatla", "Pacific/Honolulu", "America/Montevideo", "Asia/Samarkand", "Asia/Tashkent", "Europe/Vatican", "America/St_Vincent", "America/Caracas", "America/Tortola", "America/St_Thomas", "Asia/Ho_Chi_Minh", "Pacific/Efate", "Pacific/Wallis", "Pacific/Apia", "Asia/Aden", "Indian/Mayotte", "Africa/Johannesburg", "Africa/Lusaka", "Africa/Harare", "UTC" ], "default": "UTC" } }, "description": "Configure clock", "$$ref": "#/components/schemas/Clock" }, "description": { "pattern": "^[^<>]{1,32}$", "type": "string", "description": "Set a text description of the device", "example": "System settings" }, "deviceGroups": { "type": "array", "description": "Configure device groups", "items": { "type": "string", "description": "Configure device groups" } }, "gpsLocation": { "required": [ "latitude", "longitude" ], "type": "object", "properties": { "latitude": { "maximum": 90, "minimum": -90, "type": "number", "description": "Set the device\u2019s physical latitude", "example": 60 }, "longitude": { "maximum": 180, "minimum": -180, "type": "number", "description": "Set the device\u2019s physical longitude", "example": 60 } }, "description": "GPS latitude and longitude of the device", "$$ref": "#/components/schemas/GpsLocation" }, "hostName": { "pattern": "^[a-zA-Z0-9\\-_]{1,32}$", "type": "string", "description": "Set the hostname", "example": "vm12" }, "ipv6StrictControl": { "type": "boolean", "description": "Enable Dual Stack IPv6 Default", "example": false, "default": false }, "location": { "pattern": "^[^<>]{1,127}$", "type": "string", "description": "Set the location of the device", "example": "USA" }, "siteId": { "maximum": 4294967295, "minimum": 0, "type": "integer", "description": "Set the site ID", "format": "int64", "example": 100 }, "systemIp": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "Set the system IP address", "example": "102.2.3.2" } }, "description": "System configuration for manager", "$$ref": "#/components/schemas/ManagerSystemSetting" }, "vpn": { "required": [ "transport" ], "type": "object", "properties": { "management": { "required": [ "interface" ], "type": "object", "properties": { "dns": { "type": "object", "properties": { "dnsServerPrimary": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "Primary DNS server IPv4 or IPv6 Address", "example": "10.2.2.2" }, "dnsServerSecondary": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "Secondary DNS server IPv4 or IPv6 Address", "example": "10.2.2.3" }, "host": { "type": "array", "items": { "required": [ "hostname", "ip" ], "type": "object", "properties": { "hostname": { "pattern": "^[a-zA-Z0-9\\-_.]{1,64}$", "type": "string", "description": "Host name", "example": "vbond" }, "ip": { "maxItems": 64, "minItems": 1, "uniqueItems": true, "type": "array", "items": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "IP Address", "example": "10.1.1.1" } } }, "description": "Static host mapping", "$$ref": "#/components/schemas/DnsHostMapping" } } }, "description": "Configure DNS servers or static host mapping", "$$ref": "#/components/schemas/ControlComponentDnsSetting" }, "interface": { "maxItems": 2147483647, "minItems": 1, "type": "array", "items": { "required": [ "ifName" ], "type": "object", "properties": { "ifName": { "pattern": "^(?=.{1,32}$)(?:(ge0\\/\\d+(?:\\.\\d+)?|loopback\\d+|eth\\d+(?:\\.\\d+)?))$", "type": "string", "description": "Interface name eth<0-..> or eth<0-..>.vlanid or loopback when present", "example": "eth0" }, "ip": { "type": "object", "properties": { "address": { "pattern": "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\\/)([0-2]?[0-9]$|[3]?[0-2])$", "type": "string", "description": "Assign IPv4 address", "example": "10.0.1.1/24" }, "dhcpClient": { "type": "boolean", "description": "Enable DHCP", "example": false, "default": false }, "dhcpDistance": { "maximum": 65536, "minimum": 1, "type": "integer", "description": "Set administrative distance for DHCP default route", "format": "int32", "example": 1, "default": 1 } }, "description": "IPv4 address or DHCP", "$$ref": "#/components/schemas/IpConfig" }, "ipv6": { "type": "object", "properties": { "address": { "pattern": "((^\\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))(%.+)?\\s*(\\/)(\\b([0-9]{1,2}|1[01][0-9]|12[0-8])\\b)$))", "type": "string", "description": "Assign IPv6 address", "example": "2001:a0:64::20/64" }, "dhcpClient": { "type": "boolean", "description": "Enable DHCP", "example": false, "default": false }, "dhcpDistance": { "maximum": 65536, "minimum": 1, "type": "integer", "description": "Set administrative distance for DHCP default route", "format": "int32", "example": 1, "default": 1 }, "dhcpRapidCommit": { "type": "boolean", "description": "Enable DHCPv6 rapid commit", "example": false, "default": false } }, "description": "IPv6 address or DHCP", "$$ref": "#/components/schemas/Ipv6Config" }, "shutdown": { "type": "boolean", "description": "Administrative state", "example": false, "default": false } }, "description": "Interfaces configuration", "$$ref": "#/components/schemas/BaseInterfaceSetting" } }, "ipRoute": { "type": "object", "properties": { "route": { "type": "array", "items": { "required": [ "nextHop", "prefix" ], "type": "object", "properties": { "nextHop": { "maxItems": 2147483647, "minItems": 1, "type": "array", "items": { "required": [ "address" ], "type": "object", "properties": { "address": { "pattern": "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "description": "IPv4 Address", "example": "10.0.0.1" }, "distance": { "maximum": 255, "minimum": 1, "type": "integer", "description": "Administrative distance", "format": "int32", "example": 1, "default": 1 } }, "description": "IP gateway address", "$$ref": "#/components/schemas/NextHop" } }, "prefix": { "pattern": "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\\/)([0-2]?[0-9]$|[3]?[0-2])$", "type": "string", "description": "IPv4 Prefix", "example": "0.0.0.0/0" } }, "description": "Configure static routes", "$$ref": "#/components/schemas/StaticRoute" } } }, "description": "IP Route information", "$$ref": "#/components/schemas/IpRoute" }, "ipv6Route": { "type": "object", "properties": { "route": { "type": "array", "items": { "required": [ "nextHop", "prefix" ], "type": "object", "properties": { "nextHop": { "maxItems": 2147483647, "minItems": 1, "type": "array", "items": { "required": [ "address" ], "type": "object", "properties": { "address": { "pattern": "(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))", "type": "string", "description": "IPv6 Address", "example": "2001::1" }, "distance": { "maximum": 255, "minimum": 1, "type": "integer", "description": "Administrative distance", "format": "int32", "example": 1, "default": 1 } }, "description": "IP gateway address", "$$ref": "#/components/schemas/IPV6NextHop" } }, "prefix": { "pattern": "((^\\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))(%.+)?\\s*(\\/)(\\b([0-9]{1,2}|1[01][0-9]|12[0-8])\\b)$))", "type": "string", "description": "IPv6 Prefix", "example": "2001::/4" } }, "description": "Configure IPv6 static routes", "$$ref": "#/components/schemas/Ipv6StaticRoute" } } }, "description": "IPv6 Route information", "$$ref": "#/components/schemas/Ipv6Route" } }, "description": "Management VPN instance", "$$ref": "#/components/schemas/baseVpnInstanceBaseInterfaceSetting" }, "transport": { "required": [ "interface" ], "type": "object", "properties": { "dns": { "type": "object", "properties": { "dnsServerPrimary": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "Primary DNS server IPv4 or IPv6 Address", "example": "10.2.2.2" }, "dnsServerSecondary": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "Secondary DNS server IPv4 or IPv6 Address", "example": "10.2.2.3" }, "host": { "type": "array", "items": { "required": [ "hostname", "ip" ], "type": "object", "properties": { "hostname": { "pattern": "^[a-zA-Z0-9\\-_.]{1,64}$", "type": "string", "description": "Host name", "example": "vbond" }, "ip": { "maxItems": 64, "minItems": 1, "uniqueItems": true, "type": "array", "items": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "IP Address", "example": "10.1.1.1" } } }, "description": "Static host mapping", "$$ref": "#/components/schemas/DnsHostMapping" } } }, "description": "Configure DNS servers or static host mapping", "$$ref": "#/components/schemas/ControlComponentDnsSetting" }, "interface": { "maxItems": 2147483647, "minItems": 1, "type": "array", "items": { "required": [ "ifName" ], "type": "object", "properties": { "ifName": { "pattern": "^(?=.{1,32}$)(?:(ge0\\/\\d+(?:\\.\\d+)?|loopback\\d+|eth\\d+(?:\\.\\d+)?))$", "type": "string", "description": "Interface name eth<0-..> or eth<0-..>.vlanid or loopback when present", "example": "eth0" }, "ip": { "type": "object", "properties": { "address": { "pattern": "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\\/)([0-2]?[0-9]$|[3]?[0-2])$", "type": "string", "description": "Assign IPv4 address", "example": "10.0.1.1/24" }, "dhcpClient": { "type": "boolean", "description": "Enable DHCP", "example": false, "default": false }, "dhcpDistance": { "maximum": 65536, "minimum": 1, "type": "integer", "description": "Set administrative distance for DHCP default route", "format": "int32", "example": 1, "default": 1 } }, "description": "IPv4 address or DHCP", "$$ref": "#/components/schemas/IpConfig" }, "ipv6": { "type": "object", "properties": { "address": { "pattern": "((^\\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))(%.+)?\\s*(\\/)(\\b([0-9]{1,2}|1[01][0-9]|12[0-8])\\b)$))", "type": "string", "description": "Assign IPv6 address", "example": "2001:a0:64::20/64" }, "dhcpClient": { "type": "boolean", "description": "Enable DHCP", "example": false, "default": false }, "dhcpDistance": { "maximum": 65536, "minimum": 1, "type": "integer", "description": "Set administrative distance for DHCP default route", "format": "int32", "example": 1, "default": 1 }, "dhcpRapidCommit": { "type": "boolean", "description": "Enable DHCPv6 rapid commit", "example": false, "default": false } }, "description": "IPv6 address or DHCP", "$$ref": "#/components/schemas/Ipv6Config" }, "shutdown": { "type": "boolean", "description": "Administrative state", "example": false, "default": false }, "tunnelInterface": { "type": "object", "properties": { "allowService": { "type": "object", "properties": { "all": { "type": "boolean", "description": "Allow all traffic. Overrides all other allow-service options if allow-service all is set", "example": false, "default": false }, "dhcp": { "type": "boolean", "description": "Allow/Deny DHCP", "example": true, "default": true }, "dns": { "type": "boolean", "description": "Allow/Deny DNS", "example": true, "default": true }, "icmp": { "type": "boolean", "description": "Allow/Deny ICMP", "example": true, "default": true }, "netconf": { "type": "boolean", "description": "Allow/Deny NETCONF", "example": false, "default": false }, "ntp": { "type": "boolean", "description": "Allow/Deny NTP", "example": false, "default": false }, "sshd": { "type": "boolean", "description": "Allow/Deny SSH", "example": false, "default": false }, "stun": { "type": "boolean", "description": "Allow/Deny STUN", "example": false, "default": false } }, "description": "Set services allowed on the WAN interface", "$$ref": "#/components/schemas/AllowService" }, "color": { "type": "object", "properties": { "value": { "type": "string", "description": "Set color for TLOC", "example": "default", "enum": [ "default", "mpls", "metro-ethernet", "biz-internet", "public-internet", "lte", "3g", "red", "green", "blue", "gold", "silver", "bronze", "custom1", "custom2", "custom3", "private1", "private2", "private3", "private4", "private5", "private6" ], "default": "default" } }, "description": "Set color for TLOC", "$$ref": "#/components/schemas/Color" } }, "description": "Tunnel interface configuration", "$$ref": "#/components/schemas/TunnelInterface" } }, "description": "Interfaces configuration", "$$ref": "#/components/schemas/TransportInterfaceSetting" } }, "ipRoute": { "type": "object", "properties": { "route": { "type": "array", "items": { "required": [ "nextHop", "prefix" ], "type": "object", "properties": { "nextHop": { "maxItems": 2147483647, "minItems": 1, "type": "array", "items": { "required": [ "address" ], "type": "object", "properties": { "address": { "pattern": "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "description": "IPv4 Address", "example": "10.0.0.1" }, "distance": { "maximum": 255, "minimum": 1, "type": "integer", "description": "Administrative distance", "format": "int32", "example": 1, "default": 1 } }, "description": "IP gateway address", "$$ref": "#/components/schemas/NextHop" } }, "prefix": { "pattern": "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\\/)([0-2]?[0-9]$|[3]?[0-2])$", "type": "string", "description": "IPv4 Prefix", "example": "0.0.0.0/0" } }, "description": "Configure static routes", "$$ref": "#/components/schemas/StaticRoute" } } }, "description": "IP Route information", "$$ref": "#/components/schemas/IpRoute" }, "ipv6Route": { "type": "object", "properties": { "route": { "type": "array", "items": { "required": [ "nextHop", "prefix" ], "type": "object", "properties": { "nextHop": { "maxItems": 2147483647, "minItems": 1, "type": "array", "items": { "required": [ "address" ], "type": "object", "properties": { "address": { "pattern": "(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))", "type": "string", "description": "IPv6 Address", "example": "2001::1" }, "distance": { "maximum": 255, "minimum": 1, "type": "integer", "description": "Administrative distance", "format": "int32", "example": 1, "default": 1 } }, "description": "IP gateway address", "$$ref": "#/components/schemas/IPV6NextHop" } }, "prefix": { "pattern": "((^\\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))(%.+)?\\s*(\\/)(\\b([0-9]{1,2}|1[01][0-9]|12[0-8])\\b)$))", "type": "string", "description": "IPv6 Prefix", "example": "2001::/4" } }, "description": "Configure IPv6 static routes", "$$ref": "#/components/schemas/Ipv6StaticRoute" } } }, "description": "IPv6 Route information", "$$ref": "#/components/schemas/Ipv6Route" } }, "description": "Transport VPN instance", "$$ref": "#/components/schemas/baseVpnInstanceTransportInterfaceSetting" } }, "description": "Manager VPN setting", "$$ref": "#/components/schemas/ManagerVpnSetting" } }, "description": "The payload for manager device specific settings", "$$ref": "#/components/schemas/ManagerDeviceSpecificSetting" } }, "$$ref": "#/components/schemas/QueryManagerDeviceSpecificSettingsResponse" } ] }, "examples": { "QueryControllerDeviceSpecificSettingsExample": { "description": "QueryControllerDeviceSpecificSettingsExample", "value": { "createdBy": "admin", "createdOn": 1741315339238, "lastUpdatedBy": "admin", "lastUpdatedOn": 1741315439238, "payload": { "system": { "systemIp": "172.16.255.20", "hostName": "Controller01", "description": "Controller 1", "siteId": 200, "location": "Shang hai", "systemTunnelMtu": 2000, "gpsLocation": { "latitude": 90, "longitude": 180 }, "clock": { "timezone": "Europe/Andorra" }, "deviceGroups": [ "group1" ], "overlayId": 3, "ipv6StrictControl": true, "controllerGroupId": 1 }, "vpn": { "transport": { "ipRoute": { "route": [ { "prefix": "0.0.0.0/0", "nextHop": [ { "address": "10.0.12.13", "distance": 1 } ] } ] }, "ipv6Route": { "route": [ { "prefix": "::/0", "nextHop": [ { "address": "2001:a0:c::d" } ] } ] }, "interface": [ { "ifName": "eth0", "ip": { "address": "10.0.1.30/24" }, "ipv6": { "address": "2001:a0:1::1e/64" }, "shutdown": false }, { "ifName": "eth1", "ip": { "address": "10.0.12.20/24" }, "ipv6": { "address": "2001:a0:c::14/64" }, "tunnelInterface": { "allowService": { "all": true, "dhcp": true, "dns": true, "icmp": true, "sshd": false, "netconf": false, "ntp": false, "stun": false } }, "shutdown": false } ] }, "management": { "interface": [ { "ifName": "eth2", "ip": { "address": "10.2.2.20/24" }, "ipv6": { "address": "2001:a2:2::14/64" }, "shutdown": false } ] } } } }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigControlcomponentSettingResponseExampleQuerycontrollerdevicespecificsettings" }, "QueryValidatorDeviceSpecificSettingsExample": { "description": "QueryValidatorDeviceSpecificSettingsExample", "value": { "createdBy": "admin", "createdOn": 1741315339238, "lastUpdatedBy": "admin", "lastUpdatedOn": 1741315439238, "payload": { "system": { "systemIp": "172.16.255.19", "hostName": "Validator01", "description": "validator 1", "siteId": 100, "location": "Shang hai", "gpsLocation": { "latitude": 90, "longitude": 180 }, "clock": { "timezone": "Europe/Andorra" }, "deviceGroups": [ "group1" ], "vbond": { "address": "10.0.1.26" } }, "vpn": { "transport": { "ipRoute": { "route": [ { "prefix": "0.0.0.0/0", "nextHop": [ { "address": "10.0.5.13", "distance": 1 } ] } ] }, "ipv6Route": { "route": [ { "prefix": "::/0", "nextHop": [ { "address": "2001:a0:5::d" } ] } ] }, "interface": [ { "ifName": "eth0", "ip": { "address": "10.0.1.19/24" }, "ipv6": { "address": "2001:a0:1::13/64" }, "shutdown": false }, { "ifName": "eth1", "ip": { "address": "10.0.5.19/24" }, "ipv6": { "address": "2001:a0:5::13/64" }, "shutdown": false }, { "ifName": "eth3", "ip": { "address": "10.1.15.19/24" }, "ipv6": { "address": "2001:a1:f::13/64" }, "shutdown": false } ] }, "management": { "interface": [ { "ifName": "eth2", "ip": { "address": "10.2.2.19/24" }, "ipv6": { "address": "2001:a2:2::13/64" }, "shutdown": false } ] } } } }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigControlcomponentSettingResponseExampleQueryvalidatordevicespecificsettings" }, "QueryManagerDeviceSpecificSettingsExample": { "description": "QueryManagerDeviceSpecificSettingsExample", "value": { "createdBy": "admin", "createdOn": 1743658574232, "payload": { "system": { "systemIp": "172.16.255.22", "hostName": "Manager01", "clock": { "timezone": "UTC" }, "siteId": 200, "ipv6StrictControl": false }, "vpn": { "transport": { "ipRoute": { "route": [ { "prefix": "0.0.0.0/0", "nextHop": [ { "address": "10.0.12.13", "distance": 1 } ] } ] }, "interface": [ { "ifName": "eth0", "ip": { "dhcpClient": true, "dhcpDistance": 1 }, "ipv6": { "dhcpClient": true, "dhcpDistance": 1, "dhcpRapidCommit": false }, "shutdown": false }, { "ifName": "eth1", "ip": { "address": "10.0.12.22/24" }, "shutdown": false, "tunnelInterface": { "color": { "value": "default" }, "allowService": { "all": false, "dhcp": true, "dns": true, "icmp": true, "sshd": false, "netconf": false, "ntp": false, "stun": false } } }, { "ifName": "eth2", "ip": { "address": "10.0.5.22/24" }, "shutdown": false }, { "ifName": "eth5", "ip": { "address": "10.0.105.32/24" }, "shutdown": false } ] }, "management": { "interface": [ { "ifName": "eth3", "ip": { "address": "10.2.4.22/24" }, "shutdown": false } ] } } } }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigControlcomponentSettingResponseExampleQuerymanagerdevicespecificsettings" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "required": [ "error" ], "type": "object", "properties": { "error": { "required": [ "code", "details", "message", "type" ], "type": "object", "properties": { "code": { "type": "string", "description": "Internal error code", "example": "CCS0018" }, "details": { "type": "string", "description": "Error message detail", "example": "Unrecognized field user1" }, "message": { "type": "string", "description": "Error message summary", "example": "Invalid control component setting payload" }, "type": { "type": "string", "description": "Error message title", "example": "error" } }, "description": "Error response", "$$ref": "#/components/schemas/ErrorDetails" } }, "$$ref": "#/components/schemas/ErrorResponse" }, "examples": { "InvalidControlComponentDeviceId": { "description": "InvalidControlComponentDeviceId", "value": { "error": { "message": "Invalid control component device ID, only support controller,validator and manager", "code": "CCS0010", "details": "Device 73a7730e-9d48-463a-8c7f-924f6edd951c is not existed", "type": "error" } }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigControlcomponentSettingResponseExampleInvalidcontrolcomponentdeviceidresponse" } } } } }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "required": [ "error" ], "type": "object", "properties": { "error": { "required": [ "code", "details", "message", "type" ], "type": "object", "properties": { "code": { "type": "string", "description": "Internal error code", "example": "CCS0018" }, "details": { "type": "string", "description": "Error message detail", "example": "Unrecognized field user1" }, "message": { "type": "string", "description": "Error message summary", "example": "Invalid control component setting payload" }, "type": { "type": "string", "description": "Error message title", "example": "error" } }, "description": "Error response", "$$ref": "#/components/schemas/ErrorDetails" } }, "$$ref": "#/components/schemas/ErrorResponse" }, "examples": { "GetDeviceSpecificSettingsNotFoundResponse": { "description": "GetDeviceSpecificSettingsNotFoundResponse", "value": { "error": { "message": "Control component device specific settings are not found", "code": "CCS0013", "details": "Control component device specific settings are not found", "type": "error" } }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigControlcomponentSettingResponseExampleGetdevicespecificsettingsnotfoundresponse" } } } } }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Control Component Settings-read" }, "delete": { "tags": [ "Configuration - Control Component Setting" ], "description": "Delete the device-specific settings for a specific control component. The deviceId can be obtained from the \"uuid\" field in the data returned by the API (GET /dataservice/certificate/data/controller/list)", "operationId": "deleteControlComponentDeviceSpecificSettings", "parameters": [ { "name": "deviceId", "in": "path", "description": "Control component device UUID", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "required": [ "error" ], "type": "object", "properties": { "error": { "required": [ "code", "details", "message", "type" ], "type": "object", "properties": { "code": { "type": "string", "description": "Internal error code", "example": "CCS0018" }, "details": { "type": "string", "description": "Error message detail", "example": "Unrecognized field user1" }, "message": { "type": "string", "description": "Error message summary", "example": "Invalid control component setting payload" }, "type": { "type": "string", "description": "Error message title", "example": "error" } }, "description": "Error response", "$$ref": "#/components/schemas/ErrorDetails" } }, "$$ref": "#/components/schemas/ErrorResponse" }, "examples": { "DeleteControlComponentDeviceSpecificSettingsFailed": { "description": "DeleteControlComponentDeviceSpecificSettingsFailed", "value": { "error": { "message": "Failed to delete the device specific settings for specific control component", "code": "CCS0008", "details": "Control component is deployed with current settings, can't remove device specific settings, change control component to CLI mode and retry later", "type": "error" } }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigControlcomponentSettingResponseExampleDeletedevicespecificsettingsfailedresponse" } } } } }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Control Component Settings-write" } }, "/v1/control-component/devices/{deviceId}/settings/config-to-settings": { "post": { "tags": [ "Configuration - Control Component Setting" ], "description": "Auto generate the control component device specific settings(System,VPN static route and interface settings) by loading running config from a specific device which is reachable with Manager", "operationId": "controlComponentRunningConfigToDeviceSpecificSettings", "parameters": [ { "name": "deviceId", "in": "path", "description": "Control component device UUID", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "oneOf": [ { "required": [ "createdBy", "createdOn", "payload" ], "type": "object", "properties": { "createdBy": { "type": "string", "description": "The user who created the controller device specific settings", "example": "admin" }, "createdOn": { "type": "integer", "description": "The timestamp when controller device specific settings are created", "format": "int64", "example": 1741315339238 }, "lastUpdatedBy": { "type": "string", "description": "The user who modified the controller device specific settings", "example": "admin" }, "lastUpdatedOn": { "type": "integer", "description": "The timestamp when controller device specific settings are modified", "format": "int64", "example": 1741315339240 }, "payload": { "required": [ "system", "vpn" ], "type": "object", "properties": { "system": { "required": [ "hostName", "siteId", "systemIp" ], "type": "object", "properties": { "clock": { "required": [ "timezone" ], "type": "object", "properties": { "timezone": { "type": "string", "description": "Set the timezone", "example": "UTC", "enum": [ "Europe/Andorra", "Asia/Dubai", "Asia/Kabul", "America/Antigua", "America/Anguilla", "Europe/Tirane", "Asia/Yerevan", "Africa/Luanda", "Antarctica/McMurdo", "Antarctica/Rothera", "Antarctica/Palmer", "Antarctica/Mawson", "Antarctica/Davis", "Antarctica/Casey", "Antarctica/Vostok", "Antarctica/DumontDUrville", "Antarctica/Syowa", "America/Argentina/Buenos_Aires", "America/Argentina/Cordoba", "America/Argentina/Salta", "America/Argentina/Jujuy", "America/Argentina/Tucuman", "America/Argentina/Catamarca", "America/Argentina/La_Rioja", "America/Argentina/San_Juan", "America/Argentina/Mendoza", "America/Argentina/San_Luis", "America/Argentina/Rio_Gallegos", "America/Argentina/Ushuaia", "Pacific/Pago_Pago", "Europe/Vienna", "Australia/Lord_Howe", "Antarctica/Macquarie", "Australia/Hobart", "Australia/Currie", "Australia/Melbourne", "Australia/Sydney", "Australia/Broken_Hill", "Australia/Brisbane", "Australia/Lindeman", "Australia/Adelaide", "Australia/Darwin", "Australia/Perth", "Australia/Eucla", "America/Aruba", "Europe/Mariehamn", "Asia/Baku", "Europe/Sarajevo", "America/Barbados", "Asia/Dhaka", "Europe/Brussels", "Africa/Ouagadougou", "Europe/Sofia", "Asia/Bahrain", "Africa/Bujumbura", "Africa/Porto-Novo", "America/St_Barthelemy", "Atlantic/Bermuda", "Asia/Brunei", "America/La_Paz", "America/Kralendijk", "America/Noronha", "America/Belem", "America/Fortaleza", "America/Recife", "America/Araguaina", "America/Maceio", "America/Bahia", "America/Sao_Paulo", "America/Campo_Grande", "America/Cuiaba", "America/Santarem", "America/Porto_Velho", "America/Boa_Vista", "America/Manaus", "America/Eirunepe", "America/Rio_Branco", "America/Nassau", "Asia/Thimphu", "Africa/Gaborone", "Europe/Minsk", "America/Belize", "America/St_Johns", "America/Halifax", "America/Glace_Bay", "America/Moncton", "America/Goose_Bay", "America/Blanc-Sablon", "America/Toronto", "America/Nipigon", "America/Thunder_Bay", "America/Iqaluit", "America/Pangnirtung", "America/Resolute", "America/Atikokan", "America/Rankin_Inlet", "America/Winnipeg", "America/Rainy_River", "America/Regina", "America/Swift_Current", "America/Edmonton", "America/Cambridge_Bay", "America/Yellowknife", "America/Inuvik", "America/Creston", "America/Dawson_Creek", "America/Vancouver", "America/Whitehorse", "America/Dawson", "Indian/Cocos", "Africa/Kinshasa", "Africa/Lubumbashi", "Africa/Bangui", "Africa/Brazzaville", "Europe/Zurich", "Africa/Abidjan", "Pacific/Rarotonga", "America/Santiago", "Pacific/Easter", "Africa/Douala", "Asia/Shanghai", "Asia/Harbin", "Asia/Chongqing", "Asia/Urumqi", "Asia/Kashgar", "America/Bogota", "America/Costa_Rica", "America/Havana", "Atlantic/Cape_Verde", "America/Curacao", "Indian/Christmas", "Asia/Nicosia", "Europe/Prague", "Europe/Berlin", "Europe/Busingen", "Africa/Djibouti", "Europe/Copenhagen", "America/Dominica", "America/Santo_Domingo", "Africa/Algiers", "America/Guayaquil", "Pacific/Galapagos", "Europe/Tallinn", "Africa/Cairo", "Africa/El_Aaiun", "Africa/Asmara", "Europe/Madrid", "Africa/Ceuta", "Atlantic/Canary", "Africa/Addis_Ababa", "Europe/Helsinki", "Pacific/Fiji", "Atlantic/Stanley", "Pacific/Chuuk", "Pacific/Pohnpei", "Pacific/Kosrae", "Atlantic/Faroe", "Europe/Paris", "Africa/Libreville", "Europe/London", "America/Grenada", "Asia/Tbilisi", "America/Cayenne", "Europe/Guernsey", "Africa/Accra", "Europe/Gibraltar", "America/Godthab", "America/Danmarkshavn", "America/Scoresbysund", "America/Thule", "Africa/Banjul", "Africa/Conakry", "America/Guadeloupe", "Africa/Malabo", "Europe/Athens", "Atlantic/South_Georgia", "America/Guatemala", "Pacific/Guam", "Africa/Bissau", "America/Guyana", "Asia/Hong_Kong", "America/Tegucigalpa", "Europe/Zagreb", "America/Port-au-Prince", "Europe/Budapest", "Asia/Jakarta", "Asia/Pontianak", "Asia/Makassar", "Asia/Jayapura", "Europe/Dublin", "Asia/Jerusalem", "Europe/Isle_of_Man", "Asia/Kolkata", "Indian/Chagos", "Asia/Baghdad", "Asia/Tehran", "Atlantic/Reykjavik", "Europe/Rome", "Europe/Jersey", "America/Jamaica", "Asia/Amman", "Asia/Tokyo", "Africa/Nairobi", "Asia/Bishkek", "Asia/Phnom_Penh", "Pacific/Tarawa", "Pacific/Enderbury", "Pacific/Kiritimati", "Indian/Comoro", "America/St_Kitts", "Asia/Pyongyang", "Asia/Seoul", "Asia/Kuwait", "America/Cayman", "Asia/Almaty", "Asia/Qyzylorda", "Asia/Aqtobe", "Asia/Aqtau", "Asia/Oral", "Asia/Vientiane", "Asia/Beirut", "America/St_Lucia", "Europe/Vaduz", "Asia/Colombo", "Africa/Monrovia", "Africa/Maseru", "Europe/Vilnius", "Europe/Luxembourg", "Europe/Riga", "Africa/Tripoli", "Africa/Casablanca", "Europe/Monaco", "Europe/Chisinau", "Europe/Podgorica", "America/Marigot", "Indian/Antananarivo", "Pacific/Majuro", "Pacific/Kwajalein", "Europe/Skopje", "Africa/Bamako", "Asia/Rangoon", "Asia/Ulaanbaatar", "Asia/Hovd", "Asia/Choibalsan", "Asia/Macau", "Pacific/Saipan", "America/Martinique", "Africa/Nouakchott", "America/Montserrat", "Europe/Malta", "Indian/Mauritius", "Indian/Maldives", "Africa/Blantyre", "America/Mexico_City", "America/Cancun", "America/Merida", "America/Monterrey", "America/Matamoros", "America/Mazatlan", "America/Chihuahua", "America/Ojinaga", "America/Hermosillo", "America/Tijuana", "America/Santa_Isabel", "America/Bahia_Banderas", "Asia/Kuala_Lumpur", "Asia/Kuching", "Africa/Maputo", "Africa/Windhoek", "Pacific/Noumea", "Africa/Niamey", "Pacific/Norfolk", "Africa/Lagos", "America/Managua", "Europe/Amsterdam", "Europe/Oslo", "Asia/Kathmandu", "Pacific/Nauru", "Pacific/Niue", "Pacific/Auckland", "Pacific/Chatham", "Asia/Muscat", "America/Panama", "America/Lima", "Pacific/Tahiti", "Pacific/Marquesas", "Pacific/Gambier", "Pacific/Port_Moresby", "Asia/Manila", "Asia/Karachi", "Europe/Warsaw", "America/Miquelon", "Pacific/Pitcairn", "America/Puerto_Rico", "Asia/Gaza", "Asia/Hebron", "Europe/Lisbon", "Atlantic/Madeira", "Atlantic/Azores", "Pacific/Palau", "America/Asuncion", "Asia/Qatar", "Indian/Reunion", "Europe/Bucharest", "Europe/Belgrade", "Europe/Kaliningrad", "Europe/Moscow", "Europe/Volgograd", "Europe/Samara", "Asia/Yekaterinburg", "Asia/Omsk", "Asia/Novosibirsk", "Asia/Novokuznetsk", "Asia/Krasnoyarsk", "Asia/Irkutsk", "Asia/Yakutsk", "Asia/Khandyga", "Asia/Vladivostok", "Asia/Sakhalin", "Asia/Ust-Nera", "Asia/Magadan", "Asia/Kamchatka", "Asia/Anadyr", "Africa/Kigali", "Asia/Riyadh", "Pacific/Guadalcanal", "Indian/Mahe", "Africa/Khartoum", "Europe/Stockholm", "Asia/Singapore", "Atlantic/St_Helena", "Europe/Ljubljana", "Arctic/Longyearbyen", "Europe/Bratislava", "Africa/Freetown", "Europe/San_Marino", "Africa/Dakar", "Africa/Mogadishu", "America/Paramaribo", "Africa/Juba", "Africa/Sao_Tome", "America/El_Salvador", "America/Lower_Princes", "Asia/Damascus", "Africa/Mbabane", "America/Grand_Turk", "Africa/Ndjamena", "Indian/Kerguelen", "Africa/Lome", "Asia/Bangkok", "Asia/Dushanbe", "Pacific/Fakaofo", "Asia/Dili", "Asia/Ashgabat", "Africa/Tunis", "Pacific/Tongatapu", "Europe/Istanbul", "America/Port_of_Spain", "Pacific/Funafuti", "Asia/Taipei", "Africa/Dar_es_Salaam", "Europe/Kiev", "Europe/Uzhgorod", "Europe/Zaporozhye", "Europe/Simferopol", "Africa/Kampala", "Pacific/Johnston", "Pacific/Midway", "Pacific/Wake", "America/New_York", "America/Detroit", "America/Kentucky/Louisville", "America/Kentucky/Monticello", "America/Indiana/Indianapolis", "America/Indiana/Vincennes", "America/Indiana/Winamac", "America/Indiana/Marengo", "America/Indiana/Petersburg", "America/Indiana/Vevay", "America/Chicago", "America/Indiana/Tell_City", "America/Indiana/Knox", "America/Menominee", "America/North_Dakota/Center", "America/North_Dakota/New_Salem", "America/North_Dakota/Beulah", "America/Denver", "America/Boise", "America/Phoenix", "America/Los_Angeles", "America/Anchorage", "America/Juneau", "America/Sitka", "America/Yakutat", "America/Nome", "America/Adak", "America/Metlakatla", "Pacific/Honolulu", "America/Montevideo", "Asia/Samarkand", "Asia/Tashkent", "Europe/Vatican", "America/St_Vincent", "America/Caracas", "America/Tortola", "America/St_Thomas", "Asia/Ho_Chi_Minh", "Pacific/Efate", "Pacific/Wallis", "Pacific/Apia", "Asia/Aden", "Indian/Mayotte", "Africa/Johannesburg", "Africa/Lusaka", "Africa/Harare", "UTC" ], "default": "UTC" } }, "description": "Configure clock", "$$ref": "#/components/schemas/Clock" }, "description": { "pattern": "^[^<>]{1,32}$", "type": "string", "description": "Set a text description of the device", "example": "System settings" }, "deviceGroups": { "type": "array", "description": "Configure device groups", "items": { "type": "string", "description": "Configure device groups" } }, "gpsLocation": { "required": [ "latitude", "longitude" ], "type": "object", "properties": { "latitude": { "maximum": 90, "minimum": -90, "type": "number", "description": "Set the device\u2019s physical latitude", "example": 60 }, "longitude": { "maximum": 180, "minimum": -180, "type": "number", "description": "Set the device\u2019s physical longitude", "example": 60 } }, "description": "GPS latitude and longitude of the device", "$$ref": "#/components/schemas/GpsLocation" }, "hostName": { "pattern": "^[a-zA-Z0-9\\-_]{1,32}$", "type": "string", "description": "Set the hostname", "example": "vm12" }, "ipv6StrictControl": { "type": "boolean", "description": "Enable Dual Stack IPv6 Default", "example": false, "default": false }, "location": { "pattern": "^[^<>]{1,127}$", "type": "string", "description": "Set the location of the device", "example": "USA" }, "siteId": { "maximum": 4294967295, "minimum": 0, "type": "integer", "description": "Set the site ID", "format": "int64", "example": 100 }, "systemIp": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "Set the system IP address", "example": "102.2.3.2" } }, "description": "System configuration for manager", "$$ref": "#/components/schemas/ManagerSystemSetting" }, "vpn": { "required": [ "transport" ], "type": "object", "properties": { "management": { "required": [ "interface" ], "type": "object", "properties": { "dns": { "type": "object", "properties": { "dnsServerPrimary": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "Primary DNS server IPv4 or IPv6 Address", "example": "10.2.2.2" }, "dnsServerSecondary": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "Secondary DNS server IPv4 or IPv6 Address", "example": "10.2.2.3" }, "host": { "type": "array", "items": { "required": [ "hostname", "ip" ], "type": "object", "properties": { "hostname": { "pattern": "^[a-zA-Z0-9\\-_.]{1,64}$", "type": "string", "description": "Host name", "example": "vbond" }, "ip": { "maxItems": 64, "minItems": 1, "uniqueItems": true, "type": "array", "items": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "IP Address", "example": "10.1.1.1" } } }, "description": "Static host mapping", "$$ref": "#/components/schemas/DnsHostMapping" } } }, "description": "Configure DNS servers or static host mapping", "$$ref": "#/components/schemas/ControlComponentDnsSetting" }, "interface": { "maxItems": 2147483647, "minItems": 1, "type": "array", "items": { "required": [ "ifName" ], "type": "object", "properties": { "ifName": { "pattern": "^(?=.{1,32}$)(?:(ge0\\/\\d+(?:\\.\\d+)?|loopback\\d+|eth\\d+(?:\\.\\d+)?))$", "type": "string", "description": "Interface name eth<0-..> or eth<0-..>.vlanid or loopback when present", "example": "eth0" }, "ip": { "type": "object", "properties": { "address": { "pattern": "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\\/)([0-2]?[0-9]$|[3]?[0-2])$", "type": "string", "description": "Assign IPv4 address", "example": "10.0.1.1/24" }, "dhcpClient": { "type": "boolean", "description": "Enable DHCP", "example": false, "default": false }, "dhcpDistance": { "maximum": 65536, "minimum": 1, "type": "integer", "description": "Set administrative distance for DHCP default route", "format": "int32", "example": 1, "default": 1 } }, "description": "IPv4 address or DHCP", "$$ref": "#/components/schemas/IpConfig" }, "ipv6": { "type": "object", "properties": { "address": { "pattern": "((^\\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))(%.+)?\\s*(\\/)(\\b([0-9]{1,2}|1[01][0-9]|12[0-8])\\b)$))", "type": "string", "description": "Assign IPv6 address", "example": "2001:a0:64::20/64" }, "dhcpClient": { "type": "boolean", "description": "Enable DHCP", "example": false, "default": false }, "dhcpDistance": { "maximum": 65536, "minimum": 1, "type": "integer", "description": "Set administrative distance for DHCP default route", "format": "int32", "example": 1, "default": 1 }, "dhcpRapidCommit": { "type": "boolean", "description": "Enable DHCPv6 rapid commit", "example": false, "default": false } }, "description": "IPv6 address or DHCP", "$$ref": "#/components/schemas/Ipv6Config" }, "shutdown": { "type": "boolean", "description": "Administrative state", "example": false, "default": false } }, "description": "Interfaces configuration", "$$ref": "#/components/schemas/BaseInterfaceSetting" } }, "ipRoute": { "type": "object", "properties": { "route": { "type": "array", "items": { "required": [ "nextHop", "prefix" ], "type": "object", "properties": { "nextHop": { "maxItems": 2147483647, "minItems": 1, "type": "array", "items": { "required": [ "address" ], "type": "object", "properties": { "address": { "pattern": "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "description": "IPv4 Address", "example": "10.0.0.1" }, "distance": { "maximum": 255, "minimum": 1, "type": "integer", "description": "Administrative distance", "format": "int32", "example": 1, "default": 1 } }, "description": "IP gateway address", "$$ref": "#/components/schemas/NextHop" } }, "prefix": { "pattern": "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\\/)([0-2]?[0-9]$|[3]?[0-2])$", "type": "string", "description": "IPv4 Prefix", "example": "0.0.0.0/0" } }, "description": "Configure static routes", "$$ref": "#/components/schemas/StaticRoute" } } }, "description": "IP Route information", "$$ref": "#/components/schemas/IpRoute" }, "ipv6Route": { "type": "object", "properties": { "route": { "type": "array", "items": { "required": [ "nextHop", "prefix" ], "type": "object", "properties": { "nextHop": { "maxItems": 2147483647, "minItems": 1, "type": "array", "items": { "required": [ "address" ], "type": "object", "properties": { "address": { "pattern": "(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))", "type": "string", "description": "IPv6 Address", "example": "2001::1" }, "distance": { "maximum": 255, "minimum": 1, "type": "integer", "description": "Administrative distance", "format": "int32", "example": 1, "default": 1 } }, "description": "IP gateway address", "$$ref": "#/components/schemas/IPV6NextHop" } }, "prefix": { "pattern": "((^\\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))(%.+)?\\s*(\\/)(\\b([0-9]{1,2}|1[01][0-9]|12[0-8])\\b)$))", "type": "string", "description": "IPv6 Prefix", "example": "2001::/4" } }, "description": "Configure IPv6 static routes", "$$ref": "#/components/schemas/Ipv6StaticRoute" } } }, "description": "IPv6 Route information", "$$ref": "#/components/schemas/Ipv6Route" } }, "description": "Management VPN instance", "$$ref": "#/components/schemas/baseVpnInstanceBaseInterfaceSetting" }, "transport": { "required": [ "interface" ], "type": "object", "properties": { "dns": { "type": "object", "properties": { "dnsServerPrimary": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "Primary DNS server IPv4 or IPv6 Address", "example": "10.2.2.2" }, "dnsServerSecondary": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "Secondary DNS server IPv4 or IPv6 Address", "example": "10.2.2.3" }, "host": { "type": "array", "items": { "required": [ "hostname", "ip" ], "type": "object", "properties": { "hostname": { "pattern": "^[a-zA-Z0-9\\-_.]{1,64}$", "type": "string", "description": "Host name", "example": "vbond" }, "ip": { "maxItems": 64, "minItems": 1, "uniqueItems": true, "type": "array", "items": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "IP Address", "example": "10.1.1.1" } } }, "description": "Static host mapping", "$$ref": "#/components/schemas/DnsHostMapping" } } }, "description": "Configure DNS servers or static host mapping", "$$ref": "#/components/schemas/ControlComponentDnsSetting" }, "interface": { "maxItems": 2147483647, "minItems": 1, "type": "array", "items": { "required": [ "ifName" ], "type": "object", "properties": { "ifName": { "pattern": "^(?=.{1,32}$)(?:(ge0\\/\\d+(?:\\.\\d+)?|loopback\\d+|eth\\d+(?:\\.\\d+)?))$", "type": "string", "description": "Interface name eth<0-..> or eth<0-..>.vlanid or loopback when present", "example": "eth0" }, "ip": { "type": "object", "properties": { "address": { "pattern": "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\\/)([0-2]?[0-9]$|[3]?[0-2])$", "type": "string", "description": "Assign IPv4 address", "example": "10.0.1.1/24" }, "dhcpClient": { "type": "boolean", "description": "Enable DHCP", "example": false, "default": false }, "dhcpDistance": { "maximum": 65536, "minimum": 1, "type": "integer", "description": "Set administrative distance for DHCP default route", "format": "int32", "example": 1, "default": 1 } }, "description": "IPv4 address or DHCP", "$$ref": "#/components/schemas/IpConfig" }, "ipv6": { "type": "object", "properties": { "address": { "pattern": "((^\\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))(%.+)?\\s*(\\/)(\\b([0-9]{1,2}|1[01][0-9]|12[0-8])\\b)$))", "type": "string", "description": "Assign IPv6 address", "example": "2001:a0:64::20/64" }, "dhcpClient": { "type": "boolean", "description": "Enable DHCP", "example": false, "default": false }, "dhcpDistance": { "maximum": 65536, "minimum": 1, "type": "integer", "description": "Set administrative distance for DHCP default route", "format": "int32", "example": 1, "default": 1 }, "dhcpRapidCommit": { "type": "boolean", "description": "Enable DHCPv6 rapid commit", "example": false, "default": false } }, "description": "IPv6 address or DHCP", "$$ref": "#/components/schemas/Ipv6Config" }, "shutdown": { "type": "boolean", "description": "Administrative state", "example": false, "default": false }, "tunnelInterface": { "type": "object", "properties": { "allowService": { "type": "object", "properties": { "all": { "type": "boolean", "description": "Allow all traffic. Overrides all other allow-service options if allow-service all is set", "example": false, "default": false }, "dhcp": { "type": "boolean", "description": "Allow/Deny DHCP", "example": true, "default": true }, "dns": { "type": "boolean", "description": "Allow/Deny DNS", "example": true, "default": true }, "icmp": { "type": "boolean", "description": "Allow/Deny ICMP", "example": true, "default": true }, "netconf": { "type": "boolean", "description": "Allow/Deny NETCONF", "example": false, "default": false }, "ntp": { "type": "boolean", "description": "Allow/Deny NTP", "example": false, "default": false }, "sshd": { "type": "boolean", "description": "Allow/Deny SSH", "example": false, "default": false }, "stun": { "type": "boolean", "description": "Allow/Deny STUN", "example": false, "default": false } }, "description": "Set services allowed on the WAN interface", "$$ref": "#/components/schemas/AllowService" }, "color": { "type": "object", "properties": { "value": { "type": "string", "description": "Set color for TLOC", "example": "default", "enum": [ "default", "mpls", "metro-ethernet", "biz-internet", "public-internet", "lte", "3g", "red", "green", "blue", "gold", "silver", "bronze", "custom1", "custom2", "custom3", "private1", "private2", "private3", "private4", "private5", "private6" ], "default": "default" } }, "description": "Set color for TLOC", "$$ref": "#/components/schemas/Color" } }, "description": "Tunnel interface configuration", "$$ref": "#/components/schemas/TunnelInterface" } }, "description": "Interfaces configuration", "$$ref": "#/components/schemas/TransportInterfaceSetting" } }, "ipRoute": { "type": "object", "properties": { "route": { "type": "array", "items": { "required": [ "nextHop", "prefix" ], "type": "object", "properties": { "nextHop": { "maxItems": 2147483647, "minItems": 1, "type": "array", "items": { "required": [ "address" ], "type": "object", "properties": { "address": { "pattern": "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "description": "IPv4 Address", "example": "10.0.0.1" }, "distance": { "maximum": 255, "minimum": 1, "type": "integer", "description": "Administrative distance", "format": "int32", "example": 1, "default": 1 } }, "description": "IP gateway address", "$$ref": "#/components/schemas/NextHop" } }, "prefix": { "pattern": "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\\/)([0-2]?[0-9]$|[3]?[0-2])$", "type": "string", "description": "IPv4 Prefix", "example": "0.0.0.0/0" } }, "description": "Configure static routes", "$$ref": "#/components/schemas/StaticRoute" } } }, "description": "IP Route information", "$$ref": "#/components/schemas/IpRoute" }, "ipv6Route": { "type": "object", "properties": { "route": { "type": "array", "items": { "required": [ "nextHop", "prefix" ], "type": "object", "properties": { "nextHop": { "maxItems": 2147483647, "minItems": 1, "type": "array", "items": { "required": [ "address" ], "type": "object", "properties": { "address": { "pattern": "(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))", "type": "string", "description": "IPv6 Address", "example": "2001::1" }, "distance": { "maximum": 255, "minimum": 1, "type": "integer", "description": "Administrative distance", "format": "int32", "example": 1, "default": 1 } }, "description": "IP gateway address", "$$ref": "#/components/schemas/IPV6NextHop" } }, "prefix": { "pattern": "((^\\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))(%.+)?\\s*(\\/)(\\b([0-9]{1,2}|1[01][0-9]|12[0-8])\\b)$))", "type": "string", "description": "IPv6 Prefix", "example": "2001::/4" } }, "description": "Configure IPv6 static routes", "$$ref": "#/components/schemas/Ipv6StaticRoute" } } }, "description": "IPv6 Route information", "$$ref": "#/components/schemas/Ipv6Route" } }, "description": "Transport VPN instance", "$$ref": "#/components/schemas/baseVpnInstanceTransportInterfaceSetting" } }, "description": "Manager VPN setting", "$$ref": "#/components/schemas/ManagerVpnSetting" } }, "description": "The payload for manager device specific settings", "$$ref": "#/components/schemas/ManagerDeviceSpecificSetting" } }, "$$ref": "#/components/schemas/QueryManagerDeviceSpecificSettingsResponse" }, { "required": [ "createdBy", "createdOn", "payload" ], "type": "object", "properties": { "createdBy": { "type": "string", "description": "The user who created the controller device specific settings", "example": "admin" }, "createdOn": { "type": "integer", "description": "The timestamp when controller device specific settings are created", "format": "int64", "example": 1741315339238 }, "lastUpdatedBy": { "type": "string", "description": "The user who modified the controller device specific settings", "example": "admin" }, "lastUpdatedOn": { "type": "integer", "description": "The timestamp when controller device specific settings are modified", "format": "int64", "example": 1741315339240 }, "payload": { "required": [ "system", "vpn" ], "type": "object", "properties": { "system": { "required": [ "hostName", "siteId", "systemIp" ], "type": "object", "properties": { "clock": { "required": [ "timezone" ], "type": "object", "properties": { "timezone": { "type": "string", "description": "Set the timezone", "example": "UTC", "enum": [ "Europe/Andorra", "Asia/Dubai", "Asia/Kabul", "America/Antigua", "America/Anguilla", "Europe/Tirane", "Asia/Yerevan", "Africa/Luanda", "Antarctica/McMurdo", "Antarctica/Rothera", "Antarctica/Palmer", "Antarctica/Mawson", "Antarctica/Davis", "Antarctica/Casey", "Antarctica/Vostok", "Antarctica/DumontDUrville", "Antarctica/Syowa", "America/Argentina/Buenos_Aires", "America/Argentina/Cordoba", "America/Argentina/Salta", "America/Argentina/Jujuy", "America/Argentina/Tucuman", "America/Argentina/Catamarca", "America/Argentina/La_Rioja", "America/Argentina/San_Juan", "America/Argentina/Mendoza", "America/Argentina/San_Luis", "America/Argentina/Rio_Gallegos", "America/Argentina/Ushuaia", "Pacific/Pago_Pago", "Europe/Vienna", "Australia/Lord_Howe", "Antarctica/Macquarie", "Australia/Hobart", "Australia/Currie", "Australia/Melbourne", "Australia/Sydney", "Australia/Broken_Hill", "Australia/Brisbane", "Australia/Lindeman", "Australia/Adelaide", "Australia/Darwin", "Australia/Perth", "Australia/Eucla", "America/Aruba", "Europe/Mariehamn", "Asia/Baku", "Europe/Sarajevo", "America/Barbados", "Asia/Dhaka", "Europe/Brussels", "Africa/Ouagadougou", "Europe/Sofia", "Asia/Bahrain", "Africa/Bujumbura", "Africa/Porto-Novo", "America/St_Barthelemy", "Atlantic/Bermuda", "Asia/Brunei", "America/La_Paz", "America/Kralendijk", "America/Noronha", "America/Belem", "America/Fortaleza", "America/Recife", "America/Araguaina", "America/Maceio", "America/Bahia", "America/Sao_Paulo", "America/Campo_Grande", "America/Cuiaba", "America/Santarem", "America/Porto_Velho", "America/Boa_Vista", "America/Manaus", "America/Eirunepe", "America/Rio_Branco", "America/Nassau", "Asia/Thimphu", "Africa/Gaborone", "Europe/Minsk", "America/Belize", "America/St_Johns", "America/Halifax", "America/Glace_Bay", "America/Moncton", "America/Goose_Bay", "America/Blanc-Sablon", "America/Toronto", "America/Nipigon", "America/Thunder_Bay", "America/Iqaluit", "America/Pangnirtung", "America/Resolute", "America/Atikokan", "America/Rankin_Inlet", "America/Winnipeg", "America/Rainy_River", "America/Regina", "America/Swift_Current", "America/Edmonton", "America/Cambridge_Bay", "America/Yellowknife", "America/Inuvik", "America/Creston", "America/Dawson_Creek", "America/Vancouver", "America/Whitehorse", "America/Dawson", "Indian/Cocos", "Africa/Kinshasa", "Africa/Lubumbashi", "Africa/Bangui", "Africa/Brazzaville", "Europe/Zurich", "Africa/Abidjan", "Pacific/Rarotonga", "America/Santiago", "Pacific/Easter", "Africa/Douala", "Asia/Shanghai", "Asia/Harbin", "Asia/Chongqing", "Asia/Urumqi", "Asia/Kashgar", "America/Bogota", "America/Costa_Rica", "America/Havana", "Atlantic/Cape_Verde", "America/Curacao", "Indian/Christmas", "Asia/Nicosia", "Europe/Prague", "Europe/Berlin", "Europe/Busingen", "Africa/Djibouti", "Europe/Copenhagen", "America/Dominica", "America/Santo_Domingo", "Africa/Algiers", "America/Guayaquil", "Pacific/Galapagos", "Europe/Tallinn", "Africa/Cairo", "Africa/El_Aaiun", "Africa/Asmara", "Europe/Madrid", "Africa/Ceuta", "Atlantic/Canary", "Africa/Addis_Ababa", "Europe/Helsinki", "Pacific/Fiji", "Atlantic/Stanley", "Pacific/Chuuk", "Pacific/Pohnpei", "Pacific/Kosrae", "Atlantic/Faroe", "Europe/Paris", "Africa/Libreville", "Europe/London", "America/Grenada", "Asia/Tbilisi", "America/Cayenne", "Europe/Guernsey", "Africa/Accra", "Europe/Gibraltar", "America/Godthab", "America/Danmarkshavn", "America/Scoresbysund", "America/Thule", "Africa/Banjul", "Africa/Conakry", "America/Guadeloupe", "Africa/Malabo", "Europe/Athens", "Atlantic/South_Georgia", "America/Guatemala", "Pacific/Guam", "Africa/Bissau", "America/Guyana", "Asia/Hong_Kong", "America/Tegucigalpa", "Europe/Zagreb", "America/Port-au-Prince", "Europe/Budapest", "Asia/Jakarta", "Asia/Pontianak", "Asia/Makassar", "Asia/Jayapura", "Europe/Dublin", "Asia/Jerusalem", "Europe/Isle_of_Man", "Asia/Kolkata", "Indian/Chagos", "Asia/Baghdad", "Asia/Tehran", "Atlantic/Reykjavik", "Europe/Rome", "Europe/Jersey", "America/Jamaica", "Asia/Amman", "Asia/Tokyo", "Africa/Nairobi", "Asia/Bishkek", "Asia/Phnom_Penh", "Pacific/Tarawa", "Pacific/Enderbury", "Pacific/Kiritimati", "Indian/Comoro", "America/St_Kitts", "Asia/Pyongyang", "Asia/Seoul", "Asia/Kuwait", "America/Cayman", "Asia/Almaty", "Asia/Qyzylorda", "Asia/Aqtobe", "Asia/Aqtau", "Asia/Oral", "Asia/Vientiane", "Asia/Beirut", "America/St_Lucia", "Europe/Vaduz", "Asia/Colombo", "Africa/Monrovia", "Africa/Maseru", "Europe/Vilnius", "Europe/Luxembourg", "Europe/Riga", "Africa/Tripoli", "Africa/Casablanca", "Europe/Monaco", "Europe/Chisinau", "Europe/Podgorica", "America/Marigot", "Indian/Antananarivo", "Pacific/Majuro", "Pacific/Kwajalein", "Europe/Skopje", "Africa/Bamako", "Asia/Rangoon", "Asia/Ulaanbaatar", "Asia/Hovd", "Asia/Choibalsan", "Asia/Macau", "Pacific/Saipan", "America/Martinique", "Africa/Nouakchott", "America/Montserrat", "Europe/Malta", "Indian/Mauritius", "Indian/Maldives", "Africa/Blantyre", "America/Mexico_City", "America/Cancun", "America/Merida", "America/Monterrey", "America/Matamoros", "America/Mazatlan", "America/Chihuahua", "America/Ojinaga", "America/Hermosillo", "America/Tijuana", "America/Santa_Isabel", "America/Bahia_Banderas", "Asia/Kuala_Lumpur", "Asia/Kuching", "Africa/Maputo", "Africa/Windhoek", "Pacific/Noumea", "Africa/Niamey", "Pacific/Norfolk", "Africa/Lagos", "America/Managua", "Europe/Amsterdam", "Europe/Oslo", "Asia/Kathmandu", "Pacific/Nauru", "Pacific/Niue", "Pacific/Auckland", "Pacific/Chatham", "Asia/Muscat", "America/Panama", "America/Lima", "Pacific/Tahiti", "Pacific/Marquesas", "Pacific/Gambier", "Pacific/Port_Moresby", "Asia/Manila", "Asia/Karachi", "Europe/Warsaw", "America/Miquelon", "Pacific/Pitcairn", "America/Puerto_Rico", "Asia/Gaza", "Asia/Hebron", "Europe/Lisbon", "Atlantic/Madeira", "Atlantic/Azores", "Pacific/Palau", "America/Asuncion", "Asia/Qatar", "Indian/Reunion", "Europe/Bucharest", "Europe/Belgrade", "Europe/Kaliningrad", "Europe/Moscow", "Europe/Volgograd", "Europe/Samara", "Asia/Yekaterinburg", "Asia/Omsk", "Asia/Novosibirsk", "Asia/Novokuznetsk", "Asia/Krasnoyarsk", "Asia/Irkutsk", "Asia/Yakutsk", "Asia/Khandyga", "Asia/Vladivostok", "Asia/Sakhalin", "Asia/Ust-Nera", "Asia/Magadan", "Asia/Kamchatka", "Asia/Anadyr", "Africa/Kigali", "Asia/Riyadh", "Pacific/Guadalcanal", "Indian/Mahe", "Africa/Khartoum", "Europe/Stockholm", "Asia/Singapore", "Atlantic/St_Helena", "Europe/Ljubljana", "Arctic/Longyearbyen", "Europe/Bratislava", "Africa/Freetown", "Europe/San_Marino", "Africa/Dakar", "Africa/Mogadishu", "America/Paramaribo", "Africa/Juba", "Africa/Sao_Tome", "America/El_Salvador", "America/Lower_Princes", "Asia/Damascus", "Africa/Mbabane", "America/Grand_Turk", "Africa/Ndjamena", "Indian/Kerguelen", "Africa/Lome", "Asia/Bangkok", "Asia/Dushanbe", "Pacific/Fakaofo", "Asia/Dili", "Asia/Ashgabat", "Africa/Tunis", "Pacific/Tongatapu", "Europe/Istanbul", "America/Port_of_Spain", "Pacific/Funafuti", "Asia/Taipei", "Africa/Dar_es_Salaam", "Europe/Kiev", "Europe/Uzhgorod", "Europe/Zaporozhye", "Europe/Simferopol", "Africa/Kampala", "Pacific/Johnston", "Pacific/Midway", "Pacific/Wake", "America/New_York", "America/Detroit", "America/Kentucky/Louisville", "America/Kentucky/Monticello", "America/Indiana/Indianapolis", "America/Indiana/Vincennes", "America/Indiana/Winamac", "America/Indiana/Marengo", "America/Indiana/Petersburg", "America/Indiana/Vevay", "America/Chicago", "America/Indiana/Tell_City", "America/Indiana/Knox", "America/Menominee", "America/North_Dakota/Center", "America/North_Dakota/New_Salem", "America/North_Dakota/Beulah", "America/Denver", "America/Boise", "America/Phoenix", "America/Los_Angeles", "America/Anchorage", "America/Juneau", "America/Sitka", "America/Yakutat", "America/Nome", "America/Adak", "America/Metlakatla", "Pacific/Honolulu", "America/Montevideo", "Asia/Samarkand", "Asia/Tashkent", "Europe/Vatican", "America/St_Vincent", "America/Caracas", "America/Tortola", "America/St_Thomas", "Asia/Ho_Chi_Minh", "Pacific/Efate", "Pacific/Wallis", "Pacific/Apia", "Asia/Aden", "Indian/Mayotte", "Africa/Johannesburg", "Africa/Lusaka", "Africa/Harare", "UTC" ], "default": "UTC" } }, "description": "Configure clock", "$$ref": "#/components/schemas/Clock" }, "controllerGroupId": { "maximum": 100, "minimum": 0, "type": "integer", "description": "Controller group id", "format": "int32", "example": 0, "default": 0 }, "description": { "pattern": "^[^<>]{1,32}$", "type": "string", "description": "Set a text description of the device", "example": "System settings" }, "deviceGroups": { "type": "array", "description": "Configure device groups", "items": { "type": "string", "description": "Configure device groups" } }, "gpsLocation": { "required": [ "latitude", "longitude" ], "type": "object", "properties": { "latitude": { "maximum": 90, "minimum": -90, "type": "number", "description": "Set the device\u2019s physical latitude", "example": 60 }, "longitude": { "maximum": 180, "minimum": -180, "type": "number", "description": "Set the device\u2019s physical longitude", "example": 60 } }, "description": "GPS latitude and longitude of the device", "$$ref": "#/components/schemas/GpsLocation" }, "hostName": { "pattern": "^[a-zA-Z0-9\\-_]{1,32}$", "type": "string", "description": "Set the hostname", "example": "vm12" }, "ipv6StrictControl": { "type": "boolean", "description": "Sets up a strict IPv6 control connection in a dual stack IP", "example": false, "default": false }, "location": { "pattern": "^[^<>]{1,127}$", "type": "string", "description": "Set the location of the device", "example": "USA" }, "overlayId": { "maximum": 4294967295, "minimum": 1, "type": "integer", "description": "Set the Overlay ID", "format": "int64", "example": 1, "default": 1 }, "region": { "type": "object", "properties": { "regionIdList": { "maxItems": 2147483647, "minItems": 1, "uniqueItems": true, "type": "array", "items": { "maximum": 63, "minimum": 0, "type": "integer", "description": "Configure a list of region ID", "format": "int32", "example": 0 } } }, "$$ref": "#/components/schemas/Region" }, "siteId": { "maximum": 4294967295, "minimum": 0, "type": "integer", "description": "Set the site ID", "format": "int64", "example": 100 }, "systemIp": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "Set the system IP address", "example": "102.2.3.2" } }, "description": "System configuration for controller", "$$ref": "#/components/schemas/ControllerSystemSetting" }, "vpn": { "required": [ "transport" ], "type": "object", "properties": { "management": { "required": [ "interface" ], "type": "object", "properties": { "dns": { "type": "object", "properties": { "dnsServerPrimary": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "Primary DNS server IPv4 or IPv6 Address", "example": "10.2.2.2" }, "dnsServerSecondary": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "Secondary DNS server IPv4 or IPv6 Address", "example": "10.2.2.3" }, "host": { "type": "array", "items": { "required": [ "hostname", "ip" ], "type": "object", "properties": { "hostname": { "pattern": "^[a-zA-Z0-9\\-_.]{1,64}$", "type": "string", "description": "Host name", "example": "vbond" }, "ip": { "maxItems": 64, "minItems": 1, "uniqueItems": true, "type": "array", "items": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "IP Address", "example": "10.1.1.1" } } }, "description": "Static host mapping", "$$ref": "#/components/schemas/DnsHostMapping" } } }, "description": "Configure DNS servers or static host mapping", "$$ref": "#/components/schemas/ControlComponentDnsSetting" }, "interface": { "maxItems": 2147483647, "minItems": 1, "type": "array", "items": { "required": [ "ifName" ], "type": "object", "properties": { "ifName": { "pattern": "^(?=.{1,32}$)(?:(ge0\\/\\d+(?:\\.\\d+)?|loopback\\d+|eth\\d+(?:\\.\\d+)?))$", "type": "string", "description": "Interface name eth<0-..> or eth<0-..>.vlanid or loopback when present", "example": "eth0" }, "ip": { "type": "object", "properties": { "address": { "pattern": "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\\/)([0-2]?[0-9]$|[3]?[0-2])$", "type": "string", "description": "Assign IPv4 address", "example": "10.0.1.1/24" }, "dhcpClient": { "type": "boolean", "description": "Enable DHCP", "example": false, "default": false }, "dhcpDistance": { "maximum": 65536, "minimum": 1, "type": "integer", "description": "Set administrative distance for DHCP default route", "format": "int32", "example": 1, "default": 1 } }, "description": "IPv4 address or DHCP", "$$ref": "#/components/schemas/IpConfig" }, "ipv6": { "type": "object", "properties": { "address": { "pattern": "((^\\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))(%.+)?\\s*(\\/)(\\b([0-9]{1,2}|1[01][0-9]|12[0-8])\\b)$))", "type": "string", "description": "Assign IPv6 address", "example": "2001:a0:64::20/64" }, "dhcpClient": { "type": "boolean", "description": "Enable DHCP", "example": false, "default": false }, "dhcpDistance": { "maximum": 65536, "minimum": 1, "type": "integer", "description": "Set administrative distance for DHCP default route", "format": "int32", "example": 1, "default": 1 }, "dhcpRapidCommit": { "type": "boolean", "description": "Enable DHCPv6 rapid commit", "example": false, "default": false } }, "description": "IPv6 address or DHCP", "$$ref": "#/components/schemas/Ipv6Config" }, "shutdown": { "type": "boolean", "description": "Administrative state", "example": false, "default": false } }, "description": "Interfaces configuration", "$$ref": "#/components/schemas/BaseInterfaceSetting" } }, "ipRoute": { "type": "object", "properties": { "route": { "type": "array", "items": { "required": [ "nextHop", "prefix" ], "type": "object", "properties": { "nextHop": { "maxItems": 2147483647, "minItems": 1, "type": "array", "items": { "required": [ "address" ], "type": "object", "properties": { "address": { "pattern": "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "description": "IPv4 Address", "example": "10.0.0.1" }, "distance": { "maximum": 255, "minimum": 1, "type": "integer", "description": "Administrative distance", "format": "int32", "example": 1, "default": 1 } }, "description": "IP gateway address", "$$ref": "#/components/schemas/NextHop" } }, "prefix": { "pattern": "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\\/)([0-2]?[0-9]$|[3]?[0-2])$", "type": "string", "description": "IPv4 Prefix", "example": "0.0.0.0/0" } }, "description": "Configure static routes", "$$ref": "#/components/schemas/StaticRoute" } } }, "description": "IP Route information", "$$ref": "#/components/schemas/IpRoute" }, "ipv6Route": { "type": "object", "properties": { "route": { "type": "array", "items": { "required": [ "nextHop", "prefix" ], "type": "object", "properties": { "nextHop": { "maxItems": 2147483647, "minItems": 1, "type": "array", "items": { "required": [ "address" ], "type": "object", "properties": { "address": { "pattern": "(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))", "type": "string", "description": "IPv6 Address", "example": "2001::1" }, "distance": { "maximum": 255, "minimum": 1, "type": "integer", "description": "Administrative distance", "format": "int32", "example": 1, "default": 1 } }, "description": "IP gateway address", "$$ref": "#/components/schemas/IPV6NextHop" } }, "prefix": { "pattern": "((^\\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))(%.+)?\\s*(\\/)(\\b([0-9]{1,2}|1[01][0-9]|12[0-8])\\b)$))", "type": "string", "description": "IPv6 Prefix", "example": "2001::/4" } }, "description": "Configure IPv6 static routes", "$$ref": "#/components/schemas/Ipv6StaticRoute" } } }, "description": "IPv6 Route information", "$$ref": "#/components/schemas/Ipv6Route" } }, "description": "Management VPN instance", "$$ref": "#/components/schemas/baseVpnInstanceBaseInterfaceSetting" }, "transport": { "required": [ "interface" ], "type": "object", "properties": { "dns": { "type": "object", "properties": { "dnsServerPrimary": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "Primary DNS server IPv4 or IPv6 Address", "example": "10.2.2.2" }, "dnsServerSecondary": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "Secondary DNS server IPv4 or IPv6 Address", "example": "10.2.2.3" }, "host": { "type": "array", "items": { "required": [ "hostname", "ip" ], "type": "object", "properties": { "hostname": { "pattern": "^[a-zA-Z0-9\\-_.]{1,64}$", "type": "string", "description": "Host name", "example": "vbond" }, "ip": { "maxItems": 64, "minItems": 1, "uniqueItems": true, "type": "array", "items": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "IP Address", "example": "10.1.1.1" } } }, "description": "Static host mapping", "$$ref": "#/components/schemas/DnsHostMapping" } } }, "description": "Configure DNS servers or static host mapping", "$$ref": "#/components/schemas/ControlComponentDnsSetting" }, "interface": { "maxItems": 2147483647, "minItems": 1, "type": "array", "items": { "required": [ "ifName" ], "type": "object", "properties": { "ifName": { "pattern": "^(?=.{1,32}$)(?:(ge0\\/\\d+(?:\\.\\d+)?|loopback\\d+|eth\\d+(?:\\.\\d+)?))$", "type": "string", "description": "Interface name eth<0-..> or eth<0-..>.vlanid or loopback when present", "example": "eth0" }, "ip": { "type": "object", "properties": { "address": { "pattern": "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\\/)([0-2]?[0-9]$|[3]?[0-2])$", "type": "string", "description": "Assign IPv4 address", "example": "10.0.1.1/24" }, "dhcpClient": { "type": "boolean", "description": "Enable DHCP", "example": false, "default": false }, "dhcpDistance": { "maximum": 65536, "minimum": 1, "type": "integer", "description": "Set administrative distance for DHCP default route", "format": "int32", "example": 1, "default": 1 } }, "description": "IPv4 address or DHCP", "$$ref": "#/components/schemas/IpConfig" }, "ipv6": { "type": "object", "properties": { "address": { "pattern": "((^\\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))(%.+)?\\s*(\\/)(\\b([0-9]{1,2}|1[01][0-9]|12[0-8])\\b)$))", "type": "string", "description": "Assign IPv6 address", "example": "2001:a0:64::20/64" }, "dhcpClient": { "type": "boolean", "description": "Enable DHCP", "example": false, "default": false }, "dhcpDistance": { "maximum": 65536, "minimum": 1, "type": "integer", "description": "Set administrative distance for DHCP default route", "format": "int32", "example": 1, "default": 1 }, "dhcpRapidCommit": { "type": "boolean", "description": "Enable DHCPv6 rapid commit", "example": false, "default": false } }, "description": "IPv6 address or DHCP", "$$ref": "#/components/schemas/Ipv6Config" }, "shutdown": { "type": "boolean", "description": "Administrative state", "example": false, "default": false }, "tunnelInterface": { "type": "object", "properties": { "allowService": { "type": "object", "properties": { "all": { "type": "boolean", "description": "Allow all traffic. Overrides all other allow-service options if allow-service all is set", "example": false, "default": false }, "dhcp": { "type": "boolean", "description": "Allow/Deny DHCP", "example": true, "default": true }, "dns": { "type": "boolean", "description": "Allow/Deny DNS", "example": true, "default": true }, "icmp": { "type": "boolean", "description": "Allow/Deny ICMP", "example": true, "default": true }, "netconf": { "type": "boolean", "description": "Allow/Deny NETCONF", "example": false, "default": false }, "ntp": { "type": "boolean", "description": "Allow/Deny NTP", "example": false, "default": false }, "sshd": { "type": "boolean", "description": "Allow/Deny SSH", "example": false, "default": false }, "stun": { "type": "boolean", "description": "Allow/Deny STUN", "example": false, "default": false } }, "description": "Set services allowed on the WAN interface", "$$ref": "#/components/schemas/AllowService" }, "color": { "type": "object", "properties": { "value": { "type": "string", "description": "Set color for TLOC", "example": "default", "enum": [ "default", "mpls", "metro-ethernet", "biz-internet", "public-internet", "lte", "3g", "red", "green", "blue", "gold", "silver", "bronze", "custom1", "custom2", "custom3", "private1", "private2", "private3", "private4", "private5", "private6" ], "default": "default" } }, "description": "Set color for TLOC", "$$ref": "#/components/schemas/Color" } }, "description": "Tunnel interface configuration", "$$ref": "#/components/schemas/TunnelInterface" } }, "description": "Interfaces configuration", "$$ref": "#/components/schemas/TransportInterfaceSetting" } }, "ipRoute": { "type": "object", "properties": { "route": { "type": "array", "items": { "required": [ "nextHop", "prefix" ], "type": "object", "properties": { "nextHop": { "maxItems": 2147483647, "minItems": 1, "type": "array", "items": { "required": [ "address" ], "type": "object", "properties": { "address": { "pattern": "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "description": "IPv4 Address", "example": "10.0.0.1" }, "distance": { "maximum": 255, "minimum": 1, "type": "integer", "description": "Administrative distance", "format": "int32", "example": 1, "default": 1 } }, "description": "IP gateway address", "$$ref": "#/components/schemas/NextHop" } }, "prefix": { "pattern": "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\\/)([0-2]?[0-9]$|[3]?[0-2])$", "type": "string", "description": "IPv4 Prefix", "example": "0.0.0.0/0" } }, "description": "Configure static routes", "$$ref": "#/components/schemas/StaticRoute" } } }, "description": "IP Route information", "$$ref": "#/components/schemas/IpRoute" }, "ipv6Route": { "type": "object", "properties": { "route": { "type": "array", "items": { "required": [ "nextHop", "prefix" ], "type": "object", "properties": { "nextHop": { "maxItems": 2147483647, "minItems": 1, "type": "array", "items": { "required": [ "address" ], "type": "object", "properties": { "address": { "pattern": "(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))", "type": "string", "description": "IPv6 Address", "example": "2001::1" }, "distance": { "maximum": 255, "minimum": 1, "type": "integer", "description": "Administrative distance", "format": "int32", "example": 1, "default": 1 } }, "description": "IP gateway address", "$$ref": "#/components/schemas/IPV6NextHop" } }, "prefix": { "pattern": "((^\\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))(%.+)?\\s*(\\/)(\\b([0-9]{1,2}|1[01][0-9]|12[0-8])\\b)$))", "type": "string", "description": "IPv6 Prefix", "example": "2001::/4" } }, "description": "Configure IPv6 static routes", "$$ref": "#/components/schemas/Ipv6StaticRoute" } } }, "description": "IPv6 Route information", "$$ref": "#/components/schemas/Ipv6Route" } }, "description": "Transport VPN instance", "$$ref": "#/components/schemas/baseVpnInstanceTransportInterfaceSetting" } }, "description": "Controller VPN setting", "$$ref": "#/components/schemas/ControllerVpnSetting" } }, "description": "The payload for controller device specific settings", "$$ref": "#/components/schemas/ControllerDeviceSpecificSetting" } }, "$$ref": "#/components/schemas/QueryControllerDeviceSpecificSettingsResponse" }, { "required": [ "createdBy", "createdOn", "payload" ], "type": "object", "properties": { "createdBy": { "type": "string", "description": "The user who created the controller device specific settings", "example": "admin" }, "createdOn": { "type": "integer", "description": "The timestamp when controller device specific settings are created", "format": "int64", "example": 1741315339238 }, "lastUpdatedBy": { "type": "string", "description": "The user who modified the controller device specific settings", "example": "admin" }, "lastUpdatedOn": { "type": "integer", "description": "The timestamp when controller device specific settings are modified", "format": "int64", "example": 1741315339240 }, "payload": { "required": [ "system", "vpn" ], "type": "object", "properties": { "system": { "required": [ "hostName", "siteId", "systemIp" ], "type": "object", "properties": { "clock": { "required": [ "timezone" ], "type": "object", "properties": { "timezone": { "type": "string", "description": "Set the timezone", "example": "UTC", "enum": [ "Europe/Andorra", "Asia/Dubai", "Asia/Kabul", "America/Antigua", "America/Anguilla", "Europe/Tirane", "Asia/Yerevan", "Africa/Luanda", "Antarctica/McMurdo", "Antarctica/Rothera", "Antarctica/Palmer", "Antarctica/Mawson", "Antarctica/Davis", "Antarctica/Casey", "Antarctica/Vostok", "Antarctica/DumontDUrville", "Antarctica/Syowa", "America/Argentina/Buenos_Aires", "America/Argentina/Cordoba", "America/Argentina/Salta", "America/Argentina/Jujuy", "America/Argentina/Tucuman", "America/Argentina/Catamarca", "America/Argentina/La_Rioja", "America/Argentina/San_Juan", "America/Argentina/Mendoza", "America/Argentina/San_Luis", "America/Argentina/Rio_Gallegos", "America/Argentina/Ushuaia", "Pacific/Pago_Pago", "Europe/Vienna", "Australia/Lord_Howe", "Antarctica/Macquarie", "Australia/Hobart", "Australia/Currie", "Australia/Melbourne", "Australia/Sydney", "Australia/Broken_Hill", "Australia/Brisbane", "Australia/Lindeman", "Australia/Adelaide", "Australia/Darwin", "Australia/Perth", "Australia/Eucla", "America/Aruba", "Europe/Mariehamn", "Asia/Baku", "Europe/Sarajevo", "America/Barbados", "Asia/Dhaka", "Europe/Brussels", "Africa/Ouagadougou", "Europe/Sofia", "Asia/Bahrain", "Africa/Bujumbura", "Africa/Porto-Novo", "America/St_Barthelemy", "Atlantic/Bermuda", "Asia/Brunei", "America/La_Paz", "America/Kralendijk", "America/Noronha", "America/Belem", "America/Fortaleza", "America/Recife", "America/Araguaina", "America/Maceio", "America/Bahia", "America/Sao_Paulo", "America/Campo_Grande", "America/Cuiaba", "America/Santarem", "America/Porto_Velho", "America/Boa_Vista", "America/Manaus", "America/Eirunepe", "America/Rio_Branco", "America/Nassau", "Asia/Thimphu", "Africa/Gaborone", "Europe/Minsk", "America/Belize", "America/St_Johns", "America/Halifax", "America/Glace_Bay", "America/Moncton", "America/Goose_Bay", "America/Blanc-Sablon", "America/Toronto", "America/Nipigon", "America/Thunder_Bay", "America/Iqaluit", "America/Pangnirtung", "America/Resolute", "America/Atikokan", "America/Rankin_Inlet", "America/Winnipeg", "America/Rainy_River", "America/Regina", "America/Swift_Current", "America/Edmonton", "America/Cambridge_Bay", "America/Yellowknife", "America/Inuvik", "America/Creston", "America/Dawson_Creek", "America/Vancouver", "America/Whitehorse", "America/Dawson", "Indian/Cocos", "Africa/Kinshasa", "Africa/Lubumbashi", "Africa/Bangui", "Africa/Brazzaville", "Europe/Zurich", "Africa/Abidjan", "Pacific/Rarotonga", "America/Santiago", "Pacific/Easter", "Africa/Douala", "Asia/Shanghai", "Asia/Harbin", "Asia/Chongqing", "Asia/Urumqi", "Asia/Kashgar", "America/Bogota", "America/Costa_Rica", "America/Havana", "Atlantic/Cape_Verde", "America/Curacao", "Indian/Christmas", "Asia/Nicosia", "Europe/Prague", "Europe/Berlin", "Europe/Busingen", "Africa/Djibouti", "Europe/Copenhagen", "America/Dominica", "America/Santo_Domingo", "Africa/Algiers", "America/Guayaquil", "Pacific/Galapagos", "Europe/Tallinn", "Africa/Cairo", "Africa/El_Aaiun", "Africa/Asmara", "Europe/Madrid", "Africa/Ceuta", "Atlantic/Canary", "Africa/Addis_Ababa", "Europe/Helsinki", "Pacific/Fiji", "Atlantic/Stanley", "Pacific/Chuuk", "Pacific/Pohnpei", "Pacific/Kosrae", "Atlantic/Faroe", "Europe/Paris", "Africa/Libreville", "Europe/London", "America/Grenada", "Asia/Tbilisi", "America/Cayenne", "Europe/Guernsey", "Africa/Accra", "Europe/Gibraltar", "America/Godthab", "America/Danmarkshavn", "America/Scoresbysund", "America/Thule", "Africa/Banjul", "Africa/Conakry", "America/Guadeloupe", "Africa/Malabo", "Europe/Athens", "Atlantic/South_Georgia", "America/Guatemala", "Pacific/Guam", "Africa/Bissau", "America/Guyana", "Asia/Hong_Kong", "America/Tegucigalpa", "Europe/Zagreb", "America/Port-au-Prince", "Europe/Budapest", "Asia/Jakarta", "Asia/Pontianak", "Asia/Makassar", "Asia/Jayapura", "Europe/Dublin", "Asia/Jerusalem", "Europe/Isle_of_Man", "Asia/Kolkata", "Indian/Chagos", "Asia/Baghdad", "Asia/Tehran", "Atlantic/Reykjavik", "Europe/Rome", "Europe/Jersey", "America/Jamaica", "Asia/Amman", "Asia/Tokyo", "Africa/Nairobi", "Asia/Bishkek", "Asia/Phnom_Penh", "Pacific/Tarawa", "Pacific/Enderbury", "Pacific/Kiritimati", "Indian/Comoro", "America/St_Kitts", "Asia/Pyongyang", "Asia/Seoul", "Asia/Kuwait", "America/Cayman", "Asia/Almaty", "Asia/Qyzylorda", "Asia/Aqtobe", "Asia/Aqtau", "Asia/Oral", "Asia/Vientiane", "Asia/Beirut", "America/St_Lucia", "Europe/Vaduz", "Asia/Colombo", "Africa/Monrovia", "Africa/Maseru", "Europe/Vilnius", "Europe/Luxembourg", "Europe/Riga", "Africa/Tripoli", "Africa/Casablanca", "Europe/Monaco", "Europe/Chisinau", "Europe/Podgorica", "America/Marigot", "Indian/Antananarivo", "Pacific/Majuro", "Pacific/Kwajalein", "Europe/Skopje", "Africa/Bamako", "Asia/Rangoon", "Asia/Ulaanbaatar", "Asia/Hovd", "Asia/Choibalsan", "Asia/Macau", "Pacific/Saipan", "America/Martinique", "Africa/Nouakchott", "America/Montserrat", "Europe/Malta", "Indian/Mauritius", "Indian/Maldives", "Africa/Blantyre", "America/Mexico_City", "America/Cancun", "America/Merida", "America/Monterrey", "America/Matamoros", "America/Mazatlan", "America/Chihuahua", "America/Ojinaga", "America/Hermosillo", "America/Tijuana", "America/Santa_Isabel", "America/Bahia_Banderas", "Asia/Kuala_Lumpur", "Asia/Kuching", "Africa/Maputo", "Africa/Windhoek", "Pacific/Noumea", "Africa/Niamey", "Pacific/Norfolk", "Africa/Lagos", "America/Managua", "Europe/Amsterdam", "Europe/Oslo", "Asia/Kathmandu", "Pacific/Nauru", "Pacific/Niue", "Pacific/Auckland", "Pacific/Chatham", "Asia/Muscat", "America/Panama", "America/Lima", "Pacific/Tahiti", "Pacific/Marquesas", "Pacific/Gambier", "Pacific/Port_Moresby", "Asia/Manila", "Asia/Karachi", "Europe/Warsaw", "America/Miquelon", "Pacific/Pitcairn", "America/Puerto_Rico", "Asia/Gaza", "Asia/Hebron", "Europe/Lisbon", "Atlantic/Madeira", "Atlantic/Azores", "Pacific/Palau", "America/Asuncion", "Asia/Qatar", "Indian/Reunion", "Europe/Bucharest", "Europe/Belgrade", "Europe/Kaliningrad", "Europe/Moscow", "Europe/Volgograd", "Europe/Samara", "Asia/Yekaterinburg", "Asia/Omsk", "Asia/Novosibirsk", "Asia/Novokuznetsk", "Asia/Krasnoyarsk", "Asia/Irkutsk", "Asia/Yakutsk", "Asia/Khandyga", "Asia/Vladivostok", "Asia/Sakhalin", "Asia/Ust-Nera", "Asia/Magadan", "Asia/Kamchatka", "Asia/Anadyr", "Africa/Kigali", "Asia/Riyadh", "Pacific/Guadalcanal", "Indian/Mahe", "Africa/Khartoum", "Europe/Stockholm", "Asia/Singapore", "Atlantic/St_Helena", "Europe/Ljubljana", "Arctic/Longyearbyen", "Europe/Bratislava", "Africa/Freetown", "Europe/San_Marino", "Africa/Dakar", "Africa/Mogadishu", "America/Paramaribo", "Africa/Juba", "Africa/Sao_Tome", "America/El_Salvador", "America/Lower_Princes", "Asia/Damascus", "Africa/Mbabane", "America/Grand_Turk", "Africa/Ndjamena", "Indian/Kerguelen", "Africa/Lome", "Asia/Bangkok", "Asia/Dushanbe", "Pacific/Fakaofo", "Asia/Dili", "Asia/Ashgabat", "Africa/Tunis", "Pacific/Tongatapu", "Europe/Istanbul", "America/Port_of_Spain", "Pacific/Funafuti", "Asia/Taipei", "Africa/Dar_es_Salaam", "Europe/Kiev", "Europe/Uzhgorod", "Europe/Zaporozhye", "Europe/Simferopol", "Africa/Kampala", "Pacific/Johnston", "Pacific/Midway", "Pacific/Wake", "America/New_York", "America/Detroit", "America/Kentucky/Louisville", "America/Kentucky/Monticello", "America/Indiana/Indianapolis", "America/Indiana/Vincennes", "America/Indiana/Winamac", "America/Indiana/Marengo", "America/Indiana/Petersburg", "America/Indiana/Vevay", "America/Chicago", "America/Indiana/Tell_City", "America/Indiana/Knox", "America/Menominee", "America/North_Dakota/Center", "America/North_Dakota/New_Salem", "America/North_Dakota/Beulah", "America/Denver", "America/Boise", "America/Phoenix", "America/Los_Angeles", "America/Anchorage", "America/Juneau", "America/Sitka", "America/Yakutat", "America/Nome", "America/Adak", "America/Metlakatla", "Pacific/Honolulu", "America/Montevideo", "Asia/Samarkand", "Asia/Tashkent", "Europe/Vatican", "America/St_Vincent", "America/Caracas", "America/Tortola", "America/St_Thomas", "Asia/Ho_Chi_Minh", "Pacific/Efate", "Pacific/Wallis", "Pacific/Apia", "Asia/Aden", "Indian/Mayotte", "Africa/Johannesburg", "Africa/Lusaka", "Africa/Harare", "UTC" ], "default": "UTC" } }, "description": "Configure clock", "$$ref": "#/components/schemas/Clock" }, "description": { "pattern": "^[^<>]{1,32}$", "type": "string", "description": "Set a text description of the device", "example": "System settings" }, "deviceGroups": { "type": "array", "description": "Configure device groups", "items": { "type": "string", "description": "Configure device groups" } }, "gpsLocation": { "required": [ "latitude", "longitude" ], "type": "object", "properties": { "latitude": { "maximum": 90, "minimum": -90, "type": "number", "description": "Set the device\u2019s physical latitude", "example": 60 }, "longitude": { "maximum": 180, "minimum": -180, "type": "number", "description": "Set the device\u2019s physical longitude", "example": 60 } }, "description": "GPS latitude and longitude of the device", "$$ref": "#/components/schemas/GpsLocation" }, "hostName": { "pattern": "^[a-zA-Z0-9\\-_]{1,32}$", "type": "string", "description": "Set the hostname", "example": "vm12" }, "location": { "pattern": "^[^<>]{1,127}$", "type": "string", "description": "Set the location of the device", "example": "USA" }, "siteId": { "maximum": 4294967295, "minimum": 0, "type": "integer", "description": "Set the site ID", "format": "int64", "example": 100 }, "systemIp": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "Set the system IP address", "example": "102.2.3.2" }, "vbond": { "required": [ "address" ], "type": "object", "properties": { "address": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "Set the vBond IP address", "example": "10.0.12.22" } }, "$$ref": "#/components/schemas/Vbond" } }, "description": "System configuration for validator", "$$ref": "#/components/schemas/ValidatorSystemSetting" }, "vpn": { "required": [ "transport" ], "type": "object", "properties": { "management": { "required": [ "interface" ], "type": "object", "properties": { "dns": { "type": "object", "properties": { "dnsServerPrimary": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "Primary DNS server IPv4 or IPv6 Address", "example": "10.2.2.2" }, "dnsServerSecondary": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "Secondary DNS server IPv4 or IPv6 Address", "example": "10.2.2.3" }, "host": { "type": "array", "items": { "required": [ "hostname", "ip" ], "type": "object", "properties": { "hostname": { "pattern": "^[a-zA-Z0-9\\-_.]{1,64}$", "type": "string", "description": "Host name", "example": "vbond" }, "ip": { "maxItems": 64, "minItems": 1, "uniqueItems": true, "type": "array", "items": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "IP Address", "example": "10.1.1.1" } } }, "description": "Static host mapping", "$$ref": "#/components/schemas/DnsHostMapping" } } }, "description": "Configure DNS servers or static host mapping", "$$ref": "#/components/schemas/ControlComponentDnsSetting" }, "interface": { "maxItems": 2147483647, "minItems": 1, "type": "array", "items": { "required": [ "ifName" ], "type": "object", "properties": { "ifName": { "pattern": "^(?=.{1,32}$)(?:(ge0\\/\\d+(?:\\.\\d+)?|loopback\\d+|eth\\d+(?:\\.\\d+)?))$", "type": "string", "description": "Interface name eth<0-..> or eth<0-..>.vlanid or loopback when present", "example": "eth0" }, "ip": { "type": "object", "properties": { "address": { "pattern": "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\\/)([0-2]?[0-9]$|[3]?[0-2])$", "type": "string", "description": "Assign IPv4 address", "example": "10.0.1.1/24" }, "dhcpClient": { "type": "boolean", "description": "Enable DHCP", "example": false, "default": false }, "dhcpDistance": { "maximum": 65536, "minimum": 1, "type": "integer", "description": "Set administrative distance for DHCP default route", "format": "int32", "example": 1, "default": 1 } }, "description": "IPv4 address or DHCP", "$$ref": "#/components/schemas/IpConfig" }, "ipv6": { "type": "object", "properties": { "address": { "pattern": "((^\\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))(%.+)?\\s*(\\/)(\\b([0-9]{1,2}|1[01][0-9]|12[0-8])\\b)$))", "type": "string", "description": "Assign IPv6 address", "example": "2001:a0:64::20/64" }, "dhcpClient": { "type": "boolean", "description": "Enable DHCP", "example": false, "default": false }, "dhcpDistance": { "maximum": 65536, "minimum": 1, "type": "integer", "description": "Set administrative distance for DHCP default route", "format": "int32", "example": 1, "default": 1 }, "dhcpRapidCommit": { "type": "boolean", "description": "Enable DHCPv6 rapid commit", "example": false, "default": false } }, "description": "IPv6 address or DHCP", "$$ref": "#/components/schemas/Ipv6Config" }, "shutdown": { "type": "boolean", "description": "Administrative state", "example": false, "default": false } }, "description": "Interfaces configuration", "$$ref": "#/components/schemas/BaseInterfaceSetting" } }, "ipRoute": { "type": "object", "properties": { "route": { "type": "array", "items": { "required": [ "nextHop", "prefix" ], "type": "object", "properties": { "nextHop": { "maxItems": 2147483647, "minItems": 1, "type": "array", "items": { "required": [ "address" ], "type": "object", "properties": { "address": { "pattern": "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "description": "IPv4 Address", "example": "10.0.0.1" }, "distance": { "maximum": 255, "minimum": 1, "type": "integer", "description": "Administrative distance", "format": "int32", "example": 1, "default": 1 } }, "description": "IP gateway address", "$$ref": "#/components/schemas/NextHop" } }, "prefix": { "pattern": "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\\/)([0-2]?[0-9]$|[3]?[0-2])$", "type": "string", "description": "IPv4 Prefix", "example": "0.0.0.0/0" } }, "description": "Configure static routes", "$$ref": "#/components/schemas/StaticRoute" } } }, "description": "IP Route information", "$$ref": "#/components/schemas/IpRoute" }, "ipv6Route": { "type": "object", "properties": { "route": { "type": "array", "items": { "required": [ "nextHop", "prefix" ], "type": "object", "properties": { "nextHop": { "maxItems": 2147483647, "minItems": 1, "type": "array", "items": { "required": [ "address" ], "type": "object", "properties": { "address": { "pattern": "(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))", "type": "string", "description": "IPv6 Address", "example": "2001::1" }, "distance": { "maximum": 255, "minimum": 1, "type": "integer", "description": "Administrative distance", "format": "int32", "example": 1, "default": 1 } }, "description": "IP gateway address", "$$ref": "#/components/schemas/IPV6NextHop" } }, "prefix": { "pattern": "((^\\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))(%.+)?\\s*(\\/)(\\b([0-9]{1,2}|1[01][0-9]|12[0-8])\\b)$))", "type": "string", "description": "IPv6 Prefix", "example": "2001::/4" } }, "description": "Configure IPv6 static routes", "$$ref": "#/components/schemas/Ipv6StaticRoute" } } }, "description": "IPv6 Route information", "$$ref": "#/components/schemas/Ipv6Route" } }, "description": "Management VPN instance", "$$ref": "#/components/schemas/baseVpnInstanceBaseInterfaceSetting" }, "transport": { "required": [ "interface" ], "type": "object", "properties": { "dns": { "type": "object", "properties": { "dnsServerPrimary": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "Primary DNS server IPv4 or IPv6 Address", "example": "10.2.2.2" }, "dnsServerSecondary": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "Secondary DNS server IPv4 or IPv6 Address", "example": "10.2.2.3" }, "host": { "type": "array", "items": { "required": [ "hostname", "ip" ], "type": "object", "properties": { "hostname": { "pattern": "^[a-zA-Z0-9\\-_.]{1,64}$", "type": "string", "description": "Host name", "example": "vbond" }, "ip": { "maxItems": 64, "minItems": 1, "uniqueItems": true, "type": "array", "items": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "IP Address", "example": "10.1.1.1" } } }, "description": "Static host mapping", "$$ref": "#/components/schemas/DnsHostMapping" } } }, "description": "Configure DNS servers or static host mapping", "$$ref": "#/components/schemas/ControlComponentDnsSetting" }, "interface": { "maxItems": 2147483647, "minItems": 1, "type": "array", "items": { "required": [ "ifName" ], "type": "object", "properties": { "ifName": { "pattern": "^(?=.{1,32}$)(?:(ge0\\/\\d+(?:\\.\\d+)?|loopback\\d+|eth\\d+(?:\\.\\d+)?))$", "type": "string", "description": "Interface name eth<0-..> or eth<0-..>.vlanid or loopback when present", "example": "eth0" }, "ip": { "type": "object", "properties": { "address": { "pattern": "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\\/)([0-2]?[0-9]$|[3]?[0-2])$", "type": "string", "description": "Assign IPv4 address", "example": "10.0.1.1/24" }, "dhcpClient": { "type": "boolean", "description": "Enable DHCP", "example": false, "default": false }, "dhcpDistance": { "maximum": 65536, "minimum": 1, "type": "integer", "description": "Set administrative distance for DHCP default route", "format": "int32", "example": 1, "default": 1 } }, "description": "IPv4 address or DHCP", "$$ref": "#/components/schemas/IpConfig" }, "ipv6": { "type": "object", "properties": { "address": { "pattern": "((^\\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))(%.+)?\\s*(\\/)(\\b([0-9]{1,2}|1[01][0-9]|12[0-8])\\b)$))", "type": "string", "description": "Assign IPv6 address", "example": "2001:a0:64::20/64" }, "dhcpClient": { "type": "boolean", "description": "Enable DHCP", "example": false, "default": false }, "dhcpDistance": { "maximum": 65536, "minimum": 1, "type": "integer", "description": "Set administrative distance for DHCP default route", "format": "int32", "example": 1, "default": 1 }, "dhcpRapidCommit": { "type": "boolean", "description": "Enable DHCPv6 rapid commit", "example": false, "default": false } }, "description": "IPv6 address or DHCP", "$$ref": "#/components/schemas/Ipv6Config" }, "shutdown": { "type": "boolean", "description": "Administrative state", "example": false, "default": false }, "tunnelInterface": { "type": "object", "properties": { "allowService": { "type": "object", "properties": { "all": { "type": "boolean", "description": "Allow all traffic. Overrides all other allow-service options if allow-service all is set", "example": false, "default": false }, "dhcp": { "type": "boolean", "description": "Allow/Deny DHCP", "example": true, "default": true }, "dns": { "type": "boolean", "description": "Allow/Deny DNS", "example": true, "default": true }, "icmp": { "type": "boolean", "description": "Allow/Deny ICMP", "example": true, "default": true }, "netconf": { "type": "boolean", "description": "Allow/Deny NETCONF", "example": false, "default": false }, "ntp": { "type": "boolean", "description": "Allow/Deny NTP", "example": false, "default": false }, "sshd": { "type": "boolean", "description": "Allow/Deny SSH", "example": false, "default": false }, "stun": { "type": "boolean", "description": "Allow/Deny STUN", "example": false, "default": false } }, "description": "Set services allowed on the WAN interface", "$$ref": "#/components/schemas/AllowService" }, "color": { "type": "object", "properties": { "value": { "type": "string", "description": "Set color for TLOC", "example": "default", "enum": [ "default", "mpls", "metro-ethernet", "biz-internet", "public-internet", "lte", "3g", "red", "green", "blue", "gold", "silver", "bronze", "custom1", "custom2", "custom3", "private1", "private2", "private3", "private4", "private5", "private6" ], "default": "default" } }, "description": "Set color for TLOC", "$$ref": "#/components/schemas/Color" } }, "description": "Tunnel interface configuration", "$$ref": "#/components/schemas/TunnelInterface" } }, "description": "Interfaces configuration", "$$ref": "#/components/schemas/TransportInterfaceSetting" } }, "ipRoute": { "type": "object", "properties": { "route": { "type": "array", "items": { "required": [ "nextHop", "prefix" ], "type": "object", "properties": { "nextHop": { "maxItems": 2147483647, "minItems": 1, "type": "array", "items": { "required": [ "address" ], "type": "object", "properties": { "address": { "pattern": "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "description": "IPv4 Address", "example": "10.0.0.1" }, "distance": { "maximum": 255, "minimum": 1, "type": "integer", "description": "Administrative distance", "format": "int32", "example": 1, "default": 1 } }, "description": "IP gateway address", "$$ref": "#/components/schemas/NextHop" } }, "prefix": { "pattern": "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\\/)([0-2]?[0-9]$|[3]?[0-2])$", "type": "string", "description": "IPv4 Prefix", "example": "0.0.0.0/0" } }, "description": "Configure static routes", "$$ref": "#/components/schemas/StaticRoute" } } }, "description": "IP Route information", "$$ref": "#/components/schemas/IpRoute" }, "ipv6Route": { "type": "object", "properties": { "route": { "type": "array", "items": { "required": [ "nextHop", "prefix" ], "type": "object", "properties": { "nextHop": { "maxItems": 2147483647, "minItems": 1, "type": "array", "items": { "required": [ "address" ], "type": "object", "properties": { "address": { "pattern": "(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))", "type": "string", "description": "IPv6 Address", "example": "2001::1" }, "distance": { "maximum": 255, "minimum": 1, "type": "integer", "description": "Administrative distance", "format": "int32", "example": 1, "default": 1 } }, "description": "IP gateway address", "$$ref": "#/components/schemas/IPV6NextHop" } }, "prefix": { "pattern": "((^\\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))(%.+)?\\s*(\\/)(\\b([0-9]{1,2}|1[01][0-9]|12[0-8])\\b)$))", "type": "string", "description": "IPv6 Prefix", "example": "2001::/4" } }, "description": "Configure IPv6 static routes", "$$ref": "#/components/schemas/Ipv6StaticRoute" } } }, "description": "IPv6 Route information", "$$ref": "#/components/schemas/Ipv6Route" } }, "description": "Transport VPN instance", "$$ref": "#/components/schemas/baseVpnInstanceTransportInterfaceSetting" } }, "description": "Validator VPN setting", "$$ref": "#/components/schemas/ValidatorVpnSetting" } }, "description": "The payload for validator device specific settings", "$$ref": "#/components/schemas/ValidatorDeviceSpecificSetting" } }, "$$ref": "#/components/schemas/QueryValidatorDeviceSpecificSettingsResponse" } ] }, "examples": { "AutoGeneratedControllerDeviceSpecificSettings": { "description": "AutoGeneratedControllerDeviceSpecificSettings", "value": { "createdBy": "admin", "createdOn": 1741315339238, "lastUpdatedBy": "admin", "lastUpdatedOn": 1741315439238, "payload": { "system": { "systemIp": "172.16.255.20", "hostName": "Controller01", "description": "Controller 1", "siteId": 200, "location": "Shang hai", "systemTunnelMtu": 2000, "gpsLocation": { "latitude": 90, "longitude": 180 }, "clock": { "timezone": "Europe/Andorra" }, "deviceGroups": [ "group1" ], "overlayId": 3, "ipv6StrictControl": true, "controllerGroupId": 1 }, "vpn": { "transport": { "ipRoute": { "route": [ { "prefix": "0.0.0.0/0", "nextHop": [ { "address": "10.0.12.13", "distance": 1 } ] } ] }, "ipv6Route": { "route": [ { "prefix": "::/0", "nextHop": [ { "address": "2001:a0:c::d" } ] } ] }, "interface": [ { "ifName": "eth0", "ip": { "address": "10.0.1.30/24" }, "ipv6": { "address": "2001:a0:1::1e/64" }, "shutdown": false }, { "ifName": "eth1", "ip": { "address": "10.0.12.20/24" }, "ipv6": { "address": "2001:a0:c::14/64" }, "tunnelInterface": { "allowService": { "all": true, "dhcp": true, "dns": true, "icmp": true, "sshd": false, "netconf": false, "ntp": false, "stun": false } }, "shutdown": false } ] }, "management": { "interface": [ { "ifName": "eth2", "ip": { "address": "10.2.2.20/24" }, "ipv6": { "address": "2001:a2:2::14/64" }, "shutdown": false } ] } } } }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigControlcomponentSettingResponseExampleQuerycontrollerdevicespecificsettings" }, "AutoGeneratedValidatorDeviceSpecificSettings": { "description": "AutoGeneratedValidatorDeviceSpecificSettings", "value": { "createdBy": "admin", "createdOn": 1741315339238, "lastUpdatedBy": "admin", "lastUpdatedOn": 1741315439238, "payload": { "system": { "systemIp": "172.16.255.19", "hostName": "Validator01", "description": "validator 1", "siteId": 100, "location": "Shang hai", "gpsLocation": { "latitude": 90, "longitude": 180 }, "clock": { "timezone": "Europe/Andorra" }, "deviceGroups": [ "group1" ], "vbond": { "address": "10.0.1.26" } }, "vpn": { "transport": { "ipRoute": { "route": [ { "prefix": "0.0.0.0/0", "nextHop": [ { "address": "10.0.5.13", "distance": 1 } ] } ] }, "ipv6Route": { "route": [ { "prefix": "::/0", "nextHop": [ { "address": "2001:a0:5::d" } ] } ] }, "interface": [ { "ifName": "eth0", "ip": { "address": "10.0.1.19/24" }, "ipv6": { "address": "2001:a0:1::13/64" }, "shutdown": false }, { "ifName": "eth1", "ip": { "address": "10.0.5.19/24" }, "ipv6": { "address": "2001:a0:5::13/64" }, "shutdown": false }, { "ifName": "eth3", "ip": { "address": "10.1.15.19/24" }, "ipv6": { "address": "2001:a1:f::13/64" }, "shutdown": false } ] }, "management": { "interface": [ { "ifName": "eth2", "ip": { "address": "10.2.2.19/24" }, "ipv6": { "address": "2001:a2:2::13/64" }, "shutdown": false } ] } } } }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigControlcomponentSettingResponseExampleQueryvalidatordevicespecificsettings" }, "AutoGeneratedManagerDeviceSpecificSettings": { "description": "AutoGeneratedManagerDeviceSpecificSettings", "value": { "createdBy": "admin", "createdOn": 1743658574232, "payload": { "system": { "systemIp": "172.16.255.22", "hostName": "Manager01", "clock": { "timezone": "UTC" }, "siteId": 200, "ipv6StrictControl": false }, "vpn": { "transport": { "ipRoute": { "route": [ { "prefix": "0.0.0.0/0", "nextHop": [ { "address": "10.0.12.13", "distance": 1 } ] } ] }, "interface": [ { "ifName": "eth0", "ip": { "dhcpClient": true, "dhcpDistance": 1 }, "ipv6": { "dhcpClient": true, "dhcpDistance": 1, "dhcpRapidCommit": false }, "shutdown": false }, { "ifName": "eth1", "ip": { "address": "10.0.12.22/24" }, "shutdown": false, "tunnelInterface": { "color": { "value": "default" }, "allowService": { "all": false, "dhcp": true, "dns": true, "icmp": true, "sshd": false, "netconf": false, "ntp": false, "stun": false } } }, { "ifName": "eth2", "ip": { "address": "10.0.5.22/24" }, "shutdown": false }, { "ifName": "eth5", "ip": { "address": "10.0.105.32/24" }, "shutdown": false } ] }, "management": { "interface": [ { "ifName": "eth3", "ip": { "address": "10.2.4.22/24" }, "shutdown": false } ] } } } }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigControlcomponentSettingResponseExampleQuerymanagerdevicespecificsettings" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "required": [ "error" ], "type": "object", "properties": { "error": { "required": [ "code", "details", "message", "type" ], "type": "object", "properties": { "code": { "type": "string", "description": "Internal error code", "example": "CCS0018" }, "details": { "type": "string", "description": "Error message detail", "example": "Unrecognized field user1" }, "message": { "type": "string", "description": "Error message summary", "example": "Invalid control component setting payload" }, "type": { "type": "string", "description": "Error message title", "example": "error" } }, "description": "Error response", "$$ref": "#/components/schemas/ErrorDetails" } }, "$$ref": "#/components/schemas/ErrorResponse" }, "examples": { "InvalidControlComponentDeviceId": { "description": "InvalidControlComponentDeviceId", "value": { "error": { "message": "Invalid control component device ID, only support controller,validator and manager", "code": "CCS0010", "details": "Device 73a7730e-9d48-463a-8c7f-924f6edd951c is not existed", "type": "error" } }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigControlcomponentSettingResponseExampleInvalidcontrolcomponentdeviceidresponse" } } } } }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Control Component Settings-write" } }, "/v1/control-component/devices/{deviceId}/settings/preview": { "get": { "tags": [ "Configuration - Control Component Setting" ], "description": "Preview the CLI configuration for a specific control component. The deviceId can be obtained from the \"uuid\" field in the data returned by the API (GET /dataservice/certificate/data/controller/list)", "operationId": "getPreviewCliForControlComponent", "parameters": [ { "name": "deviceId", "in": "path", "description": "Control component device UUID", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "required": [ "attachedConfig", "newConfig" ], "type": "object", "properties": { "attachedConfig": { "type": "string", "description": "Current running config CLI for specific control component", "example": "system\n pseudo-confirm-commit 300\n host-name Controller01" }, "newConfig": { "type": "string", "description": "Generated intent config CLI for specific control component", "example": "system\n pseudo-confirm-commit 300\n host-name Controller01" } }, "$$ref": "#/components/schemas/ControlComponentPreviewCliResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "required": [ "error" ], "type": "object", "properties": { "error": { "required": [ "code", "details", "message", "type" ], "type": "object", "properties": { "code": { "type": "string", "description": "Internal error code", "example": "CCS0018" }, "details": { "type": "string", "description": "Error message detail", "example": "Unrecognized field user1" }, "message": { "type": "string", "description": "Error message summary", "example": "Invalid control component setting payload" }, "type": { "type": "string", "description": "Error message title", "example": "error" } }, "description": "Error response", "$$ref": "#/components/schemas/ErrorDetails" } }, "$$ref": "#/components/schemas/ErrorResponse" }, "examples": { "InvalidControlComponentDeviceId": { "description": "InvalidControlComponentDeviceId", "value": { "error": { "message": "Invalid control component device ID, only support controller,validator and manager", "code": "CCS0010", "details": "Device 73a7730e-9d48-463a-8c7f-924f6edd951c is not existed", "type": "error" } }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigControlcomponentSettingResponseExampleInvalidcontrolcomponentdeviceidresponse" } } } } }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "required": [ "error" ], "type": "object", "properties": { "error": { "required": [ "code", "details", "message", "type" ], "type": "object", "properties": { "code": { "type": "string", "description": "Internal error code", "example": "CCS0018" }, "details": { "type": "string", "description": "Error message detail", "example": "Unrecognized field user1" }, "message": { "type": "string", "description": "Error message summary", "example": "Invalid control component setting payload" }, "type": { "type": "string", "description": "Error message title", "example": "error" } }, "description": "Error response", "$$ref": "#/components/schemas/ErrorDetails" } }, "$$ref": "#/components/schemas/ErrorResponse" }, "examples": { "PreviewFailedForSettingsNotConfigured": { "description": "PreviewFailedForSettingsNotConfigured", "value": { "error": { "message": "Did not find the network settings for any control components", "code": "CCS0005", "details": "Control component common settings are not configured", "type": "error" } }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigControlcomponentSettingResponseExampleGetcommonsettingsnotfoundresponse" } } } } }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Control Component Settings-read" } }, "/v1/control-component/network-settings": { "get": { "tags": [ "Configuration - Control Component Setting" ], "description": "Get the network settings for all control components", "operationId": "getControlComponentCommonSettings", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "required": [ "createdBy", "createdOn", "payload" ], "type": "object", "properties": { "createdBy": { "type": "string", "description": "The user who created the control component common settings", "example": "admin" }, "createdOn": { "type": "integer", "description": "The timestamp when control component common settings are created", "format": "int64", "example": 1741315339238 }, "lastUpdatedBy": { "type": "string", "description": "The user who modified the control component common settings", "example": "admin" }, "lastUpdatedOn": { "type": "integer", "description": "The timestamp when control component settings are modified", "format": "int64", "example": 1741315339240 }, "payload": { "required": [ "aaa", "ntp" ], "type": "object", "properties": { "aaa": { "required": [ "authOrder", "user" ], "type": "object", "properties": { "accounting": { "type": "boolean", "description": "Enable/disable user accounting", "example": false, "default": false }, "adminAuthOrder": { "type": "boolean", "description": "Authenticate admin user as per auth-order", "example": false, "default": false }, "authFallback": { "type": "boolean", "description": "Fall back if higher-priority authentication fails", "example": false, "default": false }, "authOrder": { "maxItems": 3, "minItems": 1, "uniqueItems": true, "type": "array", "items": { "type": "string", "description": "Authentication order list", "example": "local", "enum": [ "local", "radius", "tacacs" ] } }, "ciscoTacRoUser": { "type": "boolean", "description": "Cisco Tac Enable Read only", "default": true }, "ciscoTacRwUser": { "type": "boolean", "description": "Cisco Tac Enable Read and Write", "default": true }, "logs": { "type": "object", "properties": { "auditDisable": { "type": "boolean", "description": "Disable audit logs", "default": false }, "netconfDisable": { "type": "boolean", "description": "Disable Netconf logs", "default": false } }, "description": "Enable/Disable audit or netconf logs", "$$ref": "#/components/schemas/AaaLogs" }, "radius": { "type": "object", "properties": { "retransmit": { "maximum": 1000, "minimum": 1, "type": "integer", "description": "Configure how many times to contact each RADIUS server", "format": "int32", "example": 3, "default": 3 }, "server": { "maxItems": 8, "minItems": 0, "type": "array", "description": "RADIUS server configuration", "items": { "required": [ "address", "secretKey" ], "type": "object", "properties": { "acctPort": { "maximum": 65535, "minimum": 0, "type": "integer", "description": "Accounting Port", "format": "int32", "example": 1813, "default": 1813 }, "address": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "Set IP address of RADIUS server", "example": "1.2.2.2" }, "authPort": { "maximum": 65535, "minimum": 0, "type": "integer", "description": "Authentication Port", "format": "int32", "example": 1812, "default": 1812 }, "priority": { "maximum": 7, "minimum": 0, "type": "integer", "description": "Priority", "format": "int32", "example": 1, "default": 0 }, "secretKey": { "pattern": "^(?:\\$CRYPT\\$.{17}|(?!(?:\\$CRYPT\\$)).{1,128})$", "type": "string", "description": "Secret key", "example": "password" }, "tag": { "maxLength": 16, "minLength": 4, "pattern": "^[a-zA-Z0-9\\-_]*$", "type": "string", "description": "Reference tag/name for the server", "example": "radius-server1" }, "vpn": { "type": "integer", "description": "VPN ID", "format": "int32", "example": 0, "enum": [ 0, 512 ], "default": 0 } }, "description": "Configure the RADIUS server", "$$ref": "#/components/schemas/ControlComponentAaaRadiusServer" } }, "timeout": { "maximum": 1000, "minimum": 1, "type": "integer", "description": "Configure how long to wait for replies from the RADIUS server", "format": "int32", "example": 5, "default": 5 } }, "description": "Radius configuration", "$$ref": "#/components/schemas/Radius" }, "radiusServers": { "uniqueItems": true, "type": "array", "items": { "type": "string", "description": "Designate radius server tags for authentication and accounting", "example": "radius-tag1" } }, "tacacs": { "type": "object", "properties": { "authentication": { "type": "string", "description": "TACACS authentication type", "enum": [ "pap", "ascii" ], "default": "pap" }, "servers": { "maxItems": 8, "minItems": 0, "type": "array", "description": "List of TACACS servers", "items": { "required": [ "address", "secretKey" ], "type": "object", "properties": { "acctPort": { "maximum": 65535, "minimum": 0, "type": "integer", "description": "Accounting Port", "format": "int32", "default": 49 }, "address": { "type": "string", "description": "Set IP address of TACACS server", "example": "1.2.2.2" }, "authPort": { "maximum": 65535, "minimum": 0, "type": "integer", "description": "Authentication Port", "format": "int32", "default": 49 }, "priority": { "maximum": 7, "minimum": 0, "type": "integer", "description": "TACACS server priority <0..7>", "format": "int32", "example": 1, "default": 0 }, "secretKey": { "pattern": "^(?:\\$CRYPT\\$.{17}|(?!(?:\\$CRYPT\\$)).{1,128})$", "type": "string", "description": "TACACS server password", "example": "Password123" }, "vpn": { "type": "integer", "description": "VPN ID", "format": "int32", "example": 0, "enum": [ 0, 512 ], "default": 0 } }, "description": "Configure the TACACS server", "$$ref": "#/components/schemas/TacacsServer" } }, "timeout": { "maximum": 1000, "minimum": 1, "type": "integer", "description": "Configure how long to wait for replies from the TACACS server", "format": "int32", "default": 5 } }, "description": "TACACS configuration", "$$ref": "#/components/schemas/Tacacs" }, "user": { "maxItems": 2147483647, "minItems": 1, "type": "array", "description": "Create local login account", "items": { "required": [ "name", "password" ], "type": "object", "properties": { "name": { "maxLength": 128, "minLength": 1, "pattern": "^(?!(?:root|daemon|bin|sys|sync|games|man|lp|mail|news|uucp|proxy|www-data|backup|list|irc|gnats|nobody|basic|sshd|quagga|vmanage-admin|vmanage|viptela-reserved)$)[a-z][a-z0-9._-]*$", "type": "string", "description": "User name", "example": "admin" }, "password": { "pattern": "^(?:\\$CRYPT\\$.{17}|(?!(?:\\$CRYPT\\$)).{1,128})$", "type": "string", "description": "User password, either a encrypted string starting with $CRYPT$, or a clear text string of length 1\u2013128", "example": "password" }, "userGroup": { "type": "string", "description": "User group name which user belongs to", "example": "netadmin", "enum": [ "basic", "operator", "netadmin" ] } }, "description": "Create local login account", "$$ref": "#/components/schemas/AaaLocalUser" } } }, "description": "Configure local users, TACACS or RADIUS servers for control components", "$$ref": "#/components/schemas/ControlComponentAaaSetting" }, "banner": { "required": [ "enableFeature" ], "type": "object", "properties": { "enableFeature": { "type": "boolean", "description": "Enable Banner feature or not", "default": false }, "loginMessage": { "maxLength": 2048, "minLength": 1, "type": "string", "description": "Set message to display before login prompt", "example": "Hello user" }, "motdMessage": { "maxLength": 2048, "minLength": 1, "type": "string", "description": "Set message to display after a user logs in", "example": "Hello" } }, "description": "Banner configuration", "$$ref": "#/components/schemas/ControlComponentBannerSetting" }, "controller": { "type": "object", "properties": { "hubSpokeTopology": { "type": "boolean", "description": "Hub & spoke topology", "default": false }, "omp": { "type": "object", "properties": { "controllerSendPathLimit": { "maximum": 128, "minimum": 4, "type": "integer", "description": "Limit number of paths sent to vSmart controller for a prefix", "format": "int32", "example": 20 }, "discardRejected": { "type": "boolean", "description": "Enable/Disable storage of information rejected by policy", "example": false, "default": false }, "filterRoute": { "required": [ "outbound" ], "type": "object", "properties": { "outbound": { "type": "object", "properties": { "affinityGroupPreference": { "type": "boolean", "description": "Filter routes based on affinity preference list", "example": false, "default": false }, "tlocColor": { "type": "boolean", "description": "Filter routes based on TLOC color compatibility list", "example": false, "default": false } }, "$$ref": "#/components/schemas/Outbound" } }, "description": "OMP filter route configuration", "$$ref": "#/components/schemas/OmpFilterRoute" }, "gracefulRestart": { "type": "boolean", "description": "Enable/Disable graceful restart", "example": true, "default": true }, "outboundPolicyCaching": { "type": "boolean" }, "sendBackupPaths": { "type": "boolean", "description": "Enable/Disable transmission of backup paths", "example": false, "default": false }, "shutdown": { "type": "boolean", "description": "Enable/disable OMP", "example": false, "default": false }, "timers": { "type": "object", "properties": { "advertisementInterval": { "maximum": 65535, "minimum": 0, "type": "integer", "description": "Advertisement Interval (seconds), set the time between OMP Update packets", "format": "int32", "example": 1, "default": 1 }, "eorTimer": { "maximum": 3600, "minimum": 1, "type": "integer", "description": "End of RIB timer, in seconds", "format": "int32", "example": 300, "default": 300 }, "gracefulRestartTimer": { "maximum": 31556952, "minimum": 1, "type": "integer", "description": "Graceful restart timer, in seconds", "format": "int32", "example": 43200, "default": 43200 }, "holdTime": { "maximum": 65535, "minimum": 0, "type": "integer", "description": "Hold Time(Seconds), Set how long to wait before closing OMP peer connection", "format": "int32", "example": 300, "default": 300 } }, "description": "OMP timers", "$$ref": "#/components/schemas/OmpTimers" } }, "description": "Controller OMP configuration", "$$ref": "#/components/schemas/OmpSetting" }, "tlocColorCompatibility": { "type": "object", "properties": { "compatible": { "uniqueItems": true, "type": "array", "items": { "required": [ "color1", "color2" ], "type": "object", "properties": { "color1": { "type": "string", "description": "First TLOC color in comparsion", "enum": [ "default", "mpls", "metro-ethernet", "biz-internet", "public-internet", "lte", "3g", "red", "green", "blue", "gold", "silver", "bronze", "custom1", "custom2", "custom3", "private1", "private2", "private3", "private4", "private5", "private6" ] }, "color2": { "type": "string", "description": "Second TLOC color in comparsion", "enum": [ "default", "mpls", "metro-ethernet", "biz-internet", "public-internet", "lte", "3g", "red", "green", "blue", "gold", "silver", "bronze", "custom1", "custom2", "custom3", "private1", "private2", "private3", "private4", "private5", "private6" ] } }, "description": "List of Incompatible TLOC colors", "$$ref": "#/components/schemas/Compatible" } }, "incompatible": { "uniqueItems": true, "type": "array", "items": { "required": [ "color1", "color2" ], "type": "object", "properties": { "color1": { "type": "string", "description": "First TLOC color in comparsion", "enum": [ "default", "mpls", "metro-ethernet", "biz-internet", "public-internet", "lte", "3g", "red", "green", "blue", "gold", "silver", "bronze", "custom1", "custom2", "custom3", "private1", "private2", "private3", "private4", "private5", "private6" ] }, "color2": { "type": "string", "description": "Second TLOC color in comparsion", "enum": [ "default", "mpls", "metro-ethernet", "biz-internet", "public-internet", "lte", "3g", "red", "green", "blue", "gold", "silver", "bronze", "custom1", "custom2", "custom3", "private1", "private2", "private3", "private4", "private5", "private6" ] } }, "description": "List of Incompatible TLOC colors", "$$ref": "#/components/schemas/Compatible" } } }, "description": "List of compatible/incompatible TLOC colors for BFD session formation", "$$ref": "#/components/schemas/TlocColorCompatibility" } }, "description": "Controller fabric OMP and system settings", "$$ref": "#/components/schemas/ControllerFabricSetting" }, "dns": { "type": "object", "properties": { "dnsServerPrimary": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "Primary DNS server IPv4 or IPv6 Address", "example": "10.2.2.2" }, "dnsServerSecondary": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "Secondary DNS server IPv4 or IPv6 Address", "example": "10.2.2.3" }, "host": { "type": "array", "items": { "required": [ "hostname", "ip" ], "type": "object", "properties": { "hostname": { "pattern": "^[a-zA-Z0-9\\-_.]{1,64}$", "type": "string", "description": "Host name", "example": "vbond" }, "ip": { "maxItems": 64, "minItems": 1, "uniqueItems": true, "type": "array", "items": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "IP Address", "example": "10.1.1.1" } } }, "description": "Static host mapping", "$$ref": "#/components/schemas/DnsHostMapping" } } }, "description": "Configure DNS servers or static host mapping", "$$ref": "#/components/schemas/ControlComponentDnsSetting" }, "logging": { "required": [ "enableFeature" ], "type": "object", "properties": { "enableFeature": { "type": "boolean", "description": "Enable Logging feature or not", "default": false }, "server": { "maxItems": 4, "minItems": 0, "type": "array", "description": "Configure logging servers(Maximum 4 servers)", "items": { "required": [ "name" ], "type": "object", "properties": { "enableTlsTransport": { "type": "boolean", "description": "Enable TLS transport, otherwise UDP as transport", "default": true }, "name": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))|((?=.{1,253}$)((([a-zA-Z0-9_]([a-zA-Z0-9\\-_]){0,61})?[a-zA-Z0-9]\\.)*([a-zA-Z0-9_]([a-zA-Z0-9\\-_]){0,61})?[a-zA-Z0-9]\\.?)|\\.)", "type": "string", "description": "Set hostname, IPv4 address or IPv6 address for the server", "example": "1.2.2.3" }, "vpnId": { "type": "integer", "description": "VPN ID", "format": "int32", "example": 0, "enum": [ 0, 512 ], "default": 0 } }, "description": "Logging Server", "$$ref": "#/components/schemas/LoggingServer" } } }, "description": "Logging feature for control components", "$$ref": "#/components/schemas/ControlComponentLoggingSetting" }, "managementDns": { "type": "object", "properties": { "dnsServerPrimary": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "Primary DNS server IPv4 or IPv6 Address", "example": "10.2.2.2" }, "dnsServerSecondary": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "Secondary DNS server IPv4 or IPv6 Address", "example": "10.2.2.3" }, "host": { "type": "array", "items": { "required": [ "hostname", "ip" ], "type": "object", "properties": { "hostname": { "pattern": "^[a-zA-Z0-9\\-_.]{1,64}$", "type": "string", "description": "Host name", "example": "vbond" }, "ip": { "maxItems": 64, "minItems": 1, "uniqueItems": true, "type": "array", "items": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "IP Address", "example": "10.1.1.1" } } }, "description": "Static host mapping", "$$ref": "#/components/schemas/DnsHostMapping" } } }, "description": "Configure DNS servers or static host mapping", "$$ref": "#/components/schemas/ControlComponentDnsSetting" }, "ntp": { "required": [ "server" ], "type": "object", "properties": { "server": { "maxItems": 4, "minItems": 1, "type": "array", "description": "NTP Server (up to 4)", "items": { "required": [ "name" ], "type": "object", "properties": { "authenticationKey": { "maxLength": 2147483647, "minLength": 1, "type": "string", "description": "Value of the CMAC AES-128 authentication key", "example": "123456" }, "name": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))|((?=.{1,253}$)((([a-zA-Z0-9_]([a-zA-Z0-9\\-_]){0,61})?[a-zA-Z0-9]\\.)*([a-zA-Z0-9_]([a-zA-Z0-9\\-_]){0,61})?[a-zA-Z0-9]\\.?)|\\.)", "type": "string", "description": "Set hostname or IP address of server", "example": "1.2.2.3" }, "prefer": { "type": "boolean", "description": "Prefer this NTP server", "example": false, "default": false }, "vpnId": { "type": "integer", "description": "VPN ID", "format": "int32", "example": 0, "enum": [ 0, 512 ], "default": 0 } }, "description": "NTP Server for control components", "$$ref": "#/components/schemas/NtpServer" } } }, "description": "NTP setting for control components", "$$ref": "#/components/schemas/ControlComponentNtpSetting" }, "security": { "required": [ "protocol" ], "type": "object", "properties": { "protocol": { "type": "string", "description": "Control connection protocol, default is DTLS", "example": "dtls", "enum": [ "dtls", "tls" ], "default": "dtls" }, "tlsPort": { "maximum": 65535, "minimum": 1025, "type": "integer", "description": "TLS port, cannot coexist with protocol(DTLS)", "format": "int32", "example": 23456, "default": 23456 } }, "description": "Security configuration for control components", "$$ref": "#/components/schemas/ControlComponentSecuritySetting" }, "snmp": { "required": [ "enableFeature" ], "type": "object", "properties": { "contact": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Set the contact for this managed node", "example": "PaM-2nd-Level@telekom.de" }, "enableFeature": { "type": "boolean", "description": "Enable or disable SNMP", "example": false, "default": false }, "location": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Set the physical location of this managed node", "example": "Cisco Cloud - AWS-FRA" }, "name": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Set the assigned name for this managed node", "example": "vManage-01-FRA" }, "version": { "type": "string", "description": "SNMP version(v2 or v3)", "example": "v3", "enum": [ "v2", "v3" ], "default": "v3" }, "versionSpecificData": { "type": "object", "description": "SNMP configuration", "oneOf": [ { "required": [ "community", "view" ], "type": "object", "properties": { "community": { "maxItems": 2147483647, "minItems": 1, "type": "array", "description": "SNMPv2 community configuration", "items": { "required": [ "name", "tag", "view" ], "type": "object", "properties": { "name": { "pattern": "^(?:\\$CRYPT\\$.{17}|(?!(?:\\$CRYPT\\$))[\\S]{1,})$", "type": "string", "description": "Set name of the SNMP community", "example": "community_test" }, "tag": { "pattern": "^(?=.{1,32}$)([^<>]*)$", "type": "string", "description": "Set alias name for SNMP community", "example": "test" }, "view": { "pattern": "^(?=.{1,32}$)([^<>]*)$", "type": "string", "description": "SNMP view name", "example": "test" } }, "description": "SNMPv2 community", "$$ref": "#/components/schemas/Snmpv2Community" } }, "trap": { "required": [ "group", "target" ], "type": "object", "properties": { "group": { "maxItems": 8, "minItems": 0, "type": "array", "description": "SNMPv2 trap groups", "items": { "required": [ "enable", "groupName" ], "type": "object", "properties": { "enable": { "maxItems": 2147483647, "minItems": 1, "type": "array", "description": "Trap module configuration", "items": { "required": [ "level", "module" ], "type": "object", "properties": { "level": { "maxItems": 3, "minItems": 1, "uniqueItems": true, "type": "array", "items": { "type": "string", "description": "Trap level", "example": "critical", "enum": [ "critical", "major", "minor" ] } }, "module": { "type": "string", "description": "SNMP trap module name", "example": "all", "enum": [ "all", "app-route", "bfd", "control", "dhcp", "hardware", "omp", "routing", "security", "system", "vpn", "bridge", "policy", "wwan" ] } }, "description": "Enable SNMP trap modules", "$$ref": "#/components/schemas/SnmpTrapModule" } }, "groupName": { "pattern": "^(?=.{1,32}$)([^<>]*)$", "type": "string", "description": "Trap group name", "example": "trapGroup1" } }, "description": "SNMPv3 trap groups", "$$ref": "#/components/schemas/TrapGroup" } }, "target": { "type": "array", "description": "SNMPv2 target configuration", "items": { "required": [ "communityTag", "groupName", "ip", "port", "vpnId" ], "type": "object", "properties": { "communityTag": { "pattern": "^(?=.{1,32}$)([^<>]*)$", "type": "string", "description": "Port number", "example": "COMMUNITY_TEST" }, "groupName": { "pattern": "^(?=.{1,32}$)([^<>]*)$", "type": "string", "description": "SNMPv3 group name", "example": "group1" }, "ip": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "IPv4 or IPv6 address", "example": "1.1.1.3" }, "port": { "maximum": 65535, "minimum": 1, "type": "integer", "description": "Set UDP port number to connect to SNMP server", "format": "int32", "example": 13212 }, "vpnId": { "type": "integer", "description": "VPN ID", "format": "int32", "example": 0, "enum": [ 0, 512 ] } }, "description": "SNMPv2 Target server configuration", "$$ref": "#/components/schemas/Snmpv2Target" } } }, "description": "SNMPv2 trap configuration", "$$ref": "#/components/schemas/Snmpv2Trap" }, "view": { "maxItems": 2147483647, "minItems": 1, "type": "array", "description": "SNMPv2 view configuration", "items": { "required": [ "name" ], "type": "object", "properties": { "name": { "pattern": "^(?=.{1,32}$)([^<>]*)$", "type": "string", "description": "SNMP view name" }, "oid": { "type": "array", "description": "Configure SNMP object identifier", "items": { "required": [ "id" ], "type": "object", "properties": { "exclude": { "type": "boolean", "description": "Exclude the OID or not", "example": false, "default": false }, "id": { "pattern": "(([0-1](\\.[1-3]?[0-9]))|(2\\.(0|([1-9]\\d*))))(\\.(0|\\*|([1-9]\\d*))){0,126}", "type": "string", "description": "Configure identifier of subtree of MIB objects", "example": "2.1.1.11.1" } }, "description": "SNMP OID configuration", "$$ref": "#/components/schemas/SnmpOID" } } }, "description": "SNMP view configuration", "$$ref": "#/components/schemas/SnmpView" } } }, "description": "SNMPv2 configuration", "$$ref": "#/components/schemas/SNMPv2Data" }, { "required": [ "group", "user", "view" ], "type": "object", "properties": { "group": { "maxItems": 2147483647, "minItems": 1, "type": "array", "description": "SNMPv3 group configuration", "items": { "required": [ "name", "securityLevel", "view" ], "type": "object", "properties": { "name": { "pattern": "^(?=.{1,32}$)([^<>]*)$", "type": "string", "description": "SNMP group name", "example": "group" }, "securityLevel": { "type": "string", "description": "Security Level", "example": "auth-priv", "enum": [ "no-auth-no-priv", "auth-priv" ] }, "view": { "pattern": "^(?=.{1,32}$)([^<>]*)$", "type": "string", "description": "View name", "example": "view1" } }, "description": "SNMPv3 group configuration", "$$ref": "#/components/schemas/Snmpv3Group" } }, "trap": { "required": [ "group", "target" ], "type": "object", "properties": { "group": { "maxItems": 8, "minItems": 0, "type": "array", "description": "SNMPv3 trap groups", "items": { "required": [ "enable", "groupName" ], "type": "object", "properties": { "enable": { "maxItems": 2147483647, "minItems": 1, "type": "array", "description": "Trap module configuration", "items": { "required": [ "level", "module" ], "type": "object", "properties": { "level": { "maxItems": 3, "minItems": 1, "uniqueItems": true, "type": "array", "items": { "type": "string", "description": "Trap level", "example": "critical", "enum": [ "critical", "major", "minor" ] } }, "module": { "type": "string", "description": "SNMP trap module name", "example": "all", "enum": [ "all", "app-route", "bfd", "control", "dhcp", "hardware", "omp", "routing", "security", "system", "vpn", "bridge", "policy", "wwan" ] } }, "description": "Enable SNMP trap modules", "$$ref": "#/components/schemas/SnmpTrapModule" } }, "groupName": { "pattern": "^(?=.{1,32}$)([^<>]*)$", "type": "string", "description": "Trap group name", "example": "trapGroup1" } }, "description": "SNMPv3 trap groups", "$$ref": "#/components/schemas/TrapGroup" } }, "target": { "type": "array", "description": "SNMPv3 target configuration", "items": { "required": [ "groupName", "ip", "port", "user", "vpnId" ], "type": "object", "properties": { "groupName": { "pattern": "^(?=.{1,32}$)([^<>]*)$", "type": "string", "description": "SNMPv3 group name", "example": "group1" }, "ip": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "IPv4 or IPv6 address", "example": "1.1.1.3" }, "port": { "maximum": 65535, "minimum": 1, "type": "integer", "description": "Set UDP port number to connect to SNMP server", "format": "int32", "example": 13212 }, "user": { "pattern": "^(?=.{1,32}$)([^<>]*)$", "type": "string", "description": "SNMPv3 user name", "example": "test1" }, "vpnId": { "type": "integer", "description": "VPN ID", "format": "int32", "example": 0, "enum": [ 0, 512 ], "default": 0 } }, "description": "SNMPv3 target configuration", "$$ref": "#/components/schemas/Snmpv3Target" } } }, "description": "SNMPv3 trap configuration", "$$ref": "#/components/schemas/Snmpv3Trap" }, "user": { "maxItems": 2147483647, "minItems": 1, "type": "array", "description": "SNMPv3 user configuration", "items": { "required": [ "group", "name" ], "type": "object", "properties": { "authPassword": { "pattern": "^(?:\\$CRYPT\\$.{17}|(?!(?:\\$CRYPT\\$)).{8,128})$", "type": "string", "description": "Authentication password, either a encrypt string starting with $CRYPT$, or a clear text string of length 8 to 128", "example": "authPassword" }, "group": { "pattern": "^(?=.{1,32}$)([^<>]*)$", "type": "string", "description": "SNMP group name", "example": "group1" }, "name": { "pattern": "^(?=.{1,32}$)([^<>]*)$", "type": "string", "description": "SNMPv3 User name", "example": "user1" }, "privPassword": { "pattern": "^(?:\\$CRYPT\\$.{17}|(?!(?:\\$CRYPT\\$)).{8,128})$", "type": "string", "description": "Privilege password, either a encrypt string starting with $CRYPT$, or a clear text string of length 8 to 128", "example": "privPassword" } }, "description": "SNMPv3 user", "$$ref": "#/components/schemas/SNMPv3User" } }, "view": { "maxItems": 2147483647, "minItems": 1, "type": "array", "description": "SNMPv3 view configuration", "items": { "required": [ "name" ], "type": "object", "properties": { "name": { "pattern": "^(?=.{1,32}$)([^<>]*)$", "type": "string", "description": "SNMP view name" }, "oid": { "type": "array", "description": "Configure SNMP object identifier", "items": { "required": [ "id" ], "type": "object", "properties": { "exclude": { "type": "boolean", "description": "Exclude the OID or not", "example": false, "default": false }, "id": { "pattern": "(([0-1](\\.[1-3]?[0-9]))|(2\\.(0|([1-9]\\d*))))(\\.(0|\\*|([1-9]\\d*))){0,126}", "type": "string", "description": "Configure identifier of subtree of MIB objects", "example": "2.1.1.11.1" } }, "description": "SNMP OID configuration", "$$ref": "#/components/schemas/SnmpOID" } } }, "description": "SNMP view configuration", "$$ref": "#/components/schemas/SnmpView" } } }, "description": "SNMPv3 configuration", "$$ref": "#/components/schemas/SNMPv3Data" } ], "$$ref": "#/components/schemas/SnmpVersionSpecificData" } }, "description": "SNMP setting", "$$ref": "#/components/schemas/ControlComponentSnmpSetting" } }, "description": "Configure network level features for all control components", "$$ref": "#/components/schemas/ControlComponentNetworkSettings" } }, "$$ref": "#/components/schemas/QueryCommonSettingsResponse" }, "examples": { "QueryControlComponentNetworkCommonSettingsExample": { "description": "QueryControlComponentNetworkCommonSettingsExample", "value": { "createdBy": "admin", "createdOn": 1741315339238, "lastUpdatedBy": "admin", "lastUpdatedOn": 1741317690674, "payload": { "ntp": { "server": [ { "name": "1.1.1.1", "vpnId": 0, "prefer": true }, { "name": "2002::1", "vpnId": 0, "prefer": false }, { "name": "time.google.com", "vpnId": 0, "prefer": false }, { "name": "2.1.1.1", "vpnId": 0, "prefer": false } ] }, "aaa": { "authOrder": [ "local", "radius", "tacacs" ], "radiusServers": [ "radius1", "radius2" ], "authFallback": true, "adminAuthOrder": true, "accounting": true, "user": [ { "name": "admin", "password": "$CRYPT$LlBMcwaztmurYKfN/" }, { "name": "xx", "password": "$CRYPT$hy1nRjYaA4mqsTgLU", "userGroup": "netadmin" } ], "ciscoTacRoUser": false, "ciscoTacRwUser": false, "tacacs": { "timeout": 232, "authentication": "ascii", "servers": [ { "address": "1.1.1.1", "authPort": 32200, "acctPort": 1200, "vpn": 0, "secretKey": "$CRYPT$ZrYAwz9pB8WOkW+gj", "priority": 2 }, { "address": "2002::1", "authPort": 321, "acctPort": 232, "vpn": 0, "secretKey": "$CRYPT$vgNok88PqemwCW0mX", "priority": 3 } ] }, "radius": { "timeout": 32, "retransmit": 12, "server": [ { "address": "1.1.1.1", "authPort": 1232, "acctPort": 12312, "tag": "radius1", "vpn": 0, "secretKey": "$CRYPT$9DvMb0HTJkPsW+ryY", "priority": 1 }, { "address": "3.3.3.3", "authPort": 1234, "acctPort": 123, "tag": "radius2", "vpn": 0, "secretKey": "$CRYPT$Wyt41hQUJ4bZ1pEb6", "priority": 2 } ] }, "logs": { "auditDisable": true, "netconfDisable": true } }, "security": { "protocol": "dtls" }, "controller": { "omp": { "shutdown": false, "controllerSendPathLimit": 10, "filterRoute": { "outbound": { "affinityGroupPreference": false, "tlocColor": false } }, "sendBackupPaths": false, "discardRejected": false, "gracefulRestart": true, "timers": { "holdTime": 3200, "advertisementInterval": 1, "gracefulRestartTimer": 110, "eorTimer": 200 } }, "tlocColorCompatibility": { "compatible": [ { "color1": "mpls", "color2": "default" }, { "color1": "biz-internet", "color2": "gold" } ], "incompatible": [ { "color1": "lte", "color2": "default" }, { "color1": "3g", "color2": "gold" } ] } }, "dns": { "dnsServerPrimary": "2.2.2.2", "dnsServerSecondary": "3.3.3.3", "host": [ { "hostname": "vbond", "ip": [ "10.0.12.26", "2001:a0:c::1a" ] } ] }, "banner": { "enableFeature": true, "loginMessage": "hello", "motdMessage": "hello" }, "logging": { "server": [ { "name": "3002::1", "vpnId": 0 }, { "name": "3.3.32.2", "vpnId": 0 }, { "name": "adas1.com.sd", "vpnId": 0 } ], "enableFeature": true }, "snmp": { "version": "v2", "contact": "PaM-2nd-Level@telekom.de", "name": "vManage-01-FRA", "location": "Cisco Cloud - AWS-FRA", "versionSpecificData": { "view": [ { "name": "xx", "oid": [ { "id": "1.2.2.2.2", "exclude": true }, { "id": "2.2.1.13.2", "exclude": false } ] }, { "name": "yy", "oid": [ { "id": "1.4.2.2.2" } ] } ], "community": [ { "name": "$CRYPT$/gP0oCyfJrtcopHSG", "tag": "test1", "view": "xx" }, { "name": "$CRYPT$tB7e6QTIUrMRq5vP5", "tag": "test2", "view": "yy" } ], "trap": { "target": [ { "vpnId": 0, "ip": "2.2.2.2", "port": 23, "communityTag": "test1", "groupName": "trap-group1" }, { "vpnId": 0, "ip": "3.2.2.2", "port": 12312, "communityTag": "test2", "groupName": "trap-group1" } ], "group": [ { "groupName": "trap-group1", "enable": [ { "module": "all", "level": [ "critical" ] }, { "module": "bfd", "level": [ "major" ] }, { "module": "control", "level": [ "critical" ] }, { "module": "dhcp", "level": [ "minor" ] } ] } ] } }, "enableFeature": true } } }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigControlcomponentSettingResponseExampleQuerycommonsettings" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "required": [ "error" ], "type": "object", "properties": { "error": { "required": [ "code", "details", "message", "type" ], "type": "object", "properties": { "code": { "type": "string", "description": "Internal error code", "example": "CCS0018" }, "details": { "type": "string", "description": "Error message detail", "example": "Unrecognized field user1" }, "message": { "type": "string", "description": "Error message summary", "example": "Invalid control component setting payload" }, "type": { "type": "string", "description": "Error message title", "example": "error" } }, "description": "Error response", "$$ref": "#/components/schemas/ErrorDetails" } }, "$$ref": "#/components/schemas/ErrorResponse" }, "examples": { "GetCommonSettingsNotFound": { "description": "GetCommonSettingsNotFound", "value": { "error": { "message": "Did not find the network settings for any control components", "code": "CCS0005", "details": "Control component common settings are not configured", "type": "error" } }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigControlcomponentSettingResponseExampleGetcommonsettingsnotfoundresponse" } } } } }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Control Component Settings-read" }, "delete": { "tags": [ "Configuration - Control Component Setting" ], "description": "Delete the network settings for all control components", "operationId": "deleteControlComponentCommonSettings", "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "required": [ "error" ], "type": "object", "properties": { "error": { "required": [ "code", "details", "message", "type" ], "type": "object", "properties": { "code": { "type": "string", "description": "Internal error code", "example": "CCS0018" }, "details": { "type": "string", "description": "Error message detail", "example": "Unrecognized field user1" }, "message": { "type": "string", "description": "Error message summary", "example": "Invalid control component setting payload" }, "type": { "type": "string", "description": "Error message title", "example": "error" } }, "description": "Error response", "$$ref": "#/components/schemas/ErrorDetails" } }, "$$ref": "#/components/schemas/ErrorResponse" }, "examples": { "DeleteControlComponentCommonSettingsFailed": { "description": "DeleteControlComponentCommonSettingsFailed", "value": { "error": { "message": "Failed to delete network settings for all control components", "code": "CCS0003", "details": "Control component common settings are not allowed to be removed now, since settings are already deployed to some control components, retry it after all control components are not managed by setting mode", "type": "error" } }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigControlcomponentSettingResponseExampleDeletecommonsettingsfailedresponse" } } } } }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Control Component Settings-write" }, "post": { "tags": [ "Configuration - Control Component Setting" ], "description": "Create the network settings for all control components", "operationId": "createControlComponentCommonSettings", "requestBody": { "description": "Network settings for all control components", "content": { "application/json": { "schema": { "required": [ "aaa", "ntp" ], "type": "object", "properties": { "aaa": { "required": [ "authOrder", "user" ], "type": "object", "properties": { "accounting": { "type": "boolean", "description": "Enable/disable user accounting", "example": false, "default": false }, "adminAuthOrder": { "type": "boolean", "description": "Authenticate admin user as per auth-order", "example": false, "default": false }, "authFallback": { "type": "boolean", "description": "Fall back if higher-priority authentication fails", "example": false, "default": false }, "authOrder": { "maxItems": 3, "minItems": 1, "uniqueItems": true, "type": "array", "items": { "type": "string", "description": "Authentication order list", "example": "local", "enum": [ "local", "radius", "tacacs" ] } }, "ciscoTacRoUser": { "type": "boolean", "description": "Cisco Tac Enable Read only", "default": true }, "ciscoTacRwUser": { "type": "boolean", "description": "Cisco Tac Enable Read and Write", "default": true }, "logs": { "type": "object", "properties": { "auditDisable": { "type": "boolean", "description": "Disable audit logs", "default": false }, "netconfDisable": { "type": "boolean", "description": "Disable Netconf logs", "default": false } }, "description": "Enable/Disable audit or netconf logs", "$$ref": "#/components/schemas/AaaLogs" }, "radius": { "type": "object", "properties": { "retransmit": { "maximum": 1000, "minimum": 1, "type": "integer", "description": "Configure how many times to contact each RADIUS server", "format": "int32", "example": 3, "default": 3 }, "server": { "maxItems": 8, "minItems": 0, "type": "array", "description": "RADIUS server configuration", "items": { "required": [ "address", "secretKey" ], "type": "object", "properties": { "acctPort": { "maximum": 65535, "minimum": 0, "type": "integer", "description": "Accounting Port", "format": "int32", "example": 1813, "default": 1813 }, "address": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "Set IP address of RADIUS server", "example": "1.2.2.2" }, "authPort": { "maximum": 65535, "minimum": 0, "type": "integer", "description": "Authentication Port", "format": "int32", "example": 1812, "default": 1812 }, "priority": { "maximum": 7, "minimum": 0, "type": "integer", "description": "Priority", "format": "int32", "example": 1, "default": 0 }, "secretKey": { "pattern": "^(?:\\$CRYPT\\$.{17}|(?!(?:\\$CRYPT\\$)).{1,128})$", "type": "string", "description": "Secret key", "example": "password" }, "tag": { "maxLength": 16, "minLength": 4, "pattern": "^[a-zA-Z0-9\\-_]*$", "type": "string", "description": "Reference tag/name for the server", "example": "radius-server1" }, "vpn": { "type": "integer", "description": "VPN ID", "format": "int32", "example": 0, "enum": [ 0, 512 ], "default": 0 } }, "description": "Configure the RADIUS server", "$$ref": "#/components/schemas/ControlComponentAaaRadiusServer" } }, "timeout": { "maximum": 1000, "minimum": 1, "type": "integer", "description": "Configure how long to wait for replies from the RADIUS server", "format": "int32", "example": 5, "default": 5 } }, "description": "Radius configuration", "$$ref": "#/components/schemas/Radius" }, "radiusServers": { "uniqueItems": true, "type": "array", "items": { "type": "string", "description": "Designate radius server tags for authentication and accounting", "example": "radius-tag1" } }, "tacacs": { "type": "object", "properties": { "authentication": { "type": "string", "description": "TACACS authentication type", "enum": [ "pap", "ascii" ], "default": "pap" }, "servers": { "maxItems": 8, "minItems": 0, "type": "array", "description": "List of TACACS servers", "items": { "required": [ "address", "secretKey" ], "type": "object", "properties": { "acctPort": { "maximum": 65535, "minimum": 0, "type": "integer", "description": "Accounting Port", "format": "int32", "default": 49 }, "address": { "type": "string", "description": "Set IP address of TACACS server", "example": "1.2.2.2" }, "authPort": { "maximum": 65535, "minimum": 0, "type": "integer", "description": "Authentication Port", "format": "int32", "default": 49 }, "priority": { "maximum": 7, "minimum": 0, "type": "integer", "description": "TACACS server priority <0..7>", "format": "int32", "example": 1, "default": 0 }, "secretKey": { "pattern": "^(?:\\$CRYPT\\$.{17}|(?!(?:\\$CRYPT\\$)).{1,128})$", "type": "string", "description": "TACACS server password", "example": "Password123" }, "vpn": { "type": "integer", "description": "VPN ID", "format": "int32", "example": 0, "enum": [ 0, 512 ], "default": 0 } }, "description": "Configure the TACACS server", "$$ref": "#/components/schemas/TacacsServer" } }, "timeout": { "maximum": 1000, "minimum": 1, "type": "integer", "description": "Configure how long to wait for replies from the TACACS server", "format": "int32", "default": 5 } }, "description": "TACACS configuration", "$$ref": "#/components/schemas/Tacacs" }, "user": { "maxItems": 2147483647, "minItems": 1, "type": "array", "description": "Create local login account", "items": { "required": [ "name", "password" ], "type": "object", "properties": { "name": { "maxLength": 128, "minLength": 1, "pattern": "^(?!(?:root|daemon|bin|sys|sync|games|man|lp|mail|news|uucp|proxy|www-data|backup|list|irc|gnats|nobody|basic|sshd|quagga|vmanage-admin|vmanage|viptela-reserved)$)[a-z][a-z0-9._-]*$", "type": "string", "description": "User name", "example": "admin" }, "password": { "pattern": "^(?:\\$CRYPT\\$.{17}|(?!(?:\\$CRYPT\\$)).{1,128})$", "type": "string", "description": "User password, either a encrypted string starting with $CRYPT$, or a clear text string of length 1\u2013128", "example": "password" }, "userGroup": { "type": "string", "description": "User group name which user belongs to", "example": "netadmin", "enum": [ "basic", "operator", "netadmin" ] } }, "description": "Create local login account", "$$ref": "#/components/schemas/AaaLocalUser" } } }, "description": "Configure local users, TACACS or RADIUS servers for control components", "$$ref": "#/components/schemas/ControlComponentAaaSetting" }, "banner": { "required": [ "enableFeature" ], "type": "object", "properties": { "enableFeature": { "type": "boolean", "description": "Enable Banner feature or not", "default": false }, "loginMessage": { "maxLength": 2048, "minLength": 1, "type": "string", "description": "Set message to display before login prompt", "example": "Hello user" }, "motdMessage": { "maxLength": 2048, "minLength": 1, "type": "string", "description": "Set message to display after a user logs in", "example": "Hello" } }, "description": "Banner configuration", "$$ref": "#/components/schemas/ControlComponentBannerSetting" }, "controller": { "type": "object", "properties": { "hubSpokeTopology": { "type": "boolean", "description": "Hub & spoke topology", "default": false }, "omp": { "type": "object", "properties": { "controllerSendPathLimit": { "maximum": 128, "minimum": 4, "type": "integer", "description": "Limit number of paths sent to vSmart controller for a prefix", "format": "int32", "example": 20 }, "discardRejected": { "type": "boolean", "description": "Enable/Disable storage of information rejected by policy", "example": false, "default": false }, "filterRoute": { "required": [ "outbound" ], "type": "object", "properties": { "outbound": { "type": "object", "properties": { "affinityGroupPreference": { "type": "boolean", "description": "Filter routes based on affinity preference list", "example": false, "default": false }, "tlocColor": { "type": "boolean", "description": "Filter routes based on TLOC color compatibility list", "example": false, "default": false } }, "$$ref": "#/components/schemas/Outbound" } }, "description": "OMP filter route configuration", "$$ref": "#/components/schemas/OmpFilterRoute" }, "gracefulRestart": { "type": "boolean", "description": "Enable/Disable graceful restart", "example": true, "default": true }, "outboundPolicyCaching": { "type": "boolean" }, "sendBackupPaths": { "type": "boolean", "description": "Enable/Disable transmission of backup paths", "example": false, "default": false }, "shutdown": { "type": "boolean", "description": "Enable/disable OMP", "example": false, "default": false }, "timers": { "type": "object", "properties": { "advertisementInterval": { "maximum": 65535, "minimum": 0, "type": "integer", "description": "Advertisement Interval (seconds), set the time between OMP Update packets", "format": "int32", "example": 1, "default": 1 }, "eorTimer": { "maximum": 3600, "minimum": 1, "type": "integer", "description": "End of RIB timer, in seconds", "format": "int32", "example": 300, "default": 300 }, "gracefulRestartTimer": { "maximum": 31556952, "minimum": 1, "type": "integer", "description": "Graceful restart timer, in seconds", "format": "int32", "example": 43200, "default": 43200 }, "holdTime": { "maximum": 65535, "minimum": 0, "type": "integer", "description": "Hold Time(Seconds), Set how long to wait before closing OMP peer connection", "format": "int32", "example": 300, "default": 300 } }, "description": "OMP timers", "$$ref": "#/components/schemas/OmpTimers" } }, "description": "Controller OMP configuration", "$$ref": "#/components/schemas/OmpSetting" }, "tlocColorCompatibility": { "type": "object", "properties": { "compatible": { "uniqueItems": true, "type": "array", "items": { "required": [ "color1", "color2" ], "type": "object", "properties": { "color1": { "type": "string", "description": "First TLOC color in comparsion", "enum": [ "default", "mpls", "metro-ethernet", "biz-internet", "public-internet", "lte", "3g", "red", "green", "blue", "gold", "silver", "bronze", "custom1", "custom2", "custom3", "private1", "private2", "private3", "private4", "private5", "private6" ] }, "color2": { "type": "string", "description": "Second TLOC color in comparsion", "enum": [ "default", "mpls", "metro-ethernet", "biz-internet", "public-internet", "lte", "3g", "red", "green", "blue", "gold", "silver", "bronze", "custom1", "custom2", "custom3", "private1", "private2", "private3", "private4", "private5", "private6" ] } }, "description": "List of Incompatible TLOC colors", "$$ref": "#/components/schemas/Compatible" } }, "incompatible": { "uniqueItems": true, "type": "array", "items": { "required": [ "color1", "color2" ], "type": "object", "properties": { "color1": { "type": "string", "description": "First TLOC color in comparsion", "enum": [ "default", "mpls", "metro-ethernet", "biz-internet", "public-internet", "lte", "3g", "red", "green", "blue", "gold", "silver", "bronze", "custom1", "custom2", "custom3", "private1", "private2", "private3", "private4", "private5", "private6" ] }, "color2": { "type": "string", "description": "Second TLOC color in comparsion", "enum": [ "default", "mpls", "metro-ethernet", "biz-internet", "public-internet", "lte", "3g", "red", "green", "blue", "gold", "silver", "bronze", "custom1", "custom2", "custom3", "private1", "private2", "private3", "private4", "private5", "private6" ] } }, "description": "List of Incompatible TLOC colors", "$$ref": "#/components/schemas/Compatible" } } }, "description": "List of compatible/incompatible TLOC colors for BFD session formation", "$$ref": "#/components/schemas/TlocColorCompatibility" } }, "description": "Controller fabric OMP and system settings", "$$ref": "#/components/schemas/ControllerFabricSetting" }, "dns": { "type": "object", "properties": { "dnsServerPrimary": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "Primary DNS server IPv4 or IPv6 Address", "example": "10.2.2.2" }, "dnsServerSecondary": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "Secondary DNS server IPv4 or IPv6 Address", "example": "10.2.2.3" }, "host": { "type": "array", "items": { "required": [ "hostname", "ip" ], "type": "object", "properties": { "hostname": { "pattern": "^[a-zA-Z0-9\\-_.]{1,64}$", "type": "string", "description": "Host name", "example": "vbond" }, "ip": { "maxItems": 64, "minItems": 1, "uniqueItems": true, "type": "array", "items": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "IP Address", "example": "10.1.1.1" } } }, "description": "Static host mapping", "$$ref": "#/components/schemas/DnsHostMapping" } } }, "description": "Configure DNS servers or static host mapping", "$$ref": "#/components/schemas/ControlComponentDnsSetting" }, "logging": { "required": [ "enableFeature" ], "type": "object", "properties": { "enableFeature": { "type": "boolean", "description": "Enable Logging feature or not", "default": false }, "server": { "maxItems": 4, "minItems": 0, "type": "array", "description": "Configure logging servers(Maximum 4 servers)", "items": { "required": [ "name" ], "type": "object", "properties": { "enableTlsTransport": { "type": "boolean", "description": "Enable TLS transport, otherwise UDP as transport", "default": true }, "name": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))|((?=.{1,253}$)((([a-zA-Z0-9_]([a-zA-Z0-9\\-_]){0,61})?[a-zA-Z0-9]\\.)*([a-zA-Z0-9_]([a-zA-Z0-9\\-_]){0,61})?[a-zA-Z0-9]\\.?)|\\.)", "type": "string", "description": "Set hostname, IPv4 address or IPv6 address for the server", "example": "1.2.2.3" }, "vpnId": { "type": "integer", "description": "VPN ID", "format": "int32", "example": 0, "enum": [ 0, 512 ], "default": 0 } }, "description": "Logging Server", "$$ref": "#/components/schemas/LoggingServer" } } }, "description": "Logging feature for control components", "$$ref": "#/components/schemas/ControlComponentLoggingSetting" }, "managementDns": { "type": "object", "properties": { "dnsServerPrimary": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "Primary DNS server IPv4 or IPv6 Address", "example": "10.2.2.2" }, "dnsServerSecondary": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "Secondary DNS server IPv4 or IPv6 Address", "example": "10.2.2.3" }, "host": { "type": "array", "items": { "required": [ "hostname", "ip" ], "type": "object", "properties": { "hostname": { "pattern": "^[a-zA-Z0-9\\-_.]{1,64}$", "type": "string", "description": "Host name", "example": "vbond" }, "ip": { "maxItems": 64, "minItems": 1, "uniqueItems": true, "type": "array", "items": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "IP Address", "example": "10.1.1.1" } } }, "description": "Static host mapping", "$$ref": "#/components/schemas/DnsHostMapping" } } }, "description": "Configure DNS servers or static host mapping", "$$ref": "#/components/schemas/ControlComponentDnsSetting" }, "ntp": { "required": [ "server" ], "type": "object", "properties": { "server": { "maxItems": 4, "minItems": 1, "type": "array", "description": "NTP Server (up to 4)", "items": { "required": [ "name" ], "type": "object", "properties": { "authenticationKey": { "maxLength": 2147483647, "minLength": 1, "type": "string", "description": "Value of the CMAC AES-128 authentication key", "example": "123456" }, "name": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))|((?=.{1,253}$)((([a-zA-Z0-9_]([a-zA-Z0-9\\-_]){0,61})?[a-zA-Z0-9]\\.)*([a-zA-Z0-9_]([a-zA-Z0-9\\-_]){0,61})?[a-zA-Z0-9]\\.?)|\\.)", "type": "string", "description": "Set hostname or IP address of server", "example": "1.2.2.3" }, "prefer": { "type": "boolean", "description": "Prefer this NTP server", "example": false, "default": false }, "vpnId": { "type": "integer", "description": "VPN ID", "format": "int32", "example": 0, "enum": [ 0, 512 ], "default": 0 } }, "description": "NTP Server for control components", "$$ref": "#/components/schemas/NtpServer" } } }, "description": "NTP setting for control components", "$$ref": "#/components/schemas/ControlComponentNtpSetting" }, "security": { "required": [ "protocol" ], "type": "object", "properties": { "protocol": { "type": "string", "description": "Control connection protocol, default is DTLS", "example": "dtls", "enum": [ "dtls", "tls" ], "default": "dtls" }, "tlsPort": { "maximum": 65535, "minimum": 1025, "type": "integer", "description": "TLS port, cannot coexist with protocol(DTLS)", "format": "int32", "example": 23456, "default": 23456 } }, "description": "Security configuration for control components", "$$ref": "#/components/schemas/ControlComponentSecuritySetting" }, "snmp": { "required": [ "enableFeature" ], "type": "object", "properties": { "contact": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Set the contact for this managed node", "example": "PaM-2nd-Level@telekom.de" }, "enableFeature": { "type": "boolean", "description": "Enable or disable SNMP", "example": false, "default": false }, "location": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Set the physical location of this managed node", "example": "Cisco Cloud - AWS-FRA" }, "name": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Set the assigned name for this managed node", "example": "vManage-01-FRA" }, "version": { "type": "string", "description": "SNMP version(v2 or v3)", "example": "v3", "enum": [ "v2", "v3" ], "default": "v3" }, "versionSpecificData": { "type": "object", "description": "SNMP configuration", "oneOf": [ { "required": [ "community", "view" ], "type": "object", "properties": { "community": { "maxItems": 2147483647, "minItems": 1, "type": "array", "description": "SNMPv2 community configuration", "items": { "required": [ "name", "tag", "view" ], "type": "object", "properties": { "name": { "pattern": "^(?:\\$CRYPT\\$.{17}|(?!(?:\\$CRYPT\\$))[\\S]{1,})$", "type": "string", "description": "Set name of the SNMP community", "example": "community_test" }, "tag": { "pattern": "^(?=.{1,32}$)([^<>]*)$", "type": "string", "description": "Set alias name for SNMP community", "example": "test" }, "view": { "pattern": "^(?=.{1,32}$)([^<>]*)$", "type": "string", "description": "SNMP view name", "example": "test" } }, "description": "SNMPv2 community", "$$ref": "#/components/schemas/Snmpv2Community" } }, "trap": { "required": [ "group", "target" ], "type": "object", "properties": { "group": { "maxItems": 8, "minItems": 0, "type": "array", "description": "SNMPv2 trap groups", "items": { "required": [ "enable", "groupName" ], "type": "object", "properties": { "enable": { "maxItems": 2147483647, "minItems": 1, "type": "array", "description": "Trap module configuration", "items": { "required": [ "level", "module" ], "type": "object", "properties": { "level": { "maxItems": 3, "minItems": 1, "uniqueItems": true, "type": "array", "items": { "type": "string", "description": "Trap level", "example": "critical", "enum": [ "critical", "major", "minor" ] } }, "module": { "type": "string", "description": "SNMP trap module name", "example": "all", "enum": [ "all", "app-route", "bfd", "control", "dhcp", "hardware", "omp", "routing", "security", "system", "vpn", "bridge", "policy", "wwan" ] } }, "description": "Enable SNMP trap modules", "$$ref": "#/components/schemas/SnmpTrapModule" } }, "groupName": { "pattern": "^(?=.{1,32}$)([^<>]*)$", "type": "string", "description": "Trap group name", "example": "trapGroup1" } }, "description": "SNMPv3 trap groups", "$$ref": "#/components/schemas/TrapGroup" } }, "target": { "type": "array", "description": "SNMPv2 target configuration", "items": { "required": [ "communityTag", "groupName", "ip", "port", "vpnId" ], "type": "object", "properties": { "communityTag": { "pattern": "^(?=.{1,32}$)([^<>]*)$", "type": "string", "description": "Port number", "example": "COMMUNITY_TEST" }, "groupName": { "pattern": "^(?=.{1,32}$)([^<>]*)$", "type": "string", "description": "SNMPv3 group name", "example": "group1" }, "ip": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "IPv4 or IPv6 address", "example": "1.1.1.3" }, "port": { "maximum": 65535, "minimum": 1, "type": "integer", "description": "Set UDP port number to connect to SNMP server", "format": "int32", "example": 13212 }, "vpnId": { "type": "integer", "description": "VPN ID", "format": "int32", "example": 0, "enum": [ 0, 512 ] } }, "description": "SNMPv2 Target server configuration", "$$ref": "#/components/schemas/Snmpv2Target" } } }, "description": "SNMPv2 trap configuration", "$$ref": "#/components/schemas/Snmpv2Trap" }, "view": { "maxItems": 2147483647, "minItems": 1, "type": "array", "description": "SNMPv2 view configuration", "items": { "required": [ "name" ], "type": "object", "properties": { "name": { "pattern": "^(?=.{1,32}$)([^<>]*)$", "type": "string", "description": "SNMP view name" }, "oid": { "type": "array", "description": "Configure SNMP object identifier", "items": { "required": [ "id" ], "type": "object", "properties": { "exclude": { "type": "boolean", "description": "Exclude the OID or not", "example": false, "default": false }, "id": { "pattern": "(([0-1](\\.[1-3]?[0-9]))|(2\\.(0|([1-9]\\d*))))(\\.(0|\\*|([1-9]\\d*))){0,126}", "type": "string", "description": "Configure identifier of subtree of MIB objects", "example": "2.1.1.11.1" } }, "description": "SNMP OID configuration", "$$ref": "#/components/schemas/SnmpOID" } } }, "description": "SNMP view configuration", "$$ref": "#/components/schemas/SnmpView" } } }, "description": "SNMPv2 configuration", "$$ref": "#/components/schemas/SNMPv2Data" }, { "required": [ "group", "user", "view" ], "type": "object", "properties": { "group": { "maxItems": 2147483647, "minItems": 1, "type": "array", "description": "SNMPv3 group configuration", "items": { "required": [ "name", "securityLevel", "view" ], "type": "object", "properties": { "name": { "pattern": "^(?=.{1,32}$)([^<>]*)$", "type": "string", "description": "SNMP group name", "example": "group" }, "securityLevel": { "type": "string", "description": "Security Level", "example": "auth-priv", "enum": [ "no-auth-no-priv", "auth-priv" ] }, "view": { "pattern": "^(?=.{1,32}$)([^<>]*)$", "type": "string", "description": "View name", "example": "view1" } }, "description": "SNMPv3 group configuration", "$$ref": "#/components/schemas/Snmpv3Group" } }, "trap": { "required": [ "group", "target" ], "type": "object", "properties": { "group": { "maxItems": 8, "minItems": 0, "type": "array", "description": "SNMPv3 trap groups", "items": { "required": [ "enable", "groupName" ], "type": "object", "properties": { "enable": { "maxItems": 2147483647, "minItems": 1, "type": "array", "description": "Trap module configuration", "items": { "required": [ "level", "module" ], "type": "object", "properties": { "level": { "maxItems": 3, "minItems": 1, "uniqueItems": true, "type": "array", "items": { "type": "string", "description": "Trap level", "example": "critical", "enum": [ "critical", "major", "minor" ] } }, "module": { "type": "string", "description": "SNMP trap module name", "example": "all", "enum": [ "all", "app-route", "bfd", "control", "dhcp", "hardware", "omp", "routing", "security", "system", "vpn", "bridge", "policy", "wwan" ] } }, "description": "Enable SNMP trap modules", "$$ref": "#/components/schemas/SnmpTrapModule" } }, "groupName": { "pattern": "^(?=.{1,32}$)([^<>]*)$", "type": "string", "description": "Trap group name", "example": "trapGroup1" } }, "description": "SNMPv3 trap groups", "$$ref": "#/components/schemas/TrapGroup" } }, "target": { "type": "array", "description": "SNMPv3 target configuration", "items": { "required": [ "groupName", "ip", "port", "user", "vpnId" ], "type": "object", "properties": { "groupName": { "pattern": "^(?=.{1,32}$)([^<>]*)$", "type": "string", "description": "SNMPv3 group name", "example": "group1" }, "ip": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "IPv4 or IPv6 address", "example": "1.1.1.3" }, "port": { "maximum": 65535, "minimum": 1, "type": "integer", "description": "Set UDP port number to connect to SNMP server", "format": "int32", "example": 13212 }, "user": { "pattern": "^(?=.{1,32}$)([^<>]*)$", "type": "string", "description": "SNMPv3 user name", "example": "test1" }, "vpnId": { "type": "integer", "description": "VPN ID", "format": "int32", "example": 0, "enum": [ 0, 512 ], "default": 0 } }, "description": "SNMPv3 target configuration", "$$ref": "#/components/schemas/Snmpv3Target" } } }, "description": "SNMPv3 trap configuration", "$$ref": "#/components/schemas/Snmpv3Trap" }, "user": { "maxItems": 2147483647, "minItems": 1, "type": "array", "description": "SNMPv3 user configuration", "items": { "required": [ "group", "name" ], "type": "object", "properties": { "authPassword": { "pattern": "^(?:\\$CRYPT\\$.{17}|(?!(?:\\$CRYPT\\$)).{8,128})$", "type": "string", "description": "Authentication password, either a encrypt string starting with $CRYPT$, or a clear text string of length 8 to 128", "example": "authPassword" }, "group": { "pattern": "^(?=.{1,32}$)([^<>]*)$", "type": "string", "description": "SNMP group name", "example": "group1" }, "name": { "pattern": "^(?=.{1,32}$)([^<>]*)$", "type": "string", "description": "SNMPv3 User name", "example": "user1" }, "privPassword": { "pattern": "^(?:\\$CRYPT\\$.{17}|(?!(?:\\$CRYPT\\$)).{8,128})$", "type": "string", "description": "Privilege password, either a encrypt string starting with $CRYPT$, or a clear text string of length 8 to 128", "example": "privPassword" } }, "description": "SNMPv3 user", "$$ref": "#/components/schemas/SNMPv3User" } }, "view": { "maxItems": 2147483647, "minItems": 1, "type": "array", "description": "SNMPv3 view configuration", "items": { "required": [ "name" ], "type": "object", "properties": { "name": { "pattern": "^(?=.{1,32}$)([^<>]*)$", "type": "string", "description": "SNMP view name" }, "oid": { "type": "array", "description": "Configure SNMP object identifier", "items": { "required": [ "id" ], "type": "object", "properties": { "exclude": { "type": "boolean", "description": "Exclude the OID or not", "example": false, "default": false }, "id": { "pattern": "(([0-1](\\.[1-3]?[0-9]))|(2\\.(0|([1-9]\\d*))))(\\.(0|\\*|([1-9]\\d*))){0,126}", "type": "string", "description": "Configure identifier of subtree of MIB objects", "example": "2.1.1.11.1" } }, "description": "SNMP OID configuration", "$$ref": "#/components/schemas/SnmpOID" } } }, "description": "SNMP view configuration", "$$ref": "#/components/schemas/SnmpView" } } }, "description": "SNMPv3 configuration", "$$ref": "#/components/schemas/SNMPv3Data" } ], "$$ref": "#/components/schemas/SnmpVersionSpecificData" } }, "description": "SNMP setting", "$$ref": "#/components/schemas/ControlComponentSnmpSetting" } }, "description": "Configure network level features for all control components", "$$ref": "#/components/schemas/ControlComponentNetworkSettings" }, "examples": { "CreateControlComponentNetworkCommonSettingWithAllFeatures": { "description": "CreateControlComponentNetworkCommonSettingWithAllFeatures", "value": { "ntp": { "server": [ { "name": "1.1.1.1", "vpnId": 0, "prefer": true }, { "name": "2002::1", "vpnId": 0, "prefer": false }, { "name": "time.google.com", "vpnId": 0, "prefer": false }, { "name": "2.1.1.1", "vpnId": 0, "prefer": false } ] }, "aaa": { "authFallback": true, "adminAuthOrder": true, "accounting": true, "ciscoTacRoUser": false, "ciscoTacRwUser": false, "tacacs": { "timeout": 232, "authentication": "ascii", "servers": [ { "address": "1.1.1.1", "authPort": 32200, "acctPort": 1200, "vpn": 0, "secretKey": "test123", "priority": 2 }, { "address": "2002::1", "authPort": 321, "acctPort": 232, "vpn": 0, "secretKey": "password", "priority": 3 } ] }, "radius": { "timeout": 32, "retransmit": 12, "server": [ { "address": "1.1.1.1", "authPort": 1232, "acctPort": 12312, "tag": "radius1", "vpn": 0, "secretKey": "password", "priority": 1 }, { "address": "3.3.3.3", "authPort": 1234, "acctPort": 123, "tag": "radius2", "vpn": 0, "secretKey": "password", "priority": 2 } ] }, "authOrder": [ "local", "radius", "tacacs" ], "radiusServers": [ "radius1", "radius2" ], "user": [ { "name": "admin", "password": "admin" }, { "name": "xx", "password": "xx", "userGroup": "netadmin" } ], "logs": { "auditDisable": true, "netconfDisable": true } }, "security": { "protocol": "dtls" }, "controller": { "omp": { "shutdown": false, "controllerSendPathLimit": 10, "filterRoute": { "outbound": { "affinityGroupPreference": false, "tlocColor": false } }, "sendBackupPaths": false, "discardRejected": false, "gracefulRestart": true, "timers": { "holdTime": 3200, "advertisementInterval": 1, "gracefulRestartTimer": 110, "eorTimer": 200 } }, "tlocColorCompatibility": { "compatible": [ { "color1": "mpls", "color2": "default" }, { "color1": "biz-internet", "color2": "gold" } ], "incompatible": [ { "color1": "lte", "color2": "default" }, { "color1": "3g", "color2": "gold" } ] } }, "dns": { "dnsServerPrimary": "2.2.2.2", "dnsServerSecondary": "3.3.3.3", "host": [ { "hostname": "vbond", "ip": [ "10.0.12.26", "2001:a0:c::1a" ] } ] }, "banner": { "enableFeature": true, "loginMessage": "hello", "motdMessage": "hello" }, "logging": { "enableFeature": true, "server": [ { "name": "3002::1", "vpnId": 0 }, { "name": "3.3.32.2", "vpnId": 0 }, { "name": "adas1.com.sd", "vpnId": 0 } ] }, "snmp": { "enableFeature": true, "version": "v2", "contact": "PaM-2nd-Level@telekom.de", "name": "vManage-01-FRA", "location": "Cisco Cloud - AWS-FRA", "versionSpecificData": { "view": [ { "name": "xx", "oid": [ { "id": "1.2.2.2.2", "exclude": true }, { "id": "2.2.1.13.2", "exclude": false } ] }, { "name": "yy", "oid": [ { "id": "1.4.2.2.2" } ] } ], "community": [ { "name": "comm1", "tag": "test1", "view": "xx" }, { "name": "comm2", "tag": "test2", "view": "yy" } ], "trap": { "target": [ { "vpnId": 0, "ip": "2.2.2.2", "port": 23, "communityTag": "test1", "groupName": "trap-group1" }, { "vpnId": 0, "ip": "3.2.2.2", "port": 12312, "communityTag": "test2", "groupName": "trap-group1" } ], "group": [ { "groupName": "trap-group1", "enable": [ { "module": "all", "level": [ "critical" ] }, { "module": "bfd", "level": [ "major" ] }, { "module": "control", "level": [ "critical" ] }, { "module": "dhcp", "level": [ "minor" ] } ] } ] } } } }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigControlcomponentSettingRequestExampleCreatecommonsettings" }, "CreateControlComponentNetworkCommonSettingWithMinimumFeatures": { "description": "CreateControlComponentNetworkCommonSettingWithMinimumFeatures", "value": { "ntp": { "server": [ { "name": "time.google.com" } ] }, "aaa": { "authOrder": [ "local" ], "user": [ { "name": "admin", "password": "admin" } ] } }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigControlcomponentSettingRequestExampleCreatecommonsettingsminimum" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "required": [ "aaa", "ntp" ], "type": "object", "properties": { "aaa": { "required": [ "authOrder", "user" ], "type": "object", "properties": { "accounting": { "type": "boolean", "description": "Enable/disable user accounting", "example": false, "default": false }, "adminAuthOrder": { "type": "boolean", "description": "Authenticate admin user as per auth-order", "example": false, "default": false }, "authFallback": { "type": "boolean", "description": "Fall back if higher-priority authentication fails", "example": false, "default": false }, "authOrder": { "maxItems": 3, "minItems": 1, "uniqueItems": true, "type": "array", "items": { "type": "string", "description": "Authentication order list", "example": "local", "enum": [ "local", "radius", "tacacs" ] } }, "ciscoTacRoUser": { "type": "boolean", "description": "Cisco Tac Enable Read only", "default": true }, "ciscoTacRwUser": { "type": "boolean", "description": "Cisco Tac Enable Read and Write", "default": true }, "logs": { "type": "object", "properties": { "auditDisable": { "type": "boolean", "description": "Disable audit logs", "default": false }, "netconfDisable": { "type": "boolean", "description": "Disable Netconf logs", "default": false } }, "description": "Enable/Disable audit or netconf logs", "$$ref": "#/components/schemas/AaaLogs" }, "radius": { "type": "object", "properties": { "retransmit": { "maximum": 1000, "minimum": 1, "type": "integer", "description": "Configure how many times to contact each RADIUS server", "format": "int32", "example": 3, "default": 3 }, "server": { "maxItems": 8, "minItems": 0, "type": "array", "description": "RADIUS server configuration", "items": { "required": [ "address", "secretKey" ], "type": "object", "properties": { "acctPort": { "maximum": 65535, "minimum": 0, "type": "integer", "description": "Accounting Port", "format": "int32", "example": 1813, "default": 1813 }, "address": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "Set IP address of RADIUS server", "example": "1.2.2.2" }, "authPort": { "maximum": 65535, "minimum": 0, "type": "integer", "description": "Authentication Port", "format": "int32", "example": 1812, "default": 1812 }, "priority": { "maximum": 7, "minimum": 0, "type": "integer", "description": "Priority", "format": "int32", "example": 1, "default": 0 }, "secretKey": { "pattern": "^(?:\\$CRYPT\\$.{17}|(?!(?:\\$CRYPT\\$)).{1,128})$", "type": "string", "description": "Secret key", "example": "password" }, "tag": { "maxLength": 16, "minLength": 4, "pattern": "^[a-zA-Z0-9\\-_]*$", "type": "string", "description": "Reference tag/name for the server", "example": "radius-server1" }, "vpn": { "type": "integer", "description": "VPN ID", "format": "int32", "example": 0, "enum": [ 0, 512 ], "default": 0 } }, "description": "Configure the RADIUS server", "$$ref": "#/components/schemas/ControlComponentAaaRadiusServer" } }, "timeout": { "maximum": 1000, "minimum": 1, "type": "integer", "description": "Configure how long to wait for replies from the RADIUS server", "format": "int32", "example": 5, "default": 5 } }, "description": "Radius configuration", "$$ref": "#/components/schemas/Radius" }, "radiusServers": { "uniqueItems": true, "type": "array", "items": { "type": "string", "description": "Designate radius server tags for authentication and accounting", "example": "radius-tag1" } }, "tacacs": { "type": "object", "properties": { "authentication": { "type": "string", "description": "TACACS authentication type", "enum": [ "pap", "ascii" ], "default": "pap" }, "servers": { "maxItems": 8, "minItems": 0, "type": "array", "description": "List of TACACS servers", "items": { "required": [ "address", "secretKey" ], "type": "object", "properties": { "acctPort": { "maximum": 65535, "minimum": 0, "type": "integer", "description": "Accounting Port", "format": "int32", "default": 49 }, "address": { "type": "string", "description": "Set IP address of TACACS server", "example": "1.2.2.2" }, "authPort": { "maximum": 65535, "minimum": 0, "type": "integer", "description": "Authentication Port", "format": "int32", "default": 49 }, "priority": { "maximum": 7, "minimum": 0, "type": "integer", "description": "TACACS server priority <0..7>", "format": "int32", "example": 1, "default": 0 }, "secretKey": { "pattern": "^(?:\\$CRYPT\\$.{17}|(?!(?:\\$CRYPT\\$)).{1,128})$", "type": "string", "description": "TACACS server password", "example": "Password123" }, "vpn": { "type": "integer", "description": "VPN ID", "format": "int32", "example": 0, "enum": [ 0, 512 ], "default": 0 } }, "description": "Configure the TACACS server", "$$ref": "#/components/schemas/TacacsServer" } }, "timeout": { "maximum": 1000, "minimum": 1, "type": "integer", "description": "Configure how long to wait for replies from the TACACS server", "format": "int32", "default": 5 } }, "description": "TACACS configuration", "$$ref": "#/components/schemas/Tacacs" }, "user": { "maxItems": 2147483647, "minItems": 1, "type": "array", "description": "Create local login account", "items": { "required": [ "name", "password" ], "type": "object", "properties": { "name": { "maxLength": 128, "minLength": 1, "pattern": "^(?!(?:root|daemon|bin|sys|sync|games|man|lp|mail|news|uucp|proxy|www-data|backup|list|irc|gnats|nobody|basic|sshd|quagga|vmanage-admin|vmanage|viptela-reserved)$)[a-z][a-z0-9._-]*$", "type": "string", "description": "User name", "example": "admin" }, "password": { "pattern": "^(?:\\$CRYPT\\$.{17}|(?!(?:\\$CRYPT\\$)).{1,128})$", "type": "string", "description": "User password, either a encrypted string starting with $CRYPT$, or a clear text string of length 1\u2013128", "example": "password" }, "userGroup": { "type": "string", "description": "User group name which user belongs to", "example": "netadmin", "enum": [ "basic", "operator", "netadmin" ] } }, "description": "Create local login account", "$$ref": "#/components/schemas/AaaLocalUser" } } }, "description": "Configure local users, TACACS or RADIUS servers for control components", "$$ref": "#/components/schemas/ControlComponentAaaSetting" }, "banner": { "required": [ "enableFeature" ], "type": "object", "properties": { "enableFeature": { "type": "boolean", "description": "Enable Banner feature or not", "default": false }, "loginMessage": { "maxLength": 2048, "minLength": 1, "type": "string", "description": "Set message to display before login prompt", "example": "Hello user" }, "motdMessage": { "maxLength": 2048, "minLength": 1, "type": "string", "description": "Set message to display after a user logs in", "example": "Hello" } }, "description": "Banner configuration", "$$ref": "#/components/schemas/ControlComponentBannerSetting" }, "controller": { "type": "object", "properties": { "hubSpokeTopology": { "type": "boolean", "description": "Hub & spoke topology", "default": false }, "omp": { "type": "object", "properties": { "controllerSendPathLimit": { "maximum": 128, "minimum": 4, "type": "integer", "description": "Limit number of paths sent to vSmart controller for a prefix", "format": "int32", "example": 20 }, "discardRejected": { "type": "boolean", "description": "Enable/Disable storage of information rejected by policy", "example": false, "default": false }, "filterRoute": { "required": [ "outbound" ], "type": "object", "properties": { "outbound": { "type": "object", "properties": { "affinityGroupPreference": { "type": "boolean", "description": "Filter routes based on affinity preference list", "example": false, "default": false }, "tlocColor": { "type": "boolean", "description": "Filter routes based on TLOC color compatibility list", "example": false, "default": false } }, "$$ref": "#/components/schemas/Outbound" } }, "description": "OMP filter route configuration", "$$ref": "#/components/schemas/OmpFilterRoute" }, "gracefulRestart": { "type": "boolean", "description": "Enable/Disable graceful restart", "example": true, "default": true }, "outboundPolicyCaching": { "type": "boolean" }, "sendBackupPaths": { "type": "boolean", "description": "Enable/Disable transmission of backup paths", "example": false, "default": false }, "shutdown": { "type": "boolean", "description": "Enable/disable OMP", "example": false, "default": false }, "timers": { "type": "object", "properties": { "advertisementInterval": { "maximum": 65535, "minimum": 0, "type": "integer", "description": "Advertisement Interval (seconds), set the time between OMP Update packets", "format": "int32", "example": 1, "default": 1 }, "eorTimer": { "maximum": 3600, "minimum": 1, "type": "integer", "description": "End of RIB timer, in seconds", "format": "int32", "example": 300, "default": 300 }, "gracefulRestartTimer": { "maximum": 31556952, "minimum": 1, "type": "integer", "description": "Graceful restart timer, in seconds", "format": "int32", "example": 43200, "default": 43200 }, "holdTime": { "maximum": 65535, "minimum": 0, "type": "integer", "description": "Hold Time(Seconds), Set how long to wait before closing OMP peer connection", "format": "int32", "example": 300, "default": 300 } }, "description": "OMP timers", "$$ref": "#/components/schemas/OmpTimers" } }, "description": "Controller OMP configuration", "$$ref": "#/components/schemas/OmpSetting" }, "tlocColorCompatibility": { "type": "object", "properties": { "compatible": { "uniqueItems": true, "type": "array", "items": { "required": [ "color1", "color2" ], "type": "object", "properties": { "color1": { "type": "string", "description": "First TLOC color in comparsion", "enum": [ "default", "mpls", "metro-ethernet", "biz-internet", "public-internet", "lte", "3g", "red", "green", "blue", "gold", "silver", "bronze", "custom1", "custom2", "custom3", "private1", "private2", "private3", "private4", "private5", "private6" ] }, "color2": { "type": "string", "description": "Second TLOC color in comparsion", "enum": [ "default", "mpls", "metro-ethernet", "biz-internet", "public-internet", "lte", "3g", "red", "green", "blue", "gold", "silver", "bronze", "custom1", "custom2", "custom3", "private1", "private2", "private3", "private4", "private5", "private6" ] } }, "description": "List of Incompatible TLOC colors", "$$ref": "#/components/schemas/Compatible" } }, "incompatible": { "uniqueItems": true, "type": "array", "items": { "required": [ "color1", "color2" ], "type": "object", "properties": { "color1": { "type": "string", "description": "First TLOC color in comparsion", "enum": [ "default", "mpls", "metro-ethernet", "biz-internet", "public-internet", "lte", "3g", "red", "green", "blue", "gold", "silver", "bronze", "custom1", "custom2", "custom3", "private1", "private2", "private3", "private4", "private5", "private6" ] }, "color2": { "type": "string", "description": "Second TLOC color in comparsion", "enum": [ "default", "mpls", "metro-ethernet", "biz-internet", "public-internet", "lte", "3g", "red", "green", "blue", "gold", "silver", "bronze", "custom1", "custom2", "custom3", "private1", "private2", "private3", "private4", "private5", "private6" ] } }, "description": "List of Incompatible TLOC colors", "$$ref": "#/components/schemas/Compatible" } } }, "description": "List of compatible/incompatible TLOC colors for BFD session formation", "$$ref": "#/components/schemas/TlocColorCompatibility" } }, "description": "Controller fabric OMP and system settings", "$$ref": "#/components/schemas/ControllerFabricSetting" }, "dns": { "type": "object", "properties": { "dnsServerPrimary": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "Primary DNS server IPv4 or IPv6 Address", "example": "10.2.2.2" }, "dnsServerSecondary": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "Secondary DNS server IPv4 or IPv6 Address", "example": "10.2.2.3" }, "host": { "type": "array", "items": { "required": [ "hostname", "ip" ], "type": "object", "properties": { "hostname": { "pattern": "^[a-zA-Z0-9\\-_.]{1,64}$", "type": "string", "description": "Host name", "example": "vbond" }, "ip": { "maxItems": 64, "minItems": 1, "uniqueItems": true, "type": "array", "items": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "IP Address", "example": "10.1.1.1" } } }, "description": "Static host mapping", "$$ref": "#/components/schemas/DnsHostMapping" } } }, "description": "Configure DNS servers or static host mapping", "$$ref": "#/components/schemas/ControlComponentDnsSetting" }, "logging": { "required": [ "enableFeature" ], "type": "object", "properties": { "enableFeature": { "type": "boolean", "description": "Enable Logging feature or not", "default": false }, "server": { "maxItems": 4, "minItems": 0, "type": "array", "description": "Configure logging servers(Maximum 4 servers)", "items": { "required": [ "name" ], "type": "object", "properties": { "enableTlsTransport": { "type": "boolean", "description": "Enable TLS transport, otherwise UDP as transport", "default": true }, "name": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))|((?=.{1,253}$)((([a-zA-Z0-9_]([a-zA-Z0-9\\-_]){0,61})?[a-zA-Z0-9]\\.)*([a-zA-Z0-9_]([a-zA-Z0-9\\-_]){0,61})?[a-zA-Z0-9]\\.?)|\\.)", "type": "string", "description": "Set hostname, IPv4 address or IPv6 address for the server", "example": "1.2.2.3" }, "vpnId": { "type": "integer", "description": "VPN ID", "format": "int32", "example": 0, "enum": [ 0, 512 ], "default": 0 } }, "description": "Logging Server", "$$ref": "#/components/schemas/LoggingServer" } } }, "description": "Logging feature for control components", "$$ref": "#/components/schemas/ControlComponentLoggingSetting" }, "managementDns": { "type": "object", "properties": { "dnsServerPrimary": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "Primary DNS server IPv4 or IPv6 Address", "example": "10.2.2.2" }, "dnsServerSecondary": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "Secondary DNS server IPv4 or IPv6 Address", "example": "10.2.2.3" }, "host": { "type": "array", "items": { "required": [ "hostname", "ip" ], "type": "object", "properties": { "hostname": { "pattern": "^[a-zA-Z0-9\\-_.]{1,64}$", "type": "string", "description": "Host name", "example": "vbond" }, "ip": { "maxItems": 64, "minItems": 1, "uniqueItems": true, "type": "array", "items": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "IP Address", "example": "10.1.1.1" } } }, "description": "Static host mapping", "$$ref": "#/components/schemas/DnsHostMapping" } } }, "description": "Configure DNS servers or static host mapping", "$$ref": "#/components/schemas/ControlComponentDnsSetting" }, "ntp": { "required": [ "server" ], "type": "object", "properties": { "server": { "maxItems": 4, "minItems": 1, "type": "array", "description": "NTP Server (up to 4)", "items": { "required": [ "name" ], "type": "object", "properties": { "authenticationKey": { "maxLength": 2147483647, "minLength": 1, "type": "string", "description": "Value of the CMAC AES-128 authentication key", "example": "123456" }, "name": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))|((?=.{1,253}$)((([a-zA-Z0-9_]([a-zA-Z0-9\\-_]){0,61})?[a-zA-Z0-9]\\.)*([a-zA-Z0-9_]([a-zA-Z0-9\\-_]){0,61})?[a-zA-Z0-9]\\.?)|\\.)", "type": "string", "description": "Set hostname or IP address of server", "example": "1.2.2.3" }, "prefer": { "type": "boolean", "description": "Prefer this NTP server", "example": false, "default": false }, "vpnId": { "type": "integer", "description": "VPN ID", "format": "int32", "example": 0, "enum": [ 0, 512 ], "default": 0 } }, "description": "NTP Server for control components", "$$ref": "#/components/schemas/NtpServer" } } }, "description": "NTP setting for control components", "$$ref": "#/components/schemas/ControlComponentNtpSetting" }, "security": { "required": [ "protocol" ], "type": "object", "properties": { "protocol": { "type": "string", "description": "Control connection protocol, default is DTLS", "example": "dtls", "enum": [ "dtls", "tls" ], "default": "dtls" }, "tlsPort": { "maximum": 65535, "minimum": 1025, "type": "integer", "description": "TLS port, cannot coexist with protocol(DTLS)", "format": "int32", "example": 23456, "default": 23456 } }, "description": "Security configuration for control components", "$$ref": "#/components/schemas/ControlComponentSecuritySetting" }, "snmp": { "required": [ "enableFeature" ], "type": "object", "properties": { "contact": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Set the contact for this managed node", "example": "PaM-2nd-Level@telekom.de" }, "enableFeature": { "type": "boolean", "description": "Enable or disable SNMP", "example": false, "default": false }, "location": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Set the physical location of this managed node", "example": "Cisco Cloud - AWS-FRA" }, "name": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Set the assigned name for this managed node", "example": "vManage-01-FRA" }, "version": { "type": "string", "description": "SNMP version(v2 or v3)", "example": "v3", "enum": [ "v2", "v3" ], "default": "v3" }, "versionSpecificData": { "type": "object", "description": "SNMP configuration", "oneOf": [ { "required": [ "community", "view" ], "type": "object", "properties": { "community": { "maxItems": 2147483647, "minItems": 1, "type": "array", "description": "SNMPv2 community configuration", "items": { "required": [ "name", "tag", "view" ], "type": "object", "properties": { "name": { "pattern": "^(?:\\$CRYPT\\$.{17}|(?!(?:\\$CRYPT\\$))[\\S]{1,})$", "type": "string", "description": "Set name of the SNMP community", "example": "community_test" }, "tag": { "pattern": "^(?=.{1,32}$)([^<>]*)$", "type": "string", "description": "Set alias name for SNMP community", "example": "test" }, "view": { "pattern": "^(?=.{1,32}$)([^<>]*)$", "type": "string", "description": "SNMP view name", "example": "test" } }, "description": "SNMPv2 community", "$$ref": "#/components/schemas/Snmpv2Community" } }, "trap": { "required": [ "group", "target" ], "type": "object", "properties": { "group": { "maxItems": 8, "minItems": 0, "type": "array", "description": "SNMPv2 trap groups", "items": { "required": [ "enable", "groupName" ], "type": "object", "properties": { "enable": { "maxItems": 2147483647, "minItems": 1, "type": "array", "description": "Trap module configuration", "items": { "required": [ "level", "module" ], "type": "object", "properties": { "level": { "maxItems": 3, "minItems": 1, "uniqueItems": true, "type": "array", "items": { "type": "string", "description": "Trap level", "example": "critical", "enum": [ "critical", "major", "minor" ] } }, "module": { "type": "string", "description": "SNMP trap module name", "example": "all", "enum": [ "all", "app-route", "bfd", "control", "dhcp", "hardware", "omp", "routing", "security", "system", "vpn", "bridge", "policy", "wwan" ] } }, "description": "Enable SNMP trap modules", "$$ref": "#/components/schemas/SnmpTrapModule" } }, "groupName": { "pattern": "^(?=.{1,32}$)([^<>]*)$", "type": "string", "description": "Trap group name", "example": "trapGroup1" } }, "description": "SNMPv3 trap groups", "$$ref": "#/components/schemas/TrapGroup" } }, "target": { "type": "array", "description": "SNMPv2 target configuration", "items": { "required": [ "communityTag", "groupName", "ip", "port", "vpnId" ], "type": "object", "properties": { "communityTag": { "pattern": "^(?=.{1,32}$)([^<>]*)$", "type": "string", "description": "Port number", "example": "COMMUNITY_TEST" }, "groupName": { "pattern": "^(?=.{1,32}$)([^<>]*)$", "type": "string", "description": "SNMPv3 group name", "example": "group1" }, "ip": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "IPv4 or IPv6 address", "example": "1.1.1.3" }, "port": { "maximum": 65535, "minimum": 1, "type": "integer", "description": "Set UDP port number to connect to SNMP server", "format": "int32", "example": 13212 }, "vpnId": { "type": "integer", "description": "VPN ID", "format": "int32", "example": 0, "enum": [ 0, 512 ] } }, "description": "SNMPv2 Target server configuration", "$$ref": "#/components/schemas/Snmpv2Target" } } }, "description": "SNMPv2 trap configuration", "$$ref": "#/components/schemas/Snmpv2Trap" }, "view": { "maxItems": 2147483647, "minItems": 1, "type": "array", "description": "SNMPv2 view configuration", "items": { "required": [ "name" ], "type": "object", "properties": { "name": { "pattern": "^(?=.{1,32}$)([^<>]*)$", "type": "string", "description": "SNMP view name" }, "oid": { "type": "array", "description": "Configure SNMP object identifier", "items": { "required": [ "id" ], "type": "object", "properties": { "exclude": { "type": "boolean", "description": "Exclude the OID or not", "example": false, "default": false }, "id": { "pattern": "(([0-1](\\.[1-3]?[0-9]))|(2\\.(0|([1-9]\\d*))))(\\.(0|\\*|([1-9]\\d*))){0,126}", "type": "string", "description": "Configure identifier of subtree of MIB objects", "example": "2.1.1.11.1" } }, "description": "SNMP OID configuration", "$$ref": "#/components/schemas/SnmpOID" } } }, "description": "SNMP view configuration", "$$ref": "#/components/schemas/SnmpView" } } }, "description": "SNMPv2 configuration", "$$ref": "#/components/schemas/SNMPv2Data" }, { "required": [ "group", "user", "view" ], "type": "object", "properties": { "group": { "maxItems": 2147483647, "minItems": 1, "type": "array", "description": "SNMPv3 group configuration", "items": { "required": [ "name", "securityLevel", "view" ], "type": "object", "properties": { "name": { "pattern": "^(?=.{1,32}$)([^<>]*)$", "type": "string", "description": "SNMP group name", "example": "group" }, "securityLevel": { "type": "string", "description": "Security Level", "example": "auth-priv", "enum": [ "no-auth-no-priv", "auth-priv" ] }, "view": { "pattern": "^(?=.{1,32}$)([^<>]*)$", "type": "string", "description": "View name", "example": "view1" } }, "description": "SNMPv3 group configuration", "$$ref": "#/components/schemas/Snmpv3Group" } }, "trap": { "required": [ "group", "target" ], "type": "object", "properties": { "group": { "maxItems": 8, "minItems": 0, "type": "array", "description": "SNMPv3 trap groups", "items": { "required": [ "enable", "groupName" ], "type": "object", "properties": { "enable": { "maxItems": 2147483647, "minItems": 1, "type": "array", "description": "Trap module configuration", "items": { "required": [ "level", "module" ], "type": "object", "properties": { "level": { "maxItems": 3, "minItems": 1, "uniqueItems": true, "type": "array", "items": { "type": "string", "description": "Trap level", "example": "critical", "enum": [ "critical", "major", "minor" ] } }, "module": { "type": "string", "description": "SNMP trap module name", "example": "all", "enum": [ "all", "app-route", "bfd", "control", "dhcp", "hardware", "omp", "routing", "security", "system", "vpn", "bridge", "policy", "wwan" ] } }, "description": "Enable SNMP trap modules", "$$ref": "#/components/schemas/SnmpTrapModule" } }, "groupName": { "pattern": "^(?=.{1,32}$)([^<>]*)$", "type": "string", "description": "Trap group name", "example": "trapGroup1" } }, "description": "SNMPv3 trap groups", "$$ref": "#/components/schemas/TrapGroup" } }, "target": { "type": "array", "description": "SNMPv3 target configuration", "items": { "required": [ "groupName", "ip", "port", "user", "vpnId" ], "type": "object", "properties": { "groupName": { "pattern": "^(?=.{1,32}$)([^<>]*)$", "type": "string", "description": "SNMPv3 group name", "example": "group1" }, "ip": { "pattern": "(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))", "type": "string", "description": "IPv4 or IPv6 address", "example": "1.1.1.3" }, "port": { "maximum": 65535, "minimum": 1, "type": "integer", "description": "Set UDP port number to connect to SNMP server", "format": "int32", "example": 13212 }, "user": { "pattern": "^(?=.{1,32}$)([^<>]*)$", "type": "string", "description": "SNMPv3 user name", "example": "test1" }, "vpnId": { "type": "integer", "description": "VPN ID", "format": "int32", "example": 0, "enum": [ 0, 512 ], "default": 0 } }, "description": "SNMPv3 target configuration", "$$ref": "#/components/schemas/Snmpv3Target" } } }, "description": "SNMPv3 trap configuration", "$$ref": "#/components/schemas/Snmpv3Trap" }, "user": { "maxItems": 2147483647, "minItems": 1, "type": "array", "description": "SNMPv3 user configuration", "items": { "required": [ "group", "name" ], "type": "object", "properties": { "authPassword": { "pattern": "^(?:\\$CRYPT\\$.{17}|(?!(?:\\$CRYPT\\$)).{8,128})$", "type": "string", "description": "Authentication password, either a encrypt string starting with $CRYPT$, or a clear text string of length 8 to 128", "example": "authPassword" }, "group": { "pattern": "^(?=.{1,32}$)([^<>]*)$", "type": "string", "description": "SNMP group name", "example": "group1" }, "name": { "pattern": "^(?=.{1,32}$)([^<>]*)$", "type": "string", "description": "SNMPv3 User name", "example": "user1" }, "privPassword": { "pattern": "^(?:\\$CRYPT\\$.{17}|(?!(?:\\$CRYPT\\$)).{8,128})$", "type": "string", "description": "Privilege password, either a encrypt string starting with $CRYPT$, or a clear text string of length 8 to 128", "example": "privPassword" } }, "description": "SNMPv3 user", "$$ref": "#/components/schemas/SNMPv3User" } }, "view": { "maxItems": 2147483647, "minItems": 1, "type": "array", "description": "SNMPv3 view configuration", "items": { "required": [ "name" ], "type": "object", "properties": { "name": { "pattern": "^(?=.{1,32}$)([^<>]*)$", "type": "string", "description": "SNMP view name" }, "oid": { "type": "array", "description": "Configure SNMP object identifier", "items": { "required": [ "id" ], "type": "object", "properties": { "exclude": { "type": "boolean", "description": "Exclude the OID or not", "example": false, "default": false }, "id": { "pattern": "(([0-1](\\.[1-3]?[0-9]))|(2\\.(0|([1-9]\\d*))))(\\.(0|\\*|([1-9]\\d*))){0,126}", "type": "string", "description": "Configure identifier of subtree of MIB objects", "example": "2.1.1.11.1" } }, "description": "SNMP OID configuration", "$$ref": "#/components/schemas/SnmpOID" } } }, "description": "SNMP view configuration", "$$ref": "#/components/schemas/SnmpView" } } }, "description": "SNMPv3 configuration", "$$ref": "#/components/schemas/SNMPv3Data" } ], "$$ref": "#/components/schemas/SnmpVersionSpecificData" } }, "description": "SNMP setting", "$$ref": "#/components/schemas/ControlComponentSnmpSetting" } }, "description": "Configure network level features for all control components", "$$ref": "#/components/schemas/ControlComponentNetworkSettings" }, "examples": { "CreateControlComponentNetworkCommonSettingWithAllFeatures": { "description": "CreateControlComponentNetworkCommonSettingWithAllFeatures", "value": { "ntp": { "server": [ { "name": "1.1.1.1", "vpnId": 0, "prefer": true }, { "name": "2002::1", "vpnId": 0, "prefer": false }, { "name": "time.google.com", "vpnId": 0, "prefer": false }, { "name": "2.1.1.1", "vpnId": 0, "prefer": false } ] }, "aaa": { "authOrder": [ "local", "radius", "tacacs" ], "radiusServers": [ "radius1", "radius2" ], "authFallback": true, "adminAuthOrder": true, "accounting": true, "user": [ { "name": "admin", "password": "$CRYPT$LlBMcwaztmurYKfN/" }, { "name": "xx", "password": "$CRYPT$hy1nRjYaA4mqsTgLU", "userGroup": "netadmin" } ], "ciscoTacRoUser": false, "ciscoTacRwUser": false, "tacacs": { "timeout": 232, "authentication": "ascii", "servers": [ { "address": "1.1.1.1", "authPort": 32200, "acctPort": 1200, "vpn": 0, "secretKey": "$CRYPT$ZrYAwz9pB8WOkW+gj", "priority": 2 }, { "address": "2002::1", "authPort": 321, "acctPort": 232, "vpn": 0, "secretKey": "$CRYPT$vgNok88PqemwCW0mX", "priority": 3 } ] }, "radius": { "timeout": 32, "retransmit": 12, "server": [ { "address": "1.1.1.1", "authPort": 1232, "acctPort": 12312, "tag": "radius1", "vpn": 0, "secretKey": "$CRYPT$9DvMb0HTJkPsW+ryY", "priority": 1 }, { "address": "3.3.3.3", "authPort": 1234, "acctPort": 123, "tag": "radius2", "vpn": 0, "secretKey": "$CRYPT$Wyt41hQUJ4bZ1pEb6", "priority": 2 } ] }, "logs": { "auditDisable": true, "netconfDisable": true } }, "security": { "protocol": "dtls" }, "controller": { "omp": { "shutdown": false, "controllerSendPathLimit": 10, "filterRoute": { "outbound": { "affinityGroupPreference": false, "tlocColor": false } }, "sendBackupPaths": false, "discardRejected": false, "gracefulRestart": true, "timers": { "holdTime": 3200, "advertisementInterval": 1, "gracefulRestartTimer": 110, "eorTimer": 200 } }, "tlocColorCompatibility": { "compatible": [ { "color1": "mpls", "color2": "default" }, { "color1": "biz-internet", "color2": "gold" } ], "incompatible": [ { "color1": "lte", "color2": "default" }, { "color1": "3g", "color2": "gold" } ] } }, "dns": { "dnsServerPrimary": "2.2.2.2", "dnsServerSecondary": "3.3.3.3", "host": [ { "hostname": "vbond", "ip": [ "10.0.12.26", "2001:a0:c::1a" ] } ] }, "banner": { "enableFeature": true, "loginMessage": "hello", "motdMessage": "hello" }, "logging": { "server": [ { "name": "3002::1", "vpnId": 0 }, { "name": "3.3.32.2", "vpnId": 0 }, { "name": "adas1.com.sd", "vpnId": 0 } ], "enableFeature": true }, "snmp": { "version": "v2", "contact": "PaM-2nd-Level@telekom.de", "name": "vManage-01-FRA", "location": "Cisco Cloud - AWS-FRA", "versionSpecificData": { "view": [ { "name": "xx", "oid": [ { "id": "1.2.2.2.2", "exclude": true }, { "id": "2.2.1.13.2", "exclude": false } ] }, { "name": "yy", "oid": [ { "id": "1.4.2.2.2" } ] } ], "community": [ { "name": "$CRYPT$/gP0oCyfJrtcopHSG", "tag": "test1", "view": "xx" }, { "name": "$CRYPT$tB7e6QTIUrMRq5vP5", "tag": "test2", "view": "yy" } ], "trap": { "target": [ { "vpnId": 0, "ip": "2.2.2.2", "port": 23, "communityTag": "test1", "groupName": "trap-group1" }, { "vpnId": 0, "ip": "3.2.2.2", "port": 12312, "communityTag": "test2", "groupName": "trap-group1" } ], "group": [ { "groupName": "trap-group1", "enable": [ { "module": "all", "level": [ "critical" ] }, { "module": "bfd", "level": [ "major" ] }, { "module": "control", "level": [ "critical" ] }, { "module": "dhcp", "level": [ "minor" ] } ] } ] } }, "enableFeature": true } }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigControlcomponentSettingResponseExampleCreatecommonsettingsresponse" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "required": [ "error" ], "type": "object", "properties": { "error": { "required": [ "code", "details", "message", "type" ], "type": "object", "properties": { "code": { "type": "string", "description": "Internal error code", "example": "CCS0018" }, "details": { "type": "string", "description": "Error message detail", "example": "Unrecognized field user1" }, "message": { "type": "string", "description": "Error message summary", "example": "Invalid control component setting payload" }, "type": { "type": "string", "description": "Error message title", "example": "error" } }, "description": "Error response", "$$ref": "#/components/schemas/ErrorDetails" } }, "$$ref": "#/components/schemas/ErrorResponse" }, "examples": { "CreateControlComponentCommonSettingsFailed": { "description": "CreateControlComponentCommonSettingsFailed", "value": { "error": { "message": "Invalid control component payload", "code": "CCS0018", "details": "aaa.tacacs.timeout : must be greater than or equal to 1; ", "type": "error" } }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceconfigControlcomponentSettingResponseExampleCreatecommonsettingsfailedresponse" } } } } }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Control Component Settings-write" } }, "/v1/controllers-upgrade": { "post": { "tags": [ "Workflows - Controllers Upgrade" ], "summary": "Trigger controllers upgrade.", "description": "Trigger controllers upgrade.", "operationId": "triggerControllersUpgrade", "requestBody": { "description": "Request payload for controllers upgrade", "content": { "application/json": { "schema": { "required": [ "action", "imageLocation", "isScheduleNow", "targetVersion" ], "type": "object", "properties": { "action": { "type": "string", "description": "Action to perform", "example": "controllers_upgrade/controllers_patch_upgrade" }, "applicableControllerTypes": { "type": "array", "description": "List of controller types applicable for patch upgrade", "example": [ "Manager", "Controller", "Validator" ], "items": { "type": "string", "description": "List of controller types applicable for patch upgrade", "example": [ "Manager", "Controller", "Validator" ] } }, "imageLocation": { "type": "string", "description": "Image location", "example": "vmanage/cco" }, "isScheduleNow": { "type": "boolean", "description": "Flag to schedule the upgrade immediately", "example": false }, "schedule": { "type": "object", "additionalProperties": { "type": "object", "properties": { "actionStartDate": { "type": "string", "description": "Start date for the action", "example": "Sep 30 2026" }, "actionStartTime": { "type": "string", "description": "Start time for the action", "example": "12:00:00 AM" }, "timeZone": { "type": "string", "description": "Timezone for the scheduled action", "example": "Asia/Kolkata" } }, "description": "Scheduling details for a controller component", "$$ref": "#/components/schemas/ComponentSchedule" }, "description": "Scheduling details for different component types" }, "targetVersion": { "type": "string", "description": "Target version for upgrade", "example": "20.18.1" } }, "description": "Request payload for controllers upgrade process", "$$ref": "#/components/schemas/ControllerUpgradeRequest" }, "examples": { "Schedule Now Controllers Upgrade": { "description": "Schedule Now Controllers Upgrade", "value": { "action": "controllers_upgrade", "targetVersion": "20.18.1", "imageLocation": "vmanage/cco", "isScheduleNow": true } }, "Schedule Later Controllers Upgrade": { "description": "Schedule Later Controllers Upgrade", "value": { "action": "controllers_upgrade", "targetVersion": "20.18.1", "imageLocation": "vmanage/cco", "isScheduleNow": false, "schedule": { "Controller": { "actionStartDate": "Sep 30 2026", "actionStartTime": "12:00:00 AM", "timeZone": "Asia/Kolkata" }, "Manager": { "actionStartDate": "Sep 30 2026", "actionStartTime": "12:00:00 AM", "timeZone": "Asia/Kolkata" }, "Validator": { "actionStartDate": "Sep 30 2026", "actionStartTime": "12:00:00 AM", "timeZone": "Asia/Kolkata" } } } }, "Schedule Now Patch Upgrade": { "description": "Schedule Now Patch Upgrade", "value": { "action": "controllers_patch_upgrade", "targetVersion": "20.18.1.0.0.1", "imageLocation": "vmanage/cco", "isScheduleNow": true, "applicableControllerTypes": [ "Manager", "Controller", "Validator" ] } }, "Schedule Later Patch Upgrade": { "description": "Schedule Later Patch Upgrade", "value": { "action": "controllers_patch_upgrade", "targetVersion": "20.18.1.0.0.1", "imageLocation": "vmanage/cco", "isScheduleNow": false, "applicableControllerTypes": [ "Manager", "Controller", "Validator" ], "schedule": { "Controller": { "actionStartDate": "Sep 30 2026", "actionStartTime": "12:00:00 AM", "timeZone": "Asia/Kolkata" }, "Manager": { "actionStartDate": "Sep 30 2026", "actionStartTime": "12:00:00 AM", "timeZone": "Asia/Kolkata" }, "Validator": { "actionStartDate": "Sep 30 2026", "actionStartTime": "12:00:00 AM", "timeZone": "Asia/Kolkata" } } } } } } }, "required": true }, "responses": { "200": { "description": "Successful response with the controllers upgrade process Id.", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique process Id of the Controllers upgrade.", "example": "controllers_upgrade-0ba19b6e-3b6c-4cd0-9669-dce7e148c623" } }, "$$ref": "#/components/schemas/ControllersUpgradeResponse" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/v1/controllers-upgrade/available-versions": { "get": { "tags": [ "Workflows - Controllers Upgrade" ], "summary": "Retrieve available versions for Controllers upgrade.", "description": "Returns a list of available versions for controller upgrades based on the specified image type.", "operationId": "getAvailableVersions", "parameters": [ { "name": "imageType", "in": "query", "required": true, "schema": { "type": "string", "description": "software: Supports vmanage/viptela images\npatch: Supports 6 tuple patch images", "enum": [ "upgrade", "patch" ] } } ], "responses": { "200": { "description": "Successful response with the list of available versions.", "content": { "application/json": { "schema": { "type": "object", "properties": { "availableVersions": { "type": "array", "description": "List of available versions for controller upgrades", "items": { "type": "object", "properties": { "compatibleControllerTypes": { "uniqueItems": true, "type": "array", "description": "Set of controller types compatible with this version", "example": [ "Manager", "Controller", "Validator" ], "items": { "type": "string", "description": "Set of controller types compatible with this version", "example": [ "Manager", "Controller", "Validator" ] } }, "imageType": { "uniqueItems": true, "type": "array", "description": "Set of supported controller types for this image", "example": [ "Manager", "Controller", "Validator" ], "items": { "type": "string", "description": "Set of supported controller types for this image", "example": [ "Manager", "Controller", "Validator" ] } }, "location": { "type": "string", "description": "Location of the image", "example": "cco", "enum": [ "cco", "vmanage" ] }, "tag": { "type": "string", "description": "Version tag indicating version status", "example": "recommended", "enum": [ "recommended", "latest", "custom" ] }, "version": { "type": "string", "description": "Software version number" } }, "description": "Version information for controllers upgrade", "$$ref": "#/components/schemas/VersionInfo" } } }, "description": "Response containing available controller software versions", "$$ref": "#/components/schemas/AvailableVersionsResponse" }, "examples": { "ExampleUpgradePayload": { "description": "ExampleUpgradePayload", "value": "{\n\"availableVersions\": [\n {\n \"version\": \"20.15.2\",\n \"imageType\": [\"Manager\",\"Controller\",\"Validator\"],\n \"location\": \"cco\",\n \"tag\": \"recommended\",\n \"compatibleControllerTypes\": [\"Manager\",\"Controller\",\"Validator\"]\n },\n {\n \"version\": \"20.17.1\",\n \"imageType\": [\"Manager\",\"Controller\",\"Validator\"],\n \"location\": \"cco\",\n \"tag\": \"latest\",\n \"compatibleControllerTypes\": [\"Manager\",\"Controller\",\"Validator\"]\n },\n {\n \"version\": \"20.17.1\",\n \"imageType\": [\"Controller\",\"Validator\"],\n \"location\": \"vmanage\",\n \"tag\": \"custom\",\n \"compatibleControllerTypes\": [\"Controller\",\"Validator\"],\n },\n {\n \"version\": \"20.17.2\",\n \"imageType\": [\"Manager\"],\n \"location\": \"vmanage\",\n \"tag\": \"custom\",\n \"compatibleControllerTypes\": [\"Manager\"],\n },\n {\n \"version\": \"20.17.3\",\n \"imageType\": [\"Manager\",\"Controller\",\"Validator\"],\n \"location\": \"vmanage\",\n \"tag\": \"custom\",\n \"compatibleControllerTypes\": [\"Manager\",\"Controller\",\"Validator\"],\n }\n]\n}" }, "ExamplePatchPayload": { "description": "ExamplePatchPayload", "value": "{\n\"availableVersions\": [\n {\n \"version\": \"20.17.2.1.2.3\",\n \"imageType\": [\"Manager\",\"Controller\",\"Validator\"],\n \"location\": \"cco\",\n \"tag\": \"recommended\",\n \"compatibleControllerTypes\": [\"Manager\",\"Controller\",\"Validator\"],\n },\n {\n \"version\": \"20.17.1.0.0.1\",\n \"imageType\": [\"Manager\",\"Controller\",\"Validator\"],\n \"location\": \"cco\",\n \"tag\": \"latest\",\n \"compatibleControllerTypes\": [\"Controller\",\"Validator\"],\n },\n {\n \"version\": \"20.17.1.1.0.0\",\n \"imageType\": [\"Controller\",\"Validator\"],\n \"location\": \"vmanage\",\n \"tag\": \"custom\",\n \"compatibleControllerTypes\": [\"Validator\"],\n },\n {\n \"version\": \"20.17.2.0.1.0\",\n \"imageType\": [\"Manager\"],\n \"location\": \"vmanage\",\n \"tag\": \"custom\",\n \"compatibleControllerTypes\": [\"Manager\"],\n },\n {\n \"version\": \"20.17.3.1.1.1\",\n \"imageType\": [\"Manager\",\"Controller\",\"Validator\"],\n \"location\": \"vmanage\",\n \"tag\": \"custom\",\n \"compatibleControllerTypes\": [\"Manager\",\"Controller\",\"Validator\"],\n }\n]\n}" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/v1/controllers-upgrade/cancel": { "put": { "tags": [ "Workflows - Controllers Upgrade" ], "summary": "Cancel controllers upgrade process.", "description": "Cancel the upgrade process for controllers, managers, and validators.", "operationId": "cancelUpgrade", "requestBody": { "description": "Request payload for controllers upgrade", "content": { "application/json": { "schema": { "required": [ "processId" ], "type": "object", "properties": { "processId": { "type": "string", "description": "Unique ID of the upgrade process to cancel", "example": "controllers_upgrade-61fe5fb4-81d2-4ff0-8294-e23c17b0d79e" } }, "description": "Request payload for cancelling controller upgrade process", "$$ref": "#/components/schemas/ControllerUpgradeCancelRequest" }, "examples": { "Request Payload": { "description": "Request Payload", "value": { "processId": "controllers_upgrade-61fe5fb4-81d2-4ff0-8294-e23c17b0d79e" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully cancelled the upgrade process", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "description": "Status of the operation (Cancel/Reschedule)" }, "statusDetail": { "type": "string", "description": "Detailed description of the operation (Cancel/Reschedule) result" } }, "$$ref": "#/components/schemas/ControllersOperationResponse" }, "examples": { "Response Payload": { "description": "Response Payload", "value": { "status": "Success", "statusDetail": "Upgrade process successfully cancelled" } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/v1/controllers-upgrade/reschedule": { "put": { "tags": [ "Workflows - Controllers Upgrade" ], "summary": "Reschedule controllers upgrade process.", "description": "Reschedule the upgrade process for managers, validators, and controllers by providing new execution timestamps.", "operationId": "rescheduleUpgrade", "requestBody": { "description": "Request payload for controllers upgrade", "content": { "application/json": { "schema": { "required": [ "isScheduleNow", "processId" ], "type": "object", "properties": { "isScheduleNow": { "type": "boolean", "description": "Flag to schedule the upgrade immediately", "example": false }, "processId": { "type": "string", "description": "Unique ID of the upgrade process", "example": "controllers_upgrade-61fe5fb4-81d2-4ff0-8294-e23c17b0d79e" }, "schedule": { "type": "object", "additionalProperties": { "type": "object", "properties": { "actionStartDate": { "type": "string", "description": "Start date for the action", "example": "Sep 30 2026" }, "actionStartTime": { "type": "string", "description": "Start time for the action", "example": "12:00:00 AM" }, "timeZone": { "type": "string", "description": "Timezone for the scheduled action", "example": "Asia/Kolkata" } }, "description": "Scheduling details for a controller component", "$$ref": "#/components/schemas/ComponentSchedule" }, "description": "Scheduling details for different component types" } }, "description": "Request payload for rescheduling controller upgrade process", "$$ref": "#/components/schemas/ControllerUpgradeRescheduleRequest" }, "examples": { "Request Payload - Controllers": { "description": "Request Payload - Controllers", "value": { "processId": "controllers_upgrade-61fe5fb4-81d2-4ff0-8294-e23c17b0d79e", "isScheduleNow": false, "schedule": { "Controller": { "actionStartDate": "Sep 30 2026", "actionStartTime": "12:00:00 AM", "timeZone": "Asia/Kolkata" }, "Manager": { "actionStartDate": "Sep 30 2026", "actionStartTime": "12:00:00 AM", "timeZone": "Asia/Kolkata" }, "Validator": { "actionStartDate": "Sep 30 2026", "actionStartTime": "12:00:00 AM", "timeZone": "Asia/Kolkata" } } } }, "Request Payload - Patch": { "description": "Request Payload - Patch", "value": { "processId": "controllers_patch_upgrade-61fe5fb4-81d2-4ff0-8294-e23c17b0d79e", "isScheduleNow": false, "schedule": { "Validator": { "actionStartDate": "Sep 30 2026", "actionStartTime": "12:00:00 AM", "timeZone": "Asia/Kolkata" } } } }, "Request Payload - Schedule Now": { "description": "Request Payload - Schedule Now", "value": { "processId": "controllers_upgrade-61fe5fb4-81d2-4ff0-8294-e23c17b0d79e", "isScheduleNow": true } } } } }, "required": true }, "responses": { "200": { "description": "Successfully rescheduled the upgrade process", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "description": "Status of the operation (Cancel/Reschedule)" }, "statusDetail": { "type": "string", "description": "Detailed description of the operation (Cancel/Reschedule) result" } }, "$$ref": "#/components/schemas/ControllersOperationResponse" }, "examples": { "Response Payload": { "description": "Response Payload", "value": { "status": "Success", "statusDetail": "Upgrade process successfully rescheduled" } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/v1/controllers-upgrade/status": { "get": { "tags": [ "Workflows - Controllers Upgrade" ], "summary": "Retrieve detailed controllers upgrade status.", "description": "Retrieve detailed upgrade status of controllers by providing process Id.", "operationId": "getUpgradeStatus", "parameters": [ { "name": "processId", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response with detailed upgrade status.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "description": "Status of the operation (Cancel/Reschedule)" }, "statusDetail": { "type": "string", "description": "Detailed description of the operation (Cancel/Reschedule) result" } }, "$$ref": "#/components/schemas/ControllersOperationResponse" }, "examples": { "Sample Response": { "description": "Sample Response", "value": { "validation": { "processId": "controllers_patch_upgrade-18a1ba4e-743f-4f47-91b2-c2babb4f3c60", "uuid": "Validation", "status": "Validation success", "totalChecksPerDevice": 4, "activity": [ { "stage-name": "Validation", "checks": [ { "check-name": "Active Tasks", "status": "Success", "details": "No active tasks found" }, { "check-name": "Version Compatibility", "status": "Success", "details": "Version Compatibility check completed" }, { "check-name": "Impacted Controller Types", "status": "Success", "details": "Validating impacted controller types check completed" }, { "check-name": "Summary", "status": "Success", "details": "All validation checks completed" } ], "noOfChecks": 4, "status": "Validation success" } ] }, "preparation": { "processId": "controllers_patch_upgrade-18a1ba4e-743f-4f47-91b2-c2babb4f3c60", "uuid": "Preparation", "status": "Success", "totalChecksPerDevice": 3, "activity": [ { "stage-name": "Preparation", "checks": [ { "check-name": "Image Availability", "status": "success", "details": "Found patch upgrade image in local repository for version 20.17.1.0.0.2" }, { "check-name": "Launch UC Service", "status": "success", "details": "Manager has successfully started NMS Upgrade Coordinator for patch upgrade" }, { "check-name": "Summary", "status": "success", "details": "Preparation done successfully" } ], "noOfChecks": 3, "status": "Success" } ] }, "data": [ { "processId": "controllers_patch_upgrade-18a1ba4e-743f-4f47-91b2-c2babb4f3c60", "uuid": "00fe3eb9-1ead-4237-b48f-2fd5f48bcac7", "device-type": "vbond", "host-name": "vm16", "system-ip": "172.16.255.26", "site-id": "100", "status": "Failure", "totalChecksPerDevice": 31, "activity": [ { "stage-name": "preDownloadCheck", "checks": [ { "check-name": "Checking Certification expiry", "status": "Success", "details": "Device certificate is valid" }, { "check-name": "Checking device reachability", "status": "Success", "details": "Device is reachable" }, { "check-name": "disk-space-check", "status": "Success", "details": "Sufficient space in /boot partition. Required space: 3266560 bytes, Available space: 2292785152 bytes ,remediation:No Remediation required" }, { "check-name": "version-check", "status": "Failure", "details": "Patch version Check Failed ,remediation:Patch major version mismatch" }, { "check-name": "memory-usage-check", "status": "Success", "details": "System has healthy Memory levels ,remediation:No remediation needed" }, { "check-name": "cpu-load-check", "status": "Success", "details": "System has healthy CPU levels ,remediation:No remediation needed" }, { "check-name": "precheck-fail", "status": "Warning", "details": "Finished Pre-Download image check and Failed ,remediation:Fix the errors and try again" } ], "noOfChecks": 8, "status": "Failure" } ] } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/v1/controllers-upgrade/version-compliance-info": { "get": { "tags": [ "Workflows - Controllers Upgrade" ], "summary": "Get version compliance across tenants.", "description": "Returns compliance information for the specified version of Controllers upgrade across all tenants.", "operationId": "getVersionComplianceInfo", "parameters": [ { "name": "version", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response with compliance information for the specified version.", "content": { "application/json": { "schema": { "type": "object", "properties": { "minimumControllerCompatibleVersion": { "type": "string", "description": "Minimum compatible controller version" }, "minimumDeviceCompatibleVersion": { "type": "string", "description": "Minimum compatible device version" }, "minimumValidatorCompatibleVersion": { "type": "string", "description": "Minimum compatible validator version" }, "nearNonCompliantDeviceCount": { "type": "integer", "description": "Count of devices approaching non-compliance", "format": "int32" }, "nonCompliantControllersCount": { "type": "integer", "description": "Count of non-compliant controllers", "format": "int32" }, "nonCompliantControllersCountLTSMinusOne": { "type": "integer", "description": "Count of non-compliant controllers at LTS minus one version", "format": "int32" }, "nonCompliantControllersCountLTSMinusThree": { "type": "integer", "description": "Count of non-compliant controllers at LTS minus three or lower versions", "format": "int32" }, "nonCompliantControllersCountLTSMinusTwo": { "type": "integer", "description": "Count of non-compliant controllers at LTS minus two versions", "format": "int32" }, "nonCompliantControllersLTSMinusThree": { "type": "array", "description": "List of non-compliant controllers at LTS minus three or lower versions", "items": { "type": "object", "properties": { "checkList": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" }, "status": { "type": "string" }, "type": { "type": "string" }, "upgradeCompatibilityStatus": { "type": "string" } }, "$$ref": "#/components/schemas/CheckList" } }, "deviceDetails": { "required": [ "host", "password", "username", "wan" ], "type": "object", "properties": { "device_uuid": { "type": "string", "description": "device uuid/chassis number", "example": "C8K-4facbd05-855b-45f0-af2f-c844af179bd6" }, "enable_password": { "type": "string", "description": "enable password", "example": "admin" }, "host": { "pattern": "((^\\s*((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))\\s*$)|(^\\s*((([0-9a-f]{1,4}:){7}([0-9a-f]{1,4}|:))|(([0-9a-f]{1,4}:){6}(:[0-9a-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9a-f]{1,4}:){5}(((:[0-9a-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9a-f]{1,4}:){4}(((:[0-9a-f]{1,4}){1,3})|((:[0-9a-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9a-f]{1,4}:){3}(((:[0-9a-f]{1,4}){1,4})|((:[0-9a-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9a-f]{1,4}:){2}(((:[0-9a-f]{1,4}){1,5})|((:[0-9a-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9a-f]{1,4}:){1}(((:[0-9a-f]{1,4}){1,6})|((:[0-9a-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9a-f]{1,4}){1,7})|((:[0-9a-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))(%.+)?\\s*$))", "type": "string", "description": "host ip", "example": "1.1.1.1" }, "local_file_name": { "type": "string", "description": "local file name", "example": "c8000v-universalk9.17.12.01.0.175851.SSA.bin" }, "password": { "type": "string", "description": "ssh password", "example": "admin" }, "remote_server_file_name": { "type": "string", "description": "remote server file name", "example": "c8000v-universalk9.17.12.01.0.175851.SSA.bin" }, "remote_server_id": { "type": "string", "description": "remote server Id", "example": "56a32849-aafb-4703-8887-ba64c0394835" }, "username": { "type": "string", "description": "ssh username", "example": "admin" }, "wan": { "maxLength": 32, "minLength": 3, "pattern": "(Cellular|Dialer|Ethernet|FastEthernet|FiftyGigabitEthernet|FiveGigabitEthernet|FortyGigabitEthernet|FourHundredGigE|GigabitEthernet|HundredGigE|Loopback|Multilink|Port-channel|Serial|TenGigabitEthernet|Tunnel|TwentyFiveGigE|TwentyFiveGigabitEthernet|TwoGigabitEthernet|TwoHundredGigE|Vlan|Wlan-GigabitEthernet)([0-9]*(. ?[1-9][0-9]*)*|[0-9/]+|[0-9]+/[0-9]+/[0-9]+:[0-9]+|[0-9]+/[0-9]+/[0-9]+|[0-9]+/[0-9]+|[0-9]+)", "type": "string", "description": "WAN interface name", "example": "GigabitEthernet1" } }, "description": "Device list to onboard", "$$ref": "#/components/schemas/DeviceDetails" }, "status": { "type": "string" } }, "description": "List of non-compliant validators at LTS minus three or lower versions", "$$ref": "#/components/schemas/DeviceComplianceData" } }, "nonCompliantDeviceCount": { "type": "integer", "description": "Count of non-compliant devices", "format": "int32" }, "nonCompliantValidatorsCount": { "type": "integer", "description": "Count of non-compliant validators", "format": "int32" }, "nonCompliantValidatorsCountLTSMinusOne": { "type": "integer", "description": "Count of non-compliant validators at LTS minus one version", "format": "int32" }, "nonCompliantValidatorsCountLTSMinusThree": { "type": "integer", "description": "Count of non-compliant validators at LTS minus three or lower versions", "format": "int32" }, "nonCompliantValidatorsCountLTSMinusTwo": { "type": "integer", "description": "Count of non-compliant validators at LTS minus two versions", "format": "int32" }, "nonCompliantValidatorsLTSMinusThree": { "type": "array", "description": "List of non-compliant validators at LTS minus three or lower versions", "items": { "type": "object", "properties": { "checkList": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" }, "status": { "type": "string" }, "type": { "type": "string" }, "upgradeCompatibilityStatus": { "type": "string" } }, "$$ref": "#/components/schemas/CheckList" } }, "deviceDetails": { "required": [ "host", "password", "username", "wan" ], "type": "object", "properties": { "device_uuid": { "type": "string", "description": "device uuid/chassis number", "example": "C8K-4facbd05-855b-45f0-af2f-c844af179bd6" }, "enable_password": { "type": "string", "description": "enable password", "example": "admin" }, "host": { "pattern": "((^\\s*((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))\\s*$)|(^\\s*((([0-9a-f]{1,4}:){7}([0-9a-f]{1,4}|:))|(([0-9a-f]{1,4}:){6}(:[0-9a-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9a-f]{1,4}:){5}(((:[0-9a-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9a-f]{1,4}:){4}(((:[0-9a-f]{1,4}){1,3})|((:[0-9a-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9a-f]{1,4}:){3}(((:[0-9a-f]{1,4}){1,4})|((:[0-9a-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9a-f]{1,4}:){2}(((:[0-9a-f]{1,4}){1,5})|((:[0-9a-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9a-f]{1,4}:){1}(((:[0-9a-f]{1,4}){1,6})|((:[0-9a-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9a-f]{1,4}){1,7})|((:[0-9a-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))(%.+)?\\s*$))", "type": "string", "description": "host ip", "example": "1.1.1.1" }, "local_file_name": { "type": "string", "description": "local file name", "example": "c8000v-universalk9.17.12.01.0.175851.SSA.bin" }, "password": { "type": "string", "description": "ssh password", "example": "admin" }, "remote_server_file_name": { "type": "string", "description": "remote server file name", "example": "c8000v-universalk9.17.12.01.0.175851.SSA.bin" }, "remote_server_id": { "type": "string", "description": "remote server Id", "example": "56a32849-aafb-4703-8887-ba64c0394835" }, "username": { "type": "string", "description": "ssh username", "example": "admin" }, "wan": { "maxLength": 32, "minLength": 3, "pattern": "(Cellular|Dialer|Ethernet|FastEthernet|FiftyGigabitEthernet|FiveGigabitEthernet|FortyGigabitEthernet|FourHundredGigE|GigabitEthernet|HundredGigE|Loopback|Multilink|Port-channel|Serial|TenGigabitEthernet|Tunnel|TwentyFiveGigE|TwentyFiveGigabitEthernet|TwoGigabitEthernet|TwoHundredGigE|Vlan|Wlan-GigabitEthernet)([0-9]*(. ?[1-9][0-9]*)*|[0-9/]+|[0-9]+/[0-9]+/[0-9]+:[0-9]+|[0-9]+/[0-9]+/[0-9]+|[0-9]+/[0-9]+|[0-9]+)", "type": "string", "description": "WAN interface name", "example": "GigabitEthernet1" } }, "description": "Device list to onboard", "$$ref": "#/components/schemas/DeviceDetails" }, "status": { "type": "string" } }, "description": "List of non-compliant validators at LTS minus three or lower versions", "$$ref": "#/components/schemas/DeviceComplianceData" } }, "tenantDetails": { "type": "array", "description": "Tenant compliance details", "items": { "type": "object", "properties": { "nearNonCompliantDeviceCount": { "type": "integer", "description": "Count of devices approaching non-compliance", "format": "int32" }, "nonCompliantDeviceCount": { "type": "integer", "description": "Count of non-compliant devices", "format": "int32" }, "nonCompliantDevices": { "type": "array", "description": "List of non-compliant devices", "items": { "type": "object", "properties": { "checkList": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" }, "status": { "type": "string" }, "type": { "type": "string" }, "upgradeCompatibilityStatus": { "type": "string" } }, "$$ref": "#/components/schemas/CheckList" } }, "deviceDetails": { "required": [ "host", "password", "username", "wan" ], "type": "object", "properties": { "device_uuid": { "type": "string", "description": "device uuid/chassis number", "example": "C8K-4facbd05-855b-45f0-af2f-c844af179bd6" }, "enable_password": { "type": "string", "description": "enable password", "example": "admin" }, "host": { "pattern": "((^\\s*((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))\\s*$)|(^\\s*((([0-9a-f]{1,4}:){7}([0-9a-f]{1,4}|:))|(([0-9a-f]{1,4}:){6}(:[0-9a-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9a-f]{1,4}:){5}(((:[0-9a-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9a-f]{1,4}:){4}(((:[0-9a-f]{1,4}){1,3})|((:[0-9a-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9a-f]{1,4}:){3}(((:[0-9a-f]{1,4}){1,4})|((:[0-9a-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9a-f]{1,4}:){2}(((:[0-9a-f]{1,4}){1,5})|((:[0-9a-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9a-f]{1,4}:){1}(((:[0-9a-f]{1,4}){1,6})|((:[0-9a-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9a-f]{1,4}){1,7})|((:[0-9a-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))(%.+)?\\s*$))", "type": "string", "description": "host ip", "example": "1.1.1.1" }, "local_file_name": { "type": "string", "description": "local file name", "example": "c8000v-universalk9.17.12.01.0.175851.SSA.bin" }, "password": { "type": "string", "description": "ssh password", "example": "admin" }, "remote_server_file_name": { "type": "string", "description": "remote server file name", "example": "c8000v-universalk9.17.12.01.0.175851.SSA.bin" }, "remote_server_id": { "type": "string", "description": "remote server Id", "example": "56a32849-aafb-4703-8887-ba64c0394835" }, "username": { "type": "string", "description": "ssh username", "example": "admin" }, "wan": { "maxLength": 32, "minLength": 3, "pattern": "(Cellular|Dialer|Ethernet|FastEthernet|FiftyGigabitEthernet|FiveGigabitEthernet|FortyGigabitEthernet|FourHundredGigE|GigabitEthernet|HundredGigE|Loopback|Multilink|Port-channel|Serial|TenGigabitEthernet|Tunnel|TwentyFiveGigE|TwentyFiveGigabitEthernet|TwoGigabitEthernet|TwoHundredGigE|Vlan|Wlan-GigabitEthernet)([0-9]*(. ?[1-9][0-9]*)*|[0-9/]+|[0-9]+/[0-9]+/[0-9]+:[0-9]+|[0-9]+/[0-9]+/[0-9]+|[0-9]+/[0-9]+|[0-9]+)", "type": "string", "description": "WAN interface name", "example": "GigabitEthernet1" } }, "description": "Device list to onboard", "$$ref": "#/components/schemas/DeviceDetails" }, "status": { "type": "string" } }, "description": "List of non-compliant validators at LTS minus three or lower versions", "$$ref": "#/components/schemas/DeviceComplianceData" } }, "tenantId": { "type": "string", "description": "Tenant ID" }, "tenantName": { "type": "string", "description": "Tenant name" } }, "description": "Tenant compliance details", "$$ref": "#/components/schemas/TenantCompliance" } }, "version": { "type": "string", "description": "Software version number" } }, "description": "Version compliance information across all tenants", "$$ref": "#/components/schemas/VersionComplianceInfoResponse" }, "examples": { "Version 20.18.999": { "summary": "Example response for version 20.18.999", "description": "Version 20.18.999", "value": { "version": "20.18.999", "minimumControllerCompatibleVersion": "20.18", "minimumValidatorCompatibleVersion": "20.18", "minimumDeviceCompatibleVersion": "17.12", "nonCompliantControllersCount": 0, "nonCompliantControllersCountLTSMinusOne": 0, "nonCompliantControllersCountLTSMinusTwo": 0, "nonCompliantControllersCountLTSMinusThree": 0, "nonCompliantValidatorsCount": 0, "nonCompliantValidatorsCountLTSMinusOne": 0, "nonCompliantValidatorsCountLTSMinusTwo": 0, "nonCompliantValidatorsCountLTSMinusThree": 0, "nonCompliantDeviceCount": 2, "nearNonCompliantDeviceCount": 0, "tenantDetails": [ { "tenantName": "Default", "tenantId": "default", "nonCompliantDevices": [ { "hostname": "vm11", "systemIp": "172.16.255.21", "siteId": "100", "siteName": "SITE_100", "uuid": "9dd1e23f-3c21-4c93-ade3-6fb7b7cbe0ea", "chassisNumber": "9dd1e23f-3c21-4c93-ade3-6fb7b7cbe0ea", "reachability": "reachable", "platform": "x86_64", "deviceType": "vedge", "personality": "vedge", "currentVersion": "20.9.6-957" }, { "hostname": "vm4", "systemIp": "172.16.255.14", "siteId": "400", "siteName": "SITE_400", "uuid": "add106e3-be72-4ddb-88d4-f07108b1ef12", "chassisNumber": "add106e3-be72-4ddb-88d4-f07108b1ef12", "reachability": "reachable", "platform": "x86_64", "deviceType": "vedge", "personality": "vedge", "currentVersion": "20.9.6-957" } ], "nonCompliantDeviceCount": 2, "nearNonCompliantDeviceCount": 0 } ] } }, "Version 20.25.999": { "summary": "Example response for version 20.25.999", "description": "Version 20.25.999", "value": { "version": "20.25.999", "minimumControllerCompatibleVersion": "20.25", "minimumValidatorCompatibleVersion": "20.25", "minimumDeviceCompatibleVersion": "17.21", "nonCompliantControllersCount": 1, "nonCompliantControllersCountLTSMinusOne": 0, "nonCompliantControllersCountLTSMinusTwo": 0, "nonCompliantControllersCountLTSMinusThree": 1, "nonCompliantValidatorsCount": 1, "nonCompliantValidatorsCountLTSMinusOne": 0, "nonCompliantValidatorsCountLTSMinusTwo": 0, "nonCompliantValidatorsCountLTSMinusThree": 1, "nonCompliantDeviceCount": 1, "nearNonCompliantDeviceCount": 0, "tenantDetails": [ { "tenantName": "Default", "tenantId": "default", "nonCompliantDevices": [ { "hostname": "vm11", "systemIp": "172.16.255.21", "siteId": "100", "siteName": "SITE_100", "uuid": "9dd1e23f-3c21-4c93-ade3-6fb7b7cbe0ea", "chassisNumber": "9dd1e23f-3c21-4c93-ade3-6fb7b7cbe0ea", "reachability": "reachable", "platform": "x86_64", "deviceType": "vedge", "personality": "vedge", "currentVersion": "20.9.6-957" } ], "nonCompliantDeviceCount": 1, "nearNonCompliantDeviceCount": 0 } ], "nonCompliantControllersLTSMinusThree": [ { "hostname": "vm10", "systemIp": "172.16.255.20", "siteId": "200", "siteName": "SITE_200", "uuid": "a5af47b2-b257-4831-93bd-ef7911cc47f4", "chassisNumber": "a5af47b2-b257-4831-93bd-ef7911cc47f4", "reachability": "reachable", "platform": "x86_64", "deviceType": "vsmart", "personality": "vsmart", "currentVersion": "20.18.999-4446" } ], "nonCompliantValidatorsLTSMinusThree": [ { "hostname": "vm16", "systemIp": "172.16.255.26", "siteId": "-", "siteName": "-", "uuid": "48a73b3b-1b97-42de-9128-5bab93ba614c", "chassisNumber": "48a73b3b-1b97-42de-9128-5bab93ba614c", "reachability": "reachable", "platform": "x86_64", "deviceType": "vbond", "personality": "vbond", "currentVersion": "20.18.999-4446" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/v1/licensing/assign-licenses": { "post": { "tags": [ "Licensing - Next Generation" ], "description": "Assign licenses to devices", "operationId": "assignMSLALicenses", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "baseLicenses": { "type": "array", "items": { "type": "object", "properties": { "assignLicenses": { "type": "array", "items": { "type": "object", "properties": { "allocated": { "type": "integer", "format": "int32", "example": 2 }, "billingType": { "type": "string", "example": "Prepaid" }, "displayName": { "type": "string", "example": "Advantage Large" }, "saName": { "type": "string", "example": "testaccount1.viptela.com" }, "subscriptionId": { "type": "string", "example": "sub00235" }, "tag": { "type": "string", "example": "regid.2020-10.com.cisco.DSTACK_T0_P" }, "vaName": { "type": "string", "example": "vManage_SDWAN_01" } }, "$$ref": "#/components/schemas/AssignLicensesRequestAssignLicenses" } }, "uuids": { "type": "array", "description": "List of device UUIDs", "items": { "type": "string", "description": "List of device UUIDs" } } }, "$$ref": "#/components/schemas/AssignLicensesRequestBaseLicenses" } }, "tenantLicenses": { "type": "array", "items": { "type": "object", "properties": { "allocated": { "type": "integer", "format": "int32", "example": 2 }, "billingType": { "type": "string", "example": "Prepaid" }, "displayName": { "type": "string", "example": "Advantage Large" }, "saName": { "type": "string", "example": "testaccount1.viptela.com" }, "subscriptionId": { "type": "string", "example": "sub00235" }, "tag": { "type": "string", "example": "regid.2020-10.com.cisco.DSTACK_T0_P" }, "vaName": { "type": "string", "example": "vManage_SDWAN_01" } }, "$$ref": "#/components/schemas/AssignLicensesRequestAssignLicenses" } } }, "$$ref": "#/components/schemas/AssignLicensesRequest" } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/v1/licensing/devices": { "get": { "tags": [ "Licensing - Next Generation" ], "description": "Retrieve list of all devices along with license details if assigned", "operationId": "getMSLADevices_LicensingNextGeneration_2103", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "devices": { "type": "array", "items": { "type": "object", "properties": { "complianceStatus": { "type": "string", "example": "Out Of Compliance" }, "configuredSystemIP": { "type": "string", "example": "172.16.254.3" }, "deviceModel": { "type": "string", "example": "vedge-C8530-12X4QC" }, "deviceTags": { "type": "array", "items": { "type": "string" } }, "hostName": { "type": "string", "example": "pm4" }, "hsecCompatible": { "type": "string", "example": "Yes" }, "hsecLicenseStatus": { "type": "string" }, "hsecStatus": { "type": "string", "example": "-" }, "inCompliantReason": { "type": "string", "example": "Unassigned" }, "licenses": { "type": "array", "items": { "type": "object", "properties": { "billingType": { "type": "string", "example": "prepaid" }, "displayName": { "type": "string", "example": "Essential Large" }, "endDate": { "type": "string", "example": "2025 Jun 03" }, "licenseCategory": { "type": "string", "example": "Base" }, "licenseType": { "type": "string", "example": "TERM" }, "no0fAssignedLicenses": { "type": "integer", "format": "int32", "example": 1 }, "saName": { "type": "string", "example": "testaccount1.viptela.com" }, "startDate": { "type": "string", "example": "2023 Jun 03" }, "subscriptionId": { "type": "string", "example": "sub00235" }, "tag": { "type": "string", "example": "regid.2020-10.com.cisco.DSTACK_T0_P" }, "vaName": { "type": "string", "example": "vManage_SDWAN_01" } }, "$$ref": "#/components/schemas/DevicesDetailsLicenses" } }, "noOfTenantsOnBoarded": { "type": "integer", "format": "int32", "example": 5 }, "uuid": { "type": "string", "example": "C8530-2f351fae-e60a-4a5d-b5b9-aeb1306289ff" } }, "$$ref": "#/components/schemas/DevicesDetailsDevices" } } }, "$$ref": "#/components/schemas/DevicesDetails" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/v1/licensing/edit-licenses/{uuid}": { "get": { "tags": [ "Licensing - Next Generation" ], "description": "Edit licenses associated to a device", "operationId": "getLicenseByUuid_LicensingNextGeneration_3403", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "appliedFilters": { "type": "object", "properties": { "billingType": { "type": "string", "example": "Prepaid" }, "licenseClassification": { "type": "string", "example": "Advantage" } }, "$$ref": "#/components/schemas/AppliedFilters" }, "baseLicenses": { "type": "object", "properties": { "licenses": { "type": "array", "items": { "type": "object", "properties": { "available": { "type": "integer", "format": "int32", "example": 20 }, "displayName": { "type": "string", "example": "Advantage Large" }, "inUse": { "type": "integer", "format": "int32", "example": 5 }, "isAssigned": { "type": "boolean", "example": true }, "tag": { "type": "string", "example": "regid.2020-10.com.cisco.DSTACK_T0_P" } }, "$$ref": "#/components/schemas/EditLicenseResponseLicenses" } }, "platformClass": { "type": "string", "example": "C8530" } }, "$$ref": "#/components/schemas/EditLicenseResponseBaseLicenses" }, "tenantLicenses": { "type": "object", "properties": { "licenses": { "type": "array", "items": { "type": "object", "properties": { "available": { "type": "integer", "format": "int32", "example": 20 }, "displayName": { "type": "string", "example": "Advantage Large" }, "inUse": { "type": "integer", "format": "int32", "example": 5 }, "isAssigned": { "type": "boolean", "example": true }, "tag": { "type": "string", "example": "regid.2020-10.com.cisco.DSTACK_T0_P" } }, "$$ref": "#/components/schemas/EditLicenseResponseLicenses" } }, "totalTenantLicRequired": { "type": "integer", "format": "int32", "example": 10 } }, "$$ref": "#/components/schemas/EditLicenseResponseTenantLicenses" } }, "$$ref": "#/components/schemas/EditLicenseResponse" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/v1/licensing/licenses": { "post": { "tags": [ "Licensing - Next Generation" ], "description": "Get applicable licenses based on platform class", "operationId": "getMSLALicenses", "requestBody": { "description": "List of device UUIDs and filters", "content": { "application/json": { "schema": { "type": "object", "properties": { "appliedFilters": { "type": "object", "properties": { "billingType": { "type": "string", "example": "Prepaid" }, "licenseClassification": { "type": "string", "example": "Advantage" } }, "$$ref": "#/components/schemas/AppliedFilters" }, "uuids": { "type": "array", "description": "List of device UUIDs", "items": { "type": "string", "description": "List of device UUIDs" } } }, "$$ref": "#/components/schemas/LicensesRequest" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "baseLicenses": { "type": "array", "items": { "type": "object", "properties": { "licenses": { "type": "array", "items": { "type": "object", "properties": { "available": { "type": "integer", "format": "int32", "example": 20 }, "displayName": { "type": "string", "example": "Advantage Large" }, "inUse": { "type": "integer", "format": "int32", "example": 5 }, "isPreferred": { "type": "boolean", "example": true }, "tag": { "type": "string", "example": "regid.2020-10.com.cisco.DSTACK_T0_P" } }, "$$ref": "#/components/schemas/LicensesResponseLicenses" } }, "platformClass": { "type": "string", "example": "C8530-12X4QC" }, "uuids": { "type": "array", "description": "List of device UUIDs", "items": { "type": "string", "description": "List of device UUIDs" } } }, "$$ref": "#/components/schemas/LicensesResponseBaseLicenses" } }, "tenantLicenses": { "type": "object", "properties": { "licenses": { "type": "array", "items": { "type": "object", "properties": { "available": { "type": "integer", "format": "int32", "example": 20 }, "displayName": { "type": "string", "example": "Advantage Large" }, "inUse": { "type": "integer", "format": "int32", "example": 5 }, "isPreferred": { "type": "boolean", "example": true }, "tag": { "type": "string", "example": "regid.2020-10.com.cisco.DSTACK_T0_P" } }, "$$ref": "#/components/schemas/LicensesResponseLicenses" } }, "totalTenantLicRequired": { "type": "integer", "format": "int32", "example": 10 } }, "$$ref": "#/components/schemas/LicensesResponseTenantLicenses" } }, "$$ref": "#/components/schemas/LicensesResponse" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/v1/licensing/release-licenses": { "put": { "tags": [ "Licensing - Next Generation" ], "description": "Release licenses assigned to the devices", "operationId": "releaseLicenses_LicensingNextGeneration_3003", "requestBody": { "description": "List of devices for releasing licenses", "content": { "application/json": { "schema": { "type": "object", "properties": { "uuids": { "type": "array", "description": "List of device UUIDs", "items": { "type": "string", "description": "List of device UUIDs" } } }, "$$ref": "#/components/schemas/ReleaseLicenses" } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/v1/licensing/sa-va-distribution": { "post": { "tags": [ "Licensing - Next Generation" ], "description": "Get Smart account and virtual account distribution of selected licenses", "operationId": "getSAVADistribution", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "appliedFilters": { "type": "object", "properties": { "billingType": { "type": "string", "example": "Prepaid" }, "licenseClassification": { "type": "string", "example": "Advantage" } }, "$$ref": "#/components/schemas/AppliedFilters" }, "baseLicenses": { "type": "array", "items": { "type": "object", "properties": { "displayName": { "type": "string", "example": "Advantage Large" }, "platformClass": { "type": "string", "example": "C8530-12X4QC" }, "tag": { "type": "string", "example": "regid.2020-10.com.cisco.DSTACK_T0_P" }, "uuids": { "type": "array", "description": "List of device UUIDs", "items": { "type": "string", "description": "List of device UUIDs" } } }, "$$ref": "#/components/schemas/SaVaDistributionRequestBaseLicenses" } }, "tenantLicenses": { "type": "object", "properties": { "displayName": { "type": "string", "example": "Advantage Large" }, "tag": { "type": "string", "example": "regid.2020-10.com.cisco.DSTACK_T0_P" }, "totalTenantLicRequired": { "type": "integer", "format": "int32", "example": 10 } }, "$$ref": "#/components/schemas/SaVaDistributionRequestTenantLicense" } }, "$$ref": "#/components/schemas/SaVaDistributionRequest" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "baseLicenses": { "type": "array", "items": { "type": "object", "properties": { "displayName": { "type": "string", "example": "Advantage Large" }, "platformClass": { "type": "string", "example": "C8530-12X4QC" }, "savaMap": { "type": "array", "items": { "type": "object", "properties": { "allocated": { "type": "integer", "format": "int32", "example": 5 }, "available": { "type": "integer", "format": "int32", "example": 20 }, "inUse": { "type": "integer", "format": "int32", "example": 5 }, "saName": { "type": "string", "example": "testaccount1.viptela.com" }, "subscriptionId": { "type": "string", "example": "sub00235" }, "vaName": { "type": "string", "example": "vManage_SDWAN_01" } }, "$$ref": "#/components/schemas/SaVaDistributionResponseSaVaMap" } }, "tag": { "type": "string", "example": "regid.2020-10.com.cisco.DSTACK_T0_P" }, "uuids": { "type": "array", "description": "List of device UUIDs", "items": { "type": "string", "description": "List of device UUIDs" } } }, "$$ref": "#/components/schemas/SaVaDistributionResponseBaseLicenses" } }, "tenantLicenses": { "type": "object", "properties": { "displayName": { "type": "string", "example": "Advantage Large" }, "savaMap": { "type": "array", "items": { "type": "object", "properties": { "allocated": { "type": "integer", "format": "int32", "example": 5 }, "available": { "type": "integer", "format": "int32", "example": 20 }, "inUse": { "type": "integer", "format": "int32", "example": 5 }, "saName": { "type": "string", "example": "testaccount1.viptela.com" }, "subscriptionId": { "type": "string", "example": "sub00235" }, "vaName": { "type": "string", "example": "vManage_SDWAN_01" } }, "$$ref": "#/components/schemas/SaVaDistributionResponseSaVaMap" } }, "tag": { "type": "string", "example": "regid.2020-10.com.cisco.DSTACK_T0_P" } }, "$$ref": "#/components/schemas/SaVaDistributionResponseTenantLicenses" } }, "$$ref": "#/components/schemas/SaVaDistributionResponse" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/v1/network-hierarchy/{hierarchyId}/network-settings/cybervisioncenters": { "get": { "tags": [ "Network Settings" ], "description": "Get Cybervision Centers for Network Hierarchy Node", "operationId": "getCybervisionCentersForNetworkHierarchyNode", "parameters": [ { "name": "hierarchyId", "in": "path", "description": "Network Hierarchy Id", "required": true, "schema": { "pattern": "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}", "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "CVC Network Hierarchy GET Response Example": { "description": "CVC Network Hierarchy GET Response Example", "value": { "data": [ { "solution": "sdwan", "id": "362ae435-5c10-4af5-afcf-cf0614e74f0e", "type": "cvcenters", "createdBy": "admin", "createdOn": 1714074157235, "lastUpdatedBy": "admin", "lastUpdatedOn": 1714149352945, "payload": { "data": { "cvCenterInstances": [ { "cvId": { "value": "756e6c4b-8522-4aeb-9d28-85e44e180ba5" }, "cvName": { "value": "New CV" }, "cvAddress": { "value": "127.0.0.1" }, "cvVPNInterface": { "value": 1 }, "cvKey": { "value": "eyJQU0siOiJ3al9lX0RuRk10b0M5MVNuaFdlbWFzVmV2ZVFUdDNCRSIsIlZlcnNpb24iOiI1LjAuMC0yMDI0MDQxMDA4MzciLCJGaWxlbmFtZSI6ImN2aW94LWFhcmNoNjQudGFyIn0=" }, "deletable": { "value": true }, "remoteServerId": { "value": "8125ca2d-95ce-4c3a-96b8-975892ef5f02" } } ] } } } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Network Settings > CVC-read" }, "post": { "tags": [ "Network Settings" ], "description": "Create Cybervision Center for Network Hierarchy Node", "operationId": "createCybervisionCenterForNetworkHierarchyNode", "parameters": [ { "name": "hierarchyId", "in": "path", "description": "Network Hierarchy ID", "required": true, "schema": { "pattern": "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}", "type": "string" } } ], "requestBody": { "description": "Create cybervision center for network hierarchy node", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "CVC Network Hierarchy POST Request Example": { "description": "CVC Network Hierarchy POST Request Example", "value": { "data": { "cvCenterInstances": [ { "cvName": { "value": "New CV" }, "cvAddress": { "value": "127.0.0.1" }, "cvKey": { "value": "XXX" }, "cvVPNInterface": { "value": 1 } }, { "cvId": { "value": "XXX" }, "cvName": { "value": "Edited CV" }, "cvAddress": { "value": "127.0.0.1" }, "cvKey": { "value": "XXX" }, "cvVPNInterface": { "value": 1 } } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "CVC Network Hierarchy POST Response Example": { "description": "CVC Network Hierarchy POST Response Example", "value": { "id": "64C3EF06-b09a-DeFa-Ab26-a1cc4Ef0D51b" } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Network Settings > CVC-write" } }, "/v1/network-hierarchy/{hierarchyId}/network-settings/cybervisioncenters/id": { "get": { "tags": [ "Network Settings" ], "description": "Get Network Hierarchy Cybervision Center ID By Name", "operationId": "GetCybervisionCenterIDByName", "parameters": [ { "name": "hierarchyId", "in": "path", "description": "Network Hierarchy Id", "required": true, "schema": { "type": "string" } }, { "name": "cvName", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "CVC Network Hierarchy GET CVC Id by Name Response Example": { "description": "CVC Network Hierarchy GET CVC Id by Name Response Example", "value": { "id": "64C3EF06-b09a-DeFa-Ab26-a1cc4Ef0D51b" } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Network Settings > CVC-read" } }, "/v1/network-hierarchy/{hierarchyId}/network-settings/cybervisioncenters/{cvId}": { "delete": { "tags": [ "Network Settings" ], "description": "Delete Cybervision Center for Network Hierarchy Node", "operationId": "deleteCybervisionCenterForNetworkHierarchyNode", "parameters": [ { "name": "hierarchyId", "in": "path", "description": "Network Hierarchy Id", "required": true, "schema": { "pattern": "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}", "type": "string" } }, { "name": "cvId", "in": "path", "description": "Cybervision Center ID", "required": true, "schema": { "pattern": "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}", "type": "string" } } ], "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Network Settings > CVC-write" } }, "/v1/reports": { "get": { "tags": [ "Scheduled Report Management" ], "summary": "Get all report templates information", "description": "Get all reports information", "operationId": "getAllReportTemplates", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "required": [ "reports" ], "type": "object", "properties": { "header": { "type": "object", "additionalProperties": { "type": "object" } }, "reports": { "type": "array", "description": "Report List", "items": { "required": [ "businessHours", "fileType", "hasTask", "nextRunTime", "onVmanage", "reportId", "reportName", "reportStatus", "schedule", "taskNum", "templateType", "timeFrame" ], "type": "object", "properties": { "businessHours": { "type": "string" }, "emailRecipient": { "type": "array", "description": "Email address list to receive the report files", "example": [ "alice@cisco.com", "bob@google.com" ], "items": { "type": "string", "description": "Email address list to receive the report files", "example": [ "alice@cisco.com", "bob@google.com" ] } }, "fileType": { "type": "string" }, "hasTask": { "type": "boolean", "description": "If the report template has running task records or not", "example": true }, "nextRunTime": { "type": "integer", "description": "Report next running timestamp", "format": "int64", "example": 1655991420000 }, "onVmanage": { "type": "string", "description": "vManage which scheduled report generating tasks", "example": "10.1.1.100" }, "reportId": { "type": "string", "description": "The report UUID for report template", "format": "uuid", "example": "50671437-c88e-4514-aafa-103e58c4d9cc" }, "reportName": { "type": "string", "description": "The report template name", "example": "Daily-report" }, "reportStatus": { "type": "string", "description": "Report schedule status(not_scheduled/scheduled/in_progress/completed/failed))", "example": "in_progress", "enum": [ "not_scheduled", "scheduled", "in_progress", "completed", "failed" ] }, "schedule": { "type": "string", "description": "Report schedule information", "example": "Daily" }, "taskNum": { "type": "integer", "description": "The number of scheduled tasks for report template", "format": "int64", "example": 10 }, "templateType": { "type": "string" }, "timeFrame": { "type": "string", "description": "Report time frame(7 Days/30 Days)", "example": "7 Days" } }, "description": "Report summary information", "$$ref": "#/components/schemas/ReportSummaryInfo" } } }, "description": "Query all reports summary information response", "$$ref": "#/components/schemas/ReportSummaryResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "required": [ "code", "details", "message" ], "type": "object", "properties": { "code": { "type": "string", "description": "Error code associated with the error event" }, "details": { "type": "string", "description": "Error message details" }, "message": { "type": "string", "description": "Error message title" } }, "description": "error message", "$$ref": "#/components/schemas/Model400ErrorError" } }, "$$ref": "#/components/schemas/Model400Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "required": [ "code", "details", "message" ], "type": "object", "properties": { "code": { "type": "string", "description": "Error code associated with the error event" }, "details": { "type": "string", "description": "Error message details" }, "message": { "type": "string", "description": "Error message title" } }, "description": "error message", "$$ref": "#/components/schemas/Model400ErrorError" } }, "$$ref": "#/components/schemas/Model400Error" } } } }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Scheduled Report Management" ], "summary": "Create a new report template", "description": "create a new report template", "operationId": "createReportTemplate", "requestBody": { "description": "Report Template Config", "content": { "application/json": { "schema": { "required": [ "emailRecipient", "reportName", "scheduleConfig" ], "type": "object", "properties": { "analyticsReport": { "type": "boolean" }, "analyticsScope": { "type": "string" }, "analyticsTemplateName": { "type": "string" }, "analyticsTemplateType": { "type": "string" }, "businessHours": { "required": [ "endTime", "startTime" ], "type": "object", "properties": { "endTime": { "pattern": "^(20|21|22|23|[0-1]?\\d):[0-5]?\\d:[0-5]?\\d$", "type": "string" }, "startTime": { "pattern": "^(20|21|22|23|[0-1]?\\d):[0-5]?\\d:[0-5]?\\d$", "type": "string" } }, "description": "Report business hours for data generating", "$$ref": "#/components/schemas/ReportBusinessHours" }, "emailRecipient": { "maxItems": 5, "minItems": 0, "type": "array", "description": "Email address list to receive the report files", "example": [ "alice@cisco.com", "bob@google.com" ], "items": { "type": "string", "description": "Email address list to receive the report files", "example": [ "alice@cisco.com", "bob@google.com" ] } }, "fileType": { "type": "string", "enum": [ "pdf", "csv" ] }, "reportName": { "maxLength": 32, "minLength": 1, "pattern": "(?=^.{1,32}$)[^&<>! \"]+$", "type": "string", "description": "Report Name", "example": "ExecutiveSummaryReport" }, "scheduleConfig": { "required": [ "scheduleType" ], "type": "object", "properties": { "scheduleType": { "type": "string", "description": "Schedule type", "example": "on_demand", "enum": [ "on_demand", "reoccur_onetime", "reoccur_daily", "reoccur_weekly", "reoccur_monthly" ] } }, "description": "schedule config", "discriminator": { "propertyName": "scheduleType" }, "oneOf": [ { "$ref": "#/components/schemas/ScheduleConfig", "required": [ "scheduleType" ], "type": "object", "description": "On-demand schedule", "$$ref": "#/components/schemas/OnDemandSchedule" }, { "$ref": "#/components/schemas/ScheduleConfig", "properties": { "startTime": { "pattern": "^\\d{4}\\-(0[1-9]|1[012])\\-(0[1-9]|[12][0-9]|3[01]) (20|21|22|23|[0-1]?\\d):[0-5]?\\d:[0-5]?\\d$", "type": "string", "description": "startTime string format is yyyy-MM-dd HH:mm:ss,UTC timezone", "example": "2022-07-01 14:30:00" } }, "required": [ "scheduleType", "startTime" ], "type": "object", "description": "One time schedule time config", "$$ref": "#/components/schemas/OneTimeSchedule" }, { "$ref": "#/components/schemas/ScheduleConfig", "properties": { "startTime": { "pattern": "^(20|21|22|23|[0-1]?\\d):[0-5]?\\d:[0-5]?\\d$", "type": "string", "description": "startTime string format is HH:mm:ss" } }, "required": [ "scheduleType", "startTime" ], "type": "object", "description": "Daily schedule time config", "$$ref": "#/components/schemas/ReoccurDailySchedule" }, { "$ref": "#/components/schemas/ScheduleConfig", "properties": { "startTime": { "pattern": "^(20|21|22|23|[0-1]?\\d):[0-5]?\\d:[0-5]?\\d$", "type": "string", "description": "startTime string format is HH:mm:ss", "example": "20:30:10" }, "dayOfWeek": { "maximum": 7, "minimum": 1, "type": "integer", "description": "The day number of a week, mapping is as 1 - Sun, 2 - Mon, 3 - Tus, 4 - Wed, 5 - Thu, 6 - Fri, 7 - Sat", "format": "int32", "example": 1 } }, "required": [ "dayOfWeek", "scheduleType", "startTime" ], "type": "object", "description": "Weekly schedule time config", "$$ref": "#/components/schemas/ReoccurWeeklySchedule" }, { "$ref": "#/components/schemas/ScheduleConfig", "properties": { "startTime": { "pattern": "^\\d{4}\\-(0[1-9]|1[012])\\-(0[1-9]|[12][0-9]|3[01]) (20|21|22|23|[0-1]?\\d):[0-5]?\\d:[0-5]?\\d$", "type": "string", "description": "startTime string format is (yyyy-MM-dd HH:mm:ss), time zone is UTC", "example": "2022-07-01 20:30:10" } }, "required": [ "scheduleType", "startTime" ], "type": "object", "description": "Monthly schedule time config", "$$ref": "#/components/schemas/ReoccurMonthlySchedule" } ], "$$ref": "#/components/schemas/ScheduleConfig" }, "siteIds": { "type": "array", "description": "Filtering by Site ID list is optional, if no site Id is included, all site ID will be used for report generating.", "example": [ 100, 200 ], "items": { "type": "integer", "format": "int64" } }, "templateType": { "type": "string", "enum": [ "executive_summary", "site_availability", "link_availability", "link_utilization", "link_sla", "app_usage", "ips_events_collected", "firewall_enforcement", "malware_files_collected", "internet_browsing", "license_management", "cpu_memory_energy", "energy_management" ] }, "timeRange": { "type": "string", "description": "Time range for report(one_week/one_month)", "example": "one_week", "enum": [ "one_day", "one_week", "one_month" ] } }, "description": "Executive summary report template", "$$ref": "#/components/schemas/ExecutiveSummaryReport" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "required": [ "activeStatus", "createdBy", "hasTask", "lastUpdateTime", "nextRunTime", "onVmanage", "reportConfig", "reportId", "reportStatus" ], "type": "object", "properties": { "activeStatus": { "type": "string", "description": "Report active status(active,cancelled)", "example": "active", "enum": [ "active", "cancelled" ] }, "createdBy": { "maxLength": 64, "minLength": 0, "type": "string", "description": "user name for who created the report template.", "example": "admin" }, "debugInfo": { "type": "string" }, "fileType": { "type": "string", "enum": [ "pdf", "csv" ] }, "hasTask": { "type": "boolean", "description": "If the report template has running task records or not", "example": true }, "lastUpdateTime": { "type": "integer", "description": "Report template last update timestamp", "format": "int64", "example": 1655968207288 }, "needRunImmediately": { "type": "boolean" }, "nextRunTime": { "type": "integer", "description": "Report next running timestamp", "format": "int64", "example": 1655991420000 }, "onVmanage": { "type": "string", "description": "vManage which scheduled report generating tasks", "example": "10.1.1.100" }, "reportConfig": { "required": [ "emailRecipient", "reportName", "scheduleConfig" ], "type": "object", "properties": { "analyticsReport": { "type": "boolean" }, "analyticsScope": { "type": "string" }, "analyticsTemplateName": { "type": "string" }, "analyticsTemplateType": { "type": "string" }, "businessHours": { "required": [ "endTime", "startTime" ], "type": "object", "properties": { "endTime": { "pattern": "^(20|21|22|23|[0-1]?\\d):[0-5]?\\d:[0-5]?\\d$", "type": "string" }, "startTime": { "pattern": "^(20|21|22|23|[0-1]?\\d):[0-5]?\\d:[0-5]?\\d$", "type": "string" } }, "description": "Report business hours for data generating", "$$ref": "#/components/schemas/ReportBusinessHours" }, "emailRecipient": { "maxItems": 5, "minItems": 0, "type": "array", "description": "Email address list to receive the report files", "example": [ "alice@cisco.com", "bob@google.com" ], "items": { "type": "string", "description": "Email address list to receive the report files", "example": [ "alice@cisco.com", "bob@google.com" ] } }, "fileType": { "type": "string", "enum": [ "pdf", "csv" ] }, "reportName": { "maxLength": 32, "minLength": 1, "pattern": "(?=^.{1,32}$)[^&<>! \"]+$", "type": "string", "description": "Report Name", "example": "ExecutiveSummaryReport" }, "scheduleConfig": { "required": [ "scheduleType" ], "type": "object", "properties": { "scheduleType": { "type": "string", "description": "Schedule type", "example": "on_demand", "enum": [ "on_demand", "reoccur_onetime", "reoccur_daily", "reoccur_weekly", "reoccur_monthly" ] } }, "description": "schedule config", "discriminator": { "propertyName": "scheduleType" }, "oneOf": [ { "$ref": "#/components/schemas/OnDemandSchedule" }, { "$ref": "#/components/schemas/OneTimeSchedule" }, { "$ref": "#/components/schemas/ReoccurDailySchedule" }, { "$ref": "#/components/schemas/ReoccurWeeklySchedule" }, { "$ref": "#/components/schemas/ReoccurMonthlySchedule" } ], "$$ref": "#/components/schemas/ScheduleConfig" }, "siteIds": { "type": "array", "description": "Filtering by Site ID list is optional, if no site Id is included, all site ID will be used for report generating.", "example": [ 100, 200 ], "items": { "type": "integer", "format": "int64" } }, "templateType": { "type": "string", "enum": [ "executive_summary", "site_availability", "link_availability", "link_utilization", "link_sla", "app_usage", "ips_events_collected", "firewall_enforcement", "malware_files_collected", "internet_browsing", "license_management", "cpu_memory_energy", "energy_management" ] }, "timeRange": { "type": "string", "description": "Time range for report(one_week/one_month)", "example": "one_week", "enum": [ "one_day", "one_week", "one_month" ] } }, "description": "Executive summary report template", "$$ref": "#/components/schemas/ExecutiveSummaryReport" }, "reportId": { "type": "string", "description": "The report UUID for report template", "format": "uuid", "example": "50671437-c88e-4514-aafa-103e58c4d9cc" }, "reportStatus": { "type": "string", "description": "Report schedule status(not_scheduled/scheduled/in_progress/completed/failed))", "example": "in_progress", "enum": [ "not_scheduled", "scheduled", "in_progress", "completed", "failed" ] }, "taskNum": { "type": "integer", "format": "int64" }, "templateType": { "type": "string", "enum": [ "executive_summary", "site_availability", "link_availability", "link_utilization", "link_sla", "app_usage", "ips_events_collected", "firewall_enforcement", "malware_files_collected", "internet_browsing", "license_management", "cpu_memory_energy", "energy_management" ] } }, "description": "Report Template detail info", "$$ref": "#/components/schemas/ReportInfo" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "required": [ "code", "details", "message" ], "type": "object", "properties": { "code": { "type": "string", "description": "Error code associated with the error event" }, "details": { "type": "string", "description": "Error message details" }, "message": { "type": "string", "description": "Error message title" } }, "description": "error message", "$$ref": "#/components/schemas/Model400ErrorError" } }, "$$ref": "#/components/schemas/Model400Error" } } } }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/v1/reports/preview/download": { "get": { "tags": [ "Scheduled Report Management" ], "summary": "Download a report preview file", "description": "Download a report preview file", "operationId": "downloadReportPreviewFile", "parameters": [ { "name": "templateType", "in": "query", "schema": { "type": "string", "enum": [ "executive_summary", "site_availability", "link_availability", "link_utilization", "link_sla", "app_usage", "ips_events_collected", "firewall_enforcement", "malware_files_collected", "internet_browsing", "license_management", "cpu_memory_energy", "energy_management" ] } } ], "responses": { "200": { "description": "Success", "content": { "application/pdf": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/v1/reports/{reportId}": { "get": { "tags": [ "Scheduled Report Management" ], "summary": "Get report template by ID.", "description": "Get the report template information by report ID", "operationId": "getReportTemplateById", "parameters": [ { "name": "reportId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "required": [ "reports" ], "type": "object", "properties": { "header": { "type": "object", "additionalProperties": { "type": "object" } }, "reports": { "type": "array", "description": "Report List", "items": { "required": [ "businessHours", "fileType", "hasTask", "nextRunTime", "onVmanage", "reportId", "reportName", "reportStatus", "schedule", "taskNum", "templateType", "timeFrame" ], "type": "object", "properties": { "businessHours": { "type": "string" }, "emailRecipient": { "type": "array", "description": "Email address list to receive the report files", "example": [ "alice@cisco.com", "bob@google.com" ], "items": { "type": "string", "description": "Email address list to receive the report files", "example": [ "alice@cisco.com", "bob@google.com" ] } }, "fileType": { "type": "string" }, "hasTask": { "type": "boolean", "description": "If the report template has running task records or not", "example": true }, "nextRunTime": { "type": "integer", "description": "Report next running timestamp", "format": "int64", "example": 1655991420000 }, "onVmanage": { "type": "string", "description": "vManage which scheduled report generating tasks", "example": "10.1.1.100" }, "reportId": { "type": "string", "description": "The report UUID for report template", "format": "uuid", "example": "50671437-c88e-4514-aafa-103e58c4d9cc" }, "reportName": { "type": "string", "description": "The report template name", "example": "Daily-report" }, "reportStatus": { "type": "string", "description": "Report schedule status(not_scheduled/scheduled/in_progress/completed/failed))", "example": "in_progress", "enum": [ "not_scheduled", "scheduled", "in_progress", "completed", "failed" ] }, "schedule": { "type": "string", "description": "Report schedule information", "example": "Daily" }, "taskNum": { "type": "integer", "description": "The number of scheduled tasks for report template", "format": "int64", "example": 10 }, "templateType": { "type": "string" }, "timeFrame": { "type": "string", "description": "Report time frame(7 Days/30 Days)", "example": "7 Days" } }, "description": "Report summary information", "$$ref": "#/components/schemas/ReportSummaryInfo" } } }, "description": "Query all reports summary information response", "$$ref": "#/components/schemas/ReportSummaryResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "required": [ "code", "details", "message" ], "type": "object", "properties": { "code": { "type": "string", "description": "Error code associated with the error event" }, "details": { "type": "string", "description": "Error message details" }, "message": { "type": "string", "description": "Error message title" } }, "description": "error message", "$$ref": "#/components/schemas/Model400ErrorError" } }, "$$ref": "#/components/schemas/Model400Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "required": [ "code", "details", "message" ], "type": "object", "properties": { "code": { "type": "string", "description": "Error code associated with the error event" }, "details": { "type": "string", "description": "Error message details" }, "message": { "type": "string", "description": "Error message title" } }, "description": "error message", "$$ref": "#/components/schemas/Model400ErrorError" } }, "$$ref": "#/components/schemas/Model400Error" } } } }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "Scheduled Report Management" ], "summary": "Modify the report template configuration", "description": "Update the report template by report ID", "operationId": "updateReportTemplate", "parameters": [ { "name": "reportId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "updated report config", "content": { "application/json": { "schema": { "required": [ "emailRecipient", "reportName", "scheduleConfig" ], "type": "object", "properties": { "analyticsReport": { "type": "boolean" }, "analyticsScope": { "type": "string" }, "analyticsTemplateName": { "type": "string" }, "analyticsTemplateType": { "type": "string" }, "businessHours": { "required": [ "endTime", "startTime" ], "type": "object", "properties": { "endTime": { "pattern": "^(20|21|22|23|[0-1]?\\d):[0-5]?\\d:[0-5]?\\d$", "type": "string" }, "startTime": { "pattern": "^(20|21|22|23|[0-1]?\\d):[0-5]?\\d:[0-5]?\\d$", "type": "string" } }, "description": "Report business hours for data generating", "$$ref": "#/components/schemas/ReportBusinessHours" }, "emailRecipient": { "maxItems": 5, "minItems": 0, "type": "array", "description": "Email address list to receive the report files", "example": [ "alice@cisco.com", "bob@google.com" ], "items": { "type": "string", "description": "Email address list to receive the report files", "example": [ "alice@cisco.com", "bob@google.com" ] } }, "fileType": { "type": "string", "enum": [ "pdf", "csv" ] }, "reportName": { "maxLength": 32, "minLength": 1, "pattern": "(?=^.{1,32}$)[^&<>! \"]+$", "type": "string", "description": "Report Name", "example": "ExecutiveSummaryReport" }, "scheduleConfig": { "required": [ "scheduleType" ], "type": "object", "properties": { "scheduleType": { "type": "string", "description": "Schedule type", "example": "on_demand", "enum": [ "on_demand", "reoccur_onetime", "reoccur_daily", "reoccur_weekly", "reoccur_monthly" ] } }, "description": "schedule config", "discriminator": { "propertyName": "scheduleType" }, "oneOf": [ { "$ref": "#/components/schemas/ScheduleConfig", "required": [ "scheduleType" ], "type": "object", "description": "On-demand schedule", "$$ref": "#/components/schemas/OnDemandSchedule" }, { "$ref": "#/components/schemas/ScheduleConfig", "properties": { "startTime": { "pattern": "^\\d{4}\\-(0[1-9]|1[012])\\-(0[1-9]|[12][0-9]|3[01]) (20|21|22|23|[0-1]?\\d):[0-5]?\\d:[0-5]?\\d$", "type": "string", "description": "startTime string format is yyyy-MM-dd HH:mm:ss,UTC timezone", "example": "2022-07-01 14:30:00" } }, "required": [ "scheduleType", "startTime" ], "type": "object", "description": "One time schedule time config", "$$ref": "#/components/schemas/OneTimeSchedule" }, { "$ref": "#/components/schemas/ScheduleConfig", "properties": { "startTime": { "pattern": "^(20|21|22|23|[0-1]?\\d):[0-5]?\\d:[0-5]?\\d$", "type": "string", "description": "startTime string format is HH:mm:ss" } }, "required": [ "scheduleType", "startTime" ], "type": "object", "description": "Daily schedule time config", "$$ref": "#/components/schemas/ReoccurDailySchedule" }, { "$ref": "#/components/schemas/ScheduleConfig", "properties": { "startTime": { "pattern": "^(20|21|22|23|[0-1]?\\d):[0-5]?\\d:[0-5]?\\d$", "type": "string", "description": "startTime string format is HH:mm:ss", "example": "20:30:10" }, "dayOfWeek": { "maximum": 7, "minimum": 1, "type": "integer", "description": "The day number of a week, mapping is as 1 - Sun, 2 - Mon, 3 - Tus, 4 - Wed, 5 - Thu, 6 - Fri, 7 - Sat", "format": "int32", "example": 1 } }, "required": [ "dayOfWeek", "scheduleType", "startTime" ], "type": "object", "description": "Weekly schedule time config", "$$ref": "#/components/schemas/ReoccurWeeklySchedule" }, { "$ref": "#/components/schemas/ScheduleConfig", "properties": { "startTime": { "pattern": "^\\d{4}\\-(0[1-9]|1[012])\\-(0[1-9]|[12][0-9]|3[01]) (20|21|22|23|[0-1]?\\d):[0-5]?\\d:[0-5]?\\d$", "type": "string", "description": "startTime string format is (yyyy-MM-dd HH:mm:ss), time zone is UTC", "example": "2022-07-01 20:30:10" } }, "required": [ "scheduleType", "startTime" ], "type": "object", "description": "Monthly schedule time config", "$$ref": "#/components/schemas/ReoccurMonthlySchedule" } ], "$$ref": "#/components/schemas/ScheduleConfig" }, "siteIds": { "type": "array", "description": "Filtering by Site ID list is optional, if no site Id is included, all site ID will be used for report generating.", "example": [ 100, 200 ], "items": { "type": "integer", "format": "int64" } }, "templateType": { "type": "string", "enum": [ "executive_summary", "site_availability", "link_availability", "link_utilization", "link_sla", "app_usage", "ips_events_collected", "firewall_enforcement", "malware_files_collected", "internet_browsing", "license_management", "cpu_memory_energy", "energy_management" ] }, "timeRange": { "type": "string", "description": "Time range for report(one_week/one_month)", "example": "one_week", "enum": [ "one_day", "one_week", "one_month" ] } }, "description": "Executive summary report template", "$$ref": "#/components/schemas/ExecutiveSummaryReport" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "required": [ "activeStatus", "createdBy", "hasTask", "lastUpdateTime", "nextRunTime", "onVmanage", "reportConfig", "reportId", "reportStatus" ], "type": "object", "properties": { "activeStatus": { "type": "string", "description": "Report active status(active,cancelled)", "example": "active", "enum": [ "active", "cancelled" ] }, "createdBy": { "maxLength": 64, "minLength": 0, "type": "string", "description": "user name for who created the report template.", "example": "admin" }, "debugInfo": { "type": "string" }, "fileType": { "type": "string", "enum": [ "pdf", "csv" ] }, "hasTask": { "type": "boolean", "description": "If the report template has running task records or not", "example": true }, "lastUpdateTime": { "type": "integer", "description": "Report template last update timestamp", "format": "int64", "example": 1655968207288 }, "needRunImmediately": { "type": "boolean" }, "nextRunTime": { "type": "integer", "description": "Report next running timestamp", "format": "int64", "example": 1655991420000 }, "onVmanage": { "type": "string", "description": "vManage which scheduled report generating tasks", "example": "10.1.1.100" }, "reportConfig": { "required": [ "emailRecipient", "reportName", "scheduleConfig" ], "type": "object", "properties": { "analyticsReport": { "type": "boolean" }, "analyticsScope": { "type": "string" }, "analyticsTemplateName": { "type": "string" }, "analyticsTemplateType": { "type": "string" }, "businessHours": { "required": [ "endTime", "startTime" ], "type": "object", "properties": { "endTime": { "pattern": "^(20|21|22|23|[0-1]?\\d):[0-5]?\\d:[0-5]?\\d$", "type": "string" }, "startTime": { "pattern": "^(20|21|22|23|[0-1]?\\d):[0-5]?\\d:[0-5]?\\d$", "type": "string" } }, "description": "Report business hours for data generating", "$$ref": "#/components/schemas/ReportBusinessHours" }, "emailRecipient": { "maxItems": 5, "minItems": 0, "type": "array", "description": "Email address list to receive the report files", "example": [ "alice@cisco.com", "bob@google.com" ], "items": { "type": "string", "description": "Email address list to receive the report files", "example": [ "alice@cisco.com", "bob@google.com" ] } }, "fileType": { "type": "string", "enum": [ "pdf", "csv" ] }, "reportName": { "maxLength": 32, "minLength": 1, "pattern": "(?=^.{1,32}$)[^&<>! \"]+$", "type": "string", "description": "Report Name", "example": "ExecutiveSummaryReport" }, "scheduleConfig": { "required": [ "scheduleType" ], "type": "object", "properties": { "scheduleType": { "type": "string", "description": "Schedule type", "example": "on_demand", "enum": [ "on_demand", "reoccur_onetime", "reoccur_daily", "reoccur_weekly", "reoccur_monthly" ] } }, "description": "schedule config", "discriminator": { "propertyName": "scheduleType" }, "oneOf": [ { "$ref": "#/components/schemas/OnDemandSchedule" }, { "$ref": "#/components/schemas/OneTimeSchedule" }, { "$ref": "#/components/schemas/ReoccurDailySchedule" }, { "$ref": "#/components/schemas/ReoccurWeeklySchedule" }, { "$ref": "#/components/schemas/ReoccurMonthlySchedule" } ], "$$ref": "#/components/schemas/ScheduleConfig" }, "siteIds": { "type": "array", "description": "Filtering by Site ID list is optional, if no site Id is included, all site ID will be used for report generating.", "example": [ 100, 200 ], "items": { "type": "integer", "format": "int64" } }, "templateType": { "type": "string", "enum": [ "executive_summary", "site_availability", "link_availability", "link_utilization", "link_sla", "app_usage", "ips_events_collected", "firewall_enforcement", "malware_files_collected", "internet_browsing", "license_management", "cpu_memory_energy", "energy_management" ] }, "timeRange": { "type": "string", "description": "Time range for report(one_week/one_month)", "example": "one_week", "enum": [ "one_day", "one_week", "one_month" ] } }, "description": "Executive summary report template", "$$ref": "#/components/schemas/ExecutiveSummaryReport" }, "reportId": { "type": "string", "description": "The report UUID for report template", "format": "uuid", "example": "50671437-c88e-4514-aafa-103e58c4d9cc" }, "reportStatus": { "type": "string", "description": "Report schedule status(not_scheduled/scheduled/in_progress/completed/failed))", "example": "in_progress", "enum": [ "not_scheduled", "scheduled", "in_progress", "completed", "failed" ] }, "taskNum": { "type": "integer", "format": "int64" }, "templateType": { "type": "string", "enum": [ "executive_summary", "site_availability", "link_availability", "link_utilization", "link_sla", "app_usage", "ips_events_collected", "firewall_enforcement", "malware_files_collected", "internet_browsing", "license_management", "cpu_memory_energy", "energy_management" ] } }, "description": "Report Template detail info", "$$ref": "#/components/schemas/ReportInfo" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "required": [ "code", "details", "message" ], "type": "object", "properties": { "code": { "type": "string", "description": "Error code associated with the error event" }, "details": { "type": "string", "description": "Error message details" }, "message": { "type": "string", "description": "Error message title" } }, "description": "error message", "$$ref": "#/components/schemas/Model400ErrorError" } }, "$$ref": "#/components/schemas/Model400Error" } } } }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "Scheduled Report Management" ], "summary": "Delete the report template by report ID", "description": "Delete the report template and all report files associated with it", "operationId": "deleteReportTemplate", "parameters": [ { "name": "reportId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "required": [ "reportId" ], "type": "object", "properties": { "reportId": { "type": "string", "description": "Report ID", "format": "uuid", "example": "e2e28c40-cb1e-45d7-9637-98e145a70174" } }, "$$ref": "#/components/schemas/UpdateReportTemplateResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "required": [ "code", "details", "message" ], "type": "object", "properties": { "code": { "type": "string", "description": "Error code associated with the error event" }, "details": { "type": "string", "description": "Error message details" }, "message": { "type": "string", "description": "Error message title" } }, "description": "error message", "$$ref": "#/components/schemas/Model400ErrorError" } }, "$$ref": "#/components/schemas/Model400Error" } } } }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/v1/reports/{reportId}/action/{action}": { "put": { "tags": [ "Scheduled Report Management" ], "summary": "User operations for report template", "description": "User operations for specific report template, which includes activate,deactivate and run immediately", "operationId": "ReportAction", "parameters": [ { "name": "reportId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "action", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "start", "stop", "runnow" ] } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "required": [ "reportId" ], "type": "object", "properties": { "reportId": { "type": "string", "description": "Report ID", "format": "uuid", "example": "e2e28c40-cb1e-45d7-9637-98e145a70174" } }, "$$ref": "#/components/schemas/UpdateReportTemplateResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "required": [ "code", "details", "message" ], "type": "object", "properties": { "code": { "type": "string", "description": "Error code associated with the error event" }, "details": { "type": "string", "description": "Error message details" }, "message": { "type": "string", "description": "Error message title" } }, "description": "error message", "$$ref": "#/components/schemas/Model400ErrorError" } }, "$$ref": "#/components/schemas/Model400Error" } } } }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/v1/reports/{reportId}/tasks": { "get": { "tags": [ "Scheduled Report Management" ], "summary": "Get report tasks by ID.", "description": "Get all report task detail information by report ID", "operationId": "getAllReportTasksByReportId", "parameters": [ { "name": "reportId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "required": [ "taskList" ], "type": "object", "properties": { "header": { "type": "object", "additionalProperties": { "type": "object" } }, "taskList": { "type": "array", "description": "Report Task list for specific report ID", "items": { "required": [ "reportId", "reportName", "schedule", "startTime", "taskId", "taskStatus", "taskStepDetail", "timeFrame" ], "type": "object", "properties": { "emailRecipient": { "type": "array", "description": "Email address to receive the report files", "example": [ "alice@cisco.com" ], "items": { "type": "string", "description": "Email address to receive the report files", "example": [ "alice@cisco.com" ] } }, "endTime": { "type": "integer", "description": "Report task end timestamp", "format": "int64", "example": 1656677563859 }, "fileType": { "type": "string", "description": "Report file type", "example": "pdf" }, "followerVmanages": { "type": "array", "description": "In Cluster deployment, the follower vManage IP address which needs to replicate the report file from source vManage which generated the report file.", "example": [ "10.0.105.38", "10.0.105.39" ], "items": { "type": "string", "description": "In Cluster deployment, the follower vManage IP address which needs to replicate the report file from source vManage which generated the report file.", "example": [ "10.0.105.38", "10.0.105.39" ] } }, "onVmanage": { "type": "string", "description": "IP address of the source vManage which is scheduled to generate report file. Default value is \"localhost\" for single node vManage deployment.", "example": "10.0.105.32" }, "reportDownloadUrl": { "type": "string", "description": "Report file download URL", "example": "/reports/6f4464a5-f656-4407-acac-4c273e143a0a/tasks/c3855560-462b-46d6-8c2e-82cc9cfc105a/download" }, "reportId": { "type": "string", "description": "Report Template UUID", "format": "uuid", "example": "3fa85f64-5717-4562-b3fc-2c963f66af26" }, "reportName": { "type": "string", "description": "Report name for task", "example": "SJC site summary report-20220916-123123" }, "schedule": { "type": "string", "description": "Report schedule information", "example": "Daily" }, "startTime": { "type": "integer", "description": "Report task start timestamp", "format": "int64", "example": 1656677463859 }, "taskId": { "type": "string", "description": "Task UUID", "format": "uuid", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "taskStatus": { "type": "string", "description": "Report Task status", "example": "in_progress", "enum": [ "failure", "in_progress", "success" ] }, "taskStepDetail": { "required": [ "fileGenerated", "reportDataQuery" ], "type": "object", "properties": { "emailSent": { "type": "boolean", "description": "Email sent or not, if sending report via email is enabled", "example": true }, "fileGenerated": { "type": "boolean", "description": "Report file is generated or not", "example": true }, "fileReplicated": { "type": "boolean", "description": "Report file is all replicated or not when vManage is a cluster deployment", "example": true }, "reportDataQuery": { "type": "boolean", "description": "Report data query success or not", "example": true } }, "description": "The detail status for each step of report generating task", "$$ref": "#/components/schemas/ReportTaskProcessStepInfo" }, "timeFrame": { "type": "string", "description": "Report time frame (7 Days or 30 Days)", "example": "7 Days" } }, "description": "Report Task list for specific report ID", "$$ref": "#/components/schemas/ReportTaskUIInfo" } } }, "description": "Report task query response", "$$ref": "#/components/schemas/ReportTaskQueryResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "required": [ "code", "details", "message" ], "type": "object", "properties": { "code": { "type": "string", "description": "Error code associated with the error event" }, "details": { "type": "string", "description": "Error message details" }, "message": { "type": "string", "description": "Error message title" } }, "description": "error message", "$$ref": "#/components/schemas/Model400ErrorError" } }, "$$ref": "#/components/schemas/Model400Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "required": [ "code", "details", "message" ], "type": "object", "properties": { "code": { "type": "string", "description": "Error code associated with the error event" }, "details": { "type": "string", "description": "Error message details" }, "message": { "type": "string", "description": "Error message title" } }, "description": "error message", "$$ref": "#/components/schemas/Model400ErrorError" } }, "$$ref": "#/components/schemas/Model400Error" } } } }, "500": { "description": "Internal Server Error" } } } }, "/v1/reports/{reportId}/tasks/{taskId}": { "delete": { "tags": [ "Scheduled Report Management" ], "summary": "Delete report task file by ID.", "description": "Delete the report task file by task ID", "operationId": "deleteReportTaskByTaskId", "parameters": [ { "name": "reportId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "taskId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "required": [ "taskId" ], "type": "object", "properties": { "taskId": { "type": "string", "description": "Task ID", "format": "uuid", "example": "e2e28c40-cb1e-45d7-9637-98e145a70174" } }, "$$ref": "#/components/schemas/TaskIdResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "required": [ "code", "details", "message" ], "type": "object", "properties": { "code": { "type": "string", "description": "Error code associated with the error event" }, "details": { "type": "string", "description": "Error message details" }, "message": { "type": "string", "description": "Error message title" } }, "description": "error message", "$$ref": "#/components/schemas/Model400ErrorError" } }, "$$ref": "#/components/schemas/Model400Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "required": [ "code", "details", "message" ], "type": "object", "properties": { "code": { "type": "string", "description": "Error code associated with the error event" }, "details": { "type": "string", "description": "Error message details" }, "message": { "type": "string", "description": "Error message title" } }, "description": "error message", "$$ref": "#/components/schemas/Model400ErrorError" } }, "$$ref": "#/components/schemas/Model400Error" } } } }, "500": { "description": "Internal Server Error" } } } }, "/v1/reports/{reportId}/tasks/{taskId}/download": { "get": { "tags": [ "Scheduled Report Management" ], "summary": "Download a report file", "description": "Download a report file", "operationId": "downloadReportDataFile", "parameters": [ { "name": "reportId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "taskId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/pdf": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/v1/securedeviceonboarding/fetchSdoToken": { "post": { "tags": [ "Secure Device OnBoarding - SDO Token" ], "description": "POST for fetching Secure Device Onboarding Token needed for Secure Device Onboarding APIs for eSim", "operationId": "fetchSdoToken", "requestBody": { "description": "Fetch SDO Token", "content": { "application/json": { "schema": { "required": [ "sdoSessionId" ], "type": "object", "properties": { "sdoSessionId": { "pattern": "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}", "type": "string", "description": "Session ID generated by SDO Identity Service. Please use this GET API - '/v1/securedeviceonboarding/getUrlForSdoIdentityService'to get URL of this Secure Device Onboarding Identity Service.", "example": "e01c5b71-b056-4602-b140-42221ccc3fec" } }, "$$ref": "#/components/schemas/DetailsForIdentityVerificationForSdoToken" }, "examples": { "Request Payload Example for Fetching Secure Device Onboarding Token": { "description": "Request Payload Example for Fetching Secure Device Onboarding Token", "value": { "sdoSessionId": "e01c5b71-b056-4602-b140-42221ccc3fec" } } } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Secure Device Onboarding-write" } }, "/v1/securedeviceonboarding/getUrlForSdoIdentityService": { "get": { "tags": [ "Secure Device OnBoarding - SDO Token" ], "description": "Get URL for Secure Device Onboarding Identity Service that generates Session ID required for authentication to get Secure Device Onboarding token", "operationId": "getUrlForSdoIdentityService", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "Get Secure Device Onboarding Identity Service Url Response Example": { "description": "Get Secure Device Onboarding Identity Service Url Response Example", "value": { "sdoIdentityServiceUrl": "http://sdo.jasper.com" } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Secure Device Onboarding-read" } }, "/v1/securedeviceonboarding/providercredentials": { "post": { "tags": [ "Secure Device OnBoarding - Provider Credentials" ], "description": "Create service provider credentials", "operationId": "createProviderCredentials", "requestBody": { "description": "Create Provider Credentials", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Service Provider Credentials": { "description": "Service Provider Credentials", "value": { "carrierName": "Singtel", "accountId": "100023372", "accountUserName": "testaa", "apiKey": "d6fa2f9-5a7d-4af8-8ab5-4056f631", "isDefault": false, "acceptTermsAndConditions": true } } } } }, "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": "Secure Device Onboarding-write" } }, "/v1/securedeviceonboarding/providerscredentials": { "get": { "tags": [ "Secure Device OnBoarding - Provider Credentials" ], "description": "Get all providers credentials", "operationId": "getAllAccounts", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "required": [ "accountId", "accountUserName", "apiKey", "carrierName", "isDefault" ], "type": "object", "properties": { "acceptTermsAndConditions": { "type": "boolean", "description": "Boolean value which indicates if the account user accepts account provider's terms and conditions if they exist." }, "accountData": { "required": [ "apn", "authMethod", "commPlan", "pdnType", "ratePlan" ], "type": "object", "properties": { "apn": { "maxLength": 2147483647, "minLength": 1, "type": "string", "description": "Access Point Name", "example": "103334b644" }, "authMethod": { "maxLength": 2147483647, "minLength": 1, "pattern": "(^none$|^pap$|^chap$|^pap_or_chap$)", "type": "string", "description": "Authentication method.", "example": "pap" }, "commPlan": { "maxLength": 2147483647, "minLength": 1, "type": "string", "description": "Name of the communication plan associated with default provider.", "example": "vm cp sms data shared" }, "password": { "type": "string", "description": "Password of the user.", "example": "admin123" }, "pdnType": { "maxLength": 2147483647, "minLength": 1, "pattern": "(^IPv4$|^IPv6$|^IPv4v6$)", "type": "string", "description": "Data packet protocol version", "example": "IPv4" }, "ratePlan": { "maxLength": 2147483647, "minLength": 1, "type": "string", "description": "Name of the rate plan associated with default provider.", "example": "vm fixed pool rp" }, "user": { "type": "string", "description": "User name.", "example": "admin" } }, "$$ref": "#/components/schemas/AccountData" }, "accountId": { "type": "string", "description": " ID of the account associated with user using provider service.", "example": "100025578" }, "accountUserName": { "maxLength": 2147483647, "minLength": 1, "type": "string", "description": "Name of the user registered to the service.", "example": "JaneDoe" }, "apiKey": { "maxLength": 2147483647, "minLength": 1, "type": "string", "description": "API key for the provider service.", "example": "1d6fa2f9-5a7d-4af8-8ab5-4056f631" }, "carrierName": { "maxLength": 2147483647, "minLength": 1, "type": "string", "description": "Name of the service provider.", "example": "Singtel" }, "isDefault": { "type": "boolean", "description": "Boolean value which indicates whether the provider is the default provider ." } }, "$$ref": "#/components/schemas/ProviderAccountDetails" }, "examples": { "Service Providers Credentials Response Example": { "description": "Service Providers Credentials Response Example", "value": [ { "carrierName": "Singtel", "accountId": "100023372", "accountUserName": "testaa", "apiKey": "d6fa2f9-5a7d-4af8-8ab5-4056f631", "isDefault": false, "acceptTermsAndConditions": true } ] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Secure Device Onboarding-read" } }, "/v1/securedeviceonboarding/rateplans": { "get": { "tags": [ "Secure Device Onboarding - Rate Plans" ], "description": "Get rate plans by account Id", "operationId": "getRatePlansByAcctId", "parameters": [ { "name": "accountId", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "required": [ "lastPage", "pageNumber", "ratePlans" ], "type": "object", "properties": { "lastPage": { "type": "boolean", "description": "Indicator whether the payload is the last payload.", "example": true }, "pageNumber": { "type": "integer", "description": "Page Number.", "format": "int32", "example": 1 }, "ratePlans": { "type": "array", "description": "List of rate plans.", "example": "Refer to RatePlan", "items": { "required": [ "name", "type" ], "type": "object", "properties": { "dataUsage": { "type": "object", "properties": { "usageLimit": { "type": "integer", "format": "int64" }, "usageLimitUnit": { "type": "string" }, "useDefaultRating": { "type": "boolean", "writeOnly": true } }, "description": "Data usage limit info .", "example": "\"dataUsage\":{\"useDefaultRating\": \"false\", \"usageLimit\": \"50MB\",\"usageLimitUnit\": \"MB\"}", "$$ref": "#/components/schemas/DataUsage" }, "name": { "type": "string", "description": "Name of the rate plan.", "example": "vm fixed pool rp" }, "type": { "type": "string", "description": "Rate plan type.", "example": "Monthly - Pooled Subscriber" } }, "description": "List of rate plans.", "example": "Refer to RatePlan", "$$ref": "#/components/schemas/RatePlan" } } }, "$$ref": "#/components/schemas/RatePlansResponse" }, "examples": { "Rate plans response example": { "description": "Rate plans response example", "value": [ "QaAwtRP-180421030819", "Monthly-Flexible-Pool", "hphlr rp1" ] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Secure Device Onboarding-read" } }, "/v1/securedeviceonboarding/registeredproviders": { "get": { "tags": [ "Secure Device OnBoarding - Provider Credentials" ], "description": "Get Registered Providers Info", "operationId": "getProvidersInfo", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "cmpType": { "type": "string" }, "cmpUrl": { "type": "string" }, "contactInfoLine1": { "type": "string" }, "contactInfoLine2": { "type": "string" }, "contactInfoLine3": { "type": "string" }, "countryCode": { "type": "string" }, "operatorLogoUrl": { "type": "string" }, "operatorName": { "type": "string" }, "termsAndConditions": { "type": "string" } }, "$$ref": "#/components/schemas/ProviderInfo" }, "examples": { "Registered Providers Response Example": { "description": "Registered Providers Response Example", "value": "[{\"operatorName\":\"SingTel Test\",\"countryCode\":\"+1\",\"cmpUrl\":\"https://rws-jpotest.i.jasperwireless.com\",\"cmpType\":\"CC\",\" + \"\"contactInfoLine1\":\"3003 Bunker Hill lane \",\"contactInfoLine2\":\"$$$$$$$$$\",\"contactInfoLine3\":\"asdfv!!!!6578\",\"operatorLogoUrl\":\"https://jpotest.jasper.com/provision/logout\",\"termsAndConditions\":\"Do you accept our terms 1, If yes press Ok or Sorry you cannot use our service ,See you next time!!\"}]" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Secure Device Onboarding-read" } }, "/v1/securedeviceonboarding/{accountId}/commplans": { "get": { "tags": [ "Secure Device Onboarding - Communication Plans" ], "description": "Get communication plans by account Id", "operationId": "getCommPlansByAcctId", "parameters": [ { "name": "accountId", "in": "path", "description": "Service User Account ID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "required": [ "communicationPlans", "pageNumber" ], "type": "object", "properties": { "commPlans": { "type": "array", "writeOnly": true, "items": { "required": [ "apns", "lteApns", "lteEnabled", "name" ], "type": "object", "properties": { "apns": { "type": "array", "description": "List of APNs associated with the Comm Plan", "example": "[{name:M2MTEST}]", "items": { "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string" } }, "description": "List of APNs associated with the Comm Plan", "example": "[{name:M2MTEST}]", "$$ref": "#/components/schemas/Apn" } }, "commPlanDescription": { "type": "string", "description": "Description of the communication plan.", "example": "sms data shared" }, "commPlanName": { "type": "string", "writeOnly": true }, "lteApns": { "type": "array", "description": "List of LTE APNs associated with the Comm Plan.Empty if lteEnabled is false ", "example": [], "items": { "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string" } }, "description": "List of LTE APNs associated with the Comm Plan.Empty if lteEnabled is false ", "example": [], "$$ref": "#/components/schemas/LteApn" } }, "lteEnabled": { "type": "boolean", "description": "Specifies whether the Comm Plan has LTE enabled", "example": false }, "name": { "type": "string", "description": "Name of the communication plan.", "example": "vm cp sms data share" } }, "$$ref": "#/components/schemas/CommunicationPlan" } }, "communicationPlans": { "type": "array", "description": "List of communication plans.", "example": "Refer to CommunicationPlan", "items": { "required": [ "apns", "lteApns", "lteEnabled", "name" ], "type": "object", "properties": { "apns": { "type": "array", "description": "List of APNs associated with the Comm Plan", "example": "[{name:M2MTEST}]", "items": { "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string" } }, "description": "List of APNs associated with the Comm Plan", "example": "[{name:M2MTEST}]", "$$ref": "#/components/schemas/Apn" } }, "commPlanDescription": { "type": "string", "description": "Description of the communication plan.", "example": "sms data shared" }, "commPlanName": { "type": "string", "writeOnly": true }, "lteApns": { "type": "array", "description": "List of LTE APNs associated with the Comm Plan.Empty if lteEnabled is false ", "example": [], "items": { "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string" } }, "description": "List of LTE APNs associated with the Comm Plan.Empty if lteEnabled is false ", "example": [], "$$ref": "#/components/schemas/LteApn" } }, "lteEnabled": { "type": "boolean", "description": "Specifies whether the Comm Plan has LTE enabled", "example": false }, "name": { "type": "string", "description": "Name of the communication plan.", "example": "vm cp sms data share" } }, "$$ref": "#/components/schemas/CommunicationPlan" } }, "pageNumber": { "type": "integer", "description": "Page Number.", "format": "int32", "example": 1 } }, "$$ref": "#/components/schemas/CommunicationPlansResponse" }, "examples": { "Communication plans response example": { "description": "Communication plans response example", "value": "[ \n {\n \"commPlanName\": \"vm cp sms data shared\",\n \"apns\":[{\"name\":\"M2MTEST\"}]\n \"lteApns\":[]\n \"lteEnabled\":false\n }\n ]" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Secure Device Onboarding-read" } }, "/v1/securedeviceonboarding/{accountId}/providerCredentials": { "delete": { "tags": [ "Secure Device OnBoarding - Provider Credentials" ], "description": "Delete provider credentials", "operationId": "deleteProviderCredentials", "parameters": [ { "name": "accountId", "in": "path", "description": "Service User Account 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": "Secure Device Onboarding-write" } }, "/v1/securedeviceonboarding/{accountId}/providercredentials": { "get": { "tags": [ "Secure Device OnBoarding - Provider Credentials" ], "description": "Get provider credentials by account id", "operationId": "getProviderCredentialsByAccountId", "parameters": [ { "name": "accountId", "in": "path", "description": "Service User Account ID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "providerAccountDetailsList": { "type": "array", "items": { "required": [ "accountId", "accountUserName", "apiKey", "carrierName", "isDefault" ], "type": "object", "properties": { "acceptTermsAndConditions": { "type": "boolean", "description": "Boolean value which indicates if the account user accepts account provider's terms and conditions if they exist." }, "accountData": { "required": [ "apn", "authMethod", "commPlan", "pdnType", "ratePlan" ], "type": "object", "properties": { "apn": { "maxLength": 2147483647, "minLength": 1, "type": "string", "description": "Access Point Name", "example": "103334b644" }, "authMethod": { "maxLength": 2147483647, "minLength": 1, "pattern": "(^none$|^pap$|^chap$|^pap_or_chap$)", "type": "string", "description": "Authentication method.", "example": "pap" }, "commPlan": { "maxLength": 2147483647, "minLength": 1, "type": "string", "description": "Name of the communication plan associated with default provider.", "example": "vm cp sms data shared" }, "password": { "type": "string", "description": "Password of the user.", "example": "admin123" }, "pdnType": { "maxLength": 2147483647, "minLength": 1, "pattern": "(^IPv4$|^IPv6$|^IPv4v6$)", "type": "string", "description": "Data packet protocol version", "example": "IPv4" }, "ratePlan": { "maxLength": 2147483647, "minLength": 1, "type": "string", "description": "Name of the rate plan associated with default provider.", "example": "vm fixed pool rp" }, "user": { "type": "string", "description": "User name.", "example": "admin" } }, "$$ref": "#/components/schemas/AccountData" }, "accountId": { "type": "string", "description": " ID of the account associated with user using provider service.", "example": "100025578" }, "accountUserName": { "maxLength": 2147483647, "minLength": 1, "type": "string", "description": "Name of the user registered to the service.", "example": "JaneDoe" }, "apiKey": { "maxLength": 2147483647, "minLength": 1, "type": "string", "description": "API key for the provider service.", "example": "1d6fa2f9-5a7d-4af8-8ab5-4056f631" }, "carrierName": { "maxLength": 2147483647, "minLength": 1, "type": "string", "description": "Name of the service provider.", "example": "Singtel" }, "isDefault": { "type": "boolean", "description": "Boolean value which indicates whether the provider is the default provider ." } }, "$$ref": "#/components/schemas/ProviderAccountDetails" } } }, "$$ref": "#/components/schemas/ProviderAccountDetailsList" }, "examples": { "Service Provider Credentials Response Example": { "description": "Service Provider Credentials Response Example", "value": "{\n \"carrierName\": \"Singtel\",\n \"accountId\": \"100023372\",\n \"accountUserName\":\"testaa\" ,\n \"apiKey\": \"d6fa2f9-5a7d-4af8-8ab5-4056f631\",\n \"isDefault\":true,\n \"acceptTermsAndConditions\":true,\n \"accountData\":{\n \"ratePlan\": \"vm fixed pool rp\",\n \"commPlan\": \"vm cp sms data shared\",\n \"apn\": \"123456789\",\n \"pdnType\": \"IPv4\",\n \"authType\": \"pap\",\n \"user\": \"admin\",\n \"password\": \"admin123\"\n }" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Secure Device Onboarding-read" }, "put": { "tags": [ "Secure Device OnBoarding - Provider Credentials" ], "description": "Edit service provider credentials", "operationId": "editProviderCredentials", "parameters": [ { "name": "accountId", "in": "path", "description": "Service User Account ID", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Provider Credentials", "content": { "application/json": { "schema": { "required": [ "accountId", "accountUserName", "apiKey", "carrierName", "isDefault" ], "type": "object", "properties": { "acceptTermsAndConditions": { "type": "boolean", "description": "Boolean value which indicates if the account user accepts account provider's terms and conditions if they exist." }, "accountData": { "required": [ "apn", "authMethod", "commPlan", "pdnType", "ratePlan" ], "type": "object", "properties": { "apn": { "maxLength": 2147483647, "minLength": 1, "type": "string", "description": "Access Point Name", "example": "103334b644" }, "authMethod": { "maxLength": 2147483647, "minLength": 1, "pattern": "(^none$|^pap$|^chap$|^pap_or_chap$)", "type": "string", "description": "Authentication method.", "example": "pap" }, "commPlan": { "maxLength": 2147483647, "minLength": 1, "type": "string", "description": "Name of the communication plan associated with default provider.", "example": "vm cp sms data shared" }, "password": { "type": "string", "description": "Password of the user.", "example": "admin123" }, "pdnType": { "maxLength": 2147483647, "minLength": 1, "pattern": "(^IPv4$|^IPv6$|^IPv4v6$)", "type": "string", "description": "Data packet protocol version", "example": "IPv4" }, "ratePlan": { "maxLength": 2147483647, "minLength": 1, "type": "string", "description": "Name of the rate plan associated with default provider.", "example": "vm fixed pool rp" }, "user": { "type": "string", "description": "User name.", "example": "admin" } }, "$$ref": "#/components/schemas/AccountData" }, "accountId": { "type": "string", "description": " ID of the account associated with user using provider service.", "example": "100025578" }, "accountUserName": { "maxLength": 2147483647, "minLength": 1, "type": "string", "description": "Name of the user registered to the service.", "example": "JaneDoe" }, "apiKey": { "maxLength": 2147483647, "minLength": 1, "type": "string", "description": "API key for the provider service.", "example": "1d6fa2f9-5a7d-4af8-8ab5-4056f631" }, "carrierName": { "maxLength": 2147483647, "minLength": 1, "type": "string", "description": "Name of the service provider.", "example": "Singtel" }, "isDefault": { "type": "boolean", "description": "Boolean value which indicates whether the provider is the default provider ." } }, "$$ref": "#/components/schemas/ProviderAccountDetails" }, "examples": { "Update Provider Credentials": { "description": "Update Provider Credentials", "value": "{\n \"carrierName\": \"Singtel\",\n \"accountId\": \"100023372\",\n \"accountUserName\":\"testaa\" ,\n \"apiKey\": \"d6fa2f9-5a7d-4af8-8ab5-4056f631\",\n \"isDefault\":true,\n \"acceptTermsAndConditions\":true,\n \"accountData\":{\n \"ratePlan\": \"vm fixed pool rp\",\n \"commPlan\": \"vm cp sms data shared\",\n \"apn\": \"123456789\",\n \"pdnType\": \"IPv4\",\n \"authType\": \"pap\",\n \"user\": \"admin\",\n \"password\": \"admin123\"\n }" } } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Secure Device Onboarding-write" } }, "/v1/securedeviceonboarding/{deviceUUID}/deviceusage": { "get": { "tags": [ "Secure Device OnBoarding - Provider Credentials" ], "description": "Get device data usage using device uuid", "operationId": "getDeviceDataUsage", "parameters": [ { "name": "deviceUUID", "in": "path", "description": "DeviceUUID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "required": [ "carrierName", "communicationPlan", "controllerId", "currentDataUsage", "iccid", "ratePlan", "ratePlanType", "slotId" ], "type": "object", "properties": { "carrierName": { "type": "string", "description": "Name of the service provider.", "example": "Singtel" }, "communicationPlan": { "type": "string", "description": "Name of the communication plan.", "example": "vm cp sms data share" }, "controllerId": { "type": "string", "description": "Controller Id", "example": "1" }, "currentDataUsage": { "type": "string", "description": "Current Data Usage.", "example": "10MB" }, "errorDetails": { "type": "string", "description": "Details of any error encountered while retrieving device data usage", "example": "No eSIM ICCIDs found" }, "esimStatus": { "type": "string", "description": "Bootstrap eSim Status", "example": "ACTIVATED" }, "iccid": { "type": "string", "description": "Identifier of the eSIM device.", "example": "8988216716970004975" }, "isBootstrap": { "type": "boolean", "description": "Boolean flag that indicated if ICCID is on bootstrap account" }, "otherEsimsDataUsage": { "type": "string", "description": "Total data used by other eSIM devices.", "example": "20MB" }, "ratePlan": { "type": "string", "description": "Name of the rate plan.", "example": "vm fixed pool rp" }, "ratePlanDataUsageLimit": { "type": "string", "description": "Rate plan usage limit.", "example": "50MB" }, "ratePlanType": { "type": "string", "description": "Rate plan type.", "example": "Monthly - Pooled Subscriber" }, "slotId": { "type": "integer", "description": "Slot Id", "format": "int32" }, "totalDataUsage": { "type": "string", "description": "Total data usage", "example": "30MB" }, "usageThresholdWarning": { "type": "array", "description": "Total value of current data usage and data used by other eSIM devices", "example": "Data Usage has reached or exceeded the threshold limit of 90%.", "items": { "type": "string", "description": "Total value of current data usage and data used by other eSIM devices", "example": "Data Usage has reached or exceeded the threshold limit of 90%." } } }, "$$ref": "#/components/schemas/DeviceUsageDetails" }, "examples": { "Device Usage Response Example": { "description": "Device Usage Response Example", "value": "[{\n \"iccid\": \"8988216716970004975\",\n \"carrierName\": \"Singtel\",\n \"ratePlan\":\"hphlr rp1\" ,\n \"communicationPlan\": \"vm cp sms data shared\",\n \"ratePlanType\":\"Monthly - Pooled Subscriber\",\n \"currentDataUsage\":\"10MB\",\n \"ratePlanUsageLimit\": \"50MB\",\n \"otherEsimsDataUsage\": \"20MB\",\n }]" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Secure Device Onboarding-read" } }, "/v1/smart-licensing/association": { "get": { "tags": [ "SmartLicensing - Templates" ], "description": "Get the devices associated with a template", "operationId": "getDevicesForTemplate", "parameters": [ { "name": "templateId", "in": "query", "description": "template Id", "schema": { "type": "string" }, "example": "ae7e7b38-d8aa-4c56-a25e-80c73e68ec36" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Example": { "description": "Example", "value": { "association": [ { "template": "ae7e7b38-d8aa-4c56-a25e-80c73e68ec36", "devices": [] } ] }, "$$ref": "#/components/examples/ComViptelaVmanageServerSmartlicensingSmartlicensingapiResponseExampleAssociationresp" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true } }, "/v1/smart-licensing/ea/fetch-accounts": { "post": { "tags": [ "SmartLicensing - Sync EA Licenses" ], "description": "Fetch list of VAs from EA.", "operationId": "fetchEaVirtualAccounts", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "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" } } } }, "/v1/smart-licensing/ea/fetch-sync-status": { "get": { "tags": [ "SmartLicensing - Sync EA Licenses" ], "description": "Check if EA Account has been synced. Empty Response if EA sync has not been done", "operationId": "fetchEASyncStatus", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/v1/smart-licensing/ea/generate": { "post": { "tags": [ "SmartLicensing - Sync EA Licenses" ], "description": "Generate Licenses from Enterprise Agreement Portal", "operationId": "generateEALicenses", "requestBody": { "description": "Create a rule", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "Config Group": { "description": "Config Group", "value": { "transactionId": "", "smartAccountDomain": "", "smartAccountId": "102811", "targetVirtualAccountId": "129975", "subscriptionId": "Sub1149281", "modelNumber": "", "userEmail": "", "suites": [ { "suiteName": "", "atoName": "E2-N-CL-SDWAN", "commerceSkus": [ { "commerceSku": "E2N-SDWAN-P-T2-G-P", "featureList": [ { "featureSku": "C1DNA-P-1G-A-3Y", "licenseQty": 1, "bandwithApplicable": "YES" } ] }, { "commerceSku": "E2N-SDWAN-P-T3-G-P", "featureList": [ { "featureSku": "C1DNA-P-10G-A-3Y", "licenseQty": 1, "bandwithApplicable": "YES" } ] } ] } ] } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/v1/smart-licensing/ea/sync": { "post": { "tags": [ "SmartLicensing - Sync EA Licenses" ], "description": "Get Specific Virtual Account's Details belonging to the EA", "operationId": "syncWithEA", "parameters": [ { "name": "virtual_account_id", "in": "query", "description": "virtual_account_id", "required": true, "schema": { "maxLength": 200, "minLength": 0, "pattern": "^[0-9]+$", "type": "string" }, "example": 702544 } ], "requestBody": { "content": { "*/*": { "schema": { "type": "object", "additionalProperties": { "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" } } } }, "/v1/smart-licensing/license": { "get": { "tags": [ "SmartLicensing - Sync Licenses" ], "description": "Get licenses from vManage db", "operationId": "license", "parameters": [ { "name": "virtual_account_id", "in": "query", "description": "virtual_account_id", "required": true, "schema": { "maxLength": 200, "minLength": 0, "pattern": "^[0-9]+$", "type": "string" }, "example": 702544 }, { "name": "licenseType", "in": "query", "description": "License type 'prepaid' or 'postpaid'", "required": true, "schema": { "maxLength": 20, "minLength": 0, "pattern": "^[a-zA-Z]+$", "type": "string" }, "example": "prepaid" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "properties": { "empty": { "type": "boolean" } }, "items": { "type": "object", "properties": { "billing_model": { "type": "string", "example": "UNCOMMITTED" }, "billing_type": { "type": "string", "example": "USAGE" }, "licenses": { "type": "array", "items": { "type": "object", "properties": { "Available": { "type": "string", "example": "0" }, "Purchased": { "type": "integer", "format": "int64" }, "billing_model": { "type": "string", "example": "UNCOMMITTED" }, "billing_type": { "type": "string", "example": "USAGE" }, "display_name": { "type": "string", "example": "Routing DNA Essentials: Tier 1" }, "inUse": { "type": "string", "example": "1" }, "quantity": { "type": "string", "example": "1" }, "tag": { "type": "string", "example": "regid.2020-10.com.cisco.DSTACK_T1_E,1.0_e3ff4086-b5f3-4845-b0ac-7a23d3b4a139" } }, "$$ref": "#/components/schemas/LicenseInfo" } }, "subscription_id": { "type": "string", "example": "32BJDSLL789AF" } }, "$$ref": "#/components/schemas/GetLicenseResponseInner" }, "$$ref": "#/components/schemas/GetLicenseResponse" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/v1/smart-licensing/sync": { "post": { "tags": [ "SmartLicensing - Sync Licenses" ], "description": "Sync licenses from CSSM to vManage db", "operationId": "syncLicenses_SmartlicensingSyncLicenses_2404", "requestBody": { "description": "Partner", "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "data": { "type": "string", "example": { "mode": "onprem", "multipleEntitlement": false, "smartAccounts": [ { "account_id": "1", "name": "sjc24_onprem_sle", "virtual_accounts": [ { "virtual_account_id": "1" } ] } ] } }, "name": { "type": "string", "format": "binary" } }, "$$ref": "#/components/schemas/SyncRequest" } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/v1/smart-licensing/template": { "post": { "tags": [ "SmartLicensing - Templates" ], "description": "Create and assign license template.", "operationId": "saveTemplate", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "licenseTemplate": { "type": "object", "properties": { "licenseType": { "type": "string", "example": "postpaid" }, "licenses": { "type": "array", "items": { "type": "object", "properties": { "display_name": { "type": "string", "example": "Routing DNA Premier: Tier 3" }, "tag": { "type": "string", "example": "regid.2020-10.com.cisco.DSTACK_T3_P,1.0_4fbf7891-fdee-4b78-9d70-696b260ef347" } }, "$$ref": "#/components/schemas/SaveTemplateRequestLicenseTemplateLicenses" } }, "saAccount": { "type": "string", "example": "316448" }, "saName": { "type": "string", "example": "testaccount1.viptela.com" }, "subscriptionsUsed": { "type": "array", "items": { "type": "object", "properties": { "subscription_id": { "type": "string", "example": "3432DFGDGFD" } }, "$$ref": "#/components/schemas/SaveTemplateRequestLicenseTemplateSubscriptionsUsed" } }, "templateName": { "type": "string", "example": "TestTemplate" }, "useExistingTemplate": { "type": "boolean", "example": false }, "uuid": { "type": "array", "items": { "type": "string" } }, "vaAccount": { "type": "string", "example": "702546" }, "vaName": { "type": "string", "example": "vManage_Test_Postpaid" } }, "$$ref": "#/components/schemas/SaveTemplateRequestLicenseTemplate" } }, "$$ref": "#/components/schemas/SaveTemplateRequest" } } }, "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 } }, "/v1/smart-licensing/template/{templateId}": { "delete": { "tags": [ "SmartLicensing - Templates" ], "description": "Delete a license template", "operationId": "deleteTemplate", "parameters": [ { "name": "templateId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true } }, "/v1/smart-licensing/user-settings": { "get": { "tags": [ "SmartLicensing - Sync Licenses" ], "description": "Get smart licensing user settings", "operationId": "getUserSettings", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "isPresentCredentials": { "type": "boolean", "example": true }, "mode": { "type": "string", "description": "Smart Licensing mode can be 'online', 'offline' or 'onPrem'", "example": "online" }, "multipleEntitlement": { "type": "boolean", "example": false }, "uname": { "type": "string", "description": "Smart Licensing user name", "example": "TestUser" } }, "$$ref": "#/components/schemas/UserSettingsResponse" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/v1/topology-group/{topologyGroupId}/rules/preview": { "get": { "tags": [ "Rules" ], "description": "Get all rules associated to all parcels in topololgy group", "operationId": "getPreviewOfBulkRuleAssociation", "parameters": [ { "name": "topologyGroupId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "Preview Association": { "description": "Preview Association", "value": "{\"data\":[{\n\"parcelId\": \"string\",\n\"parcelRules\" : [{\n \"ruleId\": \"string\",\n\"response\" : [{\n \"objectId\": \"string\",\n \"objectType\": \"DEVICE\",\n \"status\": \"Success\",\n \"message\": [\n {\n \"messageObject\": [\n {\n \"key\": \"string\",\n \"value\": \"string\"\n }\n ]\n }\n ]\n}]}" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/wani/recommendations": { "get": { "tags": [ "Wani Recommendations" ], "summary": "Get recommendations from WANI", "description": "API to get the recommendations obtained from WANI for a given tenant. This returns only valid recommendations based on expiry. It filters out recommendations that are inactive.", "operationId": "getWaniRecommendations", "parameters": [ { "name": "siteId", "in": "query", "description": "The specific site id to get recommendations for, if empty get recommendations for all sites", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "required": [ "recommendations" ], "type": "object", "properties": { "recommendations": { "type": "array", "example": [ { "siteName": "SITE_400", "siteId": "400", "count": 2 }, { "siteName": "SITE_500", "siteId": "500", "count": 6 } ], "items": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32", "example": 6 }, "siteId": { "type": "string", "example": "500" }, "siteName": { "type": "string", "example": "SITE_500" } }, "example": [ { "siteName": "SITE_400", "siteId": "400", "count": 2 }, { "siteName": "SITE_500", "siteId": "500", "count": 6 } ], "$$ref": "#/components/schemas/RecommendationsResponseRecommendations" } }, "totalRecommendationCount": { "type": "integer", "format": "int32", "example": 8 } }, "$$ref": "#/components/schemas/RecommendationsResponse" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/wani/recommendations/applied": { "get": { "tags": [ "Wani Recommendations" ], "summary": "Get applied vManage recommendations.", "description": "Per tenant api to check which Wani recommendations have been applied for a given tenant ", "operationId": "getAppliedWaniRecommendations", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "properties": { "empty": { "type": "boolean" } }, "items": { "required": [ "actionId", "appClassName", "last updated", "recommendationDef", "siteId", "state" ], "type": "object", "properties": { "actionId": { "type": "string", "example": "MYhj3JBjAr" }, "appClassName": { "type": "string", "example": "office365" }, "last updated": { "type": "string", "example": "09 Apr 2023 21:31:51 UTC" }, "recommendationDef": { "type": "string", "example": { "tenantId": "jSZn6hVkvr", "actionId": "MYhj3JBjAr", "actionType": "SR", "appClass": "office365", "windowStart": "2023-03-22T02:00:00+00:00", "windowEnd": "2023-04-09T23:00:00+00:00", "isActive": true, "srcEndpointId": "SgaEHHOs38", "dstEndpointId": null, "metadata": { "defaultPathType": "Tunnel", "defaultInterfaceIds": [ "public-internet", "mpls" ], "recommendedPathType": "Tunnel", "recommendedInterfaceIds": [ "public-internet" ] }, "predDefaultProbSlaViolation": 0.24967608, "predRecommendedProbSlaViolation": 0.0005022502, "predNumSessions": null, "modelName": null, "version": 0, "siteId": "12127", "state": "READY", "curState": "APPLIED", "applicationWindow": { "end": null, "start": null }, "states": [ "APPLIED", "NON_APPLIED", "APPLIED" ], "timestamps": [ "2023-04-03T21:28:49.146624+00:00", "2023-04-03T23:24:10.403133+00:00", "2023-04-03T23:45:21.623478+00:00" ], "appClassId": "office365", "appClassName": "Office 365", "isAppClassSelected": true } }, "siteId": { "type": "string", "example": "12127" }, "state": { "type": "string", "example": "APPLIED" } }, "$$ref": "#/components/schemas/AppliedRecommendationsResEntry" }, "$$ref": "#/components/schemas/AppliedRecommendationsRes" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/wani/{listType}/{listId}/listActivationStatus": { "get": { "tags": [ "Wani Recommendations" ], "summary": "Check list in activated WANI policy.", "description": "Get if specified list is apart of a activated centralized policy, if it is the response also gives the centralized policy id, the users original defined centralized policy id, and if current list is apart of a active wani policy. ", "operationId": "getListActivationStatus", "parameters": [ { "name": "listType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "listId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "required": [ "centralizedPolicyActive", "isActivatedByVSmarts" ], "type": "object", "properties": { "activatedCentralizedPolicyId": { "type": "string", "format": "uuid", "example": "efec8edf-04ce-4a99-86d5-441099f52b79" }, "centralizedPolicyActive": { "type": "boolean", "example": true }, "isActivatedByVSmarts": { "type": "boolean", "example": true }, "referredInActiveWaniPolicy": { "type": "boolean", "example": true }, "userDefinedPolicyId": { "type": "string", "format": "uuid", "example": "5b55dbd3-35db-4358-a1a6-ee59da9b9d2d" } }, "$$ref": "#/components/schemas/ActivationStatusRes" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/wani/{policyType}/{policyId}/policyActivationStatus": { "get": { "tags": [ "Wani Recommendations" ], "summary": "Check policy in activated WANI policy.", "description": "Get if specified policy is apart of a activated centralized policy, if it is the response also gives the centralized policy id, the users original defined centralized policy id, and if current policy is apart of a active wani policy. ", "operationId": "getPolicyActivationStatus", "parameters": [ { "name": "policyType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "policyId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "required": [ "centralizedPolicyActive", "isActivatedByVSmarts" ], "type": "object", "properties": { "activatedCentralizedPolicyId": { "type": "string", "format": "uuid", "example": "efec8edf-04ce-4a99-86d5-441099f52b79" }, "centralizedPolicyActive": { "type": "boolean", "example": true }, "isActivatedByVSmarts": { "type": "boolean", "example": true }, "referredInActiveWaniPolicy": { "type": "boolean", "example": true }, "userDefinedPolicyId": { "type": "string", "format": "uuid", "example": "5b55dbd3-35db-4358-a1a6-ee59da9b9d2d" } }, "$$ref": "#/components/schemas/ActivationStatusRes" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } } } }