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

UserApp Service

Table Of Contents

UserApp Service

Information About UserApp Service

bindUserToAllNetworkElements

bindUserToAllNetworkGroups

bindUserToNetworkElements

bindUserToNetworkGroups

createUsers

clearUserData

deleteUsers

getAllUsers

getAllUsersWithUserData

getCurrentUser

getDefaultNetworkElementUserCredentials

getNetworkElementGroupsForUser

getNetworkElementsForUser

getPreferences

getUserCredentialsForNetworkElementGroups

getUserCredentialsForNetworkElements

getUsers

modifyDefaultNetworkElementUserCredentials

modifyPreferences

modifyUserCredentialsForNetworkElementGroups

modifyUserCredentialsForNetworkElements

modifyUsers

unbindUserFromAllNetworkElements

unbindUserFromAllNetworkGroups

unbindUserFromNetworkElements

unbindUserFromNetworkGroups


UserApp Service


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

Information About UserApp Service

This chapter defines the APIs exposed by the user service feature.

bindUserToAllNetworkElements

Binds the user to all network elements.

Parameters

opContext—Operational context

InstanceNameId—Application user

Return Value

void

bindUserToAllNetworkGroups

Binds the user to all network groups.

Parameters

opContext—Operational context

InstanceNameId—Application user

Return Value

void

bindUserToNetworkElements

Binds the user to the specified network elements.

Parameters

opContext—Operational context

InstanceNameId—Application user

InstanceNameId—List of Instance name IDs of network elements

Return Value

void

bindUserToNetworkGroups

Binds the user to the specified network groups.

Parameters

opContext—Operational context

InstanceNameId—Application user

InstanceNameId—List of Instance name IDs of network groups

Return Value

void

createUsers

Creates users based on a list of application users.

Parameters

opContext—Operational context

ApplicationUser—List of application users

Return Value

List of application users created.

clearUserData

Clears the ApplicationUser's following association:

Preferences

NetworkElementForApplicationUser

NetworkElementGroupForApplicationUser

NetworkElementUser.

Parameters

opContext—Operational context

ppUserInstanceNameIdCol - list of ApplicationUser InstanceNameIds whose association needs to be cleared

Return Value

void

deleteUsers

Deletes users based on a list of application users.

Parameters

opContext—Operational context

ApplicationUser—List of application users

Return Value

void

getAllUsers

Gets the list of user information for all application users.

Parameters

opContext—Operational context

Return Value

List of ApplicationUser

getAllUsersWithUserData

Returns only the application users which have any one of the following association. Also it populates the below mentioned assoication:

Preferences

NetworkElementForApplicationUser

NetworkElementGroupForApplicationUser

NetworkElementUser

Parameters

opContext—Operational context

Return Value

List of ApplicationUser which have any one of the association

getCurrentUser

Returns the current logged in user.

Parameters

opContext—Operational context

Return Value

The current logged in user with role populated.

getDefaultNetworkElementUserCredentials

Get the default network element user credentials.

Parameters

opContext—Operational context

Return Value

NetworkElementUserCredentials

getNetworkElementGroupsForUser

Gets the list of network element groups for the specified user.

Parameters

opContext—Operational context

InstanceNameId—Instance name ID of user

Return Value

List of NetworkElementGroup

getNetworkElementsForUser

Gets the list of network elements for the specified user.

Parameters

opContext—Operational context

InstanceNameId—Instance name ID of user

Return Value

List of AbstractNetworkElement

getPreferences

Returns the preferences for the user invoking the API.

Parameters

opContext—Operational context

Return Value

Preferences

getUserCredentialsForNetworkElementGroups

Gets the list of user credentials for the specified network element groups.

Parameters

opContext—Operational context

InstanceNameId—Application user

InstanceNameId—List of network element groups

Return Value

List of NetworkElementUserCredentials

getUserCredentialsForNetworkElements

Gets the list of user credentials for the specified network elements.

Parameters

opContext—Operational context

InstanceNameId—Application user

InstanceNameId—List of network elements

Return Value

List of NetworkElementUserCredentials

getUsers

Gets the list of user information for the specified application users.

Parameters

opContext—Operational context

InstanceNameId—List of application users

Return Value

List of ApplicationUser

modifyDefaultNetworkElementUserCredentials

Modifies the default user credentials to the value supplied.

Parameters

opContext—Operational context

NetworkElementUserCredentials—User credentials

Return Value

NetworkElementUserCredentials

modifyPreferences

Modifies the preferences for the user invoking the API.

Parameters

opContext—Operational context

Preferences—User preferences

Return Value

Preferences

modifyUserCredentialsForNetworkElementGroups

Modifies the credentials for the specified user and the network element groups.

Parameters

opContext—Operational context

InstanceNameId—User to modify

InstanceNameId—List of network element groups to modify

NetworkElementUserCredentials—User credentials

Return Value

void

modifyUserCredentialsForNetworkElements

Modifies the credentials for the specified user and the network elements.

Parameters

opContext—Operational context

InstanceNameId—User to modify

InstanceNameId—List of network elements to modify

NetworkElementUserCredentials—User credentials

Return Value

void

modifyUsers

Modifies the list of specified application users.

Parameters

opContext—Operational context

ApplicationUser—List of users

Return Value

void

unbindUserFromAllNetworkElements

Unbinds the specified user from all network elements.

Parameters

opContext—Operational context

InstanceNameId—User to unbind

Return Value

void

unbindUserFromAllNetworkGroups

Unbinds the specified user from all network groups.

Parameters

opContext—Operational context

InstanceNameId—User to unbind

Return Value

void

unbindUserFromNetworkElements

Unbinds the specified user from all network elements.

Parameters

opContext—Operational context

InstanceNameId—User to unbind

InstanceNameId—List of network elements

Return Value

void

unbindUserFromNetworkGroups

Unbinds the specified user from all network groups.

Parameters

opContext—Operational context

InstanceNameId—User to unbind

InstanceNameId—List of network groups

Return Value

void