2.0 APPENDIX B XML Example Data

WAS THIS PAGE HELPFUL? Leave Feedback

2.0 APPENDIX B XML Example Data

Appendix B: Contents

2.1 Host XML

(toc)

2.1.1 Host - Response Data - Shallow XML
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<host id="1" hostName="localhost" description="localhost" monitorStatus="UP"
      appType="NAGIOS" deviceIdentification="127.0.0.1"
      lastCheckTime="2013-05-22T09:44:56-07:00" bubbleUpStatus="UP"
      serviceAvailability="9.52" acknowledged="false">
    <properties>
        <property name="LastPluginOutput"
                 value="OK - 127.0.0.1: rta 0.039ms, lost 0%"/>
        <property name="Comments" value=" "/>
        <property name="MaxAttempts" value="10"/>
        <property name="CurrentNotificationNumber" value="0"/>
        <property name="isFlapDetectionEnabled" value="false"/>
        <property name="isEventHandlersEnabled" value="true"/>
        <property name="PerformanceData"
                  value="rta=0.039ms;3000.000;5000.000;0; pl=0%;80;100;"/>
        <property name="PercentStateChange" value="0"/>
        <property name="isPassiveChecksEnabled" value="true"/>
        <property name="isChecksEnabled" value="true"/>
        <property name="Latency" value="31"/>
        <property name="CactiRRDCommand" value="Load Average;"/>
        <property name="isNotificationsEnabled" value="false"/>
        <property name="Alias" value="Linux Server #1"/>
        <property name="isAcknowledged" value="false"/>
        <property name="ScheduledDowntimeDepth" value="0"/>
        <property name="LastStateChange" value="May 17, 2013"/>
        <property name="CurrentAttempt" value="1"/>
        <property name="LastNotificationTime" value="0"/>
        <property name="ExecutionTime" value="6"/>
    </properties>
</host>
2.1.2 Host - Response Data - Deep XML
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<host serviceCount="21" id="1" hostName="localhost" description="localhost"
      monitorStatus="UP" appType="NAGIOS"
      deviceIdentification="127.0.0.1" lastCheckTime="2013-05-22T09:44:56-07:00"
      bubbleUpStatus="UP" serviceAvailability="9.52" acknowledged="false">
    <properties>
        <property name="LastPluginOutput"
                        value="OK - 127.0.0.1: rta 0.039ms, lost 0%"/>
        <property name="Comments" value=" "/>
        <property name="MaxAttempts" value="10"/>
    </properties>
    <device deviceId="1" displayName="127.0.0.1"
            identification="127.0.0.1" description="Device localhost"/>
    <hostStatus hostStatusId="1"
                lastCheckTime="2013-05-22T09:44:56-07:00"
                 nextCheckTime="2013-05-22T09:50:06-07:00">
        <monitorStatus monitorStatusId="1" name="UP" description="UP"/>
        <checkType checkTypeId="1" name="ACTIVE" description="Active Check"/>
        <stateType>
            <stateTypeId>2</stateTypeId>
            <name>HARD</name>
            <description>State Hard</description>
        </stateType>
    </hostStatus>
    <services>
        <service serviceStatusId="16"
                 serviceDescription="local_process_gw_listener"
                 lastCheckTime="2013-05-22T09:43:27-07:00"
                 nextCheckTime="2013-05-22T09:53:27-07:00"
                 lastStateChange="2013-05-17T07:51:26-07:00"
                 monitorStatus="UNSCHEDULED CRITICAL"
                 applicationType="NAGIOS" checkType="ACTIVE" stateType="HARD"
                 lastPlugInOutput="3^^^3^^^0^^^05/17/2013 07:51:26 A"/>
        <service serviceStatusId="11" serviceDescription="local_mem_java"
                 lastCheckTime="2013-05-22T09:40:36-07:00"
                 nextCheckTime="2013-05-22T09:50:36-07:00"
                 lastStateChange="2013-05-20T04:20:36-07:00"
                 monitorStatus="UNSCHEDULED CRITICAL" applicationType="NAGIOS"
                 checkType="ACTIVE" stateType="HARD"
                 lastPlugInOutput="3^^^3^^^0^^^05/20/2013 "/>
    </services>
    <hostGroups>
        <hostGroup name="IT" alias="it" appType="NAGIOS"/>
        <hostGroup name="Linux Servers" description=" " alias="Linux Servers" appType="NAGIOS"/>
    </hostGroups>
    <applicationType applicationTypeId="100" name="NAGIOS" description="System monitored by Nagios"
                     stateTransitionCriteria="Device;Host;ServiceDescription"/>
</host>
2.1.3 Host Query - Response Data - Simple Depth XML
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<hosts>
    <host id="6" hostName="172.28.113.151" description="172.28.113.151"
             monitorStatus="UP" appType="NAGIOS" />
    <host id="12" hostName="172.28.113.168" description="172.28.113.168"
              monitorStatus="UP" appType="NAGIOS"  />
    <host id="14" hostName="demo" description="demo"
               monitorStatus="UP" appType="NAGIOS"  />
    <host id="8" hostName="do-centos-5-64-1" description="do-centos-5-64-1"
              monitorStatus="UP" appType="NAGIOS" />
</hosts>
2.1.4 Host Query - Response Data - Sync Depth XML
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<hosts>
    <host hostName="localhost" appType="NAGIOS" deviceIdentification="127.0.0.1">
        <services>
            <service appType="NAGIOS" description="local_process_gw_listener"/>
            <service appType="NAGIOS" description="local_nagios_latency"/>
            <service appType="NAGIOS" description="local_mem_java"/>
        </services>
    </host>
</hosts>
2.1.5 Host Post - Post Data XML
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<hosts>
    <host hostName="host-100" description="local-cpu"
           monitorStatus="UP" appType="NAGIOS"
          deviceIdentification="192.168.5.50" monitorServer="localhost"
          deviceDisplayName="Device-50" >
          <properties>
            <property name="Latency" value="125" />
            <property name="UpdatedBy" value="admin" />
            <property name="Comments" value="Testing" />
          </properties>
    </host>
    <host hostName="host-101" description="tcp_http"
          monitorStatus="UP" appType="NAGIOS"
          deviceIdentification="192.168.5.51" monitorServer="localhost"
          deviceDisplayName="Device-51" >
          <properties>
          	    <property name="TimeUp" value="100" />
                <property name="TimeDown" value="200" />
          	    <property name="TimeOK" value="300" />
            </properties>
    </host>
</hosts>
2.1.6 Host Autocomplete Response XML
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<names>
    <name>localhost</name>
    <name>localhost2</name>
</names>
2.2 Host Group XML

(toc)

2.2.1 HostGroup - Response Data - Shallow XML
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<hostGroup id="5" name="Support" alias="support" appType="NAGIOS">
  <hosts>
    <host id="17" hostName="mc-cent5-64-a"
    description="mc-cent5-64-a" monitorStatus="UNSCHEDULED DOWN"
    appType="NAGIOS" deviceIdentification="172.28.113.170"
    lastCheckTime="2013-05-22T09:44:16-07:00"
    bubbleUpStatus="UNSCHEDULED DOWN" serviceAvailability="100"
    acknowledged="false" serviceCount="1" />
    <host id="6" hostName="172.28.113.151"
    description="172.28.113.151" monitorStatus="UP"
    appType="NAGIOS" deviceIdentification="172.28.113.151"
    lastCheckTime="2013-05-22T09:43:06-07:00" bubbleUpStatus="UP"
    serviceAvailability="50" acknowledged="false"
    serviceCount="4" />
  </hosts>
