ExtremeCloud IQ Site Engine and ExtremeCloud IQ Communication Overview

Extreme Management Center has transitioned to Extreme Networks' cloud-based environment, ExtremeCloud IQ when deployed in connected mode.

If you are an existing Extreme Management Center customer, contact your representative to have your Extreme Management Center license migrated to an ExtremeCloud IQ Site Engine license. The ExtremeCloud IQ Site Engine license also includes licensing for ExtremeAnalytics.

  NOTE: The communication between ExtremeCloud IQ Site Engine and ExtremeCloud IQ is protected by TLS v1.2 with Cipher Suite: TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256.

When you upgrade from Extreme Management Center to ExtremeCloud IQ Site Engine, if you used the softlaunch feature of Extreme Management Center in ExtremeCloud IQ, you need to remove Extreme Management Center from ExtremeCloud IQ before onboarding ExtremeCloud IQ Site Engine

  NOTE: Devices with IPv6 addresses in ExtremeCloud IQ Site Engine cannot be onboarded as locally-managed devices in ExtremeCloud IQ. Only devices with IPv4 addresses qualify.

This Help Document includes information on the following topics:

Device Statistics Shared Between ExtremeCloud IQ Site Engine and ExtremeCloud IQ

Devices in ExtremeCloud IQ Site Engine are added to ExtremeCloud IQ as "Locally Managed," as long as the device's serial number is reflected in ExtremeCloud IQ Site Engine and the device is not already onboarded to ExtremeCloud IQ.

For devices that are locally managed by ExtremeCloud IQ when ExtremeCloud IQ Site Engine is added, the maximum length the serial number can be is 64 characters. If a device's serial number is more than 64 characters long, it will not be onboarded to ExtremeCloud IQ through ExtremeCloud IQ Site Engine.

Devices that do not have serial numbers or MAC addresses in Extreme Management Center must be rediscovered after you upgrade to ExtremeCloud IQ Site Engine before they can be onboarded to ExtremeCloud IQ.

  NOTES:
  • Deleting a device in ExtremeCloud IQ Site Engine also deletes the locally managed device from ExtremeCloud IQ.
  • Alarms cleared for devices in ExtremeCloud IQ Site Engine are also cleared for devices in ExtremeCloud IQ.
  • Statistics for devices and ports with Historical Collection enabled in ExtremeCloud IQ Site Engine are reflected in the Locally Managed device in ExtremeCloud IQ.
  • Contact Established/Lost Status of devices in ExtremeCloud IQ Site Engine is reflected in Locally Managed devices in ExtremeCloud IQ.
  • User Device Group membership in ExtremeCloud IQ Site Engine is mapped to Cloud Config Groups in ExtremeCloud IQ.

ExtremeCloud IQ Site Engine collects the following statistics for devices and forwards them to ExtremeCloud IQ:

  • Archived status
  • Device Notes
  • User Data 1-4
  • Asset Tag
  • Device System information
  • Device Health
  • Fan
  • Power
  • LLDP
  • LACP
  • Ports - Ports statistics are shared with ExtremeCloud IQ only for ports that are enabled to Collect Port Statistics.
  • Stack membership information

Device and Port Statistics that are collected from ExtremeCloud IQ Site Engine are forwarded to ExtremeCloud IQ.

Messages from ExtremeCloud IQ Site Engine to ExtremeCloud IQ

The following messages are sent from ExtremeCloud IQ Site Engine to ExtremeCloud IQ. All messages are sent one time, after ExtremeCloud IQ Site Engine onboards a device, and then at fixed intervals going forward. The intervals are configurable through ExtremeCloud IQ.

SYSINFO message:
ExtremeCloud IQ Site Engine sends SYSINFO message to ExtremeCloud IQ every 2 minutes.

SYSINFO message consists of:

  1. hostName: Hostname or the nickname of the device.
  2. model: model of the device.
  3. softwareVersion: Device firmware version.

Sample SYSINFO message:


{
{
{
"serialNumber": "1xxx-xxx07",
"deviceFamily": "EXOS",
"macAddress": "B27DF2xxxxA4",
"modelName": "X460_G2_24p_10_G4",
"osVersion": "30.7.1.1",
"role": "Switch",
"ipAddr": "10.15.3.7",
"status": 1,
"hostName": "VSP-SJ",
"imageName": "SummitX465-24t.png"
"licenseType": "Navigator",
"licenseCount": 2,
"userData1":"user data 1",
"userData2":"",
"userData3":"",
"userData4":"user data 4",
"assetTag":"",
"note":"",
"archived":true,
"cloudConfigGroups":[]}
]
}
}
}

HEALTH message:
ExtremeCloud IQ Site Engine sends HEALTH message to ExtremeCloud IQ every 2 minutes.

HEALTH message consists of:

  1. uptime: device up time
  2. cpuTotal: Cpu usage of the device
  3. memoryUsed: memory usage of the device
  4. unitTemperature: temperature of the device

Sample HEALTH message:

{
"agentId":"0001F47E71ED",
"serialNumber":"0001F47E71ED",
 "ipAddr":"10.54.77.33",
 "macAddr":"0001F47E71ED",
"deviceFamily":"Matrix N-Series",
 "unitNumber":0,
"stackSize":0,
"osVersion":null,
"timeStamp":1610725095107,
"messageType":"HEALTH",
"cpuTotal":1.5,
"memoryUsed":83.96110534667969
}

FAN message:
ExtremeCloud IQ Site Engine sends FAN message to ExtremeCloud IQ every 10 minutes.

FAN message consists of:

  1. index: Index of the fan
  2. type: type of the fan
  3. state: current state of the fan
  4. speed: speed of the fan

Sample FAN message:

{
"xmcMessage":true,
 "agentId":"17OL0200R198",
 "serialNumber":"17OL0200R198",
"ipAddr":"10.50.74.51",
 "macAddr":"6049C1BF3400",
"deviceFamily":"ERS Series",
"timeStamp":1610727876611,
"messageType":"FAN",
"fans":[ { "index":10, "type":"FIXED", "state":"OPERATIONAL", "speed":0, "dutyLevel":0, "description":"Internal Fan 1"
}
]
}

POWER message:
ExtremeCloud IQ Site Engine sends POWER message to ExtremeCloud IQ every 10 minutes.

POWER message consists of:

  1. index: Index of power
  2. type: type of power
  3. state: current state of power
  4. descriptions: description of power

Sample POWER message:

{
"xmcMessage":true,
"agentId":"17OL0200R198",
"serialNumber":"17OL0200R198",
"ipAddr":"10.50.74.51",
"macAddr":"6049C1BF3400",
"deviceFamily":"ERS Series",
 "unitNumber":0,
 "stackSize":0,
"timeStamp":1610727876612,
"messageType":"POWER",
"powerSupplyStatus":[
{
 "index":1,
"type":"FIXED",
"state":"OPERATIONAL",
 "description":"Power 1",
 "dellState":"NORMAL",
"currentPower":0,
"avgPower":0,
"avgStartTime":0
}
]
}

LLDP message:
ExtremeCloud IQ Site Engine sends LLDP message to ExtremeCloud IQ every 10 minutes.

LLDP message consists of:

  1. chasisId: port chasisId
  2. portId: portId
  3. systemName: device system name

Sample LLDP message:

{
"xmcMessage":true,
 "agentId":"17OL0200R198",
"serialNumber":"17OL0200R198",
"ipAddr":"10.50.74.51",
"macAddr":"6049C1BF3400",
"deviceFamily":"ERS Series",
 "unitNumber":0,
"stackSize":0,
"timeStamp":1610727876613,
"messageType":"LLDP",
"lldpMap":{
"1/13":[
{
"chassisId":"02:04:96:98:94:E7",
"portId":"3:16",
"systemName":""
}
]
},
"cmdSent":true }

LACP message:
ExtremeCloud IQ Site Engine sends LACP message to ExtremeCloud IQ every 10 minutes.

LACP message consists of:

  1. mode: port mode
  2. port: name of the port
  3. lacpActive: is lacpActive

Sample LACP message:

{
"xmcMessage":true,
"agentId":"17ND2250D108",
"serialNumber":"17ND2250D108",
"ipAddr":"10.54.59.101",
"macAddr":"F873A2086000",
"deviceFamily":"VSP Series",
 "unitNumber":0, "stackSize":0,
 "timeStamp":1603298604429,
"messageType":"LACP",
"portChannels":{
"33":{
"mode":"dynamic",
"ports":[
{ "port":"2/13",
"lacpActive":true
},
{
"port":"2/14",
 "lacpActive":true
},
{
"port":"2/16",
"lacpActive":true
}
]
}
}
}

ONBOARDING message:
ExtremeCloud IQ Site Engine sends ONBOARDING message to ExtremeCloud IQ when new device is added or on server restart.

{
"Onboard Msg": {
"serialNumber": "XYZXYZXYZXY",
"deviceFamily": "EXOS",
"macAddress": "02FFFFFFFFFF",
"modelName": "X670-G2-48x-4q",
"osVersion": "31.7.1.4",
"ipAddr": "10.0.0.0",
"role": "Stack",
"status": 1,
"hostName": "x670-stack",
"licenseType": "Pilot",
"licenseCount": 1,
"note": "EXOS stack",
"imageName": "Summit_x450Stack.png",
"archived": false,
"xiqLocationId": 4299262363422,
"xiqLocationName": "Location-Salem-NH >> Building-Salem-NH >> Floor2-Salem-NH",
"cloudConfigGroups": [],
"unitNo": 1,
"stackMembers": [
{
"serialNumber": "YZXYZXYZXYX",
"deviceFamily": "EXOS",
"macAddress": "00FFFFFFFFFE",
"modelName": "X670-G2-72x",
"osVersion": "31.7.1.4",
"ipAddr": "10.0.0.0",
"role": "Member",
"status": 1,
"hostName": "x670-stack",
"unitNo": 2
}
]
}
}

STACK_SYSINFO message:
ExtremeCloud IQ Site Engine sends STACK_SYSINFO message to ExtremeCloud IQ every 2 minutes.

STACK_SYSINFO message consists of:

  1. Stack unit model
  2. Stack Management Status = Manager or Member
  3. Stack unit number
  4. Stack unit serial number

Sample STACK_SYSINFO message:

{
"STACK_SYSINFO": {
"xmcMessage": true,
"agentId": "XYZXYZXYZXY",
"serialNumber": "XYZXYZXYZXY",
"ipAddr": "10.0.0.50",
"macAddr": "020FFFFFFFFF",
"deviceFamily": "EXOS",
"stackSize": 2,
"unitNumber": 1,
"osVersion": "31.7.1.4",
"timeStamp": 1673278117263,
"messageType": "STACK_SYSINFO",
"stackSysInfo": [
{
"stackMemberIndexProductType": "X670-G2-48x-4q",
"stackMemberIndexStackManagementStatus": 1,
"stackMemberIndexUnitNo": 1,
"stackMemberIndexSerialNumber": "XYZXYZXYZXY",
}
{
"stackMemberIndexProductType": "X670-G2-72x",
"stackMemberIndexStackManagementStatus": 1,
"stackMemberIndexUnitNo": 2,
"stackMemberIndexSerialNumber": "YZXYZXYZXYX",
}
]
}
}

PORT_STATUS message:
ExtremeCloud IQ Site Engine sends PORT_STATUS message to ExtremeCloud IQ every 10 minutes.

PORT_STATUS message consists of:

  1. ifIndex: port index
  2. ifName: port name
  3. portSpeed: port speed
  4. description: port description
  5. portAdminMode: port admin mode
  6. portStatus: status of the port
  7. rxByteCount: bytes received
  8. txByteCount: bytes sent
  9. powerUsed: power used by the port
  10. portMode: port mode
  11. portType: port type

Sample PORT_STATUS message:

{
"xmcMessage":true,
"agentId":"0001F47E71ED",
 "serialNumber":"0001F47E71ED",
"ipAddr":"10.54.77.33",
"macAddr":"0001F47E71ED",
"deviceFamily":
"Matrix N-Series",
 "unitNumber":0,
 "stackSize":0,
"osVersion":null,
"timeStamp":1610724483116,
"ports":[
{
"ts":1610724483118,
 "ifIndex":41023,
"ifName":"fe.4.23",
"portSpeed":"SPEED_10M",
"description":"Extreme Networks, Inc. 100BASE-TX RJ45 Fast Ethernet Frontpanel Port",
 "portAdminMode":1,
 "portStatus":0,
 "rxByteCount":0,
 "txByteCount":0,
 "errors":0,
 "powerUsed":0.0,
 "portMode":"ACCESS",
"portType":"ELECTRICAL",
 "vlan":1,
"static":false
}
 ]
}

Device Details onboarded from ExtremeCloud IQ Site Engine are displayed in ExtremeCloud IQ:

Alarms Messages Generated Between ExtremeCloud IQ Site Engine and ExtremeCloud IQ

The following alarms messages may be generated after ExtremeCloud IQ Site Engine is onboarded to ExtremeCloud IQ:

  • A CRITICAL ALARM message is sent from ExtremeCloud IQ Site Engine to ExtremeCloud IQ when a device is disconnected.
  • Agent Alarms are displayed as (MAJOR, MINOR, INFO) for any other device alarms that are not CRITICAL.
  • A CLEAR alarm message is sent from ExtremeCloud IQ Site Engine to ExtremeCloud IQ when an Alarm is CLEARED.

Related Information

For information on related help topics:

XIQ Connection Tab