Download OpenAPI specification:Download
The Platform Manager API provides a programmatic interface to access and manage backup files, flash memory, license information, controller logs, network test data, and platform settings.
It is based on RESTful principles and uses standard HTTP methods for requests and responses. It uses OAuth 2.0 for authentication and authorization. API request and response bodies are formatted in JavaScript Object Notation (JSON).
Note: To submit API calls, your RESTful API consuming program needs to have logged in using credentials granting at least read permissions, and only user accounts with FullAdmin credentials can make configuration changes through the REST API.
The Platform Manager REST API uses the OAuth 2.0 protocol to provide secure authorized access to the API. OAuth is an authorization framework that enables web, mobile, and desktop applications to access protected resources.
To begin, pass your client login credentials in the Authorization header within a POST request to the management/v1/oauth2/token
endpoint.
In exchange for these credentials the ExtremeCloud Appliance authorization server issues tokens called bearer tokens that you use for authorization when making subsequent REST API calls.
Error message
ExtremeCloud Appliance REST API server
ExtremeCloud Appliance REST API server
Replaces the complete backup schedule on the controller with one that is input, provided that all attributes of the new schedule are valid. If the frequency attribute of the new schedule is none then the rest of the schedule attributes are ignored. If the frequency is set to none any previously set backup schedule is canceled and no new scheduled backups will occur till another schedule is installed.
new schedule to set
frequency | string (BackupFrequencyType) Enum: "none" "daily" "weekly" "monthly" Represents an enum data type containing the possible frequencies of configuration backups. |
backupWhat | string (BackupTypes) Enum: "all" "configuration" |
backupDestination | string (BackupDestination) Enum: "none" "local" "remote" "flash" A list of backup destination setting options (local, remote,..). |
transferMethod | string (FileTransferMethod) Enum: "ftp" "scp" "http" |
remoteFile | object (RemoteFile) |
dailyOptions | object (DailyScheduleOptions) |
weeklyOptions | object (WeeklyScheduleOptions) |
monthlyOptions | object (MonthlyScheduleOptions) |
startTime | string The time at which the periodic backup starts each day that it runs. The time is in 24 hour military local time in the form HH-MM. A dash ('-') is used in place of a ':' as the separator between hours and minutes. |
Error message
ExtremeCloud Appliance REST API server
Replaces the complete backup schedule on the controller with one that is input, provided that all attributes of the new schedule are valid. If the frequency attribute of the new schedule is none then the rest of the schedule attributes are ignored. If the frequency is set to none any previously set backup schedule is canceled and no new scheduled backups will occur till another schedule is installed.
new schedule to set
frequency | string (BackupFrequencyType) Enum: "none" "daily" "weekly" "monthly" Represents an enum data type containing the possible frequencies of configuration backups. |
backupWhat | string (BackupTypes) Enum: "all" "configuration" |
backupDestination | string (BackupDestination) Enum: "none" "local" "remote" "flash" A list of backup destination setting options (local, remote,..). |
transferMethod | string (FileTransferMethod) Enum: "ftp" "scp" "http" |
remoteFile | object (RemoteFile) |
dailyOptions | object (DailyScheduleOptions) |
weeklyOptions | object (WeeklyScheduleOptions) |
monthlyOptions | object (MonthlyScheduleOptions) |
startTime | string The time at which the periodic backup starts each day that it runs. The time is in 24 hour military local time in the form HH-MM. A dash ('-') is used in place of a ':' as the separator between hours and minutes. |
Error message
ExtremeCloud Appliance REST API server
The identifier backup represents backup operations(what to backup & destination)
backupWhat | string (BackupTypes) Enum: "all" "configuration" |
backupDestination | string (LocalDestination) Enum: "local" "flash" |
Error message
ExtremeCloud Appliance REST API server
fileInputStream | string <binary> Input stream |
fileMetaData | string <binary> Input file meta data (see Usage) Usage: curl -k -i -X POST -H 'Authorization: Bearer 6359d9d3c431157983d13b4edbca6026' -H "Content-Type: multipart/form-data" -F "file=@V2110-smoke.01032018.121518.zip" https://192.168.3.62:5825/platformmanager/v1/configuration/fileupload |
body | string <binary> |
Error message
ExtremeCloud Appliance REST API server
If the identified backup file exists, the file (in .zip format) is transferred back to the requestor with appropriate HTTP headers and mime type. If not, a standard 404 type error is returned.
id required | string Name of the backup file to download via HTTP. |
Error message
ExtremeCloud Appliance REST API server
Deletes the backup file the name of which was passed in as a parameter. The delete occurs in line and the method does not return till the delete operation completes. The method returns true if the deletion succeeded and false for any other reason.
id required | string The identifier number for the backup file to be deleted |
Error message
ExtremeCloud Appliance REST API server
Copies a backup file on the controller to a server elsewhere in the network. This method returns immediately even if it succeeds. The file transfer takes place in the background.
protocol required | string Only FTP and SCP are supported. |
The details to use when transferring the file. The remoteFile.fileName attribute must match the name of a backup file stored locally on the controller at the time the command is issued.
serverIP | string The IPv4 address of the server that is storing or going to store the subject file. It cannot be null. |
userid | string The user ID to authenticate with the file server. It cannot be null. |
password | string The password to authenticate with the file server. It cannot be null. |
directory | string The path on the server of the directory in which the subject file resides or is to be stored. It cannot be null but could be '/' |
fileName | string The name of the file that is to be pulled from or pushed to the file server. It cannot be null, a zero length string or begin or end with blanks. |
localDestination | string (LocalDestination) Enum: "local" "flash" |
Error message
ExtremeCloud Appliance REST API server
Copies a backup file on the controller to a server elsewhere in the network. This method returns immediately even if it succeeds. The file transfer takes place in the background.
protocol required | string Only FTP and SCP are supported. |
The details to use when transferring the file. The remoteFile.fileName attribute must match the name of a backup file stored locally on the controller at the time the command is issued.
serverIP | string The IPv4 address of the server that is storing or going to store the subject file. It cannot be null. |
userid | string The user ID to authenticate with the file server. It cannot be null. |
password | string The password to authenticate with the file server. It cannot be null. |
directory | string The path on the server of the directory in which the subject file resides or is to be stored. It cannot be null but could be '/' |
fileName | string The name of the file that is to be pulled from or pushed to the file server. It cannot be null, a zero length string or begin or end with blanks. |
localDestination | string (LocalDestination) Enum: "local" "flash" |
Error message
ExtremeCloud Appliance REST API server
This method is the inverse of copyBackupTo. It copies a file (assumed to be a controller backup) from a mounted USB flash drive or a remote FTP or SCP file server. The file is not restored. It is simply copied to the controller. Returns true if the input parameters are valid and false otherwise. The copy can take time so the method does not wait for the copy to complete before returning.
protocol required | string Only FTP and SCP are supported. |
The attributes necessary to pull the desired backup file from a file server.
serverIP | string The IPv4 address of the server that is storing or going to store the subject file. It cannot be null. |
userid | string The user ID to authenticate with the file server. It cannot be null. |
password | string The password to authenticate with the file server. It cannot be null. |
directory | string The path on the server of the directory in which the subject file resides or is to be stored. It cannot be null but could be '/' |
fileName | string The name of the file that is to be pulled from or pushed to the file server. It cannot be null, a zero length string or begin or end with blanks. |
localDestination | string (LocalDestination) Enum: "local" "flash" |
Error message
ExtremeCloud Appliance REST API server
This method is the inverse of copyBackupTo. It copies a file (assumed to be a controller backup) from a mounted USB flash drive or a remote FTP or SCP file server. The file is not restored. It is simply copied to the controller. Returns true if the input parameters are valid and false otherwise. The copy can take time so the method does not wait for the copy to complete before returning.
protocol required | string Only FTP and SCP are supported. |
The attributes necessary to pull the desired backup file from a file server.
serverIP | string The IPv4 address of the server that is storing or going to store the subject file. It cannot be null. |
userid | string The user ID to authenticate with the file server. It cannot be null. |
password | string The password to authenticate with the file server. It cannot be null. |
directory | string The path on the server of the directory in which the subject file resides or is to be stored. It cannot be null but could be '/' |
fileName | string The name of the file that is to be pulled from or pushed to the file server. It cannot be null, a zero length string or begin or end with blanks. |
localDestination | string (LocalDestination) Enum: "local" "flash" |
Error message
ExtremeCloud Appliance REST API server
A method to pre-check upload of a configuration backup file for errors. A configuration backup file (upto 10 files allowed) or backup file extension "*.zip". Usage: curl -k -H "Authorization: Bearer 5637242c9e3f9b7a7b4847a35a4afad9" -X GET https://192.168.3.62:5825/platformmanager/v1/configuration/prefileupload/"V2110-smoke.01032018.121518.zip"
filename required | string |
Error message
ExtremeCloud Appliance REST API server
Restores the contents of the identified backup file into the filesystem. Returns true if the restore was started and false otherwise. The restore can take time so the method does not wait for the restore to complete before returning.
id required | string Identifier for the backup file to be restored. File must be on the controller at the time this command is issued. |
Error message
ExtremeCloud Appliance REST API server
A command that causes the controller to mount a USB flash memory drive that has been plugged into the controller. The controller does not auto-mount USB flash drives so this method must be called before trying to use the USB drive with the controller. The method should not return till the mount operation completes.
Error message
ExtremeCloud Appliance REST API server
ExtremeCloud Appliance REST API server
This method unmounts a USB key (memory stick) that is mounted on the controller. The USB key should be unmounted manually before removing it from the controller's USB socket. The method always returns success, even when no USB key is mounted. The method does not return till the unmount operation completes.
Error message
ExtremeCloud Appliance REST API server
A command that causes the controller to delete a file from the mounted flash drive. Returns OK if the file was deleted or an error. The method returns 404 if the file is not in the root directory of the flash drive or a flash drive is not mounted.
id required | string The name of the file to be deleted from the USB key. |
Error message
ExtremeCloud Appliance REST API server
License summary information.
Error message
ExtremeCloud Appliance REST API server
license key to be install
key | string |
type | number |
optionKeys | Array of objects (KeyElement) |
Error message
ExtremeCloud Appliance REST API server
ExtremeCloud Appliance REST API server
license file info
file | string |
data | string |
Error message
ExtremeCloud Appliance REST API server
list of encoded licenses string
lic | Array of strings |
failure message
ExtremeCloud Appliance REST API server
A method to get controller's aps log. example : curl -X GET 'https://192.168.3.62:5825/platformmanager/v1/logging/aps'
endTime | number >= 1 End time in milliseconds |
startTime | number >= 1 Start time in milliseconds |
Error message
ExtremeCloud Appliance REST API server
endTime | number >= 1 End time in milliseconds |
startTime | number >= 1 Start time in milliseconds |
Error message
ExtremeCloud Appliance REST API server
endTime | number >= 1 End time in milliseconds |
startTime | number >= 1 Start time in milliseconds |
Error message
ExtremeCloud Appliance REST API server
Success message if set works, otherwise a failure code.
Error message
ExtremeCloud Appliance REST API server
custId | string |
id | string |
syslogConfiguration | object (SyslogConfigurationElement) This POJO represents the switch level configuration with a collection of destination IP addresses of the servers and UDP ports. |
incVarLog | boolean Allows user to set radio mode to Off, or enable a combination of protocols. Mode options will depend on AP model and radios band. For radio1: a/n/ac == 84, ac-strict == 132. For radio2: b/g == 3, g/n == 18, b/g/n == 19, n-strict == 32 Validations : Not null, non-empty and a valid RadioMode value as string. |
incAuditLog | boolean |
incStationEvent | boolean |
syslogAuditFacility | string (FacilityLogsLevelElement) Enum: "local0" "local1" "local2" "local3" "local4" "local5" "local6" A list of log levels used in facility logging. |
syslogStationEventFacility | string (FacilityLogsLevelElement) Enum: "local0" "local1" "local2" "local3" "local4" "local5" "local6" A list of log levels used in facility logging. |
syslogMsgFacility | string (FacilityLogsLevelElement) Enum: "local0" "local1" "local2" "local3" "local4" "local5" "local6" A list of log levels used in facility logging. |
syslogEventFacility | string (FacilityLogsLevelElement) Enum: "local0" "local1" "local2" "local3" "local4" "local5" "local6" A list of log levels used in facility logging. |
Error message
ExtremeCloud Appliance REST API server
ExtremeCloud Appliance REST API server
configure the controller's severe log level that you want to receive. the log levels are Information, Minor, Major, Critical. For example, if you select Minor, you receive all Minor, Major and Critical messages. If you select Major you receive all Major and Critical messages. The default is Minor. If set reportStationEvents to true, controller will collect and display station session events on the controller station events log.
logLevel | string (SystemlogLogging) Enum: "critical" "major" "minor" "info" |
sendStationEventTrap | boolean |
Error message
ExtremeCloud Appliance REST API server
ExtremeCloud Appliance REST API server
The ping test is run in line and the results are streamed back as they are received. Sometimes this can result in the entire ping session being returned in one file.
An object containing the details that control this particular run of the ping test. ping source-interface name Admin 192.168.3.48
targetIPAddress | string The IP address to be tested for connectivity with the controller. |
specificInterface | boolean Indicates whether the test is to be performed using a specific interface or topology defined on the controller. If true, then the topology attribute must be set to the name of a topology or interface defined on the controller and the controller will only test for reachability from that interface. If set to false, the controller will pick the interface/topology to use for testing based on internal routing rules. |
sourceInterface | string Represents the controller interface/topology from which the connectivity test will be conducted. Can be null if specificInterface is set to false. If specificInterface is set to true, sourceInterface must be between 1 and 63 characters long, and not contain invalid characters. Valid values: 'Admin' or any of the physical interfaces name |
Error message
ExtremeCloud Appliance REST API server
The ping test is run in line and the results are streamed back as they are received. Sometimes this can result in the entire ping session being returned in one file.
An object containing the details that control this particular run of the ping test.
targetIPAddress | string The IP address to be tested for connectivity with the controller. |
specificInterface | boolean Indicates whether the test is to be performed using a specific interface or topology defined on the controller. If true, then the topology attribute must be set to the name of a topology or interface defined on the controller and the controller will only test for reachability from that interface. If set to false, the controller will pick the interface/topology to use for testing based on internal routing rules. |
sourceInterface | string Represents the controller interface/topology from which the connectivity test will be conducted. Can be null if specificInterface is set to false. If specificInterface is set to true, sourceInterface must be between 1 and 63 characters long, and not contain invalid characters. Valid values: 'Admin' or any of the physical interfaces name |
Error message
ExtremeCloud Appliance REST API server
Starts a tcpdump operation. Attempts to download the dump file will fail until the test is completed or stopped manually. The dump proceeds in the background till it times out or is stopped. Once the dump completes the tcpdump capture file can be downloaded by calling getTcpDumpFile.
sourceInterface | string |
captureFileName | string |
captureFileMaxMegabytes | number |
destination | string (LocalDestination) Enum: "local" "flash" |
Error message
ExtremeCloud Appliance REST API server
Starts a tcpdump operation. Attempts to download the dump file will fail until the test is completed or stopped manually. The dump proceeds in the background till it times out or is stopped. Once the dump completes the tcpdump capture file can be downloaded by calling getTcpDumpFile.
sourceInterface | string |
captureFileName | string |
captureFileMaxMegabytes | number |
destination | string (LocalDestination) Enum: "local" "flash" |
Error message
ExtremeCloud Appliance REST API server
Returns a list of all the tcpdump files stored on the controller. The filenames can be used to retrieve or delete individual files.
Error message
ExtremeCloud Appliance REST API server
Traceroute is run inline and the results are streamed back as they are received. Sometimes this can result in the entire traceroute session being returned in one file. This can take a noticeable period of time (10-20 seconds), so a progress indicator may be useful in a UI.
An object containing the attributes that will control the requested run of traceroute.
targetIPAddress | string The IP address to be tested for connectivity with the controller. |
specificInterface | boolean Indicates whether the test is to be performed using a specific interface or topology defined on the controller. If true, then the topology attribute must be set to the name of a topology or interface defined on the controller and the controller will only test for reachability from that interface. If set to false, the controller will pick the interface/topology to use for testing based on internal routing rules. |
sourceInterface | string Represents the controller interface/topology from which the connectivity test will be conducted. Can be null if specificInterface is set to false. If specificInterface is set to true, sourceInterface must be between 1 and 63 characters long, and not contain invalid characters. Valid values: 'Admin' or any of the physical interfaces name |
Error message
ExtremeCloud Appliance REST API server
Traceroute is run inline and the results are streamed back as they are received. Sometimes this can result in the entire traceroute session being returned in one file. This can take a noticeable period of time (10-20 seconds), so a progress indicator may be useful in a UI.
An object containing the attributes that will control the requested run of traceroute.
targetIPAddress | string The IP address to be tested for connectivity with the controller. |
specificInterface | boolean Indicates whether the test is to be performed using a specific interface or topology defined on the controller. If true, then the topology attribute must be set to the name of a topology or interface defined on the controller and the controller will only test for reachability from that interface. If set to false, the controller will pick the interface/topology to use for testing based on internal routing rules. |
sourceInterface | string Represents the controller interface/topology from which the connectivity test will be conducted. Can be null if specificInterface is set to false. If specificInterface is set to true, sourceInterface must be between 1 and 63 characters long, and not contain invalid characters. Valid values: 'Admin' or any of the physical interfaces name |
Error message
ExtremeCloud Appliance REST API server
ExtremeCloud Appliance REST API server
Stops any tcpdump operation in progress on the controller. To keep things simple this returns success whether a tcpdump is in progress or not.
Error message
ExtremeCloud Appliance REST API server
A method that allows the caller to download the named tcpdump capture file to his location.
id required | string Name of the tcpdump capture file to retrieve from the controller. |
Error message
ExtremeCloud Appliance REST API server
Delete the named TCP Dump File. Returns 404 if the named file does not exist on the controller. i.e.
curl -H "Content-Type: " -X DELETE
https://192.168.3.62:5825 /platformmanager/v1/network/test/tcpdumpfile/"mgmt_traffic_blah1.cap(flash)"
id required | string The name of the tcpdump capture file to delete from controller storage. |
Error message
ExtremeCloud Appliance REST API server
the current mac address format setting
Error message
ExtremeCloud Appliance REST API server
macAddressFormat | string (MacFormat) Default: "UPPERCASE_NO_DELIMITERS" Enum: "UPPERCASE_NO_DELIMITERS" "UPPERCASE_COLON_PER2X" "UPPERCASE_HYPHEN_PER2X" "UPPERCASE_DOT_PER4X" "UPPERCASE_HYPHEN_PER6X" "UPPERCASE_SPACE_PER2X" "LOWERCASE_NO_DELIMITERS" "LOWERCASE_COLON_PER2X" "LOWERCASE_HYPHEN_PER2X" "LOWERCASE_DOT_PER4X" "LOWERCASE_HYPHEN_PER6X" "LOWERCASE_SPACE_PER2X" |
Error message
ExtremeCloud Appliance REST API server
the administration interface's setting.
Error message
ExtremeCloud Appliance REST API server
custId | string |
id | string |
name | string Represents the unique name of the Administrator Interface. This property cannot be modified. |
mode | string (ModesAdminInterface) Enum: "Routed" "BridgedAtAp" "BridgedAtAc" "ThirdPartyAP" "Physical" "Management" "FabricAttach" |
ipAddress | string Represents a valid IP Address of the Management Interface. |
cidr | number Net Mask Validations : 9 to 30! |
mtu | number Represents the MTU size, only 1500 size is supported |
cert | number Represents a boolean value to indicate if a custom certificate is installed: 0 or 1 |
certCa | number Represents a boolean value to indicate if a custom CA certificate is installed: 0 or 1 |
Error message
ExtremeCloud Appliance REST API server
ExtremeCloud Appliance REST API server
ExtremeCloud Appliance REST API server
ExtremeCloud Appliance REST API server
Map with packet capture name and corresponding ID
Error response
ExtremeCloud Appliance REST API server
ExtremeCloud Appliance REST API server
availabilityEnabled | boolean |
availabilityRole | string (AvailabilityRole) Enum: "PRIMARY" "BACKUP" |
availabilityPairAddr | string The IP address of the Peer EAE. |
Error message
ExtremeCloud Appliance REST API server
the current packet capture setting
Error message
ExtremeCloud Appliance REST API server
ids | string <uuid> The list of ids if not provided all current capture status will be returned. |
the current packet capture setting
Error message
ExtremeCloud Appliance REST API server
ExtremeCloud Appliance REST API server
hour | number |
minute | number |
Error message
ExtremeCloud Appliance REST API server
Returns an object containing the controller's view of its Host Name, Domain Name and the DNS servers it can use.
Error message
ExtremeCloud Appliance REST API server
Sets an object containing the controller's view of its Host Name, Domain Name and the DNS servers it can use.
An object that contains the domain name, host name and list of DNS servers that are assigned to the controller.
hostName | string |
domainName | string |
dnsServers | Array of strings |
Error message
ExtremeCloud Appliance REST API server
Sets an object containing the controller's view of its Host Name, Domain Name and the DNS servers it can use.
An object that contains the domain name, host name and list of DNS servers that are assigned to the controller.
hostName | string |
domainName | string |
dnsServers | Array of strings |
Error message
ExtremeCloud Appliance REST API server
custId | string |
id | string |
name | string The user assigned identifier for the physical topology. For release 1.0 the interfaces cannot be renamed, but that ability will be added in a future release. |
mode | string (Modes) Enum: "Routed" "BridgedAtAp" "BridgedAtAc" "ThirdPartyAP" "Physical" "Management" "FabricAttach" |
vlanId | number The VLAN ID. This attribute is mandatory and must be unique across all physical topologies on the controller. However the actual values don't matter so long as VLAN traffic is untagged. Note that 4094 is reserved for internal use by the controller. |
tagged | boolean Indicates whether the port should include an 802.1Q tag containing the VLAN ID associated with the physical port. |
port | number The port to which the described physical interface is mapped. |
allowManagementTraffic | boolean A boolean that indicates whether management traffic (e.g. ssh, HTTPS) is allowed through this topology to the controller's management applications. This defaults to true for the NSE and false for the Wireless Controller. |
apRegistration | boolean A boolean that indicates whether AP registration is allowed through this interface to the controller. |
mtu | number The maximum transmission unit (MTU) on the interface. This attribute is read-only. |
layer3 | boolean |
ipAddress | string The IPv4 address of the controller on this interface(topology). |
cidr | number The IPv4 CIDR (Classless Inter-Domain Routing). |
dhcpMode | string (DhcpMode) Enum: "DHCPNone" "DHCPRelay" "DHCPLocal" |
localDhcp | object (DhcpLocalServerElement) This class defines a local DHCP server. |
dhcpServers | string |
cert | number |
certCa | number |
fqdn | string |
Error message
ExtremeCloud Appliance REST API server
custId | string |
id | string |
name | string The user assigned identifier for the physical topology. For release 1.0 the interfaces cannot be renamed, but that ability will be added in a future release. |
mode | string (Modes) Enum: "Routed" "BridgedAtAp" "BridgedAtAc" "ThirdPartyAP" "Physical" "Management" "FabricAttach" |
vlanId | number The VLAN ID. This attribute is mandatory and must be unique across all physical topologies on the controller. However the actual values don't matter so long as VLAN traffic is untagged. Note that 4094 is reserved for internal use by the controller. |
tagged | boolean Indicates whether the port should include an 802.1Q tag containing the VLAN ID associated with the physical port. |
port | number The port to which the described physical interface is mapped. |
allowManagementTraffic | boolean A boolean that indicates whether management traffic (e.g. ssh, HTTPS) is allowed through this topology to the controller's management applications. This defaults to true for the NSE and false for the Wireless Controller. |
apRegistration | boolean A boolean that indicates whether AP registration is allowed through this interface to the controller. |
mtu | number The maximum transmission unit (MTU) on the interface. This attribute is read-only. |
layer3 | boolean |
ipAddress | string The IPv4 address of the controller on this interface(topology). |
cidr | number The IPv4 CIDR (Classless Inter-Domain Routing). |
dhcpMode | string (DhcpMode) Enum: "DHCPNone" "DHCPRelay" "DHCPLocal" |
localDhcp | object (DhcpLocalServerElement) This class defines a local DHCP server. |
dhcpServers | string |
cert | number |
certCa | number |
fqdn | string |
Error message
ExtremeCloud Appliance REST API server
A list containing the administration interface and the two data plane interfaces.
Error message
ExtremeCloud Appliance REST API server
ExtremeCloud Appliance REST API server
enable | boolean |
apHeight | number |
defaultEnvironment | string (LocationEnvironmentModelType) Enum: "openSpace" "lightDivisions" "dryWalls" "hardDivisions" "interiorWalls" A list of the types of physical environments where the location collection feature could be deployed. |
autoCollection | string (LocationAutoCollectionType) Enum: "none" "clients" "all" A list of possible settings for location auto-collection. |
areaNotification | boolean |
onDemandUsers | object (OnDemandUsers) |
Error message
ExtremeCloud Appliance REST API server
ExtremeCloud Appliance REST API server
mobilityEnabled | boolean |
physicalIfIp | string The IP address of a physical interface. |
discoveryMethod | string (DiscoveryMethod) Enum: "SLDP" "StaticConfiguration" |
mobilityManagerIp | string The IP address of the mobility manager. |
mobilityBackupManagerIp | string The IP address of the mobility backup manager. This field is read-only. |
Error message
ExtremeCloud Appliance REST API server
ExtremeCloud Appliance REST API server
the collection of NTP settings to be applied to the controller
isNtpClient | boolean |
remoteTimeServers | Array of strings |
Error message
ExtremeCloud Appliance REST API server
the collection of NTP settings to be applied to the controller.
isNtpClient | boolean |
remoteTimeServers | Array of strings |
Error message
ExtremeCloud Appliance REST API server
ExtremeCloud Appliance REST API server
ExtremeCloud Appliance REST API server
ExtremeCloud Appliance REST API server
A method to retrieve the login management setting with the list of radius servers used for radius login.
the current setting of login management
Error message
ExtremeCloud Appliance REST API server
A method to set the login management settings including the list of radius servers used for radius login.
custId | string |
id | string |
loginAuthMode | Array of strings (LoginModes) Items Enum: "local" "radius" Login Authentication Mode Configuration (Priority Base - first in list has the highest priority) |
radiusList | Array of objects (RadiusLoginElement) Radius servers setting for login |
the current setting of login management
Error message
ExtremeCloud Appliance REST API server
Replaces the platform and application data with factory defaults, then restarts the platform. It supports with options. if license is set to true, controller will remove the license. if managementPort is set to true, controller will reset the management port to factory default. Returns true if the method was invoked successfully.
license | boolean |
mgmtport | boolean |
Error message
ExtremeCloud Appliance REST API server
Causes the operating system, platform software and applications to reinitialize. Returns true if the method was invoked successfully.
ERROR happens in this case
ExtremeCloud Appliance REST API server
Causes a controlled shutdown of the application, the operating system and the platform. Returns true if the method was invoked successfully.
Error message
ExtremeCloud Appliance REST API server
custId | string |
id | string |
canDelete | boolean |
canEdit | boolean |
name | string^[A-Z0-9.-_]{0,128}$ user can name the capture as he wish (if null or empty - it will be auto generated). |
destination | string (DestinationType) Enum: "Local" "ScpServer" "AwsS3" |
scpStorage | object (ScpServerStorageElement) |
awsStorage | object (AwsStorageElement) |
apSerialNumber | string A string containing the globally unique serial number of the AP. The actual length and format of the string depends on the type of device being registered. This attribute of the device must not be null. Valid character set : Alphanumeric, characters |
siteId | string The site UUID. |
maxPktCount | number >= 1 An integer containing the set packet capture threshold. If not manually stopped, packet capture continuesuntil the specified Maximum Packet Count threshold is reached or the max packetcapture data limit of 1 GB is reached. |
truncatedPktSize | number >= 0 how many bytes of each captured packet are put to pcap |
duration | number An integer containing the set packet capture duration in minutes . Ifnot manually stopped, packet capture continues until the specified Maximum Packet Count threshold is reached or the max duration of 1 week is reached. |
filter | object (CaptureFilterElement) Recursive This POJO represents the properties of filters used by the packet capture engine. |
captureIf | object (CaptureLocationElement) Recursive This POJO represents the options for location packet capture. |
the result of start ap capture packets
Error message
ExtremeCloud Appliance REST API server
A method to change already running access point capture (identified by id from startappacketcapture) without stopping the capture. It is only available for Centralized site/AP.
custId | string |
id | string |
canDelete | boolean |
canEdit | boolean |
name | string^[A-Z0-9.-_]{0,128}$ user can name the capture as he wish (if null or empty - it will be auto generated). |
destination | string (DestinationType) Enum: "Local" "ScpServer" "AwsS3" |
scpStorage | object (ScpServerStorageElement) |
awsStorage | object (AwsStorageElement) |
apSerialNumber | string A string containing the globally unique serial number of the AP. The actual length and format of the string depends on the type of device being registered. This attribute of the device must not be null. Valid character set : Alphanumeric, characters |
siteId | string The site UUID. |
maxPktCount | number >= 1 An integer containing the set packet capture threshold. If not manually stopped, packet capture continuesuntil the specified Maximum Packet Count threshold is reached or the max packetcapture data limit of 1 GB is reached. |
truncatedPktSize | number >= 0 how many bytes of each captured packet are put to pcap |
duration | number An integer containing the set packet capture duration in minutes . Ifnot manually stopped, packet capture continues until the specified Maximum Packet Count threshold is reached or the max duration of 1 week is reached. |
filter | object (CaptureFilterElement) Recursive This POJO represents the properties of filters used by the packet capture engine. |
captureIf | object (CaptureLocationElement) Recursive This POJO represents the options for location packet capture. |
the result of refresh ap capture packets
Error message
ExtremeCloud Appliance REST API server
ids | string <uuid> List of ids to stop.(if not ids not given stop all running captures) |
the result of stop operation
Error message
ExtremeCloud Appliance REST API server
a list of supported timeZone
Error message
ExtremeCloud Appliance REST API server
This is the current time in the JSON format. { "hour" : 15, "minute" : 36, "second" : 56, "year" : 2016, "month" : 8, "day" : 26 } The time does not include an indication of the time zone. The time is assumed to be the local time. The timezone is assumed from the other settings.
Error message
ExtremeCloud Appliance REST API server
When setting time, leading zeros are not allowed for Numbers. leading zeros or space will cause error.
hour | number |
minute | number |
second | number |
year | number |
month | number |
day | number |
Error message
ExtremeCloud Appliance REST API server
ExtremeCloud Appliance REST API server
the timeZone to set
timeZone | string |
Error message
ExtremeCloud Appliance REST API server
the timeZone to set
timeZone | string |
Error message
ExtremeCloud Appliance REST API server
ExtremeCloud Appliance REST API server
hour | number |
minute | number |
Error message
ExtremeCloud Appliance REST API server
localStorage required | string |
Error message
ExtremeCloud Appliance REST API server
localStorage required | string |
Error message
ExtremeCloud Appliance REST API server
ExtremeCloud Appliance REST API server
id required | string |
the identified topology or a 404 error.
Error message
ExtremeCloud Appliance REST API server
A method to delete a physical interface. Admin interface cann't be deleted.
id required | string |
Success message if set works, otherwise a failure code.
Error message
ExtremeCloud Appliance REST API server
Accepts the type of a log file and returns the type file to the caller or a 404 error if the file(file type) does not exist. file type are { upgrade_history, upgrade_details, import_details}
type required | string |
Error message
ExtremeCloud Appliance REST API server
an object that can describes the NTP configuration status
Error message
ExtremeCloud Appliance REST API server
A method to test the login management radius setting by providing username, password and radius server list to check upon
custId | string |
id | string |
username | string Username for testing radius login |
password | string Password for testing radius login |
radiusList | Array of objects (RadiusLoginElement) Radius servers setting for login |
the result of the user login
Error message
ExtremeCloud Appliance REST API server
A method to test the login management radius setting by providing username, password and radius server list to check upon
custId | string |
id | string |
username | string Username for testing radius login |
password | string Password for testing radius login |
radiusList | Array of objects (RadiusLoginElement) Radius servers setting for login |
the result of the user login
Error message
ExtremeCloud Appliance REST API server
name required | string A string containing the name of the topology where the certificate is applied. Validations : Not null and not empty! |
key | string A string containing the filename of the Server Private Key in PEM format. |
ca | string A string containing the filename of the Intermediate Certification Authority certificate in PEM format. |
cert | string A string containing the filename of the Server Certificate in PEM format. |
pfx | string A string containing the filename of the Server Public/Private Key file in PKCS#12 format. |
password | string A string containing the password for the Server Public/Private Key file in PKCS#12 format. |
address | string A string containing the IP Address of the topology where the certificate is installed. Validations : Not null and valid IP address! |
reset | boolean A flag to reset the custom installed certificate back to factory default. |
Error message
ExtremeCloud Appliance REST API server
fileInputStream | string <binary> |
fileMetaData | string <binary> |
body | string <binary> |
Error message
ExtremeCloud Appliance REST API server
name required | string A string containing the name of the topology where the certificate is applied. Validations : Not null and not empty! |
address | string A string containing the IP Address of the topology where the certificate is installed. Validations : Not null and valid IP address! |
ipVersion | string (IpAddressType) Enum: "four" "six" |
keySize | string (CertificateKeySizeType) Enum: "tenTwentyFour" "twentyFortyEight" A list containing X509 private key sizes that are supported. |
country | string |
state | string |
location | string |
organization | string |
unit | string |
commonName | string A string containing the name used by DNS Servers to get the IP address of the interface. |
string |
Error message
ExtremeCloud Appliance REST API server
ExtremeCloud Appliance REST API server
ExtremeCloud Appliance REST API server
Complete list of l2 ports.
lagMembers | Array of integers List of port IDs included in LAG |
Setting l2ports successfull
Error response
ExtremeCloud Appliance REST API server
L2 (physical) ports stats
Error response
ExtremeCloud Appliance REST API server
Get all AP packet capture instances
Error response
ExtremeCloud Appliance REST API server
Start a new AP packet capture.
custId | string |
id | string |
canDelete | boolean |
canEdit | boolean |
name | string^[A-Z0-9.-_]{0,128}$ user can name the capture as he wish (if null or empty - it will be auto generated). |
storage | object |
apSerialNumber | string A string containing the globally unique serial number of the AP. The actual length and format of the string depends on the type of device being registered. This attribute of the device must not be null. Valid character set : Alphanumeric, characters |
siteId | string The site UUID. |
maxPktCount | number >= 1 An integer containing the set packet capture threshold. If not manually stopped, packet capture continuesuntil the specified Maximum Packet Count threshold is reached or the max packetcapture data limit of 1 GB is reached. |
truncatedPktSize | number >= 0 how many bytes of each captured packet are put to pcap |
duration | number An integer containing the set packet capture duration in minutes . Ifnot manually stopped, packet capture continues until the specified Maximum Packet Count threshold is reached or the max duration of 1 week is reached. |
filter | object (CaptureFilterElement) Recursive This POJO represents the properties of filters used by the packet capture engine. |
captureIf | object (CaptureLocationElement) Recursive This POJO represents the options for location packet capture. |
status | string (PktCaptureStatusV3) Default: "Inactive" Enum: "Inactive" "Active" |
Newly created packet capture (id and Name).
Error response
ExtremeCloud Appliance REST API server
AP packet capture instance with attributes set to default values
Error response
ExtremeCloud Appliance REST API server
Map with AP packet capture name and corresponding ID
Error response
ExtremeCloud Appliance REST API server
id required | string A non-empty, valid AP packet capture ID |
AP packet capture instance with the given ID
Error response
ExtremeCloud Appliance REST API server
id required | string A non-empty, valid AP packet capture ID |
A valid AP packet capture with the configured parameters.
custId | string |
id | string |
canDelete | boolean |
canEdit | boolean |
name | string^[A-Z0-9.-_]{0,128}$ user can name the capture as he wish (if null or empty - it will be auto generated). |
storage | object |
apSerialNumber | string A string containing the globally unique serial number of the AP. The actual length and format of the string depends on the type of device being registered. This attribute of the device must not be null. Valid character set : Alphanumeric, characters |
siteId | string The site UUID. |
maxPktCount | number >= 1 An integer containing the set packet capture threshold. If not manually stopped, packet capture continuesuntil the specified Maximum Packet Count threshold is reached or the max packetcapture data limit of 1 GB is reached. |
truncatedPktSize | number >= 0 how many bytes of each captured packet are put to pcap |
duration | number An integer containing the set packet capture duration in minutes . Ifnot manually stopped, packet capture continues until the specified Maximum Packet Count threshold is reached or the max duration of 1 week is reached. |
filter | object (CaptureFilterElement) Recursive This POJO represents the properties of filters used by the packet capture engine. |
captureIf | object (CaptureLocationElement) Recursive This POJO represents the options for location packet capture. |
status | string (PktCaptureStatusV3) Default: "Inactive" Enum: "Inactive" "Active" |
The updated packet capture
Error response
ExtremeCloud Appliance REST API server
id required | string A non-empty, valid packet capture ID |
packet capture stoppedd successfully
Error response
ExtremeCloud Appliance REST API server
Get AP packet capture file list
Error response
ExtremeCloud Appliance REST API server
localStorage required | string |
Returns requested packet capture file
Error message
ExtremeCloud Appliance REST API server
localStorage required | string |
Error message
ExtremeCloud Appliance REST API server
Get details set mainly at manufacturing time, such as the platform type and the platform's MAC addresses.
Error message
ExtremeCloud Appliance REST API server
ExtremeCloud Appliance REST API server
a list containing static routes
Error message
ExtremeCloud Appliance REST API server
the default gateway
Error message
ExtremeCloud Appliance REST API server
ipv4Address | string |
Error message
ExtremeCloud Appliance REST API server
ipv4Address | string |
Error message
ExtremeCloud Appliance REST API server
A method to set attributes of a static route on the controller. ** Note: the portName and vlanMapToEsa fields are not used during the PUT/POST **
ipAddress | string |
cidr | number |
gateWay | string |
portName | string |
vlanMapToEsa | number |
route if set works, otherwise 422,500 error
Error message
ExtremeCloud Appliance REST API server
A method to set attributes of a static route on the controller. ** Note: the portName and vlanMapToEsa fields are not used during the PUT/POST **
ipAddress | string |
cidr | number |
gateWay | string |
portName | string |
vlanMapToEsa | number |
Updated route
Error message
ExtremeCloud Appliance REST API server
id required | string is IP address of route |
the identified route or 422 error
Error message
ExtremeCloud Appliance REST API server
id required | string IP address of static route |
Success message if set works, otherwise 422, 500 error.
Error message
ExtremeCloud Appliance REST API server
ExtremeCloud Appliance REST API server
Validates the values of all the attributes of the input SnmpBaseSettings object and if they are all valid, replaces the current SNMP agent settings with the new settings.
custId | string |
id | string |
canDelete | boolean |
canEdit | boolean |
snmpVersion | string (SNMPVersion) Enum: "DISABLED" "SNMPv2c" "SNMPv3" |
engineId | string The SNMPv3 engine ID for the controller running the SNMP agent. The engine ID must be from 5 to 32 characters long. If SNMPv3 is selected engineId is mandatory and v2Communities will be nullified. |
context | string A string containing the descriptionof the SNMP context in V3 mode. |
trapSeverity | string (TrapSeverity) Enum: "None" "Critical" "Major" "Minor" "Informational" |
v2Communities | object |
v3Users | Array of objects (SNMPUser) A list of SNMPUser configurations. If SNMPv3 is selected, v3Users is mandatory and v2Communities will be nullified. |
notifications | Array of objects (SNMPNotification) A list of SNMPNotification / Trap destination configuration. |
Error message
ExtremeCloud Appliance REST API server
Causes the controller to collect its log files and configuration into a single tar.gz file suitable for forwarding to support organizations. This method will fail if the controller already hosts the maximum number of techsupport files. In that case use deleteTechSupportFile to remove some before generating another one.
filename | string |
mode | string (TechSupportContentType) Enum: "controller" "ap" "log" "all" "lite" An enumeration containing a list of supported content types. |
apNoStats | boolean |
Error message
ExtremeCloud Appliance REST API server
ExtremeCloud Appliance REST API server
Error message
ExtremeCloud Appliance REST API server
id required | string |
Error message
ExtremeCloud Appliance REST API server
id required | string The name, including extension of the techsupport file to be deleted. |
Error message
ExtremeCloud Appliance REST API server
A method to upload an image file. Image file extension is base on the platform (upto 3 files allowed) or one backup file extension "-rescue-user.tgz". Usage: curl -i -X POST -H "Content-Type: multipart/form-data" -F "file=@NSEM-01.00.00.0055T-1.dle" https://192.168.3.62:5825/platformmanager/v1/upgrades/fileupload
fileInputStream | string <binary> |
fileMetaData | string <binary> |
body | string <binary> |
Error message
ExtremeCloud Appliance REST API server
Error message
ExtremeCloud Appliance REST API server
ExtremeCloud Appliance REST API server
A method that attempts to schedule a local upgrade for a specific date and time. The date must be a valid calendar date (e.g. not Feb 30). It is an error if the date is not at least 5 minutes into the future or more than one year into the future. ** Note: the year and second fields are not USED. **. if enabled is set to false, controller will apply cancel command to cancel the previous scheduled upgrade. The scheduling is performed in line. The scheduling is complete when the method returns.
filename required | string |
backupDestination required | string(none|local|flash) |
startTime | object (SystemTimeWithoutYear) |
enabled | boolean |
Error message
ExtremeCloud Appliance REST API server
A method that attempts to schedule a local upgrade for a specific date and time. The date must be a valid calendar date (e.g. not Feb 30). It is an error if the date is not at least 5 minutes into the future or more than one year into the future. ** Note: the year and second fields are not USED. **. if enabled is set to false, controller will apply cancel command to cancel the previous scheduled upgrade. The scheduling is performed in line. The scheduling is complete when the method returns.
filename required | string |
backupDestination required | string(none|local|flash) |
startTime | object (SystemTimeWithoutYear) |
enabled | boolean |
Error message
ExtremeCloud Appliance REST API server
Error message
ExtremeCloud Appliance REST API server
A method to delete an AP image file. Image file must not be a default image for no platform Usage: curl -i -k -H "Authorization: Bearer 1370b88682bfb843a0433bf643edf6c5" -H "Content-Type: application/json" -X DELETE -d '{"apPlatform":"AP3916-camera","filename":"AP3916IC-V1-0-8-7.dlf"}' 'https://192.168.3.62:5825/platformmanager/v1/upgrades/apimages/delete'
Error message
ExtremeCloud Appliance REST API server
A method to upload an AP image file. Image file extension is base on AP (Camera are differnt) (upto 14/10 files allowed) Usage: curl -k -H "Authorization: Bearer 1370b88682bfb843a0433bf643edf6c5" -X POST --form apPlatform="AP3916-camera" --form file=@"AP3916IC06042017.dlf" 'https://192.168.3.62:5825/platformmanager/v1/upgrades/apimages/fileupload'
apPlatform | string : AP Platform |
fileInputStream | string <binary> |
fileMetaData | string <binary> |
body | string <binary> |
Error message
ExtremeCloud Appliance REST API server
A method that lists the AP images. Usage: curl -k -H "Authorization: Bearer 1370b88682bfb843a0433bf643edf6c5" -X GET 'https://192.168.3.62:5825/platformmanager/v1/upgrades/apimages/list'
List
Error message
ExtremeCloud Appliance REST API server
A method to set the default AP image for AP type. Image file must be present image. Usage: curl -i -k -H "Authorization: Bearer 1370b88682bfb843a0433bf643edf6c5" -H "Content-Type: application/json" -X POST -d '{"apPlatform":"AP3916-camera","filename":"AP3916IC-V5-0-8-7.dlf"}' 'https://192.168.3.62:5825/platformmanager/v1/upgrades/apimages/setdefault'
apPlatform required | string |
filename required | string |
Error message
ExtremeCloud Appliance REST API server
A method to copy a system image upgrade file from a remote file server to the controller. The file is simply copied to the controller. It is not installed by executing this method. Returns true if the file transfer can be started and false otherwise. Note that the upgrade files for the controller end in a suffix that identifies the type of platform that can take the upgrade. If the file name suffix is not the one for the host platform then the upgrade will not be performed.
protocol required | string The protocol to use to transfer the upgrade file from a file server to the controller. |
serverIP | string The IPv4 address of the server that is storing or going to store the subject file. It cannot be null. |
userid | string The user ID to authenticate with the file server. It cannot be null. |
password | string The password to authenticate with the file server. It cannot be null. |
directory | string The path on the server of the directory in which the subject file resides or is to be stored. It cannot be null but could be '/' |
fileName | string The name of the file that is to be pulled from or pushed to the file server. It cannot be null, a zero length string or begin or end with blanks. |
localDestination | string (LocalDestination) Enum: "local" "flash" |
Error message
ExtremeCloud Appliance REST API server
A method to copy a system image upgrade file from a remote file server to the controller. The file is simply copied to the controller. It is not installed by executing this method. Returns true if the file transfer can be started and false otherwise. Note that the upgrade files for the controller end in a suffix that identifies the type of platform that can take the upgrade. If the file name suffix is not the one for the host platform then the upgrade will not be performed.
protocol required | string The protocol to use to transfer the upgrade file from a file server to the controller. |
serverIP | string The IPv4 address of the server that is storing or going to store the subject file. It cannot be null. |
userid | string The user ID to authenticate with the file server. It cannot be null. |
password | string The password to authenticate with the file server. It cannot be null. |
directory | string The path on the server of the directory in which the subject file resides or is to be stored. It cannot be null but could be '/' |
fileName | string The name of the file that is to be pulled from or pushed to the file server. It cannot be null, a zero length string or begin or end with blanks. |
localDestination | string (LocalDestination) Enum: "local" "flash" |
Error message
ExtremeCloud Appliance REST API server
A method to pre-check upload of image file for errors. Image file extension is base on the platform (upto 3 files allowed) or one backup file extension "-rescue-user.tgz". Usage: curl -k -H "Authorization: Bearer 5637242c9e3f9b7a7b4847a35a4afad9" -X GET https://192.168.3.62:5825/platformmanager/v1/upgrades/prefileupload/"NSEM-01.00.00.0055T-1.dle"
filename required | string |
Error message
ExtremeCloud Appliance REST API server
Attempts to delete the named system image upgrade file from the controller's local storage. The delete is performed in line. Returns true if the delete succeeded and false otherwise. i.e. curl -H "Content-Type: " -X DELETE http://10.47.21.24:8181/platformmanager/platform/v1/upgrades/upgradeimage/"NSEM-01.00.00.0011s-1.dle(flash)"
id required | string The name of an upgrade file on the controller that will be deleted. |
ERROR happens in this case
ExtremeCloud Appliance REST API server
Attempts to install the upgrade contained in the file named in the input parameter. The method returns true if the input parameters are valid and the upgrade is started and false otherwise. The method returns before the upgrade completes as an upgrade requires disabling services on the controller and at least 1 system restart. Note that the upgrade files for the controller end in a suffix that identifies the type of platform that can take the upgrade. If the file name suffix is not the one for the host platform then the upgrade will not be performed.
backupmethod required | string Whether to take a backup of the partitions that will be modified by the upgrade before installing the upgrade file. The choices are none - fastest but if a failure occurs the controller can't be restored to its pre-upgrade state local - save the system image backup on local storage. The UpgradeManager picks a name for the system image backup. Note remote copying of system image backup file during upgrade is not supported on OneController at this time. |
id required | string Name (base name and file extension) of the upgrade file that is to be installed on OneController during the upgrade. |
Error message
ExtremeCloud Appliance REST API server
Accepts the type of a log file and returns that log file to the caller or a 404 error if the file does not exist.
type required | string (GreengrassLogType) Value: "Running" Example: Running Type can be one of "Running"/... |
Error message
ExtremeCloud Appliance REST API server
fileInputStream | string <binary> |
fileMetaData | string <binary> |
body | string <binary> |
Error message
ExtremeCloud Appliance REST API server
Upload configuration for Greengrass ('config.json')
fileInputStream | string <binary> |
fileMetaData | string <binary> |
body | string <binary> |
Error message
ExtremeCloud Appliance REST API server
forceRestart | boolean Default: false |
Error message
ExtremeCloud Appliance REST API server
ExtremeCloud Appliance REST API server
ExtremeCloud Appliance REST API server