</hostGroup>
2.2.2 HostGroup - Response Data - Deep XML
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<hostGroup id="8" name="HG1" alias="sdfg" appType="NAGIOS">
  <hosts>
    <host id="6" hostName="172.28.113.151"
    description="172.28.113.151" monitorStatus="UP"
    appType="NAGIOS" deviceIdentification="172.28.113.151"
    lastCheckTime="2013-05-22T09:43:06-07:00" bubbleUpStatus="UP"
    serviceAvailability="50" acknowledged="false" serviceCount="4">
      <properties>
        <property name="LastPluginOutput"
        value="OK - 172.28.113.151: rta 11.175ms, lost 0%" />
        <property name="Comments" value=" " />
        <property name="MaxAttempts" value="3" />
        <property name="CurrentNotificationNumber" value="0" />
        <property name="isFlapDetectionEnabled" value="false" />
        <property name="isEventHandlersEnabled" value="true" />
        <property name="PerformanceData"
        value="rta=11.175ms;3000.000;5000.000;0; pl=0%;80;100;; rtmax=11.175ms;;;; rtmin=11.175ms;;;;" />
        <property name="PercentStateChange" value="0" />
        <property name="isPassiveChecksEnabled" value="true" />
        <property name="Latency" value="356" />
        <property name="isChecksEnabled" value="true" />
        <property name="isNotificationsEnabled" value="false" />
        <property name="Alias" value="172.28.113.151" />
        <property name="isAcknowledged" value="false" />
        <property name="ScheduledDowntimeDepth" value="0" />
        <property name="LastStateChange" value="May 17, 2013" />
        <property name="CurrentAttempt" value="1" />
        <property name="LastNotificationTime" value="0" />
        <property name="ExecutionTime" value="15" />
      </properties>
    </host>
  </hosts>
  <applicationType applicationTypeId="100" name="NAGIOS"
  description="System monitored by Nagios"
  stateTransitionCriteria="Device;Host;ServiceDescription" />
  <statistics>
    <statistic name="CRITICAL" count="0" />
    <statistic name="WARNING" count="0" />
    <statistic name="UNKNOWN" count="0" />
    <statistic name="OK" count="2" />
    <statistic name="PENDING" count="0" />
    <statistic name="SCHEDULED CRITICAL" count="0" />
    <statistic name="UNSCHEDULED CRITICAL" count="2" />
  </statistics>
</hostGroup>
2.2.3 HostGroup Post - Post Data XML
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<hostGroups>
    <hostGroup name="blueGroup" description="My Blues Group" alias="blue">
        <hosts>
         <host hostName="localhost" />
        </hosts>
    </hostGroup>
    <hostGroup name="redGroup" description="My Red Group" alias="red">
        <hosts>
         <host hostName="demo"/>
         <host hostName="localhost"/>
        </hosts>
    </hostGroup>
</hostGroups>
2.2.4 Host Group Autocomplete Response XML
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<names>
    <name>HG1</name>
    <name>HG2</name>
</names>
2.3 Services XML

(toc)

2.3.1 Services - Response Data - XML
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<service id="1" appType="NAGIOS" description="local_cpu_httpd"
         monitorStatus="OK"
         lastCheckTime="2013-05-22T09:44:46-07:00"
          nextCheckTime="2013-05-22T09:54:46-07:00"
         lastStateChange="2013-05-22T09:44:46-07:00" hostName="localhost"
         stateType="HARD" checkType="ACTIVE" lastHardState="PENDING">
    <properties>
        <property name="LastPluginOutput"
                        value="OK - total %CPU for process httpd : 0.0"/>
        <property name="Comments" value=" "/>
        <property name="MaxAttempts" value="3"/>
        <property name="CurrentNotificationNumber" value="0"/>
        <property name="isFlapDetectionEnabled" value="false"/>
        <property name="RRDPath"
                        value="/usr/local/groundwork/rrd/localhost_local_cpu_httpd.rrd"/>
        <property name="isEventHandlersEnabled" value="true"/>
        <property name="PerformanceData" value="%CPU=0.0;40;50"/>
        <property name="PercentStateChange" value="0"/>
        <property name="isAcceptPassiveChecks" value="true"/>
        <property name="RRDCommand"
                        value="rrdtool graph -   DEF"/>
        <property name="isProblemAcknowledged" value="false"/>
        <property name="isChecksEnabled" value="true"/>
        <property name="Latency" value="998"/>
        <property name="RemoteRRDCommand" value=" "/>
        <property name="isNotificationsEnabled" value="false"/>
        <property name="ScheduledDowntimeDepth" value="0"/>
        <property name="RRDLabel" value="CPU Utilization"/>
        <property name="CurrentAttempt" value="1"/>
        <property name="LastNotificationTime" value="0"/>
        <property name="ExecutionTime" value="187"/>
    </properties>
</service>
2.3.2 Services Query - Response Data - XML
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<services>
    <service id="67" appType="NAGIOS" description="http_alive" monitorStatus="OK"
             lastCheckTime="2013-05-22T09:36:47-07:00"
             nextCheckTime="2013-05-22T09:46:47-07:00"
             lastStateChange="2013-05-22T09:36:47-07:00" hostName="malbec"
             stateType="HARD" checkType="ACTIVE" lastHardState="PENDING">
        <properties>
            <property name="LastPluginOutput"
                      value="HTTP OK: HTTP/1.1 200 OK - 1269 bytes in 0.002 second response"/>
            <property name="Comments" value=" "/>
            <property name="MaxAttempts" value="3"/>
            <property name="CurrentNotificationNumber" value="0"/>
            <property name="isFlapDetectionEnabled" value="false"/>
            <property name="RRDPath"
                            value="/usr/local/groundwork/rrd/malbec_http_alive.rrd"/>
            <property name="PerformanceData"
                            value="time=0.002119s;4.000000;7.000000;0.000000 size=1269B;;;0"/>
            <property name="isEventHandlersEnabled" value="true"/>
            <property name="PercentStateChange" value="0"/>
            <property name="isAcceptPassiveChecks" value="true"/>
            <property name="RRDCommand"
                           value="rrdtool graph - --imgformat=PNG --title="HTTP Performance"/>
            <property name="isChecksEnabled" value="true"/>
            <property name="isProblemAcknowledged" value="false"/>
            <property name="Latency" value="950"/>
            <property name="RemoteRRDCommand" value=" "/>
            <property name="isNotificationsEnabled" value="false"/>
            <property name="ScheduledDowntimeDepth" value="0"/>
            <property name="RRDLabel" value="Response Time"/>
            <property name="CurrentAttempt" value="1"/>
            <property name="LastNotificationTime" value="0"/>
            <property name="ExecutionTime" value="7"/>
        </properties>
    </service>
    <service id="62" appType="NAGIOS" description="http_alive" monitorStatus="OK">
       ….
    </service>
</services>
2.3.3 Services Post - Post Data XML
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<services>
    <service hostName="localhost" monitorServer="localhost"
             deviceIdentification="127.0.0.1"
             description="service-109" appType="NAGIOS"  monitorStatus="OK"
             lastCheckTime="2013-05-22T09:36:47-07:00"
             nextCheckTime="2013-05-22T09:46:47-07:00"
             lastStateChange="2013-05-22T09:36:47-07:00"
             stateType="HARD" checkType="ACTIVE" lastHardState="PENDING">
        <properties>
            <property name="LastPluginOutput"
                      value="HTTP OK: HTTP/1.1 200 OK"/>
            <property name="MaxAttempts" value="3"/>
            <property name="Latency" value="950"/>
            <property name="ExecutionTime" value="7"/>
        </properties>
    </service>
    <service hostName="localhost" monitorServer="localhost"
             deviceIdentification="127.0.0.1"
             description="service-110" appType="NAGIOS"  monitorStatus="OK"
             lastCheckTime="2013-05-22T09:36:47-07:00"
             nextCheckTime="2013-05-22T09:46:47-07:00"
             lastStateChange="2013-05-22T09:36:47-07:00"
             stateType="HARD" checkType="ACTIVE" lastHardState="PENDING">
        <properties>
            <property name="LastPluginOutput"
                      value="HTTPS OK: HTTPS/1.1 200 OK"/>
            <property name="MaxAttempts" value="1"/>
            <property name="Latency" value="100"/>
            <property name="ExecutionTime" value="30"/>
        </properties>
    </service>
</services>
2.3.4 Service Autocomplete Response XML
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<names>
    <name>local_cpu_httpd</name>
    <name>local_cpu_java</name>
</names>
2.4 Devices XML

(toc)

2.4.1 Devices - Response Data - Shallow XML
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<device id="1"
             identification="127.0.0.1"
             displayName="127.0.0.1"
             description="Device localhost" />
2.4.2 Devices - Response Data - Deep XML
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<device id="1"
            identification="127.0.0.1"
            displayName="127.0.0.1"
            description="Device localhost">
  <hosts>
      <host id="1" hostName="localhost" description="localhost"
               monitorStatus="UP" appType="NAGIOS"
              deviceIdentification="127.0.0.1"
              lastCheckTime="2013-05-22T09:44:56-07:00" bubbleUpStatus="UP"
              serviceAvailability="9.52" acknowledged="false"
              serviceCount="21" />
  </hosts>
  <monitorServers>
    <monitorServer monitorServerId="1"
               monitorServerName="localhost" ip="127.0.0.1"
               description="Default Monitor Server" />
  </monitorServers>
