Extreme Networks Logo
API docs by Redocly

ExtremeCloud IQ Controller :: Platform Manager API (1.64.1)

Download OpenAPI specification:Download

Extreme Networks Support: support@extremenetworks.com URL: https://www.extremenetworks.com License: Apache 2.0

Introduction

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.

Authentication and Authorization

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 IQ Controller authorization server issues tokens called bearer tokens that you use for authorization when making subsequent REST API calls.

bearerAuth

Security Scheme Type: HTTP
HTTP Authorization Scheme: bearer

BackupManager

Get names of all backup files stored on the controller

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "backupfile": [
    ]
}

Get current schedule for periodic backups

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "frequency": "weekly",
  • "backupWhat": "configuration",
  • "backupDestination": "flash",
  • "transferMethod": "scp",
  • "remoteFile": {
    },
  • "dailyOptions": {
    },
  • "weeklyOptions": {
    },
  • "monthlyOptions": {
    },
  • "startTime": "12-20"
}

Update backup schedule on the controller

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 until another schedule is installed.

Authorizations:
bearerAuth
Request Body schema: application/json

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. For example, local or remote.

transferMethod
string (FileTransferMethod)
Enum: "ftp" "scp" "http"
object (RemoteFile)
object (DailyScheduleOptions)
object (WeeklyScheduleOptions)
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 ':' as the separator between hours and minutes.

Responses

Request samples

Content type
application/json
{
  • "frequency": "weekly",
  • "backupWhat": "configuration",
  • "backupDestination": "flash",
  • "transferMethod": "scp",
  • "remoteFile": {
    },
  • "dailyOptions": {
    },
  • "weeklyOptions": {
    },
  • "monthlyOptions": {
    },
  • "startTime": "12-20"
}

Response samples

Content type
application/json
{
  • "frequency": "weekly",
  • "backupWhat": "configuration",
  • "backupDestination": "flash",
  • "transferMethod": "scp",
  • "remoteFile": {
    },
  • "dailyOptions": {
    },
  • "weeklyOptions": {
    },
  • "monthlyOptions": {
    },
  • "startTime": "12-20"
}

Create a new backup schedule on the controller

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 until another schedule is installed.

Authorizations:
bearerAuth
Request Body schema: application/json

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. For example, local or remote.

transferMethod
string (FileTransferMethod)
Enum: "ftp" "scp" "http"
object (RemoteFile)
object (DailyScheduleOptions)
object (WeeklyScheduleOptions)
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 ':' as the separator between hours and minutes.

Responses

Request samples

Content type
application/json
{
  • "frequency": "weekly",
  • "backupWhat": "configuration",
  • "backupDestination": "flash",
  • "transferMethod": "scp",
  • "remoteFile": {
    },
  • "dailyOptions": {
    },
  • "weeklyOptions": {
    },
  • "monthlyOptions": {
    },
  • "startTime": "12-20"
}

Response samples

Content type
application/json
{
  • "frequency": "weekly",
  • "backupWhat": "configuration",
  • "backupDestination": "flash",
  • "transferMethod": "scp",
  • "remoteFile": {
    },
  • "dailyOptions": {
    },
  • "weeklyOptions": {
    },
  • "monthlyOptions": {
    },
  • "startTime": "12-20"
}

Create a new configuration backup file

Authorizations:
bearerAuth
Request Body schema: application/json

The identifier backup represents backup operations. For example, what to backup and the backup destination.

backupWhat
string (BackupTypes)
Enum: "all" "configuration"
backupDestination
string (LocalDestination)
Enum: "local" "flash"

Responses

Request samples

Content type
application/json
{
  • "backupWhat": "configuration",
  • "backupDestination": "local"
}

Response samples

Content type
application/json
{
  • "result": "CLI Export start: Wed Aug 22 16:46:00 2018, CLI Export end: Wed Aug 22 16:46:01 2018, SUCCESS: Backup/Export complete: EAE.22082018.164600"
}

Upload a configuration backup file

Authorizations:
bearerAuth
Request Body schema: multipart/form-data
fileInputStream
string <binary>

Input stream

fileMetaData
string <binary>

Input file metadata (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>

Responses

Response samples

Content type
application/json
{
  • "result": "CLI Export start: Wed Aug 22 16:46:00 2018, CLI Export end: Wed Aug 22 16:46:01 2018, SUCCESS: Backup/Export complete: EAE.22082018.164600"
}

Upload a configuration backup file

Authorizations:
bearerAuth
Request Body schema: multipart/form-data
destination
string (LocalDestination)
Enum: "local" "flash"
fileInputStream
string <binary>

Input stream

fileMetaData
string <binary>

Input file metadata

body
string <binary>

Responses

Response samples

Content type
application/json
{
  • "result": "CLI Export start: Wed Aug 22 16:46:00 2018, CLI Export end: Wed Aug 22 16:46:01 2018, SUCCESS: Backup/Export complete: EAE.22082018.164600"
}

Download backup file via HTTP

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 the backup file does not exist, a standard 404 type error is returned.

Authorizations:
bearerAuth
path Parameters
id
required
string

Name of the backup file to download via HTTP

Responses

Response samples

Content type
application/json
null

Delete backup file

Deletes the backup file. (The file name was passed in as a parameter.) The delete occurs inline and the method does not return until the delete operation completes. The method returns true if the deletion succeeds, and returns false for any other reason.

Authorizations:
bearerAuth
path Parameters
id
required
string

The identifier number for the backup file to be deleted

Responses

Response samples

Content type
application/json
{
  • "result": "CLI Export start: Wed Aug 22 16:46:00 2018, CLI Export end: Wed Aug 22 16:46:01 2018, SUCCESS: Backup/Export complete: EAE.22082018.164600"
}

Copy backup file to remote 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.

Authorizations:
bearerAuth
path Parameters
protocol
required
string

File transfer protocol. Only FTP and SCP are supported.

Request Body schema: application/json

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 it 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"

Responses

Request samples

Content type
application/json
{
  • "serverIP": "8.8.8.8",
  • "userid": "Admin",
  • "password": "abc123",
  • "directory": "/",
  • "fileName": "example.txt",
  • "localDestination": "local"
}

Response samples

Content type
application/json
{
  • "result": "CLI Export start: Wed Aug 22 16:46:00 2018, CLI Export end: Wed Aug 22 16:46:01 2018, SUCCESS: Backup/Export complete: EAE.22082018.164600"
}

Transfer backup file to remote 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.

Authorizations:
bearerAuth
path Parameters
protocol
required
string

File transfer protocol. Only FTP and SCP are supported.

Request Body schema: application/json

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 it 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"

Responses

Request samples

Content type
application/json
{
  • "serverIP": "8.8.8.8",
  • "userid": "Admin",
  • "password": "abc123",
  • "directory": "/",
  • "fileName": "example.txt",
  • "localDestination": "local"
}

Response samples

Content type
application/json
{
  • "result": "CLI Export start: Wed Aug 22 16:46:00 2018, CLI Export end: Wed Aug 22 16:46:01 2018, SUCCESS: Backup/Export complete: EAE.22082018.164600"
}

Copy backup file from the remote server to the controller

This method is the inverse of copyBackupTo. It copies a file (assumed to be a controller backup) from a mounted USB flash drive, from a remote FTP, or from an SCP file server. The file is not restored. It is simply copied to the controller. Returns true if the input parameters are valid and returns false otherwise. The copy can take time, so the method does not wait for the copy to complete before returning.

Authorizations:
bearerAuth
path Parameters
protocol
required
string

File transfer protocol. Only FTP and SCP are supported.

Request Body schema: application/json

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 it 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"

Responses

Request samples

Content type
application/json
{
  • "serverIP": "8.8.8.8",
  • "userid": "Admin",
  • "password": "abc123",
  • "directory": "/",
  • "fileName": "example.txt",
  • "localDestination": "local"
}

Response samples

Content type
application/json
{
  • "result": "CLI Export start: Wed Aug 22 16:46:00 2018, CLI Export end: Wed Aug 22 16:46:01 2018, SUCCESS: Backup/Export complete: EAE.22082018.164600"
}

Transfer backup file from remote server to controller

This method is the inverse of copyBackupTo. It copies a file (assumed to be a controller backup) from a mounted USB flash drive, from a remote FTP, or from an SCP file server. The file is not restored. It is simply copied to the controller. Returns true if the input parameters are valid and returns false otherwise. The copy can take time, so the method does not wait for the copy to complete before returning.

Authorizations:
bearerAuth
path Parameters
protocol
required
string

File transfer protocol. Only FTP and SCP are supported.

Request Body schema: application/json

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 it 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"

Responses

Request samples

Content type
application/json
{
  • "serverIP": "8.8.8.8",
  • "userid": "Admin",
  • "password": "abc123",
  • "directory": "/",
  • "fileName": "example.txt",
  • "localDestination": "local"
}

Response samples

Content type
application/json
{
  • "result": "CLI Export start: Wed Aug 22 16:46:00 2018, CLI Export end: Wed Aug 22 16:46:01 2018, SUCCESS: Backup/Export complete: EAE.22082018.164600"
}

Pre-check configuration of backup file

A method to pre-check the upload of a configuration backup file for errors. A configuration backup file (up to 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"

Authorizations:
bearerAuth
path Parameters
filename
required
string

Responses

Response samples

Content type
application/json
{
  • "result": "CLI Export start: Wed Aug 22 16:46:00 2018, CLI Export end: Wed Aug 22 16:46:01 2018, SUCCESS: Backup/Export complete: EAE.22082018.164600"
}

Restore contents of backup file

Restores the contents of the identified backup file into the filesystem. Returns true if the restore was started and returns false otherwise. The restore can take time, so the method does not wait for the restore to complete before returning.

Authorizations:
bearerAuth
path Parameters
id
required
string

Identifier for the backup file to be restored. The file must be on the controller at the time this command is issued.

Responses

Response samples

Content type
application/json
{
  • "result": "CLI Export start: Wed Aug 22 16:46:00 2018, CLI Export end: Wed Aug 22 16:46:01 2018, SUCCESS: Backup/Export complete: EAE.22082018.164600"
}

FlashMemoryMgr

Mount USB flash drive

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 until the mount operation completes.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "result": "CLI Export start: Wed Aug 22 16:46:00 2018, CLI Export end: Wed Aug 22 16:46:01 2018, SUCCESS: Backup/Export complete: EAE.22082018.164600"
}

Get USB flash memory information

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "status": "mounted",
  • "totalMemory": "...",
  • "usedMemory": "...",
  • "freeMemory": "...",
  • "availableFiles": [
    ]
}

Unmount USB flash drive

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 until the unmount operation completes.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "result": "CLI Export start: Wed Aug 22 16:46:00 2018, CLI Export end: Wed Aug 22 16:46:01 2018, SUCCESS: Backup/Export complete: EAE.22082018.164600"
}

