com.hp.ov.sdk.rest.client

Interface PowerDeliveryDeviceClient

All Known Implementing Classes:

PowerDeliveryDeviceClientImpl

public interface PowerDeliveryDeviceClient

Method Summary

Modifier and Type	Method and Description
PowerDeliveryDevice	addPowerDeliveryDevice(RestParams params, PowerDeliveryDevice powerDeliveryDeviceDto, boolean aSync) The module aids in the inclusion of a power delivery device when provided with the power delivery device details as a PowerDeliveryDevice object.
TaskResourceV2	addPowerDeliveryDeviceByDiscover(RestParams params, ImportPdd importPddDto, boolean aSync) The module aids in the inclusion of an HPE iPDU and bring all components under management by discovery of its management module.
ResourceCollection<PowerDeliveryDevice>	getAllPowerDeliveryDevices(RestParams params) The module aids in fetching the power delivery device details for all the power delivery devices found under the current HPE OneView.
PowerDeliveryDevice	getPowerDeliveryDeviceById(RestParams params, String resourceId) The module aids in fetching the power delivery device details for the specified power delivery device resource identifier.
PowerDeliveryDevice	getPowerDeliveryDeviceByName(RestParams params, String name) The module aids in fetching the power delivery device details for the power delivery device name as specified in HPE OneView.
Power	getPowerDeliveryDevicePowerState(RestParams params, String resourceId) The module aids in fetching the power state for the specified power delivery device resource identifier.
Light	getPowerDeliveryDeviceUidState(RestParams params, String resourceId) The module aids in fetching the unit identification (UID) state (on, off, unknown) of the specified power outlet or extension bar resource.
UtilizationData	getPowerDeliveryDeviceUtilization(RestParams params, String resourceId) The module aids in fetching the power delivery device utilization details for the specified power delivery device resource identifier.
TaskResourceV2	removePowerDeliveryDevice(RestParams params, String resourceId, boolean aSync) The module aids in deleting a power delivery device for the specified power delivery device resource identifier.
TaskResourceV2	removePowerDeliveryDeviceByFilter(RestParams params, String filter, boolean aSync) This module aids in deleting all power delivery device objects from the appliance that match the provided filter.
String	removePowerDeliveryDeviceSynchronously(RestParams params, String resourceId) The module aids in deleting a power delivery device for the specified power delivery device resource identifier synchronously.
PowerDeliveryDevice	updatePowerDeliveryDevice(RestParams params, String resourceId, PowerDeliveryDevice powerDeliveryDeviceDto, boolean aSync) The module takes in a PowerDeliveryDevice object and updates the existing power delivery device based on the resource identifier.
TaskResourceV2	updatePowerDeliveryDevicePowerState(RestParams params, String resourceId, OutletState outletStateDto, boolean aSync) The module takes in a OutletState object and updates the power state of the power delivery device based on the resource identifier.
TaskResourceV2	updatePowerDeliveryDeviceRefreshState(RestParams params, String resourceId, PowerDeliveryDeviceRefreshRequest powerDeliveryDeviceRefreshRequestDto, boolean aSync) The module takes in a PowerDeliveryDeviceRefreshRequest object and updates the refresh state of the power delivery device based on the resource identifier.
TaskResourceV2	updatePowerDeliveryDeviceUidState(RestParams params, String resourceId, OutletState outletStateDto, boolean aSync) The module takes in a OutletState object and updates the unit identification (UID) light state of the specified power delivery device.

Method Detail

getPowerDeliveryDeviceById

PowerDeliveryDevice getPowerDeliveryDeviceById(RestParams params,
                                               String resourceId)

The module aids in fetching the power delivery device details for the specified power delivery device resource identifier.

Parameters:

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

resourceId - The resource identifier for power delivery device as seen in HPE OneView.

Returns:

PowerDeliveryDevice containing the power delivery device details.

getAllPowerDeliveryDevices

ResourceCollection<PowerDeliveryDevice> getAllPowerDeliveryDevices(RestParams params)

The module aids in fetching the power delivery device details for all the power delivery devices found under the current HPE OneView.

Parameters:

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

Returns:

ResourceCollection<PowerDeliveryDevice> containing the details for all found power delivery devices.

getPowerDeliveryDeviceByName

PowerDeliveryDevice getPowerDeliveryDeviceByName(RestParams params,
                                                 String name)

The module aids in fetching the power delivery device details for the power delivery device name as specified in HPE OneView.

Parameters:

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

name - The resourceName is the power delivery device name as seen in HPE OneView.

Returns:

PowerDeliveryDevice containing the power delivery device details.

addPowerDeliveryDevice

PowerDeliveryDevice addPowerDeliveryDevice(RestParams params,
                                           PowerDeliveryDevice powerDeliveryDeviceDto,
                                           boolean aSync)

The module aids in the inclusion of a power delivery device when provided with the power delivery device details as a PowerDeliveryDevice object. Use this method to create a representation of power delivery devices that provide power to other resources but cannot otherwise be discovered by the management appliance.It can process the request asynchronously or synchronously, based on the flag input.

Parameters:

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

powerDeliveryDeviceDto - Object containing the power delivery device details, used to create a power delivery device.

aSync - Flag input to process request asynchronously or synchronously.

Returns:

PowerDeliveryDevice the power delivery device resource as added to the appliance with default and assigned properties expanded.

addPowerDeliveryDeviceByDiscover

TaskResourceV2 addPowerDeliveryDeviceByDiscover(RestParams params,
                                                ImportPdd importPddDto,
                                                boolean aSync)

The module aids in the inclusion of an HPE iPDU and bring all components under management by discovery of its management module. Bring the management module under exclusive management by the appliance, configure any management or data collection settings, and create a private set of administrative credentials to enable ongoing communication and management of the iPDU. It can process the request asynchronously or synchronously, based on the flag input.

Parameters:

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

importPddDto - Object containing the power delivery device connection details.

aSync - Flag input to process request asynchronously or synchronously.

Returns:

TaskResourceV2 containing the task status for the process.

updatePowerDeliveryDevice

PowerDeliveryDevice updatePowerDeliveryDevice(RestParams params,
                                              String resourceId,
                                              PowerDeliveryDevice powerDeliveryDeviceDto,
                                              boolean aSync)

The module takes in a PowerDeliveryDevice object and updates the existing power delivery device 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 power delivery device as seen in HPE OneView.

powerDeliveryDeviceDto - Object containing the power delivery device details, used to update a power delivery device.

aSync - Flag input to process request asynchronously or synchronously.

Returns:

PowerDeliveryDevice containing the updated power delivery device information.

removePowerDeliveryDevice

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

The module aids in deleting a power delivery device for the specified power delivery device 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 power delivery device as seen in HPE OneView.

aSync - Flag input to process request asynchronously or synchronously.

Returns:

TaskResourceV2 containing the task status for the process.

removePowerDeliveryDeviceByFilter

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

This module aids in deleting all power delivery device objects from the appliance that match the provided filter.

Parameters:

params - The RestParams is a 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.

removePowerDeliveryDeviceSynchronously

String removePowerDeliveryDeviceSynchronously(RestParams params,
                                              String resourceId)

The module aids in deleting a power delivery device for the specified power delivery device resource identifier synchronously.

Parameters:

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

resourceId - The resource identifier for power delivery device as seen in HPE OneView.

Returns:

TaskResourceV2 containing the task status for the process.

getPowerDeliveryDevicePowerState

Power getPowerDeliveryDevicePowerState(RestParams params,
                                       String resourceId)

The module aids in fetching the power state for the specified power delivery device resource identifier.

Parameters:

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

resourceId - The resource identifier for power delivery device as seen in HPE OneView.

Returns:

Power representing the power state of the power delivery device.

updatePowerDeliveryDevicePowerState

TaskResourceV2 updatePowerDeliveryDevicePowerState(RestParams params,
                                                   String resourceId,
                                                   OutletState outletStateDto,
                                                   boolean aSync)

The module takes in a OutletState object and updates the power state of the power delivery device 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 power delivery device as seen in HPE OneView.

outletStateDto - Object containing the power state of the power delivery device.

aSync - Flag input to process request asynchronously or synchronously.

Returns:

TaskResourceV2 containing the task status for the process.

updatePowerDeliveryDeviceRefreshState

TaskResourceV2 updatePowerDeliveryDeviceRefreshState(RestParams params,
                                                     String resourceId,
                                                     PowerDeliveryDeviceRefreshRequest powerDeliveryDeviceRefreshRequestDto,
                                                     boolean aSync)

The module takes in a PowerDeliveryDeviceRefreshRequest object and updates the refresh state of the power delivery device 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 power delivery device as seen in HPE OneView.

powerDeliveryDeviceRefreshRequestDto - Object containing the refresh state of the power delivery device.

aSync - Flag input to process request asynchronously or synchronously.

Returns:

TaskResourceV2 containing the task status for the process.

getPowerDeliveryDeviceUidState

Light getPowerDeliveryDeviceUidState(RestParams params,
                                     String resourceId)

The module aids in fetching the unit identification (UID) state (on, off, unknown) of the specified power outlet or extension bar resource.

Parameters:

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

resourceId - The resource identifier for power delivery device as seen in HPE OneView.

Returns:

Light representing the UID state of the power delivery device.

updatePowerDeliveryDeviceUidState

TaskResourceV2 updatePowerDeliveryDeviceUidState(RestParams params,
                                                 String resourceId,
                                                 OutletState outletStateDto,
                                                 boolean aSync)

The module takes in a OutletState object and updates the unit identification (UID) light state of the specified power delivery device. 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 power delivery device as seen in HPE OneView.

outletStateDto - Object containing the identification (UID) light state of the power delivery device.

aSync - Flag input to process request asynchronously or synchronously.

Returns:

TaskResourceV2 containing the task status for the process.

getPowerDeliveryDeviceUtilization

UtilizationData getPowerDeliveryDeviceUtilization(RestParams params,
                                                  String resourceId)

The module aids in fetching the power delivery device utilization details for the specified power delivery device resource identifier.

Parameters:

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

resourceId - The resource identifier for power delivery device as seen in HPE OneView.

Returns:

UtilizationData containing the utilization information.