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

FeatureSetApp Service

Table Of Contents

FeatureSetApp Service

Information About FeatureSetApp Service

disableFeatureSets

enableFeatureSets

getFeatureSetGlobalSettingForNetworkElements

getStateOfFeatureSetsForNetworkElements


FeatureSetApp Service


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

Information About FeatureSetApp Service

A feature-set is a collection of components that perform a specific set of functions. The feature-set concept was introduced in Cisco NX-OS Release 5.1(1) to avoid overloading (the switch memory or performance) the switch when the user does not want to use the features or plugins or components that are supported on a specific switch. The APIs are defined with the following categories:

1. Query or Get APIs—Query data from the persisted database.

2. Enable or Disable APIs—Enable or disable feature-set features.

disableFeatureSets

Disables a feature-set feature on one or more network elements. Given the InstancenameId of one or more network elements, given feature-set feature will be disabled on those elements.

ValidationException is thrown if any of the following situation occurs:

If the neInstanceNameIdCol is null.

If the neInstanceNameIdCol contains one or more null element, or the collection is empty or it is not type InstanceNameId.

If featureSets collection contains an element that is null or the collection is empty or it is not type FeatureSetType.

If the argument passed is null or it is not a valid FeatureSetType.

Parameters

opContext—Operational context

neInstanceNameIdCol—list of InstanceNameId of the Network Element

featureSets—Feature-set feature names

Return Value

void

enableFeatureSets

Enables feature-set feature on one or more network elements. Given the InstancenameId of one or more network elements, given feature-set feature will be enabled on those elements.

ValidationException is thrown if any of the following situation occurs:

If the neInstanceNameIdCol is null.

If the neInstanceNameIdCol contains one or more null element, or the collection is empty or it is not type InstanceNameId.

If featureSets collection contains an element that is null or the collection is empty or it is not type FeatureSetType.

If the argument passed is null or it is not a valid FeatureSetType.

Parameters

opContext—Operational context.

neInstanceNameIdCol—list of InstanceNameId of the Network Element.

featureSets—Feature-set feature names.

Return Value

InstanceNameId the instance name id of the CollectionInfo.

getFeatureSetGlobalSettingForNetworkElements

Returns Feature-Set global setting for the given list of network elements. Given the list of instance name IDs of the network elements, returns a List of FeatureSetGlobalSetting instances.

Stops the collector if it is running for the given collection info.

ValidationException is thrown if any of the following situation occurs:

If neInstanceNameIdCol collection contains an element that is null or the collection is empty or it is not type InstanceNameId.

if the argument passed is null or it is not a valid network element InstanceNameId.

Parameters

opContext—Operational context

neInstanceNameIdCol—InstanceNameId of the one or more Network Element for Feature-Set global setting is required.

Return Value

The returned list will contain list of FeatureSetGlobalSetting instances.

getStateOfFeatureSetsForNetworkElements

Returns state of given Feature-set features whether it is enabled or disabled in a list of network elements. Given the list of instance name IDs of the network elements, returns a List of list of Boolean values.

ValidationException is thrown if any of the following situation occurs:

If the neInstanceNameIdCol is null.

If the neInstanceNameIdCol contains one or more null element, or the collection is empty or it is not type InstanceNameId.

If featureSets collection contains an element that is null or the collection is empty or it is not type FeatureSetType.

If the argument passed is null or it is not a valid FeatureSetType.

Parameters

opContext—Operational context

neInstanceNameIdCol—list of InstanceNameId of the Network Element

featureSets—Feature-set feature names

Return Value

Returned list contains a list of boolean instances as follows:

True—The given feature-set feature is enabled in the given network element.

False—The given feature-set feature is disabled in the given network element.