Delete file from the mounted flash drive

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 occurs. The method returns 404 if the file is not in the root directory of the flash drive or if a flash drive is not mounted.

Authorizations:
bearerAuth
path Parameters
id
required
string

The name of the file to be deleted from the USB key

Responses

Response samples

Content type
application/json
{
  • "result": "CLI Export start: Wed Aug 22 16:46:00 2018, CLI Export end: Wed Aug 22 16:46:01 2018, SUCCESS: Backup/Export complete: EAE.22082018.164600"
}

LicenseMgr

Configure Pilot-only mode licensing.

Authorizations:
bearerAuth
Request Body schema: application/json

License mode configuration (Pilot or Navigator)

pilotLicense
boolean

Enabled for Pilot-only mode

Responses

Request samples

Content type
application/json
{
  • "pilotLicense": true
}

Response samples

Content type
application/json
{
  • "licenseMode": "PILOT",
  • "essentialsSupport": true,
  • "licenseType": "Permanent",
  • "regulatoryDomain": "World Wide",
  • "lockingId": "1833E-CE157",
  • "maxClients": 1000,
  • "maxAps": 50,
  • "licensedAps": 50,
  • "expireDate": 2398885071000,
  • "violationReason": "",
  • "maxSwitches": 50,
  • "licensedDevices": 50,
  • "availableDevices": 44,
  • "approvedPremiumAps": 7,
  • "approvedAps": 5,
  • "activeAps": 4,
  • "activeSwitches": 1,
  • "pkiInstalledFrom": 0,
  • "pkiVerified": 0,
  • "blockEditing": false,
  • "licenseStatus": "Valid"
}

Get controller license information

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "licenseMode": "PILOT",
  • "essentialsSupport": true,
  • "licenseType": "Permanent",
  • "regulatoryDomain": "World Wide",
  • "lockingId": "1833E-CE157",
  • "maxClients": 1000,
  • "maxAps": 50,
  • "licensedAps": 50,
  • "expireDate": 2398885071000,
  • "violationReason": "",
  • "maxSwitches": 50,
  • "licensedDevices": 50,
  • "availableDevices": 44,
  • "approvedPremiumAps": 7,
  • "approvedAps": 5,
  • "activeAps": 4,
  • "activeSwitches": 1,
  • "pkiInstalledFrom": 0,
  • "pkiVerified": 0,
  • "blockEditing": false,
  • "licenseStatus": "Valid"
}

Install activation key

Authorizations:
bearerAuth
Request Body schema: application/json

License key to be install

key
string
type
number
Array of objects (KeyElement)

Responses

Request samples

Content type
application/json
{
  • "key": "...",
  • "type": 12345,
  • "optionKeys": [
    ]
}

Response samples

Content type
application/json
{
  • "result": "CLI Export start: Wed Aug 22 16:46:00 2018, CLI Export end: Wed Aug 22 16:46:01 2018, SUCCESS: Backup/Export complete: EAE.22082018.164600"
}

Get controller license file

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
null

Upload license lock file

Authorizations:
bearerAuth
Request Body schema: application/json

License file information

file
string
data
string

Responses

Request samples

Content type
application/json
{
  • "file": "...",
  • "data": "..."
}

Response samples

Content type
application/json
{
  • "result": "CLI Export start: Wed Aug 22 16:46:00 2018, CLI Export end: Wed Aug 22 16:46:01 2018, SUCCESS: Backup/Export complete: EAE.22082018.164600"
}

Decode license capacity

Authorizations:
bearerAuth
Request Body schema: application/json

List of encoded license strings

lic
Array of strings

Responses

Request samples

Content type
application/json
{
  • "lic": [
    ]
}

Response samples

Content type
application/json
{
  • "lic": [
    ]
}

A method to retrieve the License Service connection state and the time that the LEM activation was triggered

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "state": "Connected",
  • "updateTime": "11:21",
  • "enabled": true
}

A method to schedule the time of the day when an LEM activation operation is triggered: format "hh:mm" 24 hours

Authorizations:
bearerAuth
Request Body schema: application/json
updateTime
string <time-hour:time-minute>

Time of day (hh:mm) when the appliance synchronizes licenses with the LEM Server

updatenow
boolean

Flag to trigger immediate appliance license synchronization with the LEM Server

Responses

Request samples

Content type
application/json
{
  • "updateTime": "12:20",
  • "updatenow": true
}

Response samples

Content type
application/json
{
  • "state": "Connected",
  • "updateTime": "11:21",
  • "enabled": true
}

A method to retrieve the LEM entitlements and LEM activations

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "entitlements": [
    ],
  • "activations": [
    ]
}

Request for Air-Gap capacity licenses to be revoked

Authorizations:
bearerAuth
Request Body schema: application/json

Air-Gap license file information

file
string
data
string

Responses

Request samples

Content type
application/json
{
  • "file": "...",
  • "data": "..."
}

Response samples

Content type
application/json
{
  • "entitlements": [
    ],
  • "activations": [
    ]
}

Create the Air-Gap license revocation file

Authorizations:
bearerAuth
Request Body schema: application/json

Air-Gap license activations to be revoked

Array of objects (EntitlementElement)

Customer purchased subscription licenses

Array of objects (ActivationElement)

Consumed licenses from the customer purchased license pool

Responses

Request samples

Content type
application/json
{
  • "entitlements": [
    ],
  • "activations": [
    ]
}

Response samples

Content type
application/json
null

LogConfiguration

Get controller access point logs

A method to get the controller AP logs. example : curl -X GET 'https://192.168.3.62:5825/platformmanager/v1/logging/aps'

Authorizations:
bearerAuth
query Parameters
endTime
number >= 1

End time in milliseconds

startTime
number >= 1

Start time in milliseconds

Responses

Response samples

Content type
application/json
null

Get filtered list of all access point logs

Filter the list of all access point logs based on query.

Authorizations:
bearerAuth
query Parameters
query
string

Query string to filter the stations list

startTime
number >= 1

Start time in milliseconds

endTime
number >= 1

End time in milliseconds

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Return the columns list for /v1/aps/logging/query

Return the optional columns list and context values based on the time.

Authorizations:
bearerAuth
query Parameters
startTime
number >= 1

Start time in milliseconds

endTime
number >= 1

End time in milliseconds

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get controller Events log

Authorizations:
bearerAuth
query Parameters
endTime
number >= 1

End time in milliseconds

startTime
number >= 1

Start time in milliseconds

Responses

Response samples

Content type
application/json
"string"

Get controller events log filtered

Authorizations:
bearerAuth
query Parameters
query
string

Query string to filter the Events log list

startTime
number >= 1

Start time in milliseconds

endTime
number >= 1

End time in milliseconds

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Return the columns list for /v1/logging/events/query

Return the optional columns list and context values based on the time.

Authorizations:
bearerAuth
query Parameters
startTime
number >= 1

Start time in milliseconds

endTime
number >= 1

End time in milliseconds

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get controller Events log filtered

Authorizations:
bearerAuth
query Parameters
query
string

Query string to filter the Audit logs list

startTime
number >= 1

Start time in milliseconds

endTime
number >= 1

End time in milliseconds

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Returns the columns list for /v1/logging/auditlogs/query

Returns the optional columns list and context values based on the time.

Authorizations:
bearerAuth
query Parameters
startTime
number >= 1

Start time in milliseconds

endTime
number >= 1

End time in milliseconds

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get controller stations log

Authorizations:
bearerAuth
query Parameters
endTime
number >= 1

End time in milliseconds

startTime
number >= 1

Start time in milliseconds

Responses

Response samples

Content type
application/json
null

Get filtered list of all Station logs Deprecated

Filter the list of all Station logs base on query.

Authorizations:
bearerAuth
query Parameters
query
string

Query string to filter the Stations list.

startTime
number >= 1

Start time in milliseconds

endTime
number >= 1

End time in milliseconds

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get filtered list of station events and related AP and Smart RF events

Filter the list of station events and related AP and Smart RF events based on query.

Authorizations:
bearerAuth
query Parameters
query
string

Query string to filter the Stations list

startTime
number >= 1

Start time in milliseconds

endTime
number >= 1

End time in milliseconds

Responses

Response samples

Content type
application/json
{
  • "stationEvents": [
    ],
  • "apEvents": [
    ],
  • "smartRfEvents": [
    ]
}

Returns the columns list for /v1/stations/logging/query

Returns the optional columns list.

Authorizations:
bearerAuth
query Parameters
startTime
number >= 1

Start time in milliseconds

endTime
number >= 1

End time in milliseconds

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get controller syslog settings

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "syslogConfiguration": {
    },
  • "incVarLog": true,
  • "incAuditLog": true,
  • "incStationEvent": true,
  • "syslogAuditFacility": "local6",
  • "syslogStationEventFacility": "local6",
  • "syslogMsgFacility": "local4",
  • "syslogEventFacility": "local6",
  • "custId": "...",
  • "id": "..."
}

Update syslog configuration

Authorizations:
bearerAuth
Request Body schema: application/json
custId
string
id
string
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 depend on AP model and radio 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"

Service Facility

syslogEventFacility
string (FacilityLogsLevelElement)
Enum: "local0" "local1" "local2" "local3" "local4" "local5" "local6"

Application Facility

Responses

Request samples

Content type
application/json
{
  • "syslogConfiguration": {
    },
  • "incVarLog": true,
  • "incAuditLog": true,
  • "incStationEvent": true,
  • "syslogAuditFacility": "local6",
  • "syslogStationEventFacility": "local6",
  • "syslogMsgFacility": "local4",
  • "syslogEventFacility": "local6",
  • "custId": "...",
  • "id": "..."
}

Response samples

Content type
application/json
{
  • "syslogConfiguration": {
    },
  • "incVarLog": true,
  • "incAuditLog": true,
  • "incStationEvent": true,
  • "syslogAuditFacility": "local6",
  • "syslogStationEventFacility": "local6",
  • "syslogMsgFacility": "local4",
  • "syslogEventFacility": "local6",
  • "custId": "...",
  • "id": "..."
}

Get controller syslog settings

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "syslogServers": [
    ],
  • "msgToSend": {
    },
  • "facility": {
    }
}

Update syslog configuration

Authorizations:
bearerAuth
Request Body schema: application/json
Array of objects (SyslogServer) [ 0 .. 3 ] items
object (MsgTypesElement)

Message types to be sent to the syslog servers

object (SyslogFacilityElement)

Syslog facility configuration

Responses

Request samples

Content type
application/json
{
  • "syslogServers": [
    ],
  • "msgToSend": {
    },
  • "facility": {
    }
}

Response samples

Content type
application/json
{
  • "syslogServers": [
    ],
  • "msgToSend": {
    },
  • "facility": {
    }
}

Get current log configuration

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "logLevel": "major",
  • "sendStationEventTrap": true
}

