@oneuptime/common 11.6.1 → 11.6.2

package/build/dist/Models/DatabaseModels/NetworkDevice.js

@@ -8,6 +8,8 @@ var __metadata = (this && this.__metadata) || function (k, v) {
     if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
 };
 import Label from "./Label";
+import MonitorStatus from "./MonitorStatus";
+import NetworkSite from "./NetworkSite";
 import Probe from "./Probe";
 import Project from "./Project";
 import User from "./User";
@@ -41,6 +43,10 @@ let NetworkDevice = class NetworkDevice extends BaseModel {
         this.hostname = undefined;
         this.probe = undefined;
         this.probeId = undefined;
+        this.site = undefined;
+        this.siteId = undefined;
+        this.currentMonitorStatus = undefined;
+        this.currentMonitorStatusId = undefined;
         this.snmpVersion = undefined;
         this.snmpCommunityString = undefined;
         this.snmpPort = undefined;
@@ -51,6 +57,20 @@ let NetworkDevice = class NetworkDevice extends BaseModel {
         this.snmpV3AuthKey = undefined;
         this.snmpV3PrivProtocol = undefined;
         this.snmpV3PrivKey = undefined;
+        /*
+         * --- Polling configuration ---
+         * The device owns its own polling: the assigned probe walks every
+         * polling-enabled device on this schedule, independent of any Monitor.
+         * Monitors reference the device only to alert on what these walks (and
+         * traps) report.
+         */
+        this.isPollingEnabled = undefined;
+        this.pollingIntervalInMinutes = undefined;
+        this.walkInterfaces = undefined;
+        this.collectEndpoints = undefined;
+        this.snmpOids = undefined;
+        this.nextPollAt = undefined;
+        this.lastWalkLog = undefined;
         this.sysDescr = undefined;
         this.sysName = undefined;
         this.sysObjectId = undefined;
@@ -410,6 +430,167 @@ __decorate([
     }),
     __metadata("design:type", ObjectID)
 ], NetworkDevice.prototype, "probeId", void 0);
