{"type":"api","title":"Get RF Profile by ID","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":"getRFProfileByID","tags":["Wireless"],"summary":"Get RF Profile by ID","deprecated":false,"description":"This API allows the user to get a RF Profile by RF Profile ID\n\n","parameters":[{"name":"id","description":"RF Profile ID","required":true,"schema":{"type":"string","default":"application/json"},"in":"path"}],"responses":{"200":{"description":"Request was successful and the result is contained in the response body","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"type":"object","properties":{"rfProfileName":{"type":"string","description":"RF Profile Name"},"defaultRfProfile":{"type":"boolean","description":"True if RF Profile is default, else False. Maximum of only 1 RF Profile can be marked as default at any given time"},"enableRadioTypeA":{"type":"boolean","description":"True if 5 GHz radio band is enabled in the RF Profile, else False"},"enableRadioTypeB":{"type":"boolean","description":"True if 2.4 GHz radio band is enabled in the RF Profile, else False"},"enableRadioType6GHz":{"type":"boolean","description":"True if 6 GHz radio band is enabled in the RF Profile, else False"},"enableCustom":{"type":"boolean","description":"True if RF Profile is custom, else False for system RF profiles like Low, High and Medium (Typical)"},"radioTypeAProperties":{"type":"object","properties":{"parentProfile":{"type":"string","enum":["HIGH","TYPICAL","LOW","CUSTOM","GLOBAL"],"description":"Parent profile of 5 GHz radio band"},"radioChannels":{"type":"string","description":"DCA channels of 5 GHz radio band passed in comma separated format without any spaces. Permissible values: 36, 40, 44, 48, 52, 56, 60, 64, 100, 104, 108, 112, 116, 120, 124, 128, 132, 136, 140, 144, 149, 153, 157, 161, 165, 169, 173"},"dataRates":{"type":"string","description":"Data rates of 5 GHz radio band passed in comma separated format without any spaces. Permissible values: 6, 9, 12, 18, 24, 36, 48, 54"},"mandatoryDataRates":{"type":"string","description":"Mandatory data rates of 5 GHz radio band passed in comma separated format without any spaces and must be a subset of selected dataRates with maximum of 2 values. Permissible values: 6, 9, 12, 18, 24, 36, 48, 54"},"powerThresholdV1":{"type":"integer","description":"Power threshold of 5 GHz radio band"},"rxSopThreshold":{"type":"string","enum":["HIGH","MEDIUM","LOW","AUTO","CUSTOM"],"description":"RX-SOP threshold of 5 GHz radio band"},"minPowerLevel":{"type":"integer","description":"Minimum power level of 5 GHz radio band"},"maxPowerLevel":{"type":"integer","description":"Maximum power level of 5 GHz radio band"},"channelWidth":{"type":"string","enum":["20","40","80","160","best"],"description":"Channel Width"},"preamblePuncture":{"type":"boolean","description":"Enable or Disable Preamble Puncturing. This Wifi 7 configuration is applicable to wireless IOS devices supporting 17.15 and higher"},"zeroWaitDfsEnable":{"type":"boolean","description":"Zero Wait DFS is applicable only for IOS-XE based Wireless Controllers running 17.9.1 and above versions"},"customRxSopThreshold":{"type":"integer","description":"RX-SOP threshold custom configuration of 5 GHz radio band"},"maxRadioClients":{"type":"integer","description":"Client Limit of 5 GHz radio band"},"fraPropertiesA":{"type":"object","properties":{"clientAware":{"type":"boolean","description":"Client Aware of 5 GHz radio band"},"clientSelect":{"type":"integer","description":"Client Select(%) of 5 GHz radio band"},"clientReset":{"type":"integer","description":"Client Reset(%) of 5 GHz radio band"}},"description":"Configure FRA 5 GHzProperties"},"coverageHoleDetectionProperties":{"type":"object","properties":{"chdClientLevel":{"type":"integer","description":"Coverage Hole Detection Client Level"},"chdDataRssiThreshold":{"type":"integer","description":"Coverage Hole Detection Data Rssi Threshold"},"chdVoiceRssiThreshold":{"type":"integer","description":"Coverage Hole Detection Voice Rssi Threshold"},"chdExceptionLevel":{"type":"integer","description":"Coverage Hole Detection Exception Level(%)"}},"description":"Configure Coverage Hole Detection Properties"},"spatialReuseProperties":{"type":"object","properties":{"dot11axNonSrgObssPacketDetect":{"type":"boolean","description":"Dot11ax Non SRG OBSS PD"},"dot11axNonSrgObssPacketDetectMaxThreshold":{"type":"integer","description":"Dot11ax Non SRG OBSS PD Max Threshold"},"dot11axSrgObssPacketDetect":{"type":"boolean","description":"Dot11ax SRG OBSS PD"},"dot11axSrgObssPacketDetectMinThreshold":{"type":"integer","description":"Dot11ax SRG OBSS PD Min Threshold"},"dot11axSrgObssPacketDetectMaxThreshold":{"type":"integer","description":"Dot11ax SRG OBSS PD Max Threshold"}},"description":"Spatial Reuse Properties."}},"description":"Properties of 5 GHz radio band"},"radioTypeBProperties":{"type":"object","properties":{"parentProfile":{"type":"string","enum":["HIGH","TYPICAL","LOW","CUSTOM","GLOBAL"],"description":"Parent profile of 2.4 GHz radio band"},"radioChannels":{"type":"string","description":"DCA channels of 2.4 GHz radio band passed in comma separated format without any spaces. Permissible values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14"},"dataRates":{"type":"string","description":"Data rates of 2.4 GHz radio band passed in comma separated format without any spaces. Permissible values: 1, 2, 5.5, 6, 9, 11, 12, 18, 24, 36, 48, 54"},"mandatoryDataRates":{"type":"string","description":"Mandatory data rates of 2.4 GHz radio band passed in comma separated format without any spaces and must be a subset of selected dataRates with maximum of 2 values. Permissible values: 1, 2, 5.5, 6, 9, 11, 12, 18, 24, 36, 48, 54"},"powerThresholdV1":{"type":"integer","description":"Power threshold of 2.4 GHz radio band"},"rxSopThreshold":{"type":"string","enum":["HIGH","MEDIUM","LOW","AUTO","CUSTOM"],"description":"RX-SOP threshold of 2.4 GHz radio band"},"minPowerLevel":{"type":"integer","description":"Minimum power level of 2.4 GHz radio band"},"maxPowerLevel":{"type":"integer","description":"Maximum power level of 2.4 GHz radio band"},"customRxSopThreshold":{"type":"integer","description":"RX-SOP threshold custom configuration of 2.4 GHz radio band"},"maxRadioClients":{"type":"integer","description":"Client Limit of 2.4 GHz radio band"},"coverageHoleDetectionProperties":{"type":"object","properties":{"chdClientLevel":{"type":"integer","description":"Coverage Hole Detection Client Level"},"chdDataRssiThreshold":{"type":"integer","description":"Coverage Hole Detection Data Rssi Threshold"},"chdVoiceRssiThreshold":{"type":"integer","description":"Coverage Hole Detection Voice Rssi Threshold"},"chdExceptionLevel":{"type":"integer","description":"Coverage Hole Detection Exception Level(%)"}},"description":"Configure Coverage Hole Detection Properties"},"spatialReuseProperties":{"type":"object","properties":{"dot11axNonSrgObssPacketDetect":{"type":"boolean","description":"Dot11ax Non SRG OBSS PD"},"dot11axNonSrgObssPacketDetectMaxThreshold":{"type":"integer","description":"Dot11ax Non SRG OBSS PD Max Threshold"},"dot11axSrgObssPacketDetect":{"type":"boolean","description":"Dot11ax SRG OBSS PD"},"dot11axSrgObssPacketDetectMinThreshold":{"type":"integer","description":"Dot11ax SRG OBSS PD Min Threshold"},"dot11axSrgObssPacketDetectMaxThreshold":{"type":"integer","description":"Dot11ax SRG OBSS PD Max Threshold"}},"description":"Spatial Reuse Properties."}},"description":"Properties of 2.4 GHz radio band"},"radioType6GHzProperties":{"type":"object","properties":{"parentProfile":{"type":"string","enum":["CUSTOM"],"description":"Parent profile of 6 GHz radio band"},"radioChannels":{"type":"string","description":"DCA channels of 6 GHz radio band passed in comma separated format without any spaces. Permissible values: 1, 5, 9, 13, 17, 21, 25, 29, 33, 37, 41, 45, 49, 53, 57, 61, 65, 69, 73, 77, 81, 85, 89, 93, 97, 101, 105, 109, 113, 117, 121, 125, 129, 133, 137, 141, 145, 149, 153, 157, 161, 165, 169, 173, 177, 181, 185, 189, 193, 197, 201, 205, 209, 213, 217, 221, 225, 229, 233"},"dataRates":{"type":"string","description":"Data rates of 6 GHz radio band passed in comma separated format without any spaces. Permissible values: 6, 9, 12, 18, 24, 36, 48, 54"},"mandatoryDataRates":{"type":"string","description":"Mandatory data rates of 6 GHz radio band passed in comma separated format without any spaces and must be a subset of selected dataRates with maximum of 2 values. Permissible values: 6, 9, 12, 18, 24, 36, 48, 54"},"powerThresholdV1":{"type":"integer","description":"Power threshold of 6 GHz radio band"},"rxSopThreshold":{"type":"string","enum":["HIGH","MEDIUM","LOW","AUTO","CUSTOM"],"description":"RX-SOP threshold of 6 GHz radio band"},"minPowerLevel":{"type":"integer","description":"Minimum power level of 6 GHz radio band"},"maxPowerLevel":{"type":"integer","description":"Maximum power level of 6 GHz radio band"},"enableStandardPowerService":{"type":"boolean","description":"True if Standard Power Service is enabled, else False"},"multiBssidProperties":{"type":"object","properties":{"dot11axParameters":{"type":"object","properties":{"ofdmaDownLink":{"type":"boolean","description":"OFDMA Downlink"},"ofdmaUpLink":{"type":"boolean","description":"OFDMA Uplink"},"muMimoUpLink":{"type":"boolean","description":"MU-MIMO Uplink"},"muMimoDownLink":{"type":"boolean","description":"MU-MIMO Downlink"}},"description":"802.11ax Parameters"},"dot11beParameters":{"type":"object","properties":{"ofdmaDownLink":{"type":"boolean","description":"OFDMA Downlink"},"ofdmaUpLink":{"type":"boolean","description":"OFDMA Uplink"},"muMimoUpLink":{"type":"boolean","description":"MU-MIMO Uplink"},"muMimoDownLink":{"type":"boolean","description":"MU-MIMO Downlink"},"ofdmaMultiRu":{"type":"boolean","description":"OFDMA Multi-RU"}},"description":"802.11be Parameters"},"targetWakeTime":{"type":"boolean","description":"Target Wake Time"},"twtBroadcastSupport":{"type":"boolean","description":"TWT Broadcast Support"}},"description":"Multi BSSID Properties"},"preamblePuncture":{"type":"boolean","description":"Enable or Disable Preamble Puncturing. This Wifi 7 configuration is applicable to wireless IOS devices supporting 17.15 and higher"},"minDbsWidth":{"type":"integer","description":"Minimum DBS Width ( Permissible values : 20,40,80,160,320)"},"maxDbsWidth":{"type":"integer","description":"Maximum DBS Width (Permissible Values: 20,40,80,160,320)"},"customRxSopThreshold":{"type":"integer","description":"RX-SOP threshold custom configuration of 6 GHz radio band"},"maxRadioClients":{"type":"integer","description":"Client Limit of 6 GHz radio band"},"pscEnforcingEnabled":{"type":"boolean","description":"PSC Enforcing Enable for 6 GHz radio band"},"discoveryFrames6GHz":{"type":"string","enum":["None","Broadcast Probe Response","FILS Discovery"],"description":"Discovery Frames of 6 GHz radio band"},"broadcastProbeResponseInterval":{"type":"integer","description":"Broadcast Probe Response Interval of 6 GHz radio band"},"fraPropertiesC":{"type":"object","properties":{"clientResetCount":{"type":"integer","description":"Client Reset Count of 6 GHz radio band"},"clientUtilizationThreshold":{"type":"integer","description":"Client Utilization Threshold of 6 GHz radio band"}},"description":"Configure FRA 6 GHz Properties"},"coverageHoleDetectionProperties":{"type":"object","properties":{"chdClientLevel":{"type":"integer","description":"Coverage Hole Detection Client Level"},"chdDataRssiThreshold":{"type":"integer","description":"Coverage Hole Detection Data Rssi Threshold"},"chdVoiceRssiThreshold":{"type":"integer","description":"Coverage Hole Detection Voice Rssi Threshold"},"chdExceptionLevel":{"type":"integer","description":"Coverage Hole Detection Exception Level(%)"}},"description":"Configure Coverage Hole Detection Properties"},"spatialReuseProperties":{"type":"object","properties":{"dot11axNonSrgObssPacketDetect":{"type":"boolean","description":"Dot11ax Non SRG OBSS PD"},"dot11axNonSrgObssPacketDetectMaxThreshold":{"type":"integer","description":"Dot11ax Non SRG OBSS PD Max Threshold"},"dot11axSrgObssPacketDetect":{"type":"boolean","description":"Dot11ax SRG OBSS PD"},"dot11axSrgObssPacketDetectMinThreshold":{"type":"integer","description":"Dot11ax SRG OBSS PD Min Threshold"},"dot11axSrgObssPacketDetectMaxThreshold":{"type":"integer","description":"Dot11ax SRG OBSS PD Max Threshold"}},"description":"Spatial Reuse Properties."}},"description":"Properties of 6 GHz radio band"},"id":{"type":"string","description":"RF Profile ID"}},"description":""},"version":{"type":"string","description":"Version"}},"description":"","$$ref":"#/components/schemas/GetRFProfileByIDResponse"}}}},"400":{"description":"Request failed due to malformed request syntax","content":{}},"404":{"description":"Request failed because the resource does not exist","content":{}},"500":{"description":"Request failed because of unknown failure on the server","content":{}}},"x-rapi-id":"3298-aa56-4ec9-b510","x-rapi-overview":"This API allows the user to get a RF Profile by RF Profile ID\n\n","x-rapi-domain":"Connectivity","x-rapi-subdomain":"Wireless","x-rapi-version":"1.0.0","x-rapi-internalPath":"/intent/api/v1/wirelessSettings/rfProfiles/${id}","x-rapi-publicPath":"/dna/intent/api/v1/wirelessSettings/rfProfiles/${id}","x-rapi-registerInKONG":true,"x-rapi-banner":["Intent"],"x-rapi-rateLimiting":"100~MINUTE","__originalOperationId":"getRFProfileByID","method":"get","path":"/dna/intent/api/v1/wirelessSettings/rfProfiles/{id}"}}