@oneuptime/common 12.0.31 → 12.0.33

package/Models/DatabaseModels/NetworkDevice.ts

@@ -2,6 +2,8 @@ import Label from "./Label";
 import Monitor from "./Monitor";
 import MonitorStatus from "./MonitorStatus";
 import NetworkDeviceOidTemplate from "./NetworkDeviceOidTemplate";
+import NetworkSnmpCredentialProfile from "./NetworkSnmpCredentialProfile";
+import NetworkDeviceRole from "./NetworkDeviceRole";
 import NetworkSite from "./NetworkSite";
 import Probe from "./Probe";
 import Project from "./Project";
@@ -129,6 +131,19 @@ import {
  * This is the same shape siteId gets above, and deliberately so.
  */
 @Index(["projectId", "oidTemplateId"])
+/*
+ * "Which devices use this SNMP Credential Profile?" - the count the profile
+ * delete guard refuses on (NetworkSnmpCredentialProfileService.onBeforeDelete),
+ * the Credentials column's filter on the device list, and the FK's own
+ * ON DELETE SET NULL scan.
+ *
+ * Project-prefixed and composite for the reason written at the top of this
+ * block, and the reason the oidTemplateId index above is: a bare column
+ * index on a nullable FK is one btree entry per row of the product's hottest
+ * table, paid on every poll, to serve queries that all carry a projectId
+ * anyway.
+ */
+@Index(["projectId", "snmpCredentialProfileId"])
 /*
  * The other half of the Overview's attention list: reachable devices with the
  * most dark ports.
@@ -698,6 +713,103 @@ export default class NetworkDevice extends BaseModel {
   })
   public oidTemplateId?: ObjectID = undefined;
 
+  @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: "snmpCredentialProfileId",
+    type: TableColumnType.Entity,
+    modelType: NetworkSnmpCredentialProfile,
+    title: "SNMP Credential Profile",
+    description:
+      "The reusable SNMP credential set this device is walked with when it carries no credentials of its own. Resolution at poll time: the device's own credentials, then this profile, then the profile on the device's site; with none of the three the device is pinged only. The link is live: editing the profile changes the next poll of every device using it.",
+  })
+  @ManyToOne(
+    () => {
+      return NetworkSnmpCredentialProfile;
+    },
+    {
+      eager: false,
+      nullable: true,
+      onDelete: "SET NULL",
+      orphanedRowAction: "nullify",
+    },
+  )
+  @JoinColumn({ name: "snmpCredentialProfileId" })
+  public snmpCredentialProfile?: NetworkSnmpCredentialProfile = undefined;
+
+  @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,
+    ],
+  })
+  /*
+   * No bare @Index() here on purpose: the composite
+   * (projectId, snmpCredentialProfileId) declared on the class serves every
+   * query that reads this column, and all of them carry a projectId.
+   */
+  @TableColumn({
+    type: TableColumnType.ObjectID,
+    required: false,
+    canReadOnRelationQuery: true,
+    title: "SNMP Credential Profile ID",
+    description: "ID of the SNMP Credential Profile this device is walked with",
+  })
+  @Column({
+    type: ColumnType.ObjectID,
+    nullable: true,
+    transformer: ObjectID.getDatabaseTransformer(),
+  })
+  public snmpCredentialProfileId?: ObjectID = undefined;
+
   @ColumnAccessControl({
     create: [],
     read: [
@@ -813,7 +925,7 @@ export default class NetworkDevice extends BaseModel {
     nullable: true,
     type: ColumnType.ShortText,
     length: ColumnLength.ShortText,
-    default: NetworkDeviceMonitoringMethod.Snmp,
+    default: NetworkDeviceMonitoringMethod.Probe,
   })
   public monitoringMethod?: string = undefined;
 
@@ -845,13 +957,22 @@ export default class NetworkDevice extends BaseModel {
       Permission.EditNetworkDevice,
     ],
   })
+  /*
+   * DEPRECATED. Device roles used to be a fixed union stored inline as a
+   * string; they are now the per-project NetworkDeviceRole lookup table
+   * below, so a project can rename them, change what each is drawn as, or add
+   * roles of its own. This column is retained ONLY so the
+   * BackfillNetworkDeviceRoles data migration can read the old value and
+   * point networkDeviceRoleId at the matching role row. It is dropped in a
+   * follow-up PR - do not read or write it from new code.
+   */
   @TableColumn({
     required: false,
     type: TableColumnType.ShortText,
     canReadOnRelationQuery: true,
-    title: "Device Role",
+    title: "Device Role (Deprecated)",
     description:
-      "What this device does on the network — router, switch, access point and so on. Left empty, the role is worked out from the device's own SNMP identity. Set it when there is no SNMP to read: a ping-only device has no identity to classify, and the role decides both the shape it is drawn with and where it sits in the topology hierarchy.",
+      "Deprecated legacy device role key. Use the Network Device Role relation instead; this column exists only for the backfill migration and will be removed.",
     example: "switch",
   })
   @Column({
@@ -861,6 +982,115 @@ export default class NetworkDevice extends BaseModel {
   })
   public deviceRole?: string = undefined;
 
+  @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,
+    ],
+  })
+  /*
+   * The operator's own answer to what this device is, when they gave one.
+   *
+   * Empty is not "unknown": it means "no answer given", and the SNMP
+   * classifier is left to work the role out from the device's own identity.
+   * That is the better source when there IS an identity to read, which is
+   * why this is left empty on SNMP devices by default. On a device nothing
+   * walks - a ping-only device, a monitor-backed one - the classifier has
+   * only a hostname to go on, so this is the only statement about the role
+   * available at all, and it decides both the shape the device is drawn with
+   * and where it sits in the topology hierarchy.
+   *
+   * SET NULL on delete, deliberately: removing a role from the project's
+   * settings must not remove the devices that were using it. They simply go
+   * back to being classified from their SNMP identity.
+   */
+  @TableColumn({
+    manyToOneRelationColumn: "networkDeviceRoleId",
+    type: TableColumnType.Entity,
+    modelType: NetworkDeviceRole,
+    title: "Device Role",
+    description:
+      "What this device does on the network - Router, Switch, Wireless AP and so on. Configured per project in Network > Settings > Device Roles.",
+  })
+  @ManyToOne(
+    () => {
+      return NetworkDeviceRole;
+    },
+    {
+      eager: false,
+      nullable: true,
+      onDelete: "SET NULL",
+      orphanedRowAction: "nullify",
+    },
+  )
+  @JoinColumn({ name: "networkDeviceRoleId" })
+  public networkDeviceRole?: NetworkDeviceRole = undefined;
+
+  @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,
+    ],
+  })
+  @Index()
+  @TableColumn({
+    required: false,
+    type: TableColumnType.ObjectID,
+    canReadOnRelationQuery: true,
+    title: "Device Role ID",
+    description: "ID of the Network Device Role this device is assigned.",
+  })
+  @Column({
+    type: ColumnType.ObjectID,
+    nullable: true,
+    transformer: ObjectID.getDatabaseTransformer(),
+  })
+  public networkDeviceRoleId?: ObjectID = undefined;
+
   @ColumnAccessControl({
     create: [
       Permission.ProjectOwner,
@@ -2251,6 +2481,70 @@ export default class NetworkDevice extends BaseModel {
   })
   public isReachable?: boolean = undefined;
 
+  @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({
+    required: false,
+    type: TableColumnType.Boolean,
+    canReadOnRelationQuery: true,
+    title: "Is SNMP Reachable",
+    description:
+      "Whether the most recent SNMP walk of this device succeeded. Separate from isReachable, which is the ping verdict: a device that answers ping but not SNMP is Up with a failing SNMP walk, which almost always means wrong credentials or SNMP disabled on the device. NULL means no walk was attempted — the device has no usable SNMP credentials (it is pinged only) or has never been polled. Managed by the probe.",
+  })
+  @Column({
+    nullable: true,
+    type: ColumnType.Boolean,
+  })
+  public isSnmpReachable?: boolean = undefined;
+
+  @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({
+    required: false,
+    type: TableColumnType.Date,
+    canReadOnRelationQuery: true,
+    title: "Last SNMP Seen At",
+    description:
+      "When the last SUCCESSFUL SNMP walk of this device completed — the moment its interfaces, inventory and health OIDs were last refreshed. Only moves on a successful walk, so it stays honest while lastSeenAt keeps moving on ping alone. Managed by the probe.",
+  })
+  @Column({
+    nullable: true,
+    type: ColumnType.Date,
+  })
+  public lastSnmpSeenAt?: Date = undefined;
+
   @ColumnAccessControl({
     create: [],
     read: [

package/Models/DatabaseModels/NetworkDeviceOidTemplate.ts

@@ -37,7 +37,9 @@ import { Column, Entity, Index, JoinColumn, ManyToOne } from "typeorm";
  *
  * The template's NAME is the device type. There is no NetworkDeviceType
  * model and every candidate matching key was defective: labels double as the
- * row-level ACL column, deviceRole is unconstrained free text, and
+ * row-level ACL column, deviceRole was unconstrained free text (it is
+ * the NetworkDeviceRole lookup now, but a role says what a device DOES, not
+ * which OIDs it answers), and
  * vendor/sysObjectId are probe-managed and NULL until the first successful
  * walk. Devices link by an explicit FK the operator sets, in bulk from the
  * device list.