Cisco Cisco Configuration Engine 3.5 Entwickleranleitung
6-31
Cisco Configuration Engine Software Development Kit API Reference and Programmer Guide 3.5
OL-17661-02
Chapter 6 Namespace Administration, Group Administration, and Notification APIs
Group Administration API
Example:
Given
[“/config/G1/G2/G3”,”/config/G1/G3”,”/config/G1/G3/G2/G3”]
Set Notification
This method provides the client application the capability of stopping and re-starting subsequent group
administration operations from generating change notification events.
administration operations from generating change notification events.
In cases where the client application is expected to perform a great number of groups and devices
re-arrangement operations, the client application could choose to stop notification temporarily (using
setNotification(FALSE)), carry out the operations, and then re-enable notification (using
setNotification(TRUE)) after. This could reduce the event traffic and avoid handling of a large number
of notification events.
re-arrangement operations, the client application could choose to stop notification temporarily (using
setNotification(FALSE)), carry out the operations, and then re-enable notification (using
setNotification(TRUE)) after. This could reduce the event traffic and avoid handling of a large number
of notification events.
When re-enabling notification, this method sends a global-change notification to all subscribing
applications, asking them to re-load all its subject mappings to the ones defined by the latest grouping
and namespace definitions.
applications, asking them to re-load all its subject mappings to the ones defined by the latest grouping
and namespace definitions.
Exceptions
This method could throw one of the following exceptions:
•
DatastoreAccessException – Data-store connection problem or problem
not described below.
not described below.
•
InvalidInputException – See
for basic rules.
•
MemberNotFoundException – Given device does not exist.
•
MessageFormatException – Problem with message syntax.
Additional exception that can be thrown by remote API:
CommunicationException – General server access problem.
Method
void setNotification (Boolean state)
Input parameter
state
A boolean indicates whether to turn on or turn off the sending of notification
event for the subsequent change operation.
event for the subsequent change operation.
Return
None.
Exceptions
Exception that can be thrown:
MessageFormatException – Problem with message syntax.
Exception that can be thrown by the remote API:
CommunicationException – General server access problem.