com.hp.ov.sdk.rest.client

Interface ServerProfileTemplateClient

All Known Implementing Classes:

ServerProfileTemplateClientImpl

public interface ServerProfileTemplateClient

Method Summary

Modifier and Type	Method and Description
TaskResourceV2	createServerProfileTemplate(RestParams params, ServerProfileTemplate serverProfileTemplateDto, boolean aSync) The module aids in the creation of a server profile Template when provided with the server profile Template details as a ServerProfileTemplate object.
TaskResourceV2	deleteServerProfileTemplate(RestParams params, String resourceId, boolean aSync) This method aids in deletion of a server profile template.
ResourceCollection<ServerProfileTemplate>	getAllServerProfileTemplates(RestParams params) The module aids in fetching the server profile Template details for all the server profiles Templates found under the current HPE OneView.
ServerProfile	getNewServerProfile(RestParams params, String resourceId) A server profile object will be returned with the configuration based on this template.
ServerProfileTemplate	getServerProfileTemplateById(RestParams params, String resourceId) The module aids in fetching the server profile Template details for the specified server profile Template resource identifier.
ServerProfileTemplate	getServerProfileTemplateByName(RestParams params, String name) The module aids in fetching the server profile Template details for the server profile Template name as specified in HPE OneView.
TaskResourceV2	updateServerProfileTemplate(RestParams params, String resourceId, ServerProfileTemplate serverProfileTemplateDto, boolean aSync) The module takes in a ServerProfileTemplate object and updates the existing server profile Template based on the resource identifier.

Method Detail

getServerProfileTemplateById

ServerProfileTemplate getServerProfileTemplateById(RestParams params,
                                                   String resourceId)

The module aids in fetching the server profile Template details for the specified server profile Template resource identifier.

Parameters:

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

resourceId - The resource identifier for server profile Template as seen in HPE OneView.

Returns:

ServerProfileTemplate containing the server profile Template details.

getAllServerProfileTemplates

ResourceCollection<ServerProfileTemplate> getAllServerProfileTemplates(RestParams params)

The module aids in fetching the server profile Template details for all the server profiles Templates found under the current HPE OneView.

Parameters:

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

Returns:

ResourceCollection<ServerProfileTemplate> containing the details for all found server profiles Templates.

getNewServerProfile

ServerProfile getNewServerProfile(RestParams params,
                                  String resourceId)

A server profile object will be returned with the configuration based on this template. This profile object can subsequently be used to create a new server profile.

Parameters:

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

resourceId - The resource identifier for server profile Template as seen in HPE OneView.

Returns:

ServerProfile containing the server profile details.

getServerProfileTemplateByName

ServerProfileTemplate getServerProfileTemplateByName(RestParams params,
                                                     String name)

The module aids in fetching the server profile Template details for the server profile Template name as specified in HPE OneView.

Parameters:

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

name - The resourceName is the server profile Template name as seen in HPE OneView.

Returns:

ServerProfileTemplate containing the server profile Template details.

createServerProfileTemplate

TaskResourceV2 createServerProfileTemplate(RestParams params,
                                           ServerProfileTemplate serverProfileTemplateDto,
                                           boolean aSync)

The module aids in the creation of a server profile Template when provided with the server profile Template details as a ServerProfileTemplate object. It can process the request asynchronously or synchronously, based on the flag input.

Parameters:

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

serverProfileTemplateDto - Object containing the server profile template details, used to create a server profile template.

aSync - Flag input to process request asynchronously or synchronously.

Returns:

TaskResourceV2 containing the task status for the process.

updateServerProfileTemplate

TaskResourceV2 updateServerProfileTemplate(RestParams params,
                                           String resourceId,
                                           ServerProfileTemplate serverProfileTemplateDto,
                                           boolean aSync)

The module takes in a ServerProfileTemplate object and updates the existing server profile Template 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 server profile Template as seen in HPE OneView.

serverProfileTemplateDto - Object containing the server profile Template details, used to update a server profile Template.

aSync - Flag input to process request asynchronously or synchronously.

Returns:

TaskResourceV2 containing the task status for the process.

deleteServerProfileTemplate

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

This method aids in deletion of a server profile template.

Parameters:

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

resourceId - The resource identifier for server profile template as seen in HPE OneView.

aSync - flag to indicate whether the request should be processed asynchronously or synchronously.

Returns:

TaskResourceV2 containing the task status for the process.