CiscoSlaMonitor.idl

CiscoSlaMonitor::AggregateConnectivityCollection
CiscoSlaMonitor::AggregateJitterDataCollection
CiscoSlaMonitor::AggregateStatsCollection
CiscoSlaMonitor::AggregateThresholdCollection
CiscoSlaMonitor::AllStatsCollection
CiscoSlaMonitor::SAABucketCollection
CiscoSlaMonitor::SAADataSet
CiscoSlaMonitor::SAADataSetCollection
CiscoSlaMonitor::SAAEntryCollection
CiscoSlaMonitor::SAARouter
CiscoSlaMonitor::SAARouterCollection
CiscoSlaMonitor::Sla
CiscoSlaMonitor::SlaBrowser
CiscoSlaMonitor::SlaInfoCollection
CiscoSlaMonitor::SpecificStatsCollection

Module CiscoSlaMonitor

Data Structures and Types

AggregateConnectivity Structure

SLA connectivity results for an aggregation. Instead of the details in AllStats, this is a more compact result for specific need.

An example would be to get aggregated connectivity % per customer or per VPN or per source router. The set of SLA objects over which the aggregation needs to be performed is first determined based on some criteria.

A string representing the aggregate object is also maintained in AggregateConnectivity for the client to identify. For example, if the results are aggregated by Customer, the customer name is saved in each struct in the 'aggregateTag' field.

One of the aggregation could be just plain over each SLA. In that case, the aggregateTag will contain the SLA id. The id is unique for each SLA. An SLA is uniquely distinguished by its key fields. They are, Customer Name, Source and Destination address, Protocol, Request Size, Threshold.

The aggregated stats are further compiled into time based bins, depending upon the TimeInterval argument. For example the request is to get aggregated connectivity statistics per week over the last six weeks. The stats over the time line are maintained as a PercentageSeq object in the AggregateConnectivity struct.

Usage

struct AggregateConnectivity
{
AggregateName aggregateTag
SpecificStatsSeq connectivity

};

Members

aggregateTag---AggregateName A string identifying the aggregate that this data represents.

connectivity---SpecificStatsSeq sequence of SpecificStatsSeq structs representing percent connectivity for the various time intervals contained in the time range.

See Also

AggregateStats AggregateThreshold

AggregateConnectivitySeq User Defined Type

A sequence of AggregateConnectivity struct.

Usage

typedef sequence<AggregateConnectivity> AggregateConnectivitySeq

AggregateJitterData Structure

SLA statistics over period of time. The values are computed for a group of Jitter SLA.

Usage

struct AggregateJitterData
{
AggregateName aggregateTag
AllJitterDataSeq bins

};

Members

aggregateTag---AggregateName A string identifying the aggregate that this data represents.

bins---AllJitterDataSeq a sequence of all the jitter stats.

AggregateJitterDataSeq User Defined Type

A sequence of AggregateJitterData struct.

Usage

typedef sequence<AggregateJitterData> AggregateJitterDataSeq

AggregateName User Defined Type

The value of the aggregate attribute on which the aggregated statistics are being computed. For example, if the request for statistics defines the Aggregation to be by Customer, then the AggregateName will be the name of the customer.

Usage

typedef string AggregateName

AggregateStats Structure

SLA results for an aggregation. The values are computed for a group of SLA. Given a set of SLA objects and their performance data over a period of time, the combined SLA performance results are maintained in this object.

An example would be to get aggregated SLA performance per customer or per VPN or per source router. The set of SLA objects over which the aggregation needs to be performed is first determined based on some criteria.

A string representing the aggregate object is also maintained in AggregateStats for the client to identify. For example, if the results are aggregated by Customer, the customer name is saved in each struct in the 'aggregateTag' field.

The aggregated stats are further compiled into time based bins. For example you want the same aggregated statistics per week over the last six weeks. The stats over the time line are maintained as a collection of stat objects in the AggregateStats object.

AggregateStats contains the minimal set of data values to describe the SLA performance. Based upon the data values in the SLA result, various other values can be computed.

Usage

struct AggregateStats
{
AggregateName aggregateTag
AllStatsSeq bins

};

Members

aggregateTag---AggregateName A string identifying the aggregate that this data represents.

bins---AllStatsSeq sequence of AllStats struct for the varioustime intervals contained in the time range.

See Also

AggregateConnectivity

AggregateStatsSeq User Defined Type

A sequence of AggregateStats struct.

Usage

typedef sequence<AggregateStats> AggregateStatsSeq

AggregateThreshold Structure

SLA threshold results for an aggregation. Instead of the details in AllStats, this is a more compact result for the specific threshold need.

An example would be to get aggregated threshold violation % per customer or per VPN or per source router. The set of SLA objects over which the aggregation needs to be performed is first determined based on some user selected criteria.

A AggregateName is also maintained in AggregateThreshold for the client to identify. For example, if the results are aggregated by Customer, the customer name is saved in each struct in the 'aggregateTag' field.

The aggregated stats are further compiled into time based bins, depending upon the TimeInterval argument. For example the request is to get aggregated threshold violation statistics per week over the last six weeks. The stats over the time line are maintained as a PercentageSeq object in the AggregateThreshold struct.

Usage

struct AggregateThreshold
{
AggregateName aggregateTag
SpecificStatsSeq threshold

};

Members

aggregateTag---AggregateName A string identifying the aggregate that this data represents.

threshold---SpecificStatsSeq sequence of SpecificStatsSeq structs representing percent threshold for the various time intervals contained in the time range.

See Also

AggregateStats AggregateConnectivity

AggregateThresholdSeq User Defined Type

A sequence of AggregateThreshold struct.

Usage

typedef sequence<AggregateThreshold> AggregateThresholdSeq

Aggregation Enumerated Type

Defines the various aggregation schemes. The SLA statistics can be combined over these schemes to provide a composite result to the client application. The SLA server optimizes the data structures to provide a quick response, as opposed to each application extracting their results from raw SAA data sets.

Usage

enum Aggregation
{
Unspecified,
Id,
Customer,
Vpn,
SourceRouter,
DestinationRouter

};

Enumerators

Unspecified The statistics are aggregated only over the time scale. Id Keep the statistics per SLA based on the unique SLA id.

Customer Combine the SLA statistics by each unique customer.

Vpn Combine the SLA statistics by each unique VPN.

SourceRouter Combine the SLA statistics by each source router on which the SLA is programmed.

DestinationRouter Combine the SLA statistics by each destination router of an SLA.

AllJitterData Structure

Statistics for a Jitter SLA. The result is obtained over a particular set of collected data sets. Typically the datasets are combined for a contiguous time period. For example, all collected data about SLA performance in the past week.

But that is not always the case. The client may want to obtain results for every Monday over the last six months. Or look at results during 9 to 5 every day.

AllJitterData contains the full set of data values to describe a Jitter SLA performance. Based upon the data values in the SLA result, various other values can be computed.

Usage

struct AllJitterData
{
TimeStamp timeStamp
JitterData jitterData

};

Members

timeStamp---TimeStamp the start time of the set of data, the user should know what is the TimeInterval of the data (daily, hourly etc).

jitterData---JitterData the set of data values measured by Voice jitter SLA.

AllJitterDataSeq User Defined Type

A Sequence of AllJitterData struct.

Usage

typedef sequence<AllJitterData> AllJitterDataSeq

AllStats Structure

Statistics for an SLA. The result is obtained over a particular set of collected data sets. Typically the datasets are combined for a contiguous time period. For example, all collected data about SLA performance in the past week.

But that is not always the case. The client may want to obtain results for every Monday over the last six months. Or look at results during 9 to 5 every day.

AllStats contains the minimal set of data values to describe an SLA performance. Based upon the data values in the SLA result, various other values can be computed.

Usage

struct AllStats
{
TimeStamp timeStamp
NumberConnections numConnections
NumberTimeouts numTimeouts
Percentage percentConnectivity
Percentage percentThreshold
Delay minDelay
Delay maxDelay
Delay avgDelay
Delay stdDev
HttpStatsSeq httpStats
JitterStatsSeq jitterStats

};

Members

timeStamp---TimeStamp the start time of the set of data, the user should know what is the TimeInterval of the data (daily, hourly etc). numConnections---NumberConnections total # of connections.

numTimeouts---NumberTimeouts total # of timeouts. percentConnectivity---Percentage connectivity percentage as a fraction.

percentThreshold---Percentage threshold violation percentage as a fraction.

minDelay---Delay minimum RTT delay in milliseconds

maxDelay---Delay maximum RTT delay in milliseconds

avgDelay---Delay average RTT delay in milliseconds

stdDev---Delay standard deviation from average RTT delay in milliseconds

httpStats---HttpStatsSeq for an Http SLA, additional statistics are maintained. There is always only one instance of this struct. The sequence is defined to bypass a Orbix core dump for null struct reference. jitterStats---JitterStatsSeq for a Jitter SLA, additional statistics are maintained. There is always only one instance of this struct. The sequence is defined to bypass a Orbix core dump for null struct reference.

AllStatsSeq User Defined Type

A sequence of AllStats struct.

Usage

typedef sequence<AllStats> AllStatsSeq

Delay User Defined Type

An integer value representing the delay measured in milliseconds. It is represented as a long value, maximum being (2**31 - 1).

Usage

typedef long long Delay

ErrorCode Enumerated Type

Defines the different error codes used by the CiscoSlaMonitorException. be used while creating the SAA probe. This value will be mapped to the 'rttType' and 'protocol' fields in the MIB.

Usage

enum ErrorCode
{
InternalSoftwareError,
CollectionRepositoryError,
InvalidParameter,
OutOfRange

};

Enumerators

InternalSoftwareError this kind of error should never occur. Should be reported to the developer for furthur investigation.

CollectionRepositoryError error in accessing the collection repository. Can be because of InvalidParameter to the repository query.

InvalidParameter error caused by wrong parameters. Need to check the client input.

OutOfRange error from accessing data not in the acceptable range.

FileAction Enumerated Type

When the statistics have to be saved in a file, there are various options to do so. The most rudimentary would be to either create a new file every time or append to an existing file. There could also be some hints about how the file name should be generated. Those actions will be specified using this parameter.

Usage

enum FileAction
{
New,
Append

};

Enumerators

New save the statistics in a new file.

Append append the statistics to an existing file. If the file is notpresent, create one.

FloatSeq User Defined Type

A sequence of float values.

Usage

typedef sequence<float> FloatSeq

HttpData Structure

HttpData provides metrics related just to Http SLAs. The metrics related to one SAA entry, typically represents one hour collected data of Http SLA.

Usage

struct HttpData
{
long long numCompletions
long long numOverThresholds
long long sumCompletionTime
double sumCompletionTimeSquare
long long completionTimeMax
long long completionTimeMin
long long dnsRttSum
long long tcpConnectRttSum
long long transactionRttSum
long long messageBodyOctetsSum
long long dnsServerTimeout
long long tcpConnectTimeout
long long transactionTimeout
long long dnsQueryError
long long httpError
long long internalError
long long busies

};

Members

numCompletions---long long total number of successful connections.

numOverThreshold---long long total number of successful connections whose round trip time exceeded the threshold.

sumCompletionTime---long long sum of the round trip completion time for all successful connections.

sumCompletionTimeSquare---long long square of the sum of the round trip completion time for all successful connections.

completionTimeMax---long long maximum round trip completion time for all successful connections.

completionTimeMin---long long minimum round trip completion time for all successful connections.

dnsRttSum---long long the sum of round trip time taken to perform DNS query within the HTTP operation.

tcpConnectRttSum---long long the sum of round trip time taken to connect to the Http server.

transactionRttSum---long long the sum of round trip time taken to download the object specified by URL.

messageBodyOctetsSum---long long the sum of the size of the message body received as a response to the HTTP request.

dnsServerTimeout---long long the number of requests that could not connect to the DNS Server.

tcpConnectTimeout---long long the number of requests that could not connect to the HTTP Server.

transactionTimeout---long long the number of requests that timed out during Http transaction.

dnsQueryError---long long the number of requests that had DNS query error.

httpError---long long the number of requests that had HTTP errors while downloading the base page.

internalError---long long the number of occasions when a HTTP operation could not be initiated because an internal error.

busies---long long the number of occasions when a HTTP operation could not be initiated because a previous HTTP operation has not been completed.

HttpStats Structure

Over and above the common aggregated statistics provided by the AllStats object, HttpStats provides additional metrics related to just Http SLA.

Usage

struct HttpStats
{
long long dnsRttSum
long long tcpConnectRttSum
long long transactionRttSum
long long messageBodyOctetsSum
long long dnsServerTimeout
long long tcpConnectTimeout
long long transactionTimeout
long long dnsQueryError
long long httpError
long long internalError

};

Members

dnsRttSum---long long the sum of round trip time taken to perform DNS query within the HTTP operation.

tcpConnectRttSum---long long the sum of round trip time taken to connect to the Http server.

transactionRttSum---long long the sum of round trip time aken to download the object specified by URL.N

messageBodyOctetsSum---long long the sum of the size of the message body received as a response to the HTTP request.

dnsServerTimeout---long long the number of requests that could not connect to the DNS Server.

tcpConnectTimeout---long long the number of requests that could not connect to the HTTP Server.

transactionTimeout---long long the number of requests that timed out during Http transaction.

dnsQueryError---long long the number of requests that had DNS query error.

httpError---long long the number of requests that had HTTP errors while downloading the base page.

internalError---long long the number of occasions when a HTTP operation could not be initiated because an internal error.

internalError---long long the number of occasions when a HTTP operation could not be initiated because a previous HTTP operation has not been completed.

HttpStatsSeq User Defined Type

A sequence of HttpStats objects. In reality there is only one instance of HttpStats for each SLA. But since Orbix gets a core dump if a struct reference is left null, we need to define it as a sequence of struct :!)

Usage

typedef sequence<HttpStats> HttpStatsSeq

IpAddressLong User Defined Type

IP address represented as a four byte long value. IP address is represented as a.b.c.d where a, b, c and d are integer value from 0 to 255. Each of those integers is stored in one byte to create the four byte long representation for the IP address.

This is a much preferred and compact representation than a string, which could take to a maximum of 16 bytes.

Usage

typedef long IpAddressLong

JitterData Structure

JitterData provides metrics related to voice jitter SLAs. The metrics related to one SAA entry, usually represents one hour collected data of Voice Jitter SLA. This object is also used to represent the aggregated jitter entry, in this case the metrics are accumulated along a period of time (day, week, month etc).

Usage

struct JitterData
{
long long numCompletions
long long numOverThresholds
long long sumCompletionTime
double sumCompletionTimeSquare
long long completionTimeMax
long long completionTimeMin
long long numRtt
long long positiveSDMin
long long positiveSDMax
long long numPositiveSD
long long sumPositiveSD
double sumPositiveSD2
long long negativeSDMin
long long negativeSDMax
long long numNegativeSD
long long sumNegativeSD
double sumNegativeSD2
long long positiveDSMin
long long positiveDSMax
long long numPositiveDS
long long sumPositiveDS
double sumPositiveDS2
long long negativeDSMin
long long negativeDSMax
long long numNegativeDS
long long sumNegativeDS
double sumNegativeDS2
long long packetLossSD
long long packetLossDS
long long outOfSeq
long long packetMIA
long long packetLateArrival
long long statsError
long long busies

};

Members

numCompletions---long long total number of successful connections.

numOverThreshold---long long total number of successful connections whose round trip time exceeded the threshold.

sumCompletionTime---long long sum of the round trip completion time for all successful connections.

sumCompletionTimeSquare---long long square of the sum of the round trip completion time for all successful connections.

completionTimeMax---long long maximum round trip completion time for all successful connections.

completionTimeMin---long long minimum round trip completion time for all successful connections.

numRtt---long long Number of jitter operations that have completed successfully.

positiveSDMin---long long The minimum of absolute values of all positive jitter values sent from source to destination.

positiveSDMax---long long The maximum of absolute values of all positive jitter values sent from source to destination.

numPositiveSD---long long The sum of number of all positive jitter values from packets sent from source to desination.

sumPositiveSD---long long The sum of all positive jitter values from packets sent from source to desination.

sumPositiveSD2---double The sum of squares of all positive jitter values from packets sent from source to desination.

negativeSDMin---long long The minimum of absolute values of all negative jitter values sent from source to destination.

negativeSDMax---long long The maximum of absolute values of all negative jitter values sent from source to destination. numNegativeSD---long long The sum of number of all negative jitter values from packets sent from source to desination.

sumNegativeSD---long long The sum of all negative jitter values from packets sent from source to desination.

sumNegativeSD2---double The sum of squares of all negative jitter values from packets sent from source to desination.

positiveDSMin---long long The minimum of absolute values of all positive jitter values sent from destination to source.

positiveDSMax---long long The maximum of absolute values of all positive jitter values sent from destination to source.

numPositiveDS---long longThe sum of number of all positive jitter values from packets sent from destination to source.

sumPositiveDS---long long The sum of all positive jitter values from packets sent from desination to source.

sumPositiveDS2---double The sum of squares of all positive jitter values from packets sent from desination to source.

negativeDSMin---long long The minimum of absolute values of all negative jitter values sent from destination to source. negativeDSMax---long long The maximum of absolute values of all negative jitter values sent from destination to source.

numNegativeDS---long long The sum of number of all negative jitter values from packets sent from desination to source.

sumNegativeDS---long long The sum of all negative jitter values from packets sent from desination to source.

sumNegativeDS2---double The sum of squares of all negative jitter values from packets sent from desination to source.

packetLossSD---long long The number of packets lost when sent from source to destination.

packetLossDS---long long The number of packets lost when sent from destination to source.

outOfSeq---long long The number of packets that arrived out of sequence.

packetMIA---long long The number of packets that were lost and for which we cannot determine the direction.

packetLateArrival---long long The number of packets that arrived late, after the timeout.

statsError---long long The number of occasions when a jitter operation could not be initiated because aninternal error.

busies---long longThe number of occasions when a jitter operation could not be initiated because a previous jitter operation has not completed.

See Also

JitterStats

JitterDataSeq User Defined Type

Sequence of JitterData struct.

Usage

typedef sequence<JitterData> JitterDataSeq

JitterStats Structure

Over and above the common aggregated statistics provided by the AllStats object, JitterStats provides additional metrics related to Voice jitter SLA.

Usage

struct JitterStats
{
long long numRtt
long long packetLossSD
long long packetLossDS
long long outOfSeq
long long packetMIA
long long packetLateArrival
long long errors
long long busies

};

Members

numRtt---long long the number of packets that were successfully measured. packetLossSD---long long the number of packets that were lost on the router from source to destination.

packetLossDS---long long the number of packets that were lost on the router from destination to source.

outOfSeq---long long the number of packets that arrived out of sequence.

packetMIA---long long the number of lost packets for which we cannot determine the direction.

packetLaterArrival---long long the number of packets that arrived after the timeout.

errors---long long the number of error operations.

busies---long long the number of operations that cannot be initiated because a previous Jitter operation has not been completed.

JitterStatsSeq User Defined Type

A sequence of JitterStats objects. In reality there is only one instance of JitterStats for each SLA. But since Orbix gets a core dump if a struct reference is left null, we need to define it as a sequence of struct :!)

Usage

typedef sequence<JitterStats> JitterStatsSeq

NumberConnections User Defined Type

Provides the total number of connections. This is the number of times that the SAA probe was successful in making a connection with the destination end point.

Though it is an integer value, it is stored as a float since the value could get very large and a long may not always be sufficient for storage. For example, total number of connections for all SLA over a year.

Usage

typedef float NumberConnections

NumberTimeouts User Defined Type

Provides the total number of timeouts. This is the number of times that the SAA probe was not successful in making a connection with the destination end point.

Usage

typedef float NumberTimeouts

OutputAction Enumerated Type

As statistics are computed, they can typically be returned to the client as a collection of structs. The client may instead want the statistics to be written to a file. SLA Monitor will provide a utility to generate some of the common stats into files for export to other 3rd party systems.

Usage

enum OutputAction
{
ReturnValue,
File,
Both

};

Enumerators

ReturnValue the statistics are provided as a return value.

File the statistics are saved in a file.

Both the statistics are provided as a return value and also saved in a file.

Percentage User Defined Type

A ratio used to represent percentage values. The value will be between 0 and 1.

Usage

typedef float Percentage

PercentageSeq User Defined Type

A sequence of percentage values. Typically used to return percentage based statistics.

Usage

typedef sequence<Percentage> PercentageSeq

ProtocolData Structure

ProtocolData represents probe metrics, could be related to several protocols (other than http and voice jitter). The metrics related to one SAA entry, typically represents one hour collected data.

Usage

struct ProtocolData
{
long numDisconnects
long timeouts
long busies
long noConnections
long drops
long sequenceErrors
long verifyErrors
SAABucketCollection buckets

};

Members

numDisconnects---long total number of times when the probe operation completions received with data that does not compare with the expected data.

timeouts---long total number of times the probe operation was not completed before a timeout occurred. It also includes when the target could not be reached at all.

busies---long total number of occassions that the probe operation could not initiated since it was still busy with the previous operation.

noConnections---long total number of times the connection could not be established.

drops---long total number of times the operation could not be performed due to lack of internal resources, such as memory.

sequenceErrors---long total number of time when the probe operation completion was received with an unexpected sequence identifier.

buckets---SAABucketCollection statistics during this collection interval for the SAA probe, distributed over various round trip time buckets.

ProtocolDataSeq User Defined Type

A sequence of ProtocolData objects. In reality there is only one instance of ProtocolData for each SLA. But since Orbix gets a core dump if a struct reference is left null, we need to define it as a sequence of struct :!)

Usage

typedef sequence<ProtocolData> ProtocolDataSeq

ProtocolDataUnion User Defined Type

Usage

typedef protocolUnion ProtocolDataUnion

protocolUnion Union

There are certain statistics which are only present for a particular type of protocol. The union below allows SAAEntry to include different struct of statistics, related to a particular protocol.

The auto generated method 'is_data()' on the union data member has to be used to check if the data member actually exists.

Usage

union protocolUnion switch (long)
{
case PROTOCOL_HTTP_VAL: 
HttpData httpData;

case PROTOCOL_VOICE_JITTER_VAL: 
JitterData jitterData;

default: 
ProtocolData data;

};

RequestSize User Defined Type

Each SAA probe typically sends one packet per sample. The # of bytes in that packet can be specified while creating the probe. This value is referred to as the request size.

Request size is an integer value greater than 1. Generally the maximum size is limited to 1500 bytes, though the actual restriction is based on the type of protocol selected for the SLA. For exact details, refer to the SAA mib.

Usage

typedef long RequestSize

RttMonOperation Enumerated Type

For some of the protocols, the specific operation to be performed is specified when the SAA probe is created. Currently the only such operations are specified for the Http SLA.

The currently known specific RTT operations are defined below.

Usage

enum RttMonOperation
{
NotApplicable,
HttpGet,
HttpRaw

};

Enumerators

NotApplicable Operation not applicable and unspecified.

httpGet HTTP get request.

httpRaw HTTP request with user defined payload.

SAABucket Structure

Provides access to the distribution statistics collected for each SAA probe. While creating the SAA probe, the # of buckets and the bucket size is defined. For example, 10 buckets of 5 milliseconds each. As the round trip time for each sample is calculated its results are saved in the appropriate bucket.

By collecting data in multiple buckets, an application can do further detailed analysis on the distribution of response time for a service.

Usage

struct SAABucket
{
long bucketIndex
long numCompletions
long numOverThresholds
long sumCompletionTime
double sumCompletionTimeSquare
long completionTimeMax
long completionTimeMin

};

Members

bucketIndex---long specifies the bucket # starting with 1.

numCompletions---long total number of successful connections.

numOverThreshold---long total number of successful connections whose round trip time exceeded the threshold.

sumCompletionTime---long sum of the round trip completion time for all successful connections.

sumCompletionTimeSquare---long square of the sum of the round trip completion time for all successful connections.

completionTimeMax---long maximum round trip completion time for all successful connections.

completionTimeMin---long minimum round trip completion time for all successful connections.

SAABucketSeq User Defined Type

A sequence of SAA bucket entries. Typically used to maintain the statistics per bucket for a single probe.

Usage

typedef sequence<SAABucket> SAABucketSeq

SAADataSetSeq User Defined Type

Sequence of SAADataSet objects.

Usage

typedef sequence<SAADataSet> SAADataSetSeq

SAAEntry Structure

Contains the statistics information for each probe programmed on the SAA mib for a particular router. This entry represents statistics collected over the collection interval. This interval is defined when the probe is created. The convention is to keep the interval same for all probes. The default value for the interval is one hour.

Usage

struct SAAEntry
{
SlaId id
long protocol
ProtocolDataUnion protocolData

};

Members

id---SlaId unique identifier to specify the SLA for which the statistics are maintained.

protocol---long the protocol of the sla determines the the type of data will be kept in the union.

protocolData---ProtocolDataUnion each protocol probes have different type of collected data. These values are maintained as one set of values per collection interval, which typically is one hour.

SAAEntrySeq User Defined Type

Usage

typedef sequence<SAAEntry> SAAEntrySeq

SAAIndex User Defined Type

For each SLA, a SAA probe is created on the SAA router. Each SAA probe is identified by an integer index in the SAA mib. The SAAIndex represents that value.

By using the SAA index, the SLA can be traced back to an actual probe in the SAA mib. This index value is used to also identify the statistics read from the SAA mib with a particular SLA.

Usage

typedef long SAAIndex

SAARouterSeq User Defined Type

A sequence of SAARouter objects.Datasets

Usage

typedef sequence<SAARouter> SAARouterSeq

SlaId User Defined Type

An SLA id is a unique number within the SLA Monitor to identify each SLA. This number is assigned to an SLA when the SLA is created by the data collector.

An SLA is uniquely distinguished by its key fields. They are, Customer Name, Source and Destination address, Protocol, Request Size, Threshold.

Based on an SLA id, any client can uniquely identify an SLA. This SLA id will be associated with this particular SLA for its entire life, a client can save it persistently and get access to the same SLA at a later time.

Usage

typedef long SlaId

SlaIdCollection User Defined Type

A collection of SLA id values to be returned from operations and passed around to other operations. The reason it is only a sequence of id is that a sequence of long is much more efficient to pass around than a sequence of Sla 'interface' objects. If the client needs an actual Sla object, they can access it from the Sla id.

Usage

typedef sequence<SlaId> SlaIdCollection

SlaInfo Structure

Definition of an SLA, Service Level Agreement. An SLA definition is utilized to define a probe on the appropriate SAA enabled router. It is populated when a user wants to define an SLA to be monitored. Other user applications, such as report generator may want to access the various SLAs defined in the repository.

Usage

struct SlaInfo
{
SlaId id
SlaStatus status
string SAARouter
string customerName
string vpnName
IpAddressLong sourceAddress
IpAddressLong targetAddress
string targetName
long targetPort
long protocol
string protocolName
RequestSize requestSize
Threshold threshold
TypeOfService tos
long rttLife
string dnsNameServer
string targetAddressString
RttMonOperation operation
string httpVersion
string url
boolean cacheEnabled
string httpProxy
string httpRawRequest
long interval
long numPackets

};

Members

id---SlaId Unique identifier for an SLA.

status---SlaStatus indicates whether the SLA is currently active or disabled.

SAARouter---string Full name of the router on which the SAA probe is to be defined. A router with this name has to be present in the directory repository. The full name format is :.

customerName---string Name of the customer for whom this SLA is defined.

vpnName---string Name of the VPN to which this SLA belongs.

sourceAddress---IpAddressLong Source IP address for theSLA being monitored

targetAddress---IpAddressLong Destination IP addressfor the SLA being monitored.

targetName---string that represents the name of the destination router.

targetPort---long port number on the destination end of the connection. Used for protocols udpEcho, tcpConnect and jitter.

protocol---long Specifies the protocol for which the probe is programmed. It will be mapped to the SAA specific values for 'rttType' and 'protocol' when the probe is defined on the SAA router. This protocol value maps to a corresponding protocol string name 'protocolName'. When one of these values is set, the other value is internally modified to the correct value.

protocolName---string Specifies the protocol for which the probe is programmed as a string value. It will be mapped to the SAA specific values for 'rttType' and 'protocol' when the probe is defined on the SAA router. The name maps to a corresponding 'protocol' enum. When one of these values is set, the other value is internally modified to the correct value.

requestSize---long Size of the sample packet as # of bytes. The is a max packet size limit. Each sample is only one packet, unless the protocol is 'jitter'.

threshold---long Round trip time in milliseconds, beyond which the SLA is indicated to have a threshold violation.

tos---long Type of service byte used with the SAA probe.

rttLife---long Life specifies the number of seconds the probe will be active. Value of -1 means active forever.

targetAddressString---string specifies the ip addressof the name server. This object is applicable to dns probe only.

targetAddressString---string specifies the address of the target. This string can be in IP address format or a hostname. This object is applicable to dns probe only.

operation---RttMonOperation type of operation to be performed by the SAA probe.

httpVersion---string a string which specifies the version number of the HTTP Server. This object is applicable to http probe only.

url---string a string which represents the URL to which a HTTP probe should communicate with. This object is

cacheEnabled---boolean if this object is false then it means that HTTP request should not download cached pages. This means that the request should be forwarded to the origin server. This object is applicable to http probe only."

httpProxy---string represents the proxy server information. This object is applicable to http probe only.

httpRawRequest---string this string stores the content of HTTP raw request.

interval---long represents the inter-packet delay between packets and is in milliseconds. This value is currently used for Jitter probe only. Maximus = 60000 ms. Default = 20 ms.

numPackets---long represents the number of packets that need to be transmitted. This value is currently used for Jitter probe only. Default = 10.

SlaInfoSeq User Defined Type

A sequence of SlaInfo struct.

Usage

typedef sequence<SlaInfo> SlaInfoSeq

SlaSeq User Defined Type

A sequence of Sla values to be returned from operations and passed around to other operations.

Usage

typedef sequence<Sla> SlaSeq

SlaStatus Enumerated Type

Each Sla receives a unique id. The sla information is kept in the repository even after the Sla was deleted from the router. The SlaStatus indicates whether the probe is active or disabled.

Usage

enum SlaStatus
{
Active,
Disabled

};

Enumerators

Active the Sla exists on the router

Disabled the Sla was deleted from the router

SpecificStats Structure

One statistic parameter for an SLA. The result is obtained over a particular set of collected data sets. Typically the datasets are combined for a contiguous time period. For example, all collected data about SLA performance in the past week.

But that is not always the case. The client may want to obtain results for every Monday over the last six months. Or look at results during 9 to 5 every day.

SpecificStats contains the a specific value to describe an SLA performance. The value can be any percentage value such as connectivity percentage or threshold violation percentage.

Usage

struct SpecificStats
{
TimeStamp timeStamp
Percentage val

};

Members

timeStamp---TimeStamp the start time of the data, the user knows what is the TimeInterval of the data. val---Percentage connectivity or threshold percentage as a fraction.

SpecificStatsSeq User Defined Type

A sequence of SpecificStats struct.

Usage

typedef sequence<SpecificStats> SpecificStatsSeq

StringSeq User Defined Type

A sequence of string values.

Usage

typedef sequence<string> StringSeq

Threshold User Defined Type

Define the threshold value for the round trip time on this SLA. For any sample, if the round trip time for the SLA goes beyond the threshold, it is counted as a threshold violation.

The threshold value is defined in milliseconds. It is greater than 0. Typical value is in the range of 100 ms to 500 ms. The default is 5000 ms.

Usage

typedef long Threshold

TimeInterval Enumerated Type

Defines the various time intervals over which SLA statistics can be combined. The raw data is collected hourly and saved in the repository. Depending upon the client requirement, the statistics are desired at a higher level of granularity.

There are times when you want to combine all the data points of the selected SLA statistics into a single value. In those situations, 'None' is applicable.

Usage

enum TimeInterval
{
None,
Hourly,
Daily,
Weekly,
Monthly,
Annual

};

Enumerators

None combine all the data points into a single set.

Hourly maintained per hour.

Daily combined over data sets per day.

Weekly combined over data sets per week.

Monthly combined over data sets per month.

Annual combined over data sets for the complete year.

TimeStamp User Defined Type

Provides the start time of the aggregated data.

Usage

typedef long long TimeStamp

TypeOfService Enumerated Type

Defines the various type of service in an SLA. The values represents the Type of service three leftmost bits in an IP header.

Usage

enum TypeOfService
{
FourOut,
ThreeOut,
TwoOut,
OneOut,
FourIn,
ThreeIn,
TwoIn,
OneIn

};

Enumerators

FourOut out of contract, fourth class. ThreeOut out of contract, third class. TwoOut out of contract, second best class. OneOut out of contract, best class. FourIn in contract, fourth class. ThreeIn in contract, third best class. TwoIn in contract, second best class. OneIn in contract, best class.

Constants

const string PROTOCOL_DHCP = "dhcp"

String Constant for protocol name to perform DHCP query. Value is dhcp

const long PROTOCOL_DHCP_VAL = 29

Long Constant for protocol to perform DHCP query. Value is 29

const string PROTOCOL_DNS = "dns"

String Constant for protocol name to perform DNS query. Value is dns

const long PROTOCOL_DNS_VAL = 26

Long Constant for protocol to perform DNS query. Value is 26

const string PROTOCOL_HTTP = "http"

String Constant for protocol name to perform Http query. Value is http

const long PROTOCOL_HTTP_VAL = 25

Long Constant for protocol to perform Http query. Value is 25

const string PROTOCOL_ICMP_ECHO = "icmpecho"

String Constant for protocol name Icmp echo. Value is icmpecho

const long PROTOCOL_ICMP_ECHO_VAL = 2

Long Constant for protocol Icmp echo. Value is 2

const string PROTOCOL_TCP_CONNECT = "tcpconnect"

String Constant for protocol name TCP Connect. Value is tcpconnect

const long PROTOCOL_TCP_CONNECT_VAL = 24

Long Constant for protocol TCP Connect. Value is 24

const string PROTOCOL_UDP_ECHO = "udpecho"

String Constant for protocol name UDP echo. Value is udpecho

const long PROTOCOL_UDP_ECHO_VAL = 3

Long Constant for protocol UDP echo. Value is 3

const string PROTOCOL_UNDEFINED = "undefined"

String Constant to indicate that protocol name is not defined. Value is undefined

const long PROTOCOL_UNDEFINED_VAL = 0

Long constant for undefined protocol. Value is 0

const string PROTOCOL_VOICE_JITTER = "voicejitter"

String Constant for protocol name to measure voice jitter. Value is jitter

const long PROTOCOL_VOICE_JITTER_VAL = 27

Long Constant for protocol to measure voice jitter. Value is 27

Exceptions

CiscoSlaMonitorException

Generic exception thrown to indicate an error somewhere down the chain. This exception will be raised when an underlying system raises an exception, such as some errors raised in the Data server or the repository. The explanation string will provide the relevant information to be displayed in the client application and eventually the user.

Usage

exception CiscoSlaMonitorException
{
ErrorCode errorCode;
string explanation;

};

Parameters

errorCode---explanation---string description of the specific conditions that raised the exception.

NoDataAvailableException

Thrown when a client attempts to retrieve data, but none is available (e.g. there are no datasets for a particular interval). This exception may be raised in specific cases, when particular indication needs to be provided to the client application.

Usage

exception NoDataAvailableException
{
string explanation;

};

UnknownProtocolException

Thrown when a client attempts to retrieve data for a protocol that is unknown to the SLA server and the underlying SAA MIB agent.

Usage

exception UnknownProtocolException
{
long protocol;

};

UnknownSlaIdException

Thrown when a client attempts to create an SLA object with wrong identifier.

Usage

exception UnknownSlaIdException
{
long id;

};

Interface AggregateConnectivityCollection

A collection interface which provides access to a group of AggregateConnectivity struct. The AggregateConnectivity struct can either be accessed as an SlaSeq, iterated an element at a time or accessed randomly by element position in the collection.

Attributes

readonly attribute long size

A readonly attribute that represents the number of elements in the AggregateConnectivityCollection collection.

See Also

setIndex, getIndex, nextElement, nextElements, elementAtIndex, elementsAtIndex, dispose

Since

Data Collection Base Framework, Release 1.0

Cisco VPN Solutions Center, Release 1.0

Operations

dispose()

Disposes the AggregateConnectivityCollection object and frees the server resources that are associated with it.

Usage

void dispose();

Description

Once executed, the AggregateConnectivityCollection object is no longer accessible by the client. In addition, the server may free this object automatically after some time. Program your clients to retrieve data from a collection when it is first is acquired, rather than waiting before examining the data.

See Also

AggregateConnectivityCollection

Since

Data Collection Base Framework, Release 1.0

Cisco VPN Solutions Center, Release 1.0

elementAtIndex()

Gets the AggregateConnectivityCollection element at the specified index.

Usage

AggregateConnectivity elementAtIndex(
in long index)

raises(
InvalidIndexException,
InvalidatedException);

Parameters

index---in long value that specifies the index of the element to get.

Returns

AggregateConnectivity that represents the specified AggregateConnectivityCollection element.

Raises

DCBFWCollection::InvalidIndexException if the index isinvalid. An invalid index only occurs if a client explictly the indexto an invalid value using the setIndex() operation. DCBFWCollection::InvalidatedException if this collectionis invalidated by the server.

Description

Note: This operation does not affect the sequential index used by the nextElement() and nextElements() operations.

See Also

setIndex, getIndex, nextElement, nextElements, elementsAtIndex, size

Since

Data Collection Base Framework, Release 1.0

Cisco VPN Solutions Center, Release 1.0

elementsAtIndex()

Gets a specified number of AggregateConnectivityCollection elements at the specified index.

Usage

AggregateConnectivitySeq elementsAtIndex(
in long index,
in long numberOfElements)

raises(
InvalidIndexException,
InvalidatedException);

Parameters

index---in long value that specifies the index of the first element to get.

numberOfElements---in long that indicates the number of AggregateConnectivityCollection elements to get.

Returns

AggregateConnectivitySeq that represent the specified AggregateConnectivityCollection elements.

Raises

Description

If the end of the collection is reached before the specified numberOfElements is returned, AggregateConnectivityCollection elements are returned until the end of the collection is reached. The collection may also return fewer elements than requested to reduce the message size, but a minimum of one collection element is returned, if available.

Note: This operation does not affect the sequential index used by the nextElement() and nextElements() operations.

See Also

setIndex, getIndex, nextElement, nextElements, elementAtIndex, size

Since

Data Collection Base Framework, Release 1.0

Cisco VPN Solutions Center, Release 1.0

getIndex()

Gets the index value of the current AggregateConnectivityCollection element.

Usage

long getIndex();
raises(
InvalidatedException);

Returns

long---Index of the element at the current position in the AggregateConnectivityCollection collection.

Raises

DCBFWCollection::InvalidatedException if this collectionis invalidated by the server.

Description

The AggregateConnectivityCollection index is initialized to 0 and is incremented when collection elements are traversed sequentially using the nextElement() or nextElements() operations.

See Also

setIndex, nextElement, nextElements, elementAtIndex, elementsAtIndex, size

Since

Data Collection Base Framework, Release 1.0

Cisco VPN Solutions Center, Release 1.0

nextElement()

Gets the next AggregateConnectivityCollection element.

Usage

AggregateConnectivity nextElement();
raises(
EndOfCollectionException,
InvalidatedException);

Returns

AggregateConnectivity that represents the next AggregateConnectivityCollection element.

Raises

DCBFWCollection::EndOfCollectionException if the end ofthe collection is reached without returning any items. DCBFWCollection::InvalidatedException if this collectionis invalidated by the server.

Description

Executing the nextElement() operation increments the sequential index.

See Also

setIndex, getIndex, nextElements, elementAtIndex, elementsAtIndex, size

Since

Data Collection Base Framework, Release 1.0

Cisco VPN Solutions Center, Release 1.0

nextElements()

Gets the next few AggregateConnectivityCollection elements.

Usage

AggregateConnectivitySeq nextElements(
in long numberOfElements)

raises(
EndOfCollectionException,
InvalidatedException);

Parameters

numberOfElements---in long that indicates the number of elements to get.

Returns

AggregateConnectivitySeq that represent the next few AggregateConnectivityCollection elements as specified by the numberOfElements input value.

Raises

Description

See Also

setIndex, getIndex, nextElement, elementAtIndex, elementsAtIndex, size

Since

Data Collection Base Framework, Release 1.0

Cisco VPN Solutions Center, Release 1.0

setIndex()

Sets the index value of the current AggregateConnectivityCollection element.

Usage

void setIndex(
in long index)

raises(
InvalidatedException,
InvalidIndexException);

Parameters

index---in long that represents the index to value assign to the current AggregateConnectivityCollection element.

Raises

Description

The AggregateConnectivityCollection index is initialized to 0 and is incremented when collection elements are traversed sequentially using the nextElement() or nextElements() operations.

See Also

getIndex, nextElement, nextElements, elementAtIndex, elementsAtIndex, size

Since

Data Collection Base Framework, Release 1.0

Cisco VPN Solutions Center, Release 1.0

Interface AggregateJitterDataCollection

A collection interface which provides access to a group of AggregateJitterData struct. The AggregateJitterData struct can either be accessed as an SlaSeq, iterated an element at a time or accessed randomly by element position in the collection.

Attributes

readonly attribute long size

A readonly attribute that represents the number of elements in the AggregateJitterDataCollection collection.

See Also

setIndex, getIndex, nextElement, nextElements, elementAtIndex, elementsAtIndex, dispose

Since

Data Collection Base Framework, Release 1.0

Cisco VPN Solutions Center, Release 1.0

Operations

dispose()

Disposes the AggregateJitterDataCollection object and frees the server resources that are associated with it.

Usage

void dispose();

Description

Once executed, the AggregateJitterDataCollection object is no longer accessible by the client. In addition, the server may free this object automatically after some time. Program your clients to retrieve data from a collection when it is first is acquired, rather than waiting before examining the data.

See Also

AggregateJitterDataCollection

Since

Data Collection Base Framework, Release 1.0

Cisco VPN Solutions Center, Release 1.0

elementAtIndex()

Gets the AggregateJitterDataCollection element at the specified index.

Usage

AggregateJitterData elementAtIndex(
in long index)

raises(
InvalidIndexException,
InvalidatedException);

Parameters

index---in long value that specifies the index of the element to get.

Returns

AggregateJitterData that represents the specified AggregateJitterDataCollection element.

Raises

Description

Note: This operation does not affect the sequential index used by the nextElement() and nextElements() operations.

See Also

setIndex, getIndex, nextElement, nextElements, elementsAtIndex, size

Since

Data Collection Base Framework, Release 1.0

Cisco VPN Solutions Center, Release 1.0

elementsAtIndex()

Gets a specified number of AggregateJitterDataCollection elements at the specified index.

Usage

AggregateJitterDataSeq elementsAtIndex(
in long index,
in long numberOfElements)

raises(
InvalidIndexException,
InvalidatedException);

Parameters

index---in long value that specifies the index of the first element to get.

numberOfElements---in long that indicates the number of AggregateJitterDataCollection elements to get.

Returns

AggregateJitterDataSeq that represent the specified AggregateJitterDataCollection elements.

Raises

Description

If the end of the collection is reached before the specified numberOfElements is returned, AggregateJitterDataCollection elements are returned until the end of the collection is reached. The collection may also return fewer elements than requested to reduce the message size, but a minimum of one collection element is returned, if available.

Note: This operation does not affect the sequential index used by the nextElement() and nextElements() operations.

See Also

setIndex, getIndex, nextElement, nextElements, elementAtIndex, size

Since

Data Collection Base Framework, Release 1.0

Cisco VPN Solutions Center, Release 1.0

getIndex()

Gets the index value of the current AggregateJitterDataCollection element.

Usage

long getIndex();
raises(
InvalidatedException);

Returns

long---Index of the element at the current position in the AggregateJitterDataCollection collection.

Raises

DCBFWCollection::InvalidatedException if this collectionis invalidated by the server.

Description

The AggregateJitterDataCollection index is initialized to 0 and is incremented when collection elements are traversed sequentially using the nextElement() or nextElements() operations.

See Also

setIndex, nextElement, nextElements, elementAtIndex, elementsAtIndex, size

Since

Data Collection Base Framework, Release 1.0

Cisco VPN Solutions Center, Release 1.0

nextElement()

Gets the next AggregateJitterDataCollection element.

Usage

AggregateJitterData nextElement();
raises(
EndOfCollectionException,
InvalidatedException);

Returns

AggregateJitterData that represents the next AggregateJitterDataCollection element.

Raises

Description

Executing the nextElement() operation increments the sequential index.

See Also

setIndex, getIndex, nextElements, elementAtIndex, elementsAtIndex, size

Since

Data Collection Base Framework, Release 1.0

Cisco VPN Solutions Center, Release 1.0

nextElements()

Gets the next few AggregateJitterDataCollection elements.

Usage

AggregateJitterDataSeq nextElements(
in long numberOfElements)

raises(
EndOfCollectionException,
InvalidatedException);

Parameters

numberOfElements---in long that indicates the number of elements to get.

Returns

AggregateJitterDataSeq that represent the next few AggregateJitterDataCollection elements as specified by the numberOfElements input value.

Raises

Description

See Also

setIndex, getIndex, nextElement, elementAtIndex, elementsAtIndex, size

Since

Data Collection Base Framework, Release 1.0

Cisco VPN Solutions Center, Release 1.0

setIndex()

Sets the index value of the current AggregateJitterDataCollection element.

Usage

void setIndex(
in long index)

raises(
InvalidatedException,
InvalidIndexException);

Parameters

index---in long that represents the index to value assign to the current AggregateJitterDataCollection element.

Raises

Description

The AggregateJitterDataCollection index is initialized to 0 and is incremented when collection elements are traversed sequentially using the nextElement() or nextElements() operations.

See Also

getIndex, nextElement, nextElements, elementAtIndex, elementsAtIndex, size

Since

Data Collection Base Framework, Release 1.0

Cisco VPN Solutions Center, Release 1.0

Interface AggregateStatsCollection

A collection interface which provides access to a group of AggregateStats struct. The AggregateStats struct can either be accessed as an SlaSeq, iterated an element at a time or accessed randomly by element position in the collection.

Attributes

readonly attribute long size

A readonly attribute that represents the number of elements in the AggregateStatsCollection collection.

See Also

setIndex, getIndex, nextElement, nextElements, elementAtIndex, elementsAtIndex, dispose

Since

Data Collection Base Framework, Release 1.0

Cisco VPN Solutions Center, Release 1.0

Operations

dispose()

Disposes the AggregateStatsCollection object and frees the server resources that are associated with it.

Usage

void dispose();

Description

Once executed, the AggregateStatsCollection object is no longer accessible by the client. In addition, the server may free this object automatically after some time. Program your clients to retrieve data from a collection when it is first is acquired, rather than waiting before examining the data.

See Also

AggregateStatsCollection

Since

Data Collection Base Framework, Release 1.0

Cisco VPN Solutions Center, Release 1.0

elementAtIndex()

Gets the AggregateStatsCollection element at the specified index.

Usage

AggregateStats elementAtIndex(
in long index)

raises(
InvalidIndexException,
InvalidatedException);

Parameters

index---in long value that specifies the index of the element to get.

Returns

AggregateStats that represents the specified AggregateStatsCollection element.

Raises

Description

Note: This operation does not affect the sequential index used by the nextElement() and nextElements() operations.

See Also

setIndex, getIndex, nextElement, nextElements, elementsAtIndex, size

Since

Data Collection Base Framework, Release 1.0

Cisco VPN Solutions Center, Release 1.0

elementsAtIndex()

Gets a specified number of AggregateStatsCollection elements at the specified index.

Usage

AggregateStatsSeq elementsAtIndex(
in long index,
in long numberOfElements)

raises(
InvalidIndexException,
InvalidatedException);

Parameters

index---in long value that specifies the index of the first element to get.

numberOfElements---in long that indicates the number of AggregateStatsCollection elements to get.

Returns

AggregateStatsSeq that represent the specified AggregateStatsCollection elements.

Raises

Description

If the end of the collection is reached before the specified numberOfElements is returned, AggregateStatsCollection elements are returned until the end of the collection is reached. The collection may also return fewer elements than requested to reduce the message size, but a minimum of one collection element is returned, if available.

Note: This operation does not affect the sequential index used by the nextElement() and nextElements() operations.

See Also

setIndex, getIndex, nextElement, nextElements, elementAtIndex, size

Since

Data Collection Base Framework, Release 1.0

Cisco VPN Solutions Center, Release 1.0

getIndex()

Gets the index value of the current AggregateStatsCollection element.

Usage

long getIndex();
raises(
InvalidatedException);

Returns

long---Index of the element at the current position in the AggregateStatsCollection collection.

Raises

DCBFWCollection::InvalidatedException if this collectionis invalidated by the server.

Description

The AggregateStatsCollection index is initialized to 0 and is incremented when collection elements are traversed sequentially using the nextElement() or nextElements() operations.

See Also

setIndex, nextElement, nextElements, elementAtIndex, elementsAtIndex, size

Since

Data Collection Base Framework, Release 1.0

Cisco VPN Solutions Center, Release 1.0

nextElement()

Gets the next AggregateStatsCollection element.

Usage

AggregateStats nextElement();
raises(
EndOfCollectionException,
InvalidatedException);

Returns

AggregateStats that represents the next AggregateStatsCollection element.

Raises

Description

Executing the nextElement() operation increments the sequential index.

See Also

setIndex, getIndex, nextElements, elementAtIndex, elementsAtIndex, size

Since

Data Collection Base Framework, Release 1.0

Cisco VPN Solutions Center, Release 1.0

nextElements()

Gets the next few AggregateStatsCollection elements.

Usage

AggregateStatsSeq nextElements(
in long numberOfElements)

raises(
EndOfCollectionException,
InvalidatedException);

Parameters

numberOfElements---in long that indicates the number of elements to get.

Returns

AggregateStatsSeq that represent the next few AggregateStatsCollection elements as specified by the numberOfElements input value.

Raises

Description

See Also

setIndex, getIndex, nextElement, elementAtIndex, elementsAtIndex, size

Since

Data Collection Base Framework, Release 1.0

Cisco VPN Solutions Center, Release 1.0

setIndex()

Sets the index value of the current AggregateStatsCollection element.

Usage

void setIndex(
in long index)

raises(
InvalidatedException,
InvalidIndexException);

Parameters

index---in long that represents the index to value assign to the current AggregateStatsCollection element.

Raises

Description

The AggregateStatsCollection index is initialized to 0 and is incremented when collection elements are traversed sequentially using the nextElement() or nextElements() operations.

See Also

getIndex, nextElement, nextElements, elementAtIndex, elementsAtIndex, size

Since

Data Collection Base Framework, Release 1.0

Cisco VPN Solutions Center, Release 1.0

Interface AggregateThresholdCollection

A collection interface which provides access to a group of AggregateThreshold struct. The AggregateThreshold struct can either be accessed as an SlaSeq, iterated an element at a time or accessed randomly by element position in the collection.

Attributes

readonly attribute long size

A readonly attribute that represents the number of elements in the AggregateThresholdCollection collection.

See Also

setIndex, getIndex, nextElement, nextElements, elementAtIndex, elementsAtIndex, dispose

Since

Data Collection Base Framework, Release 1.0

Cisco VPN Solutions Center, Release 1.0

Operations

dispose()

Disposes the AggregateThresholdCollection object and frees the server resources that are associated with it.

Usage

void dispose();

Description

Once executed, the AggregateThresholdCollection object is no longer accessible by the client. In addition, the server may free this object automatically after some time. Program your clients to retrieve data from a collection when it is first is acquired, rather than waiting before examining the data.

See Also

AggregateThresholdCollection

Since

Data Collection Base Framework, Release 1.0

Cisco VPN Solutions Center, Release 1.0

elementAtIndex()

Gets the AggregateThresholdCollection element at the specified index.

Usage

AggregateThreshold elementAtIndex(
in long index)

raises(
InvalidIndexException,
InvalidatedException);

Parameters

index---in long value that specifies the index of the element to get.

Returns

AggregateThreshold that represents the specified AggregateThresholdCollection element.

Raises

Description

Note: This operation does not affect the sequential index used by the nextElement() and nextElements() operations.

See Also

setIndex, getIndex, nextElement, nextElements, elementsAtIndex, size

Since

Data Collection Base Framework, Release 1.0

Cisco VPN Solutions Center, Release 1.0

elementsAtIndex()

Gets a specified number of AggregateThresholdCollection elements at the specified index.

Usage

AggregateThresholdSeq elementsAtIndex(
in long index,
in long numberOfElements)

raises(
InvalidIndexException,
InvalidatedException);

Parameters

index---in long value that specifies the index of the first element to get.

numberOfElements---in long that indicates the number of AggregateThresholdCollection elements to get.

Returns

AggregateThresholdSeq that represent the specified AggregateThresholdCollection elements.

Raises

Description

If the end of the collection is reached before the specified numberOfElements is returned, AggregateThresholdCollection elements are returned until the end of the collection is reached. The collection may also return fewer elements than requested to reduce the message size, but a minimum of one collection element is returned, if available.

Note: This operation does not affect the sequential index used by the nextElement() and nextElements() operations.

See Also

setIndex, getIndex, nextElement, nextElements, elementAtIndex, size

Since

Data Collection Base Framework, Release 1.0

Cisco VPN Solutions Center, Release 1.0

getIndex()

Gets the index value of the current AggregateThresholdCollection element.

Usage

long getIndex();
raises(
InvalidatedException);

Returns

long---Index of the element at the current position in the AggregateThresholdCollection collection.

Raises

DCBFWCollection::InvalidatedException if this collectionis invalidated by the server.

Description

The AggregateThresholdCollection index is initialized to 0 and is incremented when collection elements are traversed sequentially using the nextElement() or nextElements() operations.

See Also

setIndex, nextElement, nextElements, elementAtIndex, elementsAtIndex, size

Since

Data Collection Base Framework, Release 1.0

Cisco VPN Solutions Center, Release 1.0

nextElement()

Gets the next AggregateThresholdCollection element.

Usage

AggregateThreshold nextElement();
raises(
EndOfCollectionException,
InvalidatedException);

Returns

AggregateThreshold that represents the next AggregateThresholdCollection element.

Raises

Description

Executing the nextElement() operation increments the sequential index.

See Also

setIndex, getIndex, nextElements, elementAtIndex, elementsAtIndex, size

Since

Data Collection Base Framework, Release 1.0

Cisco VPN Solutions Center, Release 1.0

nextElements()

Gets the next few AggregateThresholdCollection elements.

Usage

AggregateThresholdSeq nextElements(
in long numberOfElements)

raises(
EndOfCollectionException,
InvalidatedException);

Parameters

numberOfElements---in long that indicates the number of elements to get.

Returns

AggregateThresholdSeq that represent the next few AggregateThresholdCollection elements as specified by the numberOfElements input value.

Raises

Description

See Also

setIndex, getIndex, nextElement, elementAtIndex, elementsAtIndex, size

Since

Data Collection Base Framework, Release 1.0

Cisco VPN Solutions Center, Release 1.0

setIndex()

Sets the index value of the current AggregateThresholdCollection element.

Usage

void setIndex(
in long index)

raises(
InvalidatedException,
InvalidIndexException);

Parameters

index---in long that represents the index to value assign to the current AggregateThresholdCollection element.

Raises

Description

The AggregateThresholdCollection index is initialized to 0 and is incremented when collection elements are traversed sequentially using the nextElement() or nextElements() operations.

See Also

getIndex, nextElement, nextElements, elementAtIndex, elementsAtIndex, size

Since

Data Collection Base Framework, Release 1.0

Cisco VPN Solutions Center, Release 1.0

Interface AllStatsCollection

A collection interface which provides access to a group of AllStats struct. The AllStats struct can either be accessed as an SlaSeq, iterated an element at a time or accessed randomly by element position in the collection.

Attributes

readonly attribute long size

A readonly attribute that represents the number of elements in the AllStatsCollection collection.

See Also

setIndex, getIndex, nextElement, nextElements, elementAtIndex, elementsAtIndex, dispose

Since

Data Collection Base Framework, Release 1.0

Cisco VPN Solutions Center, Release 1.0

Operations

dispose()

Disposes the AllStatsCollection object and frees the server resources that are associated with it.

Usage

void dispose();

Description

Once executed, the AllStatsCollection object is no longer accessible by the client. In addition, the server may free this object automatically after some time. Program your clients to retrieve data from a collection when it is first is acquired, rather than waiting before examining the data.

See Also

AllStatsCollection

Since

Data Collection Base Framework, Release 1.0

Cisco VPN Solutions Center, Release 1.0

elementAtIndex()

Gets the AllStatsCollection element at the specified index.

Usage

AllStats elementAtIndex(
in long index)

raises(
InvalidIndexException,
InvalidatedException);

Parameters

index---in long value that specifies the index of the element to get.

Returns

AllStats that represents the specified AllStatsCollection element.

Raises

Description

Note: This operation does not affect the sequential index used by the nextElement() and nextElements() operations.

See Also

setIndex, getIndex, nextElement, nextElements, elementsAtIndex, size

Since

Data Collection Base Framework, Release 1.0

Cisco VPN Solutions Center, Release 1.0

elementsAtIndex()

Gets a specified number of AllStatsCollection elements at the specified index.

Usage

AllStatsSeq elementsAtIndex(
in long index,
in long numberOfElements)

raises(
InvalidIndexException,
InvalidatedException);

Parameters

index---in long value that specifies the index of the first element to get.

numberOfElements---in long that indicates the number of AllStatsCollection elements to get.

Returns

AllStatsSeq that represent the specified AllStatsCollection elements.

Raises

Description

If the end of the collection is reached before the specified numberOfElements is returned, AllStatsCollection elements are returned until the end of the collection is reached. The collection may also return fewer elements than requested to reduce the message size, but a minimum of one collection element is returned, if available.

Note: This operation does not affect the sequential index used by the nextElement() and nextElements() operations.

See Also

setIndex, getIndex, nextElement, nextElements, elementAtIndex, size

Since

Data Collection Base Framework, Release 1.0

Cisco VPN Solutions Center, Release 1.0

getIndex()

Gets the index value of the current AllStatsCollection element.

Usage

long getIndex();
raises(
InvalidatedException);

Returns

long---Index of the element at the current position in the AllStatsCollection collection.

Raises

DCBFWCollection::InvalidatedException if this collectionis invalidated by the server.

Description

The AllStatsCollection index is initialized to 0 and is incremented when collection elements are traversed sequentially using the nextElement() or nextElements() operations.

See Also

setIndex, nextElement, nextElements, elementAtIndex, elementsAtIndex, size

Since

Data Collection Base Framework, Release 1.0

Cisco VPN Solutions Center, Release 1.0

nextElement()

Gets the next AllStatsCollection element.

Usage

AllStats nextElement();
raises(
EndOfCollectionException,
InvalidatedException);

Returns

AllStats that represents the next AllStatsCollection element.

Raises

Description

Executing the nextElement() operation increments the sequential index.

See Also

setIndex, getIndex, nextElements, elementAtIndex, elementsAtIndex, size

Since

Data Collection Base Framework, Release 1.0

Cisco VPN Solutions Center, Release 1.0

nextElements()

Gets the next few AllStatsCollection elements.

Usage

AllStatsSeq nextElements(
in long numberOfElements)

raises(
EndOfCollectionException,
InvalidatedException);

Parameters

numberOfElements---in long that indicates the number of elements to get.

Returns

AllStatsSeq that represent the next few AllStatsCollection elements as specified by the numberOfElements input value.

Raises

Description

See Also

setIndex, getIndex, nextElement, elementAtIndex, elementsAtIndex, size

Since

Data Collection Base Framework, Release 1.0

Cisco VPN Solutions Center, Release 1.0

setIndex()

Sets the index value of the current AllStatsCollection element.

Usage

void setIndex(
in long index)

raises(
InvalidatedException,
InvalidIndexException);

Parameters

index---in long that represents the index to value assign to the current AllStatsCollection element.

Raises

Description

The AllStatsCollection index is initialized to 0 and is incremented when collection elements are traversed sequentially using the nextElement() or nextElements() operations.

See Also

getIndex, nextElement, nextElements, elementAtIndex, elementsAtIndex, size

Since

Data Collection Base Framework, Release 1.0

Cisco VPN Solutions Center, Release 1.0

Interface SAABucketCollection

A collection interface which provides access to a group of SAABucket struct. The SAABucket struct can either be accessed as an SAABucketSeq, iterated an element at a time or accessed randomly by element position in the collection.

Attributes

readonly attribute long size

A readonly attribute that represents the number of elements in the SAABucketCollection collection.

See Also

setIndex, getIndex, nextElement, nextElements, elementAtIndex, elementsAtIndex, dispose

Since

Data Collection Base Framework, Release 1.0

Cisco VPN Solutions Center, Release 1.0

Operations

dispose()

Disposes the SAABucketCollection object and frees the server resources that are associated with it.

Usage

void dispose();

Description

Once executed, the SAABucketCollection object is no longer accessible by the client. In addition, the server may free this object automatically after some time. Program your clients to retrieve data from a collection when it is first is acquired, rather than waiting before examining the data.

See Also

SAABucketCollection

Since

Data Collection Base Framework, Release 1.0

Cisco VPN Solutions Center, Release 1.0

elementAtIndex()

Gets the SAABucketCollection element at the specified index.

Usage

SAABucket elementAtIndex(
in long index)

raises(
InvalidIndexException,
InvalidatedException);

Parameters

index---in long value that specifies the index of the element to get.

Returns

SAABucket that represents the specified SAABucketCollection element.

Raises

Description

Note: This operation does not affect the sequential index used by the nextElement() and nextElements() operations.

See Also

setIndex, getIndex, nextElement, nextElements, elementsAtIndex, size

Since

Data Collection Base Framework, Release 1.0

Cisco VPN Solutions Center, Release 1.0

elementsAtIndex()

Gets a specified number of SAABucketCollection elements at the specified index.

Usage

SAABucketSeq elementsAtIndex(
in long index,
in long numberOfElements)

raises(
InvalidIndexException,
InvalidatedException);

Parameters

index---in long value that specifies the index of the first element to get.

numberOfElements---in long that indicates the number of SAABucketCollection elements to get.

Returns

SAABucketSeq that represent the specified SAABucketCollection elements.

Raises

Description

If the end of the collection is reached before the specified numberOfElements is returned, SAABucketCollection elements are returned until the end of the collection is reached. The collection may also return fewer elements than requested to reduce the message size, but a minimum of one collection element is returned, if available.

Note: This operation does not affect the sequential index used by the nextElement() and nextElements() operations.

See Also

setIndex, getIndex, nextElement, nextElements, elementAtIndex, size

Since

Data Collection Base Framework, Release 1.0

Cisco VPN Solutions Center, Release 1.0

getIndex()

Gets the index value of the current SAABucketCollection element.

Usage

long getIndex();
raises(
InvalidatedException);

Returns

long---Index of the element at the current position in the SAABucketCollection collection.

Raises

DCBFWCollection::InvalidatedException if this collectionis invalidated by the server.

Description

The SAABucketCollection index is initialized to 0 and is incremented when collection elements are traversed sequentially using the nextElement() or nextElements() operations.

See Also

setIndex, nextElement, nextElements, elementAtIndex, elementsAtIndex, size

Since

Data Collection Base Framework, Release 1.0

Cisco VPN Solutions Center, Release 1.0

nextElement()

Gets the next SAABucketCollection element.

Usage

SAABucket nextElement();
raises(
EndOfCollectionException,
InvalidatedException);

Returns

SAABucket that represents the next SAABucketCollection element.

Raises

Description

Executing the nextElement() operation increments the sequential index.

See Also

setIndex, getIndex, nextElements, elementAtIndex, elementsAtIndex, size

Since

Data Collection Base Framework, Release 1.0

Cisco VPN Solutions Center, Release 1.0

nextElements()

Gets the next few SAABucketCollection elements.

Usage

SAABucketSeq nextElements(
in long numberOfElements)

raises(
EndOfCollectionException,
InvalidatedException);

Parameters

numberOfElements---in long that indicates the number of elements to get.

Returns

SAABucketSeq that represent the next few SAABucketCollection elements as specified by the numberOfElements input value.

Raises

Description

See Also

setIndex, getIndex, nextElement, elementAtIndex, elementsAtIndex, size

Since

Data Collection Base Framework, Release 1.0

Cisco VPN Solutions Center, Release 1.0

setIndex()

Sets the index value of the current SAABucketCollection element.

Usage

void setIndex(
in long index)

raises(
InvalidatedException,
InvalidIndexException);

Parameters

index---in long that represents the index to value assign to the current SAABucketCollection element.

Raises

Description

The SAABucketCollection index is initialized to 0 and is incremented when collection elements are traversed sequentially using the nextElement() or nextElements() operations.

See Also

getIndex, nextElement, nextElements, elementAtIndex, elementsAtIndex, size

Since

Data Collection Base Framework, Release 1.0

Cisco VPN Solutions Center, Release 1.0

Interface SAADataSet

Each SAADataSet object represents a raw SAA dataset collected for a particular interval. It contains statistics for all SAA probes defined on that router.

The SAA dataset is collected on a regular basis to provide 24 x 7 coverage. Typically the collection interval is one hour. Information regarding when the dataset was collected and how many entries were present is maintained in the more generic DeviceDataSet object.

Operations

entries()

Get the statistics collected during an interval for all the SAA probes defined on a particular SAA router.

Usage

SAAEntryCollection entries();

Returns

SAADataSetEntryCollection a collection of individual probe statistics observed over the particular collection interval, which typically is one hour.

Description

This is the most basic form in which SAA statistics are persistently kept in the repository. There is one SAAEntry per probe defined on the SAA router.

Interface SAADataSetCollection

A collection interface which provides access to a group of SAADataSet struct. The SAADataSet struct can either be accessed as an SAADataSetSeq, iterated an element at a time or accessed randomly by element position in the collection.

Attributes

readonly attribute long size

A readonly attribute that represents the number of elements in the SAADataSetCollection collection.

See Also

setIndex, getIndex, nextElement, nextElements, elementAtIndex, elementsAtIndex, dispose

Since

Data Collection Base Framework, Release 1.0

Cisco VPN Solutions Center, Release 1.0

Operations

dispose()

Disposes the SAADataSetCollection object and frees the server resources that are associated with it.

Usage

void dispose();

Description

Once executed, the SAADataSetCollection object is no longer accessible by the client. In addition, the server may free this object automatically after some time. Program your clients to retrieve data from a collection when it is first is acquired, rather than waiting before examining the data.

See Also

SAADataSetCollection

Since

Data Collection Base Framework, Release 1.0

Cisco VPN Solutions Center, Release 1.0

elementAtIndex()

Gets the SAADataSetCollection element at the specified index.

Usage

SAADataSet elementAtIndex(
in long index)

raises(
InvalidIndexException,
InvalidatedException);

Parameters

index---in long value that specifies the index of the element to get.

Returns

SAADataSet that represents the specified SAADataSetCollection element.

Raises

Description

Note: This operation does not affect the sequential index used by the nextElement() and nextElements() operations.

See Also

setIndex, getIndex, nextElement, nextElements, elementsAtIndex, size

Since

Data Collection Base Framework, Release 1.0

Cisco VPN Solutions Center, Release 1.0

elementsAtIndex()

Gets a specified number of SAADataSetCollection elements at the specified index.

Usage

SAADataSetSeq elementsAtIndex(
in long index,
in long numberOfElements)

raises(
InvalidIndexException,
InvalidatedException);

Parameters

index---in long value that specifies the index of the first element to get.

numberOfElements---in long that indicates the number of SAADataSetCollection elements to get.

Returns

SAADataSetSeq that represent the specified SAADataSetCollection elements.

Raises

Description

If the end of the collection is reached before the specified numberOfElements is returned, SAADataSetCollection elements are returned until the end of the collection is reached. The collection may also return fewer elements than requested to reduce the message size, but a minimum of one collection element is returned, if available.

Note: This operation does not affect the sequential index used by the nextElement() and nextElements() operations.

See Also

setIndex, getIndex, nextElement, nextElements, elementAtIndex, size

Since

Data Collection Base Framework, Release 1.0

Cisco VPN Solutions Center, Release 1.0

getIndex()

Gets the index value of the current SAADataSetCollection element.

Usage

long getIndex();
raises(
InvalidatedException);

Returns

long---Index of the element at the current position in the SAADataSetCollection collection.

Raises

DCBFWCollection::InvalidatedException if this collectionis invalidated by the server.

Description

The SAADataSetCollection index is initialized to 0 and is incremented when collection elements are traversed sequentially using the nextElement() or nextElements() operations.

See Also

setIndex, nextElement, nextElements, elementAtIndex, elementsAtIndex, size

Since

Data Collection Base Framework, Release 1.0

Cisco VPN Solutions Center, Release 1.0

nextElement()

Gets the next SAADataSetCollection element.

Usage

SAADataSet nextElement();
raises(
EndOfCollectionException,
InvalidatedException);

Returns

SAADataSet that represents the next SAADataSetCollection element.

Raises

Description

Executing the nextElement() operation increments the sequential index.

See Also

setIndex, getIndex, nextElements, elementAtIndex, elementsAtIndex, size

Since

Data Collection Base Framework, Release 1.0

Cisco VPN Solutions Center, Release 1.0

nextElements()

Gets the next few SAADataSetCollection elements.

Usage

SAADataSetSeq nextElements(
in long numberOfElements)

raises(
EndOfCollectionException,
InvalidatedException);

Parameters

numberOfElements---in long that indicates the number of elements to get.

Returns

SAADataSetSeq that represent the next few SAADataSetCollection elements as specified by the numberOfElements input value.

Raises

Description

See Also

setIndex, getIndex, nextElement, elementAtIndex, elementsAtIndex, size

Since

Data Collection Base Framework, Release 1.0

Cisco VPN Solutions Center, Release 1.0

setIndex()

Sets the index value of the current SAADataSetCollection element.

Usage

void setIndex(
in long index)

raises(
InvalidatedException,
InvalidIndexException);

Parameters

index---in long that represents the index to value assign to the current SAADataSetCollection element.

Raises

Description

The SAADataSetCollection index is initialized to 0 and is incremented when collection elements are traversed sequentially using the nextElement() or nextElements() operations.

See Also

getIndex, nextElement, nextElements, elementAtIndex, elementsAtIndex, size

Since

Data Collection Base Framework, Release 1.0

Cisco VPN Solutions Center, Release 1.0

Interface SAAEntryCollection

A collection interface which provides access to a group of SAAEntry struct. The SAAEntry struct can either be accessed as an SAAEntrySeq, iterated an element at a time or accessed randomly by element position in the collection.

Attributes

readonly attribute long size

A readonly attribute that represents the number of elements in the SAAEntryCollection collection.

See Also

setIndex, getIndex, nextElement, nextElements, elementAtIndex, elementsAtIndex, dispose

Since

Data Collection Base Framework, Release 1.0

Cisco VPN Solutions Center, Release 1.0

Operations

dispose()

Disposes the SAAEntryCollection object and frees the server resources that are associated with it.

Usage

void dispose();

Description

Once executed, the SAAEntryCollection object is no longer accessible by the client. In addition, the server may free this object automatically after some time. Program your clients to retrieve data from a collection when it is first is acquired, rather than waiting before examining the data.

See Also

SAAEntryCollection

Since

Data Collection Base Framework, Release 1.0

Cisco VPN Solutions Center, Release 1.0

elementAtIndex()

Gets the SAAEntryCollection element at the specified index.

Usage

SAAEntry elementAtIndex(
in long index)

raises(
InvalidIndexException,
InvalidatedException);

Parameters

index---in long value that specifies the index of the element to get.

Returns

SAAEntry that represents the specified SAAEntryCollection element.

Raises

Description

Note: This operation does not affect the sequential index used by the nextElement() and nextElements() operations.

See Also

setIndex, getIndex, nextElement, nextElements, elementsAtIndex, size

Since

Data Collection Base Framework, Release 1.0

Cisco VPN Solutions Center, Release 1.0

elementsAtIndex()

Gets a specified number of SAAEntryCollection elements at the specified index.

Usage

SAAEntrySeq elementsAtIndex(
in long index,
in long numberOfElements)

raises(
InvalidIndexException,
InvalidatedException);

Parameters

index---in long value that specifies the index of the first element to get.

numberOfElements---in long that indicates the number of SAAEntryCollection elements to get.

Returns

SAAEntrySeq that represent the specified SAAEntryCollection elements.

Raises

Description

If the end of the collection is reached before the specified numberOfElements is returned, SAAEntryCollection elements are returned until the end of the collection is reached. The collection may also return fewer elements than requested to reduce the message size, but a minimum of one collection element is returned, if available.

Note: This operation does not affect the sequential index used by the nextElement() and nextElements() operations.

See Also

setIndex, getIndex, nextElement, nextElements, elementAtIndex, size

Since

Data Collection Base Framework, Release 1.0

Cisco VPN Solutions Center, Release 1.0

getIndex()

Gets the index value of the current SAAEntryCollection element.

Usage

long getIndex();
raises(
InvalidatedException);

Returns

long---Index of the element at the current position in the SAAEntryCollection collection.

Raises

DCBFWCollection::InvalidatedException if this collectionis invalidated by the server.

Description

The SAAEntryCollection index is initialized to 0 and is incremented when collection elements are traversed sequentially using the nextElement() or nextElements() operations.

See Also

setIndex, nextElement, nextElements, elementAtIndex, elementsAtIndex, size

Since

Data Collection Base Framework, Release 1.0

Cisco VPN Solutions Center, Release 1.0

nextElement()

Gets the next SAAEntryCollection element.

Usage

SAAEntry nextElement();
raises(
EndOfCollectionException,
InvalidatedException);

Returns

SAAEntry that represents the next SAAEntryCollection element.

Raises

Description

Executing the nextElement() operation increments the sequential index.

See Also

setIndex, getIndex, nextElements, elementAtIndex, elementsAtIndex, size

Since

Data Collection Base Framework, Release 1.0

Cisco VPN Solutions Center, Release 1.0

nextElements()

Gets the next few SAAEntryCollection elements.

Usage

SAAEntrySeq nextElements(
in long numberOfElements)

raises(
EndOfCollectionException,
InvalidatedException);

Parameters

numberOfElements---in long that indicates the number of elements to get.

Returns

SAAEntrySeq that represent the next few SAAEntryCollection elements as specified by the numberOfElements input value.

Raises

Description

See Also

setIndex, getIndex, nextElement, elementAtIndex, elementsAtIndex, size

Since

Data Collection Base Framework, Release 1.0

Cisco VPN Solutions Center, Release 1.0

setIndex()

Sets the index value of the current SAAEntryCollection element.

Usage

void setIndex(
in long index)

raises(
InvalidatedException,
InvalidIndexException);

Parameters

index---in long that represents the index to value assign to the current SAAEntryCollection element.

Raises

Description

The SAAEntryCollection index is initialized to 0 and is incremented when collection elements are traversed sequentially using the nextElement() or nextElements() operations.

See Also

getIndex, nextElement, nextElements, elementAtIndex, elementsAtIndex, size

Since

Data Collection Base Framework, Release 1.0

Cisco VPN Solutions Center, Release 1.0

Interface SAARouter

It represents the SAA router on which a set of SLAs are defined. This is the router on which the SAA agent resides. Any router designated to perform SAA operation has to have the SAA IOS image. In most respect, and SAA router is just like any other IOS router.

There are several SAA routers in the network. Some of these routers are referred to as shadow routers. A shadow router is the one associated with a particular PE router.

The SAARouter object maintains some additional SAA based information. The rest of the definition is based on the Target object defined in the DCDirectory module.

Any raw SAA dataset is always associated with a particular SAA router object.

Attributes

readonly attribute string fullName

Name format : This name should be passed to the API receiving router name.

readonly attribute long numProbes

The total number of probes defined on the SAA router. Typically each SLA is mapped to a probe on the source SAA router. The total # of probes would include any probes created by other owners of the SAA router.

readonly attribute string SAAVersion

SAA Agent version number. This would be a quick tracking mechanism for debug actions.

Operations

getAllDatasets()

Get all SAA datasets collected from this SAA router.

Usage

SAADataSetCollection getAllDatasets();
raises(
CiscoSlaMonitorException);

Returns

SAADataSetCollection containing SAADataSet objectsrepresenting raw collected data from this router.

Raises

CiscoSlaMonitor::CiscoSlaMonitorException to indicate errorencountered somewhere during the processing of this operation.

Description

At regular intervals, typically every hour, the SAA data collector collects SAA statistics from the router. Each collected dataset is marked and stored in the repository. This is the lowest form of collected SAA data. This operation returns all the datasets currently available in the repository.

Due to the large storage requirements for raw datasets, these datasets will typically be purged periodically, based on a rollover scheme. This operation will return as many raw datasets currently preserved in the repository.

getLatestDataset()

Get the latest SAA dataset collected from this SAA router.

Usage

SAADataSet getLatestDataset();
raises(
CiscoSlaMonitorException);

Returns

SAADataSet representing most recently collected raw data from this router.

Raises

CiscoSlaMonitor::CiscoSlaMonitorException to indicate errorencountered somewhere during the processing of this operation.

Description

There are always multiple datasets associated with each SAA router. The latest dataset is a likely target for debug purpose.

queryDatasets()

Get the SAA datasets collected from this SAA router based on a particular search criteria.

Usage

SAADataSetCollection queryDatasets(
in DCBFWQuery::QueryPrimitiveSeq membership)

raises(
CiscoSlaMonitorException);

Returns

SAADataSetCollection representing datasets collected from this router which match a particular request criteria.

Raises

CiscoSlaMonitor::CiscoSlaMonitorException to indicate errorencountered somewhere during the processing of this operation.

Description

Instead of accessing all the datasets associated with a router or the latest dataset, this operation chooses the datasets based on a query. It is similar to the queryDatasets operation supported by the SlaBrowser. In this case, the source router has already been narrowed down to a particular router.

See Also

SlaBrowser :: queryDatasets

Interface SAARouterCollection

A collection interface which provides access to a group of SAARouter struct. The SAARouter struct can either be accessed as an SAARouterSeq, iterated an element at a time or accessed randomly by element position in the collection.

Attributes

readonly attribute long size

A readonly attribute that represents the number of elements in the SAARouterCollection collection.

See Also

setIndex, getIndex, nextElement, nextElements, elementAtIndex, elementsAtIndex, dispose

Since

Data Collection Base Framework, Release 1.0

Cisco VPN Solutions Center, Release 1.0

Operations

dispose()

Disposes the SAARouterCollection object and frees the server resources that are associated with it.

Usage

void dispose();

Description

Once executed, the SAARouterCollection object is no longer accessible by the client. In addition, the server may free this object automatically after some time. Program your clients to retrieve data from a collection when it is first is acquired, rather than waiting before examining the data.

See Also

SAARouterCollection

Since

Data Collection Base Framework, Release 1.0

Cisco VPN Solutions Center, Release 1.0

elementAtIndex()

Gets the SAARouterCollection element at the specified index.

Usage

SAARouter elementAtIndex(
in long index)

raises(
InvalidIndexException,
InvalidatedException);

Parameters

index---in long value that specifies the index of the element to get.

Returns

SAARouter that represents the specified SAARouterCollection element.

Raises

Description

Note: This operation does not affect the sequential index used by the nextElement() and nextElements() operations.

See Also

setIndex, getIndex, nextElement, nextElements, elementsAtIndex, size

Since

Data Collection Base Framework, Release 1.0

Cisco VPN Solutions Center, Release 1.0

elementsAtIndex()

Gets a specified number of SAARouterCollection elements at the specified index.

Usage

SAARouterSeq elementsAtIndex(
in long index,
in long numberOfElements)

raises(
InvalidIndexException,
InvalidatedException);

Parameters

index---in long value that specifies the index of the first element to get.

numberOfElements---in long that indicates the number of SAARouterCollection elements to get.

Returns

SAARouterSeq that represent the specified SAARouterCollection elements.

Raises

Description

If the end of the collection is reached before the specified numberOfElements is returned, SAARouterCollection elements are returned until the end of the collection is reached. The collection may also return fewer elements than requested to reduce the message size, but a minimum of one collection element is returned, if available.

Note: This operation does not affect the sequential index used by the nextElement() and nextElements() operations.

See Also

setIndex, getIndex, nextElement, nextElements, elementAtIndex, size

Since

Data Collection Base Framework, Release 1.0

Cisco VPN Solutions Center, Release 1.0

getIndex()

Gets the index value of the current SAARouterCollection element.

Usage

long getIndex();
raises(
InvalidatedException);

Returns

long---Index of the element at the current position in the SAARouterCollection collection.

Raises

DCBFWCollection::InvalidatedException if this collectionis invalidated by the server.

Description

The SAARouterCollection index is initialized to 0 and is incremented when collection elements are traversed sequentially using the nextElement() or nextElements() operations.

See Also

setIndex, nextElement, nextElements, elementAtIndex, elementsAtIndex, size

Since

Data Collection Base Framework, Release 1.0

Cisco VPN Solutions Center, Release 1.0

nextElement()

Gets the next SAARouterCollection element.

Usage

SAARouter nextElement();
raises(
EndOfCollectionException,
InvalidatedException);

Returns

SAARouter that represents the next SAARouterCollection element.

Raises

Description

Executing the nextElement() operation increments the sequential index.

See Also

setIndex, getIndex, nextElements, elementAtIndex, elementsAtIndex, size

Since

Data Collection Base Framework, Release 1.0

Cisco VPN Solutions Center, Release 1.0

nextElements()

Gets the next few SAARouterCollection elements.

Usage

SAARouterSeq nextElements(
in long numberOfElements)

raises(
EndOfCollectionException,
InvalidatedException);

Parameters

numberOfElements---in long that indicates the number of elements to get.

Returns

SAARouterSeq that represent the next few SAARouterCollection elements as specified by the numberOfElements input value.

Raises

Description

See Also

setIndex, getIndex, nextElement, elementAtIndex, elementsAtIndex, size

Since

Data Collection Base Framework, Release 1.0

Cisco VPN Solutions Center, Release 1.0

setIndex()

Sets the index value of the current SAARouterCollection element.

Usage

void setIndex(
in long index)

raises(
InvalidatedException,
InvalidIndexException);

Parameters

index---in long that represents the index to value assign to the current SAARouterCollection element.

Raises

Description

The SAARouterCollection index is initialized to 0 and is incremented when collection elements are traversed sequentially using the nextElement() or nextElements() operations.

See Also

getIndex, nextElement, nextElements, elementAtIndex, elementsAtIndex, size

Since

Data Collection Base Framework, Release 1.0

Cisco VPN Solutions Center, Release 1.0

Interface Sla

This interface provides access to the Sla object. The Sla object represents the definition of SLA programmed on a particular SAA router. SlaInfo contains the relevant parameters which define an SLA. A subset of those parameters defines an SLA uniquely. The parameters which form the key for an SLA are,

Customer Name
Source IP Address
Destination IP Address
Protocol
Request Size
Threshold

Two SLA identical in all key values except the exchange of end points are considered to be similar. When the request to create a new SLA is received, the SLA Monitor ensures that another SLA with matching key does not exist.

Attributes

readonly attribute SlaId id

A readonly attribute specifying the unique id for an Sla. This id is a unique value across all SLA defined in this repository.

Operations

getInfo()

Get the detailed information about an Sla.

Usage

SlaInfo getInfo();

Returns

SlaInfo represents the parameters which define an Sla.

Interface SlaBrowser

This interface provides access to various SLA browsing operations. It only operates on the existing SLA definitions. The statistics it serves up is also based upon data already collected and saved in the repository. To create a new SLA, use SlaCreator interface.

The user can query the SLA browser for different SLA definitions. This interface is also used to access SLA statistics at various levels of detail. The statistics is gathered for the various SLA defined and programmed on the SAA routers in the network. The statistics are collected and saved persistently on a 24 x 7 basis.

The purpose of the SLA browser within the SLA Monitor is to provide access to aggregated analyzed version of SLA stats. If the client application is interested in raw SAA statistics, the SAA data monitor api should be used.

Operations

addSla()

Add an Sla to an SlaSeq.

Usage

SlaSeq addSla(
in SlaSeq c1,
in Sla slaElement)

raises(
CiscoSlaMonitorException);

Returns

SlaSeq containing the additional new Sla object.

Raises

CiscoSlaMonitor::CiscoSlaMonitorException to indicate error encountered somewhere during the processing of this operation.

Description

It returns a reference back to the SlaSeq which now contains the new Sla element, if it did not already exist in the collection.

addSlaCollection()

Add one SlaSeq to another SlaSeq returning a combined SlaSeq.

Usage

SlaSeq addSlaCollection(
in SlaSeq c1,
in SlaSeq c2)

raises(
CiscoSlaMonitorException);

Returns

SlaSeq containing the elements from both Sla Collections.

Raises

CiscoSlaMonitor::CiscoSlaMonitorException to indicate error encountered somewhere during the processing of this operation.

Description

It returns a reference back to the first SlaSeq which now contains elements from the second SlaSeq. Any entries in the second SlaSeq which already exist in the first SlaSeq are not added.

findAllCustomers()

Finds all the customer names. These names appear in the created and collected SLA, may be a subset of all the customers defined.

Usage

StringSeq findAllCustomers();
raises(
CiscoSlaMonitorException);

Returns

StringSeq represents all the customer names.

Raises

CiscoSlaMonitor::CiscoSlaMonitorException to indicate error encountered somewhere during the processing of this operation.

Description

If no SLA exists returns empty sequence.

findAllDestinationRouterNames()

Find all identified destination router names.

Usage

StringSeq findAllDestinationRouterNames();
raises(
CiscoSlaMonitorException);

Returns

StringSeq containing all the SAA routers names known in this repository. Name format :.

Raises

CiscoSlaMonitor::CiscoSlaMonitorException to indicate errorencountered somewhere during the processing of this operation.

Description

These routers have the SAA based IOS image on them. When a router Target is defined, it has an indicator for being an SAA router. All router objects are eventually defined in the repository.

See Also

findAllDestinationRouters

findAllDestinationRouters()

Find all identified routers that are the target of the known SLAs, these routers are not necassarily SAA routers.

Usage

SAARouterCollection findAllDestinationRouters();
raises(
CiscoSlaMonitorException);

Returns

SAARouterCollection containing all the destination routers known in this repository.

Raises

CiscoSlaMonitor::CiscoSlaMonitorException to indicate errorencountered somewhere during the processing of this operation.

Description

These routers are the destination routers of SLAs known to the repository. They need not be SAA routers. All router objects are eventually defined in the repository.

See Also

findAllDestinationRouterNames

findAllSAACENames()

Find all CE SAA routers.

Usage

StringSeq findAllSAACENames();
raises(
CiscoSlaMonitorException);

Returns

StringSeq containing all the CE SAA router names known in this repository. Name format :.

Raises

CiscoSlaMonitor::CiscoSlaMonitorException to indicate errorencountered somewhere during the processing of this operation.

Description

These routers have the SAA based IOS image on them. When a router Target is defined, it has an indicator for being an SAA router. All router objects are eventually defined in the repository.

See Also

findAllSAACEs

findAllSAACENamesPerCustomer()

Find all CE SAA router names belong to a specific customer.

Usage

StringSeq findAllSAACENamesPerCustomer(
in string customerName)

raises(
CiscoSlaMonitorException);

Parameters

customerName--- in string identifies the customer.

Returns

StringSeq containing all the CE SAA router names known in this repository that belong to the specified customer.

Raises

CiscoSlaMonitor::CiscoSlaMonitorException to indicate errorencountered somewhere during the processing of this operation.

Description

These routers have the SAA based IOS image on them. When a router Target is defined, it has an indicator for being an SAA router. All router objects are eventually defined in the repository.

See Also

findAllSAACEsPerCustomer

findAllSAACEs()

Find all CE SAA routers.

Usage

SAARouterCollection findAllSAACEs();
raises(
CiscoSlaMonitorException);

Returns

SAARouterCollection containing all the CE SAA routers known in this repository.

Raises

CiscoSlaMonitor::CiscoSlaMonitorException to indicate errorencountered somewhere during the processing of this operation.

Description

These routers have the SAA based IOS image on them. When a router Target is defined, it has an indicator for being an SAA router. All router objects are eventually defined in the repository.

Each SAA router will have a certain number of SLA associated with it. Those SLA are created on the SAA router as a probe with the appropriate settings. At every collection interval, the SAA statistics is collected from each SAA router and saved in the repository as a data set. This is typically referred to as the raw SAA dataset.

A SAARouter object can be used to access raw SAA datasets.This is kind of a lower level IDL access. Typically a client application would prefer to use the operations which provide aggregated statistics. Those values are computed by performing aggregation and analysis on the raw data.

The raw SAA data set is accessed when a client application needs to perform certain analysis which is not provided by the SlaManger. It is also used to perform debug operations.

findAllSAACEsPerCustomer()

Find all CE SAA routers belong to a specific customer.

Usage

SAARouterCollection findAllSAACEsPerCustomer(
in string customerName)

raises(
CiscoSlaMonitorException);

Parameters

customerName--- in string identifies the customer.

Returns

SAARouterCollection containing all the CE SAA routers known in this repository that belong to the specified customer.

Raises

CiscoSlaMonitor::CiscoSlaMonitorException to indicate errorencountered somewhere during the processing of this operation.

Description

These routers have the SAA based IOS image on them. When a router Target is defined, it has an indicator for being an SAA router. All router objects are eventually defined in the repository.

The raw SAA data set is accessed when a client application needs to perform certain analysis which is not provided by the SlaManger. It is also used to perform debug operations.

findAllSAAPENames()

Find all PE SAA router names.

Usage

StringSeq findAllSAAPENames();
raises(
CiscoSlaMonitorException);

Returns

StringSeq containing all the PE SAA router names known in this repository. Name format :.

Raises

CiscoSlaMonitor::CiscoSlaMonitorException to indicate errorencountered somewhere during the processing of this operation.

Description

These routers have the SAA based IOS image on them. When a router Target is defined, it has an indicator for being an SAA router. All router objects are eventually defined in the repository.

See Also

findAllSAAPEs

findAllSAAPEs()

Find all PE SAA routers.

Usage

SAARouterCollection findAllSAAPEs();
raises(
CiscoSlaMonitorException);

Returns

SAARouterCollection containing all the PE SAA routers known in this repository.

Raises

CiscoSlaMonitor::CiscoSlaMonitorException to indicate errorencountered somewhere during the processing of this operation.

Description

These routers have the SAA based IOS image on them. When a router Target is defined, it has an indicator for being an SAA router. All router objects are eventually defined in the repository.

The raw SAA data set is accessed when a client application needs to perform certain analysis which is not provided by the SlaManger. It is also used to perform debug operations.

See Also

findAllSAAPENames

findAllSAARouterNames()

Find all known SAA router names.

Usage

StringSeq findAllSAARouterNames();
raises(
CiscoSlaMonitorException);

Returns

StringSeq containing all the SAA routers names known in this repository. Name format :.

Raises

CiscoSlaMonitor::CiscoSlaMonitorException to indicate errorencountered somewhere during the processing of this operation.

Description

These routers have the SAA based IOS image on them. When a router Target is defined, it has an indicator for being an SAA router. All router objects are eventually defined in the repository.

See Also

findAllSAARouters

findAllSAARouters()

Find all known SAA routers.

Usage

SAARouterCollection findAllSAARouters();
raises(
CiscoSlaMonitorException);

Returns

SAARouterCollection containing all the SAA routers known in this repository.

Raises

CiscoSlaMonitor::CiscoSlaMonitorException to indicate errorencountered somewhere during the processing of this operation.

Description

These routers have the SAA based IOS image on them. When a router Target is defined, it has an indicator for being an SAA router. All router objects are eventually defined in the repository.

The raw SAA data set is accessed when a client application needs to perform certain analysis which is not provided by the SlaManger. It is also used to perform debug operations.

See Also

findAllSAARouterNames

findAllSla()

Find all SLA definitions known by the server.

Usage

SlaSeq findAllSla();
raises(
CiscoSlaMonitorException);

Returns

SlaSeq for all known SLA definitions.

Raises

CiscoSlaMonitor::CiscoSlaMonitorException to indicate errorencountered somewhere during the processing of this operation.

Description

A unique instance of each SLA defined in the network and known by this repository is returned as a member of the collection.

findAllVpns()

Finds all the vpn names. These names appear in the created and collected SLA, may be a subset of all the vpns defined.

Usage

StringSeq findAllVpns();
raises(
CiscoSlaMonitorException);

Returns

StringSeq represents all the vpn names.

Raises

CiscoSlaMonitor::CiscoSlaMonitorException to indicate error encountered somewhere during the processing of this operation.

Description

If no SLA exists returns empty sequence.

findSlaByCustomer()

Finds all the SLA definitions for a particular customer identified by the customer name.

Usage

SlaSeq findSlaByCustomer(
in string customerName)

raises(
CiscoSlaMonitorException);

Parameters

customerName--- in string identifies the customer.

Returns

SlaSeq represents the SLA definitions for this customer.

Raises

CiscoSlaMonitor::CiscoSlaMonitorException to indicate error encountered somewhere during the processing of this operation.

Description

If no SLA is defined for this customer, an empty sequence is returned.

findSlaByDestinationRouterAndTos()

Find all SLA definitions which terminate on a particular SAA router and belong to the specified type of service.

Usage

SlaSeq findSlaByDestinationRouterAndTos(
in string routerName,
in TypeOfService tos)

raises(
CiscoSlaMonitorException);

Parameters

routerName--- in string name of the destination SAA router.

tos--- in TypeOfService the SLA class of service.

Returns

SlaSeq whose end point match the given IP address.

Raises

CiscoSlaMonitor::CiscoSlaMonitorException to indicate errorencountered somewhere during the processing of this operation.

Description

All SLA with destination router matching the specified name and type of service matching the specified returned. If none found, an empty sequence is returned. Note that not all the SLA types have a specified destination router.

See Also

findSlaBySourceRouterAndTos

findSlaByEndpoint()

Find all SLA definitions which originate or terminate at an IP address.

Usage

SlaSeq findSlaByEndpoint(
in IpAddressLong addr)

raises(
CiscoSlaMonitorException);

Parameters

addr--- in IpAddressLong IP address of the end point.

Returns

SlaSeq whose end point match the given IP address.

Raises

CiscoSlaMonitor::CiscoSlaMonitorException to indicate errorencountered somewhere during the processing of this operation.

Description

Each SLA has a source and a destination IP address. All SLA with either end point matching the specified IP address are returned. If none found, an empty sequence is returned.

See Also

findSlaBySourceRouter

findSlaByEndPointAndTos()

Find all SLA definitions which terminate on a particular SAA router and belong to the specified type of service.

Usage

SlaSeq findSlaByEndPointAndTos(
in IpAddressLong addr,
in TypeOfService tos)

raises(
CiscoSlaMonitorException);

Parameters

addr--- in IpAddressLong IP address of the end point. tos--- in TypeOfService the SLA class of service.

Returns

SlaSeq whose end point match the given IP address.

Raises

CiscoSlaMonitor::CiscoSlaMonitorException to indicate errorencountered somewhere during the processing of this operation.

Description

See Also

findSlaBySourceRouterAndTos

findSlaById()

Find a SLA definition matching the Id number.

Usage

Sla findSlaById(
in SlaId id)

raises(
CiscoSlaMonitorException,
UnknownSlaIdException);

Parameters

id--- in SlaId unique id for an SLA.

Returns

Sla for the specified Id. If no match, return null.

Raises

CiscoSlaMonitor::CiscoSlaMonitorException to indicate error encountered somewhere during the processing of this operation. CiscoSlaMonitor::UnknownSlaIdException to indicate that the sla identifier is unknown to the repository.

Description

SLA id number is unique across the complete repository. If a matching SLA is not found, a null object is returned.

findSlaByProtocol()

Find all SLA definitions for the specified protocol.

Usage

SlaSeq findSlaByProtocol(
in long protocol)

raises(
CiscoSlaMonitorException);

Parameters

protocol--- in long protocol type for the SLA.

Returns

SlaSeq defined for a particular type of protocol.

Raises

CiscoSlaMonitor::CiscoSlaMonitorException to indicate errorencountered somewhere during the processing of this operation.

Description

The protocol specifies the type of operation performed by the SAA MIB while measuring the SLA performance. If none found, an empty sequence is returned.

findSlaByProtocolName()

Find all SLA definitions for the specified protocol name.

Usage

SlaSeq findSlaByProtocolName(
in string protocolName)

raises(
UnknownProtocolException,
CiscoSlaMonitorException);

Parameters

protocolName--- in string protocol name for the SLA.

Returns

SlaSeq defined for a particular type of protocol.

Raises

CiscoSlaMonitor::CiscoSlaMonitorException to indicate error encountered somewhere during the processing of this operation. CiscoSlaMonitor::UnknownProtocolException if the protocol name is not valid.

Description

The protocol specifies the type of operation performed by the SAA MIB while measuring the SLA performance. If none found, an empty sequence is returned.

findSlaBySourceRouter()

Find all SLA defined on a particular SAA router.

Usage

SlaSeq findSlaBySourceRouter(
in string routerName)

raises(
CiscoSlaMonitorException);

Parameters

routerName--- in string name of an SAA router.

Returns

SlaSeq for all SLA created on this SAA router

Raises

CiscoSlaMonitor::CiscoSlaMonitorException to indicate errorencountered somewhere during the processing of this operation.

Description

Each SLA definition has an associated name of the router on which the SLA is to be created. The operation provices quick access to the SLA originating on that router. This is slightly different from the findSlaByEndpoint operation.

See Also

findSlaByEndpoint

findSlaBySourceRouterAndTos()

Find all SLA definitions which originate on a particular SAA router and belong to the specified type of service.

Usage

SlaSeq findSlaBySourceRouterAndTos(
in string routerName,
in TypeOfService tos)

raises(
CiscoSlaMonitorException);

Parameters

routerName--- in string name of an SAA router.

tos--- in TypeOfService the SLA class of service.

Returns

SlaSeq whose end point match the given IP address.

Raises

CiscoSlaMonitor::CiscoSlaMonitorException to indicate error encountered somewhere during the processing of this operation.

Description

Each SLA has a source router name and a type of service. All SLA with source router matching the specified name and type of service as specified returned. If none found, an empty sequence is returned.

See Also

findSlaBySourceRouter

findSlaByVpn()

Finds all the SLA definitions for a particular vpn identified by the vpn name.

Usage

SlaSeq findSlaByVpn(
in string vpnName)

raises(
CiscoSlaMonitorException);

Parameters

vpnName--- in string identifies the vpn.

Returns

SlaSeq represents the SLA definitions for this vpn.

Raises

CiscoSlaMonitor::CiscoSlaMonitorException to indicate error encountered somewhere during the processing of this operation.

Description

If no SLA is defined for this vpn, an empty sequence is returned.

getAllStats()

Get all SLA statistics for the selected SLA based on the aggregation and distributed over the time interval.

Usage

AggregateStatsCollection getAllStats(
in SlaSeq slaList,
in Aggregation aggregateBy,
in TimeInterval timeSlice,
in DCBFWQuery::QueryPrimitiveSeq membership)

raises(
CiscoSlaMonitorException);

Parameters

slaList--- in SlaSeq specifies the SLA definitions for which the results have to be computed. If a 'null' object is passed in instead of an SlaSeq, it indicates to return the results for all known SLA objects.

aggregateBy--- in Aggregation specifies the property over which the aggregation should be performed.

timeSlice--- in TimeInterval specifies the size of the bins in which aggregated statistics are maintained.

membership--- in Query::QueryPrimitiveSeq describes the criteria used to identify the base datasets on which the aggregation operation should be performed.

Returns

AggregateStatsCollection containing the requested SLA statistics.

Raises

CiscoSlaMonitor::CiscoSlaMonitorException to indicate errorencountered somewhere during the processing of this operation.

Description

Provide access to the SLA statistics in a higher level aggregated form. The various aggregations are the popular ways in which client applications would like to group the results.

slaList defines the problem space. The statistics for only those SLA are considered while creating the aggregated results. If this parameter is null, the work space is expanded over the statistics gathered for all SLA.

Since the statistics are gathered over time, it is highly likely that data points may be missing over certain intervals of time. This could be due to network issues or just that certain SLA were defined over time. The timeStamp field indicates the starting time of the interval.The client application needs to be aware of that situation. and check the time stamp.

The collection returned contains AggregateStats structs. The number of entries depends upon the number of unique items found for this Aggregation. For example, if Aggregation was set to be 'Customer' then the # of entries in the collection would be equal to the # of customers whose SLA were present in the slaList passed in, and have data for the membership defined.

Each AggregateStats contains a tag for the value by which it was aggregated, ie. customer name or VPN name. It also contains bins for the various occurences of these statistics based on the value of TimeInterval and membership definition.

The number of bins in an AggregateStats depends upon the number of time intervals covered and the data exist. For example, if the TimeInterval was Daily and the membership was defined for 15 days, then the number of bins would be 15 if there exist data for each day, otherwise the number if bins would be less than 15.

See Also

getConnectivityStats

getConnectivityStats()

Get only the connectivity percentage value for the selected SLA based on the aggregation and distributed over the time interval.

Usage

AggregateConnectivityCollection getConnectivityStats(
in SlaSeq slaList,
in Aggregation aggregateBy,
in TimeInterval timeSlice,
in DCBFWQuery::QueryPrimitiveSeq membership)

raises(
CiscoSlaMonitorException);

Parameters

aggregateBy--- in Aggregation specifies the property over which the aggregation should be performed.

timeSlice--- in TimeInterval specifies the size of the bins in which aggregated statistics are maintained.

membership--- in DCBFWQuery::QueryPrimitiveSeq describes the criteria used to identify the base datasets on which the aggregation operation should be performed.

Returns

AggregateConnectivityCollection containing aggregated connectivitypercent values

Raises

CiscoSlaMonitor::CiscoSlaMonitorException to indicate errorencountered somewhere during the processing of this operation.

Description

Provide access to just the connectivity value in a higher level aggregated form. The various aggregations are the popular ways in which client applications would like to group the results.

Since the statistics are gathered over time, it is highly likely that data points may be missing over certain intervals of time. This could be due to network issues or just that certain SLA were defined over time. The results are able to cope with missing data. The timeStamp field indicates the starting time of the interval.The client application needs to be aware of that situation. and check the time stamp.

The collection returned contains AggregateConnectivity structs. The number of entries depends upon the number of unique items found for this Aggregation. For example, if Aggregation was set to be 'Customer' then the # of entries in the collection would be equal to the # of customers whose SLA were present in the slaList passed in, and have data for the membership defined.

Each AggregateConnectivity contains a tag for the value by which it was aggregated, ie. customer name or VPN name. It also contains a sequence PercentageSeq for the various occurences of these statistics based on the value of TimeInterval and membership definition.

The length of the sequence an AggregateConnectivity depends upon the number of time intervals covered. For example, if the TimeInterval was Daily and the membership was defined for 15 days, then the number of bins would be 15 if there exist dara for each day, otherwise the number if bins would be less than 15.

See Also

getAllStats getThresholdStats

getJitterStats()

Get only the Jitter data values for the selected Jitter SLAs. The Jitter values returned are much more elaborate than the values returned by getAllStats call. based on the aggregation and distributed over the time interval.

Usage

AggregateJitterDataCollection getJitterStats(
in SlaSeq slaList,
in Aggregation aggregateBy,
in TimeInterval timeSlice,
in DCBFWQuery::QueryPrimitiveSeq membership)

raises(
CiscoSlaMonitorException);

Parameters

aggregateBy--- in Aggregation specifies the property over which the aggregation should be performed.

timeSlice--- in TimeInterval specifies the size of the bins in which aggregated statistics are maintained.

membership--- in DCBFWQuery::QueryPrimitiveSeq describes the criteria used to identify the base datasets on which the aggregation operation should be performed.

Returns

AggregateJitterDataCollection containing aggregated voice jitter values.

Raises

CiscoSlaMonitor::CiscoSlaMonitorException to indicate errorencountered somewhere during the processing of this operation.

Description

Provide access to just jitter statistics. The various aggregations are the popular ways in which client applications would like to group the results.

Since the statistics are gathered over time, it is highly likely that data points may be missing over certain intervals of time. This could be due to network issues or just that certain SLA were defined over time. The results are able to cope with missing data. The timeStamp field indicates the starting time of the interval.The client application needs to be aware of that situation. and check the time stamp.

The collection returned contains AggregateJitterData structs. The number of entries depends upon the number of unique items found for this Aggregation. For example, if Aggregation was set to be 'Customer' then the # of entries in the collection would be equal to the # of customers whose SLA were present in the slaList passed in, and have data for the membership defined.

Each AggregateThreshold contains a tag for the value by which it was aggregated, ie. customer name or VPN name. It also contains a sequence PercentageSeq for the various occurences of these statistics based on the value of TimeInterval and membership definition.

The length of the sequence an AggregateJitterData depends upon the number of time intervals covered. For example, if the TimeInterval was Daily and the membership was defined for 15 days, then the number of bins would be 15 if there exist data for each day, otherwise the number if bins would be less than 15.

See Also

getAllStats getThresholdStats getConnectivityStats

getThresholdStats()

Get only the threshold violation percentage value for the selected SLA based on the aggregation and distributed over the time interval.

Usage

AggregateThresholdCollection getThresholdStats(
in SlaSeq slaList,
in Aggregation aggregateBy,
in TimeInterval timeSlice,
in DCBFWQuery::QueryPrimitiveSeq membership)

raises(
CiscoSlaMonitorException);

Parameters

aggregateBy--- in Aggregation specifies the property over which the aggregation should be performed.

timeSlice--- in TimeInterval specifies the size of the bins in which aggregated statistics are maintained.

membership--- in DCBFWQuery::QueryPrimitiveSeq describes the criteria used to identify the base datasets on which the aggregation operation should be performed.

Returns

AggregateThresholdCollection containing aggregated threshold violation percent values.

Raises

CiscoSlaMonitor::CiscoSlaMonitorException to indicate errorencountered somewhere during the processing of this operation.

Description

Provide access to just the threshold value in a higher level aggregated form. The various aggregations are the popular ways in which client applications would like to group the results.

Since the statistics are gathered over time, it is highly likely that data points may be missing over certain intervals of time. This could be due to network issues or just that certain SLA were defined over time. The results are able to cope with missing data. The timeStamp field indicates the starting time of the interval.The client application needs to be aware of that situation. and check the time stamp.

The collection returned contains AggregateThreshold structs. The number of entries depends upon the number of unique items found for this Aggregation. For example, if Aggregation was set to be 'Customer' then the # of entries in the collection would be equal to the # of customers whose SLA were present in the slaList passed in, and have data for the membership defined.

The length of the sequence an AggregateThreshold depends upon the number of time intervals covered. For example, if the TimeInterval was Daily and the membership was defined for 15 days, then the number of bins would be 15 if there exist data for each day, otherwise the number if bins would be less than 15.

See Also

getAllStats getConnectivityStats

nameToProtocol()

Get the Rtt protocol based on the protocol name.

Usage

long nameToProtocol(
in string protocolName)

raises(
UnknownProtocolException);

Parameters

protocolName--- in string identifies the protocol by name.

Returns

long mapping to the protocol name.

Raises

CiscoSlaMonitor::UnknownProtocolException if the protocol name is not valid.

Description

If the protocol name is not valid, Undefined is returned. Otherwise, the matching constant for the protocol name is returned. It allows all SLA server operations to primarily work on rtt protocol as a parameter. At the same time, the client applications can have an easy translation.

protocolToName()

Map the rtt protocol value to a protocol name.

Usage

string protocolToName(
in long protocol);

Parameters

protocol--- in long identifies the protocol by constant.

Returns

string name mapping for the specified protocol.

Description

The name identifying the protocol is returned. If the protocol is unknown, the name 'undefined' is returned. The client applications can use this mapping operation to convert the protocol constant to a user readable value.

queryDatasets()

Get the SAA datasets collected from all SAA routers based on a particular search criteria.

Usage

SAADataSetCollection queryDatasets(
in DCBFWQuery::QueryPrimitiveSeq membership)

raises(
CiscoSlaMonitorException);

Parameters

membership--- in DCBFWQuery::QueryPrimitiveSeq describes the criteria used to identify the base datasets on which the aggregation operation should be performed.

Returns

SAADataSetCollection representing datasets collected from all SAA routers which match a particular request criteria.

Description

If a client is interested in accessing raw SAA collected datasets, this operation provides the most generalized means to do so.

It is similar to the queryDatasets operation supported by the SAARouter. In this case, the source router has not been constrained to a single element. Though constraints can be put using the query parameter.

See Also

SAARouter :: queryDatasets

Interface SlaInfoCollection

A collection interface which provides access to a group of SlaInfo struct. The SlaInfo struct can either be accessed as an SlaInfoSeq, iterated an element at a time or accessed randomly by element position in the collection.

Attributes

readonly attribute long size

A readonly attribute that represents the number of elements in the SlaInfoCollection collection.

See Also

setIndex, getIndex, nextElement, nextElements, elementAtIndex, elementsAtIndex, dispose

Since

Data Collection Base Framework, Release 1.0

Cisco VPN Solutions Center, Release 1.0

Operations

dispose()

Disposes the SlaInfoCollection object and frees the server resources that are associated with it.

Usage

void dispose();

Description

Once executed, the SlaInfoCollection object is no longer accessible by the client. In addition, the server may free this object automatically after some time. Program your clients to retrieve data from a collection when it is first is acquired, rather than waiting before examining the data.

See Also

SlaInfoCollection

Since

Data Collection Base Framework, Release 1.0

Cisco VPN Solutions Center, Release 1.0

elementAtIndex()

Gets the SlaInfoCollection element at the specified index.

Usage

SlaInfo elementAtIndex(
in long index)

raises(
InvalidIndexException,
InvalidatedException);

Parameters

index---in long value that specifies the index of the element to get.

Returns

SlaInfo that represents the specified SlaInfoCollection element.

Raises

Description

Note: This operation does not affect the sequential index used by the nextElement() and nextElements() operations.

See Also

setIndex, getIndex, nextElement, nextElements, elementsAtIndex, size

Since

Data Collection Base Framework, Release 1.0

Cisco VPN Solutions Center, Release 1.0

elementsAtIndex()

Gets a specified number of SlaInfoCollection elements at the specified index.

Usage

SlaInfoSeq elementsAtIndex(
in long index,
in long numberOfElements)

raises(
InvalidIndexException,
InvalidatedException);

Parameters

index---in long value that specifies the index of the first element to get.

numberOfElements---in long that indicates the number of SlaInfoCollection elements to get.

Returns

SlaInfoSeq that represent the specified SlaInfoCollection elements.

Raises

Description

If the end of the collection is reached before the specified numberOfElements is returned, SlaInfoCollection elements are returned until the end of the collection is reached. The collection may also return fewer elements than requested to reduce the message size, but a minimum of one collection element is returned, if available.

Note: This operation does not affect the sequential index used by the nextElement() and nextElements() operations.

See Also

setIndex, getIndex, nextElement, nextElements, elementAtIndex, size

Since

Data Collection Base Framework, Release 1.0

Cisco VPN Solutions Center, Release 1.0

getIndex()

Gets the index value of the current SlaInfoCollection element.

Usage

long getIndex();
raises(
InvalidatedException);

Returns

long---Index of the element at the current position in the SlaInfoCollection collection.

Raises

DCBFWCollection::InvalidatedException if this collectionis invalidated by the server.

Description

The SlaInfoCollection index is initialized to 0 and is incremented when collection elements are traversed sequentially using the nextElement() or nextElements() operations.

See Also

setIndex, nextElement, nextElements, elementAtIndex, elementsAtIndex, size

Since

Data Collection Base Framework, Release 1.0

Cisco VPN Solutions Center, Release 1.0

nextElement()

Gets the next SlaInfoCollection element.

Usage

SlaInfo nextElement();
raises(
EndOfCollectionException,
InvalidatedException);

Returns

SlaInfo that represents the next SlaInfoCollection element.

Raises

Description

Executing the nextElement() operation increments the sequential index.

See Also

setIndex, getIndex, nextElements, elementAtIndex, elementsAtIndex, size

Since

Data Collection Base Framework, Release 1.0

Cisco VPN Solutions Center, Release 1.0

nextElements()

Gets the next few SlaInfoCollection elements.

Usage

SlaInfoSeq nextElements(
in long numberOfElements)

raises(
EndOfCollectionException,
InvalidatedException);

Parameters

numberOfElements---in long that indicates the number of elements to get.

Returns

SlaInfoSeq that represent the next few SlaInfoCollection elements as specified by the numberOfElements input value.

Raises

Description

See Also

setIndex, getIndex, nextElement, elementAtIndex, elementsAtIndex, size

Since

Data Collection Base Framework, Release 1.0

Cisco VPN Solutions Center, Release 1.0

setIndex()

Sets the index value of the current SlaInfoCollection element.

Usage

void setIndex(
in long index)

raises(
InvalidatedException,
InvalidIndexException);

Parameters

index---in long that represents the index to value assign to the current SlaInfoCollection element.

Raises

Description

The SlaInfoCollection index is initialized to 0 and is incremented when collection elements are traversed sequentially using the nextElement() or nextElements() operations.

See Also

getIndex, nextElement, nextElements, elementAtIndex, elementsAtIndex, size

Since

Data Collection Base Framework, Release 1.0

Cisco VPN Solutions Center, Release 1.0

Interface SpecificStatsCollection

A collection interface which provides access to a group of SpecificStats struct. The SpecificStats struct can either be accessed as an SlaSeq, iterated an element at a time or accessed randomly by element position in the collection.

Attributes

readonly attribute long size

A readonly attribute that represents the number of elements in the SpecificStatsCollection collection.

See Also

setIndex, getIndex, nextElement, nextElements, elementAtIndex, elementsAtIndex, dispose

Since

Data Collection Base Framework, Release 1.0

Cisco VPN Solutions Center, Release 1.0

Operations

dispose()

Disposes the SpecificStatsCollection object and frees the server resources that are associated with it.

Usage

void dispose();

Description

Once executed, the SpecificStatsCollection object is no longer accessible by the client. In addition, the server may free this object automatically after some time. Program your clients to retrieve data from a collection when it is first is acquired, rather than waiting before examining the data.

See Also

SpecificStatsCollection

Since

Data Collection Base Framework, Release 1.0

Cisco VPN Solutions Center, Release 1.0

elementAtIndex()

Gets the SpecificStatsCollection element at the specified index.

Usage

SpecificStats elementAtIndex(
in long index)

raises(
InvalidIndexException,
InvalidatedException);

Parameters

index---in long value that specifies the index of the element to get.

Returns

SpecificStats that represents the specified SpecificStatsCollection element.

Raises

Description

Note: This operation does not affect the sequential index used by the nextElement() and nextElements() operations.

See Also

setIndex, getIndex, nextElement, nextElements, elementsAtIndex, size

Since

Data Collection Base Framework, Release 1.0

Cisco VPN Solutions Center, Release 1.0

elementsAtIndex()

Gets a specified number of SpecificStatsCollection elements at the specified index.

Usage

SpecificStatsSeq elementsAtIndex(
in long index,
in long numberOfElements)

raises(
InvalidIndexException,
InvalidatedException);

Parameters

index---in long value that specifies the index of the first element to get.

numberOfElements---in long that indicates the number of SpecificStatsCollection elements to get.

Returns

SpecificStatsSeq that represent the specified SpecificStatsCollection elements.

Raises

Description

If the end of the collection is reached before the specified numberOfElements is returned, SpecificStatsCollection elements are returned until the end of the collection is reached. The collection may also return fewer elements than requested to reduce the message size, but a minimum of one collection element is returned, if available.

Note: This operation does not affect the sequential index used by the nextElement() and nextElements() operations.

See Also

setIndex, getIndex, nextElement, nextElements, elementAtIndex, size

Since

Data Collection Base Framework, Release 1.0

Cisco VPN Solutions Center, Release 1.0

getIndex()

Gets the index value of the current SpecificStatsCollection element.

Usage

long getIndex();
raises(
InvalidatedException);

Returns

long---Index of the element at the current position in the SpecificStatsCollection collection.

Raises

DCBFWCollection::InvalidatedException if this collectionis invalidated by the server.

Description

The SpecificStatsCollection index is initialized to 0 and is incremented when collection elements are traversed sequentially using the nextElement() or nextElements() operations.

See Also

setIndex, nextElement, nextElements, elementAtIndex, elementsAtIndex, size

Since

Data Collection Base Framework, Release 1.0

Cisco VPN Solutions Center, Release 1.0

nextElement()

Gets the next SpecificStatsCollection element.

Usage

SpecificStats nextElement();
raises(
EndOfCollectionException,
InvalidatedException);

Returns

SpecificStats that represents the next SpecificStatsCollection element.

Raises

Description

Executing the nextElement() operation increments the sequential index.

See Also

setIndex, getIndex, nextElements, elementAtIndex, elementsAtIndex, size

Since

Data Collection Base Framework, Release 1.0

Cisco VPN Solutions Center, Release 1.0

nextElements()

Gets the next few SpecificStatsCollection elements.

Usage

SpecificStatsSeq nextElements(
in long numberOfElements)

raises(
EndOfCollectionException,
InvalidatedException);

Parameters

numberOfElements---in long that indicates the number of elements to get.

Returns

SpecificStatsSeq that represent the next few SpecificStatsCollection elements as specified by the numberOfElements input value.

Raises

Description

See Also

setIndex, getIndex, nextElement, elementAtIndex, elementsAtIndex, size

Since

Data Collection Base Framework, Release 1.0

Cisco VPN Solutions Center, Release 1.0

setIndex()

Sets the index value of the current SpecificStatsCollection element.

Usage

void setIndex(
in long index)

raises(
InvalidatedException,
InvalidIndexException);

Parameters

index---in long that represents the index to value assign to the current SpecificStatsCollection element.

Raises

Description

The SpecificStatsCollection index is initialized to 0 and is incremented when collection elements are traversed sequentially using the nextElement() or nextElements() operations.

See Also

getIndex, nextElement, nextElements, elementAtIndex, elementsAtIndex, size

Since

Data Collection Base Framework, Release 1.0

Cisco VPN Solutions Center, Release 1.0

Table of Contents

CiscoSlaMonitor.idl