com.hp.ov.sdk.rest.client

Interface ServerHardwareClient

All Known Implementing Classes:

ServerHardwareClientImpl

public interface ServerHardwareClient

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.
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 environmentalConfigurationUpdateDto) 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.

Method Detail

getServerHardware

ServerHardware getServerHardware(RestParams params,
                                 String resourceId)

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

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.

getAllServerHardware

ServerHardwareCollection getAllServerHardware(RestParams params)

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

Parameters:

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

Returns:

ServerHardwareCollection containing a collection of server hardware details.

getServerHardwareByName

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.

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.

updateServerHardwarePowerState

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

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

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

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

Refreshes the server hardware to fix configuration issues.

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.

createServerHardware

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

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

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

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

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

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

BiosSettings getServerHardwareBios(RestParams params,
                                   String resourceId)

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

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

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.

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

EnvironmentalConfiguration updateServerHardwareEnvironmentConfiguration(RestParams params,
                                                                        String resourceId,
                                                                        EnvironmentalConfigurationUpdate environmentalConfigurationUpdateDto)

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

Parameters:

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

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

environmentalConfigurationUpdateDto - Details of the environmental configuration.

Returns:

EnvironmentalConfiguration containing the environmental configuration details.

getServerHardwareIloSsoUrl

IloSsoUrlResult getServerHardwareIloSsoUrl(RestParams params,
                                           String resourceId)

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

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

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. 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.

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

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.

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.

getServerHardwareRemoteConsoleUrl

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. 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.

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

UtilizationData getServerHardwareUtilization(RestParams params,
                                             String resourceId)

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

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

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.

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.