Celona Network Monitoring API: Alerts Status Codes

The Swaggerhub page for the Celona Network Monitoring API can be found at

https://app.swaggerhub.com/apis/celonanetworks/celona-network_monitoring_api/1.0.0

For each event type that you can subscribe to, we provide example data, a table of status codes, which may encompass additional contexts.

APSTATUS

{
    "event_name": "APSTATUS",
    "customer_name": "Test Customer",
    "cluster_name": "test_cluster",
    "site_name": "Test Production 5G-2",
    "event_category": "APSTATUS",
    "event_type": "NOTIFY",
    "ap_name": "TestAP-AP22-AP01",
    "message": "AP's status changed from 'Down' to 'Up'",
    "reason": "Received keepalive with IP 10.24.0.86 and Control UP",
    "action": "For more diagnostics information, please click the Celona Assistant icon in 'https://beta-cso.celonanetworks.com/access-points/AP22RFXAB1234567'",
    "timestamp": "2023-09-08 03:44:54.003 +0000 UTC",
    "serial_number": "AP22RFXAB1234567",
    "ipaddress": "10.24.0.86",
    "mac_address": "aa:bb:cc:00:11:22",
    "down_context": "ControlReady",
    "previous_status_code": 5,
    "current_status_code": 4,
    "event_severity": "INFO"
}

AP Status Codes

0 - Unknown
1 - New
2 - Pending
3 - Provisioned
4 - Up
5 - Down
6 - Deployed

New - The AP is assigned to a customer and can be added to a site
Pending - The AP is connected to a network before getting assigned to a site
Provisioned – The AP is assigned to a site and ready to be connected to a network (i.e. has not initiated bootstrap)
Up - AP is administratively UP, has S1 Up with the Edge, and ready to connect devices
Down - AP is not operational and cannot connect devices. The Down state can be associated with one of the following down_contexts
Deployed - The AP is assigned to a site and connected to a network (i.e. has initiated/completed bootstrap)

down_context can be one of the following -

NoBootstrap
GlobalACSReady
LocalACSReady
SASReady
PendingSASGrant
AdminUp
Down

NoBootstrap - Access Point has not initiated bootstrap process
GlobalACSReady - Access Point initiated bootstrap process and downloaded configuration from CSO
LocalACSReady - Access Point reached Edge and downloaded configuration as part of the bootstrap process
SASReady - AP reached Edge, registered with SAS and received spectrum grants from SAS successfully
PendingSAS - AP reached Edge and waiting for spectrum grants from SAS. No channel grants available for this Access Point
AdminUp - Edge configured Access Point with available spectrum and Admin Up
Down - Access Point is unreachable from Edge

DEVICESTATUS

{
	"event_name": "DEVICESTATUS",
	"customer_name": "QAENV",
	"timestamp": "2021-03-06 01:55:10.670098817 +0000 UTC",
	"message": "Device Status changed from 'Provisioned' to 'Activated",
	"previous_status_code": 2,
    "current_status_code": 3
	"imsi": "315010998903111"
}

Device Status Codes

0 - Unknown
1 - New
2 - Provisioned
3 - Activated
4 - Deactivated 
5 - Connected
6 - Idle
7 - Disconnected 
8 - Blocked

New – The unassigned SIM in the Celona device inventory.
Provisioned – The SIM is assigned to a Celona Orchestrator account and can be activated to connect to the Celona network.
Activated – The SIM is active and exists in the Celona Edge database. It has not yet connected to the Celona network. It is allowed to connect to the network and consume network services as per the user profile.
Deactivated – The SIM is disabled and exists in the Celona Edge database. It cannot connect to the Celona network and user data sessions are not allowed.
Retired – The SIM is deactivated and has been removed from the Celona Edge database. All assigned profiles have been removed from the Celona Orchestrator.
Connected – The SIM is currently connected to the Celona network and has active data sessions from client devices.
Idle – The SIM is currently connected to the Celona network but has no active data sessions from client devices.
Disconnected – The SIM is active but not connected to the Celona network.
Blocked/Suspended – The SIM is blocked from connecting to the Celona network and all user data sessions have been removed from Celona Edge.

UEALERT

{
    "event_name": "UEALERT",
    "customer_name": "QAENV",
    "cluster_name": "G1-OutdoorEdge",
    "event_category": "UEALERT",
    "alert_context": "IMSIATTACHFAIL",
    "message": "315010999900092",
    "timestamp": "2021-06-12 16:20:06.272 +0000 UTC",
    "imsi": "315010999900092"
}

alert_context field can have the following states -

INVALIDPLMNID
IMSINOTPRESENT
IMSIAUTHFAIL,
IMSIATTACHFAIL

INVALIDPLMNID - This alert is triggered when the PLMN ID in the UE connection request is not in our configured value. eNB itself will check for valid PLMN ID, so we will not see this alert
IMSINOTPRESENT - This alert is triggered when the IMSI is not in the configured devices list (or present in the device list but not activated)
IMSIAUTHFAIL - This alert is triggered when the verification of the SIM fails, most likely the SIM was incorrectly read by the device (due to any physical damage of the skin)
IMSIATTACHFAIL - This is a generic alert when a valid SIM failed to connect properly due to several other internal errors on the edge

DPALERT

{
    "event_name": "DPALERT",
    "customer_name": "Test Customer",
    "cluster_name": "test_cluster",
    "site_name": "Test Production 5G",
    "event_category": "DPALERT",
    "event_type": "ALERT",
    "ap_name": "HQ-Test-AP22-1",
    "alert_context": "FORCEDREREGISTER",
    "message": "Invalid frequency range: must use 5 MHz channel raster",
    "action": "Send a reset command from CSO",
    "timestamp": "2023-05-03 21:12:34.52 +0000 UTC",
    "serial_number": "AP22RFXAB1234567",
    "sector": "0",
    "channel_number": "0",
    "ipaddress": "100.100.100.11",
    "enb_ip_address": "10.24.0.124",
    "mac_address": "aa:bb:cc:00:01:02",
    "event_severity": "ERROR"
}

alert_context values could be one of the following

SUSPENDEDSTATE
TERMINATEDSTATE
NOSPECTRUM
CPIERROR
CBSDBLACKLIST
FORCEDREREGISTER

SUSPENDEDSTATE - This alert is triggered when a channel granted to an AP is suspended by SAS because the AP is deployed in a location with incumbent activity. All grants that cause too much interference with Navy operations are suspended
TERMINATEDSTATE - This alert is triggered when a channel granted to an AP is terminated. This happens when a channel allocated to a Priority Access License (PAL) holder is activated or an incumbent is nearby. Celona Domain Proxy service will attempt to reallocate a new channel to the AP from the available channels
NOSPECTRUM - This alert is triggered when an AP has no spectrum available at that location. This is not commonly seen except for locations in Hawaii.
CPIERROR - This alert is triggered when the CPI parameters or the CPI certificate/installer credentials entered are incorrect
CBSDBLACKLIST - This alert is triggered when a specific AP has been blacklisted by SAS. This is a precautionary alert and hasn't been observed yet
FORCEDREREGISTER - When a registered AP needs to be reset to get new grants or needs to move from one location to another, this alert will be triggered as the AP will be deregistered and re-registered.

CPUALERT

Triggers if the average CPU utilization is more than 70%

{
	"event_name": "CPUALERT",
	"customer_name": "QAENV",
	"cluster_name": "ajmay25",
	"node_id": "83bf98eb-673b-4d17-8aae-de3b1fecf34c",
	"event_category": "NODECPUSTATS",
	"message": "Average CPU utilization (72.788584) exceeded threshold",
	"timestamp": "2021-04-20 18:03:50.729 +0000 UTC",
	"ipaddress": "10.138.0.88"
}

MEMORYALERT

Triggers if the average Memory utilization is more than 80%

{
	"event_name": "MEMORYALERT",
	"customer_name": "QAENV",
	"cluster_name": "ajmay25",
	"node_id": "3782deea-e3d0-48b1-8396-d0222fc99c2b",
	"event_category": "NODEMEMORYSTATS",
	"message": "Memory utilization (87.982452) exceeded threshold. 3.33 GB of total 3.8 GB used",
	"timestamp": "2021-04-20 18:13:25.979 +0000 UTC",
	"ipaddress": "10.138.0.123"
}

EDGESTATUS

Edge’s state change (New/Provisioned/Up/Down) notification

{
    "event_name": "EDGESTATUS",
    "customer_name": "Test Customer",
    "cluster_name": "test_cluster",
    "event_category": "EDGESTATUS",
    "event_type": "ALERT",
    "message": "Edge Cluster is 'Up' and fully operational.",
    "timestamp": "2023-10-10 17:57:31.934 +0000 UTC",
    "previous_status_code": 5,
    "current_status_code": 4,
    "edge_node_info": [
     {
      "serial_number": "S440665X1234567",
      "node_type": "Leader",
      "sw_version": "2308.edge.0.0-57",
      "datapath": true,
      "ipaddress": "100.100.100.12",
      "node_id": "ebcbf8bb-4e3a-4894-acba-d123456789",
      "previous_status_code": 7,
      "current_status_code": 4,
      "message": "Edge Node status changed from 'Initializing' to 'Up'"
     },
     {
      "serial_number": "S440665X7654321",
      "node_type": "Follower",
      "sw_version": "2308.edge.0.0-57",
      "datapath": true,
      "ipaddress": "100.100.100.13",
      "node_id": "e62aa223-0e28-4f3e-ac0b-d7456123",
      "previous_status_code": 7,
      "current_status_code": 4,
      "message": "Edge Node status changed from 'Initializing' to 'Up'"
     }
    ],
    "event_severity": "INFO"
   }

Edge Status Codes

(applicable for current_status_code, previous_status_code)

1 - New
2 - Pending 
3 - Provisioned 
4 - Up
5 - Down
8 - Unreachable

New – Edge is assigned to a customer and can be added to a cluster or site.
Pending – Edge is connected to the network but not assigned to a cluster or site.
Provisioned – Edge is assigned to a cluster or site and ready to be connected to the network.
Up – Edge is connected to the network and reachable from the Orchestrator.
Down – Edge may not be connected to the network or not reachable from the Orchestrator.
Unreachable - Edge is not reachable from the Orchestrator.

message field can contain -

Edge Cluster is ‘Provisioned'
Edge Cluster is ‘Up’ and fully operational
Edge Cluster is ‘Down’
Edge Cluster status changed from ‘Down’ to ‘Provisioned’
Edge Cluster status changed from ‘Up’ to ‘Provisioned’
Edge Cluster status changed from ‘Provisioned’ to ‘Initializing’
Edge Cluster status changed from ‘Initializing’ to ‘Provisioned’
Edge Cluster status changed from ‘Down’ to ‘Initializing’
Edge Cluster status changed from ‘Up’ to ‘Initializing’
Edge Cluster is 'Up', but operating at reduced capacity. 1 out of 3 node(s) are operationally 'Down', with the leader being Up
Edge Cluster is ‘Down', operating at reduced capacity. 2 out of 3 node(s) are operationally 'Down’
Edge Cluster is 'Down', operating at reduced capacity. 1 out of 3 node(s) are operationally 'Down', the leader is Down

PTPSTATE

PTP state alert notification

{
 "event_name": "PTPSTATE",
 "customer_name": "qablr",
 "cluster_name": "ptpnodecluster",
 "site_name": "ptp_site",
 "event_category": "PTPSTATE",
 "ap_name": "ptpindoor1",
 "message": "Time Synchronization in progress",
 "timestamp": "2023-09-06 23:44:55.79 +0000 UTC",
 "serial_number": "1202000291217RB0776",
 "ipaddress": "10.32.0.164",
 "enb_ip_address": "10.32.12.23",
 "mac_address": "48:bf:74:1e:4e:df",
 "sync_status": "PTPACQUIRING",
 "event_severity": "INFO"
}

Various sync_status values are:

TODWAIT - Waiting for Time of Day hard-sync to complete to PTP server
PTPHOLDOVER - Lost connection to the PTP GM, tries to keep the previous clock, during PTP HOLDOVER clock can start drifting
PTPACQUIRING - Started negotiation with PTP GM, and exchanged messages with the PTP GM to determine the delay induced by the network and try to sync with the PTP GM clock.
PTPFREQLOCK - Follower AP is locked to the Leader AP/ PTP Grandmaster with respect to frequency, but not phase-aligned.
PTPPHASELOCK - Locked to the PTP Grandmaster with respect to frequency and phase.
REFFAILED - No time sync reports received Or No active server found
REFFAILEDSOAK - No time sync reports received
GPSSYNCCONFIGURED - AP is configured to attempt to sync to a GPS antenna to synchronize with the Global Navigation Satellite System (GNSS)
GPSSYNCSUCCESSFUL - AP is connected to a GPS antenna and receives signal to synchronize with the Global Navigation Satellite System (GNSS)
GPSSYNCSRCNOTAVAILABLE - AP is connected to a GPS antenna but not receiving a signal to synchronize with the Global Navigation Satellite System (GNSS)

UDPFDHCPTIMEOUT

Alerts when udpf fails to get IP address because of DHCP timeout

{
 "event_name": "UDPFDHCPTIMEOUT",
 "customer_name": "qablr",
 "cluster_name": "Device_Cert",
 "event_category": "CNCOREEVENTS",
 "event_type": "ALERT",
 "message": "DHCP IP address not received",
 "timestamp": "2023-09-13 23:22:30.426 +0000 UTC",
 "ipaddress": "10.32.111.90",
 "event_severity": "WARN"
}

NHSTATUS

Alert notification goes when NH (Neutral Host) Status is of below mentioned status:

{
 "event_name": "NHSTATUS",
 "customer_name": "MOCN-QA",
 "cluster_name": "mocn_onprem_GW",
 "event_category": "NHSTATUS",
 "event_type": "ALERT",
 "alert_context": "MNOIPSECSTATUS",
 "message": "mnoIpsecTunnel DOWN",
 "action": "Check IPSec GW reachability.",
 "timestamp": "2023-09-13 23:41:58.335 +0000 UTC",
 "ipaddress": "172.21.1.52",
 "event_severity": "CRITICAL",
 "mno_id": "17bdb735-1871-483a-bd8e-2adc187db526",
 "mno_name": "test-mnoname"
}

alert_context field can be various statuses like:

MNOIPSECSTATUS - When the IPsec connection to MNO Security Gateway is up or down
MNOS1CSTATUS - When the S1-C connection to MNO MME is up or down
MNOS1USTATUS - When the GTP echo to MNO Serving Gateway (SGW) fails
APIPSECSTATUS - When the IPsec connection to AP is up or down
APS1CSTATUS - When the S1-C connection to AP is up or down
APS1USTATUS - When the GTP echo fails to AP

SITEAVAILABILITYALERT

{ 
 "event_name": "SITEAVAILABILITYALERT",
 "customer_name": "qablr",
 "site_name": "JOGESHs_NH_SITE3",
 "event_category": "SITESTATS",
 "event_type": "STATS",
 "timestamp": "2023-12-01 17:17:00 +0000 UTC",
 "event_severity": "CRITICAL",
 "ap_down_count": 2,
 "ap_total_count": 2,
 "degradation_rate": 100 
}

RECURRINGPODCRASHALERT

{ 
 "event_name": "RECURRINGPODCRASHALERT",
 "customer_name": "qablr",
 "cluster_name": "eshwarthreevmcluster",
 "event_category": "PODCRASH",
 "event_type": "STATS",
 "num_crashes": 3,
 "timestamp": "2023-12-03 18:00:00 +0000 UTC",
 "crashed_pod_list": [ "udpf-default-ip-10-32-7-129-0-0(2)",
 "udpf-default-ip-10-32-7-193-0-0(2)",
 "udpf-default-ip-10-32-7-173-0-0(2)"
],
 "event_severity": "CRITICAL"
}

Cradlepoint and Celona: Enterprise Network Integration

Celona Network Monitoring API: How To

Introduction to Celona APIs

Celona Network Monitoring API: Integration with Elgato Stream Deck

API Endpoints for System status