The identity and technical contract details declared by the specification.
XiqMacFirewallPolicyRequest
object
3 properties
3 required
XiqAddressProfileClassifiedEntry
object
Address profile classified entry
6 properties
XiqMacFirewallAction
string
XiqHsVenue
object
Venue information helps client devices understand the type and nature of the location where the Wi-Fi network is deployed.
3 properties
XiqHsIpv6Type
string
The IPv6 address availability enum.
XiqCreateClassificationRuleRequest
object
3 properties
2 required
XiqRadioMode
string
The supported radio modes.
XiqApplicationDetectionProtocol
string
XiqHsConnectionCapability
object
The connection capability informs client devices about available network services. Used to identify the IP protocols that are permitted or denied on the networ…
3 properties
3 required
XiqUpdateL3AddressProfileRequest
object
7 properties
XiqL3AddressType
string
Address type
PagedXiqHotspotServiceProviderProfile
XiqUpdateUserProfileRequest
object
2 properties
XiqUpdateRpMacOuiProfileRequest
object
5 properties
XiqSsidPpskKeyManagement
string
The key management: WPA2PSK, WPAPSK, AUTOPSK
XiqPcgType
string
The private client group type for pcgUseOnly
XiqSsidSaeGroup
string
The SAE group: ALL, ECC, or FFC, must be selected when the key management is WPA3
XiqDeviceRadioModesSettings
array
Device Radio Operating Mode settings based on AP Model.
XiqSsidKeyManagement
string
PagedXiqClientMonitorProfile
XiqCreateL3AddressProfileRequest
object
9 properties
2 required
XiqIotpMaBleBeaconEddystoneUrl
object
5 properties
2 required
XiqUpdateRpChannelSelectionRequest
object
21 properties
XiqClientMonitorParameters
object
The client monitor setting parameters
2 properties
XiqDeviceRadioBand
string
Radio Interface Bands
XiqIotpMaBleScanDestination
object
The BLE Scan destination.
1 property
XiqHsCellularNetwork
object
The 3GPP cellular network.
3 properties
2 required
XiqIotpMaBleBeaconIBeacon
object
7 properties
4 required
XiqCreateMacObjectRequest
object
5 properties
3 required
XiqHotspotServiceProviderProfileRequest
object
The Hotspot Service Provider profile.
10 properties
1 required
XiqSsidKeyType
string
The key type, ASCII or HEX
XiqAttachIpFirewallRuleToIpFirewallPolicy
object
5 properties
XiqCreateRpMacOuiProfileRequest
object
5 properties
2 required
XiqValidForTimePeriodSettings
object
The settings for Valid For Time Period option or null for other settings.
3 properties
1 required
XiqIpFirewallPolicyRequest
object
3 properties
3 required
XiqDeviceInterfaceRadioMode
object
Device Radio Interface Band.
3 properties
3 required
XiqHsAccessNetworkType
string
The Hotspot profile Access Network: PRIVATE - An enterprise network with user accounts. PRIVATEWITHGUEST - An enterprise network providing guest access. CHARGE…
XiqHsWanMetrics
object
Hotspot WAN (Wide Area Network) metrics.
3 properties
3 required
XiqHsRoamingConsortium
object
The Roaming Consortium network provider.
2 properties
1 required
XiqApplicationDetectionType
string
XiqCreateUserProfileRequest
object
2 properties
2 required
XiqPostExpirationAction
object
The type of action to take after the account expiration.
4 properties
XiqIotpMaBleScan
object
2 properties
XiqHsVenueType
string
The venue type ID further specifies the particular kind of location within the general venue group. Each venue type ID must match the venue group ID to accurat…
XiqIotpMaBleScanGeneric
object
3 properties
1 required
XiqSsidPskKeyManagement
string
The key management: WPA3PSK, WPA2PSK, WPAPSK,AUTOPSK
XiqSsidWepEncryptionMethod
string
The encryption method type, WEP104 or WEP40
XiqWirelessIfName
string
The one or multiple ssid on wifi interfaces (example:wifi0 or wifi1) to be disabled/enabled, cannot be empty or no SSID will be disabled or enabled.
XiqClassificationType
string
Classification type
XiqSsidEncryptionMethod
string
XiqHsConnectionCapabilityStatus
string
Connection capability status.
XiqSsidPskEncryptionMethod
string
The encryption method: for WPA3PSK please use CCMP, for WPA2PSK or WPAPSK, please use CCMP or TKIP, for AUTOPSK, please use AUTOTKIPCCMP
XiqHsVenueGroup
string
The venue group ID categorizes the general type of location.
XiqAttachUPAssignmentRequest
object
6 properties
XiqHotspotProfileRequest
object
The Hotspot profile.
19 properties
2 required
XiqIotpMaBleBeaconApplication
object
The BLE Beacon application
XiqSetSsidModeWepRequest
object
The request for setting the SSID to be WEP mode.
10 properties
2 required
XiqHsQosMap
object
2 properties
XiqPasswordDbLocation
string
The access key storage location
XiqUpdateRpSensorScanSettingsRequest
object
3 properties
XiqLoggingType
string
Firewall Rule Logging type
XiqSetSsidModePskRequest
object
The request for setting the SSID to be PSK mode.
7 properties
4 required
XiqHttpServer
object
3 properties
1 required
PagedXiqClassificationRule
XiqPasswordType
string
The access key type
XiqDetachMacFirewallRequest
object
2 properties
1 required
XiqRpRadioUsageOptimization
XiqValidDailySettings
object
The settings for Valid Daily option or null for other settings.
4 properties
4 required
XiqHsQosDscpException
object
A DSCP priority to map to an Extreme QoS class that is different than the class mapped to the DSCP range in which the DSCP priority already exists.
2 properties
2 required
XiqSsidWepAuthenticationMethod
string
The authentication method type, OPEN or SHARED
XiqValidTimePeriodAfterIdCreation
object
The settings for the valid time period after ID Creation option or null for the other option
2 properties
2 required
XiqHsLanguageCode
string
Language code (3B abbreviation) found at: http://www.loc.gov/standards/iso639-2/ISO-639-2utf-8.txt.
XiqAttachMacFirewallRequest
object
2 properties
2 required
XiqUserProfileAssignmentRule
XiqRpMiscellaneousSettings
XiqApplicationDetectionRule
object
The Application Detection Rule
3 properties
XiqWildcardAddressProfile
XiqDeliverySettings
object
The password delivery settings
2 properties
XiqHsWanLinkStatus
string
The WAN metric status.
XiqIotpMaBleScanVendorType
string
The BLE Scan Vendor types for BLE Scan applications.
XiqUpdateRpNeighborhoodAnalysisRequest
object
5 properties
XiqRadiusClientProfileEntry
XiqDeviceRadioOperatingMode
string
Modern AP hardware types include dual or triple band radios. A limited subset of band combinations are supported. Operating mode defines the supported band com…
XiqIotApplicationId
string
IoT application identifiers.
XiqNetworkServiceRequest
object
Network
6 properties
XiqCreateUserProfileAssignmentRequest
object
4 properties
XiqAttachMacFirewallRuleToMacFirewallPolicy
object
4 properties
XiqIotpMaBleScanVendor
object
3 properties
1 required
XiqUserProfileAssignmentRadiusAttribute
XiqMacFirewallRuleId
object
1 property
1 required
XiqValidDuringDateSettings
object
The settings for Valid During Dates option or null for other settings.
3 properties
3 required
XiqSetSsidModeDot1xRequest
object
The request for setting the SSID to be 802.1x mode and Authentication settings. Authentication with ExtremeCloud IQ Authentication Service and Authentication w…
7 properties
2 required
XiqHsNaiRealm
object
The Network Access Identification (NAI) realm.
4 properties
1 required
XiqHsOnlineSignup
object
The Hotspot profile Online Signup settings.
3 properties
1 required
XiqRpNeighborhoodAnalysis
XiqIpFirewallRuleId
object
1 property
1 required
XiqHsNaiEncodingType
string
The NAI realm encoding type.
XiqMacFirewallRuleRequest
object
4 properties
XiqIotpMaBleBeaconAppType
string
The BLE Beacon application type.
XiqPage
object
4 properties
4 required
XiqDateTimeType
object
The end date and time
5 properties
5 required
XiqValidTimePeriodAfterType
string
The valid time period after Id creation or first login.
XiqIotpMaBleScanEddystoneUrl
object
2 properties
1 required
XiqNetworkIpProtocol
string
XiqUpdateRpMiscellaneousSettingsRequest
object
2 properties
XiqExpirationType
string
The for one of the account expiration types.
XiqUpdateRpRadioUsageOptimizationRequest
object
35 properties
XiqWildcardHostNameAddressProfile
XiqSsidDot1xEncryptionMethod
string
The encryption method: for WPA8021X, WPA28021X, please use CCMP or TKIP, for AUTO8021X, please use AUTOTKIPCCMP, for WPA38021X, please use AES192
XiqVlanObjectClassifiedEntry
XiqDetachIpFirewallRequest
object
2 properties
1 required
XiqCreateCloudConfigGroupRequest
object
3 properties
1 required
XiqExpirationSettings
object
The password expiration settings
6 properties
XiqUpdateRpWmmQosSettingsRequest
object
5 properties
XiqSsidWepKeyManagement
string
The key management type, WEP or WEP8021X
XiqIotpMaBleScanApplication
object
The BLE Scan application
XiqIotpMaBleScanAppType
string
The BLE Scan application type.
XiqUserProfileAssignmentEntry
object
2 properties
XiqError
object
6 properties
3 required
XiqPskGenerationMethod
string
The psk generation method
XiqIotProfileThreadGateway
object
4 properties
2 required
XiqUpdateCloudConfigGroupRequest
object
3 properties
XiqHsIpv4Type
string
The IPv4 address availability enum: NOTAVAILABLE - No IPv4 address is available. PUBLIC - A publicly routable IPv4 address is available. PORTRESTRICTED - An IP…
XiqHsQosAhClassToDscpRange
object
ahclass to DSCP range. The DSCP range for each user priority is non-overlapping. The end value for the DSCP range must be greater than or equal to the start va…
3 properties
3 required
XiqBaseEntity
object
3 properties
3 required
XiqAttachIpFirewallRequest
object
2 properties
2 required
XiqSsidDot1xKeyManagement
string
The key management: WPA8021X, WPA28021X, WPA38021X or AUTO8021X
XiqTraffic
string
The Firewall traffic direction.
XiqHsConnectionCapabilityProtocol
string
Hotspot Connection Capability protocol.
XiqDateTimeUnitType
string
The after expiration scheduled time unit.
XiqHsspOsuMethod
string
OSU protocols supported by the Service Provider: OMADM - Set OSU provider support of the OMA DM (Open Mobile Alliance Device Management) protocol. SOAPXMLSPP -…
XiqRecurrenceType
string
The schedule recurrence type.
XiqHsLocalizedName
object
A language specific name.
2 properties
1 required
XiqIotpTgWhiteListEntry
object
2 properties
2 required
XiqValidTimePeriodAfterFirstLogin
object
The settings for the valid time period after First Login option or null for the other option
4 properties
4 required
XiqCreateClassificationRequest
object
The details of rule assignments
3 properties
3 required
XiqIpFirewallRuleRequest
object
5 properties
XiqHsspIconFile
object
The OSU registration server icon according to language mode.
3 properties
2 required
XiqScheduleType
string
The schedule type.
XiqIotpMaBleBeacon
object
1 property
XiqClientMonitorSetting
object
The client monitor setting
3 properties
XiqUpdateRadioProfileRequest
object
11 properties
XiqHsEapMethod
string
The Extensible Authentication Protocol (EAP) method.
XiqIotApplicationSupported
string
IoT profile supported type.
XiqClientMonitorProfileRequest
XiqHotspotServiceProviderProfile
XiqMacObjectType
string
Mac Object type
XiqIpFirewallAction
string
XiqUpdateSsidAdvancedSettingsRequest
object
1 property
XiqUpdateMacObjectRequest
object
4 properties
XiqUpdateClassificationRuleRequest
object
3 properties
2 required
XiqSsidWepDefaultKey
string
The default key, FIRST, SECOND,THIRD, OR FOURTH
XiqPasswordCharacterType
string
Password generation using letters, numbers, and/or special characters
XiqIotProfileRequest
object
The IoT Profile
XiqExpirationActionType
string
The Expiration Action to take, null if the account is never expired.
XiqHsOsuNetworkAuthType
string
The Network Authentication type for Hotspot profiles: ACCEPTANCETERMS - Indicate that the network requires the user to accept terms and conditions. ONLINESIGNU…
XiqIotProfileMultiApplication
object
4 properties
2 required
XiqCreateRadioProfileRequest
object
11 properties
1 required
XiqUpdateClassificationRequest
object
The details of rule Rules
3 properties
3 required
XiqPasswordSettings
object
The password settings ID
7 properties
3 required
XiqHostNameAddressProfile
XiqIotpMaBleScanIBeacon
object
3 properties
1 required
XiqErrorParams
object
Error parameters
2 properties
XiqDetachUPAssignmentRequest
object
1 property
XiqSetSsidModePpskRequest
object
The request for setting the SSID to be PPSK mode.
8 properties
5 required
PagedXiqUserProfileAssignment
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Extreme Networks publishes across the network.