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

Interface InterconnectClient

All Superinterfaces:

PatchableResource, RetrievableResource<Interconnect>, SearchableResource<Interconnect>

public interface InterconnectClient
extends SearchableResource<Interconnect>, PatchableResource

Nested Class Summary

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 String	INTERCONNECT_NAME_SERVERS_URI
static String	INTERCONNECT_PORTS_URI
static String	INTERCONNECT_RESET_PORT_PROTECTION_URI
static String	INTERCONNECT_STATISTICS_URI
static String	INTERCONNECT_SUBPORT_URI
static String	INTERCONNECT_UPDATE_PORTS_URI
static String	INTERCONNECT_URI

Method Summary

Modifier and Type	Method and Description
List<NameServer>	getNamedServers(String resourceId) Retrieves the named servers for an interconnect found under the current HPE OneView.
Port	getPort(String resourceId, String portId) Retrieves the port of an interconnect for the specified interconnect resource identifier and portId.
ResourceCollection<Port>	getPorts(String resourceId) Retrieves the collection of ports of an interconnect for the specified interconnect resource identifier.
PortStatistics	getPortStatistics(String resourceId, String portName) Retrieves the statistics of an interconnect port for the specified interconnect resource identifier and port name.
InterconnectsStatistics	getStatistics(String resourceId) Retrieve the statistics of an interconnect for the specified interconnect resource identifier.
SubportStatistics	getSubportStatistics(String resourceId, String portName, int subportName) Retrieves the statistics of an interconnect subport for the specified interconnect resource identifier, port name, and subport number.
TaskResource	resetPortProtection(String resourceId, RequestOption... options) Triggers a reset of the interconnect port protection.
TaskResource	updatePort(String resourceId, Port port, RequestOption... options) The module takes in a Port object and updates the existing interconnect port based on the resource identifier.
TaskResource	updatePorts(String resourceId, List<Port> ports, RequestOption... options) The module takes in a List<Port> object and updates the existing interconnect 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.PatchableResource

patch

Field Detail

INTERCONNECT_URI

static final String INTERCONNECT_URI

See Also:

Constant Field Values

INTERCONNECT_NAME_SERVERS_URI

static final String INTERCONNECT_NAME_SERVERS_URI

See Also:

Constant Field Values

INTERCONNECT_PORTS_URI

static final String INTERCONNECT_PORTS_URI

See Also:

Constant Field Values

INTERCONNECT_RESET_PORT_PROTECTION_URI

static final String INTERCONNECT_RESET_PORT_PROTECTION_URI

See Also:

Constant Field Values

INTERCONNECT_STATISTICS_URI

static final String INTERCONNECT_STATISTICS_URI

See Also:

Constant Field Values

INTERCONNECT_SUBPORT_URI

static final String INTERCONNECT_SUBPORT_URI

See Also:

Constant Field Values

INTERCONNECT_UPDATE_PORTS_URI

static final String INTERCONNECT_UPDATE_PORTS_URI

See Also:

Constant Field Values

Method Detail

updatePort

TaskResource updatePort(String resourceId,
                        Port port,
                        RequestOption... options)

The module takes in a Port object and updates the existing interconnect port based on the resource identifier.

Parameters:

resourceId - resource identifier for interconnect as seen in HPE OneView.

port - containing the interconnect port details, used to update a interconnect port.

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

Returns:

TaskResource containing the task status for the process.

updatePorts

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

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

Parameters:

resourceId - resource identifier for interconnect as seen in HPE OneView.

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

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

Returns:

TaskResource containing the task status for the process.

resetPortProtection

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

Triggers a reset of the interconnect port protection.

Parameters:

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

getPorts

ResourceCollection<Port> getPorts(String resourceId)

Retrieves the collection of ports of an interconnect for the specified interconnect resource identifier.

Parameters:

resourceId - resource identifier for interconnect as seen in HPE OneView

Returns:

ResourceCollection<Port> containing the interconnect port details

getPort

Port getPort(String resourceId,
             String portId)

Retrieves the port of an interconnect for the specified interconnect resource identifier and portId.

Parameters:

resourceId - resource identifier for interconnect as seen in HPE OneView

portId - id of the interconnect port as seen in HPE OneView

Returns:

Port containing the interconnect port details

getStatistics

InterconnectsStatistics getStatistics(String resourceId)

Retrieve the statistics of an interconnect for the specified interconnect resource identifier.

Parameters:

resourceId - resource identifier for interconnect as seen in HPE OneView.

Returns:

InterconnectsStatistics containing the interconnect statistics details.

getPortStatistics

PortStatistics getPortStatistics(String resourceId,
                                 String portName)

Retrieves the statistics of an interconnect port for the specified interconnect resource identifier and port name.

Parameters:

resourceId - resource identifier for interconnect as seen in HPE OneView.

portName - name of the port as seen in HPE OneView

Returns:

PortStatistics containing the statistics of an interconnect port details.

getSubportStatistics

SubportStatistics getSubportStatistics(String resourceId,
                                       String portName,
                                       int subportName)

Retrieves the statistics of an interconnect subport for the specified interconnect resource identifier, port name, and subport number.

Parameters:

resourceId - resource identifier for interconnect as seen in HPE OneView.

portName - name of the port as seen in HPE OneView

subportName - number of the subport as seen in HPE OneView

Returns:

SubportStatistics containing the statistics of an interconnect subport details.

getNamedServers

List<NameServer> getNamedServers(String resourceId)

Retrieves the named servers for an interconnect found under the current HPE OneView.

Parameters:

resourceId - resource identifier for interconnect as seen in HPE OneView.

Returns:

List<NameServer> containing the name servers for the specified interconnect.