ExtremeCloud IQ Controller User Guide Version 10.10.01
>
Administration
>
ExtremeCloud IQ Controller Applications
>
REST API Access for Docker Container Applications
> Delete API Keys
Published June 01, 2024
Search this document
Print this page
Email this page
View PDF
Previous
Next
Preface
Conventions
Text Conventions
Documentation and Training
Send Feedback
Help and Support
AP Regulatory Information
Welcome to ExtremeCloud IQ Controller
The Appliance
Appliance Product Family
Wireless AP Overview
Support for World-Wide Universal Access Points with Wi-Fi 6E Technology
World-Wide Universal Access Points Compliance Regions
AP3000 Series Radios and 6 GHz Support
AP4000/AP4000-1 Radios and 6 GHz Support
AP5000 Series Radios and 6 GHz Support
AP5000 Series Power Management
6 GHz Channel Allocation and Notation
Universal AP Operational Modes
AP Client Bridge
Managing Client Bridge in ExtremeCloud IQ Controller
GRE Point-to-Point Tunnel
Cloud Visibility
Sites Overview
Centralized Site
Use Case: Large Centralized Site
Device Groups
Profiles
RF Management
Floor Plans
Position Aware Services
Position Aware Deployment
Floor Plan Limits
Navigate the User Interface
Search Facility
Configuring Column Display
Understanding Date and Time
Dashboard
Add a New Dashboard
Modify a Dashboard
Utilization Stats by Network SSID
Availability Link Status
Monitor
Sites List
Site Default Dashboard
Venue Dashboard
Network Snapshot: Sites
Radio Settings Buttons
Floor Plan View
Viewing a Floor Plan
User Interface Controls
Assigning Badges
Device Context Menu
Filtering Floor Plan By Badge Information
Understanding Readiness Maps
Positioning Heatmaps
Smart RF Widgets Per Site
Clients
Understanding Client Status
Client Access Lists
Global Client Access Lists
Site Client Access Lists
Client Address Protection Lists
Client Actions
Network Snapshot: Clients Dashboard
Station Events
Client Widgets
Device List
Access Points List
Understanding Access Point States
Query Builder
Build a Query for Devices or Clients
Visualize a Query
Support for ExtremeWireless AP3xx Access Points
Support for ExtremeWireless AP4xx Access Points
Support for ExtremeWireless AP5xx Access Points
Network Snapshot: AP Details
AP Widgets
LLDP Switch Port Connectivity
AP Tunnel Information
Troubleshooting
Smart RF Widgets Per Device
Channel Inspector Report — Smart RF
AP Events
View AP Events — Single Access Point
Switches List
Understanding Switch States
Network Snapshot: Switch Details
Switch Widgets
PoE Budget AP Estimator
Ports List
Port Dashboard
LAG Ports
Traces
Troubleshoot a Switch Using the CLI
VLANS
Networks List
Network Snapshot: Network Dashboard
Network Widgets
Mesh Point Network Diagram
Policy
Roles List
Preconfigured Policy Roles
Role Widgets
Rule-Level Statistics
Configure
Sites List
Devices
Access Points
AP Actions
Adoption Preference Override
Multiple APs Event Level Override
AP Certificates
Generate CSR
Apply Signed Certificate
Add APs
Configure AP Details and Radio Settings
Channel Select Dialog
Configuring RF Management
AP Feature Restrictions in Low Power Mode
Advanced AP Settings
Advanced Setting Overrides
IP Address Assignment
AP Location Information
Professional Install Settings
AP305CX Professional Install
AP310e/AP360e Professional Install Settings
AP410e Professional Install Settings
AP460e Professional Install Settings
AP510e Professional Install Settings
AP560h Professional Install
AP3000X Professional Install Settings
AP5050D Professional Install Settings
Switches
Switch Actions
Understanding Switch States
Adding a Switch
Configure a Switch
LAG Configuration
Switch Port Configuration
Advanced Switch Settings
Access the Switch CLI
Tunnel Concentrators
Configure VPN Concentrators
Assign Devices to Site
Networks
WLAN Service Settings
Privacy Settings WPA3
Settings for WPA3 Personal with SAE and H2E
Settings for WPA3 Enterprise
WPA3-Enterprise with 192-bit mode
Privacy Settings WPA2
Privacy Settings for WPA2 with PSK
Privacy Settings for WPA2 Enterprise with RADIUS
Privacy Settings for WEP
Mesh Point Network
Configure a Mesh Point Network
Mesh Point Network Settings
Transparent Bridge
Hotspot
Hotspot WBA OpenRoaming
Configure Hotspot for WBA OpenRoaming
Configure Hotspot
Hotspot Identification
SP Identification
Network Characteristics
Online Signup
Configuring the OSU Service Provider
Captive Portal Settings
Internal Captive Portal Settings
External Captive Portal Settings
Centralized Web Authentication
CWA Network Settings
CWA Policy Redirection Role
ExtremeGuest Captive Portal Settings
Walled Garden Rules
Adding Walled Garden Rules
Captive Portal Redirect Port List
Advanced Network Settings
Configuring DSCP Classification
Vendor Specific Attributes
Managing a Network Service
Band Steering
Network Configuration Steps
Sites
Add a Site
Site Parameters
Modifying Site Configuration
RADIUS Configuration for Switches Per Site
Site Location
Adding Device Groups to a Site
Device Group Parameters
Add or Edit a Configuration Profile
Associated Profiles
Associated Networks
Mesh Point Profile Configuration
Advanced Configuration and Mesh Device Settings
Configure Client Bridge
Understand Radio Mode
Radio as a Sensor
Advanced AP Radio Settings
VLAN Profile Settings
AirDefense Profile Settings
ADSP Support on .11ax APs
ESL Profile Settings
IoT Profile Settings
Generic BLE Scan Settings
iBeacon Settings
iBeacon Scan Settings
Eddystone-url Beacon Settings
Eddystone-url Scan Settings
Positioning Profile Settings
Analytics Profile Settings
RTLS Settings
Advanced Configuration Profile Settings
Session Persistence
Configuring RF Management
Basic RF Management Settings
Channel and Power Settings
Understanding Smart RF and Channel Width
Configuring a Channel Plan
Configuring ACS RF Policy
Interference Recovery Settings for ACS
Configuring Smart RF Policy
Scan Settings for Smart RF
Neighbor Recovery Settings for Smart RF
Interference Recovery Settings for Smart RF
Select Shutdown Settings
Configuring a Floor Plan
Displaying an Existing Floor Plan
Use Case: Device Group Filtering
Displaying Floors with Non-Assigned APs and Empty Floors
Use Case: Importing A Floor Plan with Unknown APs
Add a New Floor Plan
Floor Plan Settings
Importing or Exporting a Floor Plan
Setting a Background Image
Setting Floor Plan Scale
Drawing Boundary Walls
Drawing Inner Walls
Placing Devices
Configuring AP Orientation
Configuring Camera AP Angle
Configuring Floor Plan Zones
Deleting APs from the Map
Site Allow List/Deny List
Configure IP Address Protection List
Advanced Tab
Adoption Preference
Policy
Configuring Roles
Add Policy Roles
Policy Role Settings
Policy Rules for OSI L2 to L4
Configuring L2 Rules
Configuring L3, L4 Rules
Application (Layer 7) Rules
Configuring L7 Application Rules
Adding Custom Apps to the Application List
Custom Application Settings
Class of Service
Configuring CoS
Configuring ToS/DSCP
Bandwidth Rate
VLANS
Configuring VLANS
VLAN Advanced Setting
Pre-defined Multicast Rules
Configuring a Multicast Rule
Local DHCP Management Settings
Fabric Attach Topology
VxLAN Topology
Configuring a VxLAN in ExtremeCloud IQ Controller
VxLAN ExtremeXOS Considerations
GRE Topology
Configure a GRE Topology
VLAN Groups
VLAN Group Settings
Configuring Rates
AAA RADIUS Authentication
AAA Policy Network Configuration
NAI Routing and Dynamic Discovery
AAA Policy Settings for NAI Routing
Configure a Regular Expression Realm
AAA Policy Settings
RADIUS Settings
Automatic Adoption
Adoption Rules
Adding or Editing Adoption Rules
Configure AP Adoption Rule
Configure Switch Adoption Rule
Pattern-Based Matching
Configure Device Redirection
Adoption Rule Filters
Deleting Adoption Rules
ExtremeGuest Integration
ExtremeGuest Server Settings
Callback Manager
Onboard
Onboard AAA Authentication
Setting Default AAA Config
Managing RADIUS Servers
RADIUS Settings
Advanced RADIUS Settings
LDAP Configurations
LDAP Configuration Settings
LDAP Schema Definition Settings
LDAP Test Results
Managing The Local Password Repository
User Account Settings
Certificates
Generate Browser Certificates
Generate RADIUS Server Certificates
AAA Certificate Authorities
Manage Captive Portal
Portal Website Configuration
Guest Portal: Guest Web Access
Guest Portal: Guest Registration
Authentication with Third-party Credentials
Third-party Registration Requirements
Authenticated Portal: Authenticated Web Access
Authenticated Portal: Authenticated Registration Settings
Look and Feel Settings
Portal Network Configuration
Portal Administration Configuration
Login Configuration Settings
Message String Settings
Manage Access Control Groups
Access Control Group Settings
Working with Group Entries
Cloning Groups
Default Groups Provided with Your Installation
Access Control Rules
Configuring Network Policy Roles and Dynamic Access Control
Managing Access Control Rules
Default Rules for Captive Portal
Rule Settings
Tools
AFC Explorer
View a Projected Coverage Area
Workflow
Navigating ExtremeCloud IQ Controller Using Workflow
How to Navigate Using Workflow
Adding Components from Workflow
Deleting Components from Workflow
Modifying a Component
Logs
Advanced Filtering
Build a Query for Logs
View Events
View Station Events
View Audit Events
View All AP Events
View Smart RF Events
Set a Logging Filter
AP Upgrade Report
Diagnostics
System Health Best Practice Widget
Configuration Best Practices
Operational Best Practices
Network Health Widget
Network Health Reports
Smart Poll
Network Utilities
TCP Dump Management
AP Service Tab
AP Test Suites
Test Suite Parameters
Optional Parameters for Each Test
AP Test Run
Test Run Parameters
Example Testing Script
AP Test Results
Test Result Details
RADIUS Servers
AFC Server Status tab
Reports
Create Report Template
Define Venue User Groups
Run Report
Schedule Report
Report Settings
Generated Reports
Administration
System Configuration
Interfaces
Add an Interface
Add a Management Access Rule
Multiple LAG Interface Support
Add a Static Route
L2 Port Details
Network Time
Software Upgrade
Perform a Configuration Backup
Configure a Backup Schedule
Restoring a Backup File
Copy Backup
Upgrade Software
Rescue Image
Copy Upgrade Image
Remote Server Properties
Configuring an Upgrade Schedule
View Upgrade Logs
Upgrade AP Images
Install AP Firmware Image
Maintenance
Availability
Session Availability
Availability Pair Settings
Mobility Settings
Configuration Updates with an Availability Pair
Settings
SNMP Configuration
Working with SNMPv2 Communities
Working with SNMPv3 Users
Working with SNMP Notifications
MAC Format
AP Transmit Power Representation
External NAT
Broadcast Multicast Traffic Control
Web Proxy
Dynamic Authorization Server Configuration
System Logging Configuration
System Information
Trust Points
Add a Trust Point
Manage Administrator Accounts
Manage RADIUS Servers for User Authentication
Custom User Account Access
ExtremeCloud IQ Controller Applications
Install an Application
Configuration Template Details
Access an Application
Upgrade an Application
Uninstall an Application
Application Details
Extreme Defender for IoT
Scheduler for ExtremeCloud IQ Controller
AirDefense Base Application
REST API Access for Docker Container Applications
Generate API Keys
Delete API Keys
Associate API Key File with a Docker Application
Remove a Configuration File from a Docker Application
Product Subscription License
Licensed Devices
Generate and Install the Activation Package
Air Gap Licensing File
Install Air Gap File
Revoke Air Gap License
Upgrade to ExtremeCloud IQ Controller
Licensing States
Entitlement Health Checks
Licensing an Availability Pair
License Details
Entitlements
Activations
Delete API Keys
Generated API keys are listed on the user account page. To delete a key:
Go to
Administration
>
Accounts
.
.
Select a user account.
Select a key from the API Keys list, and select
.
A verification message displays.
To delete the API key file, click
OK
.
Generate API Keys
.
