@oneuptime/common 12.0.32 → 12.0.34

package/Models/DatabaseModels/NetworkDevice.ts

@@ -2,6 +2,7 @@ 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";
@@ -130,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.
@@ -699,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: [
@@ -814,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;
 
@@ -2370,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/NetworkSite.ts

@@ -1,6 +1,8 @@
 import AlertSeverity from "./AlertSeverity";
 import MonitorStatus from "./MonitorStatus";
 import NetworkSiteType from "./NetworkSiteType";
+import NetworkSnmpCredentialProfile from "./NetworkSnmpCredentialProfile";
+import Probe from "./Probe";
 import SiteHealthRollupPolicy, {
   DefaultSiteOfflineThresholdPercent,
 } from "../../Types/NetworkSite/SiteHealthRollupPolicy";
@@ -414,7 +416,13 @@ export default class NetworkSite extends BaseModel {
     {
       eager: false,
       nullable: true,
-      onDelete: "SET NULL",
+      /*
+       * NO ACTION still protects a type while any referencing site survives,
+       * but performs the check at the end of the statement. That distinction
+       * lets deleting a Project cascade through its Network Sites and Network
+       * Site Types together without the sibling cascades blocking each other.
+       */
+      onDelete: "NO ACTION",
       orphanedRowAction: "nullify",
     },
   )
@@ -464,6 +472,193 @@ export default class NetworkSite extends BaseModel {
   })
   public networkSiteTypeId?: ObjectID = undefined;
 
