[cisco-sg] add poe support

Author: geoffhouse

src/modules/cisco-cbs/container/workers/worker-snmp.js

@@ -43,7 +43,7 @@ const main = async () => {
 
         workerTaskManager({
             tasks: [
-                { name: "interfaces", seconds: 900 },
+                { name: "interfaces", seconds: 120 },
                 { name: "interfacedetails", seconds: 15, delay: 5 },
                 { name: "interfacestats", seconds: 10, delay: 8 },
                 { name: "interfacestate", seconds: 5, delay: 8 },

src/modules/cisco-sg/client/components/InterfaceList.jsx

@@ -4,6 +4,7 @@ import BugApiVlanAutocomplete from "@core/BugApiVlanAutocomplete";
 import BugAutocompletePlaceholder from "@core/BugAutocompletePlaceholder";
 import BugNetworkIcon from "@core/BugNetworkIcon";
 import BugNoData from "@core/BugNoData";
+import BugPoeIcon from "@core/BugPoeIcon";
 import { useBugRenameDialog } from "@core/BugRenameDialog";
 import BugSparkCell from "@core/BugSparkCell";
 import BugTableLinkButton from "@core/BugTableLinkButton";
@@ -194,6 +195,20 @@ export default function InterfaceList({ panelId, stackId = null }) {
         return interfaceToggle(false, item);
     };
 
+    const handlePoeClicked = async (event, item) => {
+        const action = item?.["poe-admin-enable"] ? "disable" : "enable";
+        if (await AxiosCommand(`/container/${panelId}/interface/${action}poe/${item.interfaceId}`)) {
+            doForceRefresh();
+            sendAlert(`${action === "disable" ? "Disabled" : "Enabled"} POE for interface: ${item.shortId}`, {
+                variant: "success",
+            });
+        } else {
+            sendAlert(`Failed to ${action} POE for interface: ${item.shortId}`, {
+                variant: "error",
+            });
+        }
+    };
+
     const handleProtectClicked = async (event, item) => {
         if (
             await AxiosCommand(
@@ -248,6 +263,22 @@ export default function InterfaceList({ panelId, stackId = null }) {
                     width: 44,
                     content: (item) => <BugNetworkIcon disabled={!item["link-state"]} />,
                 },
+                {
+                    noPadding: true,
+                    width: 44,
+                    content: (item) => {
+                        if (!item?.["poe-available"]) {
+                            return null;
+                        }
+                        return (
+                            <BugPoeIcon
+                                disabled={!item?.["poe-admin-enable"]}
+                                active={item?.["poe-operational-status"]}
+                                error={item?.["poe-error"]}
+                            />
+                        );
+                    },
+                },
                 {
                     noPadding: true,
                     hideWidth: 600,
@@ -378,6 +409,12 @@ export default function InterfaceList({ panelId, stackId = null }) {
                 {
                     title: "-",
                 },
+                {
+                    title: "POE",
+                    disabled: (item) => !item?.["poe-available"],
+                    icon: (item) => (item?.["poe-admin-enable"] ? <CheckIcon fontSize="small" /> : null),
+                    onClick: handlePoeClicked,
+                },
                 {
                     title: "Protect",
                     disabled: (item) => item._protected && !item._allowunprotect,

src/modules/cisco-sg/container/api/routes/interface.js

@@ -11,6 +11,7 @@ const interfaceUnprotect = require("@services/interface-unprotect");
 const interfaceSetVlanTrunk = require("@services/interface-setvlantrunk");
 const interfaceSetVlanAccess = require("@services/interface-setvlanaccess");
 const interfaceRename = require("@services/interface-rename");
+const interfacePoe = require("@services/interface-poe");
 const asyncHandler = require("express-async-handler");
 
 router.all(
@@ -88,6 +89,26 @@ router.get(
     })
 );
 
+router.get(
+    "/enablepoe/:interfaceId/",
+    asyncHandler(async (req, res) => {
+        res.json({
+            status: "success",
+            data: await interfacePoe(req.params.interfaceId, "enable"),
+        });
+    })
+);
+
+router.get(
+    "/disablepoe/:interfaceId/",
+    asyncHandler(async (req, res) => {
+        res.json({
+            status: "success",
+            data: await interfacePoe(req.params.interfaceId, "disable"),
+        });
+    })
+);
+
 router.post(
     "/setvlantrunk/:interfaceId/",
     asyncHandler(async (req, res) => {

src/modules/cisco-sg/container/api/routes/interface.test.js

@@ -12,6 +12,7 @@ jest.mock("@services/interface-unprotect", () => jest.fn(async () => ({ updated:
 jest.mock("@services/interface-setvlantrunk", () => jest.fn(async () => ({ updated: true })));
 jest.mock("@services/interface-setvlanaccess", () => jest.fn(async () => ({ updated: true })));
 jest.mock("@services/interface-rename", () => jest.fn(async () => ({ updated: true })));
+jest.mock("@services/interface-poe", () => jest.fn(async () => ({ updated: true })));
 
 const interfaceRouter = require("./interface");
 
@@ -37,4 +38,20 @@ describe("interface routes", () => {
         expect(response.body).toHaveProperty("status", "success");
         expect(response.body).toHaveProperty("data");
     });
+
+    test("GET /enablepoe/:interfaceId should return success response", async () => {
+        const response = await request(app).get("/enablepoe/123/");
+
+        expect(response.statusCode).toBe(200);
+        expect(response.body).toHaveProperty("status", "success");
+        expect(response.body).toHaveProperty("data");
+    });
+
+    test("GET /disablepoe/:interfaceId should return success response", async () => {
+        const response = await request(app).get("/disablepoe/123/");
+
+        expect(response.statusCode).toBe(200);
+        expect(response.body).toHaveProperty("status", "success");
+        expect(response.body).toHaveProperty("data");
+    });
 });

src/modules/cisco-sg/container/services/interface-poe.js

@@ -0,0 +1,66 @@
+"use strict";
+
+const SnmpAwait = require("@core/snmp-await");
+const configGet = require("@core/config-get");
+const mongoCollection = require("@core/mongo-collection");
+const deviceSetPending = require("@services/device-setpending");
+const logger = require("@core/logger")(module);
+
+module.exports = async (interfaceId, action) => {
+    let snmpAwait;
+
+    try {
+        if (!interfaceId) {
+            throw new Error("interfaceId is required");
+        }
+
+        if (!["enable", "disable"].includes(action)) {
+            throw new Error(`invalid action '${action}', must be 'enable' or 'disable'`);
+        }
+
+        const config = await configGet();
+        if (!config) {
+            throw new Error("failed to load config");
+        }
+
+        const actionText = action === "enable" ? "enabling" : "disabling";
+
+        snmpAwait = new SnmpAwait({
+            host: config.address,
+            community: config.snmpCommunity,
+        });
+
+        logger.info(`${actionText} POE on interface ${interfaceId} ...`);
+
+        await snmpAwait.set({
+            oid: `.1.3.6.1.2.1.105.1.1.1.3.1.${interfaceId}`,
+            value: action === "enable" ? 1 : 2,
+        });
+
+        logger.info("success - updating DB");
+
+        const interfacesCollection = await mongoCollection("interfaces");
+        const dbResult = await interfacesCollection.updateOne(
+            { interfaceId: Number(interfaceId) },
+            { $set: { "poe-admin-enable": action === "enable" } }
+        );
+
+        logger.info(`${JSON.stringify(dbResult.result)}`);
+
+        if (dbResult.matchedCount !== 1) {
+            throw new Error(`expected to update 1 interface in DB, matched ${dbResult.matchedCount}`);
+        }
+
+        await deviceSetPending(true);
+
+        logger.info("complete");
+    } catch (err) {
+        err.message = `${err.stack || err.message}`;
+        logger.error(err.message);
+        throw err;
+    } finally {
+        if (snmpAwait) {
+            snmpAwait.close();
+        }
+    }
+};

src/modules/cisco-sg/container/services/interface-poe.test.js

@@ -0,0 +1,28 @@
+const mockConfigGet = jest.fn();
+
+jest.mock("@core/config-get", () => mockConfigGet);
+jest.mock("@core/snmp-await", () => jest.fn().mockImplementation(() => ({ set: jest.fn(), close: jest.fn() })));
+jest.mock("@core/mongo-collection", () => jest.fn());
+jest.mock("@services/device-setpending", () => jest.fn());
+jest.mock("@core/logger", () => () => ({ info: jest.fn(), error: jest.fn() }));
+
+const interfacePoe = require("./interface-poe");
+
+describe("interface-poe", () => {
+    beforeEach(() => {
+        mockConfigGet.mockReset();
+    });
+
+    test("rejects when interfaceId is missing", async () => {
+        await expect(interfacePoe(null, "enable")).rejects.toThrow("interfaceId is required");
+    });
+
+    test("rejects when action is invalid", async () => {
+        await expect(interfacePoe(1, "bad")).rejects.toThrow("invalid action");
+    });
+
+    test("rejects when config is missing", async () => {
+        mockConfigGet.mockResolvedValue(null);
+        await expect(interfacePoe(1, "enable")).rejects.toThrow("failed to load config");
+    });
+});