Get configurations for intended layer 2 features on a wired device - Cisco Catalyst Center API 2.3.7.9

{"type":"api","title":"Get configurations for intended layer 2 features on a wired device","meta":{"id":"/apps/pubhub/media/cisco-catalyst-center-api-2-3-7-9/b3d6cc9fb9f506b3bc9099912aa8a6f9d87e0f0a/6a3cd7ca-617e-374c-a10b-740a529a993e","info":{"title":"Intent API","description":"Cisco Catalyst Center Platform v. 2.3.7.9","version":"2.3.7.9"},"tags":[{"name":"Authentication","description":"Access Token Request"},{"name":"Sites","description":"Create sites, assign devices to them and get site health"},{"name":"Topology","description":"Get topology details and overall network health"},{"name":"Devices","description":"Manage network devices"},{"name":"Clients","description":"Get client (by MAC Address) health, status, and information"},{"name":"Users","description":"Obtain information about *Users* and associated connections and devices"},{"name":"Issues","description":"Obtain issue details, impacted hosts, and suggested actions for remediation"},{"name":"Site Design","description":"Design/provision NFV device to site/area/building/floor"},{"name":"Network Settings","description":"Manage Network Settings"},{"name":"Software Image Management (SWIM)","description":"Manage activation and distribution of software images"},{"name":"Device Onboarding (PnP)","description":"Zero-touch deployment of network devices"},{"name":"Configuration Templates","description":"Configure and manage CLI templates"},{"name":"Configuration Archive","description":"Export device configurations to an encrypted zip file"},{"name":"SDA","description":"(BETA) Configure and manage SDA wired fabric border devices"},{"name":"Sensors","description":"Manage sensor test templates"},{"name":"Wireless","description":"Configure and manage SSIDs, Wireless, and RF profiles in non-fabric wireless network"},{"name":"Command Runner","description":"Retrieve real-time device configuration and CLI keywords"},{"name":"Discovery","description":"Discover network devices and manage discovery jobs"},{"name":"Path Trace","description":"Network route and flow analysis"},{"name":"File","description":"Get configuration files by namespace and ID"},{"name":"Task","description":"Get information about asynchronous tasks"},{"name":"Tag","description":"Assign administrator-defined tags to network devices"},{"name":"Application Policy","description":"Create and manage applications, application sets, and application policies"},{"name":"Applications","description":"Intent API to get a list of applications for a specific site, a device, or a client device's MAC address"},{"name":"ITSM","description":"Provide the details of the various third party integrations that are supported"},{"name":"Event Management","description":"Event based notification to external handlers"},{"name":"Security Advisories","description":"Provides the details of advisories on the network and devices"},{"name":"Compliance","description":"Provides compliance status data on the devices"}],"x-parser-conf":{"expand":0,"labelConfig":{"endpoint":"summary"}},"openapi":"3.0.1","servers":[{"url":"/"}]},"spec":{"operationId":"getConfigurationsForIntendedLayer2FeaturesOnAWiredDevice_","tags":["Wired"],"summary":"Get configurations for intended layer 2 features on a wired device.","deprecated":false,"description":"This API returns the configurations for the intended layer 2 features on a wired device. Even after the intended configurations are deployed using the API /intent/api/v1/networkDevices/{id}/configFeatures/intended/deploy, they continue to be a part of the intended features on the device.","parameters":[{"name":"id","description":"Network device ID of the wired device to configure.","required":true,"schema":{"type":"string","default":"application/json"},"in":"path"},{"name":"feature","description":"Name of the feature to configure. The API /data/intent/api/wired/networkDevices/{id}/configFeatures/supported/layer2 can be used to get the list of features supported on a device.","required":true,"schema":{"type":"string","default":"application/json"},"in":"query"}],"responses":{"200":{"description":"Success Response.","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"type":"object","properties":{"features":{"type":"object","properties":{"cdpGlobalConfig":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"configType":{"type":"string","description":""},"timer":{"type":"integer","description":""},"isCdpEnabled":{"type":"boolean","description":""},"isLogDuplexMismatchEnabled":{"type":"boolean","description":""},"isAdvertiseV2Enabled":{"type":"boolean","description":""},"holdTime":{"type":"integer","description":""}}},"description":""}},"description":""},"cdpInterfaceConfig":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"configType":{"type":"string","description":""},"interfaceName":{"type":"string","description":""},"isCdpEnabled":{"type":"boolean","description":""},"isLogDuplexMismatchEnabled":{"type":"boolean","description":""}}},"description":""}},"description":""},"dhcpSnoopingGlobalConfig":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"configType":{"type":"string","description":""},"isDhcpSnoopingEnabled":{"type":"boolean","description":""},"databaseAgent":{"type":"object","properties":{"agentUrl":{"type":"string","description":""},"timeout":{"type":"integer","description":""},"writeDelay":{"type":"integer","description":""}},"description":""},"isGleaningEnabled":{"type":"boolean","description":""},"proxyBridgeVlans":{"type":"string","description":""}}},"description":""}},"description":""},"dhcpSnoopingInterfaceConfig":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"configType":{"type":"string","description":""},"isTrustedInterface":{"type":"boolean","description":""},"interfaceName":{"type":"string","description":""}}},"description":""}},"description":""},"dot1xGlobalConfig":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"configType":{"type":"string","description":""},"authenticationConfigMode":{"type":"string","description":""},"isDot1xEnabled":{"type":"boolean","description":""}}},"description":""}},"description":""},"dot1xInterfaceConfig":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"configType":{"type":"string","description":""},"interfaceName":{"type":"string","description":""},"authenticationOrder":{"type":"object","properties":{"configType":{"type":"string","description":""},"items":{"type":"array","items":{"type":"string"},"description":""}},"description":""},"priority":{"type":"object","properties":{"configType":{"type":"string","description":""},"items":{"type":"array","items":{"type":"string"},"description":""}},"description":""},"inactivityTimer":{"type":"number","description":""},"authenticationMode":{"type":"string","description":""},"isReauthEnabled":{"type":"boolean","description":""},"maxReauthRequests":{"type":"number","description":""},"isInactivityTimerFromServerEnabled":{"type":"boolean","description":""},"isReauthTimerFromServerEnabled":{"type":"boolean","description":""},"reauthTimer":{"type":"number","description":""},"txPeriod":{"type":"number","description":""}}},"description":""}},"description":""},"igmpSnoopingGlobalConfig":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"configType":{"type":"string","description":""},"isIgmpSnoopingEnabled":{"type":"boolean","description":""},"isQuerierEnabled":{"type":"boolean","description":""},"querierQueryInterval":{"type":"number","description":""},"querierVersion":{"type":"string","description":""},"igmpSnoopingVlanSettings":{"type":"object","properties":{"configType":{"type":"string","description":""},"items":{"type":"array","items":{"type":"object","properties":{"configType":{"type":"string","description":""},"vlanId":{"type":"integer","description":""},"isIgmpSnoopingEnabled":{"type":"boolean","description":""},"isImmediateLeaveEnabled":{"type":"boolean","description":""},"isQuerierEnabled":{"type":"boolean","description":""},"querierQueryInterval":{"type":"number","description":""},"igmpSnoopingVlanMrouters":{"type":"object","properties":{"configType":{"type":"string","description":""},"items":{"type":"array","items":{"type":"object","properties":{"configType":{"type":"string","description":""},"interfaceName":{"type":"string","description":""}}},"description":""}},"description":""}}},"description":""}},"description":""}}},"description":""}},"description":""},"lldpGlobalConfig":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"configType":{"type":"string","description":""},"timer":{"type":"integer","description":""},"isLldpEnabled":{"type":"boolean","description":""},"reinitializationDelay":{"type":"integer","description":""},"holdTime":{"type":"integer","description":""}}},"description":""}},"description":""},"lldpInterfaceConfig":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"configType":{"type":"string","description":""},"interfaceName":{"type":"string","description":""},"adminStatus":{"type":"string","description":""}}},"description":""}},"description":""},"mabInterfaceConfig":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"configType":{"type":"string","description":""},"interfaceName":{"type":"string","description":""},"isMabEnabled":{"type":"boolean","description":""}}},"description":""}},"description":""},"mldSnoopingGlobalConfig":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"configType":{"type":"string","description":""},"isMldSnoopingEnabled":{"type":"boolean","description":""},"isQuerierEnabled":{"type":"boolean","description":""},"querierQueryInterval":{"type":"number","description":""},"querierVersion":{"type":"string","description":""},"mldSnoopingVlanSettings":{"type":"object","properties":{"configType":{"type":"string","description":""},"items":{"type":"array","items":{"type":"object","properties":{"configType":{"type":"string","description":""},"vlanId":{"type":"integer","description":""},"isMldSnoopingEnabled":{"type":"boolean","description":""},"isImmediateLeaveEnabled":{"type":"boolean","description":""},"isQuerierEnabled":{"type":"boolean","description":""},"querierQueryInterval":{"type":"number","description":""},"mldSnoopingVlanMrouters":{"type":"object","properties":{"configType":{"type":"string","description":""},"items":{"type":"array","items":{"type":"object"},"description":""}},"description":""}}},"description":""}},"description":""}}},"description":""}},"description":""},"portchannelConfig":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"configType":{"type":"string","description":""},"isAutoEnabled":{"type":"boolean","description":""},"loadBalancingMethod":{"type":"string","description":""},"lacpSystemPriority":{"type":"integer","description":""},"portchannels":{"type":"object","properties":{"configType":{"type":"string","description":""},"items":{"type":"array","items":{"type":"object","properties":{"configType":{"type":"string","description":""},"name":{"type":"string","description":""},"isLayer2":{"type":"boolean","description":""},"memberPorts":{"type":"object","properties":{"configType":{"type":"string","description":""},"items":{"type":"array","items":{"type":"object"},"description":""}},"description":""}}},"description":""}},"description":""}}},"description":""}},"description":""},"stpGlobalConfig":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"configType":{"type":"string","description":""},"stpMode":{"type":"string","description":""},"isBackboneFastEnabled":{"type":"boolean","description":""},"isEtherChannelGuardEnabled":{"type":"boolean","description":""},"isExtendedSystemIdEnabled":{"type":"boolean","description":""},"isLoggingEnabled":{"type":"boolean","description":""},"isLoopGuardEnabled":{"type":"boolean","description":""},"portFastMode":{"type":"string","description":""},"isBpduFilterEnabled":{"type":"boolean","description":""},"isBpduGuardEnabled":{"type":"boolean","description":""},"isUplinkFastEnabled":{"type":"boolean","description":""},"transmitHoldCount":{"type":"number","description":""},"uplinkFastMaxUpdateRate":{"type":"integer","description":""},"stpInstances":{"type":"object","properties":{"configType":{"type":"string","description":""},"items":{"type":"array","items":{"type":"object","properties":{"configType":{"type":"string","description":""},"vlanId":{"type":"integer","description":""},"priority":{"type":"integer","description":""},"isStpEnabled":{"type":"boolean","description":""}}},"description":""}},"description":""}}},"description":""}},"description":""},"stpInterfaceConfig":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"configType":{"type":"string","description":""},"interfaceName":{"type":"string","description":""},"guardMode":{"type":"string","description":""},"bpduFilter":{"type":"string","description":""},"bpduGuard":{"type":"string","description":""},"pathCost":{"type":"number","description":""},"priority":{"type":"integer","description":""},"portVlanCostSettings":{"type":"object","properties":{"configType":{"type":"string","description":""},"items":{"type":"array","items":{"type":"object","properties":{"configType":{"type":"string","description":""},"cost":{"type":"integer","description":""},"vlans":{"type":"string","description":""}}},"description":""}},"description":""},"portVlanPrioritySettings":{"type":"object","properties":{"configType":{"type":"string","description":""},"items":{"type":"array","items":{"type":"object","properties":{"configType":{"type":"string","description":""},"priority":{"type":"integer","description":""},"vlans":{"type":"string","description":""}}},"description":""}},"description":""}}},"description":""}},"description":""},"switchportInterfaceConfig":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"configType":{"type":"string","description":""},"interfaceName":{"type":"string","description":""},"description":{"type":"string","description":""},"mode":{"type":"string","description":""},"accessVlan":{"type":"integer","description":""},"adminStatus":{"type":"string","description":""},"trunkAllowedVlans":{"type":"string","description":""},"nativeVlan":{"type":"integer","description":""}}},"description":""}},"description":""},"trunkInterfaceConfig":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"configType":{"type":"string","description":""},"interfaceName":{"type":"string","description":""},"isProtected":{"type":"boolean","description":""},"isDtpNegotiationEnabled":{"type":"boolean","description":""},"pruneEligibleVlans":{"type":"string","description":""}}},"description":""}},"description":""},"vlanConfig":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"configType":{"type":"string","description":""},"vlanId":{"type":"integer","description":""},"name":{"type":"string","description":""},"isVlanEnabled":{"type":"boolean","description":""}}},"description":""}},"description":""},"vtpGlobalConfig":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"configType":{"type":"string","description":""},"mode":{"type":"string","description":""},"version":{"type":"string","description":""},"isPruningEnabled":{"type":"boolean","description":""},"configurationFileName":{"type":"string","description":""},"sourceInterface":{"type":"string","description":""}}},"description":""}},"description":""},"vtpInterfaceConfig":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"configType":{"type":"string","description":""},"interfaceName":{"type":"string","description":""},"isVtpEnabled":{"type":"boolean","description":""}}},"description":""}},"description":""}},"description":""}},"description":""},"version":{"type":"string","description":""}},"description":"","$$ref":"#/components/schemas/GetConfigurationsForIntendedLayerFeaturesOnAWiredDeviceResponse"}}}},"400":{"description":"Invalid request error message. Example: {\"response\": { \"errorCode\": \"NCCO00000\", \"message\": \"Bad Request.\", \"detail\": \"Detail message.\" }, \"version\": \"1.0\"}","content":{}},"404":{"description":"The requested resource not found error message.","content":{}},"500":{"description":"An Internal error message. Example: {\"response\": { \"errorCode\": \"NCCO00000\", \"message\": \"Internal Error Message.\", \"detail\": \"Detail message.\" }, \"version\": \"1.0\"}","content":{}}},"x-rapi-id":"f1a7-b844-4cba-833c","x-rapi-overview":"This API returns the configurations for the intended layer 2 features on a wired device. Even after the intended configurations are deployed using the API /intent/api/v1/networkDevices/{id}/configFeatures/intended/deploy, they continue to be a part of the intended features on the device.","x-rapi-domain":"Connectivity","x-rapi-subdomain":"Wired","x-rapi-version":"1.0.0","x-rapi-internalPath":"/api/provisioning/v3/campus-automation/intent/api/v1/wired/networkDevices/${id}/configFeatures/intended/layer2","x-rapi-publicPath":"/dna/intent/api/v1/intent/api/v1/wired/networkDevices/${id}/configFeatures/intended/layer2","x-rapi-registerInKONG":true,"x-rapi-banner":[],"x-rapi-rateLimiting":"50~MINUTE","__originalOperationId":"getConfigurationsForIntendedLayer2FeaturesOnAWiredDevice.","method":"get","path":"/dna/intent/api/v1/intent/api/v1/wired/networkDevices/{id}/configFeatures/intended/layer2"}}