SNMP MIB File

The SNMP MIB (Management Information Base) file defines the properties for the managed objects in KeyControl. The MIB file is written in an independent format and the object information it contains is organized hierarchically. OIDs (Object Identifiers) in the MIB file uniquely identify each managed object. Each OID has an address that follows the levels of the OID hierarchy.

The Enterprise OID for HyTrust is 1.3.6.1.4.1.33095. KeyControl's relative OID is 4.

Object Model

The model for a KeyControl MIB trap object is:

-- 1.3.6.1.4.1.33095.4.1.0.1
htkcKeyServerAlert NOTIFICATION-TYPE
     OBJECTS     { htkcKeyServerAlertID, htkcKeyServerAlertSeverity, htkcKeyServerAlertText, htkcKeyServerHostname, htkcKeyServerIP, htkcDeviceHostname, htkcDeviceIP, htkcObjectName, htkcObjectID, htkcObjectType, htkcObjectDetail }
     STATUS      current
     DESCRIPTION "An HTKC alert."
     ::= { htkcKeyServerAlerts 1 }

Message Fields

Message Field	Description
htkcKeyServerAlertID	The Alert ID number.
htkcKeyServerAlertSeverity	The alert severity. This can be 0 (high), 5 (medium), or 10 (low).
htkcKeyServerAlertText	The alert text.

Host Identification Fields

Field	Description
htkcKeyServerHostname	Hostname of the KeyControl server generating the alert.
htkcKeyServerIP	IP address of the KeyControl server generating the alert.
htkcDeviceHostname	Hostname of device for which alert is being generated. If the alert is about the KeyControl cluster, this will be the same as htkcKeyServerHostname. If it is about a client object such as a VM, disk, or filesystem, this will be the hostname of the VM on which the KeyControl Policy Agent is running.
htkcDeviceIP	The IP address of the device for which alert is being generated. This will either be the IP address of the KeyControl server or the address of the client VM on which the Policy Agent is running.

Object Identification Fields

The following fields only apply if the object identity is available.

Field	Description
htkcObjectName	Name of object for which alert is being generated.
htkcObjectID	UUID of object for which alert is being generated.
htkcObjectType	Type of object for which alert is being generated.
htkcObjectDetail	JSON string containing hierarchical list of objects starting from leaf node. This is necessary for identifying the object based on name.

Example

For example, here is a sample trap for the alert stating that Virtual Machine dkw2012 has been authenticated. The alert ID is 85 and the priority is 10 (low).

2018-07-26 14:57:44 dkkc2 [UDP: [172.16.14.22]:19357->[0.0.0.0]:0]:
DISMAN-EVENT-MIB::sysUpTimeInstance = Timeticks: (0) 0:00:00.00 SNMPv2-MIB::snmpTrapOID.0 = OID: HTKC-MIB::htkcKeyServerAlert  
    HTKC-MIB::htkcKeyServerAlertID = Gauge32: 85   
    HTKC-MIB::htkcKeyServerAlertSeverity = INTEGER: low(10)
    HTKC-MIB::htkcKeyServerAlertText = STRING: "Added Virtual Machine dkw2012 (Cloud VM Set: windows), authentication complete"
    HTKC-MIB::htkcKeyServerHostname = STRING: "dkkc2.localdomain"  
    HTKC-MIB::htkcKeyServerIP = STRING: "172.16.14.22" 
    HTKC-MIB::htkcDeviceHostname = "dkw2012.localdomain"   
    HTKC-MIB::htkcDeviceIP = STRING: "172.16.14.169"   
    HTKC-MIB::htkcObjectName = STRING: "dkw2012"   
    HTKC-MIB::htkcObjectID = STRING: "24bc7e36-90b6-11e8-a0fc-000c29cd584d"
    HTKC-MIB::htkcObjectType = STRING: "CVM"   
    HTKC-MIB::htkcObjectDetail = STRING: "[{\"type\": \"CVM\", \"name\": \"dkw2012\", \"id\": \"24bc7e36-90b6-11e8-a0fc-000c29cd584d\"}, {\"type\": \"CVMSET\", \"name\": \"windows\", \"id\": \"307e83d2-90b2-11e8-a0fc-000c29cd584d\"}, {\"type\": \"GROUP\", \"name\": \"Cloud Admin Group\", \"id\": \"d2e6a25b-9096-11e8-a0fc-000c29cd584d\"}]"