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

ConfigTemplateAppService

Table Of Contents

ConfigTemplateAppService

Information About ConfigTemplateApp Service

createTemplate

deleteTemplates

getAllTemplates

getTemplateContents

getTemplates

modifyTemplates

populateTemplateRepository


ConfigTemplateAppService


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

Information About ConfigTemplateApp Service

This application interface declares the services provided by a DCNM configuration template component.

createTemplate

Creates one or more template objects. Given a list of templates to be created, this method creates the objects in the database and returns the InstanceNameId of the object that is created.

Parameters

opContext—Operational context

templateColConfigTemplate—List of template objects.

Return Value

List of template objects that are created in the server.

deleteTemplates

Deletes one or more template objects. Deletes the template object based on the given InstanceNameId of the template objects.

Parameters

opContext—Operational context.

templateInstanceNameIdCol—A collection that contains InstanceNameId of one or more template objects that needs to be deleted.

Return Value

void

getAllTemplates

Returns all the templates that are defined in DCNM server.

Parameters

opContext—Operational context.

templateInstanceNameIdCol—A collection that contains InstanceNameId of one or more template objects that needs to be deleted.

Return Value

List of StringBuilder objects that is content of the template.

getTemplateContents

Get contents for one or more template objects.

Parameters

opContext—Operational context.

collectionInfoId—InstanceId of a collectionInfo.

Return Value

void

getTemplates

Returns config templates from the given InstanceNameId. Given a collection of InstanceNameId of the ConfigTemplates, returns the corresponding ConfigTemplate objects.

Parameters

opContext—Operational context.

templateInstanceNameIdCol—A collection of InstanceNameId of ConfigTemplate.

Return Value

List of ConfigTemplate objects corresponding to given collection of InstanceNameId.

modifyTemplates

Modifies one or more existing template objects.

Parameters

OpContext—operational Context.

templateCol—A collection of Template objects that will replace the existing template objects in the database.

Returns

void

populateTemplateRepository

Refreshes the templates information from the shared location. It marks the template as invalid if the template now does not exist. It adds new templates and update the existing templates. This method does not generate events.

Parameters

opContext—Operational context.

Return Value

void