Cisco DCNM Web Services API Guide, Release 4.1
DevicelistApp Service
Downloads: This chapterpdf (PDF - 105.0KB) The complete bookPDF (PDF - 7.86MB) | Feedback

DeviceListApp Service

Table Of Contents

DeviceListApp Service

Information About DeviceListApp Service

addNetworkElements

bindNetworkElementsToGroup

createNetworkElementGroup

deleteAllNetworkElementGroups

deleteAllNetworkElements

deleteNetworkElementGroups

deleteNetworkElements

discover

discoverNetworkElements

getAllDiscoveryTasks

getAllNetworkElementGroups

getAllNetworkElements

getDiscoveryStatus

getNetworkElementGroups

incrementalDiscovery

modifyNetworkElementGroups

performDisovery

performIncrementalDiscovery

performNetworkElementsDiscovery

performNetworkElementsRediscovery

performNetworkElementsUnmanaged

rediscoverNetworkElements

unbindNetworkElementsToGroup

unmanageNetworkElements


DeviceListApp Service


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

Information About DeviceListApp Service

The DeviceListApp Device List contains a list of devices managed by DCNM. This feature allows you to add new devices to the list and remove devices from the list. NetworkElementGroup, which is a logical grouping of devices, allows you to create groups, add devices to the group, and assign them to users. A DCNM user can manage only the devices that you, as the administrator, assign to the user. Each user can specify the credentials to log in to devices managed by that user. A user can specify default credentials for a group of devices and also for individual devices. The credentials specified for a device will override the group credentials and the credentials specified for a group will override the default credentials for the user.

addNetworkElements

Adds a list of new devices to the device list. If a device with the specified IP address already exists in the device, this method will throw AppException.

Parameters

opContext—Operational context

neCol—List of identifiers corresponding to the devices to be added to the device list.

Return Value

List of AbstractNetworkElement with its AbstractNetworkElementStatus

bindNetworkElementsToGroup

Adds the specified devices from the specified device group

Parameters

opContext—Operational context

neGroupInstanceNameId—InstanceNameId of the device group

neInstanceNameIdCol—List of InstanceNameId of devices to be added to the device group

Return Value

void

createNetworkElementGroup

Creates a NetworkElementGroup with the specified name and adds the specified devices to the group.

Parameters

opContext—Operational context

neGroupName—Name of the device group

neInstanceNameIdCol—InstanceNameId of devices to be added to the device group

Return Value

NetworkElementGroup

deleteAllNetworkElementGroups

Deletes all the device groups

Parameters

opContext—Operational context

Return Value

void

deleteAllNetworkElements

Deletes all the devices managed by DCNM. Devices and their associated management information will be deleted.

Parameters

opContext—Operational context

Return Value

void

deleteNetworkElementGroups

Deletes the specified device groups

Parameters

opContext—Operational context

neGroupInstanceNameIdCol—List of device group names to be deleted

Return Value

void

deleteNetworkElements

Deletes the specified devices from the device list. The specified devices will be removed from all the groups. AbstractNetworkElement and its associated information will be deleted from the DB. TODO what do we do the statistics and events related related to the devices?

Parameters

opContext—Operational context

neInstanceNameIdCol—List of InstanceNameId corresponding to the devices to be deleted from the device list.

Return Value

void

discover

Discovery API to discover the network based on IP address

Parameters

opContext—OpContext

seed—IpAddress of the seed Device

cred—Credentials Used to discover the network

hops—No of hops that are used for discovery

incremental—Boolean to indicate whether it is incremental discovery or not

Return Value

DiscoveryTaskStatus for the corresponding discovery task

discoverNetworkElements

Starts a task to discover configuration and status information for the specified devices. At the start of discovery, status of the devices will be set as DISCOVERY. Upon successful discovery, status will be set to MANAGED.

Parameters

opContext—Operational context

neInstanceNameIdCol—List of InstanceNameId corresponding devices to be discovered

Return Value

Task ID that identifies the discovery task

getAllDiscoveryTasks

API to return status for list of discovey tasks

Parameters

opContext—OpContext

Return Value

List of DiscoveryTaskStatus for the all discovery tasks

getAllNetworkElementGroups

Returns all the device groups with the AbstractNetworkElement belonging to the group. AbstractNetworkElementStatus will be initialized for AbstractNetworkElement.

Parameters

opContext—Operational context

Return Value

List of NetworkElementGroup

getAllNetworkElements

Returns all the network elements that are available in the Device List.

Parameters

opContext—Operational context

Return Value

List of AbstractNetworkElement with its AbstractNetworkElementStatus

getDiscoveryStatus

Gets discovery status.

Parameters

opContext—TODO

taskIdCol—

Return Value

List of Discovery Status

getNetworkElementGroups

Returns specified device groups with the AbstractNetworkElement belonging to the group. AbstractNetworkElementStatus will be initialized for AbstractNetworkElement.

Parameters

opContext—Operational context

Return Value

List of NetworkElementGroup

incrementalDiscovery

Performs incremental discovery.

Parameters

opContext—Operational context

neInstanceNameIdCol—List of InstanceNameId corresponding devices to be discovered

userCredentials—userName/password/enableUserName/enablePassword

Return Value

Task ID that identifies the discovery task

modifyNetworkElementGroups

Modifies the device membership for a list of device groups.

Parameters

opContext—Operational context

neGroupCol—List of NetworkElementGroup

Return Value

void

performDisovery

Discovery API to discover the network based on IP address

Parameters

opContext—Operational context

seed—IpAddress of the seed Device

cred—Credentials Used to discover the network

hops—No of hops that are used for discovery

incremental—Boolean to indicate whether it is incremental discovery or not

Return Value

DiscoveryTaskStatus for the corresponding discovery task

performIncrementalDiscovery

Parameters

opContext—Operational context

neInstanceNameIdCol—List of InstanceNameId corresponding devices to be discovered

userCredentials—userName/password/enableUserName/enablePassword

Return Value

Task ID that identifies the discovery task

performNetworkElementsDiscovery

Starts a task to discover configuration and status information for the specified devices. At the start of discovery, status of the devices will be set as DISCOVERY. Upon successful discovery, status will be set to MANAGED.

Parameters

opContext—Operational context

neInstanceNameIdCol—List of InstanceNameId corresponding devices to be discovered

Return Value

Task ID that identifies the discovery task

performNetworkElementsRediscovery

Parameters

opContext—Operational context

neInstanceNameIdCol—

userCredentials—

Return Value

performNetworkElementsUnmanaged

Deletes the information associated with the specified devices. The device status will be marked as UNMANAGED.

Parameters

opContext—Operational context

neInstanceNameIdCol—List of InstanceNameId corresponding to the devices to be unmanaged.

Return Value

void

rediscoverNetworkElements

Rediscovers network elements.

Parameters

opContext—Operational context

neInstanceNameIdCol—

userCredentials—

Return Value

unbindNetworkElementsToGroup

Removes the specified devices from the specified device group

Parameters

opContext—Operational context

neGroupInstanceNameId—InstanceNameId of the device group

neInstanceNameIdCol—List of InstanceNameId of devices to be added to the device group

Return Value

void

unmanageNetworkElements

Deletes the information associated with the specified devices. The device status will be marked as UNMANAGED.

Parameters

opContext—Operational context

neInstanceNameIdCol—List of InstanceNameId corresponding to the devices to be unmanaged.

Return Value

void