Merge branch 'main' into jumbo_frames

generate corresponding json files
Merge pull request #22 from Telecominfraproject/OLS-229-generate-json-file-for-capabilities-connect.capabilities.yml
2025-11-02 19:18:05 +00:00 · 2024-08-12 17:32:34 +08:00 · 2024-08-12 10:32:10 +08:00 · 2024-08-08 13:31:31 -04:00 · 2024-08-08 13:30:53 -04:00 · 2024-08-06 14:03:43 -04:00
11 changed files with 280 additions and 1 deletions
--- a/capabilities/connect.capabilities.yml
+++ b/capabilities/connect.capabilities.yml
@@ -25,6 +25,10 @@ properties:
    type: string
    description:
      Stock keeping unit
+  compatible:
+    type: string
+    description:
+      Compatibility string, that defines the family of the device
  base-mac:
    type: string
    description:
--- a/generate.sh
+++ b/generate.sh
@@ -7,7 +7,8 @@ set -x
 ./merge-schema.py schema schema ucentral.yml ucentral.schema.pretty.json 0 1
 ./merge-schema.py schema schema ucentral.yml ucentral.schema.full.json 0 0
 ./merge-schema.py state state state.yml ucentral.state.pretty.json 0 1
-./generate-reader.uc  > schemareader.uc
+./merge-schema.py capabilities capabilities connect.capabilities.yml ucentral.capabilities.pretty.json 0 1 
+#./generate-reader.uc  > schemareader.uc
 #./generate-example.uc > input.json
 mkdir -p docs
 which generate-schema-doc > /dev/null
--- a/schema/switch.yml
+++ b/schema/switch.yml
@@ -223,3 +223,8 @@ properties:
                  type: array
                  items:
                    type: string
+  jumbo-frames:
+    description:
+      Enables Jumbo frames
+    type: boolean
+    default: false
--- a/schemareader.uc
+++ b/schemareader.uc
@@ -1678,6 +1678,20 @@ function instantiateSwitch(location, value, errors) {
 			obj.port_isolation = parsePortIsolation(location + "/port-isolation", value["port-isolation"], errors);
 		}

+		function parseJumboFrames(location, value, errors) {
+			if (type(value) != "bool")
+				push(errors, [ location, "must be of type boolean" ]);
+
+			return value;
+		}
+
+		if (exists(value, "jumbo-frames")) {
+			obj.jumbo_frames = parseJumboFrames(location + "/jumbo-frames", value["jumbo-frames"], errors);
+		}
+		else {
+			obj.jumbo_frames = false;
+		}
+
 		return obj;
 	}

--- a/state/interface.yml
+++ b/state/interface.yml
@@ -38,6 +38,8 @@ items:
      $ref: "https://ucentral.io/state/v1/interface/clients/"
    counters:
      $ref: "https://ucentral.io/state/v1/interface/counter/"
+    delta_counters:
+      $ref: "https://ucentral.io/state/v1/interface/counter/"
    mesh-path:
      $ref: "https://ucentral.io/state/v1/interface/mesh-path/"
    ssids:
--- a/state/link-state.yml
+++ b/state/link-state.yml
@@ -19,6 +19,8 @@ properties:
    - half
  counters:
    $ref: "https://ucentral.io/state/v1/interface/counter/"
+  delta_counters:
+    $ref: "https://ucentral.io/state/v1/interface/counter/"
  poe:
    description:
      This section describes the ethernet poe-port link-state object (statistics + PD info).