Update controller sever log level

Configure the controller 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 you set reportStationEvents to true, the controller collects and displays station session events on the controller Station Events log.

Authorizations:
bearerAuth
Request Body schema: application/json
logLevel
string (SystemlogLogging)
Enum: "critical" "major" "minor" "info"
sendStationEventTrap
boolean

Responses

Request samples

Content type
application/json
{
  • "logLevel": "major",
  • "sendStationEventTrap": true
}

Response samples

Content type
application/json
{
  • "logLevel": "major",
  • "sendStationEventTrap": true
}

Get filtered list of all SmartRf logs

Filter the list of all SmartRf logs based on query.

Authorizations:
bearerAuth
query Parameters
query
string

Query string to filter the SmartRf list

startTime
number >= 1

Start time in milliseconds

endTime
number >= 1

End time in milliseconds

Responses

Response samples

Content type
application/json
[
  • {
    }
]

NetworkTestMgr

Get available flash size

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "result": "CLI Export start: Wed Aug 22 16:46:00 2018, CLI Export end: Wed Aug 22 16:46:01 2018, SUCCESS: Backup/Export complete: EAE.22082018.164600"
}

Update ping test configuration details

The ping test is run inline and the results are streamed back as they are received. Sometimes this can result in the entire ping session being returned in one file.

Authorizations:
bearerAuth
Request Body schema: application/json

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 or FQDN 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 is 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

Responses

Request samples

Content type
application/json
{
  • "targetIPAddress": "172.16.65.1",
  • "specificInterface": true,
  • "sourceInterface": "Admin"
}

Response samples

Content type
application/json
{
  • "result": "CLI Export start: Wed Aug 22 16:46:00 2018, CLI Export end: Wed Aug 22 16:46:01 2018, SUCCESS: Backup/Export complete: EAE.22082018.164600"
}

Update ping test attributes

The ping test is run inline and the results are streamed back as they are received. Sometimes this can result in the entire ping session being returned in one file.

Authorizations:
bearerAuth
Request Body schema: application/json

An object containing the details that control this particular run of the ping test.

targetIPAddress
string

The IP address or FQDN 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 is 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

Responses

Request samples

Content type
application/json
{
  • "targetIPAddress": "172.16.65.1",
  • "specificInterface": true,
  • "sourceInterface": "Admin"
}

Response samples

Content type
application/json
{
  • "result": "CLI Export start: Wed Aug 22 16:46:00 2018, CLI Export end: Wed Aug 22 16:46:01 2018, SUCCESS: Backup/Export complete: EAE.22082018.164600"
}

Start TCP dump operation

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 until it times out or is stopped. Once the dump completes, the tcpdump capture file can be downloaded by calling getTcpDumpFile.

Authorizations:
bearerAuth
Request Body schema: application/json
sourceInterface
string
captureFileName
string
captureFileMaxMegabytes
number
destination
string (LocalDestination)
Enum: "local" "flash"

Responses

Request samples

Content type
application/json
{
  • "sourceInterface": "...",
  • "captureFileName": "...",
  • "captureFileMaxMegabytes": 12345,
  • "destination": "flash"
}

Response samples

Content type
application/json
{
  • "sourceInterface": "...",
  • "captureFileName": "...",
  • "captureFileMaxMegabytes": 12345,
  • "destination": "flash"
}

Start TCP dump operation

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 until it times out or is stopped. Once the dump completes, the tcpdump capture file can be downloaded by calling getTcpDumpFile.

Authorizations:
bearerAuth
Request Body schema: application/json
sourceInterface
string
captureFileName
string
captureFileMaxMegabytes
number
destination
string (LocalDestination)
Enum: "local" "flash"

Responses

Request samples

Content type
application/json
{
  • "sourceInterface": "...",
  • "captureFileName": "...",
  • "captureFileMaxMegabytes": 12345,
  • "destination": "flash"
}

Response samples

Content type
application/json
{
  • "sourceInterface": "...",
  • "captureFileName": "...",
  • "captureFileMaxMegabytes": 12345,
  • "destination": "flash"
}

Get list of all TCP dump files

Returns a list of all the tcpdump files stored on the controller. The filenames can be used to retrieve or delete individual files.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "captureFile": [
    ]
}

Update traceroute attributes

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 10-20 seconds, so a progress indicator may be useful in the user interface.

Authorizations:
bearerAuth
Request Body schema: application/json

An object containing the attributes that will control the requested run of traceroute.

targetIPAddress
string

The IP address or FQDN 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 is 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

Responses

Request samples

Content type
application/json
{
  • "targetIPAddress": "172.16.65.1",
  • "specificInterface": true,
  • "sourceInterface": "Admin"
}

Response samples

Content type
application/json
{
  • "result": "CLI Export start: Wed Aug 22 16:46:00 2018, CLI Export end: Wed Aug 22 16:46:01 2018, SUCCESS: Backup/Export complete: EAE.22082018.164600"
}

Configure traceroute attributes

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 10-20 seconds, so a progress indicator may be useful in the user interface.

Authorizations:
bearerAuth
Request Body schema: application/json

An object containing the attributes that will control the requested run of traceroute.

targetIPAddress
string

The IP address or FQDN 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 is 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

Responses

Request samples

Content type
application/json
{
  • "targetIPAddress": "172.16.65.1",
  • "specificInterface": true,
  • "sourceInterface": "Admin"
}

Response samples

Content type
application/json
{
  • "result": "CLI Export start: Wed Aug 22 16:46:00 2018, CLI Export end: Wed Aug 22 16:46:01 2018, SUCCESS: Backup/Export complete: EAE.22082018.164600"
}

Get current status of the TCP dump process

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "availableSpaceOnFlashInMegaBytes": 0,
  • "availableSpaceOnLocalInMegaBytes": 100,
  • "running": true
}

Stop TCP dump operation

Stops any tcpdump operation in progress on the controller. To keep things simple, this returns success whether a tcpdump is in progress or not.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "result": "CLI Export start: Wed Aug 22 16:46:00 2018, CLI Export end: Wed Aug 22 16:46:01 2018, SUCCESS: Backup/Export complete: EAE.22082018.164600"
}

Get TCP dump capture file

A method that allows the caller to download the named tcpdump capture file to a location.

Authorizations:
bearerAuth
path Parameters
id
required
string

Name of the tcpdump capture file to retrieve from the controller.

Responses

Response samples

Content type
application/json
null

Delete TCP dump file

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)"

Authorizations:
bearerAuth
path Parameters
id
required
string

The name of the tcpdump capture file to delete from controller storage.

Responses

Response samples

Content type
application/json
{
  • "result": "CLI Export start: Wed Aug 22 16:46:00 2018, CLI Export end: Wed Aug 22 16:46:01 2018, SUCCESS: Backup/Export complete: EAE.22082018.164600"
}

Platform

Get MAC address format for user authentication

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "macAddressFormat": "UPPERCASE_NO_DELIMITERS"
}

Update MAC Address format for user authentication

Authorizations:
bearerAuth
Request Body schema: application/json
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"

Responses

Request samples

Content type
application/json
{
  • "macAddressFormat": "UPPERCASE_NO_DELIMITERS"
}

Response samples

Content type
application/json
{
  • "macAddressFormat": "UPPERCASE_NO_DELIMITERS"
}

Get admin interface setting

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "name": "Admin",
  • "mode": "Management",
  • "ipAddress": "10.41.0.1",
  • "cidr": 24,
  • "mtu": 1500,
  • "cert": 0,
  • "certCa": 0,
  • "mac": "00:11:22:33:44:55",
  • "custId": "...",
  • "id": "..."
}

Set admin interface attributes

Authorizations:
bearerAuth
Request Body schema: application/json
custId
string
id
string <uuid>
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 (1500 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

dhcp
boolean

Use DHCP to configure the Admin interface.

Responses

Request samples

Content type
application/json
{
  • "name": "Admin",
  • "mode": "Management",
  • "ipAddress": "10.41.0.1",
  • "cidr": 24,
  • "mtu": 1500,
  • "cert": 0,
  • "certCa": 0,
  • "mac": "00:11:22:33:44:55",
  • "custId": "...",
  • "id": "..."
}

Response samples

Content type
application/json
{
  • "name": "Admin",
  • "mode": "Management",
  • "ipAddress": "10.41.0.1",
  • "cidr": 24,
  • "mtu": 1500,
  • "cert": 0,
  • "certCa": 0,
  • "mac": "00:11:22:33:44:55",
  • "custId": "...",
  • "id": "..."
}

Get packet capture file list Deprecated

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get packet capture status Deprecated

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "pktCaptureStatus": "Inactive"
}

Get packet capture status Deprecated

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get packet capture name mapped to ID Deprecated

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "property1": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "property2": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Get controller's availability settings

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "availabilityEnabled": true,
  • "availabilityRole": "PRIMARY",
  • "availabilityPairAddr": "172.16.63.1",
  • "balanceAps": false
}

Update controller's availability settings

Authorizations:
bearerAuth
Request Body schema: application/json
availabilityEnabled
boolean
availabilityRole
string (AvailabilityRole)
Enum: "PRIMARY" "BACKUP"
availabilityPairAddr
string

The IP address of the peer controller

balanceAps
boolean
Default: false

Responses

Request samples

Content type
application/json
{
  • "availabilityEnabled": true,
  • "availabilityRole": "PRIMARY",
  • "availabilityPairAddr": "172.16.63.1",
  • "balanceAps": false
}

Response samples

Content type
application/json
{
  • "availabilityEnabled": true,
  • "availabilityRole": "PRIMARY",
  • "availabilityPairAddr": "172.16.63.1",
  • "balanceAps": false
}

Get current access point packet capture settings Deprecated

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "apSerialNumber": "...",
  • "siteId": "...",
  • "maxPktCount": 12345,
  • "duration": 12345,
  • "filter": {
    },
  • "captureIf": {
    },
  • "custId": "...",
  • "id": "...",
  • "canDelete": true,
  • "canEdit": true
}

Get current access point packet capture settings Deprecated

Authorizations:
bearerAuth
query Parameters
ids
string <uuid>

The list of IDs. If not provided, all current capture status is returned.

Responses

Response samples

Content type
application/json
{
  • "apSerialNumber": "...",
  • "siteId": "...",
  • "maxPktCount": 12345,
  • "duration": 12345,
  • "filter": {
    },
  • "captureIf": {
    },
  • "custId": "...",
  • "id": "...",
  • "canDelete": true,
  • "canEdit": true
}

Get guest portal session timeout settings

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "hour": 1,
  • "minute": 0
}

Update guest portal session timeout settings

Authorizations:
bearerAuth
Request Body schema: application/json
hour
number
minute
number

Responses

Request samples

Content type
application/json
{
  • "hour": 1,
  • "minute": 0
}

Response samples