</device>
2.4.3 Devices Query - Response Data - Shallow XML
<devices>
    <device id="1" displayName="127.0.0.1" identification="127.0.0.1"
  	description="Device localhost" />
    <device id="16" displayName="qa-sles-11-64-2"
  	identification="172.28.113.150" />
    <device id="6" displayName="172.28.113.151"
  	identification="172.28.113.151" />
    <device id="5" displayName="do-win7-1"
  	identification="172.28.113.152" />
    <device id="3" displayName="qa-sles-11-64"
  	identification="172.28.113.153" />
    <device id="14" displayName="demo"
  	identification="172.28.113.155" />
    <device id="20" displayName="sql-2008"
  	identification="172.28.113.156" />
    <device id="11" displayName="support-xp-1"
  	identification="172.28.113.158" />
</devices>
2.4.4 Devices Post - Post Data XML
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<devices>
   <device displayName="device-900" identification="172.28.128.100">
      <hosts>
          <host hostName='abc.com' description='Host ABC'/>
          <host hostName='def.com' description='Host DEF'/>
      </hosts>
   </device>
   <monitorServers>
   	 <monitorServer monitorServerName='ms1' ip="182.80.100.212"/>
   </monitorServers>
</devices>
2.5 Events XML

(toc)

2.5.1 Events Query - Response Data - XML
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<events>
    <event id="5" device="127.0.0.1" host="localhost" service="local_cpu_perl"
           operationStatus="ACCEPTED"
           monitorStatus="OK" severity="OK" applicationSeverity="OK"
           component="OK"
           priority="Lowest Priority in a scale from 1 -10" typeRule="UNDEFINED"
           textMessage="OK - total %CPU for process perl : 4.1"
           firstInsertDate="2013-05-17T07:46:12-07:00"
           lastInsertDate="2013-05-17T07:46:12-07:00"
           reportDate="2013-05-17T07:46:34.057-07:00"
           msgCount="1" appType="NAGIOS">
        <properties>
            <property name="ErrorType" value="SERVICE ALERT"/>
            <property name="SubComponent" value="localhost:local_cpu_perl"/>
        </properties>
    </event>
    <event id="4" device="127.0.0.1" host="localhost" service="local_cpu_nagios"
           operationStatus="ACCEPTED"
           monitorStatus="OK" severity="OK" applicationSeverity="OK"
           component="OK"
           priority="Lowest Priority in a scale from 1 -10" typeRule="UNDEFINED"
           textMessage="OK - total %CPU for process nagios : 0.0"
           firstInsertDate="2013-05-17T07:45:43-07:00"
           lastInsertDate="2013-05-17T07:45:43-07:00"
           reportDate="2013-05-17T07:46:03.951-07:00"
          msgCount="1" appType="NAGIOS">
        <properties>
            <property name="ErrorType" value="SERVICE ALERT"/>
            <property name="SubComponent" value="localhost:local_cpu_nagios"/>
        </properties>
    </event>
</events>
2.5.2 Events Post - Post Data XML
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<events>
    <event consolidationName="NAGIOSEVENT" monitorServer="locahost"
            monitorStatus="UP" service="local_load"
            appType="NAGIOS" device="127.0.0.1" severity="SERIOUS"
            textMessage="This is a serious Nagios Message on Device 127.0.0.1"
            operationStatus="OPEN" host="localhost"
            reportDate="2013-06-02T10:55:32.943"
            errorType="MyError" component="MySubComponent">
        <properties>
            <property name="Latency" value="125.31"/>
            <property name="UpdatedBy" value="UnitTester"/>
            <property name="Comments" value="This is a test."/>
        </properties>
     </event>
</events>
2.5.3 Events Properties Update - Put Data XML
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<events>
    <event id="4809">
        <properties>
            <property name="Latency" value="125.31"/>
            <property name="UpdatedBy" value="UnitTesterAB"/>
            <property name="Comments" value="This is a test 1."/>
        </properties>
     </event>
    <event id="4810">
        <properties>
            <property name="Latency" value="125.41"/>
            <property name="UpdatedBy" value="UnitTesterBC"/>
            <property name="Comments" value="This is a test 2."/>
        </properties>
     </event>
</events>
2.6 Statistics XML

