{ "openapi": "3.1.0", "info": { "title": "Feature Profiles - SD-WAN System", "description": "Feature profiles associated with UX 2.0 configuration\nIncludes API operations for the following:\n System Feature Profiles in the SD-WAN Solution\n Managing core system configurations, device management, and platform-level settings", "contact": { "email": "vmanage@cisco.com" }, "license": { "name": "Commercial License", "url": "https://www.cisco.com/c/en/us/solutions/enterprise-networks/sd-wan/index.html" }, "version": "26.1.0+2026-01-06", "x-provenance": { "method": "harvested", "authored_by": "Cisco Catalyst SD-WAN", "harvested_by": "API Evangelist", "harvested_on": "2026-08-19", "first_party": true, "provider_published": true, "source_host": "pubhub.devnetcloud.com", "note": "4,138 operations across 2,841 paths, published by Cisco as self-contained per-operation OpenAPI 3.1.0 fragments on the DevNet CDN and consolidated here into 13 documents. Ownership verified from info.contact vmanage@cisco.com and the Cisco license URL rather than from the fetch host." }, "x-evidence": [ { "type": "source", "url": "https://pubhub.devnetcloud.com/media/cisco-catalyst-sd-wan-26-1-api-guide/docs/" }, { "type": "source", "url": "https://developer.cisco.com/docs/sdwan/" } ] }, "servers": [ { "url": "/dataservice" } ], "tags": [ { "name": "Configuration - Feature Profile (SDWAN)" } ], "paths": { "/v1/feature-profile/sdwan/system/aaa/schema": { "get": { "tags": [ "Configuration - Feature Profile (SDWAN)" ], "description": "Get a SDWAN System Aaa Parcel Schema by Schema Type", "operationId": "GetSdwanSystemAaaParcelSchemaBySchemaType", "parameters": [ { "name": "schemaType", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "post", "put" ] } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "post": { "value": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[^&<>! \"]+$", "minLength": 1, "maxLength": 128 }, "description": { "description": "Set the parcel description", "type": "string" }, "data": { "type": "object", "properties": { "authenticationGroup": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ false ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "accountingGroup": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ false ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "serverAuthOrder": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "items": { "type": "string", "default": "local", "maxLength": 220, "minLength": 1 }, "additionalProperties": false, "uniqueItems": true, "type": "array", "minItems": 1, "maxItems": 4 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "user": { "description": "Create local login account", "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "name": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string", "pattern": "^[^&<>! \"]+$", "maxLength": 64, "minLength": 1 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "password": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "privilege": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string", "enum": [ "1", "15" ], "default": "15" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "string", "enum": [ "15" ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "pubkeyChain": { "description": "List of RSA public-keys per user", "type": "array", "uniqueItems": true, "maxItems": 2, "items": { "type": "object", "properties": { "keyString": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string", "pattern": "^AAAA[0-9A-Za-z+/]+[=]{0,3}$", "maxLength": 1024, "minLength": 1 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "keyType": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string", "enum": [ "ssh-rsa" ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] } }, "required": [ "keyString" ], "additionalProperties": false } } }, "additionalProperties": false, "allOf": [ { "if": { "anyOf": [ { "properties": { "name": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "name" ] }, { "properties": { "password": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "password" ] } ] }, "then": { "required": [ "name", "password" ] } } ] } }, "radius": { "description": "Configure the Radius serverGroup", "type": "array", "uniqueItems": true, "items": { "type": "object", "properties": { "groupName": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string", "maxLength": 32, "minLength": 1 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "vpn": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "integer", "minimum": 0, "maximum": 65530 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "integer", "minimum": 0, "maximum": 0, "default": 0 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "sourceInterface": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string", "pattern": "(ATM|ATM-ACR|AppGigabitEthernet|AppNav-Compress|AppNav-UnCompress|Async|BD-VIF|BDI|CEM|CEM-ACR|Cellular|Dialer|Embedded-Service-Engine|Ethernet|Ethernet-Internal|FastEthernet|FiftyGigabitEthernet|FiveGigabitEthernet|FortyGigabitEthernet|FourHundredGigE|GMPLS|GigabitEthernet|Group-Async|HundredGigE|L2LISP|LISP|Loopback|MFR|Multilink|Port-channel|SM|Serial|Service-Engine|TenGigabitEthernet|Tunnel|TwentyFiveGigE|TwentyFiveGigabitEthernet|TwoGigabitEthernet|TwoHundredGigE|Vif|Virtual-PPP|Virtual-Template|VirtualPortGroup|Vlan|Wlan-GigabitEthernet|nat64|nat66|ntp|nve|ospfv3|overlay|pseudowire|ucse|vasileft|vasiright|vmi)([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]+)", "minLength": 3, "maxLength": 32 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] } }, "required": [ "optionType" ], "additionalProperties": false } ] }, "server": { "description": "Configure the Radius server", "type": "array", "uniqueItems": true, "items": { "type": "object", "properties": { "address": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string", "oneOf": [ { "format": "ipv4" }, { "format": "ipv6" } ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "authPort": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "integer", "default": 1812, "maximum": 65534, "minimum": 1 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "integer", "maximum": 1812, "minimum": 1812 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "acctPort": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "integer", "default": 1813, "maximum": 65534, "minimum": 1 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "integer", "maximum": 1813, "minimum": 1813 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "timeout": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "integer", "default": 5, "maximum": 1000, "minimum": 1 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "integer", "maximum": 5, "minimum": 5 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "retransmit": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "integer", "default": 3, "maximum": 100, "minimum": 1 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "integer", "maximum": 3, "minimum": 3 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "key": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string", "minLength": 1 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "secretKey": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string", "maxLength": 150, "minLength": 1 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] } }, "required": [ "optionType" ], "additionalProperties": false } ] }, "keyEnum": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string", "enum": [ "6", "7" ] } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] } }, "required": [ "optionType" ], "additionalProperties": false } ] }, "keyType": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string", "enum": [ "key", "pac" ], "default": "key" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "string", "enum": [ "key" ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] } }, "required": [ "address", "key" ], "additionalProperties": false } } }, "required": [ "groupName", "server" ], "additionalProperties": false } }, "ctsAuthList": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "minLength": 1, "type": "string", "maxLength": 64 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "string", "enum": [ "" ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "radiusTrustsecGroup": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string", "minLength": 1, "maxLength": 32 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "string", "default": "" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "tacacs": { "description": "Configure the TACACS serverGroup", "type": "array", "uniqueItems": true, "items": { "type": "object", "properties": { "groupName": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string", "maxLength": 32, "minLength": 1 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "vpn": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "integer", "minimum": 0, "maximum": 65530 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "integer", "minimum": 0, "maximum": 0, "default": 0 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "sourceInterface": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string", "pattern": "(ATM|ATM-ACR|AppGigabitEthernet|AppNav-Compress|AppNav-UnCompress|Async|BD-VIF|BDI|CEM|CEM-ACR|Cellular|Dialer|Embedded-Service-Engine|Ethernet|Ethernet-Internal|FastEthernet|FiftyGigabitEthernet|FiveGigabitEthernet|FortyGigabitEthernet|FourHundredGigE|GMPLS|GigabitEthernet|Group-Async|HundredGigE|L2LISP|LISP|Loopback|MFR|Multilink|Port-channel|SM|Serial|Service-Engine|TenGigabitEthernet|Tunnel|TwentyFiveGigE|TwentyFiveGigabitEthernet|TwoGigabitEthernet|TwoHundredGigE|Vif|Virtual-PPP|Virtual-Template|VirtualPortGroup|Vlan|Wlan-GigabitEthernet|nat64|nat66|ntp|nve|ospfv3|overlay|pseudowire|ucse|vasileft|vasiright|vmi)([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]+)", "minLength": 3, "maxLength": 32 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] } }, "required": [ "optionType" ], "additionalProperties": false } ] }, "server": { "description": "Configure the TACACS server", "type": "array", "uniqueItems": true, "items": { "type": "object", "properties": { "address": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string", "oneOf": [ { "format": "ipv4" }, { "format": "ipv6" } ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "port": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "integer", "default": 49, "maximum": 65535, "minimum": 1 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "integer", "maximum": 49, "minimum": 49 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "timeout": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "integer", "default": 5, "maximum": 1000, "minimum": 1 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "integer", "maximum": 5, "minimum": 5 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "key": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string", "minLength": 1 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "secretKey": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string", "maxLength": 150, "minLength": 1 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "keyEnum": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string", "enum": [ "6", "7" ] } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] } }, "required": [ "optionType" ], "additionalProperties": false } ] } }, "required": [ "address", "key" ], "additionalProperties": false } } }, "required": [ "groupName", "server" ], "additionalProperties": false } }, "accountingRule": { "description": "Configure the accounting rules", "type": "array", "uniqueItems": true, "items": { "type": "object", "properties": { "ruleId": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string", "maxLength": 32 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "method": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string", "enum": [ "commands", "exec", "network", "system" ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "level": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string", "enum": [ "1", "15" ] } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] } }, "required": [ "optionType" ], "additionalProperties": false } ] }, "startStop": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ true ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "group": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "items": { "type": "string" }, "additionalProperties": false, "uniqueItems": true, "type": "array", "maxItems": 4 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] } }, "required": [ "ruleId", "method", "group" ], "additionalProperties": false } }, "authorizationConsole": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ false ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "authorizationConfigCommands": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ false ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "authorizationRule": { "description": "Configure the Authorization Rules", "type": "array", "uniqueItems": true, "items": { "type": "object", "properties": { "ruleId": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string", "maxLength": 32 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "method": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string", "enum": [ "commands" ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "level": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string", "enum": [ "1", "15" ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "group": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "items": { "type": "string" }, "additionalProperties": false, "uniqueItems": true, "type": "array", "maxItems": 3 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "ifAuthenticated": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ false ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] } }, "required": [ "ruleId", "method", "group", "level" ], "additionalProperties": false } } }, "required": [ "serverAuthOrder", "authorizationConsole", "authorizationConfigCommands", "authenticationGroup", "accountingGroup" ], "allOf": [ { "if": { "properties": { "ctsAuthList": { "type": "object", "properties": { "optionType": { "type": "string", "enum": [ "global" ] } } } } }, "then": { "properties": { "radiusTrustsecGroup": { "type": "object", "properties": { "optionType": { "type": "string", "enum": [ "global" ] } } } } } }, { "if": { "properties": { "ctsAuthList": { "type": "object", "properties": { "optionType": { "type": "string", "enum": [ "variable" ] } } } } }, "then": { "properties": { "radiusTrustsecGroup": { "type": "object", "properties": { "optionType": { "type": "string", "enum": [ "global" ] } } } } } }, { "if": { "properties": { "ctsAuthList": { "type": "object", "properties": { "optionType": { "type": "string", "enum": [ "default" ] } } } } }, "then": { "properties": { "radiusTrustsecGroup": { "type": "object", "properties": { "optionType": { "type": "string", "enum": [ "default" ] } } } } } } ], "additionalProperties": false } }, "required": [ "name", "data" ], "x-metadata": { "supportedDeviceTypes": [ "asr", "c1100", "c8000be", "csr1000v", "ir8100", "ir8340", "isr", "ISRv", "ir1101" ], "minVManageVersion": "20.18.1" }, "additionalProperties": false }, "$$ref": "#/components/examples/ProfileparcelSdwanSystemAaaPostRequest_ResolvedSchema" }, "put": { "value": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[^&<>! \"]+$", "minLength": 1, "maxLength": 128 }, "description": { "description": "Set the parcel description", "type": "string" }, "data": { "type": "object", "properties": { "authenticationGroup": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ false ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "accountingGroup": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ false ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "serverAuthOrder": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "items": { "type": "string", "default": "local", "maxLength": 220, "minLength": 1 }, "additionalProperties": false, "uniqueItems": true, "type": "array", "minItems": 1, "maxItems": 4 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "user": { "description": "Create local login account", "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "name": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string", "maxLength": 64, "minLength": 1 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "password": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "privilege": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string", "enum": [ "1", "15" ], "default": "15" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "string", "enum": [ "15" ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "pubkeyChain": { "description": "List of RSA public-keys per user", "type": "array", "uniqueItems": true, "maxItems": 2, "items": { "type": "object", "properties": { "keyString": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string", "pattern": "^AAAA[0-9A-Za-z+/]+[=]{0,3}$", "maxLength": 1024, "minLength": 1 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "keyType": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string", "enum": [ "ssh-rsa" ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] } }, "required": [ "keyString" ], "additionalProperties": false } } }, "additionalProperties": false, "allOf": [ { "if": { "anyOf": [ { "properties": { "name": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "name" ] }, { "properties": { "password": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "password" ] } ] }, "then": { "required": [ "name", "password" ] } } ] } }, "radius": { "description": "Configure the Radius serverGroup", "type": "array", "uniqueItems": true, "items": { "type": "object", "properties": { "groupName": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string", "maxLength": 32, "minLength": 1 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "vpn": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "integer", "minimum": 0, "maximum": 65530 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "integer", "minimum": 0, "maximum": 0, "default": 0 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "sourceInterface": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string", "pattern": "(ATM|ATM-ACR|AppGigabitEthernet|AppNav-Compress|AppNav-UnCompress|Async|BD-VIF|BDI|CEM|CEM-ACR|Cellular|Dialer|Embedded-Service-Engine|Ethernet|Ethernet-Internal|FastEthernet|FiftyGigabitEthernet|FiveGigabitEthernet|FortyGigabitEthernet|FourHundredGigE|GMPLS|GigabitEthernet|Group-Async|HundredGigE|L2LISP|LISP|Loopback|MFR|Multilink|Port-channel|SM|Serial|Service-Engine|TenGigabitEthernet|Tunnel|TwentyFiveGigE|TwentyFiveGigabitEthernet|TwoGigabitEthernet|TwoHundredGigE|Vif|Virtual-PPP|Virtual-Template|VirtualPortGroup|Vlan|Wlan-GigabitEthernet|nat64|nat66|ntp|nve|ospfv3|overlay|pseudowire|ucse|vasileft|vasiright|vmi)([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]+)", "minLength": 3, "maxLength": 32 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] } }, "required": [ "optionType" ], "additionalProperties": false } ] }, "server": { "description": "Configure the Radius server", "type": "array", "uniqueItems": true, "items": { "type": "object", "properties": { "address": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string", "oneOf": [ { "format": "ipv4" }, { "format": "ipv6" } ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "authPort": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "integer", "default": 1812, "maximum": 65534, "minimum": 1 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "integer", "maximum": 1812, "minimum": 1812 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "acctPort": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "integer", "default": 1813, "maximum": 65534, "minimum": 1 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "integer", "maximum": 1813, "minimum": 1813 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "timeout": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "integer", "default": 5, "maximum": 1000, "minimum": 1 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "integer", "maximum": 5, "minimum": 5 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "retransmit": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "integer", "default": 3, "maximum": 100, "minimum": 1 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "integer", "maximum": 3, "minimum": 3 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "key": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string", "minLength": 1 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "secretKey": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string", "maxLength": 150, "minLength": 1 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] } }, "required": [ "optionType" ], "additionalProperties": false } ] }, "keyEnum": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string", "enum": [ "6", "7" ] } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] } }, "required": [ "optionType" ], "additionalProperties": false } ] }, "keyType": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string", "enum": [ "key", "pac" ], "default": "key" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "string", "enum": [ "key" ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] } }, "required": [ "address", "key" ], "additionalProperties": false } } }, "required": [ "groupName", "server" ], "additionalProperties": false } }, "ctsAuthList": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "minLength": 1, "type": "string", "maxLength": 64 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "string", "enum": [ "" ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "radiusTrustsecGroup": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string", "minLength": 1, "maxLength": 32 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "string", "default": "" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "tacacs": { "description": "Configure the TACACS serverGroup", "type": "array", "uniqueItems": true, "items": { "type": "object", "properties": { "groupName": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string", "maxLength": 32, "minLength": 1 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "vpn": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "integer", "minimum": 0, "maximum": 65530 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "integer", "minimum": 0, "maximum": 0, "default": 0 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "sourceInterface": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string", "pattern": "(ATM|ATM-ACR|AppGigabitEthernet|AppNav-Compress|AppNav-UnCompress|Async|BD-VIF|BDI|CEM|CEM-ACR|Cellular|Dialer|Embedded-Service-Engine|Ethernet|Ethernet-Internal|FastEthernet|FiftyGigabitEthernet|FiveGigabitEthernet|FortyGigabitEthernet|FourHundredGigE|GMPLS|GigabitEthernet|Group-Async|HundredGigE|L2LISP|LISP|Loopback|MFR|Multilink|Port-channel|SM|Serial|Service-Engine|TenGigabitEthernet|Tunnel|TwentyFiveGigE|TwentyFiveGigabitEthernet|TwoGigabitEthernet|TwoHundredGigE|Vif|Virtual-PPP|Virtual-Template|VirtualPortGroup|Vlan|Wlan-GigabitEthernet|nat64|nat66|ntp|nve|ospfv3|overlay|pseudowire|ucse|vasileft|vasiright|vmi)([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]+)", "minLength": 3, "maxLength": 32 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] } }, "required": [ "optionType" ], "additionalProperties": false } ] }, "server": { "description": "Configure the TACACS server", "type": "array", "uniqueItems": true, "items": { "type": "object", "properties": { "address": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string", "oneOf": [ { "format": "ipv4" }, { "format": "ipv6" } ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "port": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "integer", "default": 49, "maximum": 65535, "minimum": 1 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "integer", "maximum": 49, "minimum": 49 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "timeout": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "integer", "default": 5, "maximum": 1000, "minimum": 1 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "integer", "maximum": 5, "minimum": 5 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "key": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string", "minLength": 1 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "secretKey": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string", "maxLength": 150, "minLength": 1 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "keyEnum": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string", "enum": [ "6", "7" ] } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] } }, "required": [ "optionType" ], "additionalProperties": false } ] } }, "required": [ "address", "key" ], "additionalProperties": false } } }, "required": [ "groupName", "server" ], "additionalProperties": false } }, "accountingRule": { "description": "Configure the accounting rules", "type": "array", "uniqueItems": true, "items": { "type": "object", "properties": { "ruleId": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string", "maxLength": 32 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "method": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string", "enum": [ "commands", "exec", "network", "system" ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "level": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string", "enum": [ "1", "15" ] } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] } }, "required": [ "optionType" ], "additionalProperties": false } ] }, "startStop": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ true ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "group": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "items": { "type": "string" }, "additionalProperties": false, "uniqueItems": true, "type": "array", "maxItems": 4 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] } }, "required": [ "ruleId", "method", "group" ], "additionalProperties": false } }, "authorizationConsole": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ false ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "authorizationConfigCommands": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ false ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "authorizationRule": { "description": "Configure the Authorization Rules", "type": "array", "uniqueItems": true, "items": { "type": "object", "properties": { "ruleId": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string", "maxLength": 32 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "method": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string", "enum": [ "commands" ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "level": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string", "enum": [ "1", "15" ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "group": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "items": { "type": "string" }, "additionalProperties": false, "uniqueItems": true, "type": "array", "maxItems": 3 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "ifAuthenticated": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ false ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] } }, "required": [ "ruleId", "method", "group", "level" ], "additionalProperties": false } } }, "required": [ "serverAuthOrder", "authorizationConsole", "authorizationConfigCommands", "authenticationGroup", "accountingGroup" ], "allOf": [ { "if": { "properties": { "ctsAuthList": { "type": "object", "properties": { "optionType": { "type": "string", "enum": [ "global" ] } } } } }, "then": { "properties": { "radiusTrustsecGroup": { "type": "object", "properties": { "optionType": { "type": "string", "enum": [ "global" ] } } } } } }, { "if": { "properties": { "ctsAuthList": { "type": "object", "properties": { "optionType": { "type": "string", "enum": [ "variable" ] } } } } }, "then": { "properties": { "radiusTrustsecGroup": { "type": "object", "properties": { "optionType": { "type": "string", "enum": [ "global" ] } } } } } }, { "if": { "properties": { "ctsAuthList": { "type": "object", "properties": { "optionType": { "type": "string", "enum": [ "default" ] } } } } }, "then": { "properties": { "radiusTrustsecGroup": { "type": "object", "properties": { "optionType": { "type": "string", "enum": [ "default" ] } } } } } } ], "additionalProperties": false } }, "required": [ "name", "data" ], "x-metadata": { "supportedDeviceTypes": [ "asr", "c1100", "c8000be", "csr1000v", "ir8100", "ir8340", "isr", "ISRv", "ir1101" ], "minVManageVersion": "20.18.1" }, "additionalProperties": false }, "$$ref": "#/components/examples/ProfileparcelSdwanSystemAaaPutRequest_ResolvedSchema" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Feature Profile > System > Aaa-read" } }, "/v1/feature-profile/sdwan/system/banner/schema": { "get": { "tags": [ "Configuration - Feature Profile (SDWAN)" ], "description": "Get a SDWAN System Banner Parcel Schema by Schema Type", "operationId": "GetSdwanSystemBannerParcelSchemaBySchemaType", "parameters": [ { "name": "schemaType", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "post", "put" ] } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "post": { "value": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[^&<>! \"]+$", "minLength": 1, "maxLength": 128 }, "description": { "type": "string" }, "data": { "type": "object", "properties": { "login": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string", "minLength": 1, "maxLength": 2048 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "string", "enum": [ "" ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "motd": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string", "minLength": 1, "maxLength": 2048 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "string", "enum": [ "" ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] } }, "required": [ "login", "motd" ], "additionalProperties": false } }, "required": [ "name", "data" ], "x-metadata": { "supportedDeviceTypes": [ "asr", "c1100", "c8000be", "csr1000v", "ir8100", "ir8340", "isr", "ISRv", "ir1101", "autonomous-all" ], "minVManageVersion": "20.15.1" }, "additionalProperties": false }, "$$ref": "#/components/examples/ProfileparcelSdwanSystemBannerPostRequest_ResolvedSchema" }, "put": { "value": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[^&<>! \"]+$", "minLength": 1, "maxLength": 128 }, "description": { "type": "string" }, "data": { "type": "object", "properties": { "login": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string", "minLength": 1, "maxLength": 2048 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "string", "enum": [ "" ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "motd": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string", "minLength": 1, "maxLength": 2048 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "string", "enum": [ "" ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] } }, "required": [ "login", "motd" ], "additionalProperties": false } }, "required": [ "name", "data" ], "x-metadata": { "supportedDeviceTypes": [ "asr", "c1100", "c8000be", "csr1000v", "ir8100", "ir8340", "isr", "ISRv", "ir1101" ], "minVManageVersion": "20.15.1" }, "additionalProperties": false }, "$$ref": "#/components/examples/ProfileparcelSdwanSystemBannerPutRequest_ResolvedSchema" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Feature Profile > System > Banner-read" } }, "/v1/feature-profile/sdwan/system/basic/schema": { "get": { "tags": [ "Configuration - Feature Profile (SDWAN)" ], "description": "Get a SDWAN System Basic Feature Schema by Schema Type", "operationId": "GetSdwanSystemBasicFeatureSchemaBySchemaType", "parameters": [ { "name": "schemaType", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "post", "put" ] } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "post": { "value": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[^&<>! \"]+$", "minLength": 1, "maxLength": 128 }, "description": { "description": "Set the feature description", "type": "string" }, "data": { "type": "object", "properties": { "clock": { "type": "object", "properties": { "timezone": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string", "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" ] } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "string", "enum": [ "UTC" ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] } }, "required": [ "timezone" ] }, "description": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string", "minLength": 1, "maxLength": 32 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] } }, "required": [ "optionType" ], "additionalProperties": false } ] }, "location": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] } }, "required": [ "optionType" ], "additionalProperties": false } ] }, "gpsLocation": { "type": "object", "properties": { "longitude": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "number", "maximum": 180, "minimum": -180, "multipleOf": 1e-06 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] } }, "required": [ "optionType" ], "additionalProperties": false } ] }, "latitude": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "number", "maximum": 90, "minimum": -90, "multipleOf": 1e-06 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] } }, "required": [ "optionType" ], "additionalProperties": false } ] }, "geoFencing": { "type": "object", "properties": { "enable": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ false ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "range": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "default": 100, "minimum": 100, "maximum": 10000, "type": "integer" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "integer", "minimum": 100, "maximum": 100 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "sms": { "type": "object", "properties": { "enable": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ false ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "mobileNumber": { "description": "Set device\u2019s geo fencing SMS phone number", "type": "array", "uniqueItems": true, "items": { "type": "object", "properties": { "number": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "minLength": 7, "type": "string", "maxLength": 20, "pattern": "[+][0-9]*" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] } }, "required": [ "number" ] } } } } } } }, "required": [ "longitude", "latitude" ] }, "ppl": { "type": "object", "properties": { "enable": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ false ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "localColors": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "array", "uniqueItems": true, "minItems": 1, "maxItems": 100, "items": { "type": "string", "enum": [ "3g", "biz-internet", "blue", "bronze", "custom1", "custom2", "custom3", "default", "gold", "green", "lte", "metro-ethernet", "mpls", "private1", "private2", "private3", "private4", "private5", "private6", "public-internet", "red", "silver" ], "default": "3g" } } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "string", "enum": [ "all" ], "default": "all" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "flowSplitting": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string", "enum": [ "Packets", "Packet Gap" ], "default": "Packets" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "string", "enum": [ "Packets" ], "default": "Packets" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "flowSplitMaxDuration": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "default": 1, "minimum": 1, "maximum": 100, "type": "integer" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "flowSplitMaxPkts": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "default": 1024, "minimum": 1024, "maximum": 10240, "type": "integer" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "flowSplitMaxSize": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "default": 10, "minimum": 10, "maximum": 1024, "type": "integer" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "flowSplitPacketGapAdaptive": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean", "enum": [ true, false ], "default": true } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "flowSplitPacketGapDuration": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "default": 1, "minimum": 1, "maximum": 100, "type": "integer" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "ctg": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string", "enum": [ "All tunnels", "Latency Offset", "Adaptive cluster" ], "default": "All tunnels" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "string", "enum": [ "All tunnels" ], "default": "All tunnels" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "ctgLatencyOffset": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "default": 10, "minimum": 1, "maximum": 100, "type": "integer" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "reordering": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ false ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] } }, "required": [ "enable", "reordering" ] }, "deviceGroups": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "items": { "type": "string", "minLength": 1 }, "additionalProperties": false, "uniqueItems": true, "type": "array" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] } }, "required": [ "optionType" ], "additionalProperties": false } ] }, "controllerGroupList": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "items": { "type": "integer", "minimum": 1, "maximum": 100 }, "additionalProperties": false, "uniqueItems": true, "type": "array" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] } }, "required": [ "optionType" ], "additionalProperties": false } ] }, "overlayId": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "default": 1, "maximum": 4294967295, "minimum": 1, "type": "integer" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "maximum": 1, "minimum": 1, "type": "integer" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "portOffset": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "default": 0, "maximum": 19, "minimum": 0, "type": "integer" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "maximum": 0, "minimum": 0, "type": "integer" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "portHop": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ true ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "controlSessionPps": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "default": 300, "maximum": 65535, "minimum": 1, "type": "integer" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "maximum": 300, "minimum": 300, "type": "integer" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "trackTransport": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ true ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "trackInterfaceTag": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "maximum": 4294967295, "minimum": 1, "type": "integer" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] } }, "required": [ "optionType" ], "additionalProperties": false } ] }, "consoleBaudRate": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "default": "9600", "enum": [ "1200", "2400", "4800", "9600", "19200", "38400", "57600", "115200" ], "type": "string" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "string", "enum": [ "9600" ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "maxOmpSessions": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "maximum": 100, "minimum": 1, "type": "integer" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] } }, "required": [ "optionType" ], "additionalProperties": false } ] }, "multiTenant": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ false ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "trackDefaultGateway": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ true ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "trackerDiaStabilizeStatus": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ false ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "adminTechOnFailure": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ true ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "idleTimeout": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "maximum": 300, "minimum": 0, "type": "integer" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] } }, "required": [ "optionType" ], "additionalProperties": false } ] }, "onDemand": { "type": "object", "properties": { "onDemandEnable": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ false ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "onDemandIdleTimeout": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "default": 10, "maximum": 65535, "minimum": 1, "type": "integer" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "maximum": 10, "minimum": 10, "type": "integer" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] } }, "required": [ "onDemandEnable", "onDemandIdleTimeout" ] }, "transportGateway": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ false ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "epfr": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string", "enum": [ "disabled", "aggressive", "moderate", "conservative" ], "default": "disabled" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "string", "enum": [ "disabled" ] } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "siteType": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "array", "uniqueItems": true, "minItems": 1, "maxItems": 4, "items": { "type": "string", "enum": [ "type-1", "type-2", "type-3", "cloud", "branch", "br", "spoke" ] } } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] } }, "required": [ "optionType" ], "additionalProperties": false } ] }, "affinityGroupNumber": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "maximum": 63, "minimum": 1, "type": "integer" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] } }, "required": [ "optionType" ], "additionalProperties": false } ] }, "affinityGroupPreference": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "array", "uniqueItems": true, "minItems": 1, "maxItems": 12, "items": { "maximum": 63, "minimum": 1, "type": "integer" } } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] } }, "required": [ "optionType" ], "additionalProperties": false } ] }, "affinityPreferenceAuto": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ false ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "affinityPerVrf": { "description": "Affinity Group Number for VRFs", "type": "array", "uniqueItems": true, "minItems": 0, "maxItems": 4, "items": { "type": "object", "properties": { "affinityGroupNumber": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "maximum": 63, "minimum": 1, "type": "integer" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] } }, "required": [ "optionType" ], "additionalProperties": false } ] }, "vrfRange": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "minLength": 1, "maxLength": 11, "type": "string", "oneOf": [ { "pattern": "^([1-9]|[1-9][0-9]{1,3}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[01])$" }, { "pattern": "^(([1-9]|[1-9][0-9]{1,3}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[01])-([1-9]|[1-9][0-9]{1,3}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[01]))$" } ] } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] } }, "required": [ "optionType" ], "additionalProperties": false } ] } }, "required": [], "additionalProperties": false } } }, "required": [ "clock", "description", "location", "gpsLocation", "deviceGroups", "overlayId", "portOffset", "portHop", "consoleBaudRate", "maxOmpSessions", "adminTechOnFailure", "onDemand" ], "additionalProperties": false } }, "required": [ "name", "data" ], "x-metadata": { "supportedDeviceTypes": [ "asr", "c1100", "c8000be", "csr1000v", "ir8100", "ir8340", "isr", "ISRv", "ir1101" ], "minVManageVersion": "26.1.1" }, "additionalProperties": false }, "$$ref": "#/components/examples/ProfileparcelSdwanSystemBasicPostRequest_ResolvedSchema" }, "put": { "value": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[^&<>! \"]+$", "minLength": 1, "maxLength": 128 }, "description": { "description": "Set the feature description", "type": "string" }, "data": { "type": "object", "properties": { "clock": { "type": "object", "properties": { "timezone": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string", "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" ] } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "string", "enum": [ "UTC" ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] } }, "required": [ "timezone" ] }, "description": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string", "minLength": 1, "maxLength": 32 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] } }, "required": [ "optionType" ], "additionalProperties": false } ] }, "location": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] } }, "required": [ "optionType" ], "additionalProperties": false } ] }, "gpsLocation": { "type": "object", "properties": { "longitude": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "number", "maximum": 180, "minimum": -180, "multipleOf": 1e-06 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] } }, "required": [ "optionType" ], "additionalProperties": false } ] }, "latitude": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "number", "maximum": 90, "minimum": -90, "multipleOf": 1e-06 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] } }, "required": [ "optionType" ], "additionalProperties": false } ] }, "geoFencing": { "type": "object", "properties": { "enable": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ false ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "range": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "default": 100, "minimum": 100, "maximum": 10000, "type": "integer" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "integer", "minimum": 100, "maximum": 100 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "sms": { "type": "object", "properties": { "enable": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ false ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "mobileNumber": { "description": "Set device\u2019s geo fencing SMS phone number", "type": "array", "uniqueItems": true, "items": { "type": "object", "properties": { "number": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "minLength": 7, "type": "string", "maxLength": 20, "pattern": "[+][0-9]*" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] } }, "required": [ "number" ] } } } } } } }, "required": [ "longitude", "latitude" ] }, "ppl": { "type": "object", "properties": { "enable": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ false ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "localColors": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "array", "uniqueItems": true, "minItems": 1, "maxItems": 100, "items": { "type": "string", "enum": [ "3g", "biz-internet", "blue", "bronze", "custom1", "custom2", "custom3", "default", "gold", "green", "lte", "metro-ethernet", "mpls", "private1", "private2", "private3", "private4", "private5", "private6", "public-internet", "red", "silver" ], "default": "3g" } } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "string", "enum": [ "all" ], "default": "all" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "flowSplitting": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string", "enum": [ "Packets", "Packet Gap" ], "default": "Packets" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "string", "enum": [ "Packets" ], "default": "Packets" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "flowSplitMaxDuration": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "default": 1, "minimum": 1, "maximum": 100, "type": "integer" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "flowSplitMaxPkts": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "default": 1024, "minimum": 1024, "maximum": 10240, "type": "integer" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "flowSplitMaxSize": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "default": 10, "minimum": 10, "maximum": 1024, "type": "integer" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "flowSplitPacketGapAdaptive": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean", "enum": [ true, false ], "default": true } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "flowSplitPacketGapDuration": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "default": 1, "minimum": 1, "maximum": 100, "type": "integer" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "ctg": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string", "enum": [ "All tunnels", "Latency Offset", "Adaptive cluster" ], "default": "All tunnels" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "string", "enum": [ "All tunnels" ], "default": "All tunnels" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "ctgLatencyOffset": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "default": 10, "minimum": 1, "maximum": 100, "type": "integer" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "reordering": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ false ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] } }, "required": [ "enable", "reordering" ] }, "deviceGroups": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "items": { "type": "string", "minLength": 1 }, "additionalProperties": false, "uniqueItems": true, "type": "array" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] } }, "required": [ "optionType" ], "additionalProperties": false } ] }, "controllerGroupList": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "items": { "type": "integer", "minimum": 1, "maximum": 100 }, "additionalProperties": false, "uniqueItems": true, "type": "array" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] } }, "required": [ "optionType" ], "additionalProperties": false } ] }, "overlayId": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "default": 1, "maximum": 4294967295, "minimum": 1, "type": "integer" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "maximum": 1, "minimum": 1, "type": "integer" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "portOffset": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "default": 0, "maximum": 19, "minimum": 0, "type": "integer" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "maximum": 0, "minimum": 0, "type": "integer" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "portHop": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ true ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "controlSessionPps": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "default": 300, "maximum": 65535, "minimum": 1, "type": "integer" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "maximum": 300, "minimum": 300, "type": "integer" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "trackTransport": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ true ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "trackInterfaceTag": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "maximum": 4294967295, "minimum": 1, "type": "integer" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] } }, "required": [ "optionType" ], "additionalProperties": false } ] }, "consoleBaudRate": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "default": "9600", "enum": [ "1200", "2400", "4800", "9600", "19200", "38400", "57600", "115200" ], "type": "string" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "string", "enum": [ "9600" ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "maxOmpSessions": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "maximum": 100, "minimum": 1, "type": "integer" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] } }, "required": [ "optionType" ], "additionalProperties": false } ] }, "multiTenant": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ false ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "trackDefaultGateway": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ true ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "trackerDiaStabilizeStatus": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ false ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "adminTechOnFailure": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ true ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "idleTimeout": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "maximum": 300, "minimum": 0, "type": "integer" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] } }, "required": [ "optionType" ], "additionalProperties": false } ] }, "onDemand": { "type": "object", "properties": { "onDemandEnable": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ false ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "onDemandIdleTimeout": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "default": 10, "maximum": 65535, "minimum": 1, "type": "integer" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "maximum": 10, "minimum": 10, "type": "integer" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] } }, "required": [ "onDemandEnable", "onDemandIdleTimeout" ] }, "transportGateway": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ false ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "epfr": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string", "enum": [ "disabled", "aggressive", "moderate", "conservative" ], "default": "disabled" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "string", "enum": [ "disabled" ] } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "siteType": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "array", "uniqueItems": true, "minItems": 1, "maxItems": 4, "items": { "type": "string", "enum": [ "type-1", "type-2", "type-3", "cloud", "branch", "br", "spoke" ] } } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] } }, "required": [ "optionType" ], "additionalProperties": false } ] }, "affinityGroupNumber": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "maximum": 63, "minimum": 1, "type": "integer" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] } }, "required": [ "optionType" ], "additionalProperties": false } ] }, "affinityGroupPreference": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "array", "uniqueItems": true, "minItems": 1, "maxItems": 12, "items": { "maximum": 63, "minimum": 1, "type": "integer" } } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] } }, "required": [ "optionType" ], "additionalProperties": false } ] }, "affinityPreferenceAuto": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ false ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "affinityPerVrf": { "description": "Affinity Group Number for VRFs", "type": "array", "uniqueItems": true, "minItems": 0, "maxItems": 4, "items": { "type": "object", "properties": { "affinityGroupNumber": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "maximum": 63, "minimum": 1, "type": "integer" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] } }, "required": [ "optionType" ], "additionalProperties": false } ] }, "vrfRange": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "minLength": 1, "maxLength": 11, "type": "string", "oneOf": [ { "pattern": "^([1-9]|[1-9][0-9]{1,3}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[01])$" }, { "pattern": "^(([1-9]|[1-9][0-9]{1,3}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[01])-([1-9]|[1-9][0-9]{1,3}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[01]))$" } ] } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] } }, "required": [ "optionType" ], "additionalProperties": false } ] } }, "required": [], "additionalProperties": false } } }, "required": [ "clock", "description", "location", "gpsLocation", "deviceGroups", "overlayId", "portOffset", "portHop", "consoleBaudRate", "maxOmpSessions", "adminTechOnFailure", "onDemand" ], "additionalProperties": false } }, "required": [ "name", "data" ], "x-metadata": { "supportedDeviceTypes": [ "asr", "c1100", "c8000be", "csr1000v", "ir8100", "ir8340", "isr", "ISRv", "ir1101" ], "minVManageVersion": "26.1.1" }, "additionalProperties": false }, "$$ref": "#/components/examples/ProfileparcelSdwanSystemBasicPutRequest_ResolvedSchema" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Feature Profile > System > Basic-read" } }, "/v1/feature-profile/sdwan/system/bfd/schema": { "get": { "tags": [ "Configuration - Feature Profile (SDWAN)" ], "description": "Get a SDWAN System Bfd Parcel Schema by Schema Type", "operationId": "GetSdwanSystemBfdParcelSchemaBySchemaType", "parameters": [ { "name": "schemaType", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "post", "put" ] } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "post": { "value": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[^&<>! \"]+$", "minLength": 1, "maxLength": 128 }, "description": { "type": "string" }, "data": { "type": "object", "properties": { "multiplier": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "default": 6, "maximum": 6, "minimum": 1, "type": "number" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "integer", "minimum": 6, "maximum": 6 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "pollInterval": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "default": 600000, "maximum": 4294967295, "minimum": 1, "type": "number" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "integer", "minimum": 600000, "maximum": 600000 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "defaultDscp": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "default": 48, "maximum": 63, "minimum": 0, "type": "number" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "integer", "minimum": 48, "maximum": 48 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "colors": { "description": "Set color that identifies the WAN transport tunnel", "type": "array", "uniqueItems": true, "items": { "type": "object", "properties": { "color": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "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" ], "type": "string" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "helloInterval": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "default": 1000, "maximum": 300000, "minimum": 100, "type": "integer" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "integer", "minimum": 1000, "maximum": 1000 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "multiplier": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "default": 7, "maximum": 60, "minimum": 1, "type": "integer" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "integer", "minimum": 7, "maximum": 7 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "pmtuDiscovery": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ true ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "dscp": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "default": 48, "maximum": 63, "minimum": 0, "type": "integer" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "integer", "minimum": 48, "maximum": 48 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] } }, "additionalProperties": false, "allOf": [ { "if": { "anyOf": [ { "properties": { "color": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "color" ] }, { "properties": { "helloInterval": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "helloInterval" ] }, { "properties": { "multiplier": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "multiplier" ] }, { "properties": { "pmtuDiscovery": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "pmtuDiscovery" ] }, { "properties": { "dscp": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "dscp" ] } ] }, "then": { "required": [ "color", "helloInterval", "multiplier", "pmtuDiscovery", "dscp" ] } } ] } } }, "required": [ "multiplier", "pollInterval", "defaultDscp" ], "additionalProperties": false } }, "required": [ "name", "data" ], "x-metadata": { "supportedDeviceTypes": [ "asr", "c1100", "c8000be", "csr1000v", "ir8100", "ir8340", "isr", "ISRv", "ir1101" ], "minVManageVersion": "20.17.1" }, "additionalProperties": false }, "$$ref": "#/components/examples/ProfileparcelSdwanSystemBfdPostRequest_ResolvedSchema" }, "put": { "value": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[^&<>! \"]+$", "minLength": 1, "maxLength": 128 }, "description": { "type": "string" }, "data": { "type": "object", "properties": { "multiplier": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "default": 6, "maximum": 6, "minimum": 1, "type": "number" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "integer", "minimum": 6, "maximum": 6 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "pollInterval": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "default": 600000, "maximum": 4294967295, "minimum": 1, "type": "number" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "integer", "minimum": 600000, "maximum": 600000 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "defaultDscp": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "default": 48, "maximum": 63, "minimum": 0, "type": "number" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "integer", "minimum": 48, "maximum": 48 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "colors": { "description": "Set color that identifies the WAN transport tunnel", "type": "array", "uniqueItems": true, "items": { "type": "object", "properties": { "color": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "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" ], "type": "string" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "helloInterval": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "default": 1000, "maximum": 300000, "minimum": 100, "type": "integer" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "integer", "minimum": 1000, "maximum": 1000 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "multiplier": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "default": 7, "maximum": 60, "minimum": 1, "type": "integer" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "integer", "minimum": 7, "maximum": 7 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "pmtuDiscovery": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ true ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "dscp": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "default": 48, "maximum": 63, "minimum": 0, "type": "integer" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "integer", "minimum": 48, "maximum": 48 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] } }, "additionalProperties": false, "allOf": [ { "if": { "anyOf": [ { "properties": { "color": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "color" ] }, { "properties": { "helloInterval": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "helloInterval" ] }, { "properties": { "multiplier": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "multiplier" ] }, { "properties": { "pmtuDiscovery": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "pmtuDiscovery" ] }, { "properties": { "dscp": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "dscp" ] } ] }, "then": { "required": [ "color", "helloInterval", "multiplier", "pmtuDiscovery", "dscp" ] } } ] } } }, "required": [ "multiplier", "pollInterval", "defaultDscp" ], "additionalProperties": false } }, "required": [ "name", "data" ], "x-metadata": { "supportedDeviceTypes": [ "asr", "c1100", "c8000be", "csr1000v", "ir8100", "ir8340", "isr", "ISRv", "ir1101" ], "minVManageVersion": "20.17.1" }, "additionalProperties": false }, "$$ref": "#/components/examples/ProfileparcelSdwanSystemBfdPutRequest_ResolvedSchema" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Feature Profile > System > Bfd-read" } }, "/v1/feature-profile/sdwan/system/global/schema": { "get": { "tags": [ "Configuration - Feature Profile (SDWAN)" ], "description": "Get a Cedge System Global Parcel Schema by Schema Type", "operationId": "GetCedgeSystemGlobalParcelSchemaBySchemaType", "parameters": [ { "name": "schemaType", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "post", "put" ] } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "post": { "value": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[^&<>! \"]+$", "minLength": 1, "maxLength": 128 }, "description": { "description": "Set the parcel description", "type": "string" }, "data": { "type": "object", "properties": { "services_global": { "type": "object", "properties": { "services_ip": { "type": "object", "properties": { "servicesGlobalServicesIpHttpServer": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ false ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "servicesGlobalServicesIpHttpsServer": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ false ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "servicesGlobalServicesIpFtpPassive": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ false ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "servicesGlobalServicesIpDomainLookup": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ false ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "servicesGlobalServicesIpArpProxy": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ false ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "servicesGlobalServicesIpRcmd": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ false ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "servicesGlobalServicesIpLineVty": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ false ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "servicesGlobalServicesIpCdp": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ true ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "servicesGlobalServicesIpLldp": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ true ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "servicesGlobalServicesIpSourceIntrf": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string", "pattern": "(ATM|ATM-ACR|AppGigabitEthernet|AppNav-Compress|AppNav-UnCompress|Async|BD-VIF|BDI|CEM|CEM-ACR|Cellular|Dialer|Embedded-Service-Engine|Ethernet|Ethernet-Internal|FastEthernet|FiftyGigabitEthernet|FiveGigabitEthernet|FortyGigabitEthernet|FourHundredGigE|GMPLS|GigabitEthernet|Group-Async|HundredGigE|L2LISP|LISP|Loopback|MFR|Multilink|Port-channel|SM|Serial|Service-Engine|TenGigabitEthernet|Tunnel|TwentyFiveGigE|TwentyFiveGigabitEthernet|TwoGigabitEthernet|TwoHundredGigE|Vif|Virtual-PPP|Virtual-Template|VirtualPortGroup|Vlan|Wlan-GigabitEthernet|nat64|nat66|ntp|nve|ospfv3|overlay|pseudowire|ucse|vasileft|vasiright|vmi)([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]+)", "minLength": 3, "maxLength": 32 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] } }, "required": [ "optionType" ], "additionalProperties": false } ] }, "globalOtherSettingsTcpKeepalivesIn": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ true ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "globalOtherSettingsTcpKeepalivesOut": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ true ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "globalOtherSettingsTcpSmallServers": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ false ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "globalOtherSettingsUdpSmallServers": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ false ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "globalOtherSettingsConsoleLogging": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ true ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "globalOtherSettingsIPSourceRoute": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ false ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "globalOtherSettingsVtyLineLogging": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ false ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "globalOtherSettingsSnmpIfindexPersist": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ true ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "globalOtherSettingsIgnoreBootp": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ true ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "globalOtherSettingsIntfPerMin": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "enum": [ "1", "5" ], "type": "string" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "enum": [ "5" ], "default": "5", "type": "string" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "globalSettingsNat64UdpTimeout": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "default": 300, "minimum": 1, "maximum": 536870, "type": "integer" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "integer", "minimum": 300, "maximum": 300 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "globalSettingsNat64TcpTimeout": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "default": 3600, "minimum": 1, "maximum": 536870, "type": "integer" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "integer", "minimum": 3600, "maximum": 3600 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "globalSettingsHttpAuthentication": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "enum": [ "local", "aaa" ], "type": "string" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] } }, "required": [ "optionType" ], "additionalProperties": false } ] }, "globalSettingsSSHVersion": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "enum": [ "2" ], "type": "string" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] } }, "required": [ "optionType" ], "additionalProperties": false } ] }, "lacpSystemPriority": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "minimum": 1, "maximum": 65535, "type": "integer" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] } }, "required": [ "optionType" ], "additionalProperties": false } ] }, "etherchannelFlowLoadBalance": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "enum": [ "src-ip", "dst-ip", "src-dst-ip", "src-mac", "dst-mac", "src-dst-mac", "src-dst-mixed-ip-port", "sdwan" ], "type": "string", "default": "src-dst-ip" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] } }, "required": [ "optionType" ], "additionalProperties": false } ] }, "etherchannelVlanLoadBalance": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ false ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "bgpCommunityNewFormat": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ false ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] } }, "required": [ "servicesGlobalServicesIpHttpServer", "servicesGlobalServicesIpHttpsServer", "servicesGlobalServicesIpFtpPassive", "servicesGlobalServicesIpDomainLookup", "servicesGlobalServicesIpArpProxy", "servicesGlobalServicesIpRcmd", "servicesGlobalServicesIpLineVty", "servicesGlobalServicesIpCdp", "servicesGlobalServicesIpLldp" ], "additionalProperties": false } }, "required": [ "services_ip" ], "additionalProperties": false } }, "required": [ "services_global" ], "additionalProperties": false } }, "required": [ "name", "data" ], "x-metadata": { "supportedDeviceTypes": [ "asr", "c1100", "c8000be", "csr1000v", "ir8100", "ir8340", "isr", "ISRv", "ir1101", "autonomous-all" ], "minVManageVersion": "26.1.1" }, "additionalProperties": false }, "$$ref": "#/components/examples/ProfileparcelSdwanSystemGlobalPostRequest_ResolvedSchema" }, "put": { "value": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[^&<>! \"]+$", "minLength": 1, "maxLength": 128 }, "description": { "description": "Set the parcel description", "type": "string" }, "data": { "type": "object", "properties": { "services_global": { "type": "object", "properties": { "services_ip": { "type": "object", "properties": { "servicesGlobalServicesIpHttpServer": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ false ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "servicesGlobalServicesIpHttpsServer": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ false ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "servicesGlobalServicesIpFtpPassive": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ false ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "servicesGlobalServicesIpDomainLookup": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ false ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "servicesGlobalServicesIpArpProxy": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ false ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "servicesGlobalServicesIpRcmd": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ false ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "servicesGlobalServicesIpLineVty": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ false ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "servicesGlobalServicesIpCdp": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ true ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "servicesGlobalServicesIpLldp": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ true ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "servicesGlobalServicesIpSourceIntrf": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string", "pattern": "(ATM|ATM-ACR|AppGigabitEthernet|AppNav-Compress|AppNav-UnCompress|Async|BD-VIF|BDI|CEM|CEM-ACR|Cellular|Dialer|Embedded-Service-Engine|Ethernet|Ethernet-Internal|FastEthernet|FiftyGigabitEthernet|FiveGigabitEthernet|FortyGigabitEthernet|FourHundredGigE|GMPLS|GigabitEthernet|Group-Async|HundredGigE|L2LISP|LISP|Loopback|MFR|Multilink|Port-channel|SM|Serial|Service-Engine|TenGigabitEthernet|Tunnel|TwentyFiveGigE|TwentyFiveGigabitEthernet|TwoGigabitEthernet|TwoHundredGigE|Vif|Virtual-PPP|Virtual-Template|VirtualPortGroup|Vlan|Wlan-GigabitEthernet|nat64|nat66|ntp|nve|ospfv3|overlay|pseudowire|ucse|vasileft|vasiright|vmi)([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]+)", "minLength": 3, "maxLength": 32 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] } }, "required": [ "optionType" ], "additionalProperties": false } ] }, "globalOtherSettingsTcpKeepalivesIn": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ true ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "globalOtherSettingsTcpKeepalivesOut": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ true ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "globalOtherSettingsTcpSmallServers": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ false ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "globalOtherSettingsUdpSmallServers": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ false ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "globalOtherSettingsConsoleLogging": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ true ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "globalOtherSettingsIPSourceRoute": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ false ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "globalOtherSettingsVtyLineLogging": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ false ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "globalOtherSettingsSnmpIfindexPersist": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ true ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "globalOtherSettingsIgnoreBootp": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ true ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "globalOtherSettingsIntfPerMin": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "enum": [ "1", "5" ], "type": "string" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "enum": [ "5" ], "default": "5", "type": "string" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "globalSettingsNat64UdpTimeout": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "default": 300, "minimum": 1, "maximum": 536870, "type": "integer" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "integer", "minimum": 300, "maximum": 300 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "globalSettingsNat64TcpTimeout": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "default": 3600, "minimum": 1, "maximum": 536870, "type": "integer" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "integer", "minimum": 3600, "maximum": 3600 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "globalSettingsHttpAuthentication": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "enum": [ "local", "aaa" ], "type": "string" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] } }, "required": [ "optionType" ], "additionalProperties": false } ] }, "globalSettingsSSHVersion": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "enum": [ "2" ], "type": "string" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] } }, "required": [ "optionType" ], "additionalProperties": false } ] }, "lacpSystemPriority": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "minimum": 1, "maximum": 65535, "type": "integer" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] } }, "required": [ "optionType" ], "additionalProperties": false } ] }, "etherchannelFlowLoadBalance": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "enum": [ "src-ip", "dst-ip", "src-dst-ip", "src-mac", "dst-mac", "src-dst-mac", "src-dst-mixed-ip-port", "sdwan" ], "type": "string", "default": "src-dst-ip" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] } }, "required": [ "optionType" ], "additionalProperties": false } ] }, "etherchannelVlanLoadBalance": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ false ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "bgpCommunityNewFormat": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ false ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] } }, "required": [ "servicesGlobalServicesIpHttpServer", "servicesGlobalServicesIpHttpsServer", "servicesGlobalServicesIpFtpPassive", "servicesGlobalServicesIpDomainLookup", "servicesGlobalServicesIpArpProxy", "servicesGlobalServicesIpRcmd", "servicesGlobalServicesIpLineVty", "servicesGlobalServicesIpCdp", "servicesGlobalServicesIpLldp" ], "additionalProperties": false } }, "required": [ "services_ip" ], "additionalProperties": false } }, "required": [ "services_global" ], "additionalProperties": false } }, "required": [ "name", "data" ], "x-metadata": { "supportedDeviceTypes": [ "asr", "c1100", "c8000be", "csr1000v", "ir8100", "ir8340", "isr", "ISRv", "ir1101", "autonomous-all" ], "minVManageVersion": "26.1.1" }, "additionalProperties": false }, "$$ref": "#/components/examples/ProfileparcelSdwanSystemGlobalPutRequest_ResolvedSchema" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Feature Profile > System > Global-read" } }, "/v1/feature-profile/sdwan/system/logging/schema": { "get": { "tags": [ "Configuration - Feature Profile (SDWAN)" ], "description": "Get a SDWAN System Logging Parcel Schema by Schema Type", "operationId": "GetSdwanSystemLoggingParcelSchemaBySchemaType", "parameters": [ { "name": "schemaType", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "post", "put" ] } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "post": { "value": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[^&<>! \"]+$", "minLength": 1, "maxLength": 128 }, "description": { "description": "Set the parcel description", "type": "string" }, "data": { "type": "object", "properties": { "disk": { "type": "object", "properties": { "diskEnable": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ true ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "file": { "type": "object", "properties": { "diskFileSize": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "integer", "minimum": 1, "maximum": 20, "default": 10 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "maximum": 10, "minimum": 10, "type": "integer", "default": 10 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "diskFileRotate": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "integer", "minimum": 1, "maximum": 10, "default": 10 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "maximum": 10, "minimum": 10, "type": "integer", "default": 10 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] } }, "required": [ "diskFileSize", "diskFileRotate" ], "additionalProperties": false } }, "required": [ "file" ], "additionalProperties": false }, "tlsProfile": { "description": "Configure a TLS profile", "uniqueItems": true, "type": "array", "additionalProperties": false, "items": { "type": "object", "properties": { "profile": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string", "minLength": 1, "maxLength": 30 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "tlsVersion": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string", "enum": [ "TLSv1.1", "TLSv1.2" ], "default": "TLSv1.1", "x-attributeMetadata": { "insecureConfiguration": { "attributeJsonPath": "$.data.tlsProfile[*].tlsVersion", "values": [ "TLSv1.1" ], "description": "Logging TLS profile configured with TLS version 1.1 - deprecated and vulnerable to attacks", "reason": "Weak tls version", "remediation": "Use stronger tls version to enhance security" } } } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "string", "enum": [ "TLSv1.1" ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "authType": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "string", "enum": [ "Server" ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "cipherSuiteList": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "array", "items": { "uniqueItems": true, "type": "string", "additionalProperties": false, "enum": [ "aes-128-cbc-sha", "aes-256-cbc-sha", "dhe-aes-cbc-sha2", "dhe-aes-gcm-sha2", "ecdhe-ecdsa-aes-gcm-sha2", "ecdhe-rsa-aes-cbc-sha2", "ecdhe-rsa-aes-gcm-sha2", "rsa-aes-cbc-sha2", "rsa-aes-gcm-sha2" ] }, "x-attributeMetadata": { "insecureConfiguration": { "attributeJsonPath": "$.data.tlsProfile[*].cipherSuiteList[*]", "values": [ "aes-128-cbc-sha", "aes-256-cbc-sha" ], "description": "Logging TLS profile configured with weak cipher suite using CBC mode and SHA-1", "reason": "Weak cipher(s) are present in the command", "remediation": "Use stronger cipher(s) to enhance security" } } } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] } }, "required": [ "optionType" ], "additionalProperties": false } ] } }, "required": [ "profile", "authType" ], "additionalProperties": false } }, "server": { "description": "Enable logging to remote server", "uniqueItems": true, "type": "array", "additionalProperties": false, "items": { "type": "object", "properties": { "name": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "pattern": "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}$" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "vpn": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "integer", "minimum": 0, "maximum": 65530 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "integer", "minimum": 0, "maximum": 0, "default": 0 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "sourceInterface": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string", "minLength": 1 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] } }, "required": [ "optionType" ], "additionalProperties": false } ] }, "priority": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string", "enum": [ "informational", "debugging", "notice", "warn", "error", "critical", "alert", "emergency" ], "default": "informational" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "string", "enum": [ "informational" ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "tlsEnable": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ false ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "tlsPropertiesCustomProfile": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ false ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "tlsPropertiesProfile": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string", "minLength": 1 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] } }, "required": [ "optionType" ], "additionalProperties": false } ] } }, "additionalProperties": false, "allOf": [ { "if": { "anyOf": [ { "properties": { "name": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "name" ] }, { "properties": { "vpn": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "vpn" ] }, { "properties": { "priority": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "priority" ] }, { "properties": { "tlsEnable": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "tlsEnable" ] } ] }, "then": { "required": [ "name", "vpn", "priority", "tlsEnable" ] } } ] } }, "ipv6Server": { "description": "Enable logging to remote ipv6 server", "uniqueItems": true, "additionalProperties": false, "type": "array", "items": { "type": "object", "properties": { "name": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string", "format": "ipv6" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "vpn": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "integer", "minimum": 0, "maximum": 65530 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "integer", "minimum": 0, "maximum": 0, "default": 0 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "sourceInterface": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string", "minLength": 1 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] } }, "required": [ "optionType" ], "additionalProperties": false } ] }, "priority": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string", "enum": [ "informational", "debugging", "notice", "warn", "error", "critical", "alert", "emergency" ], "default": "informational" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "string", "enum": [ "informational" ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "tlsEnable": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ false ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "tlsPropertiesCustomProfile": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ false ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "tlsPropertiesProfile": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string", "minLength": 1 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] } }, "required": [ "optionType" ], "additionalProperties": false } ] } }, "additionalProperties": false, "allOf": [ { "if": { "anyOf": [ { "properties": { "name": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "name" ] }, { "properties": { "vpn": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "vpn" ] }, { "properties": { "priority": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "priority" ] }, { "properties": { "tlsEnable": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "tlsEnable" ] } ] }, "then": { "required": [ "name", "vpn", "priority", "tlsEnable" ] } } ] } } }, "required": [ "disk" ], "additionalProperties": false } }, "required": [ "name", "data" ], "x-metadata": { "supportedDeviceTypes": [ "asr", "c1100", "c8000be", "csr1000v", "ir8100", "ir8340", "isr", "ISRv", "ir1101" ], "minVManageVersion": "20.18.1" }, "additionalProperties": false }, "$$ref": "#/components/examples/ProfileparcelSdwanSystemLoggingPostRequest_ResolvedSchema" }, "put": { "value": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[^&<>! \"]+$", "minLength": 1, "maxLength": 128 }, "description": { "description": "Set the parcel description", "type": "string" }, "data": { "type": "object", "properties": { "disk": { "type": "object", "properties": { "diskEnable": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ true ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "file": { "type": "object", "properties": { "diskFileSize": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "integer", "minimum": 1, "maximum": 20, "default": 10 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "maximum": 10, "minimum": 10, "type": "integer", "default": 10 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "diskFileRotate": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "integer", "minimum": 1, "maximum": 10, "default": 10 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "maximum": 10, "minimum": 10, "type": "integer", "default": 10 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] } }, "required": [ "diskFileSize", "diskFileRotate" ], "additionalProperties": false } }, "required": [ "file" ], "additionalProperties": false }, "tlsProfile": { "description": "Configure a TLS profile", "uniqueItems": true, "type": "array", "additionalProperties": false, "items": { "type": "object", "properties": { "profile": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string", "minLength": 1, "maxLength": 30 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "tlsVersion": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string", "enum": [ "TLSv1.1", "TLSv1.2" ], "default": "TLSv1.1", "x-attributeMetadata": { "insecureConfiguration": { "attributeJsonPath": "$.data.tlsProfile[*].tlsVersion", "values": [ "TLSv1.1" ], "description": "Logging TLS profile configured with TLS version 1.1 - deprecated and vulnerable to attacks", "reason": "Weak tls version", "remediation": "Use stronger tls version to enhance security" } } } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "string", "enum": [ "TLSv1.1" ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "authType": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "string", "enum": [ "Server" ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "cipherSuiteList": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "array", "items": { "uniqueItems": true, "type": "string", "additionalProperties": false, "enum": [ "aes-128-cbc-sha", "aes-256-cbc-sha", "dhe-aes-cbc-sha2", "dhe-aes-gcm-sha2", "ecdhe-ecdsa-aes-gcm-sha2", "ecdhe-rsa-aes-cbc-sha2", "ecdhe-rsa-aes-gcm-sha2", "rsa-aes-cbc-sha2", "rsa-aes-gcm-sha2" ] }, "x-attributeMetadata": { "insecureConfiguration": { "attributeJsonPath": "$.data.tlsProfile[*].cipherSuiteList[*]", "values": [ "aes-128-cbc-sha", "aes-256-cbc-sha" ], "description": "Logging TLS profile configured with weak cipher suite using CBC mode and SHA-1", "reason": "Weak cipher(s) are present in the command", "remediation": "Use stronger cipher(s) to enhance security" } } } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] } }, "required": [ "optionType" ], "additionalProperties": false } ] } }, "required": [ "profile", "authType" ], "additionalProperties": false } }, "server": { "description": "Enable logging to remote server", "uniqueItems": true, "type": "array", "additionalProperties": false, "items": { "type": "object", "properties": { "name": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "pattern": "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}$" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "vpn": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "integer", "minimum": 0, "maximum": 65530 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "integer", "minimum": 0, "maximum": 0, "default": 0 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "sourceInterface": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string", "minLength": 1 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] } }, "required": [ "optionType" ], "additionalProperties": false } ] }, "priority": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string", "enum": [ "informational", "debugging", "notice", "warn", "error", "critical", "alert", "emergency" ], "default": "informational" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "string", "enum": [ "informational" ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "tlsEnable": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ false ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "tlsPropertiesCustomProfile": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ false ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "tlsPropertiesProfile": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string", "minLength": 1 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] } }, "required": [ "optionType" ], "additionalProperties": false } ] } }, "additionalProperties": false, "allOf": [ { "if": { "anyOf": [ { "properties": { "name": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "name" ] }, { "properties": { "vpn": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "vpn" ] }, { "properties": { "priority": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "priority" ] }, { "properties": { "tlsEnable": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "tlsEnable" ] } ] }, "then": { "required": [ "name", "vpn", "priority", "tlsEnable" ] } } ] } }, "ipv6Server": { "description": "Enable logging to remote ipv6 server", "uniqueItems": true, "additionalProperties": false, "type": "array", "items": { "type": "object", "properties": { "name": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string", "format": "ipv6" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "vpn": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "integer", "minimum": 0, "maximum": 65530 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "integer", "minimum": 0, "maximum": 0, "default": 0 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "sourceInterface": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string", "minLength": 1 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] } }, "required": [ "optionType" ], "additionalProperties": false } ] }, "priority": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string", "enum": [ "informational", "debugging", "notice", "warn", "error", "critical", "alert", "emergency" ], "default": "informational" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "string", "enum": [ "informational" ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "tlsEnable": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ false ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "tlsPropertiesCustomProfile": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ false ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "tlsPropertiesProfile": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string", "minLength": 1 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] } }, "required": [ "optionType" ], "additionalProperties": false } ] } }, "additionalProperties": false, "allOf": [ { "if": { "anyOf": [ { "properties": { "name": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "name" ] }, { "properties": { "vpn": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "vpn" ] }, { "properties": { "priority": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "priority" ] }, { "properties": { "tlsEnable": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "tlsEnable" ] } ] }, "then": { "required": [ "name", "vpn", "priority", "tlsEnable" ] } } ] } } }, "required": [ "disk" ], "additionalProperties": false } }, "required": [ "name", "data" ], "x-metadata": { "supportedDeviceTypes": [ "asr", "c1100", "c8000be", "csr1000v", "ir8100", "ir8340", "isr", "ISRv", "ir1101" ], "minVManageVersion": "20.18.1" }, "additionalProperties": false }, "$$ref": "#/components/examples/ProfileparcelSdwanSystemLoggingPutRequest_ResolvedSchema" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Feature Profile > System > Logging-read" } }, "/v1/feature-profile/sdwan/system/mrf/schema": { "get": { "tags": [ "Configuration - Feature Profile (SDWAN)" ], "description": "Get a Cedge System Mrf Parcel Schema by Schema Type", "operationId": "GetCedgeSystemMrfParcelSchemaBySchemaType", "parameters": [ { "name": "schemaType", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "post", "put" ] } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "post": { "value": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[^&<>! \"]+$", "minLength": 1, "maxLength": 128 }, "description": { "type": "string" }, "data": { "type": "object", "properties": { "secondaryRegion": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "minimum": 1, "maximum": 63, "type": "integer" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] } }, "required": [ "optionType" ], "additionalProperties": false } ] }, "role": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "enum": [ "edge-router", "border-router" ], "type": "string" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] } }, "required": [ "optionType" ], "additionalProperties": false } ] }, "enableMrfMigration": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "enum": [ "enabled", "enabled-from-bgp-core" ], "type": "string" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] } }, "required": [ "optionType" ], "additionalProperties": false } ] }, "migrationBgpCommunity": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "minimum": 1, "maximum": 4294967295, "type": "integer" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] } }, "required": [ "optionType" ], "additionalProperties": false } ] }, "enableManagementRegion": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ false ] } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "managementRegion": { "description": "Management Region", "type": "object", "properties": { "vrfId": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "minimum": 1, "maximum": 65531, "type": "integer" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] } }, "required": [ "optionType" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "gatewayPreference": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "items": { "minimum": 1, "maximum": 63, "type": "integer" }, "minItems": 1, "maxItems": 8, "uniqueItems": true, "type": "array" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] } }, "required": [ "optionType" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "managementGateway": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ false ] } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] } }, "required": [], "additionalProperties": false } }, "required": [], "additionalProperties": false } }, "required": [ "name", "data" ], "x-metadata": { "minVManageVersion": "20.15.1" }, "additionalProperties": false }, "$$ref": "#/components/examples/ProfileparcelSdwanSystemMrfCommonRequest_ResolvedSchema" }, "put": { "value": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[^&<>! \"]+$", "minLength": 1, "maxLength": 128 }, "description": { "type": "string" }, "data": { "type": "object", "properties": { "secondaryRegion": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "minimum": 1, "maximum": 63, "type": "integer" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] } }, "required": [ "optionType" ], "additionalProperties": false } ] }, "role": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "enum": [ "edge-router", "border-router" ], "type": "string" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] } }, "required": [ "optionType" ], "additionalProperties": false } ] }, "enableMrfMigration": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "enum": [ "enabled", "enabled-from-bgp-core" ], "type": "string" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] } }, "required": [ "optionType" ], "additionalProperties": false } ] }, "migrationBgpCommunity": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "minimum": 1, "maximum": 4294967295, "type": "integer" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] } }, "required": [ "optionType" ], "additionalProperties": false } ] }, "enableManagementRegion": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ false ] } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "managementRegion": { "description": "Management Region", "type": "object", "properties": { "vrfId": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "minimum": 1, "maximum": 65531, "type": "integer" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] } }, "required": [ "optionType" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "gatewayPreference": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "items": { "minimum": 1, "maximum": 63, "type": "integer" }, "minItems": 1, "maxItems": 8, "uniqueItems": true, "type": "array" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] } }, "required": [ "optionType" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "managementGateway": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ false ] } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] } }, "required": [], "additionalProperties": false } }, "required": [], "additionalProperties": false } }, "required": [ "name", "data" ], "x-metadata": { "minVManageVersion": "20.15.1" }, "additionalProperties": false }, "$$ref": "#/components/examples/ProfileparcelSdwanSystemMrfCommonRequest_ResolvedSchema" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Feature Profile > System > Mrf-read" } }, "/v1/feature-profile/sdwan/system/ntp/schema": { "get": { "tags": [ "Configuration - Feature Profile (SDWAN)" ], "description": "Get a SDWAN System Ntp Parcel Schema by Schema Type", "operationId": "GetSdwanSystemNtpParcelSchemaBySchemaType", "parameters": [ { "name": "schemaType", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "post", "put" ] } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "post": { "value": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[^&<>! \"]+$", "minLength": 1, "maxLength": 128 }, "description": { "description": "Set the parcel description", "type": "string" }, "data": { "type": "object", "properties": { "server": { "description": "Configure NTP servers", "type": "array", "uniqueItems": true, "additionalProperties": false, "items": { "type": "object", "properties": { "name": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "oneOf": [ { "type": "string", "format": "ipv6" }, { "type": "string", "format": "hostname" } ] } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] } }, "required": [ "optionType" ], "additionalProperties": false } ] }, "key": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "integer", "minimum": 1, "maximum": 4294967295 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] } }, "required": [ "optionType" ], "additionalProperties": false } ] }, "vpn": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "integer", "default": 0, "minimum": 0, "maximum": 65530 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "integer", "minimum": 0, "maximum": 0 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "version": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "integer", "default": 4, "minimum": 1, "maximum": 4 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "integer", "minimum": 4, "maximum": 4 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "sourceInterface": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string", "pattern": "(ATM|ATM-ACR|AppGigabitEthernet|AppNav-Compress|AppNav-UnCompress|Async|BD-VIF|BDI|CEM|CEM-ACR|Cellular|Dialer|Embedded-Service-Engine|Ethernet|Ethernet-Internal|FastEthernet|FiftyGigabitEthernet|FiveGigabitEthernet|FortyGigabitEthernet|FourHundredGigE|GMPLS|GigabitEthernet|Group-Async|HundredGigE|L2LISP|LISP|Loopback|MFR|Multilink|Port-channel|SM|Serial|Service-Engine|TenGigabitEthernet|Tunnel|TwentyFiveGigE|TwentyFiveGigabitEthernet|TwoGigabitEthernet|TwoHundredGigE|Vif|Virtual-PPP|Virtual-Template|VirtualPortGroup|Vlan|Wlan-GigabitEthernet|nat64|nat66|ntp|nve|ospfv3|overlay|pseudowire|ucse|vasileft|vasiright|vmi)([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]+)", "minLength": 3, "maxLength": 32 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] } }, "required": [ "optionType" ], "additionalProperties": false } ] }, "prefer": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ false ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] } }, "additionalProperties": false, "allOf": [ { "if": { "anyOf": [ { "properties": { "name": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "name" ] }, { "properties": { "vpn": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "vpn" ] }, { "properties": { "version": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "version" ] }, { "properties": { "prefer": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "prefer" ] } ] }, "then": { "required": [ "name", "vpn", "version", "prefer" ] } } ] } }, "authentication": { "type": "object", "properties": { "authenticationKeys": { "description": "Set MD5 authentication key", "type": "array", "uniqueItems": true, "additionalProperties": false, "items": { "type": "object", "properties": { "keyId": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "integer", "minimum": 1, "maximum": 4294967295 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "md5Value": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string", "minLength": 1, "x-attributeMetadata": { "insecureConfiguration": { "attributeJsonPath": "$.data.authentication.authenticationKeys[*].md5Value", "description": "NTP authentication using MD5 - vulnerable to collision attacks and should use stronger algorithms", "reason": "Configuration employs an Insecure method for password storage", "remediation": "Transition to more secure algorithms like SHA and AES" } } } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "hmacSha2Value": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string", "description": "HMAC-SHA2-256 (digest length = 256 bits, key length = [1-32] bytes)", "pattern": "^\\S{1,32}$" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "cmacAes128Value": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string", "description": "CMAC-AES-128 (digest length = 128 bits, key length = [16 or 32] bytes)", "minLength": 16, "maxLength": 32 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] } }, "additionalProperties": false, "required": [ "keyId" ], "oneOf": [ { "required": [ "md5Value" ], "not": { "anyOf": [ { "required": [ "hmacSha2Value" ] }, { "required": [ "cmacAes128Value" ] } ] } }, { "required": [ "hmacSha2Value" ], "not": { "anyOf": [ { "required": [ "md5Value" ] }, { "required": [ "cmacAes128Value" ] } ] } }, { "required": [ "cmacAes128Value" ], "not": { "anyOf": [ { "required": [ "md5Value" ] }, { "required": [ "hmacSha2Value" ] } ] } } ] } }, "trustedKeys": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "array", "uniqueItems": true, "additionalProperties": false, "items": { "type": "integer", "minimum": 1, "maximum": 65535 } } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] } }, "required": [ "optionType" ], "additionalProperties": false } ] } }, "required": [ "authenticationKeys" ], "additionalProperties": false }, "leader": { "type": "object", "properties": { "enable": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ false ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "stratum": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "integer", "maximum": 15, "minimum": 1 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] } }, "required": [ "optionType" ], "additionalProperties": false } ] }, "source": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string", "pattern": "(ATM|ATM-ACR|AppGigabitEthernet|AppNav-Compress|AppNav-UnCompress|Async|BD-VIF|BDI|CEM|CEM-ACR|Cellular|Dialer|Embedded-Service-Engine|Ethernet|Ethernet-Internal|FastEthernet|FiftyGigabitEthernet|FiveGigabitEthernet|FortyGigabitEthernet|FourHundredGigE|GMPLS|GigabitEthernet|Group-Async|HundredGigE|L2LISP|LISP|Loopback|MFR|Multilink|Port-channel|SM|Serial|Service-Engine|TenGigabitEthernet|Tunnel|TwentyFiveGigE|TwentyFiveGigabitEthernet|TwoGigabitEthernet|TwoHundredGigE|Vif|Virtual-PPP|Virtual-Template|VirtualPortGroup|Vlan|Wlan-GigabitEthernet|nat64|nat66|ntp|nve|ospfv3|overlay|pseudowire|ucse|vasileft|vasiright|vmi)([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]+)", "minLength": 3, "maxLength": 32 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] } }, "required": [ "optionType" ], "additionalProperties": false } ] } } } }, "required": [ "server" ], "additionalProperties": false } }, "required": [ "name", "data" ], "x-metadata": { "supportedDeviceTypes": [ "asr", "c1100", "c8000be", "csr1000v", "ir8100", "ir8340", "isr", "ISRv", "ir1101" ], "minVManageVersion": "26.1.1" }, "additionalProperties": false }, "$$ref": "#/components/examples/ProfileparcelSdwanSystemNtpPostRequest_ResolvedSchema" }, "put": { "value": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[^&<>! \"]+$", "minLength": 1, "maxLength": 128 }, "description": { "description": "Set the parcel description", "type": "string" }, "data": { "type": "object", "properties": { "server": { "description": "Configure NTP servers", "type": "array", "uniqueItems": true, "additionalProperties": false, "items": { "type": "object", "properties": { "name": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "oneOf": [ { "type": "string", "format": "ipv6" }, { "type": "string", "format": "hostname" } ] } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] } }, "required": [ "optionType" ], "additionalProperties": false } ] }, "key": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "integer", "minimum": 1, "maximum": 4294967295 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] } }, "required": [ "optionType" ], "additionalProperties": false } ] }, "vpn": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "integer", "default": 0, "minimum": 0, "maximum": 65530 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "integer", "minimum": 0, "maximum": 0 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "version": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "integer", "default": 4, "minimum": 1, "maximum": 4 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "integer", "minimum": 4, "maximum": 4 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "sourceInterface": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string", "pattern": "(ATM|ATM-ACR|AppGigabitEthernet|AppNav-Compress|AppNav-UnCompress|Async|BD-VIF|BDI|CEM|CEM-ACR|Cellular|Dialer|Embedded-Service-Engine|Ethernet|Ethernet-Internal|FastEthernet|FiftyGigabitEthernet|FiveGigabitEthernet|FortyGigabitEthernet|FourHundredGigE|GMPLS|GigabitEthernet|Group-Async|HundredGigE|L2LISP|LISP|Loopback|MFR|Multilink|Port-channel|SM|Serial|Service-Engine|TenGigabitEthernet|Tunnel|TwentyFiveGigE|TwentyFiveGigabitEthernet|TwoGigabitEthernet|TwoHundredGigE|Vif|Virtual-PPP|Virtual-Template|VirtualPortGroup|Vlan|Wlan-GigabitEthernet|nat64|nat66|ntp|nve|ospfv3|overlay|pseudowire|ucse|vasileft|vasiright|vmi)([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]+)", "minLength": 3, "maxLength": 32 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] } }, "required": [ "optionType" ], "additionalProperties": false } ] }, "prefer": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ false ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] } }, "additionalProperties": false, "allOf": [ { "if": { "anyOf": [ { "properties": { "name": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "name" ] }, { "properties": { "vpn": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "vpn" ] }, { "properties": { "version": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "version" ] }, { "properties": { "prefer": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "prefer" ] } ] }, "then": { "required": [ "name", "vpn", "version", "prefer" ] } } ] } }, "authentication": { "type": "object", "properties": { "authenticationKeys": { "description": "Set MD5 authentication key", "type": "array", "uniqueItems": true, "additionalProperties": false, "items": { "type": "object", "properties": { "keyId": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "integer", "minimum": 1, "maximum": 4294967295 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "md5Value": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string", "minLength": 1, "x-attributeMetadata": { "insecureConfiguration": { "attributeJsonPath": "$.data.authentication.authenticationKeys[*].md5Value", "description": "NTP authentication using MD5 - vulnerable to collision attacks and should use stronger algorithms", "reason": "Configuration employs an Insecure method for password storage", "remediation": "Transition to more secure algorithms like SHA and AES" } } } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "hmacSha2Value": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string", "description": "HMAC-SHA2-256 (digest length = 256 bits, key length = [1-32] bytes)", "pattern": "^\\S{1,32}$" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "cmacAes128Value": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string", "description": "CMAC-AES-128 (digest length = 128 bits, key length = [16 or 32] bytes)", "minLength": 16, "maxLength": 32 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] } }, "additionalProperties": false, "required": [ "keyId" ], "oneOf": [ { "required": [ "md5Value" ], "not": { "anyOf": [ { "required": [ "hmacSha2Value" ] }, { "required": [ "cmacAes128Value" ] } ] } }, { "required": [ "hmacSha2Value" ], "not": { "anyOf": [ { "required": [ "md5Value" ] }, { "required": [ "cmacAes128Value" ] } ] } }, { "required": [ "cmacAes128Value" ], "not": { "anyOf": [ { "required": [ "md5Value" ] }, { "required": [ "hmacSha2Value" ] } ] } } ] } }, "trustedKeys": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "array", "uniqueItems": true, "additionalProperties": false, "items": { "type": "integer", "minimum": 1, "maximum": 65535 } } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] } }, "required": [ "optionType" ], "additionalProperties": false } ] } }, "required": [ "authenticationKeys" ], "additionalProperties": false }, "leader": { "type": "object", "properties": { "enable": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ false ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "stratum": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "integer", "maximum": 15, "minimum": 1 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] } }, "required": [ "optionType" ], "additionalProperties": false } ] }, "source": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string", "pattern": "(ATM|ATM-ACR|AppGigabitEthernet|AppNav-Compress|AppNav-UnCompress|Async|BD-VIF|BDI|CEM|CEM-ACR|Cellular|Dialer|Embedded-Service-Engine|Ethernet|Ethernet-Internal|FastEthernet|FiftyGigabitEthernet|FiveGigabitEthernet|FortyGigabitEthernet|FourHundredGigE|GMPLS|GigabitEthernet|Group-Async|HundredGigE|L2LISP|LISP|Loopback|MFR|Multilink|Port-channel|SM|Serial|Service-Engine|TenGigabitEthernet|Tunnel|TwentyFiveGigE|TwentyFiveGigabitEthernet|TwoGigabitEthernet|TwoHundredGigE|Vif|Virtual-PPP|Virtual-Template|VirtualPortGroup|Vlan|Wlan-GigabitEthernet|nat64|nat66|ntp|nve|ospfv3|overlay|pseudowire|ucse|vasileft|vasiright|vmi)([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]+)", "minLength": 3, "maxLength": 32 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] } }, "required": [ "optionType" ], "additionalProperties": false } ] } } } }, "required": [ "server" ], "additionalProperties": false } }, "required": [ "name", "data" ], "x-metadata": { "supportedDeviceTypes": [ "asr", "c1100", "c8000be", "csr1000v", "ir8100", "ir8340", "isr", "ISRv", "ir1101" ], "minVManageVersion": "26.1.1" }, "additionalProperties": false }, "$$ref": "#/components/examples/ProfileparcelSdwanSystemNtpPutRequest_ResolvedSchema" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Feature Profile > System > Ntp-read" } }, "/v1/feature-profile/sdwan/system/omp/schema": { "get": { "tags": [ "Configuration - Feature Profile (SDWAN)" ], "description": "Get a SDWAN System Omp Parcel Schema by Schema Type", "operationId": "GetSdwanSystemOmpParcelSchemaBySchemaType", "parameters": [ { "name": "schemaType", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "post", "put" ] } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "post": { "value": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[^&<>! \"]+$", "minLength": 1, "maxLength": 128 }, "description": { "description": "Set the parcel description", "type": "string" }, "data": { "type": "object", "properties": { "gracefulRestart": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ true ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "overlayAs": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "maximum": 4294967295, "minimum": 1, "type": "number" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] } }, "required": [ "optionType" ], "additionalProperties": false } ] }, "sendPathLimit": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "default": 4, "maximum": 16, "minimum": 1, "type": "integer" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "integer", "minimum": 4, "maximum": 4 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "ecmpLimit": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "default": 4, "maximum": 16, "minimum": 1, "type": "number" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "integer", "minimum": 4, "maximum": 4 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "shutdown": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ false ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "ompAdminDistanceIpv4": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "default": 251, "maximum": 255, "minimum": 1, "type": "integer" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "maximum": 251, "minimum": 251, "type": "integer" } }, "required": [ "optionType" ], "additionalProperties": false } ] }, "ompAdminDistanceIpv6": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "default": 251, "maximum": 255, "minimum": 1, "type": "integer" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "maximum": 251, "minimum": 251, "type": "integer" } }, "required": [ "optionType" ], "additionalProperties": false } ] }, "advertisementInterval": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "default": 1, "maximum": 65535, "minimum": 0, "type": "integer" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "integer", "minimum": 1, "maximum": 1 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "gracefulRestartTimer": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "default": 43200, "maximum": 31556952, "minimum": 1, "type": "integer" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "integer", "minimum": 43200, "maximum": 43200 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "eorTimer": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "default": 300, "maximum": 3600, "minimum": 1, "type": "integer" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "integer", "minimum": 300, "maximum": 300 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "holdtime": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "anyOf": [ { "default": 0, "minimum": 0, "maximum": 0, "type": "integer" }, { "default": 300, "minimum": 3, "maximum": 65535, "type": "integer" }, { "default": 5400, "minimum": 3, "maximum": 65535, "type": "integer" } ] } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "integer", "enum": [ 60, 300, 5400 ], "default": 300 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "advertiseIpv4": { "type": "object", "properties": { "bgp": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ false ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "ospf": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ false ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "ospfv3": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ false ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "connected": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ true, false ], "default": true, "description": "use enum for backward compatibility, use default for UI to display default value" } }, "required": [ "optionType" ], "additionalProperties": false } ] }, "static": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ true, false ], "default": true, "description": "use enum for backward compatibility, use default for UI to display default value" } }, "required": [ "optionType" ], "additionalProperties": false } ] }, "eigrp": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ false ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "lisp": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ false ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "isis": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ false ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] } }, "required": [ "bgp", "ospf", "ospfv3", "connected", "static", "eigrp", "lisp", "isis" ], "additionalProperties": false }, "advertiseIpv6": { "type": "object", "properties": { "bgp": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ false ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "ospf": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ false ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "connected": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ true, false ], "default": true, "description": "use enum for backward compatibility, use default for UI to display default value" } }, "required": [ "optionType" ], "additionalProperties": false } ] }, "static": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ true, false ], "default": true, "description": "use enum for backward compatibility, use default for UI to display default value" } }, "required": [ "optionType" ], "additionalProperties": false } ] }, "eigrp": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ false ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "lisp": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ false ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "isis": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ false ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] } }, "required": [ "bgp", "ospf", "connected", "static", "eigrp", "lisp", "isis" ], "additionalProperties": false }, "ignoreRegionPathLength": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ false ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "transportGateway": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string", "enum": [ "prefer", "ecmp-with-direct-path" ] } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] } }, "required": [ "optionType" ], "additionalProperties": false } ] }, "siteTypesForTransportGateway": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "array", "uniqueItems": true, "minItems": 1, "maxItems": 4, "items": { "type": "string", "enum": [ "type-1", "type-2", "type-3", "cloud", "branch", "br", "spoke" ] } } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] } }, "required": [ "optionType" ], "additionalProperties": false } ] }, "aspathAutoTranslation": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ false ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "siteTypes": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "array", "uniqueItems": true, "minItems": 1, "maxItems": 4, "items": { "type": "string", "enum": [ "type-1", "type-2", "type-3", "cloud", "branch", "br", "spoke" ] } } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] } }, "required": [ "optionType" ], "additionalProperties": false } ] } }, "required": [ "gracefulRestart", "overlayAs", "sendPathLimit", "ecmpLimit", "shutdown", "ompAdminDistanceIpv4", "ompAdminDistanceIpv6", "advertisementInterval", "gracefulRestartTimer", "eorTimer", "holdtime", "advertiseIpv4", "advertiseIpv6" ], "allOf": [ { "if": { "properties": { "siteTypesForTransportGateway": { "properties": { "optionType": { "const": "default" } } } } }, "else": { "not": { "properties": { "transportGateway": { "properties": { "optionType": { "const": "default" } } } } } } } ], "additionalProperties": false } }, "required": [ "name", "data" ], "x-metadata": { "supportedDeviceTypes": [ "asr", "c1100", "c8000be", "csr1000v", "ir8100", "ir8340", "isr", "ISRv", "ir1101" ], "minVManageVersion": "20.18" }, "additionalProperties": false }, "$$ref": "#/components/examples/ProfileparcelSdwanSystemOmpPostRequest_ResolvedSchema" }, "put": { "value": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[^&<>! \"]+$", "minLength": 1, "maxLength": 128 }, "description": { "description": "Set the parcel description", "type": "string" }, "data": { "type": "object", "properties": { "gracefulRestart": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ true ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "overlayAs": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "maximum": 4294967295, "minimum": 1, "type": "number" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] } }, "required": [ "optionType" ], "additionalProperties": false } ] }, "sendPathLimit": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "default": 4, "maximum": 16, "minimum": 1, "type": "integer" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "integer", "minimum": 4, "maximum": 4 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "ecmpLimit": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "default": 4, "maximum": 16, "minimum": 1, "type": "number" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "integer", "minimum": 4, "maximum": 4 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "shutdown": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ false ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "ompAdminDistanceIpv4": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "maximum": 255, "minimum": 1, "type": "integer" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "default": 251, "maximum": 251, "minimum": 251, "type": "integer" } }, "required": [ "optionType" ], "additionalProperties": false } ] }, "ompAdminDistanceIpv6": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "maximum": 255, "minimum": 1, "type": "integer" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "default": 251, "maximum": 251, "minimum": 251, "type": "integer" } }, "required": [ "optionType" ], "additionalProperties": false } ] }, "advertisementInterval": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "default": 1, "maximum": 65535, "minimum": 0, "type": "integer" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "integer", "minimum": 1, "maximum": 1 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "gracefulRestartTimer": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "default": 43200, "maximum": 31556952, "minimum": 1, "type": "integer" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "integer", "minimum": 43200, "maximum": 43200 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "eorTimer": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "default": 300, "maximum": 3600, "minimum": 1, "type": "integer" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "integer", "minimum": 300, "maximum": 300 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "holdtime": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "anyOf": [ { "default": 0, "minimum": 0, "maximum": 0, "type": "integer" }, { "default": 300, "minimum": 3, "maximum": 65535, "type": "integer" }, { "default": 5400, "minimum": 3, "maximum": 65535, "type": "integer" } ] } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "integer", "enum": [ 60, 300, 5400 ], "default": 300 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "advertiseIpv4": { "type": "object", "properties": { "bgp": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ false ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "ospf": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ false ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "ospfv3": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ false ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "connected": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ true, false ], "default": true, "description": "use enum for backward compatibility, use default for UI to display default value" } }, "required": [ "optionType" ], "additionalProperties": false } ] }, "static": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ true, false ], "default": true, "description": "use enum for backward compatibility, use default for UI to display default value" } }, "required": [ "optionType" ], "additionalProperties": false } ] }, "eigrp": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ false ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "lisp": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ false ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "isis": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ false ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] } }, "required": [ "bgp", "ospf", "ospfv3", "connected", "static", "eigrp", "lisp", "isis" ], "additionalProperties": false }, "advertiseIpv6": { "type": "object", "properties": { "bgp": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ false ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "ospf": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ false ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "connected": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ true, false ], "default": true, "description": "use enum for backward compatibility, use default for UI to display default value" } }, "required": [ "optionType" ], "additionalProperties": false } ] }, "static": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ true, false ], "default": true, "description": "use enum for backward compatibility, use default for UI to display default value" } }, "required": [ "optionType" ], "additionalProperties": false } ] }, "eigrp": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ false ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "lisp": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ false ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "isis": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ false ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] } }, "required": [ "bgp", "ospf", "connected", "static", "eigrp", "lisp", "isis" ], "additionalProperties": false }, "ignoreRegionPathLength": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ false ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "transportGateway": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string", "enum": [ "prefer", "ecmp-with-direct-path" ] } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] } }, "required": [ "optionType" ], "additionalProperties": false } ] }, "siteTypesForTransportGateway": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "array", "uniqueItems": true, "minItems": 1, "maxItems": 4, "items": { "type": "string", "enum": [ "type-1", "type-2", "type-3", "cloud", "branch", "br", "spoke" ] } } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] } }, "required": [ "optionType" ], "additionalProperties": false } ] }, "aspathAutoTranslation": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ false ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "siteTypes": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "array", "uniqueItems": true, "minItems": 1, "maxItems": 4, "items": { "type": "string", "enum": [ "type-1", "type-2", "type-3", "cloud", "branch", "br", "spoke" ] } } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] } }, "required": [ "optionType" ], "additionalProperties": false } ] } }, "required": [ "gracefulRestart", "overlayAs", "sendPathLimit", "ecmpLimit", "shutdown", "ompAdminDistanceIpv4", "ompAdminDistanceIpv6", "advertisementInterval", "gracefulRestartTimer", "eorTimer", "holdtime", "advertiseIpv4", "advertiseIpv6" ], "allOf": [ { "if": { "properties": { "siteTypesForTransportGateway": { "properties": { "optionType": { "const": "default" } } } } }, "else": { "not": { "properties": { "transportGateway": { "properties": { "optionType": { "const": "default" } } } } } } } ], "additionalProperties": false } }, "required": [ "name", "data" ], "x-metadata": { "supportedDeviceTypes": [ "asr", "c1100", "c8000be", "csr1000v", "ir8100", "ir8340", "isr", "ISRv", "ir1101" ], "minVManageVersion": "20.18" }, "additionalProperties": false }, "$$ref": "#/components/examples/ProfileparcelSdwanSystemOmpPutRequest_ResolvedSchema" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Feature Profile > System > Omp-read" } }, "/v1/feature-profile/sdwan/system/snmp/schema": { "get": { "tags": [ "Configuration - Feature Profile (SDWAN)" ], "description": "Get a SDWAN System Snmp Parcel Schema by Schema Type", "operationId": "GetSdwanSystemSnmpParcelSchemaBySchemaType", "parameters": [ { "name": "schemaType", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "post", "put" ] } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "post": { "value": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[^&<>! \"]+$", "minLength": 1, "maxLength": 128 }, "description": { "type": "string" }, "data": { "type": "object", "properties": { "shutdown": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ false ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "contact": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "minLength": 1, "type": "string", "maxLength": 255 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] } }, "required": [ "optionType" ], "additionalProperties": false } ] }, "location": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "minLength": 1, "type": "string", "maxLength": 255 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] } }, "required": [ "optionType" ], "additionalProperties": false } ] }, "view": { "description": "Configure a view record", "type": "array", "uniqueItems": true, "items": { "type": "object", "properties": { "name": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "minLength": 1, "type": "string", "maxLength": 32 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "oid": { "description": "Configure SNMP object identifier", "type": "array", "uniqueItems": true, "items": { "type": "object", "properties": { "id": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "minLength": 1, "type": "string", "pattern": "^(([0-1](\\.[1-3]?[0-9]))|(2\\.(0|([1-9]\\d*))))(\\.(0|\\*|([1-9]\\d*))){0,126}$" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "exclude": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ false ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] } }, "required": [ "id" ], "additionalProperties": false } } }, "required": [ "name" ], "additionalProperties": false } }, "community": { "description": "Configure SNMP community", "type": "array", "uniqueItems": true, "items": { "type": "object", "properties": { "name": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "minLength": 1, "pattern": "^[\\S]+$", "type": "string", "x-attributeMetadata": { "insecureConfiguration": { "attributeJsonPath": "$.data.community[*].name.value", "description": "SNMP v2c configured - legacy protocol poses data confidentiality and integrity risks due to lack of encryption and authentication", "reason": "Legacy protocol poses data confidentiality and integrity risks due to lack of encryption and authentication", "remediation": "Configure SNMP v3" } } } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "userLabel": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "minLength": 1, "type": "string" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "view": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "authorization": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "enum": [ "read-only", "read-write" ], "type": "string" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] } }, "required": [ "name", "view" ], "additionalProperties": false } }, "group": { "description": "Configure an SNMP group", "type": "array", "uniqueItems": true, "items": { "type": "object", "properties": { "name": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "minLength": 1, "type": "string", "maxLength": 32 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "securityLevel": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "enum": [ "no-auth-no-priv", "auth-no-priv", "auth-priv" ], "type": "string", "x-attributeMetadata": { "insecureConfiguration": { "attributeJsonPath": "$.data.group[*].securityLevel.value", "values": [ "no-auth-no-priv", "auth-no-priv" ], "description": "SNMPv3 configured with Auth/Noauth security level - data confidentiality and integrity cannot be ensured", "reason": "SNMPv3 with Auth/Noauth security level", "remediation": "Use SNMPv3 with Priv security level" } } } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "view": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "minLength": 1, "type": "string", "maxLength": 32 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] } }, "required": [ "name", "securityLevel", "view" ], "additionalProperties": false } }, "user": { "description": "Configure an SNMP user", "type": "array", "uniqueItems": true, "items": { "type": "object", "properties": { "name": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "minLength": 1, "type": "string", "maxLength": 32 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "auth": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "enum": [ "sha", "sha256" ], "type": "string" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "x-attributeMetadata": { "insecureConfiguration": { "attributeJsonPath": "$.data.user[*].auth.optionType", "values": [ "default" ], "description": "SNMP user with Auth/Noauth security level is insecure", "reason": "SNMP User with Auth/Noauth security level", "remediation": "Use SNMP User with Priv security level" } } } }, "required": [ "optionType" ], "additionalProperties": false } ] }, "authPassword": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "x-attributeMetadata": { "insecureConfiguration": { "attributeJsonPath": "$.data.user[*].authPassword.optionType", "values": [ "default" ], "description": "SNMP user with Auth/Noauth security level is insecure", "reason": "SNMP User with Auth/Noauth security level", "remediation": "Use SNMP User with Priv security level" } } } }, "required": [ "optionType" ], "additionalProperties": false } ] }, "priv": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "enum": [ "aes-cfb-128", "aes-256-cfb-128" ], "type": "string" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "x-attributeMetadata": { "insecureConfiguration": { "attributeJsonPath": "$.data.user[*].priv.optionType", "values": [ "default" ], "description": "SNMP user with Auth/Noauth security level is insecure", "reason": "SNMP User with Auth/Noauth security level", "remediation": "Use SNMP User with Priv security level" } } } }, "required": [ "optionType" ], "additionalProperties": false } ] }, "privPassword": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "x-attributeMetadata": { "insecureConfiguration": { "attributeJsonPath": "$.data.user[*].privPassword.optionType", "values": [ "default" ], "description": "SNMP user with Auth/Noauth security level is insecure", "reason": "SNMP User with Auth/Noauth security level", "remediation": "Use SNMP User with Priv security level" } } } }, "required": [ "optionType" ], "additionalProperties": false } ] }, "group": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "minLength": 1, "type": "string", "maxLength": 32 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] } }, "required": [ "name", "group" ], "additionalProperties": false } }, "target": { "description": "Configure SNMP server to receive SNMP traps", "type": "array", "uniqueItems": true, "items": { "type": "object", "properties": { "vpnId": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "minimum": 0, "maximum": 65530, "type": "integer" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "ip": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string", "oneOf": [ { "format": "ipv4" }, { "format": "ipv6" } ] } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "port": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "minimum": 1, "maximum": 65535, "type": "integer" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "userLabel": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "minLength": 1, "type": "string" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "communityName": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "user": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "minLength": 1, "type": "string", "maxLength": 32 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "sourceInterface": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "minLength": 1, "type": "string", "maxLength": 32, "pattern": "(^GigabitEthernet|Loopback|TenGigabitEthernet|TwoGigabitEthernet|FortyGigabitEthernet|HundredGigE|Vlan)(([1-9]\\d|\\d)/){0,2}(0|[1-9]\\d*)([:|\\.][1-9]\\d*)?" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] } }, "additionalProperties": false, "allOf": [ { "if": { "anyOf": [ { "properties": { "vpnId": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "vpnId" ] }, { "properties": { "ip": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "ip" ] }, { "properties": { "port": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "port" ] } ] }, "then": { "required": [ "vpnId", "ip", "port" ] } } ] } } }, "additionalProperties": false } }, "required": [ "data" ], "x-metadata": { "supportedDeviceTypes": [ "asr", "c1100", "c8000be", "csr1000v", "ir8100", "ir8340", "isr", "ISRv", "ir1101" ], "minVManageVersion": "26.1.1" }, "additionalProperties": false }, "$$ref": "#/components/examples/ProfileparcelSdwanSystemSnmpPostRequest_ResolvedSchema" }, "put": { "value": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[^&<>! \"]+$", "minLength": 1, "maxLength": 128 }, "description": { "type": "string" }, "data": { "type": "object", "properties": { "shutdown": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ false ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "contact": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "minLength": 1, "type": "string", "maxLength": 255 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] } }, "required": [ "optionType" ], "additionalProperties": false } ] }, "location": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "minLength": 1, "type": "string", "maxLength": 255 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] } }, "required": [ "optionType" ], "additionalProperties": false } ] }, "view": { "description": "Configure a view record", "type": "array", "uniqueItems": true, "items": { "type": "object", "properties": { "name": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "minLength": 1, "type": "string", "maxLength": 32 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "oid": { "description": "Configure SNMP object identifier", "type": "array", "uniqueItems": true, "items": { "type": "object", "properties": { "id": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "minLength": 1, "type": "string", "pattern": "^(([0-1](\\.[1-3]?[0-9]))|(2\\.(0|([1-9]\\d*))))(\\.(0|\\*|([1-9]\\d*))){0,126}$" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "exclude": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "boolean" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ] }, "value": { "type": "boolean", "enum": [ false ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] } }, "required": [ "id" ], "additionalProperties": false } } }, "required": [ "name" ], "additionalProperties": false } }, "community": { "description": "Configure SNMP community", "type": "array", "uniqueItems": true, "items": { "type": "object", "properties": { "name": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "minLength": 1, "pattern": "^[\\S]+$", "type": "string", "x-attributeMetadata": { "insecureConfiguration": { "attributeJsonPath": "$.data.community[*].name.value", "description": "SNMP v2c configured - legacy protocol poses data confidentiality and integrity risks due to lack of encryption and authentication", "reason": "Legacy protocol poses data confidentiality and integrity risks due to lack of encryption and authentication", "remediation": "Configure SNMP v3" } } } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "userLabel": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "minLength": 1, "type": "string" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "view": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "authorization": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "enum": [ "read-only", "read-write" ], "type": "string" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] } }, "required": [ "name", "view" ], "additionalProperties": false } }, "group": { "description": "Configure an SNMP group", "type": "array", "uniqueItems": true, "items": { "type": "object", "properties": { "name": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "minLength": 1, "type": "string", "maxLength": 32 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "securityLevel": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "enum": [ "no-auth-no-priv", "auth-no-priv", "auth-priv" ], "type": "string", "x-attributeMetadata": { "insecureConfiguration": { "attributeJsonPath": "$.data.group[*].securityLevel.value", "values": [ "no-auth-no-priv", "auth-no-priv" ], "description": "SNMPv3 configured with Auth/Noauth security level - data confidentiality and integrity cannot be ensured", "reason": "SNMPv3 with Auth/Noauth security level", "remediation": "Use SNMPv3 with Priv security level" } } } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "view": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "minLength": 1, "type": "string", "maxLength": 32 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] } }, "required": [ "name", "securityLevel", "view" ], "additionalProperties": false } }, "user": { "description": "Configure an SNMP user", "type": "array", "uniqueItems": true, "items": { "type": "object", "properties": { "name": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "minLength": 1, "type": "string", "maxLength": 32 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "auth": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "enum": [ "sha", "sha256" ], "type": "string" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "x-attributeMetadata": { "insecureConfiguration": { "attributeJsonPath": "$.data.user[*].auth.optionType", "values": [ "default" ], "description": "SNMP user with Auth/Noauth security level is insecure", "reason": "SNMP User with Auth/Noauth security level", "remediation": "Use SNMP User with Priv security level" } } } }, "required": [ "optionType" ], "additionalProperties": false } ] }, "authPassword": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "x-attributeMetadata": { "insecureConfiguration": { "attributeJsonPath": "$.data.user[*].authPassword.optionType", "values": [ "default" ], "description": "SNMP user with Auth/Noauth security level is insecure", "reason": "SNMP User with Auth/Noauth security level", "remediation": "Use SNMP User with Priv security level" } } } }, "required": [ "optionType" ], "additionalProperties": false } ] }, "priv": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "enum": [ "aes-cfb-128", "aes-256-cfb-128" ], "type": "string" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "x-attributeMetadata": { "insecureConfiguration": { "attributeJsonPath": "$.data.user[*].priv.optionType", "values": [ "default" ], "description": "SNMP user with Auth/Noauth security level is insecure", "reason": "SNMP User with Auth/Noauth security level", "remediation": "Use SNMP User with Priv security level" } } } }, "required": [ "optionType" ], "additionalProperties": false } ] }, "privPassword": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "x-attributeMetadata": { "insecureConfiguration": { "attributeJsonPath": "$.data.user[*].privPassword.optionType", "values": [ "default" ], "description": "SNMP user with Auth/Noauth security level is insecure", "reason": "SNMP User with Auth/Noauth security level", "remediation": "Use SNMP User with Priv security level" } } } }, "required": [ "optionType" ], "additionalProperties": false } ] }, "group": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "minLength": 1, "type": "string", "maxLength": 32 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] } }, "required": [ "name", "group" ], "additionalProperties": false } }, "target": { "description": "Configure SNMP server to receive SNMP traps", "type": "array", "uniqueItems": true, "items": { "type": "object", "properties": { "vpnId": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "minimum": 0, "maximum": 65530, "type": "integer" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "ip": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string", "oneOf": [ { "format": "ipv4" }, { "format": "ipv6" } ] } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "port": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "minimum": 1, "maximum": 65535, "type": "integer" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "userLabel": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "minLength": 1, "type": "string" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "communityName": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "user": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "minLength": 1, "type": "string", "maxLength": 32 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] }, "sourceInterface": { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "minLength": 1, "type": "string", "maxLength": 32, "pattern": "(^GigabitEthernet|Loopback|TenGigabitEthernet|TwoGigabitEthernet|FortyGigabitEthernet|HundredGigE|Vlan)(([1-9]\\d|\\d)/){0,2}(0|[1-9]\\d*)([:|\\.][1-9]\\d*)?" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ] }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128 }, "default": { "minLength": 1, "type": "string", "maxLength": 2048 }, "description": { "minLength": 1, "type": "string", "maxLength": 128 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ] } }, "additionalProperties": false, "allOf": [ { "if": { "anyOf": [ { "properties": { "vpnId": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "vpnId" ] }, { "properties": { "ip": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "ip" ] }, { "properties": { "port": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "port" ] } ] }, "then": { "required": [ "vpnId", "ip", "port" ] } } ] } } }, "additionalProperties": false } }, "required": [ "data" ], "x-metadata": { "supportedDeviceTypes": [ "asr", "c1100", "c8000be", "csr1000v", "ir8100", "ir8340", "isr", "ISRv", "ir1101" ], "minVManageVersion": "26.1.1" }, "additionalProperties": false }, "$$ref": "#/components/examples/ProfileparcelSdwanSystemSnmpPutRequest_ResolvedSchema" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Feature Profile > System > Snmp-read" } }, "/v1/feature-profile/sdwan/system/{systemId}": { "put": { "tags": [ "Configuration - Feature Profile (SDWAN)" ], "description": "Edit a SDWAN System Feature Profile", "operationId": "EditSdwanSystemFeatureProfile", "parameters": [ { "name": "systemId", "in": "path", "description": "Feature Profile Id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "SDWAN Feature profile", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[^&<>! \"]+$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_cgFpPpNameDef" }, "description": { "type": "string" } }, "required": [ "name", "description" ], "additionalProperties": false, "$$ref": "#/components/schemas/FeatureprofileCommonPutRequest_SchemaPayload" }, "examples": { "FeatureProfile-ConfigGroup1-NY": { "value": { "name": "FeatureProfile-ConfigGroup1-NY", "description": "Feature Profile for config group 1 for NY site" }, "$$ref": "#/components/examples/FeatureprofileCommonPutRequest_FeatureProfile-ConfigGroup1-NY" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "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}" } }, "required": [ "id" ], "additionalProperties": false, "$$ref": "#/components/schemas/FeatureprofileCommonPutResponse_SchemaPayload" }, "examples": { "example_1": { "value": { "id": "Cc51Cc8B-e2c3-F701-438F-eE6Fbac38AAB" }, "$$ref": "#/components/examples/FeatureprofileCommonPutResponse_example_1" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Feature Profile > System-write" }, "delete": { "tags": [ "Configuration - Feature Profile (SDWAN)" ], "description": "Delete Feature Profile", "operationId": "DeleteSdwanSystemFeatureProfile", "parameters": [ { "name": "systemId", "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": "Feature Profile > System-write" }, "get": { "tags": [ "Configuration - Feature Profile (SDWAN)" ], "description": "Get a SDWAN System Feature Profile with systemId", "operationId": "GetSdwanSystemFeatureProfileByProfileId", "parameters": [ { "name": "systemId", "in": "path", "description": "Feature Profile Id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "profileId": { "type": "string", "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}", "$$ref": "#/components/schemas/CommonCommonDefs_uuidDef" }, "profileType": { "type": "string", "enum": [ "system" ] }, "profileName": { "type": "string", "pattern": "^[^&<>! \"]+$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_cgFpPpNameDef" }, "description": { "type": "string" }, "solution": { "type": "string", "enum": [ "sdwan" ] }, "createdBy": { "type": "string", "description": "User who last created this.", "readOnly": true }, "createdOn": { "type": "integer", "description": "Timestamp of creation", "format": "int64", "readOnly": true }, "lastUpdatedBy": { "type": "string", "description": "User who last updated this.", "readOnly": true }, "lastUpdatedOn": { "type": "integer", "description": "Timestamp of last update", "format": "int64", "readOnly": true }, "associatedProfileParcels": { "type": "array", "items": { "type": "object", "minItems": 0, "properties": { "parcelId": { "type": "string", "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}", "$$ref": "#/components/schemas/CommonCommonDefs_uuidDef" }, "parcelType": { "type": "string" }, "payload": { "type": "object" }, "subparcels": { "type": "array", "minItems": 0, "items": { "type": "object" } } } } } }, "$$ref": "#/components/schemas/getSingleSdwanSystemPayload" }, "examples": { "get response example": { "value": { "profileName": "cg1_LAN", "lastUpdatedBy": "admin", "description": "cg1 system Profile", "profileParcelCount": 613, "createdOn": 1701850310222, "@rid": 3262, "profileType": "system", "solution": "sdwan", "createdBy": "admin", "profileId": "bc99ae4f-0ac3-4a51-95cb-c718953143ce", "lastUpdatedOn": 1702292120081, "associatedProfileParcels": [] }, "$$ref": "#/components/examples/getSingleSdwanSystemExample" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Feature Profile > System-read" } }, "/v1/feature-profile/sdwan/system/{systemId}/aaa": { "get": { "tags": [ "Configuration - Feature Profile (SDWAN)" ], "description": "Get Aaa Profile Parcels for System feature profile", "operationId": "GetAaaProfileParcelForSystem", "parameters": [ { "name": "systemId", "in": "path", "description": "Feature 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", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "parcelId": { "type": "string", "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}", "$$ref": "#/components/schemas/CommonCommonDefs_uuidDef" }, "parcelType": { "type": "string" }, "createdBy": { "type": "string", "description": "User who last created this.", "readOnly": true }, "createdOn": { "type": "integer", "description": "Timestamp of creation", "format": "int64", "readOnly": true }, "lastUpdatedBy": { "type": "string", "description": "User who last updated this.", "readOnly": true }, "lastUpdatedOn": { "type": "integer", "description": "Timestamp of last update", "format": "int64", "readOnly": true }, "payload": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[^&<>! \"]+$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_cgFpPpNameDef", "description": "Set the parcel name" }, "description": { "description": "Set the parcel description", "type": "string" }, "data": { "if": { "properties": { "ctsAuthList": { "type": "object", "properties": { "optionType": { "type": "string", "enum": [ "global", "variable", "default" ] } } } } }, "then": { "properties": { "radiusTrustsecGroup": { "type": "object", "properties": { "optionType": { "type": "string", "enum": [ "global", "global", "default" ] } } } } }, "type": "object", "properties": { "authenticationGroup": { "description": "Authentication configurations parameters", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_oneOfAuthenticationGroupOptionsDef" }, "accountingGroup": { "description": "Accounting configurations parameters", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_oneOfAccountingGroupOptionsDef" }, "serverAuthOrder": { "description": "ServerGroups priority order", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "items": { "type": "string", "default": "local", "maxLength": 220, "minLength": 1 }, "additionalProperties": false, "uniqueItems": true, "type": "array", "minItems": 1, "maxItems": 4, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_serverAuthOrderDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_oneOfServerAuthOrderOptionsDef" }, "user": { "description": "Create local login account", "type": "array", "uniqueItems": true, "minItems": 1, "items": { "if": { "anyOf": [ { "properties": { "name": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "name" ] }, { "properties": { "password": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "password" ] } ] }, "then": { "required": [ "name", "password" ] }, "type": "object", "properties": { "name": { "description": "Set the username", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "pattern": "^[^&<>! \"]+$", "maxLength": 64, "minLength": 1, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_userNameDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_oneOfUserNameOptionsDef" }, "password": { "description": "Set the user password [Note: Catalyst SD-WAN Manager will encrypt this field before saving. Cleartext strings will not be returned back to the user in GET responses for sensitive fields.]", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_userPasswordDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_oneOfUserPasswordOptionsDef" }, "privilege": { "description": "Set Privilege Level for this user", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "enum": [ "1", "15" ], "default": "15", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_userPrivilegeDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "string", "enum": [ "15" ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_defaultUserPrivilegeDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_oneOfUserPrivilegeOptionsDef" }, "pubkeyChain": { "description": "List of RSA public-keys per user", "type": "array", "uniqueItems": true, "maxItems": 2, "items": { "type": "object", "properties": { "keyString": { "description": "Set the RSA key string", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "pattern": "^AAAA[0-9A-Za-z+/]+[=]{0,3}$", "maxLength": 1024, "minLength": 1, "$$ref": "#/components/schemas/CommonCommonDefs_sshRsaKeyDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_oneOfUserPubkeyChainKeyStringOptionsDef" }, "keyType": { "description": "Only RSA is supported", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "enum": [ "ssh-rsa" ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_userPubkeyChainKeyTypeDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_oneOfUserPubkeyChainKeyTypeOptionsDef" } }, "required": [ "keyString" ], "additionalProperties": false } } }, "additionalProperties": false } }, "radius": { "description": "Configure the Radius serverGroup", "type": "array", "uniqueItems": true, "items": { "type": "object", "properties": { "groupName": { "description": "Set Radius server Group Name", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "maxLength": 32, "minLength": 1, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_radiusGroupNameDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_oneOfRadiusGroupNameOptionsDef" }, "vpn": { "description": "Set VPN in which Radius server is located", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "integer", "minimum": 0, "maximum": 65530, "$$ref": "#/components/schemas/CommonCommonDefs_vpnDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "minimum": 0, "maximum": 0, "default": 0, "$$ref": "#/components/schemas/CommonCommonDefs_vpnZeroDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_oneOfRadiusVpnOptionsDef" }, "sourceInterface": { "description": "Set interface to use to reach Radius server", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "pattern": "(ATM|ATM-ACR|AppGigabitEthernet|AppNav-Compress|AppNav-UnCompress|Async|BD-VIF|BDI|CEM|CEM-ACR|Cellular|Dialer|Embedded-Service-Engine|Ethernet|Ethernet-Internal|FastEthernet|FiftyGigabitEthernet|FiveGigabitEthernet|FortyGigabitEthernet|FourHundredGigE|GMPLS|GigabitEthernet|Group-Async|HundredGigE|L2LISP|LISP|Loopback|MFR|Multilink|Port-channel|SM|Serial|Service-Engine|TenGigabitEthernet|Tunnel|TwentyFiveGigE|TwentyFiveGigabitEthernet|TwoGigabitEthernet|TwoHundredGigE|Vif|Virtual-PPP|Virtual-Template|VirtualPortGroup|Vlan|Wlan-GigabitEthernet|nat64|nat66|ntp|nve|ospfv3|overlay|pseudowire|ucse|vasileft|vasiright|vmi)([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]+)", "minLength": 3, "maxLength": 32, "$$ref": "#/components/schemas/CommonCommonDefs_ifNameDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionNoDefaultDef" } ], "$$ref": "#/components/schemas/CommonCommonDefs_oneOfInterfaceNameOptionsDef" }, "server": { "description": "Configure the Radius server", "type": "array", "uniqueItems": true, "items": { "type": "object", "properties": { "address": { "description": "Set IP address of Radius server", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "oneOf": [ { "format": "ipv4" }, { "format": "ipv6" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_radiusServerAddressDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_oneOfRadiusServerAddressOptionsDef" }, "authPort": { "description": "Set Authentication port to use to connect to Radius server", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "integer", "default": 1812, "maximum": 65534, "minimum": 1, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_radiusServerAuthPortDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "maximum": 1812, "minimum": 1812, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_defaultRadiusServerAuthPortDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_oneOfRadiusServerAuthPortOptionsDef" }, "acctPort": { "description": "Set Accounting port to use to connect to Radius server", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "integer", "default": 1813, "maximum": 65534, "minimum": 1, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_radiusServerAcctPortDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "maximum": 1813, "minimum": 1813, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_defaultRadiusServerAcctPortDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_oneOfRadiusServerAcctPortOptionsDef" }, "timeout": { "description": "Configure how long to wait for replies from the Radius server", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "integer", "default": 5, "maximum": 1000, "minimum": 1, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_radiusServerTimeoutDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "maximum": 5, "minimum": 5, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_defaultRadiusServerTimeoutDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_oneOfRadiusServerTimeoutOptionsDef" }, "retransmit": { "description": "Configure how many times to contact this Radius server", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "integer", "default": 3, "maximum": 100, "minimum": 1, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_radiusServerRetransmitDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "maximum": 3, "minimum": 3, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_defaultRadiusServerRetransmitDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_oneOfRadiusServerRetransmitOptionsDef" }, "key": { "description": "Set the Radius server shared key [Note: Catalyst SD-WAN Manager will encrypt this field before saving. Cleartext strings will not be returned back to the user in GET responses for sensitive fields.]", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "minLength": 1, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_radiusServerKeyDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_oneOfRadiusServerKeyOptionsDef" }, "secretKey": { "description": "Set the Radius server shared type 7 encrypted key", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "maxLength": 150, "minLength": 1, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_radiusServerSecretKeyDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_oneOfRadiusServerSecretKeyOptionsDef" }, "keyEnum": { "description": "Type of encyption. To be used for type 6", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "enum": [ "6", "7" ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_radiusServerKeyEnumDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_oneOfRadiusServerKeyEnumOptionsDef" }, "keyType": { "description": "key type", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "enum": [ "key", "pac" ], "default": "key", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_radiusServerKeyTypeDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "string", "enum": [ "key" ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_defaultRadiusServerKeyTypeDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_oneOfRadiusServerKeyTypeOptionsDef" } }, "required": [ "address", "key" ], "additionalProperties": false } } }, "required": [ "groupName", "server" ], "additionalProperties": false } }, "ctsAuthList": { "description": "CTS Authorization List", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minLength": 1, "type": "string", "maxLength": 64, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_ctsAuthListDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "string", "enum": [ "" ], "$$ref": "#/components/schemas/CommonCommonDefs_emptyStringDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_oneOfCtsAuthListOptionsDef" }, "radiusTrustsecGroup": { "description": "RADIUS group", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "minLength": 1, "maxLength": 32, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_radiusTrustsecGroupDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "string", "default": "", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_defaultRadiusTrustsecGroupDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_oneOfRadiusTrustsecGroupOptionsDef" }, "tacacs": { "description": "Configure the TACACS serverGroup", "type": "array", "uniqueItems": true, "items": { "type": "object", "properties": { "groupName": { "description": "Set TACACS server Group Name", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "maxLength": 32, "minLength": 1, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_tacacsGroupNameDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_oneOfTacacsGroupNameOptionsDef" }, "vpn": { "description": "Set VPN in which TACACS server is located", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "integer", "minimum": 0, "maximum": 65530, "$$ref": "#/components/schemas/CommonCommonDefs_vpnDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "minimum": 0, "maximum": 0, "default": 0, "$$ref": "#/components/schemas/CommonCommonDefs_vpnZeroDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_oneOfTacacsVpnOptionsDef" }, "sourceInterface": { "description": "Set interface to use to reach TACACS server", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "pattern": "(ATM|ATM-ACR|AppGigabitEthernet|AppNav-Compress|AppNav-UnCompress|Async|BD-VIF|BDI|CEM|CEM-ACR|Cellular|Dialer|Embedded-Service-Engine|Ethernet|Ethernet-Internal|FastEthernet|FiftyGigabitEthernet|FiveGigabitEthernet|FortyGigabitEthernet|FourHundredGigE|GMPLS|GigabitEthernet|Group-Async|HundredGigE|L2LISP|LISP|Loopback|MFR|Multilink|Port-channel|SM|Serial|Service-Engine|TenGigabitEthernet|Tunnel|TwentyFiveGigE|TwentyFiveGigabitEthernet|TwoGigabitEthernet|TwoHundredGigE|Vif|Virtual-PPP|Virtual-Template|VirtualPortGroup|Vlan|Wlan-GigabitEthernet|nat64|nat66|ntp|nve|ospfv3|overlay|pseudowire|ucse|vasileft|vasiright|vmi)([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]+)", "minLength": 3, "maxLength": 32, "$$ref": "#/components/schemas/CommonCommonDefs_ifNameDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionNoDefaultDef" } ], "$$ref": "#/components/schemas/CommonCommonDefs_oneOfInterfaceNameOptionsDef" }, "server": { "description": "Configure the TACACS server", "type": "array", "uniqueItems": true, "items": { "type": "object", "properties": { "address": { "description": "Set IP address of TACACS server", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "oneOf": [ { "format": "ipv4" }, { "format": "ipv6" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_tacacsServerAddressDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_oneOfTacacsServerAddressOptionsDef" }, "port": { "description": "TACACS Port", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "integer", "default": 49, "maximum": 65535, "minimum": 1, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_tacacsServerPortDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "maximum": 49, "minimum": 49, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_defaultTacacsServerPortDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_oneOfTacacsServerPortOptionsDef" }, "timeout": { "description": "Configure how long to wait for replies from the TACACS server", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "integer", "default": 5, "maximum": 1000, "minimum": 1, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_tacacsServerTimeoutDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "maximum": 5, "minimum": 5, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_defaultTacacsServerTimeoutDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_oneOfTacacsServerTimeoutOptionsDef" }, "key": { "description": "Set the TACACS server shared key [Note: Catalyst SD-WAN Manager will encrypt this field before saving. Cleartext strings will not be returned back to the user in GET responses for sensitive fields.]", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "minLength": 1, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_tacacsServerKeyDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_oneOfTacacsServerKeyOptionsDef" }, "secretKey": { "description": "Set the TACACS server shared type 7 encrypted key", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "maxLength": 150, "minLength": 1, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_tacacsServerSecretKeyDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_oneOfTacacsServerSecretKeyOptionsDef" }, "keyEnum": { "description": "Type of encyption. To be used for type 6", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "enum": [ "6", "7" ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_tacacsServerKeyEnumDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_oneOfTacacsServerKeyEnumOptionsDef" } }, "required": [ "address", "key" ], "additionalProperties": false } } }, "required": [ "groupName", "server" ], "additionalProperties": false } }, "accountingRule": { "description": "Configure the accounting rules", "type": "array", "uniqueItems": true, "items": { "type": "object", "properties": { "ruleId": { "description": "Configure Accounting Rule ID", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "maxLength": 32, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_accountingRuleRuleIdDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_oneOfAccountingRuleRuleIdOptionsDef" }, "method": { "description": "Configure Accounting Method", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "enum": [ "commands", "exec", "network", "system" ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_accountingRuleMethodDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_oneOfAccountingRuleMethodOptionsDef" }, "level": { "description": "Privilege level when method is commands", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "enum": [ "1", "15" ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_accountingRuleLevelDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_oneOfAccountingRuleLevelOptionsDef" }, "startStop": { "description": "Record start and stop without waiting", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ true ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanTrueDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_oneOfAccountingRuleStartStopOptionsDef" }, "group": { "description": "Use Server-group", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "items": { "type": "string" }, "additionalProperties": false, "uniqueItems": true, "type": "array", "maxItems": 4, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_accountingRuleGroupDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_oneOfAccountingRuleGroupOptionsDef" } }, "required": [ "ruleId", "method", "group" ], "additionalProperties": false } }, "authorizationConsole": { "description": "For enabling console authorization", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_oneOfAuthorizationConsoleOptionsDef" }, "authorizationConfigCommands": { "description": "For configuration mode commands.", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_oneOfAuthorizationConfigCommandsOptionsDef" }, "authorizationRule": { "description": "Configure the Authorization Rules", "type": "array", "uniqueItems": true, "items": { "type": "object", "properties": { "ruleId": { "description": "Configure Authorization Rule ID", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "maxLength": 32, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_authorizationRuleRuleIdDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_oneOfAuthorizationRuleRuleIdOptionsDef" }, "method": { "description": "Method", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "enum": [ "commands" ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_authorizationRuleMethodDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_oneOfAuthorizationRuleMethodOptionsDef" }, "level": { "description": "Privilege level when method is commands", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "enum": [ "1", "15" ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_authorizationRuleLevelDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_oneOfAuthorizationRuleLevelOptionsDef" }, "group": { "description": "Use Server-group", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "items": { "type": "string" }, "additionalProperties": false, "uniqueItems": true, "type": "array", "maxItems": 3, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_authorizationRuleGroupDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_oneOfAuthorizationRuleGroupOptionsDef" }, "ifAuthenticated": { "description": "Succeed if user has authenticated", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_oneOfAuthorizationRuleIfAuthenticatedOptionsDef" } }, "required": [ "ruleId", "method", "group", "level" ], "additionalProperties": false } } }, "required": [ "serverAuthOrder", "authorizationConsole", "authorizationConfigCommands", "authenticationGroup", "accountingGroup" ], "additionalProperties": false } }, "required": [ "name", "data" ], "x-metadata": { "supportedDeviceTypes": [ "asr", "c1100", "c8000be", "csr1000v", "ir8100", "ir8340", "isr", "ISRv", "ir1101" ], "minVManageVersion": "20.18.1" }, "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_SchemaPayload" } } } } }, "$$ref": "#/components/schemas/getListSdwanSystemAaaPayload" }, "examples": { "get response example": { "value": { "header": { "generatedOn": 1702438718825 }, "data": [ { "parcelId": "09fc54fe-ff36-4640-ae57-c9e71a103902", "parcelType": "aaa", "createdBy": "admin", "lastUpdatedBy": "admin", "createdOn": 1701866357838, "lastUpdatedOn": 1701866357838, "payload": { "data": { "user": [ { "name": { "optionType": "global", "value": "admin" }, "password": { "optionType": "global", "value": "admin" }, "privilege": { "optionType": "global", "value": "15" } }, { "name": { "optionType": "global", "value": "myName" }, "password": { "optionType": "global", "value": "mypassword" }, "privilege": { "optionType": "global", "value": "1" }, "pubkeyChain": [ { "keyString": { "optionType": "global", "value": "cb4564309f11b2c4fa2b65f2afa0473e" }, "keyType": { "optionType": "global", "value": "ssh-rsa" } } ] } ], "radius": [ { "groupName": { "optionType": "global", "value": "radius-0" }, "vpn": { "optionType": "default", "value": 0 }, "sourceInterface": { "optionType": "global", "value": "myInterface" }, "server": [ { "address": { "optionType": "global", "value": "5.6.7.8" }, "authPort": { "optionType": "default", "value": 1812 }, "acctPort": { "optionType": "default", "value": 1813 }, "timeout": { "optionType": "default", "value": 5 }, "retransmit": { "optionType": "default", "value": 3 }, "key": { "optionType": "global", "value": "$CRYPT_CLUSTER$lvE8dxKF1YumJMdCGdT38w==$WvIslHFObpoVmV53uoRHVQ==" }, "keyType": { "optionType": "default", "value": "key" } } ] } ], "ctsAuthList": { "optionType": "global", "value": "cts-list" }, "radiusTrustsecGroup": { "optionType": "global", "value": "radius-0" }, "tacacs": [ { "groupName": { "optionType": "global", "value": "tacacs-0" }, "vpn": { "optionType": "default", "value": 0 }, "sourceInterface": { "optionType": "default" }, "server": [ { "address": { "optionType": "global", "value": "1.2.3.4" }, "port": { "optionType": "default", "value": 49 }, "timeout": { "optionType": "default", "value": 5 }, "key": { "optionType": "global", "value": "$CRYPT_CLUSTER$aVGUsCSBEIpIHvcb50yibg==$0B5dKh9wGE4Gk536mrDTEQ==" } } ] } ], "serverAuthOrder": { "optionType": "global", "value": [ "local" ] }, "authenticationGroup": { "optionType": "global", "value": true }, "accountingGroup": { "optionType": "global", "value": true }, "accountingRule": [ { "ruleId": { "optionType": "global", "value": "accountId-1" }, "method": { "optionType": "global", "value": "commands" }, "level": { "optionType": "global", "value": "1" }, "startStop": { "optionType": "global", "value": true }, "group": { "optionType": "global", "value": [ "tacacs-0" ] } } ], "authorizationConsole": { "optionType": "default", "value": false }, "authorizationConfigCommands": { "optionType": "default", "value": false }, "authorizationRule": [ { "ruleId": { "optionType": "global", "value": "authorizationId-1" }, "method": { "optionType": "global", "value": "commands" }, "level": { "optionType": "global", "value": "1" }, "group": { "optionType": "global", "value": [ "local", "tacacs-0" ] }, "ifAuthenticated": { "optionType": "default", "value": false } } ] } } } ] }, "$$ref": "#/components/examples/getListSdwanSystemAaaExample" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Feature Profile > System > Aaa-read" }, "post": { "tags": [ "Configuration - Feature Profile (SDWAN)" ], "description": "Create a Aaa Profile Parcel for System feature profile", "operationId": "CreateAaaProfileParcelForSystem", "parameters": [ { "name": "systemId", "in": "path", "description": "Feature 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": "Aaa Profile Parcel", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[^&<>! \"]+$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_cgFpPpNameDef", "description": "Set the parcel name" }, "description": { "description": "Set the parcel description", "type": "string" }, "data": { "if": { "properties": { "ctsAuthList": { "type": "object", "properties": { "optionType": { "type": "string", "enum": [ "global", "variable", "default" ] } } } } }, "then": { "properties": { "radiusTrustsecGroup": { "type": "object", "properties": { "optionType": { "type": "string", "enum": [ "global", "global", "default" ] } } } } }, "type": "object", "properties": { "authenticationGroup": { "description": "Authentication configurations parameters", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_oneOfAuthenticationGroupOptionsDef" }, "accountingGroup": { "description": "Accounting configurations parameters", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_oneOfAccountingGroupOptionsDef" }, "serverAuthOrder": { "description": "ServerGroups priority order", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "items": { "type": "string", "default": "local", "maxLength": 220, "minLength": 1 }, "additionalProperties": false, "uniqueItems": true, "type": "array", "minItems": 1, "maxItems": 4, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_serverAuthOrderDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_oneOfServerAuthOrderOptionsDef" }, "user": { "description": "Create local login account", "type": "array", "uniqueItems": true, "minItems": 1, "items": { "if": { "anyOf": [ { "properties": { "name": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "name" ] }, { "properties": { "password": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "password" ] } ] }, "then": { "required": [ "name", "password" ] }, "type": "object", "properties": { "name": { "description": "Set the username", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "pattern": "^[^&<>! \"]+$", "maxLength": 64, "minLength": 1, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_userNameDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_oneOfUserNameOptionsDef" }, "password": { "description": "Set the user password [Note: Catalyst SD-WAN Manager will encrypt this field before saving. Cleartext strings will not be returned back to the user in GET responses for sensitive fields.]", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_userPasswordDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_oneOfUserPasswordOptionsDef" }, "privilege": { "description": "Set Privilege Level for this user", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "enum": [ "1", "15" ], "default": "15", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_userPrivilegeDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "string", "enum": [ "15" ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_defaultUserPrivilegeDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_oneOfUserPrivilegeOptionsDef" }, "pubkeyChain": { "description": "List of RSA public-keys per user", "type": "array", "uniqueItems": true, "maxItems": 2, "items": { "type": "object", "properties": { "keyString": { "description": "Set the RSA key string", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "pattern": "^AAAA[0-9A-Za-z+/]+[=]{0,3}$", "maxLength": 1024, "minLength": 1, "$$ref": "#/components/schemas/CommonCommonDefs_sshRsaKeyDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_oneOfUserPubkeyChainKeyStringOptionsDef" }, "keyType": { "description": "Only RSA is supported", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "enum": [ "ssh-rsa" ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_userPubkeyChainKeyTypeDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_oneOfUserPubkeyChainKeyTypeOptionsDef" } }, "required": [ "keyString" ], "additionalProperties": false } } }, "additionalProperties": false } }, "radius": { "description": "Configure the Radius serverGroup", "type": "array", "uniqueItems": true, "items": { "type": "object", "properties": { "groupName": { "description": "Set Radius server Group Name", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "maxLength": 32, "minLength": 1, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_radiusGroupNameDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_oneOfRadiusGroupNameOptionsDef" }, "vpn": { "description": "Set VPN in which Radius server is located", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "integer", "minimum": 0, "maximum": 65530, "$$ref": "#/components/schemas/CommonCommonDefs_vpnDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "minimum": 0, "maximum": 0, "default": 0, "$$ref": "#/components/schemas/CommonCommonDefs_vpnZeroDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_oneOfRadiusVpnOptionsDef" }, "sourceInterface": { "description": "Set interface to use to reach Radius server", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "pattern": "(ATM|ATM-ACR|AppGigabitEthernet|AppNav-Compress|AppNav-UnCompress|Async|BD-VIF|BDI|CEM|CEM-ACR|Cellular|Dialer|Embedded-Service-Engine|Ethernet|Ethernet-Internal|FastEthernet|FiftyGigabitEthernet|FiveGigabitEthernet|FortyGigabitEthernet|FourHundredGigE|GMPLS|GigabitEthernet|Group-Async|HundredGigE|L2LISP|LISP|Loopback|MFR|Multilink|Port-channel|SM|Serial|Service-Engine|TenGigabitEthernet|Tunnel|TwentyFiveGigE|TwentyFiveGigabitEthernet|TwoGigabitEthernet|TwoHundredGigE|Vif|Virtual-PPP|Virtual-Template|VirtualPortGroup|Vlan|Wlan-GigabitEthernet|nat64|nat66|ntp|nve|ospfv3|overlay|pseudowire|ucse|vasileft|vasiright|vmi)([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]+)", "minLength": 3, "maxLength": 32, "$$ref": "#/components/schemas/CommonCommonDefs_ifNameDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionNoDefaultDef" } ], "$$ref": "#/components/schemas/CommonCommonDefs_oneOfInterfaceNameOptionsDef" }, "server": { "description": "Configure the Radius server", "type": "array", "uniqueItems": true, "items": { "type": "object", "properties": { "address": { "description": "Set IP address of Radius server", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "oneOf": [ { "format": "ipv4" }, { "format": "ipv6" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_radiusServerAddressDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_oneOfRadiusServerAddressOptionsDef" }, "authPort": { "description": "Set Authentication port to use to connect to Radius server", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "integer", "default": 1812, "maximum": 65534, "minimum": 1, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_radiusServerAuthPortDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "maximum": 1812, "minimum": 1812, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_defaultRadiusServerAuthPortDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_oneOfRadiusServerAuthPortOptionsDef" }, "acctPort": { "description": "Set Accounting port to use to connect to Radius server", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "integer", "default": 1813, "maximum": 65534, "minimum": 1, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_radiusServerAcctPortDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "maximum": 1813, "minimum": 1813, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_defaultRadiusServerAcctPortDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_oneOfRadiusServerAcctPortOptionsDef" }, "timeout": { "description": "Configure how long to wait for replies from the Radius server", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "integer", "default": 5, "maximum": 1000, "minimum": 1, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_radiusServerTimeoutDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "maximum": 5, "minimum": 5, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_defaultRadiusServerTimeoutDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_oneOfRadiusServerTimeoutOptionsDef" }, "retransmit": { "description": "Configure how many times to contact this Radius server", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "integer", "default": 3, "maximum": 100, "minimum": 1, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_radiusServerRetransmitDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "maximum": 3, "minimum": 3, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_defaultRadiusServerRetransmitDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_oneOfRadiusServerRetransmitOptionsDef" }, "key": { "description": "Set the Radius server shared key [Note: Catalyst SD-WAN Manager will encrypt this field before saving. Cleartext strings will not be returned back to the user in GET responses for sensitive fields.]", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "minLength": 1, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_radiusServerKeyDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_oneOfRadiusServerKeyOptionsDef" }, "secretKey": { "description": "Set the Radius server shared type 7 encrypted key", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "maxLength": 150, "minLength": 1, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_radiusServerSecretKeyDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_oneOfRadiusServerSecretKeyOptionsDef" }, "keyEnum": { "description": "Type of encyption. To be used for type 6", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "enum": [ "6", "7" ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_radiusServerKeyEnumDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_oneOfRadiusServerKeyEnumOptionsDef" }, "keyType": { "description": "key type", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "enum": [ "key", "pac" ], "default": "key", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_radiusServerKeyTypeDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "string", "enum": [ "key" ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_defaultRadiusServerKeyTypeDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_oneOfRadiusServerKeyTypeOptionsDef" } }, "required": [ "address", "key" ], "additionalProperties": false } } }, "required": [ "groupName", "server" ], "additionalProperties": false } }, "ctsAuthList": { "description": "CTS Authorization List", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minLength": 1, "type": "string", "maxLength": 64, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_ctsAuthListDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "string", "enum": [ "" ], "$$ref": "#/components/schemas/CommonCommonDefs_emptyStringDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_oneOfCtsAuthListOptionsDef" }, "radiusTrustsecGroup": { "description": "RADIUS group", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "minLength": 1, "maxLength": 32, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_radiusTrustsecGroupDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "string", "default": "", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_defaultRadiusTrustsecGroupDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_oneOfRadiusTrustsecGroupOptionsDef" }, "tacacs": { "description": "Configure the TACACS serverGroup", "type": "array", "uniqueItems": true, "items": { "type": "object", "properties": { "groupName": { "description": "Set TACACS server Group Name", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "maxLength": 32, "minLength": 1, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_tacacsGroupNameDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_oneOfTacacsGroupNameOptionsDef" }, "vpn": { "description": "Set VPN in which TACACS server is located", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "integer", "minimum": 0, "maximum": 65530, "$$ref": "#/components/schemas/CommonCommonDefs_vpnDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "minimum": 0, "maximum": 0, "default": 0, "$$ref": "#/components/schemas/CommonCommonDefs_vpnZeroDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_oneOfTacacsVpnOptionsDef" }, "sourceInterface": { "description": "Set interface to use to reach TACACS server", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "pattern": "(ATM|ATM-ACR|AppGigabitEthernet|AppNav-Compress|AppNav-UnCompress|Async|BD-VIF|BDI|CEM|CEM-ACR|Cellular|Dialer|Embedded-Service-Engine|Ethernet|Ethernet-Internal|FastEthernet|FiftyGigabitEthernet|FiveGigabitEthernet|FortyGigabitEthernet|FourHundredGigE|GMPLS|GigabitEthernet|Group-Async|HundredGigE|L2LISP|LISP|Loopback|MFR|Multilink|Port-channel|SM|Serial|Service-Engine|TenGigabitEthernet|Tunnel|TwentyFiveGigE|TwentyFiveGigabitEthernet|TwoGigabitEthernet|TwoHundredGigE|Vif|Virtual-PPP|Virtual-Template|VirtualPortGroup|Vlan|Wlan-GigabitEthernet|nat64|nat66|ntp|nve|ospfv3|overlay|pseudowire|ucse|vasileft|vasiright|vmi)([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]+)", "minLength": 3, "maxLength": 32, "$$ref": "#/components/schemas/CommonCommonDefs_ifNameDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionNoDefaultDef" } ], "$$ref": "#/components/schemas/CommonCommonDefs_oneOfInterfaceNameOptionsDef" }, "server": { "description": "Configure the TACACS server", "type": "array", "uniqueItems": true, "items": { "type": "object", "properties": { "address": { "description": "Set IP address of TACACS server", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "oneOf": [ { "format": "ipv4" }, { "format": "ipv6" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_tacacsServerAddressDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_oneOfTacacsServerAddressOptionsDef" }, "port": { "description": "TACACS Port", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "integer", "default": 49, "maximum": 65535, "minimum": 1, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_tacacsServerPortDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "maximum": 49, "minimum": 49, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_defaultTacacsServerPortDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_oneOfTacacsServerPortOptionsDef" }, "timeout": { "description": "Configure how long to wait for replies from the TACACS server", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "integer", "default": 5, "maximum": 1000, "minimum": 1, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_tacacsServerTimeoutDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "maximum": 5, "minimum": 5, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_defaultTacacsServerTimeoutDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_oneOfTacacsServerTimeoutOptionsDef" }, "key": { "description": "Set the TACACS server shared key [Note: Catalyst SD-WAN Manager will encrypt this field before saving. Cleartext strings will not be returned back to the user in GET responses for sensitive fields.]", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "minLength": 1, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_tacacsServerKeyDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_oneOfTacacsServerKeyOptionsDef" }, "secretKey": { "description": "Set the TACACS server shared type 7 encrypted key", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "maxLength": 150, "minLength": 1, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_tacacsServerSecretKeyDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_oneOfTacacsServerSecretKeyOptionsDef" }, "keyEnum": { "description": "Type of encyption. To be used for type 6", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "enum": [ "6", "7" ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_tacacsServerKeyEnumDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_oneOfTacacsServerKeyEnumOptionsDef" } }, "required": [ "address", "key" ], "additionalProperties": false } } }, "required": [ "groupName", "server" ], "additionalProperties": false } }, "accountingRule": { "description": "Configure the accounting rules", "type": "array", "uniqueItems": true, "items": { "type": "object", "properties": { "ruleId": { "description": "Configure Accounting Rule ID", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "maxLength": 32, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_accountingRuleRuleIdDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_oneOfAccountingRuleRuleIdOptionsDef" }, "method": { "description": "Configure Accounting Method", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "enum": [ "commands", "exec", "network", "system" ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_accountingRuleMethodDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_oneOfAccountingRuleMethodOptionsDef" }, "level": { "description": "Privilege level when method is commands", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "enum": [ "1", "15" ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_accountingRuleLevelDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_oneOfAccountingRuleLevelOptionsDef" }, "startStop": { "description": "Record start and stop without waiting", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ true ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanTrueDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_oneOfAccountingRuleStartStopOptionsDef" }, "group": { "description": "Use Server-group", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "items": { "type": "string" }, "additionalProperties": false, "uniqueItems": true, "type": "array", "maxItems": 4, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_accountingRuleGroupDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_oneOfAccountingRuleGroupOptionsDef" } }, "required": [ "ruleId", "method", "group" ], "additionalProperties": false } }, "authorizationConsole": { "description": "For enabling console authorization", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_oneOfAuthorizationConsoleOptionsDef" }, "authorizationConfigCommands": { "description": "For configuration mode commands.", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_oneOfAuthorizationConfigCommandsOptionsDef" }, "authorizationRule": { "description": "Configure the Authorization Rules", "type": "array", "uniqueItems": true, "items": { "type": "object", "properties": { "ruleId": { "description": "Configure Authorization Rule ID", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "maxLength": 32, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_authorizationRuleRuleIdDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_oneOfAuthorizationRuleRuleIdOptionsDef" }, "method": { "description": "Method", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "enum": [ "commands" ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_authorizationRuleMethodDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_oneOfAuthorizationRuleMethodOptionsDef" }, "level": { "description": "Privilege level when method is commands", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "enum": [ "1", "15" ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_authorizationRuleLevelDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_oneOfAuthorizationRuleLevelOptionsDef" }, "group": { "description": "Use Server-group", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "items": { "type": "string" }, "additionalProperties": false, "uniqueItems": true, "type": "array", "maxItems": 3, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_authorizationRuleGroupDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_oneOfAuthorizationRuleGroupOptionsDef" }, "ifAuthenticated": { "description": "Succeed if user has authenticated", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_oneOfAuthorizationRuleIfAuthenticatedOptionsDef" } }, "required": [ "ruleId", "method", "group", "level" ], "additionalProperties": false } } }, "required": [ "serverAuthOrder", "authorizationConsole", "authorizationConfigCommands", "authenticationGroup", "accountingGroup" ], "additionalProperties": false } }, "required": [ "name", "data" ], "x-metadata": { "supportedDeviceTypes": [ "asr", "c1100", "c8000be", "csr1000v", "ir8100", "ir8340", "isr", "ISRv", "ir1101" ], "minVManageVersion": "20.18.1" }, "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPostRequest_SchemaPayload" }, "examples": { "CedgeSystemAAAParcelConfig": { "value": { "data": { "user": [ { "name": { "optionType": "global", "value": "admin" }, "password": { "optionType": "global", "value": "admin" }, "privilege": { "optionType": "global", "value": "15" } }, { "name": { "optionType": "global", "value": "myName" }, "password": { "optionType": "global", "value": "mypassword" }, "privilege": { "optionType": "global", "value": "1" }, "pubkeyChain": [ { "keyString": { "optionType": "global", "value": "cb4564309f11b2c4fa2b65f2afa0473e" }, "keyType": { "optionType": "global", "value": "ssh-rsa" } } ] } ], "radius": [ { "groupName": { "optionType": "global", "value": "radius-0" }, "vpn": { "optionType": "default", "value": 0 }, "sourceInterface": { "optionType": "global", "value": "myInterface" }, "server": [ { "address": { "optionType": "global", "value": "5.6.7.8" }, "authPort": { "optionType": "default", "value": 1812 }, "acctPort": { "optionType": "default", "value": 1813 }, "timeout": { "optionType": "default", "value": 5 }, "retransmit": { "optionType": "default", "value": 3 }, "key": { "optionType": "global", "value": "$CRYPT_CLUSTER$lvE8dxKF1YumJMdCGdT38w==$WvIslHFObpoVmV53uoRHVQ==" }, "keyType": { "optionType": "default", "value": "key" } } ] } ], "ctsAuthList": { "optionType": "global", "value": "cts-list" }, "radiusTrustsecGroup": { "optionType": "global", "value": "radius-0" }, "tacacs": [ { "groupName": { "optionType": "global", "value": "tacacs-0" }, "vpn": { "optionType": "default", "value": 0 }, "sourceInterface": { "optionType": "default" }, "server": [ { "address": { "optionType": "global", "value": "1.2.3.4" }, "port": { "optionType": "default", "value": 49 }, "timeout": { "optionType": "default", "value": 5 }, "key": { "optionType": "global", "value": "$CRYPT_CLUSTER$aVGUsCSBEIpIHvcb50yibg==$0B5dKh9wGE4Gk536mrDTEQ==" } } ] } ], "serverAuthOrder": { "optionType": "global", "value": [ "local" ] }, "authenticationGroup": { "optionType": "global", "value": true }, "accountingGroup": { "optionType": "global", "value": true }, "accountingRule": [ { "ruleId": { "optionType": "global", "value": "accountId-1" }, "method": { "optionType": "global", "value": "commands" }, "level": { "optionType": "global", "value": "1" }, "startStop": { "optionType": "global", "value": true }, "group": { "optionType": "global", "value": [ "tacacs-0" ] } } ], "authorizationConsole": { "optionType": "default", "value": false }, "authorizationConfigCommands": { "optionType": "default", "value": false }, "authorizationRule": [ { "ruleId": { "optionType": "global", "value": "authorizationId-1" }, "method": { "optionType": "global", "value": "commands" }, "level": { "optionType": "global", "value": "1" }, "group": { "optionType": "global", "value": [ "local", "tacacs-0" ] }, "ifAuthenticated": { "optionType": "default", "value": false } } ] }, "description": "Cedge System AAA Parcel config", "name": "CedgeSystemAAAParcelConfig" }, "$$ref": "#/components/examples/ProfileparcelSdwanSystemAaaPostRequest_CedgeSystemAAAParcelConfig" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "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}" } }, "required": [ "id" ], "x-metadata": { "minVManageVersion": "20.15.1" }, "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelCommonPostResponse_SchemaPayload" }, "examples": { "example_1": { "value": { "id": "24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A" }, "$$ref": "#/components/examples/ProfileparcelCommonPostResponse_example_1" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Feature Profile > System > Aaa-write" } }, "/v1/feature-profile/sdwan/system/{systemId}/aaa/{aaaId}": { "put": { "tags": [ "Configuration - Feature Profile (SDWAN)" ], "description": "Update a Aaa Profile Parcel for System feature profile", "operationId": "EditAaaProfileParcelForSystem", "parameters": [ { "name": "systemId", "in": "path", "description": "Feature 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" } }, { "name": "aaaId", "in": "path", "description": "Profile Parcel 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": "Aaa Profile Parcel", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[^&<>! \"]+$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_cgFpPpNameDef", "description": "Set the parcel name" }, "description": { "description": "Set the parcel description", "type": "string" }, "data": { "if": { "properties": { "ctsAuthList": { "type": "object", "properties": { "optionType": { "type": "string", "enum": [ "global", "variable", "default" ] } } } } }, "then": { "properties": { "radiusTrustsecGroup": { "type": "object", "properties": { "optionType": { "type": "string", "enum": [ "global", "global", "default" ] } } } } }, "type": "object", "properties": { "authenticationGroup": { "description": "Authentication configurations parameters", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_oneOfAuthenticationGroupOptionsDef" }, "accountingGroup": { "description": "Accounting configurations parameters", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_oneOfAccountingGroupOptionsDef" }, "serverAuthOrder": { "description": "ServerGroups priority order", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "items": { "type": "string", "default": "local", "maxLength": 220, "minLength": 1 }, "additionalProperties": false, "uniqueItems": true, "type": "array", "minItems": 1, "maxItems": 4, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_serverAuthOrderDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_oneOfServerAuthOrderOptionsDef" }, "user": { "description": "Create local login account", "type": "array", "uniqueItems": true, "minItems": 1, "items": { "if": { "anyOf": [ { "properties": { "name": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "name" ] }, { "properties": { "password": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "password" ] } ] }, "then": { "required": [ "name", "password" ] }, "type": "object", "properties": { "name": { "description": "Set the username", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "maxLength": 64, "minLength": 1, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_userNameDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_oneOfUserNameOptionsDef" }, "password": { "description": "Set the user password [Note: Catalyst SD-WAN Manager will encrypt this field before saving. Cleartext strings will not be returned back to the user in GET responses for sensitive fields.]", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_userPasswordDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_oneOfUserPasswordOptionsDef" }, "privilege": { "description": "Set Privilege Level for this user", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "enum": [ "1", "15" ], "default": "15", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_userPrivilegeDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "string", "enum": [ "15" ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_defaultUserPrivilegeDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_oneOfUserPrivilegeOptionsDef" }, "pubkeyChain": { "description": "List of RSA public-keys per user", "type": "array", "uniqueItems": true, "maxItems": 2, "items": { "type": "object", "properties": { "keyString": { "description": "Set the RSA key string", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "pattern": "^AAAA[0-9A-Za-z+/]+[=]{0,3}$", "maxLength": 1024, "minLength": 1, "$$ref": "#/components/schemas/CommonCommonDefs_sshRsaKeyDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_oneOfUserPubkeyChainKeyStringOptionsDef" }, "keyType": { "description": "Only RSA is supported", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "enum": [ "ssh-rsa" ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_userPubkeyChainKeyTypeDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_oneOfUserPubkeyChainKeyTypeOptionsDef" } }, "required": [ "keyString" ], "additionalProperties": false } } }, "additionalProperties": false } }, "radius": { "description": "Configure the Radius serverGroup", "type": "array", "uniqueItems": true, "items": { "type": "object", "properties": { "groupName": { "description": "Set Radius server Group Name", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "maxLength": 32, "minLength": 1, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_radiusGroupNameDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_oneOfRadiusGroupNameOptionsDef" }, "vpn": { "description": "Set VPN in which Radius server is located", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "integer", "minimum": 0, "maximum": 65530, "$$ref": "#/components/schemas/CommonCommonDefs_vpnDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "minimum": 0, "maximum": 0, "default": 0, "$$ref": "#/components/schemas/CommonCommonDefs_vpnZeroDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_oneOfRadiusVpnOptionsDef" }, "sourceInterface": { "description": "Set interface to use to reach Radius server", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "pattern": "(ATM|ATM-ACR|AppGigabitEthernet|AppNav-Compress|AppNav-UnCompress|Async|BD-VIF|BDI|CEM|CEM-ACR|Cellular|Dialer|Embedded-Service-Engine|Ethernet|Ethernet-Internal|FastEthernet|FiftyGigabitEthernet|FiveGigabitEthernet|FortyGigabitEthernet|FourHundredGigE|GMPLS|GigabitEthernet|Group-Async|HundredGigE|L2LISP|LISP|Loopback|MFR|Multilink|Port-channel|SM|Serial|Service-Engine|TenGigabitEthernet|Tunnel|TwentyFiveGigE|TwentyFiveGigabitEthernet|TwoGigabitEthernet|TwoHundredGigE|Vif|Virtual-PPP|Virtual-Template|VirtualPortGroup|Vlan|Wlan-GigabitEthernet|nat64|nat66|ntp|nve|ospfv3|overlay|pseudowire|ucse|vasileft|vasiright|vmi)([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]+)", "minLength": 3, "maxLength": 32, "$$ref": "#/components/schemas/CommonCommonDefs_ifNameDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionNoDefaultDef" } ], "$$ref": "#/components/schemas/CommonCommonDefs_oneOfInterfaceNameOptionsDef" }, "server": { "description": "Configure the Radius server", "type": "array", "uniqueItems": true, "items": { "type": "object", "properties": { "address": { "description": "Set IP address of Radius server", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "oneOf": [ { "format": "ipv4" }, { "format": "ipv6" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_radiusServerAddressDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_oneOfRadiusServerAddressOptionsDef" }, "authPort": { "description": "Set Authentication port to use to connect to Radius server", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "integer", "default": 1812, "maximum": 65534, "minimum": 1, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_radiusServerAuthPortDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "maximum": 1812, "minimum": 1812, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_defaultRadiusServerAuthPortDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_oneOfRadiusServerAuthPortOptionsDef" }, "acctPort": { "description": "Set Accounting port to use to connect to Radius server", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "integer", "default": 1813, "maximum": 65534, "minimum": 1, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_radiusServerAcctPortDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "maximum": 1813, "minimum": 1813, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_defaultRadiusServerAcctPortDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_oneOfRadiusServerAcctPortOptionsDef" }, "timeout": { "description": "Configure how long to wait for replies from the Radius server", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "integer", "default": 5, "maximum": 1000, "minimum": 1, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_radiusServerTimeoutDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "maximum": 5, "minimum": 5, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_defaultRadiusServerTimeoutDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_oneOfRadiusServerTimeoutOptionsDef" }, "retransmit": { "description": "Configure how many times to contact this Radius server", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "integer", "default": 3, "maximum": 100, "minimum": 1, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_radiusServerRetransmitDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "maximum": 3, "minimum": 3, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_defaultRadiusServerRetransmitDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_oneOfRadiusServerRetransmitOptionsDef" }, "key": { "description": "Set the Radius server shared key [Note: Catalyst SD-WAN Manager will encrypt this field before saving. Cleartext strings will not be returned back to the user in GET responses for sensitive fields.]", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "minLength": 1, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_radiusServerKeyDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_oneOfRadiusServerKeyOptionsDef" }, "secretKey": { "description": "Set the Radius server shared type 7 encrypted key", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "maxLength": 150, "minLength": 1, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_radiusServerSecretKeyDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_oneOfRadiusServerSecretKeyOptionsDef" }, "keyEnum": { "description": "Type of encyption. To be used for type 6", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "enum": [ "6", "7" ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_radiusServerKeyEnumDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_oneOfRadiusServerKeyEnumOptionsDef" }, "keyType": { "description": "key type", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "enum": [ "key", "pac" ], "default": "key", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_radiusServerKeyTypeDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "string", "enum": [ "key" ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_defaultRadiusServerKeyTypeDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_oneOfRadiusServerKeyTypeOptionsDef" } }, "required": [ "address", "key" ], "additionalProperties": false } } }, "required": [ "groupName", "server" ], "additionalProperties": false } }, "ctsAuthList": { "description": "CTS Authorization List", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minLength": 1, "type": "string", "maxLength": 64, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_ctsAuthListDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "string", "enum": [ "" ], "$$ref": "#/components/schemas/CommonCommonDefs_emptyStringDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_oneOfCtsAuthListOptionsDef" }, "radiusTrustsecGroup": { "description": "RADIUS group", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "minLength": 1, "maxLength": 32, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_radiusTrustsecGroupDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "string", "default": "", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_defaultRadiusTrustsecGroupDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_oneOfRadiusTrustsecGroupOptionsDef" }, "tacacs": { "description": "Configure the TACACS serverGroup", "type": "array", "uniqueItems": true, "items": { "type": "object", "properties": { "groupName": { "description": "Set TACACS server Group Name", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "maxLength": 32, "minLength": 1, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_tacacsGroupNameDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_oneOfTacacsGroupNameOptionsDef" }, "vpn": { "description": "Set VPN in which TACACS server is located", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "integer", "minimum": 0, "maximum": 65530, "$$ref": "#/components/schemas/CommonCommonDefs_vpnDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "minimum": 0, "maximum": 0, "default": 0, "$$ref": "#/components/schemas/CommonCommonDefs_vpnZeroDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_oneOfTacacsVpnOptionsDef" }, "sourceInterface": { "description": "Set interface to use to reach TACACS server", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "pattern": "(ATM|ATM-ACR|AppGigabitEthernet|AppNav-Compress|AppNav-UnCompress|Async|BD-VIF|BDI|CEM|CEM-ACR|Cellular|Dialer|Embedded-Service-Engine|Ethernet|Ethernet-Internal|FastEthernet|FiftyGigabitEthernet|FiveGigabitEthernet|FortyGigabitEthernet|FourHundredGigE|GMPLS|GigabitEthernet|Group-Async|HundredGigE|L2LISP|LISP|Loopback|MFR|Multilink|Port-channel|SM|Serial|Service-Engine|TenGigabitEthernet|Tunnel|TwentyFiveGigE|TwentyFiveGigabitEthernet|TwoGigabitEthernet|TwoHundredGigE|Vif|Virtual-PPP|Virtual-Template|VirtualPortGroup|Vlan|Wlan-GigabitEthernet|nat64|nat66|ntp|nve|ospfv3|overlay|pseudowire|ucse|vasileft|vasiright|vmi)([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]+)", "minLength": 3, "maxLength": 32, "$$ref": "#/components/schemas/CommonCommonDefs_ifNameDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionNoDefaultDef" } ], "$$ref": "#/components/schemas/CommonCommonDefs_oneOfInterfaceNameOptionsDef" }, "server": { "description": "Configure the TACACS server", "type": "array", "uniqueItems": true, "items": { "type": "object", "properties": { "address": { "description": "Set IP address of TACACS server", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "oneOf": [ { "format": "ipv4" }, { "format": "ipv6" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_tacacsServerAddressDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_oneOfTacacsServerAddressOptionsDef" }, "port": { "description": "TACACS Port", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "integer", "default": 49, "maximum": 65535, "minimum": 1, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_tacacsServerPortDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "maximum": 49, "minimum": 49, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_defaultTacacsServerPortDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_oneOfTacacsServerPortOptionsDef" }, "timeout": { "description": "Configure how long to wait for replies from the TACACS server", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "integer", "default": 5, "maximum": 1000, "minimum": 1, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_tacacsServerTimeoutDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "maximum": 5, "minimum": 5, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_defaultTacacsServerTimeoutDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_oneOfTacacsServerTimeoutOptionsDef" }, "key": { "description": "Set the TACACS server shared key [Note: Catalyst SD-WAN Manager will encrypt this field before saving. Cleartext strings will not be returned back to the user in GET responses for sensitive fields.]", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "minLength": 1, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_tacacsServerKeyDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_oneOfTacacsServerKeyOptionsDef" }, "secretKey": { "description": "Set the TACACS server shared type 7 encrypted key", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "maxLength": 150, "minLength": 1, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_tacacsServerSecretKeyDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_oneOfTacacsServerSecretKeyOptionsDef" }, "keyEnum": { "description": "Type of encyption. To be used for type 6", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "enum": [ "6", "7" ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_tacacsServerKeyEnumDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_oneOfTacacsServerKeyEnumOptionsDef" } }, "required": [ "address", "key" ], "additionalProperties": false } } }, "required": [ "groupName", "server" ], "additionalProperties": false } }, "accountingRule": { "description": "Configure the accounting rules", "type": "array", "uniqueItems": true, "items": { "type": "object", "properties": { "ruleId": { "description": "Configure Accounting Rule ID", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "maxLength": 32, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_accountingRuleRuleIdDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_oneOfAccountingRuleRuleIdOptionsDef" }, "method": { "description": "Configure Accounting Method", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "enum": [ "commands", "exec", "network", "system" ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_accountingRuleMethodDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_oneOfAccountingRuleMethodOptionsDef" }, "level": { "description": "Privilege level when method is commands", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "enum": [ "1", "15" ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_accountingRuleLevelDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_oneOfAccountingRuleLevelOptionsDef" }, "startStop": { "description": "Record start and stop without waiting", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ true ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanTrueDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_oneOfAccountingRuleStartStopOptionsDef" }, "group": { "description": "Use Server-group", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "items": { "type": "string" }, "additionalProperties": false, "uniqueItems": true, "type": "array", "maxItems": 4, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_accountingRuleGroupDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_oneOfAccountingRuleGroupOptionsDef" } }, "required": [ "ruleId", "method", "group" ], "additionalProperties": false } }, "authorizationConsole": { "description": "For enabling console authorization", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_oneOfAuthorizationConsoleOptionsDef" }, "authorizationConfigCommands": { "description": "For configuration mode commands.", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_oneOfAuthorizationConfigCommandsOptionsDef" }, "authorizationRule": { "description": "Configure the Authorization Rules", "type": "array", "uniqueItems": true, "items": { "type": "object", "properties": { "ruleId": { "description": "Configure Authorization Rule ID", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "maxLength": 32, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_authorizationRuleRuleIdDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_oneOfAuthorizationRuleRuleIdOptionsDef" }, "method": { "description": "Method", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "enum": [ "commands" ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_authorizationRuleMethodDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_oneOfAuthorizationRuleMethodOptionsDef" }, "level": { "description": "Privilege level when method is commands", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "enum": [ "1", "15" ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_authorizationRuleLevelDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_oneOfAuthorizationRuleLevelOptionsDef" }, "group": { "description": "Use Server-group", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "items": { "type": "string" }, "additionalProperties": false, "uniqueItems": true, "type": "array", "maxItems": 3, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_authorizationRuleGroupDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_oneOfAuthorizationRuleGroupOptionsDef" }, "ifAuthenticated": { "description": "Succeed if user has authenticated", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_oneOfAuthorizationRuleIfAuthenticatedOptionsDef" } }, "required": [ "ruleId", "method", "group", "level" ], "additionalProperties": false } } }, "required": [ "serverAuthOrder", "authorizationConsole", "authorizationConfigCommands", "authenticationGroup", "accountingGroup" ], "additionalProperties": false } }, "required": [ "name", "data" ], "x-metadata": { "supportedDeviceTypes": [ "asr", "c1100", "c8000be", "csr1000v", "ir8100", "ir8340", "isr", "ISRv", "ir1101" ], "minVManageVersion": "20.18.1" }, "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_SchemaPayload" }, "examples": { "CedgeSystemAAAParcelConfig": { "value": { "data": { "user": [ { "name": { "optionType": "global", "value": "admin" }, "password": { "optionType": "global", "value": "admin" }, "privilege": { "optionType": "global", "value": "15" } }, { "name": { "optionType": "global", "value": "myName" }, "password": { "optionType": "global", "value": "mypassword" }, "privilege": { "optionType": "global", "value": "1" }, "pubkeyChain": [ { "keyString": { "optionType": "global", "value": "cb4564309f11b2c4fa2b65f2afa0473e" }, "keyType": { "optionType": "global", "value": "ssh-rsa" } } ] } ], "radius": [ { "groupName": { "optionType": "global", "value": "radius-0" }, "vpn": { "optionType": "default", "value": 0 }, "sourceInterface": { "optionType": "global", "value": "myInterface" }, "server": [ { "address": { "optionType": "global", "value": "5.6.7.8" }, "authPort": { "optionType": "default", "value": 1812 }, "acctPort": { "optionType": "default", "value": 1813 }, "timeout": { "optionType": "default", "value": 5 }, "retransmit": { "optionType": "default", "value": 3 }, "key": { "optionType": "global", "value": "$CRYPT_CLUSTER$lvE8dxKF1YumJMdCGdT38w==$WvIslHFObpoVmV53uoRHVQ==" }, "keyType": { "optionType": "default", "value": "key" } } ] } ], "ctsAuthList": { "optionType": "global", "value": "cts-list" }, "radiusTrustsecGroup": { "optionType": "global", "value": "radius-0" }, "tacacs": [ { "groupName": { "optionType": "global", "value": "tacacs-0" }, "vpn": { "optionType": "default", "value": 0 }, "sourceInterface": { "optionType": "default" }, "server": [ { "address": { "optionType": "global", "value": "1.2.3.4" }, "port": { "optionType": "default", "value": 49 }, "timeout": { "optionType": "default", "value": 5 }, "key": { "optionType": "global", "value": "$CRYPT_CLUSTER$aVGUsCSBEIpIHvcb50yibg==$0B5dKh9wGE4Gk536mrDTEQ==" } } ] } ], "serverAuthOrder": { "optionType": "global", "value": [ "local" ] }, "authenticationGroup": { "optionType": "global", "value": true }, "accountingGroup": { "optionType": "global", "value": true }, "accountingRule": [ { "ruleId": { "optionType": "global", "value": "accountId-1" }, "method": { "optionType": "global", "value": "commands" }, "level": { "optionType": "global", "value": "1" }, "startStop": { "optionType": "global", "value": true }, "group": { "optionType": "global", "value": [ "tacacs-0" ] } } ], "authorizationConsole": { "optionType": "default", "value": false }, "authorizationConfigCommands": { "optionType": "default", "value": false }, "authorizationRule": [ { "ruleId": { "optionType": "global", "value": "authorizationId-1" }, "method": { "optionType": "global", "value": "commands" }, "level": { "optionType": "global", "value": "1" }, "group": { "optionType": "global", "value": [ "local", "tacacs-0" ] }, "ifAuthenticated": { "optionType": "default", "value": false } } ] }, "description": "Cedge System AAA Parcel config", "name": "CedgeSystemAAAParcelConfig" }, "$$ref": "#/components/examples/ProfileparcelSdwanSystemAaaPutRequest_CedgeSystemAAAParcelConfig" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "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}" } }, "required": [ "id" ], "x-metadata": { "minVManageVersion": "20.15.1" }, "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelCommonPutResponse_SchemaPayload" }, "examples": { "example_1": { "value": { "id": "24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A" }, "$$ref": "#/components/examples/ProfileparcelCommonPutResponse_example_1" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Feature Profile > System > Aaa-write" }, "get": { "tags": [ "Configuration - Feature Profile (SDWAN)" ], "description": "Get Aaa Profile Parcel by parcelId for System feature profile", "operationId": "GetAaaProfileParcelByParcelIdForSystem", "parameters": [ { "name": "systemId", "in": "path", "description": "Feature 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" } }, { "name": "aaaId", "in": "path", "description": "Profile Parcel 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", "properties": { "parcelId": { "type": "string", "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}", "$$ref": "#/components/schemas/CommonCommonDefs_uuidDef" }, "parcelType": { "type": "string" }, "createdBy": { "type": "string", "description": "User who last created this.", "readOnly": true }, "createdOn": { "type": "integer", "description": "Timestamp of creation", "format": "int64", "readOnly": true }, "lastUpdatedBy": { "type": "string", "description": "User who last updated this.", "readOnly": true }, "lastUpdatedOn": { "type": "integer", "description": "Timestamp of last update", "format": "int64", "readOnly": true }, "payload": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[^&<>! \"]+$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_cgFpPpNameDef", "description": "Set the parcel name" }, "description": { "description": "Set the parcel description", "type": "string" }, "data": { "if": { "properties": { "ctsAuthList": { "type": "object", "properties": { "optionType": { "type": "string", "enum": [ "global", "variable", "default" ] } } } } }, "then": { "properties": { "radiusTrustsecGroup": { "type": "object", "properties": { "optionType": { "type": "string", "enum": [ "global", "global", "default" ] } } } } }, "type": "object", "properties": { "authenticationGroup": { "description": "Authentication configurations parameters", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_oneOfAuthenticationGroupOptionsDef" }, "accountingGroup": { "description": "Accounting configurations parameters", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_oneOfAccountingGroupOptionsDef" }, "serverAuthOrder": { "description": "ServerGroups priority order", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "items": { "type": "string", "default": "local", "maxLength": 220, "minLength": 1 }, "additionalProperties": false, "uniqueItems": true, "type": "array", "minItems": 1, "maxItems": 4, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_serverAuthOrderDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_oneOfServerAuthOrderOptionsDef" }, "user": { "description": "Create local login account", "type": "array", "uniqueItems": true, "minItems": 1, "items": { "if": { "anyOf": [ { "properties": { "name": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "name" ] }, { "properties": { "password": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "password" ] } ] }, "then": { "required": [ "name", "password" ] }, "type": "object", "properties": { "name": { "description": "Set the username", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "maxLength": 64, "minLength": 1, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_userNameDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_oneOfUserNameOptionsDef" }, "password": { "description": "Set the user password [Note: Catalyst SD-WAN Manager will encrypt this field before saving. Cleartext strings will not be returned back to the user in GET responses for sensitive fields.]", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_userPasswordDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_oneOfUserPasswordOptionsDef" }, "privilege": { "description": "Set Privilege Level for this user", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "enum": [ "1", "15" ], "default": "15", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_userPrivilegeDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "string", "enum": [ "15" ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_defaultUserPrivilegeDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_oneOfUserPrivilegeOptionsDef" }, "pubkeyChain": { "description": "List of RSA public-keys per user", "type": "array", "uniqueItems": true, "maxItems": 2, "items": { "type": "object", "properties": { "keyString": { "description": "Set the RSA key string", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "pattern": "^AAAA[0-9A-Za-z+/]+[=]{0,3}$", "maxLength": 1024, "minLength": 1, "$$ref": "#/components/schemas/CommonCommonDefs_sshRsaKeyDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_oneOfUserPubkeyChainKeyStringOptionsDef" }, "keyType": { "description": "Only RSA is supported", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "enum": [ "ssh-rsa" ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_userPubkeyChainKeyTypeDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_oneOfUserPubkeyChainKeyTypeOptionsDef" } }, "required": [ "keyString" ], "additionalProperties": false } } }, "additionalProperties": false } }, "radius": { "description": "Configure the Radius serverGroup", "type": "array", "uniqueItems": true, "items": { "type": "object", "properties": { "groupName": { "description": "Set Radius server Group Name", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "maxLength": 32, "minLength": 1, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_radiusGroupNameDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_oneOfRadiusGroupNameOptionsDef" }, "vpn": { "description": "Set VPN in which Radius server is located", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "integer", "minimum": 0, "maximum": 65530, "$$ref": "#/components/schemas/CommonCommonDefs_vpnDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "minimum": 0, "maximum": 0, "default": 0, "$$ref": "#/components/schemas/CommonCommonDefs_vpnZeroDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_oneOfRadiusVpnOptionsDef" }, "sourceInterface": { "description": "Set interface to use to reach Radius server", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "pattern": "(ATM|ATM-ACR|AppGigabitEthernet|AppNav-Compress|AppNav-UnCompress|Async|BD-VIF|BDI|CEM|CEM-ACR|Cellular|Dialer|Embedded-Service-Engine|Ethernet|Ethernet-Internal|FastEthernet|FiftyGigabitEthernet|FiveGigabitEthernet|FortyGigabitEthernet|FourHundredGigE|GMPLS|GigabitEthernet|Group-Async|HundredGigE|L2LISP|LISP|Loopback|MFR|Multilink|Port-channel|SM|Serial|Service-Engine|TenGigabitEthernet|Tunnel|TwentyFiveGigE|TwentyFiveGigabitEthernet|TwoGigabitEthernet|TwoHundredGigE|Vif|Virtual-PPP|Virtual-Template|VirtualPortGroup|Vlan|Wlan-GigabitEthernet|nat64|nat66|ntp|nve|ospfv3|overlay|pseudowire|ucse|vasileft|vasiright|vmi)([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]+)", "minLength": 3, "maxLength": 32, "$$ref": "#/components/schemas/CommonCommonDefs_ifNameDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionNoDefaultDef" } ], "$$ref": "#/components/schemas/CommonCommonDefs_oneOfInterfaceNameOptionsDef" }, "server": { "description": "Configure the Radius server", "type": "array", "uniqueItems": true, "items": { "type": "object", "properties": { "address": { "description": "Set IP address of Radius server", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "oneOf": [ { "format": "ipv4" }, { "format": "ipv6" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_radiusServerAddressDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_oneOfRadiusServerAddressOptionsDef" }, "authPort": { "description": "Set Authentication port to use to connect to Radius server", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "integer", "default": 1812, "maximum": 65534, "minimum": 1, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_radiusServerAuthPortDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "maximum": 1812, "minimum": 1812, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_defaultRadiusServerAuthPortDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_oneOfRadiusServerAuthPortOptionsDef" }, "acctPort": { "description": "Set Accounting port to use to connect to Radius server", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "integer", "default": 1813, "maximum": 65534, "minimum": 1, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_radiusServerAcctPortDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "maximum": 1813, "minimum": 1813, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_defaultRadiusServerAcctPortDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_oneOfRadiusServerAcctPortOptionsDef" }, "timeout": { "description": "Configure how long to wait for replies from the Radius server", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "integer", "default": 5, "maximum": 1000, "minimum": 1, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_radiusServerTimeoutDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "maximum": 5, "minimum": 5, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_defaultRadiusServerTimeoutDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_oneOfRadiusServerTimeoutOptionsDef" }, "retransmit": { "description": "Configure how many times to contact this Radius server", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "integer", "default": 3, "maximum": 100, "minimum": 1, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_radiusServerRetransmitDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "maximum": 3, "minimum": 3, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_defaultRadiusServerRetransmitDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_oneOfRadiusServerRetransmitOptionsDef" }, "key": { "description": "Set the Radius server shared key [Note: Catalyst SD-WAN Manager will encrypt this field before saving. Cleartext strings will not be returned back to the user in GET responses for sensitive fields.]", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "minLength": 1, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_radiusServerKeyDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_oneOfRadiusServerKeyOptionsDef" }, "secretKey": { "description": "Set the Radius server shared type 7 encrypted key", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "maxLength": 150, "minLength": 1, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_radiusServerSecretKeyDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_oneOfRadiusServerSecretKeyOptionsDef" }, "keyEnum": { "description": "Type of encyption. To be used for type 6", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "enum": [ "6", "7" ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_radiusServerKeyEnumDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_oneOfRadiusServerKeyEnumOptionsDef" }, "keyType": { "description": "key type", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "enum": [ "key", "pac" ], "default": "key", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_radiusServerKeyTypeDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "string", "enum": [ "key" ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_defaultRadiusServerKeyTypeDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_oneOfRadiusServerKeyTypeOptionsDef" } }, "required": [ "address", "key" ], "additionalProperties": false } } }, "required": [ "groupName", "server" ], "additionalProperties": false } }, "ctsAuthList": { "description": "CTS Authorization List", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minLength": 1, "type": "string", "maxLength": 64, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_ctsAuthListDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "string", "enum": [ "" ], "$$ref": "#/components/schemas/CommonCommonDefs_emptyStringDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_oneOfCtsAuthListOptionsDef" }, "radiusTrustsecGroup": { "description": "RADIUS group", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "minLength": 1, "maxLength": 32, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_radiusTrustsecGroupDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "string", "default": "", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_defaultRadiusTrustsecGroupDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_oneOfRadiusTrustsecGroupOptionsDef" }, "tacacs": { "description": "Configure the TACACS serverGroup", "type": "array", "uniqueItems": true, "items": { "type": "object", "properties": { "groupName": { "description": "Set TACACS server Group Name", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "maxLength": 32, "minLength": 1, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_tacacsGroupNameDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_oneOfTacacsGroupNameOptionsDef" }, "vpn": { "description": "Set VPN in which TACACS server is located", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "integer", "minimum": 0, "maximum": 65530, "$$ref": "#/components/schemas/CommonCommonDefs_vpnDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "minimum": 0, "maximum": 0, "default": 0, "$$ref": "#/components/schemas/CommonCommonDefs_vpnZeroDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_oneOfTacacsVpnOptionsDef" }, "sourceInterface": { "description": "Set interface to use to reach TACACS server", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "pattern": "(ATM|ATM-ACR|AppGigabitEthernet|AppNav-Compress|AppNav-UnCompress|Async|BD-VIF|BDI|CEM|CEM-ACR|Cellular|Dialer|Embedded-Service-Engine|Ethernet|Ethernet-Internal|FastEthernet|FiftyGigabitEthernet|FiveGigabitEthernet|FortyGigabitEthernet|FourHundredGigE|GMPLS|GigabitEthernet|Group-Async|HundredGigE|L2LISP|LISP|Loopback|MFR|Multilink|Port-channel|SM|Serial|Service-Engine|TenGigabitEthernet|Tunnel|TwentyFiveGigE|TwentyFiveGigabitEthernet|TwoGigabitEthernet|TwoHundredGigE|Vif|Virtual-PPP|Virtual-Template|VirtualPortGroup|Vlan|Wlan-GigabitEthernet|nat64|nat66|ntp|nve|ospfv3|overlay|pseudowire|ucse|vasileft|vasiright|vmi)([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]+)", "minLength": 3, "maxLength": 32, "$$ref": "#/components/schemas/CommonCommonDefs_ifNameDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionNoDefaultDef" } ], "$$ref": "#/components/schemas/CommonCommonDefs_oneOfInterfaceNameOptionsDef" }, "server": { "description": "Configure the TACACS server", "type": "array", "uniqueItems": true, "items": { "type": "object", "properties": { "address": { "description": "Set IP address of TACACS server", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "oneOf": [ { "format": "ipv4" }, { "format": "ipv6" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_tacacsServerAddressDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_oneOfTacacsServerAddressOptionsDef" }, "port": { "description": "TACACS Port", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "integer", "default": 49, "maximum": 65535, "minimum": 1, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_tacacsServerPortDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "maximum": 49, "minimum": 49, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_defaultTacacsServerPortDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_oneOfTacacsServerPortOptionsDef" }, "timeout": { "description": "Configure how long to wait for replies from the TACACS server", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "integer", "default": 5, "maximum": 1000, "minimum": 1, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_tacacsServerTimeoutDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "maximum": 5, "minimum": 5, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_defaultTacacsServerTimeoutDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_oneOfTacacsServerTimeoutOptionsDef" }, "key": { "description": "Set the TACACS server shared key [Note: Catalyst SD-WAN Manager will encrypt this field before saving. Cleartext strings will not be returned back to the user in GET responses for sensitive fields.]", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "minLength": 1, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_tacacsServerKeyDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_oneOfTacacsServerKeyOptionsDef" }, "secretKey": { "description": "Set the TACACS server shared type 7 encrypted key", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "maxLength": 150, "minLength": 1, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_tacacsServerSecretKeyDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_oneOfTacacsServerSecretKeyOptionsDef" }, "keyEnum": { "description": "Type of encyption. To be used for type 6", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "enum": [ "6", "7" ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_tacacsServerKeyEnumDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_oneOfTacacsServerKeyEnumOptionsDef" } }, "required": [ "address", "key" ], "additionalProperties": false } } }, "required": [ "groupName", "server" ], "additionalProperties": false } }, "accountingRule": { "description": "Configure the accounting rules", "type": "array", "uniqueItems": true, "items": { "type": "object", "properties": { "ruleId": { "description": "Configure Accounting Rule ID", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "maxLength": 32, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_accountingRuleRuleIdDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_oneOfAccountingRuleRuleIdOptionsDef" }, "method": { "description": "Configure Accounting Method", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "enum": [ "commands", "exec", "network", "system" ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_accountingRuleMethodDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_oneOfAccountingRuleMethodOptionsDef" }, "level": { "description": "Privilege level when method is commands", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "enum": [ "1", "15" ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_accountingRuleLevelDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_oneOfAccountingRuleLevelOptionsDef" }, "startStop": { "description": "Record start and stop without waiting", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ true ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanTrueDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_oneOfAccountingRuleStartStopOptionsDef" }, "group": { "description": "Use Server-group", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "items": { "type": "string" }, "additionalProperties": false, "uniqueItems": true, "type": "array", "maxItems": 4, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_accountingRuleGroupDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_oneOfAccountingRuleGroupOptionsDef" } }, "required": [ "ruleId", "method", "group" ], "additionalProperties": false } }, "authorizationConsole": { "description": "For enabling console authorization", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_oneOfAuthorizationConsoleOptionsDef" }, "authorizationConfigCommands": { "description": "For configuration mode commands.", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_oneOfAuthorizationConfigCommandsOptionsDef" }, "authorizationRule": { "description": "Configure the Authorization Rules", "type": "array", "uniqueItems": true, "items": { "type": "object", "properties": { "ruleId": { "description": "Configure Authorization Rule ID", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "maxLength": 32, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_authorizationRuleRuleIdDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_oneOfAuthorizationRuleRuleIdOptionsDef" }, "method": { "description": "Method", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "enum": [ "commands" ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_authorizationRuleMethodDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_oneOfAuthorizationRuleMethodOptionsDef" }, "level": { "description": "Privilege level when method is commands", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "enum": [ "1", "15" ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_authorizationRuleLevelDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_oneOfAuthorizationRuleLevelOptionsDef" }, "group": { "description": "Use Server-group", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "items": { "type": "string" }, "additionalProperties": false, "uniqueItems": true, "type": "array", "maxItems": 3, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_authorizationRuleGroupDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_oneOfAuthorizationRuleGroupOptionsDef" }, "ifAuthenticated": { "description": "Succeed if user has authenticated", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_oneOfAuthorizationRuleIfAuthenticatedOptionsDef" } }, "required": [ "ruleId", "method", "group", "level" ], "additionalProperties": false } } }, "required": [ "serverAuthOrder", "authorizationConsole", "authorizationConfigCommands", "authenticationGroup", "accountingGroup" ], "additionalProperties": false } }, "required": [ "name", "data" ], "x-metadata": { "supportedDeviceTypes": [ "asr", "c1100", "c8000be", "csr1000v", "ir8100", "ir8340", "isr", "ISRv", "ir1101" ], "minVManageVersion": "20.18.1" }, "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemAaaPutRequest_SchemaPayload" } }, "$$ref": "#/components/schemas/getSingleSdwanSystemAaaPayload" }, "examples": { "get response example": { "value": { "parcelId": "09fc54fe-ff36-4640-ae57-c9e71a103902", "parcelType": "aaa", "createdBy": "admin", "lastUpdatedBy": "admin", "createdOn": 1701866357838, "lastUpdatedOn": 1701866357838, "payload": { "data": { "user": [ { "name": { "optionType": "global", "value": "admin" }, "password": { "optionType": "global", "value": "admin" }, "privilege": { "optionType": "global", "value": "15" } }, { "name": { "optionType": "global", "value": "myName" }, "password": { "optionType": "global", "value": "mypassword" }, "privilege": { "optionType": "global", "value": "1" }, "pubkeyChain": [ { "keyString": { "optionType": "global", "value": "cb4564309f11b2c4fa2b65f2afa0473e" }, "keyType": { "optionType": "global", "value": "ssh-rsa" } } ] } ], "radius": [ { "groupName": { "optionType": "global", "value": "radius-0" }, "vpn": { "optionType": "default", "value": 0 }, "sourceInterface": { "optionType": "global", "value": "myInterface" }, "server": [ { "address": { "optionType": "global", "value": "5.6.7.8" }, "authPort": { "optionType": "default", "value": 1812 }, "acctPort": { "optionType": "default", "value": 1813 }, "timeout": { "optionType": "default", "value": 5 }, "retransmit": { "optionType": "default", "value": 3 }, "key": { "optionType": "global", "value": "$CRYPT_CLUSTER$lvE8dxKF1YumJMdCGdT38w==$WvIslHFObpoVmV53uoRHVQ==" }, "keyType": { "optionType": "default", "value": "key" } } ] } ], "ctsAuthList": { "optionType": "global", "value": "cts-list" }, "radiusTrustsecGroup": { "optionType": "global", "value": "radius-0" }, "tacacs": [ { "groupName": { "optionType": "global", "value": "tacacs-0" }, "vpn": { "optionType": "default", "value": 0 }, "sourceInterface": { "optionType": "default" }, "server": [ { "address": { "optionType": "global", "value": "1.2.3.4" }, "port": { "optionType": "default", "value": 49 }, "timeout": { "optionType": "default", "value": 5 }, "key": { "optionType": "global", "value": "$CRYPT_CLUSTER$aVGUsCSBEIpIHvcb50yibg==$0B5dKh9wGE4Gk536mrDTEQ==" } } ] } ], "serverAuthOrder": { "optionType": "global", "value": [ "local" ] }, "authenticationGroup": { "optionType": "global", "value": true }, "accountingGroup": { "optionType": "global", "value": true }, "accountingRule": [ { "ruleId": { "optionType": "global", "value": "accountId-1" }, "method": { "optionType": "global", "value": "commands" }, "level": { "optionType": "global", "value": "1" }, "startStop": { "optionType": "global", "value": true }, "group": { "optionType": "global", "value": [ "tacacs-0" ] } } ], "authorizationConsole": { "optionType": "default", "value": false }, "authorizationConfigCommands": { "optionType": "default", "value": false }, "authorizationRule": [ { "ruleId": { "optionType": "global", "value": "authorizationId-1" }, "method": { "optionType": "global", "value": "commands" }, "level": { "optionType": "global", "value": "1" }, "group": { "optionType": "global", "value": [ "local", "tacacs-0" ] }, "ifAuthenticated": { "optionType": "default", "value": false } } ] } } }, "$$ref": "#/components/examples/getSingleSdwanSystemAaaExample" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Feature Profile > System > Aaa-read" }, "delete": { "tags": [ "Configuration - Feature Profile (SDWAN)" ], "description": "Delete a Aaa Profile Parcel for System feature profile", "operationId": "DeleteAaaProfileParcelForSystem", "parameters": [ { "name": "systemId", "in": "path", "description": "Feature 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" } }, { "name": "aaaId", "in": "path", "description": "Profile Parcel 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": "Feature Profile > System > Aaa-write" } }, "/v1/feature-profile/sdwan/system/{systemId}/banner": { "get": { "tags": [ "Configuration - Feature Profile (SDWAN)" ], "description": "Get Banner Profile Parcels for System feature profile", "operationId": "GetBannerProfileParcelForSystem", "parameters": [ { "name": "systemId", "in": "path", "description": "Feature 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", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "parcelId": { "type": "string", "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}", "$$ref": "#/components/schemas/CommonCommonDefs_uuidDef" }, "parcelType": { "type": "string" }, "createdBy": { "type": "string", "description": "User who last created this.", "readOnly": true }, "createdOn": { "type": "integer", "description": "Timestamp of creation", "format": "int64", "readOnly": true }, "lastUpdatedBy": { "type": "string", "description": "User who last updated this.", "readOnly": true }, "lastUpdatedOn": { "type": "integer", "description": "Timestamp of last update", "format": "int64", "readOnly": true }, "payload": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[^&<>! \"]+$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_cgFpPpNameDef" }, "description": { "type": "string" }, "data": { "type": "object", "properties": { "login": { "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "minLength": 1, "maxLength": 2048, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBannerPostRequest_messageDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "string", "enum": [ "" ], "$$ref": "#/components/schemas/CommonCommonDefs_emptyStringDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBannerPostRequest_oneOfOptionsDef" }, "motd": { "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "minLength": 1, "maxLength": 2048, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBannerPostRequest_messageDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "string", "enum": [ "" ], "$$ref": "#/components/schemas/CommonCommonDefs_emptyStringDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBannerPostRequest_oneOfOptionsDef" } }, "required": [ "login", "motd" ], "additionalProperties": false } }, "required": [ "name", "data" ], "x-metadata": { "supportedDeviceTypes": [ "asr", "c1100", "c8000be", "csr1000v", "ir8100", "ir8340", "isr", "ISRv", "ir1101", "autonomous-all" ], "minVManageVersion": "20.15.1" }, "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBannerPostRequest_SchemaPayload" } } } } }, "$$ref": "#/components/schemas/getListSdwanSystemBannerPayload" }, "examples": { "get response example": { "value": { "header": { "generatedOn": 1702438718825 }, "data": [ { "parcelId": "09fc54fe-ff36-4640-ae57-c9e71a103902", "parcelType": "banner", "createdBy": "admin", "lastUpdatedBy": "admin", "createdOn": 1701866357838, "lastUpdatedOn": 1701866357838, "payload": { "data": { "login": { "optionType": "default", "value": "" }, "motd": { "optionType": "global", "value": "Global Message of the Day" } } } } ] }, "$$ref": "#/components/examples/getListSdwanSystemBannerExample" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Feature Profile > System > Banner-read" }, "post": { "tags": [ "Configuration - Feature Profile (SDWAN)" ], "description": "Create a Banner Profile Parcel for System feature profile", "operationId": "CreateBannerProfileParcelForSystem", "parameters": [ { "name": "systemId", "in": "path", "description": "Feature 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": "Banner Profile Parcel", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[^&<>! \"]+$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_cgFpPpNameDef" }, "description": { "type": "string" }, "data": { "type": "object", "properties": { "login": { "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "minLength": 1, "maxLength": 2048, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBannerPostRequest_messageDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "string", "enum": [ "" ], "$$ref": "#/components/schemas/CommonCommonDefs_emptyStringDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBannerPostRequest_oneOfOptionsDef" }, "motd": { "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "minLength": 1, "maxLength": 2048, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBannerPostRequest_messageDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "string", "enum": [ "" ], "$$ref": "#/components/schemas/CommonCommonDefs_emptyStringDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBannerPostRequest_oneOfOptionsDef" } }, "required": [ "login", "motd" ], "additionalProperties": false } }, "required": [ "name", "data" ], "x-metadata": { "supportedDeviceTypes": [ "asr", "c1100", "c8000be", "csr1000v", "ir8100", "ir8340", "isr", "ISRv", "ir1101", "autonomous-all" ], "minVManageVersion": "20.15.1" }, "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBannerPostRequest_SchemaPayload" }, "examples": { "SystemBannerGlobalDefault": { "value": { "name": "SystemBannerGlobalDefault", "data": { "login": { "optionType": "global", "value": "Global Login Message" }, "motd": { "optionType": "default", "value": "" } } }, "$$ref": "#/components/examples/ProfileparcelSdwanSystemBannerPostRequest_SystemBannerGlobalDefault" }, "SystemBannerVariable": { "value": { "name": "SystemBannerVariable", "data": { "login": { "optionType": "variable", "variableName": "{{var_login_parcel_cg1_ny}}" }, "motd": { "optionType": "variable", "variableName": "{{var_motd_parcel_cg1_ny}}" } } }, "$$ref": "#/components/examples/ProfileparcelSdwanSystemBannerPostRequest_SystemBannerVariable" }, "SystemBannerDefaultGlobal": { "value": { "name": "SystemBannerDefaultGlobal", "data": { "login": { "optionType": "default", "value": "" }, "motd": { "optionType": "global", "value": "Global Message of the Day" } } }, "$$ref": "#/components/examples/ProfileparcelSdwanSystemBannerPostRequest_SystemBannerDefaultGlobal" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "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}" } }, "required": [ "id" ], "x-metadata": { "minVManageVersion": "20.15.1" }, "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelCommonPostResponse_SchemaPayload" }, "examples": { "example_1": { "value": { "id": "24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A" }, "$$ref": "#/components/examples/ProfileparcelCommonPostResponse_example_1" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Feature Profile > System > Banner-write" } }, "/v1/feature-profile/sdwan/system/{systemId}/banner/{bannerId}": { "get": { "tags": [ "Configuration - Feature Profile (SDWAN)" ], "description": "Get Banner Profile Parcel by parcelId for System feature profile", "operationId": "GetBannerProfileParcelByParcelIdForSystem", "parameters": [ { "name": "systemId", "in": "path", "description": "Feature 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" } }, { "name": "bannerId", "in": "path", "description": "Profile Parcel 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", "properties": { "parcelId": { "type": "string", "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}", "$$ref": "#/components/schemas/CommonCommonDefs_uuidDef" }, "parcelType": { "type": "string" }, "createdBy": { "type": "string", "description": "User who last created this.", "readOnly": true }, "createdOn": { "type": "integer", "description": "Timestamp of creation", "format": "int64", "readOnly": true }, "lastUpdatedBy": { "type": "string", "description": "User who last updated this.", "readOnly": true }, "lastUpdatedOn": { "type": "integer", "description": "Timestamp of last update", "format": "int64", "readOnly": true }, "payload": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[^&<>! \"]+$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_cgFpPpNameDef" }, "description": { "type": "string" }, "data": { "type": "object", "properties": { "login": { "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "minLength": 1, "maxLength": 2048, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBannerPutRequest_messageDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "string", "enum": [ "" ], "$$ref": "#/components/schemas/CommonCommonDefs_emptyStringDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBannerPutRequest_oneOfOptionsDef" }, "motd": { "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "minLength": 1, "maxLength": 2048, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBannerPutRequest_messageDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "string", "enum": [ "" ], "$$ref": "#/components/schemas/CommonCommonDefs_emptyStringDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBannerPutRequest_oneOfOptionsDef" } }, "required": [ "login", "motd" ], "additionalProperties": false } }, "required": [ "name", "data" ], "x-metadata": { "supportedDeviceTypes": [ "asr", "c1100", "c8000be", "csr1000v", "ir8100", "ir8340", "isr", "ISRv", "ir1101" ], "minVManageVersion": "20.15.1" }, "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBannerPutRequest_SchemaPayload" } }, "$$ref": "#/components/schemas/getSingleSdwanSystemBannerPayload" }, "examples": { "get response example": { "value": { "parcelId": "09fc54fe-ff36-4640-ae57-c9e71a103902", "parcelType": "banner", "createdBy": "admin", "lastUpdatedBy": "admin", "createdOn": 1701866357838, "lastUpdatedOn": 1701866357838, "payload": { "data": { "login": { "optionType": "default", "value": "" }, "motd": { "optionType": "global", "value": "Global Message of the Day" } } } }, "$$ref": "#/components/examples/getSingleSdwanSystemBannerExample" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Feature Profile > System > Banner-read" }, "delete": { "tags": [ "Configuration - Feature Profile (SDWAN)" ], "description": "Delete a Banner Profile Parcel for System feature profile", "operationId": "DeleteBannerProfileParcelForSystem", "parameters": [ { "name": "systemId", "in": "path", "description": "Feature 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" } }, { "name": "bannerId", "in": "path", "description": "Profile Parcel 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": "Feature Profile > System > Banner-write" }, "put": { "tags": [ "Configuration - Feature Profile (SDWAN)" ], "description": "Update a Banner Profile Parcel for System feature profile", "operationId": "EditBannerProfileParcelForSystem", "parameters": [ { "name": "systemId", "in": "path", "description": "Feature 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" } }, { "name": "bannerId", "in": "path", "description": "Profile Parcel 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": "Banner Profile Parcel", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[^&<>! \"]+$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_cgFpPpNameDef" }, "description": { "type": "string" }, "data": { "type": "object", "properties": { "login": { "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "minLength": 1, "maxLength": 2048, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBannerPutRequest_messageDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "string", "enum": [ "" ], "$$ref": "#/components/schemas/CommonCommonDefs_emptyStringDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBannerPutRequest_oneOfOptionsDef" }, "motd": { "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "minLength": 1, "maxLength": 2048, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBannerPutRequest_messageDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "string", "enum": [ "" ], "$$ref": "#/components/schemas/CommonCommonDefs_emptyStringDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBannerPutRequest_oneOfOptionsDef" } }, "required": [ "login", "motd" ], "additionalProperties": false } }, "required": [ "name", "data" ], "x-metadata": { "supportedDeviceTypes": [ "asr", "c1100", "c8000be", "csr1000v", "ir8100", "ir8340", "isr", "ISRv", "ir1101" ], "minVManageVersion": "20.15.1" }, "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBannerPutRequest_SchemaPayload" }, "examples": { "SystemBannerGlobalDefault": { "value": { "name": "SystemBannerGlobalDefault", "data": { "login": { "optionType": "global", "value": "Global Login Message" }, "motd": { "optionType": "default", "value": "" } } }, "$$ref": "#/components/examples/ProfileparcelSdwanSystemBannerPutRequest_SystemBannerGlobalDefault" }, "SystemBannerVariable": { "value": { "name": "SystemBannerVariable", "data": { "login": { "optionType": "variable", "variableName": "{{var_login_parcel_cg1_ny}}" }, "motd": { "optionType": "variable", "variableName": "{{var_motd_parcel_cg1_ny}}" } } }, "$$ref": "#/components/examples/ProfileparcelSdwanSystemBannerPutRequest_SystemBannerVariable" }, "SystemBannerDefaultGlobal": { "value": { "name": "SystemBannerDefaultGlobal", "data": { "login": { "optionType": "default", "value": "" }, "motd": { "optionType": "global", "value": "Global Message of the Day" } } }, "$$ref": "#/components/examples/ProfileparcelSdwanSystemBannerPutRequest_SystemBannerDefaultGlobal" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "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}" } }, "required": [ "id" ], "x-metadata": { "minVManageVersion": "20.15.1" }, "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelCommonPutResponse_SchemaPayload" }, "examples": { "example_1": { "value": { "id": "24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A" }, "$$ref": "#/components/examples/ProfileparcelCommonPutResponse_example_1" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Feature Profile > System > Banner-write" } }, "/v1/feature-profile/sdwan/system/{systemId}/basic": { "get": { "tags": [ "Configuration - Feature Profile (SDWAN)" ], "description": "Get Basic Profile Feature for System feature profile", "operationId": "GetBasicProfileFeatureForSystem", "parameters": [ { "name": "systemId", "in": "path", "description": "Feature 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", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "parcelId": { "type": "string", "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}", "$$ref": "#/components/schemas/CommonCommonDefs_uuidDef" }, "parcelType": { "type": "string" }, "createdBy": { "type": "string", "description": "User who last created this.", "readOnly": true }, "createdOn": { "type": "integer", "description": "Timestamp of creation", "format": "int64", "readOnly": true }, "lastUpdatedBy": { "type": "string", "description": "User who last updated this.", "readOnly": true }, "lastUpdatedOn": { "type": "integer", "description": "Timestamp of last update", "format": "int64", "readOnly": true }, "payload": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[^&<>! \"]+$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_cgFpPpNameDef", "description": "Set the feature name" }, "description": { "description": "Set the feature description", "type": "string" }, "data": { "type": "object", "properties": { "clock": { "type": "object", "properties": { "timezone": { "description": "Set the timezone", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "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" ], "$$ref": "#/components/schemas/CommonCommonDefs_timezoneDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "string", "enum": [ "UTC" ], "$$ref": "#/components/schemas/CommonCommonDefs_utcTimezoneDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_oneOfTimezoneOptionsDef" } }, "required": [ "timezone" ] }, "description": { "description": "Set a text description of the device", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "minLength": 1, "maxLength": 32, "$$ref": "#/components/schemas/CommonCommonDefs_generalDescriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_oneOfDescriptionOptionsDef" }, "location": { "description": "Set the location of the device", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_generalLocationDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_oneOfLocationOptionsDef" }, "gpsLocation": { "type": "object", "properties": { "longitude": { "description": "Set the device physical longitude", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "number", "maximum": 180, "minimum": -180, "multipleOf": 1e-06, "$$ref": "#/components/schemas/CommonCommonDefs_longitudeDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_oneOfLongitudeOptionsDef" }, "latitude": { "description": "Set the device physical latitude", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "number", "maximum": 90, "minimum": -90, "multipleOf": 1e-06, "$$ref": "#/components/schemas/CommonCommonDefs_latitudeDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_oneOfLatitudeOptionsDef" }, "geoFencing": { "type": "object", "properties": { "enable": { "description": "Enable Geo fencing", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_oneOfEnableOptionsDef" }, "range": { "description": "Set the device\u2019s geo fencing range", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 100, "minimum": 100, "maximum": 10000, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_rangeDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "minimum": 100, "maximum": 100, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_defaultRangeDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_oneOfRangeOptionsDef" }, "sms": { "type": "object", "properties": { "enable": { "description": "Enable device\u2019s geo fencing SMS", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_oneOfEnableOptionsDef" }, "mobileNumber": { "description": "Set device\u2019s geo fencing SMS phone number", "type": "array", "uniqueItems": true, "items": { "type": "object", "properties": { "number": { "description": "Mobile number, ex: 1231234414", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minLength": 7, "type": "string", "maxLength": 20, "pattern": "[+][0-9]*", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_mobileNumberNumberDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_oneOfMobileNumberNumberOptionsDef" } }, "required": [ "number" ] } } } } } } }, "required": [ "longitude", "latitude" ] }, "ppl": { "type": "object", "properties": { "enable": { "description": "Enable PPL", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_oneOfEnableOptionsWithVariableDef" }, "localColors": { "description": "Set Local Colors", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "array", "uniqueItems": true, "minItems": 1, "maxItems": 100, "items": { "type": "string", "enum": [ "3g", "biz-internet", "blue", "bronze", "custom1", "custom2", "custom3", "default", "gold", "green", "lte", "metro-ethernet", "mpls", "private1", "private2", "private3", "private4", "private5", "private6", "public-internet", "red", "silver" ], "default": "3g", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_localColorEnumDef" }, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_allLocalColorDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "string", "enum": [ "all" ], "default": "all", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_defaultLocalColorDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_oneOfLocalColorDef" }, "flowSplitting": { "description": "Flow Splitting", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "enum": [ "Packets", "Packet Gap" ], "default": "Packets", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_allFlowSplittingDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "string", "enum": [ "Packets" ], "default": "Packets", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_defaultFlowSplittingDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_oneOfFlowSplittingDef" }, "flowSplitMaxDuration": { "description": "Flowlet size in milliseconds", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 1, "minimum": 1, "maximum": 100, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_maxDurationDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_oneOfMaxDurationDef" }, "flowSplitMaxPkts": { "description": "Flowlet size in packets", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 1024, "minimum": 1024, "maximum": 10240, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_maxPktsDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_oneOfMaxPktsDef" }, "flowSplitMaxSize": { "description": "Flowlet size in KB", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 10, "minimum": 10, "maximum": 1024, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_maxSizeDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_oneOfMaxSizeDef" }, "flowSplitPacketGapAdaptive": { "description": "Configure packet-gap splitting params Adaptive", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "enum": [ true, false ], "default": true, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_packetGapAdaptiveDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_oneOfPacketGapAdaptiveDef" }, "flowSplitPacketGapDuration": { "description": "Configure packet-gap splitting params Duration", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 1, "minimum": 1, "maximum": 100, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_packetGapDurationDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_oneOfPacketGapDurationDef" }, "ctg": { "description": "Configure top-tunnels to include in the CTG", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "enum": [ "All tunnels", "Latency Offset", "Adaptive cluster" ], "default": "All tunnels", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_ctgDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "string", "enum": [ "All tunnels" ], "default": "All tunnels", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_defaultCtgDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_oneOfCTGDef" }, "ctgLatencyOffset": { "description": "Configure CTG latency offset", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 10, "minimum": 1, "maximum": 100, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_ctgLatencyOffsetDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_oneOfCTGLatencyOffsetDef" }, "reordering": { "description": "Enable Reordering", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_oneOfEnableOptionsWithVariableDef" } }, "required": [ "enable", "reordering" ] }, "deviceGroups": { "description": "Device groups", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "items": { "type": "string", "minLength": 1, "$$ref": "#/components/schemas/CommonCommonDefs_nonEmptyStringDef" }, "additionalProperties": false, "uniqueItems": true, "type": "array", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_deviceGroupsDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_oneOfDeviceGroupsOptionsDef" }, "controllerGroupList": { "description": "Configure a list of comma-separated controller groups", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "items": { "type": "integer", "minimum": 1, "maximum": 100 }, "additionalProperties": false, "uniqueItems": true, "type": "array", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_controllerGroupListDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_oneOfControllerGroupListOptionsDef" }, "overlayId": { "description": "Set the Overlay ID", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 1, "maximum": 4294967295, "minimum": 1, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_overlayIdDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "maximum": 1, "minimum": 1, "type": "integer" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_oneOfOverlayIdOptionsDef" }, "portOffset": { "description": "Set the TLOC port offset when multiple devices are behind a NAT", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 0, "maximum": 19, "minimum": 0, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_portOffsetDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "maximum": 0, "minimum": 0, "type": "integer" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_oneOfPortOffsetOptionsDef" }, "portHop": { "description": "The port hop functionality is deprecated for devices 17.18 and higher. Use the full-port-hop field instead on interfaces.", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ true ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanTrueDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_oneOfPortHopOptionsDef" }, "controlSessionPps": { "description": "Set the policer rate for control sessions", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 300, "maximum": 65535, "minimum": 1, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_controlSessionPpsDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "maximum": 300, "minimum": 300, "type": "integer" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_oneOfControlSessionPpsOptionsDef" }, "trackTransport": { "description": "Configure tracking of transport", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ true ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanTrueDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_oneOfTrackTransportOptionsDef" }, "trackInterfaceTag": { "description": "OMP Tag attached to routes based on interface tracking", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "maximum": 4294967295, "minimum": 1, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_trackInterfaceTagDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_oneOfTrackInterfaceTagOptionsDef" }, "consoleBaudRate": { "description": "Set the console baud rate", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": "9600", "enum": [ "1200", "2400", "4800", "9600", "19200", "38400", "57600", "115200" ], "type": "string", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_consoleBaudRateDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "string", "enum": [ "9600" ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_oneOfConsoleBaudRateOptionsDef" }, "maxOmpSessions": { "description": "Set the maximum number of OMP sessions <1..100> the device can have", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "maximum": 100, "minimum": 1, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_maxOmpSessionsDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_oneOfMaxOmpSessionsOptionsDef" }, "multiTenant": { "description": "Device is multi-tenant", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_oneOfMultiTenantOptionsDef" }, "trackDefaultGateway": { "description": "Enable or disable default gateway tracking", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ true ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanTrueDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_oneOfTrackDefaultGatewayOptionsDef" }, "trackerDiaStabilizeStatus": { "description": "Enable or disable endpoint tracker diaStabilize status", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_oneOfTrackerDiaStabilizeStatusDef" }, "adminTechOnFailure": { "description": "Collect admin-tech before reboot due to daemon failure", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ true ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanTrueDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_oneOfAdminTechOnFailureOptionsDef" }, "idleTimeout": { "description": "Idle CLI timeout in minutes", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "maximum": 300, "minimum": 0, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_idleTimeoutDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_oneOfIdleTimeoutOptionsDef" }, "onDemand": { "type": "object", "properties": { "onDemandEnable": { "description": "Enable or disable On-demand Tunnel", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_oneOfOnDemandEnableOptionsDef" }, "onDemandIdleTimeout": { "description": "Set the idle timeout for on-demand tunnels", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 10, "maximum": 65535, "minimum": 1, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_onDemandIdleTimeoutDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "maximum": 10, "minimum": 10, "type": "integer" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_oneOfOnDemandIdleTimeoutOptionsDef" } }, "required": [ "onDemandEnable", "onDemandIdleTimeout" ] }, "transportGateway": { "description": "Enable transport gateway", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_oneOfTransportGatewayOptionsDef" }, "epfr": { "description": "Enable SLA Dampening and Enhanced App Routing.", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "enum": [ "disabled", "aggressive", "moderate", "conservative" ], "default": "disabled", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_epfrDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "string", "enum": [ "disabled" ] } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_oneOfEpfrOptions" }, "siteType": { "description": "Site Type", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "array", "uniqueItems": true, "minItems": 1, "maxItems": 4, "items": { "type": "string", "enum": [ "type-1", "type-2", "type-3", "cloud", "branch", "br", "spoke" ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_siteTypeDef" }, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_siteTypeListDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_oneOfSiteTypeOptionsDef" }, "affinityGroupNumber": { "description": "Affinity Group Number", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "maximum": 63, "minimum": 1, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_affinityDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_oneOfAffinityGroupNumberOptionsDef" }, "affinityGroupPreference": { "description": "Affinity Group Preference", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "array", "uniqueItems": true, "minItems": 1, "maxItems": 12, "items": { "maximum": 63, "minimum": 1, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_affinityDef" }, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_affinityPreferenceListDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_oneOfAffinityGroupPreferenceOptionsDef" }, "affinityPreferenceAuto": { "description": "Affinity Group Preference Auto", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_oneOfAffinityPreferenceAutoOptionsDef" }, "affinityPerVrf": { "description": "Affinity Group Number for VRFs", "type": "array", "uniqueItems": true, "minItems": 0, "maxItems": 4, "items": { "type": "object", "properties": { "affinityGroupNumber": { "description": "Affinity Group Number", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "maximum": 63, "minimum": 1, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_affinityDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_oneOfAffinityGroupNumberOptionsDef" }, "vrfRange": { "description": "Range of VRFs", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minLength": 1, "maxLength": 11, "type": "string", "oneOf": [ { "pattern": "^([1-9]|[1-9][0-9]{1,3}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[01])$", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_vrfPatternDef" }, { "pattern": "^(([1-9]|[1-9][0-9]{1,3}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[01])-([1-9]|[1-9][0-9]{1,3}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[01]))$", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_vrfRangePatternDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_vrfRangeDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_oneOfVrfRangeOptionsDef" } }, "required": [], "additionalProperties": false } } }, "required": [ "clock", "description", "location", "gpsLocation", "deviceGroups", "overlayId", "portOffset", "portHop", "consoleBaudRate", "maxOmpSessions", "adminTechOnFailure", "onDemand" ], "additionalProperties": false } }, "required": [ "name", "data" ], "x-metadata": { "supportedDeviceTypes": [ "asr", "c1100", "c8000be", "csr1000v", "ir8100", "ir8340", "isr", "ISRv", "ir1101" ], "minVManageVersion": "26.1.1" }, "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_SchemaPayload" } } } } }, "$$ref": "#/components/schemas/getListSdwanSystemBasicPayload" }, "examples": { "get response example": { "value": { "header": { "generatedOn": 1702438718825 }, "data": [ { "parcelId": "09fc54fe-ff36-4640-ae57-c9e71a103902", "parcelType": "basic", "createdBy": "admin", "lastUpdatedBy": "admin", "createdOn": 1701866357838, "lastUpdatedOn": 1701866357838, "payload": { "data": { "clock": { "timezone": { "optionType": "default", "value": "UTC" } }, "description": { "optionType": "global", "value": "nostrud ea" }, "location": { "optionType": "default" }, "deviceGroups": { "optionType": "default" }, "overlayId": { "optionType": "default", "value": 1 }, "portOffset": { "optionType": "global", "value": 19 }, "portHop": { "optionType": "default", "value": true }, "consoleBaudRate": { "optionType": "global", "value": "4800" }, "maxOmpSessions": { "optionType": "global", "value": 24 }, "adminTechOnFailure": { "optionType": "default", "value": true }, "idleTimeout": { "optionType": "global", "value": "10" }, "onDemand": { "onDemandEnable": { "optionType": "global", "value": true }, "onDemandIdleTimeout": { "optionType": "default", "value": 10 } }, "gpsLocation": { "longitude": { "optionType": "default" }, "latitude": { "optionType": "default" }, "geoFencing": { "enable": { "optionType": "global", "value": true }, "range": { "optionType": "global", "value": 100 }, "sms": { "enable": { "optionType": "global", "value": true }, "mobileNumber": { "number": { "optionType": "global", "value": "+11111233" } } } } }, "transportGateway": { "optionType": "default", "value": false }, "ppl": { "enable": { "optionType": "global", "value": true }, "localColors": { "optionType": "global", "value": "all" }, "flowSplitting": { "optionType": "global", "value": "max-pkts" }, "flowSplitMaxPkts": { "optionType": "global", "value": 1024 }, "ctg": { "optionType": "global", "value": "All tunnels" }, "reordering": { "optionType": "global", "value": true } } } } } ] }, "$$ref": "#/components/examples/getListSdwanSystemBasicExample" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Feature Profile > System > Basic-read" }, "post": { "tags": [ "Configuration - Feature Profile (SDWAN)" ], "description": "Create a Basic Profile Feature for System feature profile", "operationId": "CreateBasicProfileFeatureForSystem", "parameters": [ { "name": "systemId", "in": "path", "description": "Feature 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": "Basic Profile Feature", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[^&<>! \"]+$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_cgFpPpNameDef", "description": "Set the feature name" }, "description": { "description": "Set the feature description", "type": "string" }, "data": { "type": "object", "properties": { "clock": { "type": "object", "properties": { "timezone": { "description": "Set the timezone", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "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" ], "$$ref": "#/components/schemas/CommonCommonDefs_timezoneDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "string", "enum": [ "UTC" ], "$$ref": "#/components/schemas/CommonCommonDefs_utcTimezoneDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_oneOfTimezoneOptionsDef" } }, "required": [ "timezone" ] }, "description": { "description": "Set a text description of the device", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "minLength": 1, "maxLength": 32, "$$ref": "#/components/schemas/CommonCommonDefs_generalDescriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_oneOfDescriptionOptionsDef" }, "location": { "description": "Set the location of the device", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_generalLocationDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_oneOfLocationOptionsDef" }, "gpsLocation": { "type": "object", "properties": { "longitude": { "description": "Set the device physical longitude", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "number", "maximum": 180, "minimum": -180, "multipleOf": 1e-06, "$$ref": "#/components/schemas/CommonCommonDefs_longitudeDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_oneOfLongitudeOptionsDef" }, "latitude": { "description": "Set the device physical latitude", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "number", "maximum": 90, "minimum": -90, "multipleOf": 1e-06, "$$ref": "#/components/schemas/CommonCommonDefs_latitudeDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_oneOfLatitudeOptionsDef" }, "geoFencing": { "type": "object", "properties": { "enable": { "description": "Enable Geo fencing", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_oneOfEnableOptionsDef" }, "range": { "description": "Set the device\u2019s geo fencing range", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 100, "minimum": 100, "maximum": 10000, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_rangeDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "minimum": 100, "maximum": 100, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_defaultRangeDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_oneOfRangeOptionsDef" }, "sms": { "type": "object", "properties": { "enable": { "description": "Enable device\u2019s geo fencing SMS", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_oneOfEnableOptionsDef" }, "mobileNumber": { "description": "Set device\u2019s geo fencing SMS phone number", "type": "array", "uniqueItems": true, "items": { "type": "object", "properties": { "number": { "description": "Mobile number, ex: 1231234414", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minLength": 7, "type": "string", "maxLength": 20, "pattern": "[+][0-9]*", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_mobileNumberNumberDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_oneOfMobileNumberNumberOptionsDef" } }, "required": [ "number" ] } } } } } } }, "required": [ "longitude", "latitude" ] }, "ppl": { "type": "object", "properties": { "enable": { "description": "Enable PPL", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_oneOfEnableOptionsWithVariableDef" }, "localColors": { "description": "Set Local Colors", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "array", "uniqueItems": true, "minItems": 1, "maxItems": 100, "items": { "type": "string", "enum": [ "3g", "biz-internet", "blue", "bronze", "custom1", "custom2", "custom3", "default", "gold", "green", "lte", "metro-ethernet", "mpls", "private1", "private2", "private3", "private4", "private5", "private6", "public-internet", "red", "silver" ], "default": "3g", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_localColorEnumDef" }, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_allLocalColorDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "string", "enum": [ "all" ], "default": "all", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_defaultLocalColorDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_oneOfLocalColorDef" }, "flowSplitting": { "description": "Flow Splitting", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "enum": [ "Packets", "Packet Gap" ], "default": "Packets", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_allFlowSplittingDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "string", "enum": [ "Packets" ], "default": "Packets", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_defaultFlowSplittingDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_oneOfFlowSplittingDef" }, "flowSplitMaxDuration": { "description": "Flowlet size in milliseconds", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 1, "minimum": 1, "maximum": 100, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_maxDurationDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_oneOfMaxDurationDef" }, "flowSplitMaxPkts": { "description": "Flowlet size in packets", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 1024, "minimum": 1024, "maximum": 10240, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_maxPktsDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_oneOfMaxPktsDef" }, "flowSplitMaxSize": { "description": "Flowlet size in KB", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 10, "minimum": 10, "maximum": 1024, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_maxSizeDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_oneOfMaxSizeDef" }, "flowSplitPacketGapAdaptive": { "description": "Configure packet-gap splitting params Adaptive", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "enum": [ true, false ], "default": true, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_packetGapAdaptiveDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_oneOfPacketGapAdaptiveDef" }, "flowSplitPacketGapDuration": { "description": "Configure packet-gap splitting params Duration", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 1, "minimum": 1, "maximum": 100, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_packetGapDurationDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_oneOfPacketGapDurationDef" }, "ctg": { "description": "Configure top-tunnels to include in the CTG", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "enum": [ "All tunnels", "Latency Offset", "Adaptive cluster" ], "default": "All tunnels", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_ctgDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "string", "enum": [ "All tunnels" ], "default": "All tunnels", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_defaultCtgDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_oneOfCTGDef" }, "ctgLatencyOffset": { "description": "Configure CTG latency offset", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 10, "minimum": 1, "maximum": 100, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_ctgLatencyOffsetDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_oneOfCTGLatencyOffsetDef" }, "reordering": { "description": "Enable Reordering", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_oneOfEnableOptionsWithVariableDef" } }, "required": [ "enable", "reordering" ] }, "deviceGroups": { "description": "Device groups", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "items": { "type": "string", "minLength": 1, "$$ref": "#/components/schemas/CommonCommonDefs_nonEmptyStringDef" }, "additionalProperties": false, "uniqueItems": true, "type": "array", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_deviceGroupsDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_oneOfDeviceGroupsOptionsDef" }, "controllerGroupList": { "description": "Configure a list of comma-separated controller groups", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "items": { "type": "integer", "minimum": 1, "maximum": 100 }, "additionalProperties": false, "uniqueItems": true, "type": "array", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_controllerGroupListDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_oneOfControllerGroupListOptionsDef" }, "overlayId": { "description": "Set the Overlay ID", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 1, "maximum": 4294967295, "minimum": 1, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_overlayIdDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "maximum": 1, "minimum": 1, "type": "integer" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_oneOfOverlayIdOptionsDef" }, "portOffset": { "description": "Set the TLOC port offset when multiple devices are behind a NAT", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 0, "maximum": 19, "minimum": 0, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_portOffsetDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "maximum": 0, "minimum": 0, "type": "integer" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_oneOfPortOffsetOptionsDef" }, "portHop": { "description": "The port hop functionality is deprecated for devices 17.18 and higher. Use the full-port-hop field instead on interfaces.", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ true ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanTrueDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_oneOfPortHopOptionsDef" }, "controlSessionPps": { "description": "Set the policer rate for control sessions", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 300, "maximum": 65535, "minimum": 1, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_controlSessionPpsDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "maximum": 300, "minimum": 300, "type": "integer" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_oneOfControlSessionPpsOptionsDef" }, "trackTransport": { "description": "Configure tracking of transport", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ true ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanTrueDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_oneOfTrackTransportOptionsDef" }, "trackInterfaceTag": { "description": "OMP Tag attached to routes based on interface tracking", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "maximum": 4294967295, "minimum": 1, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_trackInterfaceTagDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_oneOfTrackInterfaceTagOptionsDef" }, "consoleBaudRate": { "description": "Set the console baud rate", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": "9600", "enum": [ "1200", "2400", "4800", "9600", "19200", "38400", "57600", "115200" ], "type": "string", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_consoleBaudRateDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "string", "enum": [ "9600" ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_oneOfConsoleBaudRateOptionsDef" }, "maxOmpSessions": { "description": "Set the maximum number of OMP sessions <1..100> the device can have", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "maximum": 100, "minimum": 1, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_maxOmpSessionsDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_oneOfMaxOmpSessionsOptionsDef" }, "multiTenant": { "description": "Device is multi-tenant", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_oneOfMultiTenantOptionsDef" }, "trackDefaultGateway": { "description": "Enable or disable default gateway tracking", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ true ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanTrueDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_oneOfTrackDefaultGatewayOptionsDef" }, "trackerDiaStabilizeStatus": { "description": "Enable or disable endpoint tracker diaStabilize status", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_oneOfTrackerDiaStabilizeStatusDef" }, "adminTechOnFailure": { "description": "Collect admin-tech before reboot due to daemon failure", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ true ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanTrueDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_oneOfAdminTechOnFailureOptionsDef" }, "idleTimeout": { "description": "Idle CLI timeout in minutes", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "maximum": 300, "minimum": 0, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_idleTimeoutDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_oneOfIdleTimeoutOptionsDef" }, "onDemand": { "type": "object", "properties": { "onDemandEnable": { "description": "Enable or disable On-demand Tunnel", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_oneOfOnDemandEnableOptionsDef" }, "onDemandIdleTimeout": { "description": "Set the idle timeout for on-demand tunnels", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 10, "maximum": 65535, "minimum": 1, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_onDemandIdleTimeoutDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "maximum": 10, "minimum": 10, "type": "integer" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_oneOfOnDemandIdleTimeoutOptionsDef" } }, "required": [ "onDemandEnable", "onDemandIdleTimeout" ] }, "transportGateway": { "description": "Enable transport gateway", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_oneOfTransportGatewayOptionsDef" }, "epfr": { "description": "Enable SLA Dampening and Enhanced App Routing.", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "enum": [ "disabled", "aggressive", "moderate", "conservative" ], "default": "disabled", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_epfrDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "string", "enum": [ "disabled" ] } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_oneOfEpfrOptions" }, "siteType": { "description": "Site Type", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "array", "uniqueItems": true, "minItems": 1, "maxItems": 4, "items": { "type": "string", "enum": [ "type-1", "type-2", "type-3", "cloud", "branch", "br", "spoke" ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_siteTypeDef" }, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_siteTypeListDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_oneOfSiteTypeOptionsDef" }, "affinityGroupNumber": { "description": "Affinity Group Number", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "maximum": 63, "minimum": 1, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_affinityDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_oneOfAffinityGroupNumberOptionsDef" }, "affinityGroupPreference": { "description": "Affinity Group Preference", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "array", "uniqueItems": true, "minItems": 1, "maxItems": 12, "items": { "maximum": 63, "minimum": 1, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_affinityDef" }, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_affinityPreferenceListDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_oneOfAffinityGroupPreferenceOptionsDef" }, "affinityPreferenceAuto": { "description": "Affinity Group Preference Auto", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_oneOfAffinityPreferenceAutoOptionsDef" }, "affinityPerVrf": { "description": "Affinity Group Number for VRFs", "type": "array", "uniqueItems": true, "minItems": 0, "maxItems": 4, "items": { "type": "object", "properties": { "affinityGroupNumber": { "description": "Affinity Group Number", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "maximum": 63, "minimum": 1, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_affinityDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_oneOfAffinityGroupNumberOptionsDef" }, "vrfRange": { "description": "Range of VRFs", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minLength": 1, "maxLength": 11, "type": "string", "oneOf": [ { "pattern": "^([1-9]|[1-9][0-9]{1,3}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[01])$", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_vrfPatternDef" }, { "pattern": "^(([1-9]|[1-9][0-9]{1,3}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[01])-([1-9]|[1-9][0-9]{1,3}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[01]))$", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_vrfRangePatternDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_vrfRangeDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_oneOfVrfRangeOptionsDef" } }, "required": [], "additionalProperties": false } } }, "required": [ "clock", "description", "location", "gpsLocation", "deviceGroups", "overlayId", "portOffset", "portHop", "consoleBaudRate", "maxOmpSessions", "adminTechOnFailure", "onDemand" ], "additionalProperties": false } }, "required": [ "name", "data" ], "x-metadata": { "supportedDeviceTypes": [ "asr", "c1100", "c8000be", "csr1000v", "ir8100", "ir8340", "isr", "ISRv", "ir1101" ], "minVManageVersion": "26.1.1" }, "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPostRequest_SchemaPayload" }, "examples": { "Cedge_CG1_System_basic_parcel1": { "value": { "data": { "clock": { "timezone": { "optionType": "default", "value": "UTC" } }, "description": { "optionType": "global", "value": "nostrud ea" }, "location": { "optionType": "default" }, "deviceGroups": { "optionType": "default" }, "overlayId": { "optionType": "default", "value": 1 }, "portOffset": { "optionType": "global", "value": 19 }, "portHop": { "optionType": "default", "value": true }, "consoleBaudRate": { "optionType": "global", "value": "4800" }, "maxOmpSessions": { "optionType": "global", "value": 24 }, "adminTechOnFailure": { "optionType": "default", "value": true }, "idleTimeout": { "optionType": "global", "value": "10" }, "onDemand": { "onDemandEnable": { "optionType": "global", "value": true }, "onDemandIdleTimeout": { "optionType": "default", "value": 10 } }, "gpsLocation": { "longitude": { "optionType": "default" }, "latitude": { "optionType": "default" }, "geoFencing": { "enable": { "optionType": "global", "value": true }, "range": { "optionType": "global", "value": 100 }, "sms": { "enable": { "optionType": "global", "value": true }, "mobileNumber": { "number": { "optionType": "global", "value": "+11111233" } } } } }, "transportGateway": { "optionType": "default", "value": false }, "ppl": { "enable": { "optionType": "global", "value": true }, "localColors": { "optionType": "global", "value": "all" }, "flowSplitting": { "optionType": "global", "value": "max-pkts" }, "flowSplitMaxPkts": { "optionType": "global", "value": 1024 }, "ctg": { "optionType": "global", "value": "All tunnels" }, "reordering": { "optionType": "global", "value": true } } }, "description": "Cedge System Basic PArcel config", "name": "Cedge_CG1_System_basic_parcel1" }, "$$ref": "#/components/examples/ProfileparcelSdwanSystemBasicPostRequest_Cedge_CG1_System_basic_parcel1" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "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}" } }, "required": [ "id" ], "x-metadata": { "minVManageVersion": "20.15.1" }, "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelCommonPostResponse_SchemaPayload" }, "examples": { "example_1": { "value": { "id": "24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A" }, "$$ref": "#/components/examples/ProfileparcelCommonPostResponse_example_1" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Feature Profile > System > Basic-write" } }, "/v1/feature-profile/sdwan/system/{systemId}/basic/{basicId}": { "delete": { "tags": [ "Configuration - Feature Profile (SDWAN)" ], "description": "Delete a Basic Profile Feature for System feature profile", "operationId": "DeleteBasicProfileFeatureForSystem", "parameters": [ { "name": "systemId", "in": "path", "description": "Feature 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" } }, { "name": "basicId", "in": "path", "description": "Profile Feature 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": "Feature Profile > System > Basic-write" }, "get": { "tags": [ "Configuration - Feature Profile (SDWAN)" ], "description": "Get Basic Profile Feature by FeatureId for System feature profile", "operationId": "GetBasicProfileFeatureByFeatureIdForSystem", "parameters": [ { "name": "systemId", "in": "path", "description": "Feature 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" } }, { "name": "basicId", "in": "path", "description": "Profile Feature 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", "properties": { "parcelId": { "type": "string", "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}", "$$ref": "#/components/schemas/CommonCommonDefs_uuidDef" }, "parcelType": { "type": "string" }, "createdBy": { "type": "string", "description": "User who last created this.", "readOnly": true }, "createdOn": { "type": "integer", "description": "Timestamp of creation", "format": "int64", "readOnly": true }, "lastUpdatedBy": { "type": "string", "description": "User who last updated this.", "readOnly": true }, "lastUpdatedOn": { "type": "integer", "description": "Timestamp of last update", "format": "int64", "readOnly": true }, "payload": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[^&<>! \"]+$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_cgFpPpNameDef", "description": "Set the feature name" }, "description": { "description": "Set the feature description", "type": "string" }, "data": { "type": "object", "properties": { "clock": { "type": "object", "properties": { "timezone": { "description": "Set the timezone", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "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" ], "$$ref": "#/components/schemas/CommonCommonDefs_timezoneDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "string", "enum": [ "UTC" ], "$$ref": "#/components/schemas/CommonCommonDefs_utcTimezoneDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_oneOfTimezoneOptionsDef" } }, "required": [ "timezone" ] }, "description": { "description": "Set a text description of the device", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "minLength": 1, "maxLength": 32, "$$ref": "#/components/schemas/CommonCommonDefs_generalDescriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_oneOfDescriptionOptionsDef" }, "location": { "description": "Set the location of the device", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_generalLocationDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_oneOfLocationOptionsDef" }, "gpsLocation": { "type": "object", "properties": { "longitude": { "description": "Set the device physical longitude", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "number", "maximum": 180, "minimum": -180, "multipleOf": 1e-06, "$$ref": "#/components/schemas/CommonCommonDefs_longitudeDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_oneOfLongitudeOptionsDef" }, "latitude": { "description": "Set the device physical latitude", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "number", "maximum": 90, "minimum": -90, "multipleOf": 1e-06, "$$ref": "#/components/schemas/CommonCommonDefs_latitudeDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_oneOfLatitudeOptionsDef" }, "geoFencing": { "type": "object", "properties": { "enable": { "description": "Enable Geo fencing", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_oneOfEnableOptionsDef" }, "range": { "description": "Set the device\u2019s geo fencing range", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 100, "minimum": 100, "maximum": 10000, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_rangeDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "minimum": 100, "maximum": 100, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_defaultRangeDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_oneOfRangeOptionsDef" }, "sms": { "type": "object", "properties": { "enable": { "description": "Enable device\u2019s geo fencing SMS", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_oneOfEnableOptionsDef" }, "mobileNumber": { "description": "Set device\u2019s geo fencing SMS phone number", "type": "array", "uniqueItems": true, "items": { "type": "object", "properties": { "number": { "description": "Mobile number, ex: 1231234414", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minLength": 7, "type": "string", "maxLength": 20, "pattern": "[+][0-9]*", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_mobileNumberNumberDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_oneOfMobileNumberNumberOptionsDef" } }, "required": [ "number" ] } } } } } } }, "required": [ "longitude", "latitude" ] }, "ppl": { "type": "object", "properties": { "enable": { "description": "Enable PPL", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_oneOfEnableOptionsWithVariableDef" }, "localColors": { "description": "Set Local Colors", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "array", "uniqueItems": true, "minItems": 1, "maxItems": 100, "items": { "type": "string", "enum": [ "3g", "biz-internet", "blue", "bronze", "custom1", "custom2", "custom3", "default", "gold", "green", "lte", "metro-ethernet", "mpls", "private1", "private2", "private3", "private4", "private5", "private6", "public-internet", "red", "silver" ], "default": "3g", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_localColorEnumDef" }, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_allLocalColorDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "string", "enum": [ "all" ], "default": "all", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_defaultLocalColorDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_oneOfLocalColorDef" }, "flowSplitting": { "description": "Flow Splitting", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "enum": [ "Packets", "Packet Gap" ], "default": "Packets", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_allFlowSplittingDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "string", "enum": [ "Packets" ], "default": "Packets", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_defaultFlowSplittingDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_oneOfFlowSplittingDef" }, "flowSplitMaxDuration": { "description": "Flowlet size in milliseconds", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 1, "minimum": 1, "maximum": 100, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_maxDurationDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_oneOfMaxDurationDef" }, "flowSplitMaxPkts": { "description": "Flowlet size in packets", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 1024, "minimum": 1024, "maximum": 10240, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_maxPktsDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_oneOfMaxPktsDef" }, "flowSplitMaxSize": { "description": "Flowlet size in KB", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 10, "minimum": 10, "maximum": 1024, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_maxSizeDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_oneOfMaxSizeDef" }, "flowSplitPacketGapAdaptive": { "description": "Configure packet-gap splitting params Adaptive", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "enum": [ true, false ], "default": true, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_packetGapAdaptiveDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_oneOfPacketGapAdaptiveDef" }, "flowSplitPacketGapDuration": { "description": "Configure packet-gap splitting params Duration", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 1, "minimum": 1, "maximum": 100, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_packetGapDurationDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_oneOfPacketGapDurationDef" }, "ctg": { "description": "Configure top-tunnels to include in the CTG", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "enum": [ "All tunnels", "Latency Offset", "Adaptive cluster" ], "default": "All tunnels", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_ctgDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "string", "enum": [ "All tunnels" ], "default": "All tunnels", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_defaultCtgDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_oneOfCTGDef" }, "ctgLatencyOffset": { "description": "Configure CTG latency offset", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 10, "minimum": 1, "maximum": 100, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_ctgLatencyOffsetDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_oneOfCTGLatencyOffsetDef" }, "reordering": { "description": "Enable Reordering", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_oneOfEnableOptionsWithVariableDef" } }, "required": [ "enable", "reordering" ] }, "deviceGroups": { "description": "Device groups", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "items": { "type": "string", "minLength": 1, "$$ref": "#/components/schemas/CommonCommonDefs_nonEmptyStringDef" }, "additionalProperties": false, "uniqueItems": true, "type": "array", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_deviceGroupsDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_oneOfDeviceGroupsOptionsDef" }, "controllerGroupList": { "description": "Configure a list of comma-separated controller groups", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "items": { "type": "integer", "minimum": 1, "maximum": 100 }, "additionalProperties": false, "uniqueItems": true, "type": "array", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_controllerGroupListDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_oneOfControllerGroupListOptionsDef" }, "overlayId": { "description": "Set the Overlay ID", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 1, "maximum": 4294967295, "minimum": 1, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_overlayIdDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "maximum": 1, "minimum": 1, "type": "integer" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_oneOfOverlayIdOptionsDef" }, "portOffset": { "description": "Set the TLOC port offset when multiple devices are behind a NAT", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 0, "maximum": 19, "minimum": 0, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_portOffsetDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "maximum": 0, "minimum": 0, "type": "integer" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_oneOfPortOffsetOptionsDef" }, "portHop": { "description": "The port hop functionality is deprecated for devices 17.18 and higher. Use the full-port-hop field instead on interfaces.", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ true ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanTrueDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_oneOfPortHopOptionsDef" }, "controlSessionPps": { "description": "Set the policer rate for control sessions", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 300, "maximum": 65535, "minimum": 1, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_controlSessionPpsDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "maximum": 300, "minimum": 300, "type": "integer" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_oneOfControlSessionPpsOptionsDef" }, "trackTransport": { "description": "Configure tracking of transport", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ true ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanTrueDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_oneOfTrackTransportOptionsDef" }, "trackInterfaceTag": { "description": "OMP Tag attached to routes based on interface tracking", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "maximum": 4294967295, "minimum": 1, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_trackInterfaceTagDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_oneOfTrackInterfaceTagOptionsDef" }, "consoleBaudRate": { "description": "Set the console baud rate", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": "9600", "enum": [ "1200", "2400", "4800", "9600", "19200", "38400", "57600", "115200" ], "type": "string", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_consoleBaudRateDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "string", "enum": [ "9600" ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_oneOfConsoleBaudRateOptionsDef" }, "maxOmpSessions": { "description": "Set the maximum number of OMP sessions <1..100> the device can have", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "maximum": 100, "minimum": 1, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_maxOmpSessionsDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_oneOfMaxOmpSessionsOptionsDef" }, "multiTenant": { "description": "Device is multi-tenant", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_oneOfMultiTenantOptionsDef" }, "trackDefaultGateway": { "description": "Enable or disable default gateway tracking", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ true ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanTrueDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_oneOfTrackDefaultGatewayOptionsDef" }, "trackerDiaStabilizeStatus": { "description": "Enable or disable endpoint tracker diaStabilize status", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_oneOfTrackerDiaStabilizeStatusDef" }, "adminTechOnFailure": { "description": "Collect admin-tech before reboot due to daemon failure", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ true ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanTrueDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_oneOfAdminTechOnFailureOptionsDef" }, "idleTimeout": { "description": "Idle CLI timeout in minutes", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "maximum": 300, "minimum": 0, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_idleTimeoutDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_oneOfIdleTimeoutOptionsDef" }, "onDemand": { "type": "object", "properties": { "onDemandEnable": { "description": "Enable or disable On-demand Tunnel", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_oneOfOnDemandEnableOptionsDef" }, "onDemandIdleTimeout": { "description": "Set the idle timeout for on-demand tunnels", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 10, "maximum": 65535, "minimum": 1, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_onDemandIdleTimeoutDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "maximum": 10, "minimum": 10, "type": "integer" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_oneOfOnDemandIdleTimeoutOptionsDef" } }, "required": [ "onDemandEnable", "onDemandIdleTimeout" ] }, "transportGateway": { "description": "Enable transport gateway", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_oneOfTransportGatewayOptionsDef" }, "epfr": { "description": "Enable SLA Dampening and Enhanced App Routing.", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "enum": [ "disabled", "aggressive", "moderate", "conservative" ], "default": "disabled", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_epfrDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "string", "enum": [ "disabled" ] } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_oneOfEpfrOptions" }, "siteType": { "description": "Site Type", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "array", "uniqueItems": true, "minItems": 1, "maxItems": 4, "items": { "type": "string", "enum": [ "type-1", "type-2", "type-3", "cloud", "branch", "br", "spoke" ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_siteTypeDef" }, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_siteTypeListDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_oneOfSiteTypeOptionsDef" }, "affinityGroupNumber": { "description": "Affinity Group Number", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "maximum": 63, "minimum": 1, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_affinityDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_oneOfAffinityGroupNumberOptionsDef" }, "affinityGroupPreference": { "description": "Affinity Group Preference", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "array", "uniqueItems": true, "minItems": 1, "maxItems": 12, "items": { "maximum": 63, "minimum": 1, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_affinityDef" }, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_affinityPreferenceListDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_oneOfAffinityGroupPreferenceOptionsDef" }, "affinityPreferenceAuto": { "description": "Affinity Group Preference Auto", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_oneOfAffinityPreferenceAutoOptionsDef" }, "affinityPerVrf": { "description": "Affinity Group Number for VRFs", "type": "array", "uniqueItems": true, "minItems": 0, "maxItems": 4, "items": { "type": "object", "properties": { "affinityGroupNumber": { "description": "Affinity Group Number", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "maximum": 63, "minimum": 1, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_affinityDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_oneOfAffinityGroupNumberOptionsDef" }, "vrfRange": { "description": "Range of VRFs", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minLength": 1, "maxLength": 11, "type": "string", "oneOf": [ { "pattern": "^([1-9]|[1-9][0-9]{1,3}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[01])$", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_vrfPatternDef" }, { "pattern": "^(([1-9]|[1-9][0-9]{1,3}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[01])-([1-9]|[1-9][0-9]{1,3}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[01]))$", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_vrfRangePatternDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_vrfRangeDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_oneOfVrfRangeOptionsDef" } }, "required": [], "additionalProperties": false } } }, "required": [ "clock", "description", "location", "gpsLocation", "deviceGroups", "overlayId", "portOffset", "portHop", "consoleBaudRate", "maxOmpSessions", "adminTechOnFailure", "onDemand" ], "additionalProperties": false } }, "required": [ "name", "data" ], "x-metadata": { "supportedDeviceTypes": [ "asr", "c1100", "c8000be", "csr1000v", "ir8100", "ir8340", "isr", "ISRv", "ir1101" ], "minVManageVersion": "26.1.1" }, "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_SchemaPayload" } }, "$$ref": "#/components/schemas/getSingleSdwanSystemBasicPayload" }, "examples": { "get response example": { "value": { "parcelId": "09fc54fe-ff36-4640-ae57-c9e71a103902", "parcelType": "basic", "createdBy": "admin", "lastUpdatedBy": "admin", "createdOn": 1701866357838, "lastUpdatedOn": 1701866357838, "payload": { "data": { "clock": { "timezone": { "optionType": "default", "value": "UTC" } }, "description": { "optionType": "global", "value": "nostrud ea" }, "location": { "optionType": "default" }, "deviceGroups": { "optionType": "default" }, "overlayId": { "optionType": "default", "value": 1 }, "portOffset": { "optionType": "global", "value": 19 }, "portHop": { "optionType": "default", "value": true }, "consoleBaudRate": { "optionType": "global", "value": "4800" }, "maxOmpSessions": { "optionType": "global", "value": 24 }, "adminTechOnFailure": { "optionType": "default", "value": true }, "idleTimeout": { "optionType": "global", "value": "10" }, "onDemand": { "onDemandEnable": { "optionType": "global", "value": true }, "onDemandIdleTimeout": { "optionType": "default", "value": 10 } }, "gpsLocation": { "longitude": { "optionType": "default" }, "latitude": { "optionType": "default" }, "geoFencing": { "enable": { "optionType": "global", "value": true }, "range": { "optionType": "global", "value": 100 }, "sms": { "enable": { "optionType": "global", "value": true }, "mobileNumber": { "number": { "optionType": "global", "value": "+11111233" } } } } }, "transportGateway": { "optionType": "default", "value": false } } } }, "$$ref": "#/components/examples/getSingleSdwanSystemBasicExample" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Feature Profile > System > Basic-read" }, "put": { "tags": [ "Configuration - Feature Profile (SDWAN)" ], "description": "Update a Basic Profile Feature for System feature profile", "operationId": "EditBasicProfileFeatureForSystem", "parameters": [ { "name": "systemId", "in": "path", "description": "Feature 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" } }, { "name": "basicId", "in": "path", "description": "Profile Feature 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": "Basic Profile Feature", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[^&<>! \"]+$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_cgFpPpNameDef", "description": "Set the feature name" }, "description": { "description": "Set the feature description", "type": "string" }, "data": { "type": "object", "properties": { "clock": { "type": "object", "properties": { "timezone": { "description": "Set the timezone", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "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" ], "$$ref": "#/components/schemas/CommonCommonDefs_timezoneDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "string", "enum": [ "UTC" ], "$$ref": "#/components/schemas/CommonCommonDefs_utcTimezoneDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_oneOfTimezoneOptionsDef" } }, "required": [ "timezone" ] }, "description": { "description": "Set a text description of the device", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "minLength": 1, "maxLength": 32, "$$ref": "#/components/schemas/CommonCommonDefs_generalDescriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_oneOfDescriptionOptionsDef" }, "location": { "description": "Set the location of the device", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_generalLocationDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_oneOfLocationOptionsDef" }, "gpsLocation": { "type": "object", "properties": { "longitude": { "description": "Set the device physical longitude", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "number", "maximum": 180, "minimum": -180, "multipleOf": 1e-06, "$$ref": "#/components/schemas/CommonCommonDefs_longitudeDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_oneOfLongitudeOptionsDef" }, "latitude": { "description": "Set the device physical latitude", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "number", "maximum": 90, "minimum": -90, "multipleOf": 1e-06, "$$ref": "#/components/schemas/CommonCommonDefs_latitudeDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_oneOfLatitudeOptionsDef" }, "geoFencing": { "type": "object", "properties": { "enable": { "description": "Enable Geo fencing", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_oneOfEnableOptionsDef" }, "range": { "description": "Set the device\u2019s geo fencing range", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 100, "minimum": 100, "maximum": 10000, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_rangeDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "minimum": 100, "maximum": 100, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_defaultRangeDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_oneOfRangeOptionsDef" }, "sms": { "type": "object", "properties": { "enable": { "description": "Enable device\u2019s geo fencing SMS", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_oneOfEnableOptionsDef" }, "mobileNumber": { "description": "Set device\u2019s geo fencing SMS phone number", "type": "array", "uniqueItems": true, "items": { "type": "object", "properties": { "number": { "description": "Mobile number, ex: 1231234414", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minLength": 7, "type": "string", "maxLength": 20, "pattern": "[+][0-9]*", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_mobileNumberNumberDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_oneOfMobileNumberNumberOptionsDef" } }, "required": [ "number" ] } } } } } } }, "required": [ "longitude", "latitude" ] }, "ppl": { "type": "object", "properties": { "enable": { "description": "Enable PPL", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_oneOfEnableOptionsWithVariableDef" }, "localColors": { "description": "Set Local Colors", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "array", "uniqueItems": true, "minItems": 1, "maxItems": 100, "items": { "type": "string", "enum": [ "3g", "biz-internet", "blue", "bronze", "custom1", "custom2", "custom3", "default", "gold", "green", "lte", "metro-ethernet", "mpls", "private1", "private2", "private3", "private4", "private5", "private6", "public-internet", "red", "silver" ], "default": "3g", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_localColorEnumDef" }, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_allLocalColorDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "string", "enum": [ "all" ], "default": "all", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_defaultLocalColorDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_oneOfLocalColorDef" }, "flowSplitting": { "description": "Flow Splitting", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "enum": [ "Packets", "Packet Gap" ], "default": "Packets", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_allFlowSplittingDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "string", "enum": [ "Packets" ], "default": "Packets", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_defaultFlowSplittingDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_oneOfFlowSplittingDef" }, "flowSplitMaxDuration": { "description": "Flowlet size in milliseconds", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 1, "minimum": 1, "maximum": 100, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_maxDurationDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_oneOfMaxDurationDef" }, "flowSplitMaxPkts": { "description": "Flowlet size in packets", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 1024, "minimum": 1024, "maximum": 10240, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_maxPktsDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_oneOfMaxPktsDef" }, "flowSplitMaxSize": { "description": "Flowlet size in KB", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 10, "minimum": 10, "maximum": 1024, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_maxSizeDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_oneOfMaxSizeDef" }, "flowSplitPacketGapAdaptive": { "description": "Configure packet-gap splitting params Adaptive", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "enum": [ true, false ], "default": true, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_packetGapAdaptiveDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_oneOfPacketGapAdaptiveDef" }, "flowSplitPacketGapDuration": { "description": "Configure packet-gap splitting params Duration", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 1, "minimum": 1, "maximum": 100, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_packetGapDurationDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_oneOfPacketGapDurationDef" }, "ctg": { "description": "Configure top-tunnels to include in the CTG", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "enum": [ "All tunnels", "Latency Offset", "Adaptive cluster" ], "default": "All tunnels", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_ctgDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "string", "enum": [ "All tunnels" ], "default": "All tunnels", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_defaultCtgDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_oneOfCTGDef" }, "ctgLatencyOffset": { "description": "Configure CTG latency offset", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 10, "minimum": 1, "maximum": 100, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_ctgLatencyOffsetDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_oneOfCTGLatencyOffsetDef" }, "reordering": { "description": "Enable Reordering", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_oneOfEnableOptionsWithVariableDef" } }, "required": [ "enable", "reordering" ] }, "deviceGroups": { "description": "Device groups", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "items": { "type": "string", "minLength": 1, "$$ref": "#/components/schemas/CommonCommonDefs_nonEmptyStringDef" }, "additionalProperties": false, "uniqueItems": true, "type": "array", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_deviceGroupsDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_oneOfDeviceGroupsOptionsDef" }, "controllerGroupList": { "description": "Configure a list of comma-separated controller groups", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "items": { "type": "integer", "minimum": 1, "maximum": 100 }, "additionalProperties": false, "uniqueItems": true, "type": "array", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_controllerGroupListDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_oneOfControllerGroupListOptionsDef" }, "overlayId": { "description": "Set the Overlay ID", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 1, "maximum": 4294967295, "minimum": 1, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_overlayIdDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "maximum": 1, "minimum": 1, "type": "integer" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_oneOfOverlayIdOptionsDef" }, "portOffset": { "description": "Set the TLOC port offset when multiple devices are behind a NAT", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 0, "maximum": 19, "minimum": 0, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_portOffsetDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "maximum": 0, "minimum": 0, "type": "integer" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_oneOfPortOffsetOptionsDef" }, "portHop": { "description": "The port hop functionality is deprecated for devices 17.18 and higher. Use the full-port-hop field instead on interfaces.", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ true ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanTrueDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_oneOfPortHopOptionsDef" }, "controlSessionPps": { "description": "Set the policer rate for control sessions", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 300, "maximum": 65535, "minimum": 1, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_controlSessionPpsDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "maximum": 300, "minimum": 300, "type": "integer" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_oneOfControlSessionPpsOptionsDef" }, "trackTransport": { "description": "Configure tracking of transport", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ true ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanTrueDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_oneOfTrackTransportOptionsDef" }, "trackInterfaceTag": { "description": "OMP Tag attached to routes based on interface tracking", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "maximum": 4294967295, "minimum": 1, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_trackInterfaceTagDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_oneOfTrackInterfaceTagOptionsDef" }, "consoleBaudRate": { "description": "Set the console baud rate", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": "9600", "enum": [ "1200", "2400", "4800", "9600", "19200", "38400", "57600", "115200" ], "type": "string", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_consoleBaudRateDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "string", "enum": [ "9600" ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_oneOfConsoleBaudRateOptionsDef" }, "maxOmpSessions": { "description": "Set the maximum number of OMP sessions <1..100> the device can have", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "maximum": 100, "minimum": 1, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_maxOmpSessionsDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_oneOfMaxOmpSessionsOptionsDef" }, "multiTenant": { "description": "Device is multi-tenant", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_oneOfMultiTenantOptionsDef" }, "trackDefaultGateway": { "description": "Enable or disable default gateway tracking", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ true ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanTrueDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_oneOfTrackDefaultGatewayOptionsDef" }, "trackerDiaStabilizeStatus": { "description": "Enable or disable endpoint tracker diaStabilize status", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_oneOfTrackerDiaStabilizeStatusDef" }, "adminTechOnFailure": { "description": "Collect admin-tech before reboot due to daemon failure", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ true ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanTrueDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_oneOfAdminTechOnFailureOptionsDef" }, "idleTimeout": { "description": "Idle CLI timeout in minutes", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "maximum": 300, "minimum": 0, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_idleTimeoutDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_oneOfIdleTimeoutOptionsDef" }, "onDemand": { "type": "object", "properties": { "onDemandEnable": { "description": "Enable or disable On-demand Tunnel", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_oneOfOnDemandEnableOptionsDef" }, "onDemandIdleTimeout": { "description": "Set the idle timeout for on-demand tunnels", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 10, "maximum": 65535, "minimum": 1, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_onDemandIdleTimeoutDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "maximum": 10, "minimum": 10, "type": "integer" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_oneOfOnDemandIdleTimeoutOptionsDef" } }, "required": [ "onDemandEnable", "onDemandIdleTimeout" ] }, "transportGateway": { "description": "Enable transport gateway", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_oneOfTransportGatewayOptionsDef" }, "epfr": { "description": "Enable SLA Dampening and Enhanced App Routing.", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "enum": [ "disabled", "aggressive", "moderate", "conservative" ], "default": "disabled", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_epfrDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "string", "enum": [ "disabled" ] } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_oneOfEpfrOptions" }, "siteType": { "description": "Site Type", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "array", "uniqueItems": true, "minItems": 1, "maxItems": 4, "items": { "type": "string", "enum": [ "type-1", "type-2", "type-3", "cloud", "branch", "br", "spoke" ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_siteTypeDef" }, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_siteTypeListDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_oneOfSiteTypeOptionsDef" }, "affinityGroupNumber": { "description": "Affinity Group Number", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "maximum": 63, "minimum": 1, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_affinityDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_oneOfAffinityGroupNumberOptionsDef" }, "affinityGroupPreference": { "description": "Affinity Group Preference", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "array", "uniqueItems": true, "minItems": 1, "maxItems": 12, "items": { "maximum": 63, "minimum": 1, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_affinityDef" }, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_affinityPreferenceListDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_oneOfAffinityGroupPreferenceOptionsDef" }, "affinityPreferenceAuto": { "description": "Affinity Group Preference Auto", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_oneOfAffinityPreferenceAutoOptionsDef" }, "affinityPerVrf": { "description": "Affinity Group Number for VRFs", "type": "array", "uniqueItems": true, "minItems": 0, "maxItems": 4, "items": { "type": "object", "properties": { "affinityGroupNumber": { "description": "Affinity Group Number", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "maximum": 63, "minimum": 1, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_affinityDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_oneOfAffinityGroupNumberOptionsDef" }, "vrfRange": { "description": "Range of VRFs", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minLength": 1, "maxLength": 11, "type": "string", "oneOf": [ { "pattern": "^([1-9]|[1-9][0-9]{1,3}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[01])$", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_vrfPatternDef" }, { "pattern": "^(([1-9]|[1-9][0-9]{1,3}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[01])-([1-9]|[1-9][0-9]{1,3}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[01]))$", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_vrfRangePatternDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_vrfRangeDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_oneOfVrfRangeOptionsDef" } }, "required": [], "additionalProperties": false } } }, "required": [ "clock", "description", "location", "gpsLocation", "deviceGroups", "overlayId", "portOffset", "portHop", "consoleBaudRate", "maxOmpSessions", "adminTechOnFailure", "onDemand" ], "additionalProperties": false } }, "required": [ "name", "data" ], "x-metadata": { "supportedDeviceTypes": [ "asr", "c1100", "c8000be", "csr1000v", "ir8100", "ir8340", "isr", "ISRv", "ir1101" ], "minVManageVersion": "26.1.1" }, "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBasicPutRequest_SchemaPayload" }, "examples": { "Cedge_CG1_System_basic_parcel1": { "value": { "data": { "clock": { "timezone": { "optionType": "default", "value": "UTC" } }, "description": { "optionType": "global", "value": "nostrud ea" }, "location": { "optionType": "default" }, "deviceGroups": { "optionType": "default" }, "overlayId": { "optionType": "default", "value": 1 }, "portOffset": { "optionType": "global", "value": 19 }, "portHop": { "optionType": "default", "value": true }, "consoleBaudRate": { "optionType": "global", "value": "4800" }, "maxOmpSessions": { "optionType": "global", "value": 24 }, "adminTechOnFailure": { "optionType": "default", "value": true }, "idleTimeout": { "optionType": "global", "value": "10" }, "onDemand": { "onDemandEnable": { "optionType": "global", "value": true }, "onDemandIdleTimeout": { "optionType": "default", "value": 10 } }, "gpsLocation": { "longitude": { "optionType": "default" }, "latitude": { "optionType": "default" }, "geoFencing": { "enable": { "optionType": "global", "value": true }, "range": { "optionType": "global", "value": 100 }, "sms": { "enable": { "optionType": "global", "value": true }, "mobileNumber": { "number": { "optionType": "global", "value": "+11111233" } } } } }, "transportGateway": { "optionType": "default", "value": false } }, "description": "Cedge System Basic PArcel config", "name": "Cedge_CG1_System_basic_parcel1" }, "$$ref": "#/components/examples/ProfileparcelSdwanSystemBasicPutRequest_Cedge_CG1_System_basic_parcel1" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "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}" } }, "required": [ "id" ], "x-metadata": { "minVManageVersion": "20.15.1" }, "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelCommonPutResponse_SchemaPayload" }, "examples": { "example_1": { "value": { "id": "24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A" }, "$$ref": "#/components/examples/ProfileparcelCommonPutResponse_example_1" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Feature Profile > System > Basic-write" } }, "/v1/feature-profile/sdwan/system/{systemId}/bfd": { "get": { "tags": [ "Configuration - Feature Profile (SDWAN)" ], "description": "Get Bfd Profile Parcels for System feature profile", "operationId": "GetBfdProfileParcelForSystem", "parameters": [ { "name": "systemId", "in": "path", "description": "Feature 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", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "parcelId": { "type": "string", "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}", "$$ref": "#/components/schemas/CommonCommonDefs_uuidDef" }, "parcelType": { "type": "string" }, "createdBy": { "type": "string", "description": "User who last created this.", "readOnly": true }, "createdOn": { "type": "integer", "description": "Timestamp of creation", "format": "int64", "readOnly": true }, "lastUpdatedBy": { "type": "string", "description": "User who last updated this.", "readOnly": true }, "lastUpdatedOn": { "type": "integer", "description": "Timestamp of last update", "format": "int64", "readOnly": true }, "payload": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[^&<>! \"]+$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_cgFpPpNameDef" }, "description": { "type": "string" }, "data": { "type": "object", "properties": { "multiplier": { "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 6, "maximum": 6, "minimum": 1, "type": "number", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBfdPostRequest_multiplierDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "minimum": 6, "maximum": 6 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBfdPostRequest_oneOfMultiplierOptions" }, "pollInterval": { "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 600000, "maximum": 4294967295, "minimum": 1, "type": "number", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBfdPostRequest_pollIntervalDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "minimum": 600000, "maximum": 600000 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBfdPostRequest_oneOfPollIntervalOptions" }, "defaultDscp": { "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 48, "maximum": 63, "minimum": 0, "type": "number", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBfdPostRequest_defaultDscpDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "minimum": 48, "maximum": 48 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBfdPostRequest_oneOfDefaultDscpOptions" }, "colors": { "description": "Set color that identifies the WAN transport tunnel", "type": "array", "uniqueItems": true, "items": { "if": { "anyOf": [ { "properties": { "color": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "color" ] }, { "properties": { "helloInterval": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "helloInterval" ] }, { "properties": { "multiplier": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "multiplier" ] }, { "properties": { "pmtuDiscovery": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "pmtuDiscovery" ] }, { "properties": { "dscp": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "dscp" ] } ] }, "then": { "required": [ "color", "helloInterval", "multiplier", "pmtuDiscovery", "dscp" ] }, "type": "object", "properties": { "color": { "description": "Color that identifies the WAN transport tunnel", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "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" ], "type": "string", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBfdPostRequest_colorDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBfdPostRequest_oneOfColorOptions" }, "helloInterval": { "description": "Hello Interval (milliseconds)", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 1000, "maximum": 300000, "minimum": 100, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBfdPostRequest_helloIntervalDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "minimum": 1000, "maximum": 1000 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBfdPostRequest_oneOfHelloIntervalOptions" }, "multiplier": { "description": "Multiplier", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 7, "maximum": 60, "minimum": 1, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBfdPostRequest_colorMultiplierDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "minimum": 7, "maximum": 7 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBfdPostRequest_oneOfColorMultiplierOptions" }, "pmtuDiscovery": { "description": "Path MTU Discovery", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ true ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanTrueDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBfdPostRequest_oneOfPmtuDiscoveryOptions" }, "dscp": { "description": "BFD Default DSCP value for tloc color", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 48, "maximum": 63, "minimum": 0, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBfdPostRequest_colorDscpDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "minimum": 48, "maximum": 48 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBfdPostRequest_oneOfColorDscpOptions" } }, "additionalProperties": false } } }, "required": [ "multiplier", "pollInterval", "defaultDscp" ], "additionalProperties": false } }, "required": [ "name", "data" ], "x-metadata": { "supportedDeviceTypes": [ "asr", "c1100", "c8000be", "csr1000v", "ir8100", "ir8340", "isr", "ISRv", "ir1101" ], "minVManageVersion": "20.17.1" }, "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBfdPostRequest_SchemaPayload" } } } } }, "$$ref": "#/components/schemas/getListSdwanSystemBfdPayload" }, "examples": { "get response example": { "value": { "header": { "generatedOn": 1702438718825 }, "data": [ { "parcelId": "09fc54fe-ff36-4640-ae57-c9e71a103902", "parcelType": "bfd", "createdBy": "admin", "lastUpdatedBy": "admin", "createdOn": 1701866357838, "lastUpdatedOn": 1701866357838, "payload": { "data": { "multiplier": { "optionType": "global", "value": 6 }, "pollInterval": { "optionType": "global", "value": 600000 }, "defaultDscp": { "optionType": "global", "value": 48 }, "color": [ { "color": { "optionType": "global", "value": "MPLS" }, "helloInterval": { "optionType": "global", "value": 1000 }, "multiplier": { "optionType": "global", "value": 7 }, "pmtuDiscovery": { "optionType": "global", "value": true }, "dscp": { "optionType": "global", "value": 48 } } ] } } } ] }, "$$ref": "#/components/examples/getListSdwanSystemBfdExample" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Feature Profile > System > Bfd-read" }, "post": { "tags": [ "Configuration - Feature Profile (SDWAN)" ], "description": "Create a Bfd Profile Parcel for System feature profile", "operationId": "CreateBfdProfileParcelForSystem", "parameters": [ { "name": "systemId", "in": "path", "description": "Feature 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": "Bfd Profile Parcel", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[^&<>! \"]+$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_cgFpPpNameDef" }, "description": { "type": "string" }, "data": { "type": "object", "properties": { "multiplier": { "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 6, "maximum": 6, "minimum": 1, "type": "number", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBfdPostRequest_multiplierDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "minimum": 6, "maximum": 6 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBfdPostRequest_oneOfMultiplierOptions" }, "pollInterval": { "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 600000, "maximum": 4294967295, "minimum": 1, "type": "number", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBfdPostRequest_pollIntervalDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "minimum": 600000, "maximum": 600000 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBfdPostRequest_oneOfPollIntervalOptions" }, "defaultDscp": { "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 48, "maximum": 63, "minimum": 0, "type": "number", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBfdPostRequest_defaultDscpDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "minimum": 48, "maximum": 48 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBfdPostRequest_oneOfDefaultDscpOptions" }, "colors": { "description": "Set color that identifies the WAN transport tunnel", "type": "array", "uniqueItems": true, "items": { "if": { "anyOf": [ { "properties": { "color": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "color" ] }, { "properties": { "helloInterval": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "helloInterval" ] }, { "properties": { "multiplier": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "multiplier" ] }, { "properties": { "pmtuDiscovery": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "pmtuDiscovery" ] }, { "properties": { "dscp": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "dscp" ] } ] }, "then": { "required": [ "color", "helloInterval", "multiplier", "pmtuDiscovery", "dscp" ] }, "type": "object", "properties": { "color": { "description": "Color that identifies the WAN transport tunnel", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "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" ], "type": "string", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBfdPostRequest_colorDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBfdPostRequest_oneOfColorOptions" }, "helloInterval": { "description": "Hello Interval (milliseconds)", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 1000, "maximum": 300000, "minimum": 100, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBfdPostRequest_helloIntervalDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "minimum": 1000, "maximum": 1000 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBfdPostRequest_oneOfHelloIntervalOptions" }, "multiplier": { "description": "Multiplier", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 7, "maximum": 60, "minimum": 1, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBfdPostRequest_colorMultiplierDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "minimum": 7, "maximum": 7 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBfdPostRequest_oneOfColorMultiplierOptions" }, "pmtuDiscovery": { "description": "Path MTU Discovery", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ true ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanTrueDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBfdPostRequest_oneOfPmtuDiscoveryOptions" }, "dscp": { "description": "BFD Default DSCP value for tloc color", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 48, "maximum": 63, "minimum": 0, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBfdPostRequest_colorDscpDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "minimum": 48, "maximum": 48 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBfdPostRequest_oneOfColorDscpOptions" } }, "additionalProperties": false } } }, "required": [ "multiplier", "pollInterval", "defaultDscp" ], "additionalProperties": false } }, "required": [ "name", "data" ], "x-metadata": { "supportedDeviceTypes": [ "asr", "c1100", "c8000be", "csr1000v", "ir8100", "ir8340", "isr", "ISRv", "ir1101" ], "minVManageVersion": "20.17.1" }, "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBfdPostRequest_SchemaPayload" }, "examples": { "SystemBfdParcelGlobalDefault": { "value": { "data": { "multiplier": { "optionType": "global", "value": 6 }, "pollInterval": { "optionType": "global", "value": 600000 }, "defaultDscp": { "optionType": "global", "value": 48 }, "color": [ { "color": { "optionType": "global", "value": "MPLS" }, "helloInterval": { "optionType": "global", "value": 1000 }, "multiplier": { "optionType": "global", "value": 7 }, "pmtuDiscovery": { "optionType": "global", "value": true }, "dscp": { "optionType": "global", "value": 48 } } ] }, "name": "SystemBfdParcelGlobalDefault" }, "$$ref": "#/components/examples/ProfileparcelSdwanSystemBfdPostRequest_SystemBfdParcelGlobalDefault" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "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}" } }, "required": [ "id" ], "x-metadata": { "minVManageVersion": "20.15.1" }, "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelCommonPostResponse_SchemaPayload" }, "examples": { "example_1": { "value": { "id": "24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A" }, "$$ref": "#/components/examples/ProfileparcelCommonPostResponse_example_1" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Feature Profile > System > Bfd-write" } }, "/v1/feature-profile/sdwan/system/{systemId}/bfd/{bfdId}": { "get": { "tags": [ "Configuration - Feature Profile (SDWAN)" ], "description": "Get Bfd Profile Parcel by parcelId for System feature profile", "operationId": "GetBfdProfileParcelByParcelIdForSystem", "parameters": [ { "name": "systemId", "in": "path", "description": "Feature 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" } }, { "name": "bfdId", "in": "path", "description": "Profile Parcel 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", "properties": { "parcelId": { "type": "string", "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}", "$$ref": "#/components/schemas/CommonCommonDefs_uuidDef" }, "parcelType": { "type": "string" }, "createdBy": { "type": "string", "description": "User who last created this.", "readOnly": true }, "createdOn": { "type": "integer", "description": "Timestamp of creation", "format": "int64", "readOnly": true }, "lastUpdatedBy": { "type": "string", "description": "User who last updated this.", "readOnly": true }, "lastUpdatedOn": { "type": "integer", "description": "Timestamp of last update", "format": "int64", "readOnly": true }, "payload": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[^&<>! \"]+$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_cgFpPpNameDef" }, "description": { "type": "string" }, "data": { "type": "object", "properties": { "multiplier": { "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 6, "maximum": 6, "minimum": 1, "type": "number", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBfdPutRequest_multiplierDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "minimum": 6, "maximum": 6 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBfdPutRequest_oneOfMultiplierOptions" }, "pollInterval": { "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 600000, "maximum": 4294967295, "minimum": 1, "type": "number", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBfdPutRequest_pollIntervalDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "minimum": 600000, "maximum": 600000 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBfdPutRequest_oneOfPollIntervalOptions" }, "defaultDscp": { "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 48, "maximum": 63, "minimum": 0, "type": "number", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBfdPutRequest_defaultDscpDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "minimum": 48, "maximum": 48 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBfdPutRequest_oneOfDefaultDscpOptions" }, "colors": { "description": "Set color that identifies the WAN transport tunnel", "type": "array", "uniqueItems": true, "items": { "if": { "anyOf": [ { "properties": { "color": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "color" ] }, { "properties": { "helloInterval": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "helloInterval" ] }, { "properties": { "multiplier": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "multiplier" ] }, { "properties": { "pmtuDiscovery": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "pmtuDiscovery" ] }, { "properties": { "dscp": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "dscp" ] } ] }, "then": { "required": [ "color", "helloInterval", "multiplier", "pmtuDiscovery", "dscp" ] }, "type": "object", "properties": { "color": { "description": "Color that identifies the WAN transport tunnel", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "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" ], "type": "string", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBfdPutRequest_colorDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBfdPutRequest_oneOfColorOptions" }, "helloInterval": { "description": "Hello Interval (milliseconds)", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 1000, "maximum": 300000, "minimum": 100, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBfdPutRequest_helloIntervalDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "minimum": 1000, "maximum": 1000 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBfdPutRequest_oneOfHelloIntervalOptions" }, "multiplier": { "description": "Multiplier", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 7, "maximum": 60, "minimum": 1, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBfdPutRequest_colorMultiplierDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "minimum": 7, "maximum": 7 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBfdPutRequest_oneOfColorMultiplierOptions" }, "pmtuDiscovery": { "description": "Path MTU Discovery", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ true ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanTrueDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBfdPutRequest_oneOfPmtuDiscoveryOptions" }, "dscp": { "description": "BFD Default DSCP value for tloc color", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 48, "maximum": 63, "minimum": 0, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBfdPutRequest_colorDscpDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "minimum": 48, "maximum": 48 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBfdPutRequest_oneOfColorDscpOptions" } }, "additionalProperties": false } } }, "required": [ "multiplier", "pollInterval", "defaultDscp" ], "additionalProperties": false } }, "required": [ "name", "data" ], "x-metadata": { "supportedDeviceTypes": [ "asr", "c1100", "c8000be", "csr1000v", "ir8100", "ir8340", "isr", "ISRv", "ir1101" ], "minVManageVersion": "20.17.1" }, "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBfdPutRequest_SchemaPayload" } }, "$$ref": "#/components/schemas/getSingleSdwanSystemBfdPayload" }, "examples": { "get response example": { "value": { "parcelId": "09fc54fe-ff36-4640-ae57-c9e71a103902", "parcelType": "bfd", "createdBy": "admin", "lastUpdatedBy": "admin", "createdOn": 1701866357838, "lastUpdatedOn": 1701866357838, "payload": { "data": { "multiplier": { "optionType": "global", "value": 6 }, "pollInterval": { "optionType": "global", "value": 600000 }, "defaultDscp": { "optionType": "global", "value": 48 }, "color": [ { "color": { "optionType": "global", "value": "MPLS" }, "helloInterval": { "optionType": "global", "value": 1000 }, "multiplier": { "optionType": "global", "value": 7 }, "pmtuDiscovery": { "optionType": "global", "value": true }, "dscp": { "optionType": "global", "value": 48 } } ] } } }, "$$ref": "#/components/examples/getSingleSdwanSystemBfdExample" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Feature Profile > System > Bfd-read" }, "put": { "tags": [ "Configuration - Feature Profile (SDWAN)" ], "description": "Update a Bfd Profile Parcel for System feature profile", "operationId": "EditBfdProfileParcelForSystem", "parameters": [ { "name": "systemId", "in": "path", "description": "Feature 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" } }, { "name": "bfdId", "in": "path", "description": "Profile Parcel 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": "Bfd Profile Parcel", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[^&<>! \"]+$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_cgFpPpNameDef" }, "description": { "type": "string" }, "data": { "type": "object", "properties": { "multiplier": { "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 6, "maximum": 6, "minimum": 1, "type": "number", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBfdPutRequest_multiplierDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "minimum": 6, "maximum": 6 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBfdPutRequest_oneOfMultiplierOptions" }, "pollInterval": { "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 600000, "maximum": 4294967295, "minimum": 1, "type": "number", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBfdPutRequest_pollIntervalDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "minimum": 600000, "maximum": 600000 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBfdPutRequest_oneOfPollIntervalOptions" }, "defaultDscp": { "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 48, "maximum": 63, "minimum": 0, "type": "number", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBfdPutRequest_defaultDscpDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "minimum": 48, "maximum": 48 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBfdPutRequest_oneOfDefaultDscpOptions" }, "colors": { "description": "Set color that identifies the WAN transport tunnel", "type": "array", "uniqueItems": true, "items": { "if": { "anyOf": [ { "properties": { "color": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "color" ] }, { "properties": { "helloInterval": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "helloInterval" ] }, { "properties": { "multiplier": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "multiplier" ] }, { "properties": { "pmtuDiscovery": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "pmtuDiscovery" ] }, { "properties": { "dscp": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "dscp" ] } ] }, "then": { "required": [ "color", "helloInterval", "multiplier", "pmtuDiscovery", "dscp" ] }, "type": "object", "properties": { "color": { "description": "Color that identifies the WAN transport tunnel", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "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" ], "type": "string", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBfdPutRequest_colorDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBfdPutRequest_oneOfColorOptions" }, "helloInterval": { "description": "Hello Interval (milliseconds)", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 1000, "maximum": 300000, "minimum": 100, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBfdPutRequest_helloIntervalDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "minimum": 1000, "maximum": 1000 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBfdPutRequest_oneOfHelloIntervalOptions" }, "multiplier": { "description": "Multiplier", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 7, "maximum": 60, "minimum": 1, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBfdPutRequest_colorMultiplierDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "minimum": 7, "maximum": 7 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBfdPutRequest_oneOfColorMultiplierOptions" }, "pmtuDiscovery": { "description": "Path MTU Discovery", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ true ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanTrueDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBfdPutRequest_oneOfPmtuDiscoveryOptions" }, "dscp": { "description": "BFD Default DSCP value for tloc color", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 48, "maximum": 63, "minimum": 0, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBfdPutRequest_colorDscpDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "minimum": 48, "maximum": 48 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBfdPutRequest_oneOfColorDscpOptions" } }, "additionalProperties": false } } }, "required": [ "multiplier", "pollInterval", "defaultDscp" ], "additionalProperties": false } }, "required": [ "name", "data" ], "x-metadata": { "supportedDeviceTypes": [ "asr", "c1100", "c8000be", "csr1000v", "ir8100", "ir8340", "isr", "ISRv", "ir1101" ], "minVManageVersion": "20.17.1" }, "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemBfdPutRequest_SchemaPayload" }, "examples": { "SystemBfdParcelGlobalDefault": { "value": { "data": { "multiplier": { "optionType": "global", "value": 6 }, "pollInterval": { "optionType": "global", "value": 600000 }, "defaultDscp": { "optionType": "global", "value": 48 }, "color": [ { "color": { "optionType": "global", "value": "MPLS" }, "helloInterval": { "optionType": "global", "value": 1000 }, "multiplier": { "optionType": "global", "value": 7 }, "pmtuDiscovery": { "optionType": "global", "value": true }, "dscp": { "optionType": "global", "value": 48 } } ] }, "name": "SystemBfdParcelGlobalDefault" }, "$$ref": "#/components/examples/ProfileparcelSdwanSystemBfdPutRequest_SystemBfdParcelGlobalDefault" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "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}" } }, "required": [ "id" ], "x-metadata": { "minVManageVersion": "20.15.1" }, "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelCommonPutResponse_SchemaPayload" }, "examples": { "example_1": { "value": { "id": "24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A" }, "$$ref": "#/components/examples/ProfileparcelCommonPutResponse_example_1" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Feature Profile > System > Bfd-write" }, "delete": { "tags": [ "Configuration - Feature Profile (SDWAN)" ], "description": "Delete a Bfd Profile Parcel for System feature profile", "operationId": "DeleteBfdProfileParcelForSystem", "parameters": [ { "name": "systemId", "in": "path", "description": "Feature 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" } }, { "name": "bfdId", "in": "path", "description": "Profile Parcel 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": "Feature Profile > System > Bfd-write" } }, "/v1/feature-profile/sdwan/system/{systemId}/global": { "get": { "tags": [ "Configuration - Feature Profile (SDWAN)" ], "description": "Get Global Profile Parcels for System feature profile", "operationId": "GetGlobalProfileParcelForSystem", "parameters": [ { "name": "systemId", "in": "path", "description": "Feature 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", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "parcelId": { "type": "string", "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}", "$$ref": "#/components/schemas/CommonCommonDefs_uuidDef" }, "parcelType": { "type": "string" }, "createdBy": { "type": "string", "description": "User who last created this.", "readOnly": true }, "createdOn": { "type": "integer", "description": "Timestamp of creation", "format": "int64", "readOnly": true }, "lastUpdatedBy": { "type": "string", "description": "User who last updated this.", "readOnly": true }, "lastUpdatedOn": { "type": "integer", "description": "Timestamp of last update", "format": "int64", "readOnly": true }, "payload": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[^&<>! \"]+$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_cgFpPpNameDef", "description": "Set the parcel name" }, "description": { "description": "Set the parcel description", "type": "string" }, "data": { "type": "object", "properties": { "services_global": { "type": "object", "properties": { "services_ip": { "type": "object", "properties": { "servicesGlobalServicesIpHttpServer": { "description": "Set a HTTP Server", "type": "object", "x-attributeMetadata": { "insecureConfiguration": { "attributeJsonPath": "$.data.services_global.services_ip.servicesGlobalServicesIpHttpServer.value", "values": [ true ], "description": "HTTP server enabled - unencrypted protocol vulnerable to eavesdropping and man-in-the-middle attacks", "reason": "Legacy protocol poses data confidentiality and integrity risks due to lack of encryption and authentication", "remediation": "Use http secure server to ensure secure web access" } }, "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPostRequest_oneOfServerDefaultFalseOptionsDef" }, "servicesGlobalServicesIpHttpsServer": { "description": "Set a HTTPS Server", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPostRequest_oneOfServerDefaultFalseOptionsDef" }, "servicesGlobalServicesIpFtpPassive": { "description": "Set Passive FTP", "type": "object", "x-attributeMetadata": { "insecureConfiguration": { "attributeJsonPath": "$.data.services_global.services_ip.servicesGlobalServicesIpFtpPassive.value", "values": [ true ], "description": "FTP service enabled - transmits credentials and data in plain text, vulnerable to interception", "reason": "Legacy protocol poses data confidentiality and integrity risks due to lack of encryption and authentication", "remediation": "Remove FTP configuration and transition to secure file transfer methods using SCP, SFTP, HTTPS protocols" } }, "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPostRequest_oneOfServerDefaultFalseOptionsDef" }, "servicesGlobalServicesIpDomainLookup": { "description": "Configure Domain-Lookup", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPostRequest_oneOfServerDefaultFalseOptionsDef" }, "servicesGlobalServicesIpArpProxy": { "description": "Set ARP Proxy", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPostRequest_oneOfServerDefaultFalseOptionsDef" }, "servicesGlobalServicesIpRcmd": { "description": "Set RSH/RCP", "type": "object", "x-attributeMetadata": { "insecureConfiguration": { "attributeJsonPath": "$.data.services_global.services_ip.servicesGlobalServicesIpRcmd.value", "values": [ true ], "description": "Remote command (rcmd) service enabled - allows unencrypted remote command execution without proper authentication", "reason": "No encryption is configured", "remediation": "This is a legacy feature, please consider disabling it" } }, "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPostRequest_oneOfServerDefaultFalseOptionsDef" }, "servicesGlobalServicesIpLineVty": { "description": "Configure Telnet (Outbound)", "type": "object", "x-attributeMetadata": { "insecureConfiguration": { "attributeJsonPath": "$.data.services_global.services_ip.servicesGlobalServicesIpLineVty.value", "values": [ true ], "description": "Line transport configured with unencrypted protocols - allows plaintext transmission of sensitive data", "reason": "Legacy protocol poses data confidentiality and integrity risks due to lack of encryption and authentication", "remediation": "Migrate to secure SSH-based remote access" } }, "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPostRequest_oneOfServerDefaultFalseOptionsDef" }, "servicesGlobalServicesIpCdp": { "description": "Configure CDP", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ true ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanTrueDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPostRequest_oneOfServerDefaultTrueOptionsDef" }, "servicesGlobalServicesIpLldp": { "description": "Configure LLDP", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ true ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanTrueDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPostRequest_oneOfServerDefaultTrueOptionsDef" }, "servicesGlobalServicesIpSourceIntrf": { "description": "Specify interface for source address in all HTTP(S) client connections", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "pattern": "(ATM|ATM-ACR|AppGigabitEthernet|AppNav-Compress|AppNav-UnCompress|Async|BD-VIF|BDI|CEM|CEM-ACR|Cellular|Dialer|Embedded-Service-Engine|Ethernet|Ethernet-Internal|FastEthernet|FiftyGigabitEthernet|FiveGigabitEthernet|FortyGigabitEthernet|FourHundredGigE|GMPLS|GigabitEthernet|Group-Async|HundredGigE|L2LISP|LISP|Loopback|MFR|Multilink|Port-channel|SM|Serial|Service-Engine|TenGigabitEthernet|Tunnel|TwentyFiveGigE|TwentyFiveGigabitEthernet|TwoGigabitEthernet|TwoHundredGigE|Vif|Virtual-PPP|Virtual-Template|VirtualPortGroup|Vlan|Wlan-GigabitEthernet|nat64|nat66|ntp|nve|ospfv3|overlay|pseudowire|ucse|vasileft|vasiright|vmi)([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]+)", "minLength": 3, "maxLength": 32, "$$ref": "#/components/schemas/CommonCommonDefs_ifNameDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPostRequest_oneOfSourceInterfaceOptionsDef" }, "globalOtherSettingsTcpKeepalivesIn": { "description": "Configure tcp-keepalives-in", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ true ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanTrueDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPostRequest_oneOfServerDefaultTrueOptionsDef" }, "globalOtherSettingsTcpKeepalivesOut": { "description": "Configure tcp-keepalives-out", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ true ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanTrueDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPostRequest_oneOfServerDefaultTrueOptionsDef" }, "globalOtherSettingsTcpSmallServers": { "description": "Configure tcp-small-servers", "type": "object", "x-attributeMetadata": { "insecureConfiguration": { "attributeJsonPath": "$.data.services_global.services_ip.globalOtherSettingsTcpSmallServers.value", "values": [ true ], "description": "TCP small servers enabled - provides unnecessary services like echo, discard, and daytime that can be exploited", "reason": "TCP small servers expose unnecessary network services and potential attack vectors", "remediation": "Disable small servers and use modern network diagnostic tools like ping, traceroute, or SSH-based commands" } }, "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPostRequest_oneOfServerDefaultFalseOptionsDef" }, "globalOtherSettingsUdpSmallServers": { "description": "Configure udp-small-servers", "type": "object", "x-attributeMetadata": { "insecureConfiguration": { "attributeJsonPath": "$.data.services_global.services_ip.globalOtherSettingsUdpSmallServers.value", "values": [ true ], "description": "UDP small servers enabled - provides unnecessary services that can be used for DDoS amplification attacks", "reason": "UDP small servers expose unnecessary network services and potential attack vectors", "remediation": "Disable small servers and use modern network diagnostic tools like ping, traceroute, or SSH-based commands" } }, "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPostRequest_oneOfServerDefaultFalseOptionsDef" }, "globalOtherSettingsConsoleLogging": { "description": "Configure Console Logging", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ true ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanTrueDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPostRequest_oneOfServerDefaultTrueOptionsDef" }, "globalOtherSettingsIPSourceRoute": { "description": "Set Source Route", "type": "object", "x-attributeMetadata": { "insecureConfiguration": { "attributeJsonPath": "$.data.services_global.services_ip.globalOtherSettingsIPSourceRoute.value", "values": [ true ], "description": "IP source routing enabled - allows attackers to specify packet routing and bypass security controls", "reason": "IP source routing allows attackers to bypass network security controls and routing policies", "remediation": "This is a legacy feature, please consider disabling it" } }, "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPostRequest_oneOfServerDefaultFalseOptionsDef" }, "globalOtherSettingsVtyLineLogging": { "description": "Configure VTY Line Logging", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPostRequest_oneOfServerDefaultFalseOptionsDef" }, "globalOtherSettingsSnmpIfindexPersist": { "description": "Configure SNMP Ifindex Persist", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ true ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanTrueDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPostRequest_oneOfServerDefaultTrueOptionsDef" }, "globalOtherSettingsIgnoreBootp": { "description": "Configure Ignore BOOTP", "type": "object", "x-attributeMetadata": { "insecureConfiguration": { "attributeJsonPath": "$.data.services_global.services_ip.globalOtherSettingsIgnoreBootp.value", "values": [ false ], "description": "BOOTP server enabled - legacy protocol vulnerable to man-in-the-middle attacks and lacks security features", "reason": "Legacy protocol poses data confidentiality and integrity risks due to lack of encryption and authentication", "remediation": "Use DHCP to automatically configure network settings" } }, "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ true ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanTrueDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPostRequest_oneOfServerDefaultTrueOptionsDef" }, "globalOtherSettingsIntfPerMin": { "description": "Configure Interface Statistics Per Minute", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "enum": [ "1", "5" ], "type": "string", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPostRequest_interfaceIntervalDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "enum": [ "5" ], "default": "5", "type": "string", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPostRequest_defaultInterfaceIntervalDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPostRequest_oneOfInterfaceIntervalOptionsDef" }, "globalSettingsNat64UdpTimeout": { "description": "Set NAT64 UDP session timeout, in seconds", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 300, "minimum": 1, "maximum": 536870, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPostRequest_udpTimeoutDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "minimum": 300, "maximum": 300, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPostRequest_defaultUdpTimeoutDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPostRequest_oneOfUdpTimeoutOptionsDef" }, "globalSettingsNat64TcpTimeout": { "description": "Set NAT64 TCP session timeout, in seconds", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 3600, "minimum": 1, "maximum": 536870, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPostRequest_tcpTimeoutDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "minimum": 3600, "maximum": 3600, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPostRequest_defaultTcpTimeoutDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPostRequest_oneOfTcpTimeoutOptionsDef" }, "globalSettingsHttpAuthentication": { "description": "Set preference for HTTP Authentication", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "enum": [ "local", "aaa" ], "type": "string", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPostRequest_httpAuthenticationDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionNoDefaultDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPostRequest_oneOfHttpAuthenticationOptionsDef" }, "globalSettingsSSHVersion": { "description": "Set SSH version", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "enum": [ "2" ], "type": "string", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPostRequest_versionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionNoDefaultDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPostRequest_oneOfVersionOptionsDef" }, "lacpSystemPriority": { "description": "Set LACP system priority", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minimum": 1, "maximum": 65535, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPostRequest_lacpSystemPriorityDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionNoDefaultDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPostRequest_oneOfLacpSystemPriorityOptionsDef" }, "etherchannelFlowLoadBalance": { "description": "Set Etherchannel load balance hash algorithm", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "enum": [ "src-ip", "dst-ip", "src-dst-ip", "src-mac", "dst-mac", "src-dst-mac", "src-dst-mixed-ip-port", "sdwan" ], "type": "string", "default": "src-dst-ip", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPostRequest_etherchannelFlowLBDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionNoDefaultDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPostRequest_oneOfEtherchannelFlowLBOptionsDef" }, "etherchannelVlanLoadBalance": { "description": "Set Etherchannel vlan manual load balance", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPostRequest_oneOfServerDefaultFalseOptionsDef" }, "bgpCommunityNewFormat": { "description": "Display community attributes in the newer format. Instead of displaying communities as a 32-bit value, it shows them as two 16-bit integers separated by a colon (AA:NN format)", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPostRequest_oneOfServerDefaultFalseOptionsDef" } }, "required": [ "servicesGlobalServicesIpHttpServer", "servicesGlobalServicesIpHttpsServer", "servicesGlobalServicesIpFtpPassive", "servicesGlobalServicesIpDomainLookup", "servicesGlobalServicesIpArpProxy", "servicesGlobalServicesIpRcmd", "servicesGlobalServicesIpLineVty", "servicesGlobalServicesIpCdp", "servicesGlobalServicesIpLldp" ], "additionalProperties": false } }, "required": [ "services_ip" ], "additionalProperties": false } }, "required": [ "services_global" ], "additionalProperties": false } }, "required": [ "name", "data" ], "x-metadata": { "supportedDeviceTypes": [ "asr", "c1100", "c8000be", "csr1000v", "ir8100", "ir8340", "isr", "ISRv", "ir1101", "autonomous-all" ], "minVManageVersion": "26.1.1" }, "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPostRequest_SchemaPayload" } } } } }, "$$ref": "#/components/schemas/getListSdwanSystemGlobalPayload" }, "examples": { "get response example": { "value": { "header": { "generatedOn": 1702438718825 }, "data": [ { "parcelId": "09fc54fe-ff36-4640-ae57-c9e71a103902", "parcelType": "global", "createdBy": "admin", "lastUpdatedBy": "admin", "createdOn": 1701866357838, "lastUpdatedOn": 1701866357838, "payload": { "data": { "services_global": { "services_ip": { "servicesGlobalServicesIpHttpServer": { "optionType": "global", "value": false }, "servicesGlobalServicesIpHttpsServer": { "optionType": "global", "value": true }, "servicesGlobalServicesIpFtpPassive": { "optionType": "global", "value": false }, "servicesGlobalServicesIpDomainLookup": { "optionType": "global", "value": false }, "servicesGlobalServicesIpArpProxy": { "optionType": "global", "value": false }, "servicesGlobalServicesIpRcmd": { "optionType": "global", "value": false }, "servicesGlobalServicesIpLineVty": { "optionType": "global", "value": false }, "servicesGlobalServicesIpCdp": { "optionType": "global", "value": true }, "servicesGlobalServicesIpLldp": { "optionType": "global", "value": true }, "servicesGlobalServicesIpSourceIntrf": { "optionType": "global", "value": "GigabitEthernet0/0/1" }, "globalOtherSettingsTcpKeepalivesIn": { "optionType": "global", "value": true }, "globalOtherSettingsTcpKeepalivesOut": { "optionType": "global", "value": true }, "globalOtherSettingsTcpSmallServers": { "optionType": "global", "value": false }, "globalOtherSettingsUdpSmallServers": { "optionType": "global", "value": false }, "globalOtherSettingsConsoleLogging": { "optionType": "global", "value": true }, "globalOtherSettingsIPSourceRoute": { "optionType": "global", "value": false }, "globalOtherSettingsVtyLineLogging": { "optionType": "global", "value": false }, "globalOtherSettingsSnmpIfindexPersist": { "optionType": "global", "value": true }, "globalOtherSettingsIgnoreBootp": { "optionType": "global", "value": false }, "globalSettingsNat64UdpTimeout": { "optionType": "global", "value": 300 }, "globalSettingsNat64TcpTimeout": { "optionType": "global", "value": 3600 }, "globalSettingsHttpAuthentication": { "optionType": "default", "value": "" }, "globalSettingsSSHVersion": { "optionType": "default", "value": "" } } } } } } ] }, "$$ref": "#/components/examples/getListSdwanSystemGlobalExample" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Feature Profile > System > Global-read" }, "post": { "tags": [ "Configuration - Feature Profile (SDWAN)" ], "description": "Create a Global Profile Parcel for System feature profile", "operationId": "CreateGlobalProfileParcelForSystem", "parameters": [ { "name": "systemId", "in": "path", "description": "Feature 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": "Global Profile Parcel", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[^&<>! \"]+$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_cgFpPpNameDef", "description": "Set the parcel name" }, "description": { "description": "Set the parcel description", "type": "string" }, "data": { "type": "object", "properties": { "services_global": { "type": "object", "properties": { "services_ip": { "type": "object", "properties": { "servicesGlobalServicesIpHttpServer": { "description": "Set a HTTP Server", "type": "object", "x-attributeMetadata": { "insecureConfiguration": { "attributeJsonPath": "$.data.services_global.services_ip.servicesGlobalServicesIpHttpServer.value", "values": [ true ], "description": "HTTP server enabled - unencrypted protocol vulnerable to eavesdropping and man-in-the-middle attacks", "reason": "Legacy protocol poses data confidentiality and integrity risks due to lack of encryption and authentication", "remediation": "Use http secure server to ensure secure web access" } }, "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPostRequest_oneOfServerDefaultFalseOptionsDef" }, "servicesGlobalServicesIpHttpsServer": { "description": "Set a HTTPS Server", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPostRequest_oneOfServerDefaultFalseOptionsDef" }, "servicesGlobalServicesIpFtpPassive": { "description": "Set Passive FTP", "type": "object", "x-attributeMetadata": { "insecureConfiguration": { "attributeJsonPath": "$.data.services_global.services_ip.servicesGlobalServicesIpFtpPassive.value", "values": [ true ], "description": "FTP service enabled - transmits credentials and data in plain text, vulnerable to interception", "reason": "Legacy protocol poses data confidentiality and integrity risks due to lack of encryption and authentication", "remediation": "Remove FTP configuration and transition to secure file transfer methods using SCP, SFTP, HTTPS protocols" } }, "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPostRequest_oneOfServerDefaultFalseOptionsDef" }, "servicesGlobalServicesIpDomainLookup": { "description": "Configure Domain-Lookup", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPostRequest_oneOfServerDefaultFalseOptionsDef" }, "servicesGlobalServicesIpArpProxy": { "description": "Set ARP Proxy", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPostRequest_oneOfServerDefaultFalseOptionsDef" }, "servicesGlobalServicesIpRcmd": { "description": "Set RSH/RCP", "type": "object", "x-attributeMetadata": { "insecureConfiguration": { "attributeJsonPath": "$.data.services_global.services_ip.servicesGlobalServicesIpRcmd.value", "values": [ true ], "description": "Remote command (rcmd) service enabled - allows unencrypted remote command execution without proper authentication", "reason": "No encryption is configured", "remediation": "This is a legacy feature, please consider disabling it" } }, "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPostRequest_oneOfServerDefaultFalseOptionsDef" }, "servicesGlobalServicesIpLineVty": { "description": "Configure Telnet (Outbound)", "type": "object", "x-attributeMetadata": { "insecureConfiguration": { "attributeJsonPath": "$.data.services_global.services_ip.servicesGlobalServicesIpLineVty.value", "values": [ true ], "description": "Line transport configured with unencrypted protocols - allows plaintext transmission of sensitive data", "reason": "Legacy protocol poses data confidentiality and integrity risks due to lack of encryption and authentication", "remediation": "Migrate to secure SSH-based remote access" } }, "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPostRequest_oneOfServerDefaultFalseOptionsDef" }, "servicesGlobalServicesIpCdp": { "description": "Configure CDP", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ true ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanTrueDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPostRequest_oneOfServerDefaultTrueOptionsDef" }, "servicesGlobalServicesIpLldp": { "description": "Configure LLDP", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ true ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanTrueDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPostRequest_oneOfServerDefaultTrueOptionsDef" }, "servicesGlobalServicesIpSourceIntrf": { "description": "Specify interface for source address in all HTTP(S) client connections", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "pattern": "(ATM|ATM-ACR|AppGigabitEthernet|AppNav-Compress|AppNav-UnCompress|Async|BD-VIF|BDI|CEM|CEM-ACR|Cellular|Dialer|Embedded-Service-Engine|Ethernet|Ethernet-Internal|FastEthernet|FiftyGigabitEthernet|FiveGigabitEthernet|FortyGigabitEthernet|FourHundredGigE|GMPLS|GigabitEthernet|Group-Async|HundredGigE|L2LISP|LISP|Loopback|MFR|Multilink|Port-channel|SM|Serial|Service-Engine|TenGigabitEthernet|Tunnel|TwentyFiveGigE|TwentyFiveGigabitEthernet|TwoGigabitEthernet|TwoHundredGigE|Vif|Virtual-PPP|Virtual-Template|VirtualPortGroup|Vlan|Wlan-GigabitEthernet|nat64|nat66|ntp|nve|ospfv3|overlay|pseudowire|ucse|vasileft|vasiright|vmi)([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]+)", "minLength": 3, "maxLength": 32, "$$ref": "#/components/schemas/CommonCommonDefs_ifNameDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPostRequest_oneOfSourceInterfaceOptionsDef" }, "globalOtherSettingsTcpKeepalivesIn": { "description": "Configure tcp-keepalives-in", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ true ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanTrueDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPostRequest_oneOfServerDefaultTrueOptionsDef" }, "globalOtherSettingsTcpKeepalivesOut": { "description": "Configure tcp-keepalives-out", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ true ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanTrueDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPostRequest_oneOfServerDefaultTrueOptionsDef" }, "globalOtherSettingsTcpSmallServers": { "description": "Configure tcp-small-servers", "type": "object", "x-attributeMetadata": { "insecureConfiguration": { "attributeJsonPath": "$.data.services_global.services_ip.globalOtherSettingsTcpSmallServers.value", "values": [ true ], "description": "TCP small servers enabled - provides unnecessary services like echo, discard, and daytime that can be exploited", "reason": "TCP small servers expose unnecessary network services and potential attack vectors", "remediation": "Disable small servers and use modern network diagnostic tools like ping, traceroute, or SSH-based commands" } }, "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPostRequest_oneOfServerDefaultFalseOptionsDef" }, "globalOtherSettingsUdpSmallServers": { "description": "Configure udp-small-servers", "type": "object", "x-attributeMetadata": { "insecureConfiguration": { "attributeJsonPath": "$.data.services_global.services_ip.globalOtherSettingsUdpSmallServers.value", "values": [ true ], "description": "UDP small servers enabled - provides unnecessary services that can be used for DDoS amplification attacks", "reason": "UDP small servers expose unnecessary network services and potential attack vectors", "remediation": "Disable small servers and use modern network diagnostic tools like ping, traceroute, or SSH-based commands" } }, "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPostRequest_oneOfServerDefaultFalseOptionsDef" }, "globalOtherSettingsConsoleLogging": { "description": "Configure Console Logging", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ true ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanTrueDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPostRequest_oneOfServerDefaultTrueOptionsDef" }, "globalOtherSettingsIPSourceRoute": { "description": "Set Source Route", "type": "object", "x-attributeMetadata": { "insecureConfiguration": { "attributeJsonPath": "$.data.services_global.services_ip.globalOtherSettingsIPSourceRoute.value", "values": [ true ], "description": "IP source routing enabled - allows attackers to specify packet routing and bypass security controls", "reason": "IP source routing allows attackers to bypass network security controls and routing policies", "remediation": "This is a legacy feature, please consider disabling it" } }, "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPostRequest_oneOfServerDefaultFalseOptionsDef" }, "globalOtherSettingsVtyLineLogging": { "description": "Configure VTY Line Logging", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPostRequest_oneOfServerDefaultFalseOptionsDef" }, "globalOtherSettingsSnmpIfindexPersist": { "description": "Configure SNMP Ifindex Persist", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ true ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanTrueDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPostRequest_oneOfServerDefaultTrueOptionsDef" }, "globalOtherSettingsIgnoreBootp": { "description": "Configure Ignore BOOTP", "type": "object", "x-attributeMetadata": { "insecureConfiguration": { "attributeJsonPath": "$.data.services_global.services_ip.globalOtherSettingsIgnoreBootp.value", "values": [ false ], "description": "BOOTP server enabled - legacy protocol vulnerable to man-in-the-middle attacks and lacks security features", "reason": "Legacy protocol poses data confidentiality and integrity risks due to lack of encryption and authentication", "remediation": "Use DHCP to automatically configure network settings" } }, "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ true ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanTrueDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPostRequest_oneOfServerDefaultTrueOptionsDef" }, "globalOtherSettingsIntfPerMin": { "description": "Configure Interface Statistics Per Minute", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "enum": [ "1", "5" ], "type": "string", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPostRequest_interfaceIntervalDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "enum": [ "5" ], "default": "5", "type": "string", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPostRequest_defaultInterfaceIntervalDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPostRequest_oneOfInterfaceIntervalOptionsDef" }, "globalSettingsNat64UdpTimeout": { "description": "Set NAT64 UDP session timeout, in seconds", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 300, "minimum": 1, "maximum": 536870, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPostRequest_udpTimeoutDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "minimum": 300, "maximum": 300, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPostRequest_defaultUdpTimeoutDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPostRequest_oneOfUdpTimeoutOptionsDef" }, "globalSettingsNat64TcpTimeout": { "description": "Set NAT64 TCP session timeout, in seconds", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 3600, "minimum": 1, "maximum": 536870, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPostRequest_tcpTimeoutDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "minimum": 3600, "maximum": 3600, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPostRequest_defaultTcpTimeoutDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPostRequest_oneOfTcpTimeoutOptionsDef" }, "globalSettingsHttpAuthentication": { "description": "Set preference for HTTP Authentication", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "enum": [ "local", "aaa" ], "type": "string", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPostRequest_httpAuthenticationDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionNoDefaultDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPostRequest_oneOfHttpAuthenticationOptionsDef" }, "globalSettingsSSHVersion": { "description": "Set SSH version", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "enum": [ "2" ], "type": "string", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPostRequest_versionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionNoDefaultDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPostRequest_oneOfVersionOptionsDef" }, "lacpSystemPriority": { "description": "Set LACP system priority", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minimum": 1, "maximum": 65535, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPostRequest_lacpSystemPriorityDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionNoDefaultDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPostRequest_oneOfLacpSystemPriorityOptionsDef" }, "etherchannelFlowLoadBalance": { "description": "Set Etherchannel load balance hash algorithm", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "enum": [ "src-ip", "dst-ip", "src-dst-ip", "src-mac", "dst-mac", "src-dst-mac", "src-dst-mixed-ip-port", "sdwan" ], "type": "string", "default": "src-dst-ip", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPostRequest_etherchannelFlowLBDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionNoDefaultDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPostRequest_oneOfEtherchannelFlowLBOptionsDef" }, "etherchannelVlanLoadBalance": { "description": "Set Etherchannel vlan manual load balance", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPostRequest_oneOfServerDefaultFalseOptionsDef" }, "bgpCommunityNewFormat": { "description": "Display community attributes in the newer format. Instead of displaying communities as a 32-bit value, it shows them as two 16-bit integers separated by a colon (AA:NN format)", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPostRequest_oneOfServerDefaultFalseOptionsDef" } }, "required": [ "servicesGlobalServicesIpHttpServer", "servicesGlobalServicesIpHttpsServer", "servicesGlobalServicesIpFtpPassive", "servicesGlobalServicesIpDomainLookup", "servicesGlobalServicesIpArpProxy", "servicesGlobalServicesIpRcmd", "servicesGlobalServicesIpLineVty", "servicesGlobalServicesIpCdp", "servicesGlobalServicesIpLldp" ], "additionalProperties": false } }, "required": [ "services_ip" ], "additionalProperties": false } }, "required": [ "services_global" ], "additionalProperties": false } }, "required": [ "name", "data" ], "x-metadata": { "supportedDeviceTypes": [ "asr", "c1100", "c8000be", "csr1000v", "ir8100", "ir8340", "isr", "ISRv", "ir1101", "autonomous-all" ], "minVManageVersion": "26.1.1" }, "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPostRequest_SchemaPayload" }, "examples": { "Cedge_CG1_System_Globalsettings_parcel1": { "value": { "data": { "services_global": { "services_ip": { "servicesGlobalServicesIpHttpServer": { "optionType": "global", "value": false }, "servicesGlobalServicesIpHttpsServer": { "optionType": "global", "value": true }, "servicesGlobalServicesIpFtpPassive": { "optionType": "global", "value": false }, "servicesGlobalServicesIpDomainLookup": { "optionType": "global", "value": false }, "servicesGlobalServicesIpArpProxy": { "optionType": "global", "value": false }, "servicesGlobalServicesIpRcmd": { "optionType": "global", "value": false }, "servicesGlobalServicesIpLineVty": { "optionType": "global", "value": false }, "servicesGlobalServicesIpCdp": { "optionType": "global", "value": true }, "servicesGlobalServicesIpLldp": { "optionType": "global", "value": true }, "servicesGlobalServicesIpSourceIntrf": { "optionType": "global", "value": "GigabitEthernet0/0/1" }, "globalOtherSettingsTcpKeepalivesIn": { "optionType": "global", "value": true }, "globalOtherSettingsTcpKeepalivesOut": { "optionType": "global", "value": true }, "globalOtherSettingsTcpSmallServers": { "optionType": "global", "value": false }, "globalOtherSettingsUdpSmallServers": { "optionType": "global", "value": false }, "globalOtherSettingsConsoleLogging": { "optionType": "global", "value": true }, "globalOtherSettingsIPSourceRoute": { "optionType": "global", "value": false }, "globalOtherSettingsVtyLineLogging": { "optionType": "global", "value": false }, "globalOtherSettingsSnmpIfindexPersist": { "optionType": "global", "value": true }, "globalOtherSettingsIgnoreBootp": { "optionType": "global", "value": false }, "globalSettingsNat64UdpTimeout": { "optionType": "global", "value": 300 }, "globalSettingsNat64TcpTimeout": { "optionType": "global", "value": 3600 }, "globalSettingsHttpAuthentication": { "optionType": "default", "value": "" }, "globalSettingsSSHVersion": { "optionType": "default", "value": "" } } } }, "description": "Cedge System Global Settings config", "name": "Cedge_CG1_System_Globalsettings_parcel1" }, "$$ref": "#/components/examples/ProfileparcelSdwanSystemGlobalPostRequest_Cedge_CG1_System_Globalsettings_parcel1" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "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}" } }, "required": [ "id" ], "x-metadata": { "minVManageVersion": "20.15.1" }, "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelCommonPostResponse_SchemaPayload" }, "examples": { "example_1": { "value": { "id": "24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A" }, "$$ref": "#/components/examples/ProfileparcelCommonPostResponse_example_1" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Feature Profile > System > Global-write" } }, "/v1/feature-profile/sdwan/system/{systemId}/global/{globalId}": { "get": { "tags": [ "Configuration - Feature Profile (SDWAN)" ], "description": "Get Global Profile Parcel by parcelId for System feature profile", "operationId": "GetGlobalProfileParcelByParcelIdForSystem", "parameters": [ { "name": "systemId", "in": "path", "description": "Feature 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" } }, { "name": "globalId", "in": "path", "description": "Profile Parcel 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", "properties": { "parcelId": { "type": "string", "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}", "$$ref": "#/components/schemas/CommonCommonDefs_uuidDef" }, "parcelType": { "type": "string" }, "createdBy": { "type": "string", "description": "User who last created this.", "readOnly": true }, "createdOn": { "type": "integer", "description": "Timestamp of creation", "format": "int64", "readOnly": true }, "lastUpdatedBy": { "type": "string", "description": "User who last updated this.", "readOnly": true }, "lastUpdatedOn": { "type": "integer", "description": "Timestamp of last update", "format": "int64", "readOnly": true }, "payload": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[^&<>! \"]+$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_cgFpPpNameDef", "description": "Set the parcel name" }, "description": { "description": "Set the parcel description", "type": "string" }, "data": { "type": "object", "properties": { "services_global": { "type": "object", "properties": { "services_ip": { "type": "object", "properties": { "servicesGlobalServicesIpHttpServer": { "description": "Set a HTTP Server", "type": "object", "x-attributeMetadata": { "insecureConfiguration": { "attributeJsonPath": "$.data.services_global.services_ip.servicesGlobalServicesIpHttpServer.value", "values": [ true ], "description": "HTTP server enabled - unencrypted protocol vulnerable to eavesdropping and man-in-the-middle attacks", "reason": "Legacy protocol poses data confidentiality and integrity risks due to lack of encryption and authentication", "remediation": "Use http secure server to ensure secure web access" } }, "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPutRequest_oneOfServerDefaultFalseOptionsDef" }, "servicesGlobalServicesIpHttpsServer": { "description": "Set a HTTPS Server", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPutRequest_oneOfServerDefaultFalseOptionsDef" }, "servicesGlobalServicesIpFtpPassive": { "description": "Set Passive FTP", "type": "object", "x-attributeMetadata": { "insecureConfiguration": { "attributeJsonPath": "$.data.services_global.services_ip.servicesGlobalServicesIpFtpPassive.value", "values": [ true ], "description": "FTP service enabled - transmits credentials and data in plain text, vulnerable to interception", "reason": "Legacy protocol poses data confidentiality and integrity risks due to lack of encryption and authentication", "remediation": "Remove FTP configuration and transition to secure file transfer methods using SCP, SFTP, HTTPS protocols" } }, "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPutRequest_oneOfServerDefaultFalseOptionsDef" }, "servicesGlobalServicesIpDomainLookup": { "description": "Configure Domain-Lookup", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPutRequest_oneOfServerDefaultFalseOptionsDef" }, "servicesGlobalServicesIpArpProxy": { "description": "Set ARP Proxy", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPutRequest_oneOfServerDefaultFalseOptionsDef" }, "servicesGlobalServicesIpRcmd": { "description": "Set RSH/RCP", "type": "object", "x-attributeMetadata": { "insecureConfiguration": { "attributeJsonPath": "$.data.services_global.services_ip.servicesGlobalServicesIpRcmd.value", "values": [ true ], "description": "Remote command (rcmd) service enabled - allows unencrypted remote command execution without proper authentication", "reason": "No encryption is configured", "remediation": "This is a legacy feature, please consider disabling it" } }, "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPutRequest_oneOfServerDefaultFalseOptionsDef" }, "servicesGlobalServicesIpLineVty": { "description": "Configure Telnet (Outbound)", "type": "object", "x-attributeMetadata": { "insecureConfiguration": { "attributeJsonPath": "$.data.services_global.services_ip.servicesGlobalServicesIpLineVty.value", "values": [ true ], "description": "Line transport configured with unencrypted protocols - allows plaintext transmission of sensitive data", "reason": "Legacy protocol poses data confidentiality and integrity risks due to lack of encryption and authentication", "remediation": "Migrate to secure SSH-based remote access" } }, "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPutRequest_oneOfServerDefaultFalseOptionsDef" }, "servicesGlobalServicesIpCdp": { "description": "Configure CDP", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ true ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanTrueDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPutRequest_oneOfServerDefaultTrueOptionsDef" }, "servicesGlobalServicesIpLldp": { "description": "Configure LLDP", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ true ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanTrueDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPutRequest_oneOfServerDefaultTrueOptionsDef" }, "servicesGlobalServicesIpSourceIntrf": { "description": "Specify interface for source address in all HTTP(S) client connections", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "pattern": "(ATM|ATM-ACR|AppGigabitEthernet|AppNav-Compress|AppNav-UnCompress|Async|BD-VIF|BDI|CEM|CEM-ACR|Cellular|Dialer|Embedded-Service-Engine|Ethernet|Ethernet-Internal|FastEthernet|FiftyGigabitEthernet|FiveGigabitEthernet|FortyGigabitEthernet|FourHundredGigE|GMPLS|GigabitEthernet|Group-Async|HundredGigE|L2LISP|LISP|Loopback|MFR|Multilink|Port-channel|SM|Serial|Service-Engine|TenGigabitEthernet|Tunnel|TwentyFiveGigE|TwentyFiveGigabitEthernet|TwoGigabitEthernet|TwoHundredGigE|Vif|Virtual-PPP|Virtual-Template|VirtualPortGroup|Vlan|Wlan-GigabitEthernet|nat64|nat66|ntp|nve|ospfv3|overlay|pseudowire|ucse|vasileft|vasiright|vmi)([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]+)", "minLength": 3, "maxLength": 32, "$$ref": "#/components/schemas/CommonCommonDefs_ifNameDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPutRequest_oneOfSourceInterfaceOptionsDef" }, "globalOtherSettingsTcpKeepalivesIn": { "description": "Configure tcp-keepalives-in", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ true ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanTrueDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPutRequest_oneOfServerDefaultTrueOptionsDef" }, "globalOtherSettingsTcpKeepalivesOut": { "description": "Configure tcp-keepalives-out", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ true ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanTrueDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPutRequest_oneOfServerDefaultTrueOptionsDef" }, "globalOtherSettingsTcpSmallServers": { "description": "Configure tcp-small-servers", "type": "object", "x-attributeMetadata": { "insecureConfiguration": { "attributeJsonPath": "$.data.services_global.services_ip.globalOtherSettingsTcpSmallServers.value", "values": [ true ], "description": "TCP small servers enabled - provides unnecessary services like echo, discard, and daytime that can be exploited", "reason": "TCP small servers expose unnecessary network services and potential attack vectors", "remediation": "Disable small servers and use modern network diagnostic tools like ping, traceroute, or SSH-based commands" } }, "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPutRequest_oneOfServerDefaultFalseOptionsDef" }, "globalOtherSettingsUdpSmallServers": { "description": "Configure udp-small-servers", "type": "object", "x-attributeMetadata": { "insecureConfiguration": { "attributeJsonPath": "$.data.services_global.services_ip.globalOtherSettingsUdpSmallServers.value", "values": [ true ], "description": "UDP small servers enabled - provides unnecessary services that can be used for DDoS amplification attacks", "reason": "UDP small servers expose unnecessary network services and potential attack vectors", "remediation": "Disable small servers and use modern network diagnostic tools like ping, traceroute, or SSH-based commands" } }, "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPutRequest_oneOfServerDefaultFalseOptionsDef" }, "globalOtherSettingsConsoleLogging": { "description": "Configure Console Logging", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ true ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanTrueDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPutRequest_oneOfServerDefaultTrueOptionsDef" }, "globalOtherSettingsIPSourceRoute": { "description": "Set Source Route", "type": "object", "x-attributeMetadata": { "insecureConfiguration": { "attributeJsonPath": "$.data.services_global.services_ip.globalOtherSettingsIPSourceRoute.value", "values": [ true ], "description": "IP source routing enabled - allows attackers to specify packet routing and bypass security controls", "reason": "IP source routing allows attackers to bypass network security controls and routing policies", "remediation": "This is a legacy feature, please consider disabling it" } }, "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPutRequest_oneOfServerDefaultFalseOptionsDef" }, "globalOtherSettingsVtyLineLogging": { "description": "Configure Telnet (Outbound)", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPutRequest_oneOfServerDefaultFalseOptionsDef" }, "globalOtherSettingsSnmpIfindexPersist": { "description": "Configure SNMP Ifindex Persist", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ true ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanTrueDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPutRequest_oneOfServerDefaultTrueOptionsDef" }, "globalOtherSettingsIgnoreBootp": { "description": "Configure Ignore BOOTP", "type": "object", "x-attributeMetadata": { "insecureConfiguration": { "attributeJsonPath": "$.data.services_global.services_ip.globalOtherSettingsIgnoreBootp.value", "values": [ false ], "description": "BOOTP server enabled - legacy protocol vulnerable to man-in-the-middle attacks and lacks security features", "reason": "Legacy protocol poses data confidentiality and integrity risks due to lack of encryption and authentication", "remediation": "Use DHCP to automatically configure network settings" } }, "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ true ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanTrueDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPutRequest_oneOfServerDefaultTrueOptionsDef" }, "globalOtherSettingsIntfPerMin": { "description": "Configure Interface Statistics Per Minute", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "enum": [ "1", "5" ], "type": "string", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPutRequest_interfaceIntervalDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "enum": [ "5" ], "default": "5", "type": "string", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPutRequest_defaultInterfaceIntervalDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPutRequest_oneOfInterfaceIntervalOptionsDef" }, "globalSettingsNat64UdpTimeout": { "description": "Set NAT64 UDP session timeout, in seconds", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 300, "minimum": 1, "maximum": 536870, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPutRequest_udpTimeoutDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "minimum": 300, "maximum": 300, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPutRequest_defaultUdpTimeoutDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPutRequest_oneOfUdpTimeoutOptionsDef" }, "globalSettingsNat64TcpTimeout": { "description": "Set NAT64 TCP session timeout, in seconds", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 3600, "minimum": 1, "maximum": 536870, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPutRequest_tcpTimeoutDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "minimum": 3600, "maximum": 3600, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPutRequest_defaultTcpTimeoutDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPutRequest_oneOfTcpTimeoutOptionsDef" }, "globalSettingsHttpAuthentication": { "description": "Set preference for HTTP Authentication", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "enum": [ "local", "aaa" ], "type": "string", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPutRequest_httpAuthenticationDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionNoDefaultDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPutRequest_oneOfHttpAuthenticationOptionsDef" }, "globalSettingsSSHVersion": { "description": "Set SSH version", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "enum": [ "2" ], "type": "string", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPutRequest_versionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionNoDefaultDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPutRequest_oneOfVersionOptionsDef" }, "lacpSystemPriority": { "description": "Set LACP system priority", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minimum": 1, "maximum": 65535, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPutRequest_lacpSystemPriorityDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionNoDefaultDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPutRequest_oneOfLacpSystemPriorityOptionsDef" }, "etherchannelFlowLoadBalance": { "description": "Set Etherchannel load balance hash algorithm", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "enum": [ "src-ip", "dst-ip", "src-dst-ip", "src-mac", "dst-mac", "src-dst-mac", "src-dst-mixed-ip-port", "sdwan" ], "type": "string", "default": "src-dst-ip", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPutRequest_etherchannelFlowLBDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionNoDefaultDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPutRequest_oneOfEtherchannelFlowLBOptionsDef" }, "etherchannelVlanLoadBalance": { "description": "Set Etherchannel vlan manual load balance", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPutRequest_oneOfServerDefaultFalseOptionsDef" }, "bgpCommunityNewFormat": { "description": "Display community attributes in the newer format. Instead of displaying communities as a 32-bit value, it shows them as two 16-bit integers separated by a colon (AA:NN format)", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPutRequest_oneOfServerDefaultFalseOptionsDef" } }, "required": [ "servicesGlobalServicesIpHttpServer", "servicesGlobalServicesIpHttpsServer", "servicesGlobalServicesIpFtpPassive", "servicesGlobalServicesIpDomainLookup", "servicesGlobalServicesIpArpProxy", "servicesGlobalServicesIpRcmd", "servicesGlobalServicesIpLineVty", "servicesGlobalServicesIpCdp", "servicesGlobalServicesIpLldp" ], "additionalProperties": false } }, "required": [ "services_ip" ], "additionalProperties": false } }, "required": [ "services_global" ], "additionalProperties": false } }, "required": [ "name", "data" ], "x-metadata": { "supportedDeviceTypes": [ "asr", "c1100", "c8000be", "csr1000v", "ir8100", "ir8340", "isr", "ISRv", "ir1101", "autonomous-all" ], "minVManageVersion": "26.1.1" }, "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPutRequest_SchemaPayload" } }, "$$ref": "#/components/schemas/getSingleSdwanSystemGlobalPayload" }, "examples": { "get response example": { "value": { "parcelId": "09fc54fe-ff36-4640-ae57-c9e71a103902", "parcelType": "global", "createdBy": "admin", "lastUpdatedBy": "admin", "createdOn": 1701866357838, "lastUpdatedOn": 1701866357838, "payload": { "data": { "services_global": { "services_ip": { "servicesGlobalServicesIpHttpServer": { "optionType": "global", "value": false }, "servicesGlobalServicesIpHttpsServer": { "optionType": "global", "value": true }, "servicesGlobalServicesIpFtpPassive": { "optionType": "global", "value": false }, "servicesGlobalServicesIpDomainLookup": { "optionType": "global", "value": false }, "servicesGlobalServicesIpArpProxy": { "optionType": "global", "value": false }, "servicesGlobalServicesIpRcmd": { "optionType": "global", "value": false }, "servicesGlobalServicesIpLineVty": { "optionType": "global", "value": false }, "servicesGlobalServicesIpCdp": { "optionType": "global", "value": true }, "servicesGlobalServicesIpLldp": { "optionType": "global", "value": true }, "servicesGlobalServicesIpSourceIntrf": { "optionType": "global", "value": "GigabitEthernet0/0/1" }, "globalOtherSettingsTcpKeepalivesIn": { "optionType": "global", "value": true }, "globalOtherSettingsTcpKeepalivesOut": { "optionType": "global", "value": true }, "globalOtherSettingsTcpSmallServers": { "optionType": "global", "value": false }, "globalOtherSettingsUdpSmallServers": { "optionType": "global", "value": false }, "globalOtherSettingsConsoleLogging": { "optionType": "global", "value": true }, "globalOtherSettingsIPSourceRoute": { "optionType": "global", "value": false }, "globalOtherSettingsVtyLineLogging": { "optionType": "global", "value": false }, "globalOtherSettingsSnmpIfindexPersist": { "optionType": "global", "value": true }, "globalOtherSettingsIgnoreBootp": { "optionType": "global", "value": false }, "globalSettingsNat64UdpTimeout": { "optionType": "global", "value": 300 }, "globalSettingsNat64TcpTimeout": { "optionType": "global", "value": 3600 }, "globalSettingsHttpAuthentication": { "optionType": "default", "value": "" }, "globalSettingsSSHVersion": { "optionType": "default", "value": "" } } } } } }, "$$ref": "#/components/examples/getSingleSdwanSystemGlobalExample" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Feature Profile > System > Global-read" }, "delete": { "tags": [ "Configuration - Feature Profile (SDWAN)" ], "description": "Delete a Global Profile Parcel for System feature profile", "operationId": "DeleteGlobalProfileParcelForSystem", "parameters": [ { "name": "systemId", "in": "path", "description": "Feature 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" } }, { "name": "globalId", "in": "path", "description": "Profile Parcel 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": "Feature Profile > System > Global-write" }, "put": { "tags": [ "Configuration - Feature Profile (SDWAN)" ], "description": "Update a Global Profile Parcel for System feature profile", "operationId": "EditGlobalProfileParcelForSystem", "parameters": [ { "name": "systemId", "in": "path", "description": "Feature 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" } }, { "name": "globalId", "in": "path", "description": "Profile Parcel 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": "Global Profile Parcel", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[^&<>! \"]+$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_cgFpPpNameDef", "description": "Set the parcel name" }, "description": { "description": "Set the parcel description", "type": "string" }, "data": { "type": "object", "properties": { "services_global": { "type": "object", "properties": { "services_ip": { "type": "object", "properties": { "servicesGlobalServicesIpHttpServer": { "description": "Set a HTTP Server", "type": "object", "x-attributeMetadata": { "insecureConfiguration": { "attributeJsonPath": "$.data.services_global.services_ip.servicesGlobalServicesIpHttpServer.value", "values": [ true ], "description": "HTTP server enabled - unencrypted protocol vulnerable to eavesdropping and man-in-the-middle attacks", "reason": "Legacy protocol poses data confidentiality and integrity risks due to lack of encryption and authentication", "remediation": "Use http secure server to ensure secure web access" } }, "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPutRequest_oneOfServerDefaultFalseOptionsDef" }, "servicesGlobalServicesIpHttpsServer": { "description": "Set a HTTPS Server", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPutRequest_oneOfServerDefaultFalseOptionsDef" }, "servicesGlobalServicesIpFtpPassive": { "description": "Set Passive FTP", "type": "object", "x-attributeMetadata": { "insecureConfiguration": { "attributeJsonPath": "$.data.services_global.services_ip.servicesGlobalServicesIpFtpPassive.value", "values": [ true ], "description": "FTP service enabled - transmits credentials and data in plain text, vulnerable to interception", "reason": "Legacy protocol poses data confidentiality and integrity risks due to lack of encryption and authentication", "remediation": "Remove FTP configuration and transition to secure file transfer methods using SCP, SFTP, HTTPS protocols" } }, "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPutRequest_oneOfServerDefaultFalseOptionsDef" }, "servicesGlobalServicesIpDomainLookup": { "description": "Configure Domain-Lookup", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPutRequest_oneOfServerDefaultFalseOptionsDef" }, "servicesGlobalServicesIpArpProxy": { "description": "Set ARP Proxy", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPutRequest_oneOfServerDefaultFalseOptionsDef" }, "servicesGlobalServicesIpRcmd": { "description": "Set RSH/RCP", "type": "object", "x-attributeMetadata": { "insecureConfiguration": { "attributeJsonPath": "$.data.services_global.services_ip.servicesGlobalServicesIpRcmd.value", "values": [ true ], "description": "Remote command (rcmd) service enabled - allows unencrypted remote command execution without proper authentication", "reason": "No encryption is configured", "remediation": "This is a legacy feature, please consider disabling it" } }, "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPutRequest_oneOfServerDefaultFalseOptionsDef" }, "servicesGlobalServicesIpLineVty": { "description": "Configure Telnet (Outbound)", "type": "object", "x-attributeMetadata": { "insecureConfiguration": { "attributeJsonPath": "$.data.services_global.services_ip.servicesGlobalServicesIpLineVty.value", "values": [ true ], "description": "Line transport configured with unencrypted protocols - allows plaintext transmission of sensitive data", "reason": "Legacy protocol poses data confidentiality and integrity risks due to lack of encryption and authentication", "remediation": "Migrate to secure SSH-based remote access" } }, "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPutRequest_oneOfServerDefaultFalseOptionsDef" }, "servicesGlobalServicesIpCdp": { "description": "Configure CDP", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ true ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanTrueDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPutRequest_oneOfServerDefaultTrueOptionsDef" }, "servicesGlobalServicesIpLldp": { "description": "Configure LLDP", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ true ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanTrueDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPutRequest_oneOfServerDefaultTrueOptionsDef" }, "servicesGlobalServicesIpSourceIntrf": { "description": "Specify interface for source address in all HTTP(S) client connections", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "pattern": "(ATM|ATM-ACR|AppGigabitEthernet|AppNav-Compress|AppNav-UnCompress|Async|BD-VIF|BDI|CEM|CEM-ACR|Cellular|Dialer|Embedded-Service-Engine|Ethernet|Ethernet-Internal|FastEthernet|FiftyGigabitEthernet|FiveGigabitEthernet|FortyGigabitEthernet|FourHundredGigE|GMPLS|GigabitEthernet|Group-Async|HundredGigE|L2LISP|LISP|Loopback|MFR|Multilink|Port-channel|SM|Serial|Service-Engine|TenGigabitEthernet|Tunnel|TwentyFiveGigE|TwentyFiveGigabitEthernet|TwoGigabitEthernet|TwoHundredGigE|Vif|Virtual-PPP|Virtual-Template|VirtualPortGroup|Vlan|Wlan-GigabitEthernet|nat64|nat66|ntp|nve|ospfv3|overlay|pseudowire|ucse|vasileft|vasiright|vmi)([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]+)", "minLength": 3, "maxLength": 32, "$$ref": "#/components/schemas/CommonCommonDefs_ifNameDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPutRequest_oneOfSourceInterfaceOptionsDef" }, "globalOtherSettingsTcpKeepalivesIn": { "description": "Configure tcp-keepalives-in", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ true ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanTrueDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPutRequest_oneOfServerDefaultTrueOptionsDef" }, "globalOtherSettingsTcpKeepalivesOut": { "description": "Configure tcp-keepalives-out", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ true ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanTrueDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPutRequest_oneOfServerDefaultTrueOptionsDef" }, "globalOtherSettingsTcpSmallServers": { "description": "Configure tcp-small-servers", "type": "object", "x-attributeMetadata": { "insecureConfiguration": { "attributeJsonPath": "$.data.services_global.services_ip.globalOtherSettingsTcpSmallServers.value", "values": [ true ], "description": "TCP small servers enabled - provides unnecessary services like echo, discard, and daytime that can be exploited", "reason": "TCP small servers expose unnecessary network services and potential attack vectors", "remediation": "Disable small servers and use modern network diagnostic tools like ping, traceroute, or SSH-based commands" } }, "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPutRequest_oneOfServerDefaultFalseOptionsDef" }, "globalOtherSettingsUdpSmallServers": { "description": "Configure udp-small-servers", "type": "object", "x-attributeMetadata": { "insecureConfiguration": { "attributeJsonPath": "$.data.services_global.services_ip.globalOtherSettingsUdpSmallServers.value", "values": [ true ], "description": "UDP small servers enabled - provides unnecessary services that can be used for DDoS amplification attacks", "reason": "UDP small servers expose unnecessary network services and potential attack vectors", "remediation": "Disable small servers and use modern network diagnostic tools like ping, traceroute, or SSH-based commands" } }, "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPutRequest_oneOfServerDefaultFalseOptionsDef" }, "globalOtherSettingsConsoleLogging": { "description": "Configure Console Logging", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ true ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanTrueDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPutRequest_oneOfServerDefaultTrueOptionsDef" }, "globalOtherSettingsIPSourceRoute": { "description": "Set Source Route", "type": "object", "x-attributeMetadata": { "insecureConfiguration": { "attributeJsonPath": "$.data.services_global.services_ip.globalOtherSettingsIPSourceRoute.value", "values": [ true ], "description": "IP source routing enabled - allows attackers to specify packet routing and bypass security controls", "reason": "IP source routing allows attackers to bypass network security controls and routing policies", "remediation": "This is a legacy feature, please consider disabling it" } }, "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPutRequest_oneOfServerDefaultFalseOptionsDef" }, "globalOtherSettingsVtyLineLogging": { "description": "Configure Telnet (Outbound)", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPutRequest_oneOfServerDefaultFalseOptionsDef" }, "globalOtherSettingsSnmpIfindexPersist": { "description": "Configure SNMP Ifindex Persist", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ true ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanTrueDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPutRequest_oneOfServerDefaultTrueOptionsDef" }, "globalOtherSettingsIgnoreBootp": { "description": "Configure Ignore BOOTP", "type": "object", "x-attributeMetadata": { "insecureConfiguration": { "attributeJsonPath": "$.data.services_global.services_ip.globalOtherSettingsIgnoreBootp.value", "values": [ false ], "description": "BOOTP server enabled - legacy protocol vulnerable to man-in-the-middle attacks and lacks security features", "reason": "Legacy protocol poses data confidentiality and integrity risks due to lack of encryption and authentication", "remediation": "Use DHCP to automatically configure network settings" } }, "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ true ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanTrueDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPutRequest_oneOfServerDefaultTrueOptionsDef" }, "globalOtherSettingsIntfPerMin": { "description": "Configure Interface Statistics Per Minute", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "enum": [ "1", "5" ], "type": "string", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPutRequest_interfaceIntervalDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "enum": [ "5" ], "default": "5", "type": "string", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPutRequest_defaultInterfaceIntervalDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPutRequest_oneOfInterfaceIntervalOptionsDef" }, "globalSettingsNat64UdpTimeout": { "description": "Set NAT64 UDP session timeout, in seconds", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 300, "minimum": 1, "maximum": 536870, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPutRequest_udpTimeoutDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "minimum": 300, "maximum": 300, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPutRequest_defaultUdpTimeoutDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPutRequest_oneOfUdpTimeoutOptionsDef" }, "globalSettingsNat64TcpTimeout": { "description": "Set NAT64 TCP session timeout, in seconds", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 3600, "minimum": 1, "maximum": 536870, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPutRequest_tcpTimeoutDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "minimum": 3600, "maximum": 3600, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPutRequest_defaultTcpTimeoutDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPutRequest_oneOfTcpTimeoutOptionsDef" }, "globalSettingsHttpAuthentication": { "description": "Set preference for HTTP Authentication", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "enum": [ "local", "aaa" ], "type": "string", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPutRequest_httpAuthenticationDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionNoDefaultDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPutRequest_oneOfHttpAuthenticationOptionsDef" }, "globalSettingsSSHVersion": { "description": "Set SSH version", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "enum": [ "2" ], "type": "string", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPutRequest_versionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionNoDefaultDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPutRequest_oneOfVersionOptionsDef" }, "lacpSystemPriority": { "description": "Set LACP system priority", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minimum": 1, "maximum": 65535, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPutRequest_lacpSystemPriorityDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionNoDefaultDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPutRequest_oneOfLacpSystemPriorityOptionsDef" }, "etherchannelFlowLoadBalance": { "description": "Set Etherchannel load balance hash algorithm", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "enum": [ "src-ip", "dst-ip", "src-dst-ip", "src-mac", "dst-mac", "src-dst-mac", "src-dst-mixed-ip-port", "sdwan" ], "type": "string", "default": "src-dst-ip", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPutRequest_etherchannelFlowLBDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionNoDefaultDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPutRequest_oneOfEtherchannelFlowLBOptionsDef" }, "etherchannelVlanLoadBalance": { "description": "Set Etherchannel vlan manual load balance", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPutRequest_oneOfServerDefaultFalseOptionsDef" }, "bgpCommunityNewFormat": { "description": "Display community attributes in the newer format. Instead of displaying communities as a 32-bit value, it shows them as two 16-bit integers separated by a colon (AA:NN format)", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPutRequest_oneOfServerDefaultFalseOptionsDef" } }, "required": [ "servicesGlobalServicesIpHttpServer", "servicesGlobalServicesIpHttpsServer", "servicesGlobalServicesIpFtpPassive", "servicesGlobalServicesIpDomainLookup", "servicesGlobalServicesIpArpProxy", "servicesGlobalServicesIpRcmd", "servicesGlobalServicesIpLineVty", "servicesGlobalServicesIpCdp", "servicesGlobalServicesIpLldp" ], "additionalProperties": false } }, "required": [ "services_ip" ], "additionalProperties": false } }, "required": [ "services_global" ], "additionalProperties": false } }, "required": [ "name", "data" ], "x-metadata": { "supportedDeviceTypes": [ "asr", "c1100", "c8000be", "csr1000v", "ir8100", "ir8340", "isr", "ISRv", "ir1101", "autonomous-all" ], "minVManageVersion": "26.1.1" }, "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemGlobalPutRequest_SchemaPayload" }, "examples": { "Cedge_CG1_System_Globalsettings_parcel1": { "value": { "data": { "services_global": { "services_ip": { "servicesGlobalServicesIpHttpServer": { "optionType": "global", "value": false }, "servicesGlobalServicesIpHttpsServer": { "optionType": "global", "value": true }, "servicesGlobalServicesIpFtpPassive": { "optionType": "global", "value": false }, "servicesGlobalServicesIpDomainLookup": { "optionType": "global", "value": false }, "servicesGlobalServicesIpArpProxy": { "optionType": "global", "value": false }, "servicesGlobalServicesIpRcmd": { "optionType": "global", "value": false }, "servicesGlobalServicesIpLineVty": { "optionType": "global", "value": false }, "servicesGlobalServicesIpCdp": { "optionType": "global", "value": true }, "servicesGlobalServicesIpLldp": { "optionType": "global", "value": true }, "servicesGlobalServicesIpSourceIntrf": { "optionType": "global", "value": "GigabitEthernet0/0/1" }, "globalOtherSettingsTcpKeepalivesIn": { "optionType": "global", "value": true }, "globalOtherSettingsTcpKeepalivesOut": { "optionType": "global", "value": true }, "globalOtherSettingsTcpSmallServers": { "optionType": "global", "value": false }, "globalOtherSettingsUdpSmallServers": { "optionType": "global", "value": false }, "globalOtherSettingsConsoleLogging": { "optionType": "global", "value": true }, "globalOtherSettingsIPSourceRoute": { "optionType": "global", "value": false }, "globalOtherSettingsVtyLineLogging": { "optionType": "global", "value": false }, "globalOtherSettingsSnmpIfindexPersist": { "optionType": "global", "value": true }, "globalOtherSettingsIgnoreBootp": { "optionType": "global", "value": false }, "globalSettingsNat64UdpTimeout": { "optionType": "global", "value": 300 }, "globalSettingsNat64TcpTimeout": { "optionType": "global", "value": 3600 }, "globalSettingsHttpAuthentication": { "optionType": "default", "value": "" }, "globalSettingsSSHVersion": { "optionType": "default", "value": "" } } } }, "description": "Cedge System Global Settings config", "name": "Cedge_CG1_System_Globalsettings_parcel1" }, "$$ref": "#/components/examples/ProfileparcelSdwanSystemGlobalPutRequest_Cedge_CG1_System_Globalsettings_parcel1" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "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}" } }, "required": [ "id" ], "x-metadata": { "minVManageVersion": "20.15.1" }, "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelCommonPutResponse_SchemaPayload" }, "examples": { "example_1": { "value": { "id": "24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A" }, "$$ref": "#/components/examples/ProfileparcelCommonPutResponse_example_1" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Feature Profile > System > Global-write" } }, "/v1/feature-profile/sdwan/system/{systemId}/ignition": { "post": { "tags": [ "Configuration - Feature Profile (SDWAN)" ], "description": "Create a Ignition Profile feature for System feature profile", "operationId": "CreateIgnitionProfileParcelForSystem_ConfigurationFeatureProfileSdwan_5204", "parameters": [ { "name": "systemId", "in": "path", "description": "Feature 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": "Ignition Profile feature", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[^&<>! \"]+$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_cgFpPpNameDef" }, "description": { "type": "string" }, "data": { "type": "object", "properties": { "powerManagement": { "description": "Enable/disable power management", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanCommonIgnitionCommonRequest_oneOfPowerManagementOptionsDef" }, "sense": { "description": "Enable/disable sense", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ true ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanTrueDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanCommonIgnitionCommonRequest_oneOfSenseVoltageOptionsDef" }, "batteryType": { "description": "Battery type", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "enum": [ "12v", "24v" ], "default": "12v", "$$ref": "#/components/schemas/ProfileparcelSdwanCommonIgnitionCommonRequest_batteryTypeDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "string", "enum": [ "12v" ], "$$ref": "#/components/schemas/ProfileparcelSdwanCommonIgnitionCommonRequest_defaultBatteryTypeDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanCommonIgnitionCommonRequest_oneOfBatteryTypeOptionsDef" }, "shutdownTimer": { "description": "Shutdown timer", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "integer", "minimum": 120, "maximum": 32400, "default": 300, "$$ref": "#/components/schemas/ProfileparcelSdwanCommonIgnitionCommonRequest_shutdownTimerDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "minimum": 300, "maximum": 300, "default": 300, "$$ref": "#/components/schemas/ProfileparcelSdwanCommonIgnitionCommonRequest_defaultShutdownTimerDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanCommonIgnitionCommonRequest_oneOfShutdownTimerOptionsDef" }, "underVoltageThreshold": { "description": "UnderVoltage threshold", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "number", "multipleOf": 0.001, "minimum": 9, "maximum": 24, "default": 9, "$$ref": "#/components/schemas/ProfileparcelSdwanCommonIgnitionCommonRequest_underVoltageThresholdDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "number", "multipleOf": 0.001, "minimum": 9, "maximum": 9, "default": 9, "$$ref": "#/components/schemas/ProfileparcelSdwanCommonIgnitionCommonRequest_defaultUnderVoltageThresholdDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanCommonIgnitionCommonRequest_oneOfUnderVoltageThresholdOptionsDef" }, "senseVoltageThreshold": { "description": "SenseVoltage threshold", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "number", "multipleOf": 0.001, "minimum": 9, "maximum": 36, "default": 11.5, "$$ref": "#/components/schemas/ProfileparcelSdwanCommonIgnitionCommonRequest_senseVoltageThresholdDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "number", "multipleOf": 0.001, "default": 11.5, "$$ref": "#/components/schemas/ProfileparcelSdwanCommonIgnitionCommonRequest_defaultSenseVoltageThresholdDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanCommonIgnitionCommonRequest_oneOfSenseVoltageThresholdOptionsDef" } }, "required": [ "powerManagement" ], "additionalProperties": false } }, "required": [ "data" ], "x-metadata": { "supportedDeviceTypes": [ "vedge-IR-1821", "vedge-IR-1831", "vedge-IR-1833", "vedge-IR-1835", "vedge-IR-1821-SD-ROUTING", "vedge-IR-1831-SD-ROUTING", "vedge-IR-1833-SD-ROUTING", "vedge-IR-1835-SD-ROUTING" ], "minVManageVersion": "20.18.1" }, "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelSdwanCommonIgnitionCommonRequest_SchemaPayload" }, "examples": { "Ignition": { "value": { "name": "Ignition", "data": { "powerManagement": { "optionType": "global", "value": true }, "sense": { "optionType": "global", "value": true }, "batteryType": { "optionType": "global", "value": "24v" }, "shutdownTimer": { "optionType": "global", "value": 300 }, "underVoltageThreshold": { "optionType": "global", "value": 12.345 }, "senseVoltageThreshold": { "optionType": "global", "value": 23.456 } } }, "$$ref": "#/components/examples/ProfileparcelSdwanCommonIgnitionCommonRequest_Ignition" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "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}" } }, "required": [ "id" ], "x-metadata": { "minVManageVersion": "20.15.1" }, "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelCommonPostResponse_SchemaPayload" }, "examples": { "example_1": { "value": { "id": "24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A" }, "$$ref": "#/components/examples/ProfileparcelCommonPostResponse_example_1" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Feature Profile > System > Ignition-write" }, "get": { "tags": [ "Configuration - Feature Profile (SDWAN)" ], "description": "Get Ignition Profile Parcels for System feature profile", "operationId": "GetIgnitionProfileParcelForSystem_ConfigurationFeatureProfileSdwan_5203", "parameters": [ { "name": "systemId", "in": "path", "description": "Feature 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", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "parcelId": { "type": "string", "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}", "$$ref": "#/components/schemas/CommonCommonDefs_uuidDef" }, "parcelType": { "type": "string" }, "createdBy": { "type": "string", "description": "User who last created this.", "readOnly": true }, "createdOn": { "type": "integer", "description": "Timestamp of creation", "format": "int64", "readOnly": true }, "lastUpdatedBy": { "type": "string", "description": "User who last updated this.", "readOnly": true }, "lastUpdatedOn": { "type": "integer", "description": "Timestamp of last update", "format": "int64", "readOnly": true }, "payload": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[^&<>! \"]+$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_cgFpPpNameDef" }, "description": { "type": "string" }, "data": { "type": "object", "properties": { "powerManagement": { "description": "Enable/disable power management", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanCommonIgnitionCommonRequest_oneOfPowerManagementOptionsDef" }, "sense": { "description": "Enable/disable sense", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ true ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanTrueDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanCommonIgnitionCommonRequest_oneOfSenseVoltageOptionsDef" }, "batteryType": { "description": "Battery type", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "enum": [ "12v", "24v" ], "default": "12v", "$$ref": "#/components/schemas/ProfileparcelSdwanCommonIgnitionCommonRequest_batteryTypeDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "string", "enum": [ "12v" ], "$$ref": "#/components/schemas/ProfileparcelSdwanCommonIgnitionCommonRequest_defaultBatteryTypeDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanCommonIgnitionCommonRequest_oneOfBatteryTypeOptionsDef" }, "shutdownTimer": { "description": "Shutdown timer", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "integer", "minimum": 120, "maximum": 32400, "default": 300, "$$ref": "#/components/schemas/ProfileparcelSdwanCommonIgnitionCommonRequest_shutdownTimerDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "minimum": 300, "maximum": 300, "default": 300, "$$ref": "#/components/schemas/ProfileparcelSdwanCommonIgnitionCommonRequest_defaultShutdownTimerDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanCommonIgnitionCommonRequest_oneOfShutdownTimerOptionsDef" }, "underVoltageThreshold": { "description": "UnderVoltage threshold", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "number", "multipleOf": 0.001, "minimum": 9, "maximum": 24, "default": 9, "$$ref": "#/components/schemas/ProfileparcelSdwanCommonIgnitionCommonRequest_underVoltageThresholdDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "number", "multipleOf": 0.001, "minimum": 9, "maximum": 9, "default": 9, "$$ref": "#/components/schemas/ProfileparcelSdwanCommonIgnitionCommonRequest_defaultUnderVoltageThresholdDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanCommonIgnitionCommonRequest_oneOfUnderVoltageThresholdOptionsDef" }, "senseVoltageThreshold": { "description": "SenseVoltage threshold", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "number", "multipleOf": 0.001, "minimum": 9, "maximum": 36, "default": 11.5, "$$ref": "#/components/schemas/ProfileparcelSdwanCommonIgnitionCommonRequest_senseVoltageThresholdDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "number", "multipleOf": 0.001, "default": 11.5, "$$ref": "#/components/schemas/ProfileparcelSdwanCommonIgnitionCommonRequest_defaultSenseVoltageThresholdDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanCommonIgnitionCommonRequest_oneOfSenseVoltageThresholdOptionsDef" } }, "required": [ "powerManagement" ], "additionalProperties": false } }, "required": [ "data" ], "x-metadata": { "supportedDeviceTypes": [ "vedge-IR-1821", "vedge-IR-1831", "vedge-IR-1833", "vedge-IR-1835", "vedge-IR-1821-SD-ROUTING", "vedge-IR-1831-SD-ROUTING", "vedge-IR-1833-SD-ROUTING", "vedge-IR-1835-SD-ROUTING" ], "minVManageVersion": "20.18.1" }, "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelSdwanCommonIgnitionCommonRequest_SchemaPayload" } } } } }, "$$ref": "#/components/schemas/getListSdwanSystemIgnitionPayload" }, "examples": { "get response example": { "value": { "header": { "generatedOn": 1702438718825 }, "data": [ { "parcelId": "09fc54fe-ff36-4640-ae57-c9e71a103902", "parcelType": "ignition", "createdBy": "admin", "lastUpdatedBy": "admin", "createdOn": 1701866357838, "lastUpdatedOn": 1701866357838, "payload": { "data": { "powerManagement": { "optionType": "global", "value": true }, "sense": { "optionType": "global", "value": true }, "batteryType": { "optionType": "global", "value": "24v" }, "shutdownTimer": { "optionType": "global", "value": 300 }, "underVoltageThreshold": { "optionType": "global", "value": 12.345 }, "senseVoltageThreshold": { "optionType": "global", "value": 23.456 } } } } ] }, "$$ref": "#/components/examples/getListSdwanSystemIgnitionExample" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Feature Profile > System > Ignition-read,Feature Profile > System > Ignition-write" } }, "/v1/feature-profile/sdwan/system/{systemId}/ignition/{ignitionId}": { "get": { "tags": [ "Configuration - Feature Profile (SDWAN)" ], "description": "Get Ignition Profile feature by parcelId for System feature profile", "operationId": "GetIgnitionProfileParcelByParcelIdForSystem_ConfigurationFeatureProfileSdwan_6503", "parameters": [ { "name": "systemId", "in": "path", "description": "Feature 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" } }, { "name": "ignitionId", "in": "path", "description": "Profile feature 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", "properties": { "parcelId": { "type": "string", "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}", "$$ref": "#/components/schemas/CommonCommonDefs_uuidDef" }, "parcelType": { "type": "string" }, "createdBy": { "type": "string", "description": "User who last created this.", "readOnly": true }, "createdOn": { "type": "integer", "description": "Timestamp of creation", "format": "int64", "readOnly": true }, "lastUpdatedBy": { "type": "string", "description": "User who last updated this.", "readOnly": true }, "lastUpdatedOn": { "type": "integer", "description": "Timestamp of last update", "format": "int64", "readOnly": true }, "payload": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[^&<>! \"]+$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_cgFpPpNameDef" }, "description": { "type": "string" }, "data": { "type": "object", "properties": { "powerManagement": { "description": "Enable/disable power management", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanCommonIgnitionCommonRequest_oneOfPowerManagementOptionsDef" }, "sense": { "description": "Enable/disable sense", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ true ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanTrueDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanCommonIgnitionCommonRequest_oneOfSenseVoltageOptionsDef" }, "batteryType": { "description": "Battery type", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "enum": [ "12v", "24v" ], "default": "12v", "$$ref": "#/components/schemas/ProfileparcelSdwanCommonIgnitionCommonRequest_batteryTypeDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "string", "enum": [ "12v" ], "$$ref": "#/components/schemas/ProfileparcelSdwanCommonIgnitionCommonRequest_defaultBatteryTypeDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanCommonIgnitionCommonRequest_oneOfBatteryTypeOptionsDef" }, "shutdownTimer": { "description": "Shutdown timer", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "integer", "minimum": 120, "maximum": 32400, "default": 300, "$$ref": "#/components/schemas/ProfileparcelSdwanCommonIgnitionCommonRequest_shutdownTimerDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "minimum": 300, "maximum": 300, "default": 300, "$$ref": "#/components/schemas/ProfileparcelSdwanCommonIgnitionCommonRequest_defaultShutdownTimerDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanCommonIgnitionCommonRequest_oneOfShutdownTimerOptionsDef" }, "underVoltageThreshold": { "description": "UnderVoltage threshold", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "number", "multipleOf": 0.001, "minimum": 9, "maximum": 24, "default": 9, "$$ref": "#/components/schemas/ProfileparcelSdwanCommonIgnitionCommonRequest_underVoltageThresholdDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "number", "multipleOf": 0.001, "minimum": 9, "maximum": 9, "default": 9, "$$ref": "#/components/schemas/ProfileparcelSdwanCommonIgnitionCommonRequest_defaultUnderVoltageThresholdDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanCommonIgnitionCommonRequest_oneOfUnderVoltageThresholdOptionsDef" }, "senseVoltageThreshold": { "description": "SenseVoltage threshold", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "number", "multipleOf": 0.001, "minimum": 9, "maximum": 36, "default": 11.5, "$$ref": "#/components/schemas/ProfileparcelSdwanCommonIgnitionCommonRequest_senseVoltageThresholdDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "number", "multipleOf": 0.001, "default": 11.5, "$$ref": "#/components/schemas/ProfileparcelSdwanCommonIgnitionCommonRequest_defaultSenseVoltageThresholdDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanCommonIgnitionCommonRequest_oneOfSenseVoltageThresholdOptionsDef" } }, "required": [ "powerManagement" ], "additionalProperties": false } }, "required": [ "data" ], "x-metadata": { "supportedDeviceTypes": [ "vedge-IR-1821", "vedge-IR-1831", "vedge-IR-1833", "vedge-IR-1835", "vedge-IR-1821-SD-ROUTING", "vedge-IR-1831-SD-ROUTING", "vedge-IR-1833-SD-ROUTING", "vedge-IR-1835-SD-ROUTING" ], "minVManageVersion": "20.18.1" }, "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelSdwanCommonIgnitionCommonRequest_SchemaPayload" } }, "$$ref": "#/components/schemas/getSingleSdwanSystemIgnitionPayload" }, "examples": { "get response example": { "value": { "parcelId": "09fc54fe-ff36-4640-ae57-c9e71a103902", "parcelType": "ignition", "createdBy": "admin", "lastUpdatedBy": "admin", "createdOn": 1701866357838, "lastUpdatedOn": 1701866357838, "payload": { "data": { "powerManagement": { "optionType": "global", "value": true }, "sense": { "optionType": "global", "value": true }, "batteryType": { "optionType": "global", "value": "24v" }, "shutdownTimer": { "optionType": "global", "value": 300 }, "underVoltageThreshold": { "optionType": "global", "value": 12.345 }, "senseVoltageThreshold": { "optionType": "global", "value": 23.456 } } } }, "$$ref": "#/components/examples/getSingleSdwanSystemIgnitionExample" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Feature Profile > System > Ignition-read,Feature Profile > System > Ignition-write" }, "put": { "tags": [ "Configuration - Feature Profile (SDWAN)" ], "description": "Update a Ignition Profile feature for System feature profile", "operationId": "EditIgnitionProfileParcelForSystem_ConfigurationFeatureProfileSdwan_6503", "parameters": [ { "name": "systemId", "in": "path", "description": "Feature 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" } }, { "name": "ignitionId", "in": "path", "description": "Profile feature 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": "Ignition Profile Parcel", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[^&<>! \"]+$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_cgFpPpNameDef" }, "description": { "type": "string" }, "data": { "type": "object", "properties": { "powerManagement": { "description": "Enable/disable power management", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanCommonIgnitionCommonRequest_oneOfPowerManagementOptionsDef" }, "sense": { "description": "Enable/disable sense", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ true ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanTrueDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanCommonIgnitionCommonRequest_oneOfSenseVoltageOptionsDef" }, "batteryType": { "description": "Battery type", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "enum": [ "12v", "24v" ], "default": "12v", "$$ref": "#/components/schemas/ProfileparcelSdwanCommonIgnitionCommonRequest_batteryTypeDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "string", "enum": [ "12v" ], "$$ref": "#/components/schemas/ProfileparcelSdwanCommonIgnitionCommonRequest_defaultBatteryTypeDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanCommonIgnitionCommonRequest_oneOfBatteryTypeOptionsDef" }, "shutdownTimer": { "description": "Shutdown timer", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "integer", "minimum": 120, "maximum": 32400, "default": 300, "$$ref": "#/components/schemas/ProfileparcelSdwanCommonIgnitionCommonRequest_shutdownTimerDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "minimum": 300, "maximum": 300, "default": 300, "$$ref": "#/components/schemas/ProfileparcelSdwanCommonIgnitionCommonRequest_defaultShutdownTimerDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanCommonIgnitionCommonRequest_oneOfShutdownTimerOptionsDef" }, "underVoltageThreshold": { "description": "UnderVoltage threshold", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "number", "multipleOf": 0.001, "minimum": 9, "maximum": 24, "default": 9, "$$ref": "#/components/schemas/ProfileparcelSdwanCommonIgnitionCommonRequest_underVoltageThresholdDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "number", "multipleOf": 0.001, "minimum": 9, "maximum": 9, "default": 9, "$$ref": "#/components/schemas/ProfileparcelSdwanCommonIgnitionCommonRequest_defaultUnderVoltageThresholdDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanCommonIgnitionCommonRequest_oneOfUnderVoltageThresholdOptionsDef" }, "senseVoltageThreshold": { "description": "SenseVoltage threshold", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "number", "multipleOf": 0.001, "minimum": 9, "maximum": 36, "default": 11.5, "$$ref": "#/components/schemas/ProfileparcelSdwanCommonIgnitionCommonRequest_senseVoltageThresholdDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "number", "multipleOf": 0.001, "default": 11.5, "$$ref": "#/components/schemas/ProfileparcelSdwanCommonIgnitionCommonRequest_defaultSenseVoltageThresholdDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanCommonIgnitionCommonRequest_oneOfSenseVoltageThresholdOptionsDef" } }, "required": [ "powerManagement" ], "additionalProperties": false } }, "required": [ "data" ], "x-metadata": { "supportedDeviceTypes": [ "vedge-IR-1821", "vedge-IR-1831", "vedge-IR-1833", "vedge-IR-1835", "vedge-IR-1821-SD-ROUTING", "vedge-IR-1831-SD-ROUTING", "vedge-IR-1833-SD-ROUTING", "vedge-IR-1835-SD-ROUTING" ], "minVManageVersion": "20.18.1" }, "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelSdwanCommonIgnitionCommonRequest_SchemaPayload" }, "examples": { "Ignition": { "value": { "name": "Ignition", "data": { "powerManagement": { "optionType": "global", "value": true }, "sense": { "optionType": "global", "value": true }, "batteryType": { "optionType": "global", "value": "24v" }, "shutdownTimer": { "optionType": "global", "value": 300 }, "underVoltageThreshold": { "optionType": "global", "value": 12.345 }, "senseVoltageThreshold": { "optionType": "global", "value": 23.456 } } }, "$$ref": "#/components/examples/ProfileparcelSdwanCommonIgnitionCommonRequest_Ignition" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "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}" } }, "required": [ "id" ], "x-metadata": { "minVManageVersion": "20.15.1" }, "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelCommonPutResponse_SchemaPayload" }, "examples": { "example_1": { "value": { "id": "24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A" }, "$$ref": "#/components/examples/ProfileparcelCommonPutResponse_example_1" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Feature Profile > System > Ignition-write" }, "delete": { "tags": [ "Configuration - Feature Profile (SDWAN)" ], "description": "Delete a Ignition Profile feature for System feature profile", "operationId": "DeleteIgnitionProfileParcelForSystem_ConfigurationFeatureProfileSdwan_6506", "parameters": [ { "name": "systemId", "in": "path", "description": "Feature 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" } }, { "name": "ignitionId", "in": "path", "description": "Profile feature 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": "Feature Profile > System > Ignition-write" } }, "/v1/feature-profile/sdwan/system/{systemId}/logging": { "post": { "tags": [ "Configuration - Feature Profile (SDWAN)" ], "description": "Create a Logging Profile Parcel for System feature profile", "operationId": "CreateLoggingProfileParcelForSystem", "parameters": [ { "name": "systemId", "in": "path", "description": "Feature 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": "Logging Profile Parcel", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[^&<>! \"]+$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_cgFpPpNameDef", "description": "Set the parcel name" }, "description": { "description": "Set the parcel description", "type": "string" }, "data": { "type": "object", "properties": { "disk": { "type": "object", "properties": { "diskEnable": { "description": "Enable logging to local disk", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ true ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanTrueDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPostRequest_oneOfDiskEnableOptionsDef" }, "file": { "type": "object", "properties": { "diskFileSize": { "description": "Set maximum size of file before it is rotated", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "integer", "minimum": 1, "maximum": 20, "default": 10, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPostRequest_diskFileSizeDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "maximum": 10, "minimum": 10, "type": "integer", "default": 10 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPostRequest_oneOfDiskFileSizeOptionsDef" }, "diskFileRotate": { "description": "Set number of syslog files to create before discarding oldest files", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "integer", "minimum": 1, "maximum": 10, "default": 10, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPostRequest_diskFileRotateDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "maximum": 10, "minimum": 10, "type": "integer", "default": 10 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPostRequest_oneOfDiskFileRotateOptionsDef" } }, "required": [ "diskFileSize", "diskFileRotate" ], "additionalProperties": false } }, "required": [ "file" ], "additionalProperties": false }, "tlsProfile": { "description": "Configure a TLS profile", "uniqueItems": true, "type": "array", "additionalProperties": false, "items": { "type": "object", "properties": { "profile": { "description": "Specify the name of the TLS profile", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "minLength": 1, "maxLength": 30, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPostRequest_profileDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPostRequest_oneOfProfileOptionsDef" }, "tlsVersion": { "description": "TLS Version", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "enum": [ "TLSv1.1", "TLSv1.2" ], "default": "TLSv1.1", "x-attributeMetadata": { "insecureConfiguration": { "attributeJsonPath": "$.data.tlsProfile[*].tlsVersion", "values": [ "TLSv1.1" ], "description": "Logging TLS profile configured with TLS version 1.1 - deprecated and vulnerable to attacks", "reason": "Weak tls version", "remediation": "Use stronger tls version to enhance security" } }, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPostRequest_TLSVersionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "string", "enum": [ "TLSv1.1" ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPostRequest_oneOfTLSVersionOptionsDef" }, "authType": { "description": "Authentication Type", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "string", "enum": [ "Server" ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPostRequest_oneOfAuthTypeOptionsDef" }, "cipherSuiteList": { "description": "Syslog secure server ciphersuites", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "array", "items": { "uniqueItems": true, "type": "string", "additionalProperties": false, "enum": [ "aes-128-cbc-sha", "aes-256-cbc-sha", "dhe-aes-cbc-sha2", "dhe-aes-gcm-sha2", "ecdhe-ecdsa-aes-gcm-sha2", "ecdhe-rsa-aes-cbc-sha2", "ecdhe-rsa-aes-gcm-sha2", "rsa-aes-cbc-sha2", "rsa-aes-gcm-sha2" ] }, "x-attributeMetadata": { "insecureConfiguration": { "attributeJsonPath": "$.data.tlsProfile[*].cipherSuiteList[*]", "values": [ "aes-128-cbc-sha", "aes-256-cbc-sha" ], "description": "Logging TLS profile configured with weak cipher suite using CBC mode and SHA-1", "reason": "Weak cipher(s) are present in the command", "remediation": "Use stronger cipher(s) to enhance security" } }, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPostRequest_cipherSuiteListDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPostRequest_oneOfCipherSuiteListOptionsDef" } }, "required": [ "profile", "authType" ], "additionalProperties": false } }, "server": { "description": "Enable logging to remote server", "uniqueItems": true, "type": "array", "additionalProperties": false, "items": { "if": { "anyOf": [ { "properties": { "name": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "name" ] }, { "properties": { "vpn": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "vpn" ] }, { "properties": { "priority": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "priority" ] }, { "properties": { "tlsEnable": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "tlsEnable" ] } ] }, "then": { "required": [ "name", "vpn", "priority", "tlsEnable" ] }, "type": "object", "properties": { "name": { "description": "Set IPv4 address of server", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "pattern": "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}$", "$$ref": "#/components/schemas/CommonCommonDefs_ipv4AddressDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/CommonCommonDefs_oneOfIpV4AddressOptionsDef" }, "vpn": { "description": "Set vpn of server", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "integer", "minimum": 0, "maximum": 65530, "$$ref": "#/components/schemas/CommonCommonDefs_vpnDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "minimum": 0, "maximum": 0, "default": 0, "$$ref": "#/components/schemas/CommonCommonDefs_vpnZeroDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPostRequest_oneOfVpnOptionsDef" }, "sourceInterface": { "description": "Set interface to use to reach syslog server", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "minLength": 1, "$$ref": "#/components/schemas/CommonCommonDefs_nonEmptyStringDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPostRequest_oneOfSourceInterfaceOptionsDef" }, "priority": { "description": "Set logging level for messages logged to server", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "enum": [ "informational", "debugging", "notice", "warn", "error", "critical", "alert", "emergency" ], "default": "informational", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPostRequest_prioritytDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "string", "enum": [ "informational" ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPostRequest_oneOfPriorityOptionsDef" }, "tlsEnable": { "description": "Enable TLS Profile", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPostRequest_oneOfTLSEnableOptionsDef" }, "tlsPropertiesCustomProfile": { "description": "Define custom profile", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPostRequest_oneOfTLSPropCustomProfileOptionsDef" }, "tlsPropertiesProfile": { "description": "Configure a TLS profile", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "minLength": 1, "$$ref": "#/components/schemas/CommonCommonDefs_nonEmptyStringDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionNoDefaultDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPostRequest_oneOfTLSPropProfileOptionsDef" } }, "additionalProperties": false } }, "ipv6Server": { "description": "Enable logging to remote ipv6 server", "uniqueItems": true, "additionalProperties": false, "type": "array", "items": { "if": { "anyOf": [ { "properties": { "name": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "name" ] }, { "properties": { "vpn": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "vpn" ] }, { "properties": { "priority": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "priority" ] }, { "properties": { "tlsEnable": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "tlsEnable" ] } ] }, "then": { "required": [ "name", "vpn", "priority", "tlsEnable" ] }, "type": "object", "properties": { "name": { "description": "Set IPv6 address of server", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "format": "ipv6" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_ipv6AddrGlobalOptionDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/CommonCommonDefs_oneOfIpv6AddrGlobalVariableOptionsDef" }, "vpn": { "description": "Set vpn of server", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "integer", "minimum": 0, "maximum": 65530, "$$ref": "#/components/schemas/CommonCommonDefs_vpnDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "minimum": 0, "maximum": 0, "default": 0, "$$ref": "#/components/schemas/CommonCommonDefs_vpnZeroDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPostRequest_oneOfVpnOptionsDef" }, "sourceInterface": { "description": "Set interface to use to reach syslog server", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "minLength": 1, "$$ref": "#/components/schemas/CommonCommonDefs_nonEmptyStringDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPostRequest_oneOfSourceInterfaceOptionsDef" }, "priority": { "description": "Set logging level for messages logged to server", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "enum": [ "informational", "debugging", "notice", "warn", "error", "critical", "alert", "emergency" ], "default": "informational", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPostRequest_prioritytDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "string", "enum": [ "informational" ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPostRequest_oneOfPriorityOptionsDef" }, "tlsEnable": { "description": "Enable TLS Profile", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPostRequest_oneOfTLSEnableOptionsDef" }, "tlsPropertiesCustomProfile": { "description": "Define custom profile", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPostRequest_oneOfTLSPropCustomProfileOptionsDef" }, "tlsPropertiesProfile": { "description": "Configure a TLS profile", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "minLength": 1, "$$ref": "#/components/schemas/CommonCommonDefs_nonEmptyStringDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionNoDefaultDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPostRequest_oneOfTLSPropProfileOptionsDef" } }, "additionalProperties": false } } }, "required": [ "disk" ], "additionalProperties": false } }, "required": [ "name", "data" ], "x-metadata": { "supportedDeviceTypes": [ "asr", "c1100", "c8000be", "csr1000v", "ir8100", "ir8340", "isr", "ISRv", "ir1101" ], "minVManageVersion": "20.18.1" }, "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPostRequest_SchemaPayload" }, "examples": { "Cedge_CG1_System_Logging_parcel1": { "value": { "data": { "disk": { "diskEnable": { "optionType": "global", "value": true }, "file": { "diskFileSize": { "optionType": "global", "value": 9 }, "diskFileRotate": { "optionType": "global", "value": 10 } } }, "tlsProfile": [ { "profile": { "optionType": "global", "value": "test" }, "tlsVersion": { "optionType": "global", "value": "TLSv1.1" }, "authType": { "optionType": "global", "value": "Server" }, "cipherSuiteList": { "optionType": "global", "value": [ "aes-128-cbc-sha" ] } } ], "server": [ { "name": { "optionType": "global", "value": "10.10.10.1" }, "vpn": { "optionType": "global", "value": "0" }, "sourceInterface": { "optionType": "global", "value": "ge0/0/1" }, "priority": { "optionType": "global", "value": "debugging" }, "tlsEnable": { "optionType": "default", "value": true }, "tlsPropertiesCustomProfile": { "optionType": "global", "value": true }, "tlsPropertiesProfile": { "optionType": "global", "value": "test" } } ], "ipv6Server": [ { "name": { "optionType": "global", "value": "2001::1" }, "vpn": { "optionType": "global", "value": "512" }, "sourceInterface": { "optionType": "global", "value": "GigabitEthernet1" }, "priority": { "optionType": "global", "value": "information" }, "tlsEnable": { "optionType": "default", "value": true }, "tlsPropertiesCustomProfile": { "optionType": "global", "value": false } } ] }, "description": "Cedge System Logging Parcel config", "name": "Cedge_CG1_System_Logging_parcel1" }, "$$ref": "#/components/examples/ProfileparcelSdwanSystemLoggingPostRequest_Cedge_CG1_System_Logging_parcel1" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "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}" } }, "required": [ "id" ], "x-metadata": { "minVManageVersion": "20.15.1" }, "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelCommonPostResponse_SchemaPayload" }, "examples": { "example_1": { "value": { "id": "24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A" }, "$$ref": "#/components/examples/ProfileparcelCommonPostResponse_example_1" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Feature Profile > System > Logging-write" }, "get": { "tags": [ "Configuration - Feature Profile (SDWAN)" ], "description": "Get Logging Profile Parcels for System feature profile", "operationId": "GetLoggingProfileParcelForSystem", "parameters": [ { "name": "systemId", "in": "path", "description": "Feature 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", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "parcelId": { "type": "string", "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}", "$$ref": "#/components/schemas/CommonCommonDefs_uuidDef" }, "parcelType": { "type": "string" }, "createdBy": { "type": "string", "description": "User who last created this.", "readOnly": true }, "createdOn": { "type": "integer", "description": "Timestamp of creation", "format": "int64", "readOnly": true }, "lastUpdatedBy": { "type": "string", "description": "User who last updated this.", "readOnly": true }, "lastUpdatedOn": { "type": "integer", "description": "Timestamp of last update", "format": "int64", "readOnly": true }, "payload": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[^&<>! \"]+$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_cgFpPpNameDef", "description": "Set the parcel name" }, "description": { "description": "Set the parcel description", "type": "string" }, "data": { "type": "object", "properties": { "disk": { "type": "object", "properties": { "diskEnable": { "description": "Enable logging to local disk", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ true ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanTrueDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPostRequest_oneOfDiskEnableOptionsDef" }, "file": { "type": "object", "properties": { "diskFileSize": { "description": "Set maximum size of file before it is rotated", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "integer", "minimum": 1, "maximum": 20, "default": 10, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPostRequest_diskFileSizeDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "maximum": 10, "minimum": 10, "type": "integer", "default": 10 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPostRequest_oneOfDiskFileSizeOptionsDef" }, "diskFileRotate": { "description": "Set number of syslog files to create before discarding oldest files", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "integer", "minimum": 1, "maximum": 10, "default": 10, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPostRequest_diskFileRotateDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "maximum": 10, "minimum": 10, "type": "integer", "default": 10 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPostRequest_oneOfDiskFileRotateOptionsDef" } }, "required": [ "diskFileSize", "diskFileRotate" ], "additionalProperties": false } }, "required": [ "file" ], "additionalProperties": false }, "tlsProfile": { "description": "Configure a TLS profile", "uniqueItems": true, "type": "array", "additionalProperties": false, "items": { "type": "object", "properties": { "profile": { "description": "Specify the name of the TLS profile", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "minLength": 1, "maxLength": 30, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPostRequest_profileDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPostRequest_oneOfProfileOptionsDef" }, "tlsVersion": { "description": "TLS Version", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "enum": [ "TLSv1.1", "TLSv1.2" ], "default": "TLSv1.1", "x-attributeMetadata": { "insecureConfiguration": { "attributeJsonPath": "$.data.tlsProfile[*].tlsVersion", "values": [ "TLSv1.1" ], "description": "Logging TLS profile configured with TLS version 1.1 - deprecated and vulnerable to attacks", "reason": "Weak tls version", "remediation": "Use stronger tls version to enhance security" } }, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPostRequest_TLSVersionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "string", "enum": [ "TLSv1.1" ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPostRequest_oneOfTLSVersionOptionsDef" }, "authType": { "description": "Authentication Type", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "string", "enum": [ "Server" ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPostRequest_oneOfAuthTypeOptionsDef" }, "cipherSuiteList": { "description": "Syslog secure server ciphersuites", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "array", "items": { "uniqueItems": true, "type": "string", "additionalProperties": false, "enum": [ "aes-128-cbc-sha", "aes-256-cbc-sha", "dhe-aes-cbc-sha2", "dhe-aes-gcm-sha2", "ecdhe-ecdsa-aes-gcm-sha2", "ecdhe-rsa-aes-cbc-sha2", "ecdhe-rsa-aes-gcm-sha2", "rsa-aes-cbc-sha2", "rsa-aes-gcm-sha2" ] }, "x-attributeMetadata": { "insecureConfiguration": { "attributeJsonPath": "$.data.tlsProfile[*].cipherSuiteList[*]", "values": [ "aes-128-cbc-sha", "aes-256-cbc-sha" ], "description": "Logging TLS profile configured with weak cipher suite using CBC mode and SHA-1", "reason": "Weak cipher(s) are present in the command", "remediation": "Use stronger cipher(s) to enhance security" } }, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPostRequest_cipherSuiteListDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPostRequest_oneOfCipherSuiteListOptionsDef" } }, "required": [ "profile", "authType" ], "additionalProperties": false } }, "server": { "description": "Enable logging to remote server", "uniqueItems": true, "type": "array", "additionalProperties": false, "items": { "if": { "anyOf": [ { "properties": { "name": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "name" ] }, { "properties": { "vpn": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "vpn" ] }, { "properties": { "priority": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "priority" ] }, { "properties": { "tlsEnable": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "tlsEnable" ] } ] }, "then": { "required": [ "name", "vpn", "priority", "tlsEnable" ] }, "type": "object", "properties": { "name": { "description": "Set IPv4 address of server", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "pattern": "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}$", "$$ref": "#/components/schemas/CommonCommonDefs_ipv4AddressDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/CommonCommonDefs_oneOfIpV4AddressOptionsDef" }, "vpn": { "description": "Set vpn of server", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "integer", "minimum": 0, "maximum": 65530, "$$ref": "#/components/schemas/CommonCommonDefs_vpnDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "minimum": 0, "maximum": 0, "default": 0, "$$ref": "#/components/schemas/CommonCommonDefs_vpnZeroDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPostRequest_oneOfVpnOptionsDef" }, "sourceInterface": { "description": "Set interface to use to reach syslog server", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "minLength": 1, "$$ref": "#/components/schemas/CommonCommonDefs_nonEmptyStringDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPostRequest_oneOfSourceInterfaceOptionsDef" }, "priority": { "description": "Set logging level for messages logged to server", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "enum": [ "informational", "debugging", "notice", "warn", "error", "critical", "alert", "emergency" ], "default": "informational", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPostRequest_prioritytDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "string", "enum": [ "informational" ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPostRequest_oneOfPriorityOptionsDef" }, "tlsEnable": { "description": "Enable TLS Profile", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPostRequest_oneOfTLSEnableOptionsDef" }, "tlsPropertiesCustomProfile": { "description": "Define custom profile", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPostRequest_oneOfTLSPropCustomProfileOptionsDef" }, "tlsPropertiesProfile": { "description": "Configure a TLS profile", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "minLength": 1, "$$ref": "#/components/schemas/CommonCommonDefs_nonEmptyStringDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionNoDefaultDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPostRequest_oneOfTLSPropProfileOptionsDef" } }, "additionalProperties": false } }, "ipv6Server": { "description": "Enable logging to remote ipv6 server", "uniqueItems": true, "additionalProperties": false, "type": "array", "items": { "if": { "anyOf": [ { "properties": { "name": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "name" ] }, { "properties": { "vpn": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "vpn" ] }, { "properties": { "priority": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "priority" ] }, { "properties": { "tlsEnable": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "tlsEnable" ] } ] }, "then": { "required": [ "name", "vpn", "priority", "tlsEnable" ] }, "type": "object", "properties": { "name": { "description": "Set IPv6 address of server", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "format": "ipv6" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_ipv6AddrGlobalOptionDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/CommonCommonDefs_oneOfIpv6AddrGlobalVariableOptionsDef" }, "vpn": { "description": "Set vpn of server", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "integer", "minimum": 0, "maximum": 65530, "$$ref": "#/components/schemas/CommonCommonDefs_vpnDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "minimum": 0, "maximum": 0, "default": 0, "$$ref": "#/components/schemas/CommonCommonDefs_vpnZeroDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPostRequest_oneOfVpnOptionsDef" }, "sourceInterface": { "description": "Set interface to use to reach syslog server", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "minLength": 1, "$$ref": "#/components/schemas/CommonCommonDefs_nonEmptyStringDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPostRequest_oneOfSourceInterfaceOptionsDef" }, "priority": { "description": "Set logging level for messages logged to server", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "enum": [ "informational", "debugging", "notice", "warn", "error", "critical", "alert", "emergency" ], "default": "informational", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPostRequest_prioritytDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "string", "enum": [ "informational" ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPostRequest_oneOfPriorityOptionsDef" }, "tlsEnable": { "description": "Enable TLS Profile", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPostRequest_oneOfTLSEnableOptionsDef" }, "tlsPropertiesCustomProfile": { "description": "Define custom profile", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPostRequest_oneOfTLSPropCustomProfileOptionsDef" }, "tlsPropertiesProfile": { "description": "Configure a TLS profile", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "minLength": 1, "$$ref": "#/components/schemas/CommonCommonDefs_nonEmptyStringDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionNoDefaultDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPostRequest_oneOfTLSPropProfileOptionsDef" } }, "additionalProperties": false } } }, "required": [ "disk" ], "additionalProperties": false } }, "required": [ "name", "data" ], "x-metadata": { "supportedDeviceTypes": [ "asr", "c1100", "c8000be", "csr1000v", "ir8100", "ir8340", "isr", "ISRv", "ir1101" ], "minVManageVersion": "20.18.1" }, "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPostRequest_SchemaPayload" } } } } }, "$$ref": "#/components/schemas/getListSdwanSystemLoggingPayload" }, "examples": { "get response example": { "value": { "header": { "generatedOn": 1702438718825 }, "data": [ { "parcelId": "09fc54fe-ff36-4640-ae57-c9e71a103902", "parcelType": "logging", "createdBy": "admin", "lastUpdatedBy": "admin", "createdOn": 1701866357838, "lastUpdatedOn": 1701866357838, "payload": { "data": { "disk": { "diskEnable": { "optionType": "global", "value": true }, "file": { "diskFileSize": { "optionType": "global", "value": 9 }, "diskFileRotate": { "optionType": "global", "value": 10 } } }, "tlsProfile": [ { "profile": { "optionType": "global", "value": "test" }, "tlsVersion": { "optionType": "global", "value": "TLSv1.1" }, "authType": { "optionType": "global", "value": "Server" }, "cipherSuiteList": { "optionType": "global", "value": [ "aes-128-cbc-sha" ] } } ], "server": [ { "name": { "optionType": "global", "value": "10.10.10.1" }, "vpn": { "optionType": "global", "value": "0" }, "sourceInterface": { "optionType": "global", "value": "ge0/0/1" }, "priority": { "optionType": "global", "value": "debugging" }, "tlsEnable": { "optionType": "default", "value": true }, "tlsPropertiesCustomProfile": { "optionType": "global", "value": true }, "tlsPropertiesProfile": { "optionType": "global", "value": "test" } } ], "ipv6Server": [ { "name": { "optionType": "global", "value": "2001::1" }, "vpn": { "optionType": "global", "value": "512" }, "sourceInterface": { "optionType": "global", "value": "GigabitEthernet1" }, "priority": { "optionType": "global", "value": "information" }, "tlsEnable": { "optionType": "default", "value": true }, "tlsPropertiesCustomProfile": { "optionType": "global", "value": false } } ] } } } ] }, "$$ref": "#/components/examples/getListSdwanSystemLoggingExample" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Feature Profile > System > Logging-read" } }, "/v1/feature-profile/sdwan/system/{systemId}/logging/{loggingId}": { "get": { "tags": [ "Configuration - Feature Profile (SDWAN)" ], "description": "Get Logging Profile Parcel by parcelId for System feature profile", "operationId": "GetLoggingProfileParcelByParcelIdForSystem", "parameters": [ { "name": "systemId", "in": "path", "description": "Feature 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" } }, { "name": "loggingId", "in": "path", "description": "Profile Parcel 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", "properties": { "parcelId": { "type": "string", "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}", "$$ref": "#/components/schemas/CommonCommonDefs_uuidDef" }, "parcelType": { "type": "string" }, "createdBy": { "type": "string", "description": "User who last created this.", "readOnly": true }, "createdOn": { "type": "integer", "description": "Timestamp of creation", "format": "int64", "readOnly": true }, "lastUpdatedBy": { "type": "string", "description": "User who last updated this.", "readOnly": true }, "lastUpdatedOn": { "type": "integer", "description": "Timestamp of last update", "format": "int64", "readOnly": true }, "payload": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[^&<>! \"]+$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_cgFpPpNameDef", "description": "Set the parcel name" }, "description": { "description": "Set the parcel description", "type": "string" }, "data": { "type": "object", "properties": { "disk": { "type": "object", "properties": { "diskEnable": { "description": "Enable logging to local disk", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ true ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanTrueDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPutRequest_oneOfDiskEnableOptionsDef" }, "file": { "type": "object", "properties": { "diskFileSize": { "description": "Set maximum size of file before it is rotated", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "integer", "minimum": 1, "maximum": 20, "default": 10, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPutRequest_diskFileSizeDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "maximum": 10, "minimum": 10, "type": "integer", "default": 10 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPutRequest_oneOfDiskFileSizeOptionsDef" }, "diskFileRotate": { "description": "Set number of syslog files to create before discarding oldest files", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "integer", "minimum": 1, "maximum": 10, "default": 10, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPutRequest_diskFileRotateDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "maximum": 10, "minimum": 10, "type": "integer", "default": 10 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPutRequest_oneOfDiskFileRotateOptionsDef" } }, "required": [ "diskFileSize", "diskFileRotate" ], "additionalProperties": false } }, "required": [ "file" ], "additionalProperties": false }, "tlsProfile": { "description": "Configure a TLS profile", "uniqueItems": true, "type": "array", "additionalProperties": false, "items": { "type": "object", "properties": { "profile": { "description": "Specify the name of the TLS profile", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "minLength": 1, "maxLength": 30, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPutRequest_profileDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPutRequest_oneOfProfileOptionsDef" }, "tlsVersion": { "description": "TLS Version", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "enum": [ "TLSv1.1", "TLSv1.2" ], "default": "TLSv1.1", "x-attributeMetadata": { "insecureConfiguration": { "attributeJsonPath": "$.data.tlsProfile[*].tlsVersion", "values": [ "TLSv1.1" ], "description": "Logging TLS profile configured with TLS version 1.1 - deprecated and vulnerable to attacks", "reason": "Weak tls version", "remediation": "Use stronger tls version to enhance security" } }, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPutRequest_TLSVersionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "string", "enum": [ "TLSv1.1" ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPutRequest_oneOfTLSVersionOptionsDef" }, "authType": { "description": "Authentication Type", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "string", "enum": [ "Server" ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPutRequest_oneOfAuthTypeOptionsDef" }, "cipherSuiteList": { "description": "Syslog secure server ciphersuites", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "array", "items": { "uniqueItems": true, "type": "string", "additionalProperties": false, "enum": [ "aes-128-cbc-sha", "aes-256-cbc-sha", "dhe-aes-cbc-sha2", "dhe-aes-gcm-sha2", "ecdhe-ecdsa-aes-gcm-sha2", "ecdhe-rsa-aes-cbc-sha2", "ecdhe-rsa-aes-gcm-sha2", "rsa-aes-cbc-sha2", "rsa-aes-gcm-sha2" ] }, "x-attributeMetadata": { "insecureConfiguration": { "attributeJsonPath": "$.data.tlsProfile[*].cipherSuiteList[*]", "values": [ "aes-128-cbc-sha", "aes-256-cbc-sha" ], "description": "Logging TLS profile configured with weak cipher suite using CBC mode and SHA-1", "reason": "Weak cipher(s) are present in the command", "remediation": "Use stronger cipher(s) to enhance security" } }, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPutRequest_cipherSuiteListDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPutRequest_oneOfCipherSuiteListOptionsDef" } }, "required": [ "profile", "authType" ], "additionalProperties": false } }, "server": { "description": "Enable logging to remote server", "uniqueItems": true, "type": "array", "additionalProperties": false, "items": { "if": { "anyOf": [ { "properties": { "name": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "name" ] }, { "properties": { "vpn": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "vpn" ] }, { "properties": { "priority": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "priority" ] }, { "properties": { "tlsEnable": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "tlsEnable" ] } ] }, "then": { "required": [ "name", "vpn", "priority", "tlsEnable" ] }, "type": "object", "properties": { "name": { "description": "Set IPv4 address of server", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "pattern": "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}$", "$$ref": "#/components/schemas/CommonCommonDefs_ipv4AddressDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/CommonCommonDefs_oneOfIpV4AddressOptionsDef" }, "vpn": { "description": "Set vpn of server", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "integer", "minimum": 0, "maximum": 65530, "$$ref": "#/components/schemas/CommonCommonDefs_vpnDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "minimum": 0, "maximum": 0, "default": 0, "$$ref": "#/components/schemas/CommonCommonDefs_vpnZeroDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPutRequest_oneOfVpnOptionsDef" }, "sourceInterface": { "description": "Set interface to use to reach syslog server", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "minLength": 1, "$$ref": "#/components/schemas/CommonCommonDefs_nonEmptyStringDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPutRequest_oneOfSourceInterfaceOptionsDef" }, "priority": { "description": "Set logging level for messages logged to server", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "enum": [ "informational", "debugging", "notice", "warn", "error", "critical", "alert", "emergency" ], "default": "informational", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPutRequest_prioritytDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "string", "enum": [ "informational" ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPutRequest_oneOfPriorityOptionsDef" }, "tlsEnable": { "description": "Enable TLS Profile", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPutRequest_oneOfTLSEnableOptionsDef" }, "tlsPropertiesCustomProfile": { "description": "Define custom profile", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPutRequest_oneOfTLSPropCustomProfileOptionsDef" }, "tlsPropertiesProfile": { "description": "Configure a TLS profile", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "minLength": 1, "$$ref": "#/components/schemas/CommonCommonDefs_nonEmptyStringDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionNoDefaultDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPutRequest_oneOfTLSPropProfileOptionsDef" } }, "additionalProperties": false } }, "ipv6Server": { "description": "Enable logging to remote ipv6 server", "uniqueItems": true, "additionalProperties": false, "type": "array", "items": { "if": { "anyOf": [ { "properties": { "name": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "name" ] }, { "properties": { "vpn": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "vpn" ] }, { "properties": { "priority": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "priority" ] }, { "properties": { "tlsEnable": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "tlsEnable" ] } ] }, "then": { "required": [ "name", "vpn", "priority", "tlsEnable" ] }, "type": "object", "properties": { "name": { "description": "Set IPv6 address of server", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "format": "ipv6" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_ipv6AddrGlobalOptionDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/CommonCommonDefs_oneOfIpv6AddrGlobalVariableOptionsDef" }, "vpn": { "description": "Set vpn of server", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "integer", "minimum": 0, "maximum": 65530, "$$ref": "#/components/schemas/CommonCommonDefs_vpnDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "minimum": 0, "maximum": 0, "default": 0, "$$ref": "#/components/schemas/CommonCommonDefs_vpnZeroDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPutRequest_oneOfVpnOptionsDef" }, "sourceInterface": { "description": "Set interface to use to reach syslog server", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "minLength": 1, "$$ref": "#/components/schemas/CommonCommonDefs_nonEmptyStringDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPutRequest_oneOfSourceInterfaceOptionsDef" }, "priority": { "description": "Set logging level for messages logged to server", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "enum": [ "informational", "debugging", "notice", "warn", "error", "critical", "alert", "emergency" ], "default": "informational", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPutRequest_prioritytDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "string", "enum": [ "informational" ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPutRequest_oneOfPriorityOptionsDef" }, "tlsEnable": { "description": "Enable TLS Profile", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPutRequest_oneOfTLSEnableOptionsDef" }, "tlsPropertiesCustomProfile": { "description": "Define custom profile", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPutRequest_oneOfTLSPropCustomProfileOptionsDef" }, "tlsPropertiesProfile": { "description": "Configure a TLS profile", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "minLength": 1, "$$ref": "#/components/schemas/CommonCommonDefs_nonEmptyStringDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionNoDefaultDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPutRequest_oneOfTLSPropProfileOptionsDef" } }, "additionalProperties": false } } }, "required": [ "disk" ], "additionalProperties": false } }, "required": [ "name", "data" ], "x-metadata": { "supportedDeviceTypes": [ "asr", "c1100", "c8000be", "csr1000v", "ir8100", "ir8340", "isr", "ISRv", "ir1101" ], "minVManageVersion": "20.18.1" }, "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPutRequest_SchemaPayload" } }, "$$ref": "#/components/schemas/getSingleSdwanSystemLoggingPayload" }, "examples": { "get response example": { "value": { "parcelId": "09fc54fe-ff36-4640-ae57-c9e71a103902", "parcelType": "logging", "createdBy": "admin", "lastUpdatedBy": "admin", "createdOn": 1701866357838, "lastUpdatedOn": 1701866357838, "payload": { "data": { "disk": { "diskEnable": { "optionType": "global", "value": true }, "file": { "diskFileSize": { "optionType": "global", "value": 9 }, "diskFileRotate": { "optionType": "global", "value": 10 } } }, "tlsProfile": [ { "profile": { "optionType": "global", "value": "test" }, "tlsVersion": { "optionType": "global", "value": "TLSv1.1" }, "authType": { "optionType": "global", "value": "Server" }, "cipherSuiteList": { "optionType": "global", "value": [ "aes-128-cbc-sha" ] } } ], "server": [ { "name": { "optionType": "global", "value": "10.10.10.1" }, "vpn": { "optionType": "global", "value": "0" }, "sourceInterface": { "optionType": "global", "value": "ge0/0/1" }, "priority": { "optionType": "global", "value": "debugging" }, "tlsEnable": { "optionType": "default", "value": true }, "tlsPropertiesCustomProfile": { "optionType": "global", "value": true }, "tlsPropertiesProfile": { "optionType": "global", "value": "test" } } ], "ipv6Server": [ { "name": { "optionType": "global", "value": "2001::1" }, "vpn": { "optionType": "global", "value": "512" }, "sourceInterface": { "optionType": "global", "value": "GigabitEthernet1" }, "priority": { "optionType": "global", "value": "information" }, "tlsEnable": { "optionType": "default", "value": true }, "tlsPropertiesCustomProfile": { "optionType": "global", "value": false } } ] } } }, "$$ref": "#/components/examples/getSingleSdwanSystemLoggingExample" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Feature Profile > System > Logging-read" }, "delete": { "tags": [ "Configuration - Feature Profile (SDWAN)" ], "description": "Delete a Logging Profile Parcel for System feature profile", "operationId": "DeleteLoggingProfileParcelForSystem", "parameters": [ { "name": "systemId", "in": "path", "description": "Feature 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" } }, { "name": "loggingId", "in": "path", "description": "Profile Parcel 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": "Feature Profile > System > Logging-write" }, "put": { "tags": [ "Configuration - Feature Profile (SDWAN)" ], "description": "Update a Logging Profile Parcel for System feature profile", "operationId": "EditLoggingProfileParcelForSystem", "parameters": [ { "name": "systemId", "in": "path", "description": "Feature 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" } }, { "name": "loggingId", "in": "path", "description": "Profile Parcel 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": "Logging Profile Parcel", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[^&<>! \"]+$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_cgFpPpNameDef", "description": "Set the parcel name" }, "description": { "description": "Set the parcel description", "type": "string" }, "data": { "type": "object", "properties": { "disk": { "type": "object", "properties": { "diskEnable": { "description": "Enable logging to local disk", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ true ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanTrueDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPutRequest_oneOfDiskEnableOptionsDef" }, "file": { "type": "object", "properties": { "diskFileSize": { "description": "Set maximum size of file before it is rotated", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "integer", "minimum": 1, "maximum": 20, "default": 10, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPutRequest_diskFileSizeDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "maximum": 10, "minimum": 10, "type": "integer", "default": 10 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPutRequest_oneOfDiskFileSizeOptionsDef" }, "diskFileRotate": { "description": "Set number of syslog files to create before discarding oldest files", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "integer", "minimum": 1, "maximum": 10, "default": 10, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPutRequest_diskFileRotateDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "maximum": 10, "minimum": 10, "type": "integer", "default": 10 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPutRequest_oneOfDiskFileRotateOptionsDef" } }, "required": [ "diskFileSize", "diskFileRotate" ], "additionalProperties": false } }, "required": [ "file" ], "additionalProperties": false }, "tlsProfile": { "description": "Configure a TLS profile", "uniqueItems": true, "type": "array", "additionalProperties": false, "items": { "type": "object", "properties": { "profile": { "description": "Specify the name of the TLS profile", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "minLength": 1, "maxLength": 30, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPutRequest_profileDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPutRequest_oneOfProfileOptionsDef" }, "tlsVersion": { "description": "TLS Version", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "enum": [ "TLSv1.1", "TLSv1.2" ], "default": "TLSv1.1", "x-attributeMetadata": { "insecureConfiguration": { "attributeJsonPath": "$.data.tlsProfile[*].tlsVersion", "values": [ "TLSv1.1" ], "description": "Logging TLS profile configured with TLS version 1.1 - deprecated and vulnerable to attacks", "reason": "Weak tls version", "remediation": "Use stronger tls version to enhance security" } }, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPutRequest_TLSVersionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "string", "enum": [ "TLSv1.1" ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPutRequest_oneOfTLSVersionOptionsDef" }, "authType": { "description": "Authentication Type", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "string", "enum": [ "Server" ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPutRequest_oneOfAuthTypeOptionsDef" }, "cipherSuiteList": { "description": "Syslog secure server ciphersuites", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "array", "items": { "uniqueItems": true, "type": "string", "additionalProperties": false, "enum": [ "aes-128-cbc-sha", "aes-256-cbc-sha", "dhe-aes-cbc-sha2", "dhe-aes-gcm-sha2", "ecdhe-ecdsa-aes-gcm-sha2", "ecdhe-rsa-aes-cbc-sha2", "ecdhe-rsa-aes-gcm-sha2", "rsa-aes-cbc-sha2", "rsa-aes-gcm-sha2" ] }, "x-attributeMetadata": { "insecureConfiguration": { "attributeJsonPath": "$.data.tlsProfile[*].cipherSuiteList[*]", "values": [ "aes-128-cbc-sha", "aes-256-cbc-sha" ], "description": "Logging TLS profile configured with weak cipher suite using CBC mode and SHA-1", "reason": "Weak cipher(s) are present in the command", "remediation": "Use stronger cipher(s) to enhance security" } }, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPutRequest_cipherSuiteListDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPutRequest_oneOfCipherSuiteListOptionsDef" } }, "required": [ "profile", "authType" ], "additionalProperties": false } }, "server": { "description": "Enable logging to remote server", "uniqueItems": true, "type": "array", "additionalProperties": false, "items": { "if": { "anyOf": [ { "properties": { "name": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "name" ] }, { "properties": { "vpn": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "vpn" ] }, { "properties": { "priority": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "priority" ] }, { "properties": { "tlsEnable": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "tlsEnable" ] } ] }, "then": { "required": [ "name", "vpn", "priority", "tlsEnable" ] }, "type": "object", "properties": { "name": { "description": "Set IPv4 address of server", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "pattern": "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}$", "$$ref": "#/components/schemas/CommonCommonDefs_ipv4AddressDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/CommonCommonDefs_oneOfIpV4AddressOptionsDef" }, "vpn": { "description": "Set vpn of server", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "integer", "minimum": 0, "maximum": 65530, "$$ref": "#/components/schemas/CommonCommonDefs_vpnDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "minimum": 0, "maximum": 0, "default": 0, "$$ref": "#/components/schemas/CommonCommonDefs_vpnZeroDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPutRequest_oneOfVpnOptionsDef" }, "sourceInterface": { "description": "Set interface to use to reach syslog server", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "minLength": 1, "$$ref": "#/components/schemas/CommonCommonDefs_nonEmptyStringDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPutRequest_oneOfSourceInterfaceOptionsDef" }, "priority": { "description": "Set logging level for messages logged to server", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "enum": [ "informational", "debugging", "notice", "warn", "error", "critical", "alert", "emergency" ], "default": "informational", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPutRequest_prioritytDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "string", "enum": [ "informational" ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPutRequest_oneOfPriorityOptionsDef" }, "tlsEnable": { "description": "Enable TLS Profile", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPutRequest_oneOfTLSEnableOptionsDef" }, "tlsPropertiesCustomProfile": { "description": "Define custom profile", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPutRequest_oneOfTLSPropCustomProfileOptionsDef" }, "tlsPropertiesProfile": { "description": "Configure a TLS profile", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "minLength": 1, "$$ref": "#/components/schemas/CommonCommonDefs_nonEmptyStringDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionNoDefaultDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPutRequest_oneOfTLSPropProfileOptionsDef" } }, "additionalProperties": false } }, "ipv6Server": { "description": "Enable logging to remote ipv6 server", "uniqueItems": true, "additionalProperties": false, "type": "array", "items": { "if": { "anyOf": [ { "properties": { "name": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "name" ] }, { "properties": { "vpn": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "vpn" ] }, { "properties": { "priority": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "priority" ] }, { "properties": { "tlsEnable": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "tlsEnable" ] } ] }, "then": { "required": [ "name", "vpn", "priority", "tlsEnable" ] }, "type": "object", "properties": { "name": { "description": "Set IPv6 address of server", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "format": "ipv6" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_ipv6AddrGlobalOptionDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/CommonCommonDefs_oneOfIpv6AddrGlobalVariableOptionsDef" }, "vpn": { "description": "Set vpn of server", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "integer", "minimum": 0, "maximum": 65530, "$$ref": "#/components/schemas/CommonCommonDefs_vpnDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "minimum": 0, "maximum": 0, "default": 0, "$$ref": "#/components/schemas/CommonCommonDefs_vpnZeroDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPutRequest_oneOfVpnOptionsDef" }, "sourceInterface": { "description": "Set interface to use to reach syslog server", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "minLength": 1, "$$ref": "#/components/schemas/CommonCommonDefs_nonEmptyStringDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPutRequest_oneOfSourceInterfaceOptionsDef" }, "priority": { "description": "Set logging level for messages logged to server", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "enum": [ "informational", "debugging", "notice", "warn", "error", "critical", "alert", "emergency" ], "default": "informational", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPutRequest_prioritytDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "string", "enum": [ "informational" ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPutRequest_oneOfPriorityOptionsDef" }, "tlsEnable": { "description": "Enable TLS Profile", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPutRequest_oneOfTLSEnableOptionsDef" }, "tlsPropertiesCustomProfile": { "description": "Define custom profile", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPutRequest_oneOfTLSPropCustomProfileOptionsDef" }, "tlsPropertiesProfile": { "description": "Configure a TLS profile", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "minLength": 1, "$$ref": "#/components/schemas/CommonCommonDefs_nonEmptyStringDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionNoDefaultDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPutRequest_oneOfTLSPropProfileOptionsDef" } }, "additionalProperties": false } } }, "required": [ "disk" ], "additionalProperties": false } }, "required": [ "name", "data" ], "x-metadata": { "supportedDeviceTypes": [ "asr", "c1100", "c8000be", "csr1000v", "ir8100", "ir8340", "isr", "ISRv", "ir1101" ], "minVManageVersion": "20.18.1" }, "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemLoggingPutRequest_SchemaPayload" }, "examples": { "Cedge_CG1_System_Logging_parcel1": { "value": { "data": { "disk": { "diskEnable": { "optionType": "global", "value": true }, "file": { "diskFileSize": { "optionType": "global", "value": 9 }, "diskFileRotate": { "optionType": "global", "value": 10 } } }, "tlsProfile": [ { "profile": { "optionType": "global", "value": "test" }, "tlsVersion": { "optionType": "global", "value": "TLSv1.1" }, "authType": { "optionType": "global", "value": "Server" }, "cipherSuiteList": { "optionType": "global", "value": [ "aes-128-cbc-sha" ] } } ], "server": [ { "name": { "optionType": "global", "value": "10.10.10.1" }, "vpn": { "optionType": "global", "value": "0" }, "sourceInterface": { "optionType": "global", "value": "ge0/0/1" }, "priority": { "optionType": "global", "value": "debugging" }, "tlsEnable": { "optionType": "default", "value": true }, "tlsPropertiesCustomProfile": { "optionType": "global", "value": true }, "tlsPropertiesProfile": { "optionType": "global", "value": "test" } } ], "ipv6Server": [ { "name": { "optionType": "global", "value": "2001::1" }, "vpn": { "optionType": "global", "value": "512" }, "sourceInterface": { "optionType": "global", "value": "GigabitEthernet1" }, "priority": { "optionType": "global", "value": "information" }, "tlsEnable": { "optionType": "default", "value": true }, "tlsPropertiesCustomProfile": { "optionType": "global", "value": false } } ] }, "description": "Cedge System Logging Parcel config", "name": "Cedge_CG1_System_Logging_parcel1" }, "$$ref": "#/components/examples/ProfileparcelSdwanSystemLoggingPutRequest_Cedge_CG1_System_Logging_parcel1" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "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}" } }, "required": [ "id" ], "x-metadata": { "minVManageVersion": "20.15.1" }, "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelCommonPutResponse_SchemaPayload" }, "examples": { "example_1": { "value": { "id": "24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A" }, "$$ref": "#/components/examples/ProfileparcelCommonPutResponse_example_1" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Feature Profile > System > Logging-write" } }, "/v1/feature-profile/sdwan/system/{systemId}/mrf": { "get": { "tags": [ "Configuration - Feature Profile (SDWAN)" ], "description": "Get Mrf Profile Parcels for System feature profile", "operationId": "GetMrfProfileParcelForSystem", "parameters": [ { "name": "systemId", "in": "path", "description": "Feature 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", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "parcelId": { "type": "string", "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}", "$$ref": "#/components/schemas/CommonCommonDefs_uuidDef" }, "parcelType": { "type": "string" }, "createdBy": { "type": "string", "description": "User who last created this.", "readOnly": true }, "createdOn": { "type": "integer", "description": "Timestamp of creation", "format": "int64", "readOnly": true }, "lastUpdatedBy": { "type": "string", "description": "User who last updated this.", "readOnly": true }, "lastUpdatedOn": { "type": "integer", "description": "Timestamp of last update", "format": "int64", "readOnly": true }, "payload": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[^&<>! \"]+$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_cgFpPpNameDef" }, "description": { "type": "string" }, "data": { "type": "object", "properties": { "secondaryRegion": { "description": "Set secondary region ID", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minimum": 1, "maximum": 63, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemMrfCommonRequest_secondaryRegionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionNoDefaultDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemMrfCommonRequest_oneOfSecondaryRegionOptionsDef" }, "role": { "description": "Set the role for router", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "enum": [ "edge-router", "border-router" ], "type": "string", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemMrfCommonRequest_roleDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionNoDefaultDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemMrfCommonRequest_oneOfRoleOptionsDef" }, "enableMrfMigration": { "description": "Enable migration mode to Multi-Region Fabric", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "enum": [ "enabled", "enabled-from-bgp-core" ], "type": "string", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemMrfCommonRequest_enableMrfMigrationDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionNoDefaultDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemMrfCommonRequest_oneOfEnableMrfMigrationOptionsDef" }, "migrationBgpCommunity": { "description": "Set BGP community during migration from BGP-core based network", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minimum": 1, "maximum": 4294967295, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemMrfCommonRequest_migrationBgpCommunityDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionNoDefaultDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemMrfCommonRequest_oneOfMigrationBgpCommunityOptionsDef" }, "enableManagementRegion": { "description": "Enable management region", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemMrfCommonRequest_oneOfEnableManagemantRegionOptionsDef" }, "managementRegion": { "description": "Management Region", "type": "object", "properties": { "vrfId": { "description": "VRF name for management region", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minimum": 1, "maximum": 65531, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemMrfCommonRequest_vrfIdDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemMrfCommonRequest_oneOfVrfIdOptionsDef" }, "gatewayPreference": { "description": "List of affinity group preferences for VRF", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "items": { "minimum": 1, "maximum": 63, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemMrfCommonRequest_gatewayPreferenceDef" }, "minItems": 1, "maxItems": 8, "uniqueItems": true, "type": "array", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemMrfCommonRequest_gatewayPreferenceListDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemMrfCommonRequest_oneOfGatewayPreferenceOptionsDef" }, "managementGateway": { "description": "Enable management gateway", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemMrfCommonRequest_oneOfManagementGatewayOptionsDef" } }, "required": [], "additionalProperties": false } }, "required": [], "additionalProperties": false } }, "required": [ "name", "data" ], "x-metadata": { "minVManageVersion": "20.15.1" }, "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemMrfCommonRequest_SchemaPayload" } } } } }, "$$ref": "#/components/schemas/getListSdwanSystemMrfPayload" }, "examples": { "get response example": { "value": { "header": { "generatedOn": 1702438718825 }, "data": [ { "parcelId": "09fc54fe-ff36-4640-ae57-c9e71a103902", "parcelType": "mrf", "createdBy": "admin", "lastUpdatedBy": "admin", "createdOn": 1701866357838, "lastUpdatedOn": 1701866357838, "payload": { "data": { "secondaryRegion": { "optionType": "global", "value": 2 }, "role": { "optionType": "global", "value": "edge-router" }, "enableMrfMigration": { "optionType": "global", "value": "enabled" }, "migrationBgpCommunity": { "optionType": "global", "value": 100 } } } } ] }, "$$ref": "#/components/examples/getListSdwanSystemMrfExample" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Feature Profile > System > Mrf-read" }, "post": { "tags": [ "Configuration - Feature Profile (SDWAN)" ], "description": "Create a Mrf Profile Parcel for System feature profile", "operationId": "CreateMrfProfileParcelForSystem", "parameters": [ { "name": "systemId", "in": "path", "description": "Feature 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": "Mrf Profile Parcel", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[^&<>! \"]+$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_cgFpPpNameDef" }, "description": { "type": "string" }, "data": { "type": "object", "properties": { "secondaryRegion": { "description": "Set secondary region ID", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minimum": 1, "maximum": 63, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemMrfCommonRequest_secondaryRegionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionNoDefaultDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemMrfCommonRequest_oneOfSecondaryRegionOptionsDef" }, "role": { "description": "Set the role for router", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "enum": [ "edge-router", "border-router" ], "type": "string", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemMrfCommonRequest_roleDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionNoDefaultDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemMrfCommonRequest_oneOfRoleOptionsDef" }, "enableMrfMigration": { "description": "Enable migration mode to Multi-Region Fabric", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "enum": [ "enabled", "enabled-from-bgp-core" ], "type": "string", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemMrfCommonRequest_enableMrfMigrationDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionNoDefaultDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemMrfCommonRequest_oneOfEnableMrfMigrationOptionsDef" }, "migrationBgpCommunity": { "description": "Set BGP community during migration from BGP-core based network", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minimum": 1, "maximum": 4294967295, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemMrfCommonRequest_migrationBgpCommunityDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionNoDefaultDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemMrfCommonRequest_oneOfMigrationBgpCommunityOptionsDef" }, "enableManagementRegion": { "description": "Enable management region", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemMrfCommonRequest_oneOfEnableManagemantRegionOptionsDef" }, "managementRegion": { "description": "Management Region", "type": "object", "properties": { "vrfId": { "description": "VRF name for management region", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minimum": 1, "maximum": 65531, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemMrfCommonRequest_vrfIdDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemMrfCommonRequest_oneOfVrfIdOptionsDef" }, "gatewayPreference": { "description": "List of affinity group preferences for VRF", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "items": { "minimum": 1, "maximum": 63, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemMrfCommonRequest_gatewayPreferenceDef" }, "minItems": 1, "maxItems": 8, "uniqueItems": true, "type": "array", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemMrfCommonRequest_gatewayPreferenceListDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemMrfCommonRequest_oneOfGatewayPreferenceOptionsDef" }, "managementGateway": { "description": "Enable management gateway", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemMrfCommonRequest_oneOfManagementGatewayOptionsDef" } }, "required": [], "additionalProperties": false } }, "required": [], "additionalProperties": false } }, "required": [ "name", "data" ], "x-metadata": { "minVManageVersion": "20.15.1" }, "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemMrfCommonRequest_SchemaPayload" }, "examples": { "SystemMrfParcelGlobalDefault": { "value": { "data": { "secondaryRegion": { "optionType": "global", "value": 2 }, "role": { "optionType": "global", "value": "edge-router" }, "enableMrfMigration": { "optionType": "global", "value": "enabled" }, "migrationBgpCommunity": { "optionType": "global", "value": 100 } }, "name": "SystemMrfParcelGlobalDefault" }, "$$ref": "#/components/examples/ProfileparcelSdwanSystemMrfCommonRequest_SystemMrfParcelGlobalDefault" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "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}" } }, "required": [ "id" ], "x-metadata": { "minVManageVersion": "20.15.1" }, "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelCommonPostResponse_SchemaPayload" }, "examples": { "example_1": { "value": { "id": "24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A" }, "$$ref": "#/components/examples/ProfileparcelCommonPostResponse_example_1" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Feature Profile > System > Mrf-write" } }, "/v1/feature-profile/sdwan/system/{systemId}/mrf/{mrfId}": { "get": { "tags": [ "Configuration - Feature Profile (SDWAN)" ], "description": "Get Mrf Profile Parcel by parcelId for System feature profile", "operationId": "GetMrfProfileParcelByParcelIdForSystem", "parameters": [ { "name": "systemId", "in": "path", "description": "Feature 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" } }, { "name": "mrfId", "in": "path", "description": "Profile Parcel 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", "properties": { "parcelId": { "type": "string", "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}", "$$ref": "#/components/schemas/CommonCommonDefs_uuidDef" }, "parcelType": { "type": "string" }, "createdBy": { "type": "string", "description": "User who last created this.", "readOnly": true }, "createdOn": { "type": "integer", "description": "Timestamp of creation", "format": "int64", "readOnly": true }, "lastUpdatedBy": { "type": "string", "description": "User who last updated this.", "readOnly": true }, "lastUpdatedOn": { "type": "integer", "description": "Timestamp of last update", "format": "int64", "readOnly": true }, "payload": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[^&<>! \"]+$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_cgFpPpNameDef" }, "description": { "type": "string" }, "data": { "type": "object", "properties": { "secondaryRegion": { "description": "Set secondary region ID", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minimum": 1, "maximum": 63, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemMrfCommonRequest_secondaryRegionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionNoDefaultDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemMrfCommonRequest_oneOfSecondaryRegionOptionsDef" }, "role": { "description": "Set the role for router", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "enum": [ "edge-router", "border-router" ], "type": "string", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemMrfCommonRequest_roleDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionNoDefaultDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemMrfCommonRequest_oneOfRoleOptionsDef" }, "enableMrfMigration": { "description": "Enable migration mode to Multi-Region Fabric", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "enum": [ "enabled", "enabled-from-bgp-core" ], "type": "string", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemMrfCommonRequest_enableMrfMigrationDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionNoDefaultDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemMrfCommonRequest_oneOfEnableMrfMigrationOptionsDef" }, "migrationBgpCommunity": { "description": "Set BGP community during migration from BGP-core based network", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minimum": 1, "maximum": 4294967295, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemMrfCommonRequest_migrationBgpCommunityDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionNoDefaultDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemMrfCommonRequest_oneOfMigrationBgpCommunityOptionsDef" }, "enableManagementRegion": { "description": "Enable management region", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemMrfCommonRequest_oneOfEnableManagemantRegionOptionsDef" }, "managementRegion": { "description": "Management Region", "type": "object", "properties": { "vrfId": { "description": "VRF name for management region", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minimum": 1, "maximum": 65531, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemMrfCommonRequest_vrfIdDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemMrfCommonRequest_oneOfVrfIdOptionsDef" }, "gatewayPreference": { "description": "List of affinity group preferences for VRF", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "items": { "minimum": 1, "maximum": 63, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemMrfCommonRequest_gatewayPreferenceDef" }, "minItems": 1, "maxItems": 8, "uniqueItems": true, "type": "array", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemMrfCommonRequest_gatewayPreferenceListDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemMrfCommonRequest_oneOfGatewayPreferenceOptionsDef" }, "managementGateway": { "description": "Enable management gateway", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemMrfCommonRequest_oneOfManagementGatewayOptionsDef" } }, "required": [], "additionalProperties": false } }, "required": [], "additionalProperties": false } }, "required": [ "name", "data" ], "x-metadata": { "minVManageVersion": "20.15.1" }, "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemMrfCommonRequest_SchemaPayload" } }, "$$ref": "#/components/schemas/getSingleSdwanSystemMrfPayload" }, "examples": { "get response example": { "value": { "parcelId": "09fc54fe-ff36-4640-ae57-c9e71a103902", "parcelType": "mrf", "createdBy": "admin", "lastUpdatedBy": "admin", "createdOn": 1701866357838, "lastUpdatedOn": 1701866357838, "payload": { "data": { "secondaryRegion": { "optionType": "global", "value": 2 }, "role": { "optionType": "global", "value": "edge-router" }, "enableMrfMigration": { "optionType": "global", "value": "enabled" }, "migrationBgpCommunity": { "optionType": "global", "value": 100 } } } }, "$$ref": "#/components/examples/getSingleSdwanSystemMrfExample" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Feature Profile > System > Mrf-read" }, "delete": { "tags": [ "Configuration - Feature Profile (SDWAN)" ], "description": "Delete a Mrf Profile Parcel for System feature profile", "operationId": "DeleteMrfProfileParcelForSystem", "parameters": [ { "name": "systemId", "in": "path", "description": "Feature 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" } }, { "name": "mrfId", "in": "path", "description": "Profile Parcel 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": "Feature Profile > System > Mrf-write" }, "put": { "tags": [ "Configuration - Feature Profile (SDWAN)" ], "description": "Update a Mrf Profile Parcel for System feature profile", "operationId": "EditMrfProfileParcelForSystem", "parameters": [ { "name": "systemId", "in": "path", "description": "Feature 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" } }, { "name": "mrfId", "in": "path", "description": "Profile Parcel 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": "Mrf Profile Parcel", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[^&<>! \"]+$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_cgFpPpNameDef" }, "description": { "type": "string" }, "data": { "type": "object", "properties": { "secondaryRegion": { "description": "Set secondary region ID", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minimum": 1, "maximum": 63, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemMrfCommonRequest_secondaryRegionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionNoDefaultDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemMrfCommonRequest_oneOfSecondaryRegionOptionsDef" }, "role": { "description": "Set the role for router", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "enum": [ "edge-router", "border-router" ], "type": "string", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemMrfCommonRequest_roleDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionNoDefaultDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemMrfCommonRequest_oneOfRoleOptionsDef" }, "enableMrfMigration": { "description": "Enable migration mode to Multi-Region Fabric", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "enum": [ "enabled", "enabled-from-bgp-core" ], "type": "string", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemMrfCommonRequest_enableMrfMigrationDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionNoDefaultDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemMrfCommonRequest_oneOfEnableMrfMigrationOptionsDef" }, "migrationBgpCommunity": { "description": "Set BGP community during migration from BGP-core based network", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minimum": 1, "maximum": 4294967295, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemMrfCommonRequest_migrationBgpCommunityDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionNoDefaultDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemMrfCommonRequest_oneOfMigrationBgpCommunityOptionsDef" }, "enableManagementRegion": { "description": "Enable management region", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemMrfCommonRequest_oneOfEnableManagemantRegionOptionsDef" }, "managementRegion": { "description": "Management Region", "type": "object", "properties": { "vrfId": { "description": "VRF name for management region", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minimum": 1, "maximum": 65531, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemMrfCommonRequest_vrfIdDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemMrfCommonRequest_oneOfVrfIdOptionsDef" }, "gatewayPreference": { "description": "List of affinity group preferences for VRF", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "items": { "minimum": 1, "maximum": 63, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemMrfCommonRequest_gatewayPreferenceDef" }, "minItems": 1, "maxItems": 8, "uniqueItems": true, "type": "array", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemMrfCommonRequest_gatewayPreferenceListDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemMrfCommonRequest_oneOfGatewayPreferenceOptionsDef" }, "managementGateway": { "description": "Enable management gateway", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemMrfCommonRequest_oneOfManagementGatewayOptionsDef" } }, "required": [], "additionalProperties": false } }, "required": [], "additionalProperties": false } }, "required": [ "name", "data" ], "x-metadata": { "minVManageVersion": "20.15.1" }, "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemMrfCommonRequest_SchemaPayload" }, "examples": { "SystemMrfParcelGlobalDefault": { "value": { "data": { "secondaryRegion": { "optionType": "global", "value": 2 }, "role": { "optionType": "global", "value": "edge-router" }, "enableMrfMigration": { "optionType": "global", "value": "enabled" }, "migrationBgpCommunity": { "optionType": "global", "value": 100 } }, "name": "SystemMrfParcelGlobalDefault" }, "$$ref": "#/components/examples/ProfileparcelSdwanSystemMrfCommonRequest_SystemMrfParcelGlobalDefault" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "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}" } }, "required": [ "id" ], "x-metadata": { "minVManageVersion": "20.15.1" }, "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelCommonPutResponse_SchemaPayload" }, "examples": { "example_1": { "value": { "id": "24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A" }, "$$ref": "#/components/examples/ProfileparcelCommonPutResponse_example_1" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Feature Profile > System > Mrf-write" } }, "/v1/feature-profile/sdwan/system/{systemId}/ntp": { "get": { "tags": [ "Configuration - Feature Profile (SDWAN)" ], "description": "Get Ntp Profile Parcels for System feature profile", "operationId": "GetNtpProfileParcelForSystem", "parameters": [ { "name": "systemId", "in": "path", "description": "Feature 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", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "parcelId": { "type": "string", "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}", "$$ref": "#/components/schemas/CommonCommonDefs_uuidDef" }, "parcelType": { "type": "string" }, "createdBy": { "type": "string", "description": "User who last created this.", "readOnly": true }, "createdOn": { "type": "integer", "description": "Timestamp of creation", "format": "int64", "readOnly": true }, "lastUpdatedBy": { "type": "string", "description": "User who last updated this.", "readOnly": true }, "lastUpdatedOn": { "type": "integer", "description": "Timestamp of last update", "format": "int64", "readOnly": true }, "payload": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[^&<>! \"]+$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_cgFpPpNameDef", "description": "Set the parcel name" }, "description": { "description": "Set the parcel description", "type": "string" }, "data": { "type": "object", "properties": { "server": { "description": "Configure NTP servers", "type": "array", "uniqueItems": true, "additionalProperties": false, "items": { "if": { "anyOf": [ { "properties": { "name": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "name" ] }, { "properties": { "vpn": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "vpn" ] }, { "properties": { "version": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "version" ] }, { "properties": { "prefer": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "prefer" ] } ] }, "then": { "required": [ "name", "vpn", "version", "prefer" ] }, "type": "object", "properties": { "name": { "description": "Set hostname or IP address of server", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "oneOf": [ { "type": "string", "format": "ipv6", "$$ref": "#/components/schemas/CommonCommonDefs_ipv6AddressDef" }, { "type": "string", "format": "hostname", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemNtpPostRequest_hostNameDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemNtpPostRequest_serverNameOptionsDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemNtpPostRequest_oneOfServerNameOptionsDef" }, "key": { "description": "Set authentication key for the server", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "integer", "minimum": 1, "maximum": 4294967295, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemNtpPostRequest_keyDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemNtpPostRequest_oneOfServerKeyOptionsDef" }, "vpn": { "description": "Set VPN in which NTP server is located", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "integer", "default": 0, "minimum": 0, "maximum": 65530, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemNtpPostRequest_vpnDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "minimum": 0, "maximum": 0 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemNtpPostRequest_oneOfVpnOptionsDef" }, "version": { "description": "Set NTP version", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "integer", "default": 4, "minimum": 1, "maximum": 4, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemNtpPostRequest_versionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "minimum": 4, "maximum": 4 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemNtpPostRequest_oneOfVersionOptionsDef" }, "sourceInterface": { "description": "Set interface to use to reach NTP server", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "pattern": "(ATM|ATM-ACR|AppGigabitEthernet|AppNav-Compress|AppNav-UnCompress|Async|BD-VIF|BDI|CEM|CEM-ACR|Cellular|Dialer|Embedded-Service-Engine|Ethernet|Ethernet-Internal|FastEthernet|FiftyGigabitEthernet|FiveGigabitEthernet|FortyGigabitEthernet|FourHundredGigE|GMPLS|GigabitEthernet|Group-Async|HundredGigE|L2LISP|LISP|Loopback|MFR|Multilink|Port-channel|SM|Serial|Service-Engine|TenGigabitEthernet|Tunnel|TwentyFiveGigE|TwentyFiveGigabitEthernet|TwoGigabitEthernet|TwoHundredGigE|Vif|Virtual-PPP|Virtual-Template|VirtualPortGroup|Vlan|Wlan-GigabitEthernet|nat64|nat66|ntp|nve|ospfv3|overlay|pseudowire|ucse|vasileft|vasiright|vmi)([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]+)", "minLength": 3, "maxLength": 32, "$$ref": "#/components/schemas/CommonCommonDefs_ifNameDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemNtpPostRequest_oneOfSourceInterfaceOptionsDef" }, "prefer": { "description": "Prefer this NTP server", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemNtpPostRequest_oneOfPreferOptionsDef" } }, "additionalProperties": false } }, "authentication": { "type": "object", "properties": { "authenticationKeys": { "description": "Set MD5 authentication key", "type": "array", "uniqueItems": true, "additionalProperties": false, "items": { "type": "object", "properties": { "keyId": { "description": "Authentication key ID", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "integer", "minimum": 1, "maximum": 4294967295, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemNtpPostRequest_keyDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemNtpPostRequest_oneOfAuthKeyIdOptionsDef" }, "md5Value": { "description": "Enter cleartext or AES-encrypted MD5 authentication key [Note: Catalyst SD-WAN Manager will encrypt this field before saving. Cleartext strings will not be returned back to the user in GET responses for sensitive fields.]", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "minLength": 1, "x-attributeMetadata": { "insecureConfiguration": { "attributeJsonPath": "$.data.authentication.authenticationKeys[*].md5Value", "description": "NTP authentication using MD5 - vulnerable to collision attacks and should use stronger algorithms", "reason": "Configuration employs an Insecure method for password storage", "remediation": "Transition to more secure algorithms like SHA and AES" } }, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemNtpPostRequest_md5KeyDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemNtpPostRequest_oneOfAuthKeyMd5ValueOptionsDef" }, "hmacSha2Value": { "description": "HMAC-SHA2-256 (digest length = 256 bits, key length = [1-32] bytes)", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "description": "HMAC-SHA2-256 (digest length = 256 bits, key length = [1-32] bytes)", "pattern": "^\\S{1,32}$", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemNtpPostRequest_hmacSha2KeyDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemNtpPostRequest_oneOfAuthKeyHmacSha2ValueOptionsDef" }, "cmacAes128Value": { "description": "CMAC-AES-128 (digest length = 128 bits, key length = [16 or 32] bytes)", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "description": "CMAC-AES-128 (digest length = 128 bits, key length = [16 or 32] bytes)", "minLength": 16, "maxLength": 32, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemNtpPostRequest_cmacAes128KeyDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemNtpPostRequest_oneOfAuthKeyCmacAes128ValueOptionsDef" } }, "additionalProperties": false, "required": [ "keyId" ], "oneOf": [ { "required": [ "md5Value" ], "not": { "anyOf": [ { "required": [ "hmacSha2Value" ] }, { "required": [ "cmacAes128Value" ] } ] } }, { "required": [ "hmacSha2Value" ], "not": { "anyOf": [ { "required": [ "md5Value" ] }, { "required": [ "cmacAes128Value" ] } ] } }, { "required": [ "cmacAes128Value" ], "not": { "anyOf": [ { "required": [ "md5Value" ] }, { "required": [ "hmacSha2Value" ] } ] } } ] } }, "trustedKeys": { "description": "Designate authentication key as trustworthy", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "array", "uniqueItems": true, "additionalProperties": false, "items": { "type": "integer", "minimum": 1, "maximum": 65535 }, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemNtpPostRequest_keyArrayDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemNtpPostRequest_oneOfTrustedKeyIdOptionsDef" } }, "required": [ "authenticationKeys" ], "additionalProperties": false }, "leader": { "type": "object", "properties": { "enable": { "description": "Enable device as NTP Leader", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemNtpPostRequest_oneOfLeaderEnableOptionsDef" }, "stratum": { "description": "Enable device as NTP Leader", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "integer", "maximum": 15, "minimum": 1, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemNtpPostRequest_leaderStratumDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemNtpPostRequest_oneOfLeaderStratumOptionsDef" }, "source": { "description": "Enable device as NTP Leader", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "pattern": "(ATM|ATM-ACR|AppGigabitEthernet|AppNav-Compress|AppNav-UnCompress|Async|BD-VIF|BDI|CEM|CEM-ACR|Cellular|Dialer|Embedded-Service-Engine|Ethernet|Ethernet-Internal|FastEthernet|FiftyGigabitEthernet|FiveGigabitEthernet|FortyGigabitEthernet|FourHundredGigE|GMPLS|GigabitEthernet|Group-Async|HundredGigE|L2LISP|LISP|Loopback|MFR|Multilink|Port-channel|SM|Serial|Service-Engine|TenGigabitEthernet|Tunnel|TwentyFiveGigE|TwentyFiveGigabitEthernet|TwoGigabitEthernet|TwoHundredGigE|Vif|Virtual-PPP|Virtual-Template|VirtualPortGroup|Vlan|Wlan-GigabitEthernet|nat64|nat66|ntp|nve|ospfv3|overlay|pseudowire|ucse|vasileft|vasiright|vmi)([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]+)", "minLength": 3, "maxLength": 32, "$$ref": "#/components/schemas/CommonCommonDefs_ifNameDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemNtpPostRequest_oneOfLeaderSourceOptionsDef" } } } }, "required": [ "server" ], "additionalProperties": false } }, "required": [ "name", "data" ], "x-metadata": { "supportedDeviceTypes": [ "asr", "c1100", "c8000be", "csr1000v", "ir8100", "ir8340", "isr", "ISRv", "ir1101" ], "minVManageVersion": "26.1.1" }, "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemNtpPostRequest_SchemaPayload" } } } } }, "$$ref": "#/components/schemas/getListSdwanSystemNtpPayload" }, "examples": { "get response example": { "value": { "header": { "generatedOn": 1702438718825 }, "data": [ { "parcelId": "09fc54fe-ff36-4640-ae57-c9e71a103902", "parcelType": "ntp", "createdBy": "admin", "lastUpdatedBy": "admin", "createdOn": 1701866357838, "lastUpdatedOn": 1701866357838, "payload": { "data": { "server": [ { "name": { "optionType": "global", "value": "time.google.com" }, "key": { "optionType": "global", "value": 1 }, "vpn": { "optionType": "default", "value": 0 }, "version": { "optionType": "default", "value": 4 }, "sourceInterface": { "optionType": "default" }, "prefer": { "optionType": "default", "value": false } }, { "name": { "optionType": "global", "value": "1.1.1.1" }, "key": { "optionType": "global", "value": 2 }, "vpn": { "optionType": "default", "value": 0 }, "version": { "optionType": "default", "value": 4 }, "sourceInterface": { "optionType": "default" }, "prefer": { "optionType": "global", "value": true } } ], "authentication": { "authenticationKeys": [ { "keyId": { "optionType": "global", "value": 1 }, "hmacSha2Value": { "optionType": "global", "value": "adsd123123" } }, { "keyId": { "optionType": "global", "value": 2 }, "cmacAes128Value": { "optionType": "global", "value": "0123456789abcdef" } } ], "trustedKeys": { "optionType": "global", "value": [ 1, 2 ] } } } } } ] }, "$$ref": "#/components/examples/getListSdwanSystemNtpExample" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Feature Profile > System > Ntp-read" }, "post": { "tags": [ "Configuration - Feature Profile (SDWAN)" ], "description": "Create a Ntp Profile Parcel for System feature profile", "operationId": "CreateNtpProfileParcelForSystem", "parameters": [ { "name": "systemId", "in": "path", "description": "Feature 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": "Ntp Profile Parcel", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[^&<>! \"]+$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_cgFpPpNameDef", "description": "Set the parcel name" }, "description": { "description": "Set the parcel description", "type": "string" }, "data": { "type": "object", "properties": { "server": { "description": "Configure NTP servers", "type": "array", "uniqueItems": true, "additionalProperties": false, "items": { "if": { "anyOf": [ { "properties": { "name": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "name" ] }, { "properties": { "vpn": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "vpn" ] }, { "properties": { "version": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "version" ] }, { "properties": { "prefer": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "prefer" ] } ] }, "then": { "required": [ "name", "vpn", "version", "prefer" ] }, "type": "object", "properties": { "name": { "description": "Set hostname or IP address of server", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "oneOf": [ { "type": "string", "format": "ipv6", "$$ref": "#/components/schemas/CommonCommonDefs_ipv6AddressDef" }, { "type": "string", "format": "hostname", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemNtpPostRequest_hostNameDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemNtpPostRequest_serverNameOptionsDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemNtpPostRequest_oneOfServerNameOptionsDef" }, "key": { "description": "Set authentication key for the server", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "integer", "minimum": 1, "maximum": 4294967295, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemNtpPostRequest_keyDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemNtpPostRequest_oneOfServerKeyOptionsDef" }, "vpn": { "description": "Set VPN in which NTP server is located", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "integer", "default": 0, "minimum": 0, "maximum": 65530, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemNtpPostRequest_vpnDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "minimum": 0, "maximum": 0 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemNtpPostRequest_oneOfVpnOptionsDef" }, "version": { "description": "Set NTP version", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "integer", "default": 4, "minimum": 1, "maximum": 4, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemNtpPostRequest_versionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "minimum": 4, "maximum": 4 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemNtpPostRequest_oneOfVersionOptionsDef" }, "sourceInterface": { "description": "Set interface to use to reach NTP server", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "pattern": "(ATM|ATM-ACR|AppGigabitEthernet|AppNav-Compress|AppNav-UnCompress|Async|BD-VIF|BDI|CEM|CEM-ACR|Cellular|Dialer|Embedded-Service-Engine|Ethernet|Ethernet-Internal|FastEthernet|FiftyGigabitEthernet|FiveGigabitEthernet|FortyGigabitEthernet|FourHundredGigE|GMPLS|GigabitEthernet|Group-Async|HundredGigE|L2LISP|LISP|Loopback|MFR|Multilink|Port-channel|SM|Serial|Service-Engine|TenGigabitEthernet|Tunnel|TwentyFiveGigE|TwentyFiveGigabitEthernet|TwoGigabitEthernet|TwoHundredGigE|Vif|Virtual-PPP|Virtual-Template|VirtualPortGroup|Vlan|Wlan-GigabitEthernet|nat64|nat66|ntp|nve|ospfv3|overlay|pseudowire|ucse|vasileft|vasiright|vmi)([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]+)", "minLength": 3, "maxLength": 32, "$$ref": "#/components/schemas/CommonCommonDefs_ifNameDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemNtpPostRequest_oneOfSourceInterfaceOptionsDef" }, "prefer": { "description": "Prefer this NTP server", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemNtpPostRequest_oneOfPreferOptionsDef" } }, "additionalProperties": false } }, "authentication": { "type": "object", "properties": { "authenticationKeys": { "description": "Set MD5 authentication key", "type": "array", "uniqueItems": true, "additionalProperties": false, "items": { "type": "object", "properties": { "keyId": { "description": "Authentication key ID", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "integer", "minimum": 1, "maximum": 4294967295, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemNtpPostRequest_keyDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemNtpPostRequest_oneOfAuthKeyIdOptionsDef" }, "md5Value": { "description": "Enter cleartext or AES-encrypted MD5 authentication key [Note: Catalyst SD-WAN Manager will encrypt this field before saving. Cleartext strings will not be returned back to the user in GET responses for sensitive fields.]", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "minLength": 1, "x-attributeMetadata": { "insecureConfiguration": { "attributeJsonPath": "$.data.authentication.authenticationKeys[*].md5Value", "description": "NTP authentication using MD5 - vulnerable to collision attacks and should use stronger algorithms", "reason": "Configuration employs an Insecure method for password storage", "remediation": "Transition to more secure algorithms like SHA and AES" } }, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemNtpPostRequest_md5KeyDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemNtpPostRequest_oneOfAuthKeyMd5ValueOptionsDef" }, "hmacSha2Value": { "description": "HMAC-SHA2-256 (digest length = 256 bits, key length = [1-32] bytes)", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "description": "HMAC-SHA2-256 (digest length = 256 bits, key length = [1-32] bytes)", "pattern": "^\\S{1,32}$", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemNtpPostRequest_hmacSha2KeyDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemNtpPostRequest_oneOfAuthKeyHmacSha2ValueOptionsDef" }, "cmacAes128Value": { "description": "CMAC-AES-128 (digest length = 128 bits, key length = [16 or 32] bytes)", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "description": "CMAC-AES-128 (digest length = 128 bits, key length = [16 or 32] bytes)", "minLength": 16, "maxLength": 32, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemNtpPostRequest_cmacAes128KeyDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemNtpPostRequest_oneOfAuthKeyCmacAes128ValueOptionsDef" } }, "additionalProperties": false, "required": [ "keyId" ], "oneOf": [ { "required": [ "md5Value" ], "not": { "anyOf": [ { "required": [ "hmacSha2Value" ] }, { "required": [ "cmacAes128Value" ] } ] } }, { "required": [ "hmacSha2Value" ], "not": { "anyOf": [ { "required": [ "md5Value" ] }, { "required": [ "cmacAes128Value" ] } ] } }, { "required": [ "cmacAes128Value" ], "not": { "anyOf": [ { "required": [ "md5Value" ] }, { "required": [ "hmacSha2Value" ] } ] } } ] } }, "trustedKeys": { "description": "Designate authentication key as trustworthy", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "array", "uniqueItems": true, "additionalProperties": false, "items": { "type": "integer", "minimum": 1, "maximum": 65535 }, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemNtpPostRequest_keyArrayDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemNtpPostRequest_oneOfTrustedKeyIdOptionsDef" } }, "required": [ "authenticationKeys" ], "additionalProperties": false }, "leader": { "type": "object", "properties": { "enable": { "description": "Enable device as NTP Leader", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemNtpPostRequest_oneOfLeaderEnableOptionsDef" }, "stratum": { "description": "Enable device as NTP Leader", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "integer", "maximum": 15, "minimum": 1, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemNtpPostRequest_leaderStratumDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemNtpPostRequest_oneOfLeaderStratumOptionsDef" }, "source": { "description": "Enable device as NTP Leader", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "pattern": "(ATM|ATM-ACR|AppGigabitEthernet|AppNav-Compress|AppNav-UnCompress|Async|BD-VIF|BDI|CEM|CEM-ACR|Cellular|Dialer|Embedded-Service-Engine|Ethernet|Ethernet-Internal|FastEthernet|FiftyGigabitEthernet|FiveGigabitEthernet|FortyGigabitEthernet|FourHundredGigE|GMPLS|GigabitEthernet|Group-Async|HundredGigE|L2LISP|LISP|Loopback|MFR|Multilink|Port-channel|SM|Serial|Service-Engine|TenGigabitEthernet|Tunnel|TwentyFiveGigE|TwentyFiveGigabitEthernet|TwoGigabitEthernet|TwoHundredGigE|Vif|Virtual-PPP|Virtual-Template|VirtualPortGroup|Vlan|Wlan-GigabitEthernet|nat64|nat66|ntp|nve|ospfv3|overlay|pseudowire|ucse|vasileft|vasiright|vmi)([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]+)", "minLength": 3, "maxLength": 32, "$$ref": "#/components/schemas/CommonCommonDefs_ifNameDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemNtpPostRequest_oneOfLeaderSourceOptionsDef" } } } }, "required": [ "server" ], "additionalProperties": false } }, "required": [ "name", "data" ], "x-metadata": { "supportedDeviceTypes": [ "asr", "c1100", "c8000be", "csr1000v", "ir8100", "ir8340", "isr", "ISRv", "ir1101" ], "minVManageVersion": "26.1.1" }, "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemNtpPostRequest_SchemaPayload" }, "examples": { "example_1": { "value": { "data": { "server": [ { "name": { "optionType": "global", "value": "time.google.com" }, "key": { "optionType": "global", "value": 1 }, "vpn": { "optionType": "default", "value": 0 }, "version": { "optionType": "default", "value": 4 }, "sourceInterface": { "optionType": "default" }, "prefer": { "optionType": "default", "value": false } }, { "name": { "optionType": "global", "value": "1.1.1.1" }, "key": { "optionType": "global", "value": 2 }, "vpn": { "optionType": "default", "value": 0 }, "version": { "optionType": "default", "value": 4 }, "sourceInterface": { "optionType": "default" }, "prefer": { "optionType": "global", "value": true } } ], "authentication": { "authenticationKeys": [ { "keyId": { "optionType": "global", "value": 1 }, "hmacSha2Value": { "optionType": "global", "value": "adsd123123" } }, { "keyId": { "optionType": "global", "value": 2 }, "cmacAes128Value": { "optionType": "global", "value": "0123456789abcdef" } } ], "trustedKeys": { "optionType": "global", "value": [ 1, 2 ] } } } }, "$$ref": "#/components/examples/ProfileparcelSdwanSystemNtpPostRequest_example_1" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "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}" } }, "required": [ "id" ], "x-metadata": { "minVManageVersion": "20.15.1" }, "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelCommonPostResponse_SchemaPayload" }, "examples": { "example_1": { "value": { "id": "24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A" }, "$$ref": "#/components/examples/ProfileparcelCommonPostResponse_example_1" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Feature Profile > System > Ntp-write" } }, "/v1/feature-profile/sdwan/system/{systemId}/ntp/{ntpId}": { "get": { "tags": [ "Configuration - Feature Profile (SDWAN)" ], "description": "Get Ntp Profile Parcel by parcelId for System feature profile", "operationId": "GetNtpProfileParcelByParcelIdForSystem", "parameters": [ { "name": "systemId", "in": "path", "description": "Feature 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" } }, { "name": "ntpId", "in": "path", "description": "Profile Parcel 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", "properties": { "parcelId": { "type": "string", "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}", "$$ref": "#/components/schemas/CommonCommonDefs_uuidDef" }, "parcelType": { "type": "string" }, "createdBy": { "type": "string", "description": "User who last created this.", "readOnly": true }, "createdOn": { "type": "integer", "description": "Timestamp of creation", "format": "int64", "readOnly": true }, "lastUpdatedBy": { "type": "string", "description": "User who last updated this.", "readOnly": true }, "lastUpdatedOn": { "type": "integer", "description": "Timestamp of last update", "format": "int64", "readOnly": true }, "payload": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[^&<>! \"]+$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_cgFpPpNameDef", "description": "Set the parcel name" }, "description": { "description": "Set the parcel description", "type": "string" }, "data": { "type": "object", "properties": { "server": { "description": "Configure NTP servers", "type": "array", "uniqueItems": true, "additionalProperties": false, "items": { "if": { "anyOf": [ { "properties": { "name": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "name" ] }, { "properties": { "vpn": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "vpn" ] }, { "properties": { "version": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "version" ] }, { "properties": { "prefer": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "prefer" ] } ] }, "then": { "required": [ "name", "vpn", "version", "prefer" ] }, "type": "object", "properties": { "name": { "description": "Set hostname or IP address of server", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "oneOf": [ { "type": "string", "format": "ipv6", "$$ref": "#/components/schemas/CommonCommonDefs_ipv6AddressDef" }, { "type": "string", "format": "hostname", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemNtpPutRequest_hostNameDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemNtpPutRequest_serverNameOptionsDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemNtpPutRequest_oneOfServerNameOptionsDef" }, "key": { "description": "Set authentication key for the server", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "integer", "minimum": 1, "maximum": 4294967295, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemNtpPutRequest_keyDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemNtpPutRequest_oneOfServerKeyOptionsDef" }, "vpn": { "description": "Set VPN in which NTP server is located", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "integer", "default": 0, "minimum": 0, "maximum": 65530, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemNtpPutRequest_vpnDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "minimum": 0, "maximum": 0 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemNtpPutRequest_oneOfVpnOptionsDef" }, "version": { "description": "Set NTP version", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "integer", "default": 4, "minimum": 1, "maximum": 4, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemNtpPutRequest_versionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "minimum": 4, "maximum": 4 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemNtpPutRequest_oneOfVersionOptionsDef" }, "sourceInterface": { "description": "Set interface to use to reach NTP server", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "pattern": "(ATM|ATM-ACR|AppGigabitEthernet|AppNav-Compress|AppNav-UnCompress|Async|BD-VIF|BDI|CEM|CEM-ACR|Cellular|Dialer|Embedded-Service-Engine|Ethernet|Ethernet-Internal|FastEthernet|FiftyGigabitEthernet|FiveGigabitEthernet|FortyGigabitEthernet|FourHundredGigE|GMPLS|GigabitEthernet|Group-Async|HundredGigE|L2LISP|LISP|Loopback|MFR|Multilink|Port-channel|SM|Serial|Service-Engine|TenGigabitEthernet|Tunnel|TwentyFiveGigE|TwentyFiveGigabitEthernet|TwoGigabitEthernet|TwoHundredGigE|Vif|Virtual-PPP|Virtual-Template|VirtualPortGroup|Vlan|Wlan-GigabitEthernet|nat64|nat66|ntp|nve|ospfv3|overlay|pseudowire|ucse|vasileft|vasiright|vmi)([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]+)", "minLength": 3, "maxLength": 32, "$$ref": "#/components/schemas/CommonCommonDefs_ifNameDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemNtpPutRequest_oneOfSourceInterfaceOptionsDef" }, "prefer": { "description": "Prefer this NTP server", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemNtpPutRequest_oneOfPreferOptionsDef" } }, "additionalProperties": false } }, "authentication": { "type": "object", "properties": { "authenticationKeys": { "description": "Set MD5 authentication key", "type": "array", "uniqueItems": true, "additionalProperties": false, "items": { "type": "object", "properties": { "keyId": { "description": "Authentication key ID", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "integer", "minimum": 1, "maximum": 4294967295, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemNtpPutRequest_keyDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemNtpPutRequest_oneOfAuthKeyIdOptionsDef" }, "md5Value": { "description": "Enter cleartext or AES-encrypted MD5 authentication key [Note: Catalyst SD-WAN Manager will encrypt this field before saving. Cleartext strings will not be returned back to the user in GET responses for sensitive fields.]", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "minLength": 1, "x-attributeMetadata": { "insecureConfiguration": { "attributeJsonPath": "$.data.authentication.authenticationKeys[*].md5Value", "description": "NTP authentication using MD5 - vulnerable to collision attacks and should use stronger algorithms", "reason": "Configuration employs an Insecure method for password storage", "remediation": "Transition to more secure algorithms like SHA and AES" } }, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemNtpPutRequest_md5KeyDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemNtpPutRequest_oneOfAuthKeyMd5ValueOptionsDef" }, "hmacSha2Value": { "description": "HMAC-SHA2-256 (digest length = 256 bits, key length = [1-32] bytes)", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "description": "HMAC-SHA2-256 (digest length = 256 bits, key length = [1-32] bytes)", "pattern": "^\\S{1,32}$", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemNtpPutRequest_hmacSha2KeyDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemNtpPutRequest_oneOfAuthKeyHmacSha2ValueOptionsDef" }, "cmacAes128Value": { "description": "CMAC-AES-128 (digest length = 128 bits, key length = [16 or 32] bytes)", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "description": "CMAC-AES-128 (digest length = 128 bits, key length = [16 or 32] bytes)", "minLength": 16, "maxLength": 32, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemNtpPutRequest_cmacAes128KeyDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemNtpPutRequest_oneOfAuthKeyCmacAes128ValueOptionsDef" } }, "additionalProperties": false, "required": [ "keyId" ], "oneOf": [ { "required": [ "md5Value" ], "not": { "anyOf": [ { "required": [ "hmacSha2Value" ] }, { "required": [ "cmacAes128Value" ] } ] } }, { "required": [ "hmacSha2Value" ], "not": { "anyOf": [ { "required": [ "md5Value" ] }, { "required": [ "cmacAes128Value" ] } ] } }, { "required": [ "cmacAes128Value" ], "not": { "anyOf": [ { "required": [ "md5Value" ] }, { "required": [ "hmacSha2Value" ] } ] } } ] } }, "trustedKeys": { "description": "Designate authentication key as trustworthy", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "array", "uniqueItems": true, "additionalProperties": false, "items": { "type": "integer", "minimum": 1, "maximum": 65535 }, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemNtpPutRequest_keyArrayDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemNtpPutRequest_oneOfTrustedKeyIdOptionsDef" } }, "required": [ "authenticationKeys" ], "additionalProperties": false }, "leader": { "type": "object", "properties": { "enable": { "description": "Enable device as NTP Leader", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemNtpPutRequest_oneOfLeaderEnableOptionsDef" }, "stratum": { "description": "Enable device as NTP Leader", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "integer", "maximum": 15, "minimum": 1, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemNtpPutRequest_leaderStratumDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemNtpPutRequest_oneOfLeaderStratumOptionsDef" }, "source": { "description": "Enable device as NTP Leader", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "pattern": "(ATM|ATM-ACR|AppGigabitEthernet|AppNav-Compress|AppNav-UnCompress|Async|BD-VIF|BDI|CEM|CEM-ACR|Cellular|Dialer|Embedded-Service-Engine|Ethernet|Ethernet-Internal|FastEthernet|FiftyGigabitEthernet|FiveGigabitEthernet|FortyGigabitEthernet|FourHundredGigE|GMPLS|GigabitEthernet|Group-Async|HundredGigE|L2LISP|LISP|Loopback|MFR|Multilink|Port-channel|SM|Serial|Service-Engine|TenGigabitEthernet|Tunnel|TwentyFiveGigE|TwentyFiveGigabitEthernet|TwoGigabitEthernet|TwoHundredGigE|Vif|Virtual-PPP|Virtual-Template|VirtualPortGroup|Vlan|Wlan-GigabitEthernet|nat64|nat66|ntp|nve|ospfv3|overlay|pseudowire|ucse|vasileft|vasiright|vmi)([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]+)", "minLength": 3, "maxLength": 32, "$$ref": "#/components/schemas/CommonCommonDefs_ifNameDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemNtpPutRequest_oneOfLeaderSourceOptionsDef" } } } }, "required": [ "server" ], "additionalProperties": false } }, "required": [ "name", "data" ], "x-metadata": { "supportedDeviceTypes": [ "asr", "c1100", "c8000be", "csr1000v", "ir8100", "ir8340", "isr", "ISRv", "ir1101" ], "minVManageVersion": "26.1.1" }, "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemNtpPutRequest_SchemaPayload" } }, "$$ref": "#/components/schemas/getSingleSdwanSystemNtpPayload" }, "examples": { "get response example": { "value": { "parcelId": "09fc54fe-ff36-4640-ae57-c9e71a103902", "parcelType": "ntp", "createdBy": "admin", "lastUpdatedBy": "admin", "createdOn": 1701866357838, "lastUpdatedOn": 1701866357838, "payload": { "data": { "server": [ { "name": { "optionType": "global", "value": "time.google.com" }, "key": { "optionType": "global", "value": 1 }, "vpn": { "optionType": "default", "value": 0 }, "version": { "optionType": "default", "value": 4 }, "sourceInterface": { "optionType": "default" }, "prefer": { "optionType": "default", "value": false } }, { "name": { "optionType": "global", "value": "1.1.1.1" }, "key": { "optionType": "global", "value": 2 }, "vpn": { "optionType": "default", "value": 0 }, "version": { "optionType": "default", "value": 4 }, "sourceInterface": { "optionType": "default" }, "prefer": { "optionType": "global", "value": true } } ], "authentication": { "authenticationKeys": [ { "keyId": { "optionType": "global", "value": 1 }, "hmacSha2Value": { "optionType": "global", "value": "adsd123123" } }, { "keyId": { "optionType": "global", "value": 2 }, "cmacAes128Value": { "optionType": "global", "value": "0123456789abcdef" } } ], "trustedKeys": { "optionType": "global", "value": [ 1, 2 ] } } } } }, "$$ref": "#/components/examples/getSingleSdwanSystemNtpExample" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Feature Profile > System > Ntp-read" }, "put": { "tags": [ "Configuration - Feature Profile (SDWAN)" ], "description": "Update a Ntp Profile Parcel for System feature profile", "operationId": "EditNtpProfileParcelForSystem", "parameters": [ { "name": "systemId", "in": "path", "description": "Feature 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" } }, { "name": "ntpId", "in": "path", "description": "Profile Parcel 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": "Ntp Profile Parcel", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[^&<>! \"]+$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_cgFpPpNameDef", "description": "Set the parcel name" }, "description": { "description": "Set the parcel description", "type": "string" }, "data": { "type": "object", "properties": { "server": { "description": "Configure NTP servers", "type": "array", "uniqueItems": true, "additionalProperties": false, "items": { "if": { "anyOf": [ { "properties": { "name": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "name" ] }, { "properties": { "vpn": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "vpn" ] }, { "properties": { "version": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "version" ] }, { "properties": { "prefer": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "prefer" ] } ] }, "then": { "required": [ "name", "vpn", "version", "prefer" ] }, "type": "object", "properties": { "name": { "description": "Set hostname or IP address of server", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "oneOf": [ { "type": "string", "format": "ipv6", "$$ref": "#/components/schemas/CommonCommonDefs_ipv6AddressDef" }, { "type": "string", "format": "hostname", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemNtpPutRequest_hostNameDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemNtpPutRequest_serverNameOptionsDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemNtpPutRequest_oneOfServerNameOptionsDef" }, "key": { "description": "Set authentication key for the server", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "integer", "minimum": 1, "maximum": 4294967295, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemNtpPutRequest_keyDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemNtpPutRequest_oneOfServerKeyOptionsDef" }, "vpn": { "description": "Set VPN in which NTP server is located", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "integer", "default": 0, "minimum": 0, "maximum": 65530, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemNtpPutRequest_vpnDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "minimum": 0, "maximum": 0 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemNtpPutRequest_oneOfVpnOptionsDef" }, "version": { "description": "Set NTP version", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "integer", "default": 4, "minimum": 1, "maximum": 4, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemNtpPutRequest_versionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "minimum": 4, "maximum": 4 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemNtpPutRequest_oneOfVersionOptionsDef" }, "sourceInterface": { "description": "Set interface to use to reach NTP server", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "pattern": "(ATM|ATM-ACR|AppGigabitEthernet|AppNav-Compress|AppNav-UnCompress|Async|BD-VIF|BDI|CEM|CEM-ACR|Cellular|Dialer|Embedded-Service-Engine|Ethernet|Ethernet-Internal|FastEthernet|FiftyGigabitEthernet|FiveGigabitEthernet|FortyGigabitEthernet|FourHundredGigE|GMPLS|GigabitEthernet|Group-Async|HundredGigE|L2LISP|LISP|Loopback|MFR|Multilink|Port-channel|SM|Serial|Service-Engine|TenGigabitEthernet|Tunnel|TwentyFiveGigE|TwentyFiveGigabitEthernet|TwoGigabitEthernet|TwoHundredGigE|Vif|Virtual-PPP|Virtual-Template|VirtualPortGroup|Vlan|Wlan-GigabitEthernet|nat64|nat66|ntp|nve|ospfv3|overlay|pseudowire|ucse|vasileft|vasiright|vmi)([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]+)", "minLength": 3, "maxLength": 32, "$$ref": "#/components/schemas/CommonCommonDefs_ifNameDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemNtpPutRequest_oneOfSourceInterfaceOptionsDef" }, "prefer": { "description": "Prefer this NTP server", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemNtpPutRequest_oneOfPreferOptionsDef" } }, "additionalProperties": false } }, "authentication": { "type": "object", "properties": { "authenticationKeys": { "description": "Set MD5 authentication key", "type": "array", "uniqueItems": true, "additionalProperties": false, "items": { "type": "object", "properties": { "keyId": { "description": "Authentication key ID", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "integer", "minimum": 1, "maximum": 4294967295, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemNtpPutRequest_keyDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemNtpPutRequest_oneOfAuthKeyIdOptionsDef" }, "md5Value": { "description": "Enter cleartext or AES-encrypted MD5 authentication key [Note: Catalyst SD-WAN Manager will encrypt this field before saving. Cleartext strings will not be returned back to the user in GET responses for sensitive fields.]", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "minLength": 1, "x-attributeMetadata": { "insecureConfiguration": { "attributeJsonPath": "$.data.authentication.authenticationKeys[*].md5Value", "description": "NTP authentication using MD5 - vulnerable to collision attacks and should use stronger algorithms", "reason": "Configuration employs an Insecure method for password storage", "remediation": "Transition to more secure algorithms like SHA and AES" } }, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemNtpPutRequest_md5KeyDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemNtpPutRequest_oneOfAuthKeyMd5ValueOptionsDef" }, "hmacSha2Value": { "description": "HMAC-SHA2-256 (digest length = 256 bits, key length = [1-32] bytes)", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "description": "HMAC-SHA2-256 (digest length = 256 bits, key length = [1-32] bytes)", "pattern": "^\\S{1,32}$", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemNtpPutRequest_hmacSha2KeyDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemNtpPutRequest_oneOfAuthKeyHmacSha2ValueOptionsDef" }, "cmacAes128Value": { "description": "CMAC-AES-128 (digest length = 128 bits, key length = [16 or 32] bytes)", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "description": "CMAC-AES-128 (digest length = 128 bits, key length = [16 or 32] bytes)", "minLength": 16, "maxLength": 32, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemNtpPutRequest_cmacAes128KeyDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemNtpPutRequest_oneOfAuthKeyCmacAes128ValueOptionsDef" } }, "additionalProperties": false, "required": [ "keyId" ], "oneOf": [ { "required": [ "md5Value" ], "not": { "anyOf": [ { "required": [ "hmacSha2Value" ] }, { "required": [ "cmacAes128Value" ] } ] } }, { "required": [ "hmacSha2Value" ], "not": { "anyOf": [ { "required": [ "md5Value" ] }, { "required": [ "cmacAes128Value" ] } ] } }, { "required": [ "cmacAes128Value" ], "not": { "anyOf": [ { "required": [ "md5Value" ] }, { "required": [ "hmacSha2Value" ] } ] } } ] } }, "trustedKeys": { "description": "Designate authentication key as trustworthy", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "array", "uniqueItems": true, "additionalProperties": false, "items": { "type": "integer", "minimum": 1, "maximum": 65535 }, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemNtpPutRequest_keyArrayDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemNtpPutRequest_oneOfTrustedKeyIdOptionsDef" } }, "required": [ "authenticationKeys" ], "additionalProperties": false }, "leader": { "type": "object", "properties": { "enable": { "description": "Enable device as NTP Leader", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemNtpPutRequest_oneOfLeaderEnableOptionsDef" }, "stratum": { "description": "Enable device as NTP Leader", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "integer", "maximum": 15, "minimum": 1, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemNtpPutRequest_leaderStratumDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemNtpPutRequest_oneOfLeaderStratumOptionsDef" }, "source": { "description": "Enable device as NTP Leader", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "pattern": "(ATM|ATM-ACR|AppGigabitEthernet|AppNav-Compress|AppNav-UnCompress|Async|BD-VIF|BDI|CEM|CEM-ACR|Cellular|Dialer|Embedded-Service-Engine|Ethernet|Ethernet-Internal|FastEthernet|FiftyGigabitEthernet|FiveGigabitEthernet|FortyGigabitEthernet|FourHundredGigE|GMPLS|GigabitEthernet|Group-Async|HundredGigE|L2LISP|LISP|Loopback|MFR|Multilink|Port-channel|SM|Serial|Service-Engine|TenGigabitEthernet|Tunnel|TwentyFiveGigE|TwentyFiveGigabitEthernet|TwoGigabitEthernet|TwoHundredGigE|Vif|Virtual-PPP|Virtual-Template|VirtualPortGroup|Vlan|Wlan-GigabitEthernet|nat64|nat66|ntp|nve|ospfv3|overlay|pseudowire|ucse|vasileft|vasiright|vmi)([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]+)", "minLength": 3, "maxLength": 32, "$$ref": "#/components/schemas/CommonCommonDefs_ifNameDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemNtpPutRequest_oneOfLeaderSourceOptionsDef" } } } }, "required": [ "server" ], "additionalProperties": false } }, "required": [ "name", "data" ], "x-metadata": { "supportedDeviceTypes": [ "asr", "c1100", "c8000be", "csr1000v", "ir8100", "ir8340", "isr", "ISRv", "ir1101" ], "minVManageVersion": "26.1.1" }, "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemNtpPutRequest_SchemaPayload" }, "examples": { "example_1": { "value": { "data": { "server": [ { "name": { "optionType": "global", "value": "time.google.com" }, "key": { "optionType": "global", "value": 1 }, "vpn": { "optionType": "default", "value": 0 }, "version": { "optionType": "default", "value": 4 }, "sourceInterface": { "optionType": "default" }, "prefer": { "optionType": "default", "value": false } }, { "name": { "optionType": "global", "value": "1.1.1.1" }, "key": { "optionType": "global", "value": 2 }, "vpn": { "optionType": "default", "value": 0 }, "version": { "optionType": "default", "value": 4 }, "sourceInterface": { "optionType": "default" }, "prefer": { "optionType": "global", "value": true } } ], "authentication": { "authenticationKeys": [ { "keyId": { "optionType": "global", "value": 1 }, "hmacSha2Value": { "optionType": "global", "value": "adsd123123" } }, { "keyId": { "optionType": "global", "value": 2 }, "cmacAes128Value": { "optionType": "global", "value": "0123456789abcdef" } } ], "trustedKeys": { "optionType": "global", "value": [ 1, 2 ] } } } }, "$$ref": "#/components/examples/ProfileparcelSdwanSystemNtpPutRequest_example_1" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "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}" } }, "required": [ "id" ], "x-metadata": { "minVManageVersion": "20.15.1" }, "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelCommonPutResponse_SchemaPayload" }, "examples": { "example_1": { "value": { "id": "24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A" }, "$$ref": "#/components/examples/ProfileparcelCommonPutResponse_example_1" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Feature Profile > System > Ntp-write" }, "delete": { "tags": [ "Configuration - Feature Profile (SDWAN)" ], "description": "Delete a Ntp Profile Parcel for System feature profile", "operationId": "DeleteNtpProfileParcelForSystem", "parameters": [ { "name": "systemId", "in": "path", "description": "Feature 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" } }, { "name": "ntpId", "in": "path", "description": "Profile Parcel 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": "Feature Profile > System > Ntp-write" } }, "/v1/feature-profile/sdwan/system/{systemId}/omp": { "post": { "tags": [ "Configuration - Feature Profile (SDWAN)" ], "description": "Create a Omp Profile Parcel for System feature profile", "operationId": "CreateOmpProfileParcelForSystem", "parameters": [ { "name": "systemId", "in": "path", "description": "Feature 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": "Omp Profile Parcel", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[^&<>! \"]+$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_cgFpPpNameDef", "description": "Set the parcel name" }, "description": { "description": "Set the parcel description", "type": "string" }, "data": { "if": { "properties": { "siteTypesForTransportGateway": { "properties": { "optionType": { "const": "default" } } } } }, "else": { "not": { "properties": { "transportGateway": { "properties": { "optionType": { "const": "default" } } } } } }, "type": "object", "properties": { "gracefulRestart": { "description": "Graceful Restart for OMP", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ true ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanTrueDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPostRequest_oneOfGracefulRestartOptionsDef" }, "overlayAs": { "description": "Overlay AS Number", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "maximum": 4294967295, "minimum": 1, "type": "number", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPostRequest_overlayAsDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPostRequest_oneOfOverlayAsOptionsDef" }, "sendPathLimit": { "description": "Number of Paths Advertised per Prefix", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 4, "maximum": 16, "minimum": 1, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPostRequest_sendPathLimitDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "minimum": 4, "maximum": 4 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPostRequest_oneOfSendPathLimitOptionsDef" }, "ecmpLimit": { "description": "Set maximum number of OMP paths to install in cEdge route table", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 4, "maximum": 16, "minimum": 1, "type": "number", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPostRequest_ecmpLimitDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "minimum": 4, "maximum": 4 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPostRequest_oneOfEcmpLimitOptionsDef" }, "shutdown": { "description": "Shutdown", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPostRequest_oneOfShutdownOptionsDef" }, "ompAdminDistanceIpv4": { "description": "OMP Admin Distance IPv4", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 251, "maximum": 255, "minimum": 1, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPostRequest_adminDistanceDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "maximum": 251, "minimum": 251, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPostRequest_defaultAdminDistanceDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPostRequest_oneOfOmpAdminDistanceIpv4OptionsDef" }, "ompAdminDistanceIpv6": { "description": "OMP Admin Distance IPv6", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 251, "maximum": 255, "minimum": 1, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPostRequest_adminDistanceDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "maximum": 251, "minimum": 251, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPostRequest_defaultAdminDistanceDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPostRequest_oneOfOmpAdminDistanceIpv6OptionsDef" }, "advertisementInterval": { "description": "Advertisement Interval (seconds)", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 1, "maximum": 65535, "minimum": 0, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPostRequest_advertisementIntervalDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "minimum": 1, "maximum": 1 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPostRequest_oneOfAdvertisementIntervalOptionsDef" }, "gracefulRestartTimer": { "description": "Graceful Restart Timer (seconds)", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 43200, "maximum": 31556952, "minimum": 1, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPostRequest_gracefulRestartTimerDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "minimum": 43200, "maximum": 43200 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPostRequest_oneOfGracefulRestartTimerOptionsDef" }, "eorTimer": { "description": "EOR Timer", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 300, "maximum": 3600, "minimum": 1, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPostRequest_eorTimerDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "minimum": 300, "maximum": 300 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPostRequest_oneOfEorTimerOptionsDef" }, "holdtime": { "description": "Hold Time (seconds)", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "anyOf": [ { "default": 0, "minimum": 0, "maximum": 0, "type": "integer" }, { "default": 300, "minimum": 3, "maximum": 65535, "type": "integer" }, { "default": 5400, "minimum": 3, "maximum": 65535, "type": "integer" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPostRequest_holdtimeDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "enum": [ 60, 300, 5400 ], "default": 300 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPostRequest_oneOfHoldtimeOptionsDef" }, "advertiseIpv4": { "type": "object", "properties": { "bgp": { "description": "BGP", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPostRequest_oneOfAdvertiseProtocolOptionsDef" }, "ospf": { "description": "OSPF", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPostRequest_oneOfAdvertiseProtocolOptionsDef" }, "ospfv3": { "description": "OSPFV3", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPostRequest_oneOfAdvertiseProtocolOptionsDef" }, "connected": { "description": "Connected", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ true, false ], "default": true, "description": "use enum for backward compatibility, use default for UI to display default value", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPostRequest_defaultAdvertiseConnectedDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPostRequest_oneOfAdvertiseConnectedOptionsDef" }, "static": { "description": "Static", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ true, false ], "default": true, "description": "use enum for backward compatibility, use default for UI to display default value", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPostRequest_defaultAdvertiseStaticDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPostRequest_oneOfAdvertiseStaticOptionsDef" }, "eigrp": { "description": "EIGRP", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPostRequest_oneOfAdvertiseProtocolOptionsDef" }, "lisp": { "description": "LISP", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPostRequest_oneOfAdvertiseProtocolOptionsDef" }, "isis": { "description": "ISIS", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPostRequest_oneOfAdvertiseProtocolOptionsDef" } }, "required": [ "bgp", "ospf", "ospfv3", "connected", "static", "eigrp", "lisp", "isis" ], "additionalProperties": false }, "advertiseIpv6": { "type": "object", "properties": { "bgp": { "description": "BGP", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPostRequest_oneOfAdvertiseProtocolOptionsDef" }, "ospf": { "description": "OSPF", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPostRequest_oneOfAdvertiseProtocolOptionsDef" }, "connected": { "description": "Connected", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ true, false ], "default": true, "description": "use enum for backward compatibility, use default for UI to display default value", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPostRequest_defaultAdvertiseConnectedDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPostRequest_oneOfAdvertiseConnectedOptionsDef" }, "static": { "description": "Static", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ true, false ], "default": true, "description": "use enum for backward compatibility, use default for UI to display default value", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPostRequest_defaultAdvertiseStaticDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPostRequest_oneOfAdvertiseStaticOptionsDef" }, "eigrp": { "description": "EIGRP", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPostRequest_oneOfAdvertiseProtocolOptionsDef" }, "lisp": { "description": "LISP", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPostRequest_oneOfAdvertiseProtocolOptionsDef" }, "isis": { "description": "ISIS", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPostRequest_oneOfAdvertiseProtocolOptionsDef" } }, "required": [ "bgp", "ospf", "connected", "static", "eigrp", "lisp", "isis" ], "additionalProperties": false }, "ignoreRegionPathLength": { "description": "Treat hierarchical and direct (secondary region) paths equally", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPostRequest_oneOfIgnoreRegionPathLengthOptionsDef" }, "transportGateway": { "description": "Transport Gateway Path Behavior", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "enum": [ "prefer", "ecmp-with-direct-path" ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPostRequest_transportGatewayEnumDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPostRequest_oneOfTransportGatewayOptionsDef" }, "siteTypesForTransportGateway": { "description": "Site Types", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "array", "uniqueItems": true, "minItems": 1, "maxItems": 4, "items": { "type": "string", "enum": [ "type-1", "type-2", "type-3", "cloud", "branch", "br", "spoke" ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPostRequest_siteTypeEnumDef" }, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPostRequest_siteTypeListDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPostRequest_oneOfSiteTypesOptionsDef" }, "aspathAutoTranslation": { "description": "Enable BGP AS Path Auto-Translation", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/CommonCommonDefs_oneOfOnBooleanDefaultFalseOptionsDef" }, "siteTypes": { "description": "Site Types for 20.12 backward compatiblity", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "array", "uniqueItems": true, "minItems": 1, "maxItems": 4, "items": { "type": "string", "enum": [ "type-1", "type-2", "type-3", "cloud", "branch", "br", "spoke" ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPostRequest_siteTypeEnumDef" }, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPostRequest_siteTypeListDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPostRequest_oneOfSiteTypesOptionsDef" } }, "required": [ "gracefulRestart", "overlayAs", "sendPathLimit", "ecmpLimit", "shutdown", "ompAdminDistanceIpv4", "ompAdminDistanceIpv6", "advertisementInterval", "gracefulRestartTimer", "eorTimer", "holdtime", "advertiseIpv4", "advertiseIpv6" ], "additionalProperties": false } }, "required": [ "name", "data" ], "x-metadata": { "supportedDeviceTypes": [ "asr", "c1100", "c8000be", "csr1000v", "ir8100", "ir8340", "isr", "ISRv", "ir1101" ], "minVManageVersion": "20.18" }, "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPostRequest_SchemaPayload" }, "examples": { "Cedge_CG1_System_omp_parcel1": { "value": { "data": { "gracefulRestart": { "optionType": "global", "value": true }, "overlayAs": { "optionType": "global", "value": 10 }, "sendPathLimit": { "optionType": "global", "value": 4 }, "ecmpLimit": { "optionType": "global", "value": 4 }, "shutdown": { "optionType": "global", "value": false }, "ompAdminDistanceIpv4": { "optionType": "global", "value": 10 }, "ompAdminDistanceIpv6": { "optionType": "global", "value": 20 }, "advertisementInterval": { "optionType": "global", "value": 1 }, "gracefulRestartTimer": { "optionType": "global", "value": 43200 }, "eorTimer": { "optionType": "global", "value": 300 }, "holdtime": { "optionType": "global", "value": 300 }, "advertiseIpv4": { "bgp": { "optionType": "global", "value": true }, "ospf": { "optionType": "global", "value": true }, "ospfv3": { "optionType": "global", "value": true }, "connected": { "optionType": "global", "value": true }, "static": { "optionType": "global", "value": true }, "eigrp": { "optionType": "global", "value": true }, "lisp": { "optionType": "global", "value": true }, "isis": { "optionType": "global", "value": true } }, "advertiseIpv6": { "bgp": { "optionType": "global", "value": true }, "ospf": { "optionType": "global", "value": true }, "connected": { "optionType": "global", "value": true }, "static": { "optionType": "global", "value": true }, "eigrp": { "optionType": "global", "value": true }, "lisp": { "optionType": "global", "value": true }, "isis": { "optionType": "global", "value": true } } }, "description": "Cedge System OMP Parcel config", "name": "Cedge_CG1_System_omp_parcel1" }, "$$ref": "#/components/examples/ProfileparcelSdwanSystemOmpPostRequest_Cedge_CG1_System_omp_parcel1" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "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}" } }, "required": [ "id" ], "x-metadata": { "minVManageVersion": "20.15.1" }, "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelCommonPostResponse_SchemaPayload" }, "examples": { "example_1": { "value": { "id": "24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A" }, "$$ref": "#/components/examples/ProfileparcelCommonPostResponse_example_1" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Feature Profile > System > Omp-write" }, "get": { "tags": [ "Configuration - Feature Profile (SDWAN)" ], "description": "Get Omp Profile Parcels for System feature profile", "operationId": "GetOmpProfileParcelForSystem", "parameters": [ { "name": "systemId", "in": "path", "description": "Feature 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", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "parcelId": { "type": "string", "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}", "$$ref": "#/components/schemas/CommonCommonDefs_uuidDef" }, "parcelType": { "type": "string" }, "createdBy": { "type": "string", "description": "User who last created this.", "readOnly": true }, "createdOn": { "type": "integer", "description": "Timestamp of creation", "format": "int64", "readOnly": true }, "lastUpdatedBy": { "type": "string", "description": "User who last updated this.", "readOnly": true }, "lastUpdatedOn": { "type": "integer", "description": "Timestamp of last update", "format": "int64", "readOnly": true }, "payload": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[^&<>! \"]+$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_cgFpPpNameDef", "description": "Set the parcel name" }, "description": { "description": "Set the parcel description", "type": "string" }, "data": { "if": { "properties": { "siteTypesForTransportGateway": { "properties": { "optionType": { "const": "default" } } } } }, "else": { "not": { "properties": { "transportGateway": { "properties": { "optionType": { "const": "default" } } } } } }, "type": "object", "properties": { "gracefulRestart": { "description": "Graceful Restart for OMP", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ true ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanTrueDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPostRequest_oneOfGracefulRestartOptionsDef" }, "overlayAs": { "description": "Overlay AS Number", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "maximum": 4294967295, "minimum": 1, "type": "number", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPostRequest_overlayAsDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPostRequest_oneOfOverlayAsOptionsDef" }, "sendPathLimit": { "description": "Number of Paths Advertised per Prefix", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 4, "maximum": 16, "minimum": 1, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPostRequest_sendPathLimitDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "minimum": 4, "maximum": 4 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPostRequest_oneOfSendPathLimitOptionsDef" }, "ecmpLimit": { "description": "Set maximum number of OMP paths to install in cEdge route table", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 4, "maximum": 16, "minimum": 1, "type": "number", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPostRequest_ecmpLimitDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "minimum": 4, "maximum": 4 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPostRequest_oneOfEcmpLimitOptionsDef" }, "shutdown": { "description": "Shutdown", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPostRequest_oneOfShutdownOptionsDef" }, "ompAdminDistanceIpv4": { "description": "OMP Admin Distance IPv4", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 251, "maximum": 255, "minimum": 1, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPostRequest_adminDistanceDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "maximum": 251, "minimum": 251, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPostRequest_defaultAdminDistanceDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPostRequest_oneOfOmpAdminDistanceIpv4OptionsDef" }, "ompAdminDistanceIpv6": { "description": "OMP Admin Distance IPv6", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 251, "maximum": 255, "minimum": 1, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPostRequest_adminDistanceDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "maximum": 251, "minimum": 251, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPostRequest_defaultAdminDistanceDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPostRequest_oneOfOmpAdminDistanceIpv6OptionsDef" }, "advertisementInterval": { "description": "Advertisement Interval (seconds)", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 1, "maximum": 65535, "minimum": 0, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPostRequest_advertisementIntervalDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "minimum": 1, "maximum": 1 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPostRequest_oneOfAdvertisementIntervalOptionsDef" }, "gracefulRestartTimer": { "description": "Graceful Restart Timer (seconds)", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 43200, "maximum": 31556952, "minimum": 1, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPostRequest_gracefulRestartTimerDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "minimum": 43200, "maximum": 43200 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPostRequest_oneOfGracefulRestartTimerOptionsDef" }, "eorTimer": { "description": "EOR Timer", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 300, "maximum": 3600, "minimum": 1, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPostRequest_eorTimerDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "minimum": 300, "maximum": 300 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPostRequest_oneOfEorTimerOptionsDef" }, "holdtime": { "description": "Hold Time (seconds)", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "anyOf": [ { "default": 0, "minimum": 0, "maximum": 0, "type": "integer" }, { "default": 300, "minimum": 3, "maximum": 65535, "type": "integer" }, { "default": 5400, "minimum": 3, "maximum": 65535, "type": "integer" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPostRequest_holdtimeDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "enum": [ 60, 300, 5400 ], "default": 300 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPostRequest_oneOfHoldtimeOptionsDef" }, "advertiseIpv4": { "type": "object", "properties": { "bgp": { "description": "BGP", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPostRequest_oneOfAdvertiseProtocolOptionsDef" }, "ospf": { "description": "OSPF", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPostRequest_oneOfAdvertiseProtocolOptionsDef" }, "ospfv3": { "description": "OSPFV3", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPostRequest_oneOfAdvertiseProtocolOptionsDef" }, "connected": { "description": "Connected", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ true, false ], "default": true, "description": "use enum for backward compatibility, use default for UI to display default value", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPostRequest_defaultAdvertiseConnectedDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPostRequest_oneOfAdvertiseConnectedOptionsDef" }, "static": { "description": "Static", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ true, false ], "default": true, "description": "use enum for backward compatibility, use default for UI to display default value", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPostRequest_defaultAdvertiseStaticDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPostRequest_oneOfAdvertiseStaticOptionsDef" }, "eigrp": { "description": "EIGRP", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPostRequest_oneOfAdvertiseProtocolOptionsDef" }, "lisp": { "description": "LISP", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPostRequest_oneOfAdvertiseProtocolOptionsDef" }, "isis": { "description": "ISIS", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPostRequest_oneOfAdvertiseProtocolOptionsDef" } }, "required": [ "bgp", "ospf", "ospfv3", "connected", "static", "eigrp", "lisp", "isis" ], "additionalProperties": false }, "advertiseIpv6": { "type": "object", "properties": { "bgp": { "description": "BGP", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPostRequest_oneOfAdvertiseProtocolOptionsDef" }, "ospf": { "description": "OSPF", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPostRequest_oneOfAdvertiseProtocolOptionsDef" }, "connected": { "description": "Connected", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ true, false ], "default": true, "description": "use enum for backward compatibility, use default for UI to display default value", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPostRequest_defaultAdvertiseConnectedDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPostRequest_oneOfAdvertiseConnectedOptionsDef" }, "static": { "description": "Static", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ true, false ], "default": true, "description": "use enum for backward compatibility, use default for UI to display default value", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPostRequest_defaultAdvertiseStaticDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPostRequest_oneOfAdvertiseStaticOptionsDef" }, "eigrp": { "description": "EIGRP", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPostRequest_oneOfAdvertiseProtocolOptionsDef" }, "lisp": { "description": "LISP", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPostRequest_oneOfAdvertiseProtocolOptionsDef" }, "isis": { "description": "ISIS", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPostRequest_oneOfAdvertiseProtocolOptionsDef" } }, "required": [ "bgp", "ospf", "connected", "static", "eigrp", "lisp", "isis" ], "additionalProperties": false }, "ignoreRegionPathLength": { "description": "Treat hierarchical and direct (secondary region) paths equally", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPostRequest_oneOfIgnoreRegionPathLengthOptionsDef" }, "transportGateway": { "description": "Transport Gateway Path Behavior", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "enum": [ "prefer", "ecmp-with-direct-path" ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPostRequest_transportGatewayEnumDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPostRequest_oneOfTransportGatewayOptionsDef" }, "siteTypesForTransportGateway": { "description": "Site Types", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "array", "uniqueItems": true, "minItems": 1, "maxItems": 4, "items": { "type": "string", "enum": [ "type-1", "type-2", "type-3", "cloud", "branch", "br", "spoke" ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPostRequest_siteTypeEnumDef" }, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPostRequest_siteTypeListDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPostRequest_oneOfSiteTypesOptionsDef" }, "aspathAutoTranslation": { "description": "Enable BGP AS Path Auto-Translation", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/CommonCommonDefs_oneOfOnBooleanDefaultFalseOptionsDef" }, "siteTypes": { "description": "Site Types for 20.12 backward compatiblity", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "array", "uniqueItems": true, "minItems": 1, "maxItems": 4, "items": { "type": "string", "enum": [ "type-1", "type-2", "type-3", "cloud", "branch", "br", "spoke" ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPostRequest_siteTypeEnumDef" }, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPostRequest_siteTypeListDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPostRequest_oneOfSiteTypesOptionsDef" } }, "required": [ "gracefulRestart", "overlayAs", "sendPathLimit", "ecmpLimit", "shutdown", "ompAdminDistanceIpv4", "ompAdminDistanceIpv6", "advertisementInterval", "gracefulRestartTimer", "eorTimer", "holdtime", "advertiseIpv4", "advertiseIpv6" ], "additionalProperties": false } }, "required": [ "name", "data" ], "x-metadata": { "supportedDeviceTypes": [ "asr", "c1100", "c8000be", "csr1000v", "ir8100", "ir8340", "isr", "ISRv", "ir1101" ], "minVManageVersion": "20.18" }, "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPostRequest_SchemaPayload" } } } } }, "$$ref": "#/components/schemas/getListSdwanSystemOmpPayload" }, "examples": { "get response example": { "value": { "header": { "generatedOn": 1702438718825 }, "data": [ { "parcelId": "09fc54fe-ff36-4640-ae57-c9e71a103902", "parcelType": "omp", "createdBy": "admin", "lastUpdatedBy": "admin", "createdOn": 1701866357838, "lastUpdatedOn": 1701866357838, "payload": { "data": { "gracefulRestart": { "optionType": "global", "value": true }, "overlayAs": { "optionType": "global", "value": 10 }, "sendPathLimit": { "optionType": "global", "value": 4 }, "ecmpLimit": { "optionType": "global", "value": 4 }, "shutdown": { "optionType": "global", "value": false }, "ompAdminDistanceIpv4": { "optionType": "global", "value": 10 }, "ompAdminDistanceIpv6": { "optionType": "global", "value": 20 }, "advertisementInterval": { "optionType": "global", "value": 1 }, "gracefulRestartTimer": { "optionType": "global", "value": 43200 }, "eorTimer": { "optionType": "global", "value": 300 }, "holdtime": { "optionType": "global", "value": 300 }, "advertiseIpv4": { "bgp": { "optionType": "global", "value": true }, "ospf": { "optionType": "global", "value": true }, "ospfv3": { "optionType": "global", "value": true }, "connected": { "optionType": "global", "value": true }, "static": { "optionType": "global", "value": true }, "eigrp": { "optionType": "global", "value": true }, "lisp": { "optionType": "global", "value": true }, "isis": { "optionType": "global", "value": true } }, "advertiseIpv6": { "bgp": { "optionType": "global", "value": true }, "ospf": { "optionType": "global", "value": true }, "connected": { "optionType": "global", "value": true }, "static": { "optionType": "global", "value": true }, "eigrp": { "optionType": "global", "value": true }, "lisp": { "optionType": "global", "value": true }, "isis": { "optionType": "global", "value": true } } } } } ] }, "$$ref": "#/components/examples/getListSdwanSystemOmpExample" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Feature Profile > System > Omp-read" } }, "/v1/feature-profile/sdwan/system/{systemId}/omp/{ompId}": { "delete": { "tags": [ "Configuration - Feature Profile (SDWAN)" ], "description": "Delete a Omp Profile Parcel for System feature profile", "operationId": "DeleteOmpProfileParcelForSystem", "parameters": [ { "name": "systemId", "in": "path", "description": "Feature 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" } }, { "name": "ompId", "in": "path", "description": "Profile Parcel 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": "Feature Profile > System > Omp-write" }, "get": { "tags": [ "Configuration - Feature Profile (SDWAN)" ], "description": "Get Omp Profile Parcel by parcelId for System feature profile", "operationId": "GetOmpProfileParcelByParcelIdForSystem", "parameters": [ { "name": "systemId", "in": "path", "description": "Feature 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" } }, { "name": "ompId", "in": "path", "description": "Profile Parcel 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", "properties": { "parcelId": { "type": "string", "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}", "$$ref": "#/components/schemas/CommonCommonDefs_uuidDef" }, "parcelType": { "type": "string" }, "createdBy": { "type": "string", "description": "User who last created this.", "readOnly": true }, "createdOn": { "type": "integer", "description": "Timestamp of creation", "format": "int64", "readOnly": true }, "lastUpdatedBy": { "type": "string", "description": "User who last updated this.", "readOnly": true }, "lastUpdatedOn": { "type": "integer", "description": "Timestamp of last update", "format": "int64", "readOnly": true }, "payload": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[^&<>! \"]+$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_cgFpPpNameDef", "description": "Set the parcel name" }, "description": { "description": "Set the parcel description", "type": "string" }, "data": { "if": { "properties": { "siteTypesForTransportGateway": { "properties": { "optionType": { "const": "default" } } } } }, "else": { "not": { "properties": { "transportGateway": { "properties": { "optionType": { "const": "default" } } } } } }, "type": "object", "properties": { "gracefulRestart": { "description": "Graceful Restart for OMP", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ true ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanTrueDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPutRequest_oneOfGracefulRestartOptionsDef" }, "overlayAs": { "description": "Overlay AS Number", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "maximum": 4294967295, "minimum": 1, "type": "number", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPutRequest_overlayAsDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPutRequest_oneOfOverlayAsOptionsDef" }, "sendPathLimit": { "description": "Number of Paths Advertised per Prefix", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 4, "maximum": 16, "minimum": 1, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPutRequest_sendPathLimitDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "minimum": 4, "maximum": 4 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPutRequest_oneOfSendPathLimitOptionsDef" }, "ecmpLimit": { "description": "Set maximum number of OMP paths to install in cEdge route table", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 4, "maximum": 16, "minimum": 1, "type": "number", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPutRequest_ecmpLimitDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "minimum": 4, "maximum": 4 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPutRequest_oneOfEcmpLimitOptionsDef" }, "shutdown": { "description": "Shutdown", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPutRequest_oneOfShutdownOptionsDef" }, "ompAdminDistanceIpv4": { "description": "OMP Admin Distance IPv4", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "maximum": 255, "minimum": 1, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPutRequest_adminDistanceDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "default": 251, "maximum": 251, "minimum": 251, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPutRequest_defaultAdminDistanceDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPutRequest_oneOfOmpAdminDistanceIpv4OptionsDef" }, "ompAdminDistanceIpv6": { "description": "OMP Admin Distance IPv6", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "maximum": 255, "minimum": 1, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPutRequest_adminDistanceDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "default": 251, "maximum": 251, "minimum": 251, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPutRequest_defaultAdminDistanceDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPutRequest_oneOfOmpAdminDistanceIpv6OptionsDef" }, "advertisementInterval": { "description": "Advertisement Interval (seconds)", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 1, "maximum": 65535, "minimum": 0, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPutRequest_advertisementIntervalDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "minimum": 1, "maximum": 1 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPutRequest_oneOfAdvertisementIntervalOptionsDef" }, "gracefulRestartTimer": { "description": "Graceful Restart Timer (seconds)", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 43200, "maximum": 31556952, "minimum": 1, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPutRequest_gracefulRestartTimerDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "minimum": 43200, "maximum": 43200 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPutRequest_oneOfGracefulRestartTimerOptionsDef" }, "eorTimer": { "description": "EOR Timer", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 300, "maximum": 3600, "minimum": 1, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPutRequest_eorTimerDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "minimum": 300, "maximum": 300 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPutRequest_oneOfEorTimerOptionsDef" }, "holdtime": { "description": "Hold Time (seconds)", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "anyOf": [ { "default": 0, "minimum": 0, "maximum": 0, "type": "integer" }, { "default": 300, "minimum": 3, "maximum": 65535, "type": "integer" }, { "default": 5400, "minimum": 3, "maximum": 65535, "type": "integer" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPutRequest_holdtimeDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "enum": [ 60, 300, 5400 ], "default": 300 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPutRequest_oneOfHoldtimeOptionsDef" }, "advertiseIpv4": { "type": "object", "properties": { "bgp": { "description": "BGP", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPutRequest_oneOfAdvertiseProtocolOptionsDef" }, "ospf": { "description": "OSPF", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPutRequest_oneOfAdvertiseProtocolOptionsDef" }, "ospfv3": { "description": "OSPFV3", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPutRequest_oneOfAdvertiseProtocolOptionsDef" }, "connected": { "description": "Connected", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ true, false ], "default": true, "description": "use enum for backward compatibility, use default for UI to display default value", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPutRequest_defaultAdvertiseConnectedDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPutRequest_oneOfAdvertiseConnectedOptionsDef" }, "static": { "description": "Static", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ true, false ], "default": true, "description": "use enum for backward compatibility, use default for UI to display default value", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPutRequest_defaultAdvertiseStaticDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPutRequest_oneOfAdvertiseStaticOptionsDef" }, "eigrp": { "description": "EIGRP", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPutRequest_oneOfAdvertiseProtocolOptionsDef" }, "lisp": { "description": "LISP", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPutRequest_oneOfAdvertiseProtocolOptionsDef" }, "isis": { "description": "ISIS", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPutRequest_oneOfAdvertiseProtocolOptionsDef" } }, "required": [ "bgp", "ospf", "ospfv3", "connected", "static", "eigrp", "lisp", "isis" ], "additionalProperties": false }, "advertiseIpv6": { "type": "object", "properties": { "bgp": { "description": "BGP", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPutRequest_oneOfAdvertiseProtocolOptionsDef" }, "ospf": { "description": "OSPF", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPutRequest_oneOfAdvertiseProtocolOptionsDef" }, "connected": { "description": "Connected", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ true, false ], "default": true, "description": "use enum for backward compatibility, use default for UI to display default value", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPutRequest_defaultAdvertiseConnectedDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPutRequest_oneOfAdvertiseConnectedOptionsDef" }, "static": { "description": "Static", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ true, false ], "default": true, "description": "use enum for backward compatibility, use default for UI to display default value", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPutRequest_defaultAdvertiseStaticDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPutRequest_oneOfAdvertiseStaticOptionsDef" }, "eigrp": { "description": "EIGRP", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPutRequest_oneOfAdvertiseProtocolOptionsDef" }, "lisp": { "description": "LISP", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPutRequest_oneOfAdvertiseProtocolOptionsDef" }, "isis": { "description": "ISIS", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPutRequest_oneOfAdvertiseProtocolOptionsDef" } }, "required": [ "bgp", "ospf", "connected", "static", "eigrp", "lisp", "isis" ], "additionalProperties": false }, "ignoreRegionPathLength": { "description": "Treat hierarchical and direct (secondary region) paths equally", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPutRequest_oneOfIgnoreRegionPathLengthOptionsDef" }, "transportGateway": { "description": "Transport Gateway Path Behavior", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "enum": [ "prefer", "ecmp-with-direct-path" ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPutRequest_transportGatewayEnumDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPutRequest_oneOfTransportGatewayOptionsDef" }, "siteTypesForTransportGateway": { "description": "Site Types", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "array", "uniqueItems": true, "minItems": 1, "maxItems": 4, "items": { "type": "string", "enum": [ "type-1", "type-2", "type-3", "cloud", "branch", "br", "spoke" ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPutRequest_siteTypeEnumDef" }, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPutRequest_siteTypeListDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPutRequest_oneOfSiteTypesOptionsDef" }, "aspathAutoTranslation": { "description": "Enable BGP AS Path Auto-Translation", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/CommonCommonDefs_oneOfOnBooleanDefaultFalseOptionsDef" }, "siteTypes": { "description": "Site Types for 20.12 backward compatiblity", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "array", "uniqueItems": true, "minItems": 1, "maxItems": 4, "items": { "type": "string", "enum": [ "type-1", "type-2", "type-3", "cloud", "branch", "br", "spoke" ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPutRequest_siteTypeEnumDef" }, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPutRequest_siteTypeListDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPutRequest_oneOfSiteTypesOptionsDef" } }, "required": [ "gracefulRestart", "overlayAs", "sendPathLimit", "ecmpLimit", "shutdown", "ompAdminDistanceIpv4", "ompAdminDistanceIpv6", "advertisementInterval", "gracefulRestartTimer", "eorTimer", "holdtime", "advertiseIpv4", "advertiseIpv6" ], "additionalProperties": false } }, "required": [ "name", "data" ], "x-metadata": { "supportedDeviceTypes": [ "asr", "c1100", "c8000be", "csr1000v", "ir8100", "ir8340", "isr", "ISRv", "ir1101" ], "minVManageVersion": "20.18" }, "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPutRequest_SchemaPayload" } }, "$$ref": "#/components/schemas/getSingleSdwanSystemOmpPayload" }, "examples": { "get response example": { "value": { "parcelId": "09fc54fe-ff36-4640-ae57-c9e71a103902", "parcelType": "omp", "createdBy": "admin", "lastUpdatedBy": "admin", "createdOn": 1701866357838, "lastUpdatedOn": 1701866357838, "payload": { "data": { "gracefulRestart": { "optionType": "global", "value": true }, "overlayAs": { "optionType": "global", "value": 10 }, "sendPathLimit": { "optionType": "global", "value": 4 }, "ecmpLimit": { "optionType": "global", "value": 4 }, "shutdown": { "optionType": "global", "value": false }, "ompAdminDistanceIpv4": { "optionType": "global", "value": 10 }, "ompAdminDistanceIpv6": { "optionType": "global", "value": 20 }, "advertisementInterval": { "optionType": "global", "value": 1 }, "gracefulRestartTimer": { "optionType": "global", "value": 43200 }, "eorTimer": { "optionType": "global", "value": 300 }, "holdtime": { "optionType": "global", "value": 300 }, "advertiseIpv4": { "bgp": { "optionType": "global", "value": true }, "ospf": { "optionType": "global", "value": true }, "ospfv3": { "optionType": "global", "value": true }, "connected": { "optionType": "global", "value": true }, "static": { "optionType": "global", "value": true }, "eigrp": { "optionType": "global", "value": true }, "lisp": { "optionType": "global", "value": true }, "isis": { "optionType": "global", "value": true } }, "advertiseIpv6": { "bgp": { "optionType": "global", "value": true }, "ospf": { "optionType": "global", "value": true }, "connected": { "optionType": "global", "value": true }, "static": { "optionType": "global", "value": true }, "eigrp": { "optionType": "global", "value": true }, "lisp": { "optionType": "global", "value": true }, "isis": { "optionType": "global", "value": true } } } } }, "$$ref": "#/components/examples/getSingleSdwanSystemOmpExample" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Feature Profile > System > Omp-read" }, "put": { "tags": [ "Configuration - Feature Profile (SDWAN)" ], "description": "Update a Omp Profile Parcel for System feature profile", "operationId": "EditOmpProfileParcelForSystem", "parameters": [ { "name": "systemId", "in": "path", "description": "Feature 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" } }, { "name": "ompId", "in": "path", "description": "Profile Parcel 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": "Omp Profile Parcel", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[^&<>! \"]+$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_cgFpPpNameDef", "description": "Set the parcel name" }, "description": { "description": "Set the parcel description", "type": "string" }, "data": { "if": { "properties": { "siteTypesForTransportGateway": { "properties": { "optionType": { "const": "default" } } } } }, "else": { "not": { "properties": { "transportGateway": { "properties": { "optionType": { "const": "default" } } } } } }, "type": "object", "properties": { "gracefulRestart": { "description": "Graceful Restart for OMP", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ true ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanTrueDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPutRequest_oneOfGracefulRestartOptionsDef" }, "overlayAs": { "description": "Overlay AS Number", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "maximum": 4294967295, "minimum": 1, "type": "number", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPutRequest_overlayAsDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPutRequest_oneOfOverlayAsOptionsDef" }, "sendPathLimit": { "description": "Number of Paths Advertised per Prefix", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 4, "maximum": 16, "minimum": 1, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPutRequest_sendPathLimitDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "minimum": 4, "maximum": 4 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPutRequest_oneOfSendPathLimitOptionsDef" }, "ecmpLimit": { "description": "Set maximum number of OMP paths to install in cEdge route table", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 4, "maximum": 16, "minimum": 1, "type": "number", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPutRequest_ecmpLimitDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "minimum": 4, "maximum": 4 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPutRequest_oneOfEcmpLimitOptionsDef" }, "shutdown": { "description": "Shutdown", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPutRequest_oneOfShutdownOptionsDef" }, "ompAdminDistanceIpv4": { "description": "OMP Admin Distance IPv4", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "maximum": 255, "minimum": 1, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPutRequest_adminDistanceDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "default": 251, "maximum": 251, "minimum": 251, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPutRequest_defaultAdminDistanceDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPutRequest_oneOfOmpAdminDistanceIpv4OptionsDef" }, "ompAdminDistanceIpv6": { "description": "OMP Admin Distance IPv6", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "maximum": 255, "minimum": 1, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPutRequest_adminDistanceDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "default": 251, "maximum": 251, "minimum": 251, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPutRequest_defaultAdminDistanceDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPutRequest_oneOfOmpAdminDistanceIpv6OptionsDef" }, "advertisementInterval": { "description": "Advertisement Interval (seconds)", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 1, "maximum": 65535, "minimum": 0, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPutRequest_advertisementIntervalDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "minimum": 1, "maximum": 1 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPutRequest_oneOfAdvertisementIntervalOptionsDef" }, "gracefulRestartTimer": { "description": "Graceful Restart Timer (seconds)", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 43200, "maximum": 31556952, "minimum": 1, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPutRequest_gracefulRestartTimerDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "minimum": 43200, "maximum": 43200 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPutRequest_oneOfGracefulRestartTimerOptionsDef" }, "eorTimer": { "description": "EOR Timer", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 300, "maximum": 3600, "minimum": 1, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPutRequest_eorTimerDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "minimum": 300, "maximum": 300 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPutRequest_oneOfEorTimerOptionsDef" }, "holdtime": { "description": "Hold Time (seconds)", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "anyOf": [ { "default": 0, "minimum": 0, "maximum": 0, "type": "integer" }, { "default": 300, "minimum": 3, "maximum": 65535, "type": "integer" }, { "default": 5400, "minimum": 3, "maximum": 65535, "type": "integer" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPutRequest_holdtimeDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "enum": [ 60, 300, 5400 ], "default": 300 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPutRequest_oneOfHoldtimeOptionsDef" }, "advertiseIpv4": { "type": "object", "properties": { "bgp": { "description": "BGP", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPutRequest_oneOfAdvertiseProtocolOptionsDef" }, "ospf": { "description": "OSPF", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPutRequest_oneOfAdvertiseProtocolOptionsDef" }, "ospfv3": { "description": "OSPFV3", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPutRequest_oneOfAdvertiseProtocolOptionsDef" }, "connected": { "description": "Connected", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ true, false ], "default": true, "description": "use enum for backward compatibility, use default for UI to display default value", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPutRequest_defaultAdvertiseConnectedDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPutRequest_oneOfAdvertiseConnectedOptionsDef" }, "static": { "description": "Static", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ true, false ], "default": true, "description": "use enum for backward compatibility, use default for UI to display default value", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPutRequest_defaultAdvertiseStaticDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPutRequest_oneOfAdvertiseStaticOptionsDef" }, "eigrp": { "description": "EIGRP", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPutRequest_oneOfAdvertiseProtocolOptionsDef" }, "lisp": { "description": "LISP", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPutRequest_oneOfAdvertiseProtocolOptionsDef" }, "isis": { "description": "ISIS", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPutRequest_oneOfAdvertiseProtocolOptionsDef" } }, "required": [ "bgp", "ospf", "ospfv3", "connected", "static", "eigrp", "lisp", "isis" ], "additionalProperties": false }, "advertiseIpv6": { "type": "object", "properties": { "bgp": { "description": "BGP", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPutRequest_oneOfAdvertiseProtocolOptionsDef" }, "ospf": { "description": "OSPF", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPutRequest_oneOfAdvertiseProtocolOptionsDef" }, "connected": { "description": "Connected", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ true, false ], "default": true, "description": "use enum for backward compatibility, use default for UI to display default value", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPutRequest_defaultAdvertiseConnectedDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPutRequest_oneOfAdvertiseConnectedOptionsDef" }, "static": { "description": "Static", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ true, false ], "default": true, "description": "use enum for backward compatibility, use default for UI to display default value", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPutRequest_defaultAdvertiseStaticDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPutRequest_oneOfAdvertiseStaticOptionsDef" }, "eigrp": { "description": "EIGRP", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPutRequest_oneOfAdvertiseProtocolOptionsDef" }, "lisp": { "description": "LISP", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPutRequest_oneOfAdvertiseProtocolOptionsDef" }, "isis": { "description": "ISIS", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPutRequest_oneOfAdvertiseProtocolOptionsDef" } }, "required": [ "bgp", "ospf", "connected", "static", "eigrp", "lisp", "isis" ], "additionalProperties": false }, "ignoreRegionPathLength": { "description": "Treat hierarchical and direct (secondary region) paths equally", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPutRequest_oneOfIgnoreRegionPathLengthOptionsDef" }, "transportGateway": { "description": "Transport Gateway Path Behavior", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "enum": [ "prefer", "ecmp-with-direct-path" ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPutRequest_transportGatewayEnumDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPutRequest_oneOfTransportGatewayOptionsDef" }, "siteTypesForTransportGateway": { "description": "Site Types", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "array", "uniqueItems": true, "minItems": 1, "maxItems": 4, "items": { "type": "string", "enum": [ "type-1", "type-2", "type-3", "cloud", "branch", "br", "spoke" ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPutRequest_siteTypeEnumDef" }, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPutRequest_siteTypeListDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPutRequest_oneOfSiteTypesOptionsDef" }, "aspathAutoTranslation": { "description": "Enable BGP AS Path Auto-Translation", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/CommonCommonDefs_oneOfOnBooleanDefaultFalseOptionsDef" }, "siteTypes": { "description": "Site Types for 20.12 backward compatiblity", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "array", "uniqueItems": true, "minItems": 1, "maxItems": 4, "items": { "type": "string", "enum": [ "type-1", "type-2", "type-3", "cloud", "branch", "br", "spoke" ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPutRequest_siteTypeEnumDef" }, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPutRequest_siteTypeListDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPutRequest_oneOfSiteTypesOptionsDef" } }, "required": [ "gracefulRestart", "overlayAs", "sendPathLimit", "ecmpLimit", "shutdown", "ompAdminDistanceIpv4", "ompAdminDistanceIpv6", "advertisementInterval", "gracefulRestartTimer", "eorTimer", "holdtime", "advertiseIpv4", "advertiseIpv6" ], "additionalProperties": false } }, "required": [ "name", "data" ], "x-metadata": { "supportedDeviceTypes": [ "asr", "c1100", "c8000be", "csr1000v", "ir8100", "ir8340", "isr", "ISRv", "ir1101" ], "minVManageVersion": "20.18" }, "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemOmpPutRequest_SchemaPayload" }, "examples": { "Cedge_CG1_System_omp_parcel1": { "value": { "data": { "gracefulRestart": { "optionType": "global", "value": true }, "overlayAs": { "optionType": "global", "value": 10 }, "sendPathLimit": { "optionType": "global", "value": 4 }, "ecmpLimit": { "optionType": "global", "value": 4 }, "shutdown": { "optionType": "global", "value": false }, "ompAdminDistanceIpv4": { "optionType": "global", "value": 10 }, "ompAdminDistanceIpv6": { "optionType": "global", "value": 20 }, "advertisementInterval": { "optionType": "global", "value": 1 }, "gracefulRestartTimer": { "optionType": "global", "value": 43200 }, "eorTimer": { "optionType": "global", "value": 300 }, "holdtime": { "optionType": "global", "value": 300 }, "advertiseIpv4": { "bgp": { "optionType": "global", "value": true }, "ospf": { "optionType": "global", "value": true }, "ospfv3": { "optionType": "global", "value": true }, "connected": { "optionType": "global", "value": true }, "static": { "optionType": "global", "value": true }, "eigrp": { "optionType": "global", "value": true }, "lisp": { "optionType": "global", "value": true }, "isis": { "optionType": "global", "value": true } }, "advertiseIpv6": { "bgp": { "optionType": "global", "value": true }, "ospf": { "optionType": "global", "value": true }, "connected": { "optionType": "global", "value": true }, "static": { "optionType": "global", "value": true }, "eigrp": { "optionType": "global", "value": true }, "lisp": { "optionType": "global", "value": true }, "isis": { "optionType": "global", "value": true } } }, "description": "Cedge System OMP Parcel config", "name": "Cedge_CG1_System_omp_parcel1" }, "$$ref": "#/components/examples/ProfileparcelSdwanSystemOmpPutRequest_Cedge_CG1_System_omp_parcel1" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "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}" } }, "required": [ "id" ], "x-metadata": { "minVManageVersion": "20.15.1" }, "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelCommonPutResponse_SchemaPayload" }, "examples": { "example_1": { "value": { "id": "24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A" }, "$$ref": "#/components/examples/ProfileparcelCommonPutResponse_example_1" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Feature Profile > System > Omp-write" } }, "/v1/feature-profile/sdwan/system/{systemId}/security": { "get": { "tags": [ "Configuration - Feature Profile (SDWAN)" ], "description": "Get Security for System feature profile", "operationId": "GetSecurityForSystem", "parameters": [ { "name": "systemId", "in": "path", "description": "Feature 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", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "parcelId": { "type": "string", "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}", "$$ref": "#/components/schemas/CommonCommonDefs_uuidDef" }, "parcelType": { "type": "string" }, "createdBy": { "type": "string", "description": "User who last created this.", "readOnly": true }, "createdOn": { "type": "integer", "description": "Timestamp of creation", "format": "int64", "readOnly": true }, "lastUpdatedBy": { "type": "string", "description": "User who last updated this.", "readOnly": true }, "lastUpdatedOn": { "type": "integer", "description": "Timestamp of last update", "format": "int64", "readOnly": true }, "payload": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[^&<>! \"]+$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_cgFpPpNameDef" }, "description": { "type": "string" }, "data": { "type": "object", "properties": { "rekey": { "description": "Set how often to change the AES key for DTLS connections", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 86400, "minimum": 10, "maximum": 63113904, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_rekeyDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "minimum": 86400, "maximum": 86400, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_defaultRekeyDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_oneOfRekeyOptionsDef" }, "replayWindow": { "description": "Set the sliding replay window size", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": "512", "enum": [ "64", "128", "256", "512", "1024", "2048", "4096", "8192" ], "type": "string", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_replayWindowDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "string", "enum": [ "512" ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_defaultReplayWindowDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_oneOfReplayWindowOptionsDef" }, "extendedArWindow": { "description": "Extended Anti-Replay Window", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 256, "minimum": 10, "maximum": 2048, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_extendedArWindowDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "minimum": 256, "maximum": 256, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_defaultExtendedArWindowDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_oneOfExtendedArWindowOptionsDef" }, "integrityType": { "description": "Set the authentication type for DTLS connections", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "array", "uniqueItems": true, "minItems": 1, "maxItems": 4, "items": { "type": "string", "enum": [ "esp", "ip-udp-esp", "none", "ip-udp-esp-no-id" ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_integrityTypeDef" }, "default": [ "ip-udp-esp", "esp" ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_integrityTypeListDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_oneOfIntegrityTypeOptionsDef" }, "pairwiseKeying": { "description": "Enable or disable IPsec pairwise-keying", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/CommonCommonDefs_oneOfOnBooleanDefaultFalseOptionsDef" }, "keychain": { "description": "Configure a Keychain", "type": "array", "uniqueItems": true, "items": { "type": "object", "properties": { "name": { "description": "Specify the name of the Keychain", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "maxLength": 236, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_keychainNameDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_oneOfKeychainNameOptionsDef" }, "id": { "description": "Specify the Key ID", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minimum": 0, "maximum": 2147483647, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_keychainKeyidDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_oneOfKeychainKeyidOptionsDef" } }, "required": [ "name", "id" ], "additionalProperties": false } }, "key": { "description": "Configure a Key", "type": "array", "uniqueItems": true, "items": { "type": "object", "properties": { "id": { "description": "Select the Key ID", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_keyIdDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_oneOfKeyIdOptionsDef" }, "name": { "description": "Select the chain name", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_keyChainNameDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_oneOfKeyChainNameOptionsDef" }, "sendId": { "description": "Specify the Send ID", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 0, "minimum": 0, "maximum": 255, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_keySendIdDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_oneOfKeySendIdOptionsDef" }, "recvId": { "description": "Specify the Receiver ID", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 0, "minimum": 0, "maximum": 255, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_keyRecvIdDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_oneOfKeyRecvIdOptionsDef" }, "includeTcpOptions": { "description": "Configure Include TCP Options", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/CommonCommonDefs_oneOfOnBooleanDefaultFalseOptionsDef" }, "acceptAoMismatch": { "description": "Configure Accept AO Mismatch", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/CommonCommonDefs_oneOfOnBooleanDefaultFalseOptionsDef" }, "tcp": { "description": "Crypto Algorithm", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "enum": [ "aes-128-cmac", "hmac-sha-1", "hmac-sha-256" ], "type": "string", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_keyTcpDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_oneOfKeyTcpOptionsDef" }, "keyString": { "description": "Specify the Key String [Note: Catalyst SD-WAN Manager will encrypt this field before saving. Cleartext strings will not be returned back to the user in GET responses for sensitive fields.]", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minLength": 1, "type": "string", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_keyStringDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_oneOfKeyStringOptionsDef" }, "sendLifetime": { "description": "Send Lifetime Settings", "type": "object", "properties": { "local": { "description": "Configure Send lifetime Local", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/CommonCommonDefs_oneOfOnBooleanDefaultFalseOptionsDef" }, "startEpoch": { "description": "Configure Key lifetime start time", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "number", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_keyStartEpochDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_oneOfKeyStartEpochOptionsDef" }, "oneOfendChoice": { "oneOf": [ { "type": "object", "properties": { "infinite": { "description": "Infinite lifetime", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ true ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanTrueDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/CommonCommonDefs_oneOfOnBooleanDefaultTrueOptionsDef" } }, "required": [ "infinite" ], "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_oneOfInfiniteOptionsDef" }, { "type": "object", "properties": { "duration": { "description": "Send lifetime Duration (seconds)", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minimum": 1, "maximum": 2147483646, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_keyDurationDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_oneOfKeyDurationOptionsDef" } }, "required": [ "duration" ], "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_oneOfDurationOptionsDef" }, { "type": "object", "properties": { "exact": { "description": "Configure Key lifetime end time", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "number", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_keyEndEpochDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_oneOfKeyEndEpochOptionsDef" } }, "required": [ "exact" ], "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_oneOfExactOptionsDef" } ] } }, "required": [ "startEpoch" ], "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_lifetimeSettings" }, "acceptLifetime": { "description": "Accept Lifetime Settings", "type": "object", "properties": { "local": { "description": "Configure Send lifetime Local", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/CommonCommonDefs_oneOfOnBooleanDefaultFalseOptionsDef" }, "startEpoch": { "description": "Configure Key lifetime start time", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "number", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_keyStartEpochDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_oneOfKeyStartEpochOptionsDef" }, "oneOfendChoice": { "oneOf": [ { "type": "object", "properties": { "infinite": { "description": "Infinite lifetime", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ true ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanTrueDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/CommonCommonDefs_oneOfOnBooleanDefaultTrueOptionsDef" } }, "required": [ "infinite" ], "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_oneOfInfiniteOptionsDef" }, { "type": "object", "properties": { "duration": { "description": "Send lifetime Duration (seconds)", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minimum": 1, "maximum": 2147483646, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_keyDurationDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_oneOfKeyDurationOptionsDef" } }, "required": [ "duration" ], "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_oneOfDurationOptionsDef" }, { "type": "object", "properties": { "exact": { "description": "Configure Key lifetime end time", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "number", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_keyEndEpochDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_oneOfKeyEndEpochOptionsDef" } }, "required": [ "exact" ], "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_oneOfExactOptionsDef" } ] } }, "required": [ "startEpoch" ], "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_lifetimeSettings" } }, "required": [ "id", "name", "keyString", "sendId", "recvId", "tcp" ], "additionalProperties": false } } }, "required": [], "additionalProperties": false } }, "required": [ "data", "name" ], "x-metadata": { "minVManageVersion": "20.15.1" }, "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_SchemaPayload" } } } } }, "$$ref": "#/components/schemas/getListSdwanSystemSecurityPayload" }, "examples": { "get response example": { "value": { "header": { "generatedOn": 1702438718825 }, "data": [ { "parcelId": "09fc54fe-ff36-4640-ae57-c9e71a103902", "parcelType": "security", "createdBy": "admin", "lastUpdatedBy": "admin", "createdOn": 1701866357838, "lastUpdatedOn": 1701866357838, "payload": { "data": { "rekey": { "optionType": "default", "value": 86400 }, "replayWindow": { "optionType": "default", "value": "512" }, "extendedArWindow": { "optionType": "default", "value": 256 }, "integrityType": { "optionType": "global", "value": [ "esp", "ip-udp-esp", "ip-udp-esp-no-id" ] }, "pairwiseKeying": { "optionType": "default", "value": false }, "keychain": [ { "name": { "optionType": "global", "value": "aaa" }, "keyid": { "optionType": "global", "value": 1 } } ], "key": [ { "id": { "optionType": "global", "value": 0 }, "name": { "optionType": "global", "value": "aaa" }, "sendId": { "optionType": "global", "value": 1 }, "recvId": { "optionType": "global", "value": 2 }, "includeTcpOptions": { "optionType": "global", "value": false }, "acceptAoMismatch": { "optionType": "global", "value": false }, "tcp": { "optionType": "global", "value": "aes-128-cmac" }, "keyString": { "optionType": "global", "value": "abcabc" }, "sendLifetime": { "local": { "optionType": "global", "value": true }, "startEpoch": { "optionType": "global", "value": 1659284400 }, "oneOfendChoice": { "infinite": { "optionType": "global", "value": true } } }, "acceptLifetime": { "local": { "optionType": "global", "value": false }, "startEpoch": { "optionType": "global", "value": 1659284401 }, "oneOfendChoice": { "duration": { "optionType": "global", "value": 100000 } } } } ] } } } ] }, "$$ref": "#/components/examples/getListSdwanSystemSecurityExample" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Feature Profile > System > Security-read" }, "post": { "tags": [ "Configuration - Feature Profile (SDWAN)" ], "description": "Create Security for System feature profile", "operationId": "CreateSecurityForSystem", "parameters": [ { "name": "systemId", "in": "path", "description": "Feature 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": "Security Feature", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[^&<>! \"]+$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_cgFpPpNameDef" }, "description": { "type": "string" }, "data": { "type": "object", "properties": { "rekey": { "description": "Set how often to change the AES key for DTLS connections", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 86400, "minimum": 10, "maximum": 63113904, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_rekeyDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "minimum": 86400, "maximum": 86400, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_defaultRekeyDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_oneOfRekeyOptionsDef" }, "replayWindow": { "description": "Set the sliding replay window size", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": "512", "enum": [ "64", "128", "256", "512", "1024", "2048", "4096", "8192" ], "type": "string", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_replayWindowDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "string", "enum": [ "512" ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_defaultReplayWindowDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_oneOfReplayWindowOptionsDef" }, "extendedArWindow": { "description": "Extended Anti-Replay Window", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 256, "minimum": 10, "maximum": 2048, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_extendedArWindowDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "minimum": 256, "maximum": 256, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_defaultExtendedArWindowDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_oneOfExtendedArWindowOptionsDef" }, "integrityType": { "description": "Set the authentication type for DTLS connections", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "array", "uniqueItems": true, "minItems": 1, "maxItems": 4, "items": { "type": "string", "enum": [ "esp", "ip-udp-esp", "none", "ip-udp-esp-no-id" ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_integrityTypeDef" }, "default": [ "ip-udp-esp", "esp" ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_integrityTypeListDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_oneOfIntegrityTypeOptionsDef" }, "pairwiseKeying": { "description": "Enable or disable IPsec pairwise-keying", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/CommonCommonDefs_oneOfOnBooleanDefaultFalseOptionsDef" }, "keychain": { "description": "Configure a Keychain", "type": "array", "uniqueItems": true, "items": { "type": "object", "properties": { "name": { "description": "Specify the name of the Keychain", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "maxLength": 236, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_keychainNameDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_oneOfKeychainNameOptionsDef" }, "id": { "description": "Specify the Key ID", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minimum": 0, "maximum": 2147483647, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_keychainKeyidDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_oneOfKeychainKeyidOptionsDef" } }, "required": [ "name", "id" ], "additionalProperties": false } }, "key": { "description": "Configure a Key", "type": "array", "uniqueItems": true, "items": { "type": "object", "properties": { "id": { "description": "Select the Key ID", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_keyIdDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_oneOfKeyIdOptionsDef" }, "name": { "description": "Select the chain name", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_keyChainNameDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_oneOfKeyChainNameOptionsDef" }, "sendId": { "description": "Specify the Send ID", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 0, "minimum": 0, "maximum": 255, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_keySendIdDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_oneOfKeySendIdOptionsDef" }, "recvId": { "description": "Specify the Receiver ID", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 0, "minimum": 0, "maximum": 255, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_keyRecvIdDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_oneOfKeyRecvIdOptionsDef" }, "includeTcpOptions": { "description": "Configure Include TCP Options", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/CommonCommonDefs_oneOfOnBooleanDefaultFalseOptionsDef" }, "acceptAoMismatch": { "description": "Configure Accept AO Mismatch", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/CommonCommonDefs_oneOfOnBooleanDefaultFalseOptionsDef" }, "tcp": { "description": "Crypto Algorithm", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "enum": [ "aes-128-cmac", "hmac-sha-1", "hmac-sha-256" ], "type": "string", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_keyTcpDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_oneOfKeyTcpOptionsDef" }, "keyString": { "description": "Specify the Key String [Note: Catalyst SD-WAN Manager will encrypt this field before saving. Cleartext strings will not be returned back to the user in GET responses for sensitive fields.]", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minLength": 1, "type": "string", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_keyStringDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_oneOfKeyStringOptionsDef" }, "sendLifetime": { "description": "Send Lifetime Settings", "type": "object", "properties": { "local": { "description": "Configure Send lifetime Local", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/CommonCommonDefs_oneOfOnBooleanDefaultFalseOptionsDef" }, "startEpoch": { "description": "Configure Key lifetime start time", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "number", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_keyStartEpochDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_oneOfKeyStartEpochOptionsDef" }, "oneOfendChoice": { "oneOf": [ { "type": "object", "properties": { "infinite": { "description": "Infinite lifetime", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ true ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanTrueDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/CommonCommonDefs_oneOfOnBooleanDefaultTrueOptionsDef" } }, "required": [ "infinite" ], "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_oneOfInfiniteOptionsDef" }, { "type": "object", "properties": { "duration": { "description": "Send lifetime Duration (seconds)", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minimum": 1, "maximum": 2147483646, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_keyDurationDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_oneOfKeyDurationOptionsDef" } }, "required": [ "duration" ], "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_oneOfDurationOptionsDef" }, { "type": "object", "properties": { "exact": { "description": "Configure Key lifetime end time", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "number", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_keyEndEpochDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_oneOfKeyEndEpochOptionsDef" } }, "required": [ "exact" ], "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_oneOfExactOptionsDef" } ] } }, "required": [ "startEpoch" ], "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_lifetimeSettings" }, "acceptLifetime": { "description": "Accept Lifetime Settings", "type": "object", "properties": { "local": { "description": "Configure Send lifetime Local", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/CommonCommonDefs_oneOfOnBooleanDefaultFalseOptionsDef" }, "startEpoch": { "description": "Configure Key lifetime start time", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "number", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_keyStartEpochDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_oneOfKeyStartEpochOptionsDef" }, "oneOfendChoice": { "oneOf": [ { "type": "object", "properties": { "infinite": { "description": "Infinite lifetime", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ true ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanTrueDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/CommonCommonDefs_oneOfOnBooleanDefaultTrueOptionsDef" } }, "required": [ "infinite" ], "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_oneOfInfiniteOptionsDef" }, { "type": "object", "properties": { "duration": { "description": "Send lifetime Duration (seconds)", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minimum": 1, "maximum": 2147483646, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_keyDurationDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_oneOfKeyDurationOptionsDef" } }, "required": [ "duration" ], "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_oneOfDurationOptionsDef" }, { "type": "object", "properties": { "exact": { "description": "Configure Key lifetime end time", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "number", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_keyEndEpochDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_oneOfKeyEndEpochOptionsDef" } }, "required": [ "exact" ], "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_oneOfExactOptionsDef" } ] } }, "required": [ "startEpoch" ], "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_lifetimeSettings" } }, "required": [ "id", "name", "keyString", "sendId", "recvId", "tcp" ], "additionalProperties": false } } }, "required": [], "additionalProperties": false } }, "required": [ "data", "name" ], "x-metadata": { "minVManageVersion": "20.15.1" }, "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_SchemaPayload" }, "examples": { "Security": { "value": { "data": { "rekey": { "optionType": "default", "value": 86400 }, "replayWindow": { "optionType": "default", "value": "512" }, "extendedArWindow": { "optionType": "default", "value": 256 }, "integrityType": { "optionType": "global", "value": [ "esp", "ip-udp-esp", "ip-udp-esp-no-id" ] }, "pairwiseKeying": { "optionType": "default", "value": false }, "keychain": [ { "name": { "optionType": "global", "value": "aaa" }, "keyid": { "optionType": "global", "value": 1 } } ], "key": [ { "id": { "optionType": "global", "value": 0 }, "name": { "optionType": "global", "value": "aaa" }, "sendId": { "optionType": "global", "value": 1 }, "recvId": { "optionType": "global", "value": 2 }, "includeTcpOptions": { "optionType": "global", "value": false }, "acceptAoMismatch": { "optionType": "global", "value": false }, "tcp": { "optionType": "global", "value": "aes-128-cmac" }, "keyString": { "optionType": "global", "value": "abcabc" }, "sendLifetime": { "local": { "optionType": "global", "value": true }, "startEpoch": { "optionType": "global", "value": 1659284400 }, "oneOfendChoice": { "infinite": { "optionType": "global", "value": true } } }, "acceptLifetime": { "local": { "optionType": "global", "value": false }, "startEpoch": { "optionType": "global", "value": 1659284401 }, "oneOfendChoice": { "duration": { "optionType": "global", "value": 100000 } } } } ] }, "name": "Security" }, "$$ref": "#/components/examples/ProfileparcelSdwanSystemSecurityCommonRequest_Security" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "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}" } }, "required": [ "id" ], "x-metadata": { "minVManageVersion": "20.15.1" }, "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelCommonPostResponse_SchemaPayload" }, "examples": { "example_1": { "value": { "id": "24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A" }, "$$ref": "#/components/examples/ProfileparcelCommonPostResponse_example_1" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Feature Profile > System > Security-write" } }, "/v1/feature-profile/sdwan/system/{systemId}/security/{securityId}": { "get": { "tags": [ "Configuration - Feature Profile (SDWAN)" ], "description": "Get Security by securityId for System feature profile", "operationId": "GetSecurityBySecurityIdForSystem", "parameters": [ { "name": "systemId", "in": "path", "description": "Feature 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" } }, { "name": "securityId", "in": "path", "description": "Security 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", "properties": { "parcelId": { "type": "string", "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}", "$$ref": "#/components/schemas/CommonCommonDefs_uuidDef" }, "parcelType": { "type": "string" }, "createdBy": { "type": "string", "description": "User who last created this.", "readOnly": true }, "createdOn": { "type": "integer", "description": "Timestamp of creation", "format": "int64", "readOnly": true }, "lastUpdatedBy": { "type": "string", "description": "User who last updated this.", "readOnly": true }, "lastUpdatedOn": { "type": "integer", "description": "Timestamp of last update", "format": "int64", "readOnly": true }, "payload": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[^&<>! \"]+$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_cgFpPpNameDef" }, "description": { "type": "string" }, "data": { "type": "object", "properties": { "rekey": { "description": "Set how often to change the AES key for DTLS connections", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 86400, "minimum": 10, "maximum": 63113904, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_rekeyDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "minimum": 86400, "maximum": 86400, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_defaultRekeyDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_oneOfRekeyOptionsDef" }, "replayWindow": { "description": "Set the sliding replay window size", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": "512", "enum": [ "64", "128", "256", "512", "1024", "2048", "4096", "8192" ], "type": "string", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_replayWindowDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "string", "enum": [ "512" ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_defaultReplayWindowDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_oneOfReplayWindowOptionsDef" }, "extendedArWindow": { "description": "Extended Anti-Replay Window", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 256, "minimum": 10, "maximum": 2048, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_extendedArWindowDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "minimum": 256, "maximum": 256, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_defaultExtendedArWindowDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_oneOfExtendedArWindowOptionsDef" }, "integrityType": { "description": "Set the authentication type for DTLS connections", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "array", "uniqueItems": true, "minItems": 1, "maxItems": 4, "items": { "type": "string", "enum": [ "esp", "ip-udp-esp", "none", "ip-udp-esp-no-id" ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_integrityTypeDef" }, "default": [ "ip-udp-esp", "esp" ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_integrityTypeListDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_oneOfIntegrityTypeOptionsDef" }, "pairwiseKeying": { "description": "Enable or disable IPsec pairwise-keying", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/CommonCommonDefs_oneOfOnBooleanDefaultFalseOptionsDef" }, "keychain": { "description": "Configure a Keychain", "type": "array", "uniqueItems": true, "items": { "type": "object", "properties": { "name": { "description": "Specify the name of the Keychain", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "maxLength": 236, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_keychainNameDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_oneOfKeychainNameOptionsDef" }, "id": { "description": "Specify the Key ID", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minimum": 0, "maximum": 2147483647, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_keychainKeyidDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_oneOfKeychainKeyidOptionsDef" } }, "required": [ "name", "id" ], "additionalProperties": false } }, "key": { "description": "Configure a Key", "type": "array", "uniqueItems": true, "items": { "type": "object", "properties": { "id": { "description": "Select the Key ID", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_keyIdDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_oneOfKeyIdOptionsDef" }, "name": { "description": "Select the chain name", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_keyChainNameDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_oneOfKeyChainNameOptionsDef" }, "sendId": { "description": "Specify the Send ID", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 0, "minimum": 0, "maximum": 255, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_keySendIdDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_oneOfKeySendIdOptionsDef" }, "recvId": { "description": "Specify the Receiver ID", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 0, "minimum": 0, "maximum": 255, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_keyRecvIdDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_oneOfKeyRecvIdOptionsDef" }, "includeTcpOptions": { "description": "Configure Include TCP Options", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/CommonCommonDefs_oneOfOnBooleanDefaultFalseOptionsDef" }, "acceptAoMismatch": { "description": "Configure Accept AO Mismatch", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/CommonCommonDefs_oneOfOnBooleanDefaultFalseOptionsDef" }, "tcp": { "description": "Crypto Algorithm", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "enum": [ "aes-128-cmac", "hmac-sha-1", "hmac-sha-256" ], "type": "string", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_keyTcpDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_oneOfKeyTcpOptionsDef" }, "keyString": { "description": "Specify the Key String [Note: Catalyst SD-WAN Manager will encrypt this field before saving. Cleartext strings will not be returned back to the user in GET responses for sensitive fields.]", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minLength": 1, "type": "string", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_keyStringDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_oneOfKeyStringOptionsDef" }, "sendLifetime": { "description": "Send Lifetime Settings", "type": "object", "properties": { "local": { "description": "Configure Send lifetime Local", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/CommonCommonDefs_oneOfOnBooleanDefaultFalseOptionsDef" }, "startEpoch": { "description": "Configure Key lifetime start time", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "number", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_keyStartEpochDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_oneOfKeyStartEpochOptionsDef" }, "oneOfendChoice": { "oneOf": [ { "type": "object", "properties": { "infinite": { "description": "Infinite lifetime", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ true ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanTrueDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/CommonCommonDefs_oneOfOnBooleanDefaultTrueOptionsDef" } }, "required": [ "infinite" ], "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_oneOfInfiniteOptionsDef" }, { "type": "object", "properties": { "duration": { "description": "Send lifetime Duration (seconds)", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minimum": 1, "maximum": 2147483646, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_keyDurationDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_oneOfKeyDurationOptionsDef" } }, "required": [ "duration" ], "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_oneOfDurationOptionsDef" }, { "type": "object", "properties": { "exact": { "description": "Configure Key lifetime end time", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "number", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_keyEndEpochDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_oneOfKeyEndEpochOptionsDef" } }, "required": [ "exact" ], "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_oneOfExactOptionsDef" } ] } }, "required": [ "startEpoch" ], "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_lifetimeSettings" }, "acceptLifetime": { "description": "Accept Lifetime Settings", "type": "object", "properties": { "local": { "description": "Configure Send lifetime Local", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/CommonCommonDefs_oneOfOnBooleanDefaultFalseOptionsDef" }, "startEpoch": { "description": "Configure Key lifetime start time", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "number", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_keyStartEpochDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_oneOfKeyStartEpochOptionsDef" }, "oneOfendChoice": { "oneOf": [ { "type": "object", "properties": { "infinite": { "description": "Infinite lifetime", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ true ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanTrueDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/CommonCommonDefs_oneOfOnBooleanDefaultTrueOptionsDef" } }, "required": [ "infinite" ], "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_oneOfInfiniteOptionsDef" }, { "type": "object", "properties": { "duration": { "description": "Send lifetime Duration (seconds)", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minimum": 1, "maximum": 2147483646, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_keyDurationDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_oneOfKeyDurationOptionsDef" } }, "required": [ "duration" ], "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_oneOfDurationOptionsDef" }, { "type": "object", "properties": { "exact": { "description": "Configure Key lifetime end time", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "number", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_keyEndEpochDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_oneOfKeyEndEpochOptionsDef" } }, "required": [ "exact" ], "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_oneOfExactOptionsDef" } ] } }, "required": [ "startEpoch" ], "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_lifetimeSettings" } }, "required": [ "id", "name", "keyString", "sendId", "recvId", "tcp" ], "additionalProperties": false } } }, "required": [], "additionalProperties": false } }, "required": [ "data", "name" ], "x-metadata": { "minVManageVersion": "20.15.1" }, "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_SchemaPayload" } }, "$$ref": "#/components/schemas/getSingleSdwanSystemSecurityPayload" }, "examples": { "get response example": { "value": { "parcelId": "09fc54fe-ff36-4640-ae57-c9e71a103902", "parcelType": "security", "createdBy": "admin", "lastUpdatedBy": "admin", "createdOn": 1701866357838, "lastUpdatedOn": 1701866357838, "payload": { "data": { "rekey": { "optionType": "default", "value": 86400 }, "replayWindow": { "optionType": "default", "value": "512" }, "extendedArWindow": { "optionType": "default", "value": 256 }, "integrityType": { "optionType": "global", "value": [ "esp", "ip-udp-esp", "ip-udp-esp-no-id" ] }, "pairwiseKeying": { "optionType": "default", "value": false }, "keychain": [ { "name": { "optionType": "global", "value": "aaa" }, "keyid": { "optionType": "global", "value": 1 } } ], "key": [ { "id": { "optionType": "global", "value": 0 }, "name": { "optionType": "global", "value": "aaa" }, "sendId": { "optionType": "global", "value": 1 }, "recvId": { "optionType": "global", "value": 2 }, "includeTcpOptions": { "optionType": "global", "value": false }, "acceptAoMismatch": { "optionType": "global", "value": false }, "tcp": { "optionType": "global", "value": "aes-128-cmac" }, "keyString": { "optionType": "global", "value": "abcabc" }, "sendLifetime": { "local": { "optionType": "global", "value": true }, "startEpoch": { "optionType": "global", "value": 1659284400 }, "oneOfendChoice": { "infinite": { "optionType": "global", "value": true } } }, "acceptLifetime": { "local": { "optionType": "global", "value": false }, "startEpoch": { "optionType": "global", "value": 1659284401 }, "oneOfendChoice": { "duration": { "optionType": "global", "value": 100000 } } } } ] } } }, "$$ref": "#/components/examples/getSingleSdwanSystemSecurityExample" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Feature Profile > System > Security-read" }, "delete": { "tags": [ "Configuration - Feature Profile (SDWAN)" ], "description": "Delete Security for System feature profile", "operationId": "DeleteSecurityForSystem", "parameters": [ { "name": "systemId", "in": "path", "description": "Feature 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" } }, { "name": "securityId", "in": "path", "description": "Security 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": "Feature Profile > System > Security-write" }, "put": { "tags": [ "Configuration - Feature Profile (SDWAN)" ], "description": "Update Security for System feature profile", "operationId": "EditSecurityForSystem", "parameters": [ { "name": "systemId", "in": "path", "description": "Feature 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" } }, { "name": "securityId", "in": "path", "description": "Security 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": "Security Feature", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[^&<>! \"]+$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_cgFpPpNameDef" }, "description": { "type": "string" }, "data": { "type": "object", "properties": { "rekey": { "description": "Set how often to change the AES key for DTLS connections", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 86400, "minimum": 10, "maximum": 63113904, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_rekeyDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "minimum": 86400, "maximum": 86400, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_defaultRekeyDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_oneOfRekeyOptionsDef" }, "replayWindow": { "description": "Set the sliding replay window size", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": "512", "enum": [ "64", "128", "256", "512", "1024", "2048", "4096", "8192" ], "type": "string", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_replayWindowDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "string", "enum": [ "512" ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_defaultReplayWindowDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_oneOfReplayWindowOptionsDef" }, "extendedArWindow": { "description": "Extended Anti-Replay Window", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 256, "minimum": 10, "maximum": 2048, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_extendedArWindowDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "integer", "minimum": 256, "maximum": 256, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_defaultExtendedArWindowDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_oneOfExtendedArWindowOptionsDef" }, "integrityType": { "description": "Set the authentication type for DTLS connections", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "array", "uniqueItems": true, "minItems": 1, "maxItems": 4, "items": { "type": "string", "enum": [ "esp", "ip-udp-esp", "none", "ip-udp-esp-no-id" ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_integrityTypeDef" }, "default": [ "ip-udp-esp", "esp" ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_integrityTypeListDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_oneOfIntegrityTypeOptionsDef" }, "pairwiseKeying": { "description": "Enable or disable IPsec pairwise-keying", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/CommonCommonDefs_oneOfOnBooleanDefaultFalseOptionsDef" }, "keychain": { "description": "Configure a Keychain", "type": "array", "uniqueItems": true, "items": { "type": "object", "properties": { "name": { "description": "Specify the name of the Keychain", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "maxLength": 236, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_keychainNameDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_oneOfKeychainNameOptionsDef" }, "id": { "description": "Specify the Key ID", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minimum": 0, "maximum": 2147483647, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_keychainKeyidDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_oneOfKeychainKeyidOptionsDef" } }, "required": [ "name", "id" ], "additionalProperties": false } }, "key": { "description": "Configure a Key", "type": "array", "uniqueItems": true, "items": { "type": "object", "properties": { "id": { "description": "Select the Key ID", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_keyIdDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_oneOfKeyIdOptionsDef" }, "name": { "description": "Select the chain name", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_keyChainNameDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_oneOfKeyChainNameOptionsDef" }, "sendId": { "description": "Specify the Send ID", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 0, "minimum": 0, "maximum": 255, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_keySendIdDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_oneOfKeySendIdOptionsDef" }, "recvId": { "description": "Specify the Receiver ID", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": 0, "minimum": 0, "maximum": 255, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_keyRecvIdDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_oneOfKeyRecvIdOptionsDef" }, "includeTcpOptions": { "description": "Configure Include TCP Options", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/CommonCommonDefs_oneOfOnBooleanDefaultFalseOptionsDef" }, "acceptAoMismatch": { "description": "Configure Accept AO Mismatch", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/CommonCommonDefs_oneOfOnBooleanDefaultFalseOptionsDef" }, "tcp": { "description": "Crypto Algorithm", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "enum": [ "aes-128-cmac", "hmac-sha-1", "hmac-sha-256" ], "type": "string", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_keyTcpDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_oneOfKeyTcpOptionsDef" }, "keyString": { "description": "Specify the Key String [Note: Catalyst SD-WAN Manager will encrypt this field before saving. Cleartext strings will not be returned back to the user in GET responses for sensitive fields.]", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minLength": 1, "type": "string", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_keyStringDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_oneOfKeyStringOptionsDef" }, "sendLifetime": { "description": "Send Lifetime Settings", "type": "object", "properties": { "local": { "description": "Configure Send lifetime Local", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/CommonCommonDefs_oneOfOnBooleanDefaultFalseOptionsDef" }, "startEpoch": { "description": "Configure Key lifetime start time", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "number", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_keyStartEpochDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_oneOfKeyStartEpochOptionsDef" }, "oneOfendChoice": { "oneOf": [ { "type": "object", "properties": { "infinite": { "description": "Infinite lifetime", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ true ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanTrueDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/CommonCommonDefs_oneOfOnBooleanDefaultTrueOptionsDef" } }, "required": [ "infinite" ], "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_oneOfInfiniteOptionsDef" }, { "type": "object", "properties": { "duration": { "description": "Send lifetime Duration (seconds)", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minimum": 1, "maximum": 2147483646, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_keyDurationDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_oneOfKeyDurationOptionsDef" } }, "required": [ "duration" ], "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_oneOfDurationOptionsDef" }, { "type": "object", "properties": { "exact": { "description": "Configure Key lifetime end time", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "number", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_keyEndEpochDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_oneOfKeyEndEpochOptionsDef" } }, "required": [ "exact" ], "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_oneOfExactOptionsDef" } ] } }, "required": [ "startEpoch" ], "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_lifetimeSettings" }, "acceptLifetime": { "description": "Accept Lifetime Settings", "type": "object", "properties": { "local": { "description": "Configure Send lifetime Local", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/CommonCommonDefs_oneOfOnBooleanDefaultFalseOptionsDef" }, "startEpoch": { "description": "Configure Key lifetime start time", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "number", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_keyStartEpochDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_oneOfKeyStartEpochOptionsDef" }, "oneOfendChoice": { "oneOf": [ { "type": "object", "properties": { "infinite": { "description": "Infinite lifetime", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ true ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanTrueDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/CommonCommonDefs_oneOfOnBooleanDefaultTrueOptionsDef" } }, "required": [ "infinite" ], "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_oneOfInfiniteOptionsDef" }, { "type": "object", "properties": { "duration": { "description": "Send lifetime Duration (seconds)", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minimum": 1, "maximum": 2147483646, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_keyDurationDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_oneOfKeyDurationOptionsDef" } }, "required": [ "duration" ], "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_oneOfDurationOptionsDef" }, { "type": "object", "properties": { "exact": { "description": "Configure Key lifetime end time", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "number", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_keyEndEpochDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_oneOfKeyEndEpochOptionsDef" } }, "required": [ "exact" ], "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_oneOfExactOptionsDef" } ] } }, "required": [ "startEpoch" ], "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_lifetimeSettings" } }, "required": [ "id", "name", "keyString", "sendId", "recvId", "tcp" ], "additionalProperties": false } } }, "required": [], "additionalProperties": false } }, "required": [ "data", "name" ], "x-metadata": { "minVManageVersion": "20.15.1" }, "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSecurityCommonRequest_SchemaPayload" }, "examples": { "Security": { "value": { "data": { "rekey": { "optionType": "default", "value": 86400 }, "replayWindow": { "optionType": "default", "value": "512" }, "extendedArWindow": { "optionType": "default", "value": 256 }, "integrityType": { "optionType": "global", "value": [ "esp", "ip-udp-esp", "ip-udp-esp-no-id" ] }, "pairwiseKeying": { "optionType": "default", "value": false }, "keychain": [ { "name": { "optionType": "global", "value": "aaa" }, "keyid": { "optionType": "global", "value": 1 } } ], "key": [ { "id": { "optionType": "global", "value": 0 }, "name": { "optionType": "global", "value": "aaa" }, "sendId": { "optionType": "global", "value": 1 }, "recvId": { "optionType": "global", "value": 2 }, "includeTcpOptions": { "optionType": "global", "value": false }, "acceptAoMismatch": { "optionType": "global", "value": false }, "tcp": { "optionType": "global", "value": "aes-128-cmac" }, "keyString": { "optionType": "global", "value": "abcabc" }, "sendLifetime": { "local": { "optionType": "global", "value": true }, "startEpoch": { "optionType": "global", "value": 1659284400 }, "oneOfendChoice": { "infinite": { "optionType": "global", "value": true } } }, "acceptLifetime": { "local": { "optionType": "global", "value": false }, "startEpoch": { "optionType": "global", "value": 1659284401 }, "oneOfendChoice": { "duration": { "optionType": "global", "value": 100000 } } } } ] }, "name": "Security" }, "$$ref": "#/components/examples/ProfileparcelSdwanSystemSecurityCommonRequest_Security" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "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}" } }, "required": [ "id" ], "x-metadata": { "minVManageVersion": "20.15.1" }, "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelCommonPutResponse_SchemaPayload" }, "examples": { "example_1": { "value": { "id": "24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A" }, "$$ref": "#/components/examples/ProfileparcelCommonPutResponse_example_1" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Feature Profile > System > Security-write" } }, "/v1/feature-profile/sdwan/system/{systemId}/snmp": { "get": { "tags": [ "Configuration - Feature Profile (SDWAN)" ], "description": "Get Snmp Profile Parcels for System feature profile", "operationId": "GetSnmpProfileParcelForSystem", "parameters": [ { "name": "systemId", "in": "path", "description": "Feature 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", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "parcelId": { "type": "string", "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}", "$$ref": "#/components/schemas/CommonCommonDefs_uuidDef" }, "parcelType": { "type": "string" }, "createdBy": { "type": "string", "description": "User who last created this.", "readOnly": true }, "createdOn": { "type": "integer", "description": "Timestamp of creation", "format": "int64", "readOnly": true }, "lastUpdatedBy": { "type": "string", "description": "User who last updated this.", "readOnly": true }, "lastUpdatedOn": { "type": "integer", "description": "Timestamp of last update", "format": "int64", "readOnly": true }, "payload": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[^&<>! \"]+$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_cgFpPpNameDef" }, "description": { "type": "string" }, "data": { "type": "object", "properties": { "shutdown": { "description": "Enable or disable SNMP", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_oneOfShutdownOptionsDef" }, "contact": { "description": "Set the contact for this managed node", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minLength": 1, "type": "string", "maxLength": 255, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_contactDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionNoDefaultDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_oneOfContactOptionsDef" }, "location": { "description": "Set the physical location of this managed node", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minLength": 1, "type": "string", "maxLength": 255, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_locationDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionNoDefaultDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_oneOfLocationOptionsDef" }, "view": { "description": "Configure a view record", "type": "array", "uniqueItems": true, "items": { "type": "object", "properties": { "name": { "description": "Set the name of the SNMP view", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minLength": 1, "type": "string", "maxLength": 32, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_viewNameDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_oneOfViewNameOptionsDef" }, "oid": { "description": "Configure SNMP object identifier", "type": "array", "uniqueItems": true, "items": { "type": "object", "properties": { "id": { "description": "Configure identifier of subtree of MIB objects", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minLength": 1, "type": "string", "pattern": "^(([0-1](\\.[1-3]?[0-9]))|(2\\.(0|([1-9]\\d*))))(\\.(0|\\*|([1-9]\\d*))){0,126}$", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_viewOidIdDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_oneOfViewOidIdOptionsDef" }, "exclude": { "description": "Exclude the OID", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_oneOfViewOidExcludeOptionsDef" } }, "required": [ "id" ], "additionalProperties": false } } }, "required": [ "name" ], "additionalProperties": false } }, "community": { "description": "Configure SNMP community", "type": "array", "uniqueItems": true, "items": { "type": "object", "properties": { "name": { "description": "Set name of the SNMP community [Note: Catalyst SD-WAN Manager will encrypt this field before saving. Cleartext strings will not be returned back to the user in GET responses for sensitive fields.]", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minLength": 1, "pattern": "^[\\S]+$", "type": "string", "x-attributeMetadata": { "insecureConfiguration": { "attributeJsonPath": "$.data.community[*].name.value", "description": "SNMP v2c configured - legacy protocol poses data confidentiality and integrity risks due to lack of encryption and authentication", "reason": "Legacy protocol poses data confidentiality and integrity risks due to lack of encryption and authentication", "remediation": "Configure SNMP v3" } }, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_communityNameDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_oneOfCommunityNameOptionsDef" }, "userLabel": { "description": "Set user label of the SNMP community", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minLength": 1, "type": "string", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_targetCommunityNameUserLabelDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_oneOfTargetCommunityNameUserLabelOptionsDef" }, "view": { "description": "Set name of the SNMP view", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_communityViewDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_oneOfCommunityViewOptionsDef" }, "authorization": { "description": "Configure access permissions", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "enum": [ "read-only", "read-write" ], "type": "string", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_communityAuthorizationDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_oneOfCommunityAuthorizationOptionsDef" } }, "required": [ "name", "view" ], "additionalProperties": false } }, "group": { "description": "Configure an SNMP group", "type": "array", "uniqueItems": true, "items": { "type": "object", "properties": { "name": { "description": "Name of the SNMP group", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minLength": 1, "type": "string", "maxLength": 32, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_groupNameDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_oneOfGroupNameOptionsDef" }, "securityLevel": { "description": "Configure security level", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "enum": [ "no-auth-no-priv", "auth-no-priv", "auth-priv" ], "type": "string", "x-attributeMetadata": { "insecureConfiguration": { "attributeJsonPath": "$.data.group[*].securityLevel.value", "values": [ "no-auth-no-priv", "auth-no-priv" ], "description": "SNMPv3 configured with Auth/Noauth security level - data confidentiality and integrity cannot be ensured", "reason": "SNMPv3 with Auth/Noauth security level", "remediation": "Use SNMPv3 with Priv security level" } }, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_groupSecurityLevelDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_oneOfGroupSecurityLevelOptionsDef" }, "view": { "description": "Name of the SNMP view", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minLength": 1, "type": "string", "maxLength": 32, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_groupViewDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_oneOfGroupViewOptionsDef" } }, "required": [ "name", "securityLevel", "view" ], "additionalProperties": false } }, "user": { "description": "Configure an SNMP user", "type": "array", "uniqueItems": true, "items": { "type": "object", "properties": { "name": { "description": "Name of the SNMP user", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minLength": 1, "type": "string", "maxLength": 32, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_userNameDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_oneOfUserNameOptionsDef" }, "auth": { "description": "Configure authentication protocol", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "enum": [ "sha", "sha256" ], "type": "string", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_userAuthDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "x-attributeMetadata": { "insecureConfiguration": { "attributeJsonPath": "$.data.user[*].auth.optionType", "values": [ "default" ], "description": "SNMP user with Auth/Noauth security level is insecure", "reason": "SNMP User with Auth/Noauth security level", "remediation": "Use SNMP User with Priv security level" } } } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_oneOfUserAuthOptionsDef" }, "authPassword": { "description": "Specify authentication protocol password", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_userAuthPasswordDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "x-attributeMetadata": { "insecureConfiguration": { "attributeJsonPath": "$.data.user[*].authPassword.optionType", "values": [ "default" ], "description": "SNMP user with Auth/Noauth security level is insecure", "reason": "SNMP User with Auth/Noauth security level", "remediation": "Use SNMP User with Priv security level" } } } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_oneOfUserAuthPasswordOptionsDef" }, "priv": { "description": "Configure privacy protocol", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "enum": [ "aes-cfb-128", "aes-256-cfb-128" ], "type": "string", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_userPrivDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "x-attributeMetadata": { "insecureConfiguration": { "attributeJsonPath": "$.data.user[*].priv.optionType", "values": [ "default" ], "description": "SNMP user with Auth/Noauth security level is insecure", "reason": "SNMP User with Auth/Noauth security level", "remediation": "Use SNMP User with Priv security level" } } } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_oneOfUserPrivOptionsDef" }, "privPassword": { "description": "Specify privacy protocol password", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_userPrivPasswordDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "x-attributeMetadata": { "insecureConfiguration": { "attributeJsonPath": "$.data.user[*].privPassword.optionType", "values": [ "default" ], "description": "SNMP user with Auth/Noauth security level is insecure", "reason": "SNMP User with Auth/Noauth security level", "remediation": "Use SNMP User with Priv security level" } } } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_oneOfUserPrivPasswordOptionsDef" }, "group": { "description": "Name of the SNMP group", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minLength": 1, "type": "string", "maxLength": 32, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_userGroupDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_oneOfUserGroupOptionsDef" } }, "required": [ "name", "group" ], "additionalProperties": false } }, "target": { "description": "Configure SNMP server to receive SNMP traps", "type": "array", "uniqueItems": true, "items": { "if": { "anyOf": [ { "properties": { "vpnId": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "vpnId" ] }, { "properties": { "ip": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "ip" ] }, { "properties": { "port": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "port" ] } ] }, "then": { "required": [ "vpnId", "ip", "port" ] }, "type": "object", "properties": { "vpnId": { "description": "Set VPN in which SNMP server is located", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minimum": 0, "maximum": 65530, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_targetVpnIdDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_oneOfTargetVpnIdOptionsDef" }, "ip": { "description": "Set IPv4/IPv6 address of SNMP server", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "oneOf": [ { "format": "ipv4" }, { "format": "ipv6" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_targetIpDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_oneOfTargetIpOptionsDef" }, "port": { "description": "Set UDP port number to connect to SNMP server", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minimum": 1, "maximum": 65535, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_targetPortDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_oneOfTargetPortOptionsDef" }, "userLabel": { "description": "Set user label of the SNMP community", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minLength": 1, "type": "string", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_targetCommunityNameUserLabelDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_oneOfTargetCommunityNameUserLabelOptionsDef" }, "communityName": { "description": "Set name of the SNMP community [Note: Catalyst SD-WAN Manager will encrypt this field before saving. Cleartext strings will not be returned back to the user in GET responses for sensitive fields.]. DEPRECATED. Use userLabel field instead", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_targetCommunityNameDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_oneOfTargetCommunityNameOptionsDef" }, "user": { "description": "Set name of the SNMP user", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minLength": 1, "type": "string", "maxLength": 32, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_targetUserDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_oneOfTargetUserOptionsDef" }, "sourceInterface": { "description": "Source interface for outgoing SNMP traps", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minLength": 1, "type": "string", "maxLength": 32, "pattern": "(^GigabitEthernet|Loopback|TenGigabitEthernet|TwoGigabitEthernet|FortyGigabitEthernet|HundredGigE|Vlan)(([1-9]\\d|\\d)/){0,2}(0|[1-9]\\d*)([:|\\.][1-9]\\d*)?", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_targetSourceInterfaceDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_oneOfTargetSourceInterfaceOptionsDef" } }, "additionalProperties": false } } }, "additionalProperties": false } }, "required": [ "data" ], "x-metadata": { "supportedDeviceTypes": [ "asr", "c1100", "c8000be", "csr1000v", "ir8100", "ir8340", "isr", "ISRv", "ir1101" ], "minVManageVersion": "26.1.1" }, "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_SchemaPayload" } } } } }, "$$ref": "#/components/schemas/getListSdwanSystemSnmpPayload" }, "examples": { "get response example": { "value": { "header": { "generatedOn": 1702438718825 }, "data": [ { "parcelId": "09fc54fe-ff36-4640-ae57-c9e71a103902", "parcelType": "snmp", "createdBy": "admin", "lastUpdatedBy": "admin", "createdOn": 1701866357838, "lastUpdatedOn": 1701866357838, "payload": { "data": { "shutdown": { "optionType": "default", "value": false }, "contact": { "optionType": "default" }, "location": { "optionType": "default" }, "view": [ { "name": { "optionType": "global", "value": "view1" }, "oid": [ { "id": { "optionType": "global", "value": "1.3.6.2.21.1" }, "exclude": { "optionType": "default", "value": false } } ] } ], "community": [], "group": [ { "name": { "optionType": "global", "value": "group1" }, "securityLevel": { "optionType": "global", "value": "auth-priv" }, "view": { "optionType": "global", "value": "view1" } } ], "user": [ { "name": { "optionType": "global", "value": "user1" }, "auth": { "optionType": "global", "value": "sha256" }, "authPassword": { "optionType": "global", "value": "123ad" }, "priv": { "optionType": "global", "value": "aes-256-cfb-128" }, "privPassword": { "optionType": "global", "value": "123adas" }, "group": { "optionType": "global", "value": "group1" } } ], "target": [ { "vpnId": { "optionType": "global", "value": 0 }, "ip": { "optionType": "global", "value": "2.2.1.1" }, "port": { "optionType": "global", "value": 132 }, "user": { "optionType": "global", "value": "user1" }, "sourceInterface": { "optionType": "global", "value": "GigabitEthernet1" } } ] } } } ] }, "$$ref": "#/components/examples/getListSdwanSystemSnmpExample" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Feature Profile > System > Snmp-read" }, "post": { "tags": [ "Configuration - Feature Profile (SDWAN)" ], "description": "Create a Snmp Profile Parcel for System feature profile", "operationId": "CreateSnmpProfileParcelForSystem", "parameters": [ { "name": "systemId", "in": "path", "description": "Feature 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": "Snmp Profile Parcel", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[^&<>! \"]+$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_cgFpPpNameDef" }, "description": { "type": "string" }, "data": { "type": "object", "properties": { "shutdown": { "description": "Enable or disable SNMP", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_oneOfShutdownOptionsDef" }, "contact": { "description": "Set the contact for this managed node", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minLength": 1, "type": "string", "maxLength": 255, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_contactDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionNoDefaultDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_oneOfContactOptionsDef" }, "location": { "description": "Set the physical location of this managed node", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minLength": 1, "type": "string", "maxLength": 255, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_locationDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionNoDefaultDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_oneOfLocationOptionsDef" }, "view": { "description": "Configure a view record", "type": "array", "uniqueItems": true, "items": { "type": "object", "properties": { "name": { "description": "Set the name of the SNMP view", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minLength": 1, "type": "string", "maxLength": 32, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_viewNameDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_oneOfViewNameOptionsDef" }, "oid": { "description": "Configure SNMP object identifier", "type": "array", "uniqueItems": true, "items": { "type": "object", "properties": { "id": { "description": "Configure identifier of subtree of MIB objects", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minLength": 1, "type": "string", "pattern": "^(([0-1](\\.[1-3]?[0-9]))|(2\\.(0|([1-9]\\d*))))(\\.(0|\\*|([1-9]\\d*))){0,126}$", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_viewOidIdDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_oneOfViewOidIdOptionsDef" }, "exclude": { "description": "Exclude the OID", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_oneOfViewOidExcludeOptionsDef" } }, "required": [ "id" ], "additionalProperties": false } } }, "required": [ "name" ], "additionalProperties": false } }, "community": { "description": "Configure SNMP community", "type": "array", "uniqueItems": true, "items": { "type": "object", "properties": { "name": { "description": "Set name of the SNMP community [Note: Catalyst SD-WAN Manager will encrypt this field before saving. Cleartext strings will not be returned back to the user in GET responses for sensitive fields.]", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minLength": 1, "pattern": "^[\\S]+$", "type": "string", "x-attributeMetadata": { "insecureConfiguration": { "attributeJsonPath": "$.data.community[*].name.value", "description": "SNMP v2c configured - legacy protocol poses data confidentiality and integrity risks due to lack of encryption and authentication", "reason": "Legacy protocol poses data confidentiality and integrity risks due to lack of encryption and authentication", "remediation": "Configure SNMP v3" } }, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_communityNameDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_oneOfCommunityNameOptionsDef" }, "userLabel": { "description": "Set user label of the SNMP community", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minLength": 1, "type": "string", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_targetCommunityNameUserLabelDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_oneOfTargetCommunityNameUserLabelOptionsDef" }, "view": { "description": "Set name of the SNMP view", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_communityViewDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_oneOfCommunityViewOptionsDef" }, "authorization": { "description": "Configure access permissions", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "enum": [ "read-only", "read-write" ], "type": "string", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_communityAuthorizationDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_oneOfCommunityAuthorizationOptionsDef" } }, "required": [ "name", "view" ], "additionalProperties": false } }, "group": { "description": "Configure an SNMP group", "type": "array", "uniqueItems": true, "items": { "type": "object", "properties": { "name": { "description": "Name of the SNMP group", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minLength": 1, "type": "string", "maxLength": 32, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_groupNameDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_oneOfGroupNameOptionsDef" }, "securityLevel": { "description": "Configure security level", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "enum": [ "no-auth-no-priv", "auth-no-priv", "auth-priv" ], "type": "string", "x-attributeMetadata": { "insecureConfiguration": { "attributeJsonPath": "$.data.group[*].securityLevel.value", "values": [ "no-auth-no-priv", "auth-no-priv" ], "description": "SNMPv3 configured with Auth/Noauth security level - data confidentiality and integrity cannot be ensured", "reason": "SNMPv3 with Auth/Noauth security level", "remediation": "Use SNMPv3 with Priv security level" } }, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_groupSecurityLevelDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_oneOfGroupSecurityLevelOptionsDef" }, "view": { "description": "Name of the SNMP view", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minLength": 1, "type": "string", "maxLength": 32, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_groupViewDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_oneOfGroupViewOptionsDef" } }, "required": [ "name", "securityLevel", "view" ], "additionalProperties": false } }, "user": { "description": "Configure an SNMP user", "type": "array", "uniqueItems": true, "items": { "type": "object", "properties": { "name": { "description": "Name of the SNMP user", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minLength": 1, "type": "string", "maxLength": 32, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_userNameDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_oneOfUserNameOptionsDef" }, "auth": { "description": "Configure authentication protocol", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "enum": [ "sha", "sha256" ], "type": "string", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_userAuthDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "x-attributeMetadata": { "insecureConfiguration": { "attributeJsonPath": "$.data.user[*].auth.optionType", "values": [ "default" ], "description": "SNMP user with Auth/Noauth security level is insecure", "reason": "SNMP User with Auth/Noauth security level", "remediation": "Use SNMP User with Priv security level" } } } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_oneOfUserAuthOptionsDef" }, "authPassword": { "description": "Specify authentication protocol password", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_userAuthPasswordDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "x-attributeMetadata": { "insecureConfiguration": { "attributeJsonPath": "$.data.user[*].authPassword.optionType", "values": [ "default" ], "description": "SNMP user with Auth/Noauth security level is insecure", "reason": "SNMP User with Auth/Noauth security level", "remediation": "Use SNMP User with Priv security level" } } } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_oneOfUserAuthPasswordOptionsDef" }, "priv": { "description": "Configure privacy protocol", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "enum": [ "aes-cfb-128", "aes-256-cfb-128" ], "type": "string", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_userPrivDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "x-attributeMetadata": { "insecureConfiguration": { "attributeJsonPath": "$.data.user[*].priv.optionType", "values": [ "default" ], "description": "SNMP user with Auth/Noauth security level is insecure", "reason": "SNMP User with Auth/Noauth security level", "remediation": "Use SNMP User with Priv security level" } } } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_oneOfUserPrivOptionsDef" }, "privPassword": { "description": "Specify privacy protocol password", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_userPrivPasswordDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "x-attributeMetadata": { "insecureConfiguration": { "attributeJsonPath": "$.data.user[*].privPassword.optionType", "values": [ "default" ], "description": "SNMP user with Auth/Noauth security level is insecure", "reason": "SNMP User with Auth/Noauth security level", "remediation": "Use SNMP User with Priv security level" } } } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_oneOfUserPrivPasswordOptionsDef" }, "group": { "description": "Name of the SNMP group", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minLength": 1, "type": "string", "maxLength": 32, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_userGroupDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_oneOfUserGroupOptionsDef" } }, "required": [ "name", "group" ], "additionalProperties": false } }, "target": { "description": "Configure SNMP server to receive SNMP traps", "type": "array", "uniqueItems": true, "items": { "if": { "anyOf": [ { "properties": { "vpnId": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "vpnId" ] }, { "properties": { "ip": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "ip" ] }, { "properties": { "port": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "port" ] } ] }, "then": { "required": [ "vpnId", "ip", "port" ] }, "type": "object", "properties": { "vpnId": { "description": "Set VPN in which SNMP server is located", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minimum": 0, "maximum": 65530, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_targetVpnIdDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_oneOfTargetVpnIdOptionsDef" }, "ip": { "description": "Set IPv4/IPv6 address of SNMP server", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "oneOf": [ { "format": "ipv4" }, { "format": "ipv6" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_targetIpDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_oneOfTargetIpOptionsDef" }, "port": { "description": "Set UDP port number to connect to SNMP server", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minimum": 1, "maximum": 65535, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_targetPortDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_oneOfTargetPortOptionsDef" }, "userLabel": { "description": "Set user label of the SNMP community", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minLength": 1, "type": "string", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_targetCommunityNameUserLabelDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_oneOfTargetCommunityNameUserLabelOptionsDef" }, "communityName": { "description": "Set name of the SNMP community [Note: Catalyst SD-WAN Manager will encrypt this field before saving. Cleartext strings will not be returned back to the user in GET responses for sensitive fields.]. DEPRECATED. Use userLabel field instead", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_targetCommunityNameDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_oneOfTargetCommunityNameOptionsDef" }, "user": { "description": "Set name of the SNMP user", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minLength": 1, "type": "string", "maxLength": 32, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_targetUserDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_oneOfTargetUserOptionsDef" }, "sourceInterface": { "description": "Source interface for outgoing SNMP traps", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minLength": 1, "type": "string", "maxLength": 32, "pattern": "(^GigabitEthernet|Loopback|TenGigabitEthernet|TwoGigabitEthernet|FortyGigabitEthernet|HundredGigE|Vlan)(([1-9]\\d|\\d)/){0,2}(0|[1-9]\\d*)([:|\\.][1-9]\\d*)?", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_targetSourceInterfaceDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_oneOfTargetSourceInterfaceOptionsDef" } }, "additionalProperties": false } } }, "additionalProperties": false } }, "required": [ "data" ], "x-metadata": { "supportedDeviceTypes": [ "asr", "c1100", "c8000be", "csr1000v", "ir8100", "ir8340", "isr", "ISRv", "ir1101" ], "minVManageVersion": "26.1.1" }, "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_SchemaPayload" }, "examples": { "SNMPv3": { "value": { "name": "SNMPv3", "data": { "shutdown": { "optionType": "default", "value": false }, "contact": { "optionType": "default" }, "location": { "optionType": "default" }, "view": [ { "name": { "optionType": "global", "value": "view1" }, "oid": [ { "id": { "optionType": "global", "value": "1.3.6.2.21.1" }, "exclude": { "optionType": "default", "value": false } } ] } ], "community": [], "group": [ { "name": { "optionType": "global", "value": "group1" }, "securityLevel": { "optionType": "global", "value": "auth-priv" }, "view": { "optionType": "global", "value": "view1" } } ], "user": [ { "name": { "optionType": "global", "value": "user1" }, "auth": { "optionType": "global", "value": "sha256" }, "authPassword": { "optionType": "global", "value": "123ad" }, "priv": { "optionType": "global", "value": "aes-256-cfb-128" }, "privPassword": { "optionType": "global", "value": "123adas" }, "group": { "optionType": "global", "value": "group1" } } ], "target": [ { "vpnId": { "optionType": "global", "value": 0 }, "ip": { "optionType": "global", "value": "2.2.1.1" }, "port": { "optionType": "global", "value": 132 }, "user": { "optionType": "global", "value": "user1" }, "sourceInterface": { "optionType": "global", "value": "GigabitEthernet1" } } ] } }, "$$ref": "#/components/examples/ProfileparcelSdwanSystemSnmpPostRequest_SNMPv3" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "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}" } }, "required": [ "id" ], "x-metadata": { "minVManageVersion": "20.15.1" }, "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelCommonPostResponse_SchemaPayload" }, "examples": { "example_1": { "value": { "id": "24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A" }, "$$ref": "#/components/examples/ProfileparcelCommonPostResponse_example_1" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Feature Profile > System > Snmp-write" } }, "/v1/feature-profile/sdwan/system/{systemId}/snmp/{snmpId}": { "get": { "tags": [ "Configuration - Feature Profile (SDWAN)" ], "description": "Get Snmp Profile Parcel by parcelId for System feature profile", "operationId": "GetSnmpProfileParcelByParcelIdForSystem", "parameters": [ { "name": "systemId", "in": "path", "description": "Feature 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" } }, { "name": "snmpId", "in": "path", "description": "Profile Parcel 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", "properties": { "parcelId": { "type": "string", "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}", "$$ref": "#/components/schemas/CommonCommonDefs_uuidDef" }, "parcelType": { "type": "string" }, "createdBy": { "type": "string", "description": "User who last created this.", "readOnly": true }, "createdOn": { "type": "integer", "description": "Timestamp of creation", "format": "int64", "readOnly": true }, "lastUpdatedBy": { "type": "string", "description": "User who last updated this.", "readOnly": true }, "lastUpdatedOn": { "type": "integer", "description": "Timestamp of last update", "format": "int64", "readOnly": true }, "payload": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[^&<>! \"]+$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_cgFpPpNameDef" }, "description": { "type": "string" }, "data": { "type": "object", "properties": { "shutdown": { "description": "Enable or disable SNMP", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPutRequest_oneOfShutdownOptionsDef" }, "contact": { "description": "Set the contact for this managed node", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minLength": 1, "type": "string", "maxLength": 255, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPutRequest_contactDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionNoDefaultDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPutRequest_oneOfContactOptionsDef" }, "location": { "description": "Set the physical location of this managed node", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minLength": 1, "type": "string", "maxLength": 255, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPutRequest_locationDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionNoDefaultDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPutRequest_oneOfLocationOptionsDef" }, "view": { "description": "Configure a view record", "type": "array", "uniqueItems": true, "items": { "type": "object", "properties": { "name": { "description": "Set the name of the SNMP view", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minLength": 1, "type": "string", "maxLength": 32, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPutRequest_viewNameDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPutRequest_oneOfViewNameOptionsDef" }, "oid": { "description": "Configure SNMP object identifier", "type": "array", "uniqueItems": true, "items": { "type": "object", "properties": { "id": { "description": "Configure identifier of subtree of MIB objects", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minLength": 1, "type": "string", "pattern": "^(([0-1](\\.[1-3]?[0-9]))|(2\\.(0|([1-9]\\d*))))(\\.(0|\\*|([1-9]\\d*))){0,126}$", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPutRequest_viewOidIdDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPutRequest_oneOfViewOidIdOptionsDef" }, "exclude": { "description": "Exclude the OID", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPutRequest_oneOfViewOidExcludeOptionsDef" } }, "required": [ "id" ], "additionalProperties": false } } }, "required": [ "name" ], "additionalProperties": false } }, "community": { "description": "Configure SNMP community", "type": "array", "uniqueItems": true, "items": { "type": "object", "properties": { "name": { "description": "Set name of the SNMP community [Note: Catalyst SD-WAN Manager will encrypt this field before saving. Cleartext strings will not be returned back to the user in GET responses for sensitive fields.]", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minLength": 1, "pattern": "^[\\S]+$", "type": "string", "x-attributeMetadata": { "insecureConfiguration": { "attributeJsonPath": "$.data.community[*].name.value", "description": "SNMP v2c configured - legacy protocol poses data confidentiality and integrity risks due to lack of encryption and authentication", "reason": "Legacy protocol poses data confidentiality and integrity risks due to lack of encryption and authentication", "remediation": "Configure SNMP v3" } }, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPutRequest_communityNameDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPutRequest_oneOfCommunityNameOptionsDef" }, "userLabel": { "description": "Set user label of the SNMP community", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minLength": 1, "type": "string", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPutRequest_targetCommunityNameUserLabelDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPutRequest_oneOfTargetCommunityNameUserLabelOptionsDef" }, "view": { "description": "Set name of the SNMP view", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPutRequest_communityViewDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPutRequest_oneOfCommunityViewOptionsDef" }, "authorization": { "description": "Configure access permissions", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "enum": [ "read-only", "read-write" ], "type": "string", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPutRequest_communityAuthorizationDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPutRequest_oneOfCommunityAuthorizationOptionsDef" } }, "required": [ "name", "view" ], "additionalProperties": false } }, "group": { "description": "Configure an SNMP group", "type": "array", "uniqueItems": true, "items": { "type": "object", "properties": { "name": { "description": "Name of the SNMP group", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minLength": 1, "type": "string", "maxLength": 32, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPutRequest_groupNameDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPutRequest_oneOfGroupNameOptionsDef" }, "securityLevel": { "description": "Configure security level", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "enum": [ "no-auth-no-priv", "auth-no-priv", "auth-priv" ], "type": "string", "x-attributeMetadata": { "insecureConfiguration": { "attributeJsonPath": "$.data.group[*].securityLevel.value", "values": [ "no-auth-no-priv", "auth-no-priv" ], "description": "SNMPv3 configured with Auth/Noauth security level - data confidentiality and integrity cannot be ensured", "reason": "SNMPv3 with Auth/Noauth security level", "remediation": "Use SNMPv3 with Priv security level" } }, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPutRequest_groupSecurityLevelDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPutRequest_oneOfGroupSecurityLevelOptionsDef" }, "view": { "description": "Name of the SNMP view", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minLength": 1, "type": "string", "maxLength": 32, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPutRequest_groupViewDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPutRequest_oneOfGroupViewOptionsDef" } }, "required": [ "name", "securityLevel", "view" ], "additionalProperties": false } }, "user": { "description": "Configure an SNMP user", "type": "array", "uniqueItems": true, "items": { "type": "object", "properties": { "name": { "description": "Name of the SNMP user", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minLength": 1, "type": "string", "maxLength": 32, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPutRequest_userNameDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPutRequest_oneOfUserNameOptionsDef" }, "auth": { "description": "Configure authentication protocol", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "enum": [ "sha", "sha256" ], "type": "string", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPutRequest_userAuthDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "x-attributeMetadata": { "insecureConfiguration": { "attributeJsonPath": "$.data.user[*].auth.optionType", "values": [ "default" ], "description": "SNMP user with Auth/Noauth security level is insecure", "reason": "SNMP User with Auth/Noauth security level", "remediation": "Use SNMP User with Priv security level" } } } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPutRequest_oneOfUserAuthOptionsDef" }, "authPassword": { "description": "Specify authentication protocol password", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPutRequest_userAuthPasswordDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "x-attributeMetadata": { "insecureConfiguration": { "attributeJsonPath": "$.data.user[*].authPassword.optionType", "values": [ "default" ], "description": "SNMP user with Auth/Noauth security level is insecure", "reason": "SNMP User with Auth/Noauth security level", "remediation": "Use SNMP User with Priv security level" } } } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPutRequest_oneOfUserAuthPasswordOptionsDef" }, "priv": { "description": "Configure privacy protocol", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "enum": [ "aes-cfb-128", "aes-256-cfb-128" ], "type": "string", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPutRequest_userPrivDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "x-attributeMetadata": { "insecureConfiguration": { "attributeJsonPath": "$.data.user[*].priv.optionType", "values": [ "default" ], "description": "SNMP user with Auth/Noauth security level is insecure", "reason": "SNMP User with Auth/Noauth security level", "remediation": "Use SNMP User with Priv security level" } } } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPutRequest_oneOfUserPrivOptionsDef" }, "privPassword": { "description": "Specify privacy protocol password", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPutRequest_userPrivPasswordDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "x-attributeMetadata": { "insecureConfiguration": { "attributeJsonPath": "$.data.user[*].privPassword.optionType", "values": [ "default" ], "description": "SNMP user with Auth/Noauth security level is insecure", "reason": "SNMP User with Auth/Noauth security level", "remediation": "Use SNMP User with Priv security level" } } } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPutRequest_oneOfUserPrivPasswordOptionsDef" }, "group": { "description": "Name of the SNMP group", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minLength": 1, "type": "string", "maxLength": 32, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPutRequest_userGroupDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPutRequest_oneOfUserGroupOptionsDef" } }, "required": [ "name", "group" ], "additionalProperties": false } }, "target": { "description": "Configure SNMP server to receive SNMP traps", "type": "array", "uniqueItems": true, "items": { "if": { "anyOf": [ { "properties": { "vpnId": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "vpnId" ] }, { "properties": { "ip": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "ip" ] }, { "properties": { "port": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "port" ] } ] }, "then": { "required": [ "vpnId", "ip", "port" ] }, "type": "object", "properties": { "vpnId": { "description": "Set VPN in which SNMP server is located", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minimum": 0, "maximum": 65530, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPutRequest_targetVpnIdDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPutRequest_oneOfTargetVpnIdOptionsDef" }, "ip": { "description": "Set IPv4/IPv6 address of SNMP server", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "oneOf": [ { "format": "ipv4" }, { "format": "ipv6" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPutRequest_targetIpDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPutRequest_oneOfTargetIpOptionsDef" }, "port": { "description": "Set UDP port number to connect to SNMP server", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minimum": 1, "maximum": 65535, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPutRequest_targetPortDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPutRequest_oneOfTargetPortOptionsDef" }, "userLabel": { "description": "Set user label of the SNMP community", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minLength": 1, "type": "string", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPutRequest_targetCommunityNameUserLabelDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPutRequest_oneOfTargetCommunityNameUserLabelOptionsDef" }, "communityName": { "description": "Set name of the SNMP community [Note: Catalyst SD-WAN Manager will encrypt this field before saving. Cleartext strings will not be returned back to the user in GET responses for sensitive fields.]. DEPRECATED. Use userLabel field instead", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPutRequest_targetCommunityNameDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPutRequest_oneOfTargetCommunityNameOptionsDef" }, "user": { "description": "Set name of the SNMP user", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minLength": 1, "type": "string", "maxLength": 32, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPutRequest_targetUserDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPutRequest_oneOfTargetUserOptionsDef" }, "sourceInterface": { "description": "Source interface for outgoing SNMP traps", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minLength": 1, "type": "string", "maxLength": 32, "pattern": "(^GigabitEthernet|Loopback|TenGigabitEthernet|TwoGigabitEthernet|FortyGigabitEthernet|HundredGigE|Vlan)(([1-9]\\d|\\d)/){0,2}(0|[1-9]\\d*)([:|\\.][1-9]\\d*)?", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPutRequest_targetSourceInterfaceDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPutRequest_oneOfTargetSourceInterfaceOptionsDef" } }, "additionalProperties": false } } }, "additionalProperties": false } }, "required": [ "data" ], "x-metadata": { "supportedDeviceTypes": [ "asr", "c1100", "c8000be", "csr1000v", "ir8100", "ir8340", "isr", "ISRv", "ir1101" ], "minVManageVersion": "26.1.1" }, "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPutRequest_SchemaPayload" } }, "$$ref": "#/components/schemas/getSingleSdwanSystemSnmpPayload" }, "examples": { "get response example": { "value": { "parcelId": "09fc54fe-ff36-4640-ae57-c9e71a103902", "parcelType": "snmp", "createdBy": "admin", "lastUpdatedBy": "admin", "createdOn": 1701866357838, "lastUpdatedOn": 1701866357838, "payload": { "data": { "shutdown": { "optionType": "default", "value": false }, "contact": { "optionType": "default" }, "location": { "optionType": "default" }, "view": [ { "name": { "optionType": "global", "value": "view1" }, "oid": [ { "id": { "optionType": "global", "value": "1.3.6.2.21.1" }, "exclude": { "optionType": "default", "value": false } } ] } ], "community": [], "group": [ { "name": { "optionType": "global", "value": "group1" }, "securityLevel": { "optionType": "global", "value": "auth-priv" }, "view": { "optionType": "global", "value": "view1" } } ], "user": [ { "name": { "optionType": "global", "value": "user1" }, "auth": { "optionType": "global", "value": "sha256" }, "authPassword": { "optionType": "global", "value": "123ad" }, "priv": { "optionType": "global", "value": "aes-256-cfb-128" }, "privPassword": { "optionType": "global", "value": "123adas" }, "group": { "optionType": "global", "value": "group1" } } ], "target": [ { "vpnId": { "optionType": "global", "value": 0 }, "ip": { "optionType": "global", "value": "2.2.1.1" }, "port": { "optionType": "global", "value": 132 }, "user": { "optionType": "global", "value": "user1" }, "sourceInterface": { "optionType": "global", "value": "GigabitEthernet1" } } ] } } }, "$$ref": "#/components/examples/getSingleSdwanSystemSnmpExample" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Feature Profile > System > Snmp-read" }, "put": { "tags": [ "Configuration - Feature Profile (SDWAN)" ], "description": "Update a Snmp Profile Parcel for System feature profile", "operationId": "EditSnmpProfileParcelForSystem", "parameters": [ { "name": "systemId", "in": "path", "description": "Feature 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" } }, { "name": "snmpId", "in": "path", "description": "Profile Parcel 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": "Snmp Profile Parcel", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[^&<>! \"]+$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_cgFpPpNameDef" }, "description": { "type": "string" }, "data": { "type": "object", "properties": { "shutdown": { "description": "Enable or disable SNMP", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPutRequest_oneOfShutdownOptionsDef" }, "contact": { "description": "Set the contact for this managed node", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minLength": 1, "type": "string", "maxLength": 255, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPutRequest_contactDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionNoDefaultDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPutRequest_oneOfContactOptionsDef" }, "location": { "description": "Set the physical location of this managed node", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minLength": 1, "type": "string", "maxLength": 255, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPutRequest_locationDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" } }, "required": [ "optionType" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionNoDefaultDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPutRequest_oneOfLocationOptionsDef" }, "view": { "description": "Configure a view record", "type": "array", "uniqueItems": true, "items": { "type": "object", "properties": { "name": { "description": "Set the name of the SNMP view", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minLength": 1, "type": "string", "maxLength": 32, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPutRequest_viewNameDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPutRequest_oneOfViewNameOptionsDef" }, "oid": { "description": "Configure SNMP object identifier", "type": "array", "uniqueItems": true, "items": { "type": "object", "properties": { "id": { "description": "Configure identifier of subtree of MIB objects", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minLength": 1, "type": "string", "pattern": "^(([0-1](\\.[1-3]?[0-9]))|(2\\.(0|([1-9]\\d*))))(\\.(0|\\*|([1-9]\\d*))){0,126}$", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPutRequest_viewOidIdDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPutRequest_oneOfViewOidIdOptionsDef" }, "exclude": { "description": "Exclude the OID", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "boolean", "$$ref": "#/components/schemas/CommonCommonDefs_booleanDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "boolean", "enum": [ false ], "$$ref": "#/components/schemas/CommonCommonDefs_booleanFalseDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPutRequest_oneOfViewOidExcludeOptionsDef" } }, "required": [ "id" ], "additionalProperties": false } } }, "required": [ "name" ], "additionalProperties": false } }, "community": { "description": "Configure SNMP community", "type": "array", "uniqueItems": true, "items": { "type": "object", "properties": { "name": { "description": "Set name of the SNMP community [Note: Catalyst SD-WAN Manager will encrypt this field before saving. Cleartext strings will not be returned back to the user in GET responses for sensitive fields.]", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minLength": 1, "pattern": "^[\\S]+$", "type": "string", "x-attributeMetadata": { "insecureConfiguration": { "attributeJsonPath": "$.data.community[*].name.value", "description": "SNMP v2c configured - legacy protocol poses data confidentiality and integrity risks due to lack of encryption and authentication", "reason": "Legacy protocol poses data confidentiality and integrity risks due to lack of encryption and authentication", "remediation": "Configure SNMP v3" } }, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPutRequest_communityNameDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPutRequest_oneOfCommunityNameOptionsDef" }, "userLabel": { "description": "Set user label of the SNMP community", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minLength": 1, "type": "string", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPutRequest_targetCommunityNameUserLabelDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPutRequest_oneOfTargetCommunityNameUserLabelOptionsDef" }, "view": { "description": "Set name of the SNMP view", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPutRequest_communityViewDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPutRequest_oneOfCommunityViewOptionsDef" }, "authorization": { "description": "Configure access permissions", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "enum": [ "read-only", "read-write" ], "type": "string", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPutRequest_communityAuthorizationDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPutRequest_oneOfCommunityAuthorizationOptionsDef" } }, "required": [ "name", "view" ], "additionalProperties": false } }, "group": { "description": "Configure an SNMP group", "type": "array", "uniqueItems": true, "items": { "type": "object", "properties": { "name": { "description": "Name of the SNMP group", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minLength": 1, "type": "string", "maxLength": 32, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPutRequest_groupNameDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPutRequest_oneOfGroupNameOptionsDef" }, "securityLevel": { "description": "Configure security level", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "enum": [ "no-auth-no-priv", "auth-no-priv", "auth-priv" ], "type": "string", "x-attributeMetadata": { "insecureConfiguration": { "attributeJsonPath": "$.data.group[*].securityLevel.value", "values": [ "no-auth-no-priv", "auth-no-priv" ], "description": "SNMPv3 configured with Auth/Noauth security level - data confidentiality and integrity cannot be ensured", "reason": "SNMPv3 with Auth/Noauth security level", "remediation": "Use SNMPv3 with Priv security level" } }, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPutRequest_groupSecurityLevelDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPutRequest_oneOfGroupSecurityLevelOptionsDef" }, "view": { "description": "Name of the SNMP view", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minLength": 1, "type": "string", "maxLength": 32, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPutRequest_groupViewDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPutRequest_oneOfGroupViewOptionsDef" } }, "required": [ "name", "securityLevel", "view" ], "additionalProperties": false } }, "user": { "description": "Configure an SNMP user", "type": "array", "uniqueItems": true, "items": { "type": "object", "properties": { "name": { "description": "Name of the SNMP user", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minLength": 1, "type": "string", "maxLength": 32, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPutRequest_userNameDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPutRequest_oneOfUserNameOptionsDef" }, "auth": { "description": "Configure authentication protocol", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "enum": [ "sha", "sha256" ], "type": "string", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPutRequest_userAuthDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "x-attributeMetadata": { "insecureConfiguration": { "attributeJsonPath": "$.data.user[*].auth.optionType", "values": [ "default" ], "description": "SNMP user with Auth/Noauth security level is insecure", "reason": "SNMP User with Auth/Noauth security level", "remediation": "Use SNMP User with Priv security level" } } } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPutRequest_oneOfUserAuthOptionsDef" }, "authPassword": { "description": "Specify authentication protocol password", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPutRequest_userAuthPasswordDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "x-attributeMetadata": { "insecureConfiguration": { "attributeJsonPath": "$.data.user[*].authPassword.optionType", "values": [ "default" ], "description": "SNMP user with Auth/Noauth security level is insecure", "reason": "SNMP User with Auth/Noauth security level", "remediation": "Use SNMP User with Priv security level" } } } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPutRequest_oneOfUserAuthPasswordOptionsDef" }, "priv": { "description": "Configure privacy protocol", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "enum": [ "aes-cfb-128", "aes-256-cfb-128" ], "type": "string", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPutRequest_userPrivDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "x-attributeMetadata": { "insecureConfiguration": { "attributeJsonPath": "$.data.user[*].priv.optionType", "values": [ "default" ], "description": "SNMP user with Auth/Noauth security level is insecure", "reason": "SNMP User with Auth/Noauth security level", "remediation": "Use SNMP User with Priv security level" } } } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPutRequest_oneOfUserPrivOptionsDef" }, "privPassword": { "description": "Specify privacy protocol password", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPutRequest_userPrivPasswordDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "x-attributeMetadata": { "insecureConfiguration": { "attributeJsonPath": "$.data.user[*].privPassword.optionType", "values": [ "default" ], "description": "SNMP user with Auth/Noauth security level is insecure", "reason": "SNMP User with Auth/Noauth security level", "remediation": "Use SNMP User with Priv security level" } } } }, "required": [ "optionType" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPutRequest_oneOfUserPrivPasswordOptionsDef" }, "group": { "description": "Name of the SNMP group", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minLength": 1, "type": "string", "maxLength": 32, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPutRequest_userGroupDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPutRequest_oneOfUserGroupOptionsDef" } }, "required": [ "name", "group" ], "additionalProperties": false } }, "target": { "description": "Configure SNMP server to receive SNMP traps", "type": "array", "uniqueItems": true, "items": { "if": { "anyOf": [ { "properties": { "vpnId": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "vpnId" ] }, { "properties": { "ip": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "ip" ] }, { "properties": { "port": { "properties": { "optionType": { "const": "global" } }, "required": [ "optionType" ] } }, "required": [ "port" ] } ] }, "then": { "required": [ "vpnId", "ip", "port" ] }, "type": "object", "properties": { "vpnId": { "description": "Set VPN in which SNMP server is located", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minimum": 0, "maximum": 65530, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPutRequest_targetVpnIdDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPutRequest_oneOfTargetVpnIdOptionsDef" }, "ip": { "description": "Set IPv4/IPv6 address of SNMP server", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "oneOf": [ { "format": "ipv4" }, { "format": "ipv6" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPutRequest_targetIpDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPutRequest_oneOfTargetIpOptionsDef" }, "port": { "description": "Set UDP port number to connect to SNMP server", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minimum": 1, "maximum": 65535, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPutRequest_targetPortDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPutRequest_oneOfTargetPortOptionsDef" }, "userLabel": { "description": "Set user label of the SNMP community", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minLength": 1, "type": "string", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPutRequest_targetCommunityNameUserLabelDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPutRequest_oneOfTargetCommunityNameUserLabelOptionsDef" }, "communityName": { "description": "Set name of the SNMP community [Note: Catalyst SD-WAN Manager will encrypt this field before saving. Cleartext strings will not be returned back to the user in GET responses for sensitive fields.]. DEPRECATED. Use userLabel field instead", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPutRequest_targetCommunityNameDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPutRequest_oneOfTargetCommunityNameOptionsDef" }, "user": { "description": "Set name of the SNMP user", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minLength": 1, "type": "string", "maxLength": 32, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPutRequest_targetUserDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPutRequest_oneOfTargetUserOptionsDef" }, "sourceInterface": { "description": "Source interface for outgoing SNMP traps", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "minLength": 1, "type": "string", "maxLength": 32, "pattern": "(^GigabitEthernet|Loopback|TenGigabitEthernet|TwoGigabitEthernet|FortyGigabitEthernet|HundredGigE|Vlan)(([1-9]\\d|\\d)/){0,2}(0|[1-9]\\d*)([:|\\.][1-9]\\d*)?", "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPutRequest_targetSourceInterfaceDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "pattern": "^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_valueDef" }, "default": { "minLength": 1, "type": "string", "maxLength": 2048, "$$ref": "#/components/schemas/CommonCommonDefs_defaultDef" }, "description": { "minLength": 1, "type": "string", "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_descriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef" } ], "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPutRequest_oneOfTargetSourceInterfaceOptionsDef" } }, "additionalProperties": false } } }, "additionalProperties": false } }, "required": [ "data" ], "x-metadata": { "supportedDeviceTypes": [ "asr", "c1100", "c8000be", "csr1000v", "ir8100", "ir8340", "isr", "ISRv", "ir1101" ], "minVManageVersion": "26.1.1" }, "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelSdwanSystemSnmpPutRequest_SchemaPayload" }, "examples": { "SNMPv3": { "value": { "name": "SNMPv3", "data": { "shutdown": { "optionType": "default", "value": false }, "contact": { "optionType": "default" }, "location": { "optionType": "default" }, "view": [ { "name": { "optionType": "global", "value": "view1" }, "oid": [ { "id": { "optionType": "global", "value": "1.3.6.2.21.1" }, "exclude": { "optionType": "default", "value": false } } ] } ], "community": [], "group": [ { "name": { "optionType": "global", "value": "group1" }, "securityLevel": { "optionType": "global", "value": "auth-priv" }, "view": { "optionType": "global", "value": "view1" } } ], "user": [ { "name": { "optionType": "global", "value": "user1" }, "auth": { "optionType": "global", "value": "sha256" }, "authPassword": { "optionType": "global", "value": "123ad" }, "priv": { "optionType": "global", "value": "aes-256-cfb-128" }, "privPassword": { "optionType": "global", "value": "123adas" }, "group": { "optionType": "global", "value": "group1" } } ], "target": [ { "vpnId": { "optionType": "global", "value": 0 }, "ip": { "optionType": "global", "value": "2.2.1.1" }, "port": { "optionType": "global", "value": 132 }, "user": { "optionType": "global", "value": "user1" }, "sourceInterface": { "optionType": "global", "value": "GigabitEthernet1" } } ] } }, "$$ref": "#/components/examples/ProfileparcelSdwanSystemSnmpPutRequest_SNMPv3" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "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}" } }, "required": [ "id" ], "x-metadata": { "minVManageVersion": "20.15.1" }, "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelCommonPutResponse_SchemaPayload" }, "examples": { "example_1": { "value": { "id": "24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A" }, "$$ref": "#/components/examples/ProfileparcelCommonPutResponse_example_1" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Feature Profile > System > Snmp-write" }, "delete": { "tags": [ "Configuration - Feature Profile (SDWAN)" ], "description": "Delete a Snmp Profile Parcel for System feature profile", "operationId": "DeleteSnmpProfileParcelForSystem", "parameters": [ { "name": "systemId", "in": "path", "description": "Feature 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" } }, { "name": "snmpId", "in": "path", "description": "Profile Parcel 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": "Feature Profile > System > Snmp-write" } } } }