com.hp.ov.sdk.rest.client

Interface FcoeNetworkClient

All Known Implementing Classes:

FcoeNetworkClientImpl

public interface FcoeNetworkClient

Method Summary

Modifier and Type	Method and Description
TaskResourceV2	createFcoeNetwork(RestParams params, FcoeNetwork fcoeNetwork, boolean aSync) Creates an FCoE network according to the provided FcoeNetwork object.
TaskResourceV2	deleteFcoeNetwork(RestParams params, String resourceId, boolean aSync) Deletes the FcoeNetwork identified by the given resource identifier.
FcoeNetworkCollection	getAllFcoeNetworks(RestParams params) Retrieves an FcoeNetworkCollection containing details for all the available FCoE networks found under the current HPE OneView.
FcoeNetwork	getFcoeNetwork(RestParams params, String resourceId) Retrieves the FcoeNetwork details for the specified FCoE network.
FcoeNetwork	getFcoeNetworkByName(RestParams params, String name) Retrieves the FcoeNetwork details for the specified FCoE network identified by name.
String	getId(RestParams params, String name) Retrieves the FCoE network resource identifier for the specified FCoE network identified by name.
TaskResourceV2	updateFcoeNetwork(RestParams params, String resourceId, FcoeNetwork fcoeNetwork, boolean aSync) Updates an FcoeNetwork identified by the given resource identifier.

Method Detail

getFcoeNetwork

FcoeNetwork getFcoeNetwork(RestParams params,
                           String resourceId)

Retrieves the FcoeNetwork details for the specified FCoE network.

Parameters:

params - structure containing the connection details.

resourceId - FCoE network resource identifier as seen in HPE OneView.

Returns:

FcoeNetwork object containing the details.

getAllFcoeNetworks

FcoeNetworkCollection getAllFcoeNetworks(RestParams params)

Retrieves an FcoeNetworkCollection containing details for all the available FCoE networks found under the current HPE OneView.

Parameters:

params - structure containing the connection details.

Returns:

FcoeNetworkCollection object containing the details for all found FCoE networks.

getFcoeNetworkByName

FcoeNetwork getFcoeNetworkByName(RestParams params,
                                 String name)

Retrieves the FcoeNetwork details for the specified FCoE network identified by name.

Parameters:

params - structure containing the connection details.

name - FCoE network name as seen in HPE OneView.

Returns:

FcoeNetwork object containing the details.

createFcoeNetwork

TaskResourceV2 createFcoeNetwork(RestParams params,
                                 FcoeNetwork fcoeNetwork,
                                 boolean aSync)

Creates an FCoE network according to the provided FcoeNetwork object. The request can be processed asynchronously or synchronously.

Parameters:

params - structure containing the connection details.

fcoeNetwork - object containing the FCoE network details.

aSync - flag to indicate whether the request should be processed asynchronously or synchronously.

Returns:

TaskResourceV2 containing the task status for the process.

updateFcoeNetwork

TaskResourceV2 updateFcoeNetwork(RestParams params,
                                 String resourceId,
                                 FcoeNetwork fcoeNetwork,
                                 boolean aSync)

Updates an FcoeNetwork identified by the given resource identifier.

Parameters:

params - structure containing the connection details.

resourceId - FCoE network resource identifier as seen in HPE OneView.

fcoeNetwork - object containing the FCoE network details.

aSync - flag to indicate whether the request should be processed asynchronously or synchronously.

Returns:

TaskResourceV2 containing the task status for the process.

deleteFcoeNetwork

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

Deletes the FcoeNetwork identified by the given resource identifier.

Parameters:

params - structure containing the connection details.

resourceId - FCoE network resource identifier as seen in HPE OneView.

aSync - flag to indicate whether the request should be processed asynchronously or synchronously.

Returns:

TaskResourceV2 containing the task status for the process.

getId

String getId(RestParams params,
             String name)

Retrieves the FCoE network resource identifier for the specified FCoE network identified by name.

Parameters:

params - structure containing the connection details.

name - FCoE network name as seen in HPE OneView.

Returns:

resource identifier for the FCoE network name as seen in HPE OneView.