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

ServerApp Service

Table Of Contents

ServerApp Service

Information About ServerApp Service

bindComputerSystems

createComputerSystems

createComputerSystemRanges

createComputerSystemsWithCredentials

deleteComputerSystems

deleteComputerSystemRanges

getAllComputerSystems

getAllComputerSystemRanges

getComputerSystemsForGivenMac

getComputerSystemsForGivenNameOrIp

getAllComputerSystemsInstanceNameIds

getAllUncorrelatedComputerSystems

getAllUncorrelatedComputerSystemsInstanceNameIds

getAllVirtualComputerSystems

getComputerSystemNeighbors

getComputerSystemNeighborsWithLinks

getDefaultComputerSystemCredentials

getUpstreamSwitches

getUserCredentialsForComputerSystems

modifyComputerSystemRanges

modifyDefaultComputerSystemCredentials

modifyUserCredentialsForComputerSystems

performComputerSystemCorrelation

unbindComputerSystems


ServerApp Service


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

Information About ServerApp Service

This interface defines all the APIs exposed by the ServerApp.

bindComputerSystems

Binds the List of NetworkInterfaces corresponding to the List of InstanceNameId to their corresponding server names.

Parameters

opContext—Operational context.

niInstanceNameId—List of InstanceNameIds of NetworkInterfaces.

csNameList—List of String of Server Name which needs to be bound to the given List of NetworkInterfaces.

Return Value

void

createComputerSystems

Creates a list of abstract computer systems corresponding to the given IP address or host name.

Parameters

opContext—OpContext

neCol—List of identifiers corresponding to the abstract computer systems to be added.

Return Value

List of AbstractComputerSystem.

createComputerSystemRanges

Creates the computer system ranges.

Parameters

opContext—Operational context.

computerSystemRangeCol - the computer system range col.

Return Value

void

createComputerSystemsWithCredentials

Creates the computer systems with credentials.

Parameters

opContext—Operational context.

neCol - the ne column.

credentials - Computer system credentials

Return Value

void

deleteComputerSystems

Deletes the AbstractComputerSystems whose InstanceNameIds are passed.

Parameters

opContext—Operational context.

Return Value

void.

deleteComputerSystemRanges

Delete computer system ranges.

Parameters

opContext—Operational context.

computerSystemRangeCol - the computer system range col

Return Value

void.

getAllComputerSystems

Returns the list of AbstractComputerSystems corresponding to the list of the InstanceNameIds.

Parameters

opContext—Operational context

acsInstanceNameIdList—List of instanceIDs corresponding to the AbstractComputerSystems that needs to be fetched.

Return Value

List of AbstractComputerSystems. The returned list will have the following associations.

AbstractComputerSystemStatus corresponding to AbstractComputerSystem.

List ofNetworkInterface associated with AbstractComputerSystem.

getAllComputerSystemRanges

Gets the all computer system ranges.

Parameters

opContext—Operational context

Return Value

List of computer system ranges.

getComputerSystemsForGivenMac

Returns List of AbstractComputerSystem corresponding to the givenList of Mac Addresses.

Parameters

opContext—Operational context

macList - List of strings corresponding to the Mac Addresses of the ports in the Servers that need to be fetched.

Return Value

List of AbstractComputerSystems. The returned list will have the following associations.

AbstractComputerSystemStatus corresponding to AbstractComputerSystem.

List ofNetworkInterface associated with AbstractComputerSystem.

getComputerSystemsForGivenNameOrIp

Returns List of AbstractComputerSystem corresponding to the givenList of Names or IP Addresses

Parameters

opContext—Operational context

nameOrIpList - List of strings corresponding to the Names or IP Addresses of the Servers that need to be fetched.

exactMatch - If this is set to true then we will return the server which exactly matches with the Name/IP Address passed. If this is false, then any server whose Name or IP Address matches the string passed in the nameOrIpList will be returned. This facility is provided for supporting regex matches.

Return Value

List of AbstractComputerSystems. The returned list will have the following associations.

AbstractComputerSystemStatus corresponding to AbstractComputerSystem.

List ofNetworkInterface associated with AbstractComputerSystem.

getAllComputerSystemsInstanceNameIds

Returns List of InstanceNameId of AbstractComputerSystems in the network.

Parameters

opContext—Operational context

Return Value

List of InstanceNameIds of AbstractComputerSystem.

getAllUncorrelatedComputerSystems

Returns List of AbstractComputerSystems in the network which were discovered as part of the FC Discovery and which corresponds to the List of InstanceNameIds.

Parameters

opContext—Operational context

acsInstanceNameIdList—List of InstanceNameIds corresponding to the AbstractComputerSystems that need to be fetched.

Return Value

List of AbstractComputerSystem.

getAllUncorrelatedComputerSystemsInstanceNameIds

Returns Listof InstanceNameIds of AbstractComputerSystems in the network which were discovered as part of the FC Discovery.

Parameters

opContext—Operational context

Return Value

List of InstanceNameIds of AbstractComputerSystem.

getAllVirtualComputerSystems

Returns List of VirtualComputerSystems corresponding to the given list of InstanceNameIds.

Parameters

opContext—Operational context

vcsInstanceNameIdList—List of InstanceNameId corresponding to the VirtualComputerSystems that need to be fetched.

Return Value

List of VirtualComputerSystem. The returned collection will have the following associations.

AbstractComputerSystemStatus corresponding to VirtualComputerSystem

List ofNetworkInterface associated with VirtualComputerSystem.

getComputerSystemNeighbors

Returns List of AbstractComputerSystem.

ValidationException is thrown if any of the following situation occurs:

argument passed is null

neInstanceNameIds is not a valid InstanceNameId of a AbstractNetworkElement.

Parameters

opContext—Operational context

neInstanceNameIds—tInstance name ID of network elements.

Return Value

List of AbstractComputerSystem. The returned collection will have the following associations.

AbstractComputerSystemStatus corresponding to AbstractComputerSystem

ComputerSystemChassis corresponding to ComputerSystem

List ofNetworkInterface associated with AbstractComputerSystem

List ofVirtualComputerSystem associated with ComputerSystem which are of type EndDeviceType JBOD

getComputerSystemNeighborsWithLinks

Returns List of AbstractComputerSystem.

ValidationException is thrown if any of the following situation occurs:

argument passed is null

neInstanceNameIds is not a valid InstanceNameId of a AbstractNetworkElement.

Parameters

opContext—Operational context

neInstanceNameIds—the network element instance name ids .

Return Value

List of AbstractComputerSystem. The returned collection will have the following associations.

AbstractComputerSystemStatus corresponding to AbstractComputerSystem

ComputerSystemChassis corresponding to ComputerSystem

List ofNetworkInterface associated with AbstractComputerSystem

List ofVirtualComputerSystem associated with ComputerSystem which are of type EndDeviceType JBOD

getDefaultComputerSystemCredentials

Returns a list of ComputerSystemCredentials with links.

ValidationException is thrown if any of the following situation occurs:

argument passed is null

neInstanceNameIds is not a valid InstanceNameId of a AbstractNetworkElement.

Parameters

opContext—Operational context

neInstanceNameIds—the network element instance name ids .

Return Value

List of AbstractComputerSystem. The returned collection will have the following associations.

AbstractComputerSystemStatus corresponding to AbstractComputerSystem

ComputerSystemChassis corresponding to ComputerSystem

List ofNetworkInterface associated with AbstractComputerSystem

List ofVirtualComputerSystem associated with ComputerSystem which are of type EndDeviceType JBOD

getUpstreamSwitches

Returns List of AbstractNetworkElement.

ValidationException is thrown if any of the following situation occurs:

argument passed is null

neInstanceNameIds is not a valid InstanceNameId of a AbstractNetworkElement.

Parameters

opContext—Operational context

acsInstanceNameIds—InstanceNameId of a AbstractComputerSystem .

Return Value

List of AbstractNetworkElement only with its hostName and mgmtIpAddress populated.

getUserCredentialsForComputerSystems

Sets the given credentials as the default computer system credentials of current application user.

Parameters

opContext—operational context.

cred—ComputerSystemCredentials object that is used as default credential.

Return Value

void.

modifyComputerSystemRanges

Modify computer system ranges.

Parameters

opContext—operational context.

omputerSystemRangeCol - the computer system range col.

Return Value

Void.

modifyDefaultComputerSystemCredentials

Sets the given credentials as the default computer system credentials of current application user..

Parameters

opContext—operational context.

cred—ComputerSystemCredentials object that is used as default credential.

Return Value

Void.

modifyUserCredentialsForComputerSystems

Modifies the credentials of application user for one or more abstract computer system objects.

Parameters

opContext—operational context.

appUserInstanceNameId—InstanceNameId of a ApplicationUser object.

acsInstanceNameIdCol—a collection that contains one or more InstanceNameIds of AbstractComputerSystem object.

cred—ComputerSystemCredentials object that should be used for validating the application user in the given computer system.

Return Value

Void.

performComputerSystemCorrelation

Performs the Computer System correlation and maps the Adapters to respective Computer Systems.

Parameters

opContext—Operational context

acsInstanceNameIdList—List of InstanceNameIds of AbstractComputerSystems on which automatic correlation needs to be performed.

Return Value

void.

unbindComputerSystems

This unbinds the server name from List of NetworkInterface corresponding to the list of InstanceNameIds.

Parameters

opContext—Operational context

niInstanceNameId—List of InstanceNameIds of NetworkInterfaces.

Return Value

void.