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

DeviceGroupApp Service

Table Of Contents

DeviceGroupApp Service

Information About DeviceGroupApp Service

createGroups

deleteGroups

getAbstractNetworkElementCol

getAbstractNetworkElementsMatchingCriteria

getAllGroups

getAneInstanceNameIdCol

getGroups

modifyCurrentUserDeviceGroup

modifyGroups


DeviceGroupApp Service


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

Information About DeviceGroupApp Service

DeviceGroup allows you to group a set of devices. You can create a device group with a specific set of devices and activate it. After you activate a device group, the configuration panel displays only those devices that belong to the active group. This interface defines all the APIs needed to create, modify, activate, and delete device groups.

createGroups

Creates one or more DeviceGroup objects. Given a list of DeviceGroups to be created, this API creates the objects in the database and returns the created objects.

Parameters

opContext—operational context.

deviceGroupCol—list of DeviceGroup objects.

Returns

List of DeviceGroup objects that are created in the server.

deleteGroups

Deletes one or more DeviceGroup objects. Given the InstanceNameId of the DeviceGroup objects, those objects will be deleted.

Parameters

opContext—operational context.

groupInstanceNameIdCol—a collection that contains InstanceNameId of one or more DeviceGroup objects that needs to be deleted.

Returns

void.

getAbstractNetworkElementCol

The method returns the list of AbstractNetworkElements belonging to a device group.

Parameters

opContext—operational context.

groupInstanceNameId—an InstanceNameId of DeviceGroup.

Returns

List of AbstractNetworkElement objects corresponding to a device group with given InstanceNameId.

getAbstractNetworkElementsMatchingCriteria

Fetches and return the list of abstract network Elements matching the criteria specified.

Parameters

opContext—operational context.

deviceCriteria—The criteria can specify the platform, seeddevice, hopCount.

Returns

Returns a list of abstract network Elements matching the criteria.

getAllGroups

Returns all the groups in the server owned by the user.

Parameters

opContext—operational context.

Returns

List of DeviceGroup objects.

getAneInstanceNameIdCol

The method returns the list of List of InstanceNameIds of AbstractNetworkElements belonging to the list of device groups.

Parameters

opContext—operational context.

groupInstanceNameIdList—list of InstanceNameId of DeviceGroup.

Returns

list of list of InstanceNameId of AbstractNetworkElements corresponding to list of device groups with given list of InstanceNameId.

getGroups

Returns device groups from its InstanceNameIds. Given a collection of InstanceNameId of the DeviceGroups, returns the corresponding DeviceGroup objects.

Parameters

opContext—operational context.

groupInstanceNameIdCol—a collection of InstanceNameId of DeviceGroup.

Returns

list of DeviceGroup objects corresponding to given collection of InstanceNameId.

modifyCurrentUserDeviceGroup

Activates a DeviceGroup for the current user.

Parameters

opContext—operational context.

groupinstanceNameId—InstanceNameId of DeviceGroup which needs to be associated with the current user.

Returns

void.

modifyGroups

Modifies one or more existing DeviceGroup objects.

Parameters

opContext—operational context.

deviceGroupCol—a collection (one or more) of DeviceGroup objects that will replace the existing DeviceGroup objects in the database.

Returns

void.