Table Of Contents

Previous topic

Regular Expression Syntax

Next topic

The asagent MIBs

Manifest DTD

This section includes the DTD which is used to validate the manifest XML file.

AsManifestmaster.dtd

<?xml version="1.0" encoding="utf-8"?>
<!--
# Copyright (C) 2006, 2011, 2012 Abilisoft Ltd.
# http://abilisoft.com
#
# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
#
# Abilisoft Manifest Master DTD
#
# Manifest Master is the container for multiple manifest includes or plain 
# manfest definitions.
-->
<!-- XInclude DTD -->
<!ENTITY % xinclude SYSTEM "XInclude.dtd">
%xinclude;

<!-- Component DTD -->
<!ENTITY % component SYSTEM "AsComponent.dtd">
%component;

<!-- Fragment DTD -->
<!ENTITY % fragment SYSTEM "AsFragment.dtd">
%fragment;

<!-- Manifest ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~-->
<!-- Manifest optionally contains:                                          -->
<!--  * Manifest global action settings for Trap, Smtp, Cmd and Notify      -->
<!--    actions.                                                            -->
<!--  * Component(s) that will be monitored. (Note the Agent includes HOST  -->
<!--    type components (HOST_CPU, HOST_DISK, HOST_MEM and HOST_MON) by     -->
<!--    default.                                                            -->
<!--  * Components wrappers for XInclude-ed manifest fragments              -->
<!--  * CorbaInclude directives so that manifest fragments can be obtained  -->
<!--    from the spefified CORBA uri.                                       -->
<!--  * XInclude(s) so that manifest fragments can be obtained over HTTP.   -->
<!--    Note the the XInclude(s) may specify alternate xml, urls, or        -->
<!--    CorbaIncludes in fallback clauses.                                  -->
<!--  * Fragment. Beacuse sub-manifests must be well formed this element    -->
<!--    provides a container for them.                                      -->
<!ELEMENT Manifest (Global|Variable|Trap|Smtp|Cmd|Notify|Control|Tweet|Component|Components|CorbaInclude|xi:include|Fragment|User|hostgroup|urlgroup|authentication)*>
<!ATTLIST Manifest
  name          CDATA #REQUIRED
  label         CDATA #IMPLIED
  description   CDATA #IMPLIED
  owner         CDATA #IMPLIED
  updated       CDATA #REQUIRED
  effectiveFrom CDATA #REQUIRED
  img           CDATA #IMPLIED
  xmlns:xi      CDATA #FIXED "http://www.w3.org/2001/XInclude"
>

<!-- User Definitions ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~-->
<!ELEMENT User (Feature)*>
<!ATTLIST User
  name    CDATA #REQUIRED
  pwd     CDATA #REQUIRED
  encrypted CDATA #IMPLIED
>

<!ELEMENT Feature (#PCDATA)>
<!ATTLIST Feature
  name    CDATA #REQUIRED
>

<!-- CorbaInclude ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~-->
<!-- CorbaInclude can be used to get manifest fragments from the specified  -->
<!-- URI and document name. It is also used as a fallback in failed         -->
<!-- xi:include directives.                                                 -->
<!ELEMENT CorbaInclude EMPTY>
<!ATTLIST CorbaInclude
  uri      CDATA   #REQUIRED
  document CDATA   #REQUIRED
>


<!-- <hostgroup> -->

<!ELEMENT hostgroup (host|subnet|range)*>
<!ATTLIST hostgroup
          name CDATA #REQUIRED>

<!ELEMENT host (#PCDATA)>

<!ELEMENT subnet (net|exclude?|include?)>

<!ELEMENT range (start|stop)>

<!ELEMENT net (#PCDATA)>

<!ELEMENT exclude (host|range)*>

<!ELEMENT include (host|range)*>

<!ELEMENT start (#PCDATA)>

<!ELEMENT stop (#PCDATA)>


<!-- <urlgroup> -->
<!ELEMENT urlgroup (url)*>
<!ATTLIST urlgroup
          name CDATA #REQUIRED>

<!ELEMENT url EMPTY>
<!ATTLIST url
          url_id CDATA #REQUIRED
          url_addr CDATA #REQUIRED
>

<!-- <authentication> -->
<!ELEMENT authentication EMPTY> 
<!ATTLIST authentication
          name CDATA #REQUIRED
          username CDATA #IMPLIED 
          password CDATA #IMPLIED 
          realm CDATA #IMPLIED 
          type CDATA #IMPLIED 
>

AsFragment.dtd

<?xml version="1.0" encoding="utf-8"?>
<!--
#   Copyright (C) 2006, Abilisoft Ltd.
#   All Rights Reserved.
#   www.abilisoft.com
#   ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
#   This material contains the valuable properties and trade secrets of
#   Abilisoft Ltd, Ampthill, Beds, England. Embodying substantial creative
#   efforts and confidential information, ideas and expressions no part of
#   which may be reproduced or transmitted in any form or by any means
#   electronic, mechanical, or otherwise, including photocopying and recording
#   or in connection with any information storage or retrieval system without
#   the permission in writing from Abilisoft Ltd.
#
#   This application, in individual parts and/or its entirety is subject to a
#   Patent pending, application number 0610532.4, application reference 
#   EAD/NPP/24552GB dated 26 May 2006.
#
#   $Author: flub $
#   $Date: 2011-07-18 17:30:02 +0100 (Mon, 18 Jul 2011) $
#   $Revision: 10095 $
#   $HeadURL: https://earth.abilisoft.com/svn/tags/REL_TAG_donbot.0.2/mtmCore/dtd/AsFragment.dtd $
#
#   ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
#
#   Abilisoft Fragment DTD
#
#   Helper DTD for the inclusion mechanism. Included sub-manifests must be well
#   formed, this DTD specifies the Fragment element that provides a container 
#   for sub-manifest content.
-->

<!-- Parameter Entity. By default we ignore the xinclude and component includes 
     because they are defined in AsManifestMaster.dtd. However, if we want a 
     validated standalone "Fragment" XML document that specifies only this 
     DTD then override in the xml documents internal DTD as follows:

    <!DOCTYPE Fragment SYSTEM "../../dtd/AsFragment.dtd" [
      <!ENTITY % condition "INCLUDE">
    ]>

    This will force the "xinclude" and "component" DTD includes below.
-->
<!ENTITY % condition "IGNORE">

<!-- XInclude DTD -->
<![%condition;[
<!ENTITY % xinclude SYSTEM "XInclude.dtd">
%xinclude;

<!-- Component DTD -->
<!ENTITY % component SYSTEM "AsComponent.dtd">
%component;
]]>

<!-- Fragment ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~-->
<!ELEMENT Fragment (User|Component|CorbaInclude|xi:include|Monitor|Default|Global|Variable|Trap|Smtp|Cmd|Notify|Control|Tweet)*>
<!ATTLIST Fragment 
  xmlns:xi CDATA #FIXED "http://www.w3.org/2001/XInclude"
>

AsComponent.dtd

<?xml version="1.0" encoding="utf-8"?>
<!--
# Copyright (C) 2006-2010 Abilisoft Ltd.
# http://abilisoft.com

#   ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
#
#   Abilisoft Component DTD
#
#   A Component is a dual purpose definition that:
#
#    * Describes a supported platform component and how it is monitored. 
#      Typically a component is an application (e.g. Netcool Object Server) but
#      also includes "built-in components" for host health monitoring like cpu, 
#      disk and memory metrics.
#
#    * Describes how a supported platform comonent is monitored specifically
#      on a target server, the Component definition speficies the customised 
#      parameters, observations and actions the agent user needs.
#
-->

<!-- A component contains Monitor elements (sample settings) and optionally -->
<!-- default Action settings (Trap,Smtp,Cmd,Notify) that are applied or     -->
<!-- augmented by the individual monitor setting observations. Component    -->
<!-- definitions also provide "default" (<Default>) monitor settings used by-->
<!-- the system as a template for canned monitor types.                     -->
<!ELEMENT Component (Monitor|Default|Global|Variable|Trap|Smtp|Cmd|Notify|Control|Tweet|xi:include|Fragment)*>
<!ATTLIST Component
  name        CDATA #IMPLIED
  type        CDATA #IMPLIED
  label       CDATA #IMPLIED
  description CDATA #IMPLIED
  img         CDATA #IMPLIED
  xmlns:xi    CDATA #FIXED "http://www.w3.org/2001/XInclude"
>

<!-- Monitor Setting ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~-->

<!ELEMENT Monitor (Variable|Parameter|Observation)*>
<!ATTLIST Monitor
  name        CDATA #REQUIRED
  regex       CDATA #IMPLIED
  type        CDATA #IMPLIED 
  periodicity CDATA #IMPLIED
  enabled     CDATA #IMPLIED
  label       CDATA #IMPLIED
  description CDATA #IMPLIED
  img         CDATA #IMPLIED
>

<!-- Default Setting ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~-->

<!ELEMENT Default (Parameter|Observation)*>
<!ATTLIST Default
  type        CDATA #IMPLIED
  periodicity CDATA #IMPLIED
  enabled     CDATA #IMPLIED
  label       CDATA #IMPLIED
  description CDATA #IMPLIED
  img         CDATA #IMPLIED
>

<!-- Global Parameter ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~-->

<!ELEMENT Global (#PCDATA)>
<!ATTLIST Global
  name        CDATA #REQUIRED
  encrypted   CDATA #IMPLIED
  label       CDATA #IMPLIED
  description CDATA #IMPLIED
  img         CDATA #IMPLIED
>

<!-- Variable Parameter - copy of Global above ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~-->

<!ELEMENT Variable (#PCDATA)>
<!ATTLIST Variable
  name        CDATA #REQUIRED
  encrypted   CDATA #IMPLIED
  label       CDATA #IMPLIED
  description CDATA #IMPLIED
  img         CDATA #IMPLIED
>

<!-- Monitor Setting Parameter ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~-->

<!ELEMENT Parameter (#PCDATA)>
<!ATTLIST Parameter
  name        CDATA #REQUIRED
  index       CDATA #IMPLIED
  encrypted   CDATA #IMPLIED
  label       CDATA #IMPLIED
  description CDATA #IMPLIED
  img         CDATA #IMPLIED
>

<!-- Observation ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~-->

<!ELEMENT Observation (Test?, Message?, Suppression?, (Trap|Smtp|Cmd|Notify|Control|Tweet)*)*>
<!ATTLIST Observation
  name        CDATA #REQUIRED
  enabled     CDATA #IMPLIED
  label       CDATA #IMPLIED
  description CDATA #IMPLIED
  img         CDATA #IMPLIED
>

<!ELEMENT Test (Parameter)*>
<!ATTLIST Test
  name        CDATA #IMPLIED
  type        CDATA #IMPLIED
  edge        CDATA #IMPLIED
  label       CDATA #IMPLIED
  description CDATA #IMPLIED
  img         CDATA #IMPLIED
>

<!ELEMENT Message (#PCDATA)>

<!-- Obs Suppression ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~-->

<!ELEMENT Suppression (Weekday|Date)*>
<!ATTLIST Suppression
  name          CDATA #IMPLIED
  numberOfTimes CDATA #IMPLIED
  repeat        CDATA #IMPLIED
  label         CDATA #IMPLIED
  description   CDATA #IMPLIED
  img           CDATA #IMPLIED
>

<!ELEMENT Weekday EMPTY>
<!ATTLIST Weekday
  day       CDATA #IMPLIED
  startTime CDATA #IMPLIED
  endTime   CDATA #IMPLIED
>

<!ELEMENT Date EMPTY>
<!ATTLIST Date
  startDateTime CDATA #IMPLIED
  endDateTime   CDATA #IMPLIED
>

<!-- Obs Actions ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~-->

<!ELEMENT Trap (Parameter)*>
<!ATTLIST Trap
  name        CDATA #REQUIRED
  enabled     CDATA #IMPLIED
  label       CDATA #IMPLIED
  description CDATA #IMPLIED
  img         CDATA #IMPLIED
  retrycount  CDATA #IMPLIED
  retrydelay  CDATA #IMPLIED
>

<!ELEMENT Smtp (Parameter)*>
<!ATTLIST Smtp
  name        CDATA #REQUIRED
  enabled     CDATA #IMPLIED
  label       CDATA #IMPLIED
  description CDATA #IMPLIED
  img         CDATA #IMPLIED
  retrycount  CDATA #IMPLIED
  retrydelay  CDATA #IMPLIED
>

<!ELEMENT Cmd (Parameter)*>
<!ATTLIST Cmd
  name        CDATA #REQUIRED
  enabled     CDATA #IMPLIED
  label       CDATA #IMPLIED
  description CDATA #IMPLIED
  img         CDATA #IMPLIED
  retrycount  CDATA #IMPLIED
  retrydelay  CDATA #IMPLIED
>

<!ELEMENT Notify (Parameter)*>
<!ATTLIST Notify
  name        CDATA #REQUIRED
  enabled     CDATA #IMPLIED
  label       CDATA #IMPLIED
  description CDATA #IMPLIED
  img         CDATA #IMPLIED
  retrycount  CDATA #IMPLIED
  retrydelay  CDATA #IMPLIED
>

<!ELEMENT Control (Parameter)*>
<!ATTLIST Control
  name        CDATA #REQUIRED
  enabled     CDATA #IMPLIED
  label       CDATA #IMPLIED
  description CDATA #IMPLIED
  img         CDATA #IMPLIED
  retrycount  CDATA #IMPLIED
  retrydelay  CDATA #IMPLIED
>

<!ELEMENT Tweet (Parameter)*>
<!ATTLIST Tweet
  name        CDATA #REQUIRED
  enabled     CDATA #IMPLIED
  label       CDATA #IMPLIED
  description CDATA #IMPLIED
  img         CDATA #IMPLIED
  retrycount  CDATA #IMPLIED
  retrydelay  CDATA #IMPLIED
>

XInclude.dtd

<?xml version="1.0" encoding="utf-8"?>
<!--
#   Copyright (C) 2006, Abilisoft Ltd.
#   All Rights Reserved.
#   www.abilisoft.com
#   ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
#   This material contains the valuable properties and trade secrets of
#   Abilisoft Ltd, Ampthill, Beds, England. Embodying substantial creative
#   efforts and confidential information, ideas and expressions no part of
#   which may be reproduced or transmitted in any form or by any means
#   electronic, mechanical, or otherwise, including photocopying and recording
#   or in connection with any information storage or retrieval system without
#   the permission in writing from Abilisoft Ltd.
#
#   $Author: flub $
#   $Date: 2011-07-18 17:30:02 +0100 (Mon, 18 Jul 2011) $
#   $Revision: 10095 $
#   $HeadURL: https://earth.abilisoft.com/svn/tags/REL_TAG_donbot.0.2/mtmCore/dtd/XInclude.dtd $
#
#   ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
#
#   XInclude DTD
#
#   Specifies XInclude vocabulary.
-->
<!ELEMENT xi:include (xi:fallback?)>
<!ATTLIST xi:include
    xmlns:xi   CDATA       #FIXED    "http://www.w3.org/2001/XInclude"
    href       CDATA       #IMPLIED
    parse      (xml|text)  "xml"
    xpointer   CDATA       #IMPLIED
    encoding   CDATA       #IMPLIED
    accept     CDATA       #IMPLIED
    accept-language CDATA  #IMPLIED>

<!ELEMENT xi:fallback ANY>
<!ATTLIST xi:fallback
    xmlns:xi   CDATA   #FIXED   "http://www.w3.org/2001/XInclude">