Netskope Help

The following settings need to be configured before an appliance can start responding to SNMP queries.

Configure the SNMP agent so that the appliance responds to SNMP queries from the SNMP manager. Run these commands:

set snmp agent enable true
set snmp agent syscontact <email address>
set snmp agent syslocation <location>

To poll the appliance using v2c queries, run:

set snmp agent v2c rocommunity-string <string value>
add snmp agent v2c allowed-network-list
set snmp agent v2c allowed-network-list 0 network <IP address of the SNMP agent>
save

To poll the appliance using v3 queries, run:

set snmp agent v3 engine-id <engine-id>
set snmp agent v3 usm auth username <username> key <passphrase> protocol [MD5|SHA]
set snmp agent v3 usm privacy protocol [AES|DES] key <passphrase>
save

The command descriptions are: 

Configure SNMP traps on the appliance to send trap notifications to the SNMP trap receiver. Run these commands:

set snmp traps server <hostname or IP address>

To send SNMP v2c traps to the trap receiver, run:

set snmp traps v2c enable true
save

To send SNMP v3 traps to the trap receiver, run:

set snmp traps v3 enable true 
set snmp traps v3 use-agent-settings [true|false]
set snmp traps v3 engine-id <engine-id>
set snmp traps v3 usm auth username <username> key <passphrase> protocol [MD5|SHA]
set snmp traps v3 usm privacy protocol [AES|DES] key <passphrase>
save

The command descriptions are:

These are the standard OIDs.

