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

LicensingApp Service

Table Of Contents

LicensingApp Service

Information About LicensingApp Service

getDetailedLicenseInfo

getHostIdentifier

getLicensedNetworkElements

getLicensedStateForNetworkElements

getLicenseInfo

modifyLicensedStatus

performActivateLicenses

verifyLicense


LicensingApp Service


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

Information About LicensingApp Service

This chapter defines the APIs exposed by the Licensing service feature of the DCNM server.

getDetailedLicenseInfo

Returns the detailed license information of DCNM server.

For each valid license file, there will be corresponding LicenseInfo object.

Return Value

The detailed license information

getHostIdentifier

Returns the host identifier of this DCNM server.

Parameters

opContext—Operational context of this API call

Return Value

The host id of this DCNM server

getLicensedNetworkElements

Returns the list of instance name identifiers of licensed network elements.

Parameters

opContext—operational context of this API call

Returns

The list of instance name ids of licensed network elements

getLicensedStateForNetworkElements

Returns the licensed state information for the given network elements.This method is available for Cisco Nexus 7000 Series switches that run Cisco NX-OS Release 5.0(3) or later.

Parameters

opContext—operational context of this API call

networkElementIds—the network elements for which licensed state information is required

Returns

The licensed state information of given network elements

getLicenseInfo

Returns the license information of the server.This method is available for Cisco Nexus 7000 Series switches that run Cisco NX-OS Release 5.0(3) or later.

Parameters

opContext—Operational context of this API call

Return Value

The license info of the server

modifyLicensedStatus

Modifies the licensed status of the given network elements with the given license status.This method is available for Cisco Nexus 7000 Series switches that run Cisco NX-OS Release 5.0(3) or later.

Returns the modified licensed status of passed network elements after the required validation.

Parameters

opContext—operation context of this API call

networkElementIds—the InstanceNameId instances of network elements

licensedStatus—the new license status to be set

Returns

A list of boolean values giving the modification success for each given network element

performActivateLicenses

Re-reads the license files and refreshes the licenses information.

If there is a change in license information, an event, whose source instance set as modified instance of LicenseInfo, will be sent

Parameters

opContext—Operational context of this API call

Return Value

void

verifyLicense

Returns the licensed information for all cluster nodes. This method is available for Cisco Nexus 7000 Series switches that run Cisco NX-OS Release 5.1(1) or later.

Return Value

License information as formatted report.