// MCP TOOL REFERENCE

TPLINK OMADA TOOLS

327 tools from the Tplink Omada MCP Server, categorised by risk level.

View the Tplink Omada policy →
// ALL 327 TPLINK OMADA TOOLS
READ 324 tools
Read getAccessControl Get controller access control configuration. Shows which IP ranges are permitted to access the Omada contro... Read getAclConfigTypeSetting Get the ACL configuration type setting for the site gateway (L2 or L3 mode). Determines how ACL rules are e... Read getAdvancedVpnSetting Get advanced VPN configuration settings for a site, including general VPN parameters and default settings. Read getAlg Get ALG (Application Layer Gateway) configuration for the site gateway. ALG enables inspection of specific ... Read getAllCloudUsers Get all cloud users configured on the controller, excluding the root account. Read getAllDeviceBySite Get all devices in a site including offline and disconnected devices. Unlike listDevices which may filter t... Read getAllLocalUsers Get all local users configured on the controller, excluding the root account. Read getAllRoles [DEPRECATED] Use getUserRoleProfile instead. Same GET /roles endpoint. Get all user roles configured on the... Read getAllUsersApp Get all users (both cloud and local) in a grid/app view format. Read getApDetail Fetch full configuration and status for a specific access point: model, firmware, CPU/memory, connected cli... Read getApGeneralConfig Get general configuration for an access point. Returns device name, LED settings, country/region, managemen... Read getApIpv6Config Get IPv6 configuration for a specific access point. Read getApLldpConfig Get LLDP (Link Layer Discovery Protocol) configuration for an access point. Returns enabled state and adver... Read getApLoadBalance [DEPRECATED] Use getSitesApsLoadBalance instead. Same endpoint, retained for backward compatibility. getSit... Read getApOfdmaConfig [DEPRECATED] Use getSitesApsOfdma instead. Same endpoint, retained for backward compatibility. getSitesApsO... Read getAppControlCategories Get application control categories (families) for a site, listing available app category definitions used i... Read getAppControlRules Get application control rules for a site, listing application-level firewall rules that allow or block spec... Read getAppGroupProfile [DEPRECATED] Get MAC group profiles for a site. This is an alias for getGroupPolicyDetail with groupType= Read getApplicationAcl [DEPRECATED] Get application control rules for a site. This is an alias for getAppControlRules — use getApp... Read getApplicationControlStatus Get application control (DPI) status and configuration for a site. Read getApQosConfig Get QoS configuration for a specific access point. Read getApRadios Get radio status for a specific access point: 2.4GHz and 5GHz band config, channel, TX power, channel utili... Read getApSnmpConfig Get SNMP configuration for an access point. Returns SNMP version, community strings, trap settings, and ena... Read getApUplinkConfig Get the uplink configuration for an access point. Returns uplink mode (wired/wireless mesh), preferred upli... Read getApVlanConfig Get VLAN configuration for an access point. Returns the AP Read getAttackDefenseSetting Get the DDoS and attack defense configuration, including flood protection settings and thresholds. Read getAuditLogSettingForGlobal Get global audit log notification settings for the controller. Read getAuditLogSettingForSite Get site-level audit log notification settings, including audit event recipients and filter rules. Read getAuditLogsForGlobal Get global audit logs (paginated). Records all administrative operations across the controller. Supports op... Read getAvailableRoles Get the list of roles available for assignment to users. Read getBackupFileList Get the list of available controller backup files. Read getBackupResult Get the result of the most recent controller backup operation. Read getBandSteeringSetting Get the band steering configuration. Band steering encourages dual-band clients to connect on 5GHz or 6GHz ... Read getBandwidthControl Get the global bandwidth control configuration for the site. Shows whether bandwidth control is enabled and... Read getBandwidthCtrl [DEPRECATED] Use getBandwidthControl instead. Same GET .../bandwidth-control endpoint. Get the global bandw... Read getBandwidthCtrlDetail Get gateway bandwidth control detail settings for a site, including per-IP and per-SSID bandwidth limits. Read getBeaconControlSetting Get the beacon control setting, which manages 802.11 beacon transmission parameters on access points. Read getBuiltinRadiusUsers Get the built-in RADIUS server user list for a site (paginated), including username and associated VLAN/gro... Read getCableTestFullResults Get full cable test results for all ports on a switch. Returns detailed per-port diagnostic data including ... Read getCableTestLogs Get cable test logs for a switch. Returns history of cable diagnostics including per-port test results, cab... Read getCertificate Get the SSL/TLS certificate configuration for the controller. Read getChannelLimitSetting [DEPRECATED] Get the channel limit setting that restricts which channels access points are allowed to use o... Read getChannels Get channel distribution and utilization across all APs. Shows which WiFi channels (2.4 GHz, 5 GHz, 6 GHz) ... Read getClient [DEPRECATED] Use listClients instead. When you have a client MAC, getClientDetail is also available. This t... Read getClientActiveTimeout Get the client inactivity timeout setting. Clients are marked inactive after this period of no traffic. Read getClientDetail Get full detail for a specific client by MAC address, including connection info, IP, VLAN, signal strength,... Read getClientHistoryDataEnable Get the client history data collection enable/disable setting for the controller. Read getClientsDistribution Get client count distribution by connection type and band (wired, 2.4GHz, 5GHz, 6GHz). Useful for understan... Read getClientToSiteVpnServerInfo Get detailed configuration for a specific client-to-site VPN server by ID, including protocol, port, authen... Read getCloudAccessStatus Get the current cloud access status for the controller, including connection state and cloud ID. Read getCloudUserInfo Get cloud user account information for the currently authenticated cloud user. Read getControllerPort Get the controller port configuration used for device adoption and communication. Read getControllerStatus Get the Omada controller health and status, including running state, uptime, and resource usage. Read getDashboardMostActiveEaps Get the most active access points (EAPs) in a site, sorted by traffic volume. Read getDashboardMostActiveSwitches Get the most active switches in a site, sorted by traffic volume. Read getDashboardOverview Get the site overview topology: device counts (gateways, switches, APs), client counts (wired, wireless, gu... Read getDashboardPoEUsage Get PoE (Power over Ethernet) usage statistics for a site, showing power consumption per switch. Read getDashboardSwitchSummary Get switch summary for a site dashboard: total switch count, total ports, active ports, PoE budget used vs ... Read getDashboardTopCpuUsage Get the top devices by CPU usage for a site, useful for identifying overloaded devices. Read getDashboardTopMemoryUsage Get the top devices by memory usage for a site, useful for identifying memory-constrained devices. Read getDashboardTrafficActivities Get traffic activity time-series data for a site, showing upload and download trends over time. Read getDashboardWifiSummary Get WiFi summary for a site dashboard: total APs, connected AP count, wireless client count, channel utiliz... Read getDataRetention Get the data retention settings for the controller, including how long logs and statistics are stored. Read getDdnsGrid Get DDNS (Dynamic DNS) entries for the site gateway. Each entry maps a hostname to the current WAN IP via a... Read getDevice [DEPRECATED] Use listDevices instead. Filters the site device list in-process. No dedicated per-device deta... Read getDeviceAccessManagement Get the device access management settings, controlling which devices can be managed. Read getDeviceTagList Get the list of device tags defined in a site. Read getDhcpReservationGrid Get DHCP reservations for the site. Each reservation maps a client MAC address to a fixed IP address. Pagin... Read getDisableNatList Get the list of wired networks with NAT disabled for the site gateway. Read getDnsCacheDataList Get the DNS cache data list for the site. Read getDnsCacheSetting Get DNS cache setting for the site gateway. Shows whether DNS caching is enabled and the cache TTL configur... Read getDnsProxy Get DNS proxy configuration for the site gateway. Returns DNS proxy enabled state and upstream DNS server s... Read getDot1xConfig Get the 802.1X (dot1x) authentication configuration for a site, including enabled state, authentication mod... Read getDownlinkWiredDevices Get wired downlink devices connected to an access point Read getDscpConfig [DEPRECATED] Get DSCP/QoS tag outbound traffic configuration. This is an alias for getQosPolicy — use getQo... Read getEapDot1xSetting Get the 802.1X EAP setting for access points, controlling port-based authentication on wireless clients. Read getExperienceImprovement Get the experience improvement program setting for the controller (telemetry/diagnostics participation). Read getFirewallSetting Get firewall configuration and rules for a site, including ACL rules, IP groups, and security policies. Read getFirmwareInfo Get the latest available firmware information for a device. Returns current firmware version, latest availa... Read getFirmwareUpgradePlan Get the firmware upgrade plan list for devices managed by the controller. Read getGatewayDetail Fetch full configuration and status for a specific gateway: model, firmware, CPU/memory, WAN/LAN ports, rou... Read getGatewayLanStatus Get LAN port status for a specific gateway: port link state, speed, duplex, connected device, and VLAN assi... Read getGatewayPorts Get all WAN and LAN port details for a specific gateway: link status, speed, IP address, bytes in/out, and ... Read getGatewayQosClassRules Get the gateway QoS class rules for a site, including traffic classification rules and DSCP/priority markings. Read getGatewayWanStatus Get the WAN port status and connectivity information for a specific gateway. Returns WAN IP, DNS, uptime, l... Read getGeneralSettings Get the global general settings for the Omada controller, including controller name, language, and discover... Read getGlobalDashboardOverview Get global controller dashboard overview without client data, showing device counts, site counts, and netwo... Read getGlobalSecuritySetting [DEPRECATED] Use getThreatList instead. Same threat-management endpoint. Name was misleading. Get the globa... Read getGoogleLdapProfile Get the Google LDAP profile configuration for a site, including domain, binding credentials, and user/group... Read getGridAllowList Get the IPS allow list (paginated). Returns entries that are explicitly allowed to bypass IPS inspection. S... Read getGridAllowMacFiltering Get the MAC address allow-list entries (paginated). Clients on this list are permitted access when MAC filt... Read getGridAutoCheckUpgrade Get the auto-check upgrade plan list showing scheduled firmware upgrade checks across devices. Useful for a... Read getGridBandwidthCtrlRule Get bandwidth control rules for the site gateway. Each rule defines upload/download limits for matched traf... Read getGridBlockList Get the IPS block list (paginated). Returns entries that are explicitly blocked by the Intrusion Prevention... Read getGridClientHistory Get per-client connection history (paginated). Returns past connection sessions for a specific client inclu... Read getGridDashboardIpsecTunnelStats Get IPsec tunnel statistics for the site dashboard. Returns connection counts, traffic volumes, and tunnel ... Read getGridDashboardOpenVpnTunnelStats Get OpenVPN tunnel statistics for the site dashboard filtered by role. Returns connection counts, traffic v... Read getGridDashboardTunnelStats Get VPN tunnel statistics filtered by role. Returns connection counts, traffic volumes, and status for VPN ... Read getGridDenyMacFiltering Get the MAC address deny-list entries (paginated). Clients on this list are blocked from accessing the netw... Read getGridEapRule Get the URL filter AP rules (paginated). Returns URL-based filtering rules applied to wireless clients via ... Read getGridGatewayRule Get the URL filter gateway rules (paginated). Returns URL-based filtering rules applied to traffic through ... Read getGridIpMacBinding Get IP-MAC binding entries for the site. Each binding enforces that a given MAC address must use a specific... Read getGridIpsecFailover Get IPsec failover configuration (paginated). Returns failover rules that define backup tunnel behavior whe... Read getGridKnownClients Get historical known clients list (paginated). Returns clients that have previously connected to the site, ... Read getGridOtoNats Get 1:1 NAT rules for the site gateway. Each rule maps a public IP directly to a private host IP. Paginated. Read getGridPolicyRouting Get policy routing rules for the site gateway. Policy routes direct traffic based on source IP, destination... Read getGridSessionLimitRule Get per-rule session limit rules for the site gateway. Each rule limits concurrent sessions for matched tra... Read getGridSignature Get the IPS signature list (paginated). Returns known attack signatures used by the Intrusion Prevention Sy... Read getGridStaticRouting Get static routing rules for the site gateway with explicit pagination. Returns the list of manually config... Read getGridVirtualWan Get virtual WAN list for the site gateway. Virtual WANs allow multiple logical WAN connections over a singl... Read getGroupPolicyDetail Get group policy profiles for a site filtered by group type (IP Group, IP Port Group, MAC Group, IPv6 Group... Read getGroupProfilesByType Get group profiles filtered by type (e.g. IP groups, port groups, domain groups). Returns all group profile... Read getIgmp Get IGMP (Internet Group Management Protocol) setting for the site. Shows IGMP snooping and proxy configura... Read getInterfaceLanNetwork Get interface-level LAN network bindings. Optionally filter by type (0=WAN, 1=LAN). Returns per-interface V... Read getInterfaceLanNetworkV2 Get interface-level LAN network bindings (v2 API). Returns richer per-interface VLAN and network data. Opti... Read getInterference Get top RF interference sources detected by APs. Identifies nearby networks or devices causing wireless int... Read getInternet [DEPRECATED] Use getInternetInfo instead. Same GET .../internet endpoint. Get full WAN/Internet configurati... Read getInternetBasicPortInfo Get WAN port summary / basic info for the site gateway. Returns a concise view of WAN port status, connecti... Read getInternetInfo Get internet configuration information for a site, including WAN settings and connectivity details. Read getInternetLoadBalance Get WAN load balancing configuration for the site gateway. Returns load balancing mode (failover/load balan... Read getIpGroupProfile [DEPRECATED] Get IP group profiles for a site. This is an alias for getGroupPolicyDetail with groupType= Read getIpMacBindingGeneralSetting Get the IP-MAC binding global toggle setting. Shows whether IP-MAC binding enforcement is enabled site-wide. Read getIpsConfig Get the IPS (Intrusion Prevention System) global configuration, including enabled state and detection mode. Read getIpsecTunnelDetail Get detailed configuration for a specific site-to-site VPN (IPsec) tunnel by ID, including authentication, ... Read getIpsecTunnelList List all site-to-site VPN (IPsec) tunnels for a site, including tunnel name, remote IP, status, and protoco... Read getIpsecVpnStats Get IPsec VPN tunnel statistics for a site (paginated), including active IPsec tunnels, traffic metrics, an... Read getIptvSetting Get IPTV service configuration for the site. Read getIspBandScan Get ISP band scan results for a specific WAN port. Returns available frequency bands detected by the ISP scan. Read getIspLoad Get per-WAN ISP link load over a time range. Shows traffic volume and utilization per internet uplink. Usef... Read getLanClientCount Get client distribution breakdown across LAN segments (wired, wireless, guest) for the site. Read getLanDnsRules Get LAN DNS rules configured for the site. Read getLanNetworkList [DEPRECATED] Use getLanNetworkListV2 instead. This tool returns an aggregated array of all pages from the v... Read getLanNetworkListV2 Get the LAN network list using the v2 API. Returns richer VLAN and network data including subnet info and D... Read getLanProfileEsUsage Get EAP/switch device usage for a specific LAN profile. Returns which devices are using the profile. Requires Read getLanProfileList Get the list of LAN profiles configured in a site. LAN profiles define network settings that can be applied... Read getLdapProfileList List all LDAP authentication profiles configured on the site. Read getLldpSetting Get LLDP (Link Layer Discovery Protocol) global setting for the site. Shows whether LLDP is enabled and whi... Read getLogging Get the controller logging configuration, including log levels and storage settings. Read getLogSettingForGlobal Get global log notification settings (v1), including global alert recipients and notification rules. Read getLogSettingForGlobalV2 Get global log notification settings (v2), with extended notification configuration options. Read getLogSettingForSite Get site-level log notification settings (v1), including alert recipients and notification rules. Read getLogSettingForSiteV2 Get site-level log notification settings (v2), with extended notification configuration options. Read getLtePortConfig Get LTE/cellular WAN port configuration for the site gateway. Read getMacAuthSetting Get the MAC authentication global setting. MAC auth allows or denies clients based on their MAC address wit... Read getMacAuthSsids Get per-SSID MAC authentication settings showing which SSIDs have MAC auth enabled and their individual con... Read getMacFilterDetail Get the MAC filtering global settings for a site, including whether MAC filtering is enabled and the defaul... Read getMacFilteringGeneralSetting Get the MAC filtering global setting. Returns whether MAC-based allow/deny filtering is enabled site-wide. Read getMailServerStatus Get the mail server connection status for the controller. Read getMeshSetting Get the mesh networking configuration including mesh topology mode and uplink preferences. Read getMeshStatistics Get mesh link statistics for an access point. Returns wireless backhaul link quality, signal strength, thro... Read getMfaStatus Get the global multi-factor authentication (MFA) status for the controller. Read getMulticastRateLimit Get multicast rate limit settings for a site, controlling multicast traffic rates on the wireless network. Read getNtpSetting Get NTP server configuration and synchronisation status for the site. Read getOsgCustomAclList Get the custom gateway ACL rules list (paginated). Custom ACLs extend the standard gateway ACL rules with u... Read getOspfInterface Get OSPF interface configuration for the site gateway. Read getOspfNeighbors Get OSPF neighbor devices for the site gateway. Read getOspfProcess Get OSPF process configuration for the site gateway. Read getOswAclList Get the switch ACL list (paginated). Returns per-port or VLAN-based access control rules applied to managed... Read getOswStackLagList Get Link Aggregation Group (LAG) list for a switch stack. Returns configured LAG/trunk groups including mem... Read getOuiProfileList Get the OUI-based device profile list (paginated). OUI profiles associate device manufacturers with network... Read getPastClientNum Get historical client count trend over a time range. Returns a time-series of client counts to show how con... Read getPoeScheduleList Get the list of PoE (Power over Ethernet) schedules configured for a site. Read getPortalPort Get the portal port configuration for the controller web interface. Read getPortalProfile Get portal (captive portal) profiles for a site, listing configured hotspot portals with authentication met... Read getPortForwardingList Get a paginated page of NAT port forwarding rules for the site gateway. Returns the list of entries that ma... Read getPortForwardingStatus Get port forwarding status and rules for a site. Retrieves either User-configured or UPnP-discovered port f... Read getPortScheduleList Get the list of port schedules configured for a site. Read getPortSchedulePorts Get the list of ports with port schedule assignments for a site. Read getPpskNetworkProfile List Private PSK (PPSK) network profiles for a site by type. Returns profile names, authentication mode, an... Read getPPSKProfiles List Private PSK (PPSK) profiles for the site by type. PPSK allows assigning unique per-device or per-user ... Read getPpskUserGroup Get the PPSK user group details for a specific PPSK profile by ID, including users and their individual PSK... Read getPpskUserList [DEPRECATED] Get PPSK user list for a profile. This is an alias for getPpskUserGroup — use getPpskUserGroup... Read getQosMarkingRule [DEPRECATED] Get gateway QoS marking (tag outbound traffic) settings. This is an alias for getQosPolicy — u... Read getQosPolicy Get the gateway QoS policy (tag outbound traffic settings) for a site, including DSCP marking rules for out... Read getQosPolicyRule [DEPRECATED] Get gateway QoS policy settings. This is an alias for getQosPolicy — use getQosPolicy instead. Read getQosProfile Get rate limit profiles for a site, listing bandwidth limit configurations that can be applied to clients. Read getRadioFrequencyPlanningConfig Get the RF planning configuration for the site, including frequency band assignments and channel planning s... Read getRadioFrequencyPlanningResult Get the RF planning result for the site. Returns computed channel/power assignments based on the current RF... Read getRadiosConfig Get per-radio configuration for an access point. Returns settings for each radio (2.4GHz, 5GHz, 6GHz) inclu... Read getRadiusProxyConfig Get the global RADIUS proxy configuration from the controller, including proxy enabled state and server set... Read getRadiusServer Get the global RADIUS server configuration for the controller. Read getRadiusUserDetail [DEPRECATED] Get built-in RADIUS server users. There is no per-user detail endpoint — this is an alias for ... Read getRadiusUserList List local RADIUS server users (paginated). Returns users configured in the built-in RADIUS server on the s... Read getRateLimitProfiles Get the list of available rate limit profiles for a site. These profiles can be applied to clients to contr... Read getRebootScheduleList Get the list of device reboot schedules for a site template. Read getRemoteBindingStatus Get the remote binding status between the controller and cloud service. Read getRemoteLogging Get the global syslog/remote logging configuration, including syslog server address and log level. Read getRemoteLoggingSetting Get remote logging (syslog) configuration for the site. Returns syslog server address, port, and log level ... Read getRestoreResult Get the result of the most recent controller restore operation. Read getRetention Get the data retention configuration for the controller, including how long logs, statistics, and client re... Read getRetryAndDroppedRate Get wireless retry rate and dropped packet rate over a time range. High retry rates indicate RF interferenc... Read getRFScanResult [DEPRECATED] Get the last RF scan results for an access point. This endpoint is marked deprecated in the Om... Read getRoamingSetting Get the client roaming configuration, including 802.11r/k/v settings that control how clients roam between ... Read getRogueAps Get the list of rogue (unauthorized) access points detected by WIDS in a site. Read getRoleDetail Get detailed information about a specific user role, including its permissions. Read getRoutingTable Get the live routing table for a site filtered by type. Use type= Read getScheduleProfile Get time range (schedule) profiles for a site, listing named time windows that can be applied to firewall r... Read getServiceProfile Get service type profiles for a site (paginated), listing protocol/port definitions used in firewall rules. Read getServiceTypeSummary Get a summary of service type profiles for the site, including predefined and custom service counts. Read getSessionLimit Get the session limit global setting for the site gateway. Shows whether per-IP session limiting is enabled. Read getSiteBackupFileList Get the list of available backup files for a specific site. Read getSiteBackupResult Get the result of the most recent backup operation for a specific site. Read getSiteCapacity Get site capacity settings including maximum device and client counts. Read getSiteDetail Get detailed information about a site, including name, region, timezone, and configuration settings. Read getSiteDeviceAccount Get the device account settings for a site, including shared credentials used for device access. Read getSiteNtpStatus Get NTP server status and configuration for a site. Read getSiteRememberSetting Get the remember device setting for a site, which controls whether clients are remembered after disconnection. Read getSitesApsAvailableChannel Get available channels for an AP. Read getSitesApsBridge Get P2P bridge config for an AP. Read getSitesApsChannelLimit Get channel limit config for an AP. Read getSitesApsIpSetting Get IP settings for an AP. Read getSitesApsLoadBalance Get load balance config for an AP. Read getSitesApsOfdma Get OFDMA configuration for an AP. Read getSitesApsPowerSaving Get power saving config for an AP. Read getSitesApsTrunkSetting Get trunk setting for an AP. Read getSitesDeviceWhiteList Get the device whitelist for a site. Read getSitesGatewaysGeneralConfig Get gateway general config. Read getSitesGatewaysPin Get PIN setting for a gateway (LTE model). Read getSitesGatewaysSimCardUsed Get SIM card used by a gateway. Read getSitesHealthGatewaysWansDetails Get WAN port health details for a gateway. Read getSiteSpecification Get site specification including device limits, feature capabilities, and hardware constraints. Read getSitesSwitchesEs Get easy managed switch info. Read getSitesSwitchesEsGeneralConfig Get easy managed switch general config. Read getSiteTemplateConfig Get the configuration settings for a specific site template. Read getSiteTemplateDetail Get detailed information about a specific site template by its ID. Read getSiteTemplateList Get the list of all site templates configured on the controller. Read getSiteToSiteVpnInfo Get detailed information about a specific site-to-site VPN by ID, including tunnel type, remote gateway, au... Read getSiteUrl Get the URL associated with a site for OpenAPI access. Read getSnmpSetting Get SNMP configuration for the site. Returns SNMP version, community string, and enabled state. Read getSpeedTestResults Get the last speed test results for an access point. Returns upload/download throughput measurements from t... Read getSshSetting Get SSH access settings for a site. Read getSsidDetail Get detailed information for a specific SSID (wireless network), including security settings, rate limits, ... Read getSsidList Get the list of SSIDs (wireless networks) configured in a WLAN group. Requires wlanId which can be obtained... Read getSsidsBySite Get a flat SSID list filtered by device type. Returns all SSIDs configured on the site for the specified de... Read getSslVpnServerSetting Get the SSL VPN server configuration, including port, protocol, and authentication settings. Read getStackNetworkList Get the VLAN network list for a switch stack. Returns VLAN interface assignments across all stack members. ... Read getStackPorts Get all port information for a switch stack. Read getStaticRoutingInterfaceList Get the list of available interfaces for static routing. Use this to discover valid next-hop interface name... Read getSwitchDetail Fetch full configuration and status for a specific switch: model, firmware, CPU/memory, all port states, Po... Read getSwitchDot1xSetting Get the 802.1X switch port authentication setting. Controls port-based network access control on managed sw... Read getSwitchGeneralConfig Get general configuration for a switch including device name, LED settings, LLDP settings, flow control, an... Read getSwitchStackDetail Fetch detailed information for a specific switch stack. Read getSwitchVlanInterface Get VLAN interface configuration for a specific switch. Requires Read getSyslogConfig [DEPRECATED] Alias for Read getThreatCount Get the global threat count grouped by severity level (critical, high, medium, low) within a time range. Pr... Read getThreatDetail Get detailed information about a specific IPS threat event by its ID. Use this after listing threats to ret... Read getThreatList Get the global view threat management list. Returns paginated threat information including severity, source... Read getTopThreats Get the top threats from the global threat management view across all sites. Read getTrafficDistribution Get traffic distribution by protocol and application type over a time range. Shows breakdown of traffic by ... Read getTrafficPriority Get the gateway VoIP and traffic prioritization settings for a site, including QoS prioritization rules for... Read getTrafficStats [DEPRECATED] Use getDashboardTrafficActivities instead. Same GET .../dashboard/traffic-activities endpoint.... Read getUiInterface Get the UI interface settings for the controller, including timeout and session options. Read getUpgradeLogs Get firmware upgrade logs showing the history of upgrade operations performed on devices. Read getUpgradeOverviewCritical Get the number of critical firmware upgrades available across managed devices. Read getUpgradeOverviewTryBeta Get the try-beta firmware switch status for the controller. Read getUpgradeScheduleList Get the list of firmware upgrade schedules configured for a site. Read getUplinkWiredDetail Get wired uplink detail for an access point. Returns the AP Read getUpnpSetting Get UPnP (Universal Plug and Play) setting for the site. Shows whether UPnP port mapping is enabled on the ... Read getUrlFilterBlacklist Get the MAC-based deny (blacklist) filter entries for a site (paginated). Returns MAC addresses blocked fro... Read getUrlFilterGeneral Get the URL filter global setting, including whether URL filtering is enabled and the default action for un... Read getUrlFilterRules Get gateway URL filter rules for a site (paginated), listing URL-based allow/block rules applied on the gat... Read getUrlFilterWhitelist Get the MAC-based allow (whitelist) filter entries for a site (paginated). Returns MAC addresses explicitly... Read getUrlGroupProfile [DEPRECATED] Get URL/IP port group profiles for a site. This is an alias for getGroupPolicyDetail with grou... Read getUserRoleProfile Get user role profiles from the controller, listing defined roles with associated permissions for administr... Read getVlanProfile Get LAN/VLAN profiles for a site, listing named VLAN configurations that can be applied to switch ports and... Read getVpnClientStatus Get the status of client-to-site VPN clients connected to the site, including connection state, assigned IP... Read getVpnRouteConfig [DEPRECATED] Use getGridPolicyRouting instead. Same GET .../routing/policy-routings endpoint. Note: this to... Read getVpnSettings Get VPN configuration settings for a site. Read getVpnTunnelStats Get VPN tunnel statistics for a site (paginated), including active tunnels, traffic, and connection status. Read getVpnUserDetail Get the users associated with a specific client-to-site VPN server by VPN server ID. Read getVpnUserList Get the list of VPN users for a site (paginated), including username, assigned VPN server, and connection p... Read getVrrpConfig Get VRRP (Virtual Router Redundancy Protocol) configuration for OSW devices on the site. Read getWanHealthDetail Deprecated alias of Read getWanIspProfile Get ISP scan profile result for a specific WAN port. Returns the ISP detection result including detected IS... Read getWanLanStatus Get the WAN and LAN connectivity status for a site. Read getWanNatConfig Get one-to-one NAT configuration (WAN NAT rules) for the site gateway. Read getWanPortDetail [DEPRECATED] Use getWanPortsConfig instead. Same GET .../internet/ports-config endpoint. Get detailed WAN p... Read getWanPortsConfig Get WAN port settings for the site gateway. Returns per-port WAN configuration including connection type, I... Read getWanQosConfig Get QoS configuration for gateway WAN ports on the site. Read getWanUsageStats [DEPRECATED] Use getDashboardTrafficActivities instead. Same endpoint. Get WAN traffic usage statistics and... Read getWebhookForGlobal Get the global webhook notification settings, including webhook URL and enabled event types. Read getWebhookLogsForGlobal Get webhook dispatch logs (paginated). Requires webhookId and a time range in epoch milliseconds. Returns d... Read getWids Get Wireless Intrusion Detection System (WIDS) information for a site, including detected attacks and rogue... Read getWidsBlacklist Get the WIPS (Wireless Intrusion Prevention System) rogue AP blacklist for a site. Returns the list of acce... Read getWireguardSummary Get a summary of WireGuard VPN configurations for the site, including each WireGuard ID and name. Read getWlanGroupList Get the list of WLAN groups configured in a site. WLAN groups contain SSIDs and define wireless network set... Read listAllSsids List all wireless SSIDs across all WLAN groups in a site: SSID name, WLAN group, security mode (WPA2/WPA3),... Read listClients List all network clients (wired and wireless) connected to a site. Returns client details including MAC add... Read listClientsActivity Get client activity statistics over time from the dashboard. Returns time-series data showing new, active, ... Read listClientsPastConnections Get client past connection list with historical connection data. Returns information about clients that hav... Read listClientToSiteVpnClients List all client-to-site VPN client configurations on the site. Read listClientToSiteVpnServers List all client-to-site VPN server configurations on the site, including server type, IP, and authenticatio... Read listDevices List all provisioned (adopted) network devices in a site: gateways, switches, and access points. Returns MA... Read listDevicesStats Query statistics for global adopted devices with pagination and filtering. Supports fuzzy search by MAC add... Read listEapAcls List EAP (access point) ACL rules for a site: wireless client access control rules. Returns rule name, acti... Read listGlobalAlerts List alert logs across all sites on the controller: threshold breaches, device failures, security events, e... Read listGlobalEvents List system event logs across all sites on the controller. Returns device online/offline, client connect/di... Read listGroupProfiles List group profiles (IP groups, MAC groups, port groups) configured for a site. These are named sets of add... Read listMdnsProfile List all Bonjour/mDNS service profiles configured on the site for cross-VLAN service discovery. Read listMostActiveClients Get the most active clients in a site, sorted by total traffic. Returns client name, MAC address, type, mod... Read listOsgAcls List gateway (OSG) ACL rules for a site: firewall rules controlling traffic between WAN, LAN, and guest net... Read listPendingDevices List devices discovered on the network but not yet adopted into this site. Returns device type, MAC, IP, an... Read listPolicyRoutes [DEPRECATED] Use getGridPolicyRouting instead. Note: listPolicyRoutes returns an aggregated array of all po... Read listPortForwardingRules [DEPRECATED] Use getPortForwardingList instead. Same GET .../nat/port-forwardings endpoint. getPortForwardi... Read listRadiusProfiles List RADIUS authentication profiles configured for a site: server IP, port, and profile name. Used by SSIDs... Read listServiceType List service type profiles (paginated). Returns both predefined and custom service types used in ACL and fi... Read listSiteAlerts List alert logs for a site: threshold breaches, device failures, security events, and other conditions requ... Read listSiteAuditLogs List admin audit logs for a site: who made what configuration change and when. Returns username, action des... Read listSiteEvents List system event logs for a site: device online/offline, client connect/disconnect, firmware upgrades, con... Read listSites List all sites configured on the Omada controller. Read listSitesApsPorts List ports on an AP. Read listSitesCableTestSwitchesIncrementResults Get cable test incremental results for a switch. Read listSitesCableTestSwitchesPorts List ports available for cable test on a switch. Read listSitesStacks List switch stacks in a site. Read listSiteThreatManagement List site-level threat management events detected by IPS, with optional time range and keyword filtering. Read listSiteToSiteVpns List site-to-site VPN configurations: tunnel name, remote IP, status, protocol (IPsec/OpenVPN/WireGuard), a... Read listStaticRoutes [DEPRECATED] Use getGridStaticRouting instead. Same GET .../routing/static-routings endpoint. Note: listSta... Read listSwitchNetworks List VLAN network assignments for a switch. Returns which VLANs are assigned to which ports, including tagg... Read listTimeRangeProfiles List time range profiles configured for a site. These are named schedules (e.g. Read listUpgradeFirmwares List uploaded firmware files available for manual upgrade. Read listUpgradeOverviewFirmwares List firmware pool entries in the upgrade overview. Read listWireguard List WireGuard VPN tunnels (paginated). Returns WireGuard interface configurations including listen port, p... Read listWireguardPeers List WireGuard peers (paginated). Returns peer configurations including public keys, allowed IPs, and endpo... Read searchDevices Search for devices globally across all sites the user has access to. Returns devices matching the search key.
WRITE 3 tools
Write disableClientRateLimit Disable rate limiting for a specific client, removing any bandwidth restrictions. Write setClientRateLimit Set custom rate limit (bandwidth control) for a specific client. Specify download and upload limits in Kbps... Write setClientRateLimitProfile Apply a predefined rate limit profile to a specific client. Use getRateLimitProfiles to get available profi...

Route Tplink Omada through PolicyLayer and every one of its 327 tools is checked against your policy before it runs.

CHECK YOUR STACK →

See every tool, the dangerous ones, and the token cost across your stack.

// FAQ
How many tools does the Tplink Omada MCP server have? +

The Tplink Omada MCP server exposes 327 tools across 2 categories: Read, Write.

How do I enforce policies on Tplink Omada tools? +

Route the Tplink Omada server through the PolicyLayer gateway. Define allow, deny, or approval rules per tool in the dashboard; they are enforced on every call before it reaches the server.

What risk categories do Tplink Omada tools fall into? +

Tplink Omada tools are categorised as Read (324), Write (3). Each category has a recommended default policy.

Enforce policy on every Tplink Omada tool call.

Start from Tplink Omada, add the rest of your stack, and see everything your agents can call. Then put policy on all of it.

CHECK YOUR STACK →

Free to start. No card required.

43,000+ MCP servers and 220,000+ tools scanned and risk-classified.

// GET IN TOUCH

Have a question or want to learn more? Send us a message.

Message sent.

We'll get back to you soon.