General schema files
Overview
The following general schema files describe the top level of the XML API hierarchy:
-
xmlApiMethods.xsd—describes the general methods, such as find and findToFile, that are not associated with a specific package
-
xmlApiTypes.xsd—describes the data types, which range from simple types like Date, Char, and IpAddress, to complex structures like Any, List, and Filter
Note:
The Filterholder, ChildrenFilterHolder, and ResultFilter types are also defined in the “general methods/types” section of the XML API Reference. See To view the general methods and types for information about viewing the general methods and types.
The XML schema files for NFM-P subsystems such as script management and the JMS are also available.
The following table describes the core methods that a client can use to perform specific actions. The methods are defined in xmlApiMethods.xsd.
Table 10-1: Core XML methods
Method |
Purpose |
Input parameters |
Output parameters |
---|---|---|---|
deregisterLogToFile |
To stop the creation of accounting statistics files |
— | |
deregisterSasLogToFile |
To stop the creation of OAM test result files |
|
— |
deregisterNotification |
To deregister an XML filter and stop advanced JMS message filtering for the client |
— | |
find |
To return the set of objects of a specified type that match the specified filter criteria |
|
|
findToFile |
To find the set of objects of the specified type that match the filter criteria, and store the result in the specified file. Upon completion of the request, a fileAvailable event is generated. |
— | |
ping |
To check the connectivity of the NFM-P server. |
— |
— |
registerLogToFile |
To create accounting statistics files based on the specified class type. Accounting statistics files are created and are placed in the specified directory on the server. Each time a file is created, a LogFileAvailableEvent event is generated. If there is no JMS client subscribed within a given time, the NFM-P server deregisters the request. |
— | |
registerSasLogToFile |
To create OAM test results file based on specified class types. Files are created and are placed in the specified directory on the server. Every time that a file is created, a LogFileAvailableEvent event is generated. If there is no JMS client subscribed within some time, the NFM-P server deregisters the request. |
See Table 12-1, registerSasLogToFile method input parameters . |
— |
registerNotification |
To register an advanced JMS message filter and begin using the filter for messages sent to the OSS client |
|
— |
sleep |
To halt request processing for the given period of time (in milliseconds) before proceeding to the next request element. |
— | |
timeStamp |
To view the current Java time on the NFM-P server, in milliseconds. The execution time of a command or group of commands can be determined by surrounding them with timeStamp commands and taking the delta of their return values. |
||
version |
To return NFM-P software release information |
— |
© 2023 Nokia. Nokia Confidential Information
Use subject to agreed restrictions on disclosure and use.