--- title: "[LRO] RM Device Page" method: POST path: "/devices/rm-devices-page" tags: ["Device"] --- # [LRO] RM Device Page `POST /devices/rm-devices-page` Device List with pagination. ## Query parameters - `page` integer - `limit` integer - `keyword` string - `connected` boolean - `adminStates` XiqDeviceAdminState[] - `deviceCategory` 'WIRED' | 'WIRELESS' | 'TPME' | 'APPLIANCES' - `sortField` 'HOSTNAME' | 'MAC' | 'SN' | 'CONNECTION_STATUS' | 'OS' | 'PRODUCT_TYPE' — RM Device List Sort fields - `order` 'ASC' | 'DESC' — Sort Order - `deviceTypes` XiqDeviceType[] - `configMismatch` boolean - `async` boolean - `includeUnassigned` boolean - `stacked_view` boolean - `copilotLicenseStatuses` XiqCopilotLicenseStatus[] ## Request body - XiqRmDeviceListRequest — Request body for RM Device List - `site_ids` integer[] — List of site ids to filter - `sns` string[] — List of device serial numbers to filter - `mac_addresses` string[] — List of device MAC addresses to filter - `hostnames` string[] — List of device host names to filter - `default_gateway_ips` string[] — List of device default gateway IPs to filter - `product_types` string[] — List of device product types to filter - `firmware_versions` string[] — List of device firmware versions to filter - `country_codes` integer[] — List of country codes to filter - `managed_by` string[] — List of entities managing the device to filter - `display_managed_by` string[] — List of display values for 'Managed By' shown only in EP1 - `network_policies` string[] — List of network policies to filter - `eth_uplink_speed_filters` XiqRmDeviceEthUplinkSpeedFilter[] — Filter by Eth uplink speed filter - `eth_uplink_speed` 'ETH0' | 'ETH1' — The Eth Uplink Speed - `filter_type` 'GT' | 'GTE' | 'LT' | 'LTE' | 'EQ' | 'NEQ' | 'BTW' — The filter type - `constant_value` 'VAUTO' | 'V10' | 'V100' | 'V1000' | 'V10000' | 'V100000' | 'V44' | 'V155' | 'V622' | 'V2500' | 'V5000' | 'V20000' | 'V25000' | 'V40000' | 'V50000' — The constant value - `data_unit` 'KBPS' | 'MBPS' | 'GBPS' — The data unit of eth speed - `device_icons_filter` XiqRmDeviceIconsFilter — Filter criteria for device icons - `anchor_ap` boolean — Filter by Anchor AP status - `locally_managed` boolean — Filter by Locally Managed status - `device_update_unsuccessful` boolean — Filter by Device Update Unsuccessful status - `provisioned_device` boolean — Filter by Provisioned Device status - `configuration_roll_back` boolean — Filter by Configuration Rollback status - `undetermined` boolean — Filter by Undetermined status - `configured_at_device_level` boolean — Filter by Configured at Device Level status - `switch_stack` boolean — Filter by Switch Stack status - `switch_stack_warning` boolean — Filter by Switch Stack Warning status - `radsec_proxy_server` boolean — Filter by RadSec Proxy Server status - `sensor_mode_interface` boolean — Filter by Sensor Mode Interface status - `spectrum_intelligence` boolean — Filter by Spectrum Intelligence status - `fabric_attach` boolean — Filter by Fabric Attach status - `fabric_attach_issue` boolean — Filter by Fabric Attach Issue status - `digital_twin` boolean — Filter by Digital Twin status - `managed_by_extreme_iot` boolean — Filter by Managed by Extreme IoT status - `configuration_pending` boolean — Filter by Configuration Pending status ## Response `200` OK - PagedXiqRmDevice - `page` integer, required — The current page number - `count` integer, required — The element count of the current page - `total_pages` integer, required — The total page number based on request page size - `total_count` integer, required — The total element count - `data` XiqRmDevice[] — The data in the current page - `id` integer, required — The unique identifier - `create_time` string, date-time, required — The create time in UTC (ISO 8601 format) - `update_time` string, date-time, required — The last update time in UTC (ISO 8601 format) - `org_id` integer — The organization identifier, valid when enabling HIQ feature - `connected` boolean — The device connection status - `hostname` string — The device hostname - `healthy_clients` integer — The associated active client count for the device - `unhealthy_clients` integer — The associated inactive client count for the device - `system_up_time` integer — The device uptime in milliseconds - `updated_on` integer — The last device updated time - `mac_address` string — The device MAC address in format XXXXXXXXXXXX - `serial_number` string — The device serial number, valid for all non-HAC devices - `device_ip` string — The device IPv4 address - `default_gateway` string — The device default gateway - `software_version` string — The device OS software version - `product_type` string — The product type, such as AP_230, BR_100, NX9600, etc. - `ipv6_address` string — The device IPv6 address - `device_admin_state` 'NEW' | 'BOOTSTRAP' | 'STAGED' | 'MANAGED' | 'UNMANAGED' - `sim_type` 'REAL' | 'DIGITAL_TWIN' | 'SIMULATED' - `country_code` integer — The assigned country code on the device - `managed_by` string — The managed application for the device - `display_managed_by` string — Display label used in EP1. This field represents the controller hostname for controller-managed devices and the Managed By value for other devices. - `channel_wifi0` string — Channel for wifi0 - `power_wifi0` string — Power for wifi0 - `radio_wifi0` string — Radio for wifi0 - `channel_wifi1` string — Channel for wifi1 - `power_wifi1` string — Power for wifi1 - `radio_wifi1` string — Radio for wifi1 - `channel_wifi2` string — Channel for wifi2 - `power_wifi2` string — Power for wifi2 - `radio_wifi2` string — Radio for wifi2 - `config_mismatch` boolean — Config audit status(MATCHED(false) or UNMATCHED(true)) - `locations` XiqRmDeviceLocationDetails — The detailed location information - `site` string — The site where the device is located - `site_id` integer — Site ID - `building` string — The building where the device is located - `building_id` integer — Building ID - `floor` string — The floor where the device is located - `floor_id` integer — Floor ID - `device_category` 'WIRED' | 'WIRELESS' | 'TPME_SNMP_DISCOVERED' | 'APPLIANCES' | 'UNKNOWN' — The RM device category type - `has_management_ip_issue` boolean — Flag to indicate device with management IP issue - `has_default_gateway_issue` boolean — Flag to indicate device with default gateway issue - `has_firmware_version_issue` boolean — Flag to indicate device with firmware version issue - `stack_size` string, byte — The number of devices in the stack (0 for standalone devices) - `stack_id` integer — The stack id (only for stack members) - `xiq_rm_device_icons` XiqRmDeviceIcons — The icons for device - `afc_status` string — Afc status - `provisioned_device` boolean — Provisioned device - `config_rolled_back` boolean — Configuration Rollback - `device_type` 'REAL' | 'DIGITAL_TWIN' | 'SIMULATED' - `undetermined` boolean — Undetermined device type - `configured_at_device_level` boolean — Configured at Device Level - `device_update_unsuccessful` boolean — Device Update Unsuccessful - `managed_by_extreme_iot` boolean — Managed by ExtremeIoT - `thread_commissioner_running` boolean — Thread Commissioner Running - `monitoring_unassociated_clients` boolean — Monitoring Unassociated Clients - `switch_stack` boolean — Switch stack - `switch_stack_warning` boolean — Switch stack warning - `radsec_proxy_server` boolean — RadSec Proxy Server - `rogue_ap_mitigation_on` boolean — Rogue AP Mitigation On - `sensor_mode` boolean — Sensor Mode - `swap` boolean — Swap - `spectrum_intelligence` boolean — Spectrum Intelligence - `vpn_server` 'UP' | 'DOWN' | 'UP_DOWN' — VPN Client - `vpn_client` 'UP' | 'DOWN' | 'UP_DOWN' — VPN Client - `locally_managed` boolean — Locally managed - `extreme_cluster_appliance` boolean — Extreme Cluster Appliance - `fabric_attach` boolean — Fabric Attach - `fabric_attach_error` boolean — Fabric Attach Error - `config_pending` boolean — Config pending - `anchor` boolean — Anchor - `no_connection` boolean — No Connection - `device_license_tier` 'NOT_APPLICABLE' | 'TIER_A' | 'TIER_B' | 'TIER_C' | 'TIER_D' | 'UNKNOWN' | 'NONE' | 'TIER_3RD' — The license tier of the device - `device_license_type` 'LEGACY' | 'NAVIGATOR' | 'PILOT' | 'COPILOT' | 'NONE' | 'NA' | 'TRIAL' | 'NOT_REQUIRED' | 'GRACEPERIOD' | 'UNLICENSED' | 'STANDARD' | 'ADVANCED' | 'NOT_LICENSED' — The license type of the device - `network_policy_id` integer — The network policy ID associated with the device - `network_policy_name` string — The network policy name associated with the device - `os` string — The OS Name - `device_template_name` string — The device template name - `cloud_config_groups` string[] — The device cloud config groups - `eth0_uplink_speed` 'SPEED_AUTO' | 'SPEED_10M' | 'SPEED_100M' | 'SPEED_1000M' | 'SPEED_10000M' | 'SPEED_100000M' | 'SPEED_44M' | 'SPEED_155M' | 'SPEED_622M' — Value for Eth0 uplink speed. Represents the negotiated or configured speed of the Eth0 interface. - `eth1_uplink_speed` 'SPEED_AUTO' | 'SPEED_10M' | 'SPEED_100M' | 'SPEED_1000M' | 'SPEED_10000M' | 'SPEED_100000M' | 'SPEED_44M' | 'SPEED_155M' | 'SPEED_622M' — Value for Eth1 uplink speed. Represents the negotiated or configured speed of the Eth1 interface. - `controller_id` integer — The controller ID - `primary_controller_address` string — The primary controller Address - `secondary_controller_address` string — The secondary controller Address - `copilot_license_status` 'ACTIVE' | 'EXPIRED' | 'UNLICENSED' | 'NONE' | 'NA' | 'TRIAL' - `device_family` string — Device family or category (e.g."AP", "UCP", "SWITCH", "XIQ_SE", "TPME", "THIRDPARTY", "TUNNELCONCENTRATOR", "CONTROLLER") --- [API](https://skmtc.net/extremecloudiq/apis/extremecloud-iq-api.md) · [All operations](https://skmtc.net/extremecloudiq/apis/extremecloud-iq-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/extremecloudiq/extremecloud-iq-api/versions/5ff7ab84e8e8/schema)