com.hp.ov.sdk.rest.client.server

Interface ServerHardwareClient

All Superinterfaces:

AddableResource<AddServer>, PatchableResource, RemovableResource, RetrievableResource<ServerHardware>, SearchableResource<ServerHardware>

public interface ServerHardwareClient
extends AddableResource<AddServer>, SearchableResource<ServerHardware>, RemovableResource, PatchableResource

Nested Class Summary

Nested classes/interfaces inherited from interface com.hp.ov.sdk.rest.client.common.SearchableResource

SearchableResource.GetByNameRequestInterceptor

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENVIRONMENT_CONFIGURATION_URI
static String	POWER_STATE_URI
static String	SERVER_HARDWARE_BIOS_URI
static String	SERVER_HARDWARE_FIRMWARE
static String	SERVER_HARDWARE_FIRMWARE_URI
static String	SERVER_HARDWARE_ILO_SSO_URI
static String	SERVER_HARDWARE_JAVA_REMOTE_CONSOLE_URI
static String	SERVER_HARDWARE_MP_FIRMWARE_URI
static String	SERVER_HARDWARE_REFRESH_STATE_URI
static String	SERVER_HARDWARE_REMOTE_CONSOLE_URI
static String	SERVER_HARDWARE_URI
static String	SERVER_HARDWARE_UTILIZATION_URI

Method Summary

Modifier and Type	Method and Description
BiosSettings	getBios(String resourceId) Retrieves the list of BIOS/UEFI values currently set on the physical server.
EnvironmentalConfiguration	getEnvironmentConfiguration(String resourceId) Retrieves the settings that describe the environmental configuration (supported feature set, calibrated minimum and maximum power, location, and dimensions, ...) of the server hardware resource.
IloSsoUrlResult	getIloSsoUrl(String resourceId) Retrieves the URL to launch a Single Sign-On (SSO) session for the iLO web interface.
JavaRemoteConsoleUrlResult	getJavaRemoteConsoleUrl(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	getRemoteConsoleUrl(String resourceId) Generates a Single Sign-On (SSO) session for the iLO Integrated Remote Console Application (IRC) and returns the URL to launch it.
ServerFirmwareInventory	getServerFirmwareInventory(String resourceId) Retrieves the ServerFirmwareInventory details for the specified server hardware.
ResourceCollection<ServerFirmwareInventory>	getServerFirmwareInventoryByFilter(FirmwareInventoryFilter filter) Retrieves the ServerFirmwareInventory details for the specified server hardware.
UtilizationData	getUtilization(String resourceId) Retrieves the UtilizationData details for the specified server hardware.
EnvironmentalConfiguration	updateEnvironmentConfiguration(String resourceId, EnvironmentalConfigurationUpdate environmentalConfigurationUpdate) Updates the calibrated max power of an unmanaged or unsupported server hardware resource.
TaskResource	updateMpFirmwareVersion(String resourceId, RequestOption... options) Updates the iLO firmware on a physical server to a minimum iLO firmware version required by HPE OneView to manage the server.
TaskResource	updatePowerState(String resourceId, ServerPowerControlRequest serverPowerControlRequest, RequestOption... options) Requests a power operation to change the power state of the physical server.
TaskResource	updateRefreshState(String resourceId, RefreshStateRequest refreshStateRequest, RequestOption... options) Refreshes the server hardware to fix configuration issues.

Methods inherited from interface com.hp.ov.sdk.rest.client.common.AddableResource

add

Methods inherited from interface com.hp.ov.sdk.rest.client.common.SearchableResource

getByName

Methods inherited from interface com.hp.ov.sdk.rest.client.common.RetrievableResource

get, get, getAll, getAll, getById

Methods inherited from interface com.hp.ov.sdk.rest.client.common.RemovableResource

remove

Methods inherited from interface com.hp.ov.sdk.rest.client.common.PatchableResource

patch

Field Detail

SERVER_HARDWARE_URI

static final String SERVER_HARDWARE_URI

See Also:

Constant Field Values

SERVER_HARDWARE_REFRESH_STATE_URI

static final String SERVER_HARDWARE_REFRESH_STATE_URI

See Also:

Constant Field Values

SERVER_HARDWARE_FIRMWARE_URI

static final String SERVER_HARDWARE_FIRMWARE_URI

See Also:

Constant Field Values

SERVER_HARDWARE_FIRMWARE

static final String SERVER_HARDWARE_FIRMWARE

See Also:

Constant Field Values

POWER_STATE_URI

static final String POWER_STATE_URI

See Also:

Constant Field Values

SERVER_HARDWARE_BIOS_URI

static final String SERVER_HARDWARE_BIOS_URI

See Also:

Constant Field Values

ENVIRONMENT_CONFIGURATION_URI

static final String ENVIRONMENT_CONFIGURATION_URI

See Also:

Constant Field Values

SERVER_HARDWARE_MP_FIRMWARE_URI

static final String SERVER_HARDWARE_MP_FIRMWARE_URI

See Also:

Constant Field Values

SERVER_HARDWARE_ILO_SSO_URI

static final String SERVER_HARDWARE_ILO_SSO_URI

See Also:

Constant Field Values

SERVER_HARDWARE_JAVA_REMOTE_CONSOLE_URI

static final String SERVER_HARDWARE_JAVA_REMOTE_CONSOLE_URI

See Also:

Constant Field Values

SERVER_HARDWARE_REMOTE_CONSOLE_URI

static final String SERVER_HARDWARE_REMOTE_CONSOLE_URI

See Also:

Constant Field Values

SERVER_HARDWARE_UTILIZATION_URI

static final String SERVER_HARDWARE_UTILIZATION_URI

See Also:

Constant Field Values

Method Detail

updatePowerState

TaskResource updatePowerState(String resourceId,
                              ServerPowerControlRequest serverPowerControlRequest,
                              RequestOption... options)

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

Parameters:

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

serverPowerControlRequest - object containing the ServerPowerControlRequest details.

options - varargs of RequestOption, which can be used to specify some request options.

Returns:

TaskResource which returns the task status for the process.

updateRefreshState

TaskResource updateRefreshState(String resourceId,
                                RefreshStateRequest refreshStateRequest,
                                RequestOption... options)

Refreshes the server hardware to fix configuration issues.

Parameters:

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

refreshStateRequest - object containing the refresh state request details.

options - varargs of RequestOption, which can be used to specify some request options.

Returns:

TaskResource which returns the task status for the process.

getBios

BiosSettings getBios(String resourceId)

Retrieves the list of BIOS/UEFI values currently set on the physical server.

Parameters:

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

Returns:

BiosSettings containing the collection of bios settings state details.

getEnvironmentConfiguration

EnvironmentalConfiguration getEnvironmentConfiguration(String resourceId)

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

Parameters:

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

Returns:

EnvironmentalConfiguration containing the environmental configuration details.

updateEnvironmentConfiguration

EnvironmentalConfiguration updateEnvironmentConfiguration(String resourceId,
                                                          EnvironmentalConfigurationUpdate environmentalConfigurationUpdate)

Updates the calibrated max power of an unmanaged or unsupported server hardware resource.

Parameters:

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

environmentalConfigurationUpdate - details of the environmental configuration.

Returns:

EnvironmentalConfiguration containing the environmental configuration details.

updateMpFirmwareVersion

TaskResource updateMpFirmwareVersion(String resourceId,
                                     RequestOption... options)

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

Parameters:

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

options - varargs of RequestOption, which can be used to specify some request options.

Returns:

TaskResource which returns the task status for the process.

getIloSsoUrl

IloSsoUrlResult getIloSsoUrl(String resourceId)

Retrieves the URL to launch a Single Sign-On (SSO) session for the iLO web interface.

Parameters:

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

Returns:

IloSsoUrlResult containing the iLO SSO URL details.

getJavaRemoteConsoleUrl

JavaRemoteConsoleUrlResult getJavaRemoteConsoleUrl(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:

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

Returns:

JavaRemoteConsoleUrlResult containing the Java remote console URL details.

getRemoteConsoleUrl

RemoteConsoleUrlResult getRemoteConsoleUrl(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:

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

Returns:

RemoteConsoleUrlResult containing the remote console URL details.

getUtilization

UtilizationData getUtilization(String resourceId)

Retrieves the UtilizationData details for the specified server hardware.

Parameters:

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

Returns:

UtilizationData object containing the details.

getServerFirmwareInventoryByFilter

ResourceCollection<ServerFirmwareInventory> getServerFirmwareInventoryByFilter(FirmwareInventoryFilter filter)

Retrieves the ServerFirmwareInventory details for the specified server hardware.

Parameters:

filter - used specify some filters that will be applied to narrow the results.

Returns:

ResourceCollection<ServerFirmwareInventory> containing the details for all found server hardware.

getServerFirmwareInventory

ServerFirmwareInventory getServerFirmwareInventory(String resourceId)

Retrieves the ServerFirmwareInventory details for the specified server hardware.

Parameters:

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

Returns:

ServerFirmwareInventory object containing the details.