XML Schema Documentation

Table of Contents

top

Schema Document Properties

Target Namespace http://xmlns.opennms.org/xsd/config/poller
Element and Attribute Namespaces
  • Global element and attribute declarations belong to this schema's target namespace.
  • By default, local element declarations have no namespace.
  • By default, local attribute declarations have no namespace.
Documentation XML Schema for the poller-configuration.xml configuration file. Version: $Id$

Declared Namespaces

Prefix Namespace
Default namespace http://www.w3.org/2001/XMLSchema
xml http://www.w3.org/XML/1998/namespace
xsi http://www.w3.org/2001/XMLSchema-instance
this http://xmlns.opennms.org/xsd/config/poller
ns2 http://www.w3.org/1999/xhtml
ns http://www.w3.org/2001/XMLSchema
hfp http://www.w3.org/2001/XMLSchema-hasFacetAndProperty
Schema Component Representation
<schema targetNamespace="http://xmlns.opennms.org/xsd/config/poller">
...
</schema>
top

Global Declarations

Element: critical-service

Name critical-service
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Critical service. Defining a critical service greatly reduces the traffic generated by the poller when an interface is DOWN. When an interface is DOWN only the critical service is polled. If and when the critical service comes back UP then the interface's other services are polled to determine their status. When an interface is UP all services are polled as expected. If the critical service goes DOWN, all services are considered to be DOWN and therefore the interface is also considered DOWN.
XML Instance Representation
<this:critical-service
name="string [1] ?"/>
Schema Component Representation
<element name="critical-service">
<complexType>
<attribute name="name" type=" string " use="required"/>
</complexType>
</element>
top

Element: downtime

Name downtime
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Downtime model. This determines the rates at which addresses are to be polled when they remain down for extended periods. Usually polling is done at lower rates when a node is down until a certain amount of downtime at which the node is marked 'deleted'.
XML Instance Representation
<this:downtime
begin="long [1] ?"
end="long [0..1] ?"
delete=" string (pattern = (yes|true)) [0..1] ?"
interval="long [0..1] ?"/>
Schema Component Representation
<element name="downtime">
<complexType>
<attribute name="begin" type=" long " use="required"/>
<attribute name="end" type=" long " use="optional"/>
<attribute name="delete" use="optional">
<simpleType>
<restriction base=" string ">
<pattern value="(yes|true)"/>
</restriction>
</simpleType>
</attribute>
<attribute name="interval" type=" long " use="optional"/>
</complexType>
</element>
top

Element: exclude-range

Name exclude-range
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Range of adresses to be excluded from this package.
XML Instance Representation
<this:exclude-range
begin="string [1] ?"
end="string [1] ?"/>
Schema Component Representation
<element name="exclude-range">
<complexType>
<attribute name="begin" type=" string " use="required"/>
<attribute name="end" type=" string " use="required"/>
</complexType>
</element>
top

Element: filter

Name filter
Type Locally-defined complex type
Nillable no
Abstract no
Documentation A rule which adresses belonging to this package must pass. This package is applied only to addresses that pass this filter
XML Instance Representation
<this:filter>
string
</this:filter>
Schema Component Representation
<element name="filter">
<complexType>
<simpleContent>
<extension base=" string "/>
</simpleContent>
</complexType>
</element>
top

Element: include-range

Name include-range
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Range of adresses to be included in this package.
XML Instance Representation
<this:include-range
begin="string [1] ?"
end="string [1] ?"/>
Schema Component Representation
<element name="include-range">
<complexType>
<attribute name="begin" type=" string " use="required"/>
<attribute name="end" type=" string " use="required"/>
</complexType>
</element>
top

Element: monitor

Name monitor
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Monitor for a service
XML Instance Representation
<this:monitor
service="string [1] ?"
class-name="string [1] ?">
<this:parameter> ... </this:parameter> [0..*]
</this:monitor>
Schema Component Representation
<element name="monitor">
<complexType>
<sequence>
<element ref=" this:parameter " maxOccurs="unbounded" minOccurs="0"/>
</sequence>
<attribute name="service" type=" string " use="required"/>
<attribute name="class-name" type=" string " use="required"/>
</complexType>
</element>
top

Element: node-outage

Name node-outage
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Configuration of node-outage functionality
XML Instance Representation
<this:node-outage
status=" string (pattern = (on|off)) [1] ?"
pollAllIfNoCriticalServiceDefined=" string (pattern = (true|false)) [0..1] ?">
<this:critical-service> ... </this:critical-service> [0..1]
</this:node-outage>
Schema Component Representation
<element name="node-outage">
<complexType>
<sequence>
<element ref=" this:critical-service " maxOccurs="1" minOccurs="0"/>
</sequence>
<attribute name="status" use="required">
<simpleType>
<restriction base=" string ">
<pattern value="(on|off)"/>
</restriction>
</simpleType>
</attribute>
<attribute name="pollAllIfNoCriticalServiceDefined" use="optional" default="true">
<simpleType>
<restriction base=" string ">
<pattern value="(true|false)"/>
</restriction>
</simpleType>
</attribute>
</complexType>
</element>
top

Element: package

Name package
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Package encapsulating addresses, services to be polled for these addresses, etc..
XML Instance Representation
<this:package
name="string [1] ?"
remote="boolean [0..1] ?">
<this:filter> ... </this:filter> [1] ?
<specific> string </specific> [0..*] ?
<this:include-range> ... </this:include-range> [0..*] ?
<this:exclude-range> ... </this:exclude-range> [0..*] ?
<include-url> string </include-url> [0..*] ?
<this:rrd> ... </this:rrd> [1] ?
<this:service> ... </this:service> [1..*] ?
<outage-calendar> string </outage-calendar> [0..*] ?
<this:downtime> ... </this:downtime> [1..*] ?
</this:package>
Schema Component Representation
<element name="package">
<complexType>
<sequence>
<element ref=" this:filter " maxOccurs="1" minOccurs="1"/>
<element name="specific" type=" string " maxOccurs="unbounded" minOccurs="0"/>
<element ref=" this:include-range " maxOccurs="unbounded" minOccurs="0"/>
<element ref=" this:exclude-range " maxOccurs="unbounded" minOccurs="0"/>
<element name="include-url" type=" string " maxOccurs="unbounded" minOccurs="0"/>
<element ref=" this:rrd " maxOccurs="1" minOccurs="1"/>
<element ref=" this:service " maxOccurs="unbounded" minOccurs="1"/>
<element name="outage-calendar" type=" string " maxOccurs="unbounded" minOccurs="0"/>
<element ref=" this:downtime " maxOccurs="unbounded" minOccurs="1"/>
</sequence>
<attribute name="name" type=" string " use="required"/>
<attribute name="remote" type=" boolean " use="optional" default="false"/>
</complexType>
</element>
top

Element: parameter

Name parameter
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Parameters to be used for polling this service. E.g.: for polling HTTP, the URL to hit is configurable via a parameter. Parameters are specfic to the service monitor.
XML Instance Representation
<this:parameter
key="string [1]"
value="string [0..1]">
Allow any elements from any namespace (strict validation). [0..1]
</this:parameter>
Schema Component Representation
<element name="parameter">
<complexType>
<sequence>
<any id="configuration" minOccurs="0" maxOccurs="1"/>
</sequence>
<attribute name="key" type=" string " use="required"/>
<attribute name="value" type=" string " use="optional"/>
</complexType>
</element>
top

Element: poller-configuration

Name poller-configuration
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Top-level element for the poller-configuration.xml configuration file.
XML Instance Representation
<this:poller-configuration
threads="int [1] ?"
nextOutageId="string [0..1] ?"
serviceUnresponsiveEnabled=" string (pattern = (true|false)) [1] ?"
xmlrpc=" string (pattern = (true|false)) [0..1] ?"
pathOutageEnabled=" string (pattern = (true|false)) [0..1] ?">
<this:node-outage> ... </this:node-outage> [1] ?
<this:package> ... </this:package> [1..*] ?
<this:monitor> ... </this:monitor> [1..*] ?
</this:poller-configuration>
Schema Component Representation
<element name="poller-configuration">
<complexType>
<sequence>
<element ref=" this:node-outage " maxOccurs="1" minOccurs="1"/>
<element ref=" this:package " maxOccurs="unbounded" minOccurs="1"/>
<element ref=" this:monitor " maxOccurs="unbounded" minOccurs="1"/>
</sequence>
<attribute name="threads" type=" int " use="required"/>
<attribute name="nextOutageId" type=" string " use="optional" default="SELECT nextval('outageNxtId')"/>
<attribute name="serviceUnresponsiveEnabled" use="required">
<simpleType>
<restriction base=" string ">
<pattern value="(true|false)"/>
</restriction>
</simpleType>
</attribute>
<attribute name="xmlrpc" default="false" use="optional">
<simpleType>
<restriction base=" string ">
<pattern value="(true|false)"/>
</restriction>
</simpleType>
</attribute>
<attribute name="pathOutageEnabled" default="false" use="optional">
<simpleType>
<restriction base=" string ">
<pattern value="(true|false)"/>
</restriction>
</simpleType>
</attribute>
</complexType>
</element>
top

Element: rrd

Name rrd
Type Locally-defined complex type
Nillable no
Abstract no
Documentation RRD parameters
XML Instance Representation
<this:rrd
step="int [1] ?">
<rra> string (pattern = ^RRA:(AVERAGE|MIN|MAX|LAST):.*$) </rra> [1..*] ?
</this:rrd>
Schema Component Representation
<element name="rrd">
<complexType>
<sequence>
<element name="rra" maxOccurs="unbounded" minOccurs="1">
<simpleType>
<restriction base=" string ">
<pattern value="^RRA:(AVERAGE|MIN|MAX|LAST):.*$"/>
</restriction>
</simpleType>
</element>
</sequence>
<attribute name="step" type=" int " use="required"/>
</complexType>
</element>
top

Element: service

Name service
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Service to be polled for addresses in this package.
XML Instance Representation
<this:service
name="string [1] ?"
interval="long [1] ?"
user-defined=" string (pattern = (true|false)) [0..1] ?"
status=" string (pattern = (on|off)) [0..1] ?">
<this:parameter> ... </this:parameter> [0..*]
</this:service>
Schema Component Representation
<element name="service">
<complexType>
<sequence>
<element ref=" this:parameter " maxOccurs="unbounded" minOccurs="0"/>
</sequence>
<attribute name="name" type=" string " use="required"/>
<attribute name="interval" type=" long " use="required"/>
<attribute name="user-defined" use="optional" default="false">
<simpleType>
<restriction base=" string ">
<pattern value="(true|false)"/>
</restriction>
</simpleType>
</attribute>
<attribute name="status" use="optional" default="on">
<simpleType>
<restriction base=" string ">
<pattern value="(on|off)"/>
</restriction>
</simpleType>
</attribute>
</complexType>
</element>
top

Legend

Complex Type:

Schema Component Type

AusAddress

Schema Component Name
Super-types: Address < AusAddress (by extension)
Sub-types:
  • QLDAddress (by restriction)
If this schema component is a type definition, its type hierarchy is shown in a gray-bordered box.
Name AusAddress
Abstract no
The table above displays the properties of this schema component.
XML Instance Representation
<... country="Australia" >
<unitNo> string </unitNo> [0..1]
<houseNo> string </houseNo> [1]
<street> string </street> [1]
Start Choice [1]
<city> string </city> [1]
<town> string </town> [1]
End Choice
<state> AusStates </state> [1]
<postcode> string <<pattern = [1-9][0-9]{3}>> </postcode> [1] ?
</...>

The XML Instance Representation table above shows the schema component's content as an XML instance.

Schema Component Representation
<complexType name="AusAddress">
<complexContent>
<extension base=" Address ">
<sequence>
<element name="state" type=" AusStates "/>
<element name="postcode">
<simpleType>
<restriction base=" string ">
<pattern value="[1-9][0-9]{3}"/>
</restriction>
</simpleType>
</element>
</sequence>
<attribute name="country" type=" string " fixed="Australia"/>
</extension>
</complexContent>
</complexType>
The Schema Component Representation table above displays the underlying XML representation of the schema component. (Annotations are not shown.)
top

Glossary

Abstract (Applies to complex type definitions and element declarations). An abstract element or complex type cannot used to validate an element instance. If there is a reference to an abstract element, only element declarations that can substitute the abstract element can be used to validate the instance. For references to abstract type definitions, only derived types can be used.

All Model Group Child elements can be provided in any order in instances. See: http://www.w3.org/TR/xmlschema-1/#element-all.

Choice Model Group Only one from the list of child elements and model groups can be provided in instances. See: http://www.w3.org/TR/xmlschema-1/#element-choice.

Collapse Whitespace Policy Replace tab, line feed, and carriage return characters with space character (Unicode character 32). Then, collapse contiguous sequences of space characters into single space character, and remove leading and trailing space characters.

Disallowed Substitutions (Applies to element declarations). If substitution is specified, then substitution group members cannot be used in place of the given element declaration to validate element instances. If derivation methods, e.g. extension, restriction, are specified, then the given element declaration will not validate element instances that have types derived from the element declaration's type using the specified derivation methods. Normally, element instances can override their declaration's type by specifying an xsi:type attribute.

Key Constraint Like Uniqueness Constraint, but additionally requires that the specified value(s) must be provided. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.

Key Reference Constraint Ensures that the specified value(s) must match value(s) from a Key Constraint or Uniqueness Constraint. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.

Model Group Groups together element content, specifying the order in which the element content can occur and the number of times the group of element content may be repeated. See: http://www.w3.org/TR/xmlschema-1/#Model_Groups.

Nillable (Applies to element declarations). If an element declaration is nillable, instances can use the xsi:nil attribute. The xsi:nil attribute is the boolean attribute, nil, from the http://www.w3.org/2001/XMLSchema-instance namespace. If an element instance has an xsi:nil attribute set to true, it can be left empty, even though its element declaration may have required content.

Notation A notation is used to identify the format of a piece of data. Values of elements and attributes that are of type, NOTATION, must come from the names of declared notations. See: http://www.w3.org/TR/xmlschema-1/#cNotation_Declarations.

Preserve Whitespace Policy Preserve whitespaces exactly as they appear in instances.

Prohibited Derivations (Applies to type definitions). Derivation methods that cannot be used to create sub-types from a given type definition.

Prohibited Substitutions (Applies to complex type definitions). Prevents sub-types that have been derived using the specified derivation methods from validating element instances in place of the given type definition.

Replace Whitespace Policy Replace tab, line feed, and carriage return characters with space character (Unicode character 32).

Sequence Model Group Child elements and model groups must be provided in the specified order in instances. See: http://www.w3.org/TR/xmlschema-1/#element-sequence.

Substitution Group Elements that are members of a substitution group can be used wherever the head element of the substitution group is referenced.

Substitution Group Exclusions (Applies to element declarations). Prohibits element declarations from nominating themselves as being able to substitute a given element declaration, if they have types that are derived from the original element's type using the specified derivation methods.

Target Namespace The target namespace identifies the namespace that components in this schema belongs to. If no target namespace is provided, then the schema components do not belong to any namespace.

Uniqueness Constraint Ensures uniqueness of an element/attribute value, or a combination of values, within a specified scope. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.

top

Generated by xs3p (old link) . Last modified: