com.hp.ov.sdk.rest.client

Interface LogicalSwitchClient

All Known Implementing Classes:

LogicalSwitchClientImpl

public interface LogicalSwitchClient

The logical switch resource provides REST APIs for managing logical switches. A logical switch aggregates one or more switches with a common configuration, providing L2/L3 Ethernet and Fibre Channel connectivity to a set of downlinks and uplinks. The logical switch also centralizes the display of switch firmware. A logical switch is constructed from a logical switch group. The logical switch group serves as the initial and ongoing reference for the structure of the logical switch. A logical switch is monitored for consistency to its reference logical switch group. If the logical switch transitions to a 'not consistent' state (because of changes in either the logical switch or the logical switch group), it receives a request to return to a consistent state. The logical switch is also monitored for its stacking health (BiConnected, Connected, and Disconnected) and for its overall health status regarding the network connectivity it provides. The switch map determines the physical membership of switches within a logical switch. The switch map is a list of switch entries, with the switch type permitted and optionally a member ID in each entry. When a switch with the correct switch type and firmware version is found at a location, it is monitored.

Method Summary

Modifier and Type	Method and Description
TaskResourceV2	createLogicalSwitch(RestParams params, AddLogicalSwitch addLogicalSwitch, boolean aSync) Creates a logical switch according to the provided LogicalSwitch object.
TaskResourceV2	deleteLogicalSwitch(RestParams params, String resourceId, boolean aSync) Removes a logical switch identified by the provided resource identifier.
LogicalSwitchCollection	getAllLogicalSwitches(RestParams params) Retrieves the logical switch details for all the logical switches under the current HPE OneView.
String	getId(RestParams params, String name) Retrieves the logical switch resource identifier for the specified logical switch name.
LogicalSwitch	getLogicalSwitch(RestParams params, String resourceId) Retrieves the LogicalSwitch details for the specified logical switch resource identifier.
LogicalSwitch	getLogicalSwitchByName(RestParams params, String name) Retrieves the LogicalSwitch details for the specified logical switch name.
TaskResourceV2	refreshLogicalSwitch(RestParams params, String resourceId, boolean aSync) Executes a refresh action for a logical switch identified by the provided resource identifier.
TaskResourceV2	updateLogicalSwitch(RestParams params, String resourceId, AddLogicalSwitch addLogicalSwitch, boolean aSync) Updates a logical switch according to the provided LogicalSwitch object.

Method Detail

getLogicalSwitch

LogicalSwitch getLogicalSwitch(RestParams params,
                               String resourceId)

Retrieves the LogicalSwitch details for the specified logical switch resource identifier.

Parameters:

params - structure containing the connection details.

resourceId - logical switch identifier as seen in HPE OneView.

Returns:

LogicalSwitch object containing the details.

getLogicalSwitchByName

LogicalSwitch getLogicalSwitchByName(RestParams params,
                                     String name)

Retrieves the LogicalSwitch details for the specified logical switch name.

Parameters:

params - structure containing the connection details.

name - logical switch name as seen in HPE OneView.

Returns:

LogicalSwitch object containing the details.

getAllLogicalSwitches

LogicalSwitchCollection getAllLogicalSwitches(RestParams params)

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

Parameters:

params - structure containing the connection details.

Returns:

LogicalSwitchCollection object containing the details for all the logical switches found in HPE OneView.

createLogicalSwitch

TaskResourceV2 createLogicalSwitch(RestParams params,
                                   AddLogicalSwitch addLogicalSwitch,
                                   boolean aSync)

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

Parameters:

params - structure containing the connection details.

addLogicalSwitch - object containing the logical switch details.

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

Returns:

TaskResourceV2 containing the task status for the process.

updateLogicalSwitch

TaskResourceV2 updateLogicalSwitch(RestParams params,
                                   String resourceId,
                                   AddLogicalSwitch addLogicalSwitch,
                                   boolean aSync)

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

Parameters:

params - structure containing the connection details.

resourceId - logical switch identifier as seen in HPE OneView.

addLogicalSwitch - object containing the logical switch details.

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

Returns:

TaskResourceV2 containing the task status for the process.

deleteLogicalSwitch

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

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

Parameters:

params - structure containing the connection details.

resourceId - logical switch 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.

refreshLogicalSwitch

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

Executes a refresh action for a logical switch identified by the provided resource identifier. The request can be processed asynchronously or synchronously.

Parameters:

params - structure containing the connection details.

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

Parameters:

params - structure containing the connection details.

name - logical switch name as seen in HPE OneView.

Returns:

the resource identifier for the logical switch.