Get Control Component Common Settings - Cisco Catalyst SD-WAN Manager API, Release 20.18

{"type":"api","title":"Get Control Component Common Settings","meta":{"id":"/apps/pubhub/media/cisco-catalyst-sd-wan-api-guide-20-18/1c4807bcb76af36988ebb37dc2e455b1787a155e/744a8207-9965-344e-aed3-d3ef846a4950","info":{"title":"Others","description":"Other APIs\n- Include APIs that do not belong to other categories\n","contact":{"email":"vmanage@cisco.com"},"version":"20.18 - 2025-08-15"},"openapi":"3.1.0","servers":[{"url":"/dataservice"}]},"spec":{"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","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 \u003c0..7\u003e","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":604800,"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":5400,"default":5400}},"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":{"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"},"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":{"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}$)([^\u003c\u003e]*)$","type":"string","description":"Set alias name for SNMP community","example":"test"},"view":{"pattern":"^(?=.{1,32}$)([^\u003c\u003e]*)$","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}$)([^\u003c\u003e]*)$","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}$)([^\u003c\u003e]*)$","type":"string","description":"Port number","example":"COMMUNITY_TEST"},"groupName":{"pattern":"^(?=.{1,32}$)([^\u003c\u003e]*)$","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}$)([^\u003c\u003e]*)$","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}$)([^\u003c\u003e]*)$","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}$)([^\u003c\u003e]*)$","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}$)([^\u003c\u003e]*)$","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}$)([^\u003c\u003e]*)$","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}$)([^\u003c\u003e]*)$","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}$)([^\u003c\u003e]*)$","type":"string","description":"SNMP group name","example":"group1"},"name":{"pattern":"^(?=.{1,32}$)([^\u003c\u003e]*)$","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}$)([^\u003c\u003e]*)$","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","method":"get","path":"/v1/control-component/network-settings"}}