com.hp.ov.sdk.rest.client

Interface EnclosureClient

All Known Implementing Classes:

EnclosureClientImpl

public interface EnclosureClient

Method Summary

Modifier and Type	Method and Description
TaskResourceV2	createEnclosure(RestParams params, AddEnclosureV2 addEnclosureDto, boolean aSync, boolean useJsonRequest) The module aids in the creation of an enclosure when provided with the enclosure details as an AddEnclosure object or JsonRequest.
TaskResourceV2	deleteEnclosure(RestParams params, String resourceId, boolean aSync) The module aids in deleting an enclosure for the specified enclosure resource identifier.
SsoUrlData	getActiveOaSsoUrl(RestParams params, String resourceId) This method aids in fetching data that can be used to construct a single sign-on URL for an Onboard Administrator.
EnclosureCollectionV2	getAllEnclosures(RestParams params) The module aids in fetching the enclosure details for all enclosures registered under the current HPE OneView.
Enclosures	getEnclosure(RestParams params, String resourceId) The module aids in fetching the enclosure details for the specified enclosure resource identifier.
Enclosures	getEnclosureByName(RestParams params, String name) The module aids in fetching the enclosure details for the specified enclosure name.
EnvironmentalConfiguration	getEnvironmentalConfiguration(RestParams param, String resourceId) This method aids in fetching the environmental configuration of the enclosure identified by the given enclosure identifier.
String	getId(RestParams params, String name) The module aids in fetching the enclosure resource identifier for the enclosure name as specified in HPE OneView.
String	getScript(RestParams params, String resourceId) The module aids in fetching the configuration script for the specified enclosure resource identifier.
SsoUrlData	getStandbyOaSsoUrl(RestParams params, String resourceId) This method aids in fetching data that can be used to construct a single sign-on URL for an onboard administrator.
UtilizationData	getUtilization(RestParams params, String resourceId) This method aids in retrieving historical utilization data for the specified enclosure.
TaskResourceV2	patchEnclosure(RestParams params, String resourceId, Patch patchDto, boolean aSync) The module takes in a Patch object or JsonRequest and updates the existing enclosure based on the resource identifier and the content of the Patch object.
TaskResourceV2	updateCompliance(RestParams params, String resourceId, boolean aSync) This method aids in updating the enclosure configuration with that of the enclosure group script.
TaskResourceV2	updateConfiguration(RestParams params, String resourceId, boolean aSync) This method aids in reapplying the enclosure configuration.
TaskResourceV2	updateEnclosure(RestParams params, String resourceId, Enclosures enclosureDto, boolean aSync, boolean useJsonRequest) The module takes in an enclosure object or JsonRequest and updates the existing enclosure based on the resource identifier.
TaskResourceV2	updateEnclosureFwBaseline(RestParams params, String resourceId, FwBaselineConfig fwBaselineConfigDto, boolean aSync) This method aids in applying the firmware baseline to the enclosure.
EnvironmentalConfiguration	updateEnvironmentalConfiguration(RestParams param, String resourceId, EnvironmentalConfigurationUpdate environmentalConfigurationUpdateDto) This method aids in updating the environmental configuration of the enclosure resource identifier.
TaskResourceV2	updateRefreshState(RestParams params, String resourceId, RefreshStateConfig refreshStateConfigDto, boolean aSync) This method aids in refreshing the enclosure to fix configuration issues.
TaskResourceV2	updateScript(RestParams params, String resourceId, String scriptData, boolean aSync, boolean useJsonRequest) The module aids in updating the configuration script for the specified enclosure resource identifier.

Method Detail

getEnclosure

Enclosures getEnclosure(RestParams params,
                        String resourceId)

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

Parameters:

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

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

Returns:

Enclosures containing the enclosure details.

getAllEnclosures

EnclosureCollectionV2 getAllEnclosures(RestParams params)

The module aids in fetching the enclosure details for all enclosures registered under the current HPE OneView.

Parameters:

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

Returns:

enclosureCollectionDto which is a object containing the collection of enclosure.

getEnclosureByName

Enclosures getEnclosureByName(RestParams params,
                              String name)

The module aids in fetching the enclosure details for the specified enclosure name.

Parameters:

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

name - The name is the enclosure name as seen in HPE.

Returns:

Enclosures containing the enclosure details.

createEnclosure

TaskResourceV2 createEnclosure(RestParams params,
                               AddEnclosureV2 addEnclosureDto,
                               boolean aSync,
                               boolean useJsonRequest)

The module aids in the creation of an enclosure when provided with the enclosure details as an AddEnclosure object or JsonRequest. It can process the request asynchronously or synchronously, based on the flag input.

Parameters:

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

addEnclosureDto - The enclosure information that should be created.

aSync - Flag input to process request asynchronously or synchronously.

useJsonRequest - The JsonRequest body is part of AddEnclosure object which takes in a String containing the new enclosure details, which is converted to AddEnclosure object using adaptor and processed.

Returns:

TaskResourceV2 containing the task status for the process.

updateEnclosure

TaskResourceV2 updateEnclosure(RestParams params,
                               String resourceId,
                               Enclosures enclosureDto,
                               boolean aSync,
                               boolean useJsonRequest)

The module takes in an enclosure object or JsonRequest and updates the existing enclosure based on the resource identifier. It can process the request asynchronously or synchronously, based on the flag input.

Parameters:

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

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

enclosureDto - This is a object containing the update to be made to existing enclosure pointed to by the above mentioned resource identifier.

aSync - Flag input to process request asynchronously or synchronously.

useJsonRequest - The JsonRequest body is part of Enclosures object which takes in a String containing the update to be made, which is converted to Enclosure object using adaptor and processed.

Returns:

TaskResourceV2 containing the task status for the process.

patchEnclosure

TaskResourceV2 patchEnclosure(RestParams params,
                              String resourceId,
                              Patch patchDto,
                              boolean aSync)

The module takes in a Patch object or JsonRequest and updates the existing enclosure based on the resource identifier and the content of the Patch object. It can process the request asynchronously or synchronously based on the flag input.

Parameters:

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

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

patchDto - This is a object containing the update to be made to existing enclosure pointed to by the above mentioned resource identifier.

aSync - Flag input to process request asynchronously or synchronously.

Returns:

TaskResourceV2 containing the task status for the process.

deleteEnclosure

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

The module aids in deleting an enclosure for the specified enclosure resource identifier. It can process the request asynchronously or synchronously, based on the flag input.

Parameters:

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

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

aSync - Flag input to process request asynchronously or synchronously.

Returns:

TaskResourceV2 containing the task status for the process.

getActiveOaSsoUrl

SsoUrlData getActiveOaSsoUrl(RestParams params,
                             String resourceId)

This method aids in fetching data that can be used to construct a single sign-on URL for an Onboard Administrator.

Parameters:

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

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

Returns:

SsoUrlData, gets the data used for single sign URL for onboard administrator.

updateCompliance

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

This method aids in updating the enclosure configuration with that of the enclosure group script. This is not applicable if the enclosure is monitored.

Parameters:

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

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

aSync - Flag input to process request asynchronously or synchronously.

Returns:

TaskResourceV2 containing the task status for the process.

updateConfiguration

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

This method aids in reapplying the enclosure configuration.

Parameters:

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

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

aSync - Flag input to process request asynchronously or synchronously.

Returns:

TaskResourceV2 containing the task status for the process.

updateEnclosureFwBaseline

TaskResourceV2 updateEnclosureFwBaseline(RestParams params,
                                         String resourceId,
                                         FwBaselineConfig fwBaselineConfigDto,
                                         boolean aSync)

This method aids in applying 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 enclosure is monitored.

Parameters:

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

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

fwBaselineConfigDto - fwBaselineConfig is the firmware baseline to be applied to the enclosure

aSync - Flag input to process request asynchronously or synchronously.

Returns:

TaskResourceV2 containing the task status for the process.

getEnvironmentalConfiguration

EnvironmentalConfiguration getEnvironmentalConfiguration(RestParams param,
                                                         String resourceId)

This method aids in fetching the environmental configuration of the enclosure identified by the given enclosure identifier.

Parameters:

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

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

Returns:

EnvironmentalConfiguration of the enclosure resource.

updateEnvironmentalConfiguration

EnvironmentalConfiguration updateEnvironmentalConfiguration(RestParams param,
                                                            String resourceId,
                                                            EnvironmentalConfigurationUpdate environmentalConfigurationUpdateDto)

This method aids in updating the environmental configuration of the enclosure resource identifier.

Parameters:

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

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

environmentalConfigurationUpdateDto - environmentalConfiguration, environmental configuration of enclosure resource specifying the cpu, power value.

Returns:

EnvironmentalConfiguration of the enclosure resource.

updateRefreshState

TaskResourceV2 updateRefreshState(RestParams params,
                                  String resourceId,
                                  RefreshStateConfig refreshStateConfigDto,
                                  boolean aSync)

This method aids in refreshing the enclosure to fix configuration issues.

Parameters:

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

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

refreshStateConfigDto - refreshStateConfigDto, RefreshStateConfig containing the refresh state details to fix configuration issues.

aSync - Flag input to process request asynchronously or synchronously.

Returns:

TaskResourceV2 containing the task status for the process.

getScript

String getScript(RestParams params,
                 String resourceId)

The module aids in fetching the configuration script for the specified enclosure resource identifier.

Parameters:

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

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

Returns:

String, the configuration script for the specified enclosure.

updateScript

TaskResourceV2 updateScript(RestParams params,
                            String resourceId,
                            String scriptData,
                            boolean aSync,
                            boolean useJsonRequest)

The module aids in updating the configuration script for the specified enclosure resource identifier.

Parameters:

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

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

scriptData - The script data to be updated for enclosure.

aSync - Flag input to process request asynchronously or synchronously.

useJsonRequest - The JsonRequest body is part of Enclosure object which takes in a String containing the update to be made, which is converted to FwBaselineConfig object using adaptor and processed.

Returns:

TaskResourceV2 containing the task status for the process.

getStandbyOaSsoUrl

SsoUrlData getStandbyOaSsoUrl(RestParams params,
                              String resourceId)

This method aids in fetching data that can be used to construct a single sign-on URL for an onboard administrator.

Parameters:

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

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

Returns:

SsoUrlData containing the data used for single sign URL for onboard administrator.

getUtilization

UtilizationData getUtilization(RestParams params,
                               String resourceId)

This method aids in retrieving historical utilization data for the specified enclosure.

Parameters:

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

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

Returns:

UtilizationData containing resource data utilization such as power, cpu.

getId

String getId(RestParams params,
             String name)

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

Parameters:

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

name - The name is the enclosure name as seen in HPE OneView.

Returns:

String which is the resource identifier for the enclosure name as seen in HPE OneView.