Oracle Communications Policy Management: OSSI XML Interface Definitions Reference Release 12.1.2

Oracle® Communications
Policy Management
OSSI XML Interface Definitions Reference
Release 12.1.2
E71645 Revision 01
June 2016
Oracle Communications Policy Management OSSI XML Interface Definitions Reference, Release 12.1.2
Copyright © 2013, 2016, Oracle and/or its affiliates. All rights reserved.
This software and related documentation are provided under a license agreement containing restrictions
on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your
license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license,
transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse
engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is
prohibited.
The information contained herein is subject to change without notice and is not warranted to be error-free.
If you find any errors, please report them to us in writing.
If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it
on behalf of the U.S. Government, then the following notice is applicable:
U.S. GOVERNMENT END USERS: Oracle programs, including any operating system, integrated software,
any programs installed on the hardware, and/or documentation, delivered to U.S. Government end users
are "commercial computer software" pursuant to the applicable Federal Acquisition Regulation and
agency-specific supplemental regulations. As such, use, duplication, disclosure, modification, and adaptation
of the programs, including any operating system, integrated software, any programs installed on the
hardware, and/or documentation, shall be subject to license terms and license restrictions applicable to the
programs. No other rights are granted to the U.S. Government.
This software or hardware is developed for general use in a variety of information management applications.
It is not developed or intended for use in any inherently dangerous applications, including applications
that may create a risk of personal injury. If you use this software or hardware in dangerous applications,
then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to
ensure its safe use. Oracle Corporation and its affiliates disclaim any liability for any damages caused by
use of this software or hardware in dangerous applications.
Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks
of their respective owners.
Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks
are used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD,
Opteron, the AMD logo, and the AMD Opteron logo are trademarks or registered trademarks of Advanced
Micro Devices. UNIX is a registered trademark of The Open Group.
This software or hardware and documentation may provide access to or information about content, products,
and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly
disclaim all warranties of any kind with respect to third-party content, products, and services unless otherwise
set forth in an applicable agreement between you and Oracle. Oracle Corporation and its affiliates will not
be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content,
products, or services, except as set forth in an applicable agreement between you and Oracle.
Table of Contents
Part I: Introductory Information...............................................................11
Chapter 1: About This Guide............................................................12

Introduction..............................................................................................................................13
Scope and Audience................................................................................................................13
How This Guide is Organized................................................................................................13
Documentation Admonishments...........................................................................................14
Related Publications................................................................................................................14
Locate Product Documentation on the Oracle Help Center Site.......................................15
Customer Training...................................................................................................................15
My Oracle Support (MOS)......................................................................................................15
Emergency Response...............................................................................................................16
Part II: Functionality Used in both Wireless and Cable Modes.........17
Chapter 1: Schema Definitions and Request Specifications......18

Schema Definitions..................................................................................................................19
Request Specification...............................................................................................................19
Chapter 2: Common Responses and Commands..........................21

Common Responses.................................................................................................................22
Example XML Response for a Successful Operation..............................................22
Example XML Response for an Operation that Fails at the System Level...........22
Example XML Response for an Operation that Includes an Application-level
Failure.......................................................................................................................22
Result Codes.............................................................................................................................23
Common Commands...............................................................................................................23
Get Version....................................................................................................................24
Distribute Updates.......................................................................................................24
Serving Gateway/MCC-MNC Mapping..................................................................25
Query OM Stats Settings.............................................................................................25
E71645 Revision 01, June 2016 iii

Query Absolute Values for Statistics.........................................................................26
Chapter 3: Operational Measurements Interface Overview.......27

OM Statistics Scheduled Task................................................................................................28
OM Statistics Requests............................................................................................................28
Attributes and Child Tags...........................................................................................28
Recorded Timestamp and Request Time Range......................................................30
OM Statistics Response Format..............................................................................................30
Interval Statistics..........................................................................................................30
Absolute versus Delta Values.....................................................................................31
Empty Data Set.............................................................................................................31
Timezones and Start/End Times...........................................................................................32
Counter Reset and Failover....................................................................................................32
Comparisons Between the CMP GUI and OM Statistics....................................................33
Chapter 4: Identity Management (IDM).........................................35

Identity Management Overview............................................................................................36
Add a User................................................................................................................................36
Update a User...........................................................................................................................42
Delete a User.............................................................................................................................46
Query a User.............................................................................................................................47
Query User Role.......................................................................................................................48
Query User Scope.....................................................................................................................51
Chapter 5: Policy Table Interface.....................................................52

Policy Table Overview............................................................................................................53
Exported Policy Table XML....................................................................................................53
Add a Policy Table...................................................................................................................54
Modify a Policy Table..............................................................................................................54
Delete a Policy Table................................................................................................................55
Part III: Wireless Mode...............................................................................56
Chapter 1: Topology Interface for Wireless Mode........................57

Network Elements....................................................................................................................58
Add a Network Element in Wireless.........................................................................58
Update a Network Element in Wireless...................................................................60
E71645 Revision 01, June 2016 iv

Add Network Element to Group...............................................................................61
Remove Network Element from Group...................................................................62
Delete Network Element.............................................................................................62
Delete Network Element Group................................................................................63
Query Network Elements...........................................................................................64
Applications..............................................................................................................................66
Add Application...........................................................................................................66
Update Application......................................................................................................67
Delete Application.......................................................................................................67
Query Application.......................................................................................................68
Traffic Profiles...........................................................................................................................68
Add Traffic Profile.......................................................................................................69
Update Traffic Profile..................................................................................................73
Delete Traffic Profile....................................................................................................73
Query Traffic Profile....................................................................................................74
Time Periods.............................................................................................................................75
Add Time Period..........................................................................................................75
Update Time Period.....................................................................................................76
Delete Time Period.......................................................................................................78
Query Time Period.......................................................................................................78
Charging Servers......................................................................................................................79
Add Charging Server...................................................................................................79
Update Charging Server.............................................................................................80
Delete Charging Server...............................................................................................81
Query Charging Server...............................................................................................82
Match List..................................................................................................................................83
Add Match List.............................................................................................................83
Update Match List........................................................................................................84
Delete Match List..........................................................................................................85
Query Match List..........................................................................................................85
Monitoring Key........................................................................................................................86
Add Monitoring Key...................................................................................................86
Update Monitoring Key..............................................................................................87
Delete Monitoring Key................................................................................................88
Query Monitoring Key................................................................................................88
AVP Definition.........................................................................................................................89
Add AVP Definition....................................................................................................89
Update AVP Definition...............................................................................................90
Delete AVP Definition.................................................................................................91
Query AVP Definition.................................................................................................91
Serving GPRS Support Node..................................................................................................92
E71645 Revision 01, June 2016 v

Add SGSN.....................................................................................................................92
Update SGSN................................................................................................................93
Delete SGSN..................................................................................................................93
Query SGSN..................................................................................................................94
Chapter 2: Subscriber Interface for Wireless Mode.....................96

Quota Profiles...........................................................................................................................97
Add Quota Profile........................................................................................................97
Update Quota Profile.................................................................................................101
Delete Quota Profile...................................................................................................104
Query Quota Profile...................................................................................................105
Quota Conventions................................................................................................................106
Add Quota Convention.............................................................................................106
Update Quota Conventions......................................................................................107
Delete Quota Convention..........................................................................................108
Query Quota Convention..........................................................................................108
Chapter 3: Operational Measurement Requests for Wireless

Mode.................................................................................................110
Operational Measurements Requests Overview for Wireless Mode.............................112
Message Processing Statistics...............................................................................................112
Topology Update Statistics...................................................................................................114
Network Element Statistics...................................................................................................115
Latency Statistics....................................................................................................................119
Connected Network Elements Statistics.............................................................................128
Diameter Operational Measurements Requests for Wireless Mode...............................129
Diameter Sh Statistics................................................................................................129
Diameter Sh Peer Statistics.......................................................................................131
.......................................................................................................................................132
Diameter Sy Statistics................................................................................................132
Diameter Sy Reconciliation Statistics......................................................................135
Diameter Event Trigger Statistics............................................................................135
Diameter Application Function Statistics...............................................................138
Diameter Application Function Peer Statistics......................................................142
Diameter Charging Function Statistics...................................................................144
Diameter Charging Function Peer Statistics..........................................................145
Diameter Policy Charging Enforcement Function Statistics................................146
Diameter Policy Charging Enforcement Function Peer Statistics.......................149
Diameter MRA Policy Charging Enforcement Function Statistics.....................151
E71645 Revision 01, June 2016 vi

Diameter MRA Policy Charging Enforcement Function Peer Statistics............152
Diameter MRA Distributed Routing and Management Application (DRMA)
Statistics..................................................................................................................153
Diameter MRA Diameter Routing Agent (DRA) Statistics..................................154
Diameter MRA Application Function (AF) Statistics...........................................155
Diameter MRA Application Function (AF) Peer Statistics...................................156
Diameter MRA Bearer Binding and Event Reporting Function (Bberf)
Statistics..................................................................................................................157
Diameter MRA Traffic Detection Function (TDF) Statistics................................159
Diameter MRA Traffic Detection Function (TDF) Peer Statistics........................160
Diameter MRA Traffic Detection Function (TDF) over SCTP Statistics.............161
KPI Statistics............................................................................................................................162
KPI Statistics for COMCOL Behindness and Sync State..................................................164
LDAP Source Statistics..........................................................................................................166
Protocol Error Statistics.........................................................................................................167
Protocol MRA Error Statistics..............................................................................................172
Session Cleanup Statistics.....................................................................................................176
Timeout Statistics...................................................................................................................177
Traffic Profile Statistics..........................................................................................................191
TPS Statistics...........................................................................................................................192
Quota Profile Statistics..........................................................................................................198
Quota Profile Statistics..........................................................................................................199
Interval Statistics/PCRF Session License Tracking and Reporting................................200
PDN RAT Connection Statistics...........................................................................................202
PDN Connection APN Statistics..........................................................................................204
KPI Dashboard Statistics.......................................................................................................205
AF Session Statistics for RAT-Type.....................................................................................209
Replication Statistics..............................................................................................................210
SCTP Association Statistics...................................................................................................213
Peer Associate Statistics.........................................................................................................214
Message Error Statistics for Gx............................................................................................215
SDR/SDA Message Processing Stats..................................................................................216
Part IV: Cable Mode..................................................................................217
Chapter 1: Topology Interface for Cable Mode...........................218

Network Elements..................................................................................................................219
Add a Network Element in Cable............................................................................219
Update a Network Element in Cable......................................................................221
Add Network Element to Group.............................................................................222
E71645 Revision 01, June 2016 vii

Remove Network Element from Group.................................................................223
Delete Network Element...........................................................................................223
Delete Network Element Group..............................................................................224
Query Network Elements.........................................................................................225
Chapter 2: Subscriber Interface for Cable Mode.........................228

Accounts..................................................................................................................................229
Overview.....................................................................................................................229
Add Account...............................................................................................................229
Update Account..........................................................................................................231
Delete Account...........................................................................................................231
Query Account............................................................................................................232
Tiers..........................................................................................................................................233
Add Tier.......................................................................................................................233
Update Tier.................................................................................................................234
Delete Tier...................................................................................................................235
Query Tier...................................................................................................................235
Chapter 3: Operational Measurement Requests for Cable

Mode.................................................................................................237
Operational Measurements Requests Overview for Cable Mode..................................238
Topology Update Statistics...................................................................................................238
Subscriber Update Statistics.................................................................................................239
Policy Server Statistics...........................................................................................................240
Reserve Commit Statistics.....................................................................................................241
Gate Statistics..........................................................................................................................242
Latency Statistics....................................................................................................................243
Mgpi Statistics.........................................................................................................................253
Policy Statistics.......................................................................................................................254
Diameter Operational Measurements Requests for Cable Mode....................................255
Diameter Application Function Statistics...............................................................256
Diameter Application Function Peer Statistics......................................................259
PCMM BoD and CMTS Operational Measurements........................................................261
PCMM BOD Statistics................................................................................................261
PCMM BOD Error Statistics.....................................................................................263
PCMM BOD Session Statistics..................................................................................264
PCMM BOD AM Statistics........................................................................................265
PCMM Am Gate Statistics........................................................................................267
PCMM BOD Gate Statistics......................................................................................268
E71645 Revision 01, June 2016 viii

PCMM CMTS Statistics.............................................................................................269
PCMM CTMS Gate Statistics....................................................................................270
PCMM Network Element Statistics.........................................................................271
PCMM Connection Error Statistics......................................................................................273
Connection Error Statistics for PCMM AMID.......................................................278
BoD Interface Operational Measurements.........................................................................279
HTTP BOD Statistics..................................................................................................279
SOAP BOD Statistics..................................................................................................281
CMTS Re-discovery Operational Measurement Requests...............................................282
CMTS Re-discovery Query Network Element.......................................................283
CMTS Re-discovery Add Network Element Interface.........................................284
CMTS Re-discovery Update Network Element Interface....................................285
DQos Operational Measurements Requests......................................................................285
DQos CMTS Statistics................................................................................................286
DQos Network Element Statistics............................................................................287
Traffic Profile Statistics..........................................................................................................288
Protocol Error Statistics.........................................................................................................289
PCMM Connection Error Statistics......................................................................................294
MPE/BOD Replication Statistics.........................................................................................299
Field Mapping Profile Queries.............................................................................................300
Mediation Field Mapping Profile Statistics............................................................300
Mediation - Add Field Mapping Profile.................................................................301
Mediation - Update Field Mapping Profile............................................................302
Mediation - Delete Field Mapping Profile..............................................................303
E71645 Revision 01, June 2016 ix

List of Tables
Table 1: Admonishments................................................................................................................................14
E71645 Revision 01, June 2016 x

Part
I
Introductory Information
Topics: This section of the OSSI (Operation Support System

Interface) XML interface reference provides a
• About This Guide.....12 description of the OSSI as well as important resource
associated with this reference guide.
E71645 Revision 01, June 2016 11

Chapter
1
About This Guide
Topics: This chapter contains an overview of this guide,

describes how to obtain help, where to find related
• Introduction.....13 documentation, and provides other general
• Scope and Audience.....13 information.
• How This Guide is Organized.....13
• Documentation Admonishments.....14
• Related Publications.....14
• Locate Product Documentation on the Oracle Help
Center Site.....15
• Customer Training.....15
• My Oracle Support (MOS).....15
• Emergency Response.....16

About This Guide
Introduction
This guide describes the Operation Support System Interface (OSSI) XML interface . This interface
enables an operator or third-party system to programmatically push configuration information to and
retrieve operational statistics from the policy server deployment.
Scope and Audience

This guide is intended for operators or third party systems who are responsible for pushing
configuration information to and retrieving operational statistics from a policy server deployment.
How This Guide is Organized

The information in this guide is divided into four major sections presented in the following order:
• The first part, Introductory Information, includes:
• About This Guide which contains general information about this guide, the organization of this
guide, and how to get technical assistance.
• The second part, Functionality Used in both Wireless and Cable Modes includes:
• Schema Definitions and Request Specifications describes the Schema Definitions and Request
Specifications used within the OSSI XML interface for both wireless and cable modes.
• Common Responses and Commands describes the generic response format for many of the
commands used and the commands that are common to the various OSSI interfaces.
• Operational Measurements Interface Overview describes the interface used to retrieve operational
counters from the system.
• Identity Management (IDM) describes the interface that allows the CMP to configure user names,
passwords and roles using the OSSI interface.
• Policy Table Interface describes an interface that allows you to generalize multiple similar policies
into a single policy, simplifying processes such as adding new policies, modifying existing
policies, and checking consistency among policies.
• The third part, Wireless Mode describes all the functionality used in the wireless mode which
includes:
• Topology Interface for Wireless Mode describes the interface that allows wireless users to manage
and query network elements, paths, and other topology-related objects within the system.
• Subscriber Interface for Wireless Mode describes the interface that allows wireless users to manage
and query quota profiles and quota conventions within their system.

About This Guide
• Operational Measurement Requests for Wireless Mode describes the various Operational
Measurements (OM) groups and the individual OM statistics specific to the wireless mode.
• The fourth part, Cable Mode describes all the functionality used in the cable mode which includes
• Topology Interface for Cable Mode describes the interface that allows cable users to manage and
query network elements within the system.
• Subscriber Interface for Cable Mode describes the interface that allows cable users to manage and
query accounts and tiers within their system.
• Operational Measurement Requests for Cable Mode describes the various Operational Measurements
(OM) groups and the individual OM statistics specific to the cable mode.
Documentation Admonishments
Admonishments are icons and text throughout this manual that alert the reader to assure personal
safety, to minimize possible service interruptions, and to warn of the potential for equipment damage.
Table 1: Admonishments
Icon Description
Danger:
(This icon and text indicate the possibility of
personal injury.)
Warning:
equipment damage.)
Caution:
service interruption.)
Topple:
personal injury and equipment damage.)
Related Publications
For information about additional publications that are related to this document, refer to the Related
Publications Reference document, which is published as a separate document on the Oracle Help Center
site. See Locate Product Documentation on the Oracle Help Center Site for more information.

About This Guide
Locate Product Documentation on the Oracle Help Center Site

Oracle Communications customer documentation is available on the web at the Oracle Help Center
(OHC) site, http://docs.oracle.com. You do not have to register to access these documents. Viewing these
files requires Adobe Acrobat Reader, which can be downloaded at http://www.adobe.com.
1. Access the Oracle Help Center site at http://docs.oracle.com.
2. Click Industries.
3. Under the Oracle Communications subheading, click the Oracle Communications
documentation link.
The Communications Documentation page appears. Most products covered by these documentation
sets will appear under the headings “Network Session Delivery and Control Infrastructure” or
“Platforms.”
4. Click on your Product and then the Release Number.
A list of the entire documentation set for the selected product and release appears.
5. To download a file to your location, right-click the PDF link, select Save target as (or similar
command based on your browser), and save to a local folder.
Customer Training
Oracle University offers training for service providers and enterprises. Visit our web site to view, and
register for, Oracle Communications training:
http://education.oracle.com/communication
To obtain contact phone numbers for countries or regions, visit the Oracle University Education web
site:
www.oracle.com/education/contacts
My Oracle Support (MOS)

MOS (https://support.oracle.com) is your initial point of contact for all product support and training
needs. A representative at Customer Access Support (CAS) can assist you with MOS registration.
Call the CAS main number at 1-800-223-1711 (toll-free in the US), or call the Oracle Support hotline
for your local country from the list at http://www.oracle.com/us/support/contact/index.html. When calling,
make the selections in the sequence shown below on the Support telephone menu:
1. Select 2 for New Service Request
2. Select 3 for Hardware, Networking and Solaris Operating System Support
3. Select one of the following options:
• For Technical issues such as creating a new Service Request (SR), Select 1
• For Non-technical issues such as registration or assistance with MOS, Select 2

About This Guide
You will be connected to a live agent who can assist you with MOS registration and opening a support
ticket.
MOS is available 24 hours a day, 7 days a week, 365 days a year.
Emergency Response
In the event of a critical service situation, emergency response is offered by the Customer Access
Support (CAS) main number at 1-800-223-1711 (toll-free in the US), or by calling the Oracle Support
hotline for your local country from the list at http://www.oracle.com/us/support/contact/index.html. The
emergency response provides immediate coverage, automatic escalation, and other features to ensure
that the critical situation is resolved as rapidly as possible.
A critical situation is defined as a problem with the installed equipment that severely affects service,
traffic, or maintenance capabilities, and requires immediate corrective action. Critical situations affect
service and/or system operation resulting in one or several of these situations:
• A total system failure that results in loss of all transaction processing capability
• Significant reduction in system capacity or traffic handling capability
• Loss of the system’s ability to perform automatic system reconfiguration
• Inability to restart a processor or the system
• Corruption of system databases that requires service affecting corrective actions
• Loss of access for maintenance or recovery operations
• Loss of the system ability to provide any required critical or major trouble notification
Any other problem severely affecting service, capacity/traffic, billing, and maintenance capabilities
may be defined as critical by prior discussion and agreement with Oracle.

Part
II
Functionality Used in both Wireless and Cable Modes
Topics: This section is divided into specific chapters that

define functionality common to both wireless and
• Schema Definitions and Request cable modes. The following chapters provide this
Specifications.....18 information in greater detail.
• Common Responses and Commands.....21 • Schema Definitions and Request Specification
• Operational Measurements Interface — define schema, (OssiXmlRequestResponse.xsd,
Overview.....27 OssiXmlCommon.xsd, OssiXmlToplogy.xsd, etc.)
• Identity Management (IDM).....35 and request specifications (using HTTP POST)
• Policy Table Interface.....52 for the OSSI interface.
• Common Responses and Common Commands
— define the generic response format for many
of the commands used as well as the commands
that are common to the various OSSI interfaces.
• Operational Measurements Interface Overview
— defines the interface used to retrieve
operational counters from the system.
• Identity Management (IDM) — allows the CMP
to configure user names, passwords and roles
using the OSSI interface.
• Policy Table Interface — enables you to
generalize similar policies into a single policy
that represents the policy structure, plus policy
tables that capture the differences.

Chapter
1
Schema Definitions and Request Specifications
Topics: This chapter provides detailed information on

schema definitions and request specifications used
• Schema Definitions.....19 within the OSSI XML interface.
• Request Specification.....19

Schema Definitions
To enable message validation and to accurately specify the syntax of each of the messages, the following
XML schema definitions are provided.
• OssiXmlRequestResponse.xsd: defines the XmlInterfaceRequest tag and the associated sub-element
type definition. This xsd is used to validate add/update requests.
• OssiXmlCommon.xsd: defines the schema for global types and requests used in all interfaces.
• OssiXmlTopology.xsd: defines the schema for the topology interface.
• OssiXmlSubscriber.xsd: defines the schema for the subscriber interface such as AddAccount and
UpdateAccount.
• OssiXmlOm.xsd: defines the schema for the OM interface and the OSSI OM stats query and response
type defintion.
• OssiXmlRuntimeResponse.xsd: defines the runtime response type such as SubscriberLog,
SubscriberRealtimeStats and ResponseType.
• OssiXmlUserMgr.xsd: defines the User, Role-related type (such as: AddRole and
AddSysAdminUser).
• Export.xsd: is generated according to the data model (dal.xml) during the build phase and includes
miscellaneous types.
Request Specification
Each of the requests and responses defined within the previous schema definitions are sent to and
received from the Configuration Management Platform (CMP) using HTTPs messages. Specifically,
an HTTP POST message is sent containing the specific request message. The HTTP response contains
a response message indicating status and returning any data as required.
For an application desiring to use the OSSI XML interface, the only requirement is the ability to send
an HTTP POST and to process any response. This guide contains examples that use the command line
utility wget to send an HTTP POST request that contains data specified in an XML file as input and
returns an output XML file. The example that follows demonstrates the basic wget options; additional
options are available but not described here. Please note that the request URL is case sensitive and
must be entered as seen here.
Note: The CMP has a global setting that controls how often statistics are available to OSSI. Therefore,
the availability of statistics is dependent upon when the statistics are available to OSSI. For more
information, refer to the CMP Wireless User's Guide and CMP Cable User's Guide .
> wget --post-file=input.xml --output-document=output.xml

"http://1.2.3.4/mi/xmlInterfaceRequest.do?user=test&pwd=test"
Where the following describes each parameter:

• --post-file=input.xml (Required): This parameter indicates the request input XML file.
• --output-document=output.xml (Optional): This parameter is used to name the output file.
If unspecified, the default filename is the URL string indicated in the wget request.

• http://1.2.3.4/mi/ xmlInterfaceRequest.do ?user=test&pwd=test (Required) —

The HTTP request URL, including the authentication credentials.
• --timeout=0 (Optional): This parameter sets the network timeout to seconds. The default for
this value is 900 (15min). A value of 0 disables timeout checking completely.
• --progress=dot (Optional): This parameter is used to display the progress bar on the request.

Chapter
2
Common Responses and Commands
Topics: This chapter describes the generic response format

for many of the commands used and the commands
• Common Responses.....22 that are common to the various OSSI interfaces.
• Result Codes.....23
• Common Commands.....23

Common Responses
This section describes the generic response format to many of the commands. The response format
follows the generic response tag defined in the XSDs. The following are examples of successful and
failed operations.
Example XML Response for a Successful Operation

The following is an example of an XML response for a successful operation.
<?xml version="1.0" ?>

<Response>
<Result>0</Result>
<Command type="XmlInterfaceResponse">
<Success count="2">Successfully imported 2 network elements.</Success>
<Failure count="0"></Failure>
</Command>
</Response>
Example XML Response for an Operation that Fails at the System Level
The following is an example of an XML response for an operation that fails at the system level (for
example, a malformed request).

<Response>
<Result>103</Result>
<Success count="0"></Success>
<Failure count="1">Incorrectly formatted XML. The element type
"NetworkElementStats" must be terminated by the matching end-tag
"</NetworkElementStats>".</Failure>
</Command>
</Response>
Example XML Response for an Operation that Includes an Application-level Failure

The following is an example of an XML response for an operation that includes an application-level
failure.

<Response>
<Result>0</Result>
<Failure count="1">Failed to import 1 network elements.
Network Element includes an invalid NetworkElementType.
Network Element: RouterA</Failure>

</Command>
</Response>
Result Codes
Many of the OSSI commands return a numeric result code in their response messages. This code
represents the status of the operation at the system level, and shows whether the command itself could
be executed or not. The following text describes the possible result codes.
Code Description
0 The command was valid at a system level.
100 There was a general failure due to an internal server error.
101 The command failed authentication; the account or password does not match between
the OSSI and the URL.
102 An input stream error occurred (for example, the requested data exceeds maximum
size). The maximum size for a single request is 20,000,000 bytes. An example of the
error message
is:errors.importExport.variableMessageMaxFileSize=Import file
exceeds max size of 20M.
103 The request is malformed; for example, the XML tags may be invalid. Refer to the
XSD of the OSSI query and ensure that no characters appear before the XML header
(<?xml version="1.0" encoding="UTF-8"?>).
Common Commands
This section describes commands that are common to the various OSSI interfaces. These include:
• Get Version — allows users to request the OSSI API version number, as a string (for example,
“2.0.3”). This enables you to verify that the OSSI interface being used is the version expected,
ensuring that the commands will operate as specified for that version.
• Distribute Updates: allows users to trigger an immediate distribution of any pending data changes
to the policy servers. This enables you to queue up many changes in the Configuration Management
Platform (CMP) before sending them all at one time to the policy servers in the deployment.
Alternatively, changes can be distributed one-by-one on a per-command basis. The following types
of data are pushed down to the policy servers as part of this request:
• Topology data, which includes Network Elements and Paths.
• Tiers
• Subscriber accounts
• Serving Gateway/MCC-MNC Mapping: allows users to verify input xml files.
• Query OM Stats Setting: allows users to verify the persistent-interval settings for Reset Configuration
and Collection Interval.

• Query Absolute Values for Statistics: allows users to retrieve absolute values when
Stats.Interval.Enabled. is set to false.
Get Version
The following examples show both the request and response that are defined in the XSDs for the
GetVersion tag.
The following is an example of the request that follows the GetVersion tag.
<?xml version="1.0" encoding="UTF-8" ?>

<XmlInterfaceRequest>
<GetVersion></GetVersion>
</XmlInterfaceRequest>
The following example response to the previous request follows the generic Response tag.

<Response>
<Result>0</Result>
<Success count="1">2.2.14</Success>
</Command>
</Response>
Distribute Updates
The following examples show the requests and responses that are defined in the XSDs for the
DistributeUpdates tag.
The following is an example of the request that follows the DistributeUpdates tag.

<DistributeUpdates></DistributeUpdates>
The optional ForceSynchronization attribute can be used to force a complete resynchronization of the
CMP and Multimedia Policy Engine (MPE) databases. The default value for this attribute is false.
Typically, using this attribute should not be necessary as the system should always be kept in-sync
automatically; it is merely provided as a fail-safe measure for unforeseen circumstances. Also note
that there is a performance impact from using this attribute, so it should not be used unless deemed
necessary by Policy support personnel. The following is an example of this attribute:

<DistributeUpdates ForceSynchronization="true"></DistributeUpdates>


<Response>
<Result>0</Result>
<Success count="3">Topology updates successful. Tier updates successful.
Account updates successful.</Success>
</Command>
</Response>
Serving Gateway/MCC-MNC Mapping

The following example shows the request and response defined in the XSDs for the SgwMapping tag.
The following is an example of the request that follows the SgwMapping tag.
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>

<AddSgwMapping>
<SgwMapping>
<Name>test</Name>
<Description>description for the mcc-mnc
mapping</Description>
<MccMnc>111111</MccMnc>
<SgwIpAddress>
<IpAddress>10.0.0.129</IpAddress>
</SgwIpAddress>
</SgwMapping>
</AddSgwMapping>

<Response>
<Result>0</Result>
<Success count="1">Successfully imported 1
Serving Gateway/MCC-MNC Mappings.</Success>
</Command>
</Response>
Query OM Stats Settings

The following example shows the request and response that is defined in the XSDs for the
QueryOmStatsSetting tag.
The following is an example of the request that follows the QueryOmStatsSetting tag.


<QueryOmStatsSetting/>

<OmStatsSetting>
<ResetConfiguration>Interval</ResetConfiguration>
<CollectionInterval>15</CollectionInterval>
</OmStatsSetting>
Query Absolute Values for Statistics

The following example show the request and response that is defined in the XSDs for the Statistics
tag.
Note: If Stats.Interval.Enabled is set to true (meaning that Persistent Interval Statistics are in use),
then the CMP does not collect absolute counter values.
The following is an example of the request that follows the Statistics tag.

<Statistics/>

<Statistics>
<DiameterAfPeerLatencyStats>
Absolute statistics values are not available.
</DiameterAfPeerLatencyStats>
</Statstics>

Chapter
3
Operational Measurements Interface Overview
Topics: The Operational Measurements (OM) XML interface

is used to retrieve operational counters from the
• OM Statistics Scheduled Task.....28 system. This chapter describes the interface and how
• OM Statistics Requests.....28 it should be used.
• OM Statistics Response Format.....30
• Timezones and Start/End Times.....32
• Counter Reset and Failover.....32
• Comparisons Between the CMP GUI and OM
Statistics.....33

OM Statistics Scheduled Task

The OM interface requires that the “OM Statistics” scheduled task be running on the Configuration
Management Platform (CMP). This task performs the function of collecting the operational counters
from the MPEs in the network and recording them in the CMP database; the data is then available to
be queried via the OM XML interface (See CMP Wireless User's Guide or CMP Cable User's Guide for
more information). This task can be configured by the user to poll at intervals between 5 minutes and
24 hours, with a default value of 15 minutes, and keeps the data available for query for 1 to 30 days,
with the default value being 7 days. The recommended settings for this task varies with each
deployment, dependant on the volume of data being collected.
When OM requests are made, the data for the response is taken from the information that has been
collected by this task. Without the data that is collected through this scheduled task, there would be
no data available for OM queries.
Most values returned as part of the response are presented (by default) as deltas, representing the
positive change between the start time and end time. In order to calculate a delta there must be a
minimum of two recorded values available, so the OM Statistics task must have been run at least twice
in order to provide any data through the OM XML interface.
OM Statistics Requests
These are the two OM statistic requests used in the OSSI.
• Attributes and Child Tags
• Recorded Timestamp and Request Time Range
Attributes and Child Tags

The following attributes can be used with any of the OM Statistics requests as part of the QueryOMStats
tag:
• DeltaCount: are the values for statistics which are cumulative in nature (for example, monotonically
increasing counters) are returned by default as a delta value. For these cumulative statistics, the
delta value returned represents the positive change in that value since the last recorded time period.
By setting the DeltaCount attribute to “false” you can request that all statistics be returned as
absolute values instead, that is the total values since the beginning of time.
Some statistics are always returned as absolute values. These non-cumulative statistics have values
that can increase or decrease over time, for example Upstream and Downstream Bandwidth or
active Session Counts. These statistics are explicitly called out in this document as always returning
“absolute” values.
The following is an example of the DeltaCount attribute:
<?xml version="1.0" encoding="UTF-8"?>

<QueryOmStats DeltaCount="false">

<StartTime>2006-10-12T11:15:00Z</StartTime>
<EndTime>2006-10-12T11:25:00Z</EndTime>
<NetworkElementStats></NetworkElementStats>
</QueryOmStats>
• AggregateTimeSamples: is an attribute that allows you to request that all sample buckets in the
response be aggregated into a single sample bucket. This attribute allows you to request data for
a time period and see a summary of all recorded data for that specific time period, rather than all
the individual samples that make up the requested time period.
The following is an example of the AggregateTimeSamples attribute:

<QueryOmStats AggregateTimeSamples="true">
<NetworkElementStats/>
</QueryOmStats>
The following child tags are available for OM XML Commands:

• StartTime/EndTime: These tags define the time range which all statistical data recorded is returned.
Note: The EndTime tag is an optional tag. If no EndTime tag is specified, then the time range
extends from the StartTime and continues until the current time. This provides a means to capture
the most up-to-date data.
The following is an example of the StartTime/EndTime child tags:

<QueryOmStats>
<PolicyServerStats/>
<IsComplete>true</IsComplete>
</QueryOmStats>
• PolicyServer: This optional tag, is specified as a child tag of some individual statistic groups. This
tag allows you to request statistics specific to an individual or a set of MPEs. The default behavior
displays statistics for all MPEs.
The following is an example of the PolicyServer child tag:

<QueryOmStats>
<PolicyServerStats>
<PolicyServer>Atlanta105</PolicyServer>
</PolicyServerStats>
</QueryOmStats>

Recorded Timestamp and Request Time Range

The OM Statistics task runs on a scheduled interval and is time stamped, (for increased accuracy), as
they are received from the MPEs. For example, if the OM Statistics task starts at 12:00:00, the statistics
recorded for MPE1 do not have to be time stamped until 12:00:01, and MPE2 at 12:00:02, and so on.
This detail impacts the way the captured data is requested through the XML interface. It ensures that
all the desired data is returned as part of the response. To ensure correct results, if the intent is to
retrieve data for a full 24 hour period, the start and end times should extend beyond the intended 24
hour period to ensure that any delayed results returned for an MPE are included in the response.
For example, to retrieve statistics recorded for the entire day of March 10, the following request time
range is recommended (note that the EndTime is 15 minutes past midnight) to extend beyond the 24
hour period:
OM Statistics Response Format

The XSD defines the schema for responses to OM XML requests. Results are returned in Sample
buckets representing a range of time. If Persistent Interval Statistics are enabled (Stats.Interval.Enabled),
this range is determined by the Stats Collection Period, found under Global Configuration Settings >
Stats Settings on the CMP, but also includes any Manual runs of the task initiated by the user.
If Stats.Interval.Enabled is set to false (meaning that Persistent Interval Statistics are not enabled), then
the CMP collects absolute counter values only; this range is determined by the interval settings of the
OM Statistics scheduled task and includes any Manual runs of the task initiated by the user.
Responses do not return data sets that exceed a maximum size. In this case, a user is directed to reduce
the scope of their query to accommodate for the size limitation of the XML response.
Interval Statistics
In the interval-statistics mode, all numeric data generated by MPEs and MRA s are reset at regular
intervals controlled by the Stats Collection Period. When in Interval mode, a reset occurs on the hour
and then every 5, 10, 15, 20, 30 or 60 minutes afterwards depending on the value of the Stats Collection
Period. See the CMP Wireless User Guide for details on setting interval statistics.
When in the Interval Mode, the XML request and response will look similar to this example.
Request
<QueryOmStatsSetting/>

Response
<OmStatsSetting>
<ResetConfiguration>Interval</ResetConfiguration>
<CollectionInterval>15</CollectionInterval>
</OmStatsSetting>
Absolute versus Delta Values

For all cumulative statistics (for example, monotonically increasing counters), the returned values are
presented as deltas by default. These deltas represent the positive change in value between the start
and end times. This behavior can optionally be changed to return absolute values for all statistics (see
OM Statistics Requests).
Non-cumulative statistics, those statistics whose value can either increase or decrease between intervals,
are returned as absolute values. This prevents negative value responses as a result of a delta calculation.
For example, in NetworkElementStats the Upstream Bandwidth, Downstream Bandwidth, and “active”
Session Counts are returned as absolute values. These absolute value statistics are explicitly called out
in this document as always returning “absolute” values. All absolute data points are taken as the value
at the End Time of the reported Sample.
Empty Data Set

Requests that do not result in any statistics contain the following message:
Not enough statistical data available to fulfill request.
If you receive this message, check the request parameters or select a different time range, as the message
indicates that for the parameters submitted as part of the request there is not enough recorded data
to respond.
This response can occur for a number of reasons. If you see the following in the response:
<IsComplete>false</IsComplete>
then the MPE or MRA has detected errors when collecting the stats, usually because a complete interval
was not available.
A possible explanation for this message is that the OM Statistics Task was run at least two times within
the specified time range (StartTime and EndTime). This message could also occur if recorded data is
unavailable for a specific parameter, such as a certain Network Element or MPE name.
The task itself runs on a schedule but the data is recorded dynamically as it is received from the MPEs,
so this factor should be taken into account when requesting a particular range of time. To alleviate
this message, you should start with a larger time window for testing and narrow that down, adjusting
the scheduled task as needed, until the desired data is returned. This message could also occur if
recorded data is unavailable for a specific parameter, such as a certain Network Element or MPE name.

Timezones and Start/End Times

OM responses include “Sample” buckets, each with a specified start and end time. These values are
returned in UTC (Coordinated Universal Time) format, which is the international time standard. The
CMP is unaware of the timezone of the originating request and is therefore unable to return a “localized”
timezone to the user.
The XSDs define request/responses with the following:


<xsd:element name="StartTime" type="xsd:dateTime" minOccurs="1" maxOccurs="1"/>
<xsd:element name="EndTime" type="xsd:dateTime" minOccurs="1" maxOccurs="1"/>
The type is defined as “xsd:dateTime”. This is a UTC format. This data type describes instances
identified by the combination of a date and a time.
Its lexical space is the extended format:
[-]CCYY-MM-DDThh:mm:ss[Z|(+|-)hh:mm]
The time zone may be specified as Z (UTC) or (+|-)hh:mm. Time zones that are not specified are
considered localized to the MPE Manager.
The following are examples of valid values for xsd:dateTime:
• Example 1 — 2007-03-26T21:32:52Z - UTC format. This is the default response
format for all timestamps. It is also the recommend format for user
requests.
• Example 2 — 2007-03-26T21:32:52+02:00 - Localized time with 2 hour offset
to UTC time.
• Example 3 — 2007-03-26T19:32:52 - Localized time. This will be interpreted
as localized to the MPE Manager.
• Example 4 — 2007-03-26T19:32:52+00:00 - Localized time with no offset.
Note: All date and time numbers are two digits. For example, 3:00am, April 5th is written as
“2008-04-05T03:00:00” and not “2008-4-5T3:00:00”.
A request to retrieve statistics can be made either in UTC or as a time that is localized to the CMP. It
is recommended that users make their requests in UTC format to remain consistent with the UTC
output. UTC is also recommended, as end users may not be aware they are making requests from a
different timezone than the CMP and therefore may not be accounting for that difference when
analyzing results. If the MPEs, CMP, and end user are all in different timezones then the user would
be attempting to correlate values and draw conclusions from the reported statistics across all of those
timezones.
Counter Reset and Failover

MPEs and MRAs write historical data to a distributed comcol database and save it for 24 hours.

Note: CMP stores cluster-level interval stats to its own database. Data is available for external OSS
system to retrieve after the end of the next interval period.
There are two cases where statistics can be reset:
• You can click the Reset All Counters button on the Policy Server Reports page of the CMP Graphical
User Interface (GUI). This button is typically used to reset counters as a baseline from which to run
tests (refer to CMP User Guide for detailed description of this page.).
• You can enable the Interval mode; when configured, numeric values are reset at regular intervals
controlled by the Stats Collection Period. When in Interval mode, a reset will occur on the hour
and then every 5, 10, 15, 20, 30 or 60 minutes afterwards depending on the value of the Stats
Collection Period. (When interval periods are changed, the database is purged.) See the CMP User
Guide for details.
In either case, all memory counters are reset to 0. This means that the delta values calculated for the
time period during which the reset occurred are not accurate.
For example, if at the StartTime the SuccessSessionCount value was 100, and a reset occurred resetting
the count to 0, then the next reported delta would be -100. If the SuccessSessionCount started at 100,
and during the sample time period, five successful sessions completed, then a reset occurred after
which 10 more sessions completed successfully, then the resulting delta for that time period would
be -90. This example shows that some information is lost; the response will indicate this with the
IsComplete flag set to false. In either case, the value could not be seen as an accurate representation
of activity for that time and should be ignored. For this reason, negative delta values are always
returned as “0”.
The CMP will get incomplete interval stats from MPE/MRA in the following conditions:
• The active MPE/MRA blade switches over one or more times within an interval period.
• MPE/MRA has initially started up.
• Under high-load conditions, the MPE/MRA cannot store data to the database at the end of an
interval cycle (within a margin of a few seconds).
Comparisons Between the CMP GUI and OM Statistics

Relationships between the OM XML responses and the CMP Reports GUI can be drawn and used for
comparison.
The OM XML interface persists statistic values over time. This tool is intended for historical analysis
of statistics and can be used to track usage. The interface enables you to request data over a user-defined
time range and returns data for that period. The default behavior for this interface is to return data as
delta values. The delta is calculated as the positive change in value between the start and end times
returned in “Sample” buckets. Certain non-cumulative statistics are always reported as absolutes and
those individual statistics are explicitly documented. This behavior can also be changed to return
absolute values for all statistics; even those which are cumulative in nature (see OM Statistics Requests).
The “Reports” page in the Policy Server section of the CMP GUI displays statistics in real time (Refer
to the CMP User’s Guide for details). The intent of this page is for monitoring current statistics. The
page dynamically updates the displayed statistics every 10 seconds. These statistics are categorized
by protocol. The default behavior of this page displays statistics as absolute values. There is a “Show
Deltas” button at the top of the page; this button can be used to switch the display to calculated delta

values. The delta value shown is the difference between the current value and the last refresh of the
page (approximately 10 seconds).
The top section on any statistics page, contained within the CMP GUI, usually correlates with the
“Message Processing Stats” of the OM XML interface. The individual statistics for each Network
Element can be found in the section at the bottom of the reporting page. These statistics correlate with
the “Network Element Stats” of the OM XML interface.
Labels for specific statistics may differ between the CMP GUI and the OM XML interface responses.
The specific types of statistics displayed may also differ by protocol. While the CMP GUI can use
labels and statistics specific to a certain protocol, the OM XML interface requests must use generic
language across protocols in order to remain consistent with published XSD definitions.
For deployments that collect statistics across multiple protocols, for example PCMM and DQoS, the
CMP GUI displays statistics for each protocol individually. However, in the XML Interface, the statistics
for available protocols are summarized in the response. For example, session count statistics for PCMM
and DQoS would be added together to display with each network element. Statistics for individual
protocols are not be displayed separately.
Additional details for the GUI’s Reports/Statistics section of the CMP GUI can be found in the CMP
User’s Guide.

Chapter
4
Identity Management (IDM)
Topics: Identity Management (IDM) allows the CMP to

configure user names, passwords and roles using
• Identity Management Overview.....36 the OSSI interface. It also allows querying of user
• Add a User.....36 scopes and roles.
• Update a User.....42
• Delete a User.....46
• Query a User.....47
• Query User Role.....48
• Query User Scope.....51

Identity Management Overview

The Identity Management system connects to a CMP through an HTTP or HTTPS interface. The user
must specify the operation parameter idm in the requested URL, similar to http://127.0.0.1/mi/
xmlInterfaceRequest.do?user=supervisor&pwd=password&operation=idm.
The account used for connecting the OSSI to the CMP is a regular CMP user account, with the default
global scope and the following privileges:
• Show Privilege for OSSI Import/Export
• Read-Write Privilege for User Management
The Identity Management feature allows users to perform the following tasks:
• Add a User: Create one or more users, or update a current user's parameters by overwriting them
with new parameters.
• Update a User: Update parameters for one or more users.
• Query a User: Query one user if the Name element occurs, or all users if no Name element occurs.
• Delete a User: Delete one or more users.
• Query User Role: Query one role if the Name element occurs, or all roles if no Name element occurs.
• Query User Scope: Query one scope if the Name element occurs, or all scopes if no Name element
occurs.
Add a User
Note: This query is not available to Policy servers in NW-CMP mode.
The following examples show the request and response that are defined in the XSDs for the
AddSysAdminUser tag.
Successful Request
Request
This request follows the AddSysAdminUser tag defined in the XSDs.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<AddSysAdminUser>
<SysAdminUser>
<Name>admin1</Name>
<Description>The default administrator user with all
privileges</Description>
<Password>camiant</Password>
<LockedStatus>0</LockedStatus>
<RoleRef>
<Name>Administrator</Name>
</RoleRef>
<ScopeRef>
<Name>Global</Name>
</ScopeRef>

</SysAdminUser>
</AddSysAdminUser>
The AddSysAdminUser operation parameters are:

• Name (Required) — 250 characters (string)
• Description (Optional) — 250 characters (string)
• Password (Required) — A clear text
• LockedStatus (Required) — 0 = unlocked; 1 = locked
• RoleRef (Required) — Can specify only one role
• ScopeRef (Required) — Can specify multiple scopes
Request

<Response>
<Result>0</Result>
<Success count="1">Successfully imported 1 User(s).</Success>
</Command>
</Response>
The AddSysAdminUser errors that a user may receive are:

• ERROR_USER_INVALID_NAME — Invalid User Name for: '{$UserName}'; UserName
is an empty string.
• ERROR_USER_NAME_TOO_LONG — User Name exceeds max length for:
'{$UserName}'; UserName exceeds max length (250 characters).
• ERROR_USER_DESCRIPTION_TOO_LONG — User Description exceeds max length.
User: '{$UserName}'; Description exceeds max length (250 characters)
• ERROR_USER_NOROLE_OR_NOSCOPE — User: '{$Username}' must have an
associated Role and Scope.; Non-Role or non-Scope is defined in OSSI command.
• ERROR_USER_INVALID_ROLE_NAME — Invalid Role Name for: '{$RoleName}';
RoleName is an empty string, or RoleName exceeds max length (250 characters), or there is more
than one Role defined.
• ERROR_USER_INVALID_SCOPE_NAME — Invalid Scope Name for: '{$ScopeName}';
ScopeName is an empty string, or ScopeName is exceeds max length (250 characters).
• ERROR_USER_ROLE_LINK — The user: {$UserName}'s associated role does not
exist. Please create it first.; RoleName is not defined in CMP.
• ERROR_USER_SCOPE_LINK — The user: {$UserName}'s associated scope does
not exist. Please create it first.; ScopeName is not defined in CMP.
• ERROR_SCHEMA_INVALID — N/A; If the input OSSI command cannot match the schema
specification, there will be an error-message response to the operator. For example, if you define
a LockStatus with a string, the following message will be reported: “Error parsing import
file: Error parsing import file: cvc-datatype-valid.1.2.1: 'ABC' is not
a valid value for 'integer'.”

ERROR_USER_INVALID_NAME
Request

<AddSysAdminUser>
<SysAdminUser>
<Name></Name>
<Password>oracle</Password>
<RoleRef>
</RoleRef>
<ScopeRef>
<Name>Global</Name>
</ScopeRef>
</SysAdminUser>
</AddSysAdminUser>
Request
The following error response occurs when the user name is invalid.

<Response>
<Result>0</Result>
<Failure count="1">Failed to import 1 User(s).
Invalid User Name for: ""</Failure>

</Command>
</Response>
ERROR_USER_INVALID_ROLE_NAME
Request

<AddSysAdminUser>
<SysAdminUser>
<Name>admin1</Name>
<RoleRef>
<Name></Name>
</RoleRef>
<ScopeRef>

<Name>Global</Name>
</ScopeRef>
</SysAdminUser>
</AddSysAdminUser>
Request
The following error response occurs when the role name is invalid.

<Response>
<Result>0</Result>
Invalid Role Name for: "admin1"</Failure>

</Command>
</Response>
ERROR_USER_INVALID_SCOPE_NAME
Request

<AddSysAdminUser>
<SysAdminUser>
<Name>admin1</Name>
<RoleRef>
</RoleRef>
<ScopeRef>
<Name></Name>
</ScopeRef>
</SysAdminUser>
</AddSysAdminUser>
Request
The following error response occurs when the scope name is invalid.

<Response>
<Result>0</Result>

Invalid Scope Name for: "admin1"</Failure>

</Command>
</Response>
ERROR_USER_ROLE_LINK
Request

<AddSysAdminUser>
<SysAdminUser>
<Name>admin1</Name>
<ScopeRef>
<Name>Not Exist Global</Name>
</ScopeRef>
</SysAdminUser>
</AddSysAdminUser>
Request
The following error response occurs when the user's associated role does not exist.

<Response>
<Result>0</Result>
User: "admin1" must have an associated Role and Scope.</Failure>

</Command>
</Response>
ERROR_USER_NOROLE_OR_NOSCOPE
Request

<AddSysAdminUser>
<SysAdminUser>
<Name>admin1</Name>

<RoleRef>
<Name>Not Exits Administrator</Name>
</RoleRef>
<ScopeRef>
<Name>Global</Name>
</ScopeRef>
</SysAdminUser>
</AddSysAdminUser>
Request
The following error response occurs when the user's role does not exist.

<Response>
<Result>0</Result>
The user: admin1's associated role does not exist. Please create it
first.</Failure>
</Command>
</Response>
Request

<AddSysAdminUser>
<SysAdminUser>
<Name>admin1</Name>
<RoleRef>
</RoleRef>
<ScopeRef>
<Name>Not Exist Global</Name>
</ScopeRef>
</SysAdminUser>
</AddSysAdminUser>
Request
The following error response occurs when the user's scope does not exist.

<Response>
<Result>0</Result>

The user: admin1's associated scope does not exist. Please create it
first.</Failure>
</Command>
</Response>
Update a User
UpdateSysAdminUser tag.
Request
This request follows the UpdateSysAdminUser tag defined in the XSDs.

<UpdateSysAdminUser>
<SysAdminUser>
<Name>admin1</Name>
<Description>New The default administrator user with all
<RoleRef>
</RoleRef>
<ScopeRef>
<Name>Global</Name>
</ScopeRef>
</SysAdminUser>
</UpdateSysAdminUser>
The UpdateSysAdminUser operation parameters are:

• Name(Required): 250 characters (string)
• Description (Optional): 250 characters (string)
• Password(Optional): A clear text
• LockedStatus (Optional): 0 = unlocked; 1 = locked
• RoleRef (Optional): Can specify only one role
• ScopeRef (Optional): Can specify multiple scopes
The probable errors a user may receive are as follows:
• ERROR_USER_NAME_NOT_EXIST: Specified User does not exist:
'{$UserName}';The specified user is not in system.
• ERROR_USER_INVALID_NAME: Invalid User Name for: '{$UserName}'; User Name
is an empty string.;
• ERROR_USER_NAME_TOO_LONG: User Name exceeds max length for:
'{$UserName}'; UserName exceeds max length (250 characters).

• ERROR_USER_DESCRIPTION_TOO_LONG: User Description exceeds max length.

User: '{$UserName}'; Description exceeds max length (250 characters)
• ERROR_USER_NOROLE_OR_NOSCOPE: User: '{$Username}' must have an associated
Role and Scope.; Non-Role or non-Scope is defined in OSSI command.
• ERROR_USER_INVALID_ROLE_NAME: Invalid Role Name for: '{$RoleName}';
RoleName exceeds max length (250 characters), or There is more than one Role defined.
• ERROR_USER_INVALID_SCOPE_NAME: Invalid Scope Name for: '{$ScopeName}';
ScopeName exceeds max length (250 characters).
• ERROR_USER_ROLE_LINK: The user: {$UserName}'s associated role does not
exist. Please create it first.; RoleName is an empty string, or RoleName is not defined
in CMP.
• ERROR_USER_SCOPE_LINK: The user: {$UserName}'s associated scope does not
exist. Please create it first.; ScopeName is an empty string, or ScopeName is not
defined in CMP.
• ERROR_SCHEMA_INVALID: N/A; If the input OSSI command cannot match the schema
specification, there will be an error-message response to the operator. For example, if you define
a LockStatus with a string, the following message will be reported: “Error parsing import
file: Error parsing import file: cvc-datatype-valid.1.2.1: 'ABC' is not
a valid value for 'integer'.”
Response
The response to this request follows the generic Response tag defined in the XSDs.

<Response>
<Result>0</Result>
<Success count="1">Successfully updated 1 User(s).</Success>
</Command>
</Response>
ERROR_USER_NAME_NOT_EXIST
Request

<SysAdminUser>
<Name>NotExistadmin1</Name>
<RoleRef>
</RoleRef>
<ScopeRef>
<Name>Global</Name>
</ScopeRef>
</SysAdminUser>

Response
The following error response occurs when the user name does not exist.

<Response>
<Result>0</Result>
<Failure count="1">Failed to update 1 User(s).
Specified User does not exist: "NotExistadmin1"</Failure>

</Command>
</Response>
ERROR_USER_NOROLE_OR_NOSCOPE
Request

<SysAdminUser>
<Name>admin1</Name>
<RoleRef>
<Name>not exist Administrator</Name>
</RoleRef>
<ScopeRef>
<Name>Global</Name>
</ScopeRef>
</SysAdminUser>
Response
The following error response occurs when the user's specified role does not exist.

<Response>
<Result>0</Result>
The user: admin1's associated role does not exist. Please create it
first.</Failure>
</Command>
</Response>

Request

<SysAdminUser>
<Name>admin1</Name>
<RoleRef>
</RoleRef>
<ScopeRef>
<Name>Not exist Global</Name>
</ScopeRef>
</SysAdminUser>
Response
The following error response occurs when the user's specified scope does not exist.

<Response>
<Result>0</Result>
The user: admin1's associated scope does not exist. Please create it
first.</Failure>
</Command>
</Response>
ERROR_USER_INVALID_ROLE_NAME
Request

<SysAdminUser>
<Name>admin1</Name>
<RoleRef>
<Name>123</Name>
</RoleRef>
<RoleRef>
</RoleRef>

<ScopeRef>
<Name>123</Name>
</ScopeRef>
</SysAdminUser>
Response
The following error response occurs when the role name either exceeds the maximum length of 250
characters, or there is more than one Role defined.

<Response>
<Result>0</Result>
Invalid Role Name for: "admin1"</Failure>

</Command>
</Response>
Delete a User
DeleteSysAdminUser tag.
Successful Deletion
Request
This request follows the DeleteSysAdminUser tag defined in the XSDs.

<DeleteSysAdminUser>
<SysAdminUser>
<Name>admin1</Name>
</SysAdminUser>
</DeleteSysAdminUser>
The DeleteSysAdminUser operation parameters are as follows:

• Name (Required): 250 characters (string)
The probable DeleteSysAdminUser errors a user may receive are as follows:
• ERROR_DELETE_FAILURE: Message Error deleting User Name: {$UserName}. The
specified user does not exist, or Admin user is specified.
Request

The response to this request:

<Response>
<Result>0</Result>
<Success count="1">Deleted 1 users.</Success>
</Command>
</Response>
If deletion is successful, the number of deleted users will be reported.
ERROR_DELETE_FAILURE
Request
This request follows the DeleteSysAdminUser tag defined in the XSDs.

<DeleteSysAdminUser>
<SysAdminUser>
<Name>admin1</Name>
</SysAdminUser>
</DeleteSysAdminUser>
Request
The response to this request when the specified user name does not exist:

<Response>
<Result>0</Result>
<Failure count="1">Failed to delete 1 user.
Error deleting User Name: admin1</Failure>
</Command>
</Response>
Query a User
QuerySysAdminUser tag. If the Name element occurs, the CMP will query only the corresponding
user; otherwise, all users are queried.
Request

This request follows the QuerySysAdminUser tag defined in the XSDs.

<QuerySysAdminUser>
<Name>admin</Name>
</QuerySysAdminUser>
The QuerySysAdminUser operation parameters are as follows:

• Name (Optional): 250 characters (string)
If the query is successful, the list of users will be returned in XML as a response with the following
fields for each user.
The output fields for QuerySysAdminUser operation are as follows:
• Name: The user's name
• Description: The user's description
• Password: The user's password, encrypted
• LockedStatus: 0 = locked, 1 = unlocked
• RoleRef:The associated role
• ScopeRef: The associated scope; there can be multiple scopes.
Response

<ConfigurationData version="7.5.0">
<SysAdminUser>
<Name>admin</Name>
<Password>835154D6D3FA2C3575AA700A54AB9F6492E7ABB7</Password>
<RoleRef>
</RoleRef>
<ScopeRef>
<Name>Global</Name>
</ScopeRef>
</SysAdminUser>
</ConfigurationData>
Query User Role

The following example shows the request and response that is defined in the XSDs for the QueryRole
tag. If the Name element occurs, the CMP will query the corresponding role with the name; otherwise,
it will query all roles.
Request

This request follows the QueryRole tag defined in the XSDs.

<QueryRole>
</QueryRole>
QueryRole Operation Parameters

• Name: (Optional) 250 characters (string)
If the query is successful, the list of users will be returned in XML as a response with the following
fields for each user.
Output Fields for QueryRole Operation
• Name: The role's name
• Description: The role's description
• RolePrivilege: The privilege with privilege name and access level assigned to the Role. There can
be multiple privileges.
Response

<Role>
<Description>The default role with all privileges</Description>
<RolePrivilege>
<Privilege>policy server</Privilege>
<Level>40</Level>
<RolePrivilege>
<Privilege>Network Element</Privilege>
<Level>Read-Write</Level>
</RolePrivilege>
<RolePrivilege>
<Privilege>Application</Privilege>
</RolePrivilege>
<RolePrivilege>
<Privilege>Policy Library</Privilege>
<Level>Read, Deploy, and Write</Level>
</RolePrivilege>
<RolePrivilege>
<Privilege>Template Library</Privilege>
</RolePrivilege>
<RolePrivilege>
<Privilege>User Management</Privilege>
</RolePrivilege>
<RolePrivilege>
<Privilege>Manager Event and Audit Logs</Privilege>
</RolePrivilege>
<RolePrivilege>

<Privilege>Tasks</Privilege>
</RolePrivilege>
<RolePrivilege>
<Privilege>License Management</Privilege>
</RolePrivilege>
<RolePrivilege>
<Privilege>Traffic Profiles</Privilege>
</RolePrivilege>
<RolePrivilege>
<Privilege>XML Import / Export</Privilege>
<Level>Show</Level>
</RolePrivilege>
<RolePrivilege>
<Privilege>Operational Measurements</Privilege>
<Level>Read-Only</Level>
</RolePrivilege>
<RolePrivilege>
<Privilege>Charging Server</Privilege>
</RolePrivilege>
<RolePrivilege>
<Privilege>Time Period</Privilege>
</RolePrivilege>
<RolePrivilege>
<Privilege>Policy Import / Export</Privilege>
</RolePrivilege>
<RolePrivilege>
<Privilege>Alarms</Privilege>
</RolePrivilege>
<RolePrivilege>
<Privilege>Audit Log User Info</Privilege>
<Level>Show</Level>
</RolePrivilege>
<RolePrivilege>
<Privilege>Password Strength</Privilege>
</RolePrivilege>
<RolePrivilege>
<Privilege>Event Log</Privilege>
</RolePrivilege>
<RolePrivilege>
<Privilege>Audit Log</Privilege>
</RolePrivilege>
</Role>
A subset of the RolePrivilege element will be outputted in XML based on the mode selected by the
operator. The output XML cannot be imported to the CMP again.

Query User Scope

The following example shows the request and response that is defined in the XSDs for the QueryScope
tag. If the Name element occurs, the CMP will query only the corresponding scope, otherwise all
scopes are queried.
Request
This request follows the QueryScope tag defined in the XSDs.

<QueryScope>
<Name>Global</Name>
</QueryScope>
If query is successful, the list of the scopes will be returned in XML as a response. If no Ref element
occurs, it means the scope is a global scope in system.
QueryScope Operation Parameters
• Name: (Optional) 250 characters (string)
If the query is successful, the list of the roles will be returned in XML as a response.
Output Fields for QueryScope Operation
• Name: The scope's name
• Description: The scope's description
• ResourceControllerGroupRef — The manageable MPEs’ name set.
• MRAGroupRef: The manageable MRAs’ name set.
• NetworkElementGroupRef: The manageable Network Elements’ name set.
Response

<Scope>
<Name>Global</Name>
<Description>The default scope that automatically contains all items in
the system</Description>
</Scope>
A subset of the Ref element will be outputted in XML based on the mode selected by the operator.
The output XML cannot be imported to the CMP again.

Chapter
5
Policy Table Interface
Topics: Table-driven policies allows you to generalize

multiple similar policies into a single policy that
• Policy Table Overview.....53 represents the policy structure, plus a policy table(s)
• Exported Policy Table XML.....53 that captures the differences. These tables make
• Add a Policy Table.....54 processes such as adding new policies, modifying
• Modify a Policy Table.....54 existing policies, and checking consistency among
policies, much simpler and less error prone.
• Delete a Policy Table.....55

Policy Table Overview

Policy Tables can be imported or exported to the OSSI XML Interface using the CMP. See "Importing
to and Exporting from the CMP Database" in the CMP Wireless User Guide for details on using the OSSI
XML Interface.
Policy tables can be exported to the OSSI XML Interface, and then edited or replaced. Tables can also
be imported from the OSSI back to the CMP with changes, as new tables, or to delete an existing table.
The format for both export and import must be the same and must include:
• The policy table's name
• The policy table's description
• The names of the columns
• The data types of the columns
• The designation of which columns are keys
• The policy context variables for key columns
• The values in the cells
Exported Policy Table XML

The exported policy table is an XML file. Descriptions of the fields are given after the table.
To receive correct results, the XML for a policy table must maintain the integrity of that table.
This is an example of a policy table in XML format.
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>

<AddPolicyTableData>
<PolicyTableData>
<Name>T</Name>
<Description>ABC</Description>
<Table>
<Header>
<Field Type="smartString255" Key="true" Field="TA">TA</Field>
</Header>
<Record Name="1330657994893">
<Field Field="TA">TA</Field>
</Record>
<Record Name="1330657994894">
<Field Field="TA">TAsssss</Field>
</Record>
</Table>
</PolicyTableData>
<PolicyTableData>
<Name>T2</Name>
<Description>TABLE1111111111111111111111111</Description>
<Table>
<Header>
</Header>
<Record Name="1330657994893">

</Record>\
<Record Name="1330657994894">
</Record>
</Table>
</PolicyTableData>
</AddPolicyTableData>
The fields are:

• Name: The name of the Policy Table that was exported.
• Description: This description is copied from CMP.
Add a Policy Table

You can use the OSSI XML Interface to add a policy table, or if the policy-table name does not exist
in the CMP you can use the interface to modify a table.
When naming a new table, the length limitation for the name is 255 characters. The description field
is a free-form text that identifies the policy table and also has a limit of 250 characters.
Note: If the length of either the name or description is exceeded, the import will fail.
The following example shows the code to import a Policy Table named "Sample1".

<AddPolicyTableData>
<Name>Sample 1</Name>
<Description>Sample 1</Description>
<Table>
<Header>
</Header>
<Record Name="1330657994893">
</Record>
<Record Name="1330657994894">
</Record>
</Table>
</AddPolicyTableData>
<</XmlInterfaceRequest>
Modify a Policy Table

You can use the OSSI XML Interface to change a policy table that is already in CMP.

If the table name does not exist in the CMP, the import will fail.
A column cannot be changed or removed if it is being used in a policy or policy template. If the XML
in a column is changed or removed, then the import will fail.
The import allows these types of edits:
• Editing the name and description of policy tables
• Adding, removing, and reordering columns
• Editing a column's name, data type, and key status
• Adding, removing, and reordering rows
• Changing the data within the cells
The following example imports shows the XML command to change or modify for a Policy Table
named "Sample 1".

<UpdatePolicyTableData>
<Table>
<Header>
</Header>
<Record Name="1330657994893">
</Record>
<Record Name="1330657994894">
</Record>
</Table>
</UpdatePolicyTableData>
Delete a Policy Table

You can use the OSSI XML Interface to delete a policy table that is already in CMP.
Note: If the Policy Table is currently used in a policy or policy template, the import will fail.
The following example shows the XML command to a Policy Table named "Sample 1".

<DeletePolicyTableData>
</DeletePolicyTableData>

Part
III
Wireless Mode
Topics: This section is dedicated to the using the the OSSI

XML interface specifically for the wireless mode.
• Topology Interface for Wireless Mode.....57
The interface itself is divided into the following
• Subscriber Interface for Wireless Mode.....96
areas:
• Operational Measurement Requests for Wireless
Mode.....110 • Topology Interface — allows wireless users to
manage and query network elements,
applications, traffic profiles and other
topology-related objects in the system .
• Subscriber Interface — allows wireless users to
manage and query Quota Profiles and Quota
Conventions from the subscriber interface.
• Operational Measurements (OM) Interface —
allows wireless users to retrieve statistical data
from the system.
Each of these interfaces is described in detail in later
chapters in this part of the document.

Chapter
1
Topology Interface for Wireless Mode
Topics: The Topology Interface allows wireless users to

manage and query network elements, paths, and
• Network Elements.....58 other topology-related objects within the system.
• Applications.....66
Note: Some queries of topology-related objects will
• Traffic Profiles.....68 not be available to S-CMPs. In this guide, all queries
• Time Periods.....75 NOT available in the S-CMP will be labeled with a
• Charging Servers.....79 note.
• Match List.....83
• Monitoring Key.....86
• AVP Definition.....89
• Serving GPRS Support Node.....92

Network Elements
A network element represents a node in the network (cable or wireless), such as a router, CMTS, PDSN,
B-RAS, and so on. The network elements can be organized into logical groups that subdivide the
network space. Network elements have the following attributes that can be requested.
Note: Depending on your system configuration, not all attributes may be present.
Note: The same attributes are also used in the Update Network Element operation.
• Capability: The numerical identity of network element capability type. For example:
• TDF-Solicit
• Time-Tariff (PGW,DPI)
• Usage-Report-26(GGSN,PGW,SWG,DPI)
• SctpEnabled: Whether the Network Element supports diameter over SCTP.

• InitiateDirectConnection: The diameter connection port of the TDF element network.
• TdfPort: The diameter connection port of the TDF element network.
• ReconnectDelay: The delay period after diameter connection fails. The unit is in seconds.
• WatchDogInterval: The time interval of the watch dog monitor.
• ResponseTimeout: The time period before there is a connection response timeout.
The following sections describe the available network tags.
Add a Network Element in Wireless

AddNetworkElement tag.
Request
This request follows the AddNetworkElement tag defined in the XSDs.
The following example creates a new Network Element to represent a router in the network. It also
creates a group, and puts the router in that group.
The router contains the following attributes:
• Name (unique identifier): Router 23
• Description: Core router for the north east
• HostName (IP address or DNS hostname): 12.1.1.1
• NeID (another unique identifier): 112222
• Capacity (aggregate capacity in bps): 456000
The group contains the following attributes:
• Name: NE Group 1

• Description: All core routers

<AddNetworkElement>
<NetworkElement>
<Name>Router 23</Name>
<Description>Core router for the north east</Description>
<HostName>12.1.1.1</HostName>
<NeId>112222</NeId>
<NetworkElementType>PGW</NetworkElementType>
<NeSubType></NeSubType>
<Capacity>456000</Capacity>
</NetworkElement>
<NetworkElementGroup>
<Name>NE Group 1</Name>
<Description>All core routers</Description>
<RootGroup>true</RootGroup>
<ElementRef>
<Name>router 23</Name>
<SubGroup>false</SubGroup>
</ElementRef>
</NetworkElementGroup>
</AddNetworkElement>
Response
The example XML response that follows represents a successful operation that creates a new network
element and/or groups:

<Response>
<Result>0</Result>
<Success count="2">Successfully imported 1 network elements.
Successfully imported 1 group.</Success>
</Command>
</Response>
The example XML response that follows represents an operation that includes both a success and a
failure (for example, an attempt to update a group’s description field (success), and add an unknown
network element “router 24” to the group “NE Group 1” (failed)).

<Response>
<Result>0</Result>
<Success count="1">Successfully updated 1 groups.</Success>
<Failure count="1">Failed to update 1 groups. Network Element Group
update returned an error attempting to add the following: router 24
Group NE Group 1</Failure>
</Command>
</Response>

Update a Network Element in Wireless

UpdateNetworkElement tag.
Note: For a list of all the attributes that can be associated with a Network Element see: .
Request
This request follows the UpdateNetworkElement tag defined in the XSDs.
The following example shows the XML command to change the capacity attribute of the network
element named “Router 23” to the new value: 4567000.

<UpdateNetworkElement>
<NetworkElement>
</NetworkElement>
</UpdateNetworkElement>
Response

<Response>
<Result>0</Result>
<Success count="1">Successfully updated 1 network elements.</Success>
</Command>
</Response>
Delete Request for Update Network Element in Wireless

The following examples show the delete request and response that are defined in the XSDs for the
Request
This delete request follows the UpdateNetworkElement tag defined in the XSDs.
The following example is a request for the ManualSubnet operation to delete a network element.

<NetworkElement>

<Name>cmts17o</Name>
<Description></Description>
<BackupHostName></BackupHostName>
<NetworkElementType>CMTS</NetworkElementType>
<NeSubType>None</NeSubType>
<Managed>true</Managed>
<PcmmPort>3918</PcmmPort>
<DqosPort>0</DqosPort>
<ReadCommunity></ReadCommunity>
<X>0</X>
<Y>0</Y>
<ManualSubnet operation=”delete”>
<Mask>24</Mask>
</NetworkElement>
Response

<Response>
<Result>0</Result>
</Command>
</Response>
Add Network Element to Group

AddNetworkElementToGroup tag.
Request
This request follows the AddNetworkElementToGroup tag defined in the XSDs.
The following example shows the XML command to add three network elements (Router 2, Router
34, and Router 131) to a group (Group 1).

<AddNetworkElementToGroup>
<GroupName>Group 1</GroupName>
</AddNetworkElementToGroup>
Response


<Response>
<Result>0</Result>
<Success count="3">Added 3 elements to a group.</Success>
</Command>
</Response>
Remove Network Element from Group

RemoveNetworkElementFromGroup tag.
Request
This request follows the RemoveNetworkElementFromGroup tag defined in the XSDs.
The following example shows the XML command to remove two network elements (Router 34 and
Router 131) from a group (Group 1).

<RemoveNetworkElementFromGroup>
</RemoveNetworkElementFromGroup>
Response

<Response>
<Result>0</Result>
<Success count="2">Removed 2 elements from group.</Success>
</Command>
</Response>
Delete Network Element

DeleteNetworkElement tag.
Request

This request follows the DeleteNetworkElement tag defined in the XSDs.

The following example shows the XML command to delete two network elements (Node 1 and Node
2).

<DeleteNetworkElement>
<Name>Node1</Name>
<Name>Node2</Name>
</DeleteNetworkElement>
Response

<Response>
<Result>0</Result>
<Success count="2">Deleted 2 elements.</Success>
</Command>
</Response>
Delete Network Element Group

DeleteNetworkElementGroup tag.
Request
This request follows the DeleteNetworkElementGroup tag defined in the XSDs.
The following example shows the XML command to delete two network element groups (Group 1
and Group 2).

<DeleteNetworkElementGroup>
<Name>Group 1</Name>
</DeleteNetworkElementGroup>
Response

<Response>
<Result>0</Result>

<Success count="2">Deleted 2 network element groups.</Success>
</Command>
</Response>
Query Network Elements

Note: This query is not available to Policy servers in S-CMP mode.
QueryNetworkElement tag.
Request
This request follows the QueryNetworkElement tag defined in the XSDs.
Example 1 — XML for querying multiple network elements by name.

<QueryNetworkElement>
<Name>NE A</Name>
<Name>NE B</Name>
</QueryNetworkElement>
Example 2 — XML for querying all network elements and groups.

Response
The response to this request follows the ConfigurationData > NetworkElement tag defined in the
XSDs.
<NetworkElement>
<Name>vod-1</Name>
<Description/>
<HostName/>
<BackupHostName/>
<NeId>vod-1</NeId>
<NetworkElementType>Server</NetworkElementType>
<X>0</X>
<Y>0</Y>
<ManualSubnet>
<Mask>8</Mask>
</ManualSubnet>

</NetworkElement>
<NetworkElement>
<Name>erx-1</Name>
<Description/>
<HostName/>
<BackupHostName/>
<NeId>erx-1</NeId>
<NetworkElementType>B-RAS</NetworkElementType>
<NeSubType>ERX</NeSubType>
<X>0</X>
<Y>0</Y>
<ManualSubnet>
<Mask>8</Mask>
</ManualSubnet>
<NEInterface>
<Name>8/0</Name>
<Description/>
</NEInterface>
</NetworkElement>
<NetworkElement>
<Name>router-1</Name>
<Description/>
<HostName/>
<BackupHostName/>
<NeId>router-1</NeId>
<NetworkElementType>Router</NetworkElementType>
<X>0</X>
<Y>0</Y>
</NetworkElement>
<NetworkElement>
<Description/>
<HostName/>
<BackupHostName/>
<X>0</X>
<Y>0</Y>
</NetworkElement>
<NetworkElement>
<Name>mx-1</Name>
<Description/>
<BackupHostName/>
<NeId/>
<NetworkElementType>Wireline Gateway</NetworkElementType>
<NeSubType>MX Series</NeSubType>
<X>0</X>
<Y>0</Y>
<DiameterRealm>juniper.com</DiameterRealm>
<ManualSubnet>
<Mask>8</Mask>
</ManualSubnet>
<Nediameterid>
<NediameteridStr>mx.juniper.com</NediameteridStr>

</Nediameterid>
</NetworkElement>
Applications
An application is a service in the network (for example, VoIP) for which Quality of Service (QoS) is
managed.
Add Application
AddApplication tag.
Request
This request follows the AddApplication tag defined in the XSDs.

<AddApplication>
<Application>
<Name>VoD</Name>
<Description>Video on Demand</Description>
<LatencySensitive>true</LatencySensitive>
<Tracked>true</Tracked>
<UpGatesPerSession>1</UpGatesPerSession>
<DownGatesPerSession>1</DownGatesPerSession>
<TrackingTimeoutTime>240</TrackingTimeoutTime>
<TrackingTimeoutUnit>1</TrackingTimeoutUnit>
</Application>
</AddApplication>
Response

<Response>
<Result>0</Result>
<Success count="1">Successfully imported 1 applications.</Success>
</Command>
</Response>

Update Application
UpdateApplication tag.
Request
This request follows the UpdateApplication tag defined in the XSDs.

<UpdateApplication>
<Application>
<Name>VoD</Name>
<LatencySensitive>false</LatencySensitive>
</Application>
</UpdateApplication>
Response

<Response>
<Result>0</Result>
<Success count="1">Successfully updated 1 applications.</Success>
</Command>
</Response>
Delete Application
DeleteApplication tag.
Request
This request follows the DeleteApplication tag defined in the XSDs.

<DeleteApplication>
<Name>VoD</Name>
</DeleteApplication>
Response


<Response>
<Result>0</Result>
<Success count="1">Deleted 1 applications.</Success>
</Command>
</Response>
Query Application
QueryApplication tag.
Request
This request follows the QueryApplication tag defined in the XSDs.

<QueryApplication/>
Response
The response to this request follows the ConfigurationData > Application tag defined in the XSDs.

<Application>
<Name>VoD</Name>
<LatencySensitive>true</LatencySensitive>
<Tracked>true</Tracked>
<DownGatesPerSession>1</DownGatesPerSession>
<TrackingTimeoutTime>240</TrackingTimeoutTime>
<TrackingTimeoutUnit>1</TrackingTimeoutUnit>
</Application>
Traffic Profiles
A traffic profile is a set of parameters and their values, which are used in protocol messages to define
QoS for sessions.

Add Traffic Profile

AddTrafficProfile tag.
Note: This request is only available to Policy Management releases 12.1 and beyond.
Request
This request follows the AddTrafficProfile tag defined in the XSDs.

XmlInterfaceRequest>
<AddTrafficProfile>
<QosProfile>
<Name>default-rule-traffic-profile</Name>
<ProfileType>0</ProfileType>
<QosProfileType>Diameter QoS</QosProfileType>
<QosProfileProfileParam>
<ProfileParamUid>param.diameter.qosProfile.profileTypeNumber
</ProfileParamUid>
<ParamValue>10</ParamValue>
</QosProfileProfileParam>
<ProfileParamUid>param.diameter.qosProfile.qci
</ProfileParamUid>
<ProfileParamUid>param.diameter.qosProfile.maxAuthUL
</ProfileParamUid>
<ParamValue></ParamValue>
<ProfileParamUid>param.diameter.qosProfile.maxAuthDL
</ProfileParamUid>
<ProfileParamUid>param.diameter.qosProfile.minRateUL
</ProfileParamUid>
<ProfileParamUid>param.diameter.qosProfile.minRateDL
</ProfileParamUid>
<ProfileParamUid>param.diameter.qosProfile.ARP.PriorityLevel
</ProfileParamUid>
<ProfileParamUid>param.diameter.qosProfile.ARP
.PreemptionCapability</ProfileParamUid>

<ProfileParamUid>param.diameter.qosProfile.ARP
.PreemptionVulnerability</ProfileParamUid>
<ProfileParamUid>param.diameter.qosProfile
.ResourceAllocationNotification</ProfileParamUid>
</QosProfile>
<QosProfileGroup>
<Name>group1</Name>
<ElementRef>
</ElementRef>
</QosProfileGroup>
</AddTrafficProfile>
Response

<Response>
<Result>0</Result>
<Success count="1">Successfully imported 1 Traffic Profile(s).</Success>
</Command>
</Response>
Add Traffic Profile Enhancement

AddTrafficProfile tag.
Note: This request is only available to Policy Management releases 12.1 and beyond.
Note: The Sd protocol supports only App Detection Control (ADC) profiles.
Request
This request follows the AddTrafficProfile tag defined in the XSDs.

XmlInterfaceRequest>
<AddTrafficProfile>
<QosProfile>
<Name>CAM-44498-1</Name>
<QosProfileType>PCC Rule</QosProfileType>

<ProfileParamUid>param.diameter.pccRule.profileTypeNumber</ProfileParamUid>
<ParamValue>13: {someVariableName} </ParamValue>
<ProfileParamUid>param.diameter.pccRule.name</ProfileParamUid>
<ParamValue>rule1:{someVariableName}</ParamValue>
<ProfileParamUid>param.diameter.pccRule.qci</ProfileParamUid>
<ParamValue>2:{someVariableName}</ParamValue>
<ProfileParamUid>param.diameter.pccRule.maxAuthUL</ProfileParamUid>
<ProfileParamUid>param.diameter.pccRule.maxAuthDL</ProfileParamUid>
<ProfileParamUid>param.diameter.pccRule.minRateUL</ProfileParamUid>
<ProfileParamUid>param.diameter.pccRule.minRateDL</ProfileParamUid>
<ProfileParamUid>param.diameter.pccRule.ARP.PriorityLevel</ProfileParamUid>
<ProfileParamUid>param.diameter.pccRule.ARP.PreemptionCapability</ProfileParamUid>
<ProfileParamUid>param.diameter.pccRule.ARP.PreemptionVulnerability</ProfileParamUid>
<ProfileParamUid>param.diameter.pccRule.ServiceIdentifier</ProfileParamUid>
<ProfileParamUid>param.diameter.pccRule.RatingGroup</ProfileParamUid>
<ProfileParamUid>param.diameter.pccRule.MonitoringKey</ProfileParamUid>

<ProfileParamUid>param.diameter.pccRule.ReportingLevel</ProfileParamUid>
<ProfileParamUid>param.diameter.pccRule.Online</ProfileParamUid>
<ProfileParamUid>param.diameter.pccRule.Offline</ProfileParamUid>
<ProfileParamUid>param.diameter.pccRule.MeteringMethod</ProfileParamUid>
<ProfileParamUid>param.diameter.pccRule.FlowStatus</ProfileParamUid>
<ProfileParamUid>param.diameter.pccRule.FlowDescriptions</ProfileParamUid>
<ProfileParamUid>param.diameter.pccRule.Precedence</ProfileParamUid>
<ProfileParamUid>param.diameter.pccRule.ServiceFlowDetection</ProfileParamUid>
</QosProfileGroup>
</AddTrafficProfile>
Response
<?xml version='1.0' ?>

<Response>
<Result>0</Result>
<Success count="1">Successfully imported 1 Traffic Profile(s).</Success>
</Command>
</Response>

Update Traffic Profile

UpdateTrafficProfile tag.
Request
This request follows the UpdateTrafficProfile tag defined in the XSDs.
<<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<UpdateTrafficProfile>
<QosProfile>
<QosProfileType>Second Predefined PCC Rule</QosProfileType>
</QosProfile>
</UpdateTrafficProfile>
Response

<Response>
<Result>0</Result>
<Success count="1">Successfully updated 1 Traffic Profile(s).</Success>
</Command>
</Response>
Delete Traffic Profile

DeleteTrafficProfile tag.
Request
This request follows the DeleteTrafficProfile tag defined in the XSDs.

<DeleteTrafficProfile>
</DeleteTrafficProfile>
Response


<Response>
<Result>0</Result>
<Success count="1">Deleted 1 Traffic Profile(s).</Success>
</Command>
</Response>
Query Traffic Profile

QueryTrafficProfile tag that queries all traffic profiles:
Request
This request follows the QueryTrafficProfile tag defined in the XSDs.

<QueryTrafficProfile/>
Response
The response to this request follows the ConfigurationData > QosProfile tag defined in the XSDs.

<ConfigurationData version="">
<QosProfile>
<QosProfileType>Predefined PCC Rule</QosProfileType>
<ProfileParamUid>param.diameter.pccPredefRule.profileTypeNumber
</ProfileParamUid>
<ProfileParamUid>param.diameter.pccPredefRule.name
</ProfileParamUid>
<ParamValue>PCRF-DEFAULT</ParamValue>
<ProfileParamUid>param.diameter.pccPredefRule.description
</ProfileParamUid>
<ParamValue>This is the static rule that gets applied by default
</ParamValue>
</QosProfile>
<QosProfile>
<Name>p2p-rule-traffic-profile</Name>
<QosProfileType>Predefined PCC Rule</QosProfileType>

<ProfileParamUid>param.diameter.pccPredefRule.profileTypeNumber
</ProfileParamUid>
<ProfileParamUid>param.diameter.pccPredefRule.name </ProfileParamUid>
<ParamValue>P2P-RATE-LIMIT-64K</ParamValue>
<ProfileParamUid>param.diameter.pccPredefRule.description
</ProfileParamUid>
<ParamValue>Rule limits bit-torrent and other peer to peer
applications
to 64Kbps downstream</ParamValue>
</QosProfile>
Time Periods
A time period defines a set of related time slots, which receives the same QoS (for example, “the peak
time of network usage is Monday through Friday from 9:00 am to 5:00 pm”).
Add Time Period

AddTimePeriod tag.
Request
This request follows the AddTimePeriod tag defined in the XSDs.
• The StartTime and EndTime tags represent a time-of-day value expressed in milliseconds. For
example, “01:30” time-of-day corresponds to 5,400,000 ((60+30)*60*1000) when expressed in
milliseconds.
• The Mask tag represents the day-of-week expressed in the form of a bitmask. The value for each
day-of-week corresponds to a power of two: Sunday is 1, Monday is 2, Tuesday is 4, Wednesday
is 8, Thursday is 16, Friday is 32, and Saturday is 64. To specify a set of days, add together the
values associated with the respective days. For example, "Monday and Wednesday" corresponds
to a value of 10 (i.e. 2 + 8).

<AddTimePeriod>
<TimePeriod>
<Name>timeperiod1</Name>
<Precedence>1</Precedence>
<TimeSlot>
<Mask>0</Mask>

<YearStr>2015</YearStr>
<MonthMask>4</MonthMask>
<DayStr>1,2,3</DayStr>
<Reverse>false</Reverse>
<StartTime>43200000</StartTime>
<EndTime>46800000</EndTime>
<StartDate></StartDate>
<EndDate></EndDate>
</TimeSlot>
<TimeSlot>
<Mask>24</Mask>
<YearStr></YearStr>
<DayStr></DayStr>
<EndDate></EndDate>
</TimeSlot>
</TimePeriod>
</AddTimePeriod>
Response

<Response>
<Result>0</Result>
<Success count="1">Successfully imported 1 Time Period(s).</Success>
</Command>
</Response>
Update Time Period

UpdateTimePeriod tag.
There are two operations associated with updating a time period. They are:
• Add TimeSlot (default setting)
• Delete TimeSlot
Add TimeSlot
Request
This add timeslot request follows the UpdateTimePeriod tag defined in the XSDs.

<UpdateTimePeriod>

<TimePeriod>
<Description>ss</Description>
<TimeSlot operation="add">
<Mask>8</Mask>
<YearStr>2016,2017</YearStr>
<DayStr>8,22</DayStr>
<EndDate></EndDate>
</TimeSlot>
</TimePeriod>
</UpdateTimePeriod>
Response
The add timeslot response to this request follows the generic Response tag defined in the XSDs.

<Response>
<Result>0</Result>
</Command>
</Response>
Delete TimeSlot
Request
This delete timeslot request follows the UpdateTimePeriod tag defined in the XSDs.

<UpdateTimePeriod>
<TimePeriod>
<Description>ss</Description>
<TimeSlot operation="delete">
<Mask>8</Mask>
<YearStr>2016,2017</YearStr>
<DayStr>8,22</DayStr>
<EndDate></EndDate>
</TimeSlot>
</TimePeriod>
</UpdateTimePeriod>

Response
The response to this request follows the delete timeslot Response tag defined in the XSDs.

<Response>
<Result>0</Result>
</Command>
</Response>
Delete Time Period

DeleteTimePeriod tag.
Request
This request follows the DeleteTimePeriod tag defined in the XSDs.

<DeleteTimePeriod>
</DeleteTimePeriod>
Response

<Response>
<Result>0</Result>
<Success count="1">Deleted 1 time period(s)</Success>
</Command>
</Response>
Query Time Period

QueryTimePeriod tag.
Request

This request follows the QueryTimePeriod tag defined in the XSDs.

<QueryTimePeriod>
</QueryTimePeriod>
Response
The response to this request follows the ConfigurationData > TimePeriod tag defined in the XSDs.

<TimePeriod>
<TimeSlot>
<Mask>0</Mask>
<YearStr>2015</YearStr>
<DayStr>1,2,3</DayStr>
<EndDate></EndDate>
</TimeSlot>
<TimeSlot>
<Mask>24</Mask>
<YearStr></YearStr>
<DayStr></DayStr>
<EndDate></EndDate>
</TimeSlot>
</TimePeriod>
Charging Servers
A charging server is a network element that processes accounting information for billing purposes.
Add Charging Server

AddChargingServer tag.

Request
This request follows the AddChargingServer tag defined in the XSDs.

<AddChargingServer>
<ChargingServer>
<Name>chargingServer_import1</Name>
<Security>true</Security>
<Port>4040</Port>
<Transport>udp</Transport>
<Protocol>radius</Protocol>
</ChargingServer>
<ChargingServer>
<Security>false</Security>
<Port>7089</Port>
<Transport>tcp</Transport>
<Protocol>tacacs+</Protocol>
</ChargingServer>
</AddChargingServer>
Response

<Response>
<Result>0</Result>
<Success count="2">Successfully imported 2 Charging Server(s).</Success>
</Command>
</Response>
Update Charging Server

UpdateChargingServer tag.
Request
This request follows the UpdateChargingServer tag defined in the XSDs.

<UpdateChargingServer>
<ChargingServer>

<Name>chargingServer_3</Name>
<Port>6040</Port>
</ChargingServer>
</UpdateChargingServer>
Response

<Response>
<Result>0</Result>
<Success count="1">Successfully updated 1 Charging Server(s).</Success>
</Command>
</Response>
Delete Charging Server

DeleteChargingServer tag.
Request
This request follows the DeleteChargingServer tag defined in the XSDs.

<DeleteChargingServer>
<Name>chs1</Name>
</DeleteChargingServer>
Response

<Response>
<Result>0</Result>
<Success count="1">Deleted 1 Charging Server(s).</Success>
</Command>
</Response>

Query Charging Server

QueryChargingServer tag.
Request
This request follows the QueryChargingServer tag defined in the XSDs.

<QueryChargingServer>
</QueryChargingServer>
Response
The response to this request follows the ConfigurationData > ChargingServer tag defined in the
XSDs.

<ChargingServer>
<Port>4040</Port>
</ChargingServer>
<ChargingServer>
<Port>7089</Port>
</ChargingServer>
<ChargingServer>
<Port>4040</Port>
</ChargingServer>
<ChargingServer>
<Port>7089</Port>

</ChargingServer>
Match List
The match list is a set of values that can be used within one or more policy definitions. When the user
writes a policy rule to compare against a value in a list, the list or set of lists to be used for comparison
is explicitly specified. For example:
“Where the SGSNIpAddress is contained in MaltaSgsnList, GreekSgsnList”
The Match List Type determines what kind of values can be specified in that list and how those values
are matched within the policy rule. Types can be “IPv4 Address” (allows address and subnet), “IPv6
Address”(allows address and prefix), “String”, and “Wildcard”.
Add Match List

AddMatchList tag.
Request
This request follows the AddMatchList tag defined in the XSDs.

<AddMatchList>
<TokenList>
<Name>match_list_01a_sgsn</Name>
<Description>This is a match list that will match the given
SGSN</Description>
<ItemType>3</ItemType>
<TokenListItem>
<Value>44.44.44.44</Value>
</TokenListItem>
<TokenListItem>
<Value>55.55.55.55</Value>
</TokenListItem>
<TokenListItem>
<Value>66.66.66.66</Value>
</TokenListItem>
</TokenList>
<TokenList>
<Name>match_list_01b_sgsn_black</Name>
<Description />
<TokenListItem>
<Value>44.44.44.44</Value>
</TokenListItem>
<TokenListItem>

<Value>55.55.55.55</Value>
</TokenListItem>
<TokenListItem>
<Value>66.66.66.66</Value>
</TokenListItem>
</TokenList>
</AddMatchList>
Response

<Response>
<Result>0</Result>
<Success count="2">Successfully imported 2 Match List(s).</Success>
</Command>
</Response>
Update Match List

UpdateMatchList tag.
Request
This request follows the UpdateMatchList tag defined in the XSDs.

<UpdateMatchList>
<TokenList>
<Description>This is an updated match list that will match the
given SGSN</Description>
<TokenListItem>
<Value>44.44.44.77</Value>
</TokenListItem>
<TokenListItem>
<Value>66.66.66.77</Value>
</TokenListItem>
</TokenList>
</UpdateMatchList>
Response

<Response>
<Result>0</Result>
<Success count="1">Successfully updated 1 Match List(s).</Success>
</Command>
</Response>
Delete Match List

DeleteMatchList tag.
Request
This request follows the DeleteMatchList tag defined in the XSDs.

<DeleteMatchList>
</DeleteMatchList>
Response

<Response>
<Result>0</Result>
<Success count="2">Deleted 1 Match List(s).</Success>
</Command>
</Response>
Query Match List

QueryMatchList tag.
Request
This request follows the QueryMatchList tag defined in the XSDs.

<QueryMatchList>

</QueryMatchList>
Response

<TokenList>
<Description>This is a match list that will match the given
SGSN</Description>
<TokenListItem>
<Value>44.44.44.77</Value>
</TokenListItem>
<TokenListItem>
<Value>66.66.66.77</Value>
</TokenListItem>
</TokenList>
<TokenList>
<Description />
<TokenListItem>
<Value>44.44.44.44</Value>
</TokenListItem>
<TokenListItem>
<Value>55.55.55.55</Value>
</TokenListItem>
<TokenListItem>
<Value>66.66.66.66</Value>
</TokenListItem>
</TokenList>
Monitoring Key
A monitoring key is a unique character string that identifies the quota profile to be used by a policy
and charging control (PCC) rule for usage tracking. The monitoring key is associated with the quota
profile by selecting a policy action that grants usage to a selected number of quota profiles.
Add Monitoring Key

AddMonitoringKey tag.
Request
This request follows the AddMonitoringKey tag defined in the XSDs.

<AddMonitoringKey>
<MonitoringKey>
<Name>Monitoring Key 1</Name>
<Description>Monitoring Key 1</Description>
<MonitoringType>0</MonitoringType>
<MonitoringKey>KEY_1</MonitoringKey>
</MonitoringKey>
<MonitoringKey>
</MonitoringKey>
</AddMonitoringKey>
Response

<Response>
<Result>0</Result>
<Success count="2">Successfully imported 2
monitoringKey(s).</Success>
</Command>
</Response>
Update Monitoring Key

UpdateMonitoringKey tag.
Request
This request follows the UpdateMonitoringKey tag defined in the XSDs.

<UpdateMonitoringKey>
<MonitoringKey>
</MonitoringKey>
</UpdateMonitoringKey>
Response


<Response> <Result>0</Result>
<Success count="1">Successfully updated 1 monitoringKey(s).</Success>
</Command>
</Response>
Delete Monitoring Key

DeleteMonitoringKey tag.
Request
This request follows the DeleteMonitoringKey tag defined in the XSDs.

<DeleteMonitoringKey>
<MonitoringKey>
</MonitoringKey>
</DeleteMonitoringKey>
Response

<Response>
<Result>0</Result>
<Success count="1">Deleted 1 Monitoring Keys.</Success>
</Command>
</Response>
Query Monitoring Key

QueryMonitoringKey tag.
Request
This request follows the QueryMonitoringKey tag defined in the XSDs.

<QueryMonitoringKey>


</QueryMonitoringKey>
Response
The response to this request follows the ConfigurationData > MonitoringKey tag defined in the
XSDs.

<MonitoringKey>
<Description>Monitoring Key 1</Description>
</MonitoringKey>
AVP Definition
An AVP is a Diameter protocol used to encapsulate protocol-specific information with usage monitoring
supported by the MPE. Diameter messages such as AAR, CCA, CCR, and RAR, are supported by 3rd
Party AVP policy conditions. The supported outgoing messages set or remove 3rd Party AVPs in
Diameter.
Add AVP Definition

AddAvpDefinition tag.
Request
This request follows the AddAvpDefinition tag defined in the XSDs.

<AddAvpDefinition>
<AvpDefinition>
<Name>AVPSAMPLE:1123</Name>
<AvpName>AVPSAMPLE</AvpName>
<AvpCode>0</AvpCode>
<VendorId>1123</VendorId>
<MandatoryFlag>false</MandatoryFlag>
<ProtectFlag>false</ProtectFlag>
<MayencryptFlag>false</MayencryptFlag>
<VendorSpecificFlag>true</VendorSpecificFlag>
<AvpType>float32</AvpType>
<RootAvp></RootAvp>
</AvpDefinition>

</AddAvpDefinition>
Response

<Response>
<Result>0</Result>
<Success count="1">Successfully imported 1 AVP Definition(s).</Success>
</Command>
</Response>
Update AVP Definition

UpdateAvpDefinition tag.
Request
This request follows the UpdateAvpDefinition tag defined in the XSDs.

<UpdateAvpDefinition>
<AvpDefinition>
<RootAvp></RootAvp>
</AvpDefinition>
</UpdateAvpDefinition>
Response

<Response>
<Result>0</Result>
<Success count="1">Successfully imported 1 AVP Definition(s).</Success>

</Command>
</Response>
Delete AVP Definition

DeleteAvpDefinition tag.
Request
This request follows the DeleteAvpDefinition tag defined in the XSDs.

<DeleteAvpDefinition>
<AvpDefinition>
</AvpDefinition>
</DeleteAvpDefinition>
Response

<Response>
<Result>0</Result>
<Success count="1">Deleted 1 AVP Definition(s)</Success>
</Command>
</Response>
Query AVP Definition

QueryAvpDefinition tag.
Request
This request follows the QueryAvpDefinition tag defined in the XSDs.

<QueryAvpDefinition>
<AvpDefinition>
</AvpDefinition>
</QueryAvpDefinition>
Response

The response to this request follows the ConfigurationData > AvpDefinition tag defined in the XSDs.

<AvpDefinition>
<RootAvp></RootAvp>
</AvpDefinition>
Serving GPRS Support Node

A Serving GPRS Support Node (SGSN) may not provide a Gateway GPRS Support Node (GGSN)
with accurate or complete mobile country code (MCC) or mobile network code (MNC) information.
If not, the GGSN cannot pass this information on to the PCRF (including an MPE device), reducing
the PCRF’s ability to detect specific roaming scenarios. The MCC/MNC mapping table provides a
mechanism for the MPE device to convert an SGSN IP address (a value the GGSN can determine
without SGSN input) to the proper MCC/MNC value. You can map multiple serving gateways to
each MCC/MNC pair. After the MCC/MNC values are determined, they can be used in policies to
differentiate subscriber treatment based on the specific roaming scenario.
Add SGSN
The following examples show the request and response that are defined in the XSDs for the Add tag.
Request
This request follows the AddSgwMapping tag defined in the XSDs.

<AddSgwMapping>
<SgwMapping>
<Name>SGSN-1</Name>
<Description>SGSN-1</Description>
<SgwIpAddress>
</SgwIpAddress>
</SgwMapping>
</AddSgwMapping>
Response


<Response>
<Result>0</Result>
<Success count="1">Successfully imported 1 Serving Gateway/MCC-MNC
Mapping(s).</Success>
</Command>
</Response>
Update SGSN
UpdateSgwMapping tag.
Request
This request follows the UpdateSgwMapping tag defined in the XSDs.

<UpdateSgwMapping>
<SgwMapping>
<Name>SGSN-1</Name>
<SgwIpAddress>
</SgwIpAddress>
</SgwMapping>
</UpdateSgwMapping>
Response

<Response>
<Result>0</Result>
<Success count="1">Successfully updated 1 Serving Gateway/MCC-MNC
Mapping(s).</Success>
</Command>
</Response>
Delete SGSN
DeleteSwgMapping tag.
Request

This request follows the DeleteSwgMapping tag defined in the XSDs.

<DeleteSgwMapping>
<SgwMapping>
<Name>SGSN-1</Name>
</SgwMapping>
</DeleteSgwMapping>
Response

<Response>
<Result>0</Result>
<Success count="1">Delete 1 Serving Gateway/MCC-MNC mappings.</Success>
</Command>
</Response>
Query SGSN
QuerySgwmapping tag.
Request
This request follows the QuerySgwmapping tag defined in the XSDs.

<QuerySgwMapping>
<Name>SGSN-1</Name>
</QuerySgwMapping>
Response
The response to this request follows the ConfigurationData > AvpDefinition tag defined in the XSDs.

<SgwMapping>
<Name>SGSN-1</Name>
<SgwIpAddress>
</SgwIpAddress>

</SgwMapping>

Chapter
2
Subscriber Interface for Wireless Mode
Topics: The Subscriber Interface allows wireless users to

manage and query subscriber elements within their
• Quota Profiles.....97 system. In wireless mode, subscriber data includes
• Quota Conventions.....106 only Quota Profiles and Quota Conventions.

Quota Profiles
A Quota sets limits on a subscriber’s usage; the Quota Profile defines a specific quota.
• Quota Rollovers (Rollovers) allow subscribers to carry forward unused units from one billing cycle
to another.
• Quota Top-Ups (Top-Ups) allow a subscriber to obtain additional units for an existing plan.
• Quota Passes (Passes) allow subscribers to access resources beyond the scope of their normal plan.
Add Quota Profile
Add Quota Plan

The following examples show the request and response that are defined in the XSDs for the AddQuota
tag.
Request
This request follows the AddQuota tag defined in the XSDs.
The following example creates two quotas:
• Quota1:
• quotaType = 0
• EnableDynamicGrant = true
• MaxSessionsUsedForDynamicGrant = 20
• MinGrantSize = 3
• Quota2:
• quotaType = 1
• EnableDynamicGrant = false
• MaxSessionsUsedForDynamicGrant = 10
• MinGrantSize = 0

<AddQuota>
<Quota>
<Name>quota1</Name>
<LimitTotalVolume>false</LimitTotalVolume>
<LimitUpVolume>false</LimitUpVolume>
<LimitDownVolume>false</LimitDownVolume>
<TotalVolumeLimit>0</TotalVolumeLimit>
<UpVolumeLimit>0</UpVolumeLimit>
<DownVolumeLimit>0</DownVolumeLimit>
<LimitTime>false</LimitTime>
<TimeLimit>0</TimeLimit>
<LimitEvent>false</LimitEvent>
<EventLimit>0</EventLimit>

<ReplenishingFrequency>0</ReplenishingFrequency>
<VolumeThresholdPercentage>0.0</VolumeThresholdPercentage>
<TimeThresholdPercentage>0.0</TimeThresholdPercentage>
<EventThresholdPercentage>0.0</EventThresholdPercentage>
<EnableInterimReporting>false</EnableInterimReporting>
<InterimReportingInterval>0</InterimReportingInterval>
<QuotaExhaustionAction>0</QuotaExhaustionAction>
<RedirectServerType>1</RedirectServerType>
<QuotaResetIntervalType>1</QuotaResetIntervalType>
<QuotaResetDayOfWeek>0</QuotaResetDayOfWeek>
<QuotaResetTimeOfDay></QuotaResetTimeOfDay>
<QuotaResetTimeVariable>o</QuotaResetTimeVariable>
<QuotaReportOffsetLimit>0</QuotaReportOffsetLimit>
<QuotaType>0</QuotaType>
<MaxLeakageThreshold>1</MaxLeakageThreshold>
<EnableDynamicGrant>true</EnableDynamicGrant>
<MaxSessionsUsedForDynamicGrant>20</MaxSessionsUsedForDynamicGrant>
<MinGrantSize>3</MinGrantSize>
</Quota>
<Quota>
<Name>quota2</Name>
<QuotaResetTimeVariable></QuotaResetTimeVariable>
<EnableDynamicGrant>false</EnableDynamicGrant>
</Quota>
</AddQuota>
Response

<Response>

<Result>0</Result>
<Success count="2">Successfully imported 2 quota(s).</Success>
</Command>
</Response>
Add Quota Pass

The following example creates two dynamic quota passes:
• dayPass
• DynamicQuotaType = 1
• Priority = 10
• LimitTotalVolume = true
• TotalVolumeLimit = 1,000,000
• pass1
• Priority = 0
• LimitTotalVolume = false
• TotalVolumeLimit = 0
Request
This request follows the AddQuota tag defined in the XSDs.

<AddQuota>
<Quota>
<Name>dayPass</Name>
<DynamicQuotaType>1</DynamicQuotaType>
<Priority>10</Priority>
<LimitTotalVolume>true</LimitTotalVolume>
<QuotaResetDayOfMonth>0</QuotaResetDayOfMonth>

<DurationUnitType>2</DurationUnitType>
<DurationUnit>0</DurationUnit>
<ActiveTimePeriod></ActiveTimePeriod>
<QuotaConvention></QuotaConvention>
</Quota>
<Quota>
<Name>pass1</Name>
<RestrictionFilters></RestrictionFilters>
<FilterIdList></FilterIdList>
<RedirectServerAddress></RedirectServerAddress>
</Quota>
</AddQuota>
Response

<Response>
E71645 Revision 01, June 2016 100

<Result>0</Result>
<Success count="2">Successfully imported 2 quota
convention(s).</Success>
</Command>
</Response>
Update Quota Profile
Update Quota Plan

UpdateQuota tag.
Request
This request follows the UpdateQuota tag defined in the XSDs.

<UpdateQuota>
<Quota>
<Name>quota1</Name>
<QuotaResetTimeVariable>d</QuotaResetTimeVariable>
<EnableDynamicGrant>true</EnableDynamicGrant>
</Quota>
<Quota>
<Name>p1</Name>
E71645 Revision 01, June 2016 101

<QuotaResetTimeVariable></QuotaResetTimeVariable>
</Quota>
</UpdateQuota>
Response

<Response>
<Result>0</Result>
<Success count="1">Successfully updated 2 quota.</Success>
</Command>
</Response>
The following example updates a dynamic quota with two passes:

Update Quota Pass
• dayPass
• Priority = 10
• LimitTotalVolume = true
• TotalVolumeLimit = 1,000,000
• pass1
• Priority = 0
E71645 Revision 01, June 2016 102

• LimitTotalVolume = false
• TotalVolumeLimit = 0
Request
This request follows the UpdateQuota tag defined in the XSDs.

<UpdateQuota>
<Quota>
<Name>dayPass</Name>
<LimitTotalVolume>true</LimitTotalVolume>
</Quota>
<Quota>
<Name>pass1</Name>
E71645 Revision 01, June 2016 103

<RestrictionFilters></RestrictionFilters>
<FilterIdList></FilterIdList>
<RedirectServerAddress></RedirectServerAddress>
</Quota>
</UpdateQuota>
Response

<Response>
<Result>0</Result>
<Success count="1">Successfully updated 1 quota
</Command>
</Response>
Delete Quota Profile

The following examples show the request and response that are defined in the XSDs for the DeleteQuota
tag.
Request
This request follows the DeleteQuota tag defined in the XSDs.

<DeleteQuota>
<Name> quota1</Name>
E71645 Revision 01, June 2016 104

</DeleteQuota>
Response

<Response>
<Result>0</Result>
<Success count="1>Deleted 1 quota</Success>
</Command>
</Response>
Query Quota Profile

The following examples show the request and response that are defined in the XSDs for the QueryQuota
tag.
Request
This request follows the QueryQuota tag defined in the XSDs.

<QueryQuota>
<Name> quota1</Name>
</QueryQuota>
Response
The response to this request follows the ConfigurationData > Quota tag defined in the XSDs.

<Quota>
<Name>quota1</Name>
E71645 Revision 01, June 2016 105

<QuotaResetTimeVariable>d</QuotaResetTimeVariable>
</Quota>
Quota Conventions
A Quota Convention controls how units are consumed and how thresholds are calculated in Quotas,
Top-Ups, Rollovers, and Passes. A Quota Convention stores a service provider's configuration
preferences for how Quotas, Top-Ups, Rollovers, and Passes are processed.
Add Quota Convention

AddQuotaConvention tag.
Request
This request follows the AddQuotaConvention tag defined in the XSDs.

<AddQuotaConvention>
<QuotaConvention>
<Name>quotaConvention_default</Name>
<RolloverUsage>0</RolloverUsage>
<PercentageRolloverInterval>20.0</PercentageRolloverInterval>
<PercentageRolloverMax>0.0</PercentageRolloverMax>
<BehaviorMask>128</BehaviorMask>
</QuotaConvention>
<QuotaConvention>
<Name>rollover_20150_all</Name>
</QuotaConvention>
</AddQuotaConvention>
Response
E71645 Revision 01, June 2016 106


<Response>
<Result>0</Result>
<Success count="2">Successfully imported 2 quota
</Command>
</Response>
Update Quota Conventions

UpdateQuotaConvention tag.
Request
This request follows the UpdateQuotaConvention tag defined in the XSDs.

<UpdateQuotaConvention>
<QuotaConvention>
</QuotaConvention>
<QuotaConvention>
<Name>rollover_20150_all</Name>
</QuotaConvention>
</UpdateQuotaConvention>
Response

<Response>
<Result>0</Result>
<Success count="1">Successfully updated 2 quota
</Command>
</Response>
E71645 Revision 01, June 2016 107

Delete Quota Convention

The following example shows the request and response that are defined in the XSDs for the
DeleteQuotaConvention tag.
Request
This request follows the DeleteQuotaConvention tag defined in the XSDs.

<DeleteQuotaConvention>
<Name>abc</Name>
</DeleteQuotaConvention>
Response

<Response>
<Result>0</Result>
<Success count="1">Deleted 1 Quota Convention(s).</Success>
</Command>
</Response>
Query Quota Convention

The following example shows the request and response that are defined in the XSDs for the
QueryQuotaConvention tag.
Request
This request follows the QueryQuotaConvention tag defined in the XSDs.

<QueryQuotaConvention>
<Name>quotaConvention1</Name>
</QueryQuotaConvention>
Response
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <ConfigurationData

version="9.1.0">
<QuotaConvention>
E71645 Revision 01, June 2016 108

</QuotaConvention>
E71645 Revision 01, June 2016 109

Chapter
3
Operational Measurement Requests for Wireless Mode
Topics: This chapter defines the various Operational

Measurements (OM) groups and the individual OM
• Operational Measurements Requests Overview for statistics that comprise them. For several of the more
Wireless Mode.....112 generic statistics, the instrumentation on the
• Message Processing Statistics.....112 Multimedia Policy Engine (MPE) and the Policy
• Topology Update Statistics.....114 Front End (MRA) may differ by protocol, and
therefore specific statistics may increment differently
• Network Element Statistics.....115
across those protocols.
• Latency Statistics.....119
• Connected Network Elements Statistics.....128
• Diameter Operational Measurements Requests for
Wireless Mode.....129
• KPI Statistics.....162
• KPI Statistics for COMCOL Behindness and Sync
State.....164
• LDAP Source Statistics.....166
• Protocol Error Statistics.....167
• Protocol MRA Error Statistics.....172
• Session Cleanup Statistics.....176
• Timeout Statistics.....177
• Traffic Profile Statistics.....191
• TPS Statistics.....192
• Quota Profile Statistics.....198
• Quota Profile Statistics.....199
• Interval Statistics/PCRF Session License Tracking
and Reporting.....200
• PDN RAT Connection Statistics.....202
• PDN Connection APN Statistics.....204
• KPI Dashboard Statistics.....205
• AF Session Statistics for RAT-Type.....209
• Replication Statistics.....210
• SCTP Association Statistics.....213
• Peer Associate Statistics.....214
• Message Error Statistics for Gx.....215
E71645 Revision 01, June 2016 110

Operational Measurement Requests for Wireless
Mode
• SDR/SDA Message Processing Stats.....216
E71645 Revision 01, June 2016 111

Mode
Operational Measurements Requests Overview for Wireless Mode

The OM interface consists of the following requests, grouped by category:
• OSSI XML interface statistics
• Topology Update Statistics — retrieves statistics on all updates made through the Topology
Interface.
• Subscriber Update Statistics — retrieves statistics on all updates made through the Subscriber
Interface.
• Protocol-specific statistics
• Message Processing Statistics — retrieves statistics on session events.
• Latency Statistics - retrieves statistics on how quickly protocol messages are processed.
• Network Element Statistics — retrieves statistics on session events for specific network elements
and interfaces.
• RADIUS-S Statistics — retrieves statistics on accounting and change-of-authorization messages
specific to the RADIUS-S protocol.
• Diameter Statistics — retrieves statistics on Diameter Application Functions (Cable), Charging
Functions (Wireless), Policy Charging Enforcement Functions (Wireless).
• Timeout Statistics — retrieves timeout statistics not received in a predefined amount of time,
that are tracked per network element, MPE, and MRA, and PDN statistics (Wireless).
• Latency Statistics — retrieves latency statistics information for incoming and outgoing messages
tracked per network element, MPE, and MRA.
• Event Trigger Statistics — retrieves related event trigger statistics used for tracking activity.
• Session Cleanup Statistics — retrieves the number of session cleanup statistics where sessions
are aged-out due to inactivity. The reauthorization is submitted and if it is unresponsive or an
error occurs indicating that the session is inactive, then it is removed from the system.
• Traffic Profile Statistics — retrieves traffic profile statistics which counters the number of times
a PCRF attempts to install, remove, or fails.
• Quota Profile Statistics — retrieves quota profile statistics to counter the number of times the
configured threshold reaches a maxed out limit.
Message Processing Statistics

MessageProcessingStats tag.
Request
This request follows the QueryOmStats > MessageProcessingStats tag defined in the XSDs.
The following is an example of a request for all policy servers in the system:

<QueryOmStats>
E71645 Revision 01, June 2016 112

Mode
<MessageProcessingStats/>
</QueryOmStats>
Response
The response to this request follows the Statistics > MessageProcessingStats tag defined in the XSDs.
Individual statistics are defined as follows:
• SessionCount:Session requests received.
• SessionSuccessCount: Session requests successfully created.
• ActiveSessionCount: The absolute value representing the current active session request received.
• SessionFailCount: Session request failures. For example, this could be due to a policy denying a
request.
• SessionProtocolFailCount: Number of session failures due to an invalid message or parameter.
This count is incremented whenever the MPE determines that an incoming message from the AM
has an invalid message and has to be dropped by the MPE.
• SessionPolicyFailCount: Number of session requests that trigger a policy. This count is maintained
in the MPE, one per policy. When the condition of a policy triggers, the count for that policy is
incremented. The value displayed is a total trigger count. That is, the sum of this value for all the
policies. For example, if the definition of a policy is defined as, “when the device usage is greater
than 80% of capacity, reject message”. When the MPE executes this policy in response to a request,
if the policy triggers (i.e. if the MPE determines that the device usage is > 80%), the trigger count
for that policy is incremented.
• PeakTransactionRate: An absolute value representing the peak number of transactions occurring
within a given sample period.
• SessionUnknownPathFailCount: The number of session failures resulting from an unknown or
nonexistent path.
• SessionUnknownSubscriberCount: The number of session failures resulting from an unknown
subscriber ID.
The following is an example of the MessageProcessingStats tag:

<Statistics>
<MessageProcessingStats>
<Sample>
<SessionCount>100</SessionCount>
<SessionSuccessCount>97</SessionSuccessCount>
<SessionFailCount>3</SessionFailCount>
<SessionUnknownPathFailCount>0</SessionUnknownPathFailCount>
<SessionUnknownSubscriberFailCount>0</SessionUnknownSubscriberFailCount>
<SessionProtocolFailCount>1</SessionProtocolFailCount>
<SessionPolicyFailCount>2</SessionPolicyFailCount>
<PeakTransactionRate>0</PeakTransactionRate>
<ActiveSessionCount>0</ActiveSessionCount>
</Sample>
</MessageProcessingStats>
</Statistics>
E71645 Revision 01, June 2016 113

Mode
Topology Update Statistics

TopologyUpdateStats tag.
Request
This request follows the QueryOmStats > TopologyUpdateStats tag defined in the XSDs.
The following is an example of a request for a topology update:

<QueryOmStats>
<TopologyUpdateStats></TopologyUpdateStats>
</QueryOmStats>
Response
The response to this request follows the Statistics > TopologyUpdateStats tag defined in the XSDs.
• TopologyUpdateCount: The number of topology changes made in the Configuration Management
Platform (CMP) that resulted in changes to an MPE. Topology data includes Network Elements,
Paths, Interfaces, and Links. Changes to this data can occur through either the CMP Graphical User
Interface (GUI) or the XML interface. The counter increments for each MPE that updates as a result
of the change. For example, when a user updates a Network Element, the topology update counter
increments for each MPE that the Network Element is associated with.
Batch changes are treated as a single update to an MPE. An OSSI XML interface update may be
made across multiple elements but all of those changes are pushed at one time to the MPE. This is
treated as a single topology change with regard to the counter.
• TopologyUpdateFailCount: The number of topology changes made in the CMP that fail to update
an associated MPE. For example, if an MPE is offline while a Network Element is changed, the fail
counter will increment once for that failed MPE update.
The following is an example of the TopologyUpdateStats tag:

<Statistics>
<TopologyUpdateStats>
<Sample>
<TopologyUpdateCount>942</TopologyUpdateCount>
<TopologyUpdateFailCount>6</TopologyUpdateFailCount>
</Sample>
</TopologyUpdateStats>
</Statistics>
E71645 Revision 01, June 2016 114

Mode
Network Element Statistics

NetworkElementStats tag.
Request
This request follows the QueryOmStats > NetworkElementStats tag defined in the XSDs.
The following is an example of a request for a single network element using the Name parameter:

<QueryOmStats>
<NetworkElementStats>
<Name>Router1</Name>
</NetworkElementStats>
</QueryOmStats>
The following is an example of a request for multiple network elements using the Name(s) and NeId(s)
parameters. This example returns statistics for three different network elements:

<QueryOmStats>
</QueryOmStats>
The following is an example of a request for all network elements in the system. This example returns
statistics for each network element:

<QueryOmStats>
<NetworkElementStats></NetworkElementStats>
</QueryOmStats>
Response
The response to this request follows the Statistics > NetworkElementStats tag defined in the XSDs.
Both Name and NeId are returned along with the statistics and actual recorded times for those statistics.
Sample groups are ordered by policy server, network element, available interfaces, and then by time.
This OM Group, by default, contains a combination of delta and absolute values. Individual statistics
returned as absolutes are described as follows:
• Name: Unique name identifying the Network Element for the following statistics.
E71645 Revision 01, June 2016 115

Mode
• NeId: Optional identifier field for the Network Element.

• InterfaceName: Identifying field for the Network Element’s Interface.
• SessionCount: Current active sessions for that Network Element or Interface. This is a cumulative
value and is displayed as an absolute.
• SessionSuccessCount: Successful sessions.
• SessionFailCount: Session failures.
Note: Session failures can occur for a variety of reasons, for example, when a gate is created
that is greater than the gate limit, the MPE responds with an error code. The default in this
instance is "0" which means "no limit".
• AbnormalDisconnectCount: Number of network elements that have disconnected from the
MPE abnormally. For example, due to a break in the network.
• Capacity: The currently defined maximum capacity for this Network Element or Interface. This
is a static absolute value defined in the CMP for that object.
• BandwidthUpstream: This is the current reserved upstream bandwidth allocated for this Network
Element or Interface. This is a non-cumulative value displayed as an absolute.
• BandwidthDownstream: This is the current reserved downstream bandwidth allocated for this
Network Element or Interface. This is a non-cumulative value displayed as an absolute.
• MaxBandwidthDownstream— This statistic represents the maximum committed bandwidth
flows allocated for this Nework Element or Interface. This value is also an absolute value that
indicates the peak bandwidth usage in the history of a Network Element.
The following is an example XML response to a multiple network element request:

<Statistics>
<Sample>
<NeId>12345</NeId>
<AbnormalDisconnectCount>0</AbnormalDisconnectCount>
<BandwidthUpstream>3000000</BandwidthUpstream>
<BandwidthDownstream>100000</BandwidthDownstream>
<Interface>
<InterfaceName>If1</InterfaceName>
</Interface>
</Sample>
<Sample>
E71645 Revision 01, June 2016 116

Mode
<NeId>12345</NeId>
<Interface>
</Interface>
</Sample>
<Sample>
<NeId>12345</NeId>
<Interface>
</Interface>
</Sample>
<Sample>
<NeId>12341</NeId>
<Interface>
E71645 Revision 01, June 2016 117

Mode
</Interface>
</Sample>
<Sample>
<NeId>12341</NeId>
<Interface>
</Interface>
</Sample>
<Sample>
<NeId>12341</NeId>
<Interface>
</Interface>
</Sample>
</Statistics>
E71645 Revision 01, June 2016 118

Mode
Latency Statistics
DiameterAfLatencyStats tag.
Request
This request follows the QueryOmStats > DiameterAfLatencyStats tag defined in the XSDs.
The following is an example of a request for a single policy server:

<QueryOmStats>
<StartTime>2001-12-31T12:00:00</StartTime>
<EndTime>2001-12-31T12:15:00</EndTime>
<DiameterAfLatencyStats>
<PolicyServer>PolicyServer</PolicyServer>
</DiameterAfLatencyStats>
</QueryOmStats>
Response
The response to this request follows the Statistics > DiameterAfLatencyStats tag defined in the XSDs.
The following is an example of a response for a single policy server:

<Statistics>
<Sample>
<CurrentConnectionsCount>0</CurrentConnectionsCount>
<MaxTransactionInProcessingTime>0</MaxTransactionInProcessingTime>
<AverageTransactionInProcessingTime>0</AverageTransactionInProcessingTime>
<MaxTransactionOutProcessingTime>0</MaxTransactionOutProcessingTime>
<AverageTransactionOutProcessingTime>0</AverageTransactionOutProcessingTime>
<TransactionTime_In_0_20_Count>0</TransactionTime_In_0_20_Count>
<TransactionTime_In_gt_200_Count>0</TransactionTime_In_gt_200_Count>
<TransactionTime_Out_20_40_Count>0</TransactionTime_Out_20_40_Count>
E71645 Revision 01, June 2016 119

Mode
<TransactionTime_Out_gt_200_Count>0</TransactionTime_Out_gt_200_Count>
</Sample>
</Statistics>
Request
This request follows the QueryOmStats > DiameterAfPeerLatencyStats tag defined in the XSDs.

<QueryOmStats>
<Name>ApplicationName</Name>
</QueryOmStats>
Response
The response to this request follows the Statistics > DiameterAfPeerfLatencyStats tag defined in the
XSDs.

<Statistics>
<DiameterAfPeerfLatencyStats>
<Sample>
<NeId>NeId</NeId>
<NetworkElementType>NetworkElementType</NetworkElementType>
<NetworkElementSubType>NetworkElementSubType</NetworkElementSubType>
<ConnectAddress>10.60.4.56</ConnectAddress>
<ConnectPort>3868</ConnectPort>
<ConnectType>TCP</ConnectType>
E71645 Revision 01, June 2016 120

Mode
</Sample>
</DiameterAfPeerfLatencyStats>
</Statistics>
Request
This request follows the QueryOmStats > PcmmCmtsLatencyStats tag defined in the XSDs.

<QueryOmStats>
<PcmmCmtsLatencyStats>
</PcmmCmtsLatencyStats>
</QueryOmStats>
Response
The response to this request follows the Statistics > PcmmCmtsLatencyStats tag defined in the XSDs.

<Statistics>
<Sample>
E71645 Revision 01, June 2016 121

Mode
</Sample>
</Statistics>
Request
This request follows the QueryOmStats > PcmmCmtsPeerLatencyStats tag defined in the XSDs.

<QueryOmStats>
<PcmmCmtsPeerLatencyStats>
<Name>NetworkElementName</Name>
</PcmmCmtsPeerLatencyStats>
</QueryOmStats>
Response
The response to this request follows the Statistics > PcmmCmtsPeerLatencyStats tag defined in the
XSDs.
E71645 Revision 01, June 2016 122

Mode

<Statistics>
<Sample>
<NeId>NeId</NeId>
</Sample>
</Statistics>
Request
This request follows the QueryOmStats > PcmmAmLatencyStats tag defined in the XSDs.
E71645 Revision 01, June 2016 123

Mode
<QueryOmStats>
<PcmmAmLatencyStats>
</PcmmAmLatencyStats>
</QueryOmStats>
Response
The response to this request follows the Statistics > PcmmAmLatencyStats tag defined in the XSDs.

<Statistics>
<Sample>
</Sample>
</Statistics>
E71645 Revision 01, June 2016 124

Mode
Request
This request follows the QueryOmStats > PcmmAmPeerLatencyStats tag defined in the XSDs.

<QueryOmStats>
<PcmmAmPeerLatencyStats>
</PcmmAmPeerLatencyStats>
</QueryOmStats>
Response
The response to this request follows the Statistics > PcmmAmPeerLatencyStats tag defined in the
XSDs.
<Statistics>
<Sample>
<PolicyServer>policyserver</PolicyServer>
<AmId>AmId</AmId>
E71645 Revision 01, June 2016 125

Mode
</Sample>
</Statistics>
Request
This request follows the QueryOmStats > PcmmDpsLatencyStats tag defined in the XSDs.

<QueryOmStats>
<PcmmDpsLatencyStats>
<PolicyServer>PolicyServer>
</PcmmDpsLatencyStats>
</QueryOmStats>
Response
The response to this request follows the Statistics > PcmmDpsLatencyStats tag defined in the XSDs.

<Statistics>
<Sample>
E71645 Revision 01, June 2016 126

Mode
</Sample>
</Statistics>
Request
This request follows the QueryOmStats > PcmmDpsPeerLatencyStats tag defined in the XSDs.

<QueryOmStats>
<PcmmDpsPeerLatencyStats>
<Name>DpsName</Name>
</PcmmDpsPeerLatencyStats>
</QueryOmStats>
Response
The response to this request follows the Statistics > PcmmDpsPeerLatencyStats tag defined in the
XSDs.
<Statistics>
<Sample>
<DpsId>NeId</DpsId>
E71645 Revision 01, June 2016 127

Mode
</Sample>
</Statistics>
Connected Network Elements Statistics

ConnectedNetworkElementStats tag.
Request
This request follows the QueryOmStats > ConnectedNetworkElementStats tag defined in the XSDs.

<QueryOmStats>
<ConnectedNetworkElementStats></ConnectedNetworkElementStats>
</QueryOmStats>
Response
The response to this request follows the Statistics > ConnectedNetworkElementStats tag defined in
the XSDs.
ConnectedNetworkElementCount: The absolute number of network elements maintaining a consistent
connection to each MPE. For example, B-RAS and MX elements.
E71645 Revision 01, June 2016 128

Mode
The following is an example XML response to a ConnectedNetworkElementStats tag request:
<xml version="1.0" encoding="UTF-8"?>

<Statistics>
<ConnectedNetworkElementStats>
<Sample>
<ConnectedNetworkElementCount>52</ConnectedNetworkElementCount>
</Sample>
</ConnectedNetworkElementStats>
</Statistics>
Diameter Operational Measurements Requests for Wireless Mode

This section shows the requests and responses for:
• Diameter Sh Statistics
• Diameter Sh Peer Statistics
• page 132
• Diameter Sy Statistics
• Diameter Sy Reconciliation Statistics
• Diameter Event Trigger Statistics
• Diameter Application Function Statistics
• Diameter Application Function Peer Statistics
• Diameter Charging Function Statistics
• Diameter Charging Function Peer Statistics
• Diameter Policy Charging Enforcement Function Statistics
• Diameter Policy Charging Enforcement Function Peer Statistics
• Diameter MRA Distributed Routing and Management Application (DRMA) Statistics
• Diameter MRA Diameter Routing Agent (DRA) Statistics
• Diameter MRA Application Function (AF) Statistics
• Diameter MRA Application Function (AF) Peer Statistics
• Diameter MRA Bearer Binding and Event Reporting Function (Bberf) Statistics
• Diameter MRA Traffic Detection Function (TDF) Statistics
• Diameter MRA Traffic Detection Function (TDF) Peer Statistics
• Diameter MRA Traffic Detection Function (TDF) over SCTP Statistics
Diameter Sh Statistics
DiameterShStats tag.
Request
This request follows the QueryOmStats > DiameterShStats tag defined in the XSDs.
E71645 Revision 01, June 2016 129

Mode
The following is an example of a request for all policy servers within the system:

<QueryOmStats>
<DiameterShStats>
<PolicyServer>mpe85</PolicyServer>
</DiameterShStats>
</QueryOmStats>
Response
The response to this request follows the Statistics > DiameterShStats tag defined in the XSDs.
The following is an example XML response to a DiameterShStats tag request:

<Statistics>
<DiameterShStats>
<Sample>
<MessagesInCount>0</MessagesInCount>
<MessagesOutCount>0</MessagesOutCount>
<UDRMessagesReceivedCount>0</UDRMessagesReceivedCount>
<UDRMessagesSentCount>0</UDRMessagesSentCount>
<UDASuccessMessagesReceivedCount>0</UDASuccessMessagesReceivedCount>
<UDASuccessMessagesSentCount>0</UDASuccessMessagesSentCount>
<UDAFailureMessagesReceivedCount>0</UDAFailureMessagesReceivedCount>
<UDAFailureMessagesSentCount>0</UDAFailureMessagesSentCount>
<PNRMessagesReceivedCount>0</PNRMessagesReceivedCount>
<PNRMessagesSentCount>0</PNRMessagesSentCount>
<PNASuccessMessagesReceivedCount>0</PNASuccessMessagesReceivedCount>
<PNASuccessMessagesSentCount>0</PNASuccessMessagesSentCount>
<PNAFailureMessagesReceivedCount>0</PNAFailureMessagesReceivedCount>
<PNAFailureMessagesSentCount>0</PNAFailureMessagesSentCount>
<PURMessagesReceivedCount>0</PURMessagesReceivedCount>
<PURMessagesSentCount>0</PURMessagesSentCount>
<PUASuccessMessagesReceivedCount>0</PUASuccessMessagesReceivedCount>
<PUASuccessMessagesSentCount>0</PUASuccessMessagesSentCount>
<PUAFailureMessagesReceivedCount>0</PUAFailureMessagesReceivedCount>
<PUAFailureMessagesSentCount>0</PUAFailureMessagesSentCount>
<SNRMessagesReceivedCount>0</SNRMessagesReceivedCount>
<SNRMessagesSentCount>0</SNRMessagesSentCount>
<SNASuccessMessagesReceivedCount>0</SNASuccessMessagesReceivedCount>
<SNASuccessMessagesSentCount>0</SNASuccessMessagesSentCount>
<SNAFailureMessagesReceivedCount>0</SNAFailureMessagesReceivedCount>
<SNAFailureMessagesSentCount>0</SNAFailureMessagesSentCount>
<ActiveSessionsCount>0</ActiveSessionsCount>
<MaximumActiveSessionsCount>0</MaximumActiveSessionsCount>
<PeerOkayCount>0</PeerOkayCount>
<PeerDownCount>0</PeerDownCount>
<PeerSuspectCount>0</PeerSuspectCount>
<PeerReopenCount>0</PeerReopenCount>
</Sample>
</DiameterShStats>
</Statistics>
E71645 Revision 01, June 2016 130

Mode
Diameter Sh Peer Statistics

DiameterShPeerStats tag.
Request
This request follows the QueryOmStats > DiameterShPeerStats tag defined in the XSDs.

<QueryOmStats>
<DiameterShPeerStats>
<Name>server1</Name>
</DiameterShPeerStats>
</QueryOmStats>
Response
The response to this request follows the Statistics > DiameterShPeerStats tag defined in the XSDs.
The following is an example XML response to a DiameterShPeerStats tag request:

<Statistics>
<Sample>
<PolicyServer>Cfg4-S2-MPE-1</PolicyServer>
<Name>server1</Name>
<NeId></NeId>
<NetworkElementType></NetworkElementType>
<NetworkElementSubType></NetworkElementSubType>
<ConnectTime>Fri Apr 26 15:46:17 EDT 2013</ConnectTime>
<DisconnectTime>N/A</DisconnectTime>
<MessagesErrorInCount>75439</MessagesErrorInCount>
<MessagesErrorOutCount>0</MessagesErrorOutCount>
<UDRMessagesTimeoutCount>0</UDRMessagesTimeoutCount>
<UDASuccessMessagesReceivedCount>0</UDASuccessMessagesReceivedCount>
<UDASuccessMessagesSentCount>0</UDASuccessMessagesSentCount>
<UDAFailureMessagesReceivedCount>75439</UDAFailureMessagesReceivedCount>
<UDAFailureMessagesSentCount>0</UDAFailureMessagesSentCount>
<PNRMessagesReceivedCount>0</PNRMessagesReceivedCount>
<PNRMessagesSentCount>0</PNRMessagesSentCount>
<PNASuccessMessagesReceivedCount>0</PNASuccessMessagesReceivedCount>
<PNASuccessMessagesSentCount>0</PNASuccessMessagesSentCount>
E71645 Revision 01, June 2016 131

Mode
<PNAFailureMessagesReceivedCount>0</PNAFailureMessagesReceivedCount>
<PNAFailureMessagesSentCount>0</PNAFailureMessagesSentCount>
<PURMessagesTimeoutCount>0</PURMessagesTimeoutCount>
<PUASuccessMessagesReceivedCount>0</PUASuccessMessagesReceivedCount>
<PUASuccessMessagesSentCount>0</PUASuccessMessagesSentCount>
<PUAFailureMessagesReceivedCount>0</PUAFailureMessagesReceivedCount>
<PUAFailureMessagesSentCount>0</PUAFailureMessagesSentCount>
<SNRMessagesTimeoutCount>0</SNRMessagesTimeoutCount>
</Sample>
</Statistics>
DiameterS9Stats tag.
Request
This request follows the QueryOmStats > DiameterS9Stats tag defined in the XSDs.

<QueryOmStats>
<DiameterS9Stats/>
</QueryOmStats>
Response
The response to this request follows the Statistics > DiameterSyStats tag defined in the XSDs.
Diameter Sy Statistics
DiameterSyStats tag.
Request
This request follows the QueryOmStats > DiameterSyStats tag defined in the XSDs.

<QueryOmStats>
E71645 Revision 01, June 2016 132

Mode
<DiameterSyStats/>
</QueryOmStats>
Response
The response to this request follows the Statistics > DiameterSyStats tag defined in the XSDs.
The following is an example XML response to a DiameterSyStats tag request:

<Statistics>
<DiameterSyStats>
<Sample>
<PolicyServer>MPE 35</PolicyServer>
<SLRMessagesReceivedCount>0</SLRMessagesReceivedCount>
<SLRMessagesSentCount>0</SLRMessagesSentCount>
<SLRMessagesTimeoutCount>0</SLRMessagesTimeoutCount>
<SLASuccessMessagesReceivedCount>0</SLASuccessMessagesReceivedCount>
<SLASuccessMessagesSentCount>0</SLASuccessMessagesSentCount>
<SLAFailureMessagesReceivedCount>0</SLAFailureMessagesReceivedCount>
<SLAFailureMessagesSentCount>0</SLAFailureMessagesSentCount>
<STRMessagesReceivedCount>0</STRMessagesReceivedCount>
<STRMessagesSentCount>0</STRMessagesSentCount>
<STRMessagesTimeoutCount>0</STRMessagesTimeoutCount>
<STASuccessMessagesReceivedCount>0</STASuccessMessagesReceivedCount>
<STASuccessMessagesSentCount>0</STASuccessMessagesSentCount>
<STAFailureMessagesReceivedCount>0</STAFailureMessagesReceivedCount>
<STAFailureMessagesSentCount>0</STAFailureMessagesSentCount>
</Sample>
</DiameterSyStats>
</Statistics>
Individual statistics are defined for the Sy protocol are:

• PolicyServer: The name of the MPE.
• IsComplete: Shows if the statistics are complete.
• CurrentConnectionCount: Number of servers currently connected.
• MessagesInCount: The number of total messages received..
• MessagesOutcount: The number of total messages sent.
E71645 Revision 01, June 2016 133

Mode
• SLRMessagesReceivedCount: The number of Spending-Limit-Request (SLR) messages received.

• SLRMessagesSentCount: The number of Spending-Limit-Request (SLR) messages sent.
• SLRMessagesTimeoutCount: The number of Spending-Limit-Request (SLR) messages sent where
a message was not received in a predefined amount of time.
• SLASuccessMessagesReceivedCount: The number of Spending-Limit-Answer (SLA) messages
received with success status.
• SLASuccessMessagesSentCount: The number of Spending-Limit-Answer (SLA) messages sent with
success status.
• SLAFailureMessagesReceivedCount: The number of Spending-Limit-Answer (SLA) messages
received with failure status.
• SLAFailureMessagesSentCount: The number of Spending-Limit-Answer (SLA) messages sent with
failure status.
• SNRMessagesReceivedCount: The number of Spending-Status-Notification-Request (SNR) messages
received.
• SNRMessagesReceivedCount: The number of Spending-Status-Notification-Request (SNR) messages
sent.
• SNRMessagesTimeoutCount: The number of Spending-Status-Notification-Request (SNR) messages
sent where a message was not received in a predefined amount of time.
• SNASuccessMessagesReceivedCount: The number of Spending-Status-Notification-Answer (SNA)
messages received.
• SNASuccessMessagesSentCount: The number of Spending-Status-Notification-Answer (SNA)
messages sent with success status.
• SNAFailureMessagesReceivedCount: The number of Spending-Status-Notification-Answer (SNA)
messages recived with failure status.
• SNAFailureMessagesSentCount: The number of Spending-Status-Notification-Answer (SNA)
messages sent with failure status.
• STRMessagesReceivedCount: The number of Session-Termination-Request (STR) messages received.
• STRMessagesSentCount: The number of Session-Termination-Request (STR) messages sent.
• STRMessagesTimeoutCount: The number of Session-Termination-Request (STR) messages sent
where a message was not received in a predefined amount of time.
• STASuccessMessagesReceivedCount:The number of Session-Termination-Answer (STA) messages
received with success status.
• STASuccessMessagesSentCount: The number of Session-Termination-Answer (STA) messages sent
with success status.
• STAFailureMessagesReceivedCount: The number of Session-Termination-Answer (STA) messages
received with failure status.
• STAFailureMessagesSentCount: The number of Session-Termination-Answer (STA) messages sent
with failure status.
• ActiveSessionsCount: The number of AF active sessions.
• MaximumActiveSessionsCount: The number of historical maximum active sessions.
• PeerOkayCount: The count of peers whose state is okay.
• PeerDownCount: The count of peers whose state is down.
• PeerSuspectCount: The count of peers whose state is suspect.
• PeerReopenCount: The count of peers whose state is reopened.
E71645 Revision 01, June 2016 134

Mode
Diameter Sy Reconciliation Statistics

SyReconciliationStats tag.
Request
This request follows the QueryOmStats > SyReconciliationStats tag defined in the XSDs.

<QueryOmStats>
<ValidateResponseXML-'true'/>
<SyReconciliationStats>
<PolicyServer>mpe</PolicyServer>
</SyReconciliationStats>
</QueryOmStats>
Response
The response to this request follows the Statistics > SyReconciliationStats tag defined in the XSDs.
The following is an example XML response to a SyReconciliationStats tag request:

<Statistics>
<SyReconciliationStats>
<Sample>
<TotalRuns>0</TotalAudited>
<TotalReconciled>0</TotalReconciled>
<PercentageReconciled>0</PercentageReconciled>>
</Sample>
</SyReconciliationStats>
</Statistics>
Diameter Event Trigger Statistics

DiameterEventTriggerStats tag.
Request
This request follows the QueryOmStats > DiameterEventTriggerStats tag defined in the XSDs.

<QueryOmStats>
E71645 Revision 01, June 2016 135

Mode
<DiameterEventTriggerStats>
</DiameterEventTriggerStats>
</QueryOmStats>
The response to this request follows the Statistics > DiameterEventTriggerStats tag defined in the
XSDs.

<Statistics>
<DiameterEventTriggerStats>
<Sample>
<SGSN_CHANGE>1</SGSN_CHANGE>
<QOS_CHANGE>1</QOS_CHANGE>
<RAT_CHANGE>1</RAT_CHANGE>
<TFT_CHANGE>1</TFT_CHANGE>
<PLMN_CHANGE>1</PLMN_CHANGE>
<LOSS_OF_BEARER>1</LOSS_OF_BEARER>
<RECOVERY_OF_BEARER>1</RECOVERY_OF_BEARER>
<IP_CAN_CHANGE>1</IP_CAN_CHANGE>
<GW_PCEF_MALFUNCTION>1</GW_PCEF_MALFUNCTION>
<RESOURCES_LIMITATION>1</RESOURCES_LIMITATION>
<MAX_NR_BEARERS_REACHED>1</MAX_NR_BEARERS_REACHED>
<QOS_CHANGE_EXCEEDING_AUTHORIZATION>1</QOS_CHANGE_EXCEEDING_AUTHORIZATION>
<RAI_CHANGE>1</RAI_CHANGE>
<USER_LOCATION_CHANGE>1</USER_LOCATION_CHANGE>
<OUT_OF_CREDIT>1</OUT_OF_CREDIT>
<REALLOCATION_OF_CREDIT>1</REALLOCATION_OF_CREDIT>
<REVALIDATION_TIMEOUT>1</REVALIDATION_TIMEOUT>
<UE_IP_ADDRESS_ALLOCATE>1</UE_IP_ADDRESS_ALLOCATE>
<UE_IP_ADDRESS_RELEASE>1</UE_IP_ADDRESS_RELEASE>
<DEFAULT_EPS_BEARER_QOS_CHANGE>1</DEFAULT_EPS_BEARER_QOS_CHANGE>
<AN_GW_CHANGE>1</AN_GW_CHANGE>
<SUCCESSFUL_RESOURCE_ALLOCATION>1</SUCCESSFUL_RESOURCE_ALLOCATION>
<UE_TIME_ZONE_CHANGE>1</UE_TIME_ZONE_CHANGE>
<USAGE_REPORT>1</USAGE_REPORT>
<USAGE_THRESHOLD_REACHED>1</USAGE_THRESHOLD_REACHED>
<SERVICE_FLOW_DETECTION>1</SERVICE_FLOW_DETECTION>
</Sample>
</DiameterEventTriggerStats>
</Statistics>
Request
This request follows the QueryOmStats > DiameterConnectionEventTriggerStats tag defined in the
XSDs.
E71645 Revision 01, June 2016 136

Mode

<QueryOmStats>
<DiameterConnectionEventTriggerStats>
<NeId>NeId</NeId>
</DiameterConnectionEventTriggerStats>
</QueryOmStats>
Response
The response to this request follows the Statistics > DiameterConnectionEventTriggerStats tag
defined in the XSDs.

<Statistics>
<DiameterConnectionEventTriggerStats>
<Sample>
<NeId>NeId</NeId>
<SGSN_CHANGE>1</SGSN_CHANGE>
<QOS_CHANGE>1</QOS_CHANGE>
<RAT_CHANGE>1</RAT_CHANGE>
<TFT_CHANGE>1</TFT_CHANGE>
<PLMN_CHANGE>1</PLMN_CHANGE>
<LOSS_OF_BEARER>1</LOSS_OF_BEARER>
<RECOVERY_OF_BEARER>1</RECOVERY_OF_BEARER>
<IP_CAN_CHANGE>1</IP_CAN_CHANGE>
<GW_PCEF_MALFUNCTION>1</GW_PCEF_MALFUNCTION>
<RESOURCES_LIMITATION>1</RESOURCES_LIMITATION>
<MAX_NR_BEARERS_REACHED>1</MAX_NR_BEARERS_REACHED>
<QOS_CHANGE_EXCEEDING_AUTHORIZATION>1</QOS_CHANGE_EXCEEDING_AUTHORIZATION>
<RAI_CHANGE>1</RAI_CHANGE>
<USER_LOCATION_CHANGE>1</USER_LOCATION_CHANGE>
<OUT_OF_CREDIT>1</OUT_OF_CREDIT>
<REALLOCATION_OF_CREDIT>1</REALLOCATION_OF_CREDIT>
<REVALIDATION_TIMEOUT>1</REVALIDATION_TIMEOUT>
<UE_IP_ADDRESS_ALLOCATE>1</UE_IP_ADDRESS_ALLOCATE>
<UE_IP_ADDRESS_RELEASE>1</UE_IP_ADDRESS_RELEASE>
<DEFAULT_EPS_BEARER_QOS_CHANGE>1</DEFAULT_EPS_BEARER_QOS_CHANGE>
<AN_GW_CHANGE>1</AN_GW_CHANGE>
<SUCCESSFUL_RESOURCE_ALLOCATION>1</SUCCESSFUL_RESOURCE_ALLOCATION>
<UE_TIME_ZONE_CHANGE>1</UE_TIME_ZONE_CHANGE>
<USAGE_REPORT>1</USAGE_REPORT>
<USAGE_THRESHOLD_REACHED>1</USAGE_THRESHOLD_REACHED>
<SERVICE_FLOW_DETECTION>1</SERVICE_FLOW_DETECTION>
</Sample>
</DiameterConnectionEventTriggerStats>
</Statistics>
E71645 Revision 01, June 2016 137

Mode
Note: Only non-zero event trigger counts are included in the response.
Individual statistics are defined as follows for the PCEF and BBERF protocols:
• SGSN_CHANGE (0)
• QOS_CHANGE (1)
• RAT_CHANGE (2)
• TFT_CHANGE (3)
• PLMN_CHANGE (4)
• LOSS_OF_BEARER (5)
• RECOVERY_OF_BEARER (6)
• IP_CAN_CHANGE (7)
• GW_PCEF_MALFUNCTION (8)
• RESOURCES_LIMITATION (9)
• MAX_NR_BEARERS_REACHED (10)
• QOS_CHANGE_EXCEEDING_AUTHORIZATION (11)
• RAI_CHANGE (12)
• USER_LOCATION_CHANGE (13)
• OUT_OF_CREDIT (14)
• REALLOCATION_OF_CREDIT (15)
• REVALIDATION_TIMEOUT (16)
• UE_IP_ADDRESS_ALLOCATE (17)
• UE_IP_ADDRESS_RELEASE (18)
• DEFAULT_EPS_BEARER_QOS_CHANGE (20)
• AN_GW_CHANGE (21)
Diameter Application Function Statistics

DiameterAfStats tag.
Request
This request follows the QueryOmStats > DiameterAfStats tag defined in the XSDs.

<QueryOmStats>
<DiameterAfStats>
<PolicyServer></PolicyServer>
</DiameterAfStats>
</QueryOmStats>
Response
The response to this request follows the Statistics > DiameterAfStats tag defined in the XSDs.
E71645 Revision 01, June 2016 138

Mode
The following is an example XML response to a DiameterAfStats tag request:
<Statistics>
<DiameterAfStats>
<Sample>
<PolicyServer>vmpe</PolicyServer>
<PendingConnectionsCount>0</PendingConnectionsCount>
<ASRMessagesReceivedCount>0</ASRMessagesReceivedCount>
<ASRMessagesSentCount>0</ASRMessagesSentCount>
<ASRMessagesTimeoutCount>0</ASRMessagesTimeoutCount>
<ASASuccessMessagesReceivedCount>0</ASASuccessMessagesReceivedCount>
<ASASuccessMessagesSentCount>0</ASASuccessMessagesSentCount>
<ASAFailureMessagesReceivedCount>0</ASAFailureMessagesReceivedCount>
<ASAFailureMessagesSentCount>0</ASAFailureMessagesSentCount>
<RARMessagesReceivedCount>0</RARMessagesReceivedCount>
<RARMessagesSentCount>0</RARMessagesSentCount>
<RARMessagesTimeoutCount>0</RARMessagesTimeoutCount>
<RAASuccessMessagesReceivedCount>0</RAASuccessMessagesReceivedCount>
<RAASuccessMessagesSentCount>0</RAASuccessMessagesSentCount>
<RAAFailureMessagesReceivedCount>0</RAAFailureMessagesReceivedCount>
<RAAFailureMessagesSentCount>0</RAAFailureMessagesSentCount>
<AARMessagesReceivedCount>0</AARMessagesReceivedCount>
<AARMessagesSentCount>0</AARMessagesSentCount>
<AARMessagesTimeoutCount>0</AARMessagesTimeoutCount>
<AARInitialMessagesReceivedCount>0</AARInitialMessagesReceivedCount>
<AARInitialMessagesSentCount>0</AARInitialMessagesSentCount>
<AARModificationMessagesReceivedCount>0</AARModificationMessagesReceivedCount>
<AARModificationMessagesSentCount>0</AARModificationMessagesSentCount>
<AAASuccessMessagesReceivedCount>0</AAASuccessMessagesReceivedCount>
<AAASuccessMessagesSentCount>0</AAASuccessMessagesSentCount>
<AAAFailureMessagesReceivedCount>0</AAAFailureMessagesReceivedCount>
<AAAFailureMessagesSentCount>0</AAAFailureMessagesSentCount>
<S9RxAARInitialRecvCount>0</S9RxAARInitialRecvCount>
<S9RxAARInitialSendCount>0</S9RxAARInitialSendCount>
<S9RxAARRecvCount>0</S9RxAARRecvCount>
<S9RxAARSendCount>0</S9RxAARSendCount>
<S9RxAARModificationRecvCount>0</S9RxAARModificationRecvCount>
<S9RxAARModificationSendCount>0</S9RxAARModificationSendCount>
<S9RxAARTimeoutCount>0</S9RxAARTimeoutCount>
<S9RxAAARecvSuccessCount>0</S9RxAAARecvSuccessCount>
<S9RxAAASendSuccessCount>0</S9RxAAASendSuccessCount>
<S9RxAAARecvFailureCount>0</S9RxAAARecvFailureCount>
<S9RxAAASendFailureCount>0</S9RxAAASendFailureCount>
<S9RxASRHORecvCount>0</S9RxASRHORecvCount>
<S9RxASRHOSendCount>0</S9RxASRHOSendCount>
<S9RxASROtherRecvCount>0</S9RxASROtherRecvCount>
<S9RxASROtherSendCount>0</S9RxASROtherSendCount>
<S9RxASRRecvCount>0</S9RxASRRecvCount>
<S9RxASRSendCount>0</S9RxASRSendCount>
E71645 Revision 01, June 2016 139

Mode
<S9RxCleanupASRSendCount>0</S9RxCleanupASRSendCount>
<S9RxASRHOTimeoutCount>0</S9RxASRHOTimeoutCount>
<S9RxASROtherTimeoutCount>0</S9RxASROtherTimeoutCount>
<S9RxASRTimeoutCount>0</S9RxASRTimeoutCount>
<S9RxASARecvSuccessCount>0</S9RxASARecvSuccessCount>
<S9RxASASendSuccessCount>0</S9RxASASendSuccessCount>
<S9RxASARecvFailureCount>0</S9RxASARecvFailureCount>
<S9RxASASendFailureCount>0</S9RxASASendFailureCount>
<S9RxCleanupASARecvCount>0</S9RxCleanupASARecvCount>
<S9RxRARHORecvCount>0</S9RxRARHORecvCount>
<S9RxRARHOSendCount>0</S9RxRARHOSendCount>
<S9RxRAROtherRecvCount>0</S9RxRAROtherRecvCount>
<S9RxRAROtherSendCount>0</S9RxRAROtherSendCount>
<S9RxRARRecvCount>0</S9RxRARRecvCount>
<S9RxRARSendCount>0</S9RxRARSendCount>
<S9RxRARHOTimeoutCount>0</S9RxRARHOTimeoutCount>
<S9RxRAROtherTimeoutCount>0</S9RxRAROtherTimeoutCount>
<S9RxRARTimeoutCount>0</S9RxRARTimeoutCount>
<S9RxRAARecvSuccessCount>0</S9RxRAARecvSuccessCount>
<S9RxRAASendSuccessCount>0</S9RxRAASendSuccessCount>
<S9RxRAARecvFailureCount>0</S9RxRAARecvFailureCount>
<S9RxRAASendFailureCount>0</S9RxRAASendFailureCount>
<S9RxRAARecvCount>0</S9RxRAARecvCount>
<S9RxRAASendCount>0</S9RxRAASendCount>
<S9RxSTRRecvCount>0</S9RxSTRRecvCount>
<S9RxSTRSendCount>0</S9RxSTRSendCount>
<S9RxSTRTimeoutCount>0</S9RxSTRTimeoutCount>
<S9RxSTARecvSuccessCount>0</S9RxSTARecvSuccessCount>
<S9RxSTASendSuccessCount>0</S9RxSTASendSuccessCount>
<S9RxSTARecvFailureCount>0</S9RxSTARecvFailureCount>
<S9RxSTASendFailureCount>0</S9RxSTASendFailureCount>
<RxPcmmMessagesTimeoutCount>0</RxPcmmMessagesTimeoutCount>
<CurrSponsoredSessionCount>0</CurrSponsoredSessionCount>
<MaxSponsoredSessionCount>0</MaxSponsoredSessionCount>
<CurrSponsorCount>0</CurrSponsorCount>
<MaxSponsorCount>0</MaxSponsorCount>
<CurrServiceProviderCount>0</CurrServiceProviderCount>
<MaxServiceProviderCount>0</MaxServiceProviderCount>
<CurrEmergencySessionCount>0</CurrEmergencySessionCount>
<MaxActiveEmergencySessionCount>0</MaxActiveEmergencySessionCount>
<ASRHoSendCount>0</ASRHoSendCount>
<ASRHoReceivedCount>0</ASRHoReceivedCount>
<ASRHoTimeoutCount>0</ASRHoTimeoutCount>
<RARHoSendCount>0</RARHoSendCount>
<RARHoReceivedCount>0</RARHoReceivedCount>
<RARHoTimeoutCount>0</RARHoTimeoutCount>
</Sample>
</DiameterAfStats>
</Statistics>
EmergencyAPN-MPE Support
DiameterAfStats tag utilizing support for Emergency APNs.
Request
E71645 Revision 01, June 2016 140

Mode
The following is an example of a request for all policy servers within the system utilizing support for
emergency APNs:

<QueryOmStats>
<DiameterAfStats>
<PolicyServer>EmergencyAPN-MPE</PolicyServer>
</DiameterAfStats>
</QueryOmStats>
Response
The response to this request follows the Statistics > DiameterAfStats tag defined in the XSDs utilizing
support for emergency APNs.
The following is an example XML response to a DiameterAfStats tag request for EmergencyAPN-MPE:
<Statistics>
<DiameterAfStats>
<Sample>
E71645 Revision 01, June 2016 141

Mode
</Sample>
</DiameterAfStats>
</Statistics>
Diameter Application Function Peer Statistics

DiameterAfPeerStats tag.
Request
This request follows the QueryOmStats > DiameterAfPeerStats tag defined in the XSDs.
The following is an example of a request for a single peer using the Name parameter:

<QueryOmStats>
<DiameterAfPeerStats>
<Name>Server1</Name>
</DiameterAfPeerStats>
</QueryOmStats>
The following is an example of a request for all peer elements in the system. This request returns stats
for each peer element:

<QueryOmStats>
<DiameterAfPeerStats></DiameterAfPeerStats>
</QueryOmStats>
E71645 Revision 01, June 2016 142

Mode
Response
The response to this request follows the Statistics > DiameterAfPeertStats tag defined in the XSDs.
Both the Name and NeId are returned, along with the statistics and actual recorded times for those
statistics. Samples are ordered by policy server, network element, and then by time.
The following is an example XML response to a multiple network element tag request:
<Statistics>
<Sample>
<PolicyServer>10.60.24.47</PolicyServer>
<Name>identity2</Name>
<NeId></NeId>
<ConnectTime></ConnectTime>
<DisconnectTime></DisconnectTime>
<ConnectAddress></ConnectAddress>
<ConnectPort></ConnectPort>
E71645 Revision 01, June 2016 143

Mode
</Sample>
</Statistics>
Diameter Charging Function Statistics

DiameterCTFStats tag.
Request
This request follows the QueryOmStats > DiameterCTFStats tag defined in the XSDs.

<QueryOmStats>
<DiameterCTFStats></DiameterCTFStats>
</QueryOmStats>
Response
The response to this request follows the Statistics > DiameterCTFStats tag defined in the XSDs.

<Statistics>
<DiameterCTFStats>
<Sample>
<PolicyServer>localps</PolicyServer>
<CCRMessagesReceivedCount>0</CCRMessagesReceivedCount>
<CCRMessagesSentCount>0</CCRMessagesSentCount>
<CCASuccessMessagesReceivedCount>0</CCASuccessMessagesReceivedCount>
<CCASuccessMessagesSentCount>0</CCASuccessMessagesSentCount>
<CCAFailureMessagesReceivedCount>0</CCAFailureMessagesReceivedCount>
<CCAFailureMessagesSentCount>0</CCAFailureMessagesSentCount>
E71645 Revision 01, June 2016 144

Mode
</Sample>
</DiameterCTFStats>
</Statistics>
Diameter Charging Function Peer Statistics

DiameterCTFPeerStats tag.
Request
This request follows the QueryOmStats > DiameterCTFPeerStats tag defined in the XSDs.
The following is an example of a request for a single network element using the Name parameter:

<QueryOmStats>
<DiameterCTFPeerStats>
</DiameterCTFPeerStats>
</QueryOmStats>
The following is an example of a request for all network elements in the system. This request returns
statistics for each network element.

<QueryOmStats>
<DiameterCTFPeerStats/>
</QueryOmStats>
Response
The response to this request follows the Statistics > DiameterCTFPeerStats tag defined in the XSDs.
Samples are ordered by policy server, network element, and then by time.

<Statistics>
<DiameterCTFPeerStats>
<Sample>
E71645 Revision 01, June 2016 145

Mode
<PolicyServer>localps</PolicyServer>
<Name>ctf1</Name>
<NeId></NeId>
<ActiveConnectionCount>0</ActiveConnectionCount>
</Sample>
</DiameterCTFPeerStats>
</Statistics>
Diameter Policy Charging Enforcement Function Statistics

DiameterPcefStats tag.
Request
This request follows the QueryOmStats > DiameterPcefStats tag defined in the XSDs.
The following is an example of a request for all policy servers in the system.

<QueryOmStats>
<DiameterPcefStats></DiameterPcefStats>
</QueryOmStats>
Response
The response to this request follows the Statistics > DiameterPcefStats tag defined in the XSDs.
E71645 Revision 01, June 2016 146

Mode
The following is an example XML response to a DiameterPcefStats tag request:

<Statistics>
<DiameterPcefStats>
<Sample>
<PolicyServer>MPE Site 3</PolicyServer>
<CCRMessagesTimeoutCount>0</CCRMessagesTimeoutCount>
<CCRIMessagesReceivedCount>634980</CCRIMessagesReceivedCount>
<CCRIMessagesSentCount>0</CCRIMessagesSentCount>
<CCRIMessagesTimeoutCount>0</CCRIMessagesTimeoutCount>
<CCRUMessagesReceivedCount>0</CCRUMessagesReceivedCount>
<CCRUMessagesSentCount>0</CCRUMessagesSentCount>
<CCRUMessagesTimeoutCount>0</CCRUMessagesTimeoutCount>
<CCRTMessagesReceivedCount>378993</CCRTMessagesReceivedCount>
<CCRTMessagesSentCount>0</CCRTMessagesSentCount>
<CCRTMessagesTimeoutCount>0</CCRTMessagesTimeoutCount>
<CCAISuccessMessagesReceivedCount>0</CCAISuccessMessagesReceivedCount>
<CCAISuccessMessagesSentCount>634980</CCAISuccessMessagesSentCount>
<CCAIFailureMessagesReceivedCount>0</CCAIFailureMessagesReceivedCount>
<CCAIFailureMessagesSentCount>0</CCAIFailureMessagesSentCount>
<CCAUSuccessMessagesReceivedCount>0</CCAUSuccessMessagesReceivedCount>
<CCAUSuccessMessagesSentCount>0</CCAUSuccessMessagesSentCount>
<CCAUFailureMessagesReceivedCount>0</CCAUFailureMessagesReceivedCount>
<CCAUFailureMessagesSentCount>0</CCAUFailureMessagesSentCount>
<CCATSuccessMessagesReceivedCount>0</CCATSuccessMessagesReceivedCount>
<CCATSuccessMessagesSentCount>378993</CCATSuccessMessagesSentCount>
<CCATFailureMessagesReceivedCount>0</CCATFailureMessagesReceivedCount>
<CCATFailureMessagesSentCount>0</CCATFailureMessagesSentCount>
</Sample>
</DiameterPcefStats>
</Statistics>
Request
E71645 Revision 01, June 2016 147

Mode
This request follows the QueryOmStats > DiameterPcefStats tag defined in the XSDs utilizing support
for Emergency APNs.

<QueryOmStats>
<DiameterPcefStats>
</QueryOmStats>
Response
The response to this request follows the Statistics > DiameterPcefStats tag defined in the XSDs utilizing
support for Emergency APNs.
The following is an example XML response to a DiameterPcefStats tag request:

<Statistics>
<DiameterPcefStats>
<Sample>
E71645 Revision 01, June 2016 148

Mode
</Sample>
</Statistics>
Diameter Policy Charging Enforcement Function Peer Statistics

DiameterPcefPeerStats tag.
Request
This request follows the QueryOmStats > DiameterPcefPeerStats tag defined in the XSDs.
The following is an example of a request for a single network element, using the Name parameter.

<QueryOmStats>
<DiameterPcefPeerStats>
</DiameterPcefPeerStats>
</QueryOmStats>
The following is an example of a request for all network elements in the system. This example returns
statistics for each network element.

<QueryOmStats>
<DiameterPcefPeerStats></DiameterPcefPeerStats>
</QueryOmStats>
Response
The response to this request follows the Statistics > DiameterPcefPeerStats tag defined in the XSDs.
Samples are ordered by policy server, network element, and then by time.
E71645 Revision 01, June 2016 149

Mode
The following is an example XML response to a DiameterPcefPeerStats tag request:

<Statistics>
<Sample>
<PolicyServer>MPE</PolicyServer>
<Name>mra.name.com</Name>
<NeId></NeId>
<ConnectTime>Fri Jan 25 22:58:27 EST 2013</ConnectTime>
<DisconnectTime>Thu Jan 24 09:30:21 EST 2013</DisconnectTime>
</Sample>
</Statistics>
E71645 Revision 01, June 2016 150

Mode
Diameter MRA Policy Charging Enforcement Function Statistics

DiameterMraPcefStats tag.
Request
This request follows the QueryOmStats > DiameterMraPcefStats tag defined in the XSDs.
The following is an example of this request.

<QueryOmStats>
<DiameterMraPcefStats>
<MRA>mra156</MRA>
</DiameterMraPcefStats>
</QueryOmStats>
Response
The response to this request follows the Statistics > DiameterMraPcefStats tag defined in the XSDs.
For example:
<Statistics>
<DiameterMraPcefStats>
<Sample>
<MRA>mra156</MRA>
E71645 Revision 01, June 2016 151

Mode
</Sample>
</DiameterMraPcefStats>
</Statistics>
Diameter MRA Policy Charging Enforcement Function Peer Statistics

DiameterMraPcefPeerStats tag.
Request
This request follows the QueryOmStats > DiameterMraPcefPeerStats tag defined in the XSDs.

- <XmlInterfaceRequest>
- <QueryOmStats>
- <DiameterMraPcefPeerStats>
<Name>mra157</Name>
</DiameterMraPcefPeerStats>
</QueryOmStats>
Response
The response to this request follows the Statistics > DiameterMraPcefPeerStats tag defined in the
XSDs. For example:
- <Statistics>
- <DiameterMraPcefPeerStats>
- <Sample>
<MRA>MRA</MRA>
<Name>mpe.name.com</Name>
<NeId></NeId>
E71645 Revision 01, June 2016 152

Mode
</Sample>
</DiameterMraPcefPeerStats>
</Statistics>
Diameter MRA Distributed Routing and Management Application (DRMA) Statistics

DiameterMraDrmaStats tag.
Request
This request follows the QueryOmStats > DiameterMraDrmaStats tag defined in the XSDs.

- <QueryOmStats>
- <DiameterMraDrmaStats>
<MRA>mra156</MRA>
</DiameterMraDrmaStats>
</QueryOmStats>
E71645 Revision 01, June 2016 153

Mode
Response
The response to this request follows the Statistics > DiameterMraDrmaStats tag defined in the XSDs.
For example:
- <Statistics>
- <DiameterMraDrmaStats>
- <Sample>
<MRA>mra156</MRA>
<DBRMessagesReceivedCount>0</DBRMessagesReceivedCount>
<DBRMessagesSentCount>0</DBRMessagesSentCount>
<DBASuccessMessagesReceivedCount>0</DBASuccessMessagesReceivedCount>
<DBASuccessMessagesSentCount>0</DBASuccessMessagesSentCount>
<DBAFailureMessagesReceivedCount>0</DBAFailureMessagesReceivedCount>
<DBAFailureMessagesSentCount>0</DBAFailureMessagesSentCount>
<BindingFoundSentCount>0</BindingFoundSentCount>
<BindingFoundRecvCount>0</BindingFoundRecvCount>
<BindingNotFoundSentCount>0</BindingNotFoundSentCount>
<BindingNotFoundRecvCount>0</BindingNotFoundRecvCount>
<PcrfDownSentCount>0</PcrfDownSentCount>
<PcrfDownReceivedCount>0</PcrfDownReceivedCount>
<AllPcrfsDownSentCount>0</AllPcrfsDownSentCount>
<AllPcrfsDownRecvCount>0</AllPcrfsDownRecvCount>
</Sample>
</Statistics>
Diameter MRA Diameter Routing Agent (DRA) Statistics

DiameterMraDraStats tag.
Request
This request follows the QueryOmStats > DiameterMraDraStats tag defined in the XSDs.

<QueryOmStats>
<DiameterMraDraStats>
<MRA>mra156</MRA>
<MRA>mra106</MRA>
</DiameterMraDraStats>
</QueryOmStats>
E71645 Revision 01, June 2016 154

Mode
Response
The response to this request follows the Statistics > DiameterMraDraStats tag defined in the XSDs.
For example:
<Statistics>
<DiameterMraDraStats>
<Sample>
<MRA>mra106</MRA>
<ActiveBindingsCount>0</ActiveBindingsCount>
<MaximumActiveBindingsCount>0</MaximumActiveBindingsCount>
</Sample>
</DiameterMraDraStats>
</Statistics>
Diameter MRA Application Function (AF) Statistics

DiameterMraAfStats tag.
Request
This request follows the QueryOmStats > DiameterMraAfStats tag defined in the XSDs.

- <QueryOmStats>
- <DiameterMraAfStats>
<MRA>mra156</MRA>
</DiameterMraAfStats>
</QueryOmStats>
Response
The response to this request follows the Statistics > DiameterMraAfStats tag defined in the XSDs.
For example:
- <Statistics>
- <DiameterMraAfStats>
- <Sample>
<MRA>mra156</MRA>
E71645 Revision 01, June 2016 155

Mode
</Sample>
</DiameterMraAfStats>
</Statistics>
Diameter MRA Application Function (AF) Peer Statistics

DiameterMraAfPeerStats tag.
Request
This request follows the QueryOmStats > DiameterMraAfPeerStats tag defined in the XSDs.

- <QueryOmStats>
- <DiameterMraAfPeerStats>
<Name>mra157</Name>
</DiameterMraAfPeerStats>
</QueryOmStats>
Response
E71645 Revision 01, June 2016 156

Mode
The response to this request follows the Statistics > DiameterMraAfPeerStats tag defined in the
XSDs. For example:
- <Statistics>
- <DiameterMraAfPeerStats>
- <Sample>
<MRA>mra156</MRA>
<Name>oracle</Name>
<NeId />
<NetworkElementType />
<NetworkElementSubType />
<ConnectTime>Mon May 31 15:54:23 CST 2010</ConnectTime>
</Sample>
</DiameterMraAfPeerStats>
</Statistics>
Diameter MRA Bearer Binding and Event Reporting Function (Bberf) Statistics
DiameterMraBberfStats tag.
Request
This request follows the QueryOmStats > DiameterMraBberfStats tag defined in the XSDs.
E71645 Revision 01, June 2016 157

Mode

- <QueryOmStats>
- <DiameterMraBberfStats>
<MRA>mra156</MRA>
</DiameterMraBberfStats>
</QueryOmStats>
Response
The response to this request follows the Statistics > DiameterMraBberfStats tag defined in the XSDs.
For example:
- <Statistics>
- <DiameterMraBberfStats>
- <Sample>
<MRA>mra156</MRA>
</Sample>
</DiameterMraBberfStats>
</Statistics>
E71645 Revision 01, June 2016 158

Mode
Diameter MRA Traffic Detection Function (TDF) Statistics

DiameterMraTdfStats tag.
Request
This request follows the QueryOmStats > DiameterMraTdfStats tag defined in the XSDs.

-<XmlInterfaceRequest>
-<QueryOmStats> <StartTime>2010-04-02T00:01:00</StartTime>
-<DiameterMraTdfStats>
<MRA>mra156</MRA>
</DiameterMraTdfStats>
</QueryOmStats>
Response
The response to this request follows the Statistics > DiameterMraTdfStats tag defined in the XSDs.
For example:
<Statistics>
<DiameterMraTdfStats>
<Sample>
<MRA>kli-66-mra</MRA>
<TSRMessagesReceivedCount>0</TSRMessagesReceivedCount>
<TSRMessagesSentCount>0</TSRMessagesSentCount>
<TSRMessagesTimeoutCount>0</TSRMessagesTimeoutCount>
<TSASuccessMessagesReceivedCount>0</TSASuccessMessagesReceivedCount>
<TSASuccessMessagesSentCount>0</TSASuccessMessagesSentCount>
<TSAFailureMessagesReceivedCount>0</TSAFailureMessagesReceivedCount>
<TSAFailureMessagesSentCount>0</TSAFailureMessagesSentCount>
E71645 Revision 01, June 2016 159

Mode
</Sample>
</Statistics>
Diameter MRA Traffic Detection Function (TDF) Peer Statistics

DiameterMraTdfPeerStats tag.
Request
This request follows the QueryOmStats > DiameterMraTdfPeerStats tag defined in the XSDs.
<<?xml version="1.0" encoding="UTF-8" ?>

-<XmlInterfaceRequest>
-<QueryOmStats> <StartTime>2010-04-02T00:01:00</StartTime>
-<DiameterMraTdfPeerStats>
<Name>mra157</Name>
</DiameterMraTdfPeerStats>
</QueryOmStats>
Response
The response to this request follows the Statistics > DiameterMraTdfPeerStats tag defined in the
XSDs. For example:
<Statistics>
<DiameterMraTdfStats>
<Sample>
E71645 Revision 01, June 2016 160

Mode
<MRA>kli-66-mra</MRA>
</Sample>
</Statistics>
Diameter MRA Traffic Detection Function (TDF) over SCTP Statistics

The statistics field can be set to SCTP with the ability to support multiple IP addresses.
E71645 Revision 01, June 2016 161

Mode
The following examples show the SCTP response defined in the XSDs for the
DiameterMraDrmaPeerStats tag.
Response
XSDs. For example:
<Statistics> <DiameterMraTdfPeerStats>
<Sample> <StartTime>2001-12-31T12:00:00</StartTime>
<EndTime>2001-12-31T12:15:00</EndTime> <MRA>MRA</MRA>
<ConnectTime>2001-12-31T12:00:00</ConnectTime>
<DisconnectTime>2001-12-31T12:00:00</DisconnectTime>
<ConnectType>SCTP</ConnectType>
<ConnectAddress>10.15.25.110:3868, 10.15.25.119:3868</ConnectAddress>
<ConnectPort>N/A</ConnectPort>
The following example show the TCP response defined in the XSDs for the DiameterMraTdfPeerStats
tag. This diameter connection is set to TCP.
Response
XSDs. For example:
<Statistics>
<DiameterMraTdfPeerStats> <Sample>
<MRA>MRA</MRA>
KPI Statistics
The following examples show the request and response that are defined in the XSDs for the KpiStats
tag.
Request
This request follows the QueryOmStats > KpiStats tag defined in the XSDs.
E71645 Revision 01, June 2016 162

Mode
<QueryOmStats>
<KpiStats>
</KpiStats>
</QueryOmStats>
Response
The response to this request follows the Statistics > KpiStats tag defined in the XSDs. For example:

<Statistics>
<KpiStats>
<Sample>
<TransactionStartCount>0</TransactionStartCount>
<TransactionEndCount>0</TransactionEndCount>
<CurrentTransactionsPerSecond>0</CurrentTransactionsPerSecond>
<MaxTransactionsPerSecond>0</MaxTransactionsPerSecond>
<CurrentTPSPercentageOfCapacity>0</CurrentTPSPercentageOfCapacity>
<MaxTPSPercentageOfCapacity>0</MaxTPSPercentageOfCapacity>
<CurrentRXTransactionsPerSecond>0</CurrentRXTransactionsPerSecond>
<CurrentPCMMTransactionsPerSecond>0</CurrentPCMMTransactionsPerSecond>
<MaxPCMMTransactionsPerSecond>0</MaxPCMMTransactionsPerSecond>
<CurrentPCMMTpsPercentageOfCapacity>0</CurrentPCMMTpsPercentageOfCapacity>
<MaxPCMMTpsPercentageOfCapacity>0</MaxPCMMTpsPercentageOfCapacity>
<MaxRXTransactionsPerSecond>0</MaxRXTransactionsPerSecond>
<CurrentRXTpsPercentageOfCapacity>0</CurrentRXTpsPercentageOfCapacity>
<MaxRXTpsPercentageOfCapacity>0</MaxRXTpsPercentageOfCapacity>
<LoadSheddingStatus>0</LoadSheddingStatus>
<LoadSheddingEfficiency>0</LoadSheddingEfficiency>
<LoadSheddingDistressCount>0</LoadSheddingDistressCount>
<CurrentSessionCount>0</CurrentSessionCount>
<MaxSessionCount>0</MaxSessionCount>
<CurrentSessionPercentageOfCapacity>0</CurrentSessionPercentageOfCapacity>
<MaxSessionPercentageOfCapacity>0</MaxSessionPercentageOfCapacity>
<CurrentMPEConnectionCount>0</CurrentMPEConnectionCount>
<ConfiguredMPEConnectionCount>0</ConfiguredMPEConnectionCount>
<CurrentConnectedNECount>0</CurrentConnectedNECount>
<ConfiguredNECount>1</ConfiguredNECount>
<CurrentProtocolErrorSentCount>0</CurrentProtocolErrorSentCount>
<CurrentProtocolErrorReceivedCount>0</CurrentProtocolErrorReceivedCount>
<ServerACPUUtilizationPercentage>14</ServerACPUUtilizationPercentage>
<ServerAMemoryUtilizationPercentage>78</ServerAMemoryUtilizationPercentage>
<ServerADiskUtilizationPercentage>2</ServerADiskUtilizationPercentage>
<ServerABladeFailureCount>6</ServerABladeFailureCount>
<ServerAUpTimeMillis>16208000</ServerAUpTimeMillis>
<ServerABladeStatus>12</ServerABladeStatus>
<ServerBCPUUtilizationPercentage>0</ServerBCPUUtilizationPercentage>
<ServerBMemoryUtilizationPercentage>0</ServerBMemoryUtilizationPercentage>
<ServerBDiskUtilizationPercentage>0</ServerBDiskUtilizationPercentage>
<ServerBBladeFailureCount>0</ServerBBladeFailureCount>
E71645 Revision 01, June 2016 163

Mode
<ServerBUpTimeMillis>0</ServerBUpTimeMillis>
<ServerBBladeStatus>0</ServerBBladeStatus>
<ServerCCPUUtilizationPercentage>0</ServerCCPUUtilizationPercentage>
<ServerCMemoryUtilizationPercentage>0</ServerCMemoryUtilizationPercentage>
<ServerCDiskUtilizationPercentage>0</ServerCDiskUtilizationPercentage>
<ServerCBladeFailureCount>0</ServerCBladeFailureCount>
<ServerCUpTimeMillis>0</ServerCUpTimeMillis>
<ServerCBladeStatus>0</ServerCBladeStatus>
</Sample>
</KpiStats>
</Statistics>
KPI Statistics for COMCOL Behindness and Sync State

The following examples show the request and response that are defined in the XSDs for the KpiStats
tag.
Request
The following is an example of this request for replication delta and synch status.

<QueryOmStats>
<KpiStats>
<PolicyServer> MPE </PolicyServer>
</KpiStats>
</QueryOmStats>
Response
The response to this request follows the Statistics > KpiStats tag defined in the XSDs. For example:

<Statistics>
<KpiStats>
<Sample>
<PolicyServer>MPE</PolicyServer>
<CurrentLTETransactionsPerSecond>0</CurrentLTETransactionsPerSecond>
<CurrentEHRPDTransactionsPerSecond>0</CurrentEHRPDTransactionsPerSecond>
E71645 Revision 01, June 2016 164

Mode
<CurrentMRABindingCount>0</CurrentMRABindingCount>
<MaxMRABindingCount>0</MaxMRABindingCount>
<TotalMRABindingCount>0</TotalMRABindingCount>
<CurrentPDNConnectionCount>0</CurrentPDNConnectionCount>
<MaxPDNConnectionCount>0</MaxPDNConnectionCount>
<CurrentPDNConnectionPercentageOfCapacity>0</CurrentPDNConnectionPercentageOfCapacity>
<MaxPDNConnectionPercentageOfCapacity>0</MaxPDNConnectionPercentageOfCapacity>
<CurrentDRMAConnectionCount>0</CurrentDRMAConnectionCount>
<ConfiguredDRMAConnectionCount>0</ConfiguredDRMAConnectionCount>
<CurrentMRAConnectionCount>1</CurrentMRAConnectionCount>
<ConfiguredMRAConnectionCount>1</ConfiguredMRAConnectionCount>
<CurrentSPRConnectionCount>0</CurrentSPRConnectionCount>
<ConfiguredSPRConnectionCount>0</ConfiguredSPRConnectionCount>
<CurrentMRABindingPercentageOfCapacity>0</CurrentMRABindingPercentageOfCapacity>
<MaxMRABindingPercentageOfCapacity>0</MaxMRABindingPercentageOfCapacity>
<PrimaryCPUUtilizationPercentage>0</PrimaryCPUUtilizationPercentage>
<PrimaryMemoryUtilizationPercentage>7</PrimaryMemoryUtilizationPercentage>
<PrimaryDiskUtilizationPercentage>0</PrimaryDiskUtilizationPercentage>
<PrimaryBladeFailureCount>18</PrimaryBladeFailureCount>
<PrimaryUpTimeMillis>65886600</PrimaryUpTimeMillis>
<PrimaryBladeStatus>12</PrimaryBladeStatus>
<SecondaryCPUUtilizationPercentage>0</SecondaryCPUUtilizationPercentage>
<SecondaryMemoryUtilizationPercentage>0</SecondaryMemoryUtilizationPercentage>
<SecondaryDiskUtilizationPercentage>0</SecondaryDiskUtilizationPercentage>
<SecondaryBladeFailureCount>18</SecondaryBladeFailureCount>
<SecondaryUpTimeMillis>0</SecondaryUpTimeMillis>
<SecondaryBladeStatus>0</SecondaryBladeStatus>
<ServerAHaStatus>Active</ServerAHaStatus>
<ServerABladeDeltaTimeMillis>0</ServerABladeDeltaTimeMillis>
<ServerABladePeakDeltaTime>0</ServerABladePeakDeltaTime>
<ServerABladeSyncStatus>OK</ServerABladeSyncStatus>
E71645 Revision 01, June 2016 165

Mode
<ServerBHaStatus>Standby</ServerBHaStatus>
<ServerBBladeDeltaTimeMillis>12</ServerBBladeDeltaTimeMillis>
<ServerBBladePeakDeltaTime>200</ServerBBladePeakDeltaTime>
<ServerBBladeSyncStatus>OK</ServerBBladeSyncStatus>
<ServerCHaStatus>Spare</ServerCHaStatus>
<ServerCBladeDeltaTimeMillis>8</ServerCBladeStatusDeltaTimeMillis>
<ServerCBladePeakDeltaTime>500</ServerCBladePeakDeltaTime>
<ServerCBladeSyncStatus>OK</ServerCBladeSyncStatus>
</Sample>
</KpiStats>
</Statistics>
LDAP Source Statistics

LdapDataSourceStats tag.
Request
This request follows the QueryOmStats > LdapDataSourceStats tag defined in the XSDs.

<LdapDataSourceStats/>
</QueryOmStats>
Response
The response to this request follows the Statistics > LdapDataSourceStats tag defined in the XSDs.
For example:

<Statistics>
<LdapDataSourceStats>
<Sample>
<SuccessfulSearchCount>0</SuccessfulSearchCount>
E71645 Revision 01, June 2016 166

Mode
<UnsuccessfulSearchCount>0</UnsuccessfulSearchCount>
<SearchErrorCount>0</SearchErrorCount>
<MaxSuccessfulSearchTimeTaken>0</MaxSuccessfulSearchTimeTaken>
<MaxUnsuccessfulSearchTimeTaken>0</MaxUnsuccessfulSearchTimeTaken>
<AvgSuccessfulSearchTimeTaken>0.0</AvgSuccessfulSearchTimeTaken>
<AvgUnsuccessfulSearchTimeTaken>0.0</AvgUnsuccessfulSearchTimeTaken>
</Sample>
</LdapDataSourceStats>
</Statistics>
Protocol Error Statistics

ProtocolErrorStats tag.
Request
This request follows the QueryOmStats > ProtocolErrorStats tag defined in the XSDs.

<ProtocolErrorStats>
<PolicyServer>rc178</PolicyServer>
</ProtocolErrorStats>
</QueryOmStats>
Response
The response to this request follows the Statistics > ProtocolErrorStats tag defined in the XSDs.
• DiameterCommandUnsupported - The request contained a command code that the receiver did
not recognize or support.
• DiameterUnableToDeliver - This error is given when the diameter node cannot deliver the message
to the destination, either because no host within the realm that supports the required application
was available to process the request, or because Destination-Host AVP was given without the
associated Destination-Realm AVP.
• DiameterRealmNotServed - The intended realm of the request is not recognized.
• DiameterTooBusy - The diameter node has too much traffic. When returned, a diameter node
attempts to send the message to an alternate peer.
• DiameterLoopDetected - An agent detected a loop while trying to get the message to the intended
recipient. The message may be sent to an alternate peer if available.
• DiameterRedirectIndication - A redirect agent has determined that the request could not be satisfied
locally and the initiator of the request should direct the request directly to the server, whose contact
information has been added to the response. When set, the Redirect-Host AVP must be present.
• DiameterApplicationUnsupported - A request was sent for an application that is not supported.
E71645 Revision 01, June 2016 167

Mode
• DiameterInvalidHdrBits - A request was received whose bits in the diameter header were either
set to an invalid combination, or to a value that is inconsistent with the command code's definition.
• DiameterInvalidAvpBits - A request was received that included an AVP whose flag bits are set to
an unrecognized value, or that is inconsistent with the AVP's definition.
• DiameterUnknownPeer - A CER was received from an unknown peer.
• DiameterAuthenticationRejected - The authentication process for the user failed, most likely due
to an invalid password used by the user. The user is then prompted for a new password.
• DiameterOutOfSpace - A diameter node received the accounting request but was unable to commit
it to stable storage due to a temporary lack of space.
• ElectionLost - The peer has lost the election process and has disconnected the transport connection.
• DiameterEndUserServiceDenied - The credit-control server denied the service request due to service
restrictions. If the CCR contained used-service-units, they are deducted, if possible.
• DiameterCreditControlNotApplicable - The credit-control server determined that the service can
be granted to the end user, but that no further credit control is needed for the service (for example,
the service is free of charge).
• DiameterCreditLimitReached - The credit-control server denied the service request because the
end user's account could not cover the requested service. If the CCR contained used-service-units,
they are deducted, if possible.
• DiameterAvpUnsupported - The peer received a message that contained an AVP that is not
recognized or supported and was marked with the Mandatory bit.
• DiameterUnknownSessionId - The request contained an unknown Session-Id.
• DiameterAuthorizationRejected - A request was received for which the user could not be authorized.
This error could occur if the requested service is not permitted to the user.
• DiameterInvalidAvpValue - The request contained an AVP with an invalid value in its data portion.
• DiameterMissingAvp - The request did not contain an AVP that is required by the command code
definition. If this value is sent in the Result-Code AVP, a Failed-AVP AVP is included in the message.
• DiameterResourcesExceeded - A request was received that cannot be authorized because the user
has already expended its allowed resources.
• DiameterContradictingAvps - The Home Diameter server has detected AVPs in the request that
contradict each other, and is not willing to provide service to the user.
• DiameterAvpNotAllowed - A message was received with an AVP that cannot be present.
• DiameterAvpOccursTooManyTimes - A message was received that included an AVP that appeared
more often than permitted.
• DiameterNoCommonApplication - This error is returned when a CER message is received, and
there are no common applications supported between the peers.
• DiameterUnsupportedVersion - This error is returned when a request was received with an
unsupported version number.
• DiameterUnableToComply - This error is returned when a request is rejected for unspecified
reasons.
• DiameterInvalidBitInHeader - This error is returned when an unrecognized bit in the diameter
header is set to one (1).
• DiameterInvalidAvpLength - The request contained an AVP with an invalid length.
• DiameterInvalidMessageLength - This error is returned when a request is received with an invalid
message length.
• DiameterInvalidAvpBitCombo - The request contained an AVP with an invalid AVP Flags value.
• DiameterNoCommonSecurity - This error is returned when a CER message is received, but there
are no common security mechanisms supported between the peers.
• DiameterUserUnknown - The specified end user is unknown in the credit-control server.
E71645 Revision 01, June 2016 168

Mode
• DiameterRatingFailed - This error code is used to inform the credit-control client that the
credit-control server cannot rate the service request due to insufficient rating input, an incorrect
AVP combination, or an AVP or AVP value that is not recognized or supported in the rating.
• DiameterErrorInitialParameters - The initial parameters contain an error.
• RadiusSessionContyextRemoved - The residual session context has been removed.
• RadiusInvalidEapPacket - An invalid EAP Packet was detected.
• RadiusUnsupportedAttribute - The request contained an unsupported attribute.
• RadiusMissingAttribute - A request was missing a required attribute.
• RadiusNasIdMismatch - The system was unable to match the received NAS to the stored information.
• RadiusInvalidRequest - The system has received an invalid request.
• RadiusUnsupportedService - The requested service is not supported.
• RadiusUnsupportedExtension - The requested extension is not supported.
• RadiusInvalidAttributeValue - The request contains an invalid attribute value.
• RadiusAdministrativelyProhibited - The request is administratively prohibited.
• RadiusRequestNotRoutable - The request cannot be routed.
• RadiusSessionNotFound - The session context cannot be found.
• RadiusSessionNotRemoveable - The session context cannot be removed.
• RadiusProxyProcessingError - An unknown proxy processing error has occurred.
• RadiusResourcesUnavailable - The necessary resources are unavailable.
• RadiusRequestInitiated - A request has been initiated.
• RadiusMultiSessionSelectionUnsupported - The requested multiple-session selection is not
supported.
• RadiusLocationInfoRequired - The location information is missing.

<Statistics>
<Sample>
<DiameterCommandUnsupportedReceived>0</DiameterCommandUnsupportedReceived>
<DiameterCommandUnsupportedSent>0</DiameterCommandUnsupportedSent>
<DiameterUnableToDeliverReceived>0</DiameterUnableToDeliverReceived>
<DiameterUnableToDeliverSent>0</DiameterUnableToDeliverSent>
<DiameterRealmNotServedReceived>0</DiameterRealmNotServedReceived>
<DiameterRealmNotServedSent>0</DiameterRealmNotServedSent>
<DiameterTooBusyReceived>0</DiameterTooBusyReceived>
<DiameterTooBusySent>0</DiameterTooBusySent>
<DiameterLoopDetectedReceived>0</DiameterLoopDetectedReceived>
<DiameterLoopDetectedSent>0</DiameterLoopDetectedSent>
<DiameterRedirectIndicationReceived>0</DiameterRedirectIndicationReceived>
<DiameterRedirectIndicationSent>0</DiameterRedirectIndicationSent>
<DiameterApplicationUnsupportedReceived>0</DiameterApplication
UnsupportedReceived>
<DiameterApplicationUnsupportedSent>0</DiameterApplicationUnsupportedSent>
<DiameterInvalidHdrBitsReceived>0</DiameterInvalidHdrBitsReceived>
<DiameterInvalidHdrBitsSent>0</DiameterInvalidHdrBitsSent>
<DiameterInvalidAvpBitsReceived>0</DiameterInvalidAvpBitsReceived>
<DiameterInvalidAvpBitsSent>0</DiameterInvalidAvpBitsSent>
<DiameterUnknownPeerReceived>0</DiameterUnknownPeerReceived>
E71645 Revision 01, June 2016 169

Mode
<DiameterUnknownPeerSent>0</DiameterUnknownPeerSent>
<DiameterAuthenticationRejectedReceived>0</DiameterAuthentication
RejectedReceived>
<DiameterAuthenticationRejectedSent>0</DiameterAuthentication
RejectedSent>
<DiameterOutOfSpaceReceived>0</DiameterOutOfSpaceReceived>
<DiameterOutOfSpaceSent>0</DiameterOutOfSpaceSent>
<ElectionLostReceived>0</ElectionLostReceived>
<ElectionLostSent>0</ElectionLostSent>
<DiameterEndUserServiceDeniedReceived>0</DiameterEndUserService
DeniedReceived>
<DiameterEndUserServiceDeniedSent>0</DiameterEndUserServiceDeniedSent>
<DiameterCreditControlNotApplicableReceived>0</DiameterCreditControlNot
ApplicableReceived>
<DiameterCreditControlNotApplicableSent>0</DiameterCreditControlNot
ApplicableSent>
<DiameterCreditLimitReachedReceived>0</DiameterCreditLimitReachedReceived>
<DiameterCreditLimitReachedSent>0</DiameterCreditLimitReachedSent>
<DiameterAvpUnsupportedReceived>0</DiameterAvpUnsupportedReceived>
<DiameterAvpUnsupportedSent>0</DiameterAvpUnsupportedSent>
<DiameterUnknownSessionIdReceived>0</DiameterUnknownSessionIdReceived>
<DiameterUnknownSessionIdSent>0</DiameterUnknownSessionIdSent>
<DiameterAuthorizationRejectedReceived>0</DiameterAuthorization
RejectedReceived>
<DiameterAuthorizationRejectedSent>0</DiameterAuthorizationRejectedSent>
<DiameterInvalidAvpValueReceived>0</DiameterInvalidAvpValueReceived>
<DiameterInvalidAvpValueSent>0</DiameterInvalidAvpValueSent>
<DiameterMissingAvpReceived>0</DiameterMissingAvpReceived>
<DiameterMissingAvpSent>0</DiameterMissingAvpSent>
<DiameterResourcesExceededReceived>0</DiameterResourcesExceededReceived>
<DiameterResourcesExceededSent>0</DiameterResourcesExceededSent>
<DiameterContradictingAvpsReceived>0</DiameterContradictingAvpsReceived>
<DiameterContradictingAvpsSent>0</DiameterContradictingAvpsSent>
<DiameterAvpNotAllowedReceived>0</DiameterAvpNotAllowedReceived>
<DiameterAvpNotAllowedSent>0</DiameterAvpNotAllowedSent>
<DiameterAvpOccursTooManyTimesReceived>0</DiameterAvpOccursTooMany
TimesReceived>
<DiameterAvpOccursTooManyTimesSent>0</DiameterAvpOccursTooManyTimesSent>
<DiameterNoCommonApplicationReceived>0</DiameterNoCommonApplicationReceived>
<DiameterNoCommonApplicationSent>0</DiameterNoCommonApplicationSent>
<DiameterUnsupportedVersionReceived>0</DiameterUnsupportedVersionReceived>
<DiameterUnsupportedVersionSent>0</DiameterUnsupportedVersionSent>
<DiameterUnableToComplyReceived>0</DiameterUnableToComplyReceived>
<DiameterUnableToComplySent>0</DiameterUnableToComplySent>
<DiameterInvalidBitInHeaderReceived>0</DiameterInvalidBitInHeaderReceived>
<DiameterInvalidBitInHeaderSent>0</DiameterInvalidBitInHeaderSent>
<DiameterInvalidAvpLengthReceived>0</DiameterInvalidAvpLengthReceived>
<DiameterInvalidAvpLengthSent>0</DiameterInvalidAvpLengthSent>
<DiameterInvalidMessageLengthReceived>0</DiameterInvalidMessageLengthReceived>
<DiameterInvalidMessageLengthSent>0</DiameterInvalidMessageLengthSent>
<DiameterInvalidAvpBitComboReceived>0</DiameterInvalidAvpBitComboReceived>
<DiameterInvalidAvpBitComboSent>0</DiameterInvalidAvpBitComboSent>
<DiameterNoCommonSecurityReceived>0</DiameterNoCommonSecurityReceived>
<DiameterNoCommonSecuritySent>0</DiameterNoCommonSecuritySent>
<DiameterUserUnknownReceived>0</DiameterUserUnknownReceived>
<DiameterUserUnknownSent>0</DiameterUserUnknownSent>
<DiameterRatingFailedReceived>0</DiameterRatingFailedReceived>
<DiameterRatingFailedSent>0</DiameterRatingFailedSent>
E71645 Revision 01, June 2016 170

Mode
<DiameterErrorInitialParametersReceived>0</DiameterErrorInitial
ParametersReceived>
<DiameterErrorInitialParametersSent>2</DiameterErrorInitialParametersSent>
<RadiusSessionContyextRemovedReceived>0</RadiusSessionContyext
RemovedReceived>
<RadiusSessionContyextRemovedSent>0</RadiusSessionContyextRemovedSent>
<RadiusInvalidEapPacketReceived>0</RadiusInvalidEapPacketReceived>
<RadiusInvalidEapPacketSent>0</RadiusInvalidEapPacketSent>
<RadiusUnsupportedAttributeReceived>0</RadiusUnsupportedAttributeReceived>
<RadiusUnsupportedAttributeSent>0</RadiusUnsupportedAttributeSent>
<RadiusMissingAttributeReceived>0</RadiusMissingAttributeReceived>
<RadiusMissingAttributeSent>0</RadiusMissingAttributeSent>
<RadiusNasIdMismatchReceived>0</RadiusNasIdMismatchReceived>
<RadiusNasIdMismatchSent>0</RadiusNasIdMismatchSent>
<RadiusInvalidRequestReceived>0</RadiusInvalidRequestReceived>
<RadiusInvalidRequestSent>0</RadiusInvalidRequestSent>
<RadiusUnsupportedServiceReceived>0</RadiusUnsupportedServiceReceived>
<RadiusUnsupportedServiceSent>0</RadiusUnsupportedServiceSent>
<RadiusUnsupportedExtensionReceived>0</RadiusUnsupportedExtensionReceived>
<RadiusUnsupportedExtensionSent>0</RadiusUnsupportedExtensionSent>
<RadiusInvalidAttributeValueReceived>0</RadiusInvalidAttributeValueReceived>
<RadiusInvalidAttributeValueSent>0</RadiusInvalidAttributeValueSent>
<RadiusAdministrativelyProhibitedReceived>0</RadiusAdministratively
ProhibitedReceived>
<RadiusAdministrativelyProhibitedSent>0</RadiusAdministratively
ProhibitedSent>
<RadiusRequestNotRoutableReceived>0</RadiusRequestNotRoutableReceived>
<RadiusRequestNotRoutableSent>0</RadiusRequestNotRoutableSent>
<RadiusSessionNotFoundReceived>0</RadiusSessionNotFoundReceived>
<RadiusSessionNotFoundSent>0</RadiusSessionNotFoundSent>
<RadiusSessionNotRemoveableReceived>0</RadiusSessionNotRemoveableReceived>
<RadiusSessionNotRemoveableSent>0</RadiusSessionNotRemoveableSent>
<RadiusProxyProcessingErrorReceived>0</RadiusProxyProcessingErrorReceived>
<RadiusProxyProcessingErrorSent>0</RadiusProxyProcessingErrorSent>
<RadiusResourcesUnavailableReceived>0</RadiusResourcesUnavailableReceived>
<RadiusResourcesUnavailableSent>0</RadiusResourcesUnavailableSent>
<RadiusRequestInitiatedReceived>0</RadiusRequestInitiatedReceived>
<RadiusRequestInitiatedSent>0</RadiusRequestInitiatedSent>
<RadiusMultiSessionSelectionUnsupportedReceived>0</RadiusMultiSession
SelectionUnsupportedReceived>
<RadiusMultiSessionSelectionUnsupportedSent>0</RadiusMultiSessionSelection
UnsupportedSent>
<RadiusLocationInfoRequiredReceived>0</RadiusLocationInfoRequiredReceived>
<RadiusLocationInfoRequiredSent>0</RadiusLocationInfoRequiredSent>
</Sample>
</Statistics>
E71645 Revision 01, June 2016 171

Mode
Protocol MRA Error Statistics

ProtocolMraErrorStats tag.
Request
This request follows the QueryOmStats > ProtocolMraErrorStats tag defined in the XSDs.

<MRA>MRA175</MRA>
</QueryOmStats>
Response
The response to this request follows the Statistics > ProtocolMraErrorStats tag defined in the XSDs.
E71645 Revision 01, June 2016 172

Mode
reasons.
message length.
E71645 Revision 01, June 2016 173

Mode

• RadiusRequestNotRoutable - The request can't be routed.
supported.

<Statistics>
<Sample>
<MRA>MRA175</MRA>
RejectedReceived>
RejectedSent>
DeniedReceived>
E71645 Revision 01, June 2016 174

Mode
ApplicableReceived>
ApplicableSent>
RejectedReceived>
TimesReceived>
ParametersReceived>
RemovedReceived>
E71645 Revision 01, June 2016 175

Mode
ProhibitedReceived>
ProhibitedSent>
UnsupportedSent>
</Sample>
</Statistics>
Session Cleanup Statistics

StaleSessionStats tag.
Request
This request follows the QueryOmStats > StaleSessionStats tag defined in the XSDs.
E71645 Revision 01, June 2016 176

Mode
<QueryOmStats>
<StaleSessionStats>
</StaleSessionStats>
</QueryOmStats>
Response
The response to this request follows the Statistics > StaleSessionStats Stag defined in the XSDs.

<Statistics>
<staleSessionStats>
<Sample>
<SessionReadyForCleanUp>0</SessionReadyForCleanUp>
<SessionCleaned>0</SessionCleaned>
<ReauthorizedSessions>0</ReauthorizedSessions>
<ReauthorizedTimeouts>0</ReauthorizedTimeouts>
<ReauthorizedCleaned>0</ReauthorizedCleaned>
</StaleSessionStats>

• SessionReadyForCleanUp: GAUGE to track the number of current stale sessions.
• RemovedForError: COUNTER to track the number of deleted stale sessions that failed to reauthorize
due to an error response.
• ReauthorizedSessions: COUNTER to track the number of reauthorized stale sessions.
• ReauthorizedTimeouts: COUNTER to track to the number of timed out reauthorization sessions.
• RemovedForExpiration: COUNTER to track the number of timed out reauthorization sessions due
to age.
Timeout Statistics
The following examples show the response defined in the XSDs for the DiameterAf Stats tag.
The MRA response follows the Statistics > DiameterAfStats tag defined in the XSDs.
• AAR Timeout: The numeric count of AA-Request messages sent and AA-Answer messages not
received in a set amount of time.
• ASR Timeout: The numeric count of Abort Session Requests (ASR) messages sent where ASA
messages not received in a set amount of time.
• RAR Timeout: The numeric count of ReAuthorization Request (RAR) messages sent where RAA
messages not received in a set amount of time.
• STR Timeout — The numeric count of Session Termination Requests (STR) messages sent where
STA messages not received in a set amount of time.
E71645 Revision 01, June 2016 177

Mode

<Statistics>
<DiameterAfStats>
<Sample>
...
...
...
...
...
</Sample>
</DiameterAfStats>
</Statistics>
Response
The MRA response follows the Statistics > DiameterAfPeerStats tag defined in the XSDs.

<Statistics>
<Sample>
<Name>NetworkElementName></Name>
<NeId>NeId</NeId>
...
...
...
<STRMessagesReceivedCount>STRMessagesReceivedCount</STRMessagesReceivedCount>
<STRMessagesSentCount>STRMessagesSentCount</STRMessagesSentCount>
E71645 Revision 01, June 2016 178

Mode
...
<AARMessagesReceivedCount>AARMessagesReceivedCount</AARMessagesReceivedCount>
<AARMessagesSentCount>AARMessagesSentCount</AARMessagesSentCount>
...
</Sample>
</Statistics>
The MRA response follows the Statistics > DiameterPcefStats tag defined in the XSDs.
• CCR Timeout: The numeric count of CC-Request messages sent and CC-Answer messages not
Note: The number of CCR-I/U/T Timeouts should equal this number combined.
• CCR-I Timeout: The numeric count of CCR-Initial messages sent and CCA-Initial messages not
• CCR-U Timeout: The numeric count of CCR-Update messages sent and CCA-Update messages
not received in a set amount of time.
• CCR-T Timeout: The numeric count of CCR-Terminate messages sent and CCA-Terminate messages
• RAR Timeout: The numeric count of Reauthorization Request messages sent and RAA messages

<Statistics>
<DiameterPcefStats>
<Sample>
...
...
</Sample>
E71645 Revision 01, June 2016 179

Mode
</Statistics>
The MRA response follows the Statistics > DiameterPcefPeerStats tag defined in the XSDs.

<Statistics>
<Sample>
<NeId>NeId<NeId>
...
...
...
</Sample>
</Statistics>
The MRA response follows the Statistics > DiameterBberfStats tag defined in the XSDs.
• CCR Timeout: The numeric count of CC-Request messages sent and CC-Answer messages not
E71645 Revision 01, June 2016 180

Mode

<Statistics>
<DiameterBberfStats>
<Sample>
...
...
...
</Sample>
</DiameterBberfStats>
</Statistics>
The following is an example of a response for an MPE:
<Statistics>
<DiameterBberfStats>
<Sample>
<PolicyServer>kli-63-mpe</PolicyServer>
E71645 Revision 01, June 2016 181

Mode
</Sample>
</DiameterBberfStats>
</Statistics>
The MRA response follows the Statistics > DiameterBberfPeerStats tag defined in the XSDs.

<Statistics>
<DiameterBberfPeerStats>
<Sample>
<NeId>NeId</NeId>
...
...
...
E71645 Revision 01, June 2016 182

Mode
</Sample>
</DiameterBberfPeerStats>
</Statistics>
<Statistics>
<DiameterBberfPeerStats>
<Sample>
<Name>mra66</Name>
<NeId />
<ConnectTime>Tue Jun 05 02:54:29 EDT 2012</ConnectTime>
<DisconnectTime>Tue Jun 05 02:54:28 EDT 2012</DisconnectTime>
E71645 Revision 01, June 2016 183

Mode
</Sample>
</DiameterBberfPeerStats>
</Statistics>
The MRA response follows the Statistics > DiameterShStats tag defined in the XSDs.
• UDR Timeout: The numeric count of User Data Request (UDR) messages sent and User Data
Answer (UDA) messages not received in a set amount of time.
• PUR Timeout:The numeric count of Profile Update Request (PUR) messages sent and Profile Update
Answer (PUA) messages not received in a set amount of time.
• SNR Timeout:The numeric count of Subscription Notification Request (SNR) messages sent and
Subscription Notification Answer (SNA) messages not received in a set amount of time.

<Statistics>
<DiameterShStats>
<Sample>
...
...
...
</Sample>
</DiameterShStats>
</Statistics>
The MRA response follows the Statistics > DiameterTdfStats tag defined in the XSDs.
CCR Timeout: The numeric count of CC-Request messages sent and CC-Answer messages not received
in a set amount of time.
E71645 Revision 01, June 2016 184

Mode
<Statistics>
<DiameterTdfStats>
<Sample>
E71645 Revision 01, June 2016 185

Mode
</Sample>
</DiameterTdfStats>
</Statistics>
<Statistics>
<DiameterTdfStats>
<Sample>
E71645 Revision 01, June 2016 186

Mode
</Sample>
</DiameterTdfStats>
</Statistics>
The MRA response follows the Statistics > DiameterTdfPeerStats tag defined in the XSDs.
<Statistics>
<DiameterTdfPeerStats>
<Sample>
<Name>kli-66-mra2</Name>
<NeId/>
<NetworkElementType/>
<NetworkElementSubType/>
<ConnectTime>Thu May 24 01:23:51 EDT 2012</ConnectTime>
<DisconnectTime>Fri May 25 04:18:11 EDT 2012</DisconnectTime>
<ConnectAddress>10.60.25.67:57455,10.60.25.68:57455</ConnectAddress>
<ConnectType>SCTP</ ConnectType>
E71645 Revision 01, June 2016 187

Mode
</Sample>
</DiameterTdfPeerStats>
</Statistics>
<Statistics>
<DiameterTdfPeerStats>
<Sample>
<Name>kli-66-mra2</Name>
<NeId />
<ConnectTime>Thu May 24 01:23:51 EDT 2012</ConnectTime>
<DisconnectTime>Fri May 25 04:18:11 EDT 2012</DisconnectTime>
<ConnectAddress>10.60.25.67:57455,10.60.25.68:57455</ConnectAddress>
<ConnectType />
E71645 Revision 01, June 2016 188

Mode
</Sample>
</DiameterTdfPeerStats>
</Statistics>
The MRA response follows the Statistics > DiameterShPeerStats tag defined in the XSDs.

<Statistics xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="ossiXmlOm-edit.xsd">
<Sample>
<NeId>NeId</NeId>
...
...
...
...
</Sample>
</Statistics>
The MRA response follows the Statistics > DiameterMraDrmaStats tag defined in the XSDs.
• DBR Timeout: The numeric count of Diameter Binding Request messages sent and Diameter Binding
Answer messages not received in a set amount of time.
E71645 Revision 01, June 2016 189

Mode
• RUR Timeout: The numeric count of Diameter Routing Update Request messages sent and Diameter
Routing Update messages not received in a set amount of time.
• LNR Timeout: The numeric count of Diameter Load Notify Request messages sent and Diameter
Load Notify Answer messages not received in a set amount of time.
• LSR Timeout: The numeric count of Diameter Load Subscription Request messages sent and
Diameter Load Subscription Answer messages not received in a set amount of time.

<Statistics>
<Sample>
<MRA>MRA</MRA>
<DBRMessageSentCount>0</DBRMessagesSentCount>
<DBRMessageTimeoutCount>0</DBRMessagesTimeoutCount>
...
<RURMessagesReceivedCount>0</RURMessagesReceivedCount>
<RURMessagesSentCount>0</RURMessagesSentCount>
<RURMessagesTimeoutCount>0</RURMessagesTimeoutCount>
...
<LNRMessagesReceivedCount>0</LNRMessagesReceivedCount>
<LNRMessagesSentCount>0</LNRMessagesSentCount>
<LNRMessagesTimeoutCount>0</LNRMessagesTimeoutCount>
...
<LSRMessagesReceivedCount>0</LSRMessagesReceivedCount>
<LSRMessagesSentCount>0</LSRMessagesSentCount>
<LSRMessagesTimeoutCount>0</LSRMessagesTimeoutCount>
<SQRMessagesReceivedCount>0</SQRMessagesReceivedCount>
< SQRMessagesSentCount>0</SQRMessagesSentCount>
< SQRMessagesTimeoutCount>0</SQRMessagesTimeoutCount>
...
</Sample>
</Statistics>
The MRA response follows the Statistics > DiameterMraDrmaPeerStats tag defined in the XSDs.

<Statistics>
<DiameterMraDrmaPeerStats>
<Sample>
<MRA>MRA</MRA>
E71645 Revision 01, June 2016 190

Mode
<DBRMessagesSentCount>0</DBRMessagesSentCount>
<DBRMessagesTimeoutCount>0</DBRMessagesTimeoutCount>
...
<RURMessagesReceivedCount>0</RURMessagesReceivedCount>
<RURMessagesSentCount>0</RURMessagesSentCount>
<RURMessagesTimeoutCount>0</RURMessagesTimeoutCount>
...
<LNRMessagesReceivedCount>0</LNRMessagesReceivedCount>
<LNRMessagesSentCount>0</LNRMessagesSentCount>
<LNRMessagesTimeoutCount>0</LNRMessagesTimeoutCount>
<LSRMessagesReceivedCount>0</LSRMessagesReceivedCount>
<LSRMessagesSentCount>0</LSRMessagesSentCount>
<LSRMessagesTimeoutCount>0</LSRMessagesTimeoutCount>
<SQRMessagesReceivedCount>0</SQRMessagesReceivedCount>
< SQRMessagesSentCount>0</SQRMessagesSentCount>
< SQRMessagesTimeoutCount>0</SQRMessagesTimeoutCount
...
<AllPcrfsDownRecvCount>0</AllPcrfsDownRecvCount>
</Sample>
</DiameterMraDrmaPeerStats>
</Statistics>
Traffic Profile Statistics

TrafficProfileStats tag.
Request
This request follows the QueryOmStats > TrafficProfileStats tag defined in the XSDs.

<QueryOmStats>
<TrafficProfileStats>
<Name>TrafficProfileName</Name>
</TrafficProfileStats>
</QueryOmStats>
Response
The response to this request follows the Statistics > TrafficProfileStats tag defined in the XSDs.

<Statistics>
<Sample>
E71645 Revision 01, June 2016 191

Mode
<NumberOfTimesInstalledAttemps>0</NumberOfTimesInstalledAttemps>
<NumberOfTimesRemovedByPCRF>0</NumberOfTimesRemovedByPCRF>
<NumberOfTimesFailedOrRemovedByGateway>0</NumberOfTimesFailedOrRemovedByGateway>
Individual statistics are defined for Traffic Profiles as follows:

• Install Attempt: COUNTER which tracks the number of times the PCRF attempts to install a specific
Traffic Profile.
• Removed by PCRF: COUNTER which tracks the number of times the PCRF initiates the removal
of a specific Traffic Profile.
• Failed or Removed by Gateway: COUNTER which tracks the number of times specific Traffic
Profiles fail to install on the gateway, and the number of times the gateway removes a rule without
PCRF approval.
• NumberOfTimesTotalRetryAttempts: The total number of retry attempts taken to successfully
install the rule.
• NumberOfTimesRetryCycles: The number of Retry Cycles taken to successfully install the PCC/ADC
rule for which retry mechanism was started.
• NumberOfTimesFailedAfterMaxRetryCycles: The number of times a PCC/ADC rule failed to be
installed after trying for max number of retries
TPS Statistics
The following examples show the request and response that are defined in the XSDs for the TpsStats
tag.
Request
This request follows the QueryOmStats > TpsStats tag defined in the XSDs.

<TpsStats>
<PolicyServer>kiran-anchorage-mpe</PolicyServer>
<MRA></MRA>
</TpsStats>
</QueryOmStats>
Response
The response to this request follows the Statistics > TpsStats tag defined in the XSDs.
E71645 Revision 01, June 2016 192

Mode

<Statistics>
<TpsStats>
<Sample>
<PolicyServer>kiran-anchorage-mpe</PolicyServer>
<AfAARICurrentTPS>1306</AfAARICurrentTPS>
<AfAARIMaxTPS>306</AfAARIMaxTPS>
<AfAARITimeOfMaxTPS>2015-08-31T20:21:52Z</AfAARITimeOfMaxTPS>
<AfAARMCurrentTPS>13</AfAARMCurrentTPS>
<AfAARMMaxTPS>5</AfAARMMaxTPS>
<AfAARMTimeOfMaxTPS>2015-08-31T20:21:52Z</AfAARMTimeOfMaxTPS>
<AfASRCurrentTPS>13</AfASRCurrentTPS>
<AfASRMaxTPS>5</AfASRMaxTPS>
<AfASRTimeOfMaxTPS>2015-08-31T20:21:52Z</AfASRTimeOfMaxTPS>
<AfSTRCurrentTPS>13</AfSTRCurrentTPS>
<AfSTRMaxTPS>5</AfSTRMaxTPS>
<AfSTRTimeOfMaxTPS>2015-08-31T20:21:52Z</AfSTRTimeOfMaxTPS>
...
...
<RadiusAccountingOffCurrentTPS >0</RadiusAccountingOffCurrentTPS >
<RadiusAccountingOffMaxTPS>0</RadiusAccountingOffMaxTPS>
<RadiusAccountingOffTimeOfMaxTPS>2015-08-31T20:21:52Z</RadiusAccountingOffTimeOfMaxTPS>
<RadiusAccountingOffCurrentTPS>
</Sample>
</TpsStats>
</Statistics>
This is a list of all possible individual statistics for TpsStats.

Note: Depending on your system requirements, some statistics will not be present.
Note: These statistics are only found in wireless mode.
There are three statistics for each interface. They are in the format <Interface Name> <Message Name>
<Current/Max/TimeOfMax TPS> They describe the current transactions per second, the maximum
transactions per second, and the time that maximum transactions per second occurred.
AF TPS Stats per message type
• AfAARICurrentTPS
• AfAARIMaxTPS
• AfAARITimeOfMaxTPS
• AfAARMCurrentTPS
• AfAARMMaxTPS
• AfAARMTimeOfMaxTPS
• AfASRCurrentTPS
• AfASRMaxTPS
• AfASRTimeOfMaxTPS
• AfSTRCurrentTPS
• AfSTRMaxTPS
• AfSTRTimeOfMaxTPS
• AfRARCurrentTPS
E71645 Revision 01, June 2016 193

Mode
• AfRARMaxTPS
• AfRARTimeOfMaxTPS
Gx TPS Stats per message type
•
• PcefCCRICurrentTPS
• PcefCCRIMaxTPS
• PcefCCRITimeOfMaxTPS
• PcefCCRUCurrentTPS
• PcefCCRUMaxTPS
• PcefCCRUTimeOfMaxTPS
• PcefCCRTCurrentTPS
• PcefCCRTMaxTPS
• PcefCCRITimeOfMaxTPS
• PcefRARCurrentTPS
• PcefRARMaxTPS
• PcefRARTimeOfMaxTPS
Gxx TPS Stats per message type
•
• BberfCCRICurrentTPS
• BberfCCRIMaxTPS
• BberfCCRITimeOfMaxTPS
• BberfCCRUCurrentTPS
• BberfCCRUMaxTPS
• BberfCCRUTimeOfMaxTPS
• BberfCCRTCurrentTPS
• BberfCCRTMaxTPS
• BberfCCRTTimeOfMaxTPS
• BberfRARCurrentTPS
• BberfRARMaxTPS
• BberfRARTimeOfMaxTPS
Sd TPS Stats per message type
•
• TdfTSRCurrentTPS
• TdfTSRMaxTPS
• TdfTSRTimeOfMaxTPS
• TdfCCRUCurrentTPS
• TdfCCRUMaxTPS
• TdfCCRUTimeOfMaxTPS
• TdfCCRTCurrentTPS
• TdfCCRTMaxTPS
• TdfCCRTTimeOfMaxTPS
• TdfRARCurrentTPS
• TdfRARMaxTPS
E71645 Revision 01, June 2016 194

Mode
• TdfRARimeOfMaxTPS
Sh TPS Stats per message type
•
• ShUDRSentTCurrentTPS
• ShUDRSentMaxTPS
• ShUDRSentTimeOfMaxTPS
• ShUDRRecvTCurrentTPS
• ShUDRRecvMaxTPS
• ShUDRRecvTimeOfMaxTPS
• ShPNRCurrentTPS
• ShPNRMaxTPS
• ShPNRimeOfMaxTPS
• ShPURCurrentTPS
• ShPURMaxTPS
• ShPURimeOfMaxTPS
• ShSNRCurrentTPS
• ShSNRMaxTPS
• ShSNRimeOfMaxTPS
Sy TPS Stats per message type
•
• SySLRICurrentTPS
• SySLRIMaxTPS
• SySLRITimeOfMaxTPS
• SySLRUCurrentTPS
• SySLRUMaxTPS
• SySLRUTimeOfMaxTPS
• SySNRTCurrentTPS
• SySNRTMaxTPS
• SySNRTimeOfMaxTPS
• SySTRCurrentTPS
• SySTRMaxTPS
• SySTRTimeOfMaxTPS
S9 TPS Stats per message type
• S9CCRISentCurrentTPS
• S9CCRISentMaxTPS
• S9CCRISentTimeOfMaxTPS
• S9CCRIRecvCurrentTPS
• S9CCRIRecvMaxTPS
• S9CCRIRecvTimeOfMaxTPS
• S9CCRUSentCurrentTPS
• S9CCRUSentMaxTPS
• S9CCRUSentTimeOfMaxTPS
• S9CCRURecvCurrentTPS
E71645 Revision 01, June 2016 195

Mode
• S9CCRURecvMaxTPS
• S9CCRURecvTimeOfMaxTPS
• S9CCRTSentCurrentTPS
• S9CCRTSentMaxTPS
• S9CCRTSentTimeOfMaxTPS
• S9CCRTRecvCurrentTPS
• S9CCRTRecvMaxTPS
• S9CCRTRecvTimeOfMaxTPS
• S9RARSentCurrentTPS
• S9RARSentMaxTPS
• S9RARSentTimeOfMaxTPS
• S9RARRecvCurrentTPS
• S9RARRecvMaxTPS
• S9RARRecvTimeOfMaxTPS
• S9AfAARICurrentTPS
• S9AfAARIMaxTPS
• S9AfAARITimeOfMaxTPS
• S9AfAARMCurrentTPS
• S9AfAARMMaxTPS
• S9AfAARMTimeOfMaxTPS
• S9AfASRCurrentTPS
• S9AfASRMaxTPS
• S9AfASRTimeOfMaxTPS
• S9AfSTRCurrentTPS
• S9AfSTRMaxTPS
• S9AfSTRTimeOfMaxTPS
• S9AfRARCurrentTPS
• S9AfRARMaxTPS
• S9AfRARTimeOfMaxTPS
LDAP TPS Stats per message type
• LdapBindReqSentCurrentTPS
• LdapBindReqSentMaxTPS
• LdapBindReqSentTimeOfMaxTPS
• LdapBindReqRecvCurrentTPS
• LdapBindReqRecvMaxTPS
• LdapBindReqRecvTimeOfMaxTPS
• LdapSearchReqSentCurrentTPS
• LdapSearchReqSentMaxTPS
• LdapSearchReqSentTimeOfMaxTPS
• LdapSearchReqRecvCurrentTPS
• LdapSearchReqRecvMaxTPS
• LdapSearchReqRecvTimeOfMaxTPS
• LdapModifyReqSentCurrentTPS
• LdapModifyReqSentCurrentTPS
• LdapModifyReqSentTimeOfMaxTPS
E71645 Revision 01, June 2016 196

Mode
• LdapModifyReqRecvCurrentTPS
• LdapModifyReqRecvMaxTPS
• LdapModifyReqRecvTimeOfMaxTPS
CTF Stats per message type
• CtfCCRICurrentTPS
• CtfCCRIMaxTPS
• CtfCCRITimeOfMaxTPS
• CtfCCRTCurrentTPS
• CtfCCRTMaxTPS
• CtfCCRTTimeOfMaxTPS
• CtfRARCurrentTPS
• CtfRARMaxTPS
• CtfRARTimeOfMaxTPS
• CtfASRCurrentTPS
• CtfASRMaxTPS
• CtfASRTimeOfMaxTPS
• CtfRARCurrentTPS
• CtfRARMaxTPS
• CtfRARTimeOfMaxTPS
• CtfASRCurrentTPS
• CtfASRMaxTPS
• CtfASRTimeOfMaxTPS
RADIUS Stats per message type
• RadiusAccountingStartCurrentTPS
• RadiusAccountingStartMaxTPS
• RadiusAccountingStartTimeOfMaxTPS
• RadiusInterimUpdateCurrentTPS
• RadiusInterimUpdateMaxTPS
• RadiusInterimUpdateTimeOfMaxTPS
• RadiusAccountingStopCurrentTPS
• RadiusAccountingStopMaxTPS
• RadiusAccountingStopTimeOfMaxTPS
• RadiusCoaCurrentTPS
• RadiusCoaMaxTPS
• RadiusCoaTimeOfMaxTPS
• RadiusCoaDisconnectCurrentTPS
• RadiusCoaDisconnectMaxTPS
• RadiusCoaDisconnectTimeOfMaxTPS
• RadiusAccountingOnCurrentTPS
• RadiusAccountingOnMaxTPS
• RadiusAccountingOnTimeOfMaxTPS
• RadiusAccountingOffCurrentTPS
• RadiusAccountingOffMaxTPS
• RadiusAccountingOffTimeOfMaxTPS
E71645 Revision 01, June 2016 197

Mode
Quota Profile Statistics

QuotaProfileStats tag.
Request
This request follows the QueryOmStats > QuotaProfileStats tag defined in the XSDs.

<QueryOmStats>
<QuotaProfileStats>
</QuotaProfileStats>
</QueryOmStats>
Response
The response to this request follows the Statistics > QuotaProfileStats tag defined in the XSDs.

<Statistics>
<QuotaProfileStats>
<Sample>
<Name>QuotaProfileName</Name>
<NumberOfTimesActivated>0</NumberOfTimesActivated>
<NumberOfTimesVolumnThresholdReached>0</NumberOfTimesVolumnThresholdReached>
<NumberOfTimesTimeThresholdReached>0</NumberOfTimesTimeThresholdReached>
<NumberOfTimesEventThresholdReached>0</NumberOfTimesEventThresholdReached>
Individual statistics (counters) are defined as follows for Quota Profiles:

• Activated: COUNTER which tracks the number of times that a specific Quota Profile is activated.
• Volume Threshold Reached: COUNTER which tracks the number of times the configured volume
threshold limit is reached for a specific Quota Profile.
• Time Threshold Reached: COUNTER which tracks the number of times the configured time
• Event Threshold Reached: COUNTER which tracks the number of times the configured event
E71645 Revision 01, June 2016 198

Mode
Quota Profile Statistics

QuotaProfileStats tag.
Request
This request follows the QueryOmStats > QuotaProfileStats tag defined in the XSDs.

<QueryOmStats>
<QuotaProfileStats>
</QueryOmStats>
Response
The response to this request follows the Statistics > QuotaProfileStats tag defined in the XSDs.

<Statistics>
<QuotaProfileStats>
<Sample>
<Name>QuotaProfileName</Name>
<NumberOfTimesActivated>0</NumberOfTimesActivated>
<NumberOfTimesVolumnThresholdReached>0</NumberOfTimesVolumnThresholdReached>
<NumberOfTimesTimeThresholdReached>0</NumberOfTimesTimeThresholdReached>
<NumberOfTimesEventThresholdReached>0</NumberOfTimesEventThresholdReached>
Individual statistics (counters) are defined as follows for Quota Profiles:

• Activated: COUNTER which tracks the number of times that a specific Quota Profile is activated.
• Volume Threshold Reached: COUNTER which tracks the number of times the configured volume
• Time Threshold Reached: COUNTER which tracks the number of times the configured time
• Event Threshold Reached: COUNTER which tracks the number of times the configured event
E71645 Revision 01, June 2016 199

Mode
Interval Statistics/PCRF Session License Tracking and Reporting

The following XML requests and responses apply to interval statistics and PCRF session license tracking
and reporting. The Interval Stats tag allows for the collection of specific maximum values for some
counters over a time interval of 15 minutes. By using the OSSI/data collection feature maximums can
be collected for each 15-minute interval of a day, over a 30-day period, to determine peak usage times.
The following examples show the request and response that are defined in the XSDs for the IntervalStats
tag.
MPE Request
This request follows the QueryOmStats > IntervalStats tag defined in the XSDs.
The following is an example of this request for an MPE.

<QueryOmStats>
<IntervalStats>
<PolicyServer>name</PolicyServer> (policy server name, if this field
does not exist, all policy servers are included in response)
</IntervalStats>
</QueryOmStats>
Where the TIMESTAMP is a time stamp in the form:

YYYY-MM-DD-THH:MM:SSZ
MPE Response
The response to this MPE request follows the Statistics > IntervalStats tag defined in the XSDs.
Where:
• IntervalStartTime: The time when this sub-system began collecting the data presented. If this is
the first instance of the sub-system collecting data, this value may be N/A.
• ConfiguredLength: This value is always 900 seconds, which is 15 minutes.
• ActualLength: The length of the interval. Normally, this is the same value as ConfiguredLength,
however there are two cases where these values will differ:
1. Cluster has just started and no data is available (ActualLength = 0)
2. Cluster has started and an interval completed but the software did not start on a quarter boundary
(e.g. ActualLength = nnn where nnn is any number between 0 and 900. If the software started
200 seconds after the 15-min boundary, the when the interval is completed, the ActualLength
= 700).
• IsComplete: If the ConfiguredLength has completed, then the value is true. If not, then the value
is false.
• IntervalMaxTransactionsPerSecond: The maximum value of the statistic MaxTransactionsPerSecond
for the interval reported. As with MaxTransactionsPerSecond, this count does not include SH
traffic.
• IntervalMaxMRABindingCount: The maximum value of the statistic MaxMRABindingCount for
the interval reported. This value is 0 on MPEs.
E71645 Revision 01, June 2016 200

Mode
• IntervalMaxSessionCount: The maximum value of the statistic MaxSessionCount for the interval
reported.
• IntervalMaxPDNConnectionCount: The maximum value of the statistic MaxPDNConnectionCount
for the interval reported.
For example:

<Statistics>
<IntervalStats>
<Sample>
<PolicyServer>testmpe</PolicyServer>
<IntervalStartTime>2001-05-04T13:15:00Z</IntervalStartTime>
<ConfiguredLength>900</ConfiguredLength>
<ActualLength>12</ActualLength>
<IntervalMaxTransactionsPerSecond>5</IntervalMaxTransactionsPerSecond>
<IntervalMaxMRABindingCount>16</IntervalMaxMRABindingCount>
<IntervalMaxSessionCount>12</IntervalMaxSessionCount>
<IntervalMaxPDNConnectionCount>12</IntervalMaxPDNConnectionCount>
</Sample>
<Sample>
<PolicyServer>testmpe</PolicyServer>
<IntervalStartTime>2001-08-01T10:00:01Z</IntervalStartTime>
</Sample>
</IntervalStats>
</Statistics>
MRA Request
This request follows the QueryOmStats > IntervalStats tag defined in the XSDs.
The following is an example of this request for an MRA.
Where:
• IntervalStartTime: The time when this sub-system began collecting the data presented. If this is
the first instance of the sub-system collecting data, this value may be N/A.
• ConfiguredLength: This value is always 900 seconds, which is 15 minutes.
• ActualLength: The length of the interval. Normally, this is the same value as ConfiguredLength,
however there are two cases (documented above) where these values will differ:
1. Cluster has just started and no data is available (ActualLength = 0)
2. Cluster has started and an interval completed but the software did not start on a quarter boundary
(e.g. ActualLength = nnn where nnn is any number between 0 and 900. If the software started
200 seconds after the 15-min boundary, the when the interval is completed, the ActualLength
= 700).
• IsComplete: If the ConfiguredLength has completed, then the value is true. If not, then the value
is false.
E71645 Revision 01, June 2016 201

Mode
• IntervalMaxTransactionsPerSecond: The maximum value of the statistic MaxTransactionsPerSecond

• IntervalMaxMRABindingCount: The maximum value of the statistic MaxMRABindingCount for
the interval reported.
• IntervalMaxSessionCount: The maximum value of the statistic MaxSessionCount for the interval
reported.
• IntervalMaxPDNConnectionCount: The maximum value of the statistic MaxPDNConnectionCount
For example:

<QueryOmStats>
<IntervalMraStats>
<MRA>testmra</MRA>
</IntervalMraStats>
</QueryOmStats>
MRA Response
The response to this MRA request follows the Statistics > IntervalStats tag defined in the XSDs. For
example:

<Statistics>
<IntervalMraStats>
<Sample>
<MRA>testmra</MRA>
<IntervalStartTime>2011-04-04 09:23:52.0</IntervalStartTime>
</Sample>
</IntervalMraStats>
</Statistics>
PDN RAT Connection Statistics

The following examples show the request and response that are defined in the XSDs for PDN RAT
Type tag.
Request
This request follows the QueryOmStats > PdnRatTypeStats tag defined in the XSDs.
Note: Current and Maximum AF Session counts are returned for all RAT types that are available from
each MPE device. If a RAT type is not available from an MPE device, no entry is returned.
E71645 Revision 01, June 2016 202

Mode
The following are examples of a request for a single policy server and multiple policy servers:

<PdnRatTypeStats>
<PolicyServer>mpe17-41</PolicyServer>
</PdnRatTypeStats >
</QueryOmStats>

<PdnRatTypeStats>
<PolicyServer>MPE01</PolicyServer>
</PdnRatTypeStats>
</QueryOmStats>
Response
The response to this request follows the Statistics > CurrentConnectionsCount and
MaximumConnectionsCount tags defined in the XSDs.
• StartTime - The time this stat object was created.
• ResetTime - The last time the counters for this object were reset.
• CurrentConnectionsCount - The current number of PDN connections for this RAT-Type.
• MaximumConnectionsCount - The maximum number of PDN connections at any one point for
this RAT-Type. The default interval time is 15 minutes, and it can be configured by the Stats
Collection Period attribute in the Global Configuration Settings menu. It will be reset to
CurrentConnectionsCount only in the interval mode per interval time.

<Statistics>
<PdnRatTypeStats>
<Sample>
<Type>WLAN</Type>
<MaximumConnectionsCount>0</MaximumConnectionsCount>
</Sample>
<Sample>
E71645 Revision 01, June 2016 203

Mode
<Type>HRPD</Type>
<CurrentConnectionsCount>1,444</CurrentConnectionsCount>
<MaximumConnectionsCount>2,095</MaximumConnectionsCount>
</Sample>
<Sample>
<Type>EUTRAN</Type>
</Sample>
….
</PdnRatTypeStats>
</Statistics>
Note: For multiple policy servers, the names of the servers will be listed in the <PolicyServer> tags.
For example:
<PdnRatTypeStats>
<Sample>
...
PDN Connection APN Statistics

The following examples show the request and response that are defined in the XSDs for PDN APN
tag.
Request
This request follows the QueryOmStats > PDNConnectionAPNStats tag defined in the XSDs.
The following are examples of a request for a single policy server:

<PDNConnectionAPNStats>
</PDNConnectionAPNStats>
</QueryOmStats>
Response
E71645 Revision 01, June 2016 204

Mode
• StartTime — The time this stat object was created.

• Endtime — The time this stat object was ended.
• CurrentConnectionsCount — The current number of PDN connections for this APN.
• APNSuffix — A suffix configured on a CMP system that matches the MPE. After a suffix is created,
each new PDN connection for that APN updates the current object. A CMP system can have up to
25 suffixes configured on it and each suffix can be up to 64 characters.
• MaximumConnectionsCount — The maximum number of PDN connections at any one point for
this APN. The default interval time is 15 minutes, and it can be configured by the Stats Collection
Period attribute in the Global Configuration Settings menu. It will be reset to

<Statistics>
<PDNConnectionAPNStats>
<Sample>
<APNSuffix>apn1</APNSuffix>
</Sample>
</PDNConnectionAPNStats>
</Statistics>
KPI Dashboard Statistics

The following examples show the request and response that are defined in the XSDs for KPI Statistics
including the Active Sessions count under Performance.
Request

<XmlInterfaceRequest<QueryOmStats>
<KpiStats>
</KpiStats>
</QueryOmStats>
Response
The response to this request follows the Statistics > KpiStats tags defined in the XSDs.
E71645 Revision 01, June 2016 205

Mode
The added counters are defined as follows:

<Statistics>
<KpiStats>
<Sample>
E71645 Revision 01, June 2016 206

Mode
</Sample>
<Sample>
<MRA>mra17-58</MRA>
E71645 Revision 01, June 2016 207

Mode
E71645 Revision 01, June 2016 208

Mode
</Sample>
</KpiStats>
</Statistics>
AF Session Statistics for RAT-Type

The following examples show the request and response that are defined in the XSDs for AFSession
tag.
Request
This request follows the QueryOmStats > AFSessionStats tag defined in the XSDs.
Note: Current and Maximum AF Session counts are returned for all RAT types that are available from
each MPE device. If a RAT type is not available from an MPE device, no entry is returned.
The following are examples of a request for a single policy server and multiple policy servers:

<AFSessionStats>
</AFSessionStats >
</QueryOmStats>

<PdnRatTypeStats>
</PdnRatTypeStats>
</QueryOmStats>
Response
• StartTime - The time this stat object was created.
• EndTime - The time this stat object was ended.
E71645 Revision 01, June 2016 209

Mode
• CurrentConnectionsCount - The current number of AF Sessions for this RAT-Type.

• MaximumConnectionsCount - The maximum number of AF Sessions at any one point for this
RAT-Type. The default interval time is 15 minutes, and it can be configured by the Stats Collection
Period attribute in the Global Configuration Settings menu. It will be reset to

<Statistics>
< AFSessionStats >
<Sample>
<Type>WLAN</Type>
<CurrentAfSessionCount>0</CurrentAfSessionCount>
<MaximumAfSessionCount>0</MaximumAfSessionCount>
</Sample>
<Sample>
<Type>HRPD</Type>
</Sample>
<Sample>
<Type>HRPD</Type>
</Sample>
<Sample>
<Type>EUTRAN</Type>
</AFSessionStats>
</Statistics>
Replication Statistics
ReplicationStats tag.
Request
This request follows the QueryOmStats > ReplicationStats tag defined in the XSDs.
E71645 Revision 01, June 2016 210

Mode
The following is an example of a request for performance statistics on MRA/MPE replication in the
system:

<QueryOmStats ValidateResponseXML='true'>
<PolicyServer>MPECluster1</PolicyServer>
<ReplicationStats/>
</QueryOmStats>
Response
The response to this request follows the Statistics > ReplicationStats tag defined in the XSDs.
The following is an example of the ReplicationStats tag:

<Statistics>
<ReplicationStats>
<Sample>
<BladeHostName>MPE194</BladeHostName>
<PeerHostName>MPE195</PeerHostName>
<TotalSentKB>0</TotalSentKB>
<PeakSentKB>0</PeakSentKB>
<AvgSentKB>0</AvgSentKB>
<TotalRecvKB>0</TotalRecvKB>
<PeakRecvKB>0</PeakRecvKB>
<AvgRecvKB>0</AvgRecvKB>
</Sample>
<Sample>
</Sample>
<Sample>
</Sample>
E71645 Revision 01, June 2016 211

Mode
<Sample>
</Sample>
<Sample>
</Sample>
<Sample>
</Sample>
</ReplicationStats>
</Statistics>
Individual statistics are defined for protocol errors are:

• PolicyServer: The name of the Policy Server in the system.
• BladeHostName: The name of the Blade on the host server.
• PeerHostName: The name of the peer server in the system.
• TotalSentKB: The total number of packets sent in KB during the interval.
• PeakSentKB: The peak rate of packets sent in KB/s during the interval.
• AvgSentKB: The average rate of packets sent in KB/s during the interval.
• TotalRecvKB: The total number of packets received in KB during the interval.
• PeakRecvKB: The peak rate of packets received in KB/s during the interval.
• AvgRecvKB: The average rate of packets received in KB/s during the interval.
E71645 Revision 01, June 2016 212

Mode
SCTP Association Statistics

SCTPAssociationStats tag.
Request
This request follows the QueryOmStats > SCTPAssociationStats tag defined in the XSDs.
The following is an example of a request for statistics for a SCTP association:

<QueryOmStats>
<SCTPAssociationStats>
<MRA>mra</MRA>
</SCTPAssociationStats>
</QueryOmStats>
Response
The response to this request follows the Statistics > SCTPAssociationStats tag defined in the XSDs.
The following is an example of the SCTPAssociationStats tag:

<Statistics>
<SCTPAssociationStats>
<Sample>
<MRA>mra</MRA>
<LocalAddrs>192.168.0.101,
192.168.0.102</LocalAddrs>
<LocalAddrsPort>3868</LocalAddrsPort>
<RemoteAddrs>192.168.0.103,192.168.0.104</RemoteAddrs>
<RemoteAddrsPort>60000</RemoteAddrsPort>
<SctpDataChunkSent>0</SctpDataChunkSent>
<SctpDataChunkReceived>0</SctpDataChunkReceived>
<SctpDataChunkReSent>0</SctpDataChunkReSent>
<SctpCongestionDuration>0</SctpCongestionDuration>
<NbrSctpCongestion>0</NbrSctpCongestion>
<SctpUnavailableDuration>0</SctpUnavailableDuration>
<NbrSctpUnavailable>0</NbrSctpUnavailable>
</Sample>
</SCTPAssociationStats>
</Statistics>
Note: The following three conditions exist:

• Only "SctpDataChunkSent ,SctpDataChunkReceived,SctpDataChunkReSent" items can be supported.
• If the SCTP association is established and then released within one interval , the statistics of the
SCTP association will not be generated.
E71645 Revision 01, June 2016 213

Mode
• Do not support DeltaCount="false" and AggregateTimeSamples="true."
Peer Associate Statistics

PeerAssociateStats tag.
Request
This request follows the QueryOmStats > PeerAssociateStats tag defined in the XSDs.
The following is an example of a request for statistics for PeerAssociateStats tag:

<QueryOmStats>
< PeerAssociateStats >
</ PeerAssociateStats >
</QueryOmStats>
Response
The response to this request follows the Statistics > PeerAssociateStats tag defined in the XSDs.
The following is an example of the PeerAssociateStats tag:

<Statistics>
<ReplicationStats>
<Sample>
<MRA>fwang-32-112-mra</MRA>
<LocalAddrs>fe80:0:0:0:5054:ff:fe1d:7630,0:0:0:0:0:0:0:1,127.0.0.1,
fe80:0:0:0:5054:ff:fe4d:5ae1,10.60.32.81,10.60.32.80</LocalAddrs>
<LocalAddrsPort>3456</LocalAddrsPort >
<RemoteAddrs> 10.60.32.80,10.60.32.81,0:0:0:0:0:0:0:1,127.0.0.1,
fe80:0:0:0:5054:ff:fe4d:5ae1,fe80:0:0:0:5054:ff:fe1d:7630</RemoteAddrs >
<RemoteAddrsAddr>57440</RemoteAddrsAddr>
< SctpDataChunkSent >0</ SctpDataChunkSent >
< SctpDataChunkReceived >0</ SctpDataChunkReceived >
< SctpDataChunkReSent >0</ SctpDataChunkReSent >
< SctpCongestionDuration >0</ SctpCongestionDuration >
< NbrSctpCongestion >0</ NbrSctpCongestion >
< SctpUnavailableDuration >0</ SctpUnavailableDuration >
< NbrSctpUnavailable >0</ NbrSctpUnavailable >
</Sample>
</ReplicationStats>
</Statistics>
E71645 Revision 01, June 2016 214

Mode
Message Error Statistics for Gx

MessageErrorStats tag.
Request
This request follows the QueryOmStats > MessageErrorStats tag defined in the XSDs.
The following is an example of a request for statistics for MessageErrorStats tag:

<QueryOmStats DeltaCount="true">
<MessageErrorStats></MessageErrorStats>
</QueryOmStats>
Response
The response to this request follows the Statistics > PeerErrorStats tag defined in the XSDs.
The following is an example of the MessagErrorStats tag:

<Statistics>
<MessageErrorStats>
<Sample>
<PolicyServer>MPE </PolicyServer>
<Name>mra.company.com</Name>
<NeId/>
<MessageCommand>AAA</MessageCommand>
<MessageErrorName>DIAMETER_ETC_FAIL_REASON</MessageErrorName>
<MessageErrorCode>-1</MessageErrorCode>
</Sample>
<Sample>
<MRA>MRA</MRA>
<Name>PGW-1</Name>
<NeId/>
<MessageCommand>AAA</MessageCommand>
<MessageErrorName>DIAMETER_ETC_FAIL_REASON</MessageErrorName>
<MessageErrorCode>-1</MessageErrorCode>
</Sample>
</MessageErrorStats>
</Statistics>
E71645 Revision 01, June 2016 215

Mode
SDR/SDA Message Processing Stats

MessageProcessingStats tag.
Request
This request follows the QueryOmStats > MessageProcessingStats tag defined in the XSDs.
The following is an example of a request for statistics for MessageProcessingStats tag:

<QueryOmStats ValidateResonseXML='true'>
<DiameterVzrStats>
</DiameterVzrStats>
</QueryOmStats>
Response
The response to this request follows the Statistics > PeerProcessingStats tag defined in the XSDs.
The following is an example of the MessageProcessingStats tag:

<Statistics>
<DiameterVzrStats>
<Sample>
<SDRMessagesSentCount>1</SDRMessagesSentCount>
<SDRMessagesTimeoutCount>0</SDRMessagesTimeoutCount>
<SDASuccessMessagesReceivedCount>1</SDASuccessMessagesReceivedCount>
<SDAFailureMessagesReceivedCount>0</SDAFailureMessagesReceivedCount>
</Sample>
</DiameterVzrStats>
</Statistics>
E71645 Revision 01, June 2016 216

Part
IV
Cable Mode
Topics: This section is dedicated to the using the the OSSI

XML interface specifically for the cable mode.
• Topology Interface for Cable Mode.....218
The interface itself is divided into the following
• Subscriber Interface for Cable Mode.....228
areas:
• Operational Measurement Requests for Cable
Mode.....237 • Topology Interface — allows cable users to
manage and query network elements in the
system.
• Subscriber Interface — allows cable users to
manage and query subscriber accounts and tiers.
• Operational Measurements (OM) Interface —
allows cable users to retrieve statistical data from
the system.
Each of these interfaces is described in detail in later
chapters in this part of the document.
E71645 Revision 01, June 2016 217

Chapter
1
Topology Interface for Cable Mode
Topics: The Topology Interface allows cable users to manage

and query network elements within the system.
• Network Elements.....219
E71645 Revision 01, June 2016 218

Network Elements
A network element represents a node in the network (cable or wireless), such as a router, CMTS, PDSN,
B-RAS, and so on. The network elements can be organized into logical groups that subdivide the
network space. Network elements have the following attributes that can be requested.
Note: Depending on your system configuration, not all attributes may be present.
Note: The same attributes are also used in the Update Network Element operation.
• Capability: The numerical identity of network element capability type. For example:
• TDF-Solicit
• Time-Tariff (PGW,DPI)
• Usage-Report-26(GGSN,PGW,SWG,DPI)
• SctpEnabled: Whether the Network Element supports diameter over SCTP.

• InitiateDirectConnection: The diameter connection port of the TDF element network.
• TdfPort: The diameter connection port of the TDF element network.
• ReconnectDelay: The delay period after diameter connection fails. The unit is in seconds.
• WatchDogInterval: The time interval of the watch dog monitor.
• ResponseTimeout: The time period before there is a connection response timeout.
The following sections describe the available network tags.
Add a Network Element in Cable

Request
The following example creates a new Network Element to represent a router in the network. It also
creates a group, and puts the router in that group.
The router contains the following attributes:
• Name (unique identifier) – Router 23
• Description – Core router for the north east
• HostName (IP address or DNS hostname) – 12.1.1.1
• NeID (another unique identifier) – 112222
• Capacity (aggregate capacity in bps) – 456000
The group contains the following attributes:
• Name – NE Group 1
• Description – All core routers

E71645 Revision 01, June 2016 219

<AddNetworkElement>
<NetworkElement>
<Description>Core router for the north east</Description>
<NeId>112222</NeId>
<NeSubType></NeSubType>
</NetworkElement>
<NetworkElementGroup>
<Name>NE Group 1</Name>
<Description>All core routers</Description>
<ElementRef>
<Name>router 23</Name>
</ElementRef>
Response
The example XML response that follows represents a successful operation that creates a new network
element and/or groups:

<Response>
<Result>0</Result>
<Success count="2">Successfully imported 1 network elements.
Successfully imported 1 group.</Success>
</Command>
</Response>
The example XML response that follows represents an operation that includes both a success and a
failure (for example, an attempt to update a group’s description field (success), and add an unknown
network element “router 24” to the group “NE Group 1” (failed)).

<Response>
<Result>0</Result>
<Success count="1">Successfully updated 1 groups.</Success>
<Failure count="1">Failed to update 1 groups. Network Element Group
update returned an error attempting to add the following: router 24
Group NE Group 1</Failure>
</Command>
</Response>
E71645 Revision 01, June 2016 220

Update a Network Element in Cable

Request
The following example changes the capacity attribute of the network element named “Router 23” to
the new value: 4567000.

<NetworkElement>
</NetworkElement>
Response

<Response>
<Result>0</Result>
</Command>
</Response>
Delete Request for Update Network Element in Cable

The following examples show the delete request and response that are defined in the XSDs for the
Request
This delete request follows the UpdateNetworkElement tag defined in the XSDs.
The following example is a request for the ManualSubnet operation to delete a network element.

<NetworkElement>
<Name>cmts17o</Name>
E71645 Revision 01, June 2016 221

<ReadCommunity></ReadCommunity>
<X>0</X>
<Y>0</Y>
<ManualSubnet operation=”delete”>
<Mask>24</Mask>
</NetworkElement>
Response

<Response>
<Result>0</Result>
</Command>
</Response>
Add Network Element to Group

AddNetworkElementToGroup tag.
Request
This request follows the AddNetworkElementToGroup tag defined in the XSDs.
The following example shows the XML command to add three network elements (Router 2, Router
34, and Router 131) to a group (Group 1).

<AddNetworkElementToGroup>
</AddNetworkElementToGroup>
Response
E71645 Revision 01, June 2016 222


<Response>
<Result>0</Result>
<Success count="3">Added 3 elements to a group.</Success>
</Command>
</Response>
Remove Network Element from Group

RemoveNetworkElementFromGroup tag.
Request
This request follows the RemoveNetworkElementFromGroup tag defined in the XSDs.
The following example shows the XML command to remove two network elements (Router 34 and
Router 131) from a group (Group 1).

<RemoveNetworkElementFromGroup>
</RemoveNetworkElementFromGroup>
Response

<Response>
<Result>0</Result>
<Success count="2">Removed 2 elements from group.</Success>
</Command>
</Response>
Delete Network Element

DeleteNetworkElement tag.
Request
E71645 Revision 01, June 2016 223

This request follows the DeleteNetworkElement tag defined in the XSDs.

The following example shows the XML command to delete two network elements (Node 1 and Node
2).

<DeleteNetworkElement>
<Name>Node1</Name>
<Name>Node2</Name>
</DeleteNetworkElement>
Response

<Response>
<Result>0</Result>
<Success count="2">Deleted 2 elements.</Success>
</Command>
</Response>
Delete Network Element Group

DeleteNetworkElementGroup tag.
Request
This request follows the DeleteNetworkElementGroup tag defined in the XSDs.
The following example shows the XML command to delete two network element groups (Group 1
and Group 2).

<DeleteNetworkElementGroup>
</DeleteNetworkElementGroup>
Response

<Response>
<Result>0</Result>
E71645 Revision 01, June 2016 224

<Success count="2">Deleted 2 network element groups.</Success>
</Command>
</Response>
Query Network Elements

Note: This query is not available to Policy servers in S-CMP mode.
QueryNetworkElement tag.
Request
Example 1 — XML for querying multiple network elements by name.

<Name>NE A</Name>
<Name>NE B</Name>
Example 2 — XML for querying all network elements and groups.

Response
The response to this request follows the ConfigurationData > NetworkElement tag defined in the
XSDs.
<NetworkElement>
<Name>vod-1</Name>
<Description/>
<HostName/>
<BackupHostName/>
<NeId>vod-1</NeId>
<NetworkElementType>Server</NetworkElementType>
<X>0</X>
<Y>0</Y>
<ManualSubnet>
<Mask>8</Mask>
</ManualSubnet>
E71645 Revision 01, June 2016 225

</NetworkElement>
<NetworkElement>
<Name>erx-1</Name>
<Description/>
<HostName/>
<BackupHostName/>
<NeId>erx-1</NeId>
<NetworkElementType>B-RAS</NetworkElementType>
<NeSubType>ERX</NeSubType>
<X>0</X>
<Y>0</Y>
<ManualSubnet>
<Mask>8</Mask>
</ManualSubnet>
<NEInterface>
<Name>8/0</Name>
<Description/>
</NEInterface>
</NetworkElement>
<NetworkElement>
<Description/>
<HostName/>
<BackupHostName/>
<X>0</X>
<Y>0</Y>
</NetworkElement>
<NetworkElement>
<Description/>
<HostName/>
<BackupHostName/>
<X>0</X>
<Y>0</Y>
</NetworkElement>
<NetworkElement>
<Name>mx-1</Name>
<Description/>
<BackupHostName/>
<NeId/>
<NetworkElementType>Wireline Gateway</NetworkElementType>
<NeSubType>MX Series</NeSubType>
<X>0</X>
<Y>0</Y>
<DiameterRealm>juniper.com</DiameterRealm>
<ManualSubnet>
<Mask>8</Mask>
</ManualSubnet>
<Nediameterid>
<NediameteridStr>mx.juniper.com</NediameteridStr>
E71645 Revision 01, June 2016 226

</Nediameterid>
</NetworkElement>
E71645 Revision 01, June 2016 227

Chapter
2
Subscriber Interface for Cable Mode
Topics: The Subscriber Interface allows cable users to

manage and query the subscriber accounts and tiers.
• Accounts.....229
• Tiers.....233
E71645 Revision 01, June 2016 228

Accounts
An account represents a billable entity that contains the individual users.
The Subscriber Interface consists of the following Account management requests:
• Add Account: Allows users to add and update subscriber accounts within their system. If an account
already exists with the given identifier (Account ID), then this is considered an update and the
new account replaces the existing one. All relationships between that account and other objects in
the system (for example, tiers) are maintained.
• Update Account: Allows users to update accounts in their system. If no object exists with the given
identifier (Account ID), then this is a failure condition and the object is not saved.
• Delete Account: Allows users to delete an account.
• Query Account: Allows users to query a specific account or list of accounts, returning their configured
attributes.
Overview
The Subscriber Interface consists of the following requests:
• Accounts — An account represents a billable entity that contains the individual users.
• Add Account: Allows users to add and update subscriber accounts within their system. If an
account already exists with the given identifier (Account ID), then this is considered an update
and the new account replaces the existing one. All relationships between that account and other
objects in the system (for example, tiers) are maintained.
• Update Account: Allows users to update accounts in their system. If no object exists with the
given identifier (Account ID), then this is a failure condition and the object is not saved.
• Delete Account: Allows users to delete an account.
• Query Account: Allows users to query a specific account or list of accounts, returning their
configured attributes.
• Tiers — A tier represents a class of service or a logical grouping of subscriber accounts.

• Add Tier: Allows users to add new tiers to their system. If a tier already exists with the given
identifier (Name), then this is considered an update and the new tier replaces the existing one.
All relationships between that tier and other objects in the system (for example, accounts) are
maintained.
• Update Tier: Allows users to update tiers within their system. If no object exists with the given
identifier (Name), then this is a failure condition and the object is not saved.
• Delete Tier: Allows users to delete a tier.
• Query Tier: Allows users to query a specific tier or list of tiers, returning their configured
attributes.
Add Account
The following examples show the request and response that are defined in the XSDs for the AddAccount
tag.
E71645 Revision 01, June 2016 229

Request
This request follows the AddAccount tag defined in the XSDs.
The following example creates an account with the following attributes:
• Account ID — 000123
• Association — to a network element named: Node1
• One user in this account, with the following attributes:
• User ID — [email protected]
• One cable modem in this account, with the following attributes:
• MAC address — 10:10:10:10:10:11
• IP address — 30.0.0.3
• Two CPEs behind this cable modem: 10.0.0.3, 20.0.0.3
• Association to a tier named: Premium

<AddAccount>
<Account>
<AccountId>000123</AccountId>
<NetworkElementName>Node1</NetworkElementName>
<EndUser>
<EndUserId>[email protected]</EndUserId>
</EndUser>
<CableModem>
<CmMacAddr>10:10:10:10:10:11</CmMacAddr>
<CmIpAddr>30.0.0.3</CmIpAddr>
<Cpe>
<CpeIpAddr>10.0.0.3</CpeIpAddr>
</Cpe>
<Cpe>
</Cpe>
</CableModem>
<TierRef>
<Name>Premium</Name>
</TierRef>
</Account>
</AddAccount>
Response

<Response>
<Result>0</Result>
<Command type="XmlInterfaceResponse" >
<Success count="1">Successfully imported 1 accounts.</Success>
</Command>
</Response>
E71645 Revision 01, June 2016 230

Update Account
UpdateAccount tag.
Request
This request follows the UpdateAccount tag defined in the XSDs.
The following example updates the account identified by ID 000123 to add a new user with ID
[email protected].

<UpdateAccount>
<Account>
<EndUser operator="add">
</EndUser>
</Account>
</UpdateAccount>
Response

<Response>
<Result>0</Result>
<Success count="1">Successfully updated 1 accounts.</Success>
</Command>
</Response>
Delete Account
DeleteAccount tag.
Request
This request follows the DeleteAccount tag defined in the XSDs.
The following example deletes two accounts: Account1 and Account2.

<DeleteAccount>
<AccountId>Account1</AccountId>
<AccountId>Account2</AccountId>
</DeleteAccount>
E71645 Revision 01, June 2016 231

Response

<Response>
<Result>0</Result>
<Success count="2">Deleted 2 accounts.</Success>
</Command>
</Response>
Query Account
QueryAccount tag.
Request
This request follows the QueryAccount tag defined in the XSDs.
The following example queries multiple accounts by account ID.

<QueryAccount>
</QueryAccount>
Response
The response to this request follows the ConfigurationData > Account tag defined in the XSDs.

<Account>
<NetworkElementName>Node1</NetworkElementName>
<EndUser>
</EndUser>
<CableModem>
<CmMacAddr>10:10:10:10:10:11</CmMacAddr>
<CmIpAddr>30.0.0.3</CmIpAddr>
<UpServerIndex>0</UpServerIndex>
<UpChannelIndex>0</UpChannelIndex>
<DownServerIndex>0</DownServerIndex>
<DownChannelIndex>0</DownChannelIndex>
<DocsisVersion>0</DocsisVersion>
<MaxFlows>0</MaxFlows>
<MaxClassifiers>0</MaxClassifiers>
<Cpe>
<CpeMacAddr>00:00:00:00:00:00</CpeMacAddr>
</Cpe>
E71645 Revision 01, June 2016 232

<Cpe>
<CpeMacAddr>00:00:00:00:00:00</CpeMacAddr>
</Cpe>
</CableModem>
<TierRef>
<Name>Premium</Name>
</TierRef>
</Account>
Tiers
A tier represents a class of service or a logical grouping of subscriber accounts.
The Subscriber Interface consists of the following Tiers management requests:
• Add Tier — Allows users to add new tiers to their system. If a tier already exists with the given
identifier (Name), then this is considered an update and the new tier replaces the existing one. All
relationships between that tier and other objects in the system (for example, accounts) are
maintained.
• Update Tier — Allows users to update tiers within their system. If no object exists with the given
identifier (Name), then this is a failure condition and the object is not saved.
• Delete Tier — Allows users to delete a tier.
• Query Tier — Allows users to query a specific tier or list of tiers, returning their configured attributes.
Add Tier
The following examples show the request and response that are defined in the XSDs for the AddTier
tag.
Request
This request follows the AddTier tag defined in the XSDs.
The following example creates two tiers:
• Tier1: Upstream bandwidth limit: 1 Mbps
• Tier2: Upstream bandwidth limit: 2 Mbps

<AddTier>
<Tier>
<Name>Tier1</Name>
<Description/>
<ResourceLimit>
<ResourceType>0</ResourceType>
<Direction>1</Direction>
<LimitValue>1000000</LimitValue>
</ResourceLimit>
</Tier>
<Tier>
E71645 Revision 01, June 2016 233

<Name>Tier2</Name>
<Description/>
<ResourceLimit>
</ResourceLimit>
</Tier>
</AddTier>
Response

<Response>
<Result>0</Result>
<Success count="2">Successfully imported 2 tiers.</Success>
</Command>
</Response>
Update Tier
The following examples show the request and response that are defined in the XSDs for the UpdateTier
tag.
Request
This request follows the UpdateTier tag defined in the XSDs.
The following example updates the tier named Tier1 to change the upstream bandwidth limit to 555000
bps.

<UpdateTier>
<Tier>
<Name>Tier1</Name>
<ResourceLimit>
</ResourceLimit>
</Tier>
</UpdateTier>
Response

<Response>
E71645 Revision 01, June 2016 234

<Result>0</Result>
<Success count="1">Successfully updated 1 tier.</Success>
</Command>
</Response>
Delete Tier
The following examples show the request and response that are defined in the XSDs for the DeleteTier
tag.
Request
This request follows the DeleteTier tag defined in the XSDs.

<DeleteTier>
<Name>Tier1</Name>
<Name>Tier2</Name>
</DeleteTier>
Response

<Response>
<Result>0</Result>
<Success count="2">Deleted 2 Tiers.</Success>
</Command>
</Response>
Query Tier
The following examples show the request and response that are defined in the XSDs for the QueryTier
tag.
Request
This request follows the QueryTier tag defined in the XSDs.

<QueryTier>
<Name>Tier Gold</Name>
<Name>Tier Bronze</Name>
</QueryTier>
E71645 Revision 01, June 2016 235

Response
The response to this request follows the ConfigurationData > Tier tag defined in the XSDs.

<Tier>
<Name>Tier Gold</Name>
<Description/>
<ResourceLimit>
</ResourceLimit>
</Tier>
<Tier>
<Name>Tier Bronze</Name>
<Description/>
<ResourceLimit>
</ResourceLimit>
</Tier>
E71645 Revision 01, June 2016 236

Chapter
3
Operational Measurement Requests for Cable Mode
Topics: This chapter defines the various Operational

Measurements (OM) groups and the individual OM
• Operational Measurements Requests Overview for statistics that comprise them. For several of the more
Cable Mode.....238 generic statistics, for example, the instrumentation
• Topology Update Statistics.....238 on the Multimedia Policy Engine (MPE) can differ
• Subscriber Update Statistics.....239 by protocol, and therefore specific statistics may
increment differently across those protocols.
• Policy Server Statistics.....240
• Reserve Commit Statistics.....241
• Gate Statistics.....242
• Latency Statistics.....243
• Mgpi Statistics.....253
• Policy Statistics.....254
• Diameter Operational Measurements Requests for
Cable Mode.....255
• PCMM BoD and CMTS Operational
Measurements.....261
• PCMM Connection Error Statistics.....273
• BoD Interface Operational Measurements.....279
• CMTS Re-discovery Operational Measurement
Requests.....282
• DQos Operational Measurements Requests.....285
• Traffic Profile Statistics.....288
• Protocol Error Statistics.....289
• PCMM Connection Error Statistics.....294
• MPE/BOD Replication Statistics.....299
• Field Mapping Profile Queries.....300
E71645 Revision 01, June 2016 237

Operational Measurements Requests Overview for Cable Mode

The OM interface consists of the following requests, grouped by category:
• OSSI XML interface statistics
• Topology Update Statistics: retrieves statistics on all updates made through the Topology Interface.
• Subscriber Update Statistics: retrieves statistics on all updates made through the Subscriber
Interface.
• Policy Server Statistics: retrieves statistics on each policy server in the system, including the
associated subscribers and network elements.
• Protocol-specific statistics
• Message Processing Statistics: retrieves statistics on session events.
• Reserve Commit Statistics: retrieves statistics on reserve and commit requests specific to the SPC
DQoS protocol.
• Latency Statistics: retrieves latency statistics information for incoming and outgoing messages
tracked per network element, MPE.
• Gate Statistics: retrieves statistics on gate functioning.
• Mgpi Statistics (Mgpi): retrieves statistics on an MPE device over a Diameter-based Rx interface.
• Policy Statistics: retrieves statistics on policy servers and execution frequency and duration.
• Diameter Application Function Statistics: retrieves statistics on Diameter Application Functions.
• PCMM CMTS Statistics: retrieves statistics on DQos and DQos Network statistics.
• Protocol Error Statistics: retrieves statistics from Diameter Application Functions (AF).
• PCMM Connection Error Statistics: retrieves statistics from Diameter Application Functions (AF).
• Diameter Event Trigger Statistics: retrieves related event trigger statistics used for tracking activity.
• Traffic Profile Statistics: retrieves traffic profile statistics which counters the number of times a
PCRF attempts to install, remove, or fails.
Topology Update Statistics

TopologyUpdateStats tag.
Request
This request follows the QueryOmStats > TopologyUpdateStats tag defined in the XSDs.
The following is an example of a request for a topology update:

<QueryOmStats>
<TopologyUpdateStats></TopologyUpdateStats>
</QueryOmStats>
E71645 Revision 01, June 2016 238

Response
The response to this request follows the Statistics > TopologyUpdateStats tag defined in the XSDs.
• TopologyUpdateCount: The number of topology changes made in the Configuration Management
Platform (CMP) that resulted in changes to an MPE. Topology data includes Network Elements,
Paths, Interfaces, and Links. Changes to this data can occur through either the CMP Graphical User
Interface (GUI) or the XML interface. The counter increments for each MPE that updates as a result
of the change. For example, when a user updates a Network Element, the topology update counter
increments for each MPE that the Network Element is associated with.
made across multiple elements but all of those changes are pushed at one time to the MPE. This is
treated as a single topology change with regard to the counter.
• TopologyUpdateFailCount: The number of topology changes made in the CMP that fail to update
an associated MPE. For example, if an MPE is offline while a Network Element is changed, the fail
The following is an example of the TopologyUpdateStats tag:

<Statistics>
<TopologyUpdateStats>
<Sample>
<TopologyUpdateCount>942</TopologyUpdateCount>
<TopologyUpdateFailCount>6</TopologyUpdateFailCount>
</Sample>
</TopologyUpdateStats>
</Statistics>
Subscriber Update Statistics

SubscriberUpdateStats tag.
Request
This request follows the QueryOmStats > SubscriberUpdateStats tag defined in the XSDs.
The following is an example of a request for subscriber update statistics:

<QueryOmStats>
<SubscriberUpdateStats></SubscriberUpdateStats>
</QueryOmStats>
Response
E71645 Revision 01, June 2016 239

The response to this request follows the Statistics > SubscriberUpdateStats tag defined in the XSDs.
• SubscriberUpdateCount — The number of subscriber changes made in the CMP that resulted in
changes to an MPE. Subscriber data includes accounts and tiers. Changes to this data can occur
through either the CMP GUI or the XML Interface. The counter is incremented for each MPE that
updates as a result of the change. For example, when a user updates an account, the subscriber
update counter increments for each MPE that the account is associated with.
made across multiple accounts but all of those changes are pushed at one time to the MPE. This is
treated as a single subscriber change with regard to the counter.
• SubscriberUpdateFailCount — The number of subscriber changes made in the CMP that fail to
update an associated MPE. For example, if an MPE is offline while an account is changed, the fail
The following is an example of the SubscriberUpdateStats tag:

<Statistics>
<SubscriberUpdateStats>
<Sample>
<SubscriberUpdateCount>942</SubscriberUpdateCount>
<SubscriberUpdateFailCount>6</SubscriberUpdateFailCount>
</Sample>
</SubscriberUpdateStats>
</Statistics>
Policy Server Statistics

PolicyServerStats tag.
Request
This request follows the QueryOmStats > PolicyServerStats tag defined in the XSDs.

<QueryOmStats>
<PolicyServerStats>
</QueryOmStats>
E71645 Revision 01, June 2016 240


<QueryOmStats>
<PolicyServerStats></PolicyServerStats>
</QueryOmStats>
Response
The response to this request follows the Statistics > PolicyServerStats tag defined in the XSDs.
• TotalNetworkElementCount — The total (absolute) number of network elements associated with
that MPE. The absolute value is the value taken at the EndTime of the reported sample.
• TotalSubscriberCount — The total (absolute) number of accounts associated with that MPE.
The following is an example of the PolicyServerStats tag:

<Statistics>
<PolicyServerStats>
<Sample>
<TotalNetworkElementCount>52</TotalNetworkElementCount>
<TotalSubscriberCount>1000000</TotalSubscriberCount>
</Sample>
</Statistics>
Reserve Commit Statistics

ReserveCommitStats tag.
Request
This request follows the QueryOmStats > ReserveCommitStats tag defined in the XSDs.

<QueryOmStats>
<ReserveCommitStats></ReserveCommitStats>
</QueryOmStats>
Response
E71645 Revision 01, June 2016 241

The response to this request follows the Statistics > ReserveCommitStats tag defined in the XSDs.
• ReserveCount — Number of GateSet Reserve messages received.
• ReserveSuccessCount — Number of GateSet Reserve messages acknowledged.
• ReserveFailCount — Number of GateSet Reserve messages failed.
• ReserveErrorCount — Number of GateSet Reserve messages that were errors.
• CommitCount — Number of GateSet Commit messages received.
• CommitSuccessCount — Number of GateSet Commit messages acknowledged.
• CommitFailCount — Number of GateSet Commit messages failed.
• CommitErrorCount — Number of GateSet Commit messages that were errors.
• ReserveCommitCount — Number of GateSet Reserve+Commit messages received.
• ReserveCommitSuccessCount — Number of GateSet Reserve+Commit messages acknowledged.
• ReserveCommitFailCount — Number of GateSet Reserve+Commit messages failed.
• ReserveCommitErrorCount — Number of GateSet Reserve+Commit messages that were errors.
The following is an example XML response to a ReserveCommitStats tag request:

<Statistics>
<ReserveCommitStats>
<Sample>
<ReserveCount>100</ReserveCount>
<ReserveSuccessCount>99</ReserveSuccessCount>
<ReserveFailCount>1</ReserveFailCount>
<ReserveErrorCount>0</ReserveErrorCount>
<CommitCount>99</CommitCount>
<CommitSuccessCount>99</CommitSuccessCount>
<CommitFailCount>0</CommitFailCount>
<CommitErrorCount>0</CommitErrorCount>
<ReserveCommitCount>99</ReserveCommitCount>
<ReserveCommitSuccessCount>99</ReserveCommitSuccessCount>
<ReserveCommitFailCount>0</ReserveCommitFailCount>
<ReserveCommitErrorCount>0</ReserveCommitErrorCount>
</Sample>
</ReserveCommitStats>
</Statistics>
Gate Statistics
The following examples show the request and response that are defined in the XSDs for the GateStats
tag.
Request
This request follows the QueryOmStats > GateStats tag defined in the XSDs.
E71645 Revision 01, June 2016 242


<QueryOmStats>
<GateStats></GateStats>
</QueryOmStats>
Response
The response to this request follows the Statistics > GateStats tag defined in the XSDs.
• GateSetCount — Number of Gate Set messages processed.
• GateSetSuccessCount — Number of Gate Set Success messages processed.
• GateSetErrorCount — Number of Gate Set Error messages processed.
• GateStatusCount — Number of Gate Status messages processed.
• GateStatusSuccessCount — Number of Gate Status Success messages processed.
• GateStatusErrorCount — Number of Gate Status Error messages processed.
• GateDeleteCount — Number of Gate Delete messages processed.
• GateDeleteSuccessCount — Number of Gate Delete Success messages processed.
• GateDeleteErrorCount — Number of Gate Delete Error messages processed.
The following is an example XML response to a GateStats tag request:

<Statistics>
<GateStats>
<Sample>
<GateSetCount>100</GateSetCount>
<GateSetSuccessCount>100</GateSetSuccessCount>
<GateSetErrorCount>0</GateSetErrorCount>
<GateStatusCount>100</GateStatusCount>
<GateStatusSuccessCount>100</GateStatusSuccessCount>
<GateStatusErrorCount>0</GateStatusErrorCount>
<GateDeleteCount>100</GateDeleteCount>
<GateDeleteSuccessAckCount>100</GateDeleteSuccessCount>
<GateDeleteErrorCount>0</GateDeleteErrorCount>
</Sample>
</GateStats>
</Statistics>
Latency Statistics
DiameterAfLatencyStats tag.
Request
E71645 Revision 01, June 2016 243

This request follows the QueryOmStats > DiameterAfLatencyStats tag defined in the XSDs.

<QueryOmStats>
</QueryOmStats>
Response
The response to this request follows the Statistics > DiameterAfLatencyStats tag defined in the XSDs.

<Statistics>
<Sample>
E71645 Revision 01, June 2016 244

</Sample>
</Statistics>
Request
This request follows the QueryOmStats > DiameterAfPeerLatencyStats tag defined in the XSDs.

<QueryOmStats>
</QueryOmStats>
Response
The response to this request follows the Statistics > DiameterAfPeerfLatencyStats tag defined in the
XSDs.

<Statistics>
<DiameterAfPeerfLatencyStats>
<Sample>
<NeId>NeId</NeId>
E71645 Revision 01, June 2016 245

</Sample>
</DiameterAfPeerfLatencyStats>
</Statistics>
Request
This request follows the QueryOmStats > PcmmCmtsLatencyStats tag defined in the XSDs.

<QueryOmStats>
</QueryOmStats>
Response
The response to this request follows the Statistics > PcmmCmtsLatencyStats tag defined in the XSDs.

<Statistics>
<Sample>
E71645 Revision 01, June 2016 246

</Sample>
</Statistics>
Request
This request follows the QueryOmStats > PcmmCmtsPeerLatencyStats tag defined in the XSDs.

<QueryOmStats>
</QueryOmStats>
Response
The response to this request follows the Statistics > PcmmCmtsPeerLatencyStats tag defined in the
XSDs.

<Statistics>
<Sample>
E71645 Revision 01, June 2016 247

<NeId>NeId</NeId>
</Sample>
</Statistics>
Request
This request follows the QueryOmStats > PcmmAmLatencyStats tag defined in the XSDs.

<QueryOmStats>
</QueryOmStats>
E71645 Revision 01, June 2016 248

Response
The response to this request follows the Statistics > PcmmAmLatencyStats tag defined in the XSDs.

<Statistics>
<Sample>
</Sample>
</Statistics>
Request
This request follows the QueryOmStats > PcmmAmPeerLatencyStats tag defined in the XSDs.

<QueryOmStats>
E71645 Revision 01, June 2016 249

</QueryOmStats>
Response
The response to this request follows the Statistics > PcmmAmPeerLatencyStats tag defined in the
XSDs.
<Statistics>
<Sample>
<PolicyServer>policyserver</PolicyServer>
<AmId>AmId</AmId>
</Sample>
</Statistics>
E71645 Revision 01, June 2016 250

Request
This request follows the QueryOmStats > PcmmDpsLatencyStats tag defined in the XSDs.

<QueryOmStats>
<PolicyServer>PolicyServer>
</QueryOmStats>
Response
The response to this request follows the Statistics > PcmmDpsLatencyStats tag defined in the XSDs.

<Statistics>
<Sample>
E71645 Revision 01, June 2016 251

</Sample>
</Statistics>
Request
This request follows the QueryOmStats > PcmmDpsPeerLatencyStats tag defined in the XSDs.

<QueryOmStats>
</QueryOmStats>
Response
The response to this request follows the Statistics > PcmmDpsPeerLatencyStats tag defined in the
XSDs.
<Statistics>
<Sample>
<DpsId>NeId</DpsId>
E71645 Revision 01, June 2016 252

</Sample>
</Statistics>
Mgpi Statistics
The following examples show the request and response that are defined in the XSDs for the MgpiStats
tag.
Request
This request follows the QueryOmStats > MgpiStats tag defined in the XSDs.

<QueryOmStats>
<MgpiStats></MgpiStats>
</QueryOmStats>
Response
The response to this request follows the Statistics > MgpiStats tag defined in the XSDs.
• TotalFlowsCount — The number of active upstream diameter session flows in memory.
• ActualGatesCount — The number of actual upstream gates in memory.
• MultiFlowGatesCount — The number of gates in memory that have been aggregated, (for example,
possessing multiple diameter session flows on this gate).
• EffectiveGatesCount — A calculation using the formula Effective Gates = (Active Gate Count -
Actual Gate Count ) + Total Flow Count.
Note: Active gate count is the number of active gates, including the upstream gates and downstream
gates.
Example
An MPE Upstream Service Flow Limit for Triggering MGPI = 2, Maximum Number of Grants per
Interval = 2 and MGPI = yes.
E71645 Revision 01, June 2016 253

Send 3 same AAR requests to MPE, Active Gate Count = 5, Actual Gate Count = 2, Total Flow Count
= 3.
The Effective Gate Count = (5-2) + 3 = 6
The following is an example XML response to a MgpiStats tag request:
<xml version="1.0" encoding="UTF-8"?>

<Statistics>
<MgpiStats>
<Sample>
<TotalFlowsCount>10</TotalFlowsCount>
<AcutalGatesCount>52</ActualGatesCount>
<MultiFlowGatesCount>52</MultiFlowGatesCount>
<EffectiveGatesCount>15</EffectiveGatesCount>
</Sample>
</MgpiStats>
</Statistics>
Policy Statistics
The following examples show the request and response that are defined in the XSDs for the PolicyStats
tag.
Request
This request follows the QueryOmStats > PolicyStats tag defined in the XSDs.

<QueryOmStats>
<PolicyStats>
<Name>PolicyName</Name>
</PolicyStats>
</QueryOmStats>

<QueryOmStats>
<PolicyStats></PolicyStats>
</QueryOmStats>
Response
E71645 Revision 01, June 2016 254

The response to this request follows the Statistics > PolicyStats tag defined in the XSDs.
• TotalExecTime — the summary of all execution durations, where execution duration is measured
starting the beginning of the policy conditions evaluation until the execution finishing.
• MaxExecTime — the longest execution duration of the policy.
• AvgExecTime — the arithmetic average off all execution durations of the policy.
• TriggerCount — number of policies triggered.
• FailCondCount — number of policies that failed because of conditions.
• FailNACount — number of policies that failed because of data not available/applicable.
• FailExcCount — number of policies that failed because of exceptions.
The following is an example XML response to a PolicyStats tag request:

<Statistics>
<PolicyStats>
<Sample>
<Name>PolicyName</Name>
<EvalCount>0</EvalCount>
<TriggerCount>0</TriggerCount>
<FailCondCount>0</FailCondCount>
<FailNACount>0</FailNACount>
<FailExcCount>0</FailExcCount>
<TotalExecTime>0</TotalExecTime>
<AvgExecTime>0</AvgExecTime>
<MaxExecTime>0</MaxExecTime>
<MaxExecTime>0</MaxExecTime>
<HistExecTime_000_020>0</HistExecTime_000_020>
<HistExecTimePlus_250>0</HistExecTimePlus_250>
</PolicyStats>
<Statistics>
Diameter Operational Measurements Requests for Cable Mode

• Diameter Application Function Statistics
• Diameter Application Function Peer Statistics
E71645 Revision 01, June 2016 255

Diameter Application Function Statistics

DiameterAfStats tag.
Request

<QueryOmStats>
<DiameterAfStats>
<PolicyServer></PolicyServer>
</DiameterAfStats>
</QueryOmStats>
Response
The response to this request follows the Statistics > DiameterAfStats tag defined in the XSDs.
The following is an example XML response to a DiameterAfStats tag request:
<Statistics>
<DiameterAfStats>
<Sample>
<PolicyServer>vmpe</PolicyServer>
E71645 Revision 01, June 2016 256

<S9RxAARInitialRecvCount>0</S9RxAARInitialRecvCount>
<S9RxAARInitialSendCount>0</S9RxAARInitialSendCount>
<S9RxAARRecvCount>0</S9RxAARRecvCount>
<S9RxAARSendCount>0</S9RxAARSendCount>
<S9RxAARModificationRecvCount>0</S9RxAARModificationRecvCount>
<S9RxAARModificationSendCount>0</S9RxAARModificationSendCount>
<S9RxAARTimeoutCount>0</S9RxAARTimeoutCount>
<S9RxAAARecvSuccessCount>0</S9RxAAARecvSuccessCount>
<S9RxAAASendSuccessCount>0</S9RxAAASendSuccessCount>
<S9RxAAARecvFailureCount>0</S9RxAAARecvFailureCount>
<S9RxAAASendFailureCount>0</S9RxAAASendFailureCount>
<S9RxASRHORecvCount>0</S9RxASRHORecvCount>
<S9RxASRHOSendCount>0</S9RxASRHOSendCount>
<S9RxASROtherRecvCount>0</S9RxASROtherRecvCount>
<S9RxASROtherSendCount>0</S9RxASROtherSendCount>
<S9RxASRRecvCount>0</S9RxASRRecvCount>
<S9RxASRSendCount>0</S9RxASRSendCount>
<S9RxCleanupASRSendCount>0</S9RxCleanupASRSendCount>
<S9RxASRHOTimeoutCount>0</S9RxASRHOTimeoutCount>
<S9RxASROtherTimeoutCount>0</S9RxASROtherTimeoutCount>
<S9RxASRTimeoutCount>0</S9RxASRTimeoutCount>
<S9RxASARecvSuccessCount>0</S9RxASARecvSuccessCount>
<S9RxASASendSuccessCount>0</S9RxASASendSuccessCount>
<S9RxASARecvFailureCount>0</S9RxASARecvFailureCount>
<S9RxASASendFailureCount>0</S9RxASASendFailureCount>
<S9RxCleanupASARecvCount>0</S9RxCleanupASARecvCount>
<S9RxRARHORecvCount>0</S9RxRARHORecvCount>
<S9RxRARHOSendCount>0</S9RxRARHOSendCount>
<S9RxRAROtherRecvCount>0</S9RxRAROtherRecvCount>
<S9RxRAROtherSendCount>0</S9RxRAROtherSendCount>
<S9RxRARRecvCount>0</S9RxRARRecvCount>
<S9RxRARSendCount>0</S9RxRARSendCount>
<S9RxRARHOTimeoutCount>0</S9RxRARHOTimeoutCount>
<S9RxRAROtherTimeoutCount>0</S9RxRAROtherTimeoutCount>
<S9RxRARTimeoutCount>0</S9RxRARTimeoutCount>
<S9RxRAARecvSuccessCount>0</S9RxRAARecvSuccessCount>
<S9RxRAASendSuccessCount>0</S9RxRAASendSuccessCount>
<S9RxRAARecvFailureCount>0</S9RxRAARecvFailureCount>
<S9RxRAASendFailureCount>0</S9RxRAASendFailureCount>
<S9RxRAARecvCount>0</S9RxRAARecvCount>
<S9RxRAASendCount>0</S9RxRAASendCount>
<S9RxSTRRecvCount>0</S9RxSTRRecvCount>
<S9RxSTRSendCount>0</S9RxSTRSendCount>
<S9RxSTRTimeoutCount>0</S9RxSTRTimeoutCount>
<S9RxSTARecvSuccessCount>0</S9RxSTARecvSuccessCount>
<S9RxSTASendSuccessCount>0</S9RxSTASendSuccessCount>
<S9RxSTARecvFailureCount>0</S9RxSTARecvFailureCount>
<S9RxSTASendFailureCount>0</S9RxSTASendFailureCount>
E71645 Revision 01, June 2016 257

</Sample>
</DiameterAfStats>
</Statistics>
DiameterAfStats tag utilizing support for Emergency APNs.
Request
The following is an example of a request for all policy servers within the system utilizing support for
emergency APNs:

<QueryOmStats>
<DiameterAfStats>
</DiameterAfStats>
</QueryOmStats>
Response
The response to this request follows the Statistics > DiameterAfStats tag defined in the XSDs utilizing
support for emergency APNs.
The following is an example XML response to a DiameterAfStats tag request for EmergencyAPN-MPE:
<Statistics>
<DiameterAfStats>
<Sample>
E71645 Revision 01, June 2016 258

</Sample>
</DiameterAfStats>
</Statistics>
Diameter Application Function Peer Statistics

DiameterAfPeerStats tag.
E71645 Revision 01, June 2016 259

Request
This request follows the QueryOmStats > DiameterAfPeerStats tag defined in the XSDs.
The following is an example of a request for a single peer using the Name parameter:

<QueryOmStats>
</QueryOmStats>
The following is an example of a request for all peer elements in the system. This request returns stats
for each peer element:

<QueryOmStats>
<DiameterAfPeerStats></DiameterAfPeerStats>
</QueryOmStats>
Response
The response to this request follows the Statistics > DiameterAfPeertStats tag defined in the XSDs.
Both the Name and NeId are returned, along with the statistics and actual recorded times for those
statistics. Samples are ordered by policy server, network element, and then by time.
<Statistics>
<Sample>
<PolicyServer>10.60.24.47</PolicyServer>
<Name>identity2</Name>
<NeId></NeId>
<ConnectTime></ConnectTime>
<DisconnectTime></DisconnectTime>
<ConnectAddress></ConnectAddress>
<ConnectPort></ConnectPort>
E71645 Revision 01, June 2016 260

</Sample>
</Statistics>
PCMM BoD and CMTS Operational Measurements

• PCMM BOD Statistics
• PCMM BOD Error Statistics
• PCMM BOD Session Statistics
• PCMM BOD AM Statistics
• PCMM Am Gate Statistics
• PCMM BOD Gate Statistics
• PCMM CMTS Statistics
• PCMM CTMS Gate Statistics
• PCMM Network Element Statistics
PCMM BOD Statistics

PcmmBodStats tag.
E71645 Revision 01, June 2016 261

Request
This request follows the QueryOmStats > PcmmBodStats tag defined in the XSDs.
Note: The BodServer statistic is optional. The name of the BoD, if not specified, will return the counters
from all the BoDs in the system.

<QueryOmStats>
< PcmmBodStats >
<BodServer>BoD1</BodServer>
</ PcmmBodStats>
</QueryOmStats>
Response
The response to this request follows the Statistics > PcmmBodStats tag defined in the XSDs.
• BodServer — The name of BoD server.
• IsComplete - Ture if current stats period is complete. False if current stats period is incomplete
(shorter than configured stats period) due to some reason such as failover.
• TotalGateCreate — Number of Gate Set messages processed to create session.
• TotalGateModify — Number of Gate Set messages processed to modify session.
• TotalGateDelete — Number of Gate Set messages processed to delete session.
• TotalGateInfo — Number of Gate Status messages processed.
• TotalGateReport -- Number of Gate Status messages processed.
• TotalSuccessGateCreate — Number of Gate Set Success messages of session created.
• TotalSuccessGateModify — Number of Gate Set Success messages of session modified.
• TotalSuccessGateDelete — Number of Gate Set Success messages of session deleted.
• TotalSuccessGateInfo — Number of Gate Status Success messages processed.
• TotalSuccessGateReport — Number of Gate Status Success messages processed.
• TotalFailureGateCreate — Number of Gate Set Error messages of session create failure.
• TotalFailureGateModify — Number of Gate Set Error messages of session modify failure.
• TotalFailureGateDelete — Number of Gate Set Error messages of session delete failure.
• TotalFailureGateInfo — Number of Gate Status Error messages processed.
• TotalFailureGateReport — Number of Gate Status Error messages processed.
• TotalTimeoutGateCreate — Number of Gate Set timeout messages to create session.
• TotalTimeoutGateModify — Number of Gate Set timeout messages to modify session.
• TotalTimeoutGateDelete — Number of Gate Set timeout messages to delete session.
• TotalTimeoutGateInfo — Number of Gate Status timeout messages processed.
• TotalPcmmMessages — Number of Gate messages sent or received.
• TotalInPcmmMessages — Number of Gate message received.
• TotalInPcmmMessages — Number of Gate message received.
• TotalSessions — Number of total sessions.
E71645 Revision 01, June 2016 262

The following is an example XML response to a PcmmBodStats tag request:

<Statistics>
<PcmmBodStats>
<Sample>
<BodServer>Atlanta105</BodServer>
<Type>BOD PCMM SOAP</Type>
<TotalGateCreate>0</TotalGateCreate>
<TotalGateModify>0</TotalGateModify>
<TotalGateDelete>0</TotalGateDelete>
<TotalGateInfo>0</TotalGateInfo>
<TotalGateReport>0</TotalGateReport>
<TotalSuccessGateCreate>0</TotalSuccessGateCreate>
<TotalSuccessGateModify>0</TotalSuccessGateModify>
<TotalSuccessGateDelete>0</TotalSuccessGateDelete>
<TotalSuccessGateInfo>0</TotalSuccessGateInfo>
<TotalSuccessGateReport>0</TotalSuccessGateReport>
<TotalFailureGateCreate>0</TotalFailureGateCreate>
<TotalFailureGateModify>0</TotalFailureGateModify>
<TotalFailureGateDelete>0</TotalFailureGateDelete>
<TotalFailureGateInfo>0</TotalFailureGateInfo>
<TotalFailureGateReport>0</TotalFailureGateReport>
<TotalTimeoutGateCreate>0</TotalTimeoutGateCreate>
<TotalTimeoutGateModify>0</TotalTimeoutGateModify>
<TotalTimeoutGateDelete>0</TotalTimeoutGateDelete>
<TotalTimeoutGateInfo>0</TotalTimeoutGateInfo>
<TotalPcmmMessages>0</TotalPcmmMessages>
<TotalInPcmmMessages>0</TotalInPcmmMessages>
<TotalSessions>0</TotalSessions>
</Sample>
</PcmmBodStats>
</Statistics>
PCMM BOD Error Statistics

PcmmBodErrorStats tag.
Request
This request follows the QueryOmStats > PcmmBodErrorStats tag defined in the XSDs.
Note: The name of the BoD is optional. If it is not specified, it will return the counters from all the
BoDs.

<QueryOmStats>
< PcmmBodStats >
</ PcmmBodErrorStats>
</QueryOmStats>
E71645 Revision 01, June 2016 263

Response
The response to this request follows the Statistics > PcmmBodErrorStats tag defined in the XSDs.
• BodServer — The name of BoD server.
• IsComplete — True if current stats period is complete. False if current stats period is incomplete
• Name — The identity of AM.
• ErrorCode — The error name and the error code if has.
• ErrorInCount — The number of error messages received that cause the session to fail.
• ErrorOutCount — The number of error messages sent, reserved field which is always 0 in this
statistic.

<Statistics>
<PcmmBodErrorStats>
<Sample>
<BodServer> BoD1</BodServer>
<Name>1</Name>
<ErrorCode> DEPLOYFAIL_GATESETERR_INSUFFICIENTRESOURCE (1) </ErrorCode>
<ErrorInCount>2<ErrorInCount>
<ErrorOutCount>0</ErrorOutCount>
</Sample>
</PcmmBodStats>
</Statistics>
PCMM BOD Session Statistics

PcmmBodSessionStats tag.
Request
This request follows the QueryOmStats > PcmmBodSessionStats tag defined in the XSDs.
Note:
optional.
The name of the BoD is optional. If it is not specified, it will return the counters from all the BoDs.

<QueryOmStats>
< PcmmBodSessionStats >
<Name>1</Name>
E71645 Revision 01, June 2016 264

</ PcmmBodSessionStats >

</QueryOmStats>
Response
The response to this request follows the Statistics > PcmmBodSessionStats tag defined in the XSDs.
• BodServer: The name of BoD server.
• ActiveSessionCount: Number of active session in BoD server.
• CreatedSessionCount: Number of session created before including terminated session, failure
session and expired session.
• FailedSessionCount: Number of session terminated by PCMM error.

<Statistics>
<PcmmBodSessionStats>
<Sample>
<Name>1</Name>
<ActiveSessionCount>2<ActiveSessionCount>
<CreatedSessionCount>5</CreatedSessionCount>
<FailedSessionCount>2</FailedSessionCount>
</Sample>
</PcmmBodSessionStats>
</Statistics>
PCMM BOD AM Statistics

PcmmBodStats tag.
Request
This request follows the QueryOmStats > PcmmBodAmStats tag defined in the XSDs.
Note: If both the BodServer and Name parameter values are specified together, OSSI will return
statistic counters from the MPE and application identity specified only.

<QueryOmStats>
< PcmmBodAmStats >
<Name>1</Name>
</PcmmBodAmStats >
</QueryOmStats>
Response
E71645 Revision 01, June 2016 265

The response to this request follows the Statistics > PcmmBodAmStats tag defined in the XSDs.
• Name: The identity of the AM.
• IsComplete: True if current stats period is complete. False if current stats period is incomplete
• MessagesInCount: Number of Gate messages received.
• MessagesOutCount: Number of Gate message sent.
• GateSetCount: Number of Gate Set messages sent.
• GateInfoCount: Number of Gate Info messages sent.
• GateDeleteCount: Number of Gate Delete messages sent.
• GateSetSuccessCount: Number of Gate Set Success acknowledge messages processed.
• GateInfoSuccessCount: Number of Gate Info Success acknowledge messages processed.
• GateDeleteSuccessCount: Number of Gate Delete Success acknowledge messages processed.
• GateSetErrorCount: Number of Gate Set Error acknowledge messages processed.
• GateInfoErrorCount: Number of Gate Info Error acknowledge messages processed.
• GateDeleteErrorCount: Number of Gate Delete Error acknowledge messages processed.
• ReportCount: Number of Gate Report messages processed.
• DropCount: Number of Gate Report messages ignore.
• ActiveGateCount: Number of currently active gates.
• MaxActiveGateCount: Highest number of active gates seen so far.
The following is an example XML response to a PcmmBodAmStats tag request:

<Statistics>
<PcmmBodAmStats>
<Sample>
<BodServer>bod</BodServer>
<Name>1</Name>
<GateInfoCount>0</GateInfoCount>
<GateInfoSuccessCount>0</GateInfoSuccessCount>
<GateDeleteSuccessCount>0</GateDeleteSuccessCount>
<GateInfoErrorCount>0</GateInfoErrorCount>
<ReportCount>0</ReportCount>
<DropCount>0</DropCount>
<ActiveGateCount>0</ActiveGateCount>
<MaxActiveGateCount>0</MaxActiveGateCount>
</Sample>
</PcmmBodAmStats>
</Statistics>
E71645 Revision 01, June 2016 266

PCMM Am Gate Statistics

PcmmAmGateStats tag.
Request
This request follows the QueryOmStats > PcmmAmGateStats tag defined in the XSDs.

<QueryOmStats>
< PcmmAmGateStats >
<Name>1</Name>
</ PcmmAmGateStats >
</QueryOmStats>
Response
The response to this request follows the Statistics > PcmmAmGateStats tag defined in the XSDs.
• PolicyServer: The name of MPE server.
• MessagesInCount -- Number of Gate messages received.
• MessagesOutCount: Number of Gate messages sent.
• GateSetCount: Number of Gate Set messages received.
• GateInfoCount: Number of Gate Info messages received.
• GateDeleteCount: Number of Gate Delete messages received.
• ReportCount— Number of Gate Report messages processed.
• DropCount: Number of Gate Report messages ignored.

<Statistics>
<PcmmAmGateStats>
<Sample>
E71645 Revision 01, June 2016 267

<Name>1</Name>
<ActiveGateCount>0<ActiveGateCount>
</Sample>
</PcmmAmGateStats>
</Statistics>
PCMM BOD Gate Statistics

PcmmBodGateReportStats tag.
Request
This request follows the QueryOmStats > PcmmBodGateReportStats tag defined in the XSDs.
Note: The name of BoD, if not specified, it will return the counters from all the BoDs.
I

<QueryOmStats>
< PcmmBodGateReportStats >
</ PcmmBodGateReportStats >
</QueryOmStats>
Response
The response to this request follows the Statistics > PcmmBodGateReportStats tag defined in the
XSDs.
• TotalGateReport -- Number of Gate Status messages processed.
E71645 Revision 01, June 2016 268

• UnmatchGateReport: Number of mismatch gate report message.

• ProcessedGateReport: Number of gate report processed successfully.
The following is an example XML response to a PcmmBodGateReportStats tag request:

<Statistics>
<PcmmBodGateStats>
<Sample>
<Name>1</Name>
<TotalGateReport>5</TotalGateReport>
<UnmatchedGateReport>1</UnmatchedGateReport>
<IgnoredGateReport>3</IgnoredGateReport>
<ProcessedGateReport>1</ProcessedGateReport>
</Sample>
</PcmmBodGateStats>
</Statistics>
PCMM CMTS Statistics

PcmmCmtsStats tag.
Request
This request follows the QueryOmStats > PcmmCmtsStats tag defined in the XSDs.

<QueryOmStats>
<PcmmCmtsStats></PcmmCmtsStats>
</QueryOmStats>
Response
The response to this request follows the Statistics > PcmmCmtsStats tag defined in the XSDs.
• SessionCount: The number of session requests received.
• SessionSuccessCount: The number of session requests successfully created.
• SessionFailCount: The number of session request failures. For example, this could be due to a policy
denying a request.
• SessionProtocolFailCount: The number of session failures due to an invalid message or parameter.
has an invalid message and as a result the message has to be dropped by the MPE.
• SessionPolicyFailCount: The number of session requests that trigger a policy. This count is
maintained in the MPE, one per policy. When the condition of a policy triggers, the count for that
policy is incremented. The value displayed is a total trigger count, (that is, the sum of this value
for all the policies). For example, if the definition of a policy is defined as, “when the device usage
E71645 Revision 01, June 2016 269

is greater than 80% of capacity, reject message”. When the MPE executes this policy in response to
a request, if the policy triggers (that is, if the MPE determines that the device usage is > 80%), the
trigger count for that policy is incremented.
The following is an example XML response to a PcmmCmtsStats tag request:

<Statistics>
<PcmmCmtsStats>
<Sample>
</Sample>
</PcmmCmtsStats>
</Statistics>
PCMM CTMS Gate Statistics

PcmmCmtsGateStats tag.
Request
This request follows the QueryOmStats > PcmmCmtsGateStats tag defined in the XSDs.
Note: If both the BodServer and Name parameter values are specified together, OSSI will return
statistic counters from the MPE and application identity specified only.

<QueryOmStats>
< PcmmCmtsGateStats >
<Name>CMTS-1</Name>
</ PcmmCmtsGateStats >
</QueryOmStats>
Response
The response to this request follows the Statistics > PcmmAmGateStats tag defined in the XSDs.
• PolicyServer: The name of MPE server.
• MessagesInCount -- Number of Gate messages received.
• MessagesOutCount: Number of Gate messages sent.
E71645 Revision 01, June 2016 270

• GateSetCount: Number of Gate Set messages received.

• GateInfoCount: Number of Gate Info messages received.
• GateDeleteCount: Number of Gate Delete messages received.
• ReportCount— Number of Gate Report messages processed.
• DropCount: Number of Gate Report messages ignored.

<Statistics>
<PcmmCmtsGateStats>
<Sample>
<Name>CMTS-1</Name>
<DisconnectTime>Thu Jan 24 09:30:21 EST 2013</DisconnectTime>
<ConnectCount>0</ConnectCount>
<ActiveGateCount>0</ActiveGateCount>
</Sample>
</PcmmCmtsGateStats>
</Statistics>
PCMM Network Element Statistics

PcmmNetworkElementStats tag.
Request
E71645 Revision 01, June 2016 271

This request follows the QueryOmStats > PcmmNetworkElementStats tag defined in the XSDs.
The following is an example of a request for a single PCMM network element using the Name
parameter:

<QueryOmStats>
<PcmmNetworkElementStats>
</PcmmNetworkElementStats>
</QueryOmStats>
The following is an example of a request for multiple PCMM network elements using the Name(s)
and NeId(s) parameters. This example returns statistics for three different network elements:

<QueryOmStats>
</QueryOmStats>
The following is an example of a request for all PCMM network elements in the system. This example
returns statistics for each PCMM network element:

<QueryOmStats>
<PcmmNetworkElementStats></PcmmNetworkElementStats>
</QueryOmStats>
Response
The response to this request follows the Statistics > PcmmNetworkElementStats tag defined in the
XSDs.
Sample groups are ordered by policy server, network element, available interface, and then by time.
• Name: Unique name identifying the network element for the following statistics.
• NeId: Optional identifier field for the network element.
• InterfaceName: Identifying field for the network element’s Interface.
• SessionCount: Current active sessions for that network element or Interface. This is a
non-cumulative value and is displayed as an absolute.
• Capacity: The currently defined, maximum capacity for this network element or Interface. This
E71645 Revision 01, June 2016 272


<Statistics>
<Sample>
<NeId>12345</NeId>
</Sample>
<Sample>
<NeId>12345</NeId>
</Sample>
</Statistics>
PCMM Connection Error Statistics

ConnectionErrorStats tag.
Request
This request follows the QueryOmStats > ConnectionErrorStats tag defined in the XSDs.
The following is an example of a request for all connection error statistics:

<ConnectionErrorStats>
<Name>123</Name>
</ConnectionErrorStats>
</QueryOmStats>
Response
The response to this request follows the Statistics > ConnectionErrorStats tag defined in the XSDs.
E71645 Revision 01, June 2016 273

E71645 Revision 01, June 2016 274


reasons.
message length.
supported.
The following is an example of the ConnectionErrorStats tag:

<Statistics>
<Sample>
<Name>123</Name>
E71645 Revision 01, June 2016 275

<NeId></NeId>
RejectedReceived>
<DiameterAuthenticationRejectedSent>0</DiameterAuthenticationRejectedSent>
DeniedReceived>
ApplicableReceived>
ApplicableSent>
RejectedReceived>
<DiameterAvpOccursTooManyTimesReceived>0</DiameterAvpOccursToo
ManyTimesReceived>
<DiameterNoCommonApplicationReceived>0</DiameterNoCommon
E71645 Revision 01, June 2016 276

ApplicationReceived>
<DiameterInvalidMessageLengthReceived>0</DiameterInvalidMessage
LengthReceived>
ParametersReceived>
RemovedReceived>
ProhibitedReceived>
ProhibitedSent>
E71645 Revision 01, June 2016 277

UnsupportedSent>
</Sample>
</Statistics>
Connection Error Statistics for PCMM AMID

Request
The following is an example of a request for connection error statistics for PCMM AMID:

<Name>1</Name>
</QueryOmStats>
Response
The following is an example of the ConnectionErrorStats tag specifically for PMCC AMID:

<Statistics>
<Sample>
<Name>1</Name>
<NeId>1</NeId>
<PcmmInvalidsubscriberReceived>0</PcmmInvalidsubscriberReceived>
<PcmmInvalidsubscriberSent>0</PcmmInvalidsubscriberSent>
</Sample>
E71645 Revision 01, June 2016 278

</Statistics>
BoD Interface Operational Measurements

• HTTP BOD Statistics
• SOAP BOD Statistics
HTTP BOD Statistics

HttpBodStats tag.
Request
This request follows the QueryOmStats > HttpBodStats tag defined in the XSDs.
BoDs.

<QueryOmStats>
< HttpBodStats >
<BodServer>BOD1</BodServer>
</ HttpBodStats >
</QueryOmStats>
Response
The response to this request follows the Statistics > HttpBodStats tag defined in the XSDs.
• TotalCreateSessionRequest: Number of create session request messages received.
• TotalModifySessionRequest: Number of modify session request messages received.
• TotalDeleteSessionRequest: Number of delete session request messages received.
• TotalAddClassifierRequest: Number of add classifier request messages received.
• TotalModifyClassifierRequest: Number of modify classifier request messages received.
• TotalDeleteClassifierRequest: Number of delete classifier request messages received.
• TotalCreateSessionSuccessResponse: Number of success responses for create session request.
• TotalModifySessionSuccessResponse: Number of success responses for modify session request.
• TotalDeleteSessionSuccessResponse: Number of success responses for delete session request.
• TotalAddClassifierSuccessResponse: Number of success responses for add classifier request.
E71645 Revision 01, June 2016 279

• TotalModifyClassifierSuccessResponse: Number of success responses for modify classifier request.

• TotalDeleteClassifierSuccessResponse: Number of success responses for delete classifier request.
• TotalCreateSessionFailureResponse: Number of failure responses for create session request.
• TotalModifySessionFailureResponse: Number of failure responses for modify session request.
• TotalDeleteSessionFailureResponse: Number of failure responses for delete session request.
• TotalAddClassifierFailureResponse: Number of failure responses for add classifier request.
• TotalModifyClassifierFailureResponse: Number of failure responses for modify classifier request.
• TotalDeleteClassifierFailureResponse: Number of failure responses for delete classifier request.
• TotalSuccessResponse: Number of success response sent.
• TotalFailureResponse: Number of failure response sent.
• TotalResponse: Number of response sent.
• TotalQuerySession: Number of query session requests received.
The following is an example XML response to a HttpBodStats tag request:

<Statistics>
<HttpBodStats>
<Sample>
<TotalCreateSessionRequest>0</TotalCreateSessionRequest>
<TotalModifySessionRequest>0</TotalModifySessionRequest>
<TotalDeleteSessionRequest>0</TotalDeleteSessionRequest>
<TotalAddClassifierRequest>0</TotalAddClassifierRequest>
<TotalModifyClassifierRequest>0</TotalModifyClassifierRequest>
<TotalDeleteClassifierRequest>0</TotalDeleteClassifierRequest>
<TotalCreateSessionSuccessResponse>0</TotalCreateSessionSuccessResponse>
<TotalModifySessionSuccessResponse>0</TotalModifySessionSuccessResponse>
<TotalDeleteSessionSuccessResponse>0</TotalDeleteSessionSuccessResponse>
<TotalAddClassifierSuccessResponse>0</TotalAddClassifierSuccessResponse>
<TotalDeleteClassifierSuccessResponse>0</
TotalDeleteClassifierSuccessResponse>
<TotalModifyClassifierSuccessResponse>0</
TotalModifyClassifierSuccessResponse>
<TotalCreateSessionFailureResponse>0</
TotalCreateSessionFailureResponse>
<TotalModifySessionFailureResponse>0</TotalModifySessionFailureResponse>
<TotalDeleteSessionFailureResponse>0</
TotalDeleteSessionFailureResponse>
<TotalAddClassifierFailureResponse>0</
TotalAddClassifierFailureResponse>
<TotalDeleteClassifierFailureResponse>0</
TotalDeleteClassifierFailureResponse>
<TotalModifyClassifierFailureResponse>0</
TotalModifyClassifierFailureResponse>
<TotalSuccessResponse>0</ TotalSuccessResponse>
<TotalFailureResponse>0</ TotalFailureResponse>
<TotalResponse>0</ TotalResponse>
<SetMacTranslator>0</ SetMacTranslator>
<TotalQuerySession>0</ TotalQuerySession>
E71645 Revision 01, June 2016 280

</Sample>
</HttpBodStats>
</Statistics>
SOAP BOD Statistics

SoapBodStats tag.
Request
This request follows the QueryOmStats > SoapBodStats tag defined in the XSDs.
BoDs.

<QueryOmStats>
< SoapBodStats>
</ SoapBodStats>
</QueryOmStats>
Response
The response to this request follows the Statistics > SoapBodStats tag defined in the XSDs.
• TotalCreateSessionRequest: Number of create session request messages received.
• TotalModifySessionRequest: Number of modify session request messages received.
• TotalDeleteSessionRequest: Number of delete session request messages received.
• TotalAddClassifierRequest: Number of add classifier request messages received.
• TotalModifyClassifierRequest: Number of modify classifier request messages received.
• TotalDeleteClassifierRequest: Number of delete classifier request messages received.
• TotalCreateSessionSuccessResponse: Number of success responses for create session request.
• TotalModifySessionSuccessResponse: Number of success responses for modify session request.
• TotalDeleteSessionSuccessResponse: Number of success responses for delete session request.
• TotalAddClassifierSuccessResponse: Number of success responses for add classifier request.
• TotalModifyClassifierSuccessResponse: Number of success responses for modify classifier request.
• TotalDeleteClassifierSuccessResponse: Number of success responses for delete classifier request.
• TotalCreateSessionFailureResponse: Number of failure responses for create session request.
• TotalModifySessionFailureResponse: Number of failure responses for modify session request.
• TotalDeleteSessionFailureResponse: Number of failure responses for delete session request.
• TotalAddClassifierFailureResponse: Number of failure responses for add classifier request.
• TotalModifyClassifierFailureResponse: Number of failure responses for modify classifier request.
• TotalDeleteClassifierFailureResponse: Number of failure responses for delete classifier request.
E71645 Revision 01, June 2016 281

• TotalSuccessResponse: Number of success response sent.

• TotalFailureResponse: Number of failure response sent.
• TotalResponse: Number of response sent.
• TotalQuerySession: Number of query session requests received.
The following is an example XML response to a HttpBodStats tag request:

<Statistics>
<SoapBodStats>
<Sample>
<TotalCreateSessionRequest>0</TotalCreateSessionRequest>
<TotalModifySessionRequest>0</TotalModifySessionRequest>
<TotalDeleteSessionRequest>0</TotalDeleteSessionRequest>
<TotalAddClassifierRequest>0</TotalAddClassifierRequest>
<TotalModifyClassifierRequest>0</TotalModifyClassifierRequest>
<TotalDeleteClassifierRequest>0</TotalDeleteClassifierRequest>
<TotalCreateSessionSuccessResponse>0</TotalCreateSessionSuccessResponse>
<TotalModifySessionSuccessResponse>0</TotalModifySessionSuccessResponse>
<TotalDeleteSessionSuccessResponse>0</TotalDeleteSessionSuccessResponse>
<TotalAddClassifierSuccessResponse>0</TotalAddClassifierSuccessResponse>
<TotalDeleteClassifierSuccessResponse>0</
TotalDeleteClassifierSuccessResponse>
<TotalModifyClassifierSuccessResponse>0</
TotalModifyClassifierSuccessResponse>
<TotalCreateSessionFailureResponse>0</
TotalCreateSessionFailureResponse>
<TotalModifySessionFailureResponse>0</TotalModifySessionFailureResponse>
<TotalDeleteSessionFailureResponse>0</
TotalDeleteSessionFailureResponse>
<TotalAddClassifierFailureResponse>0</
TotalAddClassifierFailureResponse>
<TotalDeleteClassifierFailureResponse>0</
TotalDeleteClassifierFailureResponse>
<TotalModifyClassifierFailureResponse>0</
TotalModifyClassifierFailureResponse>
<TotalSuccessResponse>0</ TotalSuccessResponse>
<TotalFailureResponse>0</ TotalFailureResponse>
<TotalResponse>0</ TotalResponse>
<SetMacTranslator>0</ SetMacTranslator>
<TotalQuerySession>0</ TotalQuerySession>
</Sample>
</SoapBodStats>
</Statistics>
CMTS Re-discovery Operational Measurement Requests

This section shows requests and responses for:
E71645 Revision 01, June 2016 282

• CMTS Re-discovery Query Network Element

• CMTS Re-discovery Add Network Element Interface
• CMTS Re-discovery Update Network Element Interface
CMTS Re-discovery Query Network Element

Request

<QueryNetworkElement Rediscovery="yes" DistributeImmediately=”yes”>
<Name>CMTS-27-1</Name>
Response
The response to this request follows the ConfiguratonData > NetworkElement tag defined in the
XSDs.
<NetworkElement>
<Description/>
<BackupHostName/>
<ReadCommunity>public</ReadCommunity>
<X>0</X>
<Y>0</Y>
<ManualSubnet>
<Mask>24</Mask>
</ManualSubnet>
<LearnedSubnet>
<Mask>24</Mask>
</LearnedSubnet>
<LearnedSubnet>
<Mask>24</Mask>
</LearnedSubnet>
<LearnedSubnet>
<Mask>24</Mask>
</LearnedSubnet>
E71645 Revision 01, June 2016 283

<LearnedSubnet>
<Mask>24</Mask>
</LearnedSubnet>
<LearnedSubnet>
<Mask>24</Mask>
</LearnedSubnet>
<LearnedSubnet>
<Mask>24</Mask>
</LearnedSubnet>
CMTS Re-discovery Add Network Element Interface

Request

<AddNetworkElement Rediscovery="yes" DistributeImmediately="yes">
<NetworkElement>
<Name>CMTS_public</Name>
<ReadCommunity>public</ReadCommunity>
<X>0</X>
<Y>0</Y>
</NetworkElement>
Request
The response to this request follows the Command > NetworkElement tag defined in the XSDs.

<Response>
<Result>0</Result>
<Success count="2">Successfully imported 1 network element(s).
Successfully to rediscover 1 CMTS(s).</Success>

E71645 Revision 01, June 2016 284

</Command>
</Response>
CMTS Re-discovery Update Network Element Interface

Request

<UpdateNetworkElement Rediscovery="yes" DistributeImmediately="yes">
<NetworkElement>
<Name>CMTS_public</Name>
<ReadCommunity>public1</ReadCommunity>
<X>0</X>
<Y>0</Y>
</NetworkElement>
Response
The response to this request follows the Command > UpdateNetworkElement tag defined in the
XSDs.

<Response>
<Result>0</Result>
<Success count="1">Successfully updated 1 network element(s).</Success>
<Failure count="1">Failed to rediscover 1 CMTS(s).</Failure>

</Command>
</Response>
DQos Operational Measurements Requests

• DQos CMTS Statistics
• DQos Network Element Statistics
E71645 Revision 01, June 2016 285

DQos CMTS Statistics

DqosCmtsStats tag.
Request
This request follows the QueryOmStats > DqosCmtsStats tag defined in the XSDs.

<QueryOmStats>
<DqosCmtsStats/>
</QueryOmStats>
Response
The response to this request follows the Statistics > DqosCmtsStats tag defined in the XSDs.
• SessionCount: The number of session requests received.
• SessionSuccessCount: The number of session requests successfully created.
• SessionFailCount: The number of session request failures. For example, this could be due to a policy
denying a request.
• SessionProtocolFailCount: The number of session failures due to an invalid message or parameter.
has an invalid message and as a result, the message has to be dropped by the MPE.
• SessionPolicyFailCount: The number of session requests that trigger a policy. This count is
maintained in the MPE, one per policy. When the condition of a policy triggers, the count for that
policy is incremented. The value displayed is a total trigger count, (that is, the sum of this value
for all the policies). For example, if the definition of a policy is defined as, “when the device usage
is greater than 80% of capacity, reject message”. When the MPE executes this policy in response to
a request, if the policy triggers (that is, if the MPE determines that the device usage is > 80%), the
trigger count for that policy is incremented.
The following is an example XML response to a DqosCmtsStats tag request:

<Statistics>
<DqosCmtsStats>
<Sample>
</Sample>
</DqosCmtsStats>
</Statistics>
E71645 Revision 01, June 2016 286

DQos Network Element Statistics

DqosNetworkElementStats tag.
Request
This request follows the QueryOmStats > DqosNetworkElementStats tag defined in the XSDs.
The following is an example of a request for a single DQoS network element using the Name parameter:

<QueryOmStats>
<DqosNetworkElementStats>
</DqosNetworkElementStats>
</QueryOmStats>
The following is an example of a request for all DQoS network elements in the system. This example
returns statistics for each DQoS network element:

<QueryOmStats>
<DqosNetworkElementStats></DqosNetworkElementStats>
</QueryOmStats>
Response
The response to this request follows the Statistics > DqosNetworkElementStats tag defined in the
XSDs.
Sample groups are ordered by policy server, network element, available interface, and then by time.
• Name: Unique name identifying the network element for the following statistics.
• NeId: Optional identifier field for the network element.
• InterfaceName: Identifying field for the network element’s Interface.
• SessionCount: Current active sessions for that network element or Interface. This is a
non-cumulative value and is displayed as an absolute.
• Capacity: The currently defined, maximum capacity for this network element or Interface. This

<Statistics>
<DqosNetworkElementStats>
E71645 Revision 01, June 2016 287

<Sample>
<NeId>12345</NeId>
</Sample>
<Sample>
<NeId>12345</NeId>
</Sample>
</DqosNetworkElementStats>
</Statistics>
Traffic Profile Statistics

TrafficProfileStats tag.
Request
This request follows the QueryOmStats > TrafficProfileStats tag defined in the XSDs.

<QueryOmStats>
</QueryOmStats>
Response
The response to this request follows the Statistics > TrafficProfileStats tag defined in the XSDs.

<Statistics>
<Sample>
E71645 Revision 01, June 2016 288

<NumberOfTimesInstalledAttemps>0</NumberOfTimesInstalledAttemps>
<NumberOfTimesRemovedByPCRF>0</NumberOfTimesRemovedByPCRF>
<NumberOfTimesFailedOrRemovedByGateway>0</NumberOfTimesFailedOrRemovedByGateway>
Individual statistics are defined for Traffic Profiles as follows:

• Install Attempt: COUNTER which tracks the number of times the PCRF attempts to install a specific
Traffic Profile.
• Removed by PCRF: COUNTER which tracks the number of times the PCRF initiates the removal
of a specific Traffic Profile.
• Failed or Removed by Gateway: COUNTER which tracks the number of times specific Traffic
Profiles fail to install on the gateway, and the number of times the gateway removes a rule without
PCRF approval.
• NumberOfTimesTotalRetryAttempts: The total number of retry attempts taken to successfully
install the rule.
• NumberOfTimesRetryCycles: The number of Retry Cycles taken to successfully install the PCC/ADC
rule for which retry mechanism was started.
• NumberOfTimesFailedAfterMaxRetryCycles: The number of times a PCC/ADC rule failed to be
installed after trying for max number of retries
Protocol Error Statistics

ProtocolErrorStats tag.
Request
This request follows the QueryOmStats > ProtocolErrorStats tag defined in the XSDs.

</QueryOmStats>
Response
The response to this request follows the Statistics > ProtocolErrorStats tag defined in the XSDs.
E71645 Revision 01, June 2016 289

E71645 Revision 01, June 2016 290


reasons.
message length.
• RadiusRequestNotRoutable - The request cannot be routed.
supported.

<Statistics>
<Sample>
E71645 Revision 01, June 2016 291

RejectedReceived>
RejectedSent>
DeniedReceived>
ApplicableReceived>
ApplicableSent>
RejectedReceived>
TimesReceived>
E71645 Revision 01, June 2016 292

ParametersReceived>
RemovedReceived>
ProhibitedReceived>
ProhibitedSent>
E71645 Revision 01, June 2016 293

UnsupportedSent>
</Sample>
</Statistics>
PCMM Connection Error Statistics

Request
The following is an example of a request for all connection error statistics:

<Name>123</Name>
</QueryOmStats>
Response
E71645 Revision 01, June 2016 294


reasons.
message length.
E71645 Revision 01, June 2016 295


supported.
The following is an example of the ConnectionErrorStats tag:

<Statistics>
<Sample>
<Name>123</Name>
<NeId></NeId>
E71645 Revision 01, June 2016 296

RejectedReceived>
<DiameterAuthenticationRejectedSent>0</DiameterAuthenticationRejectedSent>
DeniedReceived>
ApplicableReceived>
ApplicableSent>
RejectedReceived>
<DiameterAvpOccursTooManyTimesReceived>0</DiameterAvpOccursToo
ManyTimesReceived>
<DiameterNoCommonApplicationReceived>0</DiameterNoCommon
ApplicationReceived>
<DiameterInvalidMessageLengthReceived>0</DiameterInvalidMessage
LengthReceived>
E71645 Revision 01, June 2016 297

ParametersReceived>
RemovedReceived>
ProhibitedReceived>
ProhibitedSent>
UnsupportedSent>
</Sample>
</Statistics>
E71645 Revision 01, June 2016 298

MPE/BOD Replication Statistics

ReplicationStats tag.
Request
This request follows the QueryOmStats > ReplicationStats tag defined in the XSDs.
The following is an example of a request for all MPE/BOD replication statistics:
Note: The request must contain the BOD or Policy Server name configured in the CMP.

<ReplicationStats>
<BodServer>bod73</BodServer>
</ReplicationStats>
</QueryOmStats>
Response
The response to this request follows the Statistics > RepicationStats tag defined in the XSDs.
• BoD Server - The name of the BoD server.
• Blade Host Name - The name of the blade on the host server.
• Peer Host Name - Name of the server delegated as a peer.
• Total Sent KB - The total number of packets sent measured in kilobytes.
• Average Sent KB - The average number of packets sent measured in kilobytes.
• Peak Sent KB - The peak number of packets sent measured in kilobytes.
• Total Received KB The total number of packets received measured in kilobytes.
• Average Received KB - The average number of packets received measured in kilobytes.
• Peak Received KB - The peak number of packets received measured in kilobytes.
The following is an example of the ReplicationStats tag:

<Statistics>
<ReplicationStats>
<Sample>
<BladeHostName>kli-bod-25-73</BladeHostName>
<PeerHostName>kli-bod-25-81</PeerHostName>
E71645 Revision 01, June 2016 299

</Sample>
<Sample>
</Sample>
<Sample>
</Sample>
<Sample>
</Sample>
</ReplicationStats>
</Statistics>
Field Mapping Profile Queries

Field mapping profile queries enable the system to differentiate between SPR and BOSS systems.
Mediation Field Mapping Profile Statistics

FieldMappingProfile tag.
Request
This request follows the QueryOmStats > FieldMappingProfile tag defined in the XSDs.
E71645 Revision 01, June 2016 300

The following is an example of a request for statistics for Mediation Field Mapping Profile:

<QueryFieldMappingProfile>
<Name>XX</Name>
</QueryFieldMappingProfile>
Response
The response to this request follows the Statistics > FieldMappingProfile tag defined in the XSDs.
The following is an example of the FieldMappingProfile tag:

<FieldMappingProfile>
<Name>XX</Name>
<MappingType>2</MappingType>
<SoapFieldName>XX</SoapFieldName>
<SprFieldName>XX</SprFieldName>
<Sequence>0</Sequence>
<DataType>0</DataType>
<Mandatory>false</Mandatory>
<DefaultValue></DefaultValue>
<ValidationRules></ValidationRules>
</FieldMappingProfile>
Mediation - Add Field Mapping Profile

AddFieldMappingProfile tag.
Request
This request follows the QueryOmStats > AddFieldMappingProfile tag defined in the XSDs.
The following is an example of a request for statistics for adding a Mediation Field Mapping Profile:

<AddFieldMappingProfile>
<Name>XX</Name>
E71645 Revision 01, June 2016 301

</AddFieldMappingProfile>
Response
The response to this request follows the Statistics > AddFieldMappingProfile tag defined in the
XSDs.
The following is an example of the AddFieldMappingProfile tag:

<Response>
<Result>0</Result>
<Success count="1">Successfully updated 1 match list(s).</Success>
</Command>
</Response>
Mediation - Update Field Mapping Profile

UpdateFieldMappingProfile tag.
Request
This request follows the QueryOmStats > UpdateFieldMappingProfile tag defined in the XSDs.
The following is an example of a request for statistics for updating a Mediation Field Mapping Profile:

<UpdateFieldMappingProfile>
<Name>XX</Name>
</UpdateFieldMappingProfile>
Response
The response to this request follows the Statistics > UpdateFieldMappingProfile tag defined in the
XSDs.
The following is an example of the UpdateFieldMappingProfile tag:
E71645 Revision 01, June 2016 302

<Response>
<Result>0</Result>
<Success count="1">Successfully updated 1 match list(s).</Success>
</Command>
</Response>
Mediation - Delete Field Mapping Profile

DeleteFieldMappingProfile tag.
Request
This request follows the QueryOmStats > DeleteFieldMappingProfile tag defined in the XSDs.
The following is an example of a request for statistics for deleting a Mediation Field Mapping Profile:

<DeleteFieldMappingProfile>
<Name>XX</Name>
</DeleteFieldMappingProfile>
Response
The response to this request follows the Statistics > DeleteFieldMappingProfile tag defined in the
XSDs.
The following is an example of the DeleteFieldMappingProfile tag:

<Response>
<Result>0</Result>
<Success count="1">Deleted 1 Mediation Field Mapping Profiles.</Success>
</Command>
</Response>
E71645 Revision 01, June 2016 303

Oracle Communications Policy Management: OSSI XML Interface Definitions Reference Release 12.1.2

Uploaded by

Copyright:

Available Formats

Oracle Communications Policy Management: OSSI XML Interface Definitions Reference Release 12.1.2

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Oracle Communications Policy Management: OSSI XML Interface Definitions Reference Release 12.1.2

Uploaded by

Copyright:

Available Formats

Oracle® Communications

Part I: Introductory Information...............................................................11

Chapter 1: About This Guide............................................................12

Part II: Functionality Used in both Wireless and Cable Modes.........17

Chapter 1: Schema Definitions and Request Specifications......18

Chapter 2: Common Responses and Commands..........................21

E71645 Revision 01, June 2016 iii

Chapter 3: Operational Measurements Interface Overview.......27

Chapter 4: Identity Management (IDM).........................................35

Chapter 5: Policy Table Interface.....................................................52

Part III: Wireless Mode...............................................................................56

Chapter 1: Topology Interface for Wireless Mode........................57

E71645 Revision 01, June 2016 iv

E71645 Revision 01, June 2016 v

Chapter 2: Subscriber Interface for Wireless Mode.....................96

Chapter 3: Operational Measurement Requests for Wireless

E71645 Revision 01, June 2016 vi

Part IV: Cable Mode..................................................................................217

Chapter 1: Topology Interface for Cable Mode...........................218

E71645 Revision 01, June 2016 vii

Chapter 2: Subscriber Interface for Cable Mode.........................228

Chapter 3: Operational Measurement Requests for Cable

E71645 Revision 01, June 2016 viii

E71645 Revision 01, June 2016 ix

E71645 Revision 01, June 2016 x

Topics: This section of the OSSI (Operation Support System

E71645 Revision 01, June 2016 11

Topics: This chapter contains an overview of this guide,

E71645 Revision 01, June 2016 12

Scope and Audience

How This Guide is Organized

E71645 Revision 01, June 2016 13

E71645 Revision 01, June 2016 14

Locate Product Documentation on the Oracle Help Center Site

My Oracle Support (MOS)

E71645 Revision 01, June 2016 15

E71645 Revision 01, June 2016 16

Topics: This section is divided into specific chapters that

E71645 Revision 01, June 2016 17

Topics: This chapter provides detailed information on

E71645 Revision 01, June 2016 18

> wget --post-file=input.xml --output-document=output.xml

Where the following describes each parameter:

E71645 Revision 01, June 2016 19

• http://1.2.3.4/mi/ xmlInterfaceRequest.do ?user=test&pwd=test (Required) —

E71645 Revision 01, June 2016 20

Topics: This chapter describes the generic response format

E71645 Revision 01, June 2016 21

Example XML Response for a Successful Operation

<?xml version="1.0" ?>

<?xml version="1.0" ?>

Example XML Response for an Operation that Includes an Application-level Failure

<?xml version="1.0" ?>

E71645 Revision 01, June 2016 22

E71645 Revision 01, June 2016 23

<?xml version="1.0" encoding="UTF-8" ?>

<?xml version="1.0" ?>

<?xml version="1.0" encoding="UTF-8" ?>

<?xml version="1.0" encoding="UTF-8" ?>