com.hp.ov.sdk.rest.client

Interface LogicalSwitchGroupClient

All Known Implementing Classes:

LogicalSwitchGroupClientImpl

public interface LogicalSwitchGroupClient

Method Summary

Modifier and Type	Method and Description
TaskResourceV2	createLogicalSwitchGroup(RestParams params, LogicalSwitchGroup logicalSwitchGroup, boolean aSync) Creates a logical switch group according to the provided LogicalSwitchGroup object.
TaskResourceV2	deleteLogicalSwitchGroup(RestParams params, String resourceId, boolean aSync) Deletes a logical switch group identified by the provided resource identifier.
LogicalSwitchGroupCollection	getAllLogicalSwitchGroups(RestParams params) Retrieves the logical switch group details for all the logical switch groups under the current HPE OneView.
String	getId(RestParams params, String name) Retrieves the logical switch group resource identifier for the specified logical switch group name.
LogicalSwitchGroup	getLogicalSwitchGroup(RestParams params, String resourceId) Retrieves the LogicalSwitchGroup details for the specified logical switch group resource identifier.
LogicalSwitchGroup	getLogicalSwitchGroupByName(RestParams params, String name) Retrieves the LogicalSwitchGroup details for the specified logical switch group name.
TaskResourceV2	updateLogicalSwitchGroup(RestParams params, String resourceId, LogicalSwitchGroup logicalSwitchGroup, boolean aSync) Updates a logical switch group according to the provided LogicalSwitchGroup object.

Method Detail

getLogicalSwitchGroup

LogicalSwitchGroup getLogicalSwitchGroup(RestParams params,
                                         String resourceId)

Retrieves the LogicalSwitchGroup details for the specified logical switch group resource identifier.

Parameters:

params - structure containing the connection details.

resourceId - logical switch group identifier as seen in HPE OneView.

Returns:

LogicalSwitchGroup object containing the details.

getLogicalSwitchGroupByName

LogicalSwitchGroup getLogicalSwitchGroupByName(RestParams params,
                                               String name)

Retrieves the LogicalSwitchGroup details for the specified logical switch group name.

Parameters:

params - structure containing the connection details.

name - logical switch group name as seen in HPE OneView.

Returns:

LogicalSwitchGroup object containing the details.

getAllLogicalSwitchGroups

LogicalSwitchGroupCollection getAllLogicalSwitchGroups(RestParams params)

Retrieves the logical switch group details for all the logical switch groups under the current HPE OneView.

Parameters:

params - structure containing the connection details.

Returns:

LogicalSwitchGroupCollection object containing the details for all the logical switch groups found in HPE OneView.

createLogicalSwitchGroup

TaskResourceV2 createLogicalSwitchGroup(RestParams params,
                                        LogicalSwitchGroup logicalSwitchGroup,
                                        boolean aSync)

Creates a logical switch group according to the provided LogicalSwitchGroup object. The request can be processed asynchronously or synchronously.

Parameters:

params - structure containing the connection details.

logicalSwitchGroup - object containing the logical switch group details.

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

Returns:

TaskResourceV2 containing the task status for the process.

updateLogicalSwitchGroup

TaskResourceV2 updateLogicalSwitchGroup(RestParams params,
                                        String resourceId,
                                        LogicalSwitchGroup logicalSwitchGroup,
                                        boolean aSync)

Updates a logical switch group according to the provided LogicalSwitchGroup object. The request can be processed asynchronously or synchronously.

Parameters:

params - structure containing the connection details.

resourceId - logical switch group identifier as seen in HPE OneView.

logicalSwitchGroup - object containing the logical switch group details.

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

Returns:

TaskResourceV2 containing the task status for the process.

deleteLogicalSwitchGroup

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

Deletes a logical switch group identified by the provided resource identifier. The request can be processed asynchronously or synchronously.

Parameters:

params - structure containing the connection details.

resourceId - logical switch group 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 logical switch group resource identifier for the specified logical switch group name.

Parameters:

params - structure containing the connection details.

name - logical switch group name as seen in HPE OneView.

Returns:

the resource identifier for the logical switch group