The official Private Enterprise Number (PEN) assigned to Netskope from IANA (http://www.iana.org/ assignments/enterprise-numbers) is 48007.

Here's the Netskope MIB file:

NETSKOPE-APPLIANCE-MIB DEFINITIONS ::= BEGIN

IMPORTS
        OBJECT-TYPE, NOTIFICATION-TYPE, enterprises, MODULE-IDENTITY
                    FROM SNMPv2-SMI
        NOTIFICATION-GROUP, OBJECT-GROUP, MODULE-COMPLIANCE
                    FROM SNMPv2-CONF
;

netskopeApplianceMIB MODULE-IDENTITY
    LAST-UPDATED "202301131558Z"
    ORGANIZATION "Netskope"
    CONTACT-INFO "nauman@netskope.com"
    DESCRIPTION "Netskope Custom OIDs"
    REVISION "202301131558Z"
    DESCRIPTION "Deleted eventflowNotification"
    REVISION "202212291713Z"
    DESCRIPTION "Added deviceAutoUpgradeStatusNotification"
    REVISION "202212051713Z"
    DESCRIPTION "Deprecated storageKafkaBrokerNotification, storageMysqlNotification, and storageMongoEventNotification"
    REVISION "202106031737Z"
    DESCRIPTION "Restructured NETSKOPE APPLIANCE MIB to include objects as traps"
    REVISION "200006140000Z"
    DESCRIPTION "MIB file to represent state of Netskope Appliance"
    ::= {netskopeAppliance 6}

netskopeAppliance   OBJECT IDENTIFIER ::= {enterprises 48007}
netskopeApplianceMIBNotifs  OBJECT IDENTIFIER ::= {netskopeApplianceMIB 0}
netskopeApplianceMIBNotifsGroups OBJECT IDENTIFIER ::= {netskopeApplianceMIB 1}
netskopeApplianceMIBObjects OBJECT IDENTIFIER ::= {netskopeApplianceMIB 2}
netskopeApplianceMIBGroups OBJECT IDENTIFIER ::= {netskopeApplianceMIB 3}

-- [= = = Administrative/Conformance = = =]
netskopeApplianceMIBConformance OBJECT IDENTIFIER ::= {netskopeApplianceMIB 4}

-- [= = = OIDs section = = =]

enabledServices OBJECT-TYPE
    SYNTAX OCTET STRING (SIZE(0..1024))
    MAX-ACCESS read-only
    STATUS current
    DESCRIPTION "Description of the modes the appliance is running in.
                 Example: [DNS-Proxy,OPLP]"
    ::= {netskopeApplianceMIBObjects 1}

dataplaneStatus OBJECT-TYPE
    SYNTAX INTEGER { up(1), down(2), unknown(3) }
    MAX-ACCESS read-only
    STATUS current
    DESCRIPTION "Status of dataplane if applicable"
    ::= {netskopeApplianceMIBObjects 2}

managementplaneStatus OBJECT-TYPE
    SYNTAX INTEGER { up(1), down(2), onbox(3), unknown(4) }
    MAX-ACCESS read-only
    STATUS current
    DESCRIPTION "Status of the appliance connection to MP.
                 Returns 2 if the box itself is the Management Plane."
    ::= {netskopeApplianceMIBObjects 3}

lastConnectedToMP OBJECT-TYPE
    SYNTAX OCTET STRING (SIZE(0..256))
    MAX-ACCESS read-only
    STATUS current
    DESCRIPTION "Timestamp when connection was made to MP last time.
                 Example: Sun, 26 Jun 2016 20:13:16"
    ::= {netskopeApplianceMIBObjects 4}

deviceStatus OBJECT-TYPE
    SYNTAX INTEGER { good(1), bad(2), unknown(3) }
    MAX-ACCESS read-only
    STATUS current
    DESCRIPTION "Status of the appliance as seen by the MP."
    ::= {netskopeApplianceMIBObjects 5}

-- [= = = Grouping OIDs = = =]

netskopeApplianceGroup OBJECT-GROUP
    OBJECTS {
                enabledServices,
                dataplaneStatus,
                managementplaneStatus,
                lastConnectedToMP,
                deviceStatus
            }
    STATUS current
    DESCRIPTION "Group of Netskope Appliance OIDs"
    ::= {netskopeApplianceMIBGroups 1}

-- [= = = Traps/Notifications section = = =]

mpConnectionNotification NOTIFICATION-TYPE
    OBJECTS { mpConnectionNotif }
    STATUS current
    DESCRIPTION "varbinds for mp connection notification"
    ::= {netskopeApplianceMIB 1}

deviceStatusNotification NOTIFICATION-TYPE
    OBJECTS { deviceStatusNotif }
    STATUS current
    DESCRIPTION "varbinds for device status notification"
    ::= {netskopeApplianceMIB 2}

deviceRebootNotification NOTIFICATION-TYPE
    OBJECTS { deviceRebootNotif }
    STATUS current
    DESCRIPTION "varbinds for device reboot notification"
    ::= {netskopeApplianceMIB 3}

storageRootNotification NOTIFICATION-TYPE
    OBJECTS { storageRootNotif }
    STATUS current
    DESCRIPTION "varbinds for storage root notification"
    ::= {netskopeApplianceMIB 4}

storageMongoInfraNotification NOTIFICATION-TYPE
    OBJECTS { storageMongoInfraNotif }
    STATUS current
    DESCRIPTION "varbinds for storage mongo infra notification"
    ::= {netskopeApplianceMIB 5}

storageLogNotification NOTIFICATION-TYPE
    OBJECTS { storageLogNotif }
    STATUS current
    DESCRIPTION "varbinds for storage log notification"
    ::= {netskopeApplianceMIB 6}

cfgagentConnectionNotification NOTIFICATION-TYPE
    OBJECTS { cfgagentConnectionNotif }
    STATUS current
    DESCRIPTION "varbinds for cfgaent connection notification"
    ::= {netskopeApplianceMIB 10}

filesNotUploaded24hNotification NOTIFICATION-TYPE
    OBJECTS { filesNotUploaded24hNotif }
    STATUS current
    DESCRIPTION "varbinds for filesNotUploaded24h notification"
    ::= {netskopeApplianceMIB 12}

filesNotUploaded48hNotification NOTIFICATION-TYPE
    OBJECTS { filesNotUploaded48hNotif }
    STATUS current
    DESCRIPTION "varbinds for filesNotUploaded48h notification"
    ::= {netskopeApplianceMIB 13}

filesNotPicked24hNotification NOTIFICATION-TYPE
    OBJECTS { filesNotPicked24hNotif }
    STATUS current
    DESCRIPTION "varbinds for filesNotPicked24h notification"
    ::= {netskopeApplianceMIB 14}

filesNotPicked48hNotification NOTIFICATION-TYPE
    OBJECTS { filesNotPicked48hNotif }
    STATUS current
    DESCRIPTION "varbinds for filesNotPicked24h notification"
    ::= {netskopeApplianceMIB 15}

threatfeedAgeNotification NOTIFICATION-TYPE
    OBJECTS { threatfeedAgeNotif }
    STATUS current
    DESCRIPTION "varbinds for threatfeed age notification"
    ::= {netskopeApplianceMIB 16}

authProxyStatusNotification NOTIFICATION-TYPE
    OBJECTS { authProxyStatusNotif }
    STATUS current
    DESCRIPTION "varbinds for authproxy status notification"
    ::= {netskopeApplianceMIB 17}

noEventsFromDeviceNotification NOTIFICATION-TYPE
    OBJECTS { noEventsFromDeviceNotif }
    STATUS current
    DESCRIPTION "varbinds for no events from device notification"
    ::= {netskopeApplianceMIB 18}

noMetricsFromDeviceNotification NOTIFICATION-TYPE
    OBJECTS { noMetricsFromDeviceNotif }
    STATUS current
    DESCRIPTION "varbinds for no metrics from device notification"
    ::= {netskopeApplianceMIB 19}

storageSecureStoreNotification NOTIFICATION-TYPE
    OBJECTS { storageSecureStoreNotif }
    STATUS current
    DESCRIPTION "varbinds for storage secure store notification"
    ::= {netskopeApplianceMIB 20}

storageUpgradeNotification NOTIFICATION-TYPE
    OBJECTS { storageUpgradeNotif }
    STATUS current
    DESCRIPTION "varbinds for storage upgrade notification"
    ::= {netskopeApplianceMIB 21}

callhomeConnectivityNotification NOTIFICATION-TYPE
    OBJECTS { callhomeConnectivityNotif }
    STATUS current
    DESCRIPTION "varbinds for callhome connectivity notification"
    ::= {netskopeApplianceMIB 22}

downloaderConnectivityNotification NOTIFICATION-TYPE
    OBJECTS { downloaderConnectivityNotif }
    STATUS current
    DESCRIPTION "varbinds for downloader connectivity notification"
    ::= {netskopeApplianceMIB 23}

configsvcConnectivityNotification NOTIFICATION-TYPE
    OBJECTS { configsvcConnectivityNotif }
    STATUS current
    DESCRIPTION "varbinds for config service connectivity notification"
    ::= {netskopeApplianceMIB 24}

uploadConnectivityNotification NOTIFICATION-TYPE
    OBJECTS { uploadConnectivityNotif }
    STATUS current
    DESCRIPTION "varbinds for upload connectivity notification"
    ::= {netskopeApplianceMIB 25}

loguploadConnectivityNotification NOTIFICATION-TYPE
    OBJECTS { loguploadConnectivityNotif }
    STATUS current
    DESCRIPTION "varbinds for logupload connectivity notification"
    ::= {netskopeApplianceMIB 26}

deviceAutoUpgradeStatusNotification NOTIFICATION-TYPE
    OBJECTS { deviceAutoUpgradeStatusNotif }
    STATUS current
    DESCRIPTION "varbinds for device auto upgrade status notification"
    ::= {netskopeApplianceMIB 27}

mpConnectionNotif OBJECT-TYPE
    SYNTAX OCTET STRING
    MAX-ACCESS accessible-for-notify
    STATUS current
    DESCRIPTION "MP Connection State Notification
                1 = Connected
                2 = Disconnected
                3 = The device itself is MP
                4 = Unknown"
    ::= {netskopeApplianceMIBNotifs 1}

deviceStatusNotif OBJECT-TYPE
    SYNTAX OCTET STRING
    MAX-ACCESS accessible-for-notify
    STATUS current
    DESCRIPTION "Device State Change Notification
                1 = Healthy
                2 = Unhealthy: one or more services/functionality may be affected
                3 = Unknown"
    ::= {netskopeApplianceMIBNotifs 2}

deviceRebootNotif OBJECT-TYPE
    SYNTAX OCTET STRING
    MAX-ACCESS accessible-for-notify
    STATUS current
    DESCRIPTION "Device Rebooted Notification
                 1 = Device rebooted"
    ::= {netskopeApplianceMIBNotifs 3}

storageRootNotif OBJECT-TYPE
    SYNTAX OCTET STRING
    MAX-ACCESS accessible-for-notify
    STATUS current
    DESCRIPTION "Root partition usage Notification.
                 1 = Normal
                 2 = Medium
                 3 = High"
    ::= {netskopeApplianceMIBNotifs 4}

storageMongoInfraNotif OBJECT-TYPE
    SYNTAX OCTET STRING
    MAX-ACCESS accessible-for-notify
    STATUS current
    DESCRIPTION "Mongo Infrastructure partition usage Notification.
                1 = Normal
                2 = Medium
                3 = High"
    ::= {netskopeApplianceMIBNotifs 6}

storageLogNotif OBJECT-TYPE
    SYNTAX OCTET STRING
    MAX-ACCESS accessible-for-notify
    STATUS current
    DESCRIPTION "Log processor partition usage Notification.
                1 = Normal
                2 = Medium
                3 = High"
    ::= {netskopeApplianceMIBNotifs 7}

cfgagentConnectionNotif OBJECT-TYPE
    SYNTAX OCTET STRING
    MAX-ACCESS accessible-for-notify
    STATUS current
    DESCRIPTION "Config agent connection status Notification.
                1 = Connection restored"
    ::= {netskopeApplianceMIBNotifs 12}

filesNotUploaded24hNotif OBJECT-TYPE
    SYNTAX OCTET STRING
    MAX-ACCESS accessible-for-notify
    STATUS current
    DESCRIPTION "File upload status Notification.
                1 = Success
                2 = At least 5 files not uploaded within last 24 hours"
    ::= {netskopeApplianceMIBNotifs 15}

filesNotUploaded48hNotif OBJECT-TYPE
    SYNTAX OCTET STRING
    MAX-ACCESS accessible-for-notify
    STATUS current
    DESCRIPTION "File upload status Notification.
                1 = Success
                2 = At least 5 files not uploaded within last 48 hours"
    ::= {netskopeApplianceMIBNotifs 16}

filesNotPicked24hNotif OBJECT-TYPE
    SYNTAX OCTET STRING
    MAX-ACCESS accessible-for-notify
    STATUS current
    DESCRIPTION "File picked status Notification.
                1 = Success
                2 = At least 1 file not uploaded within last 24 hours"
    ::= {netskopeApplianceMIBNotifs 17}

filesNotPicked48hNotif OBJECT-TYPE
    SYNTAX OCTET STRING
    MAX-ACCESS accessible-for-notify
    STATUS current
    DESCRIPTION "File picked status Notification.
                1 = Success
                2 = At least 1 files not uploaded within last 48 hours"
    ::= {netskopeApplianceMIBNotifs 18}

threatfeedAgeNotif OBJECT-TYPE
    SYNTAX OCTET STRING
    MAX-ACCESS accessible-for-notify
    STATUS current
    DESCRIPTION "Threatfeed age status Notification.
                1 = Up to date
                2 = Outdated"
    ::= {netskopeApplianceMIBNotifs 23}

authProxyStatusNotif OBJECT-TYPE
    SYNTAX OCTET STRING
    MAX-ACCESS accessible-for-notify
    STATUS current
    DESCRIPTION "Auth Proxy status Notification.
                1 = Running
                2 = Not running"
    ::= {netskopeApplianceMIBNotifs 24}

noEventsFromDeviceNotif OBJECT-TYPE
    SYNTAX OCTET STRING
    MAX-ACCESS accessible-for-notify
    STATUS current
    DESCRIPTION "Event generation status Notification.
                1 = Events from device are being successfully sent
                2 = Events from device not received during last 24 hrs"
    ::= {netskopeApplianceMIBNotifs 25}

noMetricsFromDeviceNotif OBJECT-TYPE
    SYNTAX OCTET STRING
    MAX-ACCESS accessible-for-notify
    STATUS current
    DESCRIPTION "Metrics generation status Notification.
                1 = Metrics from device are being successfully sent
                2 = Metrics from device are not received during last 6 hrs"
    ::= {netskopeApplianceMIBNotifs 26}

storageSecureStoreNotif OBJECT-TYPE
    SYNTAX OCTET STRING
    MAX-ACCESS accessible-for-notify
    STATUS current
    DESCRIPTION "SecureStore partition usage Notification.
                1 = Normal
                2 = Medium
                3 = High"
    ::= {netskopeApplianceMIBNotifs 27}

storageUpgradeNotif OBJECT-TYPE
    SYNTAX OCTET STRING
    MAX-ACCESS accessible-for-notify
    STATUS current
    DESCRIPTION "Upgrade partition usage Notification.
                1 = Normal
                2 = Medium
                3 = High"
    ::= {netskopeApplianceMIBNotifs 28}

callhomeConnectivityNotif OBJECT-TYPE
    SYNTAX OCTET STRING
    MAX-ACCESS accessible-for-notify
    STATUS current
    DESCRIPTION "Callhome service Connectivity Notification
                 1 = Reachable
                 2 = Not Reachable"
    ::= {netskopeApplianceMIBNotifs 29}

downloaderConnectivityNotif OBJECT-TYPE
    SYNTAX OCTET STRING
    MAX-ACCESS accessible-for-notify
    STATUS current
    DESCRIPTION "Downloader Connectivity Notification
                 1 = Reachable
                 2 = Not Reachable"
    ::= {netskopeApplianceMIBNotifs 30}

configsvcConnectivityNotif OBJECT-TYPE
    SYNTAX OCTET STRING
    MAX-ACCESS accessible-for-notify
    STATUS current
    DESCRIPTION "Config service Connectivity Notification
                 1 = Reachable
                 2 = Not Reachable"
    ::= {netskopeApplianceMIBNotifs 31}

uploadConnectivityNotif OBJECT-TYPE
    SYNTAX OCTET STRING
    MAX-ACCESS accessible-for-notify
    STATUS current
    DESCRIPTION "Upload Connectivity Notification
                 1 = Reachable
                 2 = Not Reachable"
    ::= {netskopeApplianceMIBNotifs 32}

loguploadConnectivityNotif OBJECT-TYPE
    SYNTAX OCTET STRING
    MAX-ACCESS accessible-for-notify
    STATUS current
    DESCRIPTION "Logupload Connectivity Notification
                 1 = Reachable
                 2 = Not Reachable"
    ::= {netskopeApplianceMIBNotifs 33}

deviceAutoUpgradeStatusNotif OBJECT-TYPE
    SYNTAX OCTET STRING
    MAX-ACCESS accessible-for-notify
    STATUS current
    DESCRIPTION "Device Auto Upgrade Status Notification
                 1 = Success
                 2 = Failed"
    ::= {netskopeApplianceMIBNotifs 34}

-- [= = = Grouping Traps/Notifications = = =]

netskopeApplianceNotifGroup NOTIFICATION-GROUP
    NOTIFICATIONS {
                mpConnectionNotif,
                deviceStatusNotif,
                deviceRebootNotif,
                storageRootNotif,
                storageMongoInfraNotif,
                storageLogNotif,
                cfgagentConnectionNotif,
                filesNotUploaded24hNotif,
                filesNotUploaded48hNotif,
                filesNotPicked24hNotif,
                filesNotPicked48hNotif,
                threatfeedAgeNotif,
                authProxyStatusNotif,
                noEventsFromDeviceNotif,
                noMetricsFromDeviceNotif,
                storageSecureStoreNotif,
                storageUpgradeNotif,
                callhomeConnectivityNotif,
                downloaderConnectivityNotif,
                configsvcConnectivityNotif,
                uploadConnectivityNotif,
                loguploadConnectivityNotif,
                deviceAutoUpgradeStatusNotif
            }
    STATUS current
    DESCRIPTION "Group for Netskope Appliance Notifications"
    ::= {netskopeApplianceMIBNotifsGroups 1}

-- [= = = Conformance Information = = =]

netskopeApplianceMIBCompliances
    OBJECT IDENTIFIER ::= {netskopeApplianceMIBConformance 1}

netskopeApplianceMIBCompliance MODULE-COMPLIANCE
    STATUS current
    DESCRIPTION "The compliance statement for Netskope Appliance"
    MODULE  -- this module
    MANDATORY-GROUPS {
                netskopeApplianceGroup,
                netskopeApplianceNotifGroup
             }
    ::= { netskopeApplianceMIBCompliances 1}
END

Setup an SNMP traps receiver on your SNMP server to receive SNMP traps notifications from the appliance. The appliance uses the following SNMP traps notification OIDs.

Make sure the daemon that receives the SNMP traps (snmptrapd) is running.

To set up the traps receiver,