--- a/ucentral.capabilities.pretty.json
+++ b/ucentral.capabilities.pretty.json
@@ -0,0 +1,231 @@
+{
+    "description": "uCentral protocol (OpenLan) device and features capabilities schema",
+    "type": "object",
+    "properties": {
+        "serial": {
+            "type": "string",
+            "examples": [
+                "aabbccddeeff"
+            ]
+        },
+        "firmware": {
+            "type": "string",
+            "description": "Platform revision",
+            "examples": [
+                "Rel 1.6 build 5"
+            ]
+        },
+        "platform": {
+            "type": "string",
+            "enum": [
+                "Switch",
+                "AP"
+            ]
+        },
+        "model": {
+            "type": "string",
+            "description": "Device model"
+        },
+        "hw-sku": {
+            "type": "string",
+            "description": "Stock keeping unit"
+        },
+        "compatible": {
+            "type": "string",
+            "description": "Compatibility string, that defines the family of the device"
+        },
+        "base-mac": {
+            "type": "string",
+            "description": "Switch MAC address",
+            "format": "uc-mac",
+            "examples": [
+                "aa:bb:cc:dd:ee:ff"
+            ]
+        },
+        "port-list": {
+            "type": "array",
+            "description": "The list of physical network devices",
+            "items": {
+                "type": "object",
+                "properties": {
+                    "name": {
+                        "type": "string",
+                        "description": "The logical name of the port that is used by the OS",
+                        "examples": [
+                            "Ethernet0",
+                            "Ethernet1",
+                            "Ethernet76"
+                        ]
+                    },
+                    "front-panel-number": {
+                        "type": "integer",
+                        "description": "The identification number of the port as can be seen on the front-panel of the device"
+                    }
+                }
+            }
+        },
+        "port-capabilities": {
+            "type": "object",
+            "description": "Description of physical ports and their form-factors",
+            "properties": {
+                "form-factors": {
+                    "type": "array",
+                    "items": {
+                        "type": "string",
+                        "enum": [
+                            "RJ45",
+                            "SFP",
+                            "SFP+",
+                            "SFP28",
+                            "SFP-DD",
+                            "QSFP",
+                            "QSFP+",
+                            "QSFP28",
+                            "QSFP-DD"
+                        ]
+                    }
+                },
+                "ports-list": {
+                    "type": "array",
+                    "items": {
+                        "type": "object",
+                        "properties": {
+                            "type": {
+                                "type": "string",
+                                "examples": [
+                                    "RJ45"
+                                ]
+                            },
+                            "ports": {
+                                "type": "array",
+                                "items": {
+                                    "type": "string",
+                                    "examples": [
+                                        "Ethernet1"
+                                    ]
+                                }
+                            }
+                        }
+                    }
+                }
+            }
+        },
+        "poe-capabilities": {
+            "type": "object",
+            "description": "Description of physical ports and their PoE capabilities",
+            "properties": {
+                "supported-standards": {
+                    "type": "array",
+                    "items": {
+                        "type": "string",
+                        "enum": [
+                            ".3AF-POE",
+                            ".3AT-POE+",
+                            ".3BT-PoE++",
+                            "PreStandard-Passive"
+                        ]
+                    }
+                },
+                "power-budget": {
+                    "type": "integer",
+                    "examples": [
+                        2000
+                    ]
+                },
+                "poe-ports": {
+                    "type": "array",
+                    "items": {
+                        "type": "object",
+                        "properties": {
+                            "type": {
+                                "type": "string",
+                                "examples": [
+                                    ".3AF-POE"
+                                ]
+                            },
+                            "budget-capacity": {
+                                "type": "integer"
+                            },
+                            "ports": {
+                                "type": "array",
+                                "items": {
+                                    "type": "string",
+                                    "examples": [
+                                        "Ethernet1"
+                                    ]
+                                }
+                            }
+                        }
+                    }
+                }
+            }
+        },
+        "supported-features": {
+            "type": "array",
+            "description": "List of all features supported by the device",
+            "items": {
+                "type": "string",
+                "enum": [
+                    "VLAN",
+                    "Port-Isolation",
+                    "Spanning-Tree",
+                    "Spanning-Tree-Rapid",
+                    "Spanning-Tree-Per-VLAN",
+                    "Spanning-Tree-Per-VLAN-Rapid",
+                    "Spanning-Tree-MSTP",
+                    "SVI-StaticIPv4",
+                    "SVI-StaticIPv6",
+                    "Interface-StaticIPv4",
+                    "Interface-StaticIPv6",
+                    "Routing-VRF",
+                    "Routing-IPv4-Route-Blackhole",
+                    "Routing-IPv4-Route-Unreachable",
+                    "Routing-IPv4-Nexthop",
+                    "Routing-IPv4-Broadcast",
+                    "Routing-IPv4-Multicast-IGMP-Snooping",
+                    "Routing-IPv4-Multicast-IGMP-Querier",
+                    "Routing-IPv4-Multicast-IGMP-Static",
+                    "Routing-IPv4-DHCP-Server",
+                    "Routing-IPv4-DHCP-Relay",
+                    "Routing-IPv4-DHCP-Snooping",
+                    "Routing-IPv4-Port-Forward",
+                    "Routing-IPv6-DHCP-Relay",
+                    "Routing-IPv6-DHCP-Stateful",
+                    "Routing-IPv6-DHCP-Stateless",
+                    "Routing-IPv6-Port-Forward",
+                    "PoE-Reset",
+                    "Port-Access-Control",
+                    "PAC-Dynamic-Auth",
+                    "System-PasswordChange",
+                    "System-SwUpdate",
+                    "System-SwUpdate-Partial",
+                    "Port-Mirroring",
+                    "Service-SSH",
+                    "Service-RSSH",
+                    "Service-Telnet",
+                    "Service-LLDP",
+                    "Service-HTTP",
+                    "Service-HTTPS",
+                    "Service-GPS",
+                    "Service-IGMP",
+                    "Service-NTP",
+                    "Service-MDNS",
+                    "Service-QoS",
+                    "Service-Syslog",
+                    "Service-PAC",
+                    "Service-Wireguard-Overlay",
+                    "Service-Radius-Proxy",
+                    "Service-Online-Check",
+                    "Service-CaptivePortal",
+                    "Service-PublicIpCheck",
+                    "Tunneling-VxLAN",
+                    "Tunneling-GRE",
+                    "Tunneling-GRE6",
+                    "Tunneling-L2TP",
+                    "Tunneling-Mesh"
+                ]
+            }
+        }
+    },
+    "$defs": {}
+}
--- a/ucentral.schema.full.json
+++ b/ucentral.schema.full.json
@@ -925,6 +925,11 @@
                            }
                        }
                    }
