|
|
The file CiscoAcctMonitor.idl contains the following interfaces:
CiscoAcctMonitor::AcctEntryCollection CiscoAcctMonitor::AcctMonitor CiscoAcctMonitor::AcctTargetCollection CiscoAcctMonitor::AggrAcctEntryBinCollection CiscoAcctMonitor::AggrAcctEntryCollection CiscoAcctMonitor::AggrDetailAcctEntryBinCollection CiscoAcctMonitor::AggrDetailAcctEntryCollection CiscoAcctMonitor::AggrSummaryStatBinCollection CiscoAcctMonitor::AggrSummaryStatCollection CiscoAcctMonitor::AllAggrSummaryStatBinCollection CiscoAcctMonitor::DetailAcctEntryCollection CiscoAcctMonitor::SummaryStatCollection
The CiscoAcctMonitor module defines interfaces and supporting types to access VPN-based traffic entries for generating account data and reports. You can define the retrieval of VPN throughput data based on communications between any two endpoints.
In addition to the AcctMonitor interface, here is a list of the collection interfaces supplied by the CiscoAcctMonitor module:
VPN-management software must monitor the data flow for each VPN account it is to manage. This functionality is required for measuring the quality of service (QoS) and for generating accurate billing statements. For each managed VPN, the amount of end-to-end data flowing over the network is directly proportional to the cost of supplying the service. Therefore, the data flow must be reflected in the billing statement issued by a service provider to its customer.
The Cisco VPN Solutions Center software uses the CiscoAcctMonitor server to collect VPN-oriented network-traffic data from the provider-edge routers (PEs) of its managed VPNs. This information, in addition to raw packet size and other data, includes the route taken for each packet as it travels from one customer-edge router (CE) to another.
The raw collected data is stored persistently in the VPN Inventory Repository for each VPN. Using the GUI features of the Cisco VPN Solutions Center software, you can create visually compelling drilldown reports, and can aggregate them based on various criteria, such as PE-to-PE, PE-to-CE, and class of service (CoS). While the GUI features are not available through published APIs, you can adapt the GUI report features of your existing network-management software to view the data collected by the CiscoAcctMonitor APIs. Data for all reports, including both primitive and aggregate, cover the entire specified time scale.
See Also
DCBFWCollection, DCBFWDataSet, DCBFWQuery, DCDirectory, CiscoSlaMonitor
Since
Cisco VPN Solutions Center, Release 1.0
Usage
typedef OptionalAcctAttrQueryExpression AcctAttrQueryExpressionData
Provides a means by which to construct a query expression, applying a filter rule, by which to get desired account entries. This query primitive supplies a simple filtration scheme with which you can perform single-tiered filtration—one filter only—based on the attributes of the account entries retrieved by different aggregation APIs.
Usage
struct AcctAttrQueryPrimitive
{
AcctAttrQueryType queryType;
DCBFWQuery::Operator queryOperatorType;
string queryValue;
};
Members
queryType—AcctAttrQueryType that specifies the queriable attribute. This is the attribute that the filter process uses as its crition with which to deterime whether to keep or discard the current account entry.
queryOperatorType—DCBFWQuery::Operator that defines the relation operator for the filtration process to use when comparing the current processed entry to the queryValue entry to get the desired traffic entry.
queryValue—string that represents the query criteria.
Description
Using postfix notation, create a AcctAttrQueryPrimitive sequence, AcctAttrQueryPrimitiveSeq, to the CiscoAcctmonitor APIs. All CiscoAcctmonitor APIs accept AcctAttrQueryPrimitiveSeq sequence. On the backend the sequence will be converted into a Stack.
For example, to get the account entry with a vrfName of CompanyA, specify a query primitive of vrfName==CompanyA. To define the query primitive, set queryType to be VrfName, queryOperatorType to EQUAL, and queryValue to CompanyA.
To get an account entry for a packet size greater than 100, the query primitive is PacketSize
Since
Cisco VPN Solutions Center, Release 1.0
Sequence of AcctAttrQueryPrimitive structures.
Usage
typedef sequence<AcctAttrQueryPrimitive> AcctAttrQueryPrimitiveSeq
Description
All load operations must be needed to be passed in postfix notion as the Query primitives are organized in a postfix notion.
For example, the users would like to get the account entries whose VRF name is CompanyA and packet size greater than 100, then the users are responsible to form the following load option sequence to pass on to different Accounting manager API to select the data entries which the operation is performed.
AcctAttrQueryPrimitiveSeq loadOptionList = new AcctAttrQueryPrimitive[3]; loadOptionList[0].queryType = AcctAttrQueryType.VrfName; loadOptionList[0].queryOperatorType = Operator.Eq; loadOptionList[0].queryValue = "CompanyA";
loadOptionList[1].queryType = AcctAttrQueryType.PacketSize; loadOptionList[1].queryOperatorType = Operator.Gt; loadOptionList[1].queryValue = "100";
loadOptionList[2].queryType = AcctAttrQueryType.ConjunctionOperator; loadOptionList[2].queryOperatorType = Operator.And;
Since
Cisco VPN Solutions Center, Release 1.0
Defines the attribute on which to base queries when generating account-traffic entries.
Usage
enum AcctAttrQueryType
{
VrfName,
CustomerName,
CustomerSiteName,
PeId,
CeId,
TypeOfService,
StartTime,
EndTime,
PacketSize,
ByteSize,
ApplicationType,
NumberOfFlow,
TotalActiveTime,
ConjunctionOperator
};
Enumerators
VrfName—VRF name on the VPN Forwarding Information Table (VFIT).
CustomerName—Name of the customer for which the service provider is supplying VPN service—"Company A," for example.
CustomerSiteName—Name of the customer site for which the service provider is supplying VPN service—"Site 15," for example.
PeId—Identifier for the target PE that corresponds with a unique PE identifier for a CiscoVsmBrowser::VsmPE object stored in the Directory repository.
CeId—Identifier for the target CE that corresponds with a unique CE identifier for a CiscoVsmBrowser::VsmCE object stored in the Directory repository.
TypeOfService—Type of service which retrieved from netflow collector. IP type-of-service.
StartTime—Time of the first packet summarized into this entry.
EndTime—Time of the last packet summarized into this entry.
PacketSize—Packet size of the traffic traversing between the source and destination routers.
ByteSize The byte size that the traffic travering between the source and destination routers.
ApplicationType—Application protocol type
NumberOfFlow—Total number of Netflow data flows that are aggregated into one account entry.
ConjunctionOperator—Boolean operator—AND or OR—to use in the query string.
See Also
AcctAttrQueryPrimitive, AcctAttrQueryPrimitiveSeq
Since
Cisco VPN Solutions Center, Release 1.0
Structure of account data.
Usage
struct AcctEntry
{
IpAddressLong srcIPAddress;
IpAddressLong dstIPAddress;
string applicationName;
LongInteger fwdPackets;
LongInteger fwdBytes;
LongInteger rtnPackets;
LongInteger rtnBytes;
LongInteger totalActiveTime;
LongInteger numOfFlows;
short typeOfService;
long srcCETargetID;
long dstCETargetID;
};
Members
srcIPAddress The IP address that the traffic originated from; "192.100.200.201" for example.
dstIPAddress The IP address that the traffic arrived at; "192.168.128.42" for example.
applicationType Each application protocol name is assigned a distinct index number.
fwdPackets The packet size that the traffic traversing between the source and destination, which originated from the source end and arrived at the destination end
fwdBytes The byte size that the traffic traversing between the source and destination, which originated from the source end and arrived at the destination end
rtnPackets The packet size that the traffic traversing between the destination and source end points, which originated from the destination end and arrived at the source end
rtnBytes The byte size that the traffic traversing between the destination and source, which originated from the destination end and arrived at the source end
totalActiveTime The sum of the individual activetime for all the flows summarized into the current traffic entry.
numOfFlows Total number of flows aggregated into entry.
typeOfService IP type-of-service.
srcCETargetID Source CE target ID
dstCETargetID Destination CE target ID
A sequence of AcctEntry structures.
Usage
typedef sequence<AcctEntry> AcctEntrySeq
It represents a target object in the directory repository. It is uesd to represent as the PE router or the CE router.
Usage
struct AcctTarget
{
string targetName;
string targetNetworkName;
string targetDomainName;
string targetRole;
long targetID;
};
Members
targetName—string PE router name; "meag" for example.
targetNetworkName—string PE router network name; "Network_1" for example
targetDomainName—string PE router domain name; "Cisco.com" for example.
targetRole—string PE router type; "ciscorouter" for example.
targetID—long PE router unique ID; "10" for example.
Description
The clients can use 'getPeRouterList()' or 'getCeRouterListForCustomer()' from 'AcctMonitor' to get a list PE router or CE router.
See Also
AcctManger::getPeRouterList(), AcctManger::getCeRouterListForCustomer()
A sequence of AcctTarget objects.Datasets
Usage
typedef sequence<AcctTarget> AcctTargetSeq
Records a list of account entries based on a common aggregate category.
Usage
struct AggrAcctEntry
{
AggregateName aggregateTag;
AcctEntrySeq acctEntrySeq;
};
Members
aggregateTag—AggregateName that represents the the aggregate type for this data.
aggrAcctEntrySeq—AggrAcctEntrySeq that represents the aggregate account entries categoried by different aggregation contained in the aggregated catalog specified on 'aggregateTag'.
Description
An AggregateName type that records the aggregate category name is maintained in the AggrAcctEntry for the client.
For example, you can get aggregate account entries that are categorized based on the application protocols for a PE-to-PE link. Account entries with a common application protocol are listed in the acctEntrySeq field of in the AggrAcctEntry record. The aggregate category name is recorded in the aggregateTag field of each record.
If there are three different application protocols for all matching account entries, then three AggrAcctEntry records are kept in a AggrAcctEntryBin record, each entry with a unique application name.
See Also
AcctMonitor::getAcctEntriesForPeToPe, AggrAcctEntryBin
It provides the result to group a list of account entries based on the time line and aggregation flags.
Usage
struct AggrAcctEntryBin
{
TimeStamp timeStamp;
AggrAcctEntrySeq acctEntrySeq;
};
Members
timeStamp—TimeStamp A interger identifying the time line for the grouped account entries.
aggrAcctEntrySeq—AggrAcctEntrySeq A sequence of aggregated account entries categoried by different aggregation contained in the time line specified on 'timeStamp'.
Description
A timeStamp representing the earlies start time for a sequence of account entries aggregated by different categories is contained in the AggrAcctEntryBin for the client to identify.
An example would be to get aggregated account entries, which are categoried by different application protocol, for PE1 to PE2 per week over the last six weeks.
The categoried account entries are further compiled into time based bins. The group of account entries over the time line are maintained as an element on the AggrAcctEntryBinCollection.
"AcctEntryBin" only provided account entries falling on different time line. "AggrAcctEntryBin" provides categorized account entries falling on different time line based on the aggregation flag the client specify.
See Also
AcctMonitor::getAcctEntriesForPeToPe();
A sequence of AggrAcctEntryBin struct.
Usage
typedef sequence<AggrAcctEntryBin> AggrAcctEntryBinSeq
A sequence of AggrAcctEntry struct.
Usage
typedef sequence<AggrAcctEntry> AggrAcctEntrySeq
Lists detailed account entries based on a common aggregate category.
Usage
struct AggrDetailAcctEntry
{
AggregateName aggregateTag;
DetailAcctEntrySeq acctEntrySeq;
};
Members
aggregateTag—AggregateName type that represents the aggregate category that corresponds with the detail account entries list in the aggrAcctEntrySeq field.
aggrAcctEntrySeq—AggrAcctEntrySeq type that lists detail account entries that correspond with the aggregate category specified by the aggregateTag field.
Description
A string that represents the name of the aggregate category is stored in the aggregateTag field for each AggrDetailAcctEntry record.
For example, if you aggregate detailed account entries for traffic between PE1 and PE2 based on Application Protocol, the application protocol for PE1 to PE2 is saved in the aggregateTag field for each record.
Detail account entries sharing a common application protocol are maintained as an acctEntrySeq object in the AggrAcctEntry struct. If three different application protocols are used for the PE1-to-PE2 connection, then three different DetailAcctEntry records are listed in the acctEntrySeq field.
See Also
AcctMonitor::getDetailAcctEntriesForPeToPe, AggrDetailAcctEntrySeq, AggrDetailAcctEntryCollection
Since
Cisco VPN Solutions Center, Release 1.0
It provides the result to group a list of detail account entries based on the time line and aggregation flags.
Usage
struct AggrDetailAcctEntryBin
{
TimeStamp timeStamp;
AggrDetailAcctEntrySeq acctEntrySeq;
};
Members
timeStamp—TimeStamp A interger identifying the time line for the grouped account entries.
aggrAcctEntrySeq—AggrAcctEntrySeq A sequence of aggregated detail account entries categoried by different aggregation contained in the time line specified on 'timeStamp'.
Description
A timeStamp representing the earlies start time for a sequence of account entries aggregated by different categories is contained in the AggrDetailAcctEntryBin for the client to identify.
An example would be to get aggregated detail account entries, which are categoried by different application protocol, for PE1 to PE2 per week over the last six weeks.
The categoried account entries are further compiled into time based bins. The group of detail account entries over the time line are maintained as an element on the AggrDetailAcctEntryBinCollection.
"DetailAcctEntryBin" only provides account entries falling on different time line. "AggrDetailAcctEntryBin" provides categorized account entries falling on different time line based on the aggregation flag the client specify.
See Also
AcctMonitor::getDetailAcctEntriesForPeToPe
A sequence of AggrAcctEntryBin struct.
Usage
typedef sequence<AggrDetailAcctEntryBin> AggrDetailAcctEntryBinSeq
List of AggrDetailAcctEntry records.
Usage
typedef sequence<AggrDetailAcctEntry> AggrDetailAcctEntrySeq
See Also
AcctMonitor::getDetailAcctEntriesForPeToPe, AggrDetailAcctEntryCollection
Since
Cisco VPN Solutions Center, Release 1.0
A string that represents the aggregate attribute on which the aggregated statistics are computed.
Usage
typedef string AggregateName
Description
For example, if the request for statistics defines the Aggregation to be by customer, then the AggregateName is the name of the customer.
See Also
Aggregation
Since
Cisco VPN Solutions Center, Release 1.0
Defines the various aggregation schemes. The account summary status or the account entries can be combined over these schemes to provide a composite result to the client application. The Accounting server optimizes the data structures to provide a quick response, as opposed to each application extracting their results from raw account entries.
Usage
enum Aggregation
{
Unspecified,
Application,
ServiceType
};
Enumerators
Unspecified—Aggregate statistics over the time scale, only.
Application—Aggregate statistics over the time scale, and combine the account-summary status or accounting entries by each unique application protocol.
ServiceType—Aggregate statistics over the time scale, and combine the account-summary status or accounting entries by each unique type-of-service (ToS).
See Also
AggregateName
Since
Cisco VPN Solutions Center, Release 1.0
It provides the summary results for those account entries with the same aggregation category.
Usage
struct AggrSummaryStat
{
AggregateName aggregateTag;
SummaryStat summaryStat;
};
Members
aggregateTag—AggregateName A string identifying the aggregation that this data represents.
summaryStat—SummaryStat The Accounting Summary status for those account entries with the same category specified on 'aggregateTag'.
Description
A string representing the aggregate category name is also maintained in 'AggrSummaryStat' for the client to identify. For example, if the results are aggregated by 'Application Protocol', the application protocol is saved in each struct in the 'aggregateTag' field.
An example would be to get accounting summary status by different application protocol for PE1 to PE2.
The accounting summary status for those accounting entries with the same application protocol will be maintained in one AggrSummaryStat entry.
See Also
AggrSummaryStatSeq, AggrSummaryStatCollection
Since
Cisco VPN Solutions Center, Release 1.0
Repository for summarized account entries that are based on various time lines and aggregate categories.
Usage
struct AggrSummaryStatBin
{
TimeStamp timeStamp;
AggrSummaryStatSeq aggrSummaryStatSeq;
};
Members
timeStamp—TimeStamp type that represents the time line for the account-summary status for the group of account entries.
aggrSummaryStatSeq—AggrSummaryStatSeq type that lists each categorized account-summary status. The catalog type is specified by the client in the argument list.
Description
A timeStamp value represents the time stamp for the account-summary status. You can use the time stamp to determine the time interval for the account-summary status.
For example, you can get account-summary status that are categoried by application protocol variations for a specified PE-to-PE link for each week over the last six weeks.
Categorized account entries are further compiled into time-based bins. The group of account-summary status over the time line is maintained as an element in the AggrSummaryStatBinCollection object.
See Also
AggrSummaryStatBinSeq, AggrSummaryStatBinCollection, AcctMonitor::getAcctStatForPeToPe
Since
Cisco VPN Solutions Center, Release 1.0
List of AggrSummaryStatBin records.
Usage
typedef sequence<AggrSummaryStatBin> AggrSummaryStatBinSeq
See Also
AggrSummaryStatBinSeq, AcctMonitor::getAcctStatForPeToPe
Since
Cisco VPN Solutions Center, Release 1.0
List of AggrSummaryStat records.
Usage
typedef sequence<AggrSummaryStat> AggrSummaryStatSeq
See Also
AggrSummaryStatCollection
Since
Cisco VPN Solutions Center, Release 1.0
Lists summarized results to serve a set of aggregation process.
Usage
struct AllAggrSummaryStatBin
{
AggregateName aggrTargetName;
AggrSummaryStatBinSeq aggrSummaryStatBinSeq;
};
Members
aggrTargetName—string A string identifying the aggregated target that this data represents.
aggrSummaryStatBinSeq—AggrSummaryStatBinSeq sequence of AggrSummaryStatBin for the various time intervals contained in the time range for the aggregated target.
Description
A string representing the aggregate object is maintained in the 'AllAggrAcctSummaryStat' for the client to identify.
An example would be to get account summary statistics for all customers. The customer name is saved in each struct in the 'aggrTargetName' field. And the aggregation summary status for each customer is saved in each struct in the 'summaryStatBinSeq' field.
The aggregated stats are further compiled into time based bins and different categories. For example you want the categorized summary status by application protocol per week over the last six weeks. The categorized stats over the time line are maintained as a collection of stat objects in the 'aggrSummaryStatBinSeq' field.
See Also
AllAggrSummaryStatBinSeq, AllAggrSummaryStatBinCollection
Since
Cisco VPN Solutions Center, Release 1.0
List of AllSummaryStatBin records.
Usage
typedef sequence<AllAggrSummaryStatBin> AllAggrSummaryStatBinSeq
See Also
AllAggrSummaryStatBinCollection
Since
Cisco VPN Solutions Center, Release 1.0
Structure of detailed account-entry information for traffic, whose packets share a common type-of-service (ToS) or IP precedence, between two specified endpoints.
Usage
struct DetailAcctEntry
{
IpAddressLong srcIPAddress;
IpAddressLong dstIPAddress;
string applicationName;
LongInteger fwdPackets;
LongInteger fwdBytes;
LongInteger rtnPackets;
LongInteger rtnBytes;
LongInteger totalActiveTime;
long numOfFlows;
short typeOfService;
string srcVRFName;
string dstVRFName;
SubnetAddress srcPrefix;
SubnetAddress dstPrefix;
long srcPETargetID;
long dstPETargetID;
long srcCETargetID;
long dstCETargetID;
InterfaceName srcIntfName;
InterfaceName dstIntfName;
};
Members
srcIPAddress—IpAddressLong type that represents the IP address from which the traffic originated—for example, 10.201.1.1.
dstIPAddress—IpAddressLong type that represents the IP address at which the traffic arrived at—for example, 192.168.11.22.
applicationName—string type that represents the application protocol name.
fwdPackets—LongInteger type that represents the number of the packets traveling from the source, srcIPAddress, to the destination, dstIPAddress.
fwdBytes—LongInteger type that represents the cumulative size (bytes) of the packets represented by the fwdPackets member.
rtnPackets—LongInteger type that represents the number of the packets traveling from the destination, dstIPAddress, to the source, srcIPAddress.
rtnBytes—LongInteger type that represents the cumulative size (bytes) of the packets represented by the rtnPackets member.
totalActiveTime—LongInteger type that represents the sum of the individual active times for all flows summarized by this traffic entry.
numOfFlows—long type that represents the total number of flows that are aggregated in this traffic entry.
typeOfService—short type that represents the type of service, dictated by the IP-precedence bits, that is shared by all packets in this traffic entry.
srcVRFName—string type that represents the name of the name of the source VRF table.
dstVRFName—string type that represents the name of the name of the destination VRF table.
srcPrefix—SubnetAddress type that represents the source-subnet address that is retrieved from the VPN Forwarding Information Table (VFIT).
dstPrefix—SubnetAddress type that represents the destination-subnet address that is retrieved from the VPN Forwarding Information Table (VFIT).
srcPETargetID—long type that represents the unique identifier of the source PE target.
dstPETargetID—long type that represents the unique identifier of the destination PE target.
srcCETargetID—long type that represents the unique identifier of the source CE target.
dstCETargetID—long type that represents the unique identifier of the destination CE target.
srcIntfName—InterfaceName type that represents the ingress interface name on the ingress PE router.
dstIntfName—InterfaceName type that represents the egress interface name on the egress PE router.
See Also
DetailAcctEntrySeq, DetailAcctEntryCollection
Since
Cisco VPN Solutions Center, Release 1.0
A sequence of DetailAcctEntry records.
Usage
typedef sequence<DetailAcctEntry> DetailAcctEntrySeq
A string that represents the interface name.
Usage
typedef string InterfaceName
Since
Cisco VPN Solutions Center, Release 1.0
A four-byte long type that represents an IP address.
Usage
typedef long IpAddressLong
Description
Each IP address is represented as a four-byte long value—a.b.c.d, for example, where a, b, c, and d are integer values from 0 to 255. Each integer is stored in one byte to create the four-byte long representation for the IP address.
See Also
SubnetAddress
Since
Cisco VPN Solutions Center, Release 1.0
A long long type with a maximum value of (2**63)-1.
Usage
typedef long long LongInteger
Since
Cisco VPN Solutions Center, Release 1.0
The users many not want to apply query options on the account entry attributes for the retrieved account entries. The union below allows the users to generate the query expression to get more specific account entries or apply no query process on the account entries. If the users did not want to apply any query operation on the retrieved account entries, then the user can use a dummy value.
Usage
union OptionalAcctAttrQueryExpression switch (short)
{
case 1:
AcctAttrQueryPrimitiveSeq acctLoadOpSeq;
default:short dummy;
};
List of short types.
Usage
typedef sequence<short> ShortSeq
Since
Cisco VPN Solutions Center, Release 1.0
List of string types.
Usage
typedef sequence<string> StringSeq
Since
Cisco VPN Solutions Center, Release 1.0
A subnet address that consists of a four-byte IpAddressLong type and a short subnet mask value.
Usage
struct SubnetAddress
{
IpAddressLong ipAddr;
short subnetMask;
};
Members
ipAddr—IpAddressLong type that represents the subnet address as a four-byte long value.
subnetMask—short type that represents the subnet mask as a value from 0 to 255.
See Also
IpAddressLong
Since
Cisco VPN Solutions Center, Release 1.0
Statistical summary for a group of account entries collected over a specified collection interval.
Usage
struct SummaryStat
{
LongInteger totalFwdPackets;
LongInteger totalFwdBytes;
LongInteger totalRtnPackets;
LongInteger totalRtnBytes;
LongInteger maxFwdPackets;
LongInteger maxFwdBytes;
LongInteger maxRtnPackets;
LongInteger maxRtnBytes;
LongInteger minFwdPackets;
LongInteger minFwdBytes;
LongInteger minRtnPackets;
LongInteger minRtnBytes;
LongInteger totalEntries;
LongInteger unknownRemoteEntries;
LongInteger unknownRemotePackets;
LongInteger unknownRemoteBytes;
};
Members
totalFwdPackets—LongInteger Total forward packet size. The gross of the packet count from source router to destination router.
totalFwdBytes—LongInteger Total forward byte size. The gross of the byte count from source router to destination router.
totalRtnPackets—LongInteger Total return packet size. The gross of the packet count from destination router to source router.
totalRtnBytes—LongInteger Total return byte size. The gross of the byte count from destination router to source router.
maxFwdPackets—LongInteger Maximum forward packet size. The maximum packet count from source router to destination router during the collection interval.
maxFwdBytes—LongInteger Maximum forward byte size. The maximum byte count from source router to destination router during the collection interval.
maxRtnPackets—LongInteger Maximum return packet size. The maximum packet count from destination router to source router during the collection interval.
maxRtnBytes—LongInteger Maximum return byte size. The maximum byte count from destination router to source router during the collection interval.
minFwdPackets—LongInteger Minimum forward packet size. The minimum packet count from source router to destination router during the collection interval.
minFwdBytes—LongInteger Minimum forward byte size. The minimum byte count from source router to destination router during the collection interval.
minRtnPackets—LongInteger Minimum return packet size. The minimum packet count from destination router to source router during the collection interval.
minRtnBytes—LongInteger Minimum return byte size. The minimum byte count from destination router to source router during the collection interval.
totalEntries—LongInteger Total netflow entries that contribute to this summary status entry.
unknownRemoteEntries—LongInteger that represents the total number of entries whose destination PE or CE is UNKNOWN.
unknownRemotePackets—LongInteger that represents the cumulative packet size for those account entries whose destination PE or CE is UNKNOWN.
unknownRemoteBytes—LongInteger that represents the cumulative byte size for those account entries whose destination PE or CE is UNKNOWN.
Description
In some cases, there may not be sufficient information to get a complete account entry.While correlating data to generate a VPN-aware traffic entry,
When a collection of AcctSummaryStat is returned to the client, the client needs to get the summary status for the individual time line. An example will be the client want to get the aggregated summay statistics per week over the last six weeks. The stats over the time line are maintained as a collection of SummaryStat objects. By using the 'startTime' attribute, the users can tell which summary status belonged to which week.
See Also
SummaryStatSeq, SummaryStatCollection
Since
Cisco VPN Solutions Center, Release 1.0
List of AcctSummaryStat records.
Usage
typedef sequence<SummaryStat> SummaryStatSeq
See Also
SummaryStatCollection
Since
Cisco VPN Solutions Center, Release 1.0
Defines the various time intervals over which vpn based traffic entries 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 vpn based traffic entries 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.
A long long type that represents the start time of aggregated data.
Usage
typedef long long TimeStamp
Since
Cisco VPN Solutions Center, Release 1.0
const long ALL_TYPE_OF_SERVICE = 10
A long constant for getting all type-of-service (ToS) account entries. The constant value is 10.
Since
Cisco VPN Solutions Center, Release 1.0
const string NO_ACCT_DATA = "NO_ACCT_DATA"
A string constant that indicates that accout data does not exist. The constant value is NO_ACCT_DATA.
Since
Cisco VPN Solutions Center, Release 1.0
Generic exception that supports exceptional conditions encountered during the execution of code the incorporates features of the CiscoAcctMonitor module.
Usage
exception CiscoAcctMonitorException
{
long errCode;
string explanation;
};
Parameters
errCode—long type that is unique and associated with a specific condition. Following is a list of possible values that may be assigned to the errCode field.
Exception codes beyond 300 pertain to exceptional conditions when generating and retrieving accounting data:
Description
This exception is raised when an underlying system encounters an exceptional condition, such as some errors raised in the Data server or the repository. The explanation string provides relevant information to be displayed in the client application to assist him in debugging client code.
See Also
NoDataAvailableException
Since
Cisco VPN Solutions Center, Release 1.0
Generic exception that is raised when data is requested by the client, but none is available.
Usage
exception NoDataAvailableException
{
string explanation;
};
Parameters
explanation—string type that explains the condition that raised the exception.
Description
For example, if no datasets for a particular interval exist, this exception is raised.
See Also
CiscoAcctMonitorException
Since
Cisco VPN Solutions Center, Release 1.0
An instance of the AcctEntryCollection interface provides a means by which to interact with a collection of AcctEntry types.
Description
The AcctEntry types in the collection are managed as an AcctEntrySeq type or a list of AcctEntry types. Using the operations that are supplied in this interface, you can programmatically retrieve objects from the collection in either sequential or random order.
See Also
AcctEntry, AcctEntrySeq, AcctEntryCollection::dispose, AcctEntryCollection, AcctTargetCollection, AggrAcctEntryBinCollection, AggrAcctEntryCollection, AggrDetailAcctEntryBinCollection, AggrDetailAcctEntryCollection, AggrSummaryStatBinCollection, AggrSummaryStatCollection, AllAggrSummaryStatBinCollection, DetailAcctEntryCollection, SummaryStatCollection, DCBFWCollection::StringCollection, DCBFWCollection::KeyedObjectCollection
Since
Cisco VPN Solutions Center, Release 1.0
readonly attribute long size
A readonly attribute that represents the number of elements in the AcctEntryCollection 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
Disposes the AcctEntryCollection object and frees the server resources that are associated with it.
Usage
void dispose();
Description
Once executed, the AcctEntryCollection 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
AcctEntryCollection
Since
Data Collection Base Framework, Release 1.0
Cisco VPN Solutions Center, Release 1.0
Gets the AcctEntryCollection element at the specified index.
Usage
AcctEntry elementAtIndex(in long index)
raises(InvalidIndexException, InvalidatedException);
Parameters
index—in long value that specifies the index of the element to get.
Returns
AcctEntry that represents the specified AcctEntryCollection 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
Gets a specified number of AcctEntryCollection elements at the specified index.
Usage
AcctEntrySeq 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 AcctEntryCollection elements to get.
Returns
AcctEntrySeq that represent the specified AcctEntryCollection elements.
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
If the end of the collection is reached before the specified numberOfElements is returned, AcctEntryCollection 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
Gets the index value of the current AcctEntryCollection element.
Usage
long getIndex(); raises(InvalidatedException);
Returns
long—Index of the element at the current position in the AcctEntryCollection collection.
Raises
DCBFWCollection::InvalidatedException if this collectionis invalidated by the server.
Description
The AcctEntryCollection 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
Gets the next AcctEntryCollection element.
Usage
AcctEntry nextElement(); raises(EndOfCollectionException, InvalidatedException);
Returns
AcctEntry that represents the next AcctEntryCollection 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
Gets the next few AcctEntryCollection elements.
Usage
AcctEntrySeq nextElements(in long numberOfElements)
raises(EndOfCollectionException, InvalidatedException);
Parameters
numberOfElements—in long that indicates the number of elements to get.
Returns
AcctEntrySeq that represent the next few AcctEntryCollection elements as specified by the numberOfElements input value.
Raises
DCBFWCollection::EndOfCollectionException if the end ofthe collection is reached without returning any items. DCBFWCollection::InvalidatedException if this collectionis invalidated by the server.
Description
If the end of the collection is reached before the specified numberOfElements is returned, AcctEntryCollection 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.
See Also
setIndex, getIndex, nextElement, elementAtIndex, elementsAtIndex, size
Since
Data Collection Base Framework, Release 1.0
Cisco VPN Solutions Center, Release 1.0
Sets the index value of the current AcctEntryCollection element.
Usage
void setIndex(in long index)
raises(InvalidatedException, InvalidIndexException);
Parameters
index—in long that represents the index to value assign to the current AcctEntryCollection 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
The AcctEntryCollection 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
This interface provides access to various account entries and account summary status operations. The statistics and account entries it serves up is also based upon data already collected and saved in the repository.
The purpose for the account monitor is to provide access to aggregated analyzed version of vpn-based traffic entries and summary stats.
Gets the requested account entries that traverse the pair of PEs specified by the user input.
Usage
AggrAcctEntryBinCollection getAcctEntriesForCeToCe(in AcctTarget router1, in AcctTarget router2, in TimeInterval timeSlice, in Aggregation aggregateBy, in DCBFWQuery::QueryPrimitiveSeq membership, in AcctAttrQueryExpressionData loadOption)
raises(CiscoAcctMonitorException);
Parameters
router1—in AcctTarget One endpoint of the CE router object
router2—in AcctTarget The other endpoint of the CE router object
timeSlice—in TimeInterval specifies the size of the bins in which aggregated statistics are maintained.
aggregateBy—in Aggregation specifies the property over which the aggregation should be performed.
membership—in DCBFWQuery::QueryPrimitiveSeq describes the criteria used to identify the base datasets on which the aggregation operation should be performed.
loadOption—in AcctAttrQueryExpressionData describes the criteria used to identify the filter rules on which the filter process should be performed.
Returns
AcctEntryBinCollection containing all tbe requested account entries grouped by different time stamp. These entries only includes attributes for performance throughput information. It did not include any vpn related information.
Raises
CiscoAcctMonitor::CiscoAcctMonitorException to indicate error encountered somewhere during the processing of this operation.
Description
Provide access to all the requested account entries. The various aggregations are the popular ways in which client applications would like to group the results.
If the users want to get the summary status for the requested traffic throughput, please use 'getAcctStatForCeToCe()'.
See Also
getAcctStatForCeToCe
Gets the requested account entries that pertain to the specified customer.
Usage
AggrAcctEntryBinCollection getAcctEntriesForCustomer(in string customerName, in TimeInterval timeSlice, in Aggregation aggregateBy, in DCBFWQuery::QueryPrimitiveSeq membership, in AcctAttrQueryExpressionData loadOption)
raises(CiscoAcctMonitorException);
Parameters
customerName—in string Customer Name
timeSlice—in TimeInterval specifies the size of the bins in which aggregated statistics are maintained.
aggregateBy—in Aggregation specifies the property over which the aggregation should be performed.
membership—in DCBFWQuery::QueryPrimitiveSeq describes the criteria used to identify the base datasets on which the aggregation operation should be performed.
loadOption—in AcctAttrQueryExpressionData describes the criteria used to identify the filtering rules on which the filter process should be performed.
Returns
AcctEntryBinCollection containing all tbe requested account entries grouped by different time line. These entries only includes attributes for performance throughput information. It did not include any vpn related information.
Raises
CiscoAcctMonitor::CiscoAcctMonitorException to indicate error encountered somewhere during the processing of this operation.
Description
Provide access to all the requested account entries. The various aggregations are the popular ways in which client applications would like to group the results.
If the users want to get the summary status for the requested traffic throughput, please use 'getAcctStatForCustomer()'.
See Also
getAcctStatForCustomer
Gets the requested account entries that pertain to the specified customer site.
Usage
AggrAcctEntryBinCollection getAcctEntriesForCustomerSite(in string customerName, in string customerSiteName, in TimeInterval timeSlice, in Aggregation aggregateBy, in DCBFWQuery::QueryPrimitiveSeq membership, in AcctAttrQueryExpressionData loadOption)
raises(CiscoAcctMonitorException);
Parameters
customerName—in string Customer Name
customerSiteName—in string Customer site name
timeSlice—in TimeInterval specifies the size of the bins in which aggregated statistics are maintained.
aggregateBy—in Aggregation specifies the property over which the aggregation should be performed.
membership—in DCBFWQuery::QueryPrimitiveSeq describes the criteria used to identify the base datasets on which the aggregation operation should be performed.
loadOption—in AcctAttrQueryExpressionData describes the criteria used to identify the filtering rules on which the filter process should be performed.
Returns
AcctEntryBinCollection containing all tbe requested account entries grouped by different time line. These entries will includes both performance throughput. It did not include any vpn related information.
Raises
CiscoAcctMonitor::CiscoAcctMonitorException to indicate error encountered somewhere during the processing of this operation.
Description
Provide access to all the requested account entries. The various aggregations are the popular ways in which client applications would like to group the results.
If the users want to get the summary status for the requested traffic throughput, please use 'getAcctStatForCustomerSite()'.
See Also
getAcctStatForCustomerSite
Gets the summary status for those account entries that traverse the pair of customer sites of the specified customer.
Usage
AggrAcctEntryBinCollection getAcctEntriesForCustomerSiteToSite(in string customerName, in string siteName1, in string siteName2, in TimeInterval timeSlice, in Aggregation aggregateBy, in DCBFWQuery::QueryPrimitiveSeq membership, in AcctAttrQueryExpressionData loadOptions)
raises(CiscoAcctMonitorException);
Parameters
customerName—in string Customer Name
siteName1—in string Customer site name
siteName2—in string Customer site name
timeSlice—in TimeInterval specifies the size of the bins in which aggregated statistics are maintained.
aggregateBy—in Aggregation specifies the property over which the aggregation should be performed.
membership—in DCBFWQuery::QueryPrimitiveSeq describes the criteria used to identify the base datasets on which the aggregation operation should be performed.
loadOption—in AcctAttrQueryExpressionData describes the query expression used to identify the filtering rules on which the filter process should be performed.
Returns
AcctEntryBinCollection containing all tbe requested account entries grouped by different time line. These entries only includes attributes for performance throughput information. It did not include any vpn related information.
Raises
CiscoAcctMonitor::CiscoAcctMonitorException to indicate error encountered somewhere during the processing of this operation.
Description
Provide access to all the requested account entries. The various aggregations are the popular ways in which client applications would like to group the results.
If the users want to get the summary status for the requested traffic throughput, please use 'getAcctStatForCustomerSiteToSite()'.
See Also
getAcctStatForCustomerSiteToSite
Gets the requested account entries that pertain to the specified PE.
Usage
AggrAcctEntryBinCollection getAcctEntriesForPeRouter(in AcctTarget pe, in TimeInterval timeSlice, in Aggregation aggregateBy, in DCBFWQuery::QueryPrimitiveSeq membership, in AcctAttrQueryExpressionData loadOption)
raises(CiscoAcctMonitorException);
Parameters
pe—in AcctTarget PE router object
timeSlice—in TimeInterval specifies the size of the bins in which aggregated statistics are maintained.
aggregateBy—in Aggregation specifies the property over which the aggregation should be performed.
membership—in DCBFWQuery::QueryPrimitiveSeq describes the criteria used to identify the base datasets on which the aggregation operation should be performed.
loadOption—in AcctAttrQueryExpressionData describes the criteria used to identify the filter rules on which the filter process should be performed.
Returns
AcctEntryBinCollection containing all tbe requested account entries grouped by different time line. These entries only includes attributes for performance throughput information. These entries did not include any vpn related information.
Raises
CiscoAcctMonitor::CiscoAcctMonitorException to indicate error encountered somewhere during the processing of this operation.
Description
Provide access to all the requested account entries. The various aggregations are the popular ways in which client applications would like to group the results.
If the users want to get the summary status for the requested traffic throughput, please use 'getAcctStatForPeRouter()'
See Also
getAcctStatForPeRouter
Gets the requested account entries that traverse the specified PE-CE link. traversing between a PE router and a CE router.
Usage
AggrAcctEntryBinCollection getAcctEntriesForPeToCe(in AcctTarget pe, in AcctTarget ce, in TimeInterval timeSlice, in Aggregation aggregateBy, in DCBFWQuery::QueryPrimitiveSeq membership, in AcctAttrQueryExpressionData loadOption)
raises(CiscoAcctMonitorException);
Parameters
pe—in AcctTarget PE router object
ce—in AcctTarget CE router object
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.
loadOption—in AcctAttrQueryExpressionData describes the query expression used to identify the filtering rules on which the filter process should be performed.
Returns
AcctEntryBinCollection containing all tbe requested account entries grouped by different time line. These entries only includes attributes for performance throughput information. It did not include any vpn related information.
Raises
CiscoAcctMonitor::CiscoAcctMonitorException to indicate error encountered somewhere during the processing of this operation.
Description
Provide access to all the requested account entries. The various aggregations are the popular ways in which client applications would like to group the results.
If the users want to get the summary status for the requested traffic throughput, please use 'getAcctStatForPeToCe()'.
See Also
getAcctStatForPeToCe
Gets the requested account entries for data that traverses the PE-CE links between the specified PE and the CEs of the specified customer.
Usage
AggrAcctEntryBinCollection getAcctEntriesForPeToCustomer(in AcctTarget router, in string customerName, in TimeInterval timeSlice, in Aggregation aggregateBy, in DCBFWQuery::QueryPrimitiveSeq membership, in AcctAttrQueryExpressionData loadOption)
raises(CiscoAcctMonitorException);
Parameters
router—in AcctTarget PE Router Object
customerName—in string Customer Name
timeSlice—in TimeInterval specifies the size of the bins in which aggregated statistics are maintained.
aggregateBy—in Aggregation specifies the property over which the aggregation should be performed.
membership—in DCBFWQuery::QueryPrimitiveSeq describes the criteria used to identify the base datasets on which the aggregation operation should be performed.
loadOption—in AcctAttrQueryExpressionData describes the query expression used to identify the filtering rules on which the filter process should be performed.
Returns
AcctEntryBinCollection containing all tbe requested account entries grouped by different time line. These entries only includes attributes for performance throughput information. It did not include any vpn related information.
Raises
CiscoAcctMonitor::CiscoAcctMonitorException to indicate error encountered somewhere during the processing of this operation.
Description
Provide access to all the requested account entries. The various aggregations are the popular ways in which client applications would like to group the results.
If the users want to get the summary status for the requested traffic throughput, please use 'getAcctStatForPeToCustomer'.
See Also
getAcctStatForPeToCustomer
Gets the requested account entries that traverse the PE-CE links between the specified PE and the CEs of a specific customer site.
Usage
AggrAcctEntryBinCollection getAcctEntriesForPeToCustomerSite(in AcctTarget router, in string customerName, in string customerSiteName, in TimeInterval timeSlice, in Aggregation aggregateBy, in DCBFWQuery::QueryPrimitiveSeq membership, in AcctAttrQueryExpressionData loadOption)
raises(CiscoAcctMonitorException);
Parameters
router—in AcctTarget PE Router Object
customerName—in string Customer Name
customerSiteName—in string Customer Site Name
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.
loadOption—in AcctAttrQueryExpressionData describes the query expression used to identify the filtering rules on which the filter process should be performed.
Returns
AcctEntryBinCollection containing all tbe requested account entries grouped by different time line. These entries only includes attributes for performance throughput information. It did not include any vpn related information.
Raises
CiscoAcctMonitor::CiscoAcctMonitorException to indicate error encountered somewhere during the processing of this operation.
Description
Provide access to all the requested account entries. The various aggregations are the popular ways in which client applications would like to group the results.
If the users want to get the summary status for the requested traffic throughput, please use 'getAcctStatForPeToCustomer'.
See Also
getAcctStatForPeToCustomer
Gets the requested account entries that traverse the pair of PEs specified by the user input.
Usage
AggrAcctEntryBinCollection getAcctEntriesForPeToPe(in AcctTarget router1, in AcctTarget router2, in TimeInterval timeSlice, in Aggregation aggregateBy, in DCBFWQuery::QueryPrimitiveSeq membership, in AcctAttrQueryExpressionData loadOption)
raises(CiscoAcctMonitorException);
Parameters
router1—in AcctTarget One endpoint of the PE router object
router2—in AcctTarget The other endpoint of the PE router object
timeSlice—in TimeInterval specifies the size of the bins in which aggregated statistics are maintained.
aggregateBy—in Aggregation specifies the property over which the aggregation should be performed.
membership—in DCBFWQuery::QueryPrimitiveSeq describes the criteria used to identify the base datasets on which the aggregation operation should be performed.
loadOption—in AcctAttrQueryExpressionData describes the criteria used to identify the filter rules on which the filter process should be performed.
Returns
AggrAcctEntryBinCollection containing all tbe requested account entries grouped by different time stamp. These entries only includes attributes for performance throughput information. It did not include any vpn related information.
Raises
CiscoAcctMonitor::CiscoAcctMonitorException to indicate error encountered somewhere during the processing of this operation.
Description
Provide access to all the requested account entries. The various aggregations are the popular ways in which client applications would like to group the results.
If the users want to get the summary status for the requested traffic throughput, please use 'getAcctStatForPeToPe()'.
See Also
getAcctStatForPeToPe
Gets the summary status for those account entries for all customers.
Usage
AllAggrSummaryStatBinCollection getAcctStatForAllCustomer(in TimeInterval timeSlice, in Aggregation aggregateBy, in DCBFWQuery::QueryPrimitiveSeq membership, in AcctAttrQueryExpressionData loadOption)
raises(CiscoAcctMonitorException);
Parameters
timeSlice—in TimeInterval specifies the size of the bins in which aggregated statistics are maintained.
aggregateBy—in Aggregation specifies the property over which the aggregation should be performed.
membership—in DCBFWQuery::QueryPrimitiveSeq describes the criteria used to identify the base datasets on which the aggregation operation should be performed.
loadOption—in AcctAttrQueryExpressionData describes the criteria used to identify the filter rules on which the filter process should be performed.
Returns
AllAggrSummaryStatBinCollection containing the summary status for all customers.
Raises
CiscoAcctMonitor::CiscoAcctMonitorException to indicate error encountered somewhere during the processing of this operation.
Description
It is a convient function to get all the summary status for all the customers. The users also can user 'getAcctStatForCustomer()' to get the individual summary status for that customer.
See Also
getAcctStatForCustomer
Gets the account summary status for those account entries that traverse the pair of PEs specified by the user input.
Usage
AggrSummaryStatBinCollection getAcctStatForCeToCe(in AcctTarget router1, in AcctTarget router2, in TimeInterval timeSlice, in Aggregation aggregateBy, in DCBFWQuery::QueryPrimitiveSeq membership, in AcctAttrQueryExpressionData loadOption)
raises(CiscoAcctMonitorException);
Parameters
router1—in AcctTarget One endpoint of the CE router object
router2—in AcctTarget The other endpoint of the CE router object
timeSlice—in TimeInterval specifies the size of the bins in which aggregated statistics are maintained.
aggregateBy—in Aggregation specifies the property over which the aggregation should be performed.
membership—in DCBFWQuery::QueryPrimitiveSeq describes the criteria used to identify the base datasets on which the aggregation operation should be performed.
loadOption—in AcctAttrQueryExpressionData describes the query expresstion used to identify the filtering rules on which the filter process should be performed.
Returns
AggrSummaryStatBinCollection containing the summary statistics for the requested account entries.
Raises
CiscoAcctMonitor::CiscoAcctMonitorException to indicate error encountered somewhere during the processing of this operation.
Description
Provide access to the summary statistics. The various aggregations are the popular ways in which client applications would like to group the results.
It only provides the summay status for the requested account entries. If the users want to get the desired account entries, please use 'getAcctEntriesForCeToCe()' or 'getDetailAcctEntriesForCeToCe()'
See Also
getAcctEntriesForCeToCe, getDetailAcctEntriesForCeToCe
Gets the summary status for those account entries that pertain to the specified customer.
Usage
AggrSummaryStatBinCollection getAcctStatForCustomer(in string customerName, in TimeInterval timeSlice, in Aggregation aggregateBy, in DCBFWQuery::QueryPrimitiveSeq membership, in AcctAttrQueryExpressionData loadOption)
raises(CiscoAcctMonitorException);
Parameters
customerName—in string Customer Name
timeSlice—in TimeInterval specifies the size of the bins in which aggregated statistics are maintained.
aggregateBy—in Aggregation specifies the property over which the aggregation should be performed.
membership—in DCBFWQuery::QueryPrimitiveSeq describes the query expression used to identify the base datasets on which the aggregation operation should be performed.
loadOption—in AcctAttrQueryExpressionData describes the criteria used to identify the filtering rules on which the filter process should be performed.
Returns
AggrSummaryStatBinCollection containing the summary statistics for the requested account entries for the specified customer.
Raises
CiscoAcctMonitor::CiscoAcctMonitorException to indicate error encountered somewhere during the processing of this operation.
Description
Provide access to the summary statistics. The various aggregations are the popular ways in which client applications would like to group the results.
It only procides the summay status for the requested account entries. If the users want to get the desired account entry list, please use 'getAcctEntriesForCustomer()' or 'getDetailAcctEntriesForCustomer()'.
See Also
getAcctEntriesForCustomer, getDetailAcctEntriesForCustomer
Gets the summary status for those account entries that pertain to the specified customer site.
Usage
AggrSummaryStatBinCollection getAcctStatForCustomerSite(in string customerName, in string customerSiteName, in TimeInterval timeSlice, in Aggregation aggregateBy, in DCBFWQuery::QueryPrimitiveSeq membership, in AcctAttrQueryExpressionData loadOption)
raises(CiscoAcctMonitorException);
Parameters
customerName—in string Customer Name
customerSiteName—in string Customer site name
timeSlice—in TimeInterval specifies the size of the bins in which aggregated statistics are maintained.
aggregateBy—in Aggregation specifies the property over which the aggregation should be performed.
membership—in DCBFWQuery::QueryPrimitiveSeq describes the criteria used to identify the base datasets on which the aggregation operation should be performed.
loadOption—in AcctAttrQueryExpressionData describes the criteria used to identify the filtering rules on which the filter process should be performed.
Returns
AggrSummaryStatBinCollection containing the summary statistics for the requested account entries.
Raises
CiscoAcctMonitor::CiscoAcctMonitorException to indicate error encountered somewhere during the processing of this operation.
Description
Provide access to the summary statistics. The various aggregations are the popular ways in which client applications would like to group the results.
It only procides the summay status for the requested account entries. If the users want to get the desired account entry list, please use 'getAcctEntriesForCustomerSite()' or 'getDetailAcctEntriesForCustomerSite().
See Also
getAcctEntriesForCustomerSite, getDetailAcctEntriesForCustomerSite
Gets the summary status for those account entries that traverse the pair of customer sites of the specified customer.
Usage
AggrSummaryStatBinCollection getAcctStatForCustomerSiteToSite(in string customerName, in string siteName1, in string siteName2, in TimeInterval timeSlice, in Aggregation aggregateBy, in DCBFWQuery::QueryPrimitiveSeq membership, in AcctAttrQueryExpressionData loadOption)
raises(CiscoAcctMonitorException);
Parameters
customerName—in string Customer Name
siteName1—in string Customer site name
siteName2—in string Customer site name
timeSlice—in TimeInterval specifies the size of the bins in which aggregated statistics are maintained.
aggregateBy—in Aggregation specifies the property over which the aggregation should be performed.
membership—in DCBFWQuery::QueryPrimitiveSeq describes the criteria used to identify the base datasets on which the aggregation operation should be performed.
loadOption—in AcctAttrQueryExpressionData describes the query expression used to identify the filtering rules on which the filter process should be performed.
Returns
AggrSummaryStatBinCollection containing the summary statistics for the requested account entries.
Raises
CiscoAcctMonitor::CiscoAcctMonitorException to indicate error encountered somewhere during the processing of this operation.
Description
Provide access to the summary statistics. The various aggregations are the popular ways in which client applications would like to group the results.
It only procides the summay status for the requested account entries. If the users want to get the desired account entries list, please user 'getAcctEntriesForCustomerSiteToSite()' or 'getDetailAcctEntriesForCustomerSiteToSite()'.
See Also
getAcctEntriesForCustomerSiteToSite, getDetailAcctEntriesForCustomerSiteToSite
Gets the summary status for those account entries that pertain to the specified PE.
Usage
AggrSummaryStatBinCollection getAcctStatForPeRouter(in AcctTarget pe, in TimeInterval timeSlice, in Aggregation aggregateBy, in DCBFWQuery::QueryPrimitiveSeq membership, in AcctAttrQueryExpressionData loadOption)
raises(CiscoAcctMonitorException);
Parameters
pe—in AcctTarget PE router object
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.
aggregateBy—in Aggregation specifies the property over which the aggregation should be performed.
loadOptions—in AcctAttrQueryExpressionData describes the criteria used to identify the filter rules on which the filter process should be performed.
Returns
AggrSummaryStatBinCollection containing the summary statistics for the requested account entries.
Raises
CiscoAcctMonitor::CiscoAcctMonitorException to indicate error encountered somewhere during the processing of this operation.
Description
Provide access to the summary statistics. The various aggregations are the popular ways in which client applications would like to group the results.
It only procides the summay status for the requested account entries. If the users want to get the desired account entries, please use 'getAcctEntriesForPeRouter()' or 'getDetailAcctEntriesForPeRouter()'.
See Also
getAcctEntriesForPeRouter, getDetailAcctEntriesForPeRouter
Gets the summary statistics for the requested account entries that traverse the specified PE-CE link.
Usage
AggrSummaryStatBinCollection getAcctStatForPeToCe(in AcctTarget pe, in AcctTarget ce, in TimeInterval timeSlice, in Aggregation aggregateBy, in DCBFWQuery::QueryPrimitiveSeq membership, in AcctAttrQueryExpressionData loadOption)
raises(CiscoAcctMonitorException);
Parameters
pe—in AcctTarget PE router object
ce—in AcctTarget CE router object
timeSlice—in TimeInterval specifies the size of the bins in which aggregated statistics are maintained.
aggregateBy—in Aggregation specifies the property over which the aggregation should be performed.
membership—in DCBFWQuery::QueryPrimitiveSeq describes the criteria used to identify the base datasets on which the aggregation operation should be performed.
loadOption—in AcctAttrQueryExpressionData describes the query expression used to identify the filtering rules on which the filter process should be performed.
Returns
AggrSummaryStatBinCollection containing the summary statistics for the requested account entries.
Raises
CiscoAcctMonitor::CiscoAcctMonitorException to indicate error encountered somewhere during the processing of this operation.
Description
Provide access to all the requested vpn traffic entries. The various aggregations are the popular ways in which client applications would like to group the results.
If the users want to get the summary status for the requested traffic throughput, please use 'getAcctEntriesForPeToCe'.
See Also
getAcctEntriesForPeToCe
Gets the summary statistics for the requested account entries that traverse the PE-CE links between the specified PE and the CEs of the specified customer.
Usage
AggrSummaryStatBinCollection getAcctStatForPeToCustomer(in AcctTarget router, in string customerName, in TimeInterval timeSlice, in Aggregation aggregateBy, in DCBFWQuery::QueryPrimitiveSeq membership, in AcctAttrQueryExpressionData loadOption)
raises(CiscoAcctMonitorException);
Parameters
router—in AcctTarget PE Router Object
customerName—in string Customer Name
timeSlice—in TimeInterval specifies the size of the bins in which aggregated statistics are maintained.
aggregateBy—in Aggregation specifies the property over which the aggregation should be performed.
membership—in DCBFWQuery::QueryPrimitiveSeq describes the criteria used to identify the base datasets on which the aggregation operation should be performed.
loadOption—in AcctAttrQueryExpressionData describes the query expression used to identify the filtering rules on which the filter process should be performed.
Returns
AggrSummaryStatBinCollection containing the summary statistics for the requested account entries.
Raises
CiscoAcctMonitor::CiscoAcctMonitorException to indicate error encountered somewhere during the processing of this operation.
Description
Provide access to all the requested account entries. The various aggregations are the popular ways in which client applications would like to group the results.
If the users want to get the summary status for the desired account entries list, please use 'getAcctEntriesForPeToCustomer()' or 'getDetailAcctEntriesForPeToCustomer()'.
See Also
getAcctEntriesForPeToCustomer, getDetailAcctEntriesForPeToCustomer
Gets the summary statistics for the requested account entries that traverse the PE-CE links between the specified PE and the CEs of a specific customer site.
Usage
AggrSummaryStatBinCollection getAcctStatForPeToCustomerSite(in AcctTarget router, in string customerName, in string customerSiteName, in TimeInterval timeSlice, in Aggregation aggregateBy, in DCBFWQuery::QueryPrimitiveSeq membership, in AcctAttrQueryExpressionData loadOption)
raises(CiscoAcctMonitorException);
Parameters
router—in AcctTarget PE Router Object
customerName—in string Customer Name
customerSiteName—in string Customer Site Name
timeSlice—in TimeInterval specifies the size of the bins in which aggregated statistics are maintained.
aggregateBy—in Aggregation specifies the property over which the aggregation should be performed.
membership—in DCBFWQuery::QueryPrimitiveSeq describes the criteria used to identify the base datasets on which the aggregation operation should be performed.
loadOption—in AcctAttrQueryExpressionData describes the query expression used to identify the filtering rules on which the filter process should be performed.
Returns
AggrSummaryStatBinCollection containing the summary statistics for the requested account entries.
Raises
CiscoAcctMonitor::CiscoAcctMonitorException to indicate error encountered somewhere during the processing of this operation.
Description
Provide access to all the requested account entries. The various aggregations are the popular ways in which client applications would like to group the results.
If the users want to get the summary status for the desired account entries list, please use 'getAcctEntriesForPeToCustomer()' or 'getDetailAcctEntriesForPeToCustomer()'.
See Also
getAcctEntriesForPeToCustomer, getDetailAcctEntriesForPeToCustomer
Gets the account summary status for those account entries that traverse the pair of PEs specified by the user input.
Usage
AggrSummaryStatBinCollection getAcctStatForPeToPe(in AcctTarget router1, in AcctTarget router2, in TimeInterval timeSlice, in Aggregation aggregateBy, in DCBFWQuery::QueryPrimitiveSeq membership, in AcctAttrQueryExpressionData loadOption)
raises(CiscoAcctMonitorException);
Parameters
router1—in AcctTarget One endpoint of the PE router object
router2—in AcctTarget The other endpoint of the PE router object
timeSlice—in TimeInterval specifies the size of the bins in which aggregated statistics are maintained.
aggregateBy—in Aggregation specifies the property over which the aggregation should be performed.
membership—in DCBFWQuery::QueryPrimitiveSeq describes the criteria used to identify the base datasets on which the aggregation operation should be performed.
loadOption—in AcctAttrQueryExpressionData describes the query expresstion used to identify the filtering rules on which the filter process should be performed.
Returns
AggrSummaryStatBinCollection containing the summary statistics for the requested account entries.
Raises
CiscoAcctMonitor::CiscoAcctMonitorException to indicate error encountered somewhere during the processing of this operation.
Description
Provide access to the summary statistics. The various aggregations are the popular ways in which client applications would like to group the results.
It only procides the summay status for the requested account entries. To get the desired account entries, use either the AcctMonitor:getAcctEntriesForPeToPe() operation or the AcctMonitor::getDetailAcctEntriesForPeToPe() operation.
See Also
getAcctEntriesForPeToPe, getDetailAcctEntriesForPeToPe
Gets the requested account entries for the whole system.
Usage
AggrAcctEntryBinCollection getAllAcctEntries(in TimeInterval timeSlice, in Aggregation aggregateBy, in DCBFWQuery::QueryPrimitiveSeq membership, in AcctAttrQueryExpressionData loadOption)
raises(CiscoAcctMonitorException);
Parameters
timeSlice—in TimeInterval specifies the size of the bins in which aggregated statistics are maintained.
aggregateBy—in Aggregation specifies the property over which the aggregation should be performed.
membership—in DCBFWQuery::QueryPrimitiveSeq describes the criteria used to identify the base datasets on which the aggregation operation should be performed.
loadOption—in AcctAttrQueryExpressionData describes the criteria used to identify the filter rules on which the filter process should be performed.
Returns
AcctEntryBinCollection containing all tbe requested account entries grouped by different time stamp. These entries only includes attributes for performance throughput information. It did not include any vpn related information.
Raises
CiscoAcctMonitor::CiscoAcctMonitorException to indicate error encountered somewhere during the processing of this operation.
Description
Provide access to all the requested account entries. The various aggregations are the popular ways in which client applications would like to group the results.
If the users want to get the summary status for the requested traffic throughput, please use 'getAllAcctStat()'.
See Also
getAllAcctStat
Gets the categorized accounting summary status for the whole system.
Usage
AggrSummaryStatBinCollection getAllAcctStat(in TimeInterval timeSlice, in Aggregation aggregateBy, in DCBFWQuery::QueryPrimitiveSeq membership, in AcctAttrQueryExpressionData loadOption)
raises(CiscoAcctMonitorException);
Parameters
timeSlice—in TimeInterval specifies the size of the bins in which aggregated statistics are maintained.
aggregateBy—in Aggregation specifies the property over which the aggregation should be performed.
membership—in DCBFWQuery::QueryPrimitiveSeq describes the criteria used to identify the base datasets on which the aggregation operation should be performed.
loadOption—in AcctAttrQueryExpressionData describes the query expresstion used to identify the filtering rules on which the filter process should be performed.
Returns
AggrSummaryStatBinCollection containing the summary statistics for the requested account entries.
Raises
CiscoAcctMonitor::CiscoAcctMonitorException to indicate error encountered somewhere during the processing of this operation.
Description
Provide access to the summary statistics. The various aggregations are the popular ways in which client applications would like to group the results.
It only procides the summay status for the requested account entries. If the users want to get the desired account entries, please use 'getAllAcctEntries()' or 'getAllDetailAcctEntries()'
See Also
getAllAcctEntries, getAllDetailAcctEntries
Gets the requested account entries for the whole system.
Usage
AggrDetailAcctEntryBinCollection getAllDetailAcctEntries(in TimeInterval timeSlice, in Aggregation aggrTag, in DCBFWQuery::QueryPrimitiveSeq membership, in AcctAttrQueryExpressionData loadOption)
raises(CiscoAcctMonitorException);
Parameters
timeSlice—in TimeInterval specifies the size of the bins in which aggregated statistics are maintained.
aggregateBy—in Aggregation specifies the property over which the aggregation should be performed.
membership—in DCBFWQuery::QueryPrimitiveSeq describes the criteria used to identify the base datasets on which the aggregation operation should be performed.
loadOption—in AcctAttrQueryExpressionData describes the query expression used to identify the filtering rules on which the filter process should be performed.
Returns
DetailAcctEntryBinCollection containing all tbe requested account entries grouped by different time stamp. These entries will includes both performance throughput as well as those vpn aware information.
Raises
CiscoAcctMonitor::CiscoAcctMonitorException to indicate error encountered somewhere during the processing of this operation.
Description
Provide access to all the requested account entries. The various aggregations are the popular ways in which client applications would like to group the results.
If the users want to get the summary status for the requested traffic throughput, please use 'getAllAcctStat()'.
See Also
getAllAcctStat
Gets a CE based on its target ID.
Usage
AcctTarget getCeRouterByTargetID(in long targetID)
raises(CiscoAcctMonitorException);
Parameters
targetID—in long Target ID
Returns
AcctTarget—CE in the VPN Inventory Repository.
Raises
CiscoAcctMonitor::CiscoAcctMonitorException to indicate error encountered somewhere during the processing of this operation.
Description
It will provide the users the specified CE router currently in the repository. The user can choose the interested PE router to apply into the above different aggregation API. All the customer list will be retrieved from Vpn Inventory Repository. Hence, the user did not need to understand the VPN Inventory API to retrieved the desired information.
Gets a collection of all CEs for the specified customer.
Usage
AcctTargetCollection getCeRouterListForCustomer(in string customerName)
raises(CiscoAcctMonitorException);
Parameters
customerName—in string Customer name
Returns
AcctTargetCollection containing all the CE routers known in this repository for the specified customer.
Raises
CiscoAcctMonitor::CiscoAcctMonitorException to indicate error encountered somewhere during the processing of this operation.
Description
It will provide the users all the PE router currently in the repository. The user can choose the interested CE router to apply into the above different aggregation API. All the customer list will be retrieved from Vpn Inventory Repository. Hence, the user did not need to understand the VPN Inventory API to retrieved the desired information.
Gets all CE routers that have the immediate connection with PE router
Usage
AcctTargetCollection getConnectedCeRouterListForPe(in AcctTarget pe)
raises(CiscoAcctMonitorException);
Parameters
pe—in AcctTarget PE Router Object
Returns
AcctTargetCollection containing all the CE routers known in this repository that have the immediate connection with the specidifed PE rouer
Raises
CiscoAcctMonitor::CiscoAcctMonitorException to indicate error encountered somewhere during the processing of this operation.
Description
It will provide the users all the CE router currently in the repository that have the immediate connection with the specified PE router. The user can choose the interested CE router to apply into the above different aggregation API. The client can get the availabe PE router lists from the above API.
Gets a list of all customer names in the VPN Inventory Repository.
Usage
StringSeq getCustomerNameList(); raises(CiscoAcctMonitorException);
Returns
StringSeq A sequence of string that contains a list of customer name.
Raises
CiscoAcctMonitor::CiscoAcctMonitorException to indicate error encountered somewhere during the processing of this operation.
Description
It will provide the users a list of customer that is currently being provided service. By using the return list, user can choose the interested customer to apply into the above different aggregation API. All the customer list will be retrieved from Vpn Inventory Repository. Hence, the user did not need to understand the VPN Inventory API to retrieved the desired information.
Gets a lost of all sites in the VPN Inventory Repository for the specified customer.
Usage
StringSeq getCustomerSiteNameList(in string customerName)
raises(CiscoAcctMonitorException);
Parameters
customerName—in string Customer name
Returns
StringSeq A sequence of string that contains a list of customer name.
Raises
CiscoAcctMonitor::CiscoAcctMonitorException to indicate error encountered somewhere during the processing of this operation.
Description
It will provide the users a list of customer site that is currently being provided service. By using the return list, user can choose the interested customer and site to apply into the above aggregation API. All the customer site list will be retrieved from Vpn Inventory Repository. Hence, the user did not need to understand the VPN Inventory API to retrieved the desired information.
Gets the requested account entries that traverse the pair of PEs specified by the user input.
Usage
AggrDetailAcctEntryBinCollection getDetailAcctEntriesForCeToCe(in AcctTarget router1, in AcctTarget router2, in TimeInterval timeSlice, in Aggregation aggregateBy, in DCBFWQuery::QueryPrimitiveSeq membership, in AcctAttrQueryExpressionData loadOption)
raises(CiscoAcctMonitorException);
Parameters
router1—in AcctTarget One endpoint of the CE router object
router2—in AcctTarget The other endpoint of the CE router object
timeSlice—in TimeInterval specifies the size of the bins in which aggregated statistics are maintained.
aggregateBy—in Aggregation specifies the property over which the aggregation should be performed.
membership—in DCBFWQuery::QueryPrimitiveSeq describes the criteria used to identify the base datasets on which the aggregation operation should be performed.
loadOption—in AcctAttrQueryExpressionData describes the query expression used to identify the filtering rules on which the filter process should be performed.
Returns
DetailAcctEntryBinCollection containing all tbe requested account entries grouped by different time stamp. These entries will includes both performance throughput as well as those vpn aware information.
Raises
CiscoAcctMonitor::CiscoAcctMonitorException to indicate error encountered somewhere during the processing of this operation.
Description
Provide access to all the requested account entries. The various aggregations are the popular ways in which client applications would like to group the results.
If the users want to get the summary status for the requested traffic throughput, please use 'getAcctStatForCeToCe()'.
See Also
getAcctStatForCeToCe
Gets the requested detailed account entries that pertain to the specified customer.
Usage
AggrDetailAcctEntryBinCollection getDetailAcctEntriesForCustomer(in string customerName, in TimeInterval timeSlice, in Aggregation aggregateBy, in DCBFWQuery::QueryPrimitiveSeq membership, in AcctAttrQueryExpressionData loadOption)
raises(CiscoAcctMonitorException);
Parameters
customerName—in string Customer Name
timeSlice—in TimeInterval specifies the size of the bins in which aggregated statistics are maintained.
aggregateBy—in Aggregation specifies the property over which the aggregation should be performed.
membership—in DCBFWQuery::QueryPrimitiveSeq describes the criteria used to identify the base datasets on which the aggregation operation should be performed.
loadOption—in AcctAttrQueryExpressionData describes the criteria used to identify the filtering rules on which the filter process should be performed.
Returns
DetailAcctEntryBinCollection containing all tbe requested account entries grouped by different time line. These entries will includes both performance throughput as well as those vpn aware information.
Raises
CiscoAcctMonitor::CiscoAcctMonitorException to indicate error encountered somewhere during the processing of this operation.
Description
Provide access to all the requested account entries. The various aggregations are the popular ways in which client applications would like to group the results.
If the users want to get the summary status for the requested traffic throughput, please use 'getAcctStatForCustomer()'.
See Also
getAcctStatForCustomer
Gets the requested detailed account entries that pertain to the specified customer site.
Usage
AggrDetailAcctEntryBinCollection getDetailAcctEntriesForCustomerSite(in string customerName, in string customerSiteName, in TimeInterval timeSlice, in Aggregation aggregateBy, in DCBFWQuery::QueryPrimitiveSeq membership, in AcctAttrQueryExpressionData loadOption)
raises(CiscoAcctMonitorException);
Parameters
customerName—in string Customer Name
customerSiteName—in string Customer site name
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.
aggregateBy—in Aggregation specifies the property over which the aggregation should be performed.
loadOption—in AcctAttrQueryExpressionData describes the criteria used to identify the filter rules on which the filter process should be performed.
Returns
DetailAcctEntryBinCollection containing all tbe requested account entries grouped by different time line. These entries will includes both performance throughput as well as those vpn aware information.
Raises
CiscoAcctMonitor::CiscoAcctMonitorException to indicate error encountered somewhere during the processing of this operation.
Description
Provide access to all the requested vpn traffic entries. The various aggregations are the popular ways in which client applications would like to group the results.
If the users want to get the summary status for the requested traffic throughput, please use 'getAcctStatForCustomerSite()'.
See Also
getAcctStatForCustomerSite
Gets the summary status for those account entries that traverse the pair of customer sites of the specified customer.
Usage
AggrDetailAcctEntryBinCollection getDetailAcctEntriesForCustomerSiteToSite(in string customerName, in string siteName1, in string siteName2, in TimeInterval timeSlice, in Aggregation aggregateBy, in DCBFWQuery::QueryPrimitiveSeq membership, in AcctAttrQueryExpressionData loadOption)
raises(CiscoAcctMonitorException);
Parameters
customerName—in string Customer Name
siteName1—in string Customer site name
siteName2—in string Customer site name
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.
loadOption—in AcctAttrQueryExpressionData describes the query expression used to identify the filtering rules on which the filter process should be performed.
Returns
DetailAcctEntryBinCollection containing all tbe requested account entries grouped by different time line. Those entries will include both performance throughput information and vpn aware information as well.
Raises
CiscoAcctMonitor::CiscoAcctMonitorException to indicate error encountered somewhere during the processing of this operation.
Description
Provide access to all the requested account entries. The various aggregations are the popular ways in which client applications would like to group the results.
If the users want to get the summary status for the requested traffic throughput, please use 'getAcctStatForCustomerSiteToSite()'.
See Also
getAcctStatForCustomerSiteToSite
Gets the requested detailed account entries that pertain to the specified PE.
Usage
AggrDetailAcctEntryBinCollection getDetailAcctEntriesForPeRouter(in AcctTarget pe, in TimeInterval timeSlice, in Aggregation aggregateBy, in DCBFWQuery::QueryPrimitiveSeq membership, in AcctAttrQueryExpressionData loadOption)
raises(CiscoAcctMonitorException);
Parameters
pe—in AcctTarget PE router object
timeSlice—in TimeInterval specifies the size of the bins in which aggregated statistics are maintained.
aggregateBy—in Aggregation specifies the property over which the aggregation should be performed.
membership—in DCBFWQuery::QueryPrimitiveSeq describes the criteria used to identify the base datasets on which the aggregation operation should be performed.
loadOption—in AcctAttrQueryExpressionData describes the criteria used to identify the filter rules on which the filter process should be performed.
Returns
DetailAcctEntryBinCollection containing all tbe requested account entries grouped by different time line. These entries will includes both performance throughput as well as those vpn aware information.
Raises
CiscoAcctMonitor::CiscoAcctMonitorException to indicate error encountered somewhere during the processing of this operation.
Description
Provide access to all the requested account entries. The various aggregations are the popular ways in which client applications would like to group the results.
If the users want to get the summary status for the requested traffic throughput, please use 'getAcctStatForPeRouter()'
See Also
getAcctStatForPeRouter
Gets the requested detailed account entries that traverse the specified PE-CE link. traversing between a PE router and a CE router.
Usage
AggrDetailAcctEntryBinCollection getDetailAcctEntriesForPeToCe(in AcctTarget pe, in AcctTarget ce, in TimeInterval timeSlice, in Aggregation aggregateBy, in DCBFWQuery::QueryPrimitiveSeq membership, in AcctAttrQueryExpressionData loadOption)
raises(CiscoAcctMonitorException);
Parameters
pe—in AcctTarget PE router object
ce—in AcctTarget CE router object
timeSlice—in TimeInterval specifies the size of the bins in which aggregated statistics are maintained.
aggregateBy—in Aggregation specifies the property over which the aggregation should be performed.
membership—in DCBFWQuery::QueryPrimitiveSeq describes the criteria used to identify the base datasets on which the aggregation operation should be performed.
loadOption—in AcctAttrQueryExpressionData describes the query expression used to identify the filtering rules on which the filter process should be performed.
Returns
DetailAcctEntryBinCollection containing all tbe requested account entries grouped by different time line. These entries will includes both performance throughput as well as those vpn aware information.
Raises
CiscoAcctMonitor::CiscoAcctMonitorException to indicate error encountered somewhere during the processing of this operation.
Description
Provide access to all the requested account entries. The various aggregations are the popular ways in which client applications would like to group the results.
If the users want to get the summary status for the requested traffic throughput, please use 'getAcctStatForPeToCe()'.
See Also
getAcctStatForPeToCe
Gets the requested detailed account entries for data that traverses the PE-CE links between the specified PE and the CEs of the specified customer.
Usage
AggrDetailAcctEntryBinCollection getDetailAcctEntriesForPeToCustomer(in AcctTarget router, in string customerName, in TimeInterval timeSlice, in Aggregation aggregateBy, in DCBFWQuery::QueryPrimitiveSeq membership, in AcctAttrQueryExpressionData loadOption)
raises(CiscoAcctMonitorException);
Parameters
router—in AcctTarget PE Router Object
customerName—in string Customer Name
timeSlice—in TimeInterval specifies the size of the bins in which aggregated statistics are maintained.
aggregateBy—in Aggregation specifies the property over which the aggregation should be performed.
membership—in DCBFWQuery::QueryPrimitiveSeq describes the criteria used to identify the base datasets on which the aggregation operation should be performed.
loadOption—in AcctAttrQueryExpressionData describes the query expression used to identify the filtering rules on which the filter process should be performed.
Returns
DetailAcctEntryBinCollection containing all tbe requested account entries group by different time line. These entries will includes both performance throughput as well as those vpn aware information.
Raises
CiscoAcctMonitor::CiscoAcctMonitorException to indicate error encountered somewhere during the processing of this operation.
Description
Provide access to all the requested account entries. The various aggregations are the popular ways in which client applications would like to group the results.
If the users want to get the summary status for the requested traffic throughput, please use 'getAcctStatForPeToCustomer()'.
See Also
getAcctStatForPeToCustomer
Gets the requested detail account entries that traverse the PE-CE links between the specified PE and the CEs of a specific customer site.
Usage
AggrDetailAcctEntryBinCollection getDetailAcctEntriesForPeToCustomerSite(in AcctTarget router, in string customerName, in string customerSiteName, in TimeInterval timeSlice, in Aggregation aggregateBy, in DCBFWQuery::QueryPrimitiveSeq membership, in AcctAttrQueryExpressionData loadOption)
raises(CiscoAcctMonitorException);
Parameters
router—in AcctTarget PE Router Object
customerName—in string Customer Name
customerSiteName—in string Customer Site Name
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.
loadOption—in AcctAttrQueryExpressionData describes the query expression used to identify the filtering rules on which the filter process should be performed.
Returns
DetailAcctEntryBinCollection containing all tbe requested account entries group by different time line. These entries will includes both performance throughput as well as those vpn aware information.
Raises
CiscoAcctMonitor::CiscoAcctMonitorException to indicate error encountered somewhere during the processing of this operation.
Description
Provide access to all the requested account entries. The various aggregations are the popular ways in which client applications would like to group the results.
If the users want to get the summary status for the requested traffic throughput, please use 'getAcctStatForPeToCustomer()'.
See Also
getAcctStatForPeToCustomer
Gets the requested account entries that traverse the pair of PEs specified by the user input.
Usage
AggrDetailAcctEntryBinCollection getDetailAcctEntriesForPeToPe(in AcctTarget router1, in AcctTarget router2, in TimeInterval timeSlice, in Aggregation aggregateBy, in DCBFWQuery::QueryPrimitiveSeq membership, in AcctAttrQueryExpressionData loadOption)
raises(CiscoAcctMonitorException);
Parameters
router1—in AcctTarget One endpoint of the PE router object
router2—in AcctTarget The other endpoint of the PE router object
timeSlice—in TimeInterval specifies the size of the bins in which aggregated statistics are maintained.
aggregateBy—in Aggregation specifies the property over which the aggregation should be performed.
membership—in DCBFWQuery::QueryPrimitiveSeq describes the criteria used to identify the base datasets on which the aggregation operation should be performed.
loadOption—in AcctAttrQueryExpressionData describes the query expression used to identify the filtering rules on which the filter process should be performed.
Returns
DetailAcctEntryBinCollection containing all tbe requested account entries grouped by different time stamp. These entries will includes both performance throughput as well as those vpn aware information.
Raises
CiscoAcctMonitor::CiscoAcctMonitorException to indicate error encountered somewhere during the processing of this operation.
Description
Provide access to all the requested account entries. The various aggregations are the popular ways in which client applications would like to group the results.
If the users want to get the summary status for the requested traffic throughput, please use 'getAcctStatForPeToPe()'.
See Also
getAcctStatForPeToPe
Gets a PE based on its target ID.
Usage
AcctTarget getPeRouterByTargetID(in long targetID)
raises(CiscoAcctMonitorException);
Parameters
targetID—in long Target ID
Returns
AcctTarget—PE in the VPN Inventory Repository.
Raises
CiscoAcctMonitor::CiscoAcctMonitorException to indicate error encountered somewhere during the processing of this operation.
Description
It will provide the users the specified PE router currently in the repository. The user can choose the interested PE router to apply into the above different aggregation API. All the customer list will be retrieved from Vpn Inventory Repository. Hence, the user did not need to understand the VPN Inventory API to retrieved the desired information.
Gets a list of all PEs in the VPN Inventory Repository.
Usage
AcctTargetCollection getPeRouterList(); raises(CiscoAcctMonitorException);
Returns
AcctTargetCollection—Collection of all the PEs in the VPN Inventory Repository.
Raises
CiscoAcctMonitor::CiscoAcctMonitorException to indicate error encountered somewhere during the processing of this operation.
Description
It will provide the users all the PE router currently in the repository. The user can choose the interested PE router to apply into the above different aggregation API. All the customer list will be retrieved from Vpn Inventory Repository. Hence, the user did not need to understand the VPN Inventory API to retrieved the desired information.
An instance of the AcctTargetCollection interface provides a means by which to interact with a collection of AcctTarget types.
Description
The AcctTarget types in the collection are managed as an AcctTargetSeq type or a list of AcctTarget types. Using the operations that are supplied in this interface, you can programmatically retrieve objects from the collection in either sequential or random order.
See Also
AcctTarget, AcctTargetSeq, AcctTargetCollection::dispose, AcctEntryCollection, AcctTargetCollection, AggrAcctEntryBinCollection, AggrAcctEntryCollection, AggrDetailAcctEntryBinCollection, AggrDetailAcctEntryCollection, AggrSummaryStatBinCollection, AggrSummaryStatCollection, AllAggrSummaryStatBinCollection, DetailAcctEntryCollection, SummaryStatCollection, DCBFWCollection::StringCollection, DCBFWCollection::KeyedObjectCollection
Since
Cisco VPN Solutions Center, Release 1.0
readonly attribute long size
A readonly attribute that represents the number of elements in the AcctTargetCollection 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
Disposes the AcctTargetCollection object and frees the server resources that are associated with it.
Usage
void dispose();
Description
Once executed, the AcctTargetCollection 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
AcctTargetCollection
Since
Data Collection Base Framework, Release 1.0
Cisco VPN Solutions Center, Release 1.0
Gets the AcctTargetCollection element at the specified index.
Usage
AcctTarget elementAtIndex(in long index)
raises(InvalidIndexException, InvalidatedException);
Parameters
index—in long value that specifies the index of the element to get.
Returns
AcctTarget that represents the specified AcctTargetCollection 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
Gets a specified number of AcctTargetCollection elements at the specified index.
Usage
AcctTargetSeq 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 AcctTargetCollection elements to get.
Returns
AcctTargetSeq that represent the specified AcctTargetCollection elements.
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
If the end of the collection is reached before the specified numberOfElements is returned, AcctTargetCollection 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
Gets the index value of the current AcctTargetCollection element.
Usage
long getIndex(); raises(InvalidatedException);
Returns
long—Index of the element at the current position in the AcctTargetCollection collection.
Raises
DCBFWCollection::InvalidatedException if this collectionis invalidated by the server.
Description
The AcctTargetCollection 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
Gets the next AcctTargetCollection element.
Usage
AcctTarget nextElement(); raises(EndOfCollectionException, InvalidatedException);
Returns
AcctTarget that represents the next AcctTargetCollection 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
Gets the next few AcctTargetCollection elements.
Usage
AcctTargetSeq nextElements(in long numberOfElements)
raises(EndOfCollectionException, InvalidatedException);
Parameters
numberOfElements—in long that indicates the number of elements to get.
Returns
AcctTargetSeq that represent the next few AcctTargetCollection elements as specified by the numberOfElements input value.
Raises
DCBFWCollection::EndOfCollectionException if the end ofthe collection is reached without returning any items. DCBFWCollection::InvalidatedException if this collectionis invalidated by the server.
Description
If the end of the collection is reached before the specified numberOfElements is returned, AcctTargetCollection 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.
See Also
setIndex, getIndex, nextElement, elementAtIndex, elementsAtIndex, size
Since
Data Collection Base Framework, Release 1.0
Cisco VPN Solutions Center, Release 1.0
Sets the index value of the current AcctTargetCollection element.
Usage
void setIndex(in long index)
raises(InvalidatedException, InvalidIndexException);
Parameters
index—in long that represents the index to value assign to the current AcctTargetCollection 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
The AcctTargetCollection 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
An instance of the AggrAcctEntryBinCollection interface provides a means by which to interact with a collection of AggrAcctEntryBin types.
Description
The AggrAcctEntryBin types in the collection are managed as an AggrAcctEntryBinSeq type or a list of AggrAcctEntryBin types. Using the operations that are supplied in this interface, you can programmatically retrieve objects from the collection in either sequential or random order.
See Also
AggrAcctEntryBin, AggrAcctEntryBinSeq, AggrAcctEntryBinCollection::dispose, AcctEntryCollection, AcctTargetCollection, AggrAcctEntryBinCollection, AggrAcctEntryCollection, AggrDetailAcctEntryBinCollection, AggrDetailAcctEntryCollection, AggrSummaryStatBinCollection, AggrSummaryStatCollection, AllAggrSummaryStatBinCollection, DetailAcctEntryCollection, SummaryStatCollection, DCBFWCollection::StringCollection, DCBFWCollection::KeyedObjectCollection
Since
Cisco VPN Solutions Center, Release 1.0
readonly attribute long size
A readonly attribute that represents the number of elements in the AggrAcctEntryBinCollection 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
Disposes the AggrAcctEntryBinCollection object and frees the server resources that are associated with it.
Usage
void dispose();
Description
Once executed, the AggrAcctEntryBinCollection 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
AggrAcctEntryBinCollection
Since
Data Collection Base Framework, Release 1.0
Cisco VPN Solutions Center, Release 1.0
Gets the AggrAcctEntryBinCollection element at the specified index.
Usage
AggrAcctEntryBin elementAtIndex(in long index)
raises(InvalidIndexException, InvalidatedException);
Parameters
index—in long value that specifies the index of the element to get.
Returns
AggrAcctEntryBin that represents the specified AggrAcctEntryBinCollection 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
Gets a specified number of AggrAcctEntryBinCollection elements at the specified index.
Usage
AggrAcctEntryBinSeq 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 AggrAcctEntryBinCollection elements to get.
Returns
AggrAcctEntryBinSeq that represent the specified AggrAcctEntryBinCollection elements.
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
If the end of the collection is reached before the specified numberOfElements is returned, AggrAcctEntryBinCollection 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
Gets the index value of the current AggrAcctEntryBinCollection element.
Usage
long getIndex(); raises(InvalidatedException);
Returns
long—Index of the element at the current position in the AggrAcctEntryBinCollection collection.
Raises
DCBFWCollection::InvalidatedException if this collectionis invalidated by the server.
Description
The AggrAcctEntryBinCollection 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
Gets the next AggrAcctEntryBinCollection element.
Usage
AggrAcctEntryBin nextElement(); raises(EndOfCollectionException, InvalidatedException);
Returns
AggrAcctEntryBin that represents the next AggrAcctEntryBinCollection 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
Gets the next few AggrAcctEntryBinCollection elements.
Usage
AggrAcctEntryBinSeq nextElements(in long numberOfElements)
raises(EndOfCollectionException, InvalidatedException);
Parameters
numberOfElements—in long that indicates the number of elements to get.
Returns
AggrAcctEntryBinSeq that represent the next few AggrAcctEntryBinCollection elements as specified by the numberOfElements input value.
Raises
DCBFWCollection::EndOfCollectionException if the end ofthe collection is reached without returning any items. DCBFWCollection::InvalidatedException if this collectionis invalidated by the server.
Description
If the end of the collection is reached before the specified numberOfElements is returned, AggrAcctEntryBinCollection 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.
See Also
setIndex, getIndex, nextElement, elementAtIndex, elementsAtIndex, size
Since
Data Collection Base Framework, Release 1.0
Cisco VPN Solutions Center, Release 1.0
Sets the index value of the current AggrAcctEntryBinCollection element.
Usage
void setIndex(in long index)
raises(InvalidatedException, InvalidIndexException);
Parameters
index—in long that represents the index to value assign to the current AggrAcctEntryBinCollection 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
The AggrAcctEntryBinCollection 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
An instance of the AggrAcctEntryCollection interface provides a means by which to interact with a collection of AggrAcctEntry types.
Description
The AggrAcctEntry types in the collection are managed as an AggrAcctEntrySeq type or a list of AggrAcctEntry types. Using the operations that are supplied in this interface, you can programmatically retrieve objects from the collection in either sequential or random order.
See Also
AggrAcctEntry, AggrAcctEntrySeq, AggrAcctEntryCollection::dispose, AcctEntryCollection, AcctTargetCollection, AggrAcctEntryBinCollection, AggrAcctEntryCollection, AggrDetailAcctEntryBinCollection, AggrDetailAcctEntryCollection, AggrSummaryStatBinCollection, AggrSummaryStatCollection, AllAggrSummaryStatBinCollection, DetailAcctEntryCollection, SummaryStatCollection, DCBFWCollection::StringCollection, DCBFWCollection::KeyedObjectCollection
Since
Cisco VPN Solutions Center, Release 1.0
readonly attribute long size
A readonly attribute that represents the number of elements in the AggrAcctEntryCollection 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
Disposes the AggrAcctEntryCollection object and frees the server resources that are associated with it.
Usage
void dispose();
Description
Once executed, the AggrAcctEntryCollection 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
AggrAcctEntryCollection
Since
Data Collection Base Framework, Release 1.0
Cisco VPN Solutions Center, Release 1.0
Gets the AggrAcctEntryCollection element at the specified index.
Usage
AggrAcctEntry elementAtIndex(in long index)
raises(InvalidIndexException, InvalidatedException);
Parameters
index—in long value that specifies the index of the element to get.
Returns
AggrAcctEntry that represents the specified AggrAcctEntryCollection 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
Gets a specified number of AggrAcctEntryCollection elements at the specified index.
Usage
AggrAcctEntrySeq 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 AggrAcctEntryCollection elements to get.
Returns
AggrAcctEntrySeq that represent the specified AggrAcctEntryCollection elements.
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
If the end of the collection is reached before the specified numberOfElements is returned, AggrAcctEntryCollection 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
Gets the index value of the current AggrAcctEntryCollection element.
Usage
long getIndex(); raises(InvalidatedException);
Returns
long—Index of the element at the current position in the AggrAcctEntryCollection collection.
Raises
DCBFWCollection::InvalidatedException if this collectionis invalidated by the server.
Description
The AggrAcctEntryCollection 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
Gets the next AggrAcctEntryCollection element.
Usage
AggrAcctEntry nextElement(); raises(EndOfCollectionException, InvalidatedException);
Returns
AggrAcctEntry that represents the next AggrAcctEntryCollection 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
Gets the next few AggrAcctEntryCollection elements.
Usage
AggrAcctEntrySeq nextElements(in long numberOfElements)
raises(EndOfCollectionException, InvalidatedException);
Parameters
numberOfElements—in long that indicates the number of elements to get.
Returns
AggrAcctEntrySeq that represent the next few AggrAcctEntryCollection elements as specified by the numberOfElements input value.
Raises
DCBFWCollection::EndOfCollectionException if the end ofthe collection is reached without returning any items. DCBFWCollection::InvalidatedException if this collectionis invalidated by the server.
Description
If the end of the collection is reached before the specified numberOfElements is returned, AggrAcctEntryCollection 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.
See Also
setIndex, getIndex, nextElement, elementAtIndex, elementsAtIndex, size
Since
Data Collection Base Framework, Release 1.0
Cisco VPN Solutions Center, Release 1.0
Sets the index value of the current AggrAcctEntryCollection element.
Usage
void setIndex(in long index)
raises(InvalidatedException, InvalidIndexException);
Parameters
index—in long that represents the index to value assign to the current AggrAcctEntryCollection 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
The AggrAcctEntryCollection 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
An instance of the AggrDetailAcctEntryBinCollection interface provides a means by which to interact with a collection of AggrDetailAcctEntryBin types.
Description
The AggrDetailAcctEntryBin types in the collection are managed as an AggrDetailAcctEntryBinSeq type or a list of AggrDetailAcctEntryBin types. Using the operations that are supplied in this interface, you can programmatically retrieve objects from the collection in either sequential or random order.
See Also
AggrDetailAcctEntryBin, AggrDetailAcctEntryBinSeq, AggrDetailAcctEntryBinCollection::dispose, AcctEntryCollection, AcctTargetCollection, AggrAcctEntryBinCollection, AggrAcctEntryCollection, AggrDetailAcctEntryBinCollection, AggrDetailAcctEntryCollection, AggrSummaryStatBinCollection, AggrSummaryStatCollection, AllAggrSummaryStatBinCollection, DetailAcctEntryCollection, SummaryStatCollection, DCBFWCollection::StringCollection, DCBFWCollection::KeyedObjectCollection
Since
Cisco VPN Solutions Center, Release 1.0
readonly attribute long size
A readonly attribute that represents the number of elements in the AggrDetailAcctEntryBinCollection 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
Disposes the AggrDetailAcctEntryBinCollection object and frees the server resources that are associated with it.
Usage
void dispose();
Description
Once executed, the AggrDetailAcctEntryBinCollection 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
AggrDetailAcctEntryBinCollection
Since
Data Collection Base Framework, Release 1.0
Cisco VPN Solutions Center, Release 1.0
Gets the AggrDetailAcctEntryBinCollection element at the specified index.
Usage
AggrDetailAcctEntryBin elementAtIndex(in long index)
raises(InvalidIndexException, InvalidatedException);
Parameters
index—in long value that specifies the index of the element to get.
Returns
AggrDetailAcctEntryBin that represents the specified AggrDetailAcctEntryBinCollection 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
Gets a specified number of AggrDetailAcctEntryBinCollection elements at the specified index.
Usage
AggrDetailAcctEntryBinSeq 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 AggrDetailAcctEntryBinCollection elements to get.
Returns
AggrDetailAcctEntryBinSeq that represent the specified AggrDetailAcctEntryBinCollection elements.
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
If the end of the collection is reached before the specified numberOfElements is returned, AggrDetailAcctEntryBinCollection 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
Gets the index value of the current AggrDetailAcctEntryBinCollection element.
Usage
long getIndex(); raises(InvalidatedException);
Returns
long—Index of the element at the current position in the AggrDetailAcctEntryBinCollection collection.
Raises
DCBFWCollection::InvalidatedException if this collectionis invalidated by the server.
Description
The AggrDetailAcctEntryBinCollection 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
Gets the next AggrDetailAcctEntryBinCollection element.
Usage
AggrDetailAcctEntryBin nextElement(); raises(EndOfCollectionException, InvalidatedException);
Returns
AggrDetailAcctEntryBin that represents the next AggrDetailAcctEntryBinCollection 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
Gets the next few AggrDetailAcctEntryBinCollection elements.
Usage
AggrDetailAcctEntryBinSeq nextElements(in long numberOfElements)
raises(EndOfCollectionException, InvalidatedException);
Parameters
numberOfElements—in long that indicates the number of elements to get.
Returns
AggrDetailAcctEntryBinSeq that represent the next few AggrDetailAcctEntryBinCollection elements as specified by the numberOfElements input value.
Raises
DCBFWCollection::EndOfCollectionException if the end ofthe collection is reached without returning any items. DCBFWCollection::InvalidatedException if this collectionis invalidated by the server.
Description
If the end of the collection is reached before the specified numberOfElements is returned, AggrDetailAcctEntryBinCollection 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.
See Also
setIndex, getIndex, nextElement, elementAtIndex, elementsAtIndex, size
Since
Data Collection Base Framework, Release 1.0
Cisco VPN Solutions Center, Release 1.0
Sets the index value of the current AggrDetailAcctEntryBinCollection element.
Usage
void setIndex(in long index)
raises(InvalidatedException, InvalidIndexException);
Parameters
index—in long that represents the index to value assign to the current AggrDetailAcctEntryBinCollection 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
The AggrDetailAcctEntryBinCollection 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
An instance of the AggrDetailAcctEntryCollection interface provides a means by which to interact with a collection of AggrDetailAcctEntry types.
Description
The AggrDetailAcctEntry types in the collection are managed as an AggrDetailAcctEntrySeq type or a list of AggrDetailAcctEntry types. Using the operations that are supplied in this interface, you can programmatically retrieve objects from the collection in either sequential or random order.
See Also
AggrDetailAcctEntry, AggrDetailAcctEntrySeq, AggrDetailAcctEntryCollection::dispose, AcctEntryCollection, AcctTargetCollection, AggrAcctEntryBinCollection, AggrAcctEntryCollection, AggrDetailAcctEntryBinCollection, AggrDetailAcctEntryCollection, AggrSummaryStatBinCollection, AggrSummaryStatCollection, AllAggrSummaryStatBinCollection, DetailAcctEntryCollection, SummaryStatCollection, DCBFWCollection::StringCollection, DCBFWCollection::KeyedObjectCollection
Since
Cisco VPN Solutions Center, Release 1.0
readonly attribute long size
A readonly attribute that represents the number of elements in the AggrDetailAcctEntryCollection 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
Disposes the AggrDetailAcctEntryCollection object and frees the server resources that are associated with it.
Usage
void dispose();
Description
Once executed, the AggrDetailAcctEntryCollection 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
AggrDetailAcctEntryCollection
Since
Data Collection Base Framework, Release 1.0
Cisco VPN Solutions Center, Release 1.0
Gets the AggrDetailAcctEntryCollection element at the specified index.
Usage
AggrDetailAcctEntry elementAtIndex(in long index)
raises(InvalidIndexException, InvalidatedException);
Parameters
index—in long value that specifies the index of the element to get.
Returns
AggrDetailAcctEntry that represents the specified AggrDetailAcctEntryCollection 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
Gets a specified number of AggrDetailAcctEntryCollection elements at the specified index.
Usage
AggrDetailAcctEntrySeq 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 AggrDetailAcctEntryCollection elements to get.
Returns
AggrDetailAcctEntrySeq that represent the specified AggrDetailAcctEntryCollection elements.
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
If the end of the collection is reached before the specified numberOfElements is returned, AggrDetailAcctEntryCollection 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
Gets the index value of the current AggrDetailAcctEntryCollection element.
Usage
long getIndex(); raises(InvalidatedException);
Returns
long—Index of the element at the current position in the AggrDetailAcctEntryCollection collection.
Raises
DCBFWCollection::InvalidatedException if this collectionis invalidated by the server.
Description
The AggrDetailAcctEntryCollection 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
Gets the next AggrDetailAcctEntryCollection element.
Usage
AggrDetailAcctEntry nextElement(); raises(EndOfCollectionException, InvalidatedException);
Returns
AggrDetailAcctEntry that represents the next AggrDetailAcctEntryCollection 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
Gets the next few AggrDetailAcctEntryCollection elements.
Usage
AggrDetailAcctEntrySeq nextElements(in long numberOfElements)
raises(EndOfCollectionException, InvalidatedException);
Parameters
numberOfElements—in long that indicates the number of elements to get.
Returns
AggrDetailAcctEntrySeq that represent the next few AggrDetailAcctEntryCollection elements as specified by the numberOfElements input value.
Raises
DCBFWCollection::EndOfCollectionException if the end ofthe collection is reached without returning any items. DCBFWCollection::InvalidatedException if this collectionis invalidated by the server.
Description
If the end of the collection is reached before the specified numberOfElements is returned, AggrDetailAcctEntryCollection 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.
See Also
setIndex, getIndex, nextElement, elementAtIndex, elementsAtIndex, size
Since
Data Collection Base Framework, Release 1.0
Cisco VPN Solutions Center, Release 1.0
Sets the index value of the current AggrDetailAcctEntryCollection element.
Usage
void setIndex(in long index)
raises(InvalidatedException, InvalidIndexException);
Parameters
index—in long that represents the index to value assign to the current AggrDetailAcctEntryCollection 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
The AggrDetailAcctEntryCollection 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
An instance of the AggrSummaryStatBinCollection interface provides a means by which to interact with a collection of AggrSummaryStatBin types.
Description
The AggrSummaryStatBin types in the collection are managed as an AggrSummaryStatBinSeq type or a list of AggrSummaryStatBin types. Using the operations that are supplied in this interface, you can programmatically retrieve objects from the collection in either sequential or random order.
See Also
AggrSummaryStatBin, AggrSummaryStatBinSeq, AggrSummaryStatBinCollection::dispose, AcctEntryCollection, AcctTargetCollection, AggrAcctEntryBinCollection, AggrAcctEntryCollection, AggrDetailAcctEntryBinCollection, AggrDetailAcctEntryCollection, AggrSummaryStatBinCollection, AggrSummaryStatCollection, AllAggrSummaryStatBinCollection, DetailAcctEntryCollection, SummaryStatCollection, DCBFWCollection::StringCollection, DCBFWCollection::KeyedObjectCollection
Since
Cisco VPN Solutions Center, Release 1.0
readonly attribute long size
A readonly attribute that represents the number of elements in the AggrSummaryStatBinCollection 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
Disposes the AggrSummaryStatBinCollection object and frees the server resources that are associated with it.
Usage
void dispose();
Description
Once executed, the AggrSummaryStatBinCollection 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
AggrSummaryStatBinCollection
Since
Data Collection Base Framework, Release 1.0
Cisco VPN Solutions Center, Release 1.0
Gets the AggrSummaryStatBinCollection element at the specified index.
Usage
AggrSummaryStatBin elementAtIndex(in long index)
raises(InvalidIndexException, InvalidatedException);
Parameters
index—in long value that specifies the index of the element to get.
Returns
AggrSummaryStatBin that represents the specified AggrSummaryStatBinCollection 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
Gets a specified number of AggrSummaryStatBinCollection elements at the specified index.
Usage
AggrSummaryStatBinSeq 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 AggrSummaryStatBinCollection elements to get.
Returns
AggrSummaryStatBinSeq that represent the specified AggrSummaryStatBinCollection elements.
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
If the end of the collection is reached before the specified numberOfElements is returned, AggrSummaryStatBinCollection 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
Gets the index value of the current AggrSummaryStatBinCollection element.
Usage
long getIndex(); raises(InvalidatedException);
Returns
long—Index of the element at the current position in the AggrSummaryStatBinCollection collection.
Raises
DCBFWCollection::InvalidatedException if this collectionis invalidated by the server.
Description
The AggrSummaryStatBinCollection 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
Gets the next AggrSummaryStatBinCollection element.
Usage
AggrSummaryStatBin nextElement(); raises(EndOfCollectionException, InvalidatedException);
Returns
AggrSummaryStatBin that represents the next AggrSummaryStatBinCollection 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
Gets the next few AggrSummaryStatBinCollection elements.
Usage
AggrSummaryStatBinSeq nextElements(in long numberOfElements)
raises(EndOfCollectionException, InvalidatedException);
Parameters
numberOfElements—in long that indicates the number of elements to get.
Returns
AggrSummaryStatBinSeq that represent the next few AggrSummaryStatBinCollection elements as specified by the numberOfElements input value.
Raises
DCBFWCollection::EndOfCollectionException if the end ofthe collection is reached without returning any items. DCBFWCollection::InvalidatedException if this collectionis invalidated by the server.
Description
If the end of the collection is reached before the specified numberOfElements is returned, AggrSummaryStatBinCollection 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.
See Also
setIndex, getIndex, nextElement, elementAtIndex, elementsAtIndex, size
Since
Data Collection Base Framework, Release 1.0
Cisco VPN Solutions Center, Release 1.0
Sets the index value of the current AggrSummaryStatBinCollection element.
Usage
void setIndex(in long index)
raises(InvalidatedException, InvalidIndexException);
Parameters
index—in long that represents the index to value assign to the current AggrSummaryStatBinCollection 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
The AggrSummaryStatBinCollection 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
An instance of the AggrSummaryStatCollection interface provides a means by which to interact with a collection of AggrSummaryStat types.
Description
The AggrSummaryStat types in the collection are managed as an AggrSummaryStatSeq type or a list of AggrSummaryStat types. Using the operations that are supplied in this interface, you can programmatically retrieve objects from the collection in either sequential or random order.
See Also
AggrSummaryStat, AggrSummaryStatSeq, AggrSummaryStatCollection::dispose, AcctEntryCollection, AcctTargetCollection, AggrAcctEntryBinCollection, AggrAcctEntryCollection, AggrDetailAcctEntryBinCollection, AggrDetailAcctEntryCollection, AggrSummaryStatBinCollection, AggrSummaryStatCollection, AllAggrSummaryStatBinCollection, DetailAcctEntryCollection, SummaryStatCollection, DCBFWCollection::StringCollection, DCBFWCollection::KeyedObjectCollection
Since
Cisco VPN Solutions Center, Release 1.0
readonly attribute long size
A readonly attribute that represents the number of elements in the AggrSummaryStatCollection 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
Disposes the AggrSummaryStatCollection object and frees the server resources that are associated with it.
Usage
void dispose();
Description
Once executed, the AggrSummaryStatCollection 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
AggrSummaryStatCollection
Since
Data Collection Base Framework, Release 1.0
Cisco VPN Solutions Center, Release 1.0
Gets the AggrSummaryStatCollection element at the specified index.
Usage
AggrSummaryStat elementAtIndex(in long index)
raises(InvalidIndexException, InvalidatedException);
Parameters
index—in long value that specifies the index of the element to get.
Returns
AggrSummaryStat that represents the specified AggrSummaryStatCollection 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
Gets a specified number of AggrSummaryStatCollection elements at the specified index.
Usage
AggrSummaryStatSeq 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 AggrSummaryStatCollection elements to get.
Returns
AggrSummaryStatSeq that represent the specified AggrSummaryStatCollection elements.
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
If the end of the collection is reached before the specified numberOfElements is returned, AggrSummaryStatCollection 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
Gets the index value of the current AggrSummaryStatCollection element.
Usage
long getIndex(); raises(InvalidatedException);
Returns
long—Index of the element at the current position in the AggrSummaryStatCollection collection.
Raises
DCBFWCollection::InvalidatedException if this collectionis invalidated by the server.
Description
The AggrSummaryStatCollection 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
Gets the next AggrSummaryStatCollection element.
Usage
AggrSummaryStat nextElement(); raises(EndOfCollectionException, InvalidatedException);
Returns
AggrSummaryStat that represents the next AggrSummaryStatCollection 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
Gets the next few AggrSummaryStatCollection elements.
Usage
AggrSummaryStatSeq nextElements(in long numberOfElements)
raises(EndOfCollectionException, InvalidatedException);
Parameters
numberOfElements—in long that indicates the number of elements to get.
Returns
AggrSummaryStatSeq that represent the next few AggrSummaryStatCollection elements as specified by the numberOfElements input value.
Raises
DCBFWCollection::EndOfCollectionException if the end ofthe collection is reached without returning any items. DCBFWCollection::InvalidatedException if this collectionis invalidated by the server.
Description
If the end of the collection is reached before the specified numberOfElements is returned, AggrSummaryStatCollection 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.
See Also
setIndex, getIndex, nextElement, elementAtIndex, elementsAtIndex, size
Since
Data Collection Base Framework, Release 1.0
Cisco VPN Solutions Center, Release 1.0
Sets the index value of the current AggrSummaryStatCollection element.
Usage
void setIndex(in long index)
raises(InvalidatedException, InvalidIndexException);
Parameters
index—in long that represents the index to value assign to the current AggrSummaryStatCollection 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
The AggrSummaryStatCollection 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
An instance of the AllAggrSummaryStatBinCollection interface provides a means by which to interact with a collection of AllAggrSummaryStatBin types.
Description
The AllAggrSummaryStatBin types in the collection are managed as an AllAggrSummaryStatBinSeq type or a list of AllAggrSummaryStatBin types. Using the operations that are supplied in this interface, you can programmatically retrieve objects from the collection in either sequential or random order.
See Also
AllAggrSummaryStatBin, AllAggrSummaryStatBinSeq, AllAggrSummaryStatBinCollection::dispose, AcctEntryCollection, AcctTargetCollection, AggrAcctEntryBinCollection, AggrAcctEntryCollection, AggrDetailAcctEntryBinCollection, AggrDetailAcctEntryCollection, AggrSummaryStatBinCollection, AggrSummaryStatCollection, AllAggrSummaryStatBinCollection, DetailAcctEntryCollection, SummaryStatCollection, DCBFWCollection::StringCollection, DCBFWCollection::KeyedObjectCollection
Since
Cisco VPN Solutions Center, Release 1.0
readonly attribute long size
A readonly attribute that represents the number of elements in the AllAggrSummaryStatBinCollection 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
Disposes the AllAggrSummaryStatBinCollection object and frees the server resources that are associated with it.
Usage
void dispose();
Description
Once executed, the AllAggrSummaryStatBinCollection 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
AllAggrSummaryStatBinCollection
Since
Data Collection Base Framework, Release 1.0
Cisco VPN Solutions Center, Release 1.0
Gets the AllAggrSummaryStatBinCollection element at the specified index.
Usage
AllAggrSummaryStatBin elementAtIndex(in long index)
raises(InvalidIndexException, InvalidatedException);
Parameters
index—in long value that specifies the index of the element to get.
Returns
AllAggrSummaryStatBin that represents the specified AllAggrSummaryStatBinCollection 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
Gets a specified number of AllAggrSummaryStatBinCollection elements at the specified index.
Usage
AllAggrSummaryStatBinSeq 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 AllAggrSummaryStatBinCollection elements to get.
Returns
AllAggrSummaryStatBinSeq that represent the specified AllAggrSummaryStatBinCollection elements.
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
If the end of the collection is reached before the specified numberOfElements is returned, AllAggrSummaryStatBinCollection 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
Gets the index value of the current AllAggrSummaryStatBinCollection element.
Usage
long getIndex(); raises(InvalidatedException);
Returns
long—Index of the element at the current position in the AllAggrSummaryStatBinCollection collection.
Raises
DCBFWCollection::InvalidatedException if this collectionis invalidated by the server.
Description
The AllAggrSummaryStatBinCollection 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
Gets the next AllAggrSummaryStatBinCollection element.
Usage
AllAggrSummaryStatBin nextElement(); raises(EndOfCollectionException, InvalidatedException);
Returns
AllAggrSummaryStatBin that represents the next AllAggrSummaryStatBinCollection 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
Gets the next few AllAggrSummaryStatBinCollection elements.
Usage
AllAggrSummaryStatBinSeq nextElements(in long numberOfElements)
raises(EndOfCollectionException, InvalidatedException);
Parameters
numberOfElements—in long that indicates the number of elements to get.
Returns
AllAggrSummaryStatBinSeq that represent the next few AllAggrSummaryStatBinCollection elements as specified by the numberOfElements input value.
Raises
DCBFWCollection::EndOfCollectionException if the end ofthe collection is reached without returning any items. DCBFWCollection::InvalidatedException if this collectionis invalidated by the server.
Description
If the end of the collection is reached before the specified numberOfElements is returned, AllAggrSummaryStatBinCollection 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.
See Also
setIndex, getIndex, nextElement, elementAtIndex, elementsAtIndex, size
Since
Data Collection Base Framework, Release 1.0
Cisco VPN Solutions Center, Release 1.0
Sets the index value of the current AllAggrSummaryStatBinCollection element.
Usage
void setIndex(in long index)
raises(InvalidatedException, InvalidIndexException);
Parameters
index—in long that represents the index to value assign to the current AllAggrSummaryStatBinCollection 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
The AllAggrSummaryStatBinCollection 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
An instance of the DetailAcctEntryCollection interface provides a means by which to interact with a collection of DetailAcctEntry types.
Description
The DetailAcctEntry types in the collection are managed as an DetailAcctEntrySeq type or a list of DetailAcctEntry types. Using the operations that are supplied in this interface, you can programmatically retrieve objects from the collection in either sequential or random order.
See Also
DetailAcctEntry, DetailAcctEntrySeq, DetailAcctEntryCollection::dispose, AcctEntryCollection, AcctTargetCollection, AggrAcctEntryBinCollection, AggrAcctEntryCollection, AggrDetailAcctEntryBinCollection, AggrDetailAcctEntryCollection, AggrSummaryStatBinCollection, AggrSummaryStatCollection, AllAggrSummaryStatBinCollection, DetailAcctEntryCollection, SummaryStatCollection, DCBFWCollection::StringCollection, DCBFWCollection::KeyedObjectCollection
Since
Cisco VPN Solutions Center, Release 1.0
readonly attribute long size
A readonly attribute that represents the number of elements in the DetailAcctEntryCollection 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
Disposes the DetailAcctEntryCollection object and frees the server resources that are associated with it.
Usage
void dispose();
Description
Once executed, the DetailAcctEntryCollection 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
DetailAcctEntryCollection
Since
Data Collection Base Framework, Release 1.0
Cisco VPN Solutions Center, Release 1.0
Gets the DetailAcctEntryCollection element at the specified index.
Usage
DetailAcctEntry elementAtIndex(in long index)
raises(InvalidIndexException, InvalidatedException);
Parameters
index—in long value that specifies the index of the element to get.
Returns
DetailAcctEntry that represents the specified DetailAcctEntryCollection 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
Gets a specified number of DetailAcctEntryCollection elements at the specified index.
Usage
DetailAcctEntrySeq 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 DetailAcctEntryCollection elements to get.
Returns
DetailAcctEntrySeq that represent the specified DetailAcctEntryCollection elements.
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
If the end of the collection is reached before the specified numberOfElements is returned, DetailAcctEntryCollection 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
Gets the index value of the current DetailAcctEntryCollection element.
Usage
long getIndex(); raises(InvalidatedException);
Returns
long—Index of the element at the current position in the DetailAcctEntryCollection collection.
Raises
DCBFWCollection::InvalidatedException if this collectionis invalidated by the server.
Description
The DetailAcctEntryCollection 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
Gets the next DetailAcctEntryCollection element.
Usage
DetailAcctEntry nextElement(); raises(EndOfCollectionException, InvalidatedException);
Returns
DetailAcctEntry that represents the next DetailAcctEntryCollection 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
Gets the next few DetailAcctEntryCollection elements.
Usage
DetailAcctEntrySeq nextElements(in long numberOfElements)
raises(EndOfCollectionException, InvalidatedException);
Parameters
numberOfElements—in long that indicates the number of elements to get.
Returns
DetailAcctEntrySeq that represent the next few DetailAcctEntryCollection elements as specified by the numberOfElements input value.
Raises
DCBFWCollection::EndOfCollectionException if the end ofthe collection is reached without returning any items. DCBFWCollection::InvalidatedException if this collectionis invalidated by the server.
Description
If the end of the collection is reached before the specified numberOfElements is returned, DetailAcctEntryCollection 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.
See Also
setIndex, getIndex, nextElement, elementAtIndex, elementsAtIndex, size
Since
Data Collection Base Framework, Release 1.0
Cisco VPN Solutions Center, Release 1.0
Sets the index value of the current DetailAcctEntryCollection element.
Usage
void setIndex(in long index)
raises(InvalidatedException, InvalidIndexException);
Parameters
index—in long that represents the index to value assign to the current DetailAcctEntryCollection 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
The DetailAcctEntryCollection 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
An instance of the SummaryStatCollection interface provides a means by which to interact with a collection of SummaryStat types.
Description
The SummaryStat types in the collection are managed as an SummaryStatSeq type or a list of SummaryStat types. Using the operations that are supplied in this interface, you can programmatically retrieve objects from the collection in either sequential or random order.
See Also
SummaryStat, SummaryStatSeq, SummaryStatCollection::dispose, AcctEntryCollection, AcctTargetCollection, AggrAcctEntryBinCollection, AggrAcctEntryCollection, AggrDetailAcctEntryBinCollection, AggrDetailAcctEntryCollection, AggrSummaryStatBinCollection, AggrSummaryStatCollection, AllAggrSummaryStatBinCollection, DetailAcctEntryCollection, SummaryStatCollection, DCBFWCollection::StringCollection, DCBFWCollection::KeyedObjectCollection
Since
Cisco VPN Solutions Center, Release 1.0
readonly attribute long size
A readonly attribute that represents the number of elements in the SummaryStatCollection 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
Disposes the SummaryStatCollection object and frees the server resources that are associated with it.
Usage
void dispose();
Description
Once executed, the SummaryStatCollection 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
SummaryStatCollection
Since
Data Collection Base Framework, Release 1.0
Cisco VPN Solutions Center, Release 1.0
Gets the SummaryStatCollection element at the specified index.
Usage
SummaryStat elementAtIndex(in long index)
raises(InvalidIndexException, InvalidatedException);
Parameters
index—in long value that specifies the index of the element to get.
Returns
SummaryStat that represents the specified SummaryStatCollection 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
Gets a specified number of SummaryStatCollection elements at the specified index.
Usage
SummaryStatSeq 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 SummaryStatCollection elements to get.
Returns
SummaryStatSeq that represent the specified SummaryStatCollection elements.
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
If the end of the collection is reached before the specified numberOfElements is returned, SummaryStatCollection 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
Gets the index value of the current SummaryStatCollection element.
Usage
long getIndex(); raises(InvalidatedException);
Returns
long—Index of the element at the current position in the SummaryStatCollection collection.
Raises
DCBFWCollection::InvalidatedException if this collectionis invalidated by the server.
Description
The SummaryStatCollection 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
Gets the next SummaryStatCollection element.
Usage
SummaryStat nextElement(); raises(EndOfCollectionException, InvalidatedException);
Returns
SummaryStat that represents the next SummaryStatCollection 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
Gets the next few SummaryStatCollection elements.
Usage
SummaryStatSeq nextElements(in long numberOfElements)
raises(EndOfCollectionException, InvalidatedException);
Parameters
numberOfElements—in long that indicates the number of elements to get.
Returns
SummaryStatSeq that represent the next few SummaryStatCollection elements as specified by the numberOfElements input value.
Raises
DCBFWCollection::EndOfCollectionException if the end ofthe collection is reached without returning any items. DCBFWCollection::InvalidatedException if this collectionis invalidated by the server.
Description
If the end of the collection is reached before the specified numberOfElements is returned, SummaryStatCollection 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.
See Also
setIndex, getIndex, nextElement, elementAtIndex, elementsAtIndex, size
Since
Data Collection Base Framework, Release 1.0
Cisco VPN Solutions Center, Release 1.0
Sets the index value of the current SummaryStatCollection element.
Usage
void setIndex(in long index)
raises(InvalidatedException, InvalidIndexException);
Parameters
index—in long that represents the index to value assign to the current SummaryStatCollection 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
The SummaryStatCollection 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
Posted: Tue Sep 26 16:47:32 PDT 2000
Copyright 1989-2000©Cisco Systems Inc.