com.hp.ov.sdk.rest.client

Interface StorageSystemClient

All Known Implementing Classes:

StorageSystemClientImpl

public interface StorageSystemClient

Method Summary

Modifier and Type	Method and Description
String	createStorageSystem(RestParams params, AddStorageSystemCredentials addStorageSystemCredentialsDto, boolean useJsonRequest) The module aids in creation of storage system when provided with the storage system details as AddStorageSystemCredentials object or JsonRequest.
String	deleteStorageSystem(RestParams params, String resourceId) The module aids in deleting a storage system for the specified storage system resource identifier.
StorageTargetPortCollection	getAllManagedPortsForStorageSystem(RestParams params, String resourceId) This module aids in retrieving all managed target ports for the specified storage system.
StorageSystemCollection	getAllStorageSystems(RestParams params) The module aids in fetching the storage system details for all the storage system found under the current HPE OneView.
String	getId(RestParams params, String name) The module aids in fetching the storage system resource identifier for the storage system name as specified in HPE OneView.
StorageTargetPortV2	getManagedPortsForStorageSystem(RestParams params, String resourceId, String targetPortId) This module aids in retrieving a managed target ports for the specified storage system.
StoragePoolCollection	getStoragePoolsForStorageSystem(RestParams params, String arrayId) This module aids in retrieving a list of storage pools belonging to the storage system referred by the path property {arrayId} parameter.
StorageSystemV2	getStorageSystem(RestParams params, String resourceId) The module aids in fetching the storage system details for the specified storage system resource identifier.
StorageSystemV2	getStorageSystemByName(RestParams params, String name) The module aids in fetching the storage system details for the storage system name as specified in HPE OneView.
List<String>	getStorageSystemHostTypes(RestParams params) The module aids in fetching the list of supported storage host types.
String	updateStorageSystem(RestParams params, String resourceId, StorageSystemV2 storageSystemDto, boolean useJsonRequest) The module takes in an StorageSystemV2 object or JsonRequest and updates the existing storage system based on resource identifier.

Method Detail

getStorageSystem

StorageSystemV2 getStorageSystem(RestParams params,
                                 String resourceId)

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

Parameters:

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

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

Returns:

StorageSystemV2 containing the storage system details.

getStoragePoolsForStorageSystem

StoragePoolCollection getStoragePoolsForStorageSystem(RestParams params,
                                                      String arrayId)

This module aids in retrieving a list of storage pools belonging to the storage system referred by the path property {arrayId} parameter.

Parameters:

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

arrayId - The array identifier for a storage system as seen in HPE OneView.

Returns:

StoragePoolCollection containing a collection of storage system details.

getAllManagedPortsForStorageSystem

StorageTargetPortCollection getAllManagedPortsForStorageSystem(RestParams params,
                                                               String resourceId)

This module aids in retrieving all managed target ports for the specified storage system.

Parameters:

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

resourceId - The resource identifier for a storage system as seen in HPE OneView.

Returns:

StorageTargetPortCollection containing a collection of storage target port details.

getManagedPortsForStorageSystem

StorageTargetPortV2 getManagedPortsForStorageSystem(RestParams params,
                                                    String resourceId,
                                                    String targetPortId)

This module aids in retrieving a managed target ports for the specified storage system.

Parameters:

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

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

targetPortId - The target port identifier where the managed port is defined.

Returns:

{2link StorageTargetPortV2} containing the storage target port details.

getStorageSystemHostTypes

List<String> getStorageSystemHostTypes(RestParams params)

The module aids in fetching the list of supported storage host types.

Parameters:

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

Returns:

a list containing the names of the supported host types.

getAllStorageSystems

StorageSystemCollection getAllStorageSystems(RestParams params)

The module aids in fetching the storage system details for all the storage system found under the current HPE OneView.

Parameters:

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

Returns:

StorageSystemCollection containing a collection storage system details.

getStorageSystemByName

StorageSystemV2 getStorageSystemByName(RestParams params,
                                       String name)

The module aids in fetching the storage system details for the storage system name as specified in HPE OneView.

Parameters:

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

name - The name is the storage system name as seen in HPE OneView.

Returns:

StorageSystemV2 containing the storage system details.

createStorageSystem

String createStorageSystem(RestParams params,
                           AddStorageSystemCredentials addStorageSystemCredentialsDto,
                           boolean useJsonRequest)

The module aids in creation of storage system when provided with the storage system details as AddStorageSystemCredentials object or JsonRequest.

Parameters:

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

addStorageSystemCredentialsDto - Object containing the storage system details, used to create a storage system.

useJsonRequest - The JsonRequest body is part of AddStorageSystemCredentials object which takes in a String containing new storage system details, which is converted to AddStorageSystemCredentials object using an adaptor and processed.

Returns:

String Created if successful.

updateStorageSystem

String updateStorageSystem(RestParams params,
                           String resourceId,
                           StorageSystemV2 storageSystemDto,
                           boolean useJsonRequest)

The module takes in an StorageSystemV2 object or JsonRequest and updates the existing storage system based on resource identifier. This can also be used for updating the storage path of storage system.

Parameters:

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

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

storageSystemDto - Object containing the storage system details, used to update a storage system.

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

Returns:

String Updatedif successful.

deleteStorageSystem

String deleteStorageSystem(RestParams params,
                           String resourceId)

The module aids in deleting a storage system for the specified storage system resource identifier.

Parameters:

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

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

Returns:

String Deleted if successful.

getId

String getId(RestParams params,
             String name)

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

Parameters:

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

name - The name is the storage system name as seen in HPE OneView.

Returns:

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