(toc)

  1. Total Host Statistics
    <?xml version="1.0" encoding="utf-8" standalone="yes"?>
    <statistic totalHosts="20"
                    totalServices="131" name="_ALL_"
                    availability="75.0">
      <properties>
        <property name="DOWN" count="0" />
        <property name="UNREACHABLE" count="0" />
        <property name="PENDING" count="0" />
        <property name="UP" count="15" />
        <property name="SCHEDULED DOWN" count="0" />
        <property name="UNSCHEDULED DOWN" count="5" />
      </properties>
    </statistic>
  2. Total Services Statistics
    <?xml version="1.0" encoding="utf-8" standalone="yes"?>
    <statistic totalHosts="20"
                    totalServices="131" name="_ALL_"
                   availability="0.0">
      <properties>
        <property name="CRITICAL" count="0" />
        <property name="WARNING" count="2" />
        <property name="UNKNOWN" count="0" />
        <property name="OK" count="114" />
        <property name="PENDING" count="0" />
        <property name="SCHEDULED CRITICAL" count="0" />
        <property name="UNSCHEDULED CRITICAL" count="15" />
      </properties>
    </statistic>
  3. Host Statistics for two hosts, grouped by host
    <statistics>
      <statistic totalHosts="1" totalServices="21" name="localhost"
      availability="0.0">
        <properties>
          <property name="CRITICAL" count="0" />
          <property name="WARNING" count="0" />
          <property name="UNKNOWN" count="0" />
          <property name="OK" count="19" />
          <property name="PENDING" count="0" />
          <property name="SCHEDULED CRITICAL" count="0" />
          <property name="UNSCHEDULED CRITICAL" count="2" />
        </properties>
      </statistic>
      <statistic totalHosts="1" totalServices="1" name="support-xp-1"
      availability="0.0">
        <properties>
          <property name="CRITICAL" count="0" />
          <property name="WARNING" count="0" />
          <property name="UNKNOWN" count="0" />
          <property name="OK" count="0" />
          <property name="PENDING" count="0" />
          <property name="SCHEDULED CRITICAL" count="0" />
          <property name="UNSCHEDULED CRITICAL" count="1" />
        </properties>
      </statistic>
    </statistics>
  4. Host Group Statistics group by Host Group
    <statistics>
      <statistic totalHosts="2" totalServices="23" name="IT"
      availability="100.0">
        <properties>
          <property name="DOWN" count="0" />
          <property name="UNREACHABLE" count="0" />
          <property name="PENDING" count="0" />
          <property name="UP" count="2" />
          <property name="SCHEDULED DOWN" count="0" />
          <property name="UNSCHEDULED DOWN" count="0" />
        </properties>
      </statistic>
      <statistic totalHosts="1" totalServices="4" name="HG1"
      availability="100.0">
        <properties>
          <property name="DOWN" count="0" />
          <property name="UNREACHABLE" count="0" />
          <property name="PENDING" count="0" />
          <property name="UP" count="1" />
          <property name="SCHEDULED DOWN" count="0" />
          <property name="UNSCHEDULED DOWN" count="0" />
        </properties>
      </statistic>
      <statistic totalHosts="5" totalServices="75" name="Engineering"
      availability="60.0">
        <properties>
          <property name="DOWN" count="0" />
          <property name="UNREACHABLE" count="0" />
          <property name="PENDING" count="0" />
          <property name="UP" count="3" />
          <property name="SCHEDULED DOWN" count="0" />
          <property name="UNSCHEDULED DOWN" count="2" />
        </properties>
      </statistic>
      <statistic totalHosts="10" totalServices="55"
      name="Linux Servers" availability="100.0">
        <properties>
          <property name="DOWN" count="0" />
          <property name="UNREACHABLE" count="0" />
          <property name="PENDING" count="0" />
          <property name="UP" count="10" />
          <property name="SCHEDULED DOWN" count="0" />
          <property name="UNSCHEDULED DOWN" count="0" />
        </properties>
      </statistic>
    </statistics>
  5. Service statistics grouped by host groups
    <?xml version="1.0" encoding="utf-8" standalone="yes"?>
    <statistics>
      <statistic totalHosts="2" totalServices="23" name="IT"
      availability="86.0">
        <properties>
          <property name="CRITICAL" count="0" />
          <property name="WARNING" count="0" />
          <property name="UNKNOWN" count="0" />
          <property name="OK" count="20" />
          <property name="PENDING" count="0" />
          <property name="SCHEDULED CRITICAL" count="0" />
          <property name="UNSCHEDULED CRITICAL" count="3" />
        </properties>
      </statistic>
      <statistic totalHosts="1" totalServices="4" name="HG1"
      availability="50.0">
        <properties>
          <property name="CRITICAL" count="0" />
          <property name="WARNING" count="0" />
          <property name="UNKNOWN" count="0" />
          <property name="OK" count="2" />
          <property name="PENDING" count="0" />
          <property name="SCHEDULED CRITICAL" count="0" />
          <property name="UNSCHEDULED CRITICAL" count="2" />
        </properties>
      </statistic>
      <statistic totalHosts="5" totalServices="75" name="Engineering"
      availability="88.0">
        <properties>
          <property name="CRITICAL" count="0" />
          <property name="WARNING" count="2" />
          <property name="UNKNOWN" count="0" />
          <property name="OK" count="66" />
          <property name="PENDING" count="0" />
          <property name="SCHEDULED CRITICAL" count="0" />
          <property name="UNSCHEDULED CRITICAL" count="7" />
        </properties>
      </statistic>
      <statistic totalHosts="10" totalServices="55"
      name="Linux Servers" availability="94.0">
        <properties>
          <property name="CRITICAL" count="0" />
          <property name="WARNING" count="0" />
          <property name="UNKNOWN" count="0" />
          <property name="OK" count="52" />
          <property name="PENDING" count="0" />
          <property name="SCHEDULED CRITICAL" count="0" />
          <property name="UNSCHEDULED CRITICAL" count="3" />
        </properties>
      </statistic>
      <statistic totalHosts="4" totalServices="12" name="Support"
      availability="75.0">
        <properties>
          <property name="CRITICAL" count="0" />
          <property name="WARNING" count="0" />
          <property name="UNKNOWN" count="0" />
          <property name="OK" count="9" />
          <property name="PENDING" count="0" />
          <property name="SCHEDULED CRITICAL" count="0" />
          <property name="UNSCHEDULED CRITICAL" count="3" />
        </properties>
      </statistic>
      <statistic totalHosts="5" totalServices="13" name="Eng-QA"
      availability="92.0">
        <properties>
          <property name="CRITICAL" count="0" />
          <property name="WARNING" count="0" />
          <property name="UNKNOWN" count="0" />
          <property name="OK" count="12" />
          <property name="PENDING" count="0" />
          <property name="SCHEDULED CRITICAL" count="0" />
          <property name="UNSCHEDULED CRITICAL" count="1" />
        </properties>
      </statistic>
      <statistic totalHosts="4" totalServices="9" name="Eng-test"
      availability="66.0">
        <properties>
          <property name="CRITICAL" count="0" />
          <property name="WARNING" count="0" />
          <property name="UNKNOWN" count="0" />
          <property name="OK" count="6" />
          <property name="PENDING" count="0" />
          <property name="SCHEDULED CRITICAL" count="0" />
          <property name="UNSCHEDULED CRITICAL" count="3" />
        </properties>
      </statistic>
    </statistics>
  6. Service statistics grouped by hosts
    <?xml version="1.0" encoding="utf-8" standalone="yes"?>
    <statistics>
      <statistic totalHosts="1" totalServices="21" name="localhost"
      availability="0.0">
        <properties>
          <property name="CRITICAL" count="0" />
          <property name="WARNING" count="0" />
          <property name="UNKNOWN" count="0" />
          <property name="OK" count="19" />
          <property name="PENDING" count="0" />
          <property name="SCHEDULED CRITICAL" count="0" />
          <property name="UNSCHEDULED CRITICAL" count="2" />
        </properties>
      </statistic>
      <statistic totalHosts="1" totalServices="1" name="support-xp-1"
      availability="0.0">
        <properties>
          <property name="CRITICAL" count="0" />
          <property name="WARNING" count="0" />
          <property name="UNKNOWN" count="0" />
          <property name="OK" count="0" />
          <property name="PENDING" count="0" />
          <property name="SCHEDULED CRITICAL" count="0" />
          <property name="UNSCHEDULED CRITICAL" count="1" />
        </properties>
      </statistic>
    </statistics>
  7. Service statistics grouped by a host group
    <?xml version="1.0" encoding="utf-8" standalone="yes"?>
    <statistics>
      <statistic totalHosts="0" totalServices="2" name="SG1"
      availability="100.0">
        <properties>
          <property name="CRITICAL" count="0" />
          <property name="WARNING" count="0" />
          <property name="UNKNOWN" count="0" />
          <property name="OK" count="2" />
          <property name="PENDING" count="0" />
          <property name="SCHEDULED CRITICAL" count="0" />
          <property name="UNSCHEDULED CRITICAL" count="0" />
        </properties>
      </statistic>
    </statistics>
  8. Service statistics grouped by a service groups
    <?xml version="1.0" encoding="utf-8" standalone="yes"?>
    <statistics>
      <statistic totalHosts="0" totalServices="8" name="web-svr"
                    availability="75.0">
        <properties>
          <property name="CRITICAL" count="0" />
          <property name="WARNING" count="0" />
          <property name="UNKNOWN" count="0" />
          <property name="OK" count="6" />
          <property name="PENDING" count="0" />
          <property name="SCHEDULED CRITICAL" count="0" />
          <property name="UNSCHEDULED CRITICAL" count="2" />
        </properties>
      </statistic>
      <statistic totalHosts="0" totalServices="2" name="SG1"
                     availability="100.0">
        <properties>
          <property name="CRITICAL" count="0" />
          <property name="WARNING" count="0" />
          <property name="UNKNOWN" count="0" />
          <property name="OK" count="2" />
          <property name="PENDING" count="0" />
          <property name="SCHEDULED CRITICAL" count="0" />
          <property name="UNSCHEDULED CRITICAL" count="0" />
        </properties>
      </statistic>
    </statistics>
  9. Host availability for a host group named HG1
    <?xml version="1.0" encoding="utf-8" standalone="yes"?>
    <statistic availability="100.0" queryBy="hosts"
                  queryParam="hostGroup" queryValue="HG1" />
  10. Service availability for a host group named HG1
    <?xml version="1.0" encoding="utf-8" standalone="yes"?>
    <statistic availability="50.0" queryBy="services"
                   queryParam="hostGroup" queryValue="HG1" />
  11. Service availability for a service group named SG1
    <?xml version="1.0" encoding="utf-8" standalone="yes"?>
    <statistic availability="100.0" queryBy="services"
                  queryParam="serviceGroup" queryValue="SG1" />
2.7 Categories XML

(toc)

2.7.1 Categories - Response Data - Shallow XML
<category id="67" name="TEST-2" entityTypeName="SERVICE_GROUP" root="true">
  <childNames>
    <childName>TEST-B</childName>
  </childNames>
</category>
2.7.2 Categories - Response Data - Deep XML
<category id="67" name="TEST-2" entityTypeName="SERVICE_GROUP" root="true">
  <childNames>
    <childName>TEST-B</childName>
  </childNames>
  <applicationType/>
  <entityType id="23" name="SERVICE_GROUP" description="com.groundwork.collage.model.impl.ServiceGroup" isLogicalEntity="true" applicationTypeSupported="false"/>
  <children>
    <category id="69" name="TEST-B" entityTypeName="SERVICE_GROUP" root="false">
      <parentNames>
        <parentName>TEST-A</parentName>
        <parentName>TEST-2</parentName>
      </parentNames>
    </category>
  </children>
