Cisco DCNM Web Services API Guide, Release 4.1
PollerApp Service
Downloads: This chapterpdf (PDF - 83.0KB) The complete bookPDF (PDF - 7.86MB) | Feedback

PollerApp Service

Table Of Contents

PollerApp Service

Information About PollerApp Service

getAllPollerTasks

getLoggingLevelSettings

getLoggingLevelSettingsForDcnmDefaults

getPollerInterval

modifyLoggingLevelSettings

modifyLoggingLevelSettingsToDcnmDefaults

modifyPollerInterval

startSyslogPoller

stopSyslogPoller

synchronizeWithDevice

validateLoggingLevelSettingsForDcnmDefaults


PollerApp Service


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

Information About PollerApp Service

The PollerApp service allows you to obtain syslog poller information. The syslog poller component is used to synchronize with the device automatically. The DCNM server creates a syslog poller for each managed device. Each syslog poller periodically retrieves system and accounting logs from a device. DCNM uses the information retrieved by poller processes to update its configuration and status information for polled devices.

getAllPollerTasks

Returns all the SyslogPollerInfo running in the server.

Parameters

opContext—Operational context

Return Value

List of SyslogPollerInfo for all syslog poller tasks.

getLoggingLevelSettings

Returns a collection of LoggingLevelSeting objects for given devices.

Parameters

opcontext—Operational context

neInstanceNameIdCol—InstanceNameId of AbstractNetworkElement

Return Value

Collection of LoggingLevelSetting objects corresponding to given devices.

getLoggingLevelSettingsForDcnmDefaults

Returns a collection of LoggingLevelSetting that are set to DCNM required values based on the given platform type and version.

Parameters

opContext—Operational context

platformTypeVersionPairCol—Collectionf of a pair of platform type and the version in it.

Return Value

Returns a colelction of LoggingLevelSetting objects

getPollerInterval

Returns the interval of the syslog poller in seconds.

Parameters

opContext—

Return Value

The polling interval in seconds

modifyLoggingLevelSettings

Modfies the loggingLevelSetting object's value to be the given LoggingLevelSettings.

Parameters

opContext—Operational context

loggingLevelSettingCol—Collection of modified LoggingLevelSetting objects.

Return Value

Modifed LoggingLevelSetting objects.

modifyLoggingLevelSettingsToDcnmDefaults

Sets the log levels in given devices to be DCNM required default values.

Parameters

opContext—Operational context

neInstanceNameIdCol—Collection of Instance name id of AbstractNetworkElement.

Return Value

void

modifyPollerInterval

Modifies the given number of seconds as the polling interval of the syslog poller.

Parameters

opContext—Operational context

seconds—polling interval in seconds

Return Value

void

startSyslogPoller

Starts the syslog polling for the given network element id.

Parameters

opContext—Operational context

networkElementId—network element id for which the polling has to be started.

Return Value

void

stopSyslogPoller

Stops the syslog polling for the given network element.

Parameters

opContext—Operational context

networkElementId—network element for which the syslog polling has to be stopped.

Return Value

void

synchronizeWithDevice

Syncronizes with the device. Runs syslog polling of the given network element once immediately to syncronize the changes done in the device with DCNM.

Parameters

opContext—Operational context

networkElementId—network element for which the syslog polling has to be run immediately once.

Return Value

void

validateLoggingLevelSettingsForDcnmDefaults

Vailidate the logging level setting to check if it's attributes are set to DCNM required detaults for the given devices.

Parameters

opContext—Operational context

neInstanceNameIdCol—Collection of Instance name id of AbstractNetworkElement.

Return Value

Returns a collection Boolean objects. It is set to true if the device is configured with DCNM required logging level, else set to false