+  @ColumnAccessControl({
+    create: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.SettingsAdmin,
+      Permission.SettingsMember,
+      Permission.CreateNetworkSite,
+    ],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.Viewer,
+      Permission.SettingsAdmin,
+      Permission.SettingsMember,
+      Permission.SettingsViewer,
+      Permission.ReadNetworkSite,
+    ],
+    update: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.SettingsAdmin,
+      Permission.SettingsMember,
+      Permission.EditNetworkSite,
+    ],
+  })
+  @TableColumn({
+    manyToOneRelationColumn: "probeId",
+    type: TableColumnType.Entity,
+    modelType: Probe,
+    title: "Default Probe",
+    description:
+      "The probe that polls devices in this site unless a device names its own. A device created into this site with no probe inherits it, and so does a device moved into the site while it has none — which is what lets an operator register a device by name and address alone. It has to be able to reach the site's network, so it is usually a custom probe deployed there.",
+  })
+  @ManyToOne(
+    () => {
+      return Probe;
+    },
+    {
+      eager: false,
+      nullable: true,
+      onDelete: "SET NULL",
+      orphanedRowAction: "nullify",
+    },
+  )
+  @JoinColumn({ name: "probeId" })
+  public probe?: Probe = undefined;
+
+  @ColumnAccessControl({
+    create: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.SettingsAdmin,
+      Permission.SettingsMember,
+      Permission.CreateNetworkSite,
+    ],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.Viewer,
+      Permission.SettingsAdmin,
+      Permission.SettingsMember,
+      Permission.SettingsViewer,
+      Permission.ReadNetworkSite,
+    ],
+    update: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.SettingsAdmin,
+      Permission.SettingsMember,
+      Permission.EditNetworkSite,
+    ],
+  })
+  @Index()
+  @TableColumn({
+    type: TableColumnType.ObjectID,
+    required: false,
+    canReadOnRelationQuery: true,
+    title: "Default Probe ID",
+    description: "ID of the probe that polls devices in this site by default",
+  })
+  @Column({
+    type: ColumnType.ObjectID,
+    nullable: true,
+    transformer: ObjectID.getDatabaseTransformer(),
+  })
+  public probeId?: ObjectID = undefined;
+
+  @ColumnAccessControl({
+    create: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.SettingsAdmin,
+      Permission.SettingsMember,
+      Permission.CreateNetworkSite,
+    ],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.Viewer,
+      Permission.SettingsAdmin,
+      Permission.SettingsMember,
+      Permission.SettingsViewer,
+      Permission.ReadNetworkSite,
+    ],
+    update: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.SettingsAdmin,
+      Permission.SettingsMember,
+      Permission.EditNetworkSite,
+    ],
+  })
+  @TableColumn({
+    manyToOneRelationColumn: "snmpCredentialProfileId",
+    type: TableColumnType.Entity,
+    modelType: NetworkSnmpCredentialProfile,
+    title: "Default SNMP Credential Profile",
+    description:
+      "The SNMP credential set devices in this site are walked with when neither the device nor its own profile carries credentials. Set it once per site and every device registered there is walked over SNMP from its first poll; with no profile anywhere the device is pinged only.",
+  })
+  @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.CreateNetworkSite,
+    ],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.Viewer,
+      Permission.SettingsAdmin,
+      Permission.SettingsMember,
+      Permission.SettingsViewer,
+      Permission.ReadNetworkSite,
+    ],
+    update: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.SettingsAdmin,
+      Permission.SettingsMember,
+      Permission.EditNetworkSite,
+    ],
+  })
+  @Index()
+  @TableColumn({
+    type: TableColumnType.ObjectID,
+    required: false,
+    canReadOnRelationQuery: true,
+    title: "Default SNMP Credential Profile ID",
+    description:
+      "ID of the SNMP Credential Profile devices in this site inherit",
+  })
+  @Column({
+    type: ColumnType.ObjectID,
+    nullable: true,
+    transformer: ObjectID.getDatabaseTransformer(),
+  })
+  public snmpCredentialProfileId?: ObjectID = undefined;
+
   @ColumnAccessControl({
     create: [
       Permission.ProjectOwner,
@@ -507,7 +702,11 @@ export default class NetworkSite extends BaseModel {
     {
       eager: false,
       nullable: true,
-      onDelete: "SET NULL",
+      /*
+       * Checked at statement end so a single bulk delete may remove a whole
+       * subtree; surviving children are rejected by NetworkSiteService.
+       */
+      onDelete: "NO ACTION",
       orphanedRowAction: "nullify",
     },
   )

package/Models/DatabaseModels/NetworkSiteType.ts

@@ -65,11 +65,12 @@ import { Column, Entity, Index, JoinColumn, ManyToOne } from "typeorm";
   pluralName: "Network Site Types",
   icon: IconProp.Layers,
   tableDescription:
-    "Configure the levels of your network site hierarchy (Region, Market, Unit and so on). Rename them, reorder them, or add your own.",
+    "Configure the levels of your network site hierarchy (Region, Market, Unit and so on). Choose each type's parent, rename it, or add your own.",
 })
 @Entity({
   name: "NetworkSiteType",
 })
+@Index(["projectId", "parentNetworkSiteTypeId"])
 export default class NetworkSiteType extends BaseModel {
   @ColumnAccessControl({
     create: [
@@ -264,6 +265,105 @@ export default class NetworkSiteType extends BaseModel {
   })
   public description?: string = undefined;
 
+  @ColumnAccessControl({
+    create: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.SettingsAdmin,
+      Permission.SettingsMember,
+      Permission.CreateNetworkSiteType,
+    ],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.Viewer,
+      Permission.SettingsAdmin,
+      Permission.SettingsMember,
+      Permission.SettingsViewer,
+      Permission.ReadNetworkSiteType,
+    ],
+    update: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.SettingsAdmin,
+      Permission.SettingsMember,
+      Permission.EditNetworkSiteType,
+    ],
+  })
+  @TableColumn({
+    manyToOneRelationColumn: "parentNetworkSiteTypeId",
+    type: TableColumnType.Entity,
+    modelType: NetworkSiteType,
+    title: "Parent Site Type",
+    description:
+      "The Network Site Type directly above this type. Empty for top-level types.",
+  })
+  @ManyToOne(
+    () => {
+      return NetworkSiteType;
+    },
+    {
+      eager: false,
+      nullable: true,
+      /*
+       * NO ACTION is checked at the end of the delete statement, so deleting
+       * a complete parent/child set together is allowed while any surviving
+       * child still blocks the operation. RESTRICT can reject the former
+       * before the statement has removed its child rows.
+       */
+      onDelete: "NO ACTION",
+      orphanedRowAction: "nullify",
+    },
+  )
+  @JoinColumn({ name: "parentNetworkSiteTypeId" })
+  public parentNetworkSiteType?: NetworkSiteType = undefined;
+
+  @ColumnAccessControl({
+    create: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.SettingsAdmin,
+      Permission.SettingsMember,
+      Permission.CreateNetworkSiteType,
+    ],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.Viewer,
+      Permission.SettingsAdmin,
+      Permission.SettingsMember,
+      Permission.SettingsViewer,
+      Permission.ReadNetworkSiteType,
+    ],
+    update: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.SettingsAdmin,
+      Permission.SettingsMember,
+      Permission.EditNetworkSiteType,
+    ],
+  })
+  @TableColumn({
+    type: TableColumnType.ObjectID,
+    required: false,
+    canReadOnRelationQuery: true,
+    title: "Parent Site Type ID",
+    description:
+      "ID of the Network Site Type directly above this type. Empty for top-level types.",
+  })
+  @Column({
+    type: ColumnType.ObjectID,
+    nullable: true,
+    transformer: ObjectID.getDatabaseTransformer(),
+  })
+  public parentNetworkSiteTypeId?: ObjectID = undefined;
+
   @ColumnAccessControl({
     create: [
       Permission.ProjectOwner,
@@ -298,8 +398,7 @@ export default class NetworkSiteType extends BaseModel {
     type: TableColumnType.Number,
     canReadOnRelationQuery: true,
     title: "Order",
-    description:
-      "Where this type sits in the site hierarchy. Lower numbers are higher up: Region is 2 and Unit is 5, for example.",
+    description: "Display order among site types that have the same parent.",
     example: "5",
   })
   @Column({