Web Services API Guide, Cisco DCNM for LAN, Release 5.x - ServerAdminApp Service [Cisco Prime Data Center Network Manager]

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.

	Web Services API Guide, Cisco DCNM for LAN, Release 5.x
	ServerAdminApp Service
Web Services API Guide, Cisco DCNM for LAN, Release 5.x Preface Overview AaaApp Service AclApp Service ClusterApp Service CollectorApp Service CollectorExtendedApp Service ConfigArchiveApp Service ConfigDeliveryApp Service ConfigTemplateApp Service DaiApp Service DataPurgingApp Service DeviceGroupApp Service DevicelistApp Service DhcpSnoopApp Service Dot1xApp Service EtherChanApp Service EventApp Service FabricPathResourcesApp Service FabricPathTopologyApp Service FcApp Service FCoEApp Service FeatureSetApp Service FexApp Service FiPSnoopingApp Service FireWallApp GlbpApp Service HsrpApp Service IgmpSnoopingApp Service ImageInstallApp Service InterfacesApp Services InventoryApp Service IpSourceGuardApp Service KeyChainApp Service L2IsisApp Service LicensingApp Service LogApp Service LstApp Service NacLpIpApp Service Object Group PathLatencyApp ObjTrackingApp Service PollerApp Service PortProfileApp PortSecApp Service PreprovisionApp RbacApp Service RepositoryApp Service SecurityApp Service ServerApp Service ServerAdminApp Service SoftwareApp Service SpanApp Service StpApp Service SVSConnectionApp Service SVSDomainApp Service SwitchProfileApp ThresholdAction Service TrafficStormControlApp Service TunnelApp Service UserApp Service VdcApp Service VlanApp Service VpcApp Service VrfApp Service	Download this chapter ServerAdminApp Service Download the complete book Cisco DCNM Web Services API Guide, Release 5.x (PDF - 3 MB) Feedback 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.
	Terms & Conditions \| Privacy Statement \| Cookie Policy \| Trademarks