com.hp.ov.sdk.rest.client

Interface InterconnectsClient

All Known Implementing Classes:

InterconnectsClientImpl

public interface InterconnectsClient

Method Summary

Modifier and Type	Method and Description
InterconnectsCollection	getAllInterconnects(RestParams params) The module aids in fetching the interconnects details for all the interconnects found under the current HPE OneView.
String	getId(RestParams params, String name) The module aids in fetching the interconnect driver resource identifier for the interconnect name as specified in HPE OneView.
Interconnects	getInterconnectById(RestParams params, String resourceId) The module aids in fetching the interconnect details for the specified interconnect resource identifier.
Interconnects	getInterconnectByName(RestParams params, String interconnectName) The module aids in fetching the interconnect details for the interconnect name as specified in HPE OneView.
List<NameServer>	getInterconnectNamedServers(RestParams params, String resourceId) Gets the named servers for an interconnect.
PortStatistics	getInterconnectPortStatistics(RestParams params, String resourceId, String portName) Gets the port statistics from an interconnect.
InterconnectsStatistics	getInterconnectStatistics(RestParams params, String resourceId) Gets the statistics from an interconnect.
SubportStatistics	getInterconnectSubportStatistics(RestParams params, String resourceId, String portName, int subportNumber) Gets the subport statistics from an interconnect.
TaskResourceV2	patchInterconnect(RestParams params, String resourceId, Patch patchDto, boolean aSync) Performs a specific patch operation for the given interconnect.
TaskResourceV2	resetInterconnectPortProtection(RestParams params, String resourceId, boolean aSync) Triggers a reset of port protection.
TaskResourceV2	updateInterconnectPort(RestParams params, String resourceId, Port portDto, boolean aSync, boolean useJsonRequest) Updates an interconnect port.
TaskResourceV2	updateInterconnectPorts(RestParams params, String resourceId, List<Port> portsDto, boolean aSync, boolean useJsonRequest) Updates the interconnect ports.

Method Detail

getInterconnectById

Interconnects getInterconnectById(RestParams params,
                                  String resourceId)

The module aids in fetching the interconnect details for the specified interconnect resource identifier.

Parameters:

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

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

Returns:

Interconnects containing the interconnect details.

getInterconnectByName

Interconnects getInterconnectByName(RestParams params,
                                    String interconnectName)

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

Parameters:

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

interconnectName - The interconnectName is the interconnect name as seen in HPE OneView.

Returns:

Interconnects containing the interconnect details.

getAllInterconnects

InterconnectsCollection getAllInterconnects(RestParams params)

The module aids in fetching the interconnects details for all the interconnects found under the current HPE OneView.

Parameters:

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

Returns:

InterconnectsCollection containing a collection of interconnects details.

patchInterconnect

TaskResourceV2 patchInterconnect(RestParams params,
                                 String resourceId,
                                 Patch patchDto,
                                 boolean aSync)

Performs a specific patch operation for the given interconnect. There are a limited set of interconnect properties which may be changed. They are: 'powerState', 'uidState', 'deviceResetState'. If the interconnect supports the operation, the operation is performed and a task is returned through which the results are reported.

Parameters:

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

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

patchDto - This is a object containing the update to be made to existing interconnect.

aSync - Flag input to process request asynchronously or synchronously.

Returns:

TaskResourceV2 containing the task status for the process.

updateInterconnectPort

TaskResourceV2 updateInterconnectPort(RestParams params,
                                      String resourceId,
                                      Port portDto,
                                      boolean aSync,
                                      boolean useJsonRequest)

Updates an interconnect port.

Parameters:

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

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

portDto - This is a object containing the update to be made to existing interconnect pointed to by the above mentioned resource identifier.

aSync - Flag input to process request asynchronously or synchronously.

useJsonRequest - The JsonRequest body is part of Port object which takes in a String containing the update to be made, which is converted to Port object using adaptor and processed.

Returns:

TaskResourceV2 containing the task status for the process.

resetInterconnectPortProtection

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

Triggers a reset of port protection.

Parameters:

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

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

aSync - Flag input to process request asynchronously or synchronously.

Returns:

TaskResourceV2 containing the task status for the process.

getInterconnectStatistics

InterconnectsStatistics getInterconnectStatistics(RestParams params,
                                                  String resourceId)

Gets the statistics from an interconnect.

Parameters:

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

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

Returns:

InterconnectsStatistics containing the interconnect statistics details.

getInterconnectPortStatistics

PortStatistics getInterconnectPortStatistics(RestParams params,
                                             String resourceId,
                                             String portName)

Gets the port statistics from an interconnect.

Parameters:

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

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

portName - The name of the port as seen in HPE OneView.

Returns:

PortStatistics containing the port statistics details.

getInterconnectSubportStatistics

SubportStatistics getInterconnectSubportStatistics(RestParams params,
                                                   String resourceId,
                                                   String portName,
                                                   int subportNumber)

Gets the subport statistics from an interconnect.

Parameters:

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

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

portName - The name of the port as seen in HPE OneView.

subportNumber - The number of the subport as seen in HPE OneView.

Returns:

SubportStatistics containing the subport statistics details.

updateInterconnectPorts

TaskResourceV2 updateInterconnectPorts(RestParams params,
                                       String resourceId,
                                       List<Port> portsDto,
                                       boolean aSync,
                                       boolean useJsonRequest)

Updates the interconnect ports.

Parameters:

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

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

portsDto - This is an array of objects containing the update to be made to existing interconnect ports.

aSync - Flag input to process request asynchronously or synchronously..

useJsonRequest - The JsonRequest body is part of list of Port object which takes in a String containing the update to be made, which is converted to an array of Port object using adaptor and processed.

Returns:

TaskResourceV2 containing the task status for the process.

getInterconnectNamedServers

List<NameServer> getInterconnectNamedServers(RestParams params,
                                             String resourceId)

Gets the named servers for an interconnect.

Parameters:

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

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

Returns:

NameServer list, which is an array of objects containing the name servers details.

getId

String getId(RestParams params,
             String name)

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

Parameters:

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

name - The name is the interconnect driver name as seen in HPE OneView.

Returns:

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