</category>
2.7.3 Categories - Response Data - Full XML
<category id="67" name="TEST-2" entityTypeName="SERVICE_GROUP" root="true">
  <childNames>
    <childName>TEST-B</childName>
  </childNames>
  <applicationType/>
  <entityType id="23" name="SERVICE_GROUP" description="com.groundwork.collage.model.impl.ServiceGroup" isLogicalEntity="true" applicationTypeSupported="false"/>
  <children>
    <category id="69" name="TEST-B" entityTypeName="SERVICE_GROUP" root="false">
      <parentNames>
        <parentName>TEST-A</parentName>
        <parentName>TEST-2</parentName>
      </parentNames>
      <applicationType/>
      <entityType id="23" name="SERVICE_GROUP" description="com.groundwork.collage.model.impl.ServiceGroup" isLogicalEntity="true" applicationTypeSupported="false"/>
      <parents>
        <category id="68" name="TEST-A" entityTypeName="SERVICE_GROUP" root="true">
          <childNames>
            <childName>TEST-B</childName>
          </childNames>
        </category>
        <category id="67" name="TEST-2" entityTypeName="SERVICE_GROUP" root="true">
          <childNames>
            <childName>TEST-B</childName>
          </childNames>
        </category>
      </parents>
      <entities>
        <entity id="32" objectID="1024" entityTypeId="2" entityTypeName="SERVICE_STATUS"/>
      </entities>
    </category>
  </children>
</category>
2.7.4 Categories Query - Response Data - Shallow XML
<categories>
  <category id="66" name="TEST-1" entityTypeName="SERVICE_GROUP" root="true"/>
  <category id="67" name="TEST-2" entityTypeName="SERVICE_GROUP" root="true">
    <childNames>
      <childName>TEST-B</childName>
    </childNames>
  </category>
  <category id="68" name="TEST-A" entityTypeName="SERVICE_GROUP" root="true">
    <childNames>
      <childName>TEST-B</childName>
    </childNames>
  </category>
  <category id="69" name="TEST-B" entityTypeName="SERVICE_GROUP" root="false">
    <parentNames>
      <parentName>TEST-2</parentName>
      <parentName>TEST-A</parentName>
    </parentNames>
  </category>
</categories>
2.7.5 Categories Post - Post Data XML
<categories>
  <category name="TEST-A" entityTypeName="SERVICE_GROUP"/>
  <category name="TEST-B" entityTypeName="SERVICE_GROUP">
    <entities>
      <entity objectID="1024" entityTypeName="SERVICE_STATUS"/>
    </entities>
  </category>
</categories>
2.7.6 Categories Put - Post Data XML
<categoryUpdates>
  <categoryUpdate entityTypeName="SERVICE_GROUP" categoryName="TEST-A" create="AS_ROOT"/>
  <categoryUpdate entityTypeName="SERVICE_GROUP" categoryName="TEST-B" create="AS_CHILD" parentName="TEST-A"/>
  <categoryUpdate entityTypeName="SERVICE_GROUP" categoryName="TEST-B" modify="ADD_CHILD">
    <otherCategoryNames>
      <categoryName>TEST-2</categoryName>
    </otherCategoryNames>
  </categoryUpdate>
</categoryUpdates>
2.8 Property Types XML

(toc)

2.8.1 Property Types Query Response Data XML

Primary Key:

<propertyType id="37" name="30DayMovingAvg"  description="" dataType="DOUBLE" />

Query:

<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<propertyTypes>
  <propertyType id="37" name="30DayMovingAvg"  description="" dataType="DOUBLE" />
  <propertyType id="40" name="AcknowledgeComment"  description="" dataType="STRING" />
</propertyTypes>
2.8.2 Property Types Post Data XML
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<propertyTypes>
  <propertyType name="unusedCPU" description="Measures unused CPU usage" dataType="DOUBLE" />
  <propertyType name="virtualName" description="Name of virtual app" dataType="STRING" />
</propertyTypes>
2.9 Application Types XML

(toc)

2.9.1 Application Types Query Response Data XML

Lookup, Shallow:

<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<applicationType id="200" name="VEMA"
                 description="Virtual Environment Monitor Agent"
                 stateTransitionCriteria="Device;Host;ServiceDescription" />

Lookup, Deep:

<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<applicationType id="200" name="VEMA"
         description="Virtual Environment Monitor Agent"
         stateTransitionCriteria="Device;Host;ServiceDescription">
  <properties>
    <property name="ApplicationType" value="VEMA" />
    <property name="STAT_SERVICE_STATUS_UNKNOWN" value="0" />
    <property name="Description" value="0" />
    <property name="STAT_SERVICE_STATUS_WARNING" value="30" />
    <property name="STAT_SERVICE_STATUS_UNSCHEDULED CRITICAL"
    value="22" />
    <property name="STAT_HOST_STATUS_UNREACHABLE" value="0" />
    <property name="ServiceCount" value="710" />
    <property name="STAT_HOST_STATUS_SCHEDULED DOWN" value="43" />
    <property name="HostCount" value="135" />
    <property name="STAT_SERVICE_STATUS_PENDING" value="21" />
    <property name="STAT_HOST_STATUS_UNSCHEDULED DOWN"
    value="12" />
    <property name="STAT_HOST_STATUS_DOWN" value="0" />
    <property name="STAT_SERVICE_STATUS_SCHEDULED CRITICAL"
    value="0" />
    <property name="STAT_HOST_STATUS_PENDING" value="1" />
    <property name="STAT_SERVICE_STATUS_CRITICAL" value="0" />
    <property name="STAT_HOST_STATUS_UP" value="76" />
    <property name="ApplicationTypeId" value="200" />
    <property name="STAT_SERVICE_STATUS_OK" value="636" />
  </properties>
  <entityProperties>
    <entityProperty>
      <entityType>HOST_STATUS</entityType>
      <propertyType>isAcknowledged</propertyType>
      <sortOrder>82</sortOrder>
    </entityProperty>
    <entityProperty>
      <entityType>HOST_STATUS</entityType>
      <propertyType>LastPluginOutput</propertyType>
      <sortOrder>80</sortOrder>
    </entityProperty>
    <entityProperty>
      <entityType>SERVICE_STATUS</entityType>
      <propertyType>LastPluginOutput</propertyType>
      <sortOrder>81</sortOrder>
    </entityProperty>
    <entityProperty>
      <entityType>SERVICE_STATUS</entityType>
      <propertyType>PerformanceData</propertyType>
      <sortOrder>83</sortOrder>
    </entityProperty>
  </entityProperties>
  <entityTypes>
    <entityType id="1" name="HOST_STATUS"
    description="com.groundwork.collage.model.impl.HostStatus"
    isLogicalEntity="false" applicationTypeSupported="false" />
    <entityType id="2" name="SERVICE_STATUS"
    description="com.groundwork.collage.model.impl.ServiceStatus"
    isLogicalEntity="false" applicationTypeSupported="false" />
  </entityTypes>
</applicationType>

Collection of Application Types from Query, Shallow:

<applicationTypes>
  <applicationType id="104" name="ARCHIVE"
  description="Archiving related messages"
  stateTransitionCriteria="Device;Host" />
  <applicationType id="105" name="BSM"
  description="Business Service Monitoring"
  stateTransitionCriteria="Device;Host" />
  <applicationType id="103" name="CHRHEV"
  description="Cloud Hub for Red Hat Virtualization"
  stateTransitionCriteria="Device;Host;ServiceDescription" />
  <applicationType id="101" name="GDMA"
  description="System monitored by GDMA"
  stateTransitionCriteria="Device;Host;ServiceDescription" />
  <applicationType id="100" name="NAGIOS"
  description="System monitored by Nagios"
  stateTransitionCriteria="Device;Host;ServiceDescription" />
  <applicationType id="102" name="NOMA"
  description="NoMa Notification"
  stateTransitionCriteria="Device;Host;ServiceDescription" />
  <applicationType id="106" name="SNMPTRAP"
  description="SNMP Trap application"
  stateTransitionCriteria="Device;Event_OID_numeric" />
  <applicationType id="107" name="SYSLOG"
  description="SYSLOG application"
  stateTransitionCriteria="Device" />
  <applicationType id="1" name="SYSTEM"
  description="Properties that exist regardless of the Application being monitored"
  stateTransitionCriteria="Device" />
  <applicationType id="200" name="VEMA"
  description="Virtual Environment Monitor Agent"
  stateTransitionCriteria="Device;Host;ServiceDescription" />
