About Internal Identifiers (IDs)

Home  Previous  Next

In Monitoring Studio KM for PATROL, all objects are identified with a unique ID. When configuring Monitoring Studio using a third-party tool, it is important to have a clear understanding of the ID formats.

There are four different ID formats which vary according to the type of objects:

Group ID
Host ID
Monitor ID
Monitor Children ID

Group ID

The Group ID is the internal identifier as entered when configuring the Group Settings. It is referred to as <groupID>

Creating_Monitor_Group_Icon_3

Group  ID - Example

Host ID

The Host ID is referred to as <hostID> and always follows this format: <groupID>@<hostname> where:

<groupID> is the Internal ID as entered when configuring the Group Settings
<hostname> is the Hostname/IP address/FQDN of the Host on which the technology you wish to monitor is running

Creating_Hosts_1

Host  ID - Example

Monitor ID

For all Monitors added from the Host using KM Commands > New > Monitor... the Monitor ID format is as follows: <groupID>@<hostID>:<monitorType>:<monitorID> where:

<groupID> is the Internal ID as entered when configuring the Group Settings
<hostID> is the <groupID>@<hostname> (Hostname/IP address/FQDN)
<monitorType> is the type of Monitor (Command Line, Web Request, Folder, Process, etc.)
<monitorID> is the internal ID as entered when configuring the Monitor Settings

 

Example

If you create a File Monitor with ID "myFile" under the Host "myHost" which belongs to Group "myGroup", the complete ID of the File Monitoring would be: myGroup@myHost:File:myFile

Monitor_ID_1

Monitor ID - Example

Monitor Children ID

For all Monitors added from another Monitor using KM Commands > New > (String Search, Numeric Value Extraction, Text Pre-Processing, and Dynamic Object Builder), the Monitor Children ID format is as follows: <parentID>:<monitorType>:<monitorID> where:

<parentID> is the <groupID>@<hostID>:<monitorType>:<monitorID>
<monitorType> is the type of Monitor (String Search, Numeric Value Extraction, Text Pre-Processing, and Dynamic Object Builder)
<monitorID> is the internal ID as entered when configuring the Monitor Settings

 

Example

If you create a String Search Monitor with ID "myStringSearch" under the File "myFile" which belongs to the Host "myHost" which itself belongs to the Group "myGroup", the complete ID of the String Search Monitoring would be: myGroup@myHost:File:myFile:StringSearch:myStringSearch

Monitor_ID_2

Monitor Children ID - Example