Content type
application/json
{
  • "hour": 1,
  • "minute": 0
}

Get controller host attributes

Returns an object containing the controller's view of its hostname, domain name, and the DNS servers it can use.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "hostName": "XCC",
  • "domainName": "extremenetworks.com",
  • "dnsServers": [
    ]
}

Update controller host attributes

Sets an object containing the controller's view of its hostname, domain name, and the DNS servers it can use.

Authorizations:
bearerAuth
Request Body schema: application/json

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

Responses

Request samples

Content type
application/json
{
  • "hostName": "XCC",
  • "domainName": "extremenetworks.com",
  • "dnsServers": [
    ]
}

Response samples

Content type
application/json
{
  • "hostName": "XCC",
  • "domainName": "extremenetworks.com",
  • "dnsServers": [
    ]
}

Configure controller host attributes

Sets an object containing the controller's view of its Host Name, Domain Name and the DNS servers it can use.

Authorizations:
bearerAuth
Request Body schema: application/json

An object that contains the domain name, hostname and list of DNS servers that are assigned to the controller.

hostName
string
domainName
string
dnsServers
Array of strings

Responses

Request samples

Content type
application/json
{
  • "hostName": "XCC",
  • "domainName": "extremenetworks.com",
  • "dnsServers": [
    ]
}

Response samples

Content type
application/json
{
  • "hostName": "XCC",
  • "domainName": "extremenetworks.com",
  • "dnsServers": [
    ]
}

Update controller topology attributes

Authorizations:
bearerAuth
Request Body schema: application/json
custId
string
Deprecated
id
string <uuid>
name
string

The user assigned identifier for the physical topology. For release 1.0, the interfaces cannot be renamed. Renaming interfaces 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 as long as the 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 ExtremeCloud IQ Controller 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
Deprecated
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"
object (DhcpLocalServerElement)

This class defines a local DHCP server.

dhcpServers
string
cert
number
certCa
number
fqdn
string
Array of objects (L3ExceptionFilterElement)

Access Control List (ACL) for the management traffic. Available only for topologies with a L3 presence ("l3Presence" field is true).

Responses

Request samples

Content type
application/json
{
  • "name": "...",
  • "mode": "BridgedAtAp",
  • "vlanId": 1027,
  • "tagged": true,
  • "port": 0,
  • "allowManagementTraffic": true,
  • "apRegistration": true,
  • "mtu": 1500,
  • "layer3": true,
  • "ipAddress": "172.16.63.1",
  • "cidr": 24,
  • "dhcpMode": "DHCPRelay",
  • "localDhcp": {
    },
  • "dhcpServers": "...",
  • "cert": 12345,
  • "certCa": 12345,
  • "fqdn": "...",
  • "custId": "...",
  • "id": "..."
}

Response samples

Content type
application/json
{
  • "name": "...",
  • "mode": "BridgedAtAp",
  • "vlanId": 1027,
  • "tagged": true,
  • "port": 0,
  • "allowManagementTraffic": true,
  • "apRegistration": true,
  • "mtu": 1500,
  • "layer3": true,
  • "ipAddress": "172.16.63.1",
  • "cidr": 24,
  • "dhcpMode": "DHCPRelay",
  • "localDhcp": {
    },
  • "dhcpServers": "...",
  • "cert": 12345,
  • "certCa": 12345,
  • "fqdn": "...",
  • "custId": "...",
  • "id": "..."
}

Configure controller topology attributes

Authorizations:
bearerAuth
Request Body schema: application/json
custId
string
Deprecated
id
string <uuid>
name
string

The user assigned identifier for the physical topology. For release 1.0, the interfaces cannot be renamed. Renaming interfaces 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 as long as the 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 ExtremeCloud IQ Controller 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
Deprecated
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"
object (DhcpLocalServerElement)

This class defines a local DHCP server.

dhcpServers
string
cert
number
certCa
number
fqdn
string
Array of objects (L3ExceptionFilterElement)

Access Control List (ACL) for the management traffic. Available only for topologies with a L3 presence ("l3Presence" field is true).

Responses

Request samples

Content type
application/json
{
  • "name": "...",
  • "mode": "BridgedAtAp",
  • "vlanId": 1027,
  • "tagged": true,
  • "port": 0,
  • "allowManagementTraffic": true,
  • "apRegistration": true,
  • "mtu": 1500,
  • "layer3": true,
  • "ipAddress": "172.16.63.1",
  • "cidr": 24,
  • "dhcpMode": "DHCPRelay",
  • "localDhcp": {
    },
  • "dhcpServers": "...",
  • "cert": 12345,
  • "certCa": 12345,
  • "fqdn": "...",
  • "custId": "...",
  • "id": "..."
}

Response samples

Content type
application/json
{
  • "name": "...",
  • "mode": "BridgedAtAp",
  • "vlanId": 1027,
  • "tagged": true,
  • "port": 0,
  • "allowManagementTraffic": true,
  • "apRegistration": true,
  • "mtu": 1500,
  • "layer3": true,
  • "ipAddress": "172.16.63.1",
  • "cidr": 24,
  • "dhcpMode": "DHCPRelay",
  • "localDhcp": {
    },
  • "dhcpServers": "...",
  • "cert": 12345,
  • "certCa": 12345,
  • "fqdn": "...",
  • "custId": "...",
  • "id": "..."
}

Get list of physical interfaces on the controller

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get available widgets for the L2 Ports report (/v1/l2ports/{id}/report)

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get L2 Ports stats plus widgets data (use /v1/l2ports/report/widgets to get the available widgets)

Authorizations:
bearerAuth
path Parameters
id
required
string

l2ports ID

Request Body schema: application/json

A valid report request

duration
string (Duration)
Enum: "D_3h" "D_3d" "D_14d"

Report duration

Array of objects (WidgetInfoElement)

Responses

Request samples

Content type
application/json
{
  • "duration": "D_14d",
  • "widgets": [
    ]
}

Response samples

Content type
application/json
{
  • "custId": "string",
  • "id": "string",
  • "canDelete": true,
  • "canEdit": true,
  • "timeStamp": 0,
  • "l2portInterfaceUtilization": [
    ],
  • "l2portInterfaceThroughput": [
    ],
  • "l2portInterfacePacketThroughput": [
    ]
}

Get current location settings

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "enable": true,
  • "apHeight": 300,
  • "defaultEnvironment": "interiorWalls",
  • "autoCollection": "none",
  • "areaNotification": true,
  • "onDemandUsers": {
    }
}

Set current location settings

Authorizations:
bearerAuth
Request Body schema: application/json
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
object (OnDemandUsers)

Responses

Request samples

Content type
application/json
{
  • "enable": true,
  • "apHeight": 300,
  • "defaultEnvironment": "interiorWalls",
  • "autoCollection": "none",
  • "areaNotification": true,
  • "onDemandUsers": {
    }
}

Response samples

Content type
application/json
{
  • "enable": true,
  • "apHeight": 300,
  • "defaultEnvironment": "interiorWalls",
  • "autoCollection": "none",
  • "areaNotification": true,
  • "onDemandUsers": {
    }
}

Get mobility setting

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "mobilityEnabled": true,
  • "physicalIfIp": "10.47.2.1",
  • "discoveryMethod": "SLPD",
  • "mobilityManagerIp": "172.16.63.1",
  • "mobilityBackupManagerIp": "192.168.3.1",
  • "securityMode": "Approved",
  • "agents": [
    ],
  • "heartbeat": 5
}

Update mobility setting

Authorizations:
bearerAuth
Request Body schema: application/json
mobilityEnabled
boolean
role
string (MobilityRole)
Enum: "Manager" "Agent"
physicalIfIp
string

The IP address of a physical interface

discoveryMethod
string (DiscoveryMethod)
Enum: "SLPD" "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.

securityMode
string (MobilitySecurityMode)
Enum: "None" "Approved"
Array of objects (MobilityAgentElement)

Manager agents list

heartbeat
integer [ 1 .. 65535 ]
Default: 5

Manager update interval in seconds

Responses

Request samples

Content type
application/json
{
  • "mobilityEnabled": true,
  • "physicalIfIp": "10.47.2.1",
  • "discoveryMethod": "SLPD",
  • "mobilityManagerIp": "172.16.63.1",
  • "mobilityBackupManagerIp": "192.168.3.1",
  • "securityMode": "Approved",
  • "agents": [
    ],
  • "heartbeat": 5
}

Response samples

Content type
application/json
{
  • "mobilityEnabled": true,
  • "physicalIfIp": "10.47.2.1",
  • "discoveryMethod": "SLPD",
  • "mobilityManagerIp": "172.16.63.1",
  • "mobilityBackupManagerIp": "192.168.3.1",
  • "securityMode": "Approved",
  • "agents": [
    ],
  • "heartbeat": 5
}

Get NTP settings

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "isNtpClient": true,
  • "remoteTimeServers": [
    ]
}

Update NTP settings

Authorizations:
bearerAuth
Request Body schema: application/json

The collection of NTP settings to be applied to the controller

isNtpClient
boolean
remoteTimeServers
Array of strings

Responses

Request samples

Content type
application/json
{
  • "isNtpClient": true,
  • "remoteTimeServers": [
    ]
}

Response samples

Content type
application/json
{
  • "isNtpClient": true,
  • "remoteTimeServers": [
    ]
}

Configure NTP settings

Authorizations:
bearerAuth
Request Body schema: application/json

The collection of NTP settings to be applied to the controller

isNtpClient
boolean
remoteTimeServers
Array of strings

Responses

Request samples

Content type
application/json
{
  • "isNtpClient": true,
  • "remoteTimeServers": [
    ]
}

Response samples

Content type
application/json
{
  • "isNtpClient": true,
  • "remoteTimeServers": [
    ]
}

Get product system attributes

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "upgradeImageSuffix": [
    ],
  • "productVersion": "04.26.01.0166",
  • "supportFlash": true,
  • "supportJumboFrame": true,
  • "productName": "VE6120 Small",
  • "lagPorts": 12345,
  • "numberOfPhysicalPorts": 2,
  • "portNameAndPort": [
    ],
  • "adminIfConfig": true,
  • "maxLocalUpgradeImages": 3,
  • "maxLocalBackupImages": 1
}

Get product name

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "productName": "VE6120 Small"
}

Get product version

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "productVersion": "04.26.01.0166"
}

Get login management settings

A method to retrieve the login management setting with the list of RADIUS servers used for RADIUS login.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "custId": "string",
  • "id": "string",
  • "loginAuthMode": [
    ],
  • "radiusList": [
    ]
}

Set login management settings

A method to set the login management settings including the list of RADIUS servers used for RADIUS login.

Authorizations:
bearerAuth
Request Body schema: application/json
custId
string
id
string
loginAuthMode
Array of strings (LoginModes)
Items Enum: "local" "radius"

Login Authentication Mode Configuration (Priority Base - the first in the list has the highest priority.)

