com.hp.ov.sdk.rest.client

Interface SwitchClient

All Known Implementing Classes:

SwitchClientImpl

public interface SwitchClient

Method Summary

Modifier and Type	Method and Description
TaskResourceV2	createSwitch(RestParams params, Switch switchObj, boolean aSync) This method aids in the creation of a switch.
TaskResourceV2	deleteSwitch(RestParams params, String resourceId, boolean aSync) This method aids in deletion of a switch.
SwitchCollection	getAllSwitches(RestParams params) This method aids in fetching the top of rack switches.
String	getId(RestParams params, String name) The module aids in fetching the switch resource identifier for the switch name as specified in HPE OneView.
Switch	getSwitch(RestParams params, String resourceId) This method aids in fetching the switch for the given resource identifier.
Switch	getSwitchByName(RestParams params, String name) The module aids in fetching the switch details for the switch name as specified in HPE OneView.
EnvironmentalConfiguration	getSwitchEnvironmentalConfiguration(RestParams params, String resourceId) This method aids in fetching the environmental configuration for a switch.
SwitchPortStatistics	getSwitchPortStatistics(RestParams params, String resourceId, String portName) This method aids in fetching the statistics for the switch.
SwitchStatistics	getSwitchStatistics(RestParams params, String resourceId) This method aids in fetching the statistics for a switch.
TaskResourceV2	refreshSwitch(RestParams params, String resourceId, boolean aSync) This method aids in refreshing a switch.
TaskResourceV2	updateSwitch(RestParams params, String resourceId, Switch switchDto, boolean aSync) This method aids in updating a switch.

Method Detail

getSwitch

Switch getSwitch(RestParams params,
                 String resourceId)

This method aids in fetching the switch for the given resource identifier.

Parameters:

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

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

Returns:

Switch containing the switch details.

getAllSwitches

SwitchCollection getAllSwitches(RestParams params)

This method aids in fetching the top of rack switches.

Parameters:

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

Returns:

SwitchCollection containing the collection of switch details.

createSwitch

TaskResourceV2 createSwitch(RestParams params,
                            Switch switchObj,
                            boolean aSync)

This method aids in the creation of a switch.

Parameters:

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

switchObj - Object containing the switch details.

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

Returns:

TaskResourceV2 containing the task status for the process.

updateSwitch

TaskResourceV2 updateSwitch(RestParams params,
                            String resourceId,
                            Switch switchDto,
                            boolean aSync)

This method aids in updating a switch.

Parameters:

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

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

switchDto - Object containing the switch details.

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

Returns:

TaskResourceV2 containing the task status for the process.

deleteSwitch

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

This method aids in deletion of a switch.

Parameters:

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

resourceId - The resource identifier for switch 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.

refreshSwitch

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

This method aids in refreshing a switch.

Parameters:

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

resourceId - The resource identifier for switch 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.

getSwitchEnvironmentalConfiguration

EnvironmentalConfiguration getSwitchEnvironmentalConfiguration(RestParams params,
                                                               String resourceId)

This method aids in fetching the environmental configuration for a switch.

Parameters:

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

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

Returns:

EnvironmentalConfiguration containing the environment configuration for the switch.

getSwitchStatistics

SwitchStatistics getSwitchStatistics(RestParams params,
                                     String resourceId)

This method aids in fetching the statistics for a switch.

Parameters:

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

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

Returns:

SwitchStatistics containing the statistics for the switch.

getSwitchPortStatistics

SwitchPortStatistics getSwitchPortStatistics(RestParams params,
                                             String resourceId,
                                             String portName)

This method aids in fetching the statistics for the switch.

Parameters:

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

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

portName - The port name as seen in HPE OneView for which the statistics data should be retrieved.

Returns:

SwitchPortStatistics containing the statistics for a specific switch port.

getSwitchByName

Switch getSwitchByName(RestParams params,
                       String name)

The module aids in fetching the switch details for the switch name as specified in HPE OneView.

Parameters:

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

name - The name is the switch name as seen in HPE OneView.

Returns:

Switch containing the switch details.

getId

String getId(RestParams params,
             String name)

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

Parameters:

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

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

Returns:

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