OpenNMS.js - v2.6.2-SNAPSHOT
    Preparing search index...

    Class OnmsSnmpInterface

    Represents an OpenNMS SNMP interface.

    Implements

    Index

    Constructors

    Properties

    collect?: OnmsCollectType

    whether the SNMP interface will be collected

    id?: number

    the interface ID

    ifAdminStatus?: OnmsSnmpStatusType

    the administrative status of the interface

    ifAlias?: string

    the alias of the interface

    ifDescr?: string

    the description of the interface

    ifIndex?: number

    the SNMP interface index

    ifName?: string

    the name of the interface

    ifOperStatus?: OnmsSnmpStatusType

    the operator status of the interface

    ifSpeed?: number

    the speed of the interface

    ifType?: number

    the type of interface

    lastCapsdPoll?: Moment

    the last time the SNMP interface was provisioned

    lastSnmpPoll?: Moment

    the last time the SNMP interface was polled

    node?: any

    the node associated with this interface

    nodeId?: number

    The node associated to this snmpInterface

    physAddr?: PhysAddr

    the physical (MAC) address of the interface

    poll?: boolean

    whether the interface is set to poll

    Accessors

    Methods

    • Parameters

      • pattern: string | RegExp
      • replaceWith: string

      Returns string

    • convert to JSON object

      Returns {
          collect: {
              id: string;
              label: string;
              replace: (pattern: string | RegExp, replaceWith: string) => string;
          };
          id: number;
          ifAdminStatus: {
              id: number;
              label: string;
              replace: (pattern: string | RegExp, replaceWith: string) => string;
          };
          ifAlias: string;
          ifDescr: string;
          ifIndex: number;
          ifName: string;
          ifOperStatus: {
              id: number;
              label: string;
              replace: (pattern: string | RegExp, replaceWith: string) => string;
          };
          ifSpeed: number;
          ifType: number;
          lastCapsdPoll: number;
          lastSnmpPoll: string;
          nodeId: number;
          physAddr: string;
          poll: boolean;
          replace: (pattern: string | RegExp, replaceWith: string) => string;
      }