diff --git a/xcloudiq-openapi.yaml b/xcloudiq-openapi.yaml index c1e1f01..447db2d 100644 --- a/xcloudiq-openapi.yaml +++ b/xcloudiq-openapi.yaml @@ -21,7 +21,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 24.4.0.61 + version: 24.5.0.51 servers: - url: https://api.extremecloudiq.com description: ExtremeCloud IQ REST API Server @@ -87,6 +87,8 @@ tags: description: The SDWAN API - name: Thread description: Thread Networks in ExtremeCloud IQ +- name: AFC + description: ExtremeCloud IQ AFC Feature. paths: /login: post: @@ -3755,6 +3757,65 @@ paths: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] + /devices/{id}/radio-operating-mode: + get: + tags: + - Device + summary: Get device radio operating modes + description: Get the device radio operating mode by device ID at device level. + externalDocs: + description: API Reference + url: https://extremecloudiq.com/api-docs/api-reference.html#_get_device_radio_operating_mode + operationId: getDeviceRadioOperatingMode + parameters: + - $ref: '#/components/parameters/id' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/XiqDeviceRadioOperatingMode' + default: + $ref: '#/components/responses/ErrorResponse' + security: + - BearerAuth: [] + put: + tags: + - Device + summary: Configure radio operating mode of a device + description: Configure the device-specific radio operating mode setting at device level and set the radio profiles to the default radio profiles.
If the radio profile ID is not provided for a wifi interface in the request, the default Radio Profile will be added to device. + externalDocs: + description: API Reference + url: https://extremecloudiq.com/api-docs/api-reference.html#_configure_radio_operating_mode_device + operationId: configureDeviceRadioOperatingMode + parameters: + - $ref: '#/components/parameters/id' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/XiqConfigureRadioOperatingModeRequest' + examples: + Configure_AP5020_radio_operating_mode: + summary: Configure radio operating mode for AP5020 device and set custom radio profiles for each wifi interface. + value: + radio_operating_mode: SERVICE_2_5_6 + wireless_interfaces: + - name: WIFI0 + radio_profile_id: 1000 + - name: WIFI1 + radio_profile_id: 2000 + - name: WIFI2 + radio_profile_id: 3000 + required: true + responses: + '200': + description: OK + default: + $ref: '#/components/responses/ErrorResponse' + security: + - BearerAuth: [] /network-policies: get: tags: @@ -5412,6 +5473,29 @@ paths: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] + /logs/audit/full-descriptions/{id}: + get: + tags: + - Log + summary: Get audit log full descriptions + description: Get audit log full descriptions by ID. + externalDocs: + description: API Reference + url: https://extremecloudiq.com/api-docs/api-reference.html#_get_audit_log_full_descriptions + operationId: getAuditLogFullDescriptions + parameters: + - $ref: '#/components/parameters/id' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/XiqAuditLogFullDescriptions' + default: + $ref: '#/components/responses/ErrorResponse' + security: + - BearerAuth: [] /logs/audit/reports: post: tags: @@ -5809,12 +5893,14 @@ paths: post: tags: - Configuration - Deployment - summary: Push configuration and upgrade firmware + summary: ' [LRO] Push configuration and upgrade firmware' description: Push configuration and upgrade firmware to the target devices. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_push_configuration_and_upgrade_firmware_to_devices operationId: deployConfig + parameters: + - $ref: '#/components/parameters/async' requestBody: description: The device deploy configuration content: @@ -5888,6 +5974,48 @@ paths: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] + /deployments/firmware-metadatas: + post: + tags: + - Configuration - Deployment + summary: Get device firmware metadatas + description: Get the compatible firmware metadatas for the devices. + externalDocs: + description: API Reference + url: https://extremecloudiq.com/api-docs/api-reference.html#_get_device_firmware_metadatas + operationId: getDeviceFirmwareMetadatas + requestBody: + description: The request to get device firmware metadatas + required: true + content: + application/json: + schema: + type: object + properties: + device_ids: + type: array + description: The device IDs + uniqueItems: true + items: + type: integer + format: int64 + responses: + '200': + description: OK + content: + application/json: + schema: + type: object + properties: + firmware_metadatas: + type: object + description: The compatible firmware metadatas per device + additionalProperties: + $ref: '#/components/schemas/XiqDeviceFirmwareMetadata' + default: + $ref: '#/components/responses/ErrorResponse' + security: + - BearerAuth: [] /vlan-profiles: get: tags: @@ -6345,22 +6473,28 @@ paths: post: tags: - Configuration - User Management - summary: Setup a Key-based Private Client Group + summary: ' [LRO] Create a Key-based Private Client Group' description: Setup a Key-based Private Client Group, including network policy, user, user group, SSID, etc. externalDocs: description: API Reference url: https://extremecloudiq.com/api-docs/api-reference.html#_initiate_key_based_pcg operationId: setupKeyBasedPrivateClientGroupNetworkPolicy + parameters: + - $ref: '#/components/parameters/async' requestBody: description: The request to setup Key-based PCG network policy content: application/json: schema: - $ref: '#/components/schemas/XiqInitKeyBasedPcgNetworkPolicyRequest' + $ref: '#/components/schemas/XiqCreateKeyBasedPcgNetworkPolicyRequest' required: true responses: - '202': - description: Accepted + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/XiqCreateKeyBasedPcgNetworkPolicyResponse' default: $ref: '#/components/responses/ErrorResponse' security: @@ -6369,7 +6503,7 @@ paths: post: tags: - Configuration - User Management - summary: Create Key-based PCG in network policy + summary: ' [LRO] Create Key-based PCG in network policy' description: Create a Key-based Private Client Group for a specific network policy. externalDocs: description: API Reference @@ -6383,6 +6517,7 @@ paths: schema: type: integer format: int64 + - $ref: '#/components/parameters/async' requestBody: content: application/json: @@ -6390,8 +6525,12 @@ paths: $ref: '#/components/schemas/XiqOnboardKeyBasedPcgRequest' required: true responses: - '202': - description: Accepted + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/XiqOnboardKeyBasedPcgResponse' default: $ref: '#/components/responses/ErrorResponse' security: @@ -6464,7 +6603,7 @@ paths: post: tags: - Configuration - User Management - summary: Add users to a PCG-enabled network policy + summary: ' [LRO] Add users to a PCG-enabled network policy' description: Add users to a PCG-enabled network policy. externalDocs: description: API Reference @@ -6478,6 +6617,7 @@ paths: schema: type: integer format: int64 + - $ref: '#/components/parameters/async' requestBody: description: The payload of add users to PCG-enabled network policy content: @@ -6486,8 +6626,12 @@ paths: $ref: '#/components/schemas/XiqCreateKeyBasedPcgUsersRequest' required: true responses: - '202': - description: Accepted + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/XiqAddKeyBasedPcgUsersToNetworkPolicyResponse' default: $ref: '#/components/responses/ErrorResponse' security: @@ -9188,7 +9332,7 @@ paths: description: "Modern AP hardware types include dual or triple band radios.\nA limited subset of band combinations are supported.\nOperating mode defines the supported band combinations per radio. \nAccess Points with fixed band radios use GENERIC operating mode. \nSERVICE_2_5_6: wifi0-2.4Ghz, wifi1-5Ghz, wifi2-6Ghz\nSENSOR_SERVICE_5_6: wifi0-Tri-band sensor, wifi1-5Ghz, wifi2-6Ghz\nSERVICE_5L_5H_6: wifi0-5G Low, wifi1-5G High, wifi2-6Ghz\nSENSOR_SERVICE_5_2: wifi0-Tri-band sensor, wifi1-5GHz, wifi2-2.4Ghz\nSERVICE_5L_5H_2: wifi0-5G Low, wifi1-5G High, wifi2-2.4Ghz\nSERVICE_6L_5_6H: wifi0-6G Low, wifi1-5GHz, wifi2-6Ghz." externalDocs: description: API Reference - url: https://extremecloudiq.com/api-docs/api-reference.html#_get_device_operation_mode + url: https://extremecloudiq.com/api-docs/api-reference.html#_get_radio_operating_mode operationId: getDeviceOperationMode parameters: - name: productType @@ -11601,7 +11745,7 @@ paths: description: Get list of states or provinces in a country with country alpha2 code. externalDocs: description: API Reference - url: https://extremecloudiq.com/api-docs/api-reference.html#_get_country_states + url: https://extremecloudiq.com/api-docs/api-reference.html#_get_list_of_states_in_a_country operationId: getStateListByCountryCode parameters: - name: countryAlpha2Code @@ -11616,7 +11760,6 @@ paths: content: application/json: schema: - type: array $ref: '#/components/schemas/XiqCountryState' default: $ref: '#/components/responses/ErrorResponse' @@ -11849,6 +11992,246 @@ paths: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] + /afc/afcserver: + get: + tags: + - AFC + summary: List AFC Servers + description: List AFC servers. + externalDocs: + description: API Reference + url: https://extremecloudiq.com/api-docs/api-reference.html#_list_afc_servers + operationId: listAfcServers + responses: + '200': + description: OK + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/XiqAfcServer' + default: + $ref: '#/components/responses/ErrorResponse' + security: + - BearerAuth: [] + /afc/afcserver/{id}: + get: + tags: + - AFC + summary: Get AFC Servers + description: Get AFC servers. + externalDocs: + description: API Reference + url: https://extremecloudiq.com/api-docs/api-reference.html#_get_afc_servers + operationId: getAfcServers + parameters: + - $ref: '#/components/parameters/id' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/XiqAfcServer' + default: + $ref: '#/components/responses/ErrorResponse' + security: + - BearerAuth: [] + /afc/afcserver/statistics: + get: + tags: + - AFC + summary: AFC server Statistics + description: External AFC server Statistics. + externalDocs: + description: API Reference + url: https://extremecloudiq.com/api-docs/api-reference.html#_get_afc_server_stats + operationId: getAfcServerStats + responses: + '200': + description: OK + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/XiqAfcServerStatistics' + default: + $ref: '#/components/responses/ErrorResponse' + security: + - BearerAuth: [] + /afc/afserver/job/statistics: + get: + tags: + - AFC + summary: AFC server job statistics + description: AFC server statistics for the past 7 days. + externalDocs: + description: API Reference + url: https://extremecloudiq.com/api-docs/api-reference.html#_get_afc_job_statistics + operationId: getAfcServerJobStats + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/limit' + responses: + '200': + description: OK + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/XiqAfcJobStatistics' + default: + $ref: '#/components/responses/ErrorResponse' + security: + - BearerAuth: [] + /afc/ap/interface/details/{sn}: + get: + tags: + - AFC + summary: AFC Ap Channels info + description: AFC Ap Channels info. + externalDocs: + description: API Reference + url: https://extremecloudiq.com/api-docs/api-reference.html#_get_afc_ap_interface_details + operationId: getAfcApDetails + parameters: + - $ref: '#/components/parameters/sn' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/XiqAfcApInterfaceDetails' + default: + $ref: '#/components/responses/ErrorResponse' + security: + - BearerAuth: [] + /afc/aps/status/summary: + get: + tags: + - AFC + summary: AFC Ap status Summary + description: AFC Status summary of Ap channels and powers query. + externalDocs: + description: API Reference + url: https://extremecloudiq.com/api-docs/api-reference.html#_get_afc_ap_status_stats + operationId: getAfcApsStatusSummary + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/XiqAfcApStatusSummary' + default: + $ref: '#/components/responses/ErrorResponse' + security: + - BearerAuth: [] + /afc/aps/geolocation/summary: + get: + tags: + - AFC + summary: AFC server job statistics + description: AFC server statistics for the past 7 days. + externalDocs: + description: API Reference + url: https://extremecloudiq.com/api-docs/api-reference.html#_get_afc_job_statistics + operationId: getAfcGeoLocation + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/XiqAfcGeolocationSummary' + default: + $ref: '#/components/responses/ErrorResponse' + security: + - BearerAuth: [] + /afc/site/schedule: + get: + tags: + - AFC + summary: Get AFC Site Update Schedule + description: Get AFC site update settings. + externalDocs: + description: API Reference + url: https://extremecloudiq.com/api-docs/api-reference.html#_get_afc_site_schedule + operationId: getAfcSiteSchedule + parameters: + - $ref: '#/components/parameters/ownerId' + - $ref: '#/components/parameters/folderId' + responses: + '200': + description: OK + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/XiqAfcSiteSchedule' + default: + $ref: '#/components/responses/ErrorResponse' + security: + - BearerAuth: [] + post: + tags: + - AFC + summary: Add AFC Site Schedule + description: Add AFC Site Schedule. + externalDocs: + description: API Reference + url: https://extremecloudiq.com/api-docs/api-reference.html#_add_afc_site_schedule + operationId: addAfcServerStats + requestBody: + description: The body of the Site Schedule + content: + application/json: + schema: + $ref: '#/components/schemas/XiqAfcSiteSchedule' + required: true + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/XiqAfcSiteSchedule' + default: + $ref: '#/components/responses/ErrorResponse' + security: + - BearerAuth: [] + put: + tags: + - AFC + summary: Update AFC SiteSchedule + description: Update AFC SiteSchedule. + externalDocs: + description: API Reference + url: https://extremecloudiq.com/api-docs/api-reference.html#_update_afc_site_schedule + operationId: updateAfcSiteSchedule + requestBody: + description: The body of the Site Schedule + content: + application/json: + schema: + $ref: '#/components/schemas/XiqAfcSiteSchedule' + required: true + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/XiqAfcSiteSchedule' + default: + $ref: '#/components/responses/ErrorResponse' + security: + - BearerAuth: [] components: schemas: XiqLoginRequest: @@ -13238,6 +13621,52 @@ components: name: type: string description: The location name + XiqDeviceGeolocation: + allOf: + - type: object + properties: + latitude: + type: integer + description: Latitude expressed as a floating point number. + longitude: + type: integer + description: Longitude expressed as a floating point number. + height: + type: integer + majorAxis: + type: integer + minorAxis: + type: integer + orientation: + type: integer + XiqAfcApStatus: + type: string + description: Status of AP AFC. + enum: + - AFC_PENDING + - AFC_GRACE_PERIOD + - AFC_AVAILABLE + XiqAfcPowerMode: + type: string + description: AFC Power Mode + enum: + - LPI + - SP + XiqDeviceAfcRadioData: + type: object + description: The device AFC Radio columns + properties: + radioIndex: + type: integer + description: The wifi radio index + afcStatus: + $ref: '#/components/schemas/XiqAfcApStatus' + channel: + type: integer + powerMode: + $ref: '#/components/schemas/XiqAfcPowerMode' + power: + type: integer XiqDevice: allOf: - $ref: '#/components/schemas/XiqLocationEntity' @@ -13331,6 +13760,13 @@ components: description: type: string description: The device description + geoLocation: + $ref: '#/components/schemas/XiqDeviceGeolocation' + afcRadios: + type: array + description: Afc related Radio data + items: + $ref: '#/components/schemas/XiqDeviceAfcRadioData' PagedXiqDevice: allOf: - $ref: '#/components/schemas/XiqPage' @@ -14161,6 +14597,12 @@ components: enable_monitoring: type: boolean description: Whether to enable iBeacon monitoring. Default to True on new device iBeacon setting. + enable_cloud_reporting: + type: boolean + description: Whether to enable iBeacon Cloud Reporting. + enable_batch_reporting: + type: boolean + description: Whether to enable iBeacon Batch Reporting. network_policy_ibeacon_id: type: integer description: The beacon network policy ID @@ -14298,6 +14740,8 @@ components: - minor - power - enable_monitoring + - enable_cloud_reporting + - enable_batch_reporting properties: id: type: integer @@ -14321,6 +14765,12 @@ components: enable_monitoring: type: boolean description: Whether the device iBeacon monitoring is enabled. + enable_cloud_reporting: + type: boolean + description: Whether the device iBeacon Cloud Reporting is enabled. + enable_batch_reporting: + type: boolean + description: Whether the device iBeacon Batch Reporting is enabled. network_policy_ibeacon_id: type: integer description: The beacon network policy ID. @@ -14958,7 +15408,7 @@ components: ip_address_to_int: type: integer description: The IPv4 address set on the interface to numeric format - format: int32 + format: int64 routing_instance: type: string description: The Routing Instance @@ -15100,14 +15550,14 @@ components: dest_subnetwork_to_int: type: integer description: Destination subnetwork IP and mask to numeric format - format: int32 + format: int64 next_hop_ip: type: string description: Next hop IP next_hop_ip_to_int: type: integer description: Next hop IP to numeric format - format: int32 + format: int64 next_hop_ip_ping_protection: type: boolean description: Next hop IP ping protection @@ -15849,6 +16299,45 @@ components: allOf: - $ref: '#/components/schemas/XiqViqEntity' - $ref: '#/components/schemas/XiqFtmSettingsRequest' + XiqDeviceRadioOperatingMode: + title: OperatingMode + description: 'Modern AP hardware types include dual or triple band radios. A limited subset of band combinations are supported. Operating mode defines the supported band combinations per radio. Access Points with fixed band radios use GENERIC operating mode.
SERVICE_2_5_6: wifi0-2.4Ghz, wifi1-5Ghz, wifi2-6Ghz
SENSOR_SERVICE_5_6: wifi0-Tri-band sensor, wifi1-5Ghz, wifi2-6Ghz
SERVICE_5L_5H_6: wifi0-5G Low, wifi1-5G High, wifi2-6Ghz
SENSOR_SERVICE_5_2: wifi0-Tri-band sensor, wifi1-5GHz, wifi2-2.4Ghz
SERVICE_5L_5H_2: wifi0-5G Low, wifi1-5G High, wifi2-2.4Ghz
SERVICE_6L_5_6H: wifi0-6G Low, wifi1-5GHz, wifi2-6Ghz
' + enum: + - GENERIC + - SERVICE_2_5_6 + - SENSOR_SERVICE_5_6 + - SERVICE_5L_5H_6 + - SENSOR_SERVICE_5_2 + - SERVICE_5L_5H_2 + - SERVICE_6L_5_6H + type: string + default: GENERIC + example: SERVICE_2_5_6 + XiqDeviceWirelessInterfaceEntry: + type: object + description: Wireless Interface settings entry. + required: + - name + properties: + name: + $ref: '#/components/schemas/XiqWirelessIfName' + radio_profile_id: + type: integer + description: The Radio Profile ID + format: int64 + XiqConfigureRadioOperatingModeRequest: + type: object + description: Request to configure Radio Operating mode settings for AP device + required: + - radio_operating_mode + properties: + radio_operating_mode: + $ref: '#/components/schemas/XiqDeviceRadioOperatingMode' + wireless_interfaces: + description: Wireless Interface + type: array + items: + $ref: '#/components/schemas/XiqDeviceWirelessInterfaceEntry' PagedXiqNetworkPolicy: allOf: - $ref: '#/components/schemas/XiqPage' @@ -17136,6 +17625,13 @@ components: type: integer description: The audit log timestamp format: int64 + description: + type: string + description: The audit log summary + full_description_id: + type: integer + description: The audit log full description id + format: int64 PagedXiqAuditLog: allOf: - $ref: '#/components/schemas/XiqPage' @@ -17146,6 +17642,30 @@ components: description: The data in the current page items: $ref: '#/components/schemas/XiqAuditLog' + XiqAuditLogFullDescriptions: + type: object + description: ExtremeCloud IQ Audit Log full descriptions + required: + - id + - timestamp + - device_id + - description + properties: + id: + type: integer + description: The audit log full description id + format: int64 + timestamp: + type: integer + description: The full description timestamp + format: int64 + device_id: + type: integer + description: The device id + format: int64 + description: + type: string + description: The audit log full description XiqAuditLogReport: type: object description: ExtremeCloud IQ Audit Log report @@ -17577,6 +18097,21 @@ components: enable_distributed_upgrade: type: boolean description: Whether enable distributed firmware upgrade (Only applicable to APs) + XiqFirmwareUpgradeVersion: + type: object + description: Upgrade to the specific firmware version + required: + - firmware_id + - device_id + properties: + firmware_id: + type: integer + description: The device compatible firmware metadata ID + format: int64 + device_id: + type: integer + description: The device ID + format: int64 XiqFirmwareActivateOption: type: object description: The firmware activate option (Only one of them can be enabled) @@ -17603,6 +18138,11 @@ components: description: 'true if update complete configuration, otherwise update delta configuration. Note: ExtremeCloud IQ will neither upgrade device firmware nor reboot device for a delta configuration push. That means that the other parameters for firmware upgrade and activation are not required when this is false.' firmware_upgrade_policy: $ref: '#/components/schemas/XiqFirmwareUpgradePolicy' + firmware_upgrade_versions: + type: array + description: The firmware upgrade versions + items: + $ref: '#/components/schemas/XiqFirmwareUpgradeVersion' firmware_activate_option: $ref: '#/components/schemas/XiqFirmwareActivateOption' XiqDeploymentRequest: @@ -17616,13 +18156,37 @@ components: $ref: '#/components/schemas/XiqDeviceFilter' policy: $ref: '#/components/schemas/XiqDeploymentPolicy' - XiqDeploymentResponse: + XiqDeploymentStatus: type: object - description: The configuration deployment response + description: The configuration deployment status properties: - request_id: + current_progress: + type: integer + description: The current deploy progress if not finished, range from 0 to 100 + format: int32 + current_step_code: + type: string + description: The code of the current deploy step if not finished + current_step_message: + type: string + description: The readable message of the current deploy step if not finished + is_finished_successful: + type: boolean + description: Indicates whether the last deployment is successful if finished + last_deploy_time: type: integer + description: The last deployed time (Only valid when in_progress = false) format: int64 + finished: + type: boolean + XiqDeploymentResponse: + type: object + description: The configuration deployment response + properties: + deployment_status: + type: object + additionalProperties: + $ref: '#/components/schemas/XiqDeploymentStatus' XiqDeploymentOverview: type: object description: The configuration deployment overview @@ -17638,29 +18202,49 @@ components: type: integer description: The total progress, range from 0 to 100 format: int32 - XiqDeploymentStatus: + XiqDeviceFirmwareMetadata: type: object - description: The configuration deployment status + description: The device compatible firmware metadata properties: - current_progress: + firmware_id: type: integer - description: The current deploy progress if not finished, range from 0 to 100 - format: int32 - current_step_code: + description: The firmware metadata ID + format: int64 + create_time: type: string - description: The code of the current deploy step if not finished - current_step_message: + description: The create time + format: date-time + update_time: type: string - description: The readable message of the current deploy step if not finished - is_finished_successful: - type: boolean - description: Indicates whether the last deployment is successful if finished - last_deploy_time: - type: integer - description: The last deployed time (Only valid when in_progress = false) - format: int64 - finished: - type: boolean + description: The last update time + format: date-time + firmware_name: + type: string + description: The firmware name + firmware_type: + type: string + description: The firmware type + scope: + type: string + description: The firmware availability scope + version: + type: string + description: The firmware version + date: + type: string + description: The firmware release date + firmware_size: + type: string + description: The firmware size + display_version: + type: string + description: The firmware display version + supported_platforms: + type: string + description: The platforms supported by the firmware + md5: + type: string + description: The firmware md5 hash XiqClassificationType: type: string description: Classification type @@ -18486,7 +19070,7 @@ components: type: string description: The user group name description: The user's base info - XiqInitKeyBasedPcgNetworkPolicyRequest: + XiqCreateKeyBasedPcgNetworkPolicyRequest: type: object description: The request to initiate Key-based Private Client Group required: @@ -18505,6 +19089,31 @@ components: description: The Key-based PCG users items: $ref: '#/components/schemas/XiqKeyBasedPcgUserBaseInfo' + XiqCreateKeyBasedPcgNetworkPolicyResponse: + allOf: + - $ref: '#/components/schemas/XiqViqEntity' + - type: object + description: The response of key based PCG data + required: + - policy_id + - policy_name + - ssid_name + properties: + policy_id: + type: integer + description: The network policy ID + format: int64 + policy_name: + type: string + description: The network policy name + ssid_name: + type: string + description: The SSID name + users: + type: array + description: The XIQ key based PCG users + items: + $ref: '#/components/schemas/XiqKeyBasedPcgUser' XiqOnboardKeyBasedPcgRequest: type: object description: The payload to create Key Based PCG data(from exist network policy and SSID) @@ -18525,6 +19134,19 @@ components: type: integer description: The request user IDs format: int64 + XiqOnboardKeyBasedPcgResponse: + type: object + description: Add users to a PCG-enabled network policy + properties: + policy_name: + type: string + description: The policy name + ssid_name: + type: string + description: The SSID name + status: + type: string + description: Add user status XiqUpdateKeyBasedPcgUsersRequest: type: object description: The payload of replace Key-based Private Client Group users request @@ -18547,6 +19169,22 @@ components: description: The key based PCG users items: $ref: '#/components/schemas/XiqKeyBasedPcgUserBaseInfo' + XiqAddKeyBasedPcgUsersToNetworkPolicyResponse: + type: object + description: Add users to a PCG-enabled network policy + properties: + policy_id: + type: integer + description: The policy id + format: int64 + status: + type: string + description: Add user status + users: + type: array + description: The XIQ key based PCG users + items: + $ref: '#/components/schemas/XiqKeyBasedPcgUser' XiqDeleteKeyBasedPcgUsersRequest: type: object description: The payload of delete Key Based Private Client Group users request @@ -21167,20 +21805,6 @@ components: description: The data in the current page items: $ref: '#/components/schemas/XiqClientMonitorProfile' - XiqDeviceRadioOperatingMode: - title: OperatingMode - description: 'Modern AP hardware types include dual or triple band radios. A limited subset of band combinations are supported. Operating mode defines the supported band combinations per radio. Access Points with fixed band radios use GENERIC operating mode. SERVICE_2_5_6: wifi0-2.4Ghz, wifi1-5Ghz, wifi2-6Ghz SENSOR_SERVICE_5_6: wifi0-Tri-band sensor, wifi1-5Ghz, wifi2-6Ghz SERVICE_5L_5H_6: wifi0-5G Low, wifi1-5G High, wifi2-6Ghz SENSOR_SERVICE_5_2: wifi0-Tri-band sensor, wifi1-5GHz, wifi2-2.4Ghz SERVICE_5L_5H_2: wifi0-5G Low, wifi1-5G High, wifi2-2.4Ghz SERVICE_6L_5_6H: wifi0-6G Low, wifi1-5GHz, wifi2-6Ghz' - enum: - - GENERIC - - SERVICE_2_5_6 - - SENSOR_SERVICE_5_6 - - SERVICE_5L_5H_6 - - SENSOR_SERVICE_5_2 - - SERVICE_5L_5H_2 - - SERVICE_6L_5_6H - type: string - default: GENERIC - example: SERVICE_2_5_6 XiqDeviceRadioBand: type: string description: Radio Interface Bands @@ -29506,6 +30130,139 @@ components: description: The data in the current page items: $ref: '#/components/schemas/XiqThreadRouter' + XiqAfcServer: + allOf: + - type: object + properties: + region: + type: string + description: The country or regulatory region for which the AFC server provides service. + state: + $ref: '#/components/schemas/XiqAfcApStatus' + serverUrl: + type: string + description: url of the AFC server. + XiqAfcServerStatistics: + allOf: + - type: object + properties: + region: + type: string + description: The country or regulatory region for which the AFC server provides service. + state: + $ref: '#/components/schemas/XiqAfcApStatus' + avgRespTime: + type: integer + description: Average Respond time of AFC server. + reqErrors: + type: integer + description: The total number of failed requests. + reqSuccess: + type: integer + description: The total number of successful requests. + reqRetries: + type: integer + description: The total number of retried requests. + reqPending: + type: integer + description: The total number of pending requests. + reqRefreshed: + type: integer + description: The total number of completed requests. + XiqAfcJobStatistics: + allOf: + - $ref: '#/components/schemas/XiqPage' + - type: object + properties: + site: + type: string + description: Site name. + apCount: + type: integer + description: The total number of Aps per site. + start: + type: string + description: Query start time. + end: + type: string + description: Query end time. + success: + type: integer + description: The total number of successful Aps with successful AFC requests. + errors: + type: integer + description: The total number of Aps with failed Afc requests. + retries: + type: integer + description: The total number of retries per site. + avgRespTime: + type: integer + description: Average respond time per site. + XiqChannelPowerInfo: + allOf: + - type: object + properties: + expire: + type: string + opCh: + type: string + pwr: + type: integer + pwrMode: + $ref: '#/components/schemas/XiqAfcPowerMode' + XiqAfcApInterfaceDetails: + allOf: + - type: object + properties: + afcStatus: + $ref: '#/components/schemas/XiqAfcApStatus' + expire: + type: integer + description: timestamp of the next Ap channel/power info query. + received: + type: integer + description: Timestamp of the acquired channel/power (milliseconds from epoch). + reason: + type: string + channelPlan: + type: array + description: Available channels for this AP. + items: + $ref: '#/components/schemas/XiqChannelPowerInfo' + XiqAfcApStatusSummary: + allOf: + - type: object + properties: + totalAvailable: + type: integer + totalPending: + type: integer + totalGracePeriod: + type: integer + XiqAfcGeolocationSummary: + allOf: + - type: object + properties: + totalAvailable: + type: integer + description: Total number of Aps that have reported their geo location. + totalUnavailable: + type: integer + description: Total number of Aps that have not reported their geo location. + XiqAfcSiteSchedule: + allOf: + - type: object + properties: + ownerId: + type: integer + format: int64 + folderId: + type: integer + format: int64 + siteTimeZone: + type: string + siteSchedule: + type: integer responses: ErrorResponse: description: The generic ExtremeCloud IQ API error response @@ -30152,3 +30909,26 @@ components: schema: type: integer format: int64 + sn: + name: sn + in: path + description: The serial number of an Ap. + required: true + schema: + type: string + ownerId: + name: ownerId + in: query + description: The Owner Id + required: true + schema: + type: integer + format: int64 + folderId: + name: folderId + in: query + description: The folder id for the location + required: true + schema: + type: integer + format: int64