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

Interface EnclosureClient

All Superinterfaces:

AddableResource<AddEnclosure>, PatchableResource, RemovableResource, RetrievableResource<Enclosure>, SearchableResource<Enclosure>, UpdatableResource<Enclosure>

public interface EnclosureClient
extends AddableResource<AddEnclosure>, SearchableResource<Enclosure>, UpdatableResource<Enclosure>, 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	ENCLOSURE_ACTIVE_OA_SSO_URI
static String	ENCLOSURE_COMPLIANCE_URI
static String	ENCLOSURE_CONFIGURATION_URI
static String	ENCLOSURE_FW_BASELINE_URI
static String	ENCLOSURE_OA_SSO_URI
static String	ENCLOSURE_REFRESH_STATE_URI
static String	ENCLOSURE_SCRIPT_URI
static String	ENCLOSURE_STANDBY_OA_SSO_URI
static String	ENCLOSURE_URI
static String	ENCLOSURE_UTILIZATION_URI
static String	ENVIRONMENT_CONFIGURATION_URI
static String	ROLE_ACTIVE
static String	ROLE_STANDBY

Method Summary

Modifier and Type	Method and Description
SsoUrlData	getActiveOaSsoUrl_V120(String resourceId) Retrieves data that can be used to construct a single sign-on URL for an onboard administrator.
SsoUrlData	getActiveOaSsoUrl(String resourceId) Retrieves data that can be used to construct a single sign-on URL for an onboard administrator.
String	getConfigurationScript(String resourceId) Retrieves the configuration script for the specified enclosure resource identifier.
EnvironmentalConfiguration	getEnvironmentalConfiguration(String resourceId) Retrieves the environmental configuration of the enclosure identified by the given enclosure identifier.
SsoUrlData	getStandbyOaSsoUrl_V120(String resourceId) Retrieves data that can be used to construct a single sign-on URL for an onboard administrator.
SsoUrlData	getStandbyOaSsoUrl(String resourceId) Retrieves data that can be used to construct a single sign-on URL for an onboard administrator.
UtilizationData	getUtilization(String resourceId) Retrieves historical utilization data for the specified enclosure.
TaskResource	updateCompliance(String resourceId, RequestOption... options) Updates the enclosure configuration with that of the enclosure group script.
TaskResource	updateConfiguration(String resourceId, RequestOption... options) Re-applies the enclosure configuration in the enclosure identified by the given resource identifier.
TaskResource	updateConfigurationScript(String resourceId, String scriptData, RequestOption... options) Updates the configuration script for the specified enclosure resource identifier.
EnvironmentalConfiguration	updateEnvironmentalConfiguration(String resourceId, EnvironmentalConfigurationUpdate updateEnvironmentalConfiguration) Updates the environmental configuration of the enclosure identified by the given enclosure identifier.
TaskResource	updateFwBaseline(String resourceId, FwBaselineConfig fwBaselineConfig, RequestOption... options) Applies the firmware baseline to the enclosure.
TaskResource	updateRefreshState(String resourceId, RefreshStateConfig refreshStateConfig, RequestOption... options) Refreshes the enclosure to fix any configuration issue.

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

update

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

ENCLOSURE_ACTIVE_OA_SSO_URI

static final String ENCLOSURE_ACTIVE_OA_SSO_URI

See Also:

Constant Field Values

ENCLOSURE_CONFIGURATION_URI

static final String ENCLOSURE_CONFIGURATION_URI

See Also:

Constant Field Values

ENCLOSURE_COMPLIANCE_URI

static final String ENCLOSURE_COMPLIANCE_URI

See Also:

Constant Field Values

ENCLOSURE_FW_BASELINE_URI

static final String ENCLOSURE_FW_BASELINE_URI

See Also:

Constant Field Values

ENCLOSURE_SCRIPT_URI

static final String ENCLOSURE_SCRIPT_URI

See Also:

Constant Field Values

ENCLOSURE_STANDBY_OA_SSO_URI

static final String ENCLOSURE_STANDBY_OA_SSO_URI

See Also:

Constant Field Values

ENCLOSURE_OA_SSO_URI

static final String ENCLOSURE_OA_SSO_URI

See Also:

Constant Field Values

ENCLOSURE_REFRESH_STATE_URI

static final String ENCLOSURE_REFRESH_STATE_URI

See Also:

Constant Field Values

ENCLOSURE_URI

static final String ENCLOSURE_URI

See Also:

Constant Field Values

ENCLOSURE_UTILIZATION_URI

static final String ENCLOSURE_UTILIZATION_URI

See Also:

Constant Field Values

ENVIRONMENT_CONFIGURATION_URI

static final String ENVIRONMENT_CONFIGURATION_URI

See Also:

Constant Field Values

ROLE_STANDBY

static final String ROLE_STANDBY

See Also:

Constant Field Values

ROLE_ACTIVE

static final String ROLE_ACTIVE

See Also:

Constant Field Values

Method Detail

updateConfiguration

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

Re-applies the enclosure configuration in the enclosure identified by the given resource identifier.

Parameters:

resourceId - enclosure resource identifier as seen in HPE OneView.

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

Returns:

TaskResource containing the task status for the process.

getConfigurationScript

String getConfigurationScript(String resourceId)

Retrieves the configuration script for the specified enclosure resource identifier.

Parameters:

resourceId - enclosure resource identifier as seen in HPE OneView.

Returns:

the configuration script for the specified enclosure.

updateConfigurationScript

TaskResource updateConfigurationScript(String resourceId,
                                       String scriptData,
                                       RequestOption... options)

Updates the configuration script for the specified enclosure resource identifier.

Parameters:

resourceId - enclosure resource identifier as seen in HPE OneView.

scriptData - script data to be updated for enclosure.

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

Returns:

TaskResource containing the task status for the process.

getActiveOaSsoUrl

SsoUrlData getActiveOaSsoUrl(String resourceId)

Retrieves data that can be used to construct a single sign-on URL for an onboard administrator.

Parameters:

resourceId - enclosure resource identifier as seen in HPE OneView.

Returns:

SsoUrlData the data used for single sign URL.

getActiveOaSsoUrl_V120

SsoUrlData getActiveOaSsoUrl_V120(String resourceId)

Retrieves data that can be used to construct a single sign-on URL for an onboard administrator. Available when using API version 120.

Parameters:

resourceId - enclosure resource identifier as seen in HPE OneView.

Returns:

SsoUrlData the data used for single sign URL.

getStandbyOaSsoUrl

SsoUrlData getStandbyOaSsoUrl(String resourceId)

Retrieves data that can be used to construct a single sign-on URL for an onboard administrator.

Parameters:

resourceId - enclosure resource identifier as seen in HPE OneView.

Returns:

SsoUrlData the data used for single sign URL.

getStandbyOaSsoUrl_V120

SsoUrlData getStandbyOaSsoUrl_V120(String resourceId)

Retrieves data that can be used to construct a single sign-on URL for an onboard administrator. Available when using API version 120.

Parameters:

resourceId - enclosure resource identifier as seen in HPE OneView.

Returns:

SsoUrlData the data used for single sign URL.

updateCompliance

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

Updates the enclosure configuration with that of the enclosure group script. This is not applicable if the enclosure is monitored.

Parameters:

resourceId - enclosure resource identifier as seen in HPE OneView.

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

Returns:

TaskResource containing the task status for the process.

updateFwBaseline

TaskResource updateFwBaseline(String resourceId,
                              FwBaselineConfig fwBaselineConfig,
                              RequestOption... options)

Applies the firmware baseline to the enclosure. This method can be used to update the OA firmware, or the OA, logical interconnect, and server profiles in the enclosure. This is not applicable if the enclosure is monitored.

Parameters:

resourceId - enclosure resource identifier as seen in HPE OneView.

fwBaselineConfig - the firmware baseline to be applied to the enclosure.

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

Returns:

TaskResource containing the task status for the process.

getUtilization

UtilizationData getUtilization(String resourceId)

Retrieves historical utilization data for the specified enclosure.

Parameters:

resourceId - enclosure resource identifier as seen in HPE OneView.

Returns:

UtilizationData containing resource data utilization such as power and cpu.

getEnvironmentalConfiguration

EnvironmentalConfiguration getEnvironmentalConfiguration(String resourceId)

Retrieves the environmental configuration of the enclosure identified by the given enclosure identifier.

Parameters:

resourceId - enclosure resource identifier as seen in HPE OneView.

Returns:

EnvironmentalConfiguration for the specified enclosure.

updateEnvironmentalConfiguration

EnvironmentalConfiguration updateEnvironmentalConfiguration(String resourceId,
                                                            EnvironmentalConfigurationUpdate updateEnvironmentalConfiguration)

Updates the environmental configuration of the enclosure identified by the given enclosure identifier.

Parameters:

resourceId - enclosure resource identifier as seen in HPE OneView.

updateEnvironmentalConfiguration - environmental configuration of enclosure resource specifying the cpu and power value.

Returns:

EnvironmentalConfiguration for the specified enclosure.

updateRefreshState

TaskResource updateRefreshState(String resourceId,
                                RefreshStateConfig refreshStateConfig,
                                RequestOption... options)

Refreshes the enclosure to fix any configuration issue.

Parameters:

resourceId - enclosure resource identifier as seen in HPE OneView.

refreshStateConfig - refresh state details to fix configuration issues.

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

Returns:

TaskResource containing the task status for the process.