</applicationTypes>
2.9.2 Application Types Post Data XML
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<applicationTypes>
  <applicationType name="DAVE" description="Virtual Environment Monitor Agent"
                   stateTransitionCriteria="Device;Host;ServiceDescription">
  <entityProperties>
    <entityProperty>
      <entityType>HOST_STATUS</entityType>
      <propertyType>isAcknowledged</propertyType>
      <sortOrder>52</sortOrder>
    </entityProperty>
    <entityProperty>
      <entityType>HOST_STATUS</entityType>
      <propertyType>LastPluginOutput</propertyType>
      <sortOrder>53</sortOrder>
    </entityProperty>
    <entityProperty>
      <entityType>SERVICE_STATUS</entityType>
      <propertyType>LastPluginOutput</propertyType>
      <sortOrder>54</sortOrder>
    </entityProperty>
    <entityProperty>
      <entityType>SERVICE_STATUS</entityType>
      <propertyType>PerformanceData</propertyType>
      <sortOrder>55</sortOrder>
    </entityProperty>
  </entityProperties>
</applicationType>
</applicationTypes>
2.10 Entity Types XML

(toc)

2.10.1 Entity Types Query Response Data XML

Lookup:

<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<entityType id="15" name="STATE_TYPE"
description="com.groundwork.collage.model.impl.StateType"
isLogicalEntity="false" applicationTypeSupported="false" />

Query:

<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<entityTypes>
<entityType id="7" name="APPLICATION_TYPE"
description="com.groundwork.collage.model.impl.ApplicationType"
isLogicalEntity="false" applicationTypeSupported="false" />
<entityType id="8" name="CATEGORY"
description="com.groundwork.collage.model.impl.Category"
isLogicalEntity="false" applicationTypeSupported="false" />
<entityType id="9" name="CHECK_TYPE"
description="com.groundwork.collage.model.impl.CheckType"
isLogicalEntity="false" applicationTypeSupported="false" />
<entityType id="10" name="COMPONENT"
description="com.groundwork.collage.model.impl.Component"
isLogicalEntity="false" applicationTypeSupported="false" />
</entityTypes>
2.11 Consolidation XML

(toc)

2.11.1 Consolidation Query Response Data XML

Lookup:

<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<consolidation id="4" name="SYSLOG"
criteria="OperationStatus;Device;MonitorStatus;ipaddress;ErrorType;SubComponent"/>

Query:

<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<consolidations>
<consolidation id="2" name="NAGIOSEVENT"
criteria="Device;MonitorStatus;OperationStatus;SubComponent;ErrorType" />
<consolidation id="3" name="SNMPTRAP" criteria="OperationStatus;Device;ipaddress;MonitorStatus;Event_OID_numeric;Event_Name;Category;Variable_Bindings" />
<consolidation id="4" name="SYSLOG"
criteria="OperationStatus;Device;MonitorStatus;ipaddress;ErrorType;SubComponent" />
<consolidation id="1" name="SYSTEM"
criteria="OperationStatus;Device;MonitorStatus;ApplicationType;TextMessage" />
</consolidations>
2.11.2 Consolidation Post Data Data XML
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<consolidations>
<consolidation name='VEMA' criteria='MonitorStatus;ApplicationType'/>
<consolidation name='BMS' criteria='Device;ApplicationType'/>
</consolidations>
2.12 Notifications XML

(toc)

2.12.1 Host Notification POST Data XML
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<notifications>
<notification
hostName='server-12'
hostAddress='10.0.0.11'
hostGroupNames='group-21,group-22'
hostNotificationId=''
hostOutput='Hypervisor cannot be reached to determine the status'
hostState='PENDING'
notificationComment='Cloud Hub Host Notification'
notificationRecipients=''
notificationType='RECOVERY'
checkDateTime='2014-04-14 07:21:'
notificationAuthOrAlias=''
/>
<notification
hostName='server-13'
hostAddress='10.0.0.12'
hostGroupNames='group-21,group-22'
hostNotificationId=''
hostOutput='Application Server is rebooting'
hostState='PENDING'
notificationComment='Java Agent Host Notification'
notificationRecipients=''
notificationType='PROBLEM'
checkDateTime=''
notificationAuthOrAlias=''
/>
</notifications>
2.12.2 Service Notification POST Data XML
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<notifications>
<notification
hostName='server-12'
serviceDescription='local_cpu_nagios'
hostAddress='10.0.0.11'
hostGroupNames='group-21,group-22'
hostAlias='host1'
serviceGroupNames='sg1,sg2'
serviceOutput='Service cannot be reached to determine the status'
serviceState='UNKNOWN'
serviceNotificationId='433'
notificationComment='Cloud Hub Host Notification'
notificationRecipients='[email protected]'
notificationType='RECOVERY'
checkDateTime='2014-04-14 07:21:33'
notificationAuthOrAlias='alias'
/>
<notification
hostName='server-13'
serviceDescription='vm.cpu_util'
hostAddress='10.0.0.12'
hostGroupNames='group-21,group-22'
hostAlias='host2'
serviceGroupNames='sg3,sg4'
serviceOutput='Service cannot be reached to determine the status'
serviceState='UNKNOWN'
serviceNotificationId='433'
notificationComment='Cloud Hub Host Notification'
notificationRecipients='[email protected]'
notificationType='RECOVERY'
checkDateTime='2014-04-14 07:21:33'
notificationAuthOrAlias='alias'
/>
</notifications>
2.13 Perf Data XML

(toc)

2.13.1 Perf Data POST XML
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<perfDataList>
  <perfData appType="VEMA" serverName="localhost" serverTime="1397512737" serviceName="freespace" label="FreeSpace"
            value="334333" warning="600" critical="800"/>
  <perfData appType="VEMA" serverName="localhost" serverTime="1397512737" serviceName="load" label="LoadFactor"
            value="0.9" warning="4.0" critical="5.0" cpuTag="0" typeTag="core">
    <tagNames>
      <tagName>test</tagName>
    </tagNames>
    <tagValues>
      <tagValue>value</tagValue>
    </tagValues>
  </perfData>
</perfDataList>
2.13.2 Performance Time Series XML Data
<perfDataTimeSeries appType="VEMA" serverName="loadtest-vm-0" serviceName="loadtest-vm-metric-0" startTime="1443208066000" endTime="1443208366000" interval="30000">
    <perfDataTimeSeriesValue valueType="value" timestamp="1443208110000" value="36.0"/>
    <perfDataTimeSeriesValue valueType="value" timestamp="1443208170000" value="27.0"/>
    <perfDataTimeSeriesValue valueType="value" timestamp="1443208230000" value="20.0"/>
    <perfDataTimeSeriesValue valueType="value" timestamp="1443208290000" value="13.0"/>
    <perfDataTimeSeriesValue valueType="thold-c" timestamp="1443208110000" value="100.0"/>
    <perfDataTimeSeriesValue valueType="thold-c" timestamp="1443208170000" value="100.0"/>
    <perfDataTimeSeriesValue valueType="thold-c" timestamp="1443208230000" value="100.0"/>
    <perfDataTimeSeriesValue valueType="thold-c" timestamp="1443208290000" value="100.0"/>
    <perfDataTimeSeriesValue valueType="thold-w" timestamp="1443208110000" value="90.0"/>
    <perfDataTimeSeriesValue valueType="thold-w" timestamp="1443208170000" value="90.0"/>
    <perfDataTimeSeriesValue valueType="thold-w" timestamp="1443208230000" value="90.0"/>
    <perfDataTimeSeriesValue valueType="thold-w" timestamp="1443208290000" value="90.0"/>
</perfDataTimeSeries>
2.14 Audit Log XML

(toc)

2.14.1 Audit Log - Response Data - XML
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<auditLogs>
    <auditLog auditLogId="30" subsystem="SV" hostName="server_2" action="DELETE" description="Test deletion server 2." username="admin" timestamp="2014-09-26T14:03:24.515-0600" serviceDescription="network_users"/>
    <auditLog auditLogId="29" subsystem="SV" hostName="server_2" action="ADD" description="Test addition server 2." username="admin" timestamp="2014-09-26T14:03:24.515-0600" serviceDescription="local_processes"/>
</auditLogs>
2.15 Host Identity XML

(toc)

