Overview  Package  Class  Deprecated  Help

XML API Reference Help - Release 25

© 2025 Nokia. All rights reserved.

Overview

This XML API reference provides information about the XML interface, including package descriptions, object property values and descriptions, and UML inheritance drawings. Documentation is presented in the package list, class list and main information areas.

Package List

The package list in the upper left pane shows all packages available through the XML interface. Selecting "All Classes" or a package name changes the content of the class list area. The $core entry is a place holder for fundamental structures.

Class List

The class list in the lower left pane presents the list of classes and types defined within a package. The package name is displayed at the top of the list. Select the package name to display an overview of the package in the right pane. Select a class name or type from the list to display details of each object in the right pane.

Class Details

Each class has a page that contains a list of its inheritance, relationships, properties and methods with a summary for each.

Inheritance

The inheritance tree follows the list of classes that are extended to define a class.  Properties, methods, and naming are inherited.

The Direct Subclasses section lists all classes which directly  inherit from this one.

Containment

The Parent Hierarchy shows where an instance of the class may exist within the containment hierarchy. The format of the fully distinguished name of the current class is included in the tree.

The Children Hierarchy shows all types of classes that may be contained underneath it (directly as children or indirectly as descendents).
The hierarchy documentation is limited in depth for some classes with a very large number of descendents.

Relationships

Relationships section shows the relationships between the current class and other classes. These relationships include:

parent-child
child-parent
implied
ancestor-descendent
descendent-ancestor

The textual description is of the form:

<current-class> may be <relationship-description> <cardinality> <other-class> (<relationship-type>)
For example:
one netw.NetworkElement may be a direct parent of many equipment.Shelf's (parent-child relationship)

Class Type

Abstract and non-abstract classes are defined as:
public [abstract] class name
Abstract classes are generally used to provide common property and method inheritance for concrete classes.

Naming

Objects are named through concatenation of parent and relative names.  The relative name of an instance may be defined as:
Relative Name=[name]
Class properties present in the name are identified as ${propertyName}. For example:
Relative Name=[ospf-${version}-instance-${instanceIndex}]
Auto-generated IDs are identified with a "*", such as in ${*propertyName}.

Methods Returning Children

For some classes, methods that usually return children do not return children.  These cases are denoted with:
methodName() does not return children

Statistics

The Stats section lists the set of classes that monitor this class.  Inherited statistics classes are also listed.
Counter(32) and Counter(64) from MIB are shown as Type long and Type UInt128 respectively. 
The Stats for section lists the set of classes that this class monitors.
The Supporting MIBs section lists the MIB entries that this class reads.
Listed MIB versions reference entries based on network element version.

Methods

A list of methods is displayed for each class.  Method definitions may include:
  • comment
  • Input Parameters: name : type [comment]
  • Output Parameters: name : type [comment]
  • Exceptions: name [comment]
A list of inherited methods may exist with links to definitions in other classes.

Properties

An alphabetical list of properties is displayed for each class.  Property definitions may include:
  • comment
  • type=type-specification: The type-specification may be a fundamental type or link to another defined type.  Children-Set  indicates that objects of the specified type may  be children of this class.
  • default=value 
  • access=access-type: Access type may be read-only, WRITE-ONLY or read-create.  Read-write is default if unspecified.  Read-create values can be set at creation time only.
  • Mandatory on create: Indicates the value is required when an object is created. 
  • minimum=value
  • maximum=value
  • units=value
  • SNMP Deploy/Resync: MIB.entry:  The SNMP MIB entries defined for write/read access to the node.
  • Modification may shutdown object: This note indicates that changing the value may shutdown the object.  The GUI displays a pop-up dialog for these items.
  • Displayed(tab/group)=Displayed(tab/group):  Shows the property name and tab location in the GUI.  When tab or group details are absent, the property is displayed in the "general" area.
  • enums=enumeration: List of enumerations if defined within a property
  • bits: List of bits if defined within a property
  • rollover=true/false:  Rollover is applicable to statistics counters only and affects calculation of periodic values. The default is true.
    • true: The value increases monotonically over time, and rolls over after reaching its maximum.
      If the current value is less than the previous value then a rollover has occurred and the periodic value is defined as the current value.
      Otherwise, the periodic value is the difference between the current value and the previous value.
    • false: The value can increase or decrease over time, though never exceeding its maximum.
      The periodic value is the the difference between the current value and the previous value.
  • Overridden Properties: A list of all properties that are somehow overridden in this class.  Note that a property may be partly overridden and partly inherited through several classes.

    A list of inherited and overridden properties may exist with links to definitions in other classes. Properties which are overridden by a particular class are displayed in italics.

Supported Network Elements

This is a list of products and releases which support this class.  Supported Network Element specifications may include:
  • Excluded chassis types chassis-list: This class is not supported for the specified variants of this product.
  • Supported from version: This class is supported for this product from the specified NE release forward.  Multiple entries may be defined for different releases of the same product
  • Supported for all releases :  This class is supported for all releases of the specified NE product.
If this list is not shown, the class may be supported for any Network Element. 

Product Specifics

This is a list of properties which have different attributes, specific to NE vendor/versions.  Property definitions may include:
  • applicable=true or false: Indicates whether this property is applicable or not, for specific vendor/versions.
  • Excluded Chassis Types=chassis-list:  This class is not supported for the specified variants of this product.
  • Supported from=version:  This class is supported for this product from the specified NE release forward.  Multiple entries may be defined for different releases of the same product
  • Supported until=version:  This class is supported for this product only for versions prior to the NE release.  Multiple entries may be defined for different releases of the same product
  • default=value: 
  • access=access-type:  Indicates the vendor/version specific access type.  Access type may be read-only, write-only or read-create. 
  • write-access=yes, no, or writeAtCreation:  Overrides the write access set through the access attribute in the base property.
  • minimum=value
  • maximum=value
  • suppressEnums=enumeration:  List of enumerations suppressed, for specific vendor/versions
  • validEnums=enumeration:  List of valid enumerations for specific vendor/versions

Type Details

Each complex type has a page that contains a list of its values. Complex types include Enumeration, BitMask, Struct, Deployer, DeploymentState, List, Pointer, Map, Set, and Children-Set.

Enumeration

Enumeration value definitions may include:
The type enumerations are in the order they appear in the source code to preserve logical groupings.

BitMask

BitMask value definitions may include:

Collection Types

Collections are types that hold 0 or more items.

Other Types

XML API Schema Changes

Provides information about differences in the XML Schema between releases.

XML API JMS Changes

Provides information about changes affecting the JMS interface between releases.