Device attributes are supported as described in the table below. At minimum, MapName and Address are required. To create a device by importing, the following is required:
For any attribute that is not in the file, a default value is used. For example, if no probe is specified, the Automatic probe is used.
Use these attributes with the following table specification in line 1:
table=device
Notes:
Field Name | Description |
---|---|
MapName | Type: TEXT Access: READ-ONLY Attributes: none Description: Name of the map containing the device. |
MapPath | Type: TEXT Access: READ-ONLY Attributes: CREATE Description: Full path of the map containing the device, including the name of the map. |
Address + | Type: ADDRESS Access: READ-WRITE Attributes: CREATE Description: The IP or AppleTalk address of the device that is probed by InterMapper. The IP address is represented in dotted-decimal notation, e.g. 'a.b.c.d'. The AppleTalk address is represented in slash notation, e.g. 'a/b'. |
Id | Type: TEXT Access: READ-ONLY Attributes: INDEX Description: A unique, persistent identifier for this device instance. The id will be unique across all maps on a single InterMapper server. |
Name | Type: TEXT Access: READ-ONLY Attributes: none Description: The name of the device. The name is the first non-empty line in a device's label on a map. |
Probe + | Type: TEXT Access: READ-WRITE Attributes: none Description: The human-readable name of the InterMapper probe. |
Comment + | Type: TEXT Access: READ-WRITE Attributes: none Description: The comment associated with the device. |
Community + | Type: TEXT Access: READ-WRITE Attributes: SENSITIVE Description: The SNMP community of the device. |
DisplayIfUnNumbered + | Type: BOOLEAN Access: READ-WRITE Attributes: none Description: True if the device's behaviour is set to display unnumbered interfaces. |
DNSName + | Type: TEXT Access: READ-WRITE Attributes: CREATE Description: The fully-qualified DNS name of the device. |
IgnoreIfAppleTalk + | Type: BOOLEAN Access: READ-WRITE Attributes: none Description: True if the device's behaviour is to ignore AppleTalk interface information. |
IgnoreIfDiscards + | Type: BOOLEAN Access: READ-WRITE Attributes: none Description: True if the device's behaviour is to ignore interface discards. |
IgnoreIfErrors + | Type: BOOLEAN Access: READ-WRITE Attributes: none Description: True if the device's behaviour is to ignore interface errors. |
IgnoreOutages + | Type: BOOLEAN Access: READ-WRITE Attributes: none Description: True if the device's behaviour is to ignore outages. |
AllowPeriodicReprobe + | Type: BOOLEAN Access: READ-WRITE Attributes: none Description: True if the device's behaviour is to allow periodic reprobe. |
IMProbe *+ | Type: TEXT Access: READ-WRITE Attributes: SENSITIVE,CREATE Description: A special URL representation describing the InterMapper probe and its parameters, e.g. improbe://address:port/... |
Latitude + | Type: TEXT Access: READ-WRITE Attributes: none Description: The latitude of the device. The value will be a double within the range [-90..90] or empty string if the device does not have this attribute set. |
Longitude + | Type: TEXT Access: READ-WRITE Attributes: none Description: The longitude of the device. The value will be a double within the range [-180..180] or empty string if the device does not have this attribute set. |
LastTimeDown | Type: TIMESTAMP Access: READ-ONLY Attributes: none Description: The time when the device last went down. Value is 0 if device has not gone down since we started monitoring it. |
LastTimeSysUp | Type: TIMESTAMP Access: READ-ONLY Attributes: none Description: The time when the device last came up (ie rebooted), based on the value of sysUpTime. The value is 0 if unknown. |
LastTimeUp | Type: TIMESTAMP Access: READ-ONLY Attributes: none Description: The time when the device status last transitioned from DOWN to UP. Value is 0 if this has not happened since we started monitoring. |
MACAddress | Type: TEXT Access: READ-ONLY Attributes: none Description: The device's MAC Address. If the device has multiple interfaces, this field will contain the MAC Address associated with the device's main IP Address (the same address in the address field). |
MapAs + | Type: TEXT Access: READ-WRITE Attributes: none Description: Value is one of { ROUTER , SWITCH , HUB, END SYSTEM } |
MapId | Type: TEXT Access: READ-ONLY Attributes: CREATE Description: The unique Id of the map file containing the device. |
MaxTries + | Type: INTEGER Access: READ-WRITE Attributes: none Description: The maximum number of attempts to reach the device, typically indicates the maximum number of packets to send during each poll, for packet-based probes. |
NetBIOSName + | Type: TEXT Access: READ-WRITE Attributes: CREATE Description: The NetBIOS/WINS name of the device. |
PctLoss | Type: DOUBLE Access: READ-ONLY Attributes: none Description: The percent loss (# packets lost/total # packets sent). |
ShortTermPctLoss | Type: DOUBLE Access: READ-ONLY Attributes: none Description: The short-term percent loss (# packets lost/# packets sent). |
Availability | Type: DOUBLE Access: READ-ONLY Attributes: none Description: The percent availability (time up/time monitored). |
PollInterval + | Type: INTEGER Access: READ-WRITE Attributes: none Description: The poll interval of the device, in seconds. Value is 0 if non-polling. |
Port + | Type: INTEGER Access: READ-WRITE Attributes: none Description: The UDP or TCP port number. If the port number is not applicable, this value is always 0. (e.g. for ICMP) |
Resolve + | Type: TEXT Access: READ-WRITE Attributes: none Description: Value is one of { name , addr , none }. |
RoundTripTime | Type: INTEGER Access: READ-ONLY Attributes: none Description: The last round-trip time in milliseconds, if known. |
SNMPv3AuthPassword + | Type: TEXT Access: READ-WRITE Attributes: SENSITIVE Description: The device's SNMPv3 authentication password. |
SNMPv3AuthProtocol + | Type: TEXT Access: READ-WRITE Attributes: none Description: The device's SNMPv3 authentication protocol (MD5, SHA, None). |
SNMPv3PrivPassword + | Type: TEXT Access: READ-WRITE Attributes: SENSITIVE Description: The device's SNMPv3 privacy password. |
SNMPv3PrivProtocol + | Type: TEXT Access: READ-WRITE Attributes: none Description: The device's SNMPv3 privacy protocol (DES, None). |
SNMPv3UserName + | Type: TEXT Access: READ-WRITE Attributes: none Description: The device's SNMPv3 user name. |
SNMPVersion + | Type: TEXT Access: READ-WRITE Attributes: none Description: The device's SNMP version (SNMPv1, SNMPv2c, or SNMPv3). |
Status | Type: TEXT Access: READ-ONLY Attributes: none Description: The status of the device. The value is one of { 'UP', 'DOWN', 'UNKNOWN' }. |
StatusLevel | Type: TEXT Access: READ-ONLY Attributes: none Description: The status level of the device. The value is one of { 'Unknown', 'OK', 'Warning, Acked', 'Warning', 'Alarm, Acked', 'Alarm', 'Critical', 'Critical, Acked', 'Down', 'Down, Acked'}. |
StatusLevelReason | Type: TEXT Access: READ-ONLY Attributes: none Description: The reason the device has its status level. |
SysDescr | Type: TEXT Access: READ-ONLY Attributes: none Description: The value of sysDescr. |
SysName | Type: TEXT Access: READ-ONLY Attributes: none Description: The value of sysName. |
SysContact | Type: TEXT Access: READ-ONLY Attributes: none Description: The value of sysContact. |
SysLocation | Type: TEXT Access: READ-ONLY Attributes: none Description: The value of sysLocation. |
SysObjectID | Type: ADDRESS Access: READ-ONLY Attributes: none Description: The value of sysObjectID. |
TimeOut + | Type: INTEGER Access: READ-WRITE Attributes: none Description: The timeout of the device, in seconds. Value is 0 if not-applicable to the probe. |
IMID | Type: TEXT Access: READ-ONLY Attributes: INDEX Description: Identifier of the device in the IMID format. |
Type | Type: TEXT Access: READ-ONLY Attributes: none Description: One of { none, other, snmp, tcp, udp, icmp, cmd, bigbro, ntsvcs }. These values have been updated in 5.0 to match the values used by the database in the probekind field of the devices table. |
ProbeXML | Type: TEXT Access: READ-ONLY Attributes: SENSITIVE Description: XML dataset DTD, type='probe'. |
SNMPVersionInt | Type: INTEGER Access: READ-ONLY Attributes: none Description: 1, 2, 3 - SNMP versions. 0 for non-SNMP. |
SysServices | Type: INTEGER Access: READ-ONLY Attributes: none Description: 16-bits integer. |
EntSerialNum | Type: TEXT Access: READ-ONLY Attributes: none Description: SnmpAdminString (entPhysicalSerialNum of chassis). |
EntMfgName | Type: TEXT Access: READ-ONLY Attributes: none Description: SnmpAdminString (entPhysicalMfgName of chassis). |
EntModelName | Type: TEXT Access: READ-ONLY Attributes: none Description: SnmpAdminString (entPhysicalModelName of chassis). |
DataRetentionPolicy | Type: INTEGER Access: READ-ONLY Attributes: none Description: Data retention policy for IM Database |
CustomerNameReference | Type: TEXT Access: READ-ONLY Attributes: none Description: Customer-supplied device name reference, for linking to an external database. |
EnterpriseID | Type: TEXT Access: READ-ONLY Attributes: none Description: The value of sysEnterpriseID. |
DeviceKind | Type: TEXT Access: READ-ONLY Attributes: none Description: User-specified device type. |
SysUpTime | Type: TEXT Access: READ-ONLY Attributes: none Description: System uptime. |
LastModified | Type: TIMESTAMP Access: READ-ONLY Attributes: none Description: Timestamp of last modification to this device. |
Parent | Type: TEXT Access: READ-ONLY Attributes: none Description: Device ID of the parent probe group; this device's id if this device is a probe group; 0 if the device is not part of a probe group. |
Acknowledge + | Type: TEXT Access: READ-WRITE Attributes: none Description: The acknowledgement state of the device; one of { 'None', 'Basic', 'Maintenance' }. The AckMessage field must also be set to import this field. Indefinite maintenance will be set if AckExpiration is missing and state is set to 'Maintenance'. |
AckMessage + | Type: TEXT Access: READ-WRITE Attributes: none Description: The message associated with the acknowledge state. If Acknowledge is not set and an AckMessage is supplied, Acknowledge will be set to 'Basic'. |
AckExpiration + | Type: TEXT Access: READ-WRITE Attributes: none Description: The absolute time when the timed acknowledgement expires, if any. The AckMessage field must also be set to import this field. Acknowledge will be set to 'Maintenance' if not supplied. |
AckTimer | Type: TEXT Access: READ-ONLY Attributes: none Description: The time in seconds remaining until the timed acknowledgement expires, if any. |
VertexId | Type: TEXT Access: READ-ONLY Attributes: none Description: The Vertex Id of the vertex associated with the device. Matches the VertexId of the corresponding vertex in the vertices table. |
Layer2 | Type: BOOLEAN Access: READ-ONLY Attributes: none Description: True if layer2 mapping is enabled for this device. |