2.15.1 Host Identity - Response Data - XML
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<hostIdentity hostIdentityId="5d33537c-293e-4564-b0cf-d0998389b31f" hostName="test-host-name-2" host="false"><hostNames><hostName>test-host-name-2</hostName><hostName>46eb4a5b-a08e-470b-9be7-8108aa5a2cc7</hostName></hostNames></hostIdentity>
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<hostIdentities>
    <hostIdentity hostIdentityId="11c2d250-6437-11e4-9584-002219ed08d3" hostName="test-host-name-0" host="false"><hostNames><hostName>test-host-name-0</hostName></hostNames></hostIdentity>
    <hostIdentity hostIdentityId="12042cdc-6437-11e4-9585-002219ed08d3" hostName="test-host-name-1" host="false"><hostNames><hostName>test-host-name-1</hostName><hostName>test-host-name-1.0</hostName><hostName>test-host-name-1.1</hostName></hostNames></hostIdentity>
    <hostIdentity hostIdentityId="5d33537c-293e-4564-b0cf-d0998389b31f" hostName="test-host-name-2" host="false"><hostNames><hostName>46eb4a5b-a08e-470b-9be7-8108aa5a2cc7</hostName><hostName>test-host-name-2</hostName></hostNames></hostIdentity>
</hostIdentities>
2.15.2 Host Identity Autocomplete - Response Data - XML
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<names>
    <name>localhost</name>
    <name>localhost2</name>
</names>
2.16 Host Blacklist XML

(toc)

2.16.1 Host Blacklist - Response Data - XML
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<hostBlacklist hostBlacklistId="12" hostName="test-host-name-2"/>
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<hostBlacklists>
    <hostBlacklist hostBlacklistId="10" hostName="test-host-name-0"/>
    <hostBlacklist hostBlacklistId="11" hostName="test-host-name-1"/>
    <hostBlacklist hostBlacklistId="12" hostName="test-host-name-2"/>
</hostBlacklists>
2.17 Biz Downtime XML

(toc)

2.17.1 Biz Downtime - Request Data - XML
<bizHostsAndServices>
  <hostNames>
    <hostName>localhost</hostName>
  </hostNames>
  <serviceDescriptions>
    <serviceDescription>local_memory</serviceDescription>
  </serviceDescriptions>
</bizHostsAndServices>
<bizHostsAndServices>
  <hostNames>
    <hostName>*</hostName>
  </hostNames>
  <hostGroupNames>
    <hostGroupName>Linux Servers</hostGroupName>
  </hostGroupNames>
</bizHostsAndServices>
<bizHostsAndServices>
  <hostNames>
    <hostName>*</hostName>
  </hostNames>
  <serviceDescriptions>
    <serviceDescription>*</serviceDescription>
  </serviceDescriptions>
  <serviceGroupCategoryNames>
    <serviceGroupCategoryName>Linux Services</serviceGroupCategoryName>
  </serviceGroupCategoryNames>
</bizHostsAndServices>
2.17.2 Biz Downtime - Response Data - XML
<bizHostServiceInDowntimes>
   <bizHostServiceInDowntime hostName="localhost" serviceDescription="local_memory" scheduledDowntimeDepth="0" entityType="SERVICE_STATUS" entityName="local_memory"/>
</bizHostServiceInDowntimes>
2.18 Device Template Profile XML

(toc)

2.18.1 Device Template Profile - Response Data - XML
<deviceTemplateProfile deviceTemplateProfileId="37" deviceIdentification="test-device-identification-0" deviceDescription="test device identification 0" timestamp="2014-11-26T11:01:29.516-0700"/>
<deviceTemplateProfiles>
    <deviceTemplateProfile deviceTemplateProfileId="37" deviceIdentification="test-device-identification-0" deviceDescription="test device identification 0" timestamp="2014-11-26T11:01:29.516-0700"/>
    <deviceTemplateProfile deviceTemplateProfileId="38" deviceIdentification="test-device-identification-1" deviceDescription="test device identification 1" cactiHostTemplate="cacti-host-template" timestamp="2014-11-26T11:01:29.516-0700"/>
    <deviceTemplateProfile deviceTemplateProfileId="39" deviceIdentification="test-device-identification-2" deviceDescription="test device identification 2" monarchHostProfile="monarch-host-profile" timestamp="2014-11-26T11:01:29.516-0700"/>
</deviceTemplateProfiles>
2.19 Custom Groups XML

(toc)

2.19.1 Custom Group - Response Data
<customGroup id="15" name="TEST-CUSTOM-GROUP-0" description="TEST-CUSTOM-GROUP-0" appType="NAGIOS" agentId="TEST-AGENT" root="true">
  <hostGroups>
    <hostGroup id="4" name="TEST-HOST-GROUP-0" alias="TEST-HOST-GROUP-0" appType="NAGIOS"/>
  </hostGroups>
</customGroup>
2.19.2 Custom Groups Query - Response Data
<customGroups>
  <customGroup id="15" name="TEST-CUSTOM-GROUP-0" description="TEST-CUSTOM-GROUP-0" appType="NAGIOS" agentId="TEST-AGENT" root="true">
    <hostGroups>
      <hostGroup id="4" name="TEST-HOST-GROUP-0" alias="TEST-HOST-GROUP-0" appType="NAGIOS"/>
    </hostGroups>
  </customGroup>
  <customGroup id="16" name="TEST-CUSTOM-GROUP-1" agentId="TEST-AGENT" root="true">
    <serviceGroups>
      <serviceGroup id="10" name="TEST-SERVICE-GROUP-0"/>
    </serviceGroups>
  </customGroup>
</customGroups>
2.19.3 Custom Groups Post - Post Data
<customGroups>
  <customGroup name="TEST-CUSTOM-GROUP-0" description="TEST-CUSTOM-GROUP-0" appType="NAGIOS" agentId="TEST-AGENT">
    <hostGroupNames>
      <hostGroupName>TEST-HOST-GROUP-0</hostGroupName>
    </hostGroupNames>
  </customGroup>
  <customGroup name="TEST-CUSTOM-GROUP-1" agentId="TEST-AGENT">
    <serviceGroupNames>
      <serviceGroupName>TEST-SERVICE-GROUP-0</serviceGroupName>
    </serviceGroupNames>
  </customGroup>
  <customGroup name="TEST-CUSTOM-GROUP-2" appType="NAGIOS"/>
  <customGroup name="TEST-CUSTOM-GROUP-3"/>
</customGroups>
2.19.4 Custom Group Put - Post Data
<customGroup name="TEST-CUSTOM-GROUP-0">
  <hostGroupNames>
    <hostGroupName>TEST-HOST-GROUP-1</hostGroupName>
  </hostGroupNames>
</customGroup>
2.19.5 Custom Group Autocomplete - Response Data
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<names>
    <name>CG1</name>
    <name>CG2</name>
</names>
2.20 Service Groups XML

(toc)

2.20.1 Service Group - Response Data, (service properties elided here for the sake of brevity)
<serviceGroup id="30" name="SG-200" description="Service Group 200" appType="VEMA" appTypeDisplayName="VEMA" agentId="Agent-007">
  <services>
    <service id="2" appType="NAGIOS" description="local_cpu_java" monitorStatus="OK" lastCheckTime="2013-05-22T10:37:15.000-0600" nextCheckTime="2013-05-22T10:47:15.000-0600" lastStateChange="2013-05-17T08:57:15.000-0600" hostName="localhost" stateType="HARD" checkType="ACTIVE" lastHardState="PENDING" monitorServer="localhost" deviceIdentification="127.0.0.1" lastPlugInOutput="1^^^3^^^0^^^05/17/2013 08:57:15 AM^^^OK - total %CPU for process java : 2.8^^^%CPU=2.8;40;50">
      <properties/>
    </service>
    <service id="4" appType="NAGIOS" description="local_cpu_perl" monitorStatus="OK" lastCheckTime="2013-05-22T10:36:13.000-0600" nextCheckTime="2013-05-22T10:46:13.000-0600" lastStateChange="2013-05-17T08:46:12.000-0600" hostName="localhost" stateType="HARD" checkType="ACTIVE" lastHardState="PENDING" monitorServer="localhost" deviceIdentification="127.0.0.1" lastPlugInOutput="1^^^3^^^0^^^05/17/2013 08:46:12 AM^^^OK - total %CPU for process perl : 0.7^^^%CPU=0.7;40;50">
      <properties/>
    </service>
  </services>
