-
Web Services API Guide, Cisco DCNM for LAN, Release 5.x
-
Preface
-
Overview
-
AaaApp Service
-
AclApp Service
-
ClusterApp Service
-
CollectorApp Service
-
CollectorExtendedApp Service
-
ConfigArchiveApp Service
-
ConfigDeliveryApp Service
-
ConfigTemplateApp Service
-
DaiApp Service
-
DataPurgingApp Service
-
DeviceGroupApp Service
-
DevicelistApp Service
-
DhcpSnoopApp Service
-
Dot1xApp Service
-
EtherChanApp Service
-
EventApp Service
-
FabricPathResourcesApp Service
-
FabricPathTopologyApp Service
-
FcApp Service
-
FCoEApp Service
-
FeatureSetApp Service
-
FexApp Service
-
FiPSnoopingApp Service
-
FireWallApp
-
GlbpApp Service
-
HsrpApp Service
-
IgmpSnoopingApp Service
-
ImageInstallApp Service
-
InterfacesApp Services
-
InventoryApp Service
-
IpSourceGuardApp Service
-
KeyChainApp Service
-
L2IsisApp Service
-
LicensingApp Service
-
LogApp Service
-
LstApp Service
-
NacLpIpApp Service
-
Object Group
-
PathLatencyApp
-
ObjTrackingApp Service
-
PollerApp Service
-
PortProfileApp
-
PortSecApp Service
-
PreprovisionApp
-
RbacApp Service
-
RepositoryApp Service
-
SecurityApp Service
-
ServerApp Service
-
ServerAdminApp Service
-
SoftwareApp Service
-
SpanApp Service
-
StpApp Service
-
SVSConnectionApp Service
-
SVSDomainApp Service
-
SwitchProfileApp
-
ThresholdAction Service
-
TrafficStormControlApp Service
-
TunnelApp Service
-
UserApp Service
-
VdcApp Service
-
VlanApp Service
-
VpcApp Service
-
VrfApp Service
-
Feedback
Table Of Contents
Information About CollectorApp Service
getAllCollectionInfoByConfigIds
getAllCollectionInfoInDeviceByStatus
getAllStatisticalEntriesForDevice
getLatestCollectedStatisticalData
CollectorApp Service
This chapter describes the DCNM web services' API methods for the CollectorApp service. This API is available for Cisco Nexus 7000 Series switches that run Cisco NX-OS Release 5.0(3) or later.
Information About CollectorApp 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.
To perform a collection of statistical data, follow these steps:
1.
Create a CollectionInfo by specifying a collection information name, a list of statistical data, a schedule (simple or cron style), and a collection action (persist).
2.
To delete an existing collection of statistical data, follow these steps:
1.
2.
addStatisticalEntry
Associates the given statistical entry to an existing collection info. The given statistical entry should not be duplicated within the collection info.
ValidationException is thrown if any of the following situation occurs:
•
•
•
CollectorException is thrown if any of the following situation occurs:
•
•
Parameters
opContext—Operational context
collectionInfoId—instance name id of the CollectionInfo to which the given statisticalentry should be associated
aStatisticalEntry—instance of a StatisticalEntry that needs to be added to CollectionInfo StatisticalEntry
Return Value
InstanceNameId the instance name id of the StatisticalEntry
createCollector
Creates a collection info and returns its instance name id.
The given collection info object should have one or more statistical entries, a schedule and collector action. Collector will start polling as per the schedule given. If there is no start time is specified in the schedule, collector will start polling immediately
ValidationException is thrown if any of the following situation occurs:
•
CollectorException is thrown if any of the following situation occurs:
•
•
•
•
•
In the given statistical entries,
–
–
–
In the given schedule,
–
–
–
Parameters
opContext—Operational context
aCollectionInfo—instance of CollectionInfo
Return Value
InstanceNameId the instance name id of the CollectionInfo
deleteCollectionInfo
Deletes an existing collection info and the collected statistical data for the given collectioninfo.
Stops the collector if it is running for the given collection info.
ValidationException is thrown if any of the following situation occurs:
•
•
IntegrityException is thrown if the given collectionInfo does not exist in devices.
Parameters
opContext—Operational context
collectionInfoId—instance id of a CollectionInfo.
Return Value
void
deleteCollectionInfoCol
Deletes collection info and its statistical data for the given collection info id list. This method is available for Cisco Nexus 7000 Series switches that run Cisco NX-OS Release 5.1(1) or later.
Stops the collector if it is running for the given collection info ID list.
ValidationException is thrown if any of the following situation occurs:
•
•
AppException is thrown if any of the collectionInfo (given in the list) does not exist.
Parameters
opContext—Operational context
collectionInfoId—instance id of a CollectionInfo.
Return Value
void
deleteStatisticalDataCol
Deletes collected statistical data for the given collection info id list. This method is available for Cisco Nexus 7000 Series switches that run Cisco NX-OS Release 5.1(1) or later.
ValidationException is thrown if any of the following situation occurs:
•
•
AppException is thrown if any of the collectionInfo (given in the list) does not exist.
Parameters
opContext—Operational context
collectionInfoId—instance id of a CollectionInfo.
Return Value
void
deleteStatisticalData
Deletes the collected statistical data for the given collectioninfo.
ValidationException is thrown if any of the following situation occurs:
•
•
IntegrityException is thrown if the given collectionInfo does not exist in devices.
Parameters
opContext—Operational context
collectionInfoId—instance id of a CollectionInfo.
Return Value
void
deleteStatisticalDataTillDate
Deletes the collected statistical data for the given collectioninfo.
ValidationException is thrown if any of the following situation occurs:
•
•
IntegrityException is thrown if the given collectionInfo does not exist in devices.
Parameters
opContext—Operational context
collectionInfoId—instance id of a CollectionInfo.
Return Value
void
fetchCollectedData
Returns the last polled statistical data of an existing collection info with some additional information like next polling time.
ValidationException is thrown if any of the following situations occurs:
•
•
Parameters
OpContext—operational Context.
collectionInfoId—the instance ID of the CollectionInfo.
Returns
Return an instance of ExtendedCollectedData which is the statistical data that is polled at the last. This is usefull for realtime monitoring.
getAllCollectionInfo
Returns all existing collection info which matches with given statisticalclassname, configInstanceId and interval. If none of them are specified, returns all the CollectionInfos.
Parameters
opContext—Operational context
statisticalClassName—statistics class name
configInstanceId—InstanceNameId of the configuration instance
interval—polling interval
Return Value
All the CollectionInfo which matches with the given parameters
getAllCollectionInfoByConfigIds
Returns the active collection info which exactly matches with given statisticalclassname, configInstanceIds and interval. If none of them are specified, returns null.
Parameters
opContext—Operational context
statisticalClassName—statistics class name
configInstanceIds—List of InstanceNameId of the configuration instances
interval—polling interval
Return Value
Only one CollectionInfo which matches with the given parameters
getAllCollectionInfoByStatus
Returns all existing collection info with a specific collection status.
ValidationException is thrown if any of the following situation occurs:
•
Parameters
opContext—Operational context
aCollectionStatus—status of the CollectionInfo
Return Value
All existing CollectionInfo having the specified CollectionStatus.
getAllCollectionInfoByUserId
Returns all existing collection info created by a user.
ValidationException is thrown if any of the following situation occurs:
•
Parameters
opContext—Operational context
username—name of the user who created the CollectionInfo.
Return Value
All the CollectionInfo created by the specified username.
getAllCollectionInfoInDevice
Returns all existing collection info bound to a network element.
ValidationException is thrown if any of the following situation occurs:
•
•
Parameters
opContext—Operational context
networkElementId—instance id of the network element.
Return Value
All the CollectionInfo having the specified CollectionStatus.
getAllCollectionInfoInDeviceByStatus
Returns all existing collection info bound to a network element and having a specific collection status.
ValidationException is thrown if any of the following situation occurs:
•
•
•
Parameters
opContext—Operational context
aCollectionStatus—status of the CollectionInfo
deviceId—instance id of the CollectionInfo
Return Value
All the CollectionInfo having the specified CollectionStatus.
getAllStatisticalEntriesForDevice
Returns all the statistical entries bound to a network element.
ValidationException is thrown if any of the following situation occurs:
•
•
Parameters
opContext—Operational context
networkElementId—instance id of the CollectionInfo
Return Value
All the statistical entries that were polled for the specified deviceId.
getCollectedData (Deprecated)
Returns the last polled statistical data of an existing collection info with some additional information like next polling time.
ValidationException is thrown if any of the following situation occurs:
•
•
Parameters
opContext—Operational context
collectionInfoId—instance id of the CollectionInfo
Return Value
Return an instance of ExtendedCollectedData which is the statistical data that is polled at the last. This is useful for real-time monitoring.
getCollectedStatisticalData
Deprecated.
Returns all the collected statistical data of an existing collection info.
ValidationException is thrown if any of the following situation occurs:
•
•
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.
getCollectionInfo
Returns the instance of collection info specified by collection info name id.
ValidationException is thrown if any of the following situation occurs:
•
•
Parameters
opContext—Operational context
collectionInfoId—instance name id of the CollectionInfo
Return Value
CollectionInfo CollectionInfo
getLatestCollectedStatisticalData
Returns the last polled statistical data of an existing collection info.
ValidationException is thrown if any of the following situation occurs:
•
•
Parameters
opContext—Operational context
collectionInfoId—instance id of the CollectionInfo
Return Value
Return an instance of CollectedData which is the statistical data that is polled at the last. This is useful for real-time monitoring.
getValidConfigInstanceId
Returns valid configuration instance name ids for the given configuration instance name ids
Instancename ids will differ by the following cases, 1. Rediscovery 2. Type change ex. port mode change in interfaces 3. Data removed from the device 4. Identity is changed by APIs, ex: ACEs are recreated when ACL is getting updated through APIs. Valid instance name ids are returned by reloading from database for the given old instance name ids. ValidationException is thrown if any of the following situation occurs:
•
•
Parameters
opContext—Operational context
configInstanceIdCol—InstanceNameId of the one or more configuration entities.
Return Value
The returned list will contain valid InstanceNameIds.
modifyCollectorAction
Modifies the collector action of an existing collection info.
ValidationException is thrown if any of the following situation occurs:
•
•
•
Parameters
opContext—Operational context
collectionInfoId—instance id of the CollectionInfo.
Return Value
void
modifySchedule
Modifies the schedule of an existing collection info.
ValidationException is thrown if any of the following situation occurs:
•
•
•
In the given schedule,
–
–
–
Parameters
opContext—Operational context
collectionInfoId—instance id of the CollectionInfo
aSchedule—new job schedule
Return Value
void
removeStatisticalEntry
Removes a StatisticalEntry from an existing collection info.
ValidationException is thrown if any of the following situation occurs:
•
•
•
•
CollectorException is thrown if any of the following situation occurs:
•
•
Parameters
opContext—Operational context
collectionInfoId—instance name id of the CollectionInfo
statisticalEntryId—instance name if of a StatisticalEntry that needs to be added to CollectionInfo StatisticalEntry
Return Value
void
startCollector
Starts polling for an existing collection info with its schedule.
ValidationException is thrown if any of the following situation occurs:
•
•
•
Parameters
collectionInfoId—instance id of the collection info
Return Value
void
startCollectors
Starts polling for an existing collection info with its schedule. This method is available for Cisco Nexus 7000 Series switches that run Cisco NX-OS Release 5.1(1) or later.
AppException is thrown if any of the following situation occurs:
•
•
•
Parameters
collectionInfoId—instance id of the collection info
Return Value
void
startCollectorBySchedule
Starts polling for an existing collection info as per the given schedule.
ValidationException is thrown if any of the following situation occurs:
•
•
•
In the given schedule,
•
•
•
Parameters
collectionInfoId—instance id of the collection info
Return Value
void
stopCollector
Stops polling for an existing collection info.
ValidationException is thrown if any of the following situation occurs:
•
•
•
Parameters
collectionInfoId—instance id of the collection info
Return Value
void
stopCollectors
Stops polling for an existing collection info. This method is available for Cisco Nexus 7000 Series switches that run Cisco NX-OS Release 5.1(1) or later.
AppException is thrown if any of the following situation occurs:
•
•
•
Parameters
collectionInfoId—instance id of the collection info
Return Value
void