Array of objects (RadiusLoginElement)

RADIUS servers setting for login

Responses

Request samples

Content type
application/json
{
  • "custId": "string",
  • "id": "string",
  • "loginAuthMode": [
    ],
  • "radiusList": [
    ]
}

Response samples

Content type
application/json
{
  • "custId": "string",
  • "id": "string",
  • "loginAuthMode": [
    ],
  • "radiusList": [
    ]
}

Restore factory defaults

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 the factory default. Returns true if the method was invoked successfully.

Authorizations:
bearerAuth
Request Body schema: application/json
license
boolean
mgmtport
boolean

Responses

Request samples

Content type
application/json
{
  • "license": true,
  • "mgmtport": true
}

Response samples

Content type
application/json
{
  • "result": "CLI Export start: Wed Aug 22 16:46:00 2018, CLI Export end: Wed Aug 22 16:46:01 2018, SUCCESS: Backup/Export complete: EAE.22082018.164600"
}

Restart operating system, platform software, and applications

Causes the operating system, platform software, and applications to re-initialize. Returns true if the method was invoked successfully.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "result": "CLI Export start: Wed Aug 22 16:46:00 2018, CLI Export end: Wed Aug 22 16:46:01 2018, SUCCESS: Backup/Export complete: EAE.22082018.164600"
}

Intiate controlled shutdown

Causes a controlled shut down of the application, the operating system, and the platform. Returns true if the method was invoked successfully.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "result": "CLI Export start: Wed Aug 22 16:46:00 2018, CLI Export end: Wed Aug 22 16:46:01 2018, SUCCESS: Backup/Export complete: EAE.22082018.164600"
}

Start access point capture packets Deprecated

Authorizations:
bearerAuth
Request Body schema: application/json
custId
string
id
string
canDelete
boolean
canEdit
boolean
name
string^[A-Z0-9.-_]{0,128}$

User can name the capture. If null or empty, it will be auto generated.

destination
string (DestinationType)
Enum: "Local" "ScpServer" "AwsS3"
object (ScpServerStorageElement)
object (AwsStorageElement)
apSerialNumber
string (SerialNumber) ^[\p{Print}&&[^ ;:&\p{Cntrl}'"]]{1,16}$

The globally unique serial number of the device being registered. The serial number is represented as a string.

siteId
string

The site UUID

maxPktCount
number >= 1

An integer containing the set packet capture threshold. If not manually stopped, packet capture continues until the specified Maximum Packet Count threshold is reached or the max packetcapture data limit of 1 GB is reached.

truncatedPktSize
number >= 0

Determines the number of bytes for each captured packet are put to pcap.

duration
number

An integer containing the set packet capture duration in minutes. If not manually stopped, packet capture continues until the specified Maximum Packet Count threshold is reached or the max duration of 1 week is reached.

object (CaptureFilterElement)

This POJO represents the properties of filters used by the packet capture engine.

object (CaptureLocationElement)

This POJO represents the options for location packet capture.

Responses

Request samples

Content type
application/json
{
  • "apSerialNumber": "...",
  • "siteId": "...",
  • "maxPktCount": 12345,
  • "duration": 12345,
  • "filter": {
    },
  • "captureIf": {
    },
  • "custId": "...",
  • "id": "...",
  • "canDelete": true,
  • "canEdit": true
}

Response samples

Content type
application/json
{
  • "apSerialNumber": "...",
  • "siteId": "...",
  • "maxPktCount": 12345,
  • "duration": 12345,
  • "filter": {
    },
  • "captureIf": {
    },
  • "custId": "...",
  • "id": "...",
  • "canDelete": true,
  • "canEdit": true
}

Update currently running AP capture Deprecated

A method to change an already running access point capture, which is identified by the ID from the startappacketcapture without stopping the capture. Supported on a Centralized site AP only.

Authorizations:
bearerAuth
Request Body schema: application/json
custId
string
id
string
canDelete
boolean
canEdit
boolean
name
string^[A-Z0-9.-_]{0,128}$

User can name the capture. If null or empty, it will be auto generated.

destination
string (DestinationType)
Enum: "Local" "ScpServer" "AwsS3"
object (ScpServerStorageElement)
object (AwsStorageElement)
apSerialNumber
string (SerialNumber) ^[\p{Print}&&[^ ;:&\p{Cntrl}'"]]{1,16}$

The globally unique serial number of the device being registered. The serial number is represented as a string.

siteId
string

The site UUID

maxPktCount
number >= 1

An integer containing the set packet capture threshold. If not manually stopped, packet capture continues until the specified Maximum Packet Count threshold is reached or the max packetcapture data limit of 1 GB is reached.

truncatedPktSize
number >= 0

Determines the number of bytes for each captured packet are put to pcap.

duration
number

An integer containing the set packet capture duration in minutes. If not manually stopped, packet capture continues until the specified Maximum Packet Count threshold is reached or the max duration of 1 week is reached.

object (CaptureFilterElement)

This POJO represents the properties of filters used by the packet capture engine.

object (CaptureLocationElement)

This POJO represents the options for location packet capture.

Responses

Request samples

Content type
application/json
{
  • "apSerialNumber": "...",
  • "siteId": "...",
  • "maxPktCount": 12345,
  • "duration": 12345,
  • "filter": {
    },
  • "captureIf": {
    },
  • "custId": "...",
  • "id": "...",
  • "canDelete": true,
  • "canEdit": true
}

Response samples

Content type
application/json
{
  • "apSerialNumber": "...",
  • "siteId": "...",
  • "maxPktCount": 12345,
  • "duration": 12345,
  • "filter": {
    },
  • "captureIf": {
    },
  • "custId": "...",
  • "id": "...",
  • "canDelete": true,
  • "canEdit": true
}

Stop access point capture packets Deprecated

Authorizations:
bearerAuth
query Parameters
ids
string <uuid>

List of IDs to stop. When ID list is not provided, stop all running captures.

Responses

Response samples

Content type
application/json
{
  • "result": "CLI Export start: Wed Aug 22 16:46:00 2018, CLI Export end: Wed Aug 22 16:46:01 2018, SUCCESS: Backup/Export complete: EAE.22082018.164600"
}

Get a list of supported time zones

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get system time

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 time zone is indicated from other settings.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "hour": 18,
  • "minute": 30,
  • "second": 30,
  • "year": 2016,
  • "month": 8,
  • "day": 24
}

Update system time

When setting time, leading zeros are not allowed in numbers. Leading zeros or spaces will cause an error.

Authorizations:
bearerAuth
Request Body schema: application/json
hour
number
minute
number
second
number
year
number
month
number
day
number

Responses

Request samples

Content type
application/json
{
  • "hour": 18,
  • "minute": 30,
  • "second": 30,
  • "year": 2016,
  • "month": 8,
  • "day": 24
}

Response samples

Content type
application/json
{
  • "hour": 18,
  • "minute": 30,
  • "second": 30,
  • "year": 2016,
  • "month": 8,
  • "day": 24
}

Get time zone

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "timeZone": "America/Toronto"
}

Update time zone

Authorizations:
bearerAuth
Request Body schema: application/json

The time zone to set

timeZone
string

Responses

Request samples

Content type
application/json
{
  • "timeZone": "America/Toronto"
}

Response samples

Content type
application/json
{
  • "timeZone": "America/Toronto"
}

Create time zone

Authorizations:
bearerAuth
Request Body schema: application/json

The time zone to set

timeZone
string

Responses

Request samples

Content type
application/json
{
  • "timeZone": "America/Toronto"
}

Response samples

Content type
application/json
{
  • "timeZone": "America/Toronto"
}

Get web session timeout setting

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "hour": 1,
  • "minute": 0
}

Update web session timeout setting

Authorizations:
bearerAuth
Request Body schema: application/json
hour
number
minute
number

Responses

Request samples

Content type
application/json
{
  • "hour": 1,
  • "minute": 0
}

Response samples

Content type
application/json
{
  • "hour": 1,
  • "minute": 0
}

Get packet capture file Deprecated

Authorizations:
bearerAuth
path Parameters
localStorage
required
string

Responses

Response samples

Content type
application/json
null

Delete packet capture file Deprecated

Authorizations:
bearerAuth
path Parameters
localStorage
required
string

Responses

Response samples

Content type
application/json
null

Get current Certificates list

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "certdata": [
    ]
}

Get a named topology on the controller

Authorizations:
bearerAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "name": "...",
  • "mode": "BridgedAtAp",
  • "vlanId": 1027,
  • "tagged": true,
  • "port": 0,
  • "allowManagementTraffic": true,
  • "apRegistration": true,
  • "mtu": 1500,
  • "layer3": true,
  • "ipAddress": "172.16.63.1",
  • "cidr": 24,
  • "dhcpMode": "DHCPRelay",
  • "localDhcp": {
    },
  • "dhcpServers": "...",
  • "cert": 12345,
  • "certCa": 12345,
  • "fqdn": "...",
  • "custId": "...",
  • "id": "..."
}

Delete physical interface

A method to delete a physical interface. The Admin interface cannot be deleted.

Authorizations:
bearerAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "result": "CLI Export start: Wed Aug 22 16:46:00 2018, CLI Export end: Wed Aug 22 16:46:01 2018, SUCCESS: Backup/Export complete: EAE.22082018.164600"
}

Get log file

Accepts the type log file and returns the type file to the caller or returns a 404 error when the file (file type) does not exist. File type values include: { upgrade_history, upgrade_details, import_details}

Authorizations:
bearerAuth
path Parameters
type
required
string

Responses

Response samples

Content type
application/json
{
  • "result": "CLI Export start: Wed Aug 22 16:46:00 2018, CLI Export end: Wed Aug 22 16:46:01 2018, SUCCESS: Backup/Export complete: EAE.22082018.164600"
}

Get NTP Status

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "ntpReachable": true
}

Update login management settings

A method to test the login management RADIUS setting by providing the username, password, and RADIUS server list.

Authorizations:
bearerAuth
Request Body schema: application/json
custId
string
id
string
username
string

Username for testing RADIUS login

password
string

Password for testing RADIUS login

Array of objects (RadiusLoginElement)

RADIUS servers setting for login

Responses

Request samples

Content type
application/json
{
  • "custId": "string",
  • "id": "string",
  • "username": "string",
  • "password": "string",
  • "radiusList": [
    ]
}

Response samples

Content type
application/json
{
  • "result": "CLI Export start: Wed Aug 22 16:46:00 2018, CLI Export end: Wed Aug 22 16:46:01 2018, SUCCESS: Backup/Export complete: EAE.22082018.164600"
}

Check login management settings

A method to test the login management RADIUS setting by providing the username, password, and RADIUS server list.

Authorizations:
bearerAuth
Request Body schema: application/json
custId
string
id
string
username
string

Username for testing RADIUS login

password
string

Password for testing RADIUS login

Array of objects (RadiusLoginElement)

RADIUS servers setting for login

Responses

Request samples

Content type
application/json
{
  • "custId": "string",
  • "id": "string",
  • "username": "string",
  • "password": "string",
  • "radiusList": [
    ]
}

Response samples

Content type
application/json
{
  • "result": "CLI Export start: Wed Aug 22 16:46:00 2018, CLI Export end: Wed Aug 22 16:46:01 2018, SUCCESS: Backup/Export complete: EAE.22082018.164600"
}

Apply certificate to platform

Authorizations:
bearerAuth
Request Body schema: application/json
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.

Responses

Request samples

Content type
application/json
{
  • "key": "server.key",
  • "ca": "intermca.crt",
  • "cert": "server.crt",
  • "pfx": "custompair.pfx",
  • "password": "...",
  • "name": "Admin",
  • "address": "172.16.65.1",
  • "reset": true
}

Response samples

Content type
application/json
{
  • "result": "CLI Export start: Wed Aug 22 16:46:00 2018, CLI Export end: Wed Aug 22 16:46:01 2018, SUCCESS: Backup/Export complete: EAE.22082018.164600"
}

Upload certificate to platform

Authorizations:
bearerAuth
Request Body schema: multipart/form-data
fileInputStream
string <binary>
fileMetaData
string <binary>
body
string <binary>

Responses

Response samples

Content type
application/json
{
  • "result": "CLI Export start: Wed Aug 22 16:46:00 2018, CLI Export end: Wed Aug 22 16:46:01 2018, SUCCESS: Backup/Export complete: EAE.22082018.164600"
}

Generate CSR

Authorizations:
bearerAuth
Request Body schema: application/json
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.

email
string

Responses

Request samples

Content type
application/json
{
  • "name": "Admin",
  • "address": "172.16.65.1",
  • "ipVersion": "four",
  • "keySize": "twentyFortyEight",
  • "country": "US",
  • "state": "CA",
  • "location": "San Jose",
  • "organization": "Extreme Networks",
  • "unit": "Wireless",
  • "commonName": "*.switches.extremenetworks.com",
  • "email": "..."
}

Response samples

Content type
application/json
{
  • "name": "Admin",
  • "address": "172.16.65.1",
  • "ipVersion": "four",
  • "keySize": "twentyFortyEight",
  • "country": "US",
  • "state": "CA",
  • "location": "San Jose",
  • "organization": "Extreme Networks",
  • "unit": "Wireless",
  • "commonName": "*.switches.extremenetworks.com",
  • "email": "..."
}

Get CSR

Authorizations:
bearerAuth
path Parameters
address
required
string

Responses

Response samples

Content type
application/json
null

Get L2 ports

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Set L2 ports

Authorizations:
bearerAuth
Request Body schema: application/json

Complete list of l2 ports

Array
lagMembers
Array of integers

List of port IDs included in LAG

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
Example
{
  • "result": "CLI Export start: Wed Aug 22 16:46:00 2018, CLI Export end: Wed Aug 22 16:46:01 2018, SUCCESS: Backup/Export complete: EAE.22082018.164600"
}

Get L2 (physical) ports stats

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "type": 0,
  • "mtu": 0,
  • "speed": 0,
  • "address": "string",
  • "adminStatus": true,
  • "opStatus": true,
  • "inOctets": 0,
  • "inUcPkts": 0,
  • "inMcPkts": 0,
  • "inBcPkts": 0,
  • "inDiscards": 0,
  • "inErrors": 0,
  • "inUkProtos": 0,
  • "outOctets": 0,
  • "outUcPkts": 0,
  • "outMcPkts": 0,
  • "outBcPkts": 0,
  • "outDiscards": 0,
  • "outErrors": 0
}

PacketCaptureManager

Get all AP packet capture instances. Deprecated

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new packet capture instance. Deprecated

Authorizations:
bearerAuth
Request Body schema: application/json

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. If the name is null or empty, it will be auto generated.

