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

Interface LogicalEnclosureClient

All Superinterfaces:

CreatableResource<AddLogicalEnclosure>, DeletableResource, PatchableResource, RetrievableResource<LogicalEnclosure>, SearchableResource<LogicalEnclosure>, UpdatableResource<LogicalEnclosure>

public interface LogicalEnclosureClient
extends SearchableResource<LogicalEnclosure>, CreatableResource<AddLogicalEnclosure>, UpdatableResource<LogicalEnclosure>, PatchableResource, DeletableResource

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	CONFIGURATION_URI
static String	LOGICAL_ENCLOSURE_URI
static String	SCRIPT_URI
static String	SUPPORT_DUMP_URI
static String	UPDATE_FROM_GROUP_URI

Method Summary

Modifier and Type	Method and Description
TaskResource	createSupportDump(String resourceId, SupportDump supportDump, RequestOption... options) Creates a support dump according to the provided SupportDump object for the logical enclosure identified by the resourceId.
String	getConfigurationScript(String resourceId) Retrieves the configuration script (String) of the logical enclosure identified by the provided resourceId.
TaskResource	updateConfiguration(String resourceId, RequestOption... options) Re-applies the logical enclosure configuration in the logical enclosure identified by the provided resourceId.
TaskResource	updateConfigurationScript(String resourceId, String scriptData, RequestOption... options) Updates the logical enclosure script identified by the resourceId according to the provided script data.
TaskResource	updateFromGroup(String resourceId, RequestOption... options) Updates the logical enclosure identified by the provided resourceId to make it consistent with the associated enclosure group when the logical enclosure is in an inconsistent state.

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

create

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

update

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

patch

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

delete

Field Detail

LOGICAL_ENCLOSURE_URI

static final String LOGICAL_ENCLOSURE_URI

See Also:

Constant Field Values

UPDATE_FROM_GROUP_URI

static final String UPDATE_FROM_GROUP_URI

See Also:

Constant Field Values

CONFIGURATION_URI

static final String CONFIGURATION_URI

See Also:

Constant Field Values

SCRIPT_URI

static final String SCRIPT_URI

See Also:

Constant Field Values

SUPPORT_DUMP_URI

static final String SUPPORT_DUMP_URI

See Also:

Constant Field Values

Method Detail

updateFromGroup

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

Updates the logical enclosure identified by the provided resourceId to make it consistent with the associated enclosure group when the logical enclosure is in an inconsistent state. Since this operation can take some time to complete, it is possible to specify a timeout using the option TaskTimeout. If no timeout is specified, the default behavior is to wait until the update completes.

Parameters:

resourceId - resource identifier as seen in HPE OneView.

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

Returns:

TaskResource task containing the result of this request.

updateConfiguration

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

Re-applies the logical enclosure configuration in the logical enclosure identified by the provided resourceId. Since this operation can take some time to complete, it is possible to specify a timeout using the option TaskTimeout. If no timeout is specified, the default behavior is to wait until the update completes.

Parameters:

resourceId - resource identifier as seen in HPE OneView.

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

Returns:

TaskResource task containing the result of this request.

getConfigurationScript

String getConfigurationScript(String resourceId)

Retrieves the configuration script (String) of the logical enclosure identified by the provided resourceId.

Parameters:

resourceId - resource identifier as seen in HPE OneView.

Returns:

List containing the URIs for the associated server profiles.

updateConfigurationScript

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

Updates the logical enclosure script identified by the resourceId according to the provided script data. Since this operation can take some time to complete, it is possible to specify a timeout using the option TaskTimeout. If no timeout is specified, the default behavior is to wait until the update completes.

Parameters:

resourceId - resource identifier as seen in HPE OneView.

scriptData - script data to be configured in the logical enclosure.

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

Returns:

TaskResource task containing the result of this request.

createSupportDump

TaskResource createSupportDump(String resourceId,
                               SupportDump supportDump,
                               RequestOption... options)

Creates a support dump according to the provided SupportDump object for the logical enclosure identified by the resourceId. A logical enclosure support dump includes content for logical interconnects associated with that logical enclosure and it also contains some appliance support dump content. Since this operation can take some time to complete, it is possible to specify a timeout using the option TaskTimeout. If no timeout is specified, the default behavior is to wait until the create action completes.

Parameters:

resourceId - resource identifier as seen in HPE OneView.

supportDump - object containing the details about how the support dump should be created.

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

Returns:

TaskResource task containing the result of this request.