openapi: 3.2.0 info: title: Others Configuration - Control Component Setting API description: 'Other APIs Include APIs that do not belong to other categories' contact: email: vmanage@cisco.com license: name: Commercial License url: https://www.cisco.com/c/en/us/solutions/enterprise-networks/sd-wan/index.html version: 26.1.0+2026-01-06 x-provenance: method: harvested authored_by: Cisco Catalyst SD-WAN harvested_by: API Evangelist harvested_on: '2026-08-19' first_party: true provider_published: true source_host: pubhub.devnetcloud.com note: 4,138 operations across 2,841 paths, published by Cisco as self-contained per-operation OpenAPI 3.1.0 fragments on the DevNet CDN and consolidated here into 13 documents. Ownership verified from info.contact vmanage@cisco.com and the Cisco license URL rather than from the fetch host. x-evidence: - type: source url: https://pubhub.devnetcloud.com/media/cisco-catalyst-sd-wan-26-1-api-guide/docs/ - type: source url: https://developer.cisco.com/docs/sdwan/ servers: - url: /dataservice tags: - name: Configuration - Control Component Setting paths: /v1/control-component/devices/settings/deploy: post: tags: - Configuration - Control Component Setting description: Deploy control component settings to one or multiple control component devices operationId: deployControlComponentSettingsToDevice requestBody: description: Deploy settings to control components content: application/json: schema: required: - devices type: object properties: devices: maxItems: 2147483647 minItems: 1 type: array description: Control Component device UUID list items: required: - id type: object properties: id: pattern: ^[a-zA-Z0-9\-/]+$ type: string description: Control Component device UUID example: 48844743-8f58-4fff-845a-e54ec27340f5 description: Control Component device UUID $$ref: '#/components/schemas/ControlComponentDeviceId' description: Deploy control component setting to multiple control component devices $$ref: '#/components/schemas/ControlComponentDeployRequest' required: true responses: '200': description: Success content: application/json: schema: required: - id type: object properties: id: type: string description: Task ID example: deploy_control_component_setting-da0ca791-8a3f-4cec-9d14-f4102d6364a1 description: Return the task ID for the deploy operation $$ref: '#/components/schemas/ControlComponentDeviceDeployResponse' '400': description: Bad Request content: application/json: schema: required: - error type: object properties: error: required: - code - details - message - type type: object properties: code: type: string description: Internal error code example: CCS0018 details: type: string description: Error message detail example: Unrecognized field user1 message: type: string description: Error message summary example: Invalid control component setting payload type: type: string description: Error message title example: error description: Error response $$ref: '#/components/schemas/ErrorDetails' $$ref: '#/components/schemas/ErrorResponse' examples: DeployControlComponentDeviceFailed: description: DeployControlComponentDeviceFailed value: error: message: Deploy control component setting to device failed code: CCS0019 details: Device daaa0139-4572-4373-9fd9-f6620c1368e3 is already deploying in-progress type: error $$ref: '#/components/examples/ComViptelaVmanageServerDeviceconfigControlcomponentSettingResponseExampleDeploycontrolcomponentfailedresponse' '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Control Component Settings-write /v1/control-component/devices/{deviceId}/settings: post: tags: - Configuration - Control Component Setting description: Create device-specific settings for a specific control component. The deviceId can be obtained from the "uuid" field in the data returned by the API (GET /dataservice/certificate/data/controller/list) operationId: createControlComponentDeviceSpecificSettings parameters: - name: deviceId in: path description: Control component device UUID required: true schema: type: string format: uuid requestBody: content: application/json: schema: oneOf: - required: - system - vpn type: object properties: system: required: - hostName - siteId - systemIp type: object properties: clock: required: - timezone type: object properties: timezone: type: string description: Set the timezone example: UTC enum: - Europe/Andorra - Asia/Dubai - Asia/Kabul - America/Antigua - America/Anguilla - Europe/Tirane - Asia/Yerevan - Africa/Luanda - Antarctica/McMurdo - Antarctica/Rothera - Antarctica/Palmer - Antarctica/Mawson - Antarctica/Davis - Antarctica/Casey - Antarctica/Vostok - Antarctica/DumontDUrville - Antarctica/Syowa - America/Argentina/Buenos_Aires - America/Argentina/Cordoba - America/Argentina/Salta - America/Argentina/Jujuy - America/Argentina/Tucuman - America/Argentina/Catamarca - America/Argentina/La_Rioja - America/Argentina/San_Juan - America/Argentina/Mendoza - America/Argentina/San_Luis - America/Argentina/Rio_Gallegos - America/Argentina/Ushuaia - Pacific/Pago_Pago - Europe/Vienna - Australia/Lord_Howe - Antarctica/Macquarie - Australia/Hobart - Australia/Currie - Australia/Melbourne - Australia/Sydney - Australia/Broken_Hill - Australia/Brisbane - Australia/Lindeman - Australia/Adelaide - Australia/Darwin - Australia/Perth - Australia/Eucla - America/Aruba - Europe/Mariehamn - Asia/Baku - Europe/Sarajevo - America/Barbados - Asia/Dhaka - Europe/Brussels - Africa/Ouagadougou - Europe/Sofia - Asia/Bahrain - Africa/Bujumbura - Africa/Porto-Novo - America/St_Barthelemy - Atlantic/Bermuda - Asia/Brunei - America/La_Paz - America/Kralendijk - America/Noronha - America/Belem - America/Fortaleza - America/Recife - America/Araguaina - America/Maceio - America/Bahia - America/Sao_Paulo - America/Campo_Grande - America/Cuiaba - America/Santarem - America/Porto_Velho - America/Boa_Vista - America/Manaus - America/Eirunepe - America/Rio_Branco - America/Nassau - Asia/Thimphu - Africa/Gaborone - Europe/Minsk - America/Belize - America/St_Johns - America/Halifax - America/Glace_Bay - America/Moncton - America/Goose_Bay - America/Blanc-Sablon - America/Toronto - America/Nipigon - America/Thunder_Bay - America/Iqaluit - America/Pangnirtung - America/Resolute - America/Atikokan - America/Rankin_Inlet - America/Winnipeg - America/Rainy_River - America/Regina - America/Swift_Current - America/Edmonton - America/Cambridge_Bay - America/Yellowknife - America/Inuvik - America/Creston - America/Dawson_Creek - America/Vancouver - America/Whitehorse - America/Dawson - Indian/Cocos - Africa/Kinshasa - Africa/Lubumbashi - Africa/Bangui - Africa/Brazzaville - Europe/Zurich - Africa/Abidjan - Pacific/Rarotonga - America/Santiago - Pacific/Easter - Africa/Douala - Asia/Shanghai - Asia/Harbin - Asia/Chongqing - Asia/Urumqi - Asia/Kashgar - America/Bogota - America/Costa_Rica - America/Havana - Atlantic/Cape_Verde - America/Curacao - Indian/Christmas - Asia/Nicosia - Europe/Prague - Europe/Berlin - Europe/Busingen - Africa/Djibouti - Europe/Copenhagen - America/Dominica - America/Santo_Domingo - Africa/Algiers - America/Guayaquil - Pacific/Galapagos - Europe/Tallinn - Africa/Cairo - Africa/El_Aaiun - Africa/Asmara - Europe/Madrid - Africa/Ceuta - Atlantic/Canary - Africa/Addis_Ababa - Europe/Helsinki - Pacific/Fiji - Atlantic/Stanley - Pacific/Chuuk - Pacific/Pohnpei - Pacific/Kosrae - Atlantic/Faroe - Europe/Paris - Africa/Libreville - Europe/London - America/Grenada - Asia/Tbilisi - America/Cayenne - Europe/Guernsey - Africa/Accra - Europe/Gibraltar - America/Godthab - America/Danmarkshavn - America/Scoresbysund - America/Thule - Africa/Banjul - Africa/Conakry - America/Guadeloupe - Africa/Malabo - Europe/Athens - Atlantic/South_Georgia - America/Guatemala - Pacific/Guam - Africa/Bissau - America/Guyana - Asia/Hong_Kong - America/Tegucigalpa - Europe/Zagreb - America/Port-au-Prince - Europe/Budapest - Asia/Jakarta - Asia/Pontianak - Asia/Makassar - Asia/Jayapura - Europe/Dublin - Asia/Jerusalem - Europe/Isle_of_Man - Asia/Kolkata - Indian/Chagos - Asia/Baghdad - Asia/Tehran - Atlantic/Reykjavik - Europe/Rome - Europe/Jersey - America/Jamaica - Asia/Amman - Asia/Tokyo - Africa/Nairobi - Asia/Bishkek - Asia/Phnom_Penh - Pacific/Tarawa - Pacific/Enderbury - Pacific/Kiritimati - Indian/Comoro - America/St_Kitts - Asia/Pyongyang - Asia/Seoul - Asia/Kuwait - America/Cayman - Asia/Almaty - Asia/Qyzylorda - Asia/Aqtobe - Asia/Aqtau - Asia/Oral - Asia/Vientiane - Asia/Beirut - America/St_Lucia - Europe/Vaduz - Asia/Colombo - Africa/Monrovia - Africa/Maseru - Europe/Vilnius - Europe/Luxembourg - Europe/Riga - Africa/Tripoli - Africa/Casablanca - Europe/Monaco - Europe/Chisinau - Europe/Podgorica - America/Marigot - Indian/Antananarivo - Pacific/Majuro - Pacific/Kwajalein - Europe/Skopje - Africa/Bamako - Asia/Rangoon - Asia/Ulaanbaatar - Asia/Hovd - Asia/Choibalsan - Asia/Macau - Pacific/Saipan - America/Martinique - Africa/Nouakchott - America/Montserrat - Europe/Malta - Indian/Mauritius - Indian/Maldives - Africa/Blantyre - America/Mexico_City - America/Cancun - America/Merida - America/Monterrey - America/Matamoros - America/Mazatlan - America/Chihuahua - America/Ojinaga - America/Hermosillo - America/Tijuana - America/Santa_Isabel - America/Bahia_Banderas - Asia/Kuala_Lumpur - Asia/Kuching - Africa/Maputo - Africa/Windhoek - Pacific/Noumea - Africa/Niamey - Pacific/Norfolk - Africa/Lagos - America/Managua - Europe/Amsterdam - Europe/Oslo - Asia/Kathmandu - Pacific/Nauru - Pacific/Niue - Pacific/Auckland - Pacific/Chatham - Asia/Muscat - America/Panama - America/Lima - Pacific/Tahiti - Pacific/Marquesas - Pacific/Gambier - Pacific/Port_Moresby - Asia/Manila - Asia/Karachi - Europe/Warsaw - America/Miquelon - Pacific/Pitcairn - America/Puerto_Rico - Asia/Gaza - Asia/Hebron - Europe/Lisbon - Atlantic/Madeira - Atlantic/Azores - Pacific/Palau - America/Asuncion - Asia/Qatar - Indian/Reunion - Europe/Bucharest - Europe/Belgrade - Europe/Kaliningrad - Europe/Moscow - Europe/Volgograd - Europe/Samara - Asia/Yekaterinburg - Asia/Omsk - Asia/Novosibirsk - Asia/Novokuznetsk - Asia/Krasnoyarsk - Asia/Irkutsk - Asia/Yakutsk - Asia/Khandyga - Asia/Vladivostok - Asia/Sakhalin - Asia/Ust-Nera - Asia/Magadan - Asia/Kamchatka - Asia/Anadyr - Africa/Kigali - Asia/Riyadh - Pacific/Guadalcanal - Indian/Mahe - Africa/Khartoum - Europe/Stockholm - Asia/Singapore - Atlantic/St_Helena - Europe/Ljubljana - Arctic/Longyearbyen - Europe/Bratislava - Africa/Freetown - Europe/San_Marino - Africa/Dakar - Africa/Mogadishu - America/Paramaribo - Africa/Juba - Africa/Sao_Tome - America/El_Salvador - America/Lower_Princes - Asia/Damascus - Africa/Mbabane - America/Grand_Turk - Africa/Ndjamena - Indian/Kerguelen - Africa/Lome - Asia/Bangkok - Asia/Dushanbe - Pacific/Fakaofo - Asia/Dili - Asia/Ashgabat - Africa/Tunis - Pacific/Tongatapu - Europe/Istanbul - America/Port_of_Spain - Pacific/Funafuti - Asia/Taipei - Africa/Dar_es_Salaam - Europe/Kiev - Europe/Uzhgorod - Europe/Zaporozhye - Europe/Simferopol - Africa/Kampala - Pacific/Johnston - Pacific/Midway - Pacific/Wake - America/New_York - America/Detroit - America/Kentucky/Louisville - America/Kentucky/Monticello - America/Indiana/Indianapolis - America/Indiana/Vincennes - America/Indiana/Winamac - America/Indiana/Marengo - America/Indiana/Petersburg - America/Indiana/Vevay - America/Chicago - America/Indiana/Tell_City - America/Indiana/Knox - America/Menominee - America/North_Dakota/Center - America/North_Dakota/New_Salem - America/North_Dakota/Beulah - America/Denver - America/Boise - America/Phoenix - America/Los_Angeles - America/Anchorage - America/Juneau - America/Sitka - America/Yakutat - America/Nome - America/Adak - America/Metlakatla - Pacific/Honolulu - America/Montevideo - Asia/Samarkand - Asia/Tashkent - Europe/Vatican - America/St_Vincent - America/Caracas - America/Tortola - America/St_Thomas - Asia/Ho_Chi_Minh - Pacific/Efate - Pacific/Wallis - Pacific/Apia - Asia/Aden - Indian/Mayotte - Africa/Johannesburg - Africa/Lusaka - Africa/Harare - UTC default: UTC description: Configure clock $$ref: '#/components/schemas/Clock' description: pattern: ^[^<>]{1,32}$ type: string description: Set a text description of the device example: System settings deviceGroups: type: array description: Configure device groups items: type: string description: Configure device groups gpsLocation: required: - latitude - longitude type: object properties: latitude: maximum: 90 minimum: -90 type: number description: Set the device’s physical latitude example: 60 longitude: maximum: 180 minimum: -180 type: number description: Set the device’s physical longitude example: 60 description: GPS latitude and longitude of the device $$ref: '#/components/schemas/GpsLocation' hostName: pattern: ^[a-zA-Z0-9\-_]{1,32}$ type: string description: Set the hostname example: vm12 location: pattern: ^[^<>]{1,127}$ type: string description: Set the location of the device example: USA siteId: maximum: 4294967295 minimum: 0 type: integer description: Set the site ID format: int64 example: 100 systemIp: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: Set the system IP address example: 102.2.3.2 vbond: required: - address type: object properties: address: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: Set the vBond IP address example: 10.0.12.22 $$ref: '#/components/schemas/Vbond' description: System configuration for validator $$ref: '#/components/schemas/ValidatorSystemSetting' vpn: required: - transport type: object properties: management: required: - interface type: object properties: dns: type: object properties: dnsServerPrimary: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: Primary DNS server IPv4 or IPv6 Address example: 10.2.2.2 dnsServerSecondary: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: Secondary DNS server IPv4 or IPv6 Address example: 10.2.2.3 host: type: array items: required: - hostname - ip type: object properties: hostname: pattern: ^[a-zA-Z0-9\-_.]{1,64}$ type: string description: Host name example: vbond ip: maxItems: 64 minItems: 1 uniqueItems: true type: array items: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: IP Address example: 10.1.1.1 description: Static host mapping $$ref: '#/components/schemas/DnsHostMapping' description: Configure DNS servers or static host mapping $$ref: '#/components/schemas/ControlComponentDnsSetting' interface: maxItems: 2147483647 minItems: 1 type: array items: required: - ifName type: object properties: ifName: pattern: ^(?=.{1,32}$)(?:(ge0\/\d+(?:\.\d+)?|loopback\d+|eth\d+(?:\.\d+)?))$ type: string description: Interface name eth<0-..> or eth<0-..>.vlanid or loopback when present example: eth0 ip: type: object properties: address: pattern: ^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\/)([0-2]?[0-9]$|[3]?[0-2])$ type: string description: Assign IPv4 address example: 10.0.1.1/24 dhcpClient: type: boolean description: Enable DHCP example: false default: false dhcpDistance: maximum: 65536 minimum: 1 type: integer description: Set administrative distance for DHCP default route format: int32 example: 1 default: 1 description: IPv4 address or DHCP $$ref: '#/components/schemas/IpConfig' ipv6: type: object properties: address: pattern: ((^\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:)))(%.+)?\s*(\/)(\b([0-9]{1,2}|1[01][0-9]|12[0-8])\b)$)) type: string description: Assign IPv6 address example: 2001:a0:64::20/64 dhcpClient: type: boolean description: Enable DHCP example: false default: false dhcpDistance: maximum: 65536 minimum: 1 type: integer description: Set administrative distance for DHCP default route format: int32 example: 1 default: 1 dhcpRapidCommit: type: boolean description: Enable DHCPv6 rapid commit example: false default: false description: IPv6 address or DHCP $$ref: '#/components/schemas/Ipv6Config' shutdown: type: boolean description: Administrative state example: false default: false description: Interfaces configuration $$ref: '#/components/schemas/BaseInterfaceSetting' ipRoute: type: object properties: route: type: array items: required: - nextHop - prefix type: object properties: nextHop: maxItems: 2147483647 minItems: 1 type: array items: required: - address type: object properties: address: pattern: ^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$ type: string description: IPv4 Address example: 10.0.0.1 distance: maximum: 255 minimum: 1 type: integer description: Administrative distance format: int32 example: 1 default: 1 description: IP gateway address $$ref: '#/components/schemas/NextHop' prefix: pattern: ^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\/)([0-2]?[0-9]$|[3]?[0-2])$ type: string description: IPv4 Prefix example: 0.0.0.0/0 description: Configure static routes $$ref: '#/components/schemas/StaticRoute' description: IP Route information $$ref: '#/components/schemas/IpRoute' ipv6Route: type: object properties: route: type: array items: required: - nextHop - prefix type: object properties: nextHop: maxItems: 2147483647 minItems: 1 type: array items: required: - address type: object properties: address: pattern: (([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)) type: string description: IPv6 Address example: 2001::1 distance: maximum: 255 minimum: 1 type: integer description: Administrative distance format: int32 example: 1 default: 1 description: IP gateway address $$ref: '#/components/schemas/IPV6NextHop' prefix: pattern: ((^\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:)))(%.+)?\s*(\/)(\b([0-9]{1,2}|1[01][0-9]|12[0-8])\b)$)) type: string description: IPv6 Prefix example: 2001::/4 description: Configure IPv6 static routes $$ref: '#/components/schemas/Ipv6StaticRoute' description: IPv6 Route information $$ref: '#/components/schemas/Ipv6Route' description: Management VPN instance $$ref: '#/components/schemas/baseVpnInstanceBaseInterfaceSetting' transport: required: - interface type: object properties: dns: type: object properties: dnsServerPrimary: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: Primary DNS server IPv4 or IPv6 Address example: 10.2.2.2 dnsServerSecondary: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: Secondary DNS server IPv4 or IPv6 Address example: 10.2.2.3 host: type: array items: required: - hostname - ip type: object properties: hostname: pattern: ^[a-zA-Z0-9\-_.]{1,64}$ type: string description: Host name example: vbond ip: maxItems: 64 minItems: 1 uniqueItems: true type: array items: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: IP Address example: 10.1.1.1 description: Static host mapping $$ref: '#/components/schemas/DnsHostMapping' description: Configure DNS servers or static host mapping $$ref: '#/components/schemas/ControlComponentDnsSetting' interface: maxItems: 2147483647 minItems: 1 type: array items: required: - ifName type: object properties: ifName: pattern: ^(?=.{1,32}$)(?:(ge0\/\d+(?:\.\d+)?|loopback\d+|eth\d+(?:\.\d+)?))$ type: string description: Interface name eth<0-..> or eth<0-..>.vlanid or loopback when present example: eth0 ip: type: object properties: address: pattern: ^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\/)([0-2]?[0-9]$|[3]?[0-2])$ type: string description: Assign IPv4 address example: 10.0.1.1/24 dhcpClient: type: boolean description: Enable DHCP example: false default: false dhcpDistance: maximum: 65536 minimum: 1 type: integer description: Set administrative distance for DHCP default route format: int32 example: 1 default: 1 description: IPv4 address or DHCP $$ref: '#/components/schemas/IpConfig' ipv6: type: object properties: address: pattern: ((^\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:)))(%.+)?\s*(\/)(\b([0-9]{1,2}|1[01][0-9]|12[0-8])\b)$)) type: string description: Assign IPv6 address example: 2001:a0:64::20/64 dhcpClient: type: boolean description: Enable DHCP example: false default: false dhcpDistance: maximum: 65536 minimum: 1 type: integer description: Set administrative distance for DHCP default route format: int32 example: 1 default: 1 dhcpRapidCommit: type: boolean description: Enable DHCPv6 rapid commit example: false default: false description: IPv6 address or DHCP $$ref: '#/components/schemas/Ipv6Config' shutdown: type: boolean description: Administrative state example: false default: false tunnelInterface: type: object properties: allowService: type: object properties: all: type: boolean description: Allow all traffic. Overrides all other allow-service options if allow-service all is set example: false default: false dhcp: type: boolean description: Allow/Deny DHCP example: true default: true dns: type: boolean description: Allow/Deny DNS example: true default: true icmp: type: boolean description: Allow/Deny ICMP example: true default: true netconf: type: boolean description: Allow/Deny NETCONF example: false default: false ntp: type: boolean description: Allow/Deny NTP example: false default: false sshd: type: boolean description: Allow/Deny SSH example: false default: false stun: type: boolean description: Allow/Deny STUN example: false default: false description: Set services allowed on the WAN interface $$ref: '#/components/schemas/AllowService' color: type: object properties: value: type: string description: Set color for TLOC example: default enum: - default - mpls - metro-ethernet - biz-internet - public-internet - lte - 3g - red - green - blue - gold - silver - bronze - custom1 - custom2 - custom3 - private1 - private2 - private3 - private4 - private5 - private6 default: default description: Set color for TLOC $$ref: '#/components/schemas/Color' description: Tunnel interface configuration $$ref: '#/components/schemas/TunnelInterface' description: Interfaces configuration $$ref: '#/components/schemas/TransportInterfaceSetting' ipRoute: type: object properties: route: type: array items: required: - nextHop - prefix type: object properties: nextHop: maxItems: 2147483647 minItems: 1 type: array items: required: - address type: object properties: address: pattern: ^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$ type: string description: IPv4 Address example: 10.0.0.1 distance: maximum: 255 minimum: 1 type: integer description: Administrative distance format: int32 example: 1 default: 1 description: IP gateway address $$ref: '#/components/schemas/NextHop' prefix: pattern: ^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\/)([0-2]?[0-9]$|[3]?[0-2])$ type: string description: IPv4 Prefix example: 0.0.0.0/0 description: Configure static routes $$ref: '#/components/schemas/StaticRoute' description: IP Route information $$ref: '#/components/schemas/IpRoute' ipv6Route: type: object properties: route: type: array items: required: - nextHop - prefix type: object properties: nextHop: maxItems: 2147483647 minItems: 1 type: array items: required: - address type: object properties: address: pattern: (([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)) type: string description: IPv6 Address example: 2001::1 distance: maximum: 255 minimum: 1 type: integer description: Administrative distance format: int32 example: 1 default: 1 description: IP gateway address $$ref: '#/components/schemas/IPV6NextHop' prefix: pattern: ((^\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:)))(%.+)?\s*(\/)(\b([0-9]{1,2}|1[01][0-9]|12[0-8])\b)$)) type: string description: IPv6 Prefix example: 2001::/4 description: Configure IPv6 static routes $$ref: '#/components/schemas/Ipv6StaticRoute' description: IPv6 Route information $$ref: '#/components/schemas/Ipv6Route' description: Transport VPN instance $$ref: '#/components/schemas/baseVpnInstanceTransportInterfaceSetting' description: Validator VPN setting $$ref: '#/components/schemas/ValidatorVpnSetting' description: The payload for validator device specific settings $$ref: '#/components/schemas/ValidatorDeviceSpecificSetting' - required: - system - vpn type: object properties: system: required: - hostName - siteId - systemIp type: object properties: clock: required: - timezone type: object properties: timezone: type: string description: Set the timezone example: UTC enum: - Europe/Andorra - Asia/Dubai - Asia/Kabul - America/Antigua - America/Anguilla - Europe/Tirane - Asia/Yerevan - Africa/Luanda - Antarctica/McMurdo - Antarctica/Rothera - Antarctica/Palmer - Antarctica/Mawson - Antarctica/Davis - Antarctica/Casey - Antarctica/Vostok - Antarctica/DumontDUrville - Antarctica/Syowa - America/Argentina/Buenos_Aires - America/Argentina/Cordoba - America/Argentina/Salta - America/Argentina/Jujuy - America/Argentina/Tucuman - America/Argentina/Catamarca - America/Argentina/La_Rioja - America/Argentina/San_Juan - America/Argentina/Mendoza - America/Argentina/San_Luis - America/Argentina/Rio_Gallegos - America/Argentina/Ushuaia - Pacific/Pago_Pago - Europe/Vienna - Australia/Lord_Howe - Antarctica/Macquarie - Australia/Hobart - Australia/Currie - Australia/Melbourne - Australia/Sydney - Australia/Broken_Hill - Australia/Brisbane - Australia/Lindeman - Australia/Adelaide - Australia/Darwin - Australia/Perth - Australia/Eucla - America/Aruba - Europe/Mariehamn - Asia/Baku - Europe/Sarajevo - America/Barbados - Asia/Dhaka - Europe/Brussels - Africa/Ouagadougou - Europe/Sofia - Asia/Bahrain - Africa/Bujumbura - Africa/Porto-Novo - America/St_Barthelemy - Atlantic/Bermuda - Asia/Brunei - America/La_Paz - America/Kralendijk - America/Noronha - America/Belem - America/Fortaleza - America/Recife - America/Araguaina - America/Maceio - America/Bahia - America/Sao_Paulo - America/Campo_Grande - America/Cuiaba - America/Santarem - America/Porto_Velho - America/Boa_Vista - America/Manaus - America/Eirunepe - America/Rio_Branco - America/Nassau - Asia/Thimphu - Africa/Gaborone - Europe/Minsk - America/Belize - America/St_Johns - America/Halifax - America/Glace_Bay - America/Moncton - America/Goose_Bay - America/Blanc-Sablon - America/Toronto - America/Nipigon - America/Thunder_Bay - America/Iqaluit - America/Pangnirtung - America/Resolute - America/Atikokan - America/Rankin_Inlet - America/Winnipeg - America/Rainy_River - America/Regina - America/Swift_Current - America/Edmonton - America/Cambridge_Bay - America/Yellowknife - America/Inuvik - America/Creston - America/Dawson_Creek - America/Vancouver - America/Whitehorse - America/Dawson - Indian/Cocos - Africa/Kinshasa - Africa/Lubumbashi - Africa/Bangui - Africa/Brazzaville - Europe/Zurich - Africa/Abidjan - Pacific/Rarotonga - America/Santiago - Pacific/Easter - Africa/Douala - Asia/Shanghai - Asia/Harbin - Asia/Chongqing - Asia/Urumqi - Asia/Kashgar - America/Bogota - America/Costa_Rica - America/Havana - Atlantic/Cape_Verde - America/Curacao - Indian/Christmas - Asia/Nicosia - Europe/Prague - Europe/Berlin - Europe/Busingen - Africa/Djibouti - Europe/Copenhagen - America/Dominica - America/Santo_Domingo - Africa/Algiers - America/Guayaquil - Pacific/Galapagos - Europe/Tallinn - Africa/Cairo - Africa/El_Aaiun - Africa/Asmara - Europe/Madrid - Africa/Ceuta - Atlantic/Canary - Africa/Addis_Ababa - Europe/Helsinki - Pacific/Fiji - Atlantic/Stanley - Pacific/Chuuk - Pacific/Pohnpei - Pacific/Kosrae - Atlantic/Faroe - Europe/Paris - Africa/Libreville - Europe/London - America/Grenada - Asia/Tbilisi - America/Cayenne - Europe/Guernsey - Africa/Accra - Europe/Gibraltar - America/Godthab - America/Danmarkshavn - America/Scoresbysund - America/Thule - Africa/Banjul - Africa/Conakry - America/Guadeloupe - Africa/Malabo - Europe/Athens - Atlantic/South_Georgia - America/Guatemala - Pacific/Guam - Africa/Bissau - America/Guyana - Asia/Hong_Kong - America/Tegucigalpa - Europe/Zagreb - America/Port-au-Prince - Europe/Budapest - Asia/Jakarta - Asia/Pontianak - Asia/Makassar - Asia/Jayapura - Europe/Dublin - Asia/Jerusalem - Europe/Isle_of_Man - Asia/Kolkata - Indian/Chagos - Asia/Baghdad - Asia/Tehran - Atlantic/Reykjavik - Europe/Rome - Europe/Jersey - America/Jamaica - Asia/Amman - Asia/Tokyo - Africa/Nairobi - Asia/Bishkek - Asia/Phnom_Penh - Pacific/Tarawa - Pacific/Enderbury - Pacific/Kiritimati - Indian/Comoro - America/St_Kitts - Asia/Pyongyang - Asia/Seoul - Asia/Kuwait - America/Cayman - Asia/Almaty - Asia/Qyzylorda - Asia/Aqtobe - Asia/Aqtau - Asia/Oral - Asia/Vientiane - Asia/Beirut - America/St_Lucia - Europe/Vaduz - Asia/Colombo - Africa/Monrovia - Africa/Maseru - Europe/Vilnius - Europe/Luxembourg - Europe/Riga - Africa/Tripoli - Africa/Casablanca - Europe/Monaco - Europe/Chisinau - Europe/Podgorica - America/Marigot - Indian/Antananarivo - Pacific/Majuro - Pacific/Kwajalein - Europe/Skopje - Africa/Bamako - Asia/Rangoon - Asia/Ulaanbaatar - Asia/Hovd - Asia/Choibalsan - Asia/Macau - Pacific/Saipan - America/Martinique - Africa/Nouakchott - America/Montserrat - Europe/Malta - Indian/Mauritius - Indian/Maldives - Africa/Blantyre - America/Mexico_City - America/Cancun - America/Merida - America/Monterrey - America/Matamoros - America/Mazatlan - America/Chihuahua - America/Ojinaga - America/Hermosillo - America/Tijuana - America/Santa_Isabel - America/Bahia_Banderas - Asia/Kuala_Lumpur - Asia/Kuching - Africa/Maputo - Africa/Windhoek - Pacific/Noumea - Africa/Niamey - Pacific/Norfolk - Africa/Lagos - America/Managua - Europe/Amsterdam - Europe/Oslo - Asia/Kathmandu - Pacific/Nauru - Pacific/Niue - Pacific/Auckland - Pacific/Chatham - Asia/Muscat - America/Panama - America/Lima - Pacific/Tahiti - Pacific/Marquesas - Pacific/Gambier - Pacific/Port_Moresby - Asia/Manila - Asia/Karachi - Europe/Warsaw - America/Miquelon - Pacific/Pitcairn - America/Puerto_Rico - Asia/Gaza - Asia/Hebron - Europe/Lisbon - Atlantic/Madeira - Atlantic/Azores - Pacific/Palau - America/Asuncion - Asia/Qatar - Indian/Reunion - Europe/Bucharest - Europe/Belgrade - Europe/Kaliningrad - Europe/Moscow - Europe/Volgograd - Europe/Samara - Asia/Yekaterinburg - Asia/Omsk - Asia/Novosibirsk - Asia/Novokuznetsk - Asia/Krasnoyarsk - Asia/Irkutsk - Asia/Yakutsk - Asia/Khandyga - Asia/Vladivostok - Asia/Sakhalin - Asia/Ust-Nera - Asia/Magadan - Asia/Kamchatka - Asia/Anadyr - Africa/Kigali - Asia/Riyadh - Pacific/Guadalcanal - Indian/Mahe - Africa/Khartoum - Europe/Stockholm - Asia/Singapore - Atlantic/St_Helena - Europe/Ljubljana - Arctic/Longyearbyen - Europe/Bratislava - Africa/Freetown - Europe/San_Marino - Africa/Dakar - Africa/Mogadishu - America/Paramaribo - Africa/Juba - Africa/Sao_Tome - America/El_Salvador - America/Lower_Princes - Asia/Damascus - Africa/Mbabane - America/Grand_Turk - Africa/Ndjamena - Indian/Kerguelen - Africa/Lome - Asia/Bangkok - Asia/Dushanbe - Pacific/Fakaofo - Asia/Dili - Asia/Ashgabat - Africa/Tunis - Pacific/Tongatapu - Europe/Istanbul - America/Port_of_Spain - Pacific/Funafuti - Asia/Taipei - Africa/Dar_es_Salaam - Europe/Kiev - Europe/Uzhgorod - Europe/Zaporozhye - Europe/Simferopol - Africa/Kampala - Pacific/Johnston - Pacific/Midway - Pacific/Wake - America/New_York - America/Detroit - America/Kentucky/Louisville - America/Kentucky/Monticello - America/Indiana/Indianapolis - America/Indiana/Vincennes - America/Indiana/Winamac - America/Indiana/Marengo - America/Indiana/Petersburg - America/Indiana/Vevay - America/Chicago - America/Indiana/Tell_City - America/Indiana/Knox - America/Menominee - America/North_Dakota/Center - America/North_Dakota/New_Salem - America/North_Dakota/Beulah - America/Denver - America/Boise - America/Phoenix - America/Los_Angeles - America/Anchorage - America/Juneau - America/Sitka - America/Yakutat - America/Nome - America/Adak - America/Metlakatla - Pacific/Honolulu - America/Montevideo - Asia/Samarkand - Asia/Tashkent - Europe/Vatican - America/St_Vincent - America/Caracas - America/Tortola - America/St_Thomas - Asia/Ho_Chi_Minh - Pacific/Efate - Pacific/Wallis - Pacific/Apia - Asia/Aden - Indian/Mayotte - Africa/Johannesburg - Africa/Lusaka - Africa/Harare - UTC default: UTC description: Configure clock $$ref: '#/components/schemas/Clock' controllerGroupId: maximum: 100 minimum: 0 type: integer description: Controller group id format: int32 example: 0 default: 0 description: pattern: ^[^<>]{1,32}$ type: string description: Set a text description of the device example: System settings deviceGroups: type: array description: Configure device groups items: type: string description: Configure device groups gpsLocation: required: - latitude - longitude type: object properties: latitude: maximum: 90 minimum: -90 type: number description: Set the device’s physical latitude example: 60 longitude: maximum: 180 minimum: -180 type: number description: Set the device’s physical longitude example: 60 description: GPS latitude and longitude of the device $$ref: '#/components/schemas/GpsLocation' hostName: pattern: ^[a-zA-Z0-9\-_]{1,32}$ type: string description: Set the hostname example: vm12 ipv6StrictControl: type: boolean description: Sets up a strict IPv6 control connection in a dual stack IP example: false default: false location: pattern: ^[^<>]{1,127}$ type: string description: Set the location of the device example: USA overlayId: maximum: 4294967295 minimum: 1 type: integer description: Set the Overlay ID format: int64 example: 1 default: 1 region: type: object properties: regionIdList: maxItems: 2147483647 minItems: 1 uniqueItems: true type: array items: maximum: 63 minimum: 0 type: integer description: Configure a list of region ID format: int32 example: 0 $$ref: '#/components/schemas/Region' siteId: maximum: 4294967295 minimum: 0 type: integer description: Set the site ID format: int64 example: 100 systemIp: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: Set the system IP address example: 102.2.3.2 description: System configuration for controller $$ref: '#/components/schemas/ControllerSystemSetting' vpn: required: - transport type: object properties: management: required: - interface type: object properties: dns: type: object properties: dnsServerPrimary: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: Primary DNS server IPv4 or IPv6 Address example: 10.2.2.2 dnsServerSecondary: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: Secondary DNS server IPv4 or IPv6 Address example: 10.2.2.3 host: type: array items: required: - hostname - ip type: object properties: hostname: pattern: ^[a-zA-Z0-9\-_.]{1,64}$ type: string description: Host name example: vbond ip: maxItems: 64 minItems: 1 uniqueItems: true type: array items: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: IP Address example: 10.1.1.1 description: Static host mapping $$ref: '#/components/schemas/DnsHostMapping' description: Configure DNS servers or static host mapping $$ref: '#/components/schemas/ControlComponentDnsSetting' interface: maxItems: 2147483647 minItems: 1 type: array items: required: - ifName type: object properties: ifName: pattern: ^(?=.{1,32}$)(?:(ge0\/\d+(?:\.\d+)?|loopback\d+|eth\d+(?:\.\d+)?))$ type: string description: Interface name eth<0-..> or eth<0-..>.vlanid or loopback when present example: eth0 ip: type: object properties: address: pattern: ^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\/)([0-2]?[0-9]$|[3]?[0-2])$ type: string description: Assign IPv4 address example: 10.0.1.1/24 dhcpClient: type: boolean description: Enable DHCP example: false default: false dhcpDistance: maximum: 65536 minimum: 1 type: integer description: Set administrative distance for DHCP default route format: int32 example: 1 default: 1 description: IPv4 address or DHCP $$ref: '#/components/schemas/IpConfig' ipv6: type: object properties: address: pattern: ((^\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:)))(%.+)?\s*(\/)(\b([0-9]{1,2}|1[01][0-9]|12[0-8])\b)$)) type: string description: Assign IPv6 address example: 2001:a0:64::20/64 dhcpClient: type: boolean description: Enable DHCP example: false default: false dhcpDistance: maximum: 65536 minimum: 1 type: integer description: Set administrative distance for DHCP default route format: int32 example: 1 default: 1 dhcpRapidCommit: type: boolean description: Enable DHCPv6 rapid commit example: false default: false description: IPv6 address or DHCP $$ref: '#/components/schemas/Ipv6Config' shutdown: type: boolean description: Administrative state example: false default: false description: Interfaces configuration $$ref: '#/components/schemas/BaseInterfaceSetting' ipRoute: type: object properties: route: type: array items: required: - nextHop - prefix type: object properties: nextHop: maxItems: 2147483647 minItems: 1 type: array items: required: - address type: object properties: address: pattern: ^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$ type: string description: IPv4 Address example: 10.0.0.1 distance: maximum: 255 minimum: 1 type: integer description: Administrative distance format: int32 example: 1 default: 1 description: IP gateway address $$ref: '#/components/schemas/NextHop' prefix: pattern: ^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\/)([0-2]?[0-9]$|[3]?[0-2])$ type: string description: IPv4 Prefix example: 0.0.0.0/0 description: Configure static routes $$ref: '#/components/schemas/StaticRoute' description: IP Route information $$ref: '#/components/schemas/IpRoute' ipv6Route: type: object properties: route: type: array items: required: - nextHop - prefix type: object properties: nextHop: maxItems: 2147483647 minItems: 1 type: array items: required: - address type: object properties: address: pattern: (([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)) type: string description: IPv6 Address example: 2001::1 distance: maximum: 255 minimum: 1 type: integer description: Administrative distance format: int32 example: 1 default: 1 description: IP gateway address $$ref: '#/components/schemas/IPV6NextHop' prefix: pattern: ((^\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:)))(%.+)?\s*(\/)(\b([0-9]{1,2}|1[01][0-9]|12[0-8])\b)$)) type: string description: IPv6 Prefix example: 2001::/4 description: Configure IPv6 static routes $$ref: '#/components/schemas/Ipv6StaticRoute' description: IPv6 Route information $$ref: '#/components/schemas/Ipv6Route' description: Management VPN instance $$ref: '#/components/schemas/baseVpnInstanceBaseInterfaceSetting' transport: required: - interface type: object properties: dns: type: object properties: dnsServerPrimary: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: Primary DNS server IPv4 or IPv6 Address example: 10.2.2.2 dnsServerSecondary: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: Secondary DNS server IPv4 or IPv6 Address example: 10.2.2.3 host: type: array items: required: - hostname - ip type: object properties: hostname: pattern: ^[a-zA-Z0-9\-_.]{1,64}$ type: string description: Host name example: vbond ip: maxItems: 64 minItems: 1 uniqueItems: true type: array items: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: IP Address example: 10.1.1.1 description: Static host mapping $$ref: '#/components/schemas/DnsHostMapping' description: Configure DNS servers or static host mapping $$ref: '#/components/schemas/ControlComponentDnsSetting' interface: maxItems: 2147483647 minItems: 1 type: array items: required: - ifName type: object properties: ifName: pattern: ^(?=.{1,32}$)(?:(ge0\/\d+(?:\.\d+)?|loopback\d+|eth\d+(?:\.\d+)?))$ type: string description: Interface name eth<0-..> or eth<0-..>.vlanid or loopback when present example: eth0 ip: type: object properties: address: pattern: ^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\/)([0-2]?[0-9]$|[3]?[0-2])$ type: string description: Assign IPv4 address example: 10.0.1.1/24 dhcpClient: type: boolean description: Enable DHCP example: false default: false dhcpDistance: maximum: 65536 minimum: 1 type: integer description: Set administrative distance for DHCP default route format: int32 example: 1 default: 1 description: IPv4 address or DHCP $$ref: '#/components/schemas/IpConfig' ipv6: type: object properties: address: pattern: ((^\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:)))(%.+)?\s*(\/)(\b([0-9]{1,2}|1[01][0-9]|12[0-8])\b)$)) type: string description: Assign IPv6 address example: 2001:a0:64::20/64 dhcpClient: type: boolean description: Enable DHCP example: false default: false dhcpDistance: maximum: 65536 minimum: 1 type: integer description: Set administrative distance for DHCP default route format: int32 example: 1 default: 1 dhcpRapidCommit: type: boolean description: Enable DHCPv6 rapid commit example: false default: false description: IPv6 address or DHCP $$ref: '#/components/schemas/Ipv6Config' shutdown: type: boolean description: Administrative state example: false default: false tunnelInterface: type: object properties: allowService: type: object properties: all: type: boolean description: Allow all traffic. Overrides all other allow-service options if allow-service all is set example: false default: false dhcp: type: boolean description: Allow/Deny DHCP example: true default: true dns: type: boolean description: Allow/Deny DNS example: true default: true icmp: type: boolean description: Allow/Deny ICMP example: true default: true netconf: type: boolean description: Allow/Deny NETCONF example: false default: false ntp: type: boolean description: Allow/Deny NTP example: false default: false sshd: type: boolean description: Allow/Deny SSH example: false default: false stun: type: boolean description: Allow/Deny STUN example: false default: false description: Set services allowed on the WAN interface $$ref: '#/components/schemas/AllowService' color: type: object properties: value: type: string description: Set color for TLOC example: default enum: - default - mpls - metro-ethernet - biz-internet - public-internet - lte - 3g - red - green - blue - gold - silver - bronze - custom1 - custom2 - custom3 - private1 - private2 - private3 - private4 - private5 - private6 default: default description: Set color for TLOC $$ref: '#/components/schemas/Color' description: Tunnel interface configuration $$ref: '#/components/schemas/TunnelInterface' description: Interfaces configuration $$ref: '#/components/schemas/TransportInterfaceSetting' ipRoute: type: object properties: route: type: array items: required: - nextHop - prefix type: object properties: nextHop: maxItems: 2147483647 minItems: 1 type: array items: required: - address type: object properties: address: pattern: ^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$ type: string description: IPv4 Address example: 10.0.0.1 distance: maximum: 255 minimum: 1 type: integer description: Administrative distance format: int32 example: 1 default: 1 description: IP gateway address $$ref: '#/components/schemas/NextHop' prefix: pattern: ^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\/)([0-2]?[0-9]$|[3]?[0-2])$ type: string description: IPv4 Prefix example: 0.0.0.0/0 description: Configure static routes $$ref: '#/components/schemas/StaticRoute' description: IP Route information $$ref: '#/components/schemas/IpRoute' ipv6Route: type: object properties: route: type: array items: required: - nextHop - prefix type: object properties: nextHop: maxItems: 2147483647 minItems: 1 type: array items: required: - address type: object properties: address: pattern: (([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)) type: string description: IPv6 Address example: 2001::1 distance: maximum: 255 minimum: 1 type: integer description: Administrative distance format: int32 example: 1 default: 1 description: IP gateway address $$ref: '#/components/schemas/IPV6NextHop' prefix: pattern: ((^\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:)))(%.+)?\s*(\/)(\b([0-9]{1,2}|1[01][0-9]|12[0-8])\b)$)) type: string description: IPv6 Prefix example: 2001::/4 description: Configure IPv6 static routes $$ref: '#/components/schemas/Ipv6StaticRoute' description: IPv6 Route information $$ref: '#/components/schemas/Ipv6Route' description: Transport VPN instance $$ref: '#/components/schemas/baseVpnInstanceTransportInterfaceSetting' description: Controller VPN setting $$ref: '#/components/schemas/ControllerVpnSetting' description: The payload for controller device specific settings $$ref: '#/components/schemas/ControllerDeviceSpecificSetting' - required: - system - vpn type: object properties: system: required: - hostName - siteId - systemIp type: object properties: clock: required: - timezone type: object properties: timezone: type: string description: Set the timezone example: UTC enum: - Europe/Andorra - Asia/Dubai - Asia/Kabul - America/Antigua - America/Anguilla - Europe/Tirane - Asia/Yerevan - Africa/Luanda - Antarctica/McMurdo - Antarctica/Rothera - Antarctica/Palmer - Antarctica/Mawson - Antarctica/Davis - Antarctica/Casey - Antarctica/Vostok - Antarctica/DumontDUrville - Antarctica/Syowa - America/Argentina/Buenos_Aires - America/Argentina/Cordoba - America/Argentina/Salta - America/Argentina/Jujuy - America/Argentina/Tucuman - America/Argentina/Catamarca - America/Argentina/La_Rioja - America/Argentina/San_Juan - America/Argentina/Mendoza - America/Argentina/San_Luis - America/Argentina/Rio_Gallegos - America/Argentina/Ushuaia - Pacific/Pago_Pago - Europe/Vienna - Australia/Lord_Howe - Antarctica/Macquarie - Australia/Hobart - Australia/Currie - Australia/Melbourne - Australia/Sydney - Australia/Broken_Hill - Australia/Brisbane - Australia/Lindeman - Australia/Adelaide - Australia/Darwin - Australia/Perth - Australia/Eucla - America/Aruba - Europe/Mariehamn - Asia/Baku - Europe/Sarajevo - America/Barbados - Asia/Dhaka - Europe/Brussels - Africa/Ouagadougou - Europe/Sofia - Asia/Bahrain - Africa/Bujumbura - Africa/Porto-Novo - America/St_Barthelemy - Atlantic/Bermuda - Asia/Brunei - America/La_Paz - America/Kralendijk - America/Noronha - America/Belem - America/Fortaleza - America/Recife - America/Araguaina - America/Maceio - America/Bahia - America/Sao_Paulo - America/Campo_Grande - America/Cuiaba - America/Santarem - America/Porto_Velho - America/Boa_Vista - America/Manaus - America/Eirunepe - America/Rio_Branco - America/Nassau - Asia/Thimphu - Africa/Gaborone - Europe/Minsk - America/Belize - America/St_Johns - America/Halifax - America/Glace_Bay - America/Moncton - America/Goose_Bay - America/Blanc-Sablon - America/Toronto - America/Nipigon - America/Thunder_Bay - America/Iqaluit - America/Pangnirtung - America/Resolute - America/Atikokan - America/Rankin_Inlet - America/Winnipeg - America/Rainy_River - America/Regina - America/Swift_Current - America/Edmonton - America/Cambridge_Bay - America/Yellowknife - America/Inuvik - America/Creston - America/Dawson_Creek - America/Vancouver - America/Whitehorse - America/Dawson - Indian/Cocos - Africa/Kinshasa - Africa/Lubumbashi - Africa/Bangui - Africa/Brazzaville - Europe/Zurich - Africa/Abidjan - Pacific/Rarotonga - America/Santiago - Pacific/Easter - Africa/Douala - Asia/Shanghai - Asia/Harbin - Asia/Chongqing - Asia/Urumqi - Asia/Kashgar - America/Bogota - America/Costa_Rica - America/Havana - Atlantic/Cape_Verde - America/Curacao - Indian/Christmas - Asia/Nicosia - Europe/Prague - Europe/Berlin - Europe/Busingen - Africa/Djibouti - Europe/Copenhagen - America/Dominica - America/Santo_Domingo - Africa/Algiers - America/Guayaquil - Pacific/Galapagos - Europe/Tallinn - Africa/Cairo - Africa/El_Aaiun - Africa/Asmara - Europe/Madrid - Africa/Ceuta - Atlantic/Canary - Africa/Addis_Ababa - Europe/Helsinki - Pacific/Fiji - Atlantic/Stanley - Pacific/Chuuk - Pacific/Pohnpei - Pacific/Kosrae - Atlantic/Faroe - Europe/Paris - Africa/Libreville - Europe/London - America/Grenada - Asia/Tbilisi - America/Cayenne - Europe/Guernsey - Africa/Accra - Europe/Gibraltar - America/Godthab - America/Danmarkshavn - America/Scoresbysund - America/Thule - Africa/Banjul - Africa/Conakry - America/Guadeloupe - Africa/Malabo - Europe/Athens - Atlantic/South_Georgia - America/Guatemala - Pacific/Guam - Africa/Bissau - America/Guyana - Asia/Hong_Kong - America/Tegucigalpa - Europe/Zagreb - America/Port-au-Prince - Europe/Budapest - Asia/Jakarta - Asia/Pontianak - Asia/Makassar - Asia/Jayapura - Europe/Dublin - Asia/Jerusalem - Europe/Isle_of_Man - Asia/Kolkata - Indian/Chagos - Asia/Baghdad - Asia/Tehran - Atlantic/Reykjavik - Europe/Rome - Europe/Jersey - America/Jamaica - Asia/Amman - Asia/Tokyo - Africa/Nairobi - Asia/Bishkek - Asia/Phnom_Penh - Pacific/Tarawa - Pacific/Enderbury - Pacific/Kiritimati - Indian/Comoro - America/St_Kitts - Asia/Pyongyang - Asia/Seoul - Asia/Kuwait - America/Cayman - Asia/Almaty - Asia/Qyzylorda - Asia/Aqtobe - Asia/Aqtau - Asia/Oral - Asia/Vientiane - Asia/Beirut - America/St_Lucia - Europe/Vaduz - Asia/Colombo - Africa/Monrovia - Africa/Maseru - Europe/Vilnius - Europe/Luxembourg - Europe/Riga - Africa/Tripoli - Africa/Casablanca - Europe/Monaco - Europe/Chisinau - Europe/Podgorica - America/Marigot - Indian/Antananarivo - Pacific/Majuro - Pacific/Kwajalein - Europe/Skopje - Africa/Bamako - Asia/Rangoon - Asia/Ulaanbaatar - Asia/Hovd - Asia/Choibalsan - Asia/Macau - Pacific/Saipan - America/Martinique - Africa/Nouakchott - America/Montserrat - Europe/Malta - Indian/Mauritius - Indian/Maldives - Africa/Blantyre - America/Mexico_City - America/Cancun - America/Merida - America/Monterrey - America/Matamoros - America/Mazatlan - America/Chihuahua - America/Ojinaga - America/Hermosillo - America/Tijuana - America/Santa_Isabel - America/Bahia_Banderas - Asia/Kuala_Lumpur - Asia/Kuching - Africa/Maputo - Africa/Windhoek - Pacific/Noumea - Africa/Niamey - Pacific/Norfolk - Africa/Lagos - America/Managua - Europe/Amsterdam - Europe/Oslo - Asia/Kathmandu - Pacific/Nauru - Pacific/Niue - Pacific/Auckland - Pacific/Chatham - Asia/Muscat - America/Panama - America/Lima - Pacific/Tahiti - Pacific/Marquesas - Pacific/Gambier - Pacific/Port_Moresby - Asia/Manila - Asia/Karachi - Europe/Warsaw - America/Miquelon - Pacific/Pitcairn - America/Puerto_Rico - Asia/Gaza - Asia/Hebron - Europe/Lisbon - Atlantic/Madeira - Atlantic/Azores - Pacific/Palau - America/Asuncion - Asia/Qatar - Indian/Reunion - Europe/Bucharest - Europe/Belgrade - Europe/Kaliningrad - Europe/Moscow - Europe/Volgograd - Europe/Samara - Asia/Yekaterinburg - Asia/Omsk - Asia/Novosibirsk - Asia/Novokuznetsk - Asia/Krasnoyarsk - Asia/Irkutsk - Asia/Yakutsk - Asia/Khandyga - Asia/Vladivostok - Asia/Sakhalin - Asia/Ust-Nera - Asia/Magadan - Asia/Kamchatka - Asia/Anadyr - Africa/Kigali - Asia/Riyadh - Pacific/Guadalcanal - Indian/Mahe - Africa/Khartoum - Europe/Stockholm - Asia/Singapore - Atlantic/St_Helena - Europe/Ljubljana - Arctic/Longyearbyen - Europe/Bratislava - Africa/Freetown - Europe/San_Marino - Africa/Dakar - Africa/Mogadishu - America/Paramaribo - Africa/Juba - Africa/Sao_Tome - America/El_Salvador - America/Lower_Princes - Asia/Damascus - Africa/Mbabane - America/Grand_Turk - Africa/Ndjamena - Indian/Kerguelen - Africa/Lome - Asia/Bangkok - Asia/Dushanbe - Pacific/Fakaofo - Asia/Dili - Asia/Ashgabat - Africa/Tunis - Pacific/Tongatapu - Europe/Istanbul - America/Port_of_Spain - Pacific/Funafuti - Asia/Taipei - Africa/Dar_es_Salaam - Europe/Kiev - Europe/Uzhgorod - Europe/Zaporozhye - Europe/Simferopol - Africa/Kampala - Pacific/Johnston - Pacific/Midway - Pacific/Wake - America/New_York - America/Detroit - America/Kentucky/Louisville - America/Kentucky/Monticello - America/Indiana/Indianapolis - America/Indiana/Vincennes - America/Indiana/Winamac - America/Indiana/Marengo - America/Indiana/Petersburg - America/Indiana/Vevay - America/Chicago - America/Indiana/Tell_City - America/Indiana/Knox - America/Menominee - America/North_Dakota/Center - America/North_Dakota/New_Salem - America/North_Dakota/Beulah - America/Denver - America/Boise - America/Phoenix - America/Los_Angeles - America/Anchorage - America/Juneau - America/Sitka - America/Yakutat - America/Nome - America/Adak - America/Metlakatla - Pacific/Honolulu - America/Montevideo - Asia/Samarkand - Asia/Tashkent - Europe/Vatican - America/St_Vincent - America/Caracas - America/Tortola - America/St_Thomas - Asia/Ho_Chi_Minh - Pacific/Efate - Pacific/Wallis - Pacific/Apia - Asia/Aden - Indian/Mayotte - Africa/Johannesburg - Africa/Lusaka - Africa/Harare - UTC default: UTC description: Configure clock $$ref: '#/components/schemas/Clock' description: pattern: ^[^<>]{1,32}$ type: string description: Set a text description of the device example: System settings deviceGroups: type: array description: Configure device groups items: type: string description: Configure device groups gpsLocation: required: - latitude - longitude type: object properties: latitude: maximum: 90 minimum: -90 type: number description: Set the device’s physical latitude example: 60 longitude: maximum: 180 minimum: -180 type: number description: Set the device’s physical longitude example: 60 description: GPS latitude and longitude of the device $$ref: '#/components/schemas/GpsLocation' hostName: pattern: ^[a-zA-Z0-9\-_]{1,32}$ type: string description: Set the hostname example: vm12 ipv6StrictControl: type: boolean description: Enable Dual Stack IPv6 Default example: false default: false location: pattern: ^[^<>]{1,127}$ type: string description: Set the location of the device example: USA siteId: maximum: 4294967295 minimum: 0 type: integer description: Set the site ID format: int64 example: 100 systemIp: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: Set the system IP address example: 102.2.3.2 description: System configuration for manager $$ref: '#/components/schemas/ManagerSystemSetting' vpn: required: - transport type: object properties: management: required: - interface type: object properties: dns: type: object properties: dnsServerPrimary: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: Primary DNS server IPv4 or IPv6 Address example: 10.2.2.2 dnsServerSecondary: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: Secondary DNS server IPv4 or IPv6 Address example: 10.2.2.3 host: type: array items: required: - hostname - ip type: object properties: hostname: pattern: ^[a-zA-Z0-9\-_.]{1,64}$ type: string description: Host name example: vbond ip: maxItems: 64 minItems: 1 uniqueItems: true type: array items: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: IP Address example: 10.1.1.1 description: Static host mapping $$ref: '#/components/schemas/DnsHostMapping' description: Configure DNS servers or static host mapping $$ref: '#/components/schemas/ControlComponentDnsSetting' interface: maxItems: 2147483647 minItems: 1 type: array items: required: - ifName type: object properties: ifName: pattern: ^(?=.{1,32}$)(?:(ge0\/\d+(?:\.\d+)?|loopback\d+|eth\d+(?:\.\d+)?))$ type: string description: Interface name eth<0-..> or eth<0-..>.vlanid or loopback when present example: eth0 ip: type: object properties: address: pattern: ^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\/)([0-2]?[0-9]$|[3]?[0-2])$ type: string description: Assign IPv4 address example: 10.0.1.1/24 dhcpClient: type: boolean description: Enable DHCP example: false default: false dhcpDistance: maximum: 65536 minimum: 1 type: integer description: Set administrative distance for DHCP default route format: int32 example: 1 default: 1 description: IPv4 address or DHCP $$ref: '#/components/schemas/IpConfig' ipv6: type: object properties: address: pattern: ((^\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:)))(%.+)?\s*(\/)(\b([0-9]{1,2}|1[01][0-9]|12[0-8])\b)$)) type: string description: Assign IPv6 address example: 2001:a0:64::20/64 dhcpClient: type: boolean description: Enable DHCP example: false default: false dhcpDistance: maximum: 65536 minimum: 1 type: integer description: Set administrative distance for DHCP default route format: int32 example: 1 default: 1 dhcpRapidCommit: type: boolean description: Enable DHCPv6 rapid commit example: false default: false description: IPv6 address or DHCP $$ref: '#/components/schemas/Ipv6Config' shutdown: type: boolean description: Administrative state example: false default: false description: Interfaces configuration $$ref: '#/components/schemas/BaseInterfaceSetting' ipRoute: type: object properties: route: type: array items: required: - nextHop - prefix type: object properties: nextHop: maxItems: 2147483647 minItems: 1 type: array items: required: - address type: object properties: address: pattern: ^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$ type: string description: IPv4 Address example: 10.0.0.1 distance: maximum: 255 minimum: 1 type: integer description: Administrative distance format: int32 example: 1 default: 1 description: IP gateway address $$ref: '#/components/schemas/NextHop' prefix: pattern: ^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\/)([0-2]?[0-9]$|[3]?[0-2])$ type: string description: IPv4 Prefix example: 0.0.0.0/0 description: Configure static routes $$ref: '#/components/schemas/StaticRoute' description: IP Route information $$ref: '#/components/schemas/IpRoute' ipv6Route: type: object properties: route: type: array items: required: - nextHop - prefix type: object properties: nextHop: maxItems: 2147483647 minItems: 1 type: array items: required: - address type: object properties: address: pattern: (([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)) type: string description: IPv6 Address example: 2001::1 distance: maximum: 255 minimum: 1 type: integer description: Administrative distance format: int32 example: 1 default: 1 description: IP gateway address $$ref: '#/components/schemas/IPV6NextHop' prefix: pattern: ((^\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:)))(%.+)?\s*(\/)(\b([0-9]{1,2}|1[01][0-9]|12[0-8])\b)$)) type: string description: IPv6 Prefix example: 2001::/4 description: Configure IPv6 static routes $$ref: '#/components/schemas/Ipv6StaticRoute' description: IPv6 Route information $$ref: '#/components/schemas/Ipv6Route' description: Management VPN instance $$ref: '#/components/schemas/baseVpnInstanceBaseInterfaceSetting' transport: required: - interface type: object properties: dns: type: object properties: dnsServerPrimary: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: Primary DNS server IPv4 or IPv6 Address example: 10.2.2.2 dnsServerSecondary: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: Secondary DNS server IPv4 or IPv6 Address example: 10.2.2.3 host: type: array items: required: - hostname - ip type: object properties: hostname: pattern: ^[a-zA-Z0-9\-_.]{1,64}$ type: string description: Host name example: vbond ip: maxItems: 64 minItems: 1 uniqueItems: true type: array items: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: IP Address example: 10.1.1.1 description: Static host mapping $$ref: '#/components/schemas/DnsHostMapping' description: Configure DNS servers or static host mapping $$ref: '#/components/schemas/ControlComponentDnsSetting' interface: maxItems: 2147483647 minItems: 1 type: array items: required: - ifName type: object properties: ifName: pattern: ^(?=.{1,32}$)(?:(ge0\/\d+(?:\.\d+)?|loopback\d+|eth\d+(?:\.\d+)?))$ type: string description: Interface name eth<0-..> or eth<0-..>.vlanid or loopback when present example: eth0 ip: type: object properties: address: pattern: ^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\/)([0-2]?[0-9]$|[3]?[0-2])$ type: string description: Assign IPv4 address example: 10.0.1.1/24 dhcpClient: type: boolean description: Enable DHCP example: false default: false dhcpDistance: maximum: 65536 minimum: 1 type: integer description: Set administrative distance for DHCP default route format: int32 example: 1 default: 1 description: IPv4 address or DHCP $$ref: '#/components/schemas/IpConfig' ipv6: type: object properties: address: pattern: ((^\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:)))(%.+)?\s*(\/)(\b([0-9]{1,2}|1[01][0-9]|12[0-8])\b)$)) type: string description: Assign IPv6 address example: 2001:a0:64::20/64 dhcpClient: type: boolean description: Enable DHCP example: false default: false dhcpDistance: maximum: 65536 minimum: 1 type: integer description: Set administrative distance for DHCP default route format: int32 example: 1 default: 1 dhcpRapidCommit: type: boolean description: Enable DHCPv6 rapid commit example: false default: false description: IPv6 address or DHCP $$ref: '#/components/schemas/Ipv6Config' shutdown: type: boolean description: Administrative state example: false default: false tunnelInterface: type: object properties: allowService: type: object properties: all: type: boolean description: Allow all traffic. Overrides all other allow-service options if allow-service all is set example: false default: false dhcp: type: boolean description: Allow/Deny DHCP example: true default: true dns: type: boolean description: Allow/Deny DNS example: true default: true icmp: type: boolean description: Allow/Deny ICMP example: true default: true netconf: type: boolean description: Allow/Deny NETCONF example: false default: false ntp: type: boolean description: Allow/Deny NTP example: false default: false sshd: type: boolean description: Allow/Deny SSH example: false default: false stun: type: boolean description: Allow/Deny STUN example: false default: false description: Set services allowed on the WAN interface $$ref: '#/components/schemas/AllowService' color: type: object properties: value: type: string description: Set color for TLOC example: default enum: - default - mpls - metro-ethernet - biz-internet - public-internet - lte - 3g - red - green - blue - gold - silver - bronze - custom1 - custom2 - custom3 - private1 - private2 - private3 - private4 - private5 - private6 default: default description: Set color for TLOC $$ref: '#/components/schemas/Color' description: Tunnel interface configuration $$ref: '#/components/schemas/TunnelInterface' description: Interfaces configuration $$ref: '#/components/schemas/TransportInterfaceSetting' ipRoute: type: object properties: route: type: array items: required: - nextHop - prefix type: object properties: nextHop: maxItems: 2147483647 minItems: 1 type: array items: required: - address type: object properties: address: pattern: ^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$ type: string description: IPv4 Address example: 10.0.0.1 distance: maximum: 255 minimum: 1 type: integer description: Administrative distance format: int32 example: 1 default: 1 description: IP gateway address $$ref: '#/components/schemas/NextHop' prefix: pattern: ^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\/)([0-2]?[0-9]$|[3]?[0-2])$ type: string description: IPv4 Prefix example: 0.0.0.0/0 description: Configure static routes $$ref: '#/components/schemas/StaticRoute' description: IP Route information $$ref: '#/components/schemas/IpRoute' ipv6Route: type: object properties: route: type: array items: required: - nextHop - prefix type: object properties: nextHop: maxItems: 2147483647 minItems: 1 type: array items: required: - address type: object properties: address: pattern: (([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)) type: string description: IPv6 Address example: 2001::1 distance: maximum: 255 minimum: 1 type: integer description: Administrative distance format: int32 example: 1 default: 1 description: IP gateway address $$ref: '#/components/schemas/IPV6NextHop' prefix: pattern: ((^\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:)))(%.+)?\s*(\/)(\b([0-9]{1,2}|1[01][0-9]|12[0-8])\b)$)) type: string description: IPv6 Prefix example: 2001::/4 description: Configure IPv6 static routes $$ref: '#/components/schemas/Ipv6StaticRoute' description: IPv6 Route information $$ref: '#/components/schemas/Ipv6Route' description: Transport VPN instance $$ref: '#/components/schemas/baseVpnInstanceTransportInterfaceSetting' description: Manager VPN setting $$ref: '#/components/schemas/ManagerVpnSetting' description: The payload for manager device specific settings $$ref: '#/components/schemas/ManagerDeviceSpecificSetting' examples: CreateControllerDeviceSpecificSettingsExample: description: CreateControllerDeviceSpecificSettingsExample value: system: systemIp: 172.16.255.20 hostName: Controller01 description: Controller 1 siteId: 200 location: Shang hai systemTunnelMtu: 2000 gpsLocation: latitude: 90 longitude: 180 clock: timezone: Europe/Andorra deviceGroups: - group1 overlayId: 3 ipv6StrictControl: true controllerGroupId: 1 vpn: transport: ipRoute: route: - prefix: 0.0.0.0/0 nextHop: - address: 10.0.12.13 distance: 1 ipv6Route: route: - prefix: ::/0 nextHop: - address: 2001:a0:c::d interface: - ifName: eth0 ip: address: 10.0.1.30/24 ipv6: address: 2001:a0:1::1e/64 shutdown: false - ifName: eth1 ip: address: 10.0.12.20/24 ipv6: address: 2001:a0:c::14/64 tunnelInterface: allowService: all: true dhcp: true dns: true icmp: true sshd: false netconf: false ntp: false stun: false shutdown: false management: interface: - ifName: eth2 ip: address: 10.2.2.20/24 ipv6: address: 2001:a2:2::14/64 shutdown: false $$ref: '#/components/examples/ComViptelaVmanageServerDeviceconfigControlcomponentSettingRequestExampleCreatecontrollerdevicespecificsettings' CreateValidatorDeviceSpecificSettingsExample: description: CreateValidatorDeviceSpecificSettingsExample value: system: systemIp: 172.16.255.19 hostName: Validator01 description: Validator 1 siteId: 100 location: Shang hai gpsLocation: latitude: 90 longitude: 180 clock: timezone: Europe/Andorra deviceGroups: - group1 vbond: address: 10.0.1.26 vpn: transport: ipRoute: route: - prefix: 0.0.0.0/0 nextHop: - address: 10.0.5.13 distance: 1 ipv6Route: route: - prefix: ::/0 nextHop: - address: 2001:a0:5::d interface: - ifName: eth0 ip: address: 10.0.1.19/24 ipv6: address: 2001:a0:1::13/64 shutdown: false - ifName: eth1 ip: address: 10.0.5.19/24 ipv6: address: 2001:a0:5::13/64 shutdown: false - ifName: eth3 ip: address: 10.1.15.19/24 ipv6: address: 2001:a1:f::13/64 shutdown: false management: interface: - ifName: eth2 ip: address: 10.2.2.19/24 ipv6: address: 2001:a2:2::13/64 shutdown: false $$ref: '#/components/examples/ComViptelaVmanageServerDeviceconfigControlcomponentSettingRequestExampleCreatevalidatordevicespecificsettings' CreateManagerDeviceSpecificSettingsExample: description: CreateManagerDeviceSpecificSettingsExample value: system: systemIp: 172.16.255.22 hostName: Manager01 clock: timezone: UTC siteId: 200 ipv6StrictControl: false vpn: transport: ipRoute: route: - prefix: 0.0.0.0/0 nextHop: - address: 10.0.12.13 distance: 1 interface: - ifName: eth0 ip: dhcpClient: true dhcpDistance: 1 ipv6: dhcpClient: true dhcpDistance: 1 dhcpRapidCommit: false shutdown: false - ifName: eth1 ip: address: 10.0.12.22/24 shutdown: false tunnelInterface: color: value: default allowService: all: false dhcp: true dns: true icmp: true sshd: false netconf: false ntp: false stun: false - ifName: eth2 ip: address: 10.0.5.22/24 shutdown: false - ifName: eth5 ip: address: 10.0.105.32/24 shutdown: false management: interface: - ifName: eth3 ip: address: 10.2.4.22/24 shutdown: false $$ref: '#/components/examples/ComViptelaVmanageServerDeviceconfigControlcomponentSettingRequestExampleCreatemanagerdevicespecificsettings' required: true responses: '200': description: Success content: application/json: schema: oneOf: - required: - system - vpn type: object properties: system: required: - hostName - siteId - systemIp type: object properties: clock: required: - timezone type: object properties: timezone: type: string description: Set the timezone example: UTC enum: - Europe/Andorra - Asia/Dubai - Asia/Kabul - America/Antigua - America/Anguilla - Europe/Tirane - Asia/Yerevan - Africa/Luanda - Antarctica/McMurdo - Antarctica/Rothera - Antarctica/Palmer - Antarctica/Mawson - Antarctica/Davis - Antarctica/Casey - Antarctica/Vostok - Antarctica/DumontDUrville - Antarctica/Syowa - America/Argentina/Buenos_Aires - America/Argentina/Cordoba - America/Argentina/Salta - America/Argentina/Jujuy - America/Argentina/Tucuman - America/Argentina/Catamarca - America/Argentina/La_Rioja - America/Argentina/San_Juan - America/Argentina/Mendoza - America/Argentina/San_Luis - America/Argentina/Rio_Gallegos - America/Argentina/Ushuaia - Pacific/Pago_Pago - Europe/Vienna - Australia/Lord_Howe - Antarctica/Macquarie - Australia/Hobart - Australia/Currie - Australia/Melbourne - Australia/Sydney - Australia/Broken_Hill - Australia/Brisbane - Australia/Lindeman - Australia/Adelaide - Australia/Darwin - Australia/Perth - Australia/Eucla - America/Aruba - Europe/Mariehamn - Asia/Baku - Europe/Sarajevo - America/Barbados - Asia/Dhaka - Europe/Brussels - Africa/Ouagadougou - Europe/Sofia - Asia/Bahrain - Africa/Bujumbura - Africa/Porto-Novo - America/St_Barthelemy - Atlantic/Bermuda - Asia/Brunei - America/La_Paz - America/Kralendijk - America/Noronha - America/Belem - America/Fortaleza - America/Recife - America/Araguaina - America/Maceio - America/Bahia - America/Sao_Paulo - America/Campo_Grande - America/Cuiaba - America/Santarem - America/Porto_Velho - America/Boa_Vista - America/Manaus - America/Eirunepe - America/Rio_Branco - America/Nassau - Asia/Thimphu - Africa/Gaborone - Europe/Minsk - America/Belize - America/St_Johns - America/Halifax - America/Glace_Bay - America/Moncton - America/Goose_Bay - America/Blanc-Sablon - America/Toronto - America/Nipigon - America/Thunder_Bay - America/Iqaluit - America/Pangnirtung - America/Resolute - America/Atikokan - America/Rankin_Inlet - America/Winnipeg - America/Rainy_River - America/Regina - America/Swift_Current - America/Edmonton - America/Cambridge_Bay - America/Yellowknife - America/Inuvik - America/Creston - America/Dawson_Creek - America/Vancouver - America/Whitehorse - America/Dawson - Indian/Cocos - Africa/Kinshasa - Africa/Lubumbashi - Africa/Bangui - Africa/Brazzaville - Europe/Zurich - Africa/Abidjan - Pacific/Rarotonga - America/Santiago - Pacific/Easter - Africa/Douala - Asia/Shanghai - Asia/Harbin - Asia/Chongqing - Asia/Urumqi - Asia/Kashgar - America/Bogota - America/Costa_Rica - America/Havana - Atlantic/Cape_Verde - America/Curacao - Indian/Christmas - Asia/Nicosia - Europe/Prague - Europe/Berlin - Europe/Busingen - Africa/Djibouti - Europe/Copenhagen - America/Dominica - America/Santo_Domingo - Africa/Algiers - America/Guayaquil - Pacific/Galapagos - Europe/Tallinn - Africa/Cairo - Africa/El_Aaiun - Africa/Asmara - Europe/Madrid - Africa/Ceuta - Atlantic/Canary - Africa/Addis_Ababa - Europe/Helsinki - Pacific/Fiji - Atlantic/Stanley - Pacific/Chuuk - Pacific/Pohnpei - Pacific/Kosrae - Atlantic/Faroe - Europe/Paris - Africa/Libreville - Europe/London - America/Grenada - Asia/Tbilisi - America/Cayenne - Europe/Guernsey - Africa/Accra - Europe/Gibraltar - America/Godthab - America/Danmarkshavn - America/Scoresbysund - America/Thule - Africa/Banjul - Africa/Conakry - America/Guadeloupe - Africa/Malabo - Europe/Athens - Atlantic/South_Georgia - America/Guatemala - Pacific/Guam - Africa/Bissau - America/Guyana - Asia/Hong_Kong - America/Tegucigalpa - Europe/Zagreb - America/Port-au-Prince - Europe/Budapest - Asia/Jakarta - Asia/Pontianak - Asia/Makassar - Asia/Jayapura - Europe/Dublin - Asia/Jerusalem - Europe/Isle_of_Man - Asia/Kolkata - Indian/Chagos - Asia/Baghdad - Asia/Tehran - Atlantic/Reykjavik - Europe/Rome - Europe/Jersey - America/Jamaica - Asia/Amman - Asia/Tokyo - Africa/Nairobi - Asia/Bishkek - Asia/Phnom_Penh - Pacific/Tarawa - Pacific/Enderbury - Pacific/Kiritimati - Indian/Comoro - America/St_Kitts - Asia/Pyongyang - Asia/Seoul - Asia/Kuwait - America/Cayman - Asia/Almaty - Asia/Qyzylorda - Asia/Aqtobe - Asia/Aqtau - Asia/Oral - Asia/Vientiane - Asia/Beirut - America/St_Lucia - Europe/Vaduz - Asia/Colombo - Africa/Monrovia - Africa/Maseru - Europe/Vilnius - Europe/Luxembourg - Europe/Riga - Africa/Tripoli - Africa/Casablanca - Europe/Monaco - Europe/Chisinau - Europe/Podgorica - America/Marigot - Indian/Antananarivo - Pacific/Majuro - Pacific/Kwajalein - Europe/Skopje - Africa/Bamako - Asia/Rangoon - Asia/Ulaanbaatar - Asia/Hovd - Asia/Choibalsan - Asia/Macau - Pacific/Saipan - America/Martinique - Africa/Nouakchott - America/Montserrat - Europe/Malta - Indian/Mauritius - Indian/Maldives - Africa/Blantyre - America/Mexico_City - America/Cancun - America/Merida - America/Monterrey - America/Matamoros - America/Mazatlan - America/Chihuahua - America/Ojinaga - America/Hermosillo - America/Tijuana - America/Santa_Isabel - America/Bahia_Banderas - Asia/Kuala_Lumpur - Asia/Kuching - Africa/Maputo - Africa/Windhoek - Pacific/Noumea - Africa/Niamey - Pacific/Norfolk - Africa/Lagos - America/Managua - Europe/Amsterdam - Europe/Oslo - Asia/Kathmandu - Pacific/Nauru - Pacific/Niue - Pacific/Auckland - Pacific/Chatham - Asia/Muscat - America/Panama - America/Lima - Pacific/Tahiti - Pacific/Marquesas - Pacific/Gambier - Pacific/Port_Moresby - Asia/Manila - Asia/Karachi - Europe/Warsaw - America/Miquelon - Pacific/Pitcairn - America/Puerto_Rico - Asia/Gaza - Asia/Hebron - Europe/Lisbon - Atlantic/Madeira - Atlantic/Azores - Pacific/Palau - America/Asuncion - Asia/Qatar - Indian/Reunion - Europe/Bucharest - Europe/Belgrade - Europe/Kaliningrad - Europe/Moscow - Europe/Volgograd - Europe/Samara - Asia/Yekaterinburg - Asia/Omsk - Asia/Novosibirsk - Asia/Novokuznetsk - Asia/Krasnoyarsk - Asia/Irkutsk - Asia/Yakutsk - Asia/Khandyga - Asia/Vladivostok - Asia/Sakhalin - Asia/Ust-Nera - Asia/Magadan - Asia/Kamchatka - Asia/Anadyr - Africa/Kigali - Asia/Riyadh - Pacific/Guadalcanal - Indian/Mahe - Africa/Khartoum - Europe/Stockholm - Asia/Singapore - Atlantic/St_Helena - Europe/Ljubljana - Arctic/Longyearbyen - Europe/Bratislava - Africa/Freetown - Europe/San_Marino - Africa/Dakar - Africa/Mogadishu - America/Paramaribo - Africa/Juba - Africa/Sao_Tome - America/El_Salvador - America/Lower_Princes - Asia/Damascus - Africa/Mbabane - America/Grand_Turk - Africa/Ndjamena - Indian/Kerguelen - Africa/Lome - Asia/Bangkok - Asia/Dushanbe - Pacific/Fakaofo - Asia/Dili - Asia/Ashgabat - Africa/Tunis - Pacific/Tongatapu - Europe/Istanbul - America/Port_of_Spain - Pacific/Funafuti - Asia/Taipei - Africa/Dar_es_Salaam - Europe/Kiev - Europe/Uzhgorod - Europe/Zaporozhye - Europe/Simferopol - Africa/Kampala - Pacific/Johnston - Pacific/Midway - Pacific/Wake - America/New_York - America/Detroit - America/Kentucky/Louisville - America/Kentucky/Monticello - America/Indiana/Indianapolis - America/Indiana/Vincennes - America/Indiana/Winamac - America/Indiana/Marengo - America/Indiana/Petersburg - America/Indiana/Vevay - America/Chicago - America/Indiana/Tell_City - America/Indiana/Knox - America/Menominee - America/North_Dakota/Center - America/North_Dakota/New_Salem - America/North_Dakota/Beulah - America/Denver - America/Boise - America/Phoenix - America/Los_Angeles - America/Anchorage - America/Juneau - America/Sitka - America/Yakutat - America/Nome - America/Adak - America/Metlakatla - Pacific/Honolulu - America/Montevideo - Asia/Samarkand - Asia/Tashkent - Europe/Vatican - America/St_Vincent - America/Caracas - America/Tortola - America/St_Thomas - Asia/Ho_Chi_Minh - Pacific/Efate - Pacific/Wallis - Pacific/Apia - Asia/Aden - Indian/Mayotte - Africa/Johannesburg - Africa/Lusaka - Africa/Harare - UTC default: UTC description: Configure clock $$ref: '#/components/schemas/Clock' description: pattern: ^[^<>]{1,32}$ type: string description: Set a text description of the device example: System settings deviceGroups: type: array description: Configure device groups items: type: string description: Configure device groups gpsLocation: required: - latitude - longitude type: object properties: latitude: maximum: 90 minimum: -90 type: number description: Set the device’s physical latitude example: 60 longitude: maximum: 180 minimum: -180 type: number description: Set the device’s physical longitude example: 60 description: GPS latitude and longitude of the device $$ref: '#/components/schemas/GpsLocation' hostName: pattern: ^[a-zA-Z0-9\-_]{1,32}$ type: string description: Set the hostname example: vm12 location: pattern: ^[^<>]{1,127}$ type: string description: Set the location of the device example: USA siteId: maximum: 4294967295 minimum: 0 type: integer description: Set the site ID format: int64 example: 100 systemIp: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: Set the system IP address example: 102.2.3.2 vbond: required: - address type: object properties: address: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: Set the vBond IP address example: 10.0.12.22 $$ref: '#/components/schemas/Vbond' description: System configuration for validator $$ref: '#/components/schemas/ValidatorSystemSetting' vpn: required: - transport type: object properties: management: required: - interface type: object properties: dns: type: object properties: dnsServerPrimary: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: Primary DNS server IPv4 or IPv6 Address example: 10.2.2.2 dnsServerSecondary: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: Secondary DNS server IPv4 or IPv6 Address example: 10.2.2.3 host: type: array items: required: - hostname - ip type: object properties: hostname: pattern: ^[a-zA-Z0-9\-_.]{1,64}$ type: string description: Host name example: vbond ip: maxItems: 64 minItems: 1 uniqueItems: true type: array items: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: IP Address example: 10.1.1.1 description: Static host mapping $$ref: '#/components/schemas/DnsHostMapping' description: Configure DNS servers or static host mapping $$ref: '#/components/schemas/ControlComponentDnsSetting' interface: maxItems: 2147483647 minItems: 1 type: array items: required: - ifName type: object properties: ifName: pattern: ^(?=.{1,32}$)(?:(ge0\/\d+(?:\.\d+)?|loopback\d+|eth\d+(?:\.\d+)?))$ type: string description: Interface name eth<0-..> or eth<0-..>.vlanid or loopback when present example: eth0 ip: type: object properties: address: pattern: ^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\/)([0-2]?[0-9]$|[3]?[0-2])$ type: string description: Assign IPv4 address example: 10.0.1.1/24 dhcpClient: type: boolean description: Enable DHCP example: false default: false dhcpDistance: maximum: 65536 minimum: 1 type: integer description: Set administrative distance for DHCP default route format: int32 example: 1 default: 1 description: IPv4 address or DHCP $$ref: '#/components/schemas/IpConfig' ipv6: type: object properties: address: pattern: ((^\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:)))(%.+)?\s*(\/)(\b([0-9]{1,2}|1[01][0-9]|12[0-8])\b)$)) type: string description: Assign IPv6 address example: 2001:a0:64::20/64 dhcpClient: type: boolean description: Enable DHCP example: false default: false dhcpDistance: maximum: 65536 minimum: 1 type: integer description: Set administrative distance for DHCP default route format: int32 example: 1 default: 1 dhcpRapidCommit: type: boolean description: Enable DHCPv6 rapid commit example: false default: false description: IPv6 address or DHCP $$ref: '#/components/schemas/Ipv6Config' shutdown: type: boolean description: Administrative state example: false default: false description: Interfaces configuration $$ref: '#/components/schemas/BaseInterfaceSetting' ipRoute: type: object properties: route: type: array items: required: - nextHop - prefix type: object properties: nextHop: maxItems: 2147483647 minItems: 1 type: array items: required: - address type: object properties: address: pattern: ^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$ type: string description: IPv4 Address example: 10.0.0.1 distance: maximum: 255 minimum: 1 type: integer description: Administrative distance format: int32 example: 1 default: 1 description: IP gateway address $$ref: '#/components/schemas/NextHop' prefix: pattern: ^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\/)([0-2]?[0-9]$|[3]?[0-2])$ type: string description: IPv4 Prefix example: 0.0.0.0/0 description: Configure static routes $$ref: '#/components/schemas/StaticRoute' description: IP Route information $$ref: '#/components/schemas/IpRoute' ipv6Route: type: object properties: route: type: array items: required: - nextHop - prefix type: object properties: nextHop: maxItems: 2147483647 minItems: 1 type: array items: required: - address type: object properties: address: pattern: (([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)) type: string description: IPv6 Address example: 2001::1 distance: maximum: 255 minimum: 1 type: integer description: Administrative distance format: int32 example: 1 default: 1 description: IP gateway address $$ref: '#/components/schemas/IPV6NextHop' prefix: pattern: ((^\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:)))(%.+)?\s*(\/)(\b([0-9]{1,2}|1[01][0-9]|12[0-8])\b)$)) type: string description: IPv6 Prefix example: 2001::/4 description: Configure IPv6 static routes $$ref: '#/components/schemas/Ipv6StaticRoute' description: IPv6 Route information $$ref: '#/components/schemas/Ipv6Route' description: Management VPN instance $$ref: '#/components/schemas/baseVpnInstanceBaseInterfaceSetting' transport: required: - interface type: object properties: dns: type: object properties: dnsServerPrimary: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: Primary DNS server IPv4 or IPv6 Address example: 10.2.2.2 dnsServerSecondary: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: Secondary DNS server IPv4 or IPv6 Address example: 10.2.2.3 host: type: array items: required: - hostname - ip type: object properties: hostname: pattern: ^[a-zA-Z0-9\-_.]{1,64}$ type: string description: Host name example: vbond ip: maxItems: 64 minItems: 1 uniqueItems: true type: array items: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: IP Address example: 10.1.1.1 description: Static host mapping $$ref: '#/components/schemas/DnsHostMapping' description: Configure DNS servers or static host mapping $$ref: '#/components/schemas/ControlComponentDnsSetting' interface: maxItems: 2147483647 minItems: 1 type: array items: required: - ifName type: object properties: ifName: pattern: ^(?=.{1,32}$)(?:(ge0\/\d+(?:\.\d+)?|loopback\d+|eth\d+(?:\.\d+)?))$ type: string description: Interface name eth<0-..> or eth<0-..>.vlanid or loopback when present example: eth0 ip: type: object properties: address: pattern: ^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\/)([0-2]?[0-9]$|[3]?[0-2])$ type: string description: Assign IPv4 address example: 10.0.1.1/24 dhcpClient: type: boolean description: Enable DHCP example: false default: false dhcpDistance: maximum: 65536 minimum: 1 type: integer description: Set administrative distance for DHCP default route format: int32 example: 1 default: 1 description: IPv4 address or DHCP $$ref: '#/components/schemas/IpConfig' ipv6: type: object properties: address: pattern: ((^\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:)))(%.+)?\s*(\/)(\b([0-9]{1,2}|1[01][0-9]|12[0-8])\b)$)) type: string description: Assign IPv6 address example: 2001:a0:64::20/64 dhcpClient: type: boolean description: Enable DHCP example: false default: false dhcpDistance: maximum: 65536 minimum: 1 type: integer description: Set administrative distance for DHCP default route format: int32 example: 1 default: 1 dhcpRapidCommit: type: boolean description: Enable DHCPv6 rapid commit example: false default: false description: IPv6 address or DHCP $$ref: '#/components/schemas/Ipv6Config' shutdown: type: boolean description: Administrative state example: false default: false tunnelInterface: type: object properties: allowService: type: object properties: all: type: boolean description: Allow all traffic. Overrides all other allow-service options if allow-service all is set example: false default: false dhcp: type: boolean description: Allow/Deny DHCP example: true default: true dns: type: boolean description: Allow/Deny DNS example: true default: true icmp: type: boolean description: Allow/Deny ICMP example: true default: true netconf: type: boolean description: Allow/Deny NETCONF example: false default: false ntp: type: boolean description: Allow/Deny NTP example: false default: false sshd: type: boolean description: Allow/Deny SSH example: false default: false stun: type: boolean description: Allow/Deny STUN example: false default: false description: Set services allowed on the WAN interface $$ref: '#/components/schemas/AllowService' color: type: object properties: value: type: string description: Set color for TLOC example: default enum: - default - mpls - metro-ethernet - biz-internet - public-internet - lte - 3g - red - green - blue - gold - silver - bronze - custom1 - custom2 - custom3 - private1 - private2 - private3 - private4 - private5 - private6 default: default description: Set color for TLOC $$ref: '#/components/schemas/Color' description: Tunnel interface configuration $$ref: '#/components/schemas/TunnelInterface' description: Interfaces configuration $$ref: '#/components/schemas/TransportInterfaceSetting' ipRoute: type: object properties: route: type: array items: required: - nextHop - prefix type: object properties: nextHop: maxItems: 2147483647 minItems: 1 type: array items: required: - address type: object properties: address: pattern: ^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$ type: string description: IPv4 Address example: 10.0.0.1 distance: maximum: 255 minimum: 1 type: integer description: Administrative distance format: int32 example: 1 default: 1 description: IP gateway address $$ref: '#/components/schemas/NextHop' prefix: pattern: ^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\/)([0-2]?[0-9]$|[3]?[0-2])$ type: string description: IPv4 Prefix example: 0.0.0.0/0 description: Configure static routes $$ref: '#/components/schemas/StaticRoute' description: IP Route information $$ref: '#/components/schemas/IpRoute' ipv6Route: type: object properties: route: type: array items: required: - nextHop - prefix type: object properties: nextHop: maxItems: 2147483647 minItems: 1 type: array items: required: - address type: object properties: address: pattern: (([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)) type: string description: IPv6 Address example: 2001::1 distance: maximum: 255 minimum: 1 type: integer description: Administrative distance format: int32 example: 1 default: 1 description: IP gateway address $$ref: '#/components/schemas/IPV6NextHop' prefix: pattern: ((^\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:)))(%.+)?\s*(\/)(\b([0-9]{1,2}|1[01][0-9]|12[0-8])\b)$)) type: string description: IPv6 Prefix example: 2001::/4 description: Configure IPv6 static routes $$ref: '#/components/schemas/Ipv6StaticRoute' description: IPv6 Route information $$ref: '#/components/schemas/Ipv6Route' description: Transport VPN instance $$ref: '#/components/schemas/baseVpnInstanceTransportInterfaceSetting' description: Validator VPN setting $$ref: '#/components/schemas/ValidatorVpnSetting' description: The payload for validator device specific settings $$ref: '#/components/schemas/ValidatorDeviceSpecificSetting' - required: - system - vpn type: object properties: system: required: - hostName - siteId - systemIp type: object properties: clock: required: - timezone type: object properties: timezone: type: string description: Set the timezone example: UTC enum: - Europe/Andorra - Asia/Dubai - Asia/Kabul - America/Antigua - America/Anguilla - Europe/Tirane - Asia/Yerevan - Africa/Luanda - Antarctica/McMurdo - Antarctica/Rothera - Antarctica/Palmer - Antarctica/Mawson - Antarctica/Davis - Antarctica/Casey - Antarctica/Vostok - Antarctica/DumontDUrville - Antarctica/Syowa - America/Argentina/Buenos_Aires - America/Argentina/Cordoba - America/Argentina/Salta - America/Argentina/Jujuy - America/Argentina/Tucuman - America/Argentina/Catamarca - America/Argentina/La_Rioja - America/Argentina/San_Juan - America/Argentina/Mendoza - America/Argentina/San_Luis - America/Argentina/Rio_Gallegos - America/Argentina/Ushuaia - Pacific/Pago_Pago - Europe/Vienna - Australia/Lord_Howe - Antarctica/Macquarie - Australia/Hobart - Australia/Currie - Australia/Melbourne - Australia/Sydney - Australia/Broken_Hill - Australia/Brisbane - Australia/Lindeman - Australia/Adelaide - Australia/Darwin - Australia/Perth - Australia/Eucla - America/Aruba - Europe/Mariehamn - Asia/Baku - Europe/Sarajevo - America/Barbados - Asia/Dhaka - Europe/Brussels - Africa/Ouagadougou - Europe/Sofia - Asia/Bahrain - Africa/Bujumbura - Africa/Porto-Novo - America/St_Barthelemy - Atlantic/Bermuda - Asia/Brunei - America/La_Paz - America/Kralendijk - America/Noronha - America/Belem - America/Fortaleza - America/Recife - America/Araguaina - America/Maceio - America/Bahia - America/Sao_Paulo - America/Campo_Grande - America/Cuiaba - America/Santarem - America/Porto_Velho - America/Boa_Vista - America/Manaus - America/Eirunepe - America/Rio_Branco - America/Nassau - Asia/Thimphu - Africa/Gaborone - Europe/Minsk - America/Belize - America/St_Johns - America/Halifax - America/Glace_Bay - America/Moncton - America/Goose_Bay - America/Blanc-Sablon - America/Toronto - America/Nipigon - America/Thunder_Bay - America/Iqaluit - America/Pangnirtung - America/Resolute - America/Atikokan - America/Rankin_Inlet - America/Winnipeg - America/Rainy_River - America/Regina - America/Swift_Current - America/Edmonton - America/Cambridge_Bay - America/Yellowknife - America/Inuvik - America/Creston - America/Dawson_Creek - America/Vancouver - America/Whitehorse - America/Dawson - Indian/Cocos - Africa/Kinshasa - Africa/Lubumbashi - Africa/Bangui - Africa/Brazzaville - Europe/Zurich - Africa/Abidjan - Pacific/Rarotonga - America/Santiago - Pacific/Easter - Africa/Douala - Asia/Shanghai - Asia/Harbin - Asia/Chongqing - Asia/Urumqi - Asia/Kashgar - America/Bogota - America/Costa_Rica - America/Havana - Atlantic/Cape_Verde - America/Curacao - Indian/Christmas - Asia/Nicosia - Europe/Prague - Europe/Berlin - Europe/Busingen - Africa/Djibouti - Europe/Copenhagen - America/Dominica - America/Santo_Domingo - Africa/Algiers - America/Guayaquil - Pacific/Galapagos - Europe/Tallinn - Africa/Cairo - Africa/El_Aaiun - Africa/Asmara - Europe/Madrid - Africa/Ceuta - Atlantic/Canary - Africa/Addis_Ababa - Europe/Helsinki - Pacific/Fiji - Atlantic/Stanley - Pacific/Chuuk - Pacific/Pohnpei - Pacific/Kosrae - Atlantic/Faroe - Europe/Paris - Africa/Libreville - Europe/London - America/Grenada - Asia/Tbilisi - America/Cayenne - Europe/Guernsey - Africa/Accra - Europe/Gibraltar - America/Godthab - America/Danmarkshavn - America/Scoresbysund - America/Thule - Africa/Banjul - Africa/Conakry - America/Guadeloupe - Africa/Malabo - Europe/Athens - Atlantic/South_Georgia - America/Guatemala - Pacific/Guam - Africa/Bissau - America/Guyana - Asia/Hong_Kong - America/Tegucigalpa - Europe/Zagreb - America/Port-au-Prince - Europe/Budapest - Asia/Jakarta - Asia/Pontianak - Asia/Makassar - Asia/Jayapura - Europe/Dublin - Asia/Jerusalem - Europe/Isle_of_Man - Asia/Kolkata - Indian/Chagos - Asia/Baghdad - Asia/Tehran - Atlantic/Reykjavik - Europe/Rome - Europe/Jersey - America/Jamaica - Asia/Amman - Asia/Tokyo - Africa/Nairobi - Asia/Bishkek - Asia/Phnom_Penh - Pacific/Tarawa - Pacific/Enderbury - Pacific/Kiritimati - Indian/Comoro - America/St_Kitts - Asia/Pyongyang - Asia/Seoul - Asia/Kuwait - America/Cayman - Asia/Almaty - Asia/Qyzylorda - Asia/Aqtobe - Asia/Aqtau - Asia/Oral - Asia/Vientiane - Asia/Beirut - America/St_Lucia - Europe/Vaduz - Asia/Colombo - Africa/Monrovia - Africa/Maseru - Europe/Vilnius - Europe/Luxembourg - Europe/Riga - Africa/Tripoli - Africa/Casablanca - Europe/Monaco - Europe/Chisinau - Europe/Podgorica - America/Marigot - Indian/Antananarivo - Pacific/Majuro - Pacific/Kwajalein - Europe/Skopje - Africa/Bamako - Asia/Rangoon - Asia/Ulaanbaatar - Asia/Hovd - Asia/Choibalsan - Asia/Macau - Pacific/Saipan - America/Martinique - Africa/Nouakchott - America/Montserrat - Europe/Malta - Indian/Mauritius - Indian/Maldives - Africa/Blantyre - America/Mexico_City - America/Cancun - America/Merida - America/Monterrey - America/Matamoros - America/Mazatlan - America/Chihuahua - America/Ojinaga - America/Hermosillo - America/Tijuana - America/Santa_Isabel - America/Bahia_Banderas - Asia/Kuala_Lumpur - Asia/Kuching - Africa/Maputo - Africa/Windhoek - Pacific/Noumea - Africa/Niamey - Pacific/Norfolk - Africa/Lagos - America/Managua - Europe/Amsterdam - Europe/Oslo - Asia/Kathmandu - Pacific/Nauru - Pacific/Niue - Pacific/Auckland - Pacific/Chatham - Asia/Muscat - America/Panama - America/Lima - Pacific/Tahiti - Pacific/Marquesas - Pacific/Gambier - Pacific/Port_Moresby - Asia/Manila - Asia/Karachi - Europe/Warsaw - America/Miquelon - Pacific/Pitcairn - America/Puerto_Rico - Asia/Gaza - Asia/Hebron - Europe/Lisbon - Atlantic/Madeira - Atlantic/Azores - Pacific/Palau - America/Asuncion - Asia/Qatar - Indian/Reunion - Europe/Bucharest - Europe/Belgrade - Europe/Kaliningrad - Europe/Moscow - Europe/Volgograd - Europe/Samara - Asia/Yekaterinburg - Asia/Omsk - Asia/Novosibirsk - Asia/Novokuznetsk - Asia/Krasnoyarsk - Asia/Irkutsk - Asia/Yakutsk - Asia/Khandyga - Asia/Vladivostok - Asia/Sakhalin - Asia/Ust-Nera - Asia/Magadan - Asia/Kamchatka - Asia/Anadyr - Africa/Kigali - Asia/Riyadh - Pacific/Guadalcanal - Indian/Mahe - Africa/Khartoum - Europe/Stockholm - Asia/Singapore - Atlantic/St_Helena - Europe/Ljubljana - Arctic/Longyearbyen - Europe/Bratislava - Africa/Freetown - Europe/San_Marino - Africa/Dakar - Africa/Mogadishu - America/Paramaribo - Africa/Juba - Africa/Sao_Tome - America/El_Salvador - America/Lower_Princes - Asia/Damascus - Africa/Mbabane - America/Grand_Turk - Africa/Ndjamena - Indian/Kerguelen - Africa/Lome - Asia/Bangkok - Asia/Dushanbe - Pacific/Fakaofo - Asia/Dili - Asia/Ashgabat - Africa/Tunis - Pacific/Tongatapu - Europe/Istanbul - America/Port_of_Spain - Pacific/Funafuti - Asia/Taipei - Africa/Dar_es_Salaam - Europe/Kiev - Europe/Uzhgorod - Europe/Zaporozhye - Europe/Simferopol - Africa/Kampala - Pacific/Johnston - Pacific/Midway - Pacific/Wake - America/New_York - America/Detroit - America/Kentucky/Louisville - America/Kentucky/Monticello - America/Indiana/Indianapolis - America/Indiana/Vincennes - America/Indiana/Winamac - America/Indiana/Marengo - America/Indiana/Petersburg - America/Indiana/Vevay - America/Chicago - America/Indiana/Tell_City - America/Indiana/Knox - America/Menominee - America/North_Dakota/Center - America/North_Dakota/New_Salem - America/North_Dakota/Beulah - America/Denver - America/Boise - America/Phoenix - America/Los_Angeles - America/Anchorage - America/Juneau - America/Sitka - America/Yakutat - America/Nome - America/Adak - America/Metlakatla - Pacific/Honolulu - America/Montevideo - Asia/Samarkand - Asia/Tashkent - Europe/Vatican - America/St_Vincent - America/Caracas - America/Tortola - America/St_Thomas - Asia/Ho_Chi_Minh - Pacific/Efate - Pacific/Wallis - Pacific/Apia - Asia/Aden - Indian/Mayotte - Africa/Johannesburg - Africa/Lusaka - Africa/Harare - UTC default: UTC description: Configure clock $$ref: '#/components/schemas/Clock' controllerGroupId: maximum: 100 minimum: 0 type: integer description: Controller group id format: int32 example: 0 default: 0 description: pattern: ^[^<>]{1,32}$ type: string description: Set a text description of the device example: System settings deviceGroups: type: array description: Configure device groups items: type: string description: Configure device groups gpsLocation: required: - latitude - longitude type: object properties: latitude: maximum: 90 minimum: -90 type: number description: Set the device’s physical latitude example: 60 longitude: maximum: 180 minimum: -180 type: number description: Set the device’s physical longitude example: 60 description: GPS latitude and longitude of the device $$ref: '#/components/schemas/GpsLocation' hostName: pattern: ^[a-zA-Z0-9\-_]{1,32}$ type: string description: Set the hostname example: vm12 ipv6StrictControl: type: boolean description: Sets up a strict IPv6 control connection in a dual stack IP example: false default: false location: pattern: ^[^<>]{1,127}$ type: string description: Set the location of the device example: USA overlayId: maximum: 4294967295 minimum: 1 type: integer description: Set the Overlay ID format: int64 example: 1 default: 1 region: type: object properties: regionIdList: maxItems: 2147483647 minItems: 1 uniqueItems: true type: array items: maximum: 63 minimum: 0 type: integer description: Configure a list of region ID format: int32 example: 0 $$ref: '#/components/schemas/Region' siteId: maximum: 4294967295 minimum: 0 type: integer description: Set the site ID format: int64 example: 100 systemIp: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: Set the system IP address example: 102.2.3.2 description: System configuration for controller $$ref: '#/components/schemas/ControllerSystemSetting' vpn: required: - transport type: object properties: management: required: - interface type: object properties: dns: type: object properties: dnsServerPrimary: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: Primary DNS server IPv4 or IPv6 Address example: 10.2.2.2 dnsServerSecondary: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: Secondary DNS server IPv4 or IPv6 Address example: 10.2.2.3 host: type: array items: required: - hostname - ip type: object properties: hostname: pattern: ^[a-zA-Z0-9\-_.]{1,64}$ type: string description: Host name example: vbond ip: maxItems: 64 minItems: 1 uniqueItems: true type: array items: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: IP Address example: 10.1.1.1 description: Static host mapping $$ref: '#/components/schemas/DnsHostMapping' description: Configure DNS servers or static host mapping $$ref: '#/components/schemas/ControlComponentDnsSetting' interface: maxItems: 2147483647 minItems: 1 type: array items: required: - ifName type: object properties: ifName: pattern: ^(?=.{1,32}$)(?:(ge0\/\d+(?:\.\d+)?|loopback\d+|eth\d+(?:\.\d+)?))$ type: string description: Interface name eth<0-..> or eth<0-..>.vlanid or loopback when present example: eth0 ip: type: object properties: address: pattern: ^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\/)([0-2]?[0-9]$|[3]?[0-2])$ type: string description: Assign IPv4 address example: 10.0.1.1/24 dhcpClient: type: boolean description: Enable DHCP example: false default: false dhcpDistance: maximum: 65536 minimum: 1 type: integer description: Set administrative distance for DHCP default route format: int32 example: 1 default: 1 description: IPv4 address or DHCP $$ref: '#/components/schemas/IpConfig' ipv6: type: object properties: address: pattern: ((^\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:)))(%.+)?\s*(\/)(\b([0-9]{1,2}|1[01][0-9]|12[0-8])\b)$)) type: string description: Assign IPv6 address example: 2001:a0:64::20/64 dhcpClient: type: boolean description: Enable DHCP example: false default: false dhcpDistance: maximum: 65536 minimum: 1 type: integer description: Set administrative distance for DHCP default route format: int32 example: 1 default: 1 dhcpRapidCommit: type: boolean description: Enable DHCPv6 rapid commit example: false default: false description: IPv6 address or DHCP $$ref: '#/components/schemas/Ipv6Config' shutdown: type: boolean description: Administrative state example: false default: false description: Interfaces configuration $$ref: '#/components/schemas/BaseInterfaceSetting' ipRoute: type: object properties: route: type: array items: required: - nextHop - prefix type: object properties: nextHop: maxItems: 2147483647 minItems: 1 type: array items: required: - address type: object properties: address: pattern: ^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$ type: string description: IPv4 Address example: 10.0.0.1 distance: maximum: 255 minimum: 1 type: integer description: Administrative distance format: int32 example: 1 default: 1 description: IP gateway address $$ref: '#/components/schemas/NextHop' prefix: pattern: ^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\/)([0-2]?[0-9]$|[3]?[0-2])$ type: string description: IPv4 Prefix example: 0.0.0.0/0 description: Configure static routes $$ref: '#/components/schemas/StaticRoute' description: IP Route information $$ref: '#/components/schemas/IpRoute' ipv6Route: type: object properties: route: type: array items: required: - nextHop - prefix type: object properties: nextHop: maxItems: 2147483647 minItems: 1 type: array items: required: - address type: object properties: address: pattern: (([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)) type: string description: IPv6 Address example: 2001::1 distance: maximum: 255 minimum: 1 type: integer description: Administrative distance format: int32 example: 1 default: 1 description: IP gateway address $$ref: '#/components/schemas/IPV6NextHop' prefix: pattern: ((^\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:)))(%.+)?\s*(\/)(\b([0-9]{1,2}|1[01][0-9]|12[0-8])\b)$)) type: string description: IPv6 Prefix example: 2001::/4 description: Configure IPv6 static routes $$ref: '#/components/schemas/Ipv6StaticRoute' description: IPv6 Route information $$ref: '#/components/schemas/Ipv6Route' description: Management VPN instance $$ref: '#/components/schemas/baseVpnInstanceBaseInterfaceSetting' transport: required: - interface type: object properties: dns: type: object properties: dnsServerPrimary: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: Primary DNS server IPv4 or IPv6 Address example: 10.2.2.2 dnsServerSecondary: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: Secondary DNS server IPv4 or IPv6 Address example: 10.2.2.3 host: type: array items: required: - hostname - ip type: object properties: hostname: pattern: ^[a-zA-Z0-9\-_.]{1,64}$ type: string description: Host name example: vbond ip: maxItems: 64 minItems: 1 uniqueItems: true type: array items: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: IP Address example: 10.1.1.1 description: Static host mapping $$ref: '#/components/schemas/DnsHostMapping' description: Configure DNS servers or static host mapping $$ref: '#/components/schemas/ControlComponentDnsSetting' interface: maxItems: 2147483647 minItems: 1 type: array items: required: - ifName type: object properties: ifName: pattern: ^(?=.{1,32}$)(?:(ge0\/\d+(?:\.\d+)?|loopback\d+|eth\d+(?:\.\d+)?))$ type: string description: Interface name eth<0-..> or eth<0-..>.vlanid or loopback when present example: eth0 ip: type: object properties: address: pattern: ^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\/)([0-2]?[0-9]$|[3]?[0-2])$ type: string description: Assign IPv4 address example: 10.0.1.1/24 dhcpClient: type: boolean description: Enable DHCP example: false default: false dhcpDistance: maximum: 65536 minimum: 1 type: integer description: Set administrative distance for DHCP default route format: int32 example: 1 default: 1 description: IPv4 address or DHCP $$ref: '#/components/schemas/IpConfig' ipv6: type: object properties: address: pattern: ((^\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:)))(%.+)?\s*(\/)(\b([0-9]{1,2}|1[01][0-9]|12[0-8])\b)$)) type: string description: Assign IPv6 address example: 2001:a0:64::20/64 dhcpClient: type: boolean description: Enable DHCP example: false default: false dhcpDistance: maximum: 65536 minimum: 1 type: integer description: Set administrative distance for DHCP default route format: int32 example: 1 default: 1 dhcpRapidCommit: type: boolean description: Enable DHCPv6 rapid commit example: false default: false description: IPv6 address or DHCP $$ref: '#/components/schemas/Ipv6Config' shutdown: type: boolean description: Administrative state example: false default: false tunnelInterface: type: object properties: allowService: type: object properties: all: type: boolean description: Allow all traffic. Overrides all other allow-service options if allow-service all is set example: false default: false dhcp: type: boolean description: Allow/Deny DHCP example: true default: true dns: type: boolean description: Allow/Deny DNS example: true default: true icmp: type: boolean description: Allow/Deny ICMP example: true default: true netconf: type: boolean description: Allow/Deny NETCONF example: false default: false ntp: type: boolean description: Allow/Deny NTP example: false default: false sshd: type: boolean description: Allow/Deny SSH example: false default: false stun: type: boolean description: Allow/Deny STUN example: false default: false description: Set services allowed on the WAN interface $$ref: '#/components/schemas/AllowService' color: type: object properties: value: type: string description: Set color for TLOC example: default enum: - default - mpls - metro-ethernet - biz-internet - public-internet - lte - 3g - red - green - blue - gold - silver - bronze - custom1 - custom2 - custom3 - private1 - private2 - private3 - private4 - private5 - private6 default: default description: Set color for TLOC $$ref: '#/components/schemas/Color' description: Tunnel interface configuration $$ref: '#/components/schemas/TunnelInterface' description: Interfaces configuration $$ref: '#/components/schemas/TransportInterfaceSetting' ipRoute: type: object properties: route: type: array items: required: - nextHop - prefix type: object properties: nextHop: maxItems: 2147483647 minItems: 1 type: array items: required: - address type: object properties: address: pattern: ^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$ type: string description: IPv4 Address example: 10.0.0.1 distance: maximum: 255 minimum: 1 type: integer description: Administrative distance format: int32 example: 1 default: 1 description: IP gateway address $$ref: '#/components/schemas/NextHop' prefix: pattern: ^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\/)([0-2]?[0-9]$|[3]?[0-2])$ type: string description: IPv4 Prefix example: 0.0.0.0/0 description: Configure static routes $$ref: '#/components/schemas/StaticRoute' description: IP Route information $$ref: '#/components/schemas/IpRoute' ipv6Route: type: object properties: route: type: array items: required: - nextHop - prefix type: object properties: nextHop: maxItems: 2147483647 minItems: 1 type: array items: required: - address type: object properties: address: pattern: (([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)) type: string description: IPv6 Address example: 2001::1 distance: maximum: 255 minimum: 1 type: integer description: Administrative distance format: int32 example: 1 default: 1 description: IP gateway address $$ref: '#/components/schemas/IPV6NextHop' prefix: pattern: ((^\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:)))(%.+)?\s*(\/)(\b([0-9]{1,2}|1[01][0-9]|12[0-8])\b)$)) type: string description: IPv6 Prefix example: 2001::/4 description: Configure IPv6 static routes $$ref: '#/components/schemas/Ipv6StaticRoute' description: IPv6 Route information $$ref: '#/components/schemas/Ipv6Route' description: Transport VPN instance $$ref: '#/components/schemas/baseVpnInstanceTransportInterfaceSetting' description: Controller VPN setting $$ref: '#/components/schemas/ControllerVpnSetting' description: The payload for controller device specific settings $$ref: '#/components/schemas/ControllerDeviceSpecificSetting' - required: - system - vpn type: object properties: system: required: - hostName - siteId - systemIp type: object properties: clock: required: - timezone type: object properties: timezone: type: string description: Set the timezone example: UTC enum: - Europe/Andorra - Asia/Dubai - Asia/Kabul - America/Antigua - America/Anguilla - Europe/Tirane - Asia/Yerevan - Africa/Luanda - Antarctica/McMurdo - Antarctica/Rothera - Antarctica/Palmer - Antarctica/Mawson - Antarctica/Davis - Antarctica/Casey - Antarctica/Vostok - Antarctica/DumontDUrville - Antarctica/Syowa - America/Argentina/Buenos_Aires - America/Argentina/Cordoba - America/Argentina/Salta - America/Argentina/Jujuy - America/Argentina/Tucuman - America/Argentina/Catamarca - America/Argentina/La_Rioja - America/Argentina/San_Juan - America/Argentina/Mendoza - America/Argentina/San_Luis - America/Argentina/Rio_Gallegos - America/Argentina/Ushuaia - Pacific/Pago_Pago - Europe/Vienna - Australia/Lord_Howe - Antarctica/Macquarie - Australia/Hobart - Australia/Currie - Australia/Melbourne - Australia/Sydney - Australia/Broken_Hill - Australia/Brisbane - Australia/Lindeman - Australia/Adelaide - Australia/Darwin - Australia/Perth - Australia/Eucla - America/Aruba - Europe/Mariehamn - Asia/Baku - Europe/Sarajevo - America/Barbados - Asia/Dhaka - Europe/Brussels - Africa/Ouagadougou - Europe/Sofia - Asia/Bahrain - Africa/Bujumbura - Africa/Porto-Novo - America/St_Barthelemy - Atlantic/Bermuda - Asia/Brunei - America/La_Paz - America/Kralendijk - America/Noronha - America/Belem - America/Fortaleza - America/Recife - America/Araguaina - America/Maceio - America/Bahia - America/Sao_Paulo - America/Campo_Grande - America/Cuiaba - America/Santarem - America/Porto_Velho - America/Boa_Vista - America/Manaus - America/Eirunepe - America/Rio_Branco - America/Nassau - Asia/Thimphu - Africa/Gaborone - Europe/Minsk - America/Belize - America/St_Johns - America/Halifax - America/Glace_Bay - America/Moncton - America/Goose_Bay - America/Blanc-Sablon - America/Toronto - America/Nipigon - America/Thunder_Bay - America/Iqaluit - America/Pangnirtung - America/Resolute - America/Atikokan - America/Rankin_Inlet - America/Winnipeg - America/Rainy_River - America/Regina - America/Swift_Current - America/Edmonton - America/Cambridge_Bay - America/Yellowknife - America/Inuvik - America/Creston - America/Dawson_Creek - America/Vancouver - America/Whitehorse - America/Dawson - Indian/Cocos - Africa/Kinshasa - Africa/Lubumbashi - Africa/Bangui - Africa/Brazzaville - Europe/Zurich - Africa/Abidjan - Pacific/Rarotonga - America/Santiago - Pacific/Easter - Africa/Douala - Asia/Shanghai - Asia/Harbin - Asia/Chongqing - Asia/Urumqi - Asia/Kashgar - America/Bogota - America/Costa_Rica - America/Havana - Atlantic/Cape_Verde - America/Curacao - Indian/Christmas - Asia/Nicosia - Europe/Prague - Europe/Berlin - Europe/Busingen - Africa/Djibouti - Europe/Copenhagen - America/Dominica - America/Santo_Domingo - Africa/Algiers - America/Guayaquil - Pacific/Galapagos - Europe/Tallinn - Africa/Cairo - Africa/El_Aaiun - Africa/Asmara - Europe/Madrid - Africa/Ceuta - Atlantic/Canary - Africa/Addis_Ababa - Europe/Helsinki - Pacific/Fiji - Atlantic/Stanley - Pacific/Chuuk - Pacific/Pohnpei - Pacific/Kosrae - Atlantic/Faroe - Europe/Paris - Africa/Libreville - Europe/London - America/Grenada - Asia/Tbilisi - America/Cayenne - Europe/Guernsey - Africa/Accra - Europe/Gibraltar - America/Godthab - America/Danmarkshavn - America/Scoresbysund - America/Thule - Africa/Banjul - Africa/Conakry - America/Guadeloupe - Africa/Malabo - Europe/Athens - Atlantic/South_Georgia - America/Guatemala - Pacific/Guam - Africa/Bissau - America/Guyana - Asia/Hong_Kong - America/Tegucigalpa - Europe/Zagreb - America/Port-au-Prince - Europe/Budapest - Asia/Jakarta - Asia/Pontianak - Asia/Makassar - Asia/Jayapura - Europe/Dublin - Asia/Jerusalem - Europe/Isle_of_Man - Asia/Kolkata - Indian/Chagos - Asia/Baghdad - Asia/Tehran - Atlantic/Reykjavik - Europe/Rome - Europe/Jersey - America/Jamaica - Asia/Amman - Asia/Tokyo - Africa/Nairobi - Asia/Bishkek - Asia/Phnom_Penh - Pacific/Tarawa - Pacific/Enderbury - Pacific/Kiritimati - Indian/Comoro - America/St_Kitts - Asia/Pyongyang - Asia/Seoul - Asia/Kuwait - America/Cayman - Asia/Almaty - Asia/Qyzylorda - Asia/Aqtobe - Asia/Aqtau - Asia/Oral - Asia/Vientiane - Asia/Beirut - America/St_Lucia - Europe/Vaduz - Asia/Colombo - Africa/Monrovia - Africa/Maseru - Europe/Vilnius - Europe/Luxembourg - Europe/Riga - Africa/Tripoli - Africa/Casablanca - Europe/Monaco - Europe/Chisinau - Europe/Podgorica - America/Marigot - Indian/Antananarivo - Pacific/Majuro - Pacific/Kwajalein - Europe/Skopje - Africa/Bamako - Asia/Rangoon - Asia/Ulaanbaatar - Asia/Hovd - Asia/Choibalsan - Asia/Macau - Pacific/Saipan - America/Martinique - Africa/Nouakchott - America/Montserrat - Europe/Malta - Indian/Mauritius - Indian/Maldives - Africa/Blantyre - America/Mexico_City - America/Cancun - America/Merida - America/Monterrey - America/Matamoros - America/Mazatlan - America/Chihuahua - America/Ojinaga - America/Hermosillo - America/Tijuana - America/Santa_Isabel - America/Bahia_Banderas - Asia/Kuala_Lumpur - Asia/Kuching - Africa/Maputo - Africa/Windhoek - Pacific/Noumea - Africa/Niamey - Pacific/Norfolk - Africa/Lagos - America/Managua - Europe/Amsterdam - Europe/Oslo - Asia/Kathmandu - Pacific/Nauru - Pacific/Niue - Pacific/Auckland - Pacific/Chatham - Asia/Muscat - America/Panama - America/Lima - Pacific/Tahiti - Pacific/Marquesas - Pacific/Gambier - Pacific/Port_Moresby - Asia/Manila - Asia/Karachi - Europe/Warsaw - America/Miquelon - Pacific/Pitcairn - America/Puerto_Rico - Asia/Gaza - Asia/Hebron - Europe/Lisbon - Atlantic/Madeira - Atlantic/Azores - Pacific/Palau - America/Asuncion - Asia/Qatar - Indian/Reunion - Europe/Bucharest - Europe/Belgrade - Europe/Kaliningrad - Europe/Moscow - Europe/Volgograd - Europe/Samara - Asia/Yekaterinburg - Asia/Omsk - Asia/Novosibirsk - Asia/Novokuznetsk - Asia/Krasnoyarsk - Asia/Irkutsk - Asia/Yakutsk - Asia/Khandyga - Asia/Vladivostok - Asia/Sakhalin - Asia/Ust-Nera - Asia/Magadan - Asia/Kamchatka - Asia/Anadyr - Africa/Kigali - Asia/Riyadh - Pacific/Guadalcanal - Indian/Mahe - Africa/Khartoum - Europe/Stockholm - Asia/Singapore - Atlantic/St_Helena - Europe/Ljubljana - Arctic/Longyearbyen - Europe/Bratislava - Africa/Freetown - Europe/San_Marino - Africa/Dakar - Africa/Mogadishu - America/Paramaribo - Africa/Juba - Africa/Sao_Tome - America/El_Salvador - America/Lower_Princes - Asia/Damascus - Africa/Mbabane - America/Grand_Turk - Africa/Ndjamena - Indian/Kerguelen - Africa/Lome - Asia/Bangkok - Asia/Dushanbe - Pacific/Fakaofo - Asia/Dili - Asia/Ashgabat - Africa/Tunis - Pacific/Tongatapu - Europe/Istanbul - America/Port_of_Spain - Pacific/Funafuti - Asia/Taipei - Africa/Dar_es_Salaam - Europe/Kiev - Europe/Uzhgorod - Europe/Zaporozhye - Europe/Simferopol - Africa/Kampala - Pacific/Johnston - Pacific/Midway - Pacific/Wake - America/New_York - America/Detroit - America/Kentucky/Louisville - America/Kentucky/Monticello - America/Indiana/Indianapolis - America/Indiana/Vincennes - America/Indiana/Winamac - America/Indiana/Marengo - America/Indiana/Petersburg - America/Indiana/Vevay - America/Chicago - America/Indiana/Tell_City - America/Indiana/Knox - America/Menominee - America/North_Dakota/Center - America/North_Dakota/New_Salem - America/North_Dakota/Beulah - America/Denver - America/Boise - America/Phoenix - America/Los_Angeles - America/Anchorage - America/Juneau - America/Sitka - America/Yakutat - America/Nome - America/Adak - America/Metlakatla - Pacific/Honolulu - America/Montevideo - Asia/Samarkand - Asia/Tashkent - Europe/Vatican - America/St_Vincent - America/Caracas - America/Tortola - America/St_Thomas - Asia/Ho_Chi_Minh - Pacific/Efate - Pacific/Wallis - Pacific/Apia - Asia/Aden - Indian/Mayotte - Africa/Johannesburg - Africa/Lusaka - Africa/Harare - UTC default: UTC description: Configure clock $$ref: '#/components/schemas/Clock' description: pattern: ^[^<>]{1,32}$ type: string description: Set a text description of the device example: System settings deviceGroups: type: array description: Configure device groups items: type: string description: Configure device groups gpsLocation: required: - latitude - longitude type: object properties: latitude: maximum: 90 minimum: -90 type: number description: Set the device’s physical latitude example: 60 longitude: maximum: 180 minimum: -180 type: number description: Set the device’s physical longitude example: 60 description: GPS latitude and longitude of the device $$ref: '#/components/schemas/GpsLocation' hostName: pattern: ^[a-zA-Z0-9\-_]{1,32}$ type: string description: Set the hostname example: vm12 ipv6StrictControl: type: boolean description: Enable Dual Stack IPv6 Default example: false default: false location: pattern: ^[^<>]{1,127}$ type: string description: Set the location of the device example: USA siteId: maximum: 4294967295 minimum: 0 type: integer description: Set the site ID format: int64 example: 100 systemIp: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: Set the system IP address example: 102.2.3.2 description: System configuration for manager $$ref: '#/components/schemas/ManagerSystemSetting' vpn: required: - transport type: object properties: management: required: - interface type: object properties: dns: type: object properties: dnsServerPrimary: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: Primary DNS server IPv4 or IPv6 Address example: 10.2.2.2 dnsServerSecondary: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: Secondary DNS server IPv4 or IPv6 Address example: 10.2.2.3 host: type: array items: required: - hostname - ip type: object properties: hostname: pattern: ^[a-zA-Z0-9\-_.]{1,64}$ type: string description: Host name example: vbond ip: maxItems: 64 minItems: 1 uniqueItems: true type: array items: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: IP Address example: 10.1.1.1 description: Static host mapping $$ref: '#/components/schemas/DnsHostMapping' description: Configure DNS servers or static host mapping $$ref: '#/components/schemas/ControlComponentDnsSetting' interface: maxItems: 2147483647 minItems: 1 type: array items: required: - ifName type: object properties: ifName: pattern: ^(?=.{1,32}$)(?:(ge0\/\d+(?:\.\d+)?|loopback\d+|eth\d+(?:\.\d+)?))$ type: string description: Interface name eth<0-..> or eth<0-..>.vlanid or loopback when present example: eth0 ip: type: object properties: address: pattern: ^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\/)([0-2]?[0-9]$|[3]?[0-2])$ type: string description: Assign IPv4 address example: 10.0.1.1/24 dhcpClient: type: boolean description: Enable DHCP example: false default: false dhcpDistance: maximum: 65536 minimum: 1 type: integer description: Set administrative distance for DHCP default route format: int32 example: 1 default: 1 description: IPv4 address or DHCP $$ref: '#/components/schemas/IpConfig' ipv6: type: object properties: address: pattern: ((^\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:)))(%.+)?\s*(\/)(\b([0-9]{1,2}|1[01][0-9]|12[0-8])\b)$)) type: string description: Assign IPv6 address example: 2001:a0:64::20/64 dhcpClient: type: boolean description: Enable DHCP example: false default: false dhcpDistance: maximum: 65536 minimum: 1 type: integer description: Set administrative distance for DHCP default route format: int32 example: 1 default: 1 dhcpRapidCommit: type: boolean description: Enable DHCPv6 rapid commit example: false default: false description: IPv6 address or DHCP $$ref: '#/components/schemas/Ipv6Config' shutdown: type: boolean description: Administrative state example: false default: false description: Interfaces configuration $$ref: '#/components/schemas/BaseInterfaceSetting' ipRoute: type: object properties: route: type: array items: required: - nextHop - prefix type: object properties: nextHop: maxItems: 2147483647 minItems: 1 type: array items: required: - address type: object properties: address: pattern: ^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$ type: string description: IPv4 Address example: 10.0.0.1 distance: maximum: 255 minimum: 1 type: integer description: Administrative distance format: int32 example: 1 default: 1 description: IP gateway address $$ref: '#/components/schemas/NextHop' prefix: pattern: ^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\/)([0-2]?[0-9]$|[3]?[0-2])$ type: string description: IPv4 Prefix example: 0.0.0.0/0 description: Configure static routes $$ref: '#/components/schemas/StaticRoute' description: IP Route information $$ref: '#/components/schemas/IpRoute' ipv6Route: type: object properties: route: type: array items: required: - nextHop - prefix type: object properties: nextHop: maxItems: 2147483647 minItems: 1 type: array items: required: - address type: object properties: address: pattern: (([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)) type: string description: IPv6 Address example: 2001::1 distance: maximum: 255 minimum: 1 type: integer description: Administrative distance format: int32 example: 1 default: 1 description: IP gateway address $$ref: '#/components/schemas/IPV6NextHop' prefix: pattern: ((^\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:)))(%.+)?\s*(\/)(\b([0-9]{1,2}|1[01][0-9]|12[0-8])\b)$)) type: string description: IPv6 Prefix example: 2001::/4 description: Configure IPv6 static routes $$ref: '#/components/schemas/Ipv6StaticRoute' description: IPv6 Route information $$ref: '#/components/schemas/Ipv6Route' description: Management VPN instance $$ref: '#/components/schemas/baseVpnInstanceBaseInterfaceSetting' transport: required: - interface type: object properties: dns: type: object properties: dnsServerPrimary: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: Primary DNS server IPv4 or IPv6 Address example: 10.2.2.2 dnsServerSecondary: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: Secondary DNS server IPv4 or IPv6 Address example: 10.2.2.3 host: type: array items: required: - hostname - ip type: object properties: hostname: pattern: ^[a-zA-Z0-9\-_.]{1,64}$ type: string description: Host name example: vbond ip: maxItems: 64 minItems: 1 uniqueItems: true type: array items: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: IP Address example: 10.1.1.1 description: Static host mapping $$ref: '#/components/schemas/DnsHostMapping' description: Configure DNS servers or static host mapping $$ref: '#/components/schemas/ControlComponentDnsSetting' interface: maxItems: 2147483647 minItems: 1 type: array items: required: - ifName type: object properties: ifName: pattern: ^(?=.{1,32}$)(?:(ge0\/\d+(?:\.\d+)?|loopback\d+|eth\d+(?:\.\d+)?))$ type: string description: Interface name eth<0-..> or eth<0-..>.vlanid or loopback when present example: eth0 ip: type: object properties: address: pattern: ^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\/)([0-2]?[0-9]$|[3]?[0-2])$ type: string description: Assign IPv4 address example: 10.0.1.1/24 dhcpClient: type: boolean description: Enable DHCP example: false default: false dhcpDistance: maximum: 65536 minimum: 1 type: integer description: Set administrative distance for DHCP default route format: int32 example: 1 default: 1 description: IPv4 address or DHCP $$ref: '#/components/schemas/IpConfig' ipv6: type: object properties: address: pattern: ((^\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:)))(%.+)?\s*(\/)(\b([0-9]{1,2}|1[01][0-9]|12[0-8])\b)$)) type: string description: Assign IPv6 address example: 2001:a0:64::20/64 dhcpClient: type: boolean description: Enable DHCP example: false default: false dhcpDistance: maximum: 65536 minimum: 1 type: integer description: Set administrative distance for DHCP default route format: int32 example: 1 default: 1 dhcpRapidCommit: type: boolean description: Enable DHCPv6 rapid commit example: false default: false description: IPv6 address or DHCP $$ref: '#/components/schemas/Ipv6Config' shutdown: type: boolean description: Administrative state example: false default: false tunnelInterface: type: object properties: allowService: type: object properties: all: type: boolean description: Allow all traffic. Overrides all other allow-service options if allow-service all is set example: false default: false dhcp: type: boolean description: Allow/Deny DHCP example: true default: true dns: type: boolean description: Allow/Deny DNS example: true default: true icmp: type: boolean description: Allow/Deny ICMP example: true default: true netconf: type: boolean description: Allow/Deny NETCONF example: false default: false ntp: type: boolean description: Allow/Deny NTP example: false default: false sshd: type: boolean description: Allow/Deny SSH example: false default: false stun: type: boolean description: Allow/Deny STUN example: false default: false description: Set services allowed on the WAN interface $$ref: '#/components/schemas/AllowService' color: type: object properties: value: type: string description: Set color for TLOC example: default enum: - default - mpls - metro-ethernet - biz-internet - public-internet - lte - 3g - red - green - blue - gold - silver - bronze - custom1 - custom2 - custom3 - private1 - private2 - private3 - private4 - private5 - private6 default: default description: Set color for TLOC $$ref: '#/components/schemas/Color' description: Tunnel interface configuration $$ref: '#/components/schemas/TunnelInterface' description: Interfaces configuration $$ref: '#/components/schemas/TransportInterfaceSetting' ipRoute: type: object properties: route: type: array items: required: - nextHop - prefix type: object properties: nextHop: maxItems: 2147483647 minItems: 1 type: array items: required: - address type: object properties: address: pattern: ^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$ type: string description: IPv4 Address example: 10.0.0.1 distance: maximum: 255 minimum: 1 type: integer description: Administrative distance format: int32 example: 1 default: 1 description: IP gateway address $$ref: '#/components/schemas/NextHop' prefix: pattern: ^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\/)([0-2]?[0-9]$|[3]?[0-2])$ type: string description: IPv4 Prefix example: 0.0.0.0/0 description: Configure static routes $$ref: '#/components/schemas/StaticRoute' description: IP Route information $$ref: '#/components/schemas/IpRoute' ipv6Route: type: object properties: route: type: array items: required: - nextHop - prefix type: object properties: nextHop: maxItems: 2147483647 minItems: 1 type: array items: required: - address type: object properties: address: pattern: (([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)) type: string description: IPv6 Address example: 2001::1 distance: maximum: 255 minimum: 1 type: integer description: Administrative distance format: int32 example: 1 default: 1 description: IP gateway address $$ref: '#/components/schemas/IPV6NextHop' prefix: pattern: ((^\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:)))(%.+)?\s*(\/)(\b([0-9]{1,2}|1[01][0-9]|12[0-8])\b)$)) type: string description: IPv6 Prefix example: 2001::/4 description: Configure IPv6 static routes $$ref: '#/components/schemas/Ipv6StaticRoute' description: IPv6 Route information $$ref: '#/components/schemas/Ipv6Route' description: Transport VPN instance $$ref: '#/components/schemas/baseVpnInstanceTransportInterfaceSetting' description: Manager VPN setting $$ref: '#/components/schemas/ManagerVpnSetting' description: The payload for manager device specific settings $$ref: '#/components/schemas/ManagerDeviceSpecificSetting' examples: CreateControllerDeviceSpecificSettingsExample: description: CreateControllerDeviceSpecificSettingsExample value: system: systemIp: 172.16.255.20 hostName: Controller01 description: Controller 1 siteId: 200 location: Shang hai systemTunnelMtu: 2000 gpsLocation: latitude: 90 longitude: 180 clock: timezone: Europe/Andorra deviceGroups: - group1 overlayId: 3 ipv6StrictControl: true controllerGroupId: 1 vpn: transport: ipRoute: route: - prefix: 0.0.0.0/0 nextHop: - address: 10.0.12.13 distance: 1 ipv6Route: route: - prefix: ::/0 nextHop: - address: 2001:a0:c::d interface: - ifName: eth0 ip: address: 10.0.1.30/24 ipv6: address: 2001:a0:1::1e/64 shutdown: false - ifName: eth1 ip: address: 10.0.12.20/24 ipv6: address: 2001:a0:c::14/64 tunnelInterface: allowService: all: true dhcp: true dns: true icmp: true sshd: false netconf: false ntp: false stun: false shutdown: false management: interface: - ifName: eth2 ip: address: 10.2.2.20/24 ipv6: address: 2001:a2:2::14/64 shutdown: false $$ref: '#/components/examples/ComViptelaVmanageServerDeviceconfigControlcomponentSettingRequestExampleCreatecontrollerdevicespecificsettings' CreateValidatorDeviceSpecificSettingsExample: description: CreateValidatorDeviceSpecificSettingsExample value: system: systemIp: 172.16.255.19 hostName: Validator01 description: Validator 1 siteId: 100 location: Shang hai gpsLocation: latitude: 90 longitude: 180 clock: timezone: Europe/Andorra deviceGroups: - group1 vbond: address: 10.0.1.26 vpn: transport: ipRoute: route: - prefix: 0.0.0.0/0 nextHop: - address: 10.0.5.13 distance: 1 ipv6Route: route: - prefix: ::/0 nextHop: - address: 2001:a0:5::d interface: - ifName: eth0 ip: address: 10.0.1.19/24 ipv6: address: 2001:a0:1::13/64 shutdown: false - ifName: eth1 ip: address: 10.0.5.19/24 ipv6: address: 2001:a0:5::13/64 shutdown: false - ifName: eth3 ip: address: 10.1.15.19/24 ipv6: address: 2001:a1:f::13/64 shutdown: false management: interface: - ifName: eth2 ip: address: 10.2.2.19/24 ipv6: address: 2001:a2:2::13/64 shutdown: false $$ref: '#/components/examples/ComViptelaVmanageServerDeviceconfigControlcomponentSettingRequestExampleCreatevalidatordevicespecificsettings' CreateManagerDeviceSpecificSettingsExample: description: CreateManagerDeviceSpecificSettingsExample value: system: systemIp: 172.16.255.22 hostName: Manager01 clock: timezone: UTC siteId: 200 ipv6StrictControl: false vpn: transport: ipRoute: route: - prefix: 0.0.0.0/0 nextHop: - address: 10.0.12.13 distance: 1 interface: - ifName: eth0 ip: dhcpClient: true dhcpDistance: 1 ipv6: dhcpClient: true dhcpDistance: 1 dhcpRapidCommit: false shutdown: false - ifName: eth1 ip: address: 10.0.12.22/24 shutdown: false tunnelInterface: color: value: default allowService: all: false dhcp: true dns: true icmp: true sshd: false netconf: false ntp: false stun: false - ifName: eth2 ip: address: 10.0.5.22/24 shutdown: false - ifName: eth5 ip: address: 10.0.105.32/24 shutdown: false management: interface: - ifName: eth3 ip: address: 10.2.4.22/24 shutdown: false $$ref: '#/components/examples/ComViptelaVmanageServerDeviceconfigControlcomponentSettingRequestExampleCreatemanagerdevicespecificsettings' '400': description: Bad Request content: application/json: schema: required: - error type: object properties: error: required: - code - details - message - type type: object properties: code: type: string description: Internal error code example: CCS0018 details: type: string description: Error message detail example: Unrecognized field user1 message: type: string description: Error message summary example: Invalid control component setting payload type: type: string description: Error message title example: error description: Error response $$ref: '#/components/schemas/ErrorDetails' $$ref: '#/components/schemas/ErrorResponse' examples: InvalidControlComponentDeviceSpecificSettings: description: InvalidControlComponentDeviceSpecificSettings value: error: message: Invalid control component payload code: CCS0018 details: 'vpn.transport.interfaces : required but missing; ' type: error $$ref: '#/components/examples/ComViptelaVmanageServerDeviceconfigControlcomponentSettingResponseExampleCreatedevicespecificsettingsfailedresponse' '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Control Component Settings-write get: tags: - Configuration - Control Component Setting description: Get the device-specific settings for a specific control component. The deviceId can be obtained from the "uuid" field in the data returned by the API (GET /dataservice/certificate/data/controller/list) operationId: getControlComponentDeviceSpecificSettings parameters: - name: deviceId in: path description: Control component device UUID required: true schema: type: string format: uuid responses: '200': description: Success content: application/json: schema: oneOf: - required: - createdBy - createdOn - payload type: object properties: createdBy: type: string description: The user who created the controller device specific settings example: admin createdOn: type: integer description: The timestamp when controller device specific settings are created format: int64 example: 1741315339238 lastUpdatedBy: type: string description: The user who modified the controller device specific settings example: admin lastUpdatedOn: type: integer description: The timestamp when controller device specific settings are modified format: int64 example: 1741315339240 payload: required: - system - vpn type: object properties: system: required: - hostName - siteId - systemIp type: object properties: clock: required: - timezone type: object properties: timezone: type: string description: Set the timezone example: UTC enum: - Europe/Andorra - Asia/Dubai - Asia/Kabul - America/Antigua - America/Anguilla - Europe/Tirane - Asia/Yerevan - Africa/Luanda - Antarctica/McMurdo - Antarctica/Rothera - Antarctica/Palmer - Antarctica/Mawson - Antarctica/Davis - Antarctica/Casey - Antarctica/Vostok - Antarctica/DumontDUrville - Antarctica/Syowa - America/Argentina/Buenos_Aires - America/Argentina/Cordoba - America/Argentina/Salta - America/Argentina/Jujuy - America/Argentina/Tucuman - America/Argentina/Catamarca - America/Argentina/La_Rioja - America/Argentina/San_Juan - America/Argentina/Mendoza - America/Argentina/San_Luis - America/Argentina/Rio_Gallegos - America/Argentina/Ushuaia - Pacific/Pago_Pago - Europe/Vienna - Australia/Lord_Howe - Antarctica/Macquarie - Australia/Hobart - Australia/Currie - Australia/Melbourne - Australia/Sydney - Australia/Broken_Hill - Australia/Brisbane - Australia/Lindeman - Australia/Adelaide - Australia/Darwin - Australia/Perth - Australia/Eucla - America/Aruba - Europe/Mariehamn - Asia/Baku - Europe/Sarajevo - America/Barbados - Asia/Dhaka - Europe/Brussels - Africa/Ouagadougou - Europe/Sofia - Asia/Bahrain - Africa/Bujumbura - Africa/Porto-Novo - America/St_Barthelemy - Atlantic/Bermuda - Asia/Brunei - America/La_Paz - America/Kralendijk - America/Noronha - America/Belem - America/Fortaleza - America/Recife - America/Araguaina - America/Maceio - America/Bahia - America/Sao_Paulo - America/Campo_Grande - America/Cuiaba - America/Santarem - America/Porto_Velho - America/Boa_Vista - America/Manaus - America/Eirunepe - America/Rio_Branco - America/Nassau - Asia/Thimphu - Africa/Gaborone - Europe/Minsk - America/Belize - America/St_Johns - America/Halifax - America/Glace_Bay - America/Moncton - America/Goose_Bay - America/Blanc-Sablon - America/Toronto - America/Nipigon - America/Thunder_Bay - America/Iqaluit - America/Pangnirtung - America/Resolute - America/Atikokan - America/Rankin_Inlet - America/Winnipeg - America/Rainy_River - America/Regina - America/Swift_Current - America/Edmonton - America/Cambridge_Bay - America/Yellowknife - America/Inuvik - America/Creston - America/Dawson_Creek - America/Vancouver - America/Whitehorse - America/Dawson - Indian/Cocos - Africa/Kinshasa - Africa/Lubumbashi - Africa/Bangui - Africa/Brazzaville - Europe/Zurich - Africa/Abidjan - Pacific/Rarotonga - America/Santiago - Pacific/Easter - Africa/Douala - Asia/Shanghai - Asia/Harbin - Asia/Chongqing - Asia/Urumqi - Asia/Kashgar - America/Bogota - America/Costa_Rica - America/Havana - Atlantic/Cape_Verde - America/Curacao - Indian/Christmas - Asia/Nicosia - Europe/Prague - Europe/Berlin - Europe/Busingen - Africa/Djibouti - Europe/Copenhagen - America/Dominica - America/Santo_Domingo - Africa/Algiers - America/Guayaquil - Pacific/Galapagos - Europe/Tallinn - Africa/Cairo - Africa/El_Aaiun - Africa/Asmara - Europe/Madrid - Africa/Ceuta - Atlantic/Canary - Africa/Addis_Ababa - Europe/Helsinki - Pacific/Fiji - Atlantic/Stanley - Pacific/Chuuk - Pacific/Pohnpei - Pacific/Kosrae - Atlantic/Faroe - Europe/Paris - Africa/Libreville - Europe/London - America/Grenada - Asia/Tbilisi - America/Cayenne - Europe/Guernsey - Africa/Accra - Europe/Gibraltar - America/Godthab - America/Danmarkshavn - America/Scoresbysund - America/Thule - Africa/Banjul - Africa/Conakry - America/Guadeloupe - Africa/Malabo - Europe/Athens - Atlantic/South_Georgia - America/Guatemala - Pacific/Guam - Africa/Bissau - America/Guyana - Asia/Hong_Kong - America/Tegucigalpa - Europe/Zagreb - America/Port-au-Prince - Europe/Budapest - Asia/Jakarta - Asia/Pontianak - Asia/Makassar - Asia/Jayapura - Europe/Dublin - Asia/Jerusalem - Europe/Isle_of_Man - Asia/Kolkata - Indian/Chagos - Asia/Baghdad - Asia/Tehran - Atlantic/Reykjavik - Europe/Rome - Europe/Jersey - America/Jamaica - Asia/Amman - Asia/Tokyo - Africa/Nairobi - Asia/Bishkek - Asia/Phnom_Penh - Pacific/Tarawa - Pacific/Enderbury - Pacific/Kiritimati - Indian/Comoro - America/St_Kitts - Asia/Pyongyang - Asia/Seoul - Asia/Kuwait - America/Cayman - Asia/Almaty - Asia/Qyzylorda - Asia/Aqtobe - Asia/Aqtau - Asia/Oral - Asia/Vientiane - Asia/Beirut - America/St_Lucia - Europe/Vaduz - Asia/Colombo - Africa/Monrovia - Africa/Maseru - Europe/Vilnius - Europe/Luxembourg - Europe/Riga - Africa/Tripoli - Africa/Casablanca - Europe/Monaco - Europe/Chisinau - Europe/Podgorica - America/Marigot - Indian/Antananarivo - Pacific/Majuro - Pacific/Kwajalein - Europe/Skopje - Africa/Bamako - Asia/Rangoon - Asia/Ulaanbaatar - Asia/Hovd - Asia/Choibalsan - Asia/Macau - Pacific/Saipan - America/Martinique - Africa/Nouakchott - America/Montserrat - Europe/Malta - Indian/Mauritius - Indian/Maldives - Africa/Blantyre - America/Mexico_City - America/Cancun - America/Merida - America/Monterrey - America/Matamoros - America/Mazatlan - America/Chihuahua - America/Ojinaga - America/Hermosillo - America/Tijuana - America/Santa_Isabel - America/Bahia_Banderas - Asia/Kuala_Lumpur - Asia/Kuching - Africa/Maputo - Africa/Windhoek - Pacific/Noumea - Africa/Niamey - Pacific/Norfolk - Africa/Lagos - America/Managua - Europe/Amsterdam - Europe/Oslo - Asia/Kathmandu - Pacific/Nauru - Pacific/Niue - Pacific/Auckland - Pacific/Chatham - Asia/Muscat - America/Panama - America/Lima - Pacific/Tahiti - Pacific/Marquesas - Pacific/Gambier - Pacific/Port_Moresby - Asia/Manila - Asia/Karachi - Europe/Warsaw - America/Miquelon - Pacific/Pitcairn - America/Puerto_Rico - Asia/Gaza - Asia/Hebron - Europe/Lisbon - Atlantic/Madeira - Atlantic/Azores - Pacific/Palau - America/Asuncion - Asia/Qatar - Indian/Reunion - Europe/Bucharest - Europe/Belgrade - Europe/Kaliningrad - Europe/Moscow - Europe/Volgograd - Europe/Samara - Asia/Yekaterinburg - Asia/Omsk - Asia/Novosibirsk - Asia/Novokuznetsk - Asia/Krasnoyarsk - Asia/Irkutsk - Asia/Yakutsk - Asia/Khandyga - Asia/Vladivostok - Asia/Sakhalin - Asia/Ust-Nera - Asia/Magadan - Asia/Kamchatka - Asia/Anadyr - Africa/Kigali - Asia/Riyadh - Pacific/Guadalcanal - Indian/Mahe - Africa/Khartoum - Europe/Stockholm - Asia/Singapore - Atlantic/St_Helena - Europe/Ljubljana - Arctic/Longyearbyen - Europe/Bratislava - Africa/Freetown - Europe/San_Marino - Africa/Dakar - Africa/Mogadishu - America/Paramaribo - Africa/Juba - Africa/Sao_Tome - America/El_Salvador - America/Lower_Princes - Asia/Damascus - Africa/Mbabane - America/Grand_Turk - Africa/Ndjamena - Indian/Kerguelen - Africa/Lome - Asia/Bangkok - Asia/Dushanbe - Pacific/Fakaofo - Asia/Dili - Asia/Ashgabat - Africa/Tunis - Pacific/Tongatapu - Europe/Istanbul - America/Port_of_Spain - Pacific/Funafuti - Asia/Taipei - Africa/Dar_es_Salaam - Europe/Kiev - Europe/Uzhgorod - Europe/Zaporozhye - Europe/Simferopol - Africa/Kampala - Pacific/Johnston - Pacific/Midway - Pacific/Wake - America/New_York - America/Detroit - America/Kentucky/Louisville - America/Kentucky/Monticello - America/Indiana/Indianapolis - America/Indiana/Vincennes - America/Indiana/Winamac - America/Indiana/Marengo - America/Indiana/Petersburg - America/Indiana/Vevay - America/Chicago - America/Indiana/Tell_City - America/Indiana/Knox - America/Menominee - America/North_Dakota/Center - America/North_Dakota/New_Salem - America/North_Dakota/Beulah - America/Denver - America/Boise - America/Phoenix - America/Los_Angeles - America/Anchorage - America/Juneau - America/Sitka - America/Yakutat - America/Nome - America/Adak - America/Metlakatla - Pacific/Honolulu - America/Montevideo - Asia/Samarkand - Asia/Tashkent - Europe/Vatican - America/St_Vincent - America/Caracas - America/Tortola - America/St_Thomas - Asia/Ho_Chi_Minh - Pacific/Efate - Pacific/Wallis - Pacific/Apia - Asia/Aden - Indian/Mayotte - Africa/Johannesburg - Africa/Lusaka - Africa/Harare - UTC default: UTC description: Configure clock $$ref: '#/components/schemas/Clock' controllerGroupId: maximum: 100 minimum: 0 type: integer description: Controller group id format: int32 example: 0 default: 0 description: pattern: ^[^<>]{1,32}$ type: string description: Set a text description of the device example: System settings deviceGroups: type: array description: Configure device groups items: type: string description: Configure device groups gpsLocation: required: - latitude - longitude type: object properties: latitude: maximum: 90 minimum: -90 type: number description: Set the device’s physical latitude example: 60 longitude: maximum: 180 minimum: -180 type: number description: Set the device’s physical longitude example: 60 description: GPS latitude and longitude of the device $$ref: '#/components/schemas/GpsLocation' hostName: pattern: ^[a-zA-Z0-9\-_]{1,32}$ type: string description: Set the hostname example: vm12 ipv6StrictControl: type: boolean description: Sets up a strict IPv6 control connection in a dual stack IP example: false default: false location: pattern: ^[^<>]{1,127}$ type: string description: Set the location of the device example: USA overlayId: maximum: 4294967295 minimum: 1 type: integer description: Set the Overlay ID format: int64 example: 1 default: 1 region: type: object properties: regionIdList: maxItems: 2147483647 minItems: 1 uniqueItems: true type: array items: maximum: 63 minimum: 0 type: integer description: Configure a list of region ID format: int32 example: 0 $$ref: '#/components/schemas/Region' siteId: maximum: 4294967295 minimum: 0 type: integer description: Set the site ID format: int64 example: 100 systemIp: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: Set the system IP address example: 102.2.3.2 description: System configuration for controller $$ref: '#/components/schemas/ControllerSystemSetting' vpn: required: - transport type: object properties: management: required: - interface type: object properties: dns: type: object properties: dnsServerPrimary: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: Primary DNS server IPv4 or IPv6 Address example: 10.2.2.2 dnsServerSecondary: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: Secondary DNS server IPv4 or IPv6 Address example: 10.2.2.3 host: type: array items: required: - hostname - ip type: object properties: hostname: pattern: ^[a-zA-Z0-9\-_.]{1,64}$ type: string description: Host name example: vbond ip: maxItems: 64 minItems: 1 uniqueItems: true type: array items: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: IP Address example: 10.1.1.1 description: Static host mapping $$ref: '#/components/schemas/DnsHostMapping' description: Configure DNS servers or static host mapping $$ref: '#/components/schemas/ControlComponentDnsSetting' interface: maxItems: 2147483647 minItems: 1 type: array items: required: - ifName type: object properties: ifName: pattern: ^(?=.{1,32}$)(?:(ge0\/\d+(?:\.\d+)?|loopback\d+|eth\d+(?:\.\d+)?))$ type: string description: Interface name eth<0-..> or eth<0-..>.vlanid or loopback when present example: eth0 ip: type: object properties: address: pattern: ^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\/)([0-2]?[0-9]$|[3]?[0-2])$ type: string description: Assign IPv4 address example: 10.0.1.1/24 dhcpClient: type: boolean description: Enable DHCP example: false default: false dhcpDistance: maximum: 65536 minimum: 1 type: integer description: Set administrative distance for DHCP default route format: int32 example: 1 default: 1 description: IPv4 address or DHCP $$ref: '#/components/schemas/IpConfig' ipv6: type: object properties: address: pattern: ((^\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:)))(%.+)?\s*(\/)(\b([0-9]{1,2}|1[01][0-9]|12[0-8])\b)$)) type: string description: Assign IPv6 address example: 2001:a0:64::20/64 dhcpClient: type: boolean description: Enable DHCP example: false default: false dhcpDistance: maximum: 65536 minimum: 1 type: integer description: Set administrative distance for DHCP default route format: int32 example: 1 default: 1 dhcpRapidCommit: type: boolean description: Enable DHCPv6 rapid commit example: false default: false description: IPv6 address or DHCP $$ref: '#/components/schemas/Ipv6Config' shutdown: type: boolean description: Administrative state example: false default: false description: Interfaces configuration $$ref: '#/components/schemas/BaseInterfaceSetting' ipRoute: type: object properties: route: type: array items: required: - nextHop - prefix type: object properties: nextHop: maxItems: 2147483647 minItems: 1 type: array items: required: - address type: object properties: address: pattern: ^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$ type: string description: IPv4 Address example: 10.0.0.1 distance: maximum: 255 minimum: 1 type: integer description: Administrative distance format: int32 example: 1 default: 1 description: IP gateway address $$ref: '#/components/schemas/NextHop' prefix: pattern: ^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\/)([0-2]?[0-9]$|[3]?[0-2])$ type: string description: IPv4 Prefix example: 0.0.0.0/0 description: Configure static routes $$ref: '#/components/schemas/StaticRoute' description: IP Route information $$ref: '#/components/schemas/IpRoute' ipv6Route: type: object properties: route: type: array items: required: - nextHop - prefix type: object properties: nextHop: maxItems: 2147483647 minItems: 1 type: array items: required: - address type: object properties: address: pattern: (([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)) type: string description: IPv6 Address example: 2001::1 distance: maximum: 255 minimum: 1 type: integer description: Administrative distance format: int32 example: 1 default: 1 description: IP gateway address $$ref: '#/components/schemas/IPV6NextHop' prefix: pattern: ((^\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:)))(%.+)?\s*(\/)(\b([0-9]{1,2}|1[01][0-9]|12[0-8])\b)$)) type: string description: IPv6 Prefix example: 2001::/4 description: Configure IPv6 static routes $$ref: '#/components/schemas/Ipv6StaticRoute' description: IPv6 Route information $$ref: '#/components/schemas/Ipv6Route' description: Management VPN instance $$ref: '#/components/schemas/baseVpnInstanceBaseInterfaceSetting' transport: required: - interface type: object properties: dns: type: object properties: dnsServerPrimary: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: Primary DNS server IPv4 or IPv6 Address example: 10.2.2.2 dnsServerSecondary: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: Secondary DNS server IPv4 or IPv6 Address example: 10.2.2.3 host: type: array items: required: - hostname - ip type: object properties: hostname: pattern: ^[a-zA-Z0-9\-_.]{1,64}$ type: string description: Host name example: vbond ip: maxItems: 64 minItems: 1 uniqueItems: true type: array items: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: IP Address example: 10.1.1.1 description: Static host mapping $$ref: '#/components/schemas/DnsHostMapping' description: Configure DNS servers or static host mapping $$ref: '#/components/schemas/ControlComponentDnsSetting' interface: maxItems: 2147483647 minItems: 1 type: array items: required: - ifName type: object properties: ifName: pattern: ^(?=.{1,32}$)(?:(ge0\/\d+(?:\.\d+)?|loopback\d+|eth\d+(?:\.\d+)?))$ type: string description: Interface name eth<0-..> or eth<0-..>.vlanid or loopback when present example: eth0 ip: type: object properties: address: pattern: ^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\/)([0-2]?[0-9]$|[3]?[0-2])$ type: string description: Assign IPv4 address example: 10.0.1.1/24 dhcpClient: type: boolean description: Enable DHCP example: false default: false dhcpDistance: maximum: 65536 minimum: 1 type: integer description: Set administrative distance for DHCP default route format: int32 example: 1 default: 1 description: IPv4 address or DHCP $$ref: '#/components/schemas/IpConfig' ipv6: type: object properties: address: pattern: ((^\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:)))(%.+)?\s*(\/)(\b([0-9]{1,2}|1[01][0-9]|12[0-8])\b)$)) type: string description: Assign IPv6 address example: 2001:a0:64::20/64 dhcpClient: type: boolean description: Enable DHCP example: false default: false dhcpDistance: maximum: 65536 minimum: 1 type: integer description: Set administrative distance for DHCP default route format: int32 example: 1 default: 1 dhcpRapidCommit: type: boolean description: Enable DHCPv6 rapid commit example: false default: false description: IPv6 address or DHCP $$ref: '#/components/schemas/Ipv6Config' shutdown: type: boolean description: Administrative state example: false default: false tunnelInterface: type: object properties: allowService: type: object properties: all: type: boolean description: Allow all traffic. Overrides all other allow-service options if allow-service all is set example: false default: false dhcp: type: boolean description: Allow/Deny DHCP example: true default: true dns: type: boolean description: Allow/Deny DNS example: true default: true icmp: type: boolean description: Allow/Deny ICMP example: true default: true netconf: type: boolean description: Allow/Deny NETCONF example: false default: false ntp: type: boolean description: Allow/Deny NTP example: false default: false sshd: type: boolean description: Allow/Deny SSH example: false default: false stun: type: boolean description: Allow/Deny STUN example: false default: false description: Set services allowed on the WAN interface $$ref: '#/components/schemas/AllowService' color: type: object properties: value: type: string description: Set color for TLOC example: default enum: - default - mpls - metro-ethernet - biz-internet - public-internet - lte - 3g - red - green - blue - gold - silver - bronze - custom1 - custom2 - custom3 - private1 - private2 - private3 - private4 - private5 - private6 default: default description: Set color for TLOC $$ref: '#/components/schemas/Color' description: Tunnel interface configuration $$ref: '#/components/schemas/TunnelInterface' description: Interfaces configuration $$ref: '#/components/schemas/TransportInterfaceSetting' ipRoute: type: object properties: route: type: array items: required: - nextHop - prefix type: object properties: nextHop: maxItems: 2147483647 minItems: 1 type: array items: required: - address type: object properties: address: pattern: ^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$ type: string description: IPv4 Address example: 10.0.0.1 distance: maximum: 255 minimum: 1 type: integer description: Administrative distance format: int32 example: 1 default: 1 description: IP gateway address $$ref: '#/components/schemas/NextHop' prefix: pattern: ^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\/)([0-2]?[0-9]$|[3]?[0-2])$ type: string description: IPv4 Prefix example: 0.0.0.0/0 description: Configure static routes $$ref: '#/components/schemas/StaticRoute' description: IP Route information $$ref: '#/components/schemas/IpRoute' ipv6Route: type: object properties: route: type: array items: required: - nextHop - prefix type: object properties: nextHop: maxItems: 2147483647 minItems: 1 type: array items: required: - address type: object properties: address: pattern: (([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)) type: string description: IPv6 Address example: 2001::1 distance: maximum: 255 minimum: 1 type: integer description: Administrative distance format: int32 example: 1 default: 1 description: IP gateway address $$ref: '#/components/schemas/IPV6NextHop' prefix: pattern: ((^\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:)))(%.+)?\s*(\/)(\b([0-9]{1,2}|1[01][0-9]|12[0-8])\b)$)) type: string description: IPv6 Prefix example: 2001::/4 description: Configure IPv6 static routes $$ref: '#/components/schemas/Ipv6StaticRoute' description: IPv6 Route information $$ref: '#/components/schemas/Ipv6Route' description: Transport VPN instance $$ref: '#/components/schemas/baseVpnInstanceTransportInterfaceSetting' description: Controller VPN setting $$ref: '#/components/schemas/ControllerVpnSetting' description: The payload for controller device specific settings $$ref: '#/components/schemas/ControllerDeviceSpecificSetting' $$ref: '#/components/schemas/QueryControllerDeviceSpecificSettingsResponse' - required: - createdBy - createdOn - payload type: object properties: createdBy: type: string description: The user who created the controller device specific settings example: admin createdOn: type: integer description: The timestamp when controller device specific settings are created format: int64 example: 1741315339238 lastUpdatedBy: type: string description: The user who modified the controller device specific settings example: admin lastUpdatedOn: type: integer description: The timestamp when controller device specific settings are modified format: int64 example: 1741315339240 payload: required: - system - vpn type: object properties: system: required: - hostName - siteId - systemIp type: object properties: clock: required: - timezone type: object properties: timezone: type: string description: Set the timezone example: UTC enum: - Europe/Andorra - Asia/Dubai - Asia/Kabul - America/Antigua - America/Anguilla - Europe/Tirane - Asia/Yerevan - Africa/Luanda - Antarctica/McMurdo - Antarctica/Rothera - Antarctica/Palmer - Antarctica/Mawson - Antarctica/Davis - Antarctica/Casey - Antarctica/Vostok - Antarctica/DumontDUrville - Antarctica/Syowa - America/Argentina/Buenos_Aires - America/Argentina/Cordoba - America/Argentina/Salta - America/Argentina/Jujuy - America/Argentina/Tucuman - America/Argentina/Catamarca - America/Argentina/La_Rioja - America/Argentina/San_Juan - America/Argentina/Mendoza - America/Argentina/San_Luis - America/Argentina/Rio_Gallegos - America/Argentina/Ushuaia - Pacific/Pago_Pago - Europe/Vienna - Australia/Lord_Howe - Antarctica/Macquarie - Australia/Hobart - Australia/Currie - Australia/Melbourne - Australia/Sydney - Australia/Broken_Hill - Australia/Brisbane - Australia/Lindeman - Australia/Adelaide - Australia/Darwin - Australia/Perth - Australia/Eucla - America/Aruba - Europe/Mariehamn - Asia/Baku - Europe/Sarajevo - America/Barbados - Asia/Dhaka - Europe/Brussels - Africa/Ouagadougou - Europe/Sofia - Asia/Bahrain - Africa/Bujumbura - Africa/Porto-Novo - America/St_Barthelemy - Atlantic/Bermuda - Asia/Brunei - America/La_Paz - America/Kralendijk - America/Noronha - America/Belem - America/Fortaleza - America/Recife - America/Araguaina - America/Maceio - America/Bahia - America/Sao_Paulo - America/Campo_Grande - America/Cuiaba - America/Santarem - America/Porto_Velho - America/Boa_Vista - America/Manaus - America/Eirunepe - America/Rio_Branco - America/Nassau - Asia/Thimphu - Africa/Gaborone - Europe/Minsk - America/Belize - America/St_Johns - America/Halifax - America/Glace_Bay - America/Moncton - America/Goose_Bay - America/Blanc-Sablon - America/Toronto - America/Nipigon - America/Thunder_Bay - America/Iqaluit - America/Pangnirtung - America/Resolute - America/Atikokan - America/Rankin_Inlet - America/Winnipeg - America/Rainy_River - America/Regina - America/Swift_Current - America/Edmonton - America/Cambridge_Bay - America/Yellowknife - America/Inuvik - America/Creston - America/Dawson_Creek - America/Vancouver - America/Whitehorse - America/Dawson - Indian/Cocos - Africa/Kinshasa - Africa/Lubumbashi - Africa/Bangui - Africa/Brazzaville - Europe/Zurich - Africa/Abidjan - Pacific/Rarotonga - America/Santiago - Pacific/Easter - Africa/Douala - Asia/Shanghai - Asia/Harbin - Asia/Chongqing - Asia/Urumqi - Asia/Kashgar - America/Bogota - America/Costa_Rica - America/Havana - Atlantic/Cape_Verde - America/Curacao - Indian/Christmas - Asia/Nicosia - Europe/Prague - Europe/Berlin - Europe/Busingen - Africa/Djibouti - Europe/Copenhagen - America/Dominica - America/Santo_Domingo - Africa/Algiers - America/Guayaquil - Pacific/Galapagos - Europe/Tallinn - Africa/Cairo - Africa/El_Aaiun - Africa/Asmara - Europe/Madrid - Africa/Ceuta - Atlantic/Canary - Africa/Addis_Ababa - Europe/Helsinki - Pacific/Fiji - Atlantic/Stanley - Pacific/Chuuk - Pacific/Pohnpei - Pacific/Kosrae - Atlantic/Faroe - Europe/Paris - Africa/Libreville - Europe/London - America/Grenada - Asia/Tbilisi - America/Cayenne - Europe/Guernsey - Africa/Accra - Europe/Gibraltar - America/Godthab - America/Danmarkshavn - America/Scoresbysund - America/Thule - Africa/Banjul - Africa/Conakry - America/Guadeloupe - Africa/Malabo - Europe/Athens - Atlantic/South_Georgia - America/Guatemala - Pacific/Guam - Africa/Bissau - America/Guyana - Asia/Hong_Kong - America/Tegucigalpa - Europe/Zagreb - America/Port-au-Prince - Europe/Budapest - Asia/Jakarta - Asia/Pontianak - Asia/Makassar - Asia/Jayapura - Europe/Dublin - Asia/Jerusalem - Europe/Isle_of_Man - Asia/Kolkata - Indian/Chagos - Asia/Baghdad - Asia/Tehran - Atlantic/Reykjavik - Europe/Rome - Europe/Jersey - America/Jamaica - Asia/Amman - Asia/Tokyo - Africa/Nairobi - Asia/Bishkek - Asia/Phnom_Penh - Pacific/Tarawa - Pacific/Enderbury - Pacific/Kiritimati - Indian/Comoro - America/St_Kitts - Asia/Pyongyang - Asia/Seoul - Asia/Kuwait - America/Cayman - Asia/Almaty - Asia/Qyzylorda - Asia/Aqtobe - Asia/Aqtau - Asia/Oral - Asia/Vientiane - Asia/Beirut - America/St_Lucia - Europe/Vaduz - Asia/Colombo - Africa/Monrovia - Africa/Maseru - Europe/Vilnius - Europe/Luxembourg - Europe/Riga - Africa/Tripoli - Africa/Casablanca - Europe/Monaco - Europe/Chisinau - Europe/Podgorica - America/Marigot - Indian/Antananarivo - Pacific/Majuro - Pacific/Kwajalein - Europe/Skopje - Africa/Bamako - Asia/Rangoon - Asia/Ulaanbaatar - Asia/Hovd - Asia/Choibalsan - Asia/Macau - Pacific/Saipan - America/Martinique - Africa/Nouakchott - America/Montserrat - Europe/Malta - Indian/Mauritius - Indian/Maldives - Africa/Blantyre - America/Mexico_City - America/Cancun - America/Merida - America/Monterrey - America/Matamoros - America/Mazatlan - America/Chihuahua - America/Ojinaga - America/Hermosillo - America/Tijuana - America/Santa_Isabel - America/Bahia_Banderas - Asia/Kuala_Lumpur - Asia/Kuching - Africa/Maputo - Africa/Windhoek - Pacific/Noumea - Africa/Niamey - Pacific/Norfolk - Africa/Lagos - America/Managua - Europe/Amsterdam - Europe/Oslo - Asia/Kathmandu - Pacific/Nauru - Pacific/Niue - Pacific/Auckland - Pacific/Chatham - Asia/Muscat - America/Panama - America/Lima - Pacific/Tahiti - Pacific/Marquesas - Pacific/Gambier - Pacific/Port_Moresby - Asia/Manila - Asia/Karachi - Europe/Warsaw - America/Miquelon - Pacific/Pitcairn - America/Puerto_Rico - Asia/Gaza - Asia/Hebron - Europe/Lisbon - Atlantic/Madeira - Atlantic/Azores - Pacific/Palau - America/Asuncion - Asia/Qatar - Indian/Reunion - Europe/Bucharest - Europe/Belgrade - Europe/Kaliningrad - Europe/Moscow - Europe/Volgograd - Europe/Samara - Asia/Yekaterinburg - Asia/Omsk - Asia/Novosibirsk - Asia/Novokuznetsk - Asia/Krasnoyarsk - Asia/Irkutsk - Asia/Yakutsk - Asia/Khandyga - Asia/Vladivostok - Asia/Sakhalin - Asia/Ust-Nera - Asia/Magadan - Asia/Kamchatka - Asia/Anadyr - Africa/Kigali - Asia/Riyadh - Pacific/Guadalcanal - Indian/Mahe - Africa/Khartoum - Europe/Stockholm - Asia/Singapore - Atlantic/St_Helena - Europe/Ljubljana - Arctic/Longyearbyen - Europe/Bratislava - Africa/Freetown - Europe/San_Marino - Africa/Dakar - Africa/Mogadishu - America/Paramaribo - Africa/Juba - Africa/Sao_Tome - America/El_Salvador - America/Lower_Princes - Asia/Damascus - Africa/Mbabane - America/Grand_Turk - Africa/Ndjamena - Indian/Kerguelen - Africa/Lome - Asia/Bangkok - Asia/Dushanbe - Pacific/Fakaofo - Asia/Dili - Asia/Ashgabat - Africa/Tunis - Pacific/Tongatapu - Europe/Istanbul - America/Port_of_Spain - Pacific/Funafuti - Asia/Taipei - Africa/Dar_es_Salaam - Europe/Kiev - Europe/Uzhgorod - Europe/Zaporozhye - Europe/Simferopol - Africa/Kampala - Pacific/Johnston - Pacific/Midway - Pacific/Wake - America/New_York - America/Detroit - America/Kentucky/Louisville - America/Kentucky/Monticello - America/Indiana/Indianapolis - America/Indiana/Vincennes - America/Indiana/Winamac - America/Indiana/Marengo - America/Indiana/Petersburg - America/Indiana/Vevay - America/Chicago - America/Indiana/Tell_City - America/Indiana/Knox - America/Menominee - America/North_Dakota/Center - America/North_Dakota/New_Salem - America/North_Dakota/Beulah - America/Denver - America/Boise - America/Phoenix - America/Los_Angeles - America/Anchorage - America/Juneau - America/Sitka - America/Yakutat - America/Nome - America/Adak - America/Metlakatla - Pacific/Honolulu - America/Montevideo - Asia/Samarkand - Asia/Tashkent - Europe/Vatican - America/St_Vincent - America/Caracas - America/Tortola - America/St_Thomas - Asia/Ho_Chi_Minh - Pacific/Efate - Pacific/Wallis - Pacific/Apia - Asia/Aden - Indian/Mayotte - Africa/Johannesburg - Africa/Lusaka - Africa/Harare - UTC default: UTC description: Configure clock $$ref: '#/components/schemas/Clock' description: pattern: ^[^<>]{1,32}$ type: string description: Set a text description of the device example: System settings deviceGroups: type: array description: Configure device groups items: type: string description: Configure device groups gpsLocation: required: - latitude - longitude type: object properties: latitude: maximum: 90 minimum: -90 type: number description: Set the device’s physical latitude example: 60 longitude: maximum: 180 minimum: -180 type: number description: Set the device’s physical longitude example: 60 description: GPS latitude and longitude of the device $$ref: '#/components/schemas/GpsLocation' hostName: pattern: ^[a-zA-Z0-9\-_]{1,32}$ type: string description: Set the hostname example: vm12 location: pattern: ^[^<>]{1,127}$ type: string description: Set the location of the device example: USA siteId: maximum: 4294967295 minimum: 0 type: integer description: Set the site ID format: int64 example: 100 systemIp: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: Set the system IP address example: 102.2.3.2 vbond: required: - address type: object properties: address: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: Set the vBond IP address example: 10.0.12.22 $$ref: '#/components/schemas/Vbond' description: System configuration for validator $$ref: '#/components/schemas/ValidatorSystemSetting' vpn: required: - transport type: object properties: management: required: - interface type: object properties: dns: type: object properties: dnsServerPrimary: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: Primary DNS server IPv4 or IPv6 Address example: 10.2.2.2 dnsServerSecondary: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: Secondary DNS server IPv4 or IPv6 Address example: 10.2.2.3 host: type: array items: required: - hostname - ip type: object properties: hostname: pattern: ^[a-zA-Z0-9\-_.]{1,64}$ type: string description: Host name example: vbond ip: maxItems: 64 minItems: 1 uniqueItems: true type: array items: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: IP Address example: 10.1.1.1 description: Static host mapping $$ref: '#/components/schemas/DnsHostMapping' description: Configure DNS servers or static host mapping $$ref: '#/components/schemas/ControlComponentDnsSetting' interface: maxItems: 2147483647 minItems: 1 type: array items: required: - ifName type: object properties: ifName: pattern: ^(?=.{1,32}$)(?:(ge0\/\d+(?:\.\d+)?|loopback\d+|eth\d+(?:\.\d+)?))$ type: string description: Interface name eth<0-..> or eth<0-..>.vlanid or loopback when present example: eth0 ip: type: object properties: address: pattern: ^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\/)([0-2]?[0-9]$|[3]?[0-2])$ type: string description: Assign IPv4 address example: 10.0.1.1/24 dhcpClient: type: boolean description: Enable DHCP example: false default: false dhcpDistance: maximum: 65536 minimum: 1 type: integer description: Set administrative distance for DHCP default route format: int32 example: 1 default: 1 description: IPv4 address or DHCP $$ref: '#/components/schemas/IpConfig' ipv6: type: object properties: address: pattern: ((^\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:)))(%.+)?\s*(\/)(\b([0-9]{1,2}|1[01][0-9]|12[0-8])\b)$)) type: string description: Assign IPv6 address example: 2001:a0:64::20/64 dhcpClient: type: boolean description: Enable DHCP example: false default: false dhcpDistance: maximum: 65536 minimum: 1 type: integer description: Set administrative distance for DHCP default route format: int32 example: 1 default: 1 dhcpRapidCommit: type: boolean description: Enable DHCPv6 rapid commit example: false default: false description: IPv6 address or DHCP $$ref: '#/components/schemas/Ipv6Config' shutdown: type: boolean description: Administrative state example: false default: false description: Interfaces configuration $$ref: '#/components/schemas/BaseInterfaceSetting' ipRoute: type: object properties: route: type: array items: required: - nextHop - prefix type: object properties: nextHop: maxItems: 2147483647 minItems: 1 type: array items: required: - address type: object properties: address: pattern: ^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$ type: string description: IPv4 Address example: 10.0.0.1 distance: maximum: 255 minimum: 1 type: integer description: Administrative distance format: int32 example: 1 default: 1 description: IP gateway address $$ref: '#/components/schemas/NextHop' prefix: pattern: ^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\/)([0-2]?[0-9]$|[3]?[0-2])$ type: string description: IPv4 Prefix example: 0.0.0.0/0 description: Configure static routes $$ref: '#/components/schemas/StaticRoute' description: IP Route information $$ref: '#/components/schemas/IpRoute' ipv6Route: type: object properties: route: type: array items: required: - nextHop - prefix type: object properties: nextHop: maxItems: 2147483647 minItems: 1 type: array items: required: - address type: object properties: address: pattern: (([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)) type: string description: IPv6 Address example: 2001::1 distance: maximum: 255 minimum: 1 type: integer description: Administrative distance format: int32 example: 1 default: 1 description: IP gateway address $$ref: '#/components/schemas/IPV6NextHop' prefix: pattern: ((^\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:)))(%.+)?\s*(\/)(\b([0-9]{1,2}|1[01][0-9]|12[0-8])\b)$)) type: string description: IPv6 Prefix example: 2001::/4 description: Configure IPv6 static routes $$ref: '#/components/schemas/Ipv6StaticRoute' description: IPv6 Route information $$ref: '#/components/schemas/Ipv6Route' description: Management VPN instance $$ref: '#/components/schemas/baseVpnInstanceBaseInterfaceSetting' transport: required: - interface type: object properties: dns: type: object properties: dnsServerPrimary: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: Primary DNS server IPv4 or IPv6 Address example: 10.2.2.2 dnsServerSecondary: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: Secondary DNS server IPv4 or IPv6 Address example: 10.2.2.3 host: type: array items: required: - hostname - ip type: object properties: hostname: pattern: ^[a-zA-Z0-9\-_.]{1,64}$ type: string description: Host name example: vbond ip: maxItems: 64 minItems: 1 uniqueItems: true type: array items: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: IP Address example: 10.1.1.1 description: Static host mapping $$ref: '#/components/schemas/DnsHostMapping' description: Configure DNS servers or static host mapping $$ref: '#/components/schemas/ControlComponentDnsSetting' interface: maxItems: 2147483647 minItems: 1 type: array items: required: - ifName type: object properties: ifName: pattern: ^(?=.{1,32}$)(?:(ge0\/\d+(?:\.\d+)?|loopback\d+|eth\d+(?:\.\d+)?))$ type: string description: Interface name eth<0-..> or eth<0-..>.vlanid or loopback when present example: eth0 ip: type: object properties: address: pattern: ^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\/)([0-2]?[0-9]$|[3]?[0-2])$ type: string description: Assign IPv4 address example: 10.0.1.1/24 dhcpClient: type: boolean description: Enable DHCP example: false default: false dhcpDistance: maximum: 65536 minimum: 1 type: integer description: Set administrative distance for DHCP default route format: int32 example: 1 default: 1 description: IPv4 address or DHCP $$ref: '#/components/schemas/IpConfig' ipv6: type: object properties: address: pattern: ((^\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:)))(%.+)?\s*(\/)(\b([0-9]{1,2}|1[01][0-9]|12[0-8])\b)$)) type: string description: Assign IPv6 address example: 2001:a0:64::20/64 dhcpClient: type: boolean description: Enable DHCP example: false default: false dhcpDistance: maximum: 65536 minimum: 1 type: integer description: Set administrative distance for DHCP default route format: int32 example: 1 default: 1 dhcpRapidCommit: type: boolean description: Enable DHCPv6 rapid commit example: false default: false description: IPv6 address or DHCP $$ref: '#/components/schemas/Ipv6Config' shutdown: type: boolean description: Administrative state example: false default: false tunnelInterface: type: object properties: allowService: type: object properties: all: type: boolean description: Allow all traffic. Overrides all other allow-service options if allow-service all is set example: false default: false dhcp: type: boolean description: Allow/Deny DHCP example: true default: true dns: type: boolean description: Allow/Deny DNS example: true default: true icmp: type: boolean description: Allow/Deny ICMP example: true default: true netconf: type: boolean description: Allow/Deny NETCONF example: false default: false ntp: type: boolean description: Allow/Deny NTP example: false default: false sshd: type: boolean description: Allow/Deny SSH example: false default: false stun: type: boolean description: Allow/Deny STUN example: false default: false description: Set services allowed on the WAN interface $$ref: '#/components/schemas/AllowService' color: type: object properties: value: type: string description: Set color for TLOC example: default enum: - default - mpls - metro-ethernet - biz-internet - public-internet - lte - 3g - red - green - blue - gold - silver - bronze - custom1 - custom2 - custom3 - private1 - private2 - private3 - private4 - private5 - private6 default: default description: Set color for TLOC $$ref: '#/components/schemas/Color' description: Tunnel interface configuration $$ref: '#/components/schemas/TunnelInterface' description: Interfaces configuration $$ref: '#/components/schemas/TransportInterfaceSetting' ipRoute: type: object properties: route: type: array items: required: - nextHop - prefix type: object properties: nextHop: maxItems: 2147483647 minItems: 1 type: array items: required: - address type: object properties: address: pattern: ^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$ type: string description: IPv4 Address example: 10.0.0.1 distance: maximum: 255 minimum: 1 type: integer description: Administrative distance format: int32 example: 1 default: 1 description: IP gateway address $$ref: '#/components/schemas/NextHop' prefix: pattern: ^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\/)([0-2]?[0-9]$|[3]?[0-2])$ type: string description: IPv4 Prefix example: 0.0.0.0/0 description: Configure static routes $$ref: '#/components/schemas/StaticRoute' description: IP Route information $$ref: '#/components/schemas/IpRoute' ipv6Route: type: object properties: route: type: array items: required: - nextHop - prefix type: object properties: nextHop: maxItems: 2147483647 minItems: 1 type: array items: required: - address type: object properties: address: pattern: (([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)) type: string description: IPv6 Address example: 2001::1 distance: maximum: 255 minimum: 1 type: integer description: Administrative distance format: int32 example: 1 default: 1 description: IP gateway address $$ref: '#/components/schemas/IPV6NextHop' prefix: pattern: ((^\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:)))(%.+)?\s*(\/)(\b([0-9]{1,2}|1[01][0-9]|12[0-8])\b)$)) type: string description: IPv6 Prefix example: 2001::/4 description: Configure IPv6 static routes $$ref: '#/components/schemas/Ipv6StaticRoute' description: IPv6 Route information $$ref: '#/components/schemas/Ipv6Route' description: Transport VPN instance $$ref: '#/components/schemas/baseVpnInstanceTransportInterfaceSetting' description: Validator VPN setting $$ref: '#/components/schemas/ValidatorVpnSetting' description: The payload for validator device specific settings $$ref: '#/components/schemas/ValidatorDeviceSpecificSetting' $$ref: '#/components/schemas/QueryValidatorDeviceSpecificSettingsResponse' - required: - createdBy - createdOn - payload type: object properties: createdBy: type: string description: The user who created the controller device specific settings example: admin createdOn: type: integer description: The timestamp when controller device specific settings are created format: int64 example: 1741315339238 lastUpdatedBy: type: string description: The user who modified the controller device specific settings example: admin lastUpdatedOn: type: integer description: The timestamp when controller device specific settings are modified format: int64 example: 1741315339240 payload: required: - system - vpn type: object properties: system: required: - hostName - siteId - systemIp type: object properties: clock: required: - timezone type: object properties: timezone: type: string description: Set the timezone example: UTC enum: - Europe/Andorra - Asia/Dubai - Asia/Kabul - America/Antigua - America/Anguilla - Europe/Tirane - Asia/Yerevan - Africa/Luanda - Antarctica/McMurdo - Antarctica/Rothera - Antarctica/Palmer - Antarctica/Mawson - Antarctica/Davis - Antarctica/Casey - Antarctica/Vostok - Antarctica/DumontDUrville - Antarctica/Syowa - America/Argentina/Buenos_Aires - America/Argentina/Cordoba - America/Argentina/Salta - America/Argentina/Jujuy - America/Argentina/Tucuman - America/Argentina/Catamarca - America/Argentina/La_Rioja - America/Argentina/San_Juan - America/Argentina/Mendoza - America/Argentina/San_Luis - America/Argentina/Rio_Gallegos - America/Argentina/Ushuaia - Pacific/Pago_Pago - Europe/Vienna - Australia/Lord_Howe - Antarctica/Macquarie - Australia/Hobart - Australia/Currie - Australia/Melbourne - Australia/Sydney - Australia/Broken_Hill - Australia/Brisbane - Australia/Lindeman - Australia/Adelaide - Australia/Darwin - Australia/Perth - Australia/Eucla - America/Aruba - Europe/Mariehamn - Asia/Baku - Europe/Sarajevo - America/Barbados - Asia/Dhaka - Europe/Brussels - Africa/Ouagadougou - Europe/Sofia - Asia/Bahrain - Africa/Bujumbura - Africa/Porto-Novo - America/St_Barthelemy - Atlantic/Bermuda - Asia/Brunei - America/La_Paz - America/Kralendijk - America/Noronha - America/Belem - America/Fortaleza - America/Recife - America/Araguaina - America/Maceio - America/Bahia - America/Sao_Paulo - America/Campo_Grande - America/Cuiaba - America/Santarem - America/Porto_Velho - America/Boa_Vista - America/Manaus - America/Eirunepe - America/Rio_Branco - America/Nassau - Asia/Thimphu - Africa/Gaborone - Europe/Minsk - America/Belize - America/St_Johns - America/Halifax - America/Glace_Bay - America/Moncton - America/Goose_Bay - America/Blanc-Sablon - America/Toronto - America/Nipigon - America/Thunder_Bay - America/Iqaluit - America/Pangnirtung - America/Resolute - America/Atikokan - America/Rankin_Inlet - America/Winnipeg - America/Rainy_River - America/Regina - America/Swift_Current - America/Edmonton - America/Cambridge_Bay - America/Yellowknife - America/Inuvik - America/Creston - America/Dawson_Creek - America/Vancouver - America/Whitehorse - America/Dawson - Indian/Cocos - Africa/Kinshasa - Africa/Lubumbashi - Africa/Bangui - Africa/Brazzaville - Europe/Zurich - Africa/Abidjan - Pacific/Rarotonga - America/Santiago - Pacific/Easter - Africa/Douala - Asia/Shanghai - Asia/Harbin - Asia/Chongqing - Asia/Urumqi - Asia/Kashgar - America/Bogota - America/Costa_Rica - America/Havana - Atlantic/Cape_Verde - America/Curacao - Indian/Christmas - Asia/Nicosia - Europe/Prague - Europe/Berlin - Europe/Busingen - Africa/Djibouti - Europe/Copenhagen - America/Dominica - America/Santo_Domingo - Africa/Algiers - America/Guayaquil - Pacific/Galapagos - Europe/Tallinn - Africa/Cairo - Africa/El_Aaiun - Africa/Asmara - Europe/Madrid - Africa/Ceuta - Atlantic/Canary - Africa/Addis_Ababa - Europe/Helsinki - Pacific/Fiji - Atlantic/Stanley - Pacific/Chuuk - Pacific/Pohnpei - Pacific/Kosrae - Atlantic/Faroe - Europe/Paris - Africa/Libreville - Europe/London - America/Grenada - Asia/Tbilisi - America/Cayenne - Europe/Guernsey - Africa/Accra - Europe/Gibraltar - America/Godthab - America/Danmarkshavn - America/Scoresbysund - America/Thule - Africa/Banjul - Africa/Conakry - America/Guadeloupe - Africa/Malabo - Europe/Athens - Atlantic/South_Georgia - America/Guatemala - Pacific/Guam - Africa/Bissau - America/Guyana - Asia/Hong_Kong - America/Tegucigalpa - Europe/Zagreb - America/Port-au-Prince - Europe/Budapest - Asia/Jakarta - Asia/Pontianak - Asia/Makassar - Asia/Jayapura - Europe/Dublin - Asia/Jerusalem - Europe/Isle_of_Man - Asia/Kolkata - Indian/Chagos - Asia/Baghdad - Asia/Tehran - Atlantic/Reykjavik - Europe/Rome - Europe/Jersey - America/Jamaica - Asia/Amman - Asia/Tokyo - Africa/Nairobi - Asia/Bishkek - Asia/Phnom_Penh - Pacific/Tarawa - Pacific/Enderbury - Pacific/Kiritimati - Indian/Comoro - America/St_Kitts - Asia/Pyongyang - Asia/Seoul - Asia/Kuwait - America/Cayman - Asia/Almaty - Asia/Qyzylorda - Asia/Aqtobe - Asia/Aqtau - Asia/Oral - Asia/Vientiane - Asia/Beirut - America/St_Lucia - Europe/Vaduz - Asia/Colombo - Africa/Monrovia - Africa/Maseru - Europe/Vilnius - Europe/Luxembourg - Europe/Riga - Africa/Tripoli - Africa/Casablanca - Europe/Monaco - Europe/Chisinau - Europe/Podgorica - America/Marigot - Indian/Antananarivo - Pacific/Majuro - Pacific/Kwajalein - Europe/Skopje - Africa/Bamako - Asia/Rangoon - Asia/Ulaanbaatar - Asia/Hovd - Asia/Choibalsan - Asia/Macau - Pacific/Saipan - America/Martinique - Africa/Nouakchott - America/Montserrat - Europe/Malta - Indian/Mauritius - Indian/Maldives - Africa/Blantyre - America/Mexico_City - America/Cancun - America/Merida - America/Monterrey - America/Matamoros - America/Mazatlan - America/Chihuahua - America/Ojinaga - America/Hermosillo - America/Tijuana - America/Santa_Isabel - America/Bahia_Banderas - Asia/Kuala_Lumpur - Asia/Kuching - Africa/Maputo - Africa/Windhoek - Pacific/Noumea - Africa/Niamey - Pacific/Norfolk - Africa/Lagos - America/Managua - Europe/Amsterdam - Europe/Oslo - Asia/Kathmandu - Pacific/Nauru - Pacific/Niue - Pacific/Auckland - Pacific/Chatham - Asia/Muscat - America/Panama - America/Lima - Pacific/Tahiti - Pacific/Marquesas - Pacific/Gambier - Pacific/Port_Moresby - Asia/Manila - Asia/Karachi - Europe/Warsaw - America/Miquelon - Pacific/Pitcairn - America/Puerto_Rico - Asia/Gaza - Asia/Hebron - Europe/Lisbon - Atlantic/Madeira - Atlantic/Azores - Pacific/Palau - America/Asuncion - Asia/Qatar - Indian/Reunion - Europe/Bucharest - Europe/Belgrade - Europe/Kaliningrad - Europe/Moscow - Europe/Volgograd - Europe/Samara - Asia/Yekaterinburg - Asia/Omsk - Asia/Novosibirsk - Asia/Novokuznetsk - Asia/Krasnoyarsk - Asia/Irkutsk - Asia/Yakutsk - Asia/Khandyga - Asia/Vladivostok - Asia/Sakhalin - Asia/Ust-Nera - Asia/Magadan - Asia/Kamchatka - Asia/Anadyr - Africa/Kigali - Asia/Riyadh - Pacific/Guadalcanal - Indian/Mahe - Africa/Khartoum - Europe/Stockholm - Asia/Singapore - Atlantic/St_Helena - Europe/Ljubljana - Arctic/Longyearbyen - Europe/Bratislava - Africa/Freetown - Europe/San_Marino - Africa/Dakar - Africa/Mogadishu - America/Paramaribo - Africa/Juba - Africa/Sao_Tome - America/El_Salvador - America/Lower_Princes - Asia/Damascus - Africa/Mbabane - America/Grand_Turk - Africa/Ndjamena - Indian/Kerguelen - Africa/Lome - Asia/Bangkok - Asia/Dushanbe - Pacific/Fakaofo - Asia/Dili - Asia/Ashgabat - Africa/Tunis - Pacific/Tongatapu - Europe/Istanbul - America/Port_of_Spain - Pacific/Funafuti - Asia/Taipei - Africa/Dar_es_Salaam - Europe/Kiev - Europe/Uzhgorod - Europe/Zaporozhye - Europe/Simferopol - Africa/Kampala - Pacific/Johnston - Pacific/Midway - Pacific/Wake - America/New_York - America/Detroit - America/Kentucky/Louisville - America/Kentucky/Monticello - America/Indiana/Indianapolis - America/Indiana/Vincennes - America/Indiana/Winamac - America/Indiana/Marengo - America/Indiana/Petersburg - America/Indiana/Vevay - America/Chicago - America/Indiana/Tell_City - America/Indiana/Knox - America/Menominee - America/North_Dakota/Center - America/North_Dakota/New_Salem - America/North_Dakota/Beulah - America/Denver - America/Boise - America/Phoenix - America/Los_Angeles - America/Anchorage - America/Juneau - America/Sitka - America/Yakutat - America/Nome - America/Adak - America/Metlakatla - Pacific/Honolulu - America/Montevideo - Asia/Samarkand - Asia/Tashkent - Europe/Vatican - America/St_Vincent - America/Caracas - America/Tortola - America/St_Thomas - Asia/Ho_Chi_Minh - Pacific/Efate - Pacific/Wallis - Pacific/Apia - Asia/Aden - Indian/Mayotte - Africa/Johannesburg - Africa/Lusaka - Africa/Harare - UTC default: UTC description: Configure clock $$ref: '#/components/schemas/Clock' description: pattern: ^[^<>]{1,32}$ type: string description: Set a text description of the device example: System settings deviceGroups: type: array description: Configure device groups items: type: string description: Configure device groups gpsLocation: required: - latitude - longitude type: object properties: latitude: maximum: 90 minimum: -90 type: number description: Set the device’s physical latitude example: 60 longitude: maximum: 180 minimum: -180 type: number description: Set the device’s physical longitude example: 60 description: GPS latitude and longitude of the device $$ref: '#/components/schemas/GpsLocation' hostName: pattern: ^[a-zA-Z0-9\-_]{1,32}$ type: string description: Set the hostname example: vm12 ipv6StrictControl: type: boolean description: Enable Dual Stack IPv6 Default example: false default: false location: pattern: ^[^<>]{1,127}$ type: string description: Set the location of the device example: USA siteId: maximum: 4294967295 minimum: 0 type: integer description: Set the site ID format: int64 example: 100 systemIp: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: Set the system IP address example: 102.2.3.2 description: System configuration for manager $$ref: '#/components/schemas/ManagerSystemSetting' vpn: required: - transport type: object properties: management: required: - interface type: object properties: dns: type: object properties: dnsServerPrimary: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: Primary DNS server IPv4 or IPv6 Address example: 10.2.2.2 dnsServerSecondary: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: Secondary DNS server IPv4 or IPv6 Address example: 10.2.2.3 host: type: array items: required: - hostname - ip type: object properties: hostname: pattern: ^[a-zA-Z0-9\-_.]{1,64}$ type: string description: Host name example: vbond ip: maxItems: 64 minItems: 1 uniqueItems: true type: array items: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: IP Address example: 10.1.1.1 description: Static host mapping $$ref: '#/components/schemas/DnsHostMapping' description: Configure DNS servers or static host mapping $$ref: '#/components/schemas/ControlComponentDnsSetting' interface: maxItems: 2147483647 minItems: 1 type: array items: required: - ifName type: object properties: ifName: pattern: ^(?=.{1,32}$)(?:(ge0\/\d+(?:\.\d+)?|loopback\d+|eth\d+(?:\.\d+)?))$ type: string description: Interface name eth<0-..> or eth<0-..>.vlanid or loopback when present example: eth0 ip: type: object properties: address: pattern: ^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\/)([0-2]?[0-9]$|[3]?[0-2])$ type: string description: Assign IPv4 address example: 10.0.1.1/24 dhcpClient: type: boolean description: Enable DHCP example: false default: false dhcpDistance: maximum: 65536 minimum: 1 type: integer description: Set administrative distance for DHCP default route format: int32 example: 1 default: 1 description: IPv4 address or DHCP $$ref: '#/components/schemas/IpConfig' ipv6: type: object properties: address: pattern: ((^\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:)))(%.+)?\s*(\/)(\b([0-9]{1,2}|1[01][0-9]|12[0-8])\b)$)) type: string description: Assign IPv6 address example: 2001:a0:64::20/64 dhcpClient: type: boolean description: Enable DHCP example: false default: false dhcpDistance: maximum: 65536 minimum: 1 type: integer description: Set administrative distance for DHCP default route format: int32 example: 1 default: 1 dhcpRapidCommit: type: boolean description: Enable DHCPv6 rapid commit example: false default: false description: IPv6 address or DHCP $$ref: '#/components/schemas/Ipv6Config' shutdown: type: boolean description: Administrative state example: false default: false description: Interfaces configuration $$ref: '#/components/schemas/BaseInterfaceSetting' ipRoute: type: object properties: route: type: array items: required: - nextHop - prefix type: object properties: nextHop: maxItems: 2147483647 minItems: 1 type: array items: required: - address type: object properties: address: pattern: ^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$ type: string description: IPv4 Address example: 10.0.0.1 distance: maximum: 255 minimum: 1 type: integer description: Administrative distance format: int32 example: 1 default: 1 description: IP gateway address $$ref: '#/components/schemas/NextHop' prefix: pattern: ^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\/)([0-2]?[0-9]$|[3]?[0-2])$ type: string description: IPv4 Prefix example: 0.0.0.0/0 description: Configure static routes $$ref: '#/components/schemas/StaticRoute' description: IP Route information $$ref: '#/components/schemas/IpRoute' ipv6Route: type: object properties: route: type: array items: required: - nextHop - prefix type: object properties: nextHop: maxItems: 2147483647 minItems: 1 type: array items: required: - address type: object properties: address: pattern: (([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)) type: string description: IPv6 Address example: 2001::1 distance: maximum: 255 minimum: 1 type: integer description: Administrative distance format: int32 example: 1 default: 1 description: IP gateway address $$ref: '#/components/schemas/IPV6NextHop' prefix: pattern: ((^\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:)))(%.+)?\s*(\/)(\b([0-9]{1,2}|1[01][0-9]|12[0-8])\b)$)) type: string description: IPv6 Prefix example: 2001::/4 description: Configure IPv6 static routes $$ref: '#/components/schemas/Ipv6StaticRoute' description: IPv6 Route information $$ref: '#/components/schemas/Ipv6Route' description: Management VPN instance $$ref: '#/components/schemas/baseVpnInstanceBaseInterfaceSetting' transport: required: - interface type: object properties: dns: type: object properties: dnsServerPrimary: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: Primary DNS server IPv4 or IPv6 Address example: 10.2.2.2 dnsServerSecondary: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: Secondary DNS server IPv4 or IPv6 Address example: 10.2.2.3 host: type: array items: required: - hostname - ip type: object properties: hostname: pattern: ^[a-zA-Z0-9\-_.]{1,64}$ type: string description: Host name example: vbond ip: maxItems: 64 minItems: 1 uniqueItems: true type: array items: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: IP Address example: 10.1.1.1 description: Static host mapping $$ref: '#/components/schemas/DnsHostMapping' description: Configure DNS servers or static host mapping $$ref: '#/components/schemas/ControlComponentDnsSetting' interface: maxItems: 2147483647 minItems: 1 type: array items: required: - ifName type: object properties: ifName: pattern: ^(?=.{1,32}$)(?:(ge0\/\d+(?:\.\d+)?|loopback\d+|eth\d+(?:\.\d+)?))$ type: string description: Interface name eth<0-..> or eth<0-..>.vlanid or loopback when present example: eth0 ip: type: object properties: address: pattern: ^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\/)([0-2]?[0-9]$|[3]?[0-2])$ type: string description: Assign IPv4 address example: 10.0.1.1/24 dhcpClient: type: boolean description: Enable DHCP example: false default: false dhcpDistance: maximum: 65536 minimum: 1 type: integer description: Set administrative distance for DHCP default route format: int32 example: 1 default: 1 description: IPv4 address or DHCP $$ref: '#/components/schemas/IpConfig' ipv6: type: object properties: address: pattern: ((^\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:)))(%.+)?\s*(\/)(\b([0-9]{1,2}|1[01][0-9]|12[0-8])\b)$)) type: string description: Assign IPv6 address example: 2001:a0:64::20/64 dhcpClient: type: boolean description: Enable DHCP example: false default: false dhcpDistance: maximum: 65536 minimum: 1 type: integer description: Set administrative distance for DHCP default route format: int32 example: 1 default: 1 dhcpRapidCommit: type: boolean description: Enable DHCPv6 rapid commit example: false default: false description: IPv6 address or DHCP $$ref: '#/components/schemas/Ipv6Config' shutdown: type: boolean description: Administrative state example: false default: false tunnelInterface: type: object properties: allowService: type: object properties: all: type: boolean description: Allow all traffic. Overrides all other allow-service options if allow-service all is set example: false default: false dhcp: type: boolean description: Allow/Deny DHCP example: true default: true dns: type: boolean description: Allow/Deny DNS example: true default: true icmp: type: boolean description: Allow/Deny ICMP example: true default: true netconf: type: boolean description: Allow/Deny NETCONF example: false default: false ntp: type: boolean description: Allow/Deny NTP example: false default: false sshd: type: boolean description: Allow/Deny SSH example: false default: false stun: type: boolean description: Allow/Deny STUN example: false default: false description: Set services allowed on the WAN interface $$ref: '#/components/schemas/AllowService' color: type: object properties: value: type: string description: Set color for TLOC example: default enum: - default - mpls - metro-ethernet - biz-internet - public-internet - lte - 3g - red - green - blue - gold - silver - bronze - custom1 - custom2 - custom3 - private1 - private2 - private3 - private4 - private5 - private6 default: default description: Set color for TLOC $$ref: '#/components/schemas/Color' description: Tunnel interface configuration $$ref: '#/components/schemas/TunnelInterface' description: Interfaces configuration $$ref: '#/components/schemas/TransportInterfaceSetting' ipRoute: type: object properties: route: type: array items: required: - nextHop - prefix type: object properties: nextHop: maxItems: 2147483647 minItems: 1 type: array items: required: - address type: object properties: address: pattern: ^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$ type: string description: IPv4 Address example: 10.0.0.1 distance: maximum: 255 minimum: 1 type: integer description: Administrative distance format: int32 example: 1 default: 1 description: IP gateway address $$ref: '#/components/schemas/NextHop' prefix: pattern: ^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\/)([0-2]?[0-9]$|[3]?[0-2])$ type: string description: IPv4 Prefix example: 0.0.0.0/0 description: Configure static routes $$ref: '#/components/schemas/StaticRoute' description: IP Route information $$ref: '#/components/schemas/IpRoute' ipv6Route: type: object properties: route: type: array items: required: - nextHop - prefix type: object properties: nextHop: maxItems: 2147483647 minItems: 1 type: array items: required: - address type: object properties: address: pattern: (([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)) type: string description: IPv6 Address example: 2001::1 distance: maximum: 255 minimum: 1 type: integer description: Administrative distance format: int32 example: 1 default: 1 description: IP gateway address $$ref: '#/components/schemas/IPV6NextHop' prefix: pattern: ((^\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:)))(%.+)?\s*(\/)(\b([0-9]{1,2}|1[01][0-9]|12[0-8])\b)$)) type: string description: IPv6 Prefix example: 2001::/4 description: Configure IPv6 static routes $$ref: '#/components/schemas/Ipv6StaticRoute' description: IPv6 Route information $$ref: '#/components/schemas/Ipv6Route' description: Transport VPN instance $$ref: '#/components/schemas/baseVpnInstanceTransportInterfaceSetting' description: Manager VPN setting $$ref: '#/components/schemas/ManagerVpnSetting' description: The payload for manager device specific settings $$ref: '#/components/schemas/ManagerDeviceSpecificSetting' $$ref: '#/components/schemas/QueryManagerDeviceSpecificSettingsResponse' examples: QueryControllerDeviceSpecificSettingsExample: description: QueryControllerDeviceSpecificSettingsExample value: createdBy: admin createdOn: 1741315339238 lastUpdatedBy: admin lastUpdatedOn: 1741315439238 payload: system: systemIp: 172.16.255.20 hostName: Controller01 description: Controller 1 siteId: 200 location: Shang hai systemTunnelMtu: 2000 gpsLocation: latitude: 90 longitude: 180 clock: timezone: Europe/Andorra deviceGroups: - group1 overlayId: 3 ipv6StrictControl: true controllerGroupId: 1 vpn: transport: ipRoute: route: - prefix: 0.0.0.0/0 nextHop: - address: 10.0.12.13 distance: 1 ipv6Route: route: - prefix: ::/0 nextHop: - address: 2001:a0:c::d interface: - ifName: eth0 ip: address: 10.0.1.30/24 ipv6: address: 2001:a0:1::1e/64 shutdown: false - ifName: eth1 ip: address: 10.0.12.20/24 ipv6: address: 2001:a0:c::14/64 tunnelInterface: allowService: all: true dhcp: true dns: true icmp: true sshd: false netconf: false ntp: false stun: false shutdown: false management: interface: - ifName: eth2 ip: address: 10.2.2.20/24 ipv6: address: 2001:a2:2::14/64 shutdown: false $$ref: '#/components/examples/ComViptelaVmanageServerDeviceconfigControlcomponentSettingResponseExampleQuerycontrollerdevicespecificsettings' QueryValidatorDeviceSpecificSettingsExample: description: QueryValidatorDeviceSpecificSettingsExample value: createdBy: admin createdOn: 1741315339238 lastUpdatedBy: admin lastUpdatedOn: 1741315439238 payload: system: systemIp: 172.16.255.19 hostName: Validator01 description: validator 1 siteId: 100 location: Shang hai gpsLocation: latitude: 90 longitude: 180 clock: timezone: Europe/Andorra deviceGroups: - group1 vbond: address: 10.0.1.26 vpn: transport: ipRoute: route: - prefix: 0.0.0.0/0 nextHop: - address: 10.0.5.13 distance: 1 ipv6Route: route: - prefix: ::/0 nextHop: - address: 2001:a0:5::d interface: - ifName: eth0 ip: address: 10.0.1.19/24 ipv6: address: 2001:a0:1::13/64 shutdown: false - ifName: eth1 ip: address: 10.0.5.19/24 ipv6: address: 2001:a0:5::13/64 shutdown: false - ifName: eth3 ip: address: 10.1.15.19/24 ipv6: address: 2001:a1:f::13/64 shutdown: false management: interface: - ifName: eth2 ip: address: 10.2.2.19/24 ipv6: address: 2001:a2:2::13/64 shutdown: false $$ref: '#/components/examples/ComViptelaVmanageServerDeviceconfigControlcomponentSettingResponseExampleQueryvalidatordevicespecificsettings' QueryManagerDeviceSpecificSettingsExample: description: QueryManagerDeviceSpecificSettingsExample value: createdBy: admin createdOn: 1743658574232 payload: system: systemIp: 172.16.255.22 hostName: Manager01 clock: timezone: UTC siteId: 200 ipv6StrictControl: false vpn: transport: ipRoute: route: - prefix: 0.0.0.0/0 nextHop: - address: 10.0.12.13 distance: 1 interface: - ifName: eth0 ip: dhcpClient: true dhcpDistance: 1 ipv6: dhcpClient: true dhcpDistance: 1 dhcpRapidCommit: false shutdown: false - ifName: eth1 ip: address: 10.0.12.22/24 shutdown: false tunnelInterface: color: value: default allowService: all: false dhcp: true dns: true icmp: true sshd: false netconf: false ntp: false stun: false - ifName: eth2 ip: address: 10.0.5.22/24 shutdown: false - ifName: eth5 ip: address: 10.0.105.32/24 shutdown: false management: interface: - ifName: eth3 ip: address: 10.2.4.22/24 shutdown: false $$ref: '#/components/examples/ComViptelaVmanageServerDeviceconfigControlcomponentSettingResponseExampleQuerymanagerdevicespecificsettings' '400': description: Bad Request content: application/json: schema: required: - error type: object properties: error: required: - code - details - message - type type: object properties: code: type: string description: Internal error code example: CCS0018 details: type: string description: Error message detail example: Unrecognized field user1 message: type: string description: Error message summary example: Invalid control component setting payload type: type: string description: Error message title example: error description: Error response $$ref: '#/components/schemas/ErrorDetails' $$ref: '#/components/schemas/ErrorResponse' examples: InvalidControlComponentDeviceId: description: InvalidControlComponentDeviceId value: error: message: Invalid control component device ID, only support controller,validator and manager code: CCS0010 details: Device 73a7730e-9d48-463a-8c7f-924f6edd951c is not existed type: error $$ref: '#/components/examples/ComViptelaVmanageServerDeviceconfigControlcomponentSettingResponseExampleInvalidcontrolcomponentdeviceidresponse' '403': description: Forbidden '404': description: Not Found content: application/json: schema: required: - error type: object properties: error: required: - code - details - message - type type: object properties: code: type: string description: Internal error code example: CCS0018 details: type: string description: Error message detail example: Unrecognized field user1 message: type: string description: Error message summary example: Invalid control component setting payload type: type: string description: Error message title example: error description: Error response $$ref: '#/components/schemas/ErrorDetails' $$ref: '#/components/schemas/ErrorResponse' examples: GetDeviceSpecificSettingsNotFoundResponse: description: GetDeviceSpecificSettingsNotFoundResponse value: error: message: Control component device specific settings are not found code: CCS0013 details: Control component device specific settings are not found type: error $$ref: '#/components/examples/ComViptelaVmanageServerDeviceconfigControlcomponentSettingResponseExampleGetdevicespecificsettingsnotfoundresponse' '500': description: Internal Server Error x-roles-required: Control Component Settings-read delete: tags: - Configuration - Control Component Setting description: Delete the device-specific settings for a specific control component. The deviceId can be obtained from the "uuid" field in the data returned by the API (GET /dataservice/certificate/data/controller/list) operationId: deleteControlComponentDeviceSpecificSettings parameters: - name: deviceId in: path description: Control component device UUID required: true schema: type: string format: uuid responses: '200': description: Success '400': description: Bad Request content: application/json: schema: required: - error type: object properties: error: required: - code - details - message - type type: object properties: code: type: string description: Internal error code example: CCS0018 details: type: string description: Error message detail example: Unrecognized field user1 message: type: string description: Error message summary example: Invalid control component setting payload type: type: string description: Error message title example: error description: Error response $$ref: '#/components/schemas/ErrorDetails' $$ref: '#/components/schemas/ErrorResponse' examples: DeleteControlComponentDeviceSpecificSettingsFailed: description: DeleteControlComponentDeviceSpecificSettingsFailed value: error: message: Failed to delete the device specific settings for specific control component code: CCS0008 details: Control component is deployed with current settings, can't remove device specific settings, change control component to CLI mode and retry later type: error $$ref: '#/components/examples/ComViptelaVmanageServerDeviceconfigControlcomponentSettingResponseExampleDeletedevicespecificsettingsfailedresponse' '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Control Component Settings-write /v1/control-component/devices/{deviceId}/settings/config-to-settings: post: tags: - Configuration - Control Component Setting description: Auto generate the control component device specific settings(System,VPN static route and interface settings) by loading running config from a specific device which is reachable with Manager operationId: controlComponentRunningConfigToDeviceSpecificSettings parameters: - name: deviceId in: path description: Control component device UUID required: true schema: type: string format: uuid responses: '200': description: Success content: application/json: schema: oneOf: - required: - createdBy - createdOn - payload type: object properties: createdBy: type: string description: The user who created the controller device specific settings example: admin createdOn: type: integer description: The timestamp when controller device specific settings are created format: int64 example: 1741315339238 lastUpdatedBy: type: string description: The user who modified the controller device specific settings example: admin lastUpdatedOn: type: integer description: The timestamp when controller device specific settings are modified format: int64 example: 1741315339240 payload: required: - system - vpn type: object properties: system: required: - hostName - siteId - systemIp type: object properties: clock: required: - timezone type: object properties: timezone: type: string description: Set the timezone example: UTC enum: - Europe/Andorra - Asia/Dubai - Asia/Kabul - America/Antigua - America/Anguilla - Europe/Tirane - Asia/Yerevan - Africa/Luanda - Antarctica/McMurdo - Antarctica/Rothera - Antarctica/Palmer - Antarctica/Mawson - Antarctica/Davis - Antarctica/Casey - Antarctica/Vostok - Antarctica/DumontDUrville - Antarctica/Syowa - America/Argentina/Buenos_Aires - America/Argentina/Cordoba - America/Argentina/Salta - America/Argentina/Jujuy - America/Argentina/Tucuman - America/Argentina/Catamarca - America/Argentina/La_Rioja - America/Argentina/San_Juan - America/Argentina/Mendoza - America/Argentina/San_Luis - America/Argentina/Rio_Gallegos - America/Argentina/Ushuaia - Pacific/Pago_Pago - Europe/Vienna - Australia/Lord_Howe - Antarctica/Macquarie - Australia/Hobart - Australia/Currie - Australia/Melbourne - Australia/Sydney - Australia/Broken_Hill - Australia/Brisbane - Australia/Lindeman - Australia/Adelaide - Australia/Darwin - Australia/Perth - Australia/Eucla - America/Aruba - Europe/Mariehamn - Asia/Baku - Europe/Sarajevo - America/Barbados - Asia/Dhaka - Europe/Brussels - Africa/Ouagadougou - Europe/Sofia - Asia/Bahrain - Africa/Bujumbura - Africa/Porto-Novo - America/St_Barthelemy - Atlantic/Bermuda - Asia/Brunei - America/La_Paz - America/Kralendijk - America/Noronha - America/Belem - America/Fortaleza - America/Recife - America/Araguaina - America/Maceio - America/Bahia - America/Sao_Paulo - America/Campo_Grande - America/Cuiaba - America/Santarem - America/Porto_Velho - America/Boa_Vista - America/Manaus - America/Eirunepe - America/Rio_Branco - America/Nassau - Asia/Thimphu - Africa/Gaborone - Europe/Minsk - America/Belize - America/St_Johns - America/Halifax - America/Glace_Bay - America/Moncton - America/Goose_Bay - America/Blanc-Sablon - America/Toronto - America/Nipigon - America/Thunder_Bay - America/Iqaluit - America/Pangnirtung - America/Resolute - America/Atikokan - America/Rankin_Inlet - America/Winnipeg - America/Rainy_River - America/Regina - America/Swift_Current - America/Edmonton - America/Cambridge_Bay - America/Yellowknife - America/Inuvik - America/Creston - America/Dawson_Creek - America/Vancouver - America/Whitehorse - America/Dawson - Indian/Cocos - Africa/Kinshasa - Africa/Lubumbashi - Africa/Bangui - Africa/Brazzaville - Europe/Zurich - Africa/Abidjan - Pacific/Rarotonga - America/Santiago - Pacific/Easter - Africa/Douala - Asia/Shanghai - Asia/Harbin - Asia/Chongqing - Asia/Urumqi - Asia/Kashgar - America/Bogota - America/Costa_Rica - America/Havana - Atlantic/Cape_Verde - America/Curacao - Indian/Christmas - Asia/Nicosia - Europe/Prague - Europe/Berlin - Europe/Busingen - Africa/Djibouti - Europe/Copenhagen - America/Dominica - America/Santo_Domingo - Africa/Algiers - America/Guayaquil - Pacific/Galapagos - Europe/Tallinn - Africa/Cairo - Africa/El_Aaiun - Africa/Asmara - Europe/Madrid - Africa/Ceuta - Atlantic/Canary - Africa/Addis_Ababa - Europe/Helsinki - Pacific/Fiji - Atlantic/Stanley - Pacific/Chuuk - Pacific/Pohnpei - Pacific/Kosrae - Atlantic/Faroe - Europe/Paris - Africa/Libreville - Europe/London - America/Grenada - Asia/Tbilisi - America/Cayenne - Europe/Guernsey - Africa/Accra - Europe/Gibraltar - America/Godthab - America/Danmarkshavn - America/Scoresbysund - America/Thule - Africa/Banjul - Africa/Conakry - America/Guadeloupe - Africa/Malabo - Europe/Athens - Atlantic/South_Georgia - America/Guatemala - Pacific/Guam - Africa/Bissau - America/Guyana - Asia/Hong_Kong - America/Tegucigalpa - Europe/Zagreb - America/Port-au-Prince - Europe/Budapest - Asia/Jakarta - Asia/Pontianak - Asia/Makassar - Asia/Jayapura - Europe/Dublin - Asia/Jerusalem - Europe/Isle_of_Man - Asia/Kolkata - Indian/Chagos - Asia/Baghdad - Asia/Tehran - Atlantic/Reykjavik - Europe/Rome - Europe/Jersey - America/Jamaica - Asia/Amman - Asia/Tokyo - Africa/Nairobi - Asia/Bishkek - Asia/Phnom_Penh - Pacific/Tarawa - Pacific/Enderbury - Pacific/Kiritimati - Indian/Comoro - America/St_Kitts - Asia/Pyongyang - Asia/Seoul - Asia/Kuwait - America/Cayman - Asia/Almaty - Asia/Qyzylorda - Asia/Aqtobe - Asia/Aqtau - Asia/Oral - Asia/Vientiane - Asia/Beirut - America/St_Lucia - Europe/Vaduz - Asia/Colombo - Africa/Monrovia - Africa/Maseru - Europe/Vilnius - Europe/Luxembourg - Europe/Riga - Africa/Tripoli - Africa/Casablanca - Europe/Monaco - Europe/Chisinau - Europe/Podgorica - America/Marigot - Indian/Antananarivo - Pacific/Majuro - Pacific/Kwajalein - Europe/Skopje - Africa/Bamako - Asia/Rangoon - Asia/Ulaanbaatar - Asia/Hovd - Asia/Choibalsan - Asia/Macau - Pacific/Saipan - America/Martinique - Africa/Nouakchott - America/Montserrat - Europe/Malta - Indian/Mauritius - Indian/Maldives - Africa/Blantyre - America/Mexico_City - America/Cancun - America/Merida - America/Monterrey - America/Matamoros - America/Mazatlan - America/Chihuahua - America/Ojinaga - America/Hermosillo - America/Tijuana - America/Santa_Isabel - America/Bahia_Banderas - Asia/Kuala_Lumpur - Asia/Kuching - Africa/Maputo - Africa/Windhoek - Pacific/Noumea - Africa/Niamey - Pacific/Norfolk - Africa/Lagos - America/Managua - Europe/Amsterdam - Europe/Oslo - Asia/Kathmandu - Pacific/Nauru - Pacific/Niue - Pacific/Auckland - Pacific/Chatham - Asia/Muscat - America/Panama - America/Lima - Pacific/Tahiti - Pacific/Marquesas - Pacific/Gambier - Pacific/Port_Moresby - Asia/Manila - Asia/Karachi - Europe/Warsaw - America/Miquelon - Pacific/Pitcairn - America/Puerto_Rico - Asia/Gaza - Asia/Hebron - Europe/Lisbon - Atlantic/Madeira - Atlantic/Azores - Pacific/Palau - America/Asuncion - Asia/Qatar - Indian/Reunion - Europe/Bucharest - Europe/Belgrade - Europe/Kaliningrad - Europe/Moscow - Europe/Volgograd - Europe/Samara - Asia/Yekaterinburg - Asia/Omsk - Asia/Novosibirsk - Asia/Novokuznetsk - Asia/Krasnoyarsk - Asia/Irkutsk - Asia/Yakutsk - Asia/Khandyga - Asia/Vladivostok - Asia/Sakhalin - Asia/Ust-Nera - Asia/Magadan - Asia/Kamchatka - Asia/Anadyr - Africa/Kigali - Asia/Riyadh - Pacific/Guadalcanal - Indian/Mahe - Africa/Khartoum - Europe/Stockholm - Asia/Singapore - Atlantic/St_Helena - Europe/Ljubljana - Arctic/Longyearbyen - Europe/Bratislava - Africa/Freetown - Europe/San_Marino - Africa/Dakar - Africa/Mogadishu - America/Paramaribo - Africa/Juba - Africa/Sao_Tome - America/El_Salvador - America/Lower_Princes - Asia/Damascus - Africa/Mbabane - America/Grand_Turk - Africa/Ndjamena - Indian/Kerguelen - Africa/Lome - Asia/Bangkok - Asia/Dushanbe - Pacific/Fakaofo - Asia/Dili - Asia/Ashgabat - Africa/Tunis - Pacific/Tongatapu - Europe/Istanbul - America/Port_of_Spain - Pacific/Funafuti - Asia/Taipei - Africa/Dar_es_Salaam - Europe/Kiev - Europe/Uzhgorod - Europe/Zaporozhye - Europe/Simferopol - Africa/Kampala - Pacific/Johnston - Pacific/Midway - Pacific/Wake - America/New_York - America/Detroit - America/Kentucky/Louisville - America/Kentucky/Monticello - America/Indiana/Indianapolis - America/Indiana/Vincennes - America/Indiana/Winamac - America/Indiana/Marengo - America/Indiana/Petersburg - America/Indiana/Vevay - America/Chicago - America/Indiana/Tell_City - America/Indiana/Knox - America/Menominee - America/North_Dakota/Center - America/North_Dakota/New_Salem - America/North_Dakota/Beulah - America/Denver - America/Boise - America/Phoenix - America/Los_Angeles - America/Anchorage - America/Juneau - America/Sitka - America/Yakutat - America/Nome - America/Adak - America/Metlakatla - Pacific/Honolulu - America/Montevideo - Asia/Samarkand - Asia/Tashkent - Europe/Vatican - America/St_Vincent - America/Caracas - America/Tortola - America/St_Thomas - Asia/Ho_Chi_Minh - Pacific/Efate - Pacific/Wallis - Pacific/Apia - Asia/Aden - Indian/Mayotte - Africa/Johannesburg - Africa/Lusaka - Africa/Harare - UTC default: UTC description: Configure clock $$ref: '#/components/schemas/Clock' description: pattern: ^[^<>]{1,32}$ type: string description: Set a text description of the device example: System settings deviceGroups: type: array description: Configure device groups items: type: string description: Configure device groups gpsLocation: required: - latitude - longitude type: object properties: latitude: maximum: 90 minimum: -90 type: number description: Set the device’s physical latitude example: 60 longitude: maximum: 180 minimum: -180 type: number description: Set the device’s physical longitude example: 60 description: GPS latitude and longitude of the device $$ref: '#/components/schemas/GpsLocation' hostName: pattern: ^[a-zA-Z0-9\-_]{1,32}$ type: string description: Set the hostname example: vm12 ipv6StrictControl: type: boolean description: Enable Dual Stack IPv6 Default example: false default: false location: pattern: ^[^<>]{1,127}$ type: string description: Set the location of the device example: USA siteId: maximum: 4294967295 minimum: 0 type: integer description: Set the site ID format: int64 example: 100 systemIp: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: Set the system IP address example: 102.2.3.2 description: System configuration for manager $$ref: '#/components/schemas/ManagerSystemSetting' vpn: required: - transport type: object properties: management: required: - interface type: object properties: dns: type: object properties: dnsServerPrimary: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: Primary DNS server IPv4 or IPv6 Address example: 10.2.2.2 dnsServerSecondary: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: Secondary DNS server IPv4 or IPv6 Address example: 10.2.2.3 host: type: array items: required: - hostname - ip type: object properties: hostname: pattern: ^[a-zA-Z0-9\-_.]{1,64}$ type: string description: Host name example: vbond ip: maxItems: 64 minItems: 1 uniqueItems: true type: array items: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: IP Address example: 10.1.1.1 description: Static host mapping $$ref: '#/components/schemas/DnsHostMapping' description: Configure DNS servers or static host mapping $$ref: '#/components/schemas/ControlComponentDnsSetting' interface: maxItems: 2147483647 minItems: 1 type: array items: required: - ifName type: object properties: ifName: pattern: ^(?=.{1,32}$)(?:(ge0\/\d+(?:\.\d+)?|loopback\d+|eth\d+(?:\.\d+)?))$ type: string description: Interface name eth<0-..> or eth<0-..>.vlanid or loopback when present example: eth0 ip: type: object properties: address: pattern: ^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\/)([0-2]?[0-9]$|[3]?[0-2])$ type: string description: Assign IPv4 address example: 10.0.1.1/24 dhcpClient: type: boolean description: Enable DHCP example: false default: false dhcpDistance: maximum: 65536 minimum: 1 type: integer description: Set administrative distance for DHCP default route format: int32 example: 1 default: 1 description: IPv4 address or DHCP $$ref: '#/components/schemas/IpConfig' ipv6: type: object properties: address: pattern: ((^\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:)))(%.+)?\s*(\/)(\b([0-9]{1,2}|1[01][0-9]|12[0-8])\b)$)) type: string description: Assign IPv6 address example: 2001:a0:64::20/64 dhcpClient: type: boolean description: Enable DHCP example: false default: false dhcpDistance: maximum: 65536 minimum: 1 type: integer description: Set administrative distance for DHCP default route format: int32 example: 1 default: 1 dhcpRapidCommit: type: boolean description: Enable DHCPv6 rapid commit example: false default: false description: IPv6 address or DHCP $$ref: '#/components/schemas/Ipv6Config' shutdown: type: boolean description: Administrative state example: false default: false description: Interfaces configuration $$ref: '#/components/schemas/BaseInterfaceSetting' ipRoute: type: object properties: route: type: array items: required: - nextHop - prefix type: object properties: nextHop: maxItems: 2147483647 minItems: 1 type: array items: required: - address type: object properties: address: pattern: ^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$ type: string description: IPv4 Address example: 10.0.0.1 distance: maximum: 255 minimum: 1 type: integer description: Administrative distance format: int32 example: 1 default: 1 description: IP gateway address $$ref: '#/components/schemas/NextHop' prefix: pattern: ^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\/)([0-2]?[0-9]$|[3]?[0-2])$ type: string description: IPv4 Prefix example: 0.0.0.0/0 description: Configure static routes $$ref: '#/components/schemas/StaticRoute' description: IP Route information $$ref: '#/components/schemas/IpRoute' ipv6Route: type: object properties: route: type: array items: required: - nextHop - prefix type: object properties: nextHop: maxItems: 2147483647 minItems: 1 type: array items: required: - address type: object properties: address: pattern: (([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)) type: string description: IPv6 Address example: 2001::1 distance: maximum: 255 minimum: 1 type: integer description: Administrative distance format: int32 example: 1 default: 1 description: IP gateway address $$ref: '#/components/schemas/IPV6NextHop' prefix: pattern: ((^\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:)))(%.+)?\s*(\/)(\b([0-9]{1,2}|1[01][0-9]|12[0-8])\b)$)) type: string description: IPv6 Prefix example: 2001::/4 description: Configure IPv6 static routes $$ref: '#/components/schemas/Ipv6StaticRoute' description: IPv6 Route information $$ref: '#/components/schemas/Ipv6Route' description: Management VPN instance $$ref: '#/components/schemas/baseVpnInstanceBaseInterfaceSetting' transport: required: - interface type: object properties: dns: type: object properties: dnsServerPrimary: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: Primary DNS server IPv4 or IPv6 Address example: 10.2.2.2 dnsServerSecondary: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: Secondary DNS server IPv4 or IPv6 Address example: 10.2.2.3 host: type: array items: required: - hostname - ip type: object properties: hostname: pattern: ^[a-zA-Z0-9\-_.]{1,64}$ type: string description: Host name example: vbond ip: maxItems: 64 minItems: 1 uniqueItems: true type: array items: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: IP Address example: 10.1.1.1 description: Static host mapping $$ref: '#/components/schemas/DnsHostMapping' description: Configure DNS servers or static host mapping $$ref: '#/components/schemas/ControlComponentDnsSetting' interface: maxItems: 2147483647 minItems: 1 type: array items: required: - ifName type: object properties: ifName: pattern: ^(?=.{1,32}$)(?:(ge0\/\d+(?:\.\d+)?|loopback\d+|eth\d+(?:\.\d+)?))$ type: string description: Interface name eth<0-..> or eth<0-..>.vlanid or loopback when present example: eth0 ip: type: object properties: address: pattern: ^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\/)([0-2]?[0-9]$|[3]?[0-2])$ type: string description: Assign IPv4 address example: 10.0.1.1/24 dhcpClient: type: boolean description: Enable DHCP example: false default: false dhcpDistance: maximum: 65536 minimum: 1 type: integer description: Set administrative distance for DHCP default route format: int32 example: 1 default: 1 description: IPv4 address or DHCP $$ref: '#/components/schemas/IpConfig' ipv6: type: object properties: address: pattern: ((^\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:)))(%.+)?\s*(\/)(\b([0-9]{1,2}|1[01][0-9]|12[0-8])\b)$)) type: string description: Assign IPv6 address example: 2001:a0:64::20/64 dhcpClient: type: boolean description: Enable DHCP example: false default: false dhcpDistance: maximum: 65536 minimum: 1 type: integer description: Set administrative distance for DHCP default route format: int32 example: 1 default: 1 dhcpRapidCommit: type: boolean description: Enable DHCPv6 rapid commit example: false default: false description: IPv6 address or DHCP $$ref: '#/components/schemas/Ipv6Config' shutdown: type: boolean description: Administrative state example: false default: false tunnelInterface: type: object properties: allowService: type: object properties: all: type: boolean description: Allow all traffic. Overrides all other allow-service options if allow-service all is set example: false default: false dhcp: type: boolean description: Allow/Deny DHCP example: true default: true dns: type: boolean description: Allow/Deny DNS example: true default: true icmp: type: boolean description: Allow/Deny ICMP example: true default: true netconf: type: boolean description: Allow/Deny NETCONF example: false default: false ntp: type: boolean description: Allow/Deny NTP example: false default: false sshd: type: boolean description: Allow/Deny SSH example: false default: false stun: type: boolean description: Allow/Deny STUN example: false default: false description: Set services allowed on the WAN interface $$ref: '#/components/schemas/AllowService' color: type: object properties: value: type: string description: Set color for TLOC example: default enum: - default - mpls - metro-ethernet - biz-internet - public-internet - lte - 3g - red - green - blue - gold - silver - bronze - custom1 - custom2 - custom3 - private1 - private2 - private3 - private4 - private5 - private6 default: default description: Set color for TLOC $$ref: '#/components/schemas/Color' description: Tunnel interface configuration $$ref: '#/components/schemas/TunnelInterface' description: Interfaces configuration $$ref: '#/components/schemas/TransportInterfaceSetting' ipRoute: type: object properties: route: type: array items: required: - nextHop - prefix type: object properties: nextHop: maxItems: 2147483647 minItems: 1 type: array items: required: - address type: object properties: address: pattern: ^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$ type: string description: IPv4 Address example: 10.0.0.1 distance: maximum: 255 minimum: 1 type: integer description: Administrative distance format: int32 example: 1 default: 1 description: IP gateway address $$ref: '#/components/schemas/NextHop' prefix: pattern: ^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\/)([0-2]?[0-9]$|[3]?[0-2])$ type: string description: IPv4 Prefix example: 0.0.0.0/0 description: Configure static routes $$ref: '#/components/schemas/StaticRoute' description: IP Route information $$ref: '#/components/schemas/IpRoute' ipv6Route: type: object properties: route: type: array items: required: - nextHop - prefix type: object properties: nextHop: maxItems: 2147483647 minItems: 1 type: array items: required: - address type: object properties: address: pattern: (([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)) type: string description: IPv6 Address example: 2001::1 distance: maximum: 255 minimum: 1 type: integer description: Administrative distance format: int32 example: 1 default: 1 description: IP gateway address $$ref: '#/components/schemas/IPV6NextHop' prefix: pattern: ((^\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:)))(%.+)?\s*(\/)(\b([0-9]{1,2}|1[01][0-9]|12[0-8])\b)$)) type: string description: IPv6 Prefix example: 2001::/4 description: Configure IPv6 static routes $$ref: '#/components/schemas/Ipv6StaticRoute' description: IPv6 Route information $$ref: '#/components/schemas/Ipv6Route' description: Transport VPN instance $$ref: '#/components/schemas/baseVpnInstanceTransportInterfaceSetting' description: Manager VPN setting $$ref: '#/components/schemas/ManagerVpnSetting' description: The payload for manager device specific settings $$ref: '#/components/schemas/ManagerDeviceSpecificSetting' $$ref: '#/components/schemas/QueryManagerDeviceSpecificSettingsResponse' - required: - createdBy - createdOn - payload type: object properties: createdBy: type: string description: The user who created the controller device specific settings example: admin createdOn: type: integer description: The timestamp when controller device specific settings are created format: int64 example: 1741315339238 lastUpdatedBy: type: string description: The user who modified the controller device specific settings example: admin lastUpdatedOn: type: integer description: The timestamp when controller device specific settings are modified format: int64 example: 1741315339240 payload: required: - system - vpn type: object properties: system: required: - hostName - siteId - systemIp type: object properties: clock: required: - timezone type: object properties: timezone: type: string description: Set the timezone example: UTC enum: - Europe/Andorra - Asia/Dubai - Asia/Kabul - America/Antigua - America/Anguilla - Europe/Tirane - Asia/Yerevan - Africa/Luanda - Antarctica/McMurdo - Antarctica/Rothera - Antarctica/Palmer - Antarctica/Mawson - Antarctica/Davis - Antarctica/Casey - Antarctica/Vostok - Antarctica/DumontDUrville - Antarctica/Syowa - America/Argentina/Buenos_Aires - America/Argentina/Cordoba - America/Argentina/Salta - America/Argentina/Jujuy - America/Argentina/Tucuman - America/Argentina/Catamarca - America/Argentina/La_Rioja - America/Argentina/San_Juan - America/Argentina/Mendoza - America/Argentina/San_Luis - America/Argentina/Rio_Gallegos - America/Argentina/Ushuaia - Pacific/Pago_Pago - Europe/Vienna - Australia/Lord_Howe - Antarctica/Macquarie - Australia/Hobart - Australia/Currie - Australia/Melbourne - Australia/Sydney - Australia/Broken_Hill - Australia/Brisbane - Australia/Lindeman - Australia/Adelaide - Australia/Darwin - Australia/Perth - Australia/Eucla - America/Aruba - Europe/Mariehamn - Asia/Baku - Europe/Sarajevo - America/Barbados - Asia/Dhaka - Europe/Brussels - Africa/Ouagadougou - Europe/Sofia - Asia/Bahrain - Africa/Bujumbura - Africa/Porto-Novo - America/St_Barthelemy - Atlantic/Bermuda - Asia/Brunei - America/La_Paz - America/Kralendijk - America/Noronha - America/Belem - America/Fortaleza - America/Recife - America/Araguaina - America/Maceio - America/Bahia - America/Sao_Paulo - America/Campo_Grande - America/Cuiaba - America/Santarem - America/Porto_Velho - America/Boa_Vista - America/Manaus - America/Eirunepe - America/Rio_Branco - America/Nassau - Asia/Thimphu - Africa/Gaborone - Europe/Minsk - America/Belize - America/St_Johns - America/Halifax - America/Glace_Bay - America/Moncton - America/Goose_Bay - America/Blanc-Sablon - America/Toronto - America/Nipigon - America/Thunder_Bay - America/Iqaluit - America/Pangnirtung - America/Resolute - America/Atikokan - America/Rankin_Inlet - America/Winnipeg - America/Rainy_River - America/Regina - America/Swift_Current - America/Edmonton - America/Cambridge_Bay - America/Yellowknife - America/Inuvik - America/Creston - America/Dawson_Creek - America/Vancouver - America/Whitehorse - America/Dawson - Indian/Cocos - Africa/Kinshasa - Africa/Lubumbashi - Africa/Bangui - Africa/Brazzaville - Europe/Zurich - Africa/Abidjan - Pacific/Rarotonga - America/Santiago - Pacific/Easter - Africa/Douala - Asia/Shanghai - Asia/Harbin - Asia/Chongqing - Asia/Urumqi - Asia/Kashgar - America/Bogota - America/Costa_Rica - America/Havana - Atlantic/Cape_Verde - America/Curacao - Indian/Christmas - Asia/Nicosia - Europe/Prague - Europe/Berlin - Europe/Busingen - Africa/Djibouti - Europe/Copenhagen - America/Dominica - America/Santo_Domingo - Africa/Algiers - America/Guayaquil - Pacific/Galapagos - Europe/Tallinn - Africa/Cairo - Africa/El_Aaiun - Africa/Asmara - Europe/Madrid - Africa/Ceuta - Atlantic/Canary - Africa/Addis_Ababa - Europe/Helsinki - Pacific/Fiji - Atlantic/Stanley - Pacific/Chuuk - Pacific/Pohnpei - Pacific/Kosrae - Atlantic/Faroe - Europe/Paris - Africa/Libreville - Europe/London - America/Grenada - Asia/Tbilisi - America/Cayenne - Europe/Guernsey - Africa/Accra - Europe/Gibraltar - America/Godthab - America/Danmarkshavn - America/Scoresbysund - America/Thule - Africa/Banjul - Africa/Conakry - America/Guadeloupe - Africa/Malabo - Europe/Athens - Atlantic/South_Georgia - America/Guatemala - Pacific/Guam - Africa/Bissau - America/Guyana - Asia/Hong_Kong - America/Tegucigalpa - Europe/Zagreb - America/Port-au-Prince - Europe/Budapest - Asia/Jakarta - Asia/Pontianak - Asia/Makassar - Asia/Jayapura - Europe/Dublin - Asia/Jerusalem - Europe/Isle_of_Man - Asia/Kolkata - Indian/Chagos - Asia/Baghdad - Asia/Tehran - Atlantic/Reykjavik - Europe/Rome - Europe/Jersey - America/Jamaica - Asia/Amman - Asia/Tokyo - Africa/Nairobi - Asia/Bishkek - Asia/Phnom_Penh - Pacific/Tarawa - Pacific/Enderbury - Pacific/Kiritimati - Indian/Comoro - America/St_Kitts - Asia/Pyongyang - Asia/Seoul - Asia/Kuwait - America/Cayman - Asia/Almaty - Asia/Qyzylorda - Asia/Aqtobe - Asia/Aqtau - Asia/Oral - Asia/Vientiane - Asia/Beirut - America/St_Lucia - Europe/Vaduz - Asia/Colombo - Africa/Monrovia - Africa/Maseru - Europe/Vilnius - Europe/Luxembourg - Europe/Riga - Africa/Tripoli - Africa/Casablanca - Europe/Monaco - Europe/Chisinau - Europe/Podgorica - America/Marigot - Indian/Antananarivo - Pacific/Majuro - Pacific/Kwajalein - Europe/Skopje - Africa/Bamako - Asia/Rangoon - Asia/Ulaanbaatar - Asia/Hovd - Asia/Choibalsan - Asia/Macau - Pacific/Saipan - America/Martinique - Africa/Nouakchott - America/Montserrat - Europe/Malta - Indian/Mauritius - Indian/Maldives - Africa/Blantyre - America/Mexico_City - America/Cancun - America/Merida - America/Monterrey - America/Matamoros - America/Mazatlan - America/Chihuahua - America/Ojinaga - America/Hermosillo - America/Tijuana - America/Santa_Isabel - America/Bahia_Banderas - Asia/Kuala_Lumpur - Asia/Kuching - Africa/Maputo - Africa/Windhoek - Pacific/Noumea - Africa/Niamey - Pacific/Norfolk - Africa/Lagos - America/Managua - Europe/Amsterdam - Europe/Oslo - Asia/Kathmandu - Pacific/Nauru - Pacific/Niue - Pacific/Auckland - Pacific/Chatham - Asia/Muscat - America/Panama - America/Lima - Pacific/Tahiti - Pacific/Marquesas - Pacific/Gambier - Pacific/Port_Moresby - Asia/Manila - Asia/Karachi - Europe/Warsaw - America/Miquelon - Pacific/Pitcairn - America/Puerto_Rico - Asia/Gaza - Asia/Hebron - Europe/Lisbon - Atlantic/Madeira - Atlantic/Azores - Pacific/Palau - America/Asuncion - Asia/Qatar - Indian/Reunion - Europe/Bucharest - Europe/Belgrade - Europe/Kaliningrad - Europe/Moscow - Europe/Volgograd - Europe/Samara - Asia/Yekaterinburg - Asia/Omsk - Asia/Novosibirsk - Asia/Novokuznetsk - Asia/Krasnoyarsk - Asia/Irkutsk - Asia/Yakutsk - Asia/Khandyga - Asia/Vladivostok - Asia/Sakhalin - Asia/Ust-Nera - Asia/Magadan - Asia/Kamchatka - Asia/Anadyr - Africa/Kigali - Asia/Riyadh - Pacific/Guadalcanal - Indian/Mahe - Africa/Khartoum - Europe/Stockholm - Asia/Singapore - Atlantic/St_Helena - Europe/Ljubljana - Arctic/Longyearbyen - Europe/Bratislava - Africa/Freetown - Europe/San_Marino - Africa/Dakar - Africa/Mogadishu - America/Paramaribo - Africa/Juba - Africa/Sao_Tome - America/El_Salvador - America/Lower_Princes - Asia/Damascus - Africa/Mbabane - America/Grand_Turk - Africa/Ndjamena - Indian/Kerguelen - Africa/Lome - Asia/Bangkok - Asia/Dushanbe - Pacific/Fakaofo - Asia/Dili - Asia/Ashgabat - Africa/Tunis - Pacific/Tongatapu - Europe/Istanbul - America/Port_of_Spain - Pacific/Funafuti - Asia/Taipei - Africa/Dar_es_Salaam - Europe/Kiev - Europe/Uzhgorod - Europe/Zaporozhye - Europe/Simferopol - Africa/Kampala - Pacific/Johnston - Pacific/Midway - Pacific/Wake - America/New_York - America/Detroit - America/Kentucky/Louisville - America/Kentucky/Monticello - America/Indiana/Indianapolis - America/Indiana/Vincennes - America/Indiana/Winamac - America/Indiana/Marengo - America/Indiana/Petersburg - America/Indiana/Vevay - America/Chicago - America/Indiana/Tell_City - America/Indiana/Knox - America/Menominee - America/North_Dakota/Center - America/North_Dakota/New_Salem - America/North_Dakota/Beulah - America/Denver - America/Boise - America/Phoenix - America/Los_Angeles - America/Anchorage - America/Juneau - America/Sitka - America/Yakutat - America/Nome - America/Adak - America/Metlakatla - Pacific/Honolulu - America/Montevideo - Asia/Samarkand - Asia/Tashkent - Europe/Vatican - America/St_Vincent - America/Caracas - America/Tortola - America/St_Thomas - Asia/Ho_Chi_Minh - Pacific/Efate - Pacific/Wallis - Pacific/Apia - Asia/Aden - Indian/Mayotte - Africa/Johannesburg - Africa/Lusaka - Africa/Harare - UTC default: UTC description: Configure clock $$ref: '#/components/schemas/Clock' controllerGroupId: maximum: 100 minimum: 0 type: integer description: Controller group id format: int32 example: 0 default: 0 description: pattern: ^[^<>]{1,32}$ type: string description: Set a text description of the device example: System settings deviceGroups: type: array description: Configure device groups items: type: string description: Configure device groups gpsLocation: required: - latitude - longitude type: object properties: latitude: maximum: 90 minimum: -90 type: number description: Set the device’s physical latitude example: 60 longitude: maximum: 180 minimum: -180 type: number description: Set the device’s physical longitude example: 60 description: GPS latitude and longitude of the device $$ref: '#/components/schemas/GpsLocation' hostName: pattern: ^[a-zA-Z0-9\-_]{1,32}$ type: string description: Set the hostname example: vm12 ipv6StrictControl: type: boolean description: Sets up a strict IPv6 control connection in a dual stack IP example: false default: false location: pattern: ^[^<>]{1,127}$ type: string description: Set the location of the device example: USA overlayId: maximum: 4294967295 minimum: 1 type: integer description: Set the Overlay ID format: int64 example: 1 default: 1 region: type: object properties: regionIdList: maxItems: 2147483647 minItems: 1 uniqueItems: true type: array items: maximum: 63 minimum: 0 type: integer description: Configure a list of region ID format: int32 example: 0 $$ref: '#/components/schemas/Region' siteId: maximum: 4294967295 minimum: 0 type: integer description: Set the site ID format: int64 example: 100 systemIp: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: Set the system IP address example: 102.2.3.2 description: System configuration for controller $$ref: '#/components/schemas/ControllerSystemSetting' vpn: required: - transport type: object properties: management: required: - interface type: object properties: dns: type: object properties: dnsServerPrimary: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: Primary DNS server IPv4 or IPv6 Address example: 10.2.2.2 dnsServerSecondary: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: Secondary DNS server IPv4 or IPv6 Address example: 10.2.2.3 host: type: array items: required: - hostname - ip type: object properties: hostname: pattern: ^[a-zA-Z0-9\-_.]{1,64}$ type: string description: Host name example: vbond ip: maxItems: 64 minItems: 1 uniqueItems: true type: array items: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: IP Address example: 10.1.1.1 description: Static host mapping $$ref: '#/components/schemas/DnsHostMapping' description: Configure DNS servers or static host mapping $$ref: '#/components/schemas/ControlComponentDnsSetting' interface: maxItems: 2147483647 minItems: 1 type: array items: required: - ifName type: object properties: ifName: pattern: ^(?=.{1,32}$)(?:(ge0\/\d+(?:\.\d+)?|loopback\d+|eth\d+(?:\.\d+)?))$ type: string description: Interface name eth<0-..> or eth<0-..>.vlanid or loopback when present example: eth0 ip: type: object properties: address: pattern: ^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\/)([0-2]?[0-9]$|[3]?[0-2])$ type: string description: Assign IPv4 address example: 10.0.1.1/24 dhcpClient: type: boolean description: Enable DHCP example: false default: false dhcpDistance: maximum: 65536 minimum: 1 type: integer description: Set administrative distance for DHCP default route format: int32 example: 1 default: 1 description: IPv4 address or DHCP $$ref: '#/components/schemas/IpConfig' ipv6: type: object properties: address: pattern: ((^\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:)))(%.+)?\s*(\/)(\b([0-9]{1,2}|1[01][0-9]|12[0-8])\b)$)) type: string description: Assign IPv6 address example: 2001:a0:64::20/64 dhcpClient: type: boolean description: Enable DHCP example: false default: false dhcpDistance: maximum: 65536 minimum: 1 type: integer description: Set administrative distance for DHCP default route format: int32 example: 1 default: 1 dhcpRapidCommit: type: boolean description: Enable DHCPv6 rapid commit example: false default: false description: IPv6 address or DHCP $$ref: '#/components/schemas/Ipv6Config' shutdown: type: boolean description: Administrative state example: false default: false description: Interfaces configuration $$ref: '#/components/schemas/BaseInterfaceSetting' ipRoute: type: object properties: route: type: array items: required: - nextHop - prefix type: object properties: nextHop: maxItems: 2147483647 minItems: 1 type: array items: required: - address type: object properties: address: pattern: ^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$ type: string description: IPv4 Address example: 10.0.0.1 distance: maximum: 255 minimum: 1 type: integer description: Administrative distance format: int32 example: 1 default: 1 description: IP gateway address $$ref: '#/components/schemas/NextHop' prefix: pattern: ^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\/)([0-2]?[0-9]$|[3]?[0-2])$ type: string description: IPv4 Prefix example: 0.0.0.0/0 description: Configure static routes $$ref: '#/components/schemas/StaticRoute' description: IP Route information $$ref: '#/components/schemas/IpRoute' ipv6Route: type: object properties: route: type: array items: required: - nextHop - prefix type: object properties: nextHop: maxItems: 2147483647 minItems: 1 type: array items: required: - address type: object properties: address: pattern: (([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)) type: string description: IPv6 Address example: 2001::1 distance: maximum: 255 minimum: 1 type: integer description: Administrative distance format: int32 example: 1 default: 1 description: IP gateway address $$ref: '#/components/schemas/IPV6NextHop' prefix: pattern: ((^\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:)))(%.+)?\s*(\/)(\b([0-9]{1,2}|1[01][0-9]|12[0-8])\b)$)) type: string description: IPv6 Prefix example: 2001::/4 description: Configure IPv6 static routes $$ref: '#/components/schemas/Ipv6StaticRoute' description: IPv6 Route information $$ref: '#/components/schemas/Ipv6Route' description: Management VPN instance $$ref: '#/components/schemas/baseVpnInstanceBaseInterfaceSetting' transport: required: - interface type: object properties: dns: type: object properties: dnsServerPrimary: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: Primary DNS server IPv4 or IPv6 Address example: 10.2.2.2 dnsServerSecondary: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: Secondary DNS server IPv4 or IPv6 Address example: 10.2.2.3 host: type: array items: required: - hostname - ip type: object properties: hostname: pattern: ^[a-zA-Z0-9\-_.]{1,64}$ type: string description: Host name example: vbond ip: maxItems: 64 minItems: 1 uniqueItems: true type: array items: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: IP Address example: 10.1.1.1 description: Static host mapping $$ref: '#/components/schemas/DnsHostMapping' description: Configure DNS servers or static host mapping $$ref: '#/components/schemas/ControlComponentDnsSetting' interface: maxItems: 2147483647 minItems: 1 type: array items: required: - ifName type: object properties: ifName: pattern: ^(?=.{1,32}$)(?:(ge0\/\d+(?:\.\d+)?|loopback\d+|eth\d+(?:\.\d+)?))$ type: string description: Interface name eth<0-..> or eth<0-..>.vlanid or loopback when present example: eth0 ip: type: object properties: address: pattern: ^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\/)([0-2]?[0-9]$|[3]?[0-2])$ type: string description: Assign IPv4 address example: 10.0.1.1/24 dhcpClient: type: boolean description: Enable DHCP example: false default: false dhcpDistance: maximum: 65536 minimum: 1 type: integer description: Set administrative distance for DHCP default route format: int32 example: 1 default: 1 description: IPv4 address or DHCP $$ref: '#/components/schemas/IpConfig' ipv6: type: object properties: address: pattern: ((^\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:)))(%.+)?\s*(\/)(\b([0-9]{1,2}|1[01][0-9]|12[0-8])\b)$)) type: string description: Assign IPv6 address example: 2001:a0:64::20/64 dhcpClient: type: boolean description: Enable DHCP example: false default: false dhcpDistance: maximum: 65536 minimum: 1 type: integer description: Set administrative distance for DHCP default route format: int32 example: 1 default: 1 dhcpRapidCommit: type: boolean description: Enable DHCPv6 rapid commit example: false default: false description: IPv6 address or DHCP $$ref: '#/components/schemas/Ipv6Config' shutdown: type: boolean description: Administrative state example: false default: false tunnelInterface: type: object properties: allowService: type: object properties: all: type: boolean description: Allow all traffic. Overrides all other allow-service options if allow-service all is set example: false default: false dhcp: type: boolean description: Allow/Deny DHCP example: true default: true dns: type: boolean description: Allow/Deny DNS example: true default: true icmp: type: boolean description: Allow/Deny ICMP example: true default: true netconf: type: boolean description: Allow/Deny NETCONF example: false default: false ntp: type: boolean description: Allow/Deny NTP example: false default: false sshd: type: boolean description: Allow/Deny SSH example: false default: false stun: type: boolean description: Allow/Deny STUN example: false default: false description: Set services allowed on the WAN interface $$ref: '#/components/schemas/AllowService' color: type: object properties: value: type: string description: Set color for TLOC example: default enum: - default - mpls - metro-ethernet - biz-internet - public-internet - lte - 3g - red - green - blue - gold - silver - bronze - custom1 - custom2 - custom3 - private1 - private2 - private3 - private4 - private5 - private6 default: default description: Set color for TLOC $$ref: '#/components/schemas/Color' description: Tunnel interface configuration $$ref: '#/components/schemas/TunnelInterface' description: Interfaces configuration $$ref: '#/components/schemas/TransportInterfaceSetting' ipRoute: type: object properties: route: type: array items: required: - nextHop - prefix type: object properties: nextHop: maxItems: 2147483647 minItems: 1 type: array items: required: - address type: object properties: address: pattern: ^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$ type: string description: IPv4 Address example: 10.0.0.1 distance: maximum: 255 minimum: 1 type: integer description: Administrative distance format: int32 example: 1 default: 1 description: IP gateway address $$ref: '#/components/schemas/NextHop' prefix: pattern: ^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\/)([0-2]?[0-9]$|[3]?[0-2])$ type: string description: IPv4 Prefix example: 0.0.0.0/0 description: Configure static routes $$ref: '#/components/schemas/StaticRoute' description: IP Route information $$ref: '#/components/schemas/IpRoute' ipv6Route: type: object properties: route: type: array items: required: - nextHop - prefix type: object properties: nextHop: maxItems: 2147483647 minItems: 1 type: array items: required: - address type: object properties: address: pattern: (([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)) type: string description: IPv6 Address example: 2001::1 distance: maximum: 255 minimum: 1 type: integer description: Administrative distance format: int32 example: 1 default: 1 description: IP gateway address $$ref: '#/components/schemas/IPV6NextHop' prefix: pattern: ((^\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:)))(%.+)?\s*(\/)(\b([0-9]{1,2}|1[01][0-9]|12[0-8])\b)$)) type: string description: IPv6 Prefix example: 2001::/4 description: Configure IPv6 static routes $$ref: '#/components/schemas/Ipv6StaticRoute' description: IPv6 Route information $$ref: '#/components/schemas/Ipv6Route' description: Transport VPN instance $$ref: '#/components/schemas/baseVpnInstanceTransportInterfaceSetting' description: Controller VPN setting $$ref: '#/components/schemas/ControllerVpnSetting' description: The payload for controller device specific settings $$ref: '#/components/schemas/ControllerDeviceSpecificSetting' $$ref: '#/components/schemas/QueryControllerDeviceSpecificSettingsResponse' - required: - createdBy - createdOn - payload type: object properties: createdBy: type: string description: The user who created the controller device specific settings example: admin createdOn: type: integer description: The timestamp when controller device specific settings are created format: int64 example: 1741315339238 lastUpdatedBy: type: string description: The user who modified the controller device specific settings example: admin lastUpdatedOn: type: integer description: The timestamp when controller device specific settings are modified format: int64 example: 1741315339240 payload: required: - system - vpn type: object properties: system: required: - hostName - siteId - systemIp type: object properties: clock: required: - timezone type: object properties: timezone: type: string description: Set the timezone example: UTC enum: - Europe/Andorra - Asia/Dubai - Asia/Kabul - America/Antigua - America/Anguilla - Europe/Tirane - Asia/Yerevan - Africa/Luanda - Antarctica/McMurdo - Antarctica/Rothera - Antarctica/Palmer - Antarctica/Mawson - Antarctica/Davis - Antarctica/Casey - Antarctica/Vostok - Antarctica/DumontDUrville - Antarctica/Syowa - America/Argentina/Buenos_Aires - America/Argentina/Cordoba - America/Argentina/Salta - America/Argentina/Jujuy - America/Argentina/Tucuman - America/Argentina/Catamarca - America/Argentina/La_Rioja - America/Argentina/San_Juan - America/Argentina/Mendoza - America/Argentina/San_Luis - America/Argentina/Rio_Gallegos - America/Argentina/Ushuaia - Pacific/Pago_Pago - Europe/Vienna - Australia/Lord_Howe - Antarctica/Macquarie - Australia/Hobart - Australia/Currie - Australia/Melbourne - Australia/Sydney - Australia/Broken_Hill - Australia/Brisbane - Australia/Lindeman - Australia/Adelaide - Australia/Darwin - Australia/Perth - Australia/Eucla - America/Aruba - Europe/Mariehamn - Asia/Baku - Europe/Sarajevo - America/Barbados - Asia/Dhaka - Europe/Brussels - Africa/Ouagadougou - Europe/Sofia - Asia/Bahrain - Africa/Bujumbura - Africa/Porto-Novo - America/St_Barthelemy - Atlantic/Bermuda - Asia/Brunei - America/La_Paz - America/Kralendijk - America/Noronha - America/Belem - America/Fortaleza - America/Recife - America/Araguaina - America/Maceio - America/Bahia - America/Sao_Paulo - America/Campo_Grande - America/Cuiaba - America/Santarem - America/Porto_Velho - America/Boa_Vista - America/Manaus - America/Eirunepe - America/Rio_Branco - America/Nassau - Asia/Thimphu - Africa/Gaborone - Europe/Minsk - America/Belize - America/St_Johns - America/Halifax - America/Glace_Bay - America/Moncton - America/Goose_Bay - America/Blanc-Sablon - America/Toronto - America/Nipigon - America/Thunder_Bay - America/Iqaluit - America/Pangnirtung - America/Resolute - America/Atikokan - America/Rankin_Inlet - America/Winnipeg - America/Rainy_River - America/Regina - America/Swift_Current - America/Edmonton - America/Cambridge_Bay - America/Yellowknife - America/Inuvik - America/Creston - America/Dawson_Creek - America/Vancouver - America/Whitehorse - America/Dawson - Indian/Cocos - Africa/Kinshasa - Africa/Lubumbashi - Africa/Bangui - Africa/Brazzaville - Europe/Zurich - Africa/Abidjan - Pacific/Rarotonga - America/Santiago - Pacific/Easter - Africa/Douala - Asia/Shanghai - Asia/Harbin - Asia/Chongqing - Asia/Urumqi - Asia/Kashgar - America/Bogota - America/Costa_Rica - America/Havana - Atlantic/Cape_Verde - America/Curacao - Indian/Christmas - Asia/Nicosia - Europe/Prague - Europe/Berlin - Europe/Busingen - Africa/Djibouti - Europe/Copenhagen - America/Dominica - America/Santo_Domingo - Africa/Algiers - America/Guayaquil - Pacific/Galapagos - Europe/Tallinn - Africa/Cairo - Africa/El_Aaiun - Africa/Asmara - Europe/Madrid - Africa/Ceuta - Atlantic/Canary - Africa/Addis_Ababa - Europe/Helsinki - Pacific/Fiji - Atlantic/Stanley - Pacific/Chuuk - Pacific/Pohnpei - Pacific/Kosrae - Atlantic/Faroe - Europe/Paris - Africa/Libreville - Europe/London - America/Grenada - Asia/Tbilisi - America/Cayenne - Europe/Guernsey - Africa/Accra - Europe/Gibraltar - America/Godthab - America/Danmarkshavn - America/Scoresbysund - America/Thule - Africa/Banjul - Africa/Conakry - America/Guadeloupe - Africa/Malabo - Europe/Athens - Atlantic/South_Georgia - America/Guatemala - Pacific/Guam - Africa/Bissau - America/Guyana - Asia/Hong_Kong - America/Tegucigalpa - Europe/Zagreb - America/Port-au-Prince - Europe/Budapest - Asia/Jakarta - Asia/Pontianak - Asia/Makassar - Asia/Jayapura - Europe/Dublin - Asia/Jerusalem - Europe/Isle_of_Man - Asia/Kolkata - Indian/Chagos - Asia/Baghdad - Asia/Tehran - Atlantic/Reykjavik - Europe/Rome - Europe/Jersey - America/Jamaica - Asia/Amman - Asia/Tokyo - Africa/Nairobi - Asia/Bishkek - Asia/Phnom_Penh - Pacific/Tarawa - Pacific/Enderbury - Pacific/Kiritimati - Indian/Comoro - America/St_Kitts - Asia/Pyongyang - Asia/Seoul - Asia/Kuwait - America/Cayman - Asia/Almaty - Asia/Qyzylorda - Asia/Aqtobe - Asia/Aqtau - Asia/Oral - Asia/Vientiane - Asia/Beirut - America/St_Lucia - Europe/Vaduz - Asia/Colombo - Africa/Monrovia - Africa/Maseru - Europe/Vilnius - Europe/Luxembourg - Europe/Riga - Africa/Tripoli - Africa/Casablanca - Europe/Monaco - Europe/Chisinau - Europe/Podgorica - America/Marigot - Indian/Antananarivo - Pacific/Majuro - Pacific/Kwajalein - Europe/Skopje - Africa/Bamako - Asia/Rangoon - Asia/Ulaanbaatar - Asia/Hovd - Asia/Choibalsan - Asia/Macau - Pacific/Saipan - America/Martinique - Africa/Nouakchott - America/Montserrat - Europe/Malta - Indian/Mauritius - Indian/Maldives - Africa/Blantyre - America/Mexico_City - America/Cancun - America/Merida - America/Monterrey - America/Matamoros - America/Mazatlan - America/Chihuahua - America/Ojinaga - America/Hermosillo - America/Tijuana - America/Santa_Isabel - America/Bahia_Banderas - Asia/Kuala_Lumpur - Asia/Kuching - Africa/Maputo - Africa/Windhoek - Pacific/Noumea - Africa/Niamey - Pacific/Norfolk - Africa/Lagos - America/Managua - Europe/Amsterdam - Europe/Oslo - Asia/Kathmandu - Pacific/Nauru - Pacific/Niue - Pacific/Auckland - Pacific/Chatham - Asia/Muscat - America/Panama - America/Lima - Pacific/Tahiti - Pacific/Marquesas - Pacific/Gambier - Pacific/Port_Moresby - Asia/Manila - Asia/Karachi - Europe/Warsaw - America/Miquelon - Pacific/Pitcairn - America/Puerto_Rico - Asia/Gaza - Asia/Hebron - Europe/Lisbon - Atlantic/Madeira - Atlantic/Azores - Pacific/Palau - America/Asuncion - Asia/Qatar - Indian/Reunion - Europe/Bucharest - Europe/Belgrade - Europe/Kaliningrad - Europe/Moscow - Europe/Volgograd - Europe/Samara - Asia/Yekaterinburg - Asia/Omsk - Asia/Novosibirsk - Asia/Novokuznetsk - Asia/Krasnoyarsk - Asia/Irkutsk - Asia/Yakutsk - Asia/Khandyga - Asia/Vladivostok - Asia/Sakhalin - Asia/Ust-Nera - Asia/Magadan - Asia/Kamchatka - Asia/Anadyr - Africa/Kigali - Asia/Riyadh - Pacific/Guadalcanal - Indian/Mahe - Africa/Khartoum - Europe/Stockholm - Asia/Singapore - Atlantic/St_Helena - Europe/Ljubljana - Arctic/Longyearbyen - Europe/Bratislava - Africa/Freetown - Europe/San_Marino - Africa/Dakar - Africa/Mogadishu - America/Paramaribo - Africa/Juba - Africa/Sao_Tome - America/El_Salvador - America/Lower_Princes - Asia/Damascus - Africa/Mbabane - America/Grand_Turk - Africa/Ndjamena - Indian/Kerguelen - Africa/Lome - Asia/Bangkok - Asia/Dushanbe - Pacific/Fakaofo - Asia/Dili - Asia/Ashgabat - Africa/Tunis - Pacific/Tongatapu - Europe/Istanbul - America/Port_of_Spain - Pacific/Funafuti - Asia/Taipei - Africa/Dar_es_Salaam - Europe/Kiev - Europe/Uzhgorod - Europe/Zaporozhye - Europe/Simferopol - Africa/Kampala - Pacific/Johnston - Pacific/Midway - Pacific/Wake - America/New_York - America/Detroit - America/Kentucky/Louisville - America/Kentucky/Monticello - America/Indiana/Indianapolis - America/Indiana/Vincennes - America/Indiana/Winamac - America/Indiana/Marengo - America/Indiana/Petersburg - America/Indiana/Vevay - America/Chicago - America/Indiana/Tell_City - America/Indiana/Knox - America/Menominee - America/North_Dakota/Center - America/North_Dakota/New_Salem - America/North_Dakota/Beulah - America/Denver - America/Boise - America/Phoenix - America/Los_Angeles - America/Anchorage - America/Juneau - America/Sitka - America/Yakutat - America/Nome - America/Adak - America/Metlakatla - Pacific/Honolulu - America/Montevideo - Asia/Samarkand - Asia/Tashkent - Europe/Vatican - America/St_Vincent - America/Caracas - America/Tortola - America/St_Thomas - Asia/Ho_Chi_Minh - Pacific/Efate - Pacific/Wallis - Pacific/Apia - Asia/Aden - Indian/Mayotte - Africa/Johannesburg - Africa/Lusaka - Africa/Harare - UTC default: UTC description: Configure clock $$ref: '#/components/schemas/Clock' description: pattern: ^[^<>]{1,32}$ type: string description: Set a text description of the device example: System settings deviceGroups: type: array description: Configure device groups items: type: string description: Configure device groups gpsLocation: required: - latitude - longitude type: object properties: latitude: maximum: 90 minimum: -90 type: number description: Set the device’s physical latitude example: 60 longitude: maximum: 180 minimum: -180 type: number description: Set the device’s physical longitude example: 60 description: GPS latitude and longitude of the device $$ref: '#/components/schemas/GpsLocation' hostName: pattern: ^[a-zA-Z0-9\-_]{1,32}$ type: string description: Set the hostname example: vm12 location: pattern: ^[^<>]{1,127}$ type: string description: Set the location of the device example: USA siteId: maximum: 4294967295 minimum: 0 type: integer description: Set the site ID format: int64 example: 100 systemIp: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: Set the system IP address example: 102.2.3.2 vbond: required: - address type: object properties: address: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: Set the vBond IP address example: 10.0.12.22 $$ref: '#/components/schemas/Vbond' description: System configuration for validator $$ref: '#/components/schemas/ValidatorSystemSetting' vpn: required: - transport type: object properties: management: required: - interface type: object properties: dns: type: object properties: dnsServerPrimary: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: Primary DNS server IPv4 or IPv6 Address example: 10.2.2.2 dnsServerSecondary: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: Secondary DNS server IPv4 or IPv6 Address example: 10.2.2.3 host: type: array items: required: - hostname - ip type: object properties: hostname: pattern: ^[a-zA-Z0-9\-_.]{1,64}$ type: string description: Host name example: vbond ip: maxItems: 64 minItems: 1 uniqueItems: true type: array items: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: IP Address example: 10.1.1.1 description: Static host mapping $$ref: '#/components/schemas/DnsHostMapping' description: Configure DNS servers or static host mapping $$ref: '#/components/schemas/ControlComponentDnsSetting' interface: maxItems: 2147483647 minItems: 1 type: array items: required: - ifName type: object properties: ifName: pattern: ^(?=.{1,32}$)(?:(ge0\/\d+(?:\.\d+)?|loopback\d+|eth\d+(?:\.\d+)?))$ type: string description: Interface name eth<0-..> or eth<0-..>.vlanid or loopback when present example: eth0 ip: type: object properties: address: pattern: ^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\/)([0-2]?[0-9]$|[3]?[0-2])$ type: string description: Assign IPv4 address example: 10.0.1.1/24 dhcpClient: type: boolean description: Enable DHCP example: false default: false dhcpDistance: maximum: 65536 minimum: 1 type: integer description: Set administrative distance for DHCP default route format: int32 example: 1 default: 1 description: IPv4 address or DHCP $$ref: '#/components/schemas/IpConfig' ipv6: type: object properties: address: pattern: ((^\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:)))(%.+)?\s*(\/)(\b([0-9]{1,2}|1[01][0-9]|12[0-8])\b)$)) type: string description: Assign IPv6 address example: 2001:a0:64::20/64 dhcpClient: type: boolean description: Enable DHCP example: false default: false dhcpDistance: maximum: 65536 minimum: 1 type: integer description: Set administrative distance for DHCP default route format: int32 example: 1 default: 1 dhcpRapidCommit: type: boolean description: Enable DHCPv6 rapid commit example: false default: false description: IPv6 address or DHCP $$ref: '#/components/schemas/Ipv6Config' shutdown: type: boolean description: Administrative state example: false default: false description: Interfaces configuration $$ref: '#/components/schemas/BaseInterfaceSetting' ipRoute: type: object properties: route: type: array items: required: - nextHop - prefix type: object properties: nextHop: maxItems: 2147483647 minItems: 1 type: array items: required: - address type: object properties: address: pattern: ^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$ type: string description: IPv4 Address example: 10.0.0.1 distance: maximum: 255 minimum: 1 type: integer description: Administrative distance format: int32 example: 1 default: 1 description: IP gateway address $$ref: '#/components/schemas/NextHop' prefix: pattern: ^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\/)([0-2]?[0-9]$|[3]?[0-2])$ type: string description: IPv4 Prefix example: 0.0.0.0/0 description: Configure static routes $$ref: '#/components/schemas/StaticRoute' description: IP Route information $$ref: '#/components/schemas/IpRoute' ipv6Route: type: object properties: route: type: array items: required: - nextHop - prefix type: object properties: nextHop: maxItems: 2147483647 minItems: 1 type: array items: required: - address type: object properties: address: pattern: (([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)) type: string description: IPv6 Address example: 2001::1 distance: maximum: 255 minimum: 1 type: integer description: Administrative distance format: int32 example: 1 default: 1 description: IP gateway address $$ref: '#/components/schemas/IPV6NextHop' prefix: pattern: ((^\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:)))(%.+)?\s*(\/)(\b([0-9]{1,2}|1[01][0-9]|12[0-8])\b)$)) type: string description: IPv6 Prefix example: 2001::/4 description: Configure IPv6 static routes $$ref: '#/components/schemas/Ipv6StaticRoute' description: IPv6 Route information $$ref: '#/components/schemas/Ipv6Route' description: Management VPN instance $$ref: '#/components/schemas/baseVpnInstanceBaseInterfaceSetting' transport: required: - interface type: object properties: dns: type: object properties: dnsServerPrimary: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: Primary DNS server IPv4 or IPv6 Address example: 10.2.2.2 dnsServerSecondary: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: Secondary DNS server IPv4 or IPv6 Address example: 10.2.2.3 host: type: array items: required: - hostname - ip type: object properties: hostname: pattern: ^[a-zA-Z0-9\-_.]{1,64}$ type: string description: Host name example: vbond ip: maxItems: 64 minItems: 1 uniqueItems: true type: array items: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: IP Address example: 10.1.1.1 description: Static host mapping $$ref: '#/components/schemas/DnsHostMapping' description: Configure DNS servers or static host mapping $$ref: '#/components/schemas/ControlComponentDnsSetting' interface: maxItems: 2147483647 minItems: 1 type: array items: required: - ifName type: object properties: ifName: pattern: ^(?=.{1,32}$)(?:(ge0\/\d+(?:\.\d+)?|loopback\d+|eth\d+(?:\.\d+)?))$ type: string description: Interface name eth<0-..> or eth<0-..>.vlanid or loopback when present example: eth0 ip: type: object properties: address: pattern: ^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\/)([0-2]?[0-9]$|[3]?[0-2])$ type: string description: Assign IPv4 address example: 10.0.1.1/24 dhcpClient: type: boolean description: Enable DHCP example: false default: false dhcpDistance: maximum: 65536 minimum: 1 type: integer description: Set administrative distance for DHCP default route format: int32 example: 1 default: 1 description: IPv4 address or DHCP $$ref: '#/components/schemas/IpConfig' ipv6: type: object properties: address: pattern: ((^\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:)))(%.+)?\s*(\/)(\b([0-9]{1,2}|1[01][0-9]|12[0-8])\b)$)) type: string description: Assign IPv6 address example: 2001:a0:64::20/64 dhcpClient: type: boolean description: Enable DHCP example: false default: false dhcpDistance: maximum: 65536 minimum: 1 type: integer description: Set administrative distance for DHCP default route format: int32 example: 1 default: 1 dhcpRapidCommit: type: boolean description: Enable DHCPv6 rapid commit example: false default: false description: IPv6 address or DHCP $$ref: '#/components/schemas/Ipv6Config' shutdown: type: boolean description: Administrative state example: false default: false tunnelInterface: type: object properties: allowService: type: object properties: all: type: boolean description: Allow all traffic. Overrides all other allow-service options if allow-service all is set example: false default: false dhcp: type: boolean description: Allow/Deny DHCP example: true default: true dns: type: boolean description: Allow/Deny DNS example: true default: true icmp: type: boolean description: Allow/Deny ICMP example: true default: true netconf: type: boolean description: Allow/Deny NETCONF example: false default: false ntp: type: boolean description: Allow/Deny NTP example: false default: false sshd: type: boolean description: Allow/Deny SSH example: false default: false stun: type: boolean description: Allow/Deny STUN example: false default: false description: Set services allowed on the WAN interface $$ref: '#/components/schemas/AllowService' color: type: object properties: value: type: string description: Set color for TLOC example: default enum: - default - mpls - metro-ethernet - biz-internet - public-internet - lte - 3g - red - green - blue - gold - silver - bronze - custom1 - custom2 - custom3 - private1 - private2 - private3 - private4 - private5 - private6 default: default description: Set color for TLOC $$ref: '#/components/schemas/Color' description: Tunnel interface configuration $$ref: '#/components/schemas/TunnelInterface' description: Interfaces configuration $$ref: '#/components/schemas/TransportInterfaceSetting' ipRoute: type: object properties: route: type: array items: required: - nextHop - prefix type: object properties: nextHop: maxItems: 2147483647 minItems: 1 type: array items: required: - address type: object properties: address: pattern: ^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$ type: string description: IPv4 Address example: 10.0.0.1 distance: maximum: 255 minimum: 1 type: integer description: Administrative distance format: int32 example: 1 default: 1 description: IP gateway address $$ref: '#/components/schemas/NextHop' prefix: pattern: ^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\/)([0-2]?[0-9]$|[3]?[0-2])$ type: string description: IPv4 Prefix example: 0.0.0.0/0 description: Configure static routes $$ref: '#/components/schemas/StaticRoute' description: IP Route information $$ref: '#/components/schemas/IpRoute' ipv6Route: type: object properties: route: type: array items: required: - nextHop - prefix type: object properties: nextHop: maxItems: 2147483647 minItems: 1 type: array items: required: - address type: object properties: address: pattern: (([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)) type: string description: IPv6 Address example: 2001::1 distance: maximum: 255 minimum: 1 type: integer description: Administrative distance format: int32 example: 1 default: 1 description: IP gateway address $$ref: '#/components/schemas/IPV6NextHop' prefix: pattern: ((^\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:)))(%.+)?\s*(\/)(\b([0-9]{1,2}|1[01][0-9]|12[0-8])\b)$)) type: string description: IPv6 Prefix example: 2001::/4 description: Configure IPv6 static routes $$ref: '#/components/schemas/Ipv6StaticRoute' description: IPv6 Route information $$ref: '#/components/schemas/Ipv6Route' description: Transport VPN instance $$ref: '#/components/schemas/baseVpnInstanceTransportInterfaceSetting' description: Validator VPN setting $$ref: '#/components/schemas/ValidatorVpnSetting' description: The payload for validator device specific settings $$ref: '#/components/schemas/ValidatorDeviceSpecificSetting' $$ref: '#/components/schemas/QueryValidatorDeviceSpecificSettingsResponse' examples: AutoGeneratedControllerDeviceSpecificSettings: description: AutoGeneratedControllerDeviceSpecificSettings value: createdBy: admin createdOn: 1741315339238 lastUpdatedBy: admin lastUpdatedOn: 1741315439238 payload: system: systemIp: 172.16.255.20 hostName: Controller01 description: Controller 1 siteId: 200 location: Shang hai systemTunnelMtu: 2000 gpsLocation: latitude: 90 longitude: 180 clock: timezone: Europe/Andorra deviceGroups: - group1 overlayId: 3 ipv6StrictControl: true controllerGroupId: 1 vpn: transport: ipRoute: route: - prefix: 0.0.0.0/0 nextHop: - address: 10.0.12.13 distance: 1 ipv6Route: route: - prefix: ::/0 nextHop: - address: 2001:a0:c::d interface: - ifName: eth0 ip: address: 10.0.1.30/24 ipv6: address: 2001:a0:1::1e/64 shutdown: false - ifName: eth1 ip: address: 10.0.12.20/24 ipv6: address: 2001:a0:c::14/64 tunnelInterface: allowService: all: true dhcp: true dns: true icmp: true sshd: false netconf: false ntp: false stun: false shutdown: false management: interface: - ifName: eth2 ip: address: 10.2.2.20/24 ipv6: address: 2001:a2:2::14/64 shutdown: false $$ref: '#/components/examples/ComViptelaVmanageServerDeviceconfigControlcomponentSettingResponseExampleQuerycontrollerdevicespecificsettings' AutoGeneratedValidatorDeviceSpecificSettings: description: AutoGeneratedValidatorDeviceSpecificSettings value: createdBy: admin createdOn: 1741315339238 lastUpdatedBy: admin lastUpdatedOn: 1741315439238 payload: system: systemIp: 172.16.255.19 hostName: Validator01 description: validator 1 siteId: 100 location: Shang hai gpsLocation: latitude: 90 longitude: 180 clock: timezone: Europe/Andorra deviceGroups: - group1 vbond: address: 10.0.1.26 vpn: transport: ipRoute: route: - prefix: 0.0.0.0/0 nextHop: - address: 10.0.5.13 distance: 1 ipv6Route: route: - prefix: ::/0 nextHop: - address: 2001:a0:5::d interface: - ifName: eth0 ip: address: 10.0.1.19/24 ipv6: address: 2001:a0:1::13/64 shutdown: false - ifName: eth1 ip: address: 10.0.5.19/24 ipv6: address: 2001:a0:5::13/64 shutdown: false - ifName: eth3 ip: address: 10.1.15.19/24 ipv6: address: 2001:a1:f::13/64 shutdown: false management: interface: - ifName: eth2 ip: address: 10.2.2.19/24 ipv6: address: 2001:a2:2::13/64 shutdown: false $$ref: '#/components/examples/ComViptelaVmanageServerDeviceconfigControlcomponentSettingResponseExampleQueryvalidatordevicespecificsettings' AutoGeneratedManagerDeviceSpecificSettings: description: AutoGeneratedManagerDeviceSpecificSettings value: createdBy: admin createdOn: 1743658574232 payload: system: systemIp: 172.16.255.22 hostName: Manager01 clock: timezone: UTC siteId: 200 ipv6StrictControl: false vpn: transport: ipRoute: route: - prefix: 0.0.0.0/0 nextHop: - address: 10.0.12.13 distance: 1 interface: - ifName: eth0 ip: dhcpClient: true dhcpDistance: 1 ipv6: dhcpClient: true dhcpDistance: 1 dhcpRapidCommit: false shutdown: false - ifName: eth1 ip: address: 10.0.12.22/24 shutdown: false tunnelInterface: color: value: default allowService: all: false dhcp: true dns: true icmp: true sshd: false netconf: false ntp: false stun: false - ifName: eth2 ip: address: 10.0.5.22/24 shutdown: false - ifName: eth5 ip: address: 10.0.105.32/24 shutdown: false management: interface: - ifName: eth3 ip: address: 10.2.4.22/24 shutdown: false $$ref: '#/components/examples/ComViptelaVmanageServerDeviceconfigControlcomponentSettingResponseExampleQuerymanagerdevicespecificsettings' '400': description: Bad Request content: application/json: schema: required: - error type: object properties: error: required: - code - details - message - type type: object properties: code: type: string description: Internal error code example: CCS0018 details: type: string description: Error message detail example: Unrecognized field user1 message: type: string description: Error message summary example: Invalid control component setting payload type: type: string description: Error message title example: error description: Error response $$ref: '#/components/schemas/ErrorDetails' $$ref: '#/components/schemas/ErrorResponse' examples: InvalidControlComponentDeviceId: description: InvalidControlComponentDeviceId value: error: message: Invalid control component device ID, only support controller,validator and manager code: CCS0010 details: Device 73a7730e-9d48-463a-8c7f-924f6edd951c is not existed type: error $$ref: '#/components/examples/ComViptelaVmanageServerDeviceconfigControlcomponentSettingResponseExampleInvalidcontrolcomponentdeviceidresponse' '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Control Component Settings-write /v1/control-component/devices/{deviceId}/settings/preview: get: tags: - Configuration - Control Component Setting description: Preview the CLI configuration for a specific control component. The deviceId can be obtained from the "uuid" field in the data returned by the API (GET /dataservice/certificate/data/controller/list) operationId: getPreviewCliForControlComponent parameters: - name: deviceId in: path description: Control component device UUID required: true schema: type: string format: uuid responses: '200': description: Success content: application/json: schema: required: - attachedConfig - newConfig type: object properties: attachedConfig: type: string description: Current running config CLI for specific control component example: "system\n pseudo-confirm-commit 300\n host-name Controller01" newConfig: type: string description: Generated intent config CLI for specific control component example: "system\n pseudo-confirm-commit 300\n host-name Controller01" $$ref: '#/components/schemas/ControlComponentPreviewCliResponse' '400': description: Bad Request content: application/json: schema: required: - error type: object properties: error: required: - code - details - message - type type: object properties: code: type: string description: Internal error code example: CCS0018 details: type: string description: Error message detail example: Unrecognized field user1 message: type: string description: Error message summary example: Invalid control component setting payload type: type: string description: Error message title example: error description: Error response $$ref: '#/components/schemas/ErrorDetails' $$ref: '#/components/schemas/ErrorResponse' examples: InvalidControlComponentDeviceId: description: InvalidControlComponentDeviceId value: error: message: Invalid control component device ID, only support controller,validator and manager code: CCS0010 details: Device 73a7730e-9d48-463a-8c7f-924f6edd951c is not existed type: error $$ref: '#/components/examples/ComViptelaVmanageServerDeviceconfigControlcomponentSettingResponseExampleInvalidcontrolcomponentdeviceidresponse' '403': description: Forbidden '404': description: Not Found content: application/json: schema: required: - error type: object properties: error: required: - code - details - message - type type: object properties: code: type: string description: Internal error code example: CCS0018 details: type: string description: Error message detail example: Unrecognized field user1 message: type: string description: Error message summary example: Invalid control component setting payload type: type: string description: Error message title example: error description: Error response $$ref: '#/components/schemas/ErrorDetails' $$ref: '#/components/schemas/ErrorResponse' examples: PreviewFailedForSettingsNotConfigured: description: PreviewFailedForSettingsNotConfigured value: error: message: Did not find the network settings for any control components code: CCS0005 details: Control component common settings are not configured type: error $$ref: '#/components/examples/ComViptelaVmanageServerDeviceconfigControlcomponentSettingResponseExampleGetcommonsettingsnotfoundresponse' '500': description: Internal Server Error x-roles-required: Control Component Settings-read /v1/control-component/network-settings: get: tags: - Configuration - Control Component Setting description: Get the network settings for all control components operationId: getControlComponentCommonSettings responses: '200': description: Success content: application/json: schema: required: - createdBy - createdOn - payload type: object properties: createdBy: type: string description: The user who created the control component common settings example: admin createdOn: type: integer description: The timestamp when control component common settings are created format: int64 example: 1741315339238 lastUpdatedBy: type: string description: The user who modified the control component common settings example: admin lastUpdatedOn: type: integer description: The timestamp when control component settings are modified format: int64 example: 1741315339240 payload: required: - aaa - ntp type: object properties: aaa: required: - authOrder - user type: object properties: accounting: type: boolean description: Enable/disable user accounting example: false default: false adminAuthOrder: type: boolean description: Authenticate admin user as per auth-order example: false default: false authFallback: type: boolean description: Fall back if higher-priority authentication fails example: false default: false authOrder: maxItems: 3 minItems: 1 uniqueItems: true type: array items: type: string description: Authentication order list example: local enum: - local - radius - tacacs ciscoTacRoUser: type: boolean description: Cisco Tac Enable Read only default: true ciscoTacRwUser: type: boolean description: Cisco Tac Enable Read and Write default: true logs: type: object properties: auditDisable: type: boolean description: Disable audit logs default: false netconfDisable: type: boolean description: Disable Netconf logs default: false description: Enable/Disable audit or netconf logs $$ref: '#/components/schemas/AaaLogs' radius: type: object properties: retransmit: maximum: 1000 minimum: 1 type: integer description: Configure how many times to contact each RADIUS server format: int32 example: 3 default: 3 server: maxItems: 8 minItems: 0 type: array description: RADIUS server configuration items: required: - address - secretKey type: object properties: acctPort: maximum: 65535 minimum: 0 type: integer description: Accounting Port format: int32 example: 1813 default: 1813 address: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: Set IP address of RADIUS server example: 1.2.2.2 authPort: maximum: 65535 minimum: 0 type: integer description: Authentication Port format: int32 example: 1812 default: 1812 priority: maximum: 7 minimum: 0 type: integer description: Priority format: int32 example: 1 default: 0 secretKey: pattern: ^(?:\$CRYPT\$.{17}|(?!(?:\$CRYPT\$)).{1,128})$ type: string description: Secret key example: password tag: maxLength: 16 minLength: 4 pattern: ^[a-zA-Z0-9\-_]*$ type: string description: Reference tag/name for the server example: radius-server1 vpn: type: integer description: VPN ID format: int32 example: 0 enum: - 0 - 512 default: 0 description: Configure the RADIUS server $$ref: '#/components/schemas/ControlComponentAaaRadiusServer' timeout: maximum: 1000 minimum: 1 type: integer description: Configure how long to wait for replies from the RADIUS server format: int32 example: 5 default: 5 description: Radius configuration $$ref: '#/components/schemas/Radius' radiusServers: uniqueItems: true type: array items: type: string description: Designate radius server tags for authentication and accounting example: radius-tag1 tacacs: type: object properties: authentication: type: string description: TACACS authentication type enum: - pap - ascii default: pap servers: maxItems: 8 minItems: 0 type: array description: List of TACACS servers items: required: - address - secretKey type: object properties: acctPort: maximum: 65535 minimum: 0 type: integer description: Accounting Port format: int32 default: 49 address: type: string description: Set IP address of TACACS server example: 1.2.2.2 authPort: maximum: 65535 minimum: 0 type: integer description: Authentication Port format: int32 default: 49 priority: maximum: 7 minimum: 0 type: integer description: TACACS server priority <0..7> format: int32 example: 1 default: 0 secretKey: pattern: ^(?:\$CRYPT\$.{17}|(?!(?:\$CRYPT\$)).{1,128})$ type: string description: TACACS server password example: Password123 vpn: type: integer description: VPN ID format: int32 example: 0 enum: - 0 - 512 default: 0 description: Configure the TACACS server $$ref: '#/components/schemas/TacacsServer' timeout: maximum: 1000 minimum: 1 type: integer description: Configure how long to wait for replies from the TACACS server format: int32 default: 5 description: TACACS configuration $$ref: '#/components/schemas/Tacacs' user: maxItems: 2147483647 minItems: 1 type: array description: Create local login account items: required: - name - password type: object properties: name: maxLength: 128 minLength: 1 pattern: ^(?!(?:root|daemon|bin|sys|sync|games|man|lp|mail|news|uucp|proxy|www-data|backup|list|irc|gnats|nobody|basic|sshd|quagga|vmanage-admin|vmanage|viptela-reserved)$)[a-z][a-z0-9._-]*$ type: string description: User name example: admin password: pattern: ^(?:\$CRYPT\$.{17}|(?!(?:\$CRYPT\$)).{1,128})$ type: string description: User password, either a encrypted string starting with $CRYPT$, or a clear text string of length 1–128 example: password userGroup: type: string description: User group name which user belongs to example: netadmin enum: - basic - operator - netadmin description: Create local login account $$ref: '#/components/schemas/AaaLocalUser' description: Configure local users, TACACS or RADIUS servers for control components $$ref: '#/components/schemas/ControlComponentAaaSetting' banner: required: - enableFeature type: object properties: enableFeature: type: boolean description: Enable Banner feature or not default: false loginMessage: maxLength: 2048 minLength: 1 type: string description: Set message to display before login prompt example: Hello user motdMessage: maxLength: 2048 minLength: 1 type: string description: Set message to display after a user logs in example: Hello description: Banner configuration $$ref: '#/components/schemas/ControlComponentBannerSetting' controller: type: object properties: hubSpokeTopology: type: boolean description: Hub & spoke topology default: false omp: type: object properties: controllerSendPathLimit: maximum: 128 minimum: 4 type: integer description: Limit number of paths sent to vSmart controller for a prefix format: int32 example: 20 discardRejected: type: boolean description: Enable/Disable storage of information rejected by policy example: false default: false filterRoute: required: - outbound type: object properties: outbound: type: object properties: affinityGroupPreference: type: boolean description: Filter routes based on affinity preference list example: false default: false tlocColor: type: boolean description: Filter routes based on TLOC color compatibility list example: false default: false $$ref: '#/components/schemas/Outbound' description: OMP filter route configuration $$ref: '#/components/schemas/OmpFilterRoute' gracefulRestart: type: boolean description: Enable/Disable graceful restart example: true default: true outboundPolicyCaching: type: boolean sendBackupPaths: type: boolean description: Enable/Disable transmission of backup paths example: false default: false shutdown: type: boolean description: Enable/disable OMP example: false default: false timers: type: object properties: advertisementInterval: maximum: 65535 minimum: 0 type: integer description: Advertisement Interval (seconds), set the time between OMP Update packets format: int32 example: 1 default: 1 eorTimer: maximum: 3600 minimum: 1 type: integer description: End of RIB timer, in seconds format: int32 example: 300 default: 300 gracefulRestartTimer: maximum: 31556952 minimum: 1 type: integer description: Graceful restart timer, in seconds format: int32 example: 43200 default: 43200 holdTime: maximum: 65535 minimum: 0 type: integer description: Hold Time(Seconds), Set how long to wait before closing OMP peer connection format: int32 example: 300 default: 300 description: OMP timers $$ref: '#/components/schemas/OmpTimers' description: Controller OMP configuration $$ref: '#/components/schemas/OmpSetting' tlocColorCompatibility: type: object properties: compatible: uniqueItems: true type: array items: required: - color1 - color2 type: object properties: color1: type: string description: First TLOC color in comparsion enum: - default - mpls - metro-ethernet - biz-internet - public-internet - lte - 3g - red - green - blue - gold - silver - bronze - custom1 - custom2 - custom3 - private1 - private2 - private3 - private4 - private5 - private6 color2: type: string description: Second TLOC color in comparsion enum: - default - mpls - metro-ethernet - biz-internet - public-internet - lte - 3g - red - green - blue - gold - silver - bronze - custom1 - custom2 - custom3 - private1 - private2 - private3 - private4 - private5 - private6 description: List of Incompatible TLOC colors $$ref: '#/components/schemas/Compatible' incompatible: uniqueItems: true type: array items: required: - color1 - color2 type: object properties: color1: type: string description: First TLOC color in comparsion enum: - default - mpls - metro-ethernet - biz-internet - public-internet - lte - 3g - red - green - blue - gold - silver - bronze - custom1 - custom2 - custom3 - private1 - private2 - private3 - private4 - private5 - private6 color2: type: string description: Second TLOC color in comparsion enum: - default - mpls - metro-ethernet - biz-internet - public-internet - lte - 3g - red - green - blue - gold - silver - bronze - custom1 - custom2 - custom3 - private1 - private2 - private3 - private4 - private5 - private6 description: List of Incompatible TLOC colors $$ref: '#/components/schemas/Compatible' description: List of compatible/incompatible TLOC colors for BFD session formation $$ref: '#/components/schemas/TlocColorCompatibility' description: Controller fabric OMP and system settings $$ref: '#/components/schemas/ControllerFabricSetting' dns: type: object properties: dnsServerPrimary: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: Primary DNS server IPv4 or IPv6 Address example: 10.2.2.2 dnsServerSecondary: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: Secondary DNS server IPv4 or IPv6 Address example: 10.2.2.3 host: type: array items: required: - hostname - ip type: object properties: hostname: pattern: ^[a-zA-Z0-9\-_.]{1,64}$ type: string description: Host name example: vbond ip: maxItems: 64 minItems: 1 uniqueItems: true type: array items: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: IP Address example: 10.1.1.1 description: Static host mapping $$ref: '#/components/schemas/DnsHostMapping' description: Configure DNS servers or static host mapping $$ref: '#/components/schemas/ControlComponentDnsSetting' logging: required: - enableFeature type: object properties: enableFeature: type: boolean description: Enable Logging feature or not default: false server: maxItems: 4 minItems: 0 type: array description: Configure logging servers(Maximum 4 servers) items: required: - name type: object properties: enableTlsTransport: type: boolean description: Enable TLS transport, otherwise UDP as transport default: true name: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))|((?=.{1,253}$)((([a-zA-Z0-9_]([a-zA-Z0-9\-_]){0,61})?[a-zA-Z0-9]\.)*([a-zA-Z0-9_]([a-zA-Z0-9\-_]){0,61})?[a-zA-Z0-9]\.?)|\.) type: string description: Set hostname, IPv4 address or IPv6 address for the server example: 1.2.2.3 vpnId: type: integer description: VPN ID format: int32 example: 0 enum: - 0 - 512 default: 0 description: Logging Server $$ref: '#/components/schemas/LoggingServer' description: Logging feature for control components $$ref: '#/components/schemas/ControlComponentLoggingSetting' managementDns: type: object properties: dnsServerPrimary: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: Primary DNS server IPv4 or IPv6 Address example: 10.2.2.2 dnsServerSecondary: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: Secondary DNS server IPv4 or IPv6 Address example: 10.2.2.3 host: type: array items: required: - hostname - ip type: object properties: hostname: pattern: ^[a-zA-Z0-9\-_.]{1,64}$ type: string description: Host name example: vbond ip: maxItems: 64 minItems: 1 uniqueItems: true type: array items: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: IP Address example: 10.1.1.1 description: Static host mapping $$ref: '#/components/schemas/DnsHostMapping' description: Configure DNS servers or static host mapping $$ref: '#/components/schemas/ControlComponentDnsSetting' ntp: required: - server type: object properties: server: maxItems: 4 minItems: 1 type: array description: NTP Server (up to 4) items: required: - name type: object properties: authenticationKey: maxLength: 2147483647 minLength: 1 type: string description: Value of the CMAC AES-128 authentication key example: '123456' name: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))|((?=.{1,253}$)((([a-zA-Z0-9_]([a-zA-Z0-9\-_]){0,61})?[a-zA-Z0-9]\.)*([a-zA-Z0-9_]([a-zA-Z0-9\-_]){0,61})?[a-zA-Z0-9]\.?)|\.) type: string description: Set hostname or IP address of server example: 1.2.2.3 prefer: type: boolean description: Prefer this NTP server example: false default: false vpnId: type: integer description: VPN ID format: int32 example: 0 enum: - 0 - 512 default: 0 description: NTP Server for control components $$ref: '#/components/schemas/NtpServer' description: NTP setting for control components $$ref: '#/components/schemas/ControlComponentNtpSetting' security: required: - protocol type: object properties: protocol: type: string description: Control connection protocol, default is DTLS example: dtls enum: - dtls - tls default: dtls tlsPort: maximum: 65535 minimum: 1025 type: integer description: TLS port, cannot coexist with protocol(DTLS) format: int32 example: 23456 default: 23456 description: Security configuration for control components $$ref: '#/components/schemas/ControlComponentSecuritySetting' snmp: required: - enableFeature type: object properties: contact: maxLength: 255 minLength: 1 type: string description: Set the contact for this managed node example: PaM-2nd-Level@telekom.de enableFeature: type: boolean description: Enable or disable SNMP example: false default: false location: maxLength: 255 minLength: 1 type: string description: Set the physical location of this managed node example: Cisco Cloud - AWS-FRA name: maxLength: 255 minLength: 1 type: string description: Set the assigned name for this managed node example: vManage-01-FRA version: type: string description: SNMP version(v2 or v3) example: v3 enum: - v2 - v3 default: v3 versionSpecificData: type: object description: SNMP configuration oneOf: - required: - community - view type: object properties: community: maxItems: 2147483647 minItems: 1 type: array description: SNMPv2 community configuration items: required: - name - tag - view type: object properties: name: pattern: ^(?:\$CRYPT\$.{17}|(?!(?:\$CRYPT\$))[\S]{1,})$ type: string description: Set name of the SNMP community example: community_test tag: pattern: ^(?=.{1,32}$)([^<>]*)$ type: string description: Set alias name for SNMP community example: test view: pattern: ^(?=.{1,32}$)([^<>]*)$ type: string description: SNMP view name example: test description: SNMPv2 community $$ref: '#/components/schemas/Snmpv2Community' trap: required: - group - target type: object properties: group: maxItems: 8 minItems: 0 type: array description: SNMPv2 trap groups items: required: - enable - groupName type: object properties: enable: maxItems: 2147483647 minItems: 1 type: array description: Trap module configuration items: required: - level - module type: object properties: level: maxItems: 3 minItems: 1 uniqueItems: true type: array items: type: string description: Trap level example: critical enum: - critical - major - minor module: type: string description: SNMP trap module name example: all enum: - all - app-route - bfd - control - dhcp - hardware - omp - routing - security - system - vpn - bridge - policy - wwan description: Enable SNMP trap modules $$ref: '#/components/schemas/SnmpTrapModule' groupName: pattern: ^(?=.{1,32}$)([^<>]*)$ type: string description: Trap group name example: trapGroup1 description: SNMPv3 trap groups $$ref: '#/components/schemas/TrapGroup' target: type: array description: SNMPv2 target configuration items: required: - communityTag - groupName - ip - port - vpnId type: object properties: communityTag: pattern: ^(?=.{1,32}$)([^<>]*)$ type: string description: Port number example: COMMUNITY_TEST groupName: pattern: ^(?=.{1,32}$)([^<>]*)$ type: string description: SNMPv3 group name example: group1 ip: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: IPv4 or IPv6 address example: 1.1.1.3 port: maximum: 65535 minimum: 1 type: integer description: Set UDP port number to connect to SNMP server format: int32 example: 13212 vpnId: type: integer description: VPN ID format: int32 example: 0 enum: - 0 - 512 description: SNMPv2 Target server configuration $$ref: '#/components/schemas/Snmpv2Target' description: SNMPv2 trap configuration $$ref: '#/components/schemas/Snmpv2Trap' view: maxItems: 2147483647 minItems: 1 type: array description: SNMPv2 view configuration items: required: - name type: object properties: name: pattern: ^(?=.{1,32}$)([^<>]*)$ type: string description: SNMP view name oid: type: array description: Configure SNMP object identifier items: required: - id type: object properties: exclude: type: boolean description: Exclude the OID or not example: false default: false id: pattern: (([0-1](\.[1-3]?[0-9]))|(2\.(0|([1-9]\d*))))(\.(0|\*|([1-9]\d*))){0,126} type: string description: Configure identifier of subtree of MIB objects example: 2.1.1.11.1 description: SNMP OID configuration $$ref: '#/components/schemas/SnmpOID' description: SNMP view configuration $$ref: '#/components/schemas/SnmpView' description: SNMPv2 configuration $$ref: '#/components/schemas/SNMPv2Data' - required: - group - user - view type: object properties: group: maxItems: 2147483647 minItems: 1 type: array description: SNMPv3 group configuration items: required: - name - securityLevel - view type: object properties: name: pattern: ^(?=.{1,32}$)([^<>]*)$ type: string description: SNMP group name example: group securityLevel: type: string description: Security Level example: auth-priv enum: - no-auth-no-priv - auth-priv view: pattern: ^(?=.{1,32}$)([^<>]*)$ type: string description: View name example: view1 description: SNMPv3 group configuration $$ref: '#/components/schemas/Snmpv3Group' trap: required: - group - target type: object properties: group: maxItems: 8 minItems: 0 type: array description: SNMPv3 trap groups items: required: - enable - groupName type: object properties: enable: maxItems: 2147483647 minItems: 1 type: array description: Trap module configuration items: required: - level - module type: object properties: level: maxItems: 3 minItems: 1 uniqueItems: true type: array items: type: string description: Trap level example: critical enum: - critical - major - minor module: type: string description: SNMP trap module name example: all enum: - all - app-route - bfd - control - dhcp - hardware - omp - routing - security - system - vpn - bridge - policy - wwan description: Enable SNMP trap modules $$ref: '#/components/schemas/SnmpTrapModule' groupName: pattern: ^(?=.{1,32}$)([^<>]*)$ type: string description: Trap group name example: trapGroup1 description: SNMPv3 trap groups $$ref: '#/components/schemas/TrapGroup' target: type: array description: SNMPv3 target configuration items: required: - groupName - ip - port - user - vpnId type: object properties: groupName: pattern: ^(?=.{1,32}$)([^<>]*)$ type: string description: SNMPv3 group name example: group1 ip: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: IPv4 or IPv6 address example: 1.1.1.3 port: maximum: 65535 minimum: 1 type: integer description: Set UDP port number to connect to SNMP server format: int32 example: 13212 user: pattern: ^(?=.{1,32}$)([^<>]*)$ type: string description: SNMPv3 user name example: test1 vpnId: type: integer description: VPN ID format: int32 example: 0 enum: - 0 - 512 default: 0 description: SNMPv3 target configuration $$ref: '#/components/schemas/Snmpv3Target' description: SNMPv3 trap configuration $$ref: '#/components/schemas/Snmpv3Trap' user: maxItems: 2147483647 minItems: 1 type: array description: SNMPv3 user configuration items: required: - group - name type: object properties: authPassword: pattern: ^(?:\$CRYPT\$.{17}|(?!(?:\$CRYPT\$)).{8,128})$ type: string description: Authentication password, either a encrypt string starting with $CRYPT$, or a clear text string of length 8 to 128 example: authPassword group: pattern: ^(?=.{1,32}$)([^<>]*)$ type: string description: SNMP group name example: group1 name: pattern: ^(?=.{1,32}$)([^<>]*)$ type: string description: SNMPv3 User name example: user1 privPassword: pattern: ^(?:\$CRYPT\$.{17}|(?!(?:\$CRYPT\$)).{8,128})$ type: string description: Privilege password, either a encrypt string starting with $CRYPT$, or a clear text string of length 8 to 128 example: privPassword description: SNMPv3 user $$ref: '#/components/schemas/SNMPv3User' view: maxItems: 2147483647 minItems: 1 type: array description: SNMPv3 view configuration items: required: - name type: object properties: name: pattern: ^(?=.{1,32}$)([^<>]*)$ type: string description: SNMP view name oid: type: array description: Configure SNMP object identifier items: required: - id type: object properties: exclude: type: boolean description: Exclude the OID or not example: false default: false id: pattern: (([0-1](\.[1-3]?[0-9]))|(2\.(0|([1-9]\d*))))(\.(0|\*|([1-9]\d*))){0,126} type: string description: Configure identifier of subtree of MIB objects example: 2.1.1.11.1 description: SNMP OID configuration $$ref: '#/components/schemas/SnmpOID' description: SNMP view configuration $$ref: '#/components/schemas/SnmpView' description: SNMPv3 configuration $$ref: '#/components/schemas/SNMPv3Data' $$ref: '#/components/schemas/SnmpVersionSpecificData' description: SNMP setting $$ref: '#/components/schemas/ControlComponentSnmpSetting' description: Configure network level features for all control components $$ref: '#/components/schemas/ControlComponentNetworkSettings' $$ref: '#/components/schemas/QueryCommonSettingsResponse' examples: QueryControlComponentNetworkCommonSettingsExample: description: QueryControlComponentNetworkCommonSettingsExample value: createdBy: admin createdOn: 1741315339238 lastUpdatedBy: admin lastUpdatedOn: 1741317690674 payload: ntp: server: - name: 1.1.1.1 vpnId: 0 prefer: true - name: 2002::1 vpnId: 0 prefer: false - name: time.google.com vpnId: 0 prefer: false - name: 2.1.1.1 vpnId: 0 prefer: false aaa: authOrder: - local - radius - tacacs radiusServers: - radius1 - radius2 authFallback: true adminAuthOrder: true accounting: true user: - name: admin password: $CRYPT$LlBMcwaztmurYKfN/ - name: xx password: $CRYPT$hy1nRjYaA4mqsTgLU userGroup: netadmin ciscoTacRoUser: false ciscoTacRwUser: false tacacs: timeout: 232 authentication: ascii servers: - address: 1.1.1.1 authPort: 32200 acctPort: 1200 vpn: 0 secretKey: $CRYPT$ZrYAwz9pB8WOkW+gj priority: 2 - address: 2002::1 authPort: 321 acctPort: 232 vpn: 0 secretKey: $CRYPT$vgNok88PqemwCW0mX priority: 3 radius: timeout: 32 retransmit: 12 server: - address: 1.1.1.1 authPort: 1232 acctPort: 12312 tag: radius1 vpn: 0 secretKey: $CRYPT$9DvMb0HTJkPsW+ryY priority: 1 - address: 3.3.3.3 authPort: 1234 acctPort: 123 tag: radius2 vpn: 0 secretKey: $CRYPT$Wyt41hQUJ4bZ1pEb6 priority: 2 logs: auditDisable: true netconfDisable: true security: protocol: dtls controller: omp: shutdown: false controllerSendPathLimit: 10 filterRoute: outbound: affinityGroupPreference: false tlocColor: false sendBackupPaths: false discardRejected: false gracefulRestart: true timers: holdTime: 3200 advertisementInterval: 1 gracefulRestartTimer: 110 eorTimer: 200 tlocColorCompatibility: compatible: - color1: mpls color2: default - color1: biz-internet color2: gold incompatible: - color1: lte color2: default - color1: 3g color2: gold dns: dnsServerPrimary: 2.2.2.2 dnsServerSecondary: 3.3.3.3 host: - hostname: vbond ip: - 10.0.12.26 - 2001:a0:c::1a banner: enableFeature: true loginMessage: hello motdMessage: hello logging: server: - name: 3002::1 vpnId: 0 - name: 3.3.32.2 vpnId: 0 - name: adas1.com.sd vpnId: 0 enableFeature: true snmp: version: v2 contact: PaM-2nd-Level@telekom.de name: vManage-01-FRA location: Cisco Cloud - AWS-FRA versionSpecificData: view: - name: xx oid: - id: 1.2.2.2.2 exclude: true - id: 2.2.1.13.2 exclude: false - name: yy oid: - id: 1.4.2.2.2 community: - name: $CRYPT$/gP0oCyfJrtcopHSG tag: test1 view: xx - name: $CRYPT$tB7e6QTIUrMRq5vP5 tag: test2 view: yy trap: target: - vpnId: 0 ip: 2.2.2.2 port: 23 communityTag: test1 groupName: trap-group1 - vpnId: 0 ip: 3.2.2.2 port: 12312 communityTag: test2 groupName: trap-group1 group: - groupName: trap-group1 enable: - module: all level: - critical - module: bfd level: - major - module: control level: - critical - module: dhcp level: - minor enableFeature: true $$ref: '#/components/examples/ComViptelaVmanageServerDeviceconfigControlcomponentSettingResponseExampleQuerycommonsettings' '400': description: Bad Request '403': description: Forbidden '404': description: Not Found content: application/json: schema: required: - error type: object properties: error: required: - code - details - message - type type: object properties: code: type: string description: Internal error code example: CCS0018 details: type: string description: Error message detail example: Unrecognized field user1 message: type: string description: Error message summary example: Invalid control component setting payload type: type: string description: Error message title example: error description: Error response $$ref: '#/components/schemas/ErrorDetails' $$ref: '#/components/schemas/ErrorResponse' examples: GetCommonSettingsNotFound: description: GetCommonSettingsNotFound value: error: message: Did not find the network settings for any control components code: CCS0005 details: Control component common settings are not configured type: error $$ref: '#/components/examples/ComViptelaVmanageServerDeviceconfigControlcomponentSettingResponseExampleGetcommonsettingsnotfoundresponse' '500': description: Internal Server Error x-roles-required: Control Component Settings-read delete: tags: - Configuration - Control Component Setting description: Delete the network settings for all control components operationId: deleteControlComponentCommonSettings responses: '200': description: Success '400': description: Bad Request content: application/json: schema: required: - error type: object properties: error: required: - code - details - message - type type: object properties: code: type: string description: Internal error code example: CCS0018 details: type: string description: Error message detail example: Unrecognized field user1 message: type: string description: Error message summary example: Invalid control component setting payload type: type: string description: Error message title example: error description: Error response $$ref: '#/components/schemas/ErrorDetails' $$ref: '#/components/schemas/ErrorResponse' examples: DeleteControlComponentCommonSettingsFailed: description: DeleteControlComponentCommonSettingsFailed value: error: message: Failed to delete network settings for all control components code: CCS0003 details: Control component common settings are not allowed to be removed now, since settings are already deployed to some control components, retry it after all control components are not managed by setting mode type: error $$ref: '#/components/examples/ComViptelaVmanageServerDeviceconfigControlcomponentSettingResponseExampleDeletecommonsettingsfailedresponse' '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Control Component Settings-write post: tags: - Configuration - Control Component Setting description: Create the network settings for all control components operationId: createControlComponentCommonSettings requestBody: description: Network settings for all control components content: application/json: schema: required: - aaa - ntp type: object properties: aaa: required: - authOrder - user type: object properties: accounting: type: boolean description: Enable/disable user accounting example: false default: false adminAuthOrder: type: boolean description: Authenticate admin user as per auth-order example: false default: false authFallback: type: boolean description: Fall back if higher-priority authentication fails example: false default: false authOrder: maxItems: 3 minItems: 1 uniqueItems: true type: array items: type: string description: Authentication order list example: local enum: - local - radius - tacacs ciscoTacRoUser: type: boolean description: Cisco Tac Enable Read only default: true ciscoTacRwUser: type: boolean description: Cisco Tac Enable Read and Write default: true logs: type: object properties: auditDisable: type: boolean description: Disable audit logs default: false netconfDisable: type: boolean description: Disable Netconf logs default: false description: Enable/Disable audit or netconf logs $$ref: '#/components/schemas/AaaLogs' radius: type: object properties: retransmit: maximum: 1000 minimum: 1 type: integer description: Configure how many times to contact each RADIUS server format: int32 example: 3 default: 3 server: maxItems: 8 minItems: 0 type: array description: RADIUS server configuration items: required: - address - secretKey type: object properties: acctPort: maximum: 65535 minimum: 0 type: integer description: Accounting Port format: int32 example: 1813 default: 1813 address: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: Set IP address of RADIUS server example: 1.2.2.2 authPort: maximum: 65535 minimum: 0 type: integer description: Authentication Port format: int32 example: 1812 default: 1812 priority: maximum: 7 minimum: 0 type: integer description: Priority format: int32 example: 1 default: 0 secretKey: pattern: ^(?:\$CRYPT\$.{17}|(?!(?:\$CRYPT\$)).{1,128})$ type: string description: Secret key example: password tag: maxLength: 16 minLength: 4 pattern: ^[a-zA-Z0-9\-_]*$ type: string description: Reference tag/name for the server example: radius-server1 vpn: type: integer description: VPN ID format: int32 example: 0 enum: - 0 - 512 default: 0 description: Configure the RADIUS server $$ref: '#/components/schemas/ControlComponentAaaRadiusServer' timeout: maximum: 1000 minimum: 1 type: integer description: Configure how long to wait for replies from the RADIUS server format: int32 example: 5 default: 5 description: Radius configuration $$ref: '#/components/schemas/Radius' radiusServers: uniqueItems: true type: array items: type: string description: Designate radius server tags for authentication and accounting example: radius-tag1 tacacs: type: object properties: authentication: type: string description: TACACS authentication type enum: - pap - ascii default: pap servers: maxItems: 8 minItems: 0 type: array description: List of TACACS servers items: required: - address - secretKey type: object properties: acctPort: maximum: 65535 minimum: 0 type: integer description: Accounting Port format: int32 default: 49 address: type: string description: Set IP address of TACACS server example: 1.2.2.2 authPort: maximum: 65535 minimum: 0 type: integer description: Authentication Port format: int32 default: 49 priority: maximum: 7 minimum: 0 type: integer description: TACACS server priority <0..7> format: int32 example: 1 default: 0 secretKey: pattern: ^(?:\$CRYPT\$.{17}|(?!(?:\$CRYPT\$)).{1,128})$ type: string description: TACACS server password example: Password123 vpn: type: integer description: VPN ID format: int32 example: 0 enum: - 0 - 512 default: 0 description: Configure the TACACS server $$ref: '#/components/schemas/TacacsServer' timeout: maximum: 1000 minimum: 1 type: integer description: Configure how long to wait for replies from the TACACS server format: int32 default: 5 description: TACACS configuration $$ref: '#/components/schemas/Tacacs' user: maxItems: 2147483647 minItems: 1 type: array description: Create local login account items: required: - name - password type: object properties: name: maxLength: 128 minLength: 1 pattern: ^(?!(?:root|daemon|bin|sys|sync|games|man|lp|mail|news|uucp|proxy|www-data|backup|list|irc|gnats|nobody|basic|sshd|quagga|vmanage-admin|vmanage|viptela-reserved)$)[a-z][a-z0-9._-]*$ type: string description: User name example: admin password: pattern: ^(?:\$CRYPT\$.{17}|(?!(?:\$CRYPT\$)).{1,128})$ type: string description: User password, either a encrypted string starting with $CRYPT$, or a clear text string of length 1–128 example: password userGroup: type: string description: User group name which user belongs to example: netadmin enum: - basic - operator - netadmin description: Create local login account $$ref: '#/components/schemas/AaaLocalUser' description: Configure local users, TACACS or RADIUS servers for control components $$ref: '#/components/schemas/ControlComponentAaaSetting' banner: required: - enableFeature type: object properties: enableFeature: type: boolean description: Enable Banner feature or not default: false loginMessage: maxLength: 2048 minLength: 1 type: string description: Set message to display before login prompt example: Hello user motdMessage: maxLength: 2048 minLength: 1 type: string description: Set message to display after a user logs in example: Hello description: Banner configuration $$ref: '#/components/schemas/ControlComponentBannerSetting' controller: type: object properties: hubSpokeTopology: type: boolean description: Hub & spoke topology default: false omp: type: object properties: controllerSendPathLimit: maximum: 128 minimum: 4 type: integer description: Limit number of paths sent to vSmart controller for a prefix format: int32 example: 20 discardRejected: type: boolean description: Enable/Disable storage of information rejected by policy example: false default: false filterRoute: required: - outbound type: object properties: outbound: type: object properties: affinityGroupPreference: type: boolean description: Filter routes based on affinity preference list example: false default: false tlocColor: type: boolean description: Filter routes based on TLOC color compatibility list example: false default: false $$ref: '#/components/schemas/Outbound' description: OMP filter route configuration $$ref: '#/components/schemas/OmpFilterRoute' gracefulRestart: type: boolean description: Enable/Disable graceful restart example: true default: true outboundPolicyCaching: type: boolean sendBackupPaths: type: boolean description: Enable/Disable transmission of backup paths example: false default: false shutdown: type: boolean description: Enable/disable OMP example: false default: false timers: type: object properties: advertisementInterval: maximum: 65535 minimum: 0 type: integer description: Advertisement Interval (seconds), set the time between OMP Update packets format: int32 example: 1 default: 1 eorTimer: maximum: 3600 minimum: 1 type: integer description: End of RIB timer, in seconds format: int32 example: 300 default: 300 gracefulRestartTimer: maximum: 31556952 minimum: 1 type: integer description: Graceful restart timer, in seconds format: int32 example: 43200 default: 43200 holdTime: maximum: 65535 minimum: 0 type: integer description: Hold Time(Seconds), Set how long to wait before closing OMP peer connection format: int32 example: 300 default: 300 description: OMP timers $$ref: '#/components/schemas/OmpTimers' description: Controller OMP configuration $$ref: '#/components/schemas/OmpSetting' tlocColorCompatibility: type: object properties: compatible: uniqueItems: true type: array items: required: - color1 - color2 type: object properties: color1: type: string description: First TLOC color in comparsion enum: - default - mpls - metro-ethernet - biz-internet - public-internet - lte - 3g - red - green - blue - gold - silver - bronze - custom1 - custom2 - custom3 - private1 - private2 - private3 - private4 - private5 - private6 color2: type: string description: Second TLOC color in comparsion enum: - default - mpls - metro-ethernet - biz-internet - public-internet - lte - 3g - red - green - blue - gold - silver - bronze - custom1 - custom2 - custom3 - private1 - private2 - private3 - private4 - private5 - private6 description: List of Incompatible TLOC colors $$ref: '#/components/schemas/Compatible' incompatible: uniqueItems: true type: array items: required: - color1 - color2 type: object properties: color1: type: string description: First TLOC color in comparsion enum: - default - mpls - metro-ethernet - biz-internet - public-internet - lte - 3g - red - green - blue - gold - silver - bronze - custom1 - custom2 - custom3 - private1 - private2 - private3 - private4 - private5 - private6 color2: type: string description: Second TLOC color in comparsion enum: - default - mpls - metro-ethernet - biz-internet - public-internet - lte - 3g - red - green - blue - gold - silver - bronze - custom1 - custom2 - custom3 - private1 - private2 - private3 - private4 - private5 - private6 description: List of Incompatible TLOC colors $$ref: '#/components/schemas/Compatible' description: List of compatible/incompatible TLOC colors for BFD session formation $$ref: '#/components/schemas/TlocColorCompatibility' description: Controller fabric OMP and system settings $$ref: '#/components/schemas/ControllerFabricSetting' dns: type: object properties: dnsServerPrimary: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: Primary DNS server IPv4 or IPv6 Address example: 10.2.2.2 dnsServerSecondary: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: Secondary DNS server IPv4 or IPv6 Address example: 10.2.2.3 host: type: array items: required: - hostname - ip type: object properties: hostname: pattern: ^[a-zA-Z0-9\-_.]{1,64}$ type: string description: Host name example: vbond ip: maxItems: 64 minItems: 1 uniqueItems: true type: array items: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: IP Address example: 10.1.1.1 description: Static host mapping $$ref: '#/components/schemas/DnsHostMapping' description: Configure DNS servers or static host mapping $$ref: '#/components/schemas/ControlComponentDnsSetting' logging: required: - enableFeature type: object properties: enableFeature: type: boolean description: Enable Logging feature or not default: false server: maxItems: 4 minItems: 0 type: array description: Configure logging servers(Maximum 4 servers) items: required: - name type: object properties: enableTlsTransport: type: boolean description: Enable TLS transport, otherwise UDP as transport default: true name: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))|((?=.{1,253}$)((([a-zA-Z0-9_]([a-zA-Z0-9\-_]){0,61})?[a-zA-Z0-9]\.)*([a-zA-Z0-9_]([a-zA-Z0-9\-_]){0,61})?[a-zA-Z0-9]\.?)|\.) type: string description: Set hostname, IPv4 address or IPv6 address for the server example: 1.2.2.3 vpnId: type: integer description: VPN ID format: int32 example: 0 enum: - 0 - 512 default: 0 description: Logging Server $$ref: '#/components/schemas/LoggingServer' description: Logging feature for control components $$ref: '#/components/schemas/ControlComponentLoggingSetting' managementDns: type: object properties: dnsServerPrimary: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: Primary DNS server IPv4 or IPv6 Address example: 10.2.2.2 dnsServerSecondary: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: Secondary DNS server IPv4 or IPv6 Address example: 10.2.2.3 host: type: array items: required: - hostname - ip type: object properties: hostname: pattern: ^[a-zA-Z0-9\-_.]{1,64}$ type: string description: Host name example: vbond ip: maxItems: 64 minItems: 1 uniqueItems: true type: array items: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: IP Address example: 10.1.1.1 description: Static host mapping $$ref: '#/components/schemas/DnsHostMapping' description: Configure DNS servers or static host mapping $$ref: '#/components/schemas/ControlComponentDnsSetting' ntp: required: - server type: object properties: server: maxItems: 4 minItems: 1 type: array description: NTP Server (up to 4) items: required: - name type: object properties: authenticationKey: maxLength: 2147483647 minLength: 1 type: string description: Value of the CMAC AES-128 authentication key example: '123456' name: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))|((?=.{1,253}$)((([a-zA-Z0-9_]([a-zA-Z0-9\-_]){0,61})?[a-zA-Z0-9]\.)*([a-zA-Z0-9_]([a-zA-Z0-9\-_]){0,61})?[a-zA-Z0-9]\.?)|\.) type: string description: Set hostname or IP address of server example: 1.2.2.3 prefer: type: boolean description: Prefer this NTP server example: false default: false vpnId: type: integer description: VPN ID format: int32 example: 0 enum: - 0 - 512 default: 0 description: NTP Server for control components $$ref: '#/components/schemas/NtpServer' description: NTP setting for control components $$ref: '#/components/schemas/ControlComponentNtpSetting' security: required: - protocol type: object properties: protocol: type: string description: Control connection protocol, default is DTLS example: dtls enum: - dtls - tls default: dtls tlsPort: maximum: 65535 minimum: 1025 type: integer description: TLS port, cannot coexist with protocol(DTLS) format: int32 example: 23456 default: 23456 description: Security configuration for control components $$ref: '#/components/schemas/ControlComponentSecuritySetting' snmp: required: - enableFeature type: object properties: contact: maxLength: 255 minLength: 1 type: string description: Set the contact for this managed node example: PaM-2nd-Level@telekom.de enableFeature: type: boolean description: Enable or disable SNMP example: false default: false location: maxLength: 255 minLength: 1 type: string description: Set the physical location of this managed node example: Cisco Cloud - AWS-FRA name: maxLength: 255 minLength: 1 type: string description: Set the assigned name for this managed node example: vManage-01-FRA version: type: string description: SNMP version(v2 or v3) example: v3 enum: - v2 - v3 default: v3 versionSpecificData: type: object description: SNMP configuration oneOf: - required: - community - view type: object properties: community: maxItems: 2147483647 minItems: 1 type: array description: SNMPv2 community configuration items: required: - name - tag - view type: object properties: name: pattern: ^(?:\$CRYPT\$.{17}|(?!(?:\$CRYPT\$))[\S]{1,})$ type: string description: Set name of the SNMP community example: community_test tag: pattern: ^(?=.{1,32}$)([^<>]*)$ type: string description: Set alias name for SNMP community example: test view: pattern: ^(?=.{1,32}$)([^<>]*)$ type: string description: SNMP view name example: test description: SNMPv2 community $$ref: '#/components/schemas/Snmpv2Community' trap: required: - group - target type: object properties: group: maxItems: 8 minItems: 0 type: array description: SNMPv2 trap groups items: required: - enable - groupName type: object properties: enable: maxItems: 2147483647 minItems: 1 type: array description: Trap module configuration items: required: - level - module type: object properties: level: maxItems: 3 minItems: 1 uniqueItems: true type: array items: type: string description: Trap level example: critical enum: - critical - major - minor module: type: string description: SNMP trap module name example: all enum: - all - app-route - bfd - control - dhcp - hardware - omp - routing - security - system - vpn - bridge - policy - wwan description: Enable SNMP trap modules $$ref: '#/components/schemas/SnmpTrapModule' groupName: pattern: ^(?=.{1,32}$)([^<>]*)$ type: string description: Trap group name example: trapGroup1 description: SNMPv3 trap groups $$ref: '#/components/schemas/TrapGroup' target: type: array description: SNMPv2 target configuration items: required: - communityTag - groupName - ip - port - vpnId type: object properties: communityTag: pattern: ^(?=.{1,32}$)([^<>]*)$ type: string description: Port number example: COMMUNITY_TEST groupName: pattern: ^(?=.{1,32}$)([^<>]*)$ type: string description: SNMPv3 group name example: group1 ip: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: IPv4 or IPv6 address example: 1.1.1.3 port: maximum: 65535 minimum: 1 type: integer description: Set UDP port number to connect to SNMP server format: int32 example: 13212 vpnId: type: integer description: VPN ID format: int32 example: 0 enum: - 0 - 512 description: SNMPv2 Target server configuration $$ref: '#/components/schemas/Snmpv2Target' description: SNMPv2 trap configuration $$ref: '#/components/schemas/Snmpv2Trap' view: maxItems: 2147483647 minItems: 1 type: array description: SNMPv2 view configuration items: required: - name type: object properties: name: pattern: ^(?=.{1,32}$)([^<>]*)$ type: string description: SNMP view name oid: type: array description: Configure SNMP object identifier items: required: - id type: object properties: exclude: type: boolean description: Exclude the OID or not example: false default: false id: pattern: (([0-1](\.[1-3]?[0-9]))|(2\.(0|([1-9]\d*))))(\.(0|\*|([1-9]\d*))){0,126} type: string description: Configure identifier of subtree of MIB objects example: 2.1.1.11.1 description: SNMP OID configuration $$ref: '#/components/schemas/SnmpOID' description: SNMP view configuration $$ref: '#/components/schemas/SnmpView' description: SNMPv2 configuration $$ref: '#/components/schemas/SNMPv2Data' - required: - group - user - view type: object properties: group: maxItems: 2147483647 minItems: 1 type: array description: SNMPv3 group configuration items: required: - name - securityLevel - view type: object properties: name: pattern: ^(?=.{1,32}$)([^<>]*)$ type: string description: SNMP group name example: group securityLevel: type: string description: Security Level example: auth-priv enum: - no-auth-no-priv - auth-priv view: pattern: ^(?=.{1,32}$)([^<>]*)$ type: string description: View name example: view1 description: SNMPv3 group configuration $$ref: '#/components/schemas/Snmpv3Group' trap: required: - group - target type: object properties: group: maxItems: 8 minItems: 0 type: array description: SNMPv3 trap groups items: required: - enable - groupName type: object properties: enable: maxItems: 2147483647 minItems: 1 type: array description: Trap module configuration items: required: - level - module type: object properties: level: maxItems: 3 minItems: 1 uniqueItems: true type: array items: type: string description: Trap level example: critical enum: - critical - major - minor module: type: string description: SNMP trap module name example: all enum: - all - app-route - bfd - control - dhcp - hardware - omp - routing - security - system - vpn - bridge - policy - wwan description: Enable SNMP trap modules $$ref: '#/components/schemas/SnmpTrapModule' groupName: pattern: ^(?=.{1,32}$)([^<>]*)$ type: string description: Trap group name example: trapGroup1 description: SNMPv3 trap groups $$ref: '#/components/schemas/TrapGroup' target: type: array description: SNMPv3 target configuration items: required: - groupName - ip - port - user - vpnId type: object properties: groupName: pattern: ^(?=.{1,32}$)([^<>]*)$ type: string description: SNMPv3 group name example: group1 ip: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: IPv4 or IPv6 address example: 1.1.1.3 port: maximum: 65535 minimum: 1 type: integer description: Set UDP port number to connect to SNMP server format: int32 example: 13212 user: pattern: ^(?=.{1,32}$)([^<>]*)$ type: string description: SNMPv3 user name example: test1 vpnId: type: integer description: VPN ID format: int32 example: 0 enum: - 0 - 512 default: 0 description: SNMPv3 target configuration $$ref: '#/components/schemas/Snmpv3Target' description: SNMPv3 trap configuration $$ref: '#/components/schemas/Snmpv3Trap' user: maxItems: 2147483647 minItems: 1 type: array description: SNMPv3 user configuration items: required: - group - name type: object properties: authPassword: pattern: ^(?:\$CRYPT\$.{17}|(?!(?:\$CRYPT\$)).{8,128})$ type: string description: Authentication password, either a encrypt string starting with $CRYPT$, or a clear text string of length 8 to 128 example: authPassword group: pattern: ^(?=.{1,32}$)([^<>]*)$ type: string description: SNMP group name example: group1 name: pattern: ^(?=.{1,32}$)([^<>]*)$ type: string description: SNMPv3 User name example: user1 privPassword: pattern: ^(?:\$CRYPT\$.{17}|(?!(?:\$CRYPT\$)).{8,128})$ type: string description: Privilege password, either a encrypt string starting with $CRYPT$, or a clear text string of length 8 to 128 example: privPassword description: SNMPv3 user $$ref: '#/components/schemas/SNMPv3User' view: maxItems: 2147483647 minItems: 1 type: array description: SNMPv3 view configuration items: required: - name type: object properties: name: pattern: ^(?=.{1,32}$)([^<>]*)$ type: string description: SNMP view name oid: type: array description: Configure SNMP object identifier items: required: - id type: object properties: exclude: type: boolean description: Exclude the OID or not example: false default: false id: pattern: (([0-1](\.[1-3]?[0-9]))|(2\.(0|([1-9]\d*))))(\.(0|\*|([1-9]\d*))){0,126} type: string description: Configure identifier of subtree of MIB objects example: 2.1.1.11.1 description: SNMP OID configuration $$ref: '#/components/schemas/SnmpOID' description: SNMP view configuration $$ref: '#/components/schemas/SnmpView' description: SNMPv3 configuration $$ref: '#/components/schemas/SNMPv3Data' $$ref: '#/components/schemas/SnmpVersionSpecificData' description: SNMP setting $$ref: '#/components/schemas/ControlComponentSnmpSetting' description: Configure network level features for all control components $$ref: '#/components/schemas/ControlComponentNetworkSettings' examples: CreateControlComponentNetworkCommonSettingWithAllFeatures: description: CreateControlComponentNetworkCommonSettingWithAllFeatures value: ntp: server: - name: 1.1.1.1 vpnId: 0 prefer: true - name: 2002::1 vpnId: 0 prefer: false - name: time.google.com vpnId: 0 prefer: false - name: 2.1.1.1 vpnId: 0 prefer: false aaa: authFallback: true adminAuthOrder: true accounting: true ciscoTacRoUser: false ciscoTacRwUser: false tacacs: timeout: 232 authentication: ascii servers: - address: 1.1.1.1 authPort: 32200 acctPort: 1200 vpn: 0 secretKey: test123 priority: 2 - address: 2002::1 authPort: 321 acctPort: 232 vpn: 0 secretKey: password priority: 3 radius: timeout: 32 retransmit: 12 server: - address: 1.1.1.1 authPort: 1232 acctPort: 12312 tag: radius1 vpn: 0 secretKey: password priority: 1 - address: 3.3.3.3 authPort: 1234 acctPort: 123 tag: radius2 vpn: 0 secretKey: password priority: 2 authOrder: - local - radius - tacacs radiusServers: - radius1 - radius2 user: - name: admin password: admin - name: xx password: xx userGroup: netadmin logs: auditDisable: true netconfDisable: true security: protocol: dtls controller: omp: shutdown: false controllerSendPathLimit: 10 filterRoute: outbound: affinityGroupPreference: false tlocColor: false sendBackupPaths: false discardRejected: false gracefulRestart: true timers: holdTime: 3200 advertisementInterval: 1 gracefulRestartTimer: 110 eorTimer: 200 tlocColorCompatibility: compatible: - color1: mpls color2: default - color1: biz-internet color2: gold incompatible: - color1: lte color2: default - color1: 3g color2: gold dns: dnsServerPrimary: 2.2.2.2 dnsServerSecondary: 3.3.3.3 host: - hostname: vbond ip: - 10.0.12.26 - 2001:a0:c::1a banner: enableFeature: true loginMessage: hello motdMessage: hello logging: enableFeature: true server: - name: 3002::1 vpnId: 0 - name: 3.3.32.2 vpnId: 0 - name: adas1.com.sd vpnId: 0 snmp: enableFeature: true version: v2 contact: PaM-2nd-Level@telekom.de name: vManage-01-FRA location: Cisco Cloud - AWS-FRA versionSpecificData: view: - name: xx oid: - id: 1.2.2.2.2 exclude: true - id: 2.2.1.13.2 exclude: false - name: yy oid: - id: 1.4.2.2.2 community: - name: comm1 tag: test1 view: xx - name: comm2 tag: test2 view: yy trap: target: - vpnId: 0 ip: 2.2.2.2 port: 23 communityTag: test1 groupName: trap-group1 - vpnId: 0 ip: 3.2.2.2 port: 12312 communityTag: test2 groupName: trap-group1 group: - groupName: trap-group1 enable: - module: all level: - critical - module: bfd level: - major - module: control level: - critical - module: dhcp level: - minor $$ref: '#/components/examples/ComViptelaVmanageServerDeviceconfigControlcomponentSettingRequestExampleCreatecommonsettings' CreateControlComponentNetworkCommonSettingWithMinimumFeatures: description: CreateControlComponentNetworkCommonSettingWithMinimumFeatures value: ntp: server: - name: time.google.com aaa: authOrder: - local user: - name: admin password: admin $$ref: '#/components/examples/ComViptelaVmanageServerDeviceconfigControlcomponentSettingRequestExampleCreatecommonsettingsminimum' required: true responses: '200': description: Success content: application/json: schema: required: - aaa - ntp type: object properties: aaa: required: - authOrder - user type: object properties: accounting: type: boolean description: Enable/disable user accounting example: false default: false adminAuthOrder: type: boolean description: Authenticate admin user as per auth-order example: false default: false authFallback: type: boolean description: Fall back if higher-priority authentication fails example: false default: false authOrder: maxItems: 3 minItems: 1 uniqueItems: true type: array items: type: string description: Authentication order list example: local enum: - local - radius - tacacs ciscoTacRoUser: type: boolean description: Cisco Tac Enable Read only default: true ciscoTacRwUser: type: boolean description: Cisco Tac Enable Read and Write default: true logs: type: object properties: auditDisable: type: boolean description: Disable audit logs default: false netconfDisable: type: boolean description: Disable Netconf logs default: false description: Enable/Disable audit or netconf logs $$ref: '#/components/schemas/AaaLogs' radius: type: object properties: retransmit: maximum: 1000 minimum: 1 type: integer description: Configure how many times to contact each RADIUS server format: int32 example: 3 default: 3 server: maxItems: 8 minItems: 0 type: array description: RADIUS server configuration items: required: - address - secretKey type: object properties: acctPort: maximum: 65535 minimum: 0 type: integer description: Accounting Port format: int32 example: 1813 default: 1813 address: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: Set IP address of RADIUS server example: 1.2.2.2 authPort: maximum: 65535 minimum: 0 type: integer description: Authentication Port format: int32 example: 1812 default: 1812 priority: maximum: 7 minimum: 0 type: integer description: Priority format: int32 example: 1 default: 0 secretKey: pattern: ^(?:\$CRYPT\$.{17}|(?!(?:\$CRYPT\$)).{1,128})$ type: string description: Secret key example: password tag: maxLength: 16 minLength: 4 pattern: ^[a-zA-Z0-9\-_]*$ type: string description: Reference tag/name for the server example: radius-server1 vpn: type: integer description: VPN ID format: int32 example: 0 enum: - 0 - 512 default: 0 description: Configure the RADIUS server $$ref: '#/components/schemas/ControlComponentAaaRadiusServer' timeout: maximum: 1000 minimum: 1 type: integer description: Configure how long to wait for replies from the RADIUS server format: int32 example: 5 default: 5 description: Radius configuration $$ref: '#/components/schemas/Radius' radiusServers: uniqueItems: true type: array items: type: string description: Designate radius server tags for authentication and accounting example: radius-tag1 tacacs: type: object properties: authentication: type: string description: TACACS authentication type enum: - pap - ascii default: pap servers: maxItems: 8 minItems: 0 type: array description: List of TACACS servers items: required: - address - secretKey type: object properties: acctPort: maximum: 65535 minimum: 0 type: integer description: Accounting Port format: int32 default: 49 address: type: string description: Set IP address of TACACS server example: 1.2.2.2 authPort: maximum: 65535 minimum: 0 type: integer description: Authentication Port format: int32 default: 49 priority: maximum: 7 minimum: 0 type: integer description: TACACS server priority <0..7> format: int32 example: 1 default: 0 secretKey: pattern: ^(?:\$CRYPT\$.{17}|(?!(?:\$CRYPT\$)).{1,128})$ type: string description: TACACS server password example: Password123 vpn: type: integer description: VPN ID format: int32 example: 0 enum: - 0 - 512 default: 0 description: Configure the TACACS server $$ref: '#/components/schemas/TacacsServer' timeout: maximum: 1000 minimum: 1 type: integer description: Configure how long to wait for replies from the TACACS server format: int32 default: 5 description: TACACS configuration $$ref: '#/components/schemas/Tacacs' user: maxItems: 2147483647 minItems: 1 type: array description: Create local login account items: required: - name - password type: object properties: name: maxLength: 128 minLength: 1 pattern: ^(?!(?:root|daemon|bin|sys|sync|games|man|lp|mail|news|uucp|proxy|www-data|backup|list|irc|gnats|nobody|basic|sshd|quagga|vmanage-admin|vmanage|viptela-reserved)$)[a-z][a-z0-9._-]*$ type: string description: User name example: admin password: pattern: ^(?:\$CRYPT\$.{17}|(?!(?:\$CRYPT\$)).{1,128})$ type: string description: User password, either a encrypted string starting with $CRYPT$, or a clear text string of length 1–128 example: password userGroup: type: string description: User group name which user belongs to example: netadmin enum: - basic - operator - netadmin description: Create local login account $$ref: '#/components/schemas/AaaLocalUser' description: Configure local users, TACACS or RADIUS servers for control components $$ref: '#/components/schemas/ControlComponentAaaSetting' banner: required: - enableFeature type: object properties: enableFeature: type: boolean description: Enable Banner feature or not default: false loginMessage: maxLength: 2048 minLength: 1 type: string description: Set message to display before login prompt example: Hello user motdMessage: maxLength: 2048 minLength: 1 type: string description: Set message to display after a user logs in example: Hello description: Banner configuration $$ref: '#/components/schemas/ControlComponentBannerSetting' controller: type: object properties: hubSpokeTopology: type: boolean description: Hub & spoke topology default: false omp: type: object properties: controllerSendPathLimit: maximum: 128 minimum: 4 type: integer description: Limit number of paths sent to vSmart controller for a prefix format: int32 example: 20 discardRejected: type: boolean description: Enable/Disable storage of information rejected by policy example: false default: false filterRoute: required: - outbound type: object properties: outbound: type: object properties: affinityGroupPreference: type: boolean description: Filter routes based on affinity preference list example: false default: false tlocColor: type: boolean description: Filter routes based on TLOC color compatibility list example: false default: false $$ref: '#/components/schemas/Outbound' description: OMP filter route configuration $$ref: '#/components/schemas/OmpFilterRoute' gracefulRestart: type: boolean description: Enable/Disable graceful restart example: true default: true outboundPolicyCaching: type: boolean sendBackupPaths: type: boolean description: Enable/Disable transmission of backup paths example: false default: false shutdown: type: boolean description: Enable/disable OMP example: false default: false timers: type: object properties: advertisementInterval: maximum: 65535 minimum: 0 type: integer description: Advertisement Interval (seconds), set the time between OMP Update packets format: int32 example: 1 default: 1 eorTimer: maximum: 3600 minimum: 1 type: integer description: End of RIB timer, in seconds format: int32 example: 300 default: 300 gracefulRestartTimer: maximum: 31556952 minimum: 1 type: integer description: Graceful restart timer, in seconds format: int32 example: 43200 default: 43200 holdTime: maximum: 65535 minimum: 0 type: integer description: Hold Time(Seconds), Set how long to wait before closing OMP peer connection format: int32 example: 300 default: 300 description: OMP timers $$ref: '#/components/schemas/OmpTimers' description: Controller OMP configuration $$ref: '#/components/schemas/OmpSetting' tlocColorCompatibility: type: object properties: compatible: uniqueItems: true type: array items: required: - color1 - color2 type: object properties: color1: type: string description: First TLOC color in comparsion enum: - default - mpls - metro-ethernet - biz-internet - public-internet - lte - 3g - red - green - blue - gold - silver - bronze - custom1 - custom2 - custom3 - private1 - private2 - private3 - private4 - private5 - private6 color2: type: string description: Second TLOC color in comparsion enum: - default - mpls - metro-ethernet - biz-internet - public-internet - lte - 3g - red - green - blue - gold - silver - bronze - custom1 - custom2 - custom3 - private1 - private2 - private3 - private4 - private5 - private6 description: List of Incompatible TLOC colors $$ref: '#/components/schemas/Compatible' incompatible: uniqueItems: true type: array items: required: - color1 - color2 type: object properties: color1: type: string description: First TLOC color in comparsion enum: - default - mpls - metro-ethernet - biz-internet - public-internet - lte - 3g - red - green - blue - gold - silver - bronze - custom1 - custom2 - custom3 - private1 - private2 - private3 - private4 - private5 - private6 color2: type: string description: Second TLOC color in comparsion enum: - default - mpls - metro-ethernet - biz-internet - public-internet - lte - 3g - red - green - blue - gold - silver - bronze - custom1 - custom2 - custom3 - private1 - private2 - private3 - private4 - private5 - private6 description: List of Incompatible TLOC colors $$ref: '#/components/schemas/Compatible' description: List of compatible/incompatible TLOC colors for BFD session formation $$ref: '#/components/schemas/TlocColorCompatibility' description: Controller fabric OMP and system settings $$ref: '#/components/schemas/ControllerFabricSetting' dns: type: object properties: dnsServerPrimary: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: Primary DNS server IPv4 or IPv6 Address example: 10.2.2.2 dnsServerSecondary: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: Secondary DNS server IPv4 or IPv6 Address example: 10.2.2.3 host: type: array items: required: - hostname - ip type: object properties: hostname: pattern: ^[a-zA-Z0-9\-_.]{1,64}$ type: string description: Host name example: vbond ip: maxItems: 64 minItems: 1 uniqueItems: true type: array items: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: IP Address example: 10.1.1.1 description: Static host mapping $$ref: '#/components/schemas/DnsHostMapping' description: Configure DNS servers or static host mapping $$ref: '#/components/schemas/ControlComponentDnsSetting' logging: required: - enableFeature type: object properties: enableFeature: type: boolean description: Enable Logging feature or not default: false server: maxItems: 4 minItems: 0 type: array description: Configure logging servers(Maximum 4 servers) items: required: - name type: object properties: enableTlsTransport: type: boolean description: Enable TLS transport, otherwise UDP as transport default: true name: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))|((?=.{1,253}$)((([a-zA-Z0-9_]([a-zA-Z0-9\-_]){0,61})?[a-zA-Z0-9]\.)*([a-zA-Z0-9_]([a-zA-Z0-9\-_]){0,61})?[a-zA-Z0-9]\.?)|\.) type: string description: Set hostname, IPv4 address or IPv6 address for the server example: 1.2.2.3 vpnId: type: integer description: VPN ID format: int32 example: 0 enum: - 0 - 512 default: 0 description: Logging Server $$ref: '#/components/schemas/LoggingServer' description: Logging feature for control components $$ref: '#/components/schemas/ControlComponentLoggingSetting' managementDns: type: object properties: dnsServerPrimary: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: Primary DNS server IPv4 or IPv6 Address example: 10.2.2.2 dnsServerSecondary: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: Secondary DNS server IPv4 or IPv6 Address example: 10.2.2.3 host: type: array items: required: - hostname - ip type: object properties: hostname: pattern: ^[a-zA-Z0-9\-_.]{1,64}$ type: string description: Host name example: vbond ip: maxItems: 64 minItems: 1 uniqueItems: true type: array items: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: IP Address example: 10.1.1.1 description: Static host mapping $$ref: '#/components/schemas/DnsHostMapping' description: Configure DNS servers or static host mapping $$ref: '#/components/schemas/ControlComponentDnsSetting' ntp: required: - server type: object properties: server: maxItems: 4 minItems: 1 type: array description: NTP Server (up to 4) items: required: - name type: object properties: authenticationKey: maxLength: 2147483647 minLength: 1 type: string description: Value of the CMAC AES-128 authentication key example: '123456' name: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))|((?=.{1,253}$)((([a-zA-Z0-9_]([a-zA-Z0-9\-_]){0,61})?[a-zA-Z0-9]\.)*([a-zA-Z0-9_]([a-zA-Z0-9\-_]){0,61})?[a-zA-Z0-9]\.?)|\.) type: string description: Set hostname or IP address of server example: 1.2.2.3 prefer: type: boolean description: Prefer this NTP server example: false default: false vpnId: type: integer description: VPN ID format: int32 example: 0 enum: - 0 - 512 default: 0 description: NTP Server for control components $$ref: '#/components/schemas/NtpServer' description: NTP setting for control components $$ref: '#/components/schemas/ControlComponentNtpSetting' security: required: - protocol type: object properties: protocol: type: string description: Control connection protocol, default is DTLS example: dtls enum: - dtls - tls default: dtls tlsPort: maximum: 65535 minimum: 1025 type: integer description: TLS port, cannot coexist with protocol(DTLS) format: int32 example: 23456 default: 23456 description: Security configuration for control components $$ref: '#/components/schemas/ControlComponentSecuritySetting' snmp: required: - enableFeature type: object properties: contact: maxLength: 255 minLength: 1 type: string description: Set the contact for this managed node example: PaM-2nd-Level@telekom.de enableFeature: type: boolean description: Enable or disable SNMP example: false default: false location: maxLength: 255 minLength: 1 type: string description: Set the physical location of this managed node example: Cisco Cloud - AWS-FRA name: maxLength: 255 minLength: 1 type: string description: Set the assigned name for this managed node example: vManage-01-FRA version: type: string description: SNMP version(v2 or v3) example: v3 enum: - v2 - v3 default: v3 versionSpecificData: type: object description: SNMP configuration oneOf: - required: - community - view type: object properties: community: maxItems: 2147483647 minItems: 1 type: array description: SNMPv2 community configuration items: required: - name - tag - view type: object properties: name: pattern: ^(?:\$CRYPT\$.{17}|(?!(?:\$CRYPT\$))[\S]{1,})$ type: string description: Set name of the SNMP community example: community_test tag: pattern: ^(?=.{1,32}$)([^<>]*)$ type: string description: Set alias name for SNMP community example: test view: pattern: ^(?=.{1,32}$)([^<>]*)$ type: string description: SNMP view name example: test description: SNMPv2 community $$ref: '#/components/schemas/Snmpv2Community' trap: required: - group - target type: object properties: group: maxItems: 8 minItems: 0 type: array description: SNMPv2 trap groups items: required: - enable - groupName type: object properties: enable: maxItems: 2147483647 minItems: 1 type: array description: Trap module configuration items: required: - level - module type: object properties: level: maxItems: 3 minItems: 1 uniqueItems: true type: array items: type: string description: Trap level example: critical enum: - critical - major - minor module: type: string description: SNMP trap module name example: all enum: - all - app-route - bfd - control - dhcp - hardware - omp - routing - security - system - vpn - bridge - policy - wwan description: Enable SNMP trap modules $$ref: '#/components/schemas/SnmpTrapModule' groupName: pattern: ^(?=.{1,32}$)([^<>]*)$ type: string description: Trap group name example: trapGroup1 description: SNMPv3 trap groups $$ref: '#/components/schemas/TrapGroup' target: type: array description: SNMPv2 target configuration items: required: - communityTag - groupName - ip - port - vpnId type: object properties: communityTag: pattern: ^(?=.{1,32}$)([^<>]*)$ type: string description: Port number example: COMMUNITY_TEST groupName: pattern: ^(?=.{1,32}$)([^<>]*)$ type: string description: SNMPv3 group name example: group1 ip: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: IPv4 or IPv6 address example: 1.1.1.3 port: maximum: 65535 minimum: 1 type: integer description: Set UDP port number to connect to SNMP server format: int32 example: 13212 vpnId: type: integer description: VPN ID format: int32 example: 0 enum: - 0 - 512 description: SNMPv2 Target server configuration $$ref: '#/components/schemas/Snmpv2Target' description: SNMPv2 trap configuration $$ref: '#/components/schemas/Snmpv2Trap' view: maxItems: 2147483647 minItems: 1 type: array description: SNMPv2 view configuration items: required: - name type: object properties: name: pattern: ^(?=.{1,32}$)([^<>]*)$ type: string description: SNMP view name oid: type: array description: Configure SNMP object identifier items: required: - id type: object properties: exclude: type: boolean description: Exclude the OID or not example: false default: false id: pattern: (([0-1](\.[1-3]?[0-9]))|(2\.(0|([1-9]\d*))))(\.(0|\*|([1-9]\d*))){0,126} type: string description: Configure identifier of subtree of MIB objects example: 2.1.1.11.1 description: SNMP OID configuration $$ref: '#/components/schemas/SnmpOID' description: SNMP view configuration $$ref: '#/components/schemas/SnmpView' description: SNMPv2 configuration $$ref: '#/components/schemas/SNMPv2Data' - required: - group - user - view type: object properties: group: maxItems: 2147483647 minItems: 1 type: array description: SNMPv3 group configuration items: required: - name - securityLevel - view type: object properties: name: pattern: ^(?=.{1,32}$)([^<>]*)$ type: string description: SNMP group name example: group securityLevel: type: string description: Security Level example: auth-priv enum: - no-auth-no-priv - auth-priv view: pattern: ^(?=.{1,32}$)([^<>]*)$ type: string description: View name example: view1 description: SNMPv3 group configuration $$ref: '#/components/schemas/Snmpv3Group' trap: required: - group - target type: object properties: group: maxItems: 8 minItems: 0 type: array description: SNMPv3 trap groups items: required: - enable - groupName type: object properties: enable: maxItems: 2147483647 minItems: 1 type: array description: Trap module configuration items: required: - level - module type: object properties: level: maxItems: 3 minItems: 1 uniqueItems: true type: array items: type: string description: Trap level example: critical enum: - critical - major - minor module: type: string description: SNMP trap module name example: all enum: - all - app-route - bfd - control - dhcp - hardware - omp - routing - security - system - vpn - bridge - policy - wwan description: Enable SNMP trap modules $$ref: '#/components/schemas/SnmpTrapModule' groupName: pattern: ^(?=.{1,32}$)([^<>]*)$ type: string description: Trap group name example: trapGroup1 description: SNMPv3 trap groups $$ref: '#/components/schemas/TrapGroup' target: type: array description: SNMPv3 target configuration items: required: - groupName - ip - port - user - vpnId type: object properties: groupName: pattern: ^(?=.{1,32}$)([^<>]*)$ type: string description: SNMPv3 group name example: group1 ip: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: IPv4 or IPv6 address example: 1.1.1.3 port: maximum: 65535 minimum: 1 type: integer description: Set UDP port number to connect to SNMP server format: int32 example: 13212 user: pattern: ^(?=.{1,32}$)([^<>]*)$ type: string description: SNMPv3 user name example: test1 vpnId: type: integer description: VPN ID format: int32 example: 0 enum: - 0 - 512 default: 0 description: SNMPv3 target configuration $$ref: '#/components/schemas/Snmpv3Target' description: SNMPv3 trap configuration $$ref: '#/components/schemas/Snmpv3Trap' user: maxItems: 2147483647 minItems: 1 type: array description: SNMPv3 user configuration items: required: - group - name type: object properties: authPassword: pattern: ^(?:\$CRYPT\$.{17}|(?!(?:\$CRYPT\$)).{8,128})$ type: string description: Authentication password, either a encrypt string starting with $CRYPT$, or a clear text string of length 8 to 128 example: authPassword group: pattern: ^(?=.{1,32}$)([^<>]*)$ type: string description: SNMP group name example: group1 name: pattern: ^(?=.{1,32}$)([^<>]*)$ type: string description: SNMPv3 User name example: user1 privPassword: pattern: ^(?:\$CRYPT\$.{17}|(?!(?:\$CRYPT\$)).{8,128})$ type: string description: Privilege password, either a encrypt string starting with $CRYPT$, or a clear text string of length 8 to 128 example: privPassword description: SNMPv3 user $$ref: '#/components/schemas/SNMPv3User' view: maxItems: 2147483647 minItems: 1 type: array description: SNMPv3 view configuration items: required: - name type: object properties: name: pattern: ^(?=.{1,32}$)([^<>]*)$ type: string description: SNMP view name oid: type: array description: Configure SNMP object identifier items: required: - id type: object properties: exclude: type: boolean description: Exclude the OID or not example: false default: false id: pattern: (([0-1](\.[1-3]?[0-9]))|(2\.(0|([1-9]\d*))))(\.(0|\*|([1-9]\d*))){0,126} type: string description: Configure identifier of subtree of MIB objects example: 2.1.1.11.1 description: SNMP OID configuration $$ref: '#/components/schemas/SnmpOID' description: SNMP view configuration $$ref: '#/components/schemas/SnmpView' description: SNMPv3 configuration $$ref: '#/components/schemas/SNMPv3Data' $$ref: '#/components/schemas/SnmpVersionSpecificData' description: SNMP setting $$ref: '#/components/schemas/ControlComponentSnmpSetting' description: Configure network level features for all control components $$ref: '#/components/schemas/ControlComponentNetworkSettings' examples: CreateControlComponentNetworkCommonSettingWithAllFeatures: description: CreateControlComponentNetworkCommonSettingWithAllFeatures value: ntp: server: - name: 1.1.1.1 vpnId: 0 prefer: true - name: 2002::1 vpnId: 0 prefer: false - name: time.google.com vpnId: 0 prefer: false - name: 2.1.1.1 vpnId: 0 prefer: false aaa: authOrder: - local - radius - tacacs radiusServers: - radius1 - radius2 authFallback: true adminAuthOrder: true accounting: true user: - name: admin password: $CRYPT$LlBMcwaztmurYKfN/ - name: xx password: $CRYPT$hy1nRjYaA4mqsTgLU userGroup: netadmin ciscoTacRoUser: false ciscoTacRwUser: false tacacs: timeout: 232 authentication: ascii servers: - address: 1.1.1.1 authPort: 32200 acctPort: 1200 vpn: 0 secretKey: $CRYPT$ZrYAwz9pB8WOkW+gj priority: 2 - address: 2002::1 authPort: 321 acctPort: 232 vpn: 0 secretKey: $CRYPT$vgNok88PqemwCW0mX priority: 3 radius: timeout: 32 retransmit: 12 server: - address: 1.1.1.1 authPort: 1232 acctPort: 12312 tag: radius1 vpn: 0 secretKey: $CRYPT$9DvMb0HTJkPsW+ryY priority: 1 - address: 3.3.3.3 authPort: 1234 acctPort: 123 tag: radius2 vpn: 0 secretKey: $CRYPT$Wyt41hQUJ4bZ1pEb6 priority: 2 logs: auditDisable: true netconfDisable: true security: protocol: dtls controller: omp: shutdown: false controllerSendPathLimit: 10 filterRoute: outbound: affinityGroupPreference: false tlocColor: false sendBackupPaths: false discardRejected: false gracefulRestart: true timers: holdTime: 3200 advertisementInterval: 1 gracefulRestartTimer: 110 eorTimer: 200 tlocColorCompatibility: compatible: - color1: mpls color2: default - color1: biz-internet color2: gold incompatible: - color1: lte color2: default - color1: 3g color2: gold dns: dnsServerPrimary: 2.2.2.2 dnsServerSecondary: 3.3.3.3 host: - hostname: vbond ip: - 10.0.12.26 - 2001:a0:c::1a banner: enableFeature: true loginMessage: hello motdMessage: hello logging: server: - name: 3002::1 vpnId: 0 - name: 3.3.32.2 vpnId: 0 - name: adas1.com.sd vpnId: 0 enableFeature: true snmp: version: v2 contact: PaM-2nd-Level@telekom.de name: vManage-01-FRA location: Cisco Cloud - AWS-FRA versionSpecificData: view: - name: xx oid: - id: 1.2.2.2.2 exclude: true - id: 2.2.1.13.2 exclude: false - name: yy oid: - id: 1.4.2.2.2 community: - name: $CRYPT$/gP0oCyfJrtcopHSG tag: test1 view: xx - name: $CRYPT$tB7e6QTIUrMRq5vP5 tag: test2 view: yy trap: target: - vpnId: 0 ip: 2.2.2.2 port: 23 communityTag: test1 groupName: trap-group1 - vpnId: 0 ip: 3.2.2.2 port: 12312 communityTag: test2 groupName: trap-group1 group: - groupName: trap-group1 enable: - module: all level: - critical - module: bfd level: - major - module: control level: - critical - module: dhcp level: - minor enableFeature: true $$ref: '#/components/examples/ComViptelaVmanageServerDeviceconfigControlcomponentSettingResponseExampleCreatecommonsettingsresponse' '400': description: Bad Request content: application/json: schema: required: - error type: object properties: error: required: - code - details - message - type type: object properties: code: type: string description: Internal error code example: CCS0018 details: type: string description: Error message detail example: Unrecognized field user1 message: type: string description: Error message summary example: Invalid control component setting payload type: type: string description: Error message title example: error description: Error response $$ref: '#/components/schemas/ErrorDetails' $$ref: '#/components/schemas/ErrorResponse' examples: CreateControlComponentCommonSettingsFailed: description: CreateControlComponentCommonSettingsFailed value: error: message: Invalid control component payload code: CCS0018 details: 'aaa.tacacs.timeout : must be greater than or equal to 1; ' type: error $$ref: '#/components/examples/ComViptelaVmanageServerDeviceconfigControlcomponentSettingResponseExampleCreatecommonsettingsfailedresponse' '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Control Component Settings-write