destination
string (DestinationType)
Enum: "Local" "ScpServer" "AwsS3"
object
apSerialNumber
string (SerialNumber) ^[\p{Print}&&[^ ;:&\p{Cntrl}'"]]{1,16}$

The globally unique serial number of the device being registered. The serial number is represented as a string.

siteId
string

The site UUID

maxPktCount
number >= 1

An integer containing the set packet capture threshold. If not manually stopped, packet capture continues until the specified Maximum Packet Count threshold is reached or the max packetcapture data limit of 1 GB is reached.

truncatedPktSize
number >= 0

The number of bytes in each captured packet that are put to pcap

duration
number

An integer containing the set packet capture duration in minutes. If not manually stopped, packet capture continues until the specified Maximum Packet Count threshold is reached or the max duration of 1 week is reached.

object (CaptureFilterElement)

This POJO represents the properties of filters used by the packet capture engine.

object (CaptureLocationElement)

This POJO represents the options for location packet capture.

Responses

Request samples

Content type
application/json
{
  • "apSerialNumber": "...",
  • "siteId": "...",
  • "maxPktCount": 12345,
  • "duration": 12345,
  • "filter": {
    },
  • "captureIf": {
    },
  • "custId": "...",
  • "id": "...",
  • "canDelete": true,
  • "canEdit": true
}

Response samples

Content type
application/json
{
  • "apSerialNumber": "...",
  • "siteId": "...",
  • "maxPktCount": 12345,
  • "duration": 12345,
  • "filter": {
    },
  • "captureIf": {
    },
  • "custId": "...",
  • "id": "...",
  • "canDelete": true,
  • "canEdit": true
}

Get the default AP packet capture configuration. Deprecated

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "apSerialNumber": "...",
  • "siteId": "...",
  • "maxPktCount": 12345,
  • "duration": 12345,
  • "filter": {
    },
  • "captureIf": {
    },
  • "custId": "...",
  • "id": "...",
  • "canDelete": true,
  • "canEdit": true
}

Get AP packet capture name to ID map. Deprecated

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "property1": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "property2": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Get an AP packet capture by ID. Deprecated

Authorizations:
bearerAuth
path Parameters
id
required
string

A non-empty, valid AP packet capture ID

Responses

Response samples

Content type
application/json
{
  • "apSerialNumber": "...",
  • "siteId": "...",
  • "maxPktCount": 12345,
  • "duration": 12345,
  • "filter": {
    },
  • "captureIf": {
    },
  • "custId": "...",
  • "id": "...",
  • "canDelete": true,
  • "canEdit": true
}

Refresh an AP packet capture. Deprecated

Authorizations:
bearerAuth
path Parameters
id
required
string

A non-empty, valid AP packet capture ID

Request Body schema: application/json

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. If the name is null or empty, it will be auto generated.

destination
string (DestinationType)
Enum: "Local" "ScpServer" "AwsS3"
object
apSerialNumber
string (SerialNumber) ^[\p{Print}&&[^ ;:&\p{Cntrl}'"]]{1,16}$

The globally unique serial number of the device being registered. The serial number is represented as a string.

siteId
string

The site UUID

maxPktCount
number >= 1

An integer containing the set packet capture threshold. If not manually stopped, packet capture continues until the specified Maximum Packet Count threshold is reached or the max packetcapture data limit of 1 GB is reached.

truncatedPktSize
number >= 0

The number of bytes in each captured packet that are put to pcap

duration
number

An integer containing the set packet capture duration in minutes. If not manually stopped, packet capture continues until the specified Maximum Packet Count threshold is reached or the max duration of 1 week is reached.

object (CaptureFilterElement)

This POJO represents the properties of filters used by the packet capture engine.

object (CaptureLocationElement)

This POJO represents the options for location packet capture.

Responses

Request samples

Content type
application/json
{
  • "apSerialNumber": "...",
  • "siteId": "...",
  • "maxPktCount": 12345,
  • "duration": 12345,
  • "filter": {
    },
  • "captureIf": {
    },
  • "custId": "...",
  • "id": "...",
  • "canDelete": true,
  • "canEdit": true
}

Response samples

Content type
application/json
{
  • "apSerialNumber": "...",
  • "siteId": "...",
  • "maxPktCount": 12345,
  • "duration": 12345,
  • "filter": {
    },
  • "captureIf": {
    },
  • "custId": "...",
  • "id": "...",
  • "canDelete": true,
  • "canEdit": true
}

Stop an AP packet capture. Deprecated

Authorizations:
bearerAuth
path Parameters
id
required
string

A non-empty, valid packet capture ID

Responses

Response samples

Content type
application/json
Example
{
  • "result": "CLI Export start: Wed Aug 22 16:46:00 2018, CLI Export end: Wed Aug 22 16:46:01 2018, SUCCESS: Backup/Export complete: EAE.22082018.164600"
}

Get packet capture file list. Deprecated

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get AP packet capture file. Deprecated

Authorizations:
bearerAuth
path Parameters
localStorage
required
string

Responses

Response samples

Content type
application/json
null

Delete AP packet capture file. Deprecated

Authorizations:
bearerAuth
path Parameters
localStorage
required
string

Responses

Response samples

Content type
application/json
null

Get all AP packet captures instances

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new packet capture instance

Authorizations:
bearerAuth
Request Body schema: application/json

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. If the name is null or empty, it will be auto generated.

destination
string (DestinationType)
Enum: "Local" "ScpServer" "AwsS3"
object
apSerialNumber
string (SerialNumber) ^[\p{Print}&&[^ ;:&\p{Cntrl}'"]]{1,16}$

The globally unique serial number of the device being registered. The serial number is represented as a string.

siteId
string

The site UUID

maxPktCount
number >= 1

An integer containing the set packet capture threshold. If not manually stopped, packet capture continues until the specified Maximum Packet Count threshold is reached or the max packetcapture data limit of 1 GB is reached.

truncatedPktSize
number >= 0

The number of bytes in each captured packet that are put to pcap

duration
number

An integer containing the set packet capture duration in minutes. If not manually stopped, packet capture continues until the specified Maximum Packet Count threshold is reached or the max duration of 1 week is reached.

object (CaptureFilterElement)

This POJO represents the properties of filters used by the packet capture engine.

object (CaptureLocationElement)

This POJO represents the options for location packet capture.

Responses

Request samples

Content type
application/json
{
  • "apSerialNumber": "...",
  • "siteId": "...",
  • "maxPktCount": 12345,
  • "duration": 12345,
  • "filter": {
    },
  • "captureIf": {
    },
  • "custId": "...",
  • "id": "...",
  • "canDelete": true,
  • "canEdit": true
}

Response samples

Content type
application/json
{
  • "apSerialNumber": "...",
  • "siteId": "...",
  • "maxPktCount": 12345,
  • "duration": 12345,
  • "filter": {
    },
  • "captureIf": {
    },
  • "custId": "...",
  • "id": "...",
  • "canDelete": true,
  • "canEdit": true
}

Get the default AP packet capture configuration

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "apSerialNumber": "...",
  • "siteId": "...",
  • "maxPktCount": 12345,
  • "duration": 12345,
  • "filter": {
    },
  • "captureIf": {
    },
  • "custId": "...",
  • "id": "...",
  • "canDelete": true,
  • "canEdit": true
}

Get AP packet capture name to ID map

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "property1": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "property2": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Get an AP packet capture by ID

Authorizations:
bearerAuth
path Parameters
id
required
string

A non-empty, valid AP packet capture ID

Responses

Response samples

Content type
application/json
{
  • "apSerialNumber": "...",
  • "siteId": "...",
  • "maxPktCount": 12345,
  • "duration": 12345,
  • "filter": {
    },
  • "captureIf": {
    },
  • "custId": "...",
  • "id": "...",
  • "canDelete": true,
  • "canEdit": true
}

Refresh an AP packet capture

Authorizations:
bearerAuth
path Parameters
id
required
string

A non-empty, valid AP packet capture ID

Request Body schema: application/json

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. If the name is null or empty, it will be auto generated.

destination
string (DestinationType)
Enum: "Local" "ScpServer" "AwsS3"
object
apSerialNumber
string (SerialNumber) ^[\p{Print}&&[^ ;:&\p{Cntrl}'"]]{1,16}$

The globally unique serial number of the device being registered. The serial number is represented as a string.

siteId
string

The site UUID

maxPktCount
number >= 1

An integer containing the set packet capture threshold. If not manually stopped, packet capture continues until the specified Maximum Packet Count threshold is reached or the max packetcapture data limit of 1 GB is reached.

truncatedPktSize
number >= 0

The number of bytes in each captured packet that are put to pcap

duration
number

An integer containing the set packet capture duration in minutes. If not manually stopped, packet capture continues until the specified Maximum Packet Count threshold is reached or the max duration of 1 week is reached.

object (CaptureFilterElement)

This POJO represents the properties of filters used by the packet capture engine.

object (CaptureLocationElement)

This POJO represents the options for location packet capture.

Responses

Request samples

Content type
application/json
{
  • "apSerialNumber": "...",
  • "siteId": "...",
  • "maxPktCount": 12345,
  • "duration": 12345,
  • "filter": {
    },
  • "captureIf": {
    },
  • "custId": "...",
  • "id": "...",
  • "canDelete": true,
  • "canEdit": true
}

Response samples

Content type
application/json
{
  • "apSerialNumber": "...",
  • "siteId": "...",
  • "maxPktCount": 12345,
  • "duration": 12345,
  • "filter": {
    },
  • "captureIf": {
    },
  • "custId": "...",
  • "id": "...",
  • "canDelete": true,
  • "canEdit": true
}

Stop an AP packet capture

Authorizations:
bearerAuth
path Parameters
id
required
string

A non-empty, valid packet capture ID

Responses

Response samples

Content type
application/json
Example
{
  • "result": "CLI Export start: Wed Aug 22 16:46:00 2018, CLI Export end: Wed Aug 22 16:46:01 2018, SUCCESS: Backup/Export complete: EAE.22082018.164600"
}

Get packet capture file list

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get AP packet capture file

Authorizations:
bearerAuth
path Parameters
localStorage
required
string

Responses

Response samples

Content type
application/json
null

Delete AP packet capture file

Authorizations:
bearerAuth
path Parameters
localStorage
required
string

Responses

Response samples

Content type
application/json
null

PlatformReports

Get platform details

Get details that are set mainly at manufacturing time, such as the platform type and the platform MAC address.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "result": "CLI Export start: Wed Aug 22 16:46:00 2018, CLI Export end: Wed Aug 22 16:46:01 2018, SUCCESS: Backup/Export complete: EAE.22082018.164600"
}

Get system information report

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "result": "",
  • "lastUpgrade": 1690999674000,
  • "sysUptime": 1690999674000
}

RoutesManager

Get list of static routes on the controller

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get default gateway of the controller

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "ipv4Address": "..."
}

Update controller default gateway

Authorizations:
bearerAuth
Request Body schema: application/json
ipv4Address
string

Responses

Request samples

Content type
application/json
{
  • "ipv4Address": "..."
}

Response samples

Content type
application/json
{
  • "ipAddress": "...",
  • "cidr": 12345,
  • "gateWay": "...",
  • "portName": "...",
  • "vlanMapToEsa": 12345
}

Create default gateway

Authorizations:
bearerAuth
Request Body schema: application/json
ipv4Address
string

Responses

Request samples

Content type
application/json
{
  • "ipv4Address": "..."
}

Response samples

Content type
application/json
{
  • "ipAddress": "...",
  • "cidr": 12345,
  • "gateWay": "...",
  • "portName": "...",
  • "vlanMapToEsa": 12345
}

Update static route

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.

Authorizations:
bearerAuth
Request Body schema: application/json
ipAddress
string
cidr
number
gateWay
string
portName
string
vlanMapToEsa
number

Responses

Request samples

Content type
application/json
{
  • "ipAddress": "...",
  • "cidr": 12345,
  • "gateWay": "...",
  • "portName": "...",
  • "vlanMapToEsa": 12345
}

Response samples

Content type
application/json
{
  • "ipAddress": "...",
  • "cidr": 12345,
  • "gateWay": "...",
  • "portName": "...",
  • "vlanMapToEsa": 12345
}

Create new static route

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.

Authorizations:
bearerAuth
Request Body schema: application/json
ipAddress
string
cidr
number
gateWay
string
portName
string
vlanMapToEsa
number

Responses

Request samples

Content type
application/json
{
  • "ipAddress": "...",
  • "cidr": 12345,
  • "gateWay": "...",
  • "portName": "...",
  • "vlanMapToEsa": 12345
}

Response samples

Content type
application/json
{
  • "ipAddress": "...",
  • "cidr": 12345,
  • "gateWay": "...",
  • "portName": "...",
  • "vlanMapToEsa": 12345
}

Get static route by IP address

Authorizations:
bearerAuth
path Parameters
id
required
string

IP address of route

Responses

Response samples

Content type
application/json
{
  • "ipAddress": "...",
  • "cidr": 12345,
  • "gateWay": "...",
  • "portName": "...",
  • "vlanMapToEsa": 12345
}

Delete static route based on IP address

Authorizations:
bearerAuth
path Parameters
id
required
string

IP address of static route

Responses

Response samples

Content type
application/json
{
  • "result": "CLI Export start: Wed Aug 22 16:46:00 2018, CLI Export end: Wed Aug 22 16:46:01 2018, SUCCESS: Backup/Export complete: EAE.22082018.164600"
}

SnmpSettingsManager

Get SNMP settings

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "custId": "string",
  • "id": "string",
  • "canDelete": true,
  • "canEdit": true,
  • "snmpVersion": "DISABLED",
  • "engineId": "string",
  • "context": "string",
  • "trapSeverity": "None",
  • "v2Communities": {
    },
  • "v3Users": [
    ],
  • "notifications": [
    ]
}

Update SNMP agent settings

Validates the values of all the attributes of the input SnmpBaseSettings object. If they are all valid, it replaces the current SNMP agent settings with the new settings.

Authorizations:
bearerAuth
Request Body schema: application/json
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 description of the SNMP context in V3 mode

trapSeverity
string (TrapSeverity)
Enum: "None" "Critical" "Major" "Minor" "Informational"
object
Array of objects (SNMPUser)

A list of SNMPUser configurations. If SNMPv3 is selected, v3Users is mandatory and v2Communities will be nullified.

Array of objects (SNMPNotification)

A list of SNMPNotification / Trap destination configuration

Responses

Request samples

Content type
application/json
{
  • "custId": "string",
  • "id": "string",
  • "canDelete": true,
  • "canEdit": true,
  • "snmpVersion": "DISABLED",
  • "engineId": "string",
  • "context": "string",
  • "trapSeverity": "None",
  • "v2Communities": {
    },
  • "v3Users": [
    ],
  • "notifications": [
    ]
}

Response samples

Content type
application/json
{
  • "custId": "string",
  • "id": "string",
  • "canDelete": true,
  • "canEdit": true,
  • "snmpVersion": "DISABLED",
  • "engineId": "string",
  • "context": "string",
  • "trapSeverity": "None",
  • "v2Communities": {
    },
  • "v3Users": [
    ],
  • "notifications": [
    ]
}

TechSupport

Create a single log file for controller

Causes the controller to collect log files and configuration into a single tar.gz file that is suitable for forwarding to support organizations. This method fails if the controller already hosts the maximum number of tech support files. If necessary, use deleteTechSupportFile to remove files before generating another tar.gz file.

Authorizations:
bearerAuth
Request Body schema: application/json
filename
string
mode
string (TechSupportContentType)
Enum: "controller" "ap" "log" "all" "lite"

An enumeration containing a list of supported content types.

apNoStats
boolean

Responses

Request samples

Content type
application/json
{
  • "filename": "...",
  • "mode": "ap",
  • "apNoStats": true
}

Response samples

Content type
application/json
{
  • "result": "CLI Export start: Wed Aug 22 16:46:00 2018, CLI Export end: Wed Aug 22 16:46:01 2018, SUCCESS: Backup/Export complete: EAE.22082018.164600"
}

Get all tech support files

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "techsupportfile": [
    ]
}

Get status of tech support file generating process

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "result": "CLI Export start: Wed Aug 22 16:46:00 2018, CLI Export end: Wed Aug 22 16:46:01 2018, SUCCESS: Backup/Export complete: EAE.22082018.164600"
}

Get tech support file by name

Authorizations:
bearerAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
null

Delete tech support file by name

Authorizations:
bearerAuth
path Parameters
id
required
string

The file name and file extension of the tech support file to be deleted.

Responses

Response samples

Content type
application/json
{
  • "result": "CLI Export start: Wed Aug 22 16:46:00 2018, CLI Export end: Wed Aug 22 16:46:01 2018, SUCCESS: Backup/Export complete: EAE.22082018.164600"
}

UpgradeManager

Upload an image file

A method to upload an image file. The image file extension is based on the platform. File capacity on the controller is three image files or one backup file: "-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

Authorizations:
bearerAuth
Request Body schema: multipart/form-data
fileInputStream
string <binary>
fileMetaData
string <binary>
body
string <binary>

Responses

Response samples

Content type
application/json
{
  • "result": "CLI Export start: Wed Aug 22 16:46:00 2018, CLI Export end: Wed Aug 22 16:46:01 2018, SUCCESS: Backup/Export complete: EAE.22082018.164600"
}

Upload an image file

A method to upload an image file with destination

Authorizations:
bearerAuth
Request Body schema: multipart/form-data
destination
string (LocalDestination)
Enum: "local" "flash"
fileInputStream
string <binary>
fileMetaData
string <binary>
body
string <binary>