+__decorate([
+    ColumnAccessControl({
+        create: [
+            Permission.ProjectOwner,
+            Permission.ProjectAdmin,
+            Permission.ProjectMember,
+            Permission.SettingsAdmin,
+            Permission.SettingsMember,
+            Permission.CreateNetworkDevice,
+        ],
+        read: [
+            Permission.ProjectOwner,
+            Permission.ProjectAdmin,
+            Permission.ProjectMember,
+            Permission.Viewer,
+            Permission.SettingsAdmin,
+            Permission.SettingsMember,
+            Permission.SettingsViewer,
+            Permission.ReadNetworkDevice,
+        ],
+        update: [
+            Permission.ProjectOwner,
+            Permission.ProjectAdmin,
+            Permission.ProjectMember,
+            Permission.SettingsAdmin,
+            Permission.SettingsMember,
+            Permission.EditNetworkDevice,
+        ],
+    }),
+    TableColumn({
+        manyToOneRelationColumn: "siteId",
+        type: TableColumnType.Entity,
+        modelType: NetworkSite,
+        title: "Network Site",
+        description: "Relation to the Network Site this network device belongs to",
+    }),
+    ManyToOne(() => {
+        return NetworkSite;
+    }, {
+        eager: false,
+        nullable: true,
+        onDelete: "SET NULL",
+        orphanedRowAction: "nullify",
+    }),
+    JoinColumn({ name: "siteId" }),
+    __metadata("design:type", NetworkSite)
+], NetworkDevice.prototype, "site", void 0);
+__decorate([
+    ColumnAccessControl({
+        create: [
+            Permission.ProjectOwner,
+            Permission.ProjectAdmin,
+            Permission.ProjectMember,
+            Permission.SettingsAdmin,
+            Permission.SettingsMember,
+            Permission.CreateNetworkDevice,
+        ],
+        read: [
+            Permission.ProjectOwner,
+            Permission.ProjectAdmin,
+            Permission.ProjectMember,
+            Permission.Viewer,
+            Permission.SettingsAdmin,
+            Permission.SettingsMember,
+            Permission.SettingsViewer,
+            Permission.ReadNetworkDevice,
+        ],
+        update: [
+            Permission.ProjectOwner,
+            Permission.ProjectAdmin,
+            Permission.ProjectMember,
+            Permission.SettingsAdmin,
+            Permission.SettingsMember,
+            Permission.EditNetworkDevice,
+        ],
+    }),
+    TableColumn({
+        type: TableColumnType.ObjectID,
+        required: false,
+        canReadOnRelationQuery: true,
+        title: "Network Site ID",
+        description: "ID of the Network Site this network device belongs to",
+    }),
+    Column({
+        type: ColumnType.ObjectID,
+        nullable: true,
+        transformer: ObjectID.getDatabaseTransformer(),
+    }),
+    __metadata("design:type", ObjectID)
+], NetworkDevice.prototype, "siteId", void 0);
+__decorate([
+    ColumnAccessControl({
+        create: [],
+        read: [
+            Permission.ProjectOwner,
+            Permission.ProjectAdmin,
+            Permission.ProjectMember,
+            Permission.Viewer,
+            Permission.SettingsAdmin,
+            Permission.SettingsMember,
+            Permission.SettingsViewer,
+            Permission.ReadNetworkDevice,
+        ],
+        update: [
+            Permission.ProjectOwner,
+            Permission.ProjectAdmin,
+            Permission.EditNetworkDevice,
+        ],
+    }),
+    TableColumn({
+        manyToOneRelationColumn: "currentMonitorStatusId",
+        type: TableColumnType.Entity,
+        modelType: MonitorStatus,
+        title: "Current Monitor Status",
+        description: "Whats the current status of this network device? Stamped from the monitor that polls it.",
+    }),
+    ManyToOne(() => {
+        return MonitorStatus;
+    }, {
+        eager: false,
+        nullable: true,
+        onDelete: "SET NULL",
+        orphanedRowAction: "nullify",
+    }),
+    JoinColumn({ name: "currentMonitorStatusId" }),
+    __metadata("design:type", MonitorStatus)
+], NetworkDevice.prototype, "currentMonitorStatus", void 0);
+__decorate([
+    ColumnAccessControl({
+        create: [],
+        read: [
+            Permission.ProjectOwner,
+            Permission.ProjectAdmin,
+            Permission.ProjectMember,
+            Permission.Viewer,
+            Permission.SettingsAdmin,
+            Permission.SettingsMember,
+            Permission.SettingsViewer,
+            Permission.ReadNetworkDevice,
+        ],
+        update: [
+            Permission.ProjectOwner,
+            Permission.ProjectAdmin,
+            Permission.EditNetworkDevice,
+        ],
+    }),
+    Index(),
+    TableColumn({
+        type: TableColumnType.ObjectID,
+        required: false,
+        canReadOnRelationQuery: true,
+        title: "Current Monitor Status ID",
+        description: "Whats the current status ID of this network device? Stamped from the monitor that polls it.",
+    }),
+    Column({
+        type: ColumnType.ObjectID,
+        nullable: true,
+        transformer: ObjectID.getDatabaseTransformer(),
+    }),
+    __metadata("design:type", ObjectID)
+], NetworkDevice.prototype, "currentMonitorStatusId", void 0);
 __decorate([
     ColumnAccessControl({
         create: [
@@ -469,10 +650,8 @@ __decorate([
             Permission.ProjectOwner,
             Permission.ProjectAdmin,
             Permission.ProjectMember,
-            Permission.Viewer,
             Permission.SettingsAdmin,
             Permission.SettingsMember,
-            Permission.SettingsViewer,
             Permission.ReadNetworkDevice,
         ],
         update: [
@@ -725,10 +904,8 @@ __decorate([
             Permission.ProjectOwner,
             Permission.ProjectAdmin,
             Permission.ProjectMember,
-            Permission.Viewer,
             Permission.SettingsAdmin,
             Permission.SettingsMember,
-            Permission.SettingsViewer,
             Permission.ReadNetworkDevice,
         ],
         update: [
@@ -809,10 +986,8 @@ __decorate([
             Permission.ProjectOwner,
             Permission.ProjectAdmin,
             Permission.ProjectMember,
-            Permission.Viewer,
             Permission.SettingsAdmin,
             Permission.SettingsMember,
-            Permission.SettingsViewer,
             Permission.ReadNetworkDevice,
         ],
         update: [
@@ -836,6 +1011,283 @@ __decorate([
     }),
     __metadata("design:type", String)
 ], NetworkDevice.prototype, "snmpV3PrivKey", void 0);
+__decorate([
+    ColumnAccessControl({
+        create: [
+            Permission.ProjectOwner,
+            Permission.ProjectAdmin,
+            Permission.ProjectMember,
+            Permission.SettingsAdmin,
+            Permission.SettingsMember,
+            Permission.CreateNetworkDevice,
+        ],
+        read: [
+            Permission.ProjectOwner,
+            Permission.ProjectAdmin,
+            Permission.ProjectMember,
+            Permission.Viewer,
+            Permission.SettingsAdmin,
+            Permission.SettingsMember,
+            Permission.SettingsViewer,
+            Permission.ReadNetworkDevice,
+        ],
+        update: [
+            Permission.ProjectOwner,
+            Permission.ProjectAdmin,
+            Permission.ProjectMember,
+            Permission.SettingsAdmin,
+            Permission.SettingsMember,
+            Permission.EditNetworkDevice,
+        ],
+    }),
+    TableColumn({
+        isDefaultValueColumn: true,
+        required: true,
+        type: TableColumnType.Boolean,
+        title: "Polling Enabled",
+        description: "Whether the assigned probe polls this device on a schedule. Disable to pause SNMP polling without deleting the device.",
+        defaultValue: true,
+    }),
+    Column({
+        type: ColumnType.Boolean,
+        nullable: false,
+        default: true,
+    }),
+    __metadata("design:type", Boolean)
+], NetworkDevice.prototype, "isPollingEnabled", void 0);
+__decorate([
+    ColumnAccessControl({
+        create: [
+            Permission.ProjectOwner,
+            Permission.ProjectAdmin,
+            Permission.ProjectMember,
+            Permission.SettingsAdmin,
+            Permission.SettingsMember,
+            Permission.CreateNetworkDevice,
+        ],
+        read: [
+            Permission.ProjectOwner,
+            Permission.ProjectAdmin,
+            Permission.ProjectMember,
+            Permission.Viewer,
+            Permission.SettingsAdmin,
+            Permission.SettingsMember,
+            Permission.SettingsViewer,
+            Permission.ReadNetworkDevice,
+        ],
+        update: [
+            Permission.ProjectOwner,
+            Permission.ProjectAdmin,
+            Permission.ProjectMember,
+            Permission.SettingsAdmin,
+            Permission.SettingsMember,
+            Permission.EditNetworkDevice,
+        ],
+    }),
+    TableColumn({
+        required: false,
+        type: TableColumnType.Number,
+        title: "Polling Interval (Minutes)",
+        description: "How often, in minutes, the assigned probe polls this device via SNMP",
+        example: "5",
+    }),
+    Column({
+        type: ColumnType.Number,
+        nullable: true,
+        default: 5,
+    }),
+    __metadata("design:type", Number)
+], NetworkDevice.prototype, "pollingIntervalInMinutes", void 0);
+__decorate([
+    ColumnAccessControl({
+        create: [
+            Permission.ProjectOwner,
+            Permission.ProjectAdmin,
+            Permission.ProjectMember,
+            Permission.SettingsAdmin,
+            Permission.SettingsMember,
+            Permission.CreateNetworkDevice,
+        ],
+        read: [
+            Permission.ProjectOwner,
+            Permission.ProjectAdmin,
+            Permission.ProjectMember,
+            Permission.Viewer,
+            Permission.SettingsAdmin,
+            Permission.SettingsMember,
+            Permission.SettingsViewer,
+            Permission.ReadNetworkDevice,
+        ],
+        update: [
+            Permission.ProjectOwner,
+            Permission.ProjectAdmin,
+            Permission.ProjectMember,
+            Permission.SettingsAdmin,
+            Permission.SettingsMember,
+            Permission.EditNetworkDevice,
+        ],
+    }),
+    TableColumn({
+        isDefaultValueColumn: true,
+        required: true,
+        type: TableColumnType.Boolean,
+        title: "Walk Interfaces",
+        description: "Walk the IF-MIB interface tables on each poll to inventory interfaces, bandwidth, and errors. Also collects LLDP/CDP neighbors for the topology graph.",
+        defaultValue: true,
+    }),
+    Column({
+        type: ColumnType.Boolean,
+        nullable: false,
+        default: true,
+    }),
+    __metadata("design:type", Boolean)
+], NetworkDevice.prototype, "walkInterfaces", void 0);
+__decorate([
+    ColumnAccessControl({
+        create: [
+            Permission.ProjectOwner,
+            Permission.ProjectAdmin,
+            Permission.ProjectMember,
+            Permission.SettingsAdmin,
+            Permission.SettingsMember,
+            Permission.CreateNetworkDevice,
+        ],
+        read: [
+            Permission.ProjectOwner,
+            Permission.ProjectAdmin,
+            Permission.ProjectMember,
+            Permission.Viewer,
+            Permission.SettingsAdmin,
+            Permission.SettingsMember,
+            Permission.SettingsViewer,
+            Permission.ReadNetworkDevice,
+        ],
+        update: [
+            Permission.ProjectOwner,
+            Permission.ProjectAdmin,
+            Permission.ProjectMember,
+            Permission.SettingsAdmin,
+            Permission.SettingsMember,
+            Permission.EditNetworkDevice,
+        ],
+    }),
+    TableColumn({
+        isDefaultValueColumn: true,
+        required: true,
+        type: TableColumnType.Boolean,
+        title: "Collect Connected Endpoints",
+        description: "Also walk the device's ARP cache and bridge forwarding database on each poll to discover endpoints (laptops, printers, POS terminals) attached to it. Strictly opt-in: costs extra SNMP table walks per poll. Only meaningful when Walk Interfaces is on.",
+        defaultValue: false,
+    }),
+    Column({
+        type: ColumnType.Boolean,
+        nullable: false,
+        default: false,
+    }),
+    __metadata("design:type", Boolean)
+], NetworkDevice.prototype, "collectEndpoints", void 0);
+__decorate([
+    ColumnAccessControl({
+        create: [
+            Permission.ProjectOwner,
+            Permission.ProjectAdmin,
+            Permission.ProjectMember,
+            Permission.SettingsAdmin,
+            Permission.SettingsMember,
+            Permission.CreateNetworkDevice,
+        ],
+        read: [
+            Permission.ProjectOwner,
+            Permission.ProjectAdmin,
+            Permission.ProjectMember,
+            Permission.Viewer,
+            Permission.SettingsAdmin,
+            Permission.SettingsMember,
+            Permission.SettingsViewer,
+            Permission.ReadNetworkDevice,
+        ],
+        update: [
+            Permission.ProjectOwner,
+            Permission.ProjectAdmin,
+            Permission.ProjectMember,
+            Permission.SettingsAdmin,
+            Permission.SettingsMember,
+            Permission.EditNetworkDevice,
+        ],
+    }),
+    TableColumn({
+        type: TableColumnType.JSON,
+        required: false,
+        title: "Health OIDs",
+        description: "SNMP OIDs (CPU, memory, temperature, or any custom OID) collected on each poll. Values are recorded as metrics and can be alerted on through monitor criteria.",
+    }),
+    Column({
+        type: ColumnType.JSON,
+        nullable: true,
+    }),
+    __metadata("design:type", Array)
+], NetworkDevice.prototype, "snmpOids", void 0);
+__decorate([
+    ColumnAccessControl({
+        create: [],
+        read: [
+            Permission.ProjectOwner,
+            Permission.ProjectAdmin,
+            Permission.ProjectMember,
+            Permission.Viewer,
+            Permission.SettingsAdmin,
+            Permission.SettingsMember,
+            Permission.SettingsViewer,
+            Permission.ReadNetworkDevice,
+        ],
+        /*
+         * Editable so the dashboard can offer "Poll Now" — setting this to the
+         * current time makes the assigned probe pick the device up on its next
+         * claim cycle.
+         */
+        update: [
+            Permission.ProjectOwner,
+            Permission.ProjectAdmin,
+            Permission.EditNetworkDevice,
+        ],
+    }),
+    TableColumn({
+        required: false,
+        type: TableColumnType.Date,
+        title: "Next Poll At",
+        description: "When the assigned probe should next poll this device. Advanced by the claim cycle; NULL means poll as soon as possible.",
+    }),
+    Column({
+        nullable: true,
+        type: ColumnType.Date,
+    }),
+    __metadata("design:type", Date)
+], NetworkDevice.prototype, "nextPollAt", void 0);
+__decorate([
+    ColumnAccessControl({
+        create: [],
+        read: [
+            Permission.ProjectOwner,
+            Permission.ProjectAdmin,
+            Permission.ProjectMember,
+            Permission.SettingsAdmin,
+            Permission.SettingsMember,
+            Permission.ReadNetworkDevice,
+        ],
+        update: [],
+    }),
+    TableColumn({
+        type: TableColumnType.JSON,
+        required: false,
+        title: "Last Walk Log",
+        description: "The previous poll's raw walk response. Kept so interface rates (bandwidth, utilization, errors/sec) can be computed as counter deltas between polls. Managed by the server.",
+    }),
+    Column({
+        type: ColumnType.JSON,
+        nullable: true,
+    }),
+    __metadata("design:type", Object)
+], NetworkDevice.prototype, "lastWalkLog", void 0);
 __decorate([
     ColumnAccessControl({
         create: [],