com.hp.ov.sdk.rest.client

Interface FcSansDeviceManagerClient

All Known Implementing Classes:

FcSansDeviceManagerClientImpl

public interface FcSansDeviceManagerClient

A device manager is a hardware system that the SAN Resource Manager can communicate with in order to manage the zones on a SAN. For example, the SAN Resource Manager may communicate with one or more Brocade Network Advisor systems, identified by IP addresses or DNS names, in order to manage the zones on the SANs controlled by those BNA systems.

Method Summary

Modifier and Type	Method and Description
TaskResourceV2	createDeviceManager(RestParams params, String providerUrl, DeviceManagerResponse deviceManagerResponseDto, boolean aSync) The module aids in creating a device manager under the specified provider.
TaskResourceV2	deleteDeviceManager(RestParams params, String resourceId, boolean aSync) The module aids in deleting a device manager for the specified device manager resource identifier.
DeviceManagerResponseCollection	getAllDeviceManager(RestParams params) The module aids in fetching all the device managers registered under the current HPE OneView.
DeviceManagerResponse	getDeviceManager(RestParams params, String resourceId) The module aids in fetching the device manager registered under current HPE OneView.
DeviceManagerResponse	getDeviceManagerByName(RestParams params, String name) The module aids in fetching the device manager registered under the current HPE OneView.
String	getId(RestParams params, String name) The module aids in fetching the device manager resource identifier for the device manager name as specified in HPE OneView.
TaskResourceV2	updateDeviceManager(RestParams params, String resourceId, DeviceManagerResponse updateDeviceManagerResponseDto, boolean useJsonRequest, boolean aSync) The module takes in an DeviceManagerResponse object or JsonRequest and updates the existing device manager based on the resource identifier.

Method Detail

createDeviceManager

TaskResourceV2 createDeviceManager(RestParams params,
                                   String providerUrl,
                                   DeviceManagerResponse deviceManagerResponseDto,
                                   boolean aSync)

The module aids in creating a device manager under the specified provider.

Parameters:

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

providerUrl - The provider URL based on the switch provider obtained from HPE OneView.

deviceManagerResponseDto - The DeviceManagerResponse object containing the device manager details.

aSync - Flag input to process request asynchronously or synchronously.

Returns:

TaskResourceV2 containing the task status for the process.

getAllDeviceManager

DeviceManagerResponseCollection getAllDeviceManager(RestParams params)

The module aids in fetching all the device managers registered under the current HPE OneView.

Parameters:

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

Returns:

DeviceManagerResponseCollection containing the device managers details.

getDeviceManager

DeviceManagerResponse getDeviceManager(RestParams params,
                                       String resourceId)

The module aids in fetching the device manager registered under current HPE OneView.

Parameters:

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

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

Returns:

DeviceManagerResponse containing the device manager details.

getDeviceManagerByName

DeviceManagerResponse getDeviceManagerByName(RestParams params,
                                             String name)

The module aids in fetching the device manager registered under the current HPE OneView.

Parameters:

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

name - The name is the device manager name as seen in HPE

Returns:

DeviceManagerResponse containing the device manager details.

deleteDeviceManager

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

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

aSync - Flag input to process request asynchronously or synchronously.

Returns:

TaskResourceV2 containing the task status for the process.

updateDeviceManager

TaskResourceV2 updateDeviceManager(RestParams params,
                                   String resourceId,
                                   DeviceManagerResponse updateDeviceManagerResponseDto,
                                   boolean useJsonRequest,
                                   boolean aSync)

The module takes in an DeviceManagerResponse object or JsonRequest and updates the existing device manager 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 device manager as seen in HPE OneView.

updateDeviceManagerResponseDto - object containing the device manager details.

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

aSync - Flag input to process request asynchronously or synchronously.

Returns:

TaskResourceV2 containing the task status for the process.

getId

String getId(RestParams params,
             String name)

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

Parameters:

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

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

Returns:

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