+                },
+                "jumbo-frames": {
+                    "description": "Enables Jumbo frames",
+                    "type": "boolean",
+                    "default": false
                }
            }
        },
--- a/ucentral.schema.json
+++ b/ucentral.schema.json
@@ -678,6 +678,10 @@
                            }
                        }
                    }
+                },
+                "jumbo-frames": {
+                    "type": "boolean",
+                    "default": false
                }
            }
        },
--- a/ucentral.schema.pretty.json
+++ b/ucentral.schema.pretty.json
@@ -776,6 +776,11 @@
                            }
                        }
                    }
+                },
+                "jumbo-frames": {
+                    "description": "Enables Jumbo frames",
+                    "type": "boolean",
+                    "default": false
                }
            }
        },
--- a/ucentral.state.pretty.json
+++ b/ucentral.state.pretty.json
@@ -759,6 +759,9 @@
                    "counters": {
                        "$ref": "#/$defs/interface.counter"
                    },
+                    "delta_counters": {
+                        "$ref": "#/$defs/interface.counter"
+                    },
                    "mesh-path": {
                        "$ref": "#/$defs/interface.mesh-path"
                    },
@@ -887,6 +890,9 @@
                "counters": {
                    "$ref": "#/$defs/interface.counter"
                },
+                "delta_counters": {
+                    "$ref": "#/$defs/interface.counter"
+                },
                "poe": {
                    "description": "This section describes the ethernet poe-port link-state object (statistics + PD info). Present only in case if port has any Power sourcing capabilities.",
                    "type": "object",
Author	SHA1	Message	Date
jacky1100002	8a4815187f	Merge branch 'main' into jumbo_frames	2024-08-12 17:32:34 +08:00
jacky_chang	5da5b090be	generate corresponding json files	2024-08-12 10:32:10 +08:00
Mike Hansen	4235960ab8	Merge pull request #22 from Telecominfraproject/OLS-229-generate-json-file-for-capabilities-connect.capabilities.yml [OLS-229] generate json file for capabilities/connect.capabilities.yml	2024-08-08 13:31:31 -04:00
Mike Hansen	7e839b0681	Merge pull request #21 from Telecominfraproject/OLS-228-delta_counters [OLS-228] Schema -- adding delta_counters	2024-08-08 13:30:53 -04:00
Mike Hansen	b98f8a2b46	[OLS-229] generate json file for capabilities/connect.capabilities.yml Signed-off-by: Mike Hansen <mike.hansen@netexperience.com>	2024-08-06 14:03:43 -04:00
Mike Hansen	1de6cad7e8	[OLS-228] Schema Add delta_counters to state/interface.yml state/link-state.yml Signed-off-by: Mike Hansen <mike.hansen@netexperience.com>	2024-08-06 13:58:37 -04:00
Olexandr, Mazur	0f9f4489d2	Merge pull request #17 from Telecominfraproject/secure_http_server add whether enabled & port number support for https	2024-08-06 12:49:01 +03:00
jacky_chang	4d03a432c1	support jumbo frmaes	2024-08-06 11:08:10 +08:00
Olexandr, Mazur	747ccb4993	Merge pull request #16 from Telecominfraproject/fix/capabilities_add_missing_field Schema: capabilities: add missed <compatible> field	2024-06-05 17:25:31 +03:00
Oleksandr Mazur	a0fac0b3d7	Schema: capabilities: add missed <compatible> field Connect message is required to have compatible field, as it defines device's <family> of devices and compatible counterparts. Add this - originally missed - field to the schema, to make sure cloud infrastructure has enough information to deduce device type / compatible devices (for cfg generation etc). Signed-off-by: Oleksandr Mazur <oleksandr.mazur@plvision.eu>	2024-06-05 11:30:47 +03:00