Web Services API Guide, Cisco DCNM for LAN, Release 5.x - ConfigDeliveryApp Service [Cisco Prime Data Center Network Manager]

Table Of Contents

ConfigDeliveryApp Service

Information About Config DeliveryApp Service

bindTargetDeviceDetails

cancelConfigDeliveryTasks

createConfigDeliveryTask

createConfigDeliveryTasks

deleteConfigDeliveryTasks

deliverConfiguration

fetchNetworkElementCommandResponse

fetchNetworkElementCommandResponses

getAllConfigDeliveryTasks

getAllTemplates

getConfigDeliveryTask

getTargetDeviceDetails

modifyConfigDeliveryTask

modifyConfigDeliveryTaskDeviceDetails

performCopyRunToStart

unbindTargetDeviceDetails

ConfigDeliveryApp Service

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

Information About Config DeliveryApp Service

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

bindTargetDeviceDetails

Binds the given target device with the given configuration delivery task object.

Parameters

opContext—the operational context of this API call.

configDeliveryTaskId—the configuration delivery task to which the given target device needs to be bound.

details—the target device to be bound.

Returns

void.

cancelConfigDeliveryTasks

This method cancels all the given configuration delivery tasks that are currently in progress.

This operation will ignore the completed tasks.

Parameters

opContext—the operational context of this API call.

taskIds—the list of InstanceNameId of configuration delivery tasks to be cancelled.

Returns

void.

createConfigDeliveryTask

This method creates the given configuration delivery task in server and returns the InstanceNameId of the newly created configuration delivery task object.

Parameters

opContext—the operational context of this API call.

task—the new configuration delivery task to be created.

Returns

The InstanceNameId of the new object.

createConfigDeliveryTasks

This method creates the given configuration delivery task in server and returns the InstanceNameId of the newly created configuration delivery task object.

Parameters

opContext—the operational context of this API call.

task—the new configuration delivery task to be created.

Returns

The InstanceNameId of the new object.

deleteConfigDeliveryTasks

This method deletes all the given configuration delivery tasks from the server.

Parameters

opContext—the operational context of this API call.

taskIds—the list of InstanceNameId of configuration delivery tasks to be deleted.

Returns

void.

deliverConfiguration

Delivers the given raw CLI commands to the given device.

Parameters

opContext—the operational context of this API call.

neId—the InstanceNameId of the network element to which the commands to be delivered.

commands—the list of commands to be delivered.

processExitCommands—a boolean flag to enable the automatic exit commands addition based on spaces before given commands .

Returns

void.

fetchNetworkElementCommandResponse

This method invokes the given command in the given device and returns the device response.

Parameters

opContext—the operational context of this API call.

neId—the InstanceNameId of the network element whose response is required.

command—the command to be executed in the given device.

Returns

The device response for the given command.

fetchNetworkElementCommandResponses

This method invokes the given commands in the given device and returns the device responses.

Parameters

opContext—the operational context of this API call.

neId—the InstanceNameId of the network element whose response is required.

commands—the list of commands to be executed in the given device.

Returns

The device responses for the given commands .

getAllConfigDeliveryTasks

This method returns all the configuration delivery tasks provisioned in the server.

Parameters

opContext—the operational context of this API call.

Returns

All the configuration delivery tasks as instances of ConfigDeliveryTask.

getAllTemplates

This method returns all the templates defined in DCNM server.

Parameters

opContext—the operational context of the API call.

Returns

The list of all templates defined in server.

getConfigDeliveryTask

This method returns the configuration delivery task of the given instance class identifier.

Parameters

opContext—the operational context of this API call

taskId—the InstanceNameId of the required configuration delivery task.

Returns

The configuration delivery task.

getTargetDeviceDetails

This method returns the device level status information for each target device selected in the given configuration delivery task.

Parameters

opContext—the operational context of this API call.

taskId—the InstanceNameId of the configuration delivery task for which detailed status is required.

Returns

The device level status information as a list of ConfigDeliveryTaskDeviceDetails instances.

modifyConfigDeliveryTask

Updates the given modified configuration delivery task in the server.

This method updates all the modifications in the given configuration delivery task object except the modifications in target device associations collection, ConfigDeliveryTask.getConfigDeliveryTaskDeviceDetailsCol().

Parameters

opContext—the operational context of this API call.

task—the modified configuration delivery task.

Returns

void.

modifyConfigDeliveryTaskDeviceDetails

Modifies the given configuration task device details object in the server.

Parameters

opContext—the operational context of this API call.

details—the configuration task device details object that needs to be updated.

Returns

void.

performCopyRunToStart

Creates a new config delivery task to deliver "copy running-config startup-config" cmd on the given list of devices and returns the InstanceNameId of the newly created configuration delivery task object. This method is available for Cisco Nexus 7000 Series switches that run Cisco NX-OS Release 5.1(1) or later.

Parameters

opContext—the operational context of this API call.

neInstanceNameIdCol - the list of InstanceNameId of the network elements on which the command needs to be delivered

isForAllVdcs - The boolean flag which determines if copy run to start has to be triggered for all VDCs

bootflashFileName - This specifies the name of the file to which the running config has to be copied to. If "null" is specified then the running-config is copied to startup-config.

Returns

InstanceNameId of the new configuration delivery task object.

unbindTargetDeviceDetails

Unbinds the given target device from the given configuration delivery task object.

Parameters

opContext—the operational context of this API call.

configDeliveryTaskId—the configuration delivery task from which the given target device needs to be unbound.

details—the target device that needs to be unbound.

Returns

void.

	Web Services API Guide, Cisco DCNM for LAN, Release 5.x
	ConfigDeliveryApp Service
Web Services API Guide, Cisco DCNM for LAN, Release 5.x Preface Overview AaaApp Service AclApp Service ClusterApp Service CollectorApp Service CollectorExtendedApp Service ConfigArchiveApp Service ConfigDeliveryApp Service ConfigTemplateApp Service DaiApp Service DataPurgingApp Service DeviceGroupApp Service DevicelistApp Service DhcpSnoopApp Service Dot1xApp Service EtherChanApp Service EventApp Service FabricPathResourcesApp Service FabricPathTopologyApp Service FcApp Service FCoEApp Service FeatureSetApp Service FexApp Service FiPSnoopingApp Service FireWallApp GlbpApp Service HsrpApp Service IgmpSnoopingApp Service ImageInstallApp Service InterfacesApp Services InventoryApp Service IpSourceGuardApp Service KeyChainApp Service L2IsisApp Service LicensingApp Service LogApp Service LstApp Service NacLpIpApp Service Object Group PathLatencyApp ObjTrackingApp Service PollerApp Service PortProfileApp PortSecApp Service PreprovisionApp RbacApp Service RepositoryApp Service SecurityApp Service ServerApp Service ServerAdminApp Service SoftwareApp Service SpanApp Service StpApp Service SVSConnectionApp Service SVSDomainApp Service SwitchProfileApp ThresholdAction Service TrafficStormControlApp Service TunnelApp Service UserApp Service VdcApp Service VlanApp Service VpcApp Service VrfApp Service	Download this chapter ConfigDeliveryApp Service Download the complete book Cisco DCNM Web Services API Guide, Release 5.x (PDF - 3 MB) Feedback Table Of Contents ConfigDeliveryApp Service Information About Config DeliveryApp Service bindTargetDeviceDetails cancelConfigDeliveryTasks createConfigDeliveryTask createConfigDeliveryTasks deleteConfigDeliveryTasks deliverConfiguration fetchNetworkElementCommandResponse fetchNetworkElementCommandResponses getAllConfigDeliveryTasks getAllTemplates getConfigDeliveryTask getTargetDeviceDetails modifyConfigDeliveryTask modifyConfigDeliveryTaskDeviceDetails performCopyRunToStart unbindTargetDeviceDetails ConfigDeliveryApp Service This chapter describes the DCNM web services' API methods for the ConfigDeliveryApp service. This API is available for Cisco Nexus 7000 Series switches that run Cisco NX-OS Release 5.0(3) or later. Information About Config DeliveryApp Service This application interface declares the services provided by DCNM configuration delivery component. bindTargetDeviceDetails Binds the given target device with the given configuration delivery task object. Parameters opContext—the operational context of this API call. configDeliveryTaskId—the configuration delivery task to which the given target device needs to be bound. details—the target device to be bound. Returns void. cancelConfigDeliveryTasks This method cancels all the given configuration delivery tasks that are currently in progress. This operation will ignore the completed tasks. Parameters opContext—the operational context of this API call. taskIds—the list of InstanceNameId of configuration delivery tasks to be cancelled. Returns void. createConfigDeliveryTask This method creates the given configuration delivery task in server and returns the InstanceNameId of the newly created configuration delivery task object. Parameters opContext—the operational context of this API call. task—the new configuration delivery task to be created. Returns The InstanceNameId of the new object. createConfigDeliveryTasks This method creates the given configuration delivery task in server and returns the InstanceNameId of the newly created configuration delivery task object. Parameters opContext—the operational context of this API call. task—the new configuration delivery task to be created. Returns The InstanceNameId of the new object. deleteConfigDeliveryTasks This method deletes all the given configuration delivery tasks from the server. Parameters opContext—the operational context of this API call. taskIds—the list of InstanceNameId of configuration delivery tasks to be deleted. Returns void. deliverConfiguration Delivers the given raw CLI commands to the given device. Parameters opContext—the operational context of this API call. neId—the InstanceNameId of the network element to which the commands to be delivered. commands—the list of commands to be delivered. processExitCommands—a boolean flag to enable the automatic exit commands addition based on spaces before given commands . Returns void. fetchNetworkElementCommandResponse This method invokes the given command in the given device and returns the device response. Parameters opContext—the operational context of this API call. neId—the InstanceNameId of the network element whose response is required. command—the command to be executed in the given device. Returns The device response for the given command. fetchNetworkElementCommandResponses This method invokes the given commands in the given device and returns the device responses. Parameters opContext—the operational context of this API call. neId—the InstanceNameId of the network element whose response is required. commands—the list of commands to be executed in the given device. Returns The device responses for the given commands . getAllConfigDeliveryTasks This method returns all the configuration delivery tasks provisioned in the server. Parameters opContext—the operational context of this API call. Returns All the configuration delivery tasks as instances of ConfigDeliveryTask. getAllTemplates This method returns all the templates defined in DCNM server. Parameters opContext—the operational context of the API call. Returns The list of all templates defined in server. getConfigDeliveryTask This method returns the configuration delivery task of the given instance class identifier. Parameters opContext—the operational context of this API call taskId—the InstanceNameId of the required configuration delivery task. Returns The configuration delivery task. getTargetDeviceDetails This method returns the device level status information for each target device selected in the given configuration delivery task. Parameters opContext—the operational context of this API call. taskId—the InstanceNameId of the configuration delivery task for which detailed status is required. Returns The device level status information as a list of ConfigDeliveryTaskDeviceDetails instances. modifyConfigDeliveryTask Updates the given modified configuration delivery task in the server. This method updates all the modifications in the given configuration delivery task object except the modifications in target device associations collection, ConfigDeliveryTask.getConfigDeliveryTaskDeviceDetailsCol(). Parameters opContext—the operational context of this API call. task—the modified configuration delivery task. Returns void. modifyConfigDeliveryTaskDeviceDetails Modifies the given configuration task device details object in the server. Parameters opContext—the operational context of this API call. details—the configuration task device details object that needs to be updated. Returns void. performCopyRunToStart Creates a new config delivery task to deliver "copy running-config startup-config" cmd on the given list of devices and returns the InstanceNameId of the newly created configuration delivery task object. This method is available for Cisco Nexus 7000 Series switches that run Cisco NX-OS Release 5.1(1) or later. Parameters opContext—the operational context of this API call. neInstanceNameIdCol - the list of InstanceNameId of the network elements on which the command needs to be delivered isForAllVdcs - The boolean flag which determines if copy run to start has to be triggered for all VDCs bootflashFileName - This specifies the name of the file to which the running config has to be copied to. If "null" is specified then the running-config is copied to startup-config. Returns InstanceNameId of the new configuration delivery task object. unbindTargetDeviceDetails Unbinds the given target device from the given configuration delivery task object. Parameters opContext—the operational context of this API call. configDeliveryTaskId—the configuration delivery task from which the given target device needs to be unbound. details—the target device that needs to be unbound. Returns void.
	Terms & Conditions \| Privacy Statement \| Cookie Policy \| Trademarks