</serviceGroup>
2.20.2 Service Groups Query - Response Data, (service properties elided here for the sake of brevity)
<serviceGroups>
  <serviceGroup id="30" name="SG-200" description="Service Group 200" appType="VEMA" appTypeDisplayName="VEMA" agentId="Agent-007">
    <services>
      <service id="2" appType="NAGIOS" description="local_cpu_java" monitorStatus="OK" lastCheckTime="2013-05-22T10:37:15.000-0600" nextCheckTime="2013-05-22T10:47:15.000-0600" lastStateChange="2013-05-17T08:57:15.000-0600" hostName="localhost" stateType="HARD" checkType="ACTIVE" lastHardState="PENDING" monitorServer="localhost" deviceIdentification="127.0.0.1" lastPlugInOutput="1^^^3^^^0^^^05/17/2013 08:57:15 AM^^^OK - total %CPU for process java : 2.8^^^%CPU=2.8;40;50">
        <properties/>
      </service>
      <service id="4" appType="NAGIOS" description="local_cpu_perl" monitorStatus="OK" lastCheckTime="2013-05-22T10:36:13.000-0600" nextCheckTime="2013-05-22T10:46:13.000-0600" lastStateChange="2013-05-17T08:46:12.000-0600" hostName="localhost" stateType="HARD" checkType="ACTIVE" lastHardState="PENDING" monitorServer="localhost" deviceIdentification="127.0.0.1" lastPlugInOutput="1^^^3^^^0^^^05/17/2013 08:46:12 AM^^^OK - total %CPU for process perl : 0.7^^^%CPU=0.7;40;50">
        <properties/>
      </service>
    </services>
  </serviceGroup>
</serviceGroups>
2.20.3 Service Groups Post - Post Data
<serviceGroups>
  <serviceGroup name="SG-200" description="Service Group 200" appType="VEMA" agentId="Agent-007">
    <services>
      <service service="local_cpu_java" host="localhost"/>
      <service service="local_cpu_perl" host="localhost"/>
    </services>
  </serviceGroup>
</serviceGroups>
2.20.4 Service Group Put - Post Data
<serviceGroup name="SG-200">
  <services>
    <service service="local_load" host="localhost"/>
  </services>
</serviceGroup>
2.20.5 Service Group Autocomplete - Response Data
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<names>
    <name>SG1</name>
    <name>SG2</name>
</names>
2.21 Biz Service Authorization XML

(toc)

2.21.1 Biz Service Authorization - Request Data - XML
<bizAuthorization>
    <hostGroupNames>
        <hostGroupName>Linux Servers</hostGroupName>
    </hostGroupNames>
</bizAuthorization>
2.21.2 Biz Service Authorization - Response Data - XML
<bizAuthorizedServices>
    <hostNames>
        <hostName>localhost</hostName>
    </hostNames>
    <serviceHostNames>
        <serviceHostMap>
            <serviceHostMapEntry serviceName="local_cpu_httpd">
                <hostNames>
                    <hostName>localhost</hostName>
                </hostNames>
            </serviceHostMapEntry>
            <serviceHostMapEntry serviceName="local_cpu_java">
                <hostNames>
                    <hostName>localhost</hostName>
                </hostNames>
            </serviceHostMapEntry>
            <serviceHostMapEntry serviceName="local_cpu_syslog-ng">
                <hostNames>
                    <hostName>localhost</hostName>
                </hostNames>
            </serviceHostMapEntry>
            <serviceHostMapEntry serviceName="local_swap">
                <hostNames>
                    <hostName>localhost</hostName>
                </hostNames>
            </serviceHostMapEntry>
            <serviceHostMapEntry serviceName="local_process_nagios">
                <hostNames>
                    <hostName>localhost</hostName>
                </hostNames>
            </serviceHostMapEntry>
            <serviceHostMapEntry serviceName="tcp_http">
                <hostNames>
                    <hostName>localhost</hostName>
                </hostNames>
            </serviceHostMapEntry>
        </serviceHostMap>
    </serviceHostNames>
</bizAuthorizedServices>
2.22 Suggestions XML

(toc)

2.22.1 Suggestions - Query Response Data - XML
<suggestions count="18">
    <suggestions>
        <suggestion name="local_cpu_httpd" entityType="SERVICE"/>
        <suggestion name="local_cpu_java" entityType="SERVICE"/>
        <suggestion name="local_cpu_nagios" entityType="SERVICE"/>
    </suggestions>
</suggestions>
2.22.2 Suggestions - Names Response Data - XML
<names>
    <name>local_cpu_httpd</name>
    <name>local_cpu_java</name>
    <name>local_cpu_nagios</name>
    <name>local_cpu_perl</name>
</names>
2.23 License Check XML

(toc)

2.23.1 License Check - Check Response Data - XML
<licenseCheck success="true" message="OK to allocate 5 devices" devicesRequested="5" devices="1"/>
2.24 Biz Feeder XML

(toc)

2.24.1 Biz Create or Update Hosts - Hosts Request Data - XML
<hosts>
    <host host="host6" status="UP" message="UP" hostGroup="hosts" device="10.0.0.6" appType="NAGIOS" agentId="a4ca80e0-e855-43ee-86d8-f4e499f0a824" checkIntervalMinutes="5" allowInserts="true" mergeHosts="true" setStatusOnCreate="true">
        <services>
            <service host="host6" service="local_cpu_httpd" status="OK" message="OK - 10" serviceGroup="cpu" hostGroup="hosts" device="10.0.0.6" appType="NAGIOS" agentId="a4ca80e0-e855-43ee-86d8-f4e499f0a824" serviceValue="10" metricType="vm" warningLevel="50" criticalLevel="90" checkIntervalMinutes="5" allowInserts="true" mergeHosts="true" setStatusOnCreate="true"/>
            <service host="host6" service="local_cpu_java" status="OK" message="OK - 20" serviceGroup="cpu" hostGroup="hosts" device="10.0.0.6" appType="NAGIOS" agentId="a4ca80e0-e855-43ee-86d8-f4e499f0a824" serviceValue="20" metricType="vm" warningLevel="75" criticalLevel="90" checkIntervalMinutes="5" allowInserts="true" mergeHosts="true" setStatusOnCreate="true"/>
        </services>
    </host>
</hosts>
2.24.2 Biz Create or Update Hosts - Results Data - XML
<results successful="3" failed="0" entityType="Host" operation="Update" warning="0" count="3">
    <result>
        <entity>host6</entity>
        <location>http://localhost:8080/foundation-webapp/api/hosts/host6</location>
        <status>success</status>
        <message>Update</message>
    </result>
    <result>
        <entity>host6:local_cpu_httpd</entity>
        <location>http://localhost:8080/foundation-webapp/api/services/local_cpu_httpd%3FhostName=host6</location>
        <status>success</status>
        <message>Update</message>
    </result>
    <result>
        <entity>host6:local_cpu_java</entity>
        <location>http://localhost:8080/foundation-webapp/api/services/local_cpu_java%3FhostName=host6</location>
        <status>success</status>
        <message>Update</message>
    </result>
</results>
2.24.3 Biz Create or Update Services - Services Request Data - XML
<services>
    <service host="host6" service="local_cpu_httpd" status="PENDING" message="PENDING - new" serviceGroup="cpu" hostGroup="hosts" device="10.0.0.6" appType="NAGIOS" agentId="a4ca80e0-e855-43ee-86d8-f4e499f0a824" warningLevel="-1" criticalLevel="-1" checkIntervalMinutes="5" allowInserts="true" mergeHosts="true" setStatusOnCreate="false"/>
    <service host="host6" service="local_cpu_java" status="PENDING" message="PENDING - new" serviceGroup="cpu" hostGroup="hosts" device="10.0.0.6" appType="NAGIOS" agentId="a4ca80e0-e855-43ee-86d8-f4e499f0a824" warningLevel="-1" criticalLevel="-1" checkIntervalMinutes="5" allowInserts="true" mergeHosts="true" setStatusOnCreate="false"/>
</services>
2.24.4 Biz Create or Update Services - Results Data - XML
<results successful="3" failed="0" entityType="ServiceStatus" operation="Update" warning="0" count="3">
    <result>
        <entity>host6</entity>
        <location>http://localhost:8080/foundation-webapp/api/hosts/host6</location>
        <status>success</status>
        <message>Insert</message>
    </result>
    <result>
        <entity>host6:local_cpu_httpd</entity>
        <location>http://localhost:8080/foundation-webapp/api/services/local_cpu_httpd%3FhostName=host6</location>
        <status>success</status>
        <message>Insert</message>
    </result>
    <result>
        <entity>host6:local_cpu_java</entity>
        <location>http://localhost:8080/foundation-webapp/api/services/local_cpu_java%3FhostName=host6</location>
        <status>success</status>
        <message>Insert</message>
    </result>
</results>

Labels

restful restful Delete
rest rest Delete
api api Delete
xml xml Delete
Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.