com.hp.ov.sdk.rest.client

Interface NetworkClient

All Known Implementing Classes:

NetworkClientImpl

public interface NetworkClient

Method Summary

Modifier and Type	Method and Description
TaskResourceV2	createNetwork(RestParams params, Network networkDto, boolean aSync, boolean useJsonRequest) The module aids in creation of an ethernet network when provided with the ethernet network details as a Network object or JsonRequest.
TaskResourceV2	createNetworkInBulk(RestParams params, BulkEthernetNetwork bulkEthernetDto, boolean aSync, boolean useJsonRequest) The module aids in creation of set of ethernet networks when provided with the ethernet network details as a BulkEthernetNetwork object or a JsonRequest containing a VLAN identifier range.
TaskResourceV2	deleteNetwork(RestParams params, String resourceId, boolean aSync) The module aids in deleting a ethernet network for the specified ethernet network resource identifier.
NetworkCollection	getAllNetworks(RestParams params) The module aids in fetching the ethernet network details for all the ethernet networks found under the current HPE OneView.
String	getId(RestParams params, String name) The module aids in fetching the ethernet network resource identifier for the ethernet network name as specified in HPE OneView.
Network	getNetwork(RestParams params, String resourceId) The module aids in fetching the Network details for the specified ethernet network resource identifier.
List<String>	getNetworkAssociatedProfiles(RestParams params, String resourceId) Returns a list of profile URIs for the ethernet network.
List<String>	getNetworkAssociatedUplinkGroups(RestParams params, String resourceId) Returns the uplink sets which are using an ethernet network.
Network	getNetworkByName(RestParams params, String name) The module aids in fetching the ethernet network details for the ethernet network name as specified in HPE OneView.
TaskResourceV2	updateNetwork(RestParams params, String resourceId, Network networkDto, boolean aSync, boolean useJsonRequest) The module takes in a Network object or JsonRequest and updates the existing ethernet network based on the resource identifier.

Method Detail

getNetwork

Network getNetwork(RestParams params,
                   String resourceId)

The module aids in fetching the Network details for the specified ethernet network resource identifier.

Parameters:

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

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

Returns:

Network containing the ethernet network details.

getAllNetworks

NetworkCollection getAllNetworks(RestParams params)

The module aids in fetching the ethernet network details for all the ethernet networks found under the current HPE OneView.

Parameters:

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

Returns:

NetworkCollection containing the collection of ethernet network details.

getNetworkByName

Network getNetworkByName(RestParams params,
                         String name)

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

Parameters:

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

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

Returns:

Network containing the ethernet network details.

createNetwork

TaskResourceV2 createNetwork(RestParams params,
                             Network networkDto,
                             boolean aSync,
                             boolean useJsonRequest)

The module aids in creation of an ethernet network when provided with the ethernet network details as a Network object or JsonRequest. It can process the request asynchronously or synchronously, based on the flag input. ATTENTION: if you use async mode equals to true and you set some connection template data, this information will not be used. Thus, we strongly recommend the value false for the async flag if you want to set bandwidth values.

Parameters:

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

networkDto - This is a object containing the ethernet network details, used to create a ethernet network.

aSync - Flag input to process request asynchronously or synchronously (preferable false).

useJsonRequest - The JsonRequest body is part of Network object which takes in a String containing the new ethernet network details, which is converted to Network object using adaptor and processed.

Returns:

TaskResourceV2 containing the task status for the process.

updateNetwork

TaskResourceV2 updateNetwork(RestParams params,
                             String resourceId,
                             Network networkDto,
                             boolean aSync,
                             boolean useJsonRequest)

The module takes in a Network object or JsonRequest and updates the existing ethernet network based on the resource identifier. It can process the request asynchronously or synchronously, based on the flag input.

Parameters:

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

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

networkDto - This is a object containing the ethernet network details, used to update a ethernet network

aSync - Flag input to process request asynchronously or synchronously.

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

Returns:

TaskResourceV2 containing the task status for the process.

deleteNetwork

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

The module aids in deleting a ethernet network for the specified ethernet network resource identifier. It can process the request asynchronously or synchronously, based on the flag input.

Parameters:

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

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

aSync - Flag input to process request asynchronously or synchronously.

Returns:

TaskResourceV2 containing the task status for the process.

createNetworkInBulk

TaskResourceV2 createNetworkInBulk(RestParams params,
                                   BulkEthernetNetwork bulkEthernetDto,
                                   boolean aSync,
                                   boolean useJsonRequest)

The module aids in creation of set of ethernet networks when provided with the ethernet network details as a BulkEthernetNetwork object or a JsonRequest containing a VLAN identifier range. It can process the request asynchronously or synchronously, based on the flag input.

Parameters:

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

bulkEthernetDto - This is a object containing the BulkEthernetNetwork details, used to create a set of ethernet networks for the mentioned range with VLAN name as suffix.

aSync - Flag input to process request asynchronously or synchronously.

useJsonRequest - The JsonRequest body is part of BulkEthernetNetwork object which takes in a String containing the new bulk ethernet network details, which is converted to a BulkEthernetNetwork object using an adaptor and processed.

Returns:

TaskResourceV2 containing the task status for the process.

getNetworkAssociatedProfiles

List<String> getNetworkAssociatedProfiles(RestParams params,
                                          String resourceId)

Returns a list of profile URIs for the ethernet network.

Parameters:

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

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

Returns:

list of profile URIs for the specified ethernet network.

getNetworkAssociatedUplinkGroups

List<String> getNetworkAssociatedUplinkGroups(RestParams params,
                                              String resourceId)

Returns the uplink sets which are using an ethernet network.

Parameters:

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

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

Returns:

list of uplink sets using the specified ethernet network.

getId

String getId(RestParams params,
             String name)

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

Parameters:

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

name - The name is the ethernet network name as seen in HPE OneView.

Returns:

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