Web Services API Guide, Cisco DCNM for LAN, Release 5.x
CollectorExtendedApp Service
Downloads: This chapterpdf (PDF - 85.0KB) The complete bookPDF (PDF - 11.08MB) | Feedback

CollectorExtendedApp Service

Table Of Contents

CollectorExtendedApp Service

Information About CollectorExtendedApp Service

getCollectedStatisticalData

getCollectedStatisticalDataByDaysMaxLimit

getCollectedStatisticalDataByMaxLimit

getCollectedStatisticalDataByTimeRange

getCollectedStatisticalDataByTimeRangeInterval

getCollectedStatisticalDataByTimeRangeMaxLimit

getCollectedStatisticalDataSizeByTimeRangeInterval

getPreviousCollectedData


CollectorExtendedApp Service


This chapter describes the DCNM web services' API methods for the CollectorExtendedApp service.

Information About CollectorExtendedApp Service

The collector allows you to address performance management of network resources. By analyzing statistical data with the collector, you can perform real-time monitoring of data that includes the traffic throughput, the percentage utilization, error rates, and the response time. As a result, you can efficiently use the network resources and have an in-depth knowledge of the network health.

The collector can read statistical information from the devices and store it in the database. You can use the collector APIs to retrieve the information stored in the database. In addition, you can use the extended collector API to trend statistical data over a period of time.

getCollectedStatisticalData

Returns all the collected statistical data of an existing collection info.

ValidationException is thrown if any of the following situation occurs:

If collectionInfoId is null.

If collectionInfoId is not a valid collection info InstanceNameId.

Parameters

opContext—Operational context

collectionInfoId—instance id of the CollectionInfo

Return Value

Return a collection of CollectedData which is all the statistical data that is polled for the specified collectionInfoId.

getCollectedStatisticalDataByDaysMaxLimit

Returns List of collected statistical data of an existing collection info during a time period specified by days. Filter the result by given max limits.

ValidationException is thrown if any of the following situation occurs:

If collectionInfoId is null.

If collectionInfoId is not a valid collection info InstanceNameId.

Parameters

opContext—Operational context

collectionInfoId—instance id of the CollectionInfo

Integer—Specifies the no of days to get collected statistical data.

maxLimits—Specifies the max points to be returned

Return Value

Return List of the collection of CollectedData which is all the statistical data that is polled for the specified collectionInfoId during the current date from the given no of days within the max points.

getCollectedStatisticalDataByMaxLimit

Returns List of collected statistical data of an existing collection info and filter the result for the max limits.

ValidationException is thrown if any of the following situation occurs:

If collectionInfoId is null.

If collectionInfoId is not a valid collection info InstanceNameId.

Parameters

opContext—Operational context

collectionInfoId—instance id of the CollectionInfo

maxLimits—Specifies the max points to be returned

Return Value

Return List of the collection of CollectedData which is all the statistical data that is polled for the specified collectionInfoId within the max points.

getCollectedStatisticalDataByTimeRange

Returns all the collected statistical data of an existing collection info during a time period specified by the start time and end time.

ValidationException is thrown if any of the following situation occurs:

If collectionInfoId is null.

If collectionInfoId is not a valid collection info InstanceNameId.

Parameters

opContext—Operational context

collectionInfoId—instance id of the CollectionInfo

startTime—Specifies the start of the time range to get collected statistical data.

endTime—Specifies the end of the time range to get collected statistical data.

Return Value

Return a collection of CollectedData which is all the statistical data that is polled for the specified collectionInfoId during the specified time range.

getCollectedStatisticalDataByTimeRangeInterval

Returns all the collected statistical data of an existing collection info during a time period specified by the start time and end time. Filter the result by given interval.

ValidationException is thrown if any of the following situation occurs:

If collectionInfoId is null.

If collectionInfoId is not a valid collection info InstanceNameId.

Parameters

opContext—Operational context

collectionInfoId—instance id of the CollectionInfo

startTime—Specifies the start of the time range to get collected statistical data.

endTime—Specifies the end of the time range to get collected statistical data.

intervalInSeconds—Specifies the interval needs to be filtered

Return Value

Return a collection of CollectedData which is all the statistical data that is polled for the specified collectionInfoId during the specified time range and the interval.

getCollectedStatisticalDataByTimeRangeMaxLimit

Returns all the collected statistical data of an existing collection info during a time period specified by the start time and end time. Filter the result by given max limits.

ValidationException is thrown if any of the following situation occurs:

If collectionInfoId is null.

If collectionInfoId is not a valid collection info InstanceNameId.

Parameters

opContext—Operational context

collectionInfoId—instance id of the CollectionInfo

startTime—Specifies the start of the time range to get collected statistical data.

endTime—Specifies the end of the time range to get collected statistical data.

maxLimits—Specifies the max points to be returned

Return Value

Return List of the collection of CollectedData which is all the statistical data that is polled for the specified collectionInfoId during time period specified by the start time and end time. within the max points.

getCollectedStatisticalDataSizeByTimeRangeInterval

Returns size of the collected statistical data of an existing collection info during a time period specified by the start time and end time. Filter the result by given interval.

ValidationException is thrown if any of the following situation occurs:

If collectionInfoId is null.

If collectionInfoId is not a valid collection info InstanceNameId.

Parameters

opContext—Operational context

collectionInfoId—instance id of the CollectionInfo

startTime—Specifies the start of the time range to get collected statistical data.

endTime—Specifies the end of the time range to get collected statistical data.

intervalInSeconds—Specifies the interval needs to be filtered

Return Value

Return size of the collection of CollectedData which is all the statistical data that is polled for the specified collectionInfoId during the specified time range and the interval.

getPreviousCollectedData

Returns the previous to the last polled statistical data of an existing collection info.

ValidationException is thrown if any of the following situation occurs:

If collectionInfoId is null.

If collectionInfoId is not a valid collection info InstanceNameId.

Parameters

opContext—Operational context

collectionInfoId—instance id of the CollectionInfo

Return Value

Return an instance of CollectedData which is the statistical data that is previous to the last polled data.