com.hp.ov.sdk.rest.client

Class ServerHardwareClientImpl

java.lang.Object

com.hp.ov.sdk.rest.client.ServerHardwareClientImpl

All Implemented Interfaces:

ServerHardwareClient

public class ServerHardwareClientImpl
extends Object
implements ServerHardwareClient

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ServerHardwareClientImpl(HttpRestClient restClient, ResourceAdaptor adaptor, TaskMonitorManager taskMonitor)

Method Summary

Modifier and Type	Method and Description
TaskResourceV2	createServerHardware(RestParams params, AddServer addServerDto, boolean aSync) This module aids in adding a rack-mount server for management by the appliance.
TaskResourceV2	deleteServerHardware(RestParams params, String resourceId, boolean aSync) The module aids in deleting a server hardware for the specified server hardware resource identifier.
ServerHardwareCollection	getAllServerHardware(RestParams params) The module aids in fetching the server hardware details for all the server hardware found under the current HPE OneView.
static ServerHardwareClient	getClient()
String	getId(RestParams params, String name) The module aids in fetching the server hardware resource identifier for the server hardware name as specified in HPE OneView.
ServerHardware	getServerHardware(RestParams params, String resourceId) The module aids in fetching the server hardware details for the specified server hardware resource identifier.
BiosSettings	getServerHardwareBios(RestParams params, String resourceId) This module aids in fetching the list of BIOS/UEFI values currently set on the physical server.
ServerHardware	getServerHardwareByName(RestParams params, String destinationBay) The module aids in fetching the server hardware details for the server hardware name as specified in HPE OneView.
EnvironmentalConfiguration	getServerHardwareEnvironmentConfiguration(RestParams params, String resourceId) This module aids in fetching the settings that describe the environmental configuration (supported feature set, calibrated minimum and maximum power, location and dimensions, ...) of the server hardware resource.
IloSsoUrlResult	getServerHardwareIloSsoUrl(RestParams params, String resourceId) This module fetches the URL to launch a Single Sign-On (SSO) session for the iLO web interface
JavaRemoteConsoleUrlResult	getServerHardwareJavaRemoteConsoleUrl(RestParams params, String resourceId) This module aids in generating a Single Sign-On (SSO) session for the iLO Java Applet console and returns the URL to launch it.
RemoteConsoleUrlResult	getServerHardwareRemoteConsoleUrl(RestParams params, String resourceId) Generates a Single Sign-On (SSO) session for the iLO Integrated Remote Console Application (IRC) and returns the URL to launch it.
UtilizationData	getServerHardwareUtilization(RestParams params, String resourceId) This module aids in retrieving historical utilization data for the specified resource, metrics, and time span.
EnvironmentalConfiguration	updateServerHardwareEnvironmentConfiguration(RestParams params, String resourceId, EnvironmentalConfigurationUpdate environmentalConfigurationUpdate) This module aids in updating/setting the calibrated max power of an unmanaged or unsupported server hardware resource.
TaskResourceV2	updateServerHardwareMpFirmwareVersion(RestParams params, String resourceId, boolean aSync) Updates the iLO firmware on a physical server to a minimum iLO firmware version required by HPE OneView to manage the server.
TaskResourceV2	updateServerHardwarePowerState(RestParams params, String resourceId, ServerPowerControlRequest serverPowerControlRequestDto, boolean aSync) Requests a power operation to change the power state of the physical server.
TaskResourceV2	updateServerHardwareRefreshState(RestParams params, String resourceId, RefreshStateRequest refreshStateRequest, boolean aSync) Refreshes the server hardware to fix configuration issues.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ServerHardwareClientImpl

protected ServerHardwareClientImpl(HttpRestClient restClient,
                                   ResourceAdaptor adaptor,
                                   TaskMonitorManager taskMonitor)

Method Detail

getClient

public static ServerHardwareClient getClient()

getServerHardware

public ServerHardware getServerHardware(RestParams params,
                                        String resourceId)

Description copied from interface: ServerHardwareClient

The module aids in fetching the server hardware details for the specified server hardware resource identifier.

Specified by:

getServerHardware in interface ServerHardwareClient

Parameters:

params - The RestParams is a structure containing the connection details.

resourceId - The resource identifier for server hardware as seen in HPE OneView.

Returns:

ServerHardware containing the server hardware details.

getServerHardwareByName

public ServerHardware getServerHardwareByName(RestParams params,
                                              String destinationBay)

Description copied from interface: ServerHardwareClient

The module aids in fetching the server hardware details for the server hardware name as specified in HPE OneView.

Specified by:

getServerHardwareByName in interface ServerHardwareClient

Parameters:

params - The RestParams is a structure containing the connection details.

destinationBay - The destinationBay is the server hardware name as seen in HPE OneView.

Returns:

ServerHardware containing the server hardware details.

getAllServerHardware

public ServerHardwareCollection getAllServerHardware(RestParams params)

Description copied from interface: ServerHardwareClient

The module aids in fetching the server hardware details for all the server hardware found under the current HPE OneView.

Specified by:

getAllServerHardware in interface ServerHardwareClient

Parameters:

params - The RestParams is a structure containing the connection details.

Returns:

ServerHardwareCollection containing a collection of server hardware details.

createServerHardware

public TaskResourceV2 createServerHardware(RestParams params,
                                           AddServer addServerDto,
                                           boolean aSync)

Description copied from interface: ServerHardwareClient

This module aids in adding a rack-mount server for management by the appliance.

Specified by:

createServerHardware in interface ServerHardwareClient

Parameters:

params - The RestParams is a structure containing the connection details.

addServerDto - Details of the server hardware.

aSync - Flag input to process request asynchronously or synchronously.

Returns:

TaskResourceV2 which returns the task status for the process.

deleteServerHardware

public TaskResourceV2 deleteServerHardware(RestParams params,
                                           String resourceId,
                                           boolean aSync)

Description copied from interface: ServerHardwareClient

The module aids in deleting a server hardware for the specified server hardware resource identifier.

Specified by:

deleteServerHardware in interface ServerHardwareClient

Parameters:

params - The RestParams is a structure containing the connection details.

resourceId - The resource identifier for server hardware as seen in HPE OneView.

aSync - Flag input to process request asynchronously or synchronously.

Returns:

TaskResourceV2 which returns the task status for the process.

getServerHardwareBios

public BiosSettings getServerHardwareBios(RestParams params,
                                          String resourceId)

Description copied from interface: ServerHardwareClient

This module aids in fetching the list of BIOS/UEFI values currently set on the physical server.

Specified by:

getServerHardwareBios in interface ServerHardwareClient

Parameters:

params - The RestParams is a structure containing the connection details.

resourceId - The resource identifier for server hardware as seen in HPE OneView.

Returns:

BiosSettings containing the collection of bios settings state details.

getServerHardwareEnvironmentConfiguration

public EnvironmentalConfiguration getServerHardwareEnvironmentConfiguration(RestParams params,
                                                                            String resourceId)

Description copied from interface: ServerHardwareClient

This module aids in fetching the settings that describe the environmental configuration (supported feature set, calibrated minimum and maximum power, location and dimensions, ...) of the server hardware resource.

Specified by:

getServerHardwareEnvironmentConfiguration in interface ServerHardwareClient

Parameters:

params - The RestParams is a structure containing the connection details.

resourceId - The resource identifier for server hardware as seen in HPE OneView.

Returns:

EnvironmentalConfiguration containing the environmental configuration details.

updateServerHardwareEnvironmentConfiguration

public EnvironmentalConfiguration updateServerHardwareEnvironmentConfiguration(RestParams params,
                                                                               String resourceId,
                                                                               EnvironmentalConfigurationUpdate environmentalConfigurationUpdate)

Description copied from interface: ServerHardwareClient

This module aids in updating/setting the calibrated max power of an unmanaged or unsupported server hardware resource.

Specified by:

updateServerHardwareEnvironmentConfiguration in interface ServerHardwareClient

Parameters:

params - The RestParams is a structure containing the connection details.

resourceId - The resource identifier for server hardware as seen in HPE OneView.

environmentalConfigurationUpdate - Details of the environmental configuration.

Returns:

EnvironmentalConfiguration containing the environmental configuration details.

getServerHardwareIloSsoUrl

public IloSsoUrlResult getServerHardwareIloSsoUrl(RestParams params,
                                                  String resourceId)

Description copied from interface: ServerHardwareClient

This module fetches the URL to launch a Single Sign-On (SSO) session for the iLO web interface

Specified by:

getServerHardwareIloSsoUrl in interface ServerHardwareClient

Parameters:

params - The RestParams is a structure containing the connection details.

resourceId - The resource identifier for server hardware as seen in HPE OneView.

Returns:

IloSsoUrlResult containing the iLO SSO URL details.

getServerHardwareJavaRemoteConsoleUrl

public JavaRemoteConsoleUrlResult getServerHardwareJavaRemoteConsoleUrl(RestParams params,
                                                                        String resourceId)

Description copied from interface: ServerHardwareClient

This module aids in generating a Single Sign-On (SSO) session for the iLO Java Applet console and returns the URL to launch it. If the server hardware is unmanaged or unsupported, the resulting URL will not use SSO and the iLO Java Applet will prompt for credentials.

Note: this is not supported on G7/iLO3 or earlier servers.

Specified by:

getServerHardwareJavaRemoteConsoleUrl in interface ServerHardwareClient

Parameters:

params - The RestParams is a structure containing the connection details.

resourceId - The resource identifier for server hardware as seen in HPE OneView.

Returns:

JavaRemoteConsoleUrlResult containing the Java remote console URL details.

updateServerHardwareMpFirmwareVersion

public TaskResourceV2 updateServerHardwareMpFirmwareVersion(RestParams params,
                                                            String resourceId,
                                                            boolean aSync)

Description copied from interface: ServerHardwareClient

Updates the iLO firmware on a physical server to a minimum iLO firmware version required by HPE OneView to manage the server.

Specified by:

updateServerHardwareMpFirmwareVersion in interface ServerHardwareClient

Parameters:

params - The RestParams is a structure containing the connection details.

resourceId - The resource identifier for server hardware as seen in HPE OneView.

aSync - Flag input to process request asynchronously or synchronously.

Returns:

TaskResourceV2 which returns the task status for the process.

updateServerHardwarePowerState

public TaskResourceV2 updateServerHardwarePowerState(RestParams params,
                                                     String resourceId,
                                                     ServerPowerControlRequest serverPowerControlRequestDto,
                                                     boolean aSync)

Description copied from interface: ServerHardwareClient

Requests a power operation to change the power state of the physical server.

Specified by:

updateServerHardwarePowerState in interface ServerHardwareClient

Parameters:

params - The RestParams is a structure containing the connection details.

resourceId - The resource identifier for server hardware as seen in HPE OneView.

serverPowerControlRequestDto - This is a object containing the ServerPowerControlRequest details.

aSync - Flag input to process request asynchronously or synchronously.

Returns:

TaskResourceV2 which returns the task status for the process.

updateServerHardwareRefreshState

public TaskResourceV2 updateServerHardwareRefreshState(RestParams params,
                                                       String resourceId,
                                                       RefreshStateRequest refreshStateRequest,
                                                       boolean aSync)

Description copied from interface: ServerHardwareClient

Refreshes the server hardware to fix configuration issues.

Specified by:

updateServerHardwareRefreshState in interface ServerHardwareClient

Parameters:

params - The RestParams is a structure containing the connection details.

resourceId - The resource identifier for server hardware as seen in HPE OneView.

refreshStateRequest - This is a object containing the refresh state request details.

aSync - Flag input to process request asynchronously or synchronously.

Returns:

TaskResourceV2 which returns the task status for the process.

getServerHardwareRemoteConsoleUrl

public RemoteConsoleUrlResult getServerHardwareRemoteConsoleUrl(RestParams params,
                                                                String resourceId)

Description copied from interface: ServerHardwareClient

Generates a Single Sign-On (SSO) session for the iLO Integrated Remote Console Application (IRC) and returns the URL to launch it. If the server hardware is unmanaged or unsupported, the resulting URL will not use SSO and the IRC application will prompt for credentials. Use of this URL requires a previous installation of the iLO IRC and is supported only on Windows client.

Specified by:

getServerHardwareRemoteConsoleUrl in interface ServerHardwareClient

Parameters:

params - The RestParams is a structure containing the connection details.

resourceId - The resource identifier for server hardware as seen in HPE OneView.

Returns:

RemoteConsoleUrlResult containing the remote console URL details.

getServerHardwareUtilization

public UtilizationData getServerHardwareUtilization(RestParams params,
                                                    String resourceId)

Description copied from interface: ServerHardwareClient

This module aids in retrieving historical utilization data for the specified resource, metrics, and time span. Filters are not supported yet.

Specified by:

getServerHardwareUtilization in interface ServerHardwareClient

Parameters:

params - The RestParams is a structure containing the connection details.

resourceId - The resource identifier for server hardware as seen in HPE OneView.

Returns:

UtilizationData containing the utilization data details.

getId

public String getId(RestParams params,
                    String name)

Description copied from interface: ServerHardwareClient

The module aids in fetching the server hardware resource identifier for the server hardware name as specified in HPE OneView.

Specified by:

getId in interface ServerHardwareClient

Parameters:

params - The RestParams is a structure containing the connection details.

name - The resourceName is the server hardware name as seen in HPE OneView.

Returns:

String which is the resource Id for the ServerHardware name as seen in HPE OneView.