Responses

Response samples

Content type
application/json
{
  • "result": "CLI Export start: Wed Aug 22 16:46:00 2018, CLI Export end: Wed Aug 22 16:46:01 2018, SUCCESS: Backup/Export complete: EAE.22082018.164600"
}

Get amount of free space available in the partition that is used to store system upgrade images

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "size": "3000"
}

Get local upgrade schedule

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "upgradeFileName": "...",
  • "upgradeBackupFileName": "...",
  • "systemImageBackup": "...",
  • "startTime": "..."
}

Schedule local upgrade for a specific date and time

A method that attempts to schedule a local upgrade for a specific date and time. The value must be a valid calendar date, at least five minutes into the future or less than one year into the future. Or else, an error is returned. Note: For the date, the year field is not used. For the time, the seconds fields are not used. If enabled, the value is set to false. The controller will apply the cancel command to cancel the previous scheduled upgrade. The scheduling is performed inline. The scheduling is complete when the method returns.

Authorizations:
bearerAuth
Request Body schema: application/json
filename
required
string
backupDestination
required
string(none|local|flash)
object (SystemTimeWithoutYear)
enabled
boolean

Responses

Request samples

Content type
application/json
{
  • "filename": "string",
  • "backupDestination": "string",
  • "startTime": {
    },
  • "enabled": true
}

Response samples

Content type
application/json
{
  • "result": "CLI Export start: Wed Aug 22 16:46:00 2018, CLI Export end: Wed Aug 22 16:46:01 2018, SUCCESS: Backup/Export complete: EAE.22082018.164600"
}

Change local upgrade schedule

A method that attempts to schedule a local upgrade for a specific date and time. The date must be a valid calendar date. The value must be a valid calendar date, at least five minutes into the future or less than one year into the future. Or else, an error is returned. Note: For the date, the year field is not used. For the time, the seconds field is not used. When enabled, it is set to false. The controller will apply the cancel command to cancel the previous scheduled upgrade. The scheduling is performed in line. The scheduling is complete when the method returns.

Authorizations:
bearerAuth
Request Body schema: application/json
filename
required
string
backupDestination
required
string(none|local|flash)
object (SystemTimeWithoutYear)
enabled
boolean

Responses

Request samples

Content type
application/json
{
  • "filename": "string",
  • "backupDestination": "string",
  • "startTime": {
    },
  • "enabled": true
}

Response samples

Content type
application/json
{
  • "result": "CLI Export start: Wed Aug 22 16:46:00 2018, CLI Export end: Wed Aug 22 16:46:01 2018, SUCCESS: Backup/Export complete: EAE.22082018.164600"
}

Get list of files on the controller containing an upgrade bundle

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "upgradefile": [
    ]
}

Delete access point image file

A method to delete an AP image file. The image file must not be a default image for a 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'

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "result": "CLI Export start: Wed Aug 22 16:46:00 2018, CLI Export end: Wed Aug 22 16:46:01 2018, SUCCESS: Backup/Export complete: EAE.22082018.164600"
}

Create an access point image file

A method to upload an AP image file. The image file extension is base on the AP. (Camera APs are differnt.) Up to 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'

Authorizations:
bearerAuth
Request Body schema: multipart/form-data
apPlatform
string

: AP Platform

fileInputStream
string <binary>
fileMetaData
string <binary>
body
string <binary>

Responses

Response samples

Content type
application/json
{
  • "result": "CLI Export start: Wed Aug 22 16:46:00 2018, CLI Export end: Wed Aug 22 16:46:01 2018, SUCCESS: Backup/Export complete: EAE.22082018.164600"
}

Get list of access point images

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'

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Set default access point image

A method to set the default AP image for AP type. The image file must be a 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'

Authorizations:
bearerAuth
Request Body schema: application/json
apPlatform
required
string
filename
required
string

Responses

Request samples

Content type
application/json
{
  • "apPlatform": "...",
  • "filename": "..."
}

Response samples

Content type
application/json
{
  • "result": "CLI Export start: Wed Aug 22 16:46:00 2018, CLI Export end: Wed Aug 22 16:46:01 2018, SUCCESS: Backup/Export complete: EAE.22082018.164600"
}

Copy image upgrade file

A method to copy a system image upgrade file from a remote file server to the controller. The file is copied to the controller. It is not installed by executing this method. It returns true if the file transfer can be started. Otherwise, it returns false. Note: The upgrade files for the controller end in a suffix that identifies the type of platform that can support the upgrade. If the file suffix is not supported by the host platform, the upgrade will not be performed.

Authorizations:
bearerAuth
path Parameters
protocol
required
string

The protocol to use to transfer the upgrade file from a file server to the controller.

Request Body schema: application/json
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 it 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"

Responses

Request samples

Content type
application/json
{
  • "serverIP": "8.8.8.8",
  • "userid": "Admin",
  • "password": "abc123",
  • "directory": "/",
  • "fileName": "example.txt",
  • "localDestination": "local"
}

Response samples

Content type
application/json
{
  • "result": "CLI Export start: Wed Aug 22 16:46:00 2018, CLI Export end: Wed Aug 22 16:46:01 2018, SUCCESS: Backup/Export complete: EAE.22082018.164600"
}

Transfer remote image upgrade file to controller

A method to copy a system image upgrade file from a remote file server to the controller. The file is copied to the controller. It is not installed by executing this method. It returns true if the file transfer can be started. Otherwise, it returns false. Note: The upgrade files for the controller end in a suffix that identifies the type of platform that can support the upgrade. If the file suffix is not supported by the host platform, the upgrade will not be performed.

Authorizations:
bearerAuth
path Parameters
protocol
required
string

The protocol used to transfer the upgrade file from a file server to the controller.

Request Body schema: application/json
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 it 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"

Responses

Request samples

Content type
application/json
{
  • "serverIP": "8.8.8.8",
  • "userid": "Admin",
  • "password": "abc123",
  • "directory": "/",
  • "fileName": "example.txt",
  • "localDestination": "local"
}

Response samples

Content type
application/json
{
  • "result": "CLI Export start: Wed Aug 22 16:46:00 2018, CLI Export end: Wed Aug 22 16:46:01 2018, SUCCESS: Backup/Export complete: EAE.22082018.164600"
}

Check upgrade image file for errors

A method to pre-check the upload of an image file for errors. The image file extension is base on the platform. File capacity on the controller is three image files or one backup file: "-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"

Authorizations:
bearerAuth
path Parameters
filename
required
string

Responses

Response samples

Content type
application/json
{
  • "result": "CLI Export start: Wed Aug 22 16:46:00 2018, CLI Export end: Wed Aug 22 16:46:01 2018, SUCCESS: Backup/Export complete: EAE.22082018.164600"
}

Check upgrade image file for errors

A method to pre-check the upload of an image file for errors.

Authorizations:
bearerAuth
Request Body schema: application/json
filename
string
destination
string (LocalDestination)
Enum: "local" "flash"

Responses

Request samples

Content type
application/json
{
  • "filename": "string",
  • "destination": "local"
}

Response samples

Content type
application/json
{
  • "result": "CLI Export start: Wed Aug 22 16:46:00 2018, CLI Export end: Wed Aug 22 16:46:01 2018, SUCCESS: Backup/Export complete: EAE.22082018.164600"
}

Delete upgrade file from the controller

Attempts to delete the named system image upgrade file from the controller's local storage. The delete is performed inline. Returns true if the delete succeeded. Otherwise, returns false. 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)"

Authorizations:
bearerAuth
path Parameters
id
required
string

The name of an upgrade file on the controller that will be deleted

Responses

Response samples

Content type
application/json
{
  • "result": "CLI Export start: Wed Aug 22 16:46:00 2018, CLI Export end: Wed Aug 22 16:46:01 2018, SUCCESS: Backup/Export complete: EAE.22082018.164600"
}

Upgrade backup files for the controller

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. Otherwise, returns false. The method returns before the upgrade completes because a completed upgrade requires disabling services on the controller and at least one system restart. Note: The upgrade files for the controller end in a suffix that identifies the type of platform that can support the upgrade. If the file suffix is not supported by the host platform, the upgrade is not performed.

Authorizations:
bearerAuth
path Parameters
backupmethod
required
string

Indicates whether to back up the partitions that will be modified by the upgrade before installing the upgrade file. It is a best practice to create an image backup file. The choices are: None - (No backup). This is the fastest method, but the controller cannot be restored to its pre-upgrade state upon a failure. Local - Saves the system image backup file on local storage. The UpgradeManager picks a name for the system image backup file. Note: Remote copying of the 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.

Responses

Response samples

Content type
application/json
{
  • "result": "CLI Export start: Wed Aug 22 16:46:00 2018, CLI Export end: Wed Aug 22 16:46:01 2018, SUCCESS: Backup/Export complete: EAE.22082018.164600"
}

Greengrass(Experimental)

Get log file by type

Accepts the type of a log file and returns the log file to the caller or returns a 404 error if the file does not exist.

Authorizations:
bearerAuth
path Parameters
type
required
string (GreengrassLogType)
Value: "Running"
Example: Running

Type can be one of "Running"/...

Responses

Response samples

Content type
application/json
null

Upload certificate to Greengrass

Authorizations:
bearerAuth
Request Body schema: multipart/form-data
fileInputStream
string <binary>
fileMetaData
string <binary>
body
string <binary>

Responses

Response samples

Content type
application/json
{
  • "result": "CLI Export start: Wed Aug 22 16:46:00 2018, CLI Export end: Wed Aug 22 16:46:01 2018, SUCCESS: Backup/Export complete: EAE.22082018.164600"
}

Upload Greengrass configuration

Upload configuration for Greengrass ('config.json').

Authorizations:
bearerAuth
Request Body schema: multipart/form-data
fileInputStream
string <binary>
fileMetaData
string <binary>
body
string <binary>

Responses

Response samples

Content type
application/json
{
  • "result": "CLI Export start: Wed Aug 22 16:46:00 2018, CLI Export end: Wed Aug 22 16:46:01 2018, SUCCESS: Backup/Export complete: EAE.22082018.164600"
}

Start Greengrass daemon

Authorizations:
bearerAuth
Request Body schema: application/json
forceRestart
boolean
Default: false

Responses

Request samples

Content type
application/json
{
  • "forceRestart": true
}

Response samples

Content type
application/json
{
  • "result": "CLI Export start: Wed Aug 22 16:46:00 2018, CLI Export end: Wed Aug 22 16:46:01 2018, SUCCESS: Backup/Export complete: EAE.22082018.164600"
}

Get current status of Greengrass daemon

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "running": true
}

Stop the Greengrass daemon

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "result": "CLI Export start: Wed Aug 22 16:46:00 2018, CLI Export end: Wed Aug 22 16:46:01 2018, SUCCESS: Backup/Export complete: EAE.22082018.164600"
}