com.hp.ov.sdk.rest.client.networking

Interface SwitchClient

All Superinterfaces:

AddableResource<Switch>, PatchableResource, RemovableResource, RetrievableResource<Switch>, SearchableResource<Switch>, UpdatableResource<Switch>

public interface SwitchClient
extends SearchableResource<Switch>, AddableResource<Switch>, UpdatableResource<Switch>, RemovableResource, PatchableResource

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SwitchClient.SwitchRefreshRequestInterceptor

Nested classes/interfaces inherited from interface com.hp.ov.sdk.rest.client.common.SearchableResource

SearchableResource.GetByNameRequestInterceptor

Field Summary

Fields

Modifier and Type	Field and Description
static Object	EMPTY_OBJECT_BODY
static String	SWITCHES_ENVIRONMENT_CONFIGURATION_URI
static String	SWITCHES_REFRESH_URI
static String	SWITCHES_STATISTICS_URI
static String	SWITCHES_UPDATE_PORTS_URI
static String	SWITCHES_URI

Method Summary

Modifier and Type	Method and Description
EnvironmentalConfiguration	getEnvironmentalConfiguration(String resourceId) Retrieves the environmental configuration for the specified switch.
SwitchPortStatistics	getPortStatistics(String resourceId, String portName) Retrieves the statistics for the specified switch port.
SwitchStatistics	getStatistics(String resourceId) Retrieves the statistics for the specified switch.
TaskResource	refresh(String resourceId, RequestOption... options) Requests a refresh for the specified switch.
TaskResource	updatePorts(String resourceId, List<Port> ports, RequestOption... options) The module takes in a List<Port> object and updates the existing switch ports based on the resource identifier.

Methods inherited from interface com.hp.ov.sdk.rest.client.common.SearchableResource

getByName

Methods inherited from interface com.hp.ov.sdk.rest.client.common.RetrievableResource

get, get, getAll, getAll, getById

Methods inherited from interface com.hp.ov.sdk.rest.client.common.AddableResource

add

Methods inherited from interface com.hp.ov.sdk.rest.client.common.UpdatableResource

update

Methods inherited from interface com.hp.ov.sdk.rest.client.common.RemovableResource

remove

Methods inherited from interface com.hp.ov.sdk.rest.client.common.PatchableResource

patch

Field Detail

SWITCHES_URI

static final String SWITCHES_URI

See Also:

Constant Field Values

SWITCHES_ENVIRONMENT_CONFIGURATION_URI

static final String SWITCHES_ENVIRONMENT_CONFIGURATION_URI

See Also:

Constant Field Values

SWITCHES_REFRESH_URI

static final String SWITCHES_REFRESH_URI

See Also:

Constant Field Values

SWITCHES_STATISTICS_URI

static final String SWITCHES_STATISTICS_URI

See Also:

Constant Field Values

SWITCHES_UPDATE_PORTS_URI

static final String SWITCHES_UPDATE_PORTS_URI

See Also:

Constant Field Values

EMPTY_OBJECT_BODY

static final Object EMPTY_OBJECT_BODY

Method Detail

refresh

TaskResource refresh(String resourceId,
                     RequestOption... options)

Requests a refresh for the specified switch.

Parameters:

resourceId - switch resource identifier as seen in HPE OneView.

options - varargs of RequestOption, which can be used to specify some request options.

Returns:

TaskResource containing the task status for the process.

getEnvironmentalConfiguration

EnvironmentalConfiguration getEnvironmentalConfiguration(String resourceId)

Retrieves the environmental configuration for the specified switch.

Parameters:

resourceId - switch resource identifier as seen in HPE OneView.

Returns:

EnvironmentalConfiguration object containing the environment configuration for the switch.

getStatistics

SwitchStatistics getStatistics(String resourceId)

Retrieves the statistics for the specified switch.

Parameters:

resourceId - switch resource identifier as seen in HPE OneView.

Returns:

SwitchStatistics object containing the the statistics for the switch.

getPortStatistics

SwitchPortStatistics getPortStatistics(String resourceId,
                                       String portName)

Retrieves the statistics for the specified switch port.

Parameters:

resourceId - switch resource identifier as seen in HPE OneView.

portName - port name for which the statistics data should be retrieved.

Returns:

SwitchPortStatistics object containing the the statistics for the switch port.

updatePorts

TaskResource updatePorts(String resourceId,
                         List<Port> ports,
                         RequestOption... options)

The module takes in a List<Port> object and updates the existing switch ports based on the resource identifier.

Parameters:

resourceId - switch resource identifier as seen in HPE OneView.

ports - containing the switch ports details, used to update the switch ports.

options - varargs of RequestOption, which can be used to specify some request options.

Returns:

TaskResource containing the task status for the process.