From 44c07718e36688d296247f7367b23cabf95d10fb Mon Sep 17 00:00:00 2001
From: Binny <binnyjeshan@gmail.com>
Date: Wed, 15 Jan 2025 14:10:01 +0000
Subject: [PATCH] Changes for RT event subscription

---
 schema/switch.yml           | 165 ++++++++++++++++++++++++++-
 ucentral.schema.full.json   | 217 ++++++++++++++++++++++++++++++++++++
 ucentral.schema.json        | 181 ++++++++++++++++++++++++++++++
 ucentral.schema.pretty.json | 217 ++++++++++++++++++++++++++++++++++++
 4 files changed, 779 insertions(+), 1 deletion(-)

diff --git a/schema/switch.yml b/schema/switch.yml
index 1550c80..e54901b 100644
--- a/schema/switch.yml
+++ b/schema/switch.yml
@@ -706,4 +706,167 @@ properties:
               maxLength: 32
               minLength: 1
               examples:
-                - "A VoIP Phone"
\ No newline at end of file
+                - "A VoIP Phone"
+  rt-event-config:
+    description: Configuration for enabling or disabling specific event categories and their sub-events.
+    type: object
+    properties:
+      port-status:
+        description: Enable/Disable Port Status events.
+        type: object
+        properties:
+          enabled:
+            description: Enable/Disable Port Status category.
+            type: boolean
+            default: false
+          sub-events:
+            type: object
+            properties:
+              wired.carrier-down:
+                type: boolean
+                description: Enable/Disable carrier down event.
+                default: false
+              wired.carrier-up:
+                type: boolean
+                description: Enable/Disable carrier up event.
+                default: false
+      module:
+        description: Enable/Disable Module events.
+        type: object
+        properties:
+          enabled:
+            type: boolean
+            description: Enable/Disable Module category.
+            default: false
+          sub-events:
+            type: object
+            properties:
+              module.plugout:
+                type: boolean
+                description: Enable/Disable module plugout event.
+                default: false
+              module.plugin:
+                type: boolean
+                description: Enable/Disable module plugin event.
+                default: false
+      stp:
+        description: Enable/Disable STP events.
+        type: object
+        properties:
+          enabled:
+            type: boolean
+            description: Enable/Disable STP category.
+            default: false
+          sub-events:
+            type: object
+            properties:
+              stp.loop-detected:
+                type: boolean
+                description: Enable/Disable loop detected event.
+                default: false
+              stp.loop-cleared:
+                type: boolean
+                description: Enable/Disable loop cleared event.
+                default: false
+              stp.state-change:
+                type: boolean
+                description: Enable/Disable state change event.
+                default: false
+      rstp:
+        description: Enable/Disable RSTP events.
+        type: object
+        properties:
+          enabled:
+            type: boolean
+            description: Enable/Disable RSTP category.
+            default: false
+          sub-events:
+            type: object
+            properties:
+              rstp.loop-detected:
+                type: boolean
+                description: Enable/Disable loop detected event.
+                default: false
+              rstp.loop-cleared:
+                type: boolean
+                description: Enable/Disable loop cleared event.
+                default: false
+              rstp.state-change:
+                type: boolean
+                description: Enable/Disable state change event.
+                default: false
+      fw-upgrade:
+        description: Enable/Disable Firmware Upgrade events.
+        type: object
+        properties:
+          enabled:
+            type: boolean
+            description: Enable/Disable Firmware Upgrade category.
+            default: false
+          sub-events:
+            type: object
+            properties:
+              upg.download-start:
+                type: boolean
+                description: Enable/Disable download start event.
+                default: false
+              upg.download-in-progress:
+                type: boolean
+                description: Enable/Disable download in progress event.
+                default: false
+              upg.download-failed:
+                type: boolean
+                description: Enable/Disable download failed event.
+                default: false
+              upg.validation-start:
+                type: boolean
+                description: Enable/Disable validation start event.
+                default: false
+              upg.validation-success:
+                type: boolean
+                description: Enable/Disable validation success event.
+                default: false
+              upg.validation-failed:
+                type: boolean
+                description: Enable/Disable validation failed event.
+                default: false
+              upg.backup-current-firmware:
+                type: boolean
+                description: Enable/Disable firmware backup event.
+                default: false
+              upg.install-start:
+                type: boolean
+                description: Enable/Disable install start event.
+                default: false
+              upg.install-failed:
+                type: boolean
+                description: Enable/Disable install failed event.
+                default: false
+              upg.reboot-start:
+                type: boolean
+                description: Enable/Disable reboot start event.
+                default: false
+              upg.success:
+                type: boolean
+                description: Enable/Disable upgrade success event.
+                default: false
+      dhcp-snooping:
+        description: Enable/Disable DHCP Snooping events.
+        type: object
+        properties:
+          enabled:
+            type: boolean
+            description: Enable/Disable DHCP Snooping category.
+            default: false
+          sub-events:
+            type: object
+            properties:
+              dhcp-snooping.violation-detected:
+                type: boolean
+                description: Enable/Disable DHCP Snooping violation detected event.
+                default: false
+              dhcp-snooping.violation-cleared:
+                type: boolean
+                description: Enable/Disable DHCP Snooping violation cleared event.
+                default: false
+      # Continue similarly for ARP Inspection, IPSG, PoE Status, PoE Fault, and Device Events.
diff --git a/ucentral.schema.full.json b/ucentral.schema.full.json
index 7238cd4..b26ad72 100644
--- a/ucentral.schema.full.json
+++ b/ucentral.schema.full.json
@@ -1421,6 +1421,223 @@
                             }
                         }
                     }
+                },
+                "rt-event-config": {
+                    "description": "Configuration for enabling or disabling specific event categories and their sub-events.",
+                    "type": "object",
+                    "properties": {
+                        "port-status": {
+                            "description": "Enable/Disable Port Status events.",
+                            "type": "object",
+                            "properties": {
+                                "enabled": {
+                                    "description": "Enable/Disable Port Status category.",
+                                    "type": "boolean",
+                                    "default": false
+                                },
+                                "sub-events": {
+                                    "type": "object",
+                                    "properties": {
+                                        "wired.carrier-down": {
+                                            "type": "boolean",
+                                            "description": "Enable/Disable carrier down event.",
+                                            "default": false
+                                        },
+                                        "wired.carrier-up": {
+                                            "type": "boolean",
+                                            "description": "Enable/Disable carrier up event.",
+                                            "default": false
+                                        }
+                                    }
+                                }
+                            }
+                        },
+                        "module": {
+                            "description": "Enable/Disable Module events.",
+                            "type": "object",
+                            "properties": {
+                                "enabled": {
+                                    "type": "boolean",
+                                    "description": "Enable/Disable Module category.",
+                                    "default": false
+                                },
+                                "sub-events": {
+                                    "type": "object",
+                                    "properties": {
+                                        "module.plugout": {
+                                            "type": "boolean",
+                                            "description": "Enable/Disable module plugout event.",
+                                            "default": false
+                                        },
+                                        "module.plugin": {
+                                            "type": "boolean",
+                                            "description": "Enable/Disable module plugin event.",
+                                            "default": false
+                                        }
+                                    }
+                                }
+                            }
+                        },
+                        "stp": {
+                            "description": "Enable/Disable STP events.",
+                            "type": "object",
+                            "properties": {
+                                "enabled": {
+                                    "type": "boolean",
+                                    "description": "Enable/Disable STP category.",
+                                    "default": false
+                                },
+                                "sub-events": {
+                                    "type": "object",
+                                    "properties": {
+                                        "stp.loop-detected": {
+                                            "type": "boolean",
+                                            "description": "Enable/Disable loop detected event.",
+                                            "default": false
+                                        },
+                                        "stp.loop-cleared": {
+                                            "type": "boolean",
+                                            "description": "Enable/Disable loop cleared event.",
+                                            "default": false
+                                        },
+                                        "stp.state-change": {
+                                            "type": "boolean",
+                                            "description": "Enable/Disable state change event.",
+                                            "default": false
+                                        }
+                                    }
+                                }
+                            }
+                        },
+                        "rstp": {
+                            "description": "Enable/Disable RSTP events.",
+                            "type": "object",
+                            "properties": {
+                                "enabled": {
+                                    "type": "boolean",
+                                    "description": "Enable/Disable RSTP category.",
+                                    "default": false
+                                },
+                                "sub-events": {
+                                    "type": "object",
+                                    "properties": {
+                                        "rstp.loop-detected": {
+                                            "type": "boolean",
+                                            "description": "Enable/Disable loop detected event.",
+                                            "default": false
+                                        },
+                                        "rstp.loop-cleared": {
+                                            "type": "boolean",
+                                            "description": "Enable/Disable loop cleared event.",
+                                            "default": false
+                                        },
+                                        "rstp.state-change": {
+                                            "type": "boolean",
+                                            "description": "Enable/Disable state change event.",
+                                            "default": false
+                                        }
+                                    }
+                                }
+                            }
+                        },
+                        "fw-upgrade": {
+                            "description": "Enable/Disable Firmware Upgrade events.",
+                            "type": "object",
+                            "properties": {
+                                "enabled": {
+                                    "type": "boolean",
+                                    "description": "Enable/Disable Firmware Upgrade category.",
+                                    "default": false
+                                },
+                                "sub-events": {
+                                    "type": "object",
+                                    "properties": {
+                                        "upg.download-start": {
+                                            "type": "boolean",
+                                            "description": "Enable/Disable download start event.",
+                                            "default": false
+                                        },
+                                        "upg.download-in-progress": {
+                                            "type": "boolean",
+                                            "description": "Enable/Disable download in progress event.",
+                                            "default": false
+                                        },
+                                        "upg.download-failed": {
+                                            "type": "boolean",
+                                            "description": "Enable/Disable download failed event.",
+                                            "default": false
+                                        },
+                                        "upg.validation-start": {
+                                            "type": "boolean",
+                                            "description": "Enable/Disable validation start event.",
+                                            "default": false
+                                        },
+                                        "upg.validation-success": {
+                                            "type": "boolean",
+                                            "description": "Enable/Disable validation success event.",
+                                            "default": false
+                                        },
+                                        "upg.validation-failed": {
+                                            "type": "boolean",
+                                            "description": "Enable/Disable validation failed event.",
+                                            "default": false
+                                        },
+                                        "upg.backup-current-firmware": {
+                                            "type": "boolean",
+                                            "description": "Enable/Disable firmware backup event.",
+                                            "default": false
+                                        },
+                                        "upg.install-start": {
+                                            "type": "boolean",
+                                            "description": "Enable/Disable install start event.",
+                                            "default": false
+                                        },
+                                        "upg.install-failed": {
+                                            "type": "boolean",
+                                            "description": "Enable/Disable install failed event.",
+                                            "default": false
+                                        },
+                                        "upg.reboot-start": {
+                                            "type": "boolean",
+                                            "description": "Enable/Disable reboot start event.",
+                                            "default": false
+                                        },
+                                        "upg.success": {
+                                            "type": "boolean",
+                                            "description": "Enable/Disable upgrade success event.",
+                                            "default": false
+                                        }
+                                    }
+                                }
+                            }
+                        },
+                        "dhcp-snooping": {
+                            "description": "Enable/Disable DHCP Snooping events.",
+                            "type": "object",
+                            "properties": {
+                                "enabled": {
+                                    "type": "boolean",
+                                    "description": "Enable/Disable DHCP Snooping category.",
+                                    "default": false
+                                },
+                                "sub-events": {
+                                    "type": "object",
+                                    "properties": {
+                                        "dhcp-snooping.violation-detected": {
+                                            "type": "boolean",
+                                            "description": "Enable/Disable DHCP Snooping violation detected event.",
+                                            "default": false
+                                        },
+                                        "dhcp-snooping.violation-cleared": {
+                                            "type": "boolean",
+                                            "description": "Enable/Disable DHCP Snooping violation cleared event.",
+                                            "default": false
+                                        }
+                                    }
+                                }
+                            }
+                        }
+                    }
                 }
             }
         },
diff --git a/ucentral.schema.json b/ucentral.schema.json
index f6d1fe7..e9d9354 100644
--- a/ucentral.schema.json
+++ b/ucentral.schema.json
@@ -1231,6 +1231,187 @@
                             }
                         }
                     }
+                },
+                "rt-event-config": {
+                    "type": "object",
+                    "properties": {
+                        "port-status": {
+                            "type": "object",
+                            "properties": {
+                                "enabled": {
+                                    "type": "boolean",
+                                    "default": false
+                                },
+                                "sub-events": {
+                                    "type": "object",
+                                    "properties": {
+                                        "wired.carrier-down": {
+                                            "type": "boolean",
+                                            "default": false
+                                        },
+                                        "wired.carrier-up": {
+                                            "type": "boolean",
+                                            "default": false
+                                        }
+                                    }
+                                }
+                            }
+                        },
+                        "module": {
+                            "type": "object",
+                            "properties": {
+                                "enabled": {
+                                    "type": "boolean",
+                                    "default": false
+                                },
+                                "sub-events": {
+                                    "type": "object",
+                                    "properties": {
+                                        "module.plugout": {
+                                            "type": "boolean",
+                                            "default": false
+                                        },
+                                        "module.plugin": {
+                                            "type": "boolean",
+                                            "default": false
+                                        }
+                                    }
+                                }
+                            }
+                        },
+                        "stp": {
+                            "type": "object",
+                            "properties": {
+                                "enabled": {
+                                    "type": "boolean",
+                                    "default": false
+                                },
+                                "sub-events": {
+                                    "type": "object",
+                                    "properties": {
+                                        "stp.loop-detected": {
+                                            "type": "boolean",
+                                            "default": false
+                                        },
+                                        "stp.loop-cleared": {
+                                            "type": "boolean",
+                                            "default": false
+                                        },
+                                        "stp.state-change": {
+                                            "type": "boolean",
+                                            "default": false
+                                        }
+                                    }
+                                }
+                            }
+                        },
+                        "rstp": {
+                            "type": "object",
+                            "properties": {
+                                "enabled": {
+                                    "type": "boolean",
+                                    "default": false
+                                },
+                                "sub-events": {
+                                    "type": "object",
+                                    "properties": {
+                                        "rstp.loop-detected": {
+                                            "type": "boolean",
+                                            "default": false
+                                        },
+                                        "rstp.loop-cleared": {
+                                            "type": "boolean",
+                                            "default": false
+                                        },
+                                        "rstp.state-change": {
+                                            "type": "boolean",
+                                            "default": false
+                                        }
+                                    }
+                                }
+                            }
+                        },
+                        "fw-upgrade": {
+                            "type": "object",
+                            "properties": {
+                                "enabled": {
+                                    "type": "boolean",
+                                    "default": false
+                                },
+                                "sub-events": {
+                                    "type": "object",
+                                    "properties": {
+                                        "upg.download-start": {
+                                            "type": "boolean",
+                                            "default": false
+                                        },
+                                        "upg.download-in-progress": {
+                                            "type": "boolean",
+                                            "default": false
+                                        },
+                                        "upg.download-failed": {
+                                            "type": "boolean",
+                                            "default": false
+                                        },
+                                        "upg.validation-start": {
+                                            "type": "boolean",
+                                            "default": false
+                                        },
+                                        "upg.validation-success": {
+                                            "type": "boolean",
+                                            "default": false
+                                        },
+                                        "upg.validation-failed": {
+                                            "type": "boolean",
+                                            "default": false
+                                        },
+                                        "upg.backup-current-firmware": {
+                                            "type": "boolean",
+                                            "default": false
+                                        },
+                                        "upg.install-start": {
+                                            "type": "boolean",
+                                            "default": false
+                                        },
+                                        "upg.install-failed": {
+                                            "type": "boolean",
+                                            "default": false
+                                        },
+                                        "upg.reboot-start": {
+                                            "type": "boolean",
+                                            "default": false
+                                        },
+                                        "upg.success": {
+                                            "type": "boolean",
+                                            "default": false
+                                        }
+                                    }
+                                }
+                            }
+                        },
+                        "dhcp-snooping": {
+                            "type": "object",
+                            "properties": {
+                                "enabled": {
+                                    "type": "boolean",
+                                    "default": false
+                                },
+                                "sub-events": {
+                                    "type": "object",
+                                    "properties": {
+                                        "dhcp-snooping.violation-detected": {
+                                            "type": "boolean",
+                                            "default": false
+                                        },
+                                        "dhcp-snooping.violation-cleared": {
+                                            "type": "boolean",
+                                            "default": false
+                                        }
+                                    }
+                                }
+                            }
+                        }
+                    }
                 }
             }
         },
diff --git a/ucentral.schema.pretty.json b/ucentral.schema.pretty.json
index 2cd29c9..0c08371 100644
--- a/ucentral.schema.pretty.json
+++ b/ucentral.schema.pretty.json
@@ -1454,6 +1454,223 @@
                             }
                         }
                     }
+                },
+                "rt-event-config": {
+                    "description": "Configuration for enabling or disabling specific event categories and their sub-events.",
+                    "type": "object",
+                    "properties": {
+                        "port-status": {
+                            "description": "Enable/Disable Port Status events.",
+                            "type": "object",
+                            "properties": {
+                                "enabled": {
+                                    "description": "Enable/Disable Port Status category.",
+                                    "type": "boolean",
+                                    "default": false
+                                },
+                                "sub-events": {
+                                    "type": "object",
+                                    "properties": {
+                                        "wired.carrier-down": {
+                                            "type": "boolean",
+                                            "description": "Enable/Disable carrier down event.",
+                                            "default": false
+                                        },
+                                        "wired.carrier-up": {
+                                            "type": "boolean",
+                                            "description": "Enable/Disable carrier up event.",
+                                            "default": false
+                                        }
+                                    }
+                                }
+                            }
+                        },
+                        "module": {
+                            "description": "Enable/Disable Module events.",
+                            "type": "object",
+                            "properties": {
+                                "enabled": {
+                                    "type": "boolean",
+                                    "description": "Enable/Disable Module category.",
+                                    "default": false
+                                },
+                                "sub-events": {
+                                    "type": "object",
+                                    "properties": {
+                                        "module.plugout": {
+                                            "type": "boolean",
+                                            "description": "Enable/Disable module plugout event.",
+                                            "default": false
+                                        },
+                                        "module.plugin": {
+                                            "type": "boolean",
+                                            "description": "Enable/Disable module plugin event.",
+                                            "default": false
+                                        }
+                                    }
+                                }
+                            }
+                        },
+                        "stp": {
+                            "description": "Enable/Disable STP events.",
+                            "type": "object",
+                            "properties": {
+                                "enabled": {
+                                    "type": "boolean",
+                                    "description": "Enable/Disable STP category.",
+                                    "default": false
+                                },
+                                "sub-events": {
+                                    "type": "object",
+                                    "properties": {
+                                        "stp.loop-detected": {
+                                            "type": "boolean",
+                                            "description": "Enable/Disable loop detected event.",
+                                            "default": false
+                                        },
+                                        "stp.loop-cleared": {
+                                            "type": "boolean",
+                                            "description": "Enable/Disable loop cleared event.",
+                                            "default": false
+                                        },
+                                        "stp.state-change": {
+                                            "type": "boolean",
+                                            "description": "Enable/Disable state change event.",
+                                            "default": false
+                                        }
+                                    }
+                                }
+                            }
+                        },
+                        "rstp": {
+                            "description": "Enable/Disable RSTP events.",
+                            "type": "object",
+                            "properties": {
+                                "enabled": {
+                                    "type": "boolean",
+                                    "description": "Enable/Disable RSTP category.",
+                                    "default": false
+                                },
+                                "sub-events": {
+                                    "type": "object",
+                                    "properties": {
+                                        "rstp.loop-detected": {
+                                            "type": "boolean",
+                                            "description": "Enable/Disable loop detected event.",
+                                            "default": false
+                                        },
+                                        "rstp.loop-cleared": {
+                                            "type": "boolean",
+                                            "description": "Enable/Disable loop cleared event.",
+                                            "default": false
+                                        },
+                                        "rstp.state-change": {
+                                            "type": "boolean",
+                                            "description": "Enable/Disable state change event.",
+                                            "default": false
+                                        }
+                                    }
+                                }
+                            }
+                        },
+                        "fw-upgrade": {
+                            "description": "Enable/Disable Firmware Upgrade events.",
+                            "type": "object",
+                            "properties": {
+                                "enabled": {
+                                    "type": "boolean",
+                                    "description": "Enable/Disable Firmware Upgrade category.",
+                                    "default": false
+                                },
+                                "sub-events": {
+                                    "type": "object",
+                                    "properties": {
+                                        "upg.download-start": {
+                                            "type": "boolean",
+                                            "description": "Enable/Disable download start event.",
+                                            "default": false
+                                        },
+                                        "upg.download-in-progress": {
+                                            "type": "boolean",
+                                            "description": "Enable/Disable download in progress event.",
+                                            "default": false
+                                        },
+                                        "upg.download-failed": {
+                                            "type": "boolean",
+                                            "description": "Enable/Disable download failed event.",
+                                            "default": false
+                                        },
+                                        "upg.validation-start": {
+                                            "type": "boolean",
+                                            "description": "Enable/Disable validation start event.",
+                                            "default": false
+                                        },
+                                        "upg.validation-success": {
+                                            "type": "boolean",
+                                            "description": "Enable/Disable validation success event.",
+                                            "default": false
+                                        },
+                                        "upg.validation-failed": {
+                                            "type": "boolean",
+                                            "description": "Enable/Disable validation failed event.",
+                                            "default": false
+                                        },
+                                        "upg.backup-current-firmware": {
+                                            "type": "boolean",
+                                            "description": "Enable/Disable firmware backup event.",
+                                            "default": false
+                                        },
+                                        "upg.install-start": {
+                                            "type": "boolean",
+                                            "description": "Enable/Disable install start event.",
+                                            "default": false
+                                        },
+                                        "upg.install-failed": {
+                                            "type": "boolean",
+                                            "description": "Enable/Disable install failed event.",
+                                            "default": false
+                                        },
+                                        "upg.reboot-start": {
+                                            "type": "boolean",
+                                            "description": "Enable/Disable reboot start event.",
+                                            "default": false
+                                        },
+                                        "upg.success": {
+                                            "type": "boolean",
+                                            "description": "Enable/Disable upgrade success event.",
+                                            "default": false
+                                        }
+                                    }
+                                }
+                            }
+                        },
+                        "dhcp-snooping": {
+                            "description": "Enable/Disable DHCP Snooping events.",
+                            "type": "object",
+                            "properties": {
+                                "enabled": {
+                                    "type": "boolean",
+                                    "description": "Enable/Disable DHCP Snooping category.",
+                                    "default": false
+                                },
+                                "sub-events": {
+                                    "type": "object",
+                                    "properties": {
+                                        "dhcp-snooping.violation-detected": {
+                                            "type": "boolean",
+                                            "description": "Enable/Disable DHCP Snooping violation detected event.",
+                                            "default": false
+                                        },
+                                        "dhcp-snooping.violation-cleared": {
+                                            "type": "boolean",
+                                            "description": "Enable/Disable DHCP Snooping violation cleared event.",
+                                            "default": false
+                                        }
+                                    }
+                                }
+                            }
+                        }
+                    }
                 }
             }
         },