com.hp.ov.sdk.rest.client

Interface FcSansManagedSanClient

All Known Implementing Classes:

FcSansManagedSanClientImpl

public interface FcSansManagedSanClient

A SAN represents a physical or logical fibre channel SAN or a Flat SAN (i.e. direct wire attach).

Method Summary

Modifier and Type	Method and Description
EndpointsCsvFileResponse	createEndpointsCsvOfManagedSan(RestParams params, String resourceId) Creates an endpoints CSV file for a SAN.
FcSansManagedSanTask	createManagedSanIssuesReport(RestParams params, String resourceId, boolean aSync) Creates a new SAN issues report indicating any connectivity issues in the specified SAN.
SanResponseCollection	getAllManagedSan(RestParams params) The module aids in fetching the managed SAN details for all the managed SANs found under the current HPE OneView.
EndpointResponseCollection	getEndpointsOfManagedSan(RestParams params, String resourceId) Reports all endpoints known within the specified SAN, and data about that endpoint.
String	getId(RestParams params, String name) The module aids in fetching the managed SAN resource identifier for the managed SAN name as specified in HPE OneView.
SanResponse	getManagedSan(RestParams params, String resourceId) The module aids in fetching the managed SAN details for the specified managed SAN resource identifier.
SanResponse	getManagedSanByName(RestParams params, String name) The module aids in fetching the managed SAN details for the managed SAN name as specified in HPE OneView.
SanResponse	updateManagedSan(RestParams params, String resourceId, SanRequest updateSanRequest, boolean aSync, boolean useJsonRequest) The module takes in a SanRequest object or JsonRequest and updates the existing managed SAN based on the resource identifier.

Method Detail

getManagedSan

SanResponse getManagedSan(RestParams params,
                          String resourceId)

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

Parameters:

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

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

Returns:

SanResponse containing the managed SAN details.

getAllManagedSan

SanResponseCollection getAllManagedSan(RestParams params)

The module aids in fetching the managed SAN details for all the managed SANs found under the current HPE OneView.

Parameters:

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

Returns:

SanResponseCollection containing the collection of managed SAN details.

getManagedSanByName

SanResponse getManagedSanByName(RestParams params,
                                String name)

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

Parameters:

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

name - The name is the managed SAN name as seen in HPE OneView.

Returns:

SanResponse containing the managed SAN details.

updateManagedSan

SanResponse updateManagedSan(RestParams params,
                             String resourceId,
                             SanRequest updateSanRequest,
                             boolean aSync,
                             boolean useJsonRequest)

The module takes in a SanRequest object or JsonRequest and updates the existing managed SAN 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 managed SAN as seen in HPE OneView.

updateSanRequest - This is a object containing the managed SAN details, used to update a managed SAN.

aSync - Flag input to process request asynchronously or synchronously.

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

Returns:

SanResponse containing the managed SAN details.

getEndpointsOfManagedSan

EndpointResponseCollection getEndpointsOfManagedSan(RestParams params,
                                                    String resourceId)

Reports all endpoints known within the specified SAN, and data about that endpoint.

Parameters:

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

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

Returns:

EndpointResponseCollection which contains data of all endpoints os the specified SAN.

createManagedSanIssuesReport

FcSansManagedSanTask createManagedSanIssuesReport(RestParams params,
                                                  String resourceId,
                                                  boolean aSync)

Creates a new SAN issues report indicating any connectivity issues in the specified SAN.

Parameters:

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

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

aSync - Flag input to process request asynchronously or synchronously.

Returns:

FcSansManagedSanTask which contains the task status for the process and the report data.

createEndpointsCsvOfManagedSan

EndpointsCsvFileResponse createEndpointsCsvOfManagedSan(RestParams params,
                                                        String resourceId)

Creates an endpoints CSV file for a SAN. Clients should perform a GET on the URI in the response to download the file.

Parameters:

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

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

Returns:

EndpointsCsvFileResponse contains the data of the created CSV file.

getId

String getId(RestParams params,
             String name)

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

Parameters:

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

name - The name is the managed SAN name as seen in HPE OneView.

Returns:

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