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

ThresholdActionAppService

Table Of Contents

ThresholdActionAppService

Information About ThresholdActionApp Service

createThresholdRuleBindings

createThresholdRules

deleteThresholdRuleBindings

deleteThresholdRules

getAllThresholdRules

getThresholdRuleBindingIds

getThresholdRuleBindings

modifyThresholdRules


ThresholdActionAppService


This chapter describes the DCNM web services' API methods for the ThresholdActionApp service. This API is available for Cisco Nexus 7000 Series switches that run Cisco NX-OS Release 5.1(1) or later.

Information About ThresholdActionApp Service

DCNM allows you to apply threshold rules on the collected statistical data. DCNM performs the set of action depending on the rule definition. The user can define the threshold rule as a template and apply the threshold rule template to an existing collected statistical data.

The rising threshold is the upper threshold and the falling threshold is the lower threshold for the sampled variable. When the current sampled variable is greater than or equal to the specified threshold, DCNM may perform a set of actions. You can specify only one rising threshold and only one falling threshold on the same sampled variable. The threshold rule have a set of properties (threshold settings) and a set of actions (threshold actions).

The main threshold setting properties are as follows:

Name—A user-friendly name to identify the threshold settings.

Frequency—The number of times that the sampled variable must cross the threshold value before triggering the actions. That may allow to throttle the number of actions to be performed in case such an event occurs too frequently.

Period—Interval of time to monitor the frequency for the sampled variable.

Repeat— Prevent the timer to reset after triggering action within the interval of time (period).

Trend— Rising or falling threshold.

The main threshold actions are as follows:

Send an e-mail or SMS.

Run a script on the DCNM server.

Send an event to the current DCNM event channel.

createThresholdRuleBindings

Creates threshold rule bindings with associated a threshold rule.

ParameterException is thrown if any of the following situations occurs:

If aThresholdRuleBindings and aThresholdRuleIds and aStatisticalEntryIds does not have same collection size.

Parameters

opContext—Operational context

aThresholdRuleBindings—threshold rule bindings.

aThresholdRuleIds—threshold rule associated to the specified threshold rule bindings.

aStatisticalEntryIds—StatisticalEntry related to ThresholdRuleBinding.

Return Value

A list of threshold rule bindings.

createThresholdRules

Creates threshold rules. Each ThresholdRule must contain up to 2 ThresholdSettings (one for rising and/or one for falling threshold). Each ThresholdSetting must contain ThresholdActions.

FeatureException is thrown if any of the following situations occurs.

If aCollectionInfo is null.

ValidationException is thrown if any of the following situation occurs:

If Rising/Falling Threshold Setting Frequency is 0.

If Rising/Falling Threshold Setting Period is less than 60.

If Threshold Rule does not have either Rising/Falling Threshold Setting.

If Rising/Falling Threshold Setting does not even have one Threshold Action.

Parameters

opContext—Operational context.

aThresholdRules—a list of threshold rules.

Return Value

List of threshold rule instance names.

deleteThresholdRuleBindings

Deletes threshold rule bindings.

Parameters

opContext—Operational context

aThresholdRuleBindingIds—a list threshold rule binding instance names to delete.

Return Value

void

deleteThresholdRules

Deletes threshold rules specified with threshold rule instance names. Associated threshold settings and threshold actions will be deleted.

FeatureException is thrown if any of the following situation occurs:

* If ThresholdRule contains ThresholdRuleBinding.

IntegrityException is thrown if the given collectionInfo does not exist in devices.

Parameters

opContext—Operational context

aThresholdRuleIds—threshold rule instance names.

Return Value

void

getAllThresholdRules

Returns all the threshold rules present in the application.

Parameters

opContext—Operational context

Return Value

All the threshold rules in the application.

getThresholdRuleBindingIds

Returns all the threshold rule binding instance names associated to specified threshold rule instance name.

Parameters

OpContext—operational Context.

ThresholdRuleIds—list of threshold rule instance names.

Returns

A list of list of threshold rule binding instance names.

getThresholdRuleBindings

Returns threshold rule bindings corresponding to threshold rule binding instance names.

Parameters

opContext—Operational context

aThresholdRuleBindingIds—threshold rule binding instance names.

Return Value

Alist of threshold rule bindings.

modifyThresholdRules

Modifies threshold rules.

ParameterException is thrown if any of the following situations occurs:

If Rising/Falling Threshold Setting Frequency is 0.

If Rising/Falling Threshold Setting Period is less than 60.

If Threshold Rule does not have either Rising/Falling Threshold Setting.

If Rising/Falling Threshold Setting does not even have one Threshold Action.

Parameters

opContext—Operational context

aThresholdRules—A list of threshold rules to modify.

Return Value

void