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

ServerAdminApp Service

Table Of Contents

ServerAdminApp Service

Information About ServerAdminApp Service

getAuthenticationSettings

getCurrentAuthenticationSettings

modifyAuthenticationSettings

getServerSetting

getServerStatus

modifyServerSetting

validateDcmAuthenticationServer


ServerAdminApp Service


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

Information About ServerAdminApp Service

This chapter defines the APIs exposed by the Server Administration service feature.

getAuthenticationSettings

Returns the persisted AuthenticationSettings. This method is available for Cisco Nexus 7000 Series switches that run Cisco NX-OS Release 5.0(3) or later.

Parameters

opContext—Operational context

Return Value

Perisisted authentication settings.

getCurrentAuthenticationSettings

Returns the AuthenticationSettings from memory. This method is available for Cisco Nexus 7000 Series switches that run Cisco NX-OS Release 5.0(3) or later.

Parameters

opContext—Operational context

Return Value

AuthenticationSettings from memory.

modifyAuthenticationSettings

Modifies the persisted AuthenticationSetting. This method is available for Cisco Nexus 7000 Series switches that run Cisco NX-OS Release 5.0(3) or later.

Parameters

opContext—Operational context

setting—Modified Authentication Settings

Return Value

void.

getServerSetting

Gets the setting of the DCNM server. This method is available for Cisco Nexus 7000 Series switches that run Cisco NX-OS Release 5.0(3) or later.

Parameters

opContext—Operational context

Return Value

ServerSetting

getServerStatus

Gets the status of the DCNM server. This method is available for Cisco Nexus 7000 Series switches that run Cisco NX-OS Release 4.0 or later.

Parameters

opContext—Operational context

Return Value

ServerStatus

modifyServerSetting

Modifies the DCNM server setting. This method is available for Cisco Nexus 7000 Series switches that run Cisco NX-OS Release 4.0 or later.

Parameters

opContext—Operational context

ServerSetting—server setting

Return Value

ServerSetting

validateDcmAuthenticationServer

Verifies the dcmAuthServer with the userName and password. This method is available for Cisco Nexus 7000 Series switches that run Cisco NX-OS Release 4.0 or later.

Throws ParameterException when serverType is of ApplicationUserLoginType.LOCAL

Parameters

opContext—Operational context.

dcmAuthServer—DcmAuthServer to verify

userName—Username to use for verification

password—Password to use for Verification

Return Value

The result of the authentication procoess of the DcmAuthServer.