com.hp.ov.sdk.rest.client

Interface UnmanagedDeviceClient

All Known Implementing Classes:

UnmanagedDeviceClientImpl

public interface UnmanagedDeviceClient

Method Summary

Modifier and Type	Method and Description
UnmanagedDevice	addUnmanagedDevice(RestParams params, UnmanagedDevice unmanagedDevice) Adds an unmanaged device according to the provided UnmanagedDevice object.
ResourceCollection<UnmanagedDevice>	getAllUnmanagedDevices(RestParams params) Retrieves a ResourceCollection<UnmanagedDevice> containing details for all the available unmanaged devices found under the current HPE OneView.
EnvironmentalConfiguration	getEnvironmentalConfiguration(RestParams params, String resourceId) Returns a description of the environmental configuration (supported feature set, calibrated minimum and maximum power, location and dimensions, ...) of the resource.
String	getId(RestParams params, String name) Retrieves the unmanaged device resource identifier for the specified unmanaged device identified by name.
UnmanagedDevice	getUnmanagedDevice(RestParams params, String resourceId) Retrieves the UnmanagedDevice details for the specified unmanaged device.
UnmanagedDevice	getUnmanagedDeviceByName(RestParams params, String name) Retrieves the UnmanagedDevice details for the specified unmanaged device identified by name.
String	removeUnmanagedDevice(RestParams params, String resourceId) Removes the UnmanagedDevice identified by the given resource identifier.
TaskResourceV2	removeUnmanagedDeviceByFilter(RestParams params, String filter, boolean aSync) Removes the UnmanagedDevice(s) matching the filter.
UnmanagedDevice	updateUnmanagedDevice(RestParams params, String resourceId, UnmanagedDevice unmanagedDevice) Updates an UnmanagedDevice identified by the given resource identifier.

Method Detail

getUnmanagedDevice

UnmanagedDevice getUnmanagedDevice(RestParams params,
                                   String resourceId)

Retrieves the UnmanagedDevice details for the specified unmanaged device.

Parameters:

params - structure containing the connection details.

resourceId - unmanaged device resource identifier as seen in HPE OneView.

Returns:

UnmanagedDevice object containing the details.

getAllUnmanagedDevices

ResourceCollection<UnmanagedDevice> getAllUnmanagedDevices(RestParams params)

Retrieves a ResourceCollection<UnmanagedDevice> containing details for all the available unmanaged devices found under the current HPE OneView.

Parameters:

params - structure containing the connection details.

Returns:

ResourceCollection<UnmanagedDevice> containing the details for all found unmanaged devices.

getUnmanagedDeviceByName

UnmanagedDevice getUnmanagedDeviceByName(RestParams params,
                                         String name)

Retrieves the UnmanagedDevice details for the specified unmanaged device identified by name.

Parameters:

params - structure containing the connection details.

name - unmanaged device name as seen in HPE OneView.

Returns:

UnmanagedDevice object containing the details.

addUnmanagedDevice

UnmanagedDevice addUnmanagedDevice(RestParams params,
                                   UnmanagedDevice unmanagedDevice)

Adds an unmanaged device according to the provided UnmanagedDevice object.

Parameters:

params - structure containing the connection details.

unmanagedDevice - object containing the unmanaged device details.

Returns:

UnmanagedDevice containing the added unmanaged device.

updateUnmanagedDevice

UnmanagedDevice updateUnmanagedDevice(RestParams params,
                                      String resourceId,
                                      UnmanagedDevice unmanagedDevice)

Updates an UnmanagedDevice identified by the given resource identifier.

Parameters:

params - structure containing the connection details.

resourceId - unmanaged device resource identifier as seen in HPE OneView.

unmanagedDevice - object containing the unmanaged device details.

Returns:

UnmanagedDevice containing the unmanaged device updated.

removeUnmanagedDevice

String removeUnmanagedDevice(RestParams params,
                             String resourceId)

Removes the UnmanagedDevice identified by the given resource identifier.

Parameters:

params - structure containing the connection details.

resourceId - unmanaged device resource identifier as seen in HPE OneView.

Returns:

String value containing the result of the process.

removeUnmanagedDeviceByFilter

TaskResourceV2 removeUnmanagedDeviceByFilter(RestParams params,
                                             String filter,
                                             boolean aSync)

Removes the UnmanagedDevice(s) matching the filter. A filter is required to identify the set of resources to be removed. The actual removal will proceed asynchronously. Although, the method can process the request asynchronously or synchronously, based on the aSync flag input.

Parameters:

params - structure containing the connection details.

filter - A general filter/query string that narrows the list of resources.

aSync - Flag input to process request asynchronously or synchronously.

Returns:

TaskResourceV2 containing the task status for the process.

getEnvironmentalConfiguration

EnvironmentalConfiguration getEnvironmentalConfiguration(RestParams params,
                                                         String resourceId)

Returns a description of the environmental configuration (supported feature set, calibrated minimum and maximum power, location and dimensions, ...) of the resource.

Parameters:

params - structure containing the connection details.

resourceId - unmanaged device resource identifier as seen in HPE OneView.

Returns:

EnvironmentalConfiguration containing the description of the environmental configuration.

getId

String getId(RestParams params,
             String name)

Retrieves the unmanaged device resource identifier for the specified unmanaged device identified by name.

Parameters:

params - structure containing the connection details.

name - unmanaged device name as seen in HPE OneView.

Returns:

resource identifier for the unmanaged device name as seen in HPE OneView.