ControlComponentAaaSetting - Cisco Catalyst SD-WAN Manager API, Release 20.18

{"type":"model","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":{"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","title":"ControlComponentAaaSetting"}}