com.hp.ov.sdk.rest.client

Class ServerProfileClientImpl

java.lang.Object

com.hp.ov.sdk.rest.client.ServerProfileClientImpl

All Implemented Interfaces:

ServerProfileClient

public class ServerProfileClientImpl
extends Object
implements ServerProfileClient

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ServerProfileClientImpl(ServerProfileAdaptor adaptor, TaskAdaptor taskAdaptor, TaskMonitorManager taskMonitor, ServerHardwareClient serverHardwareClientImpl)

Method Summary

Modifier and Type	Method and Description
TaskResourceV2	createServerProfile(RestParams params, ServerProfile serverProfileDto, boolean aSync, boolean useJsonRequest) The module aids in the creation of a server profile when provided with the server profile details as a ServerProfile object or JsonRequest.
TaskResourceV2	deleteServerProfile(RestParams params, String resourceId, boolean aSync) The module aids in deleting a server profile for the specified server profile resource identifier.
TaskResourceV2	deleteServerProfileByFilter(RestParams params, String filter, Boolean match, boolean aSync) This module aids in deleting all server profile objects from the appliance that match the provided filter.
ServerProfileCollection	getAllServerProfile(RestParams params) The module aids in fetching the server profile details for all the server profiles found under the current HPE OneView.
AvailableNetworks	getAvailableNetworksForServerProfile(RestParams params, String serverHardwareTypeUri, String enclosureGroupUri) The module aids in retrieving the list of ethernet networks, fibre channel networks and network sets that are available to a server profile along with their respective ports for the specified enclosure group URI and server hardware type URI.
List<AvailableServers>	getAvailableServersForServerProfile(RestParams params) Returns a list of the servers that are available for assignment to the server profile.
List<AvailableServers>	getAvailableServersForServerProfile(RestParams params, String profileUri) Returns a list of the servers that are available for assignment to the server profile.
List<AvailableServers>	getAvailableServersForServerProfile(RestParams params, String serverHardwareTypeUri, String enclosureGroupUri) Returns a list of the servers that are available for assignment to the server profile.
AvailableStorageSystem	getAvailableStorageSystemForServerProfile(RestParams params, String enclosureGroupUri, String serverHardwareTypeUri, String storageSystemId) Returns a specific storage system and its associated volumes that are available to the server profile based on the given server hardware type and enclosure group.
AvailableStorageSystems	getAvailableStorageSystemsForServerProfile(RestParams params, String enclosureGroupUri, String serverHardwareTypeUri) Returns the list of the storage systems and their associated volumes that are available to the server profile based on the given server hardware type and enclosure group.
AvailableTargets	getAvailableTargetsForServerProfile(RestParams params) Returns a list of the target servers and empty device bays that are available for assignment to the server profile.
AvailableTargets	getAvailableTargetsForServerProfile(RestParams params, String enclosureGroupUri, String serverHardwareTypeUri, String profileUri) Returns a list of the target servers and empty device bays that are available for assignment to the server profile.
static ServerProfileClient	getClient()
String	getId(RestParams params, String name) The module aids in fetching the server profile resource identifier for the server profile name as specified in HPE OneView.
ProfilePorts	getProfilePortsForServerProfile(RestParams params, String serverHardwareTypeUri, String enclosureGroupUri) Returns the port model associated server hardware type and enclosure group.
ServerProfile	getServerProfile(RestParams params, String resourceId) The module aids in fetching the server profile details for the specified server profile resource identifier.
ServerProfile	getServerProfileByName(RestParams params, String name) The module aids in fetching the server profile details for the server profile name as specified in HPE OneView.
ServerProfileCompliancePreview	getServerProfileCompliancePreview(RestParams params, String resourceId) Returns the preview of manual and automatic updates required to make the server profile consistent with its template.
ServerProfileHealth	getServerProfileMessages(RestParams params, String resourceId) Returns the error or status messages associated with the specified server profile.
ServerProfile	getServerProfileTransformation(RestParams params, String resourceId, String serverHardwareTypeUri, String enclosureGroupUri) Transforms an existing profile by supplying a new server hardware type and/or enclosure group.
TaskResourceV2	patchServerProfile(RestParams params, String resourceId, Patch patchDto, boolean aSync) Use the PATCH REST API to update the server profile.
TaskResourceV2	updateServerProfile(RestParams params, String resourceId, ServerProfile serverProfileDto, boolean aSync, boolean useJsonRequest) The module takes in a ServerProfile object or JsonRequest and updates the existing server profile based on the resource identifier.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ServerProfileClientImpl

protected ServerProfileClientImpl(ServerProfileAdaptor adaptor,
                                  TaskAdaptor taskAdaptor,
                                  TaskMonitorManager taskMonitor,
                                  ServerHardwareClient serverHardwareClientImpl)

Method Detail

getClient

public static ServerProfileClient getClient()

getServerProfile

public ServerProfile getServerProfile(RestParams params,
                                      String resourceId)

Description copied from interface: ServerProfileClient

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

Specified by:

getServerProfile in interface ServerProfileClient

Parameters:

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

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

Returns:

ServerProfile containing the server profile details.

getAllServerProfile

public ServerProfileCollection getAllServerProfile(RestParams params)

Description copied from interface: ServerProfileClient

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

Specified by:

getAllServerProfile in interface ServerProfileClient

Parameters:

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

Returns:

ServerProfileCollection containing a collection of server profile details.

getServerProfileByName

public ServerProfile getServerProfileByName(RestParams params,
                                            String name)

Description copied from interface: ServerProfileClient

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

Specified by:

getServerProfileByName in interface ServerProfileClient

Parameters:

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

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

Returns:

ServerProfile containing the server profile details.

getServerProfileCompliancePreview

public ServerProfileCompliancePreview getServerProfileCompliancePreview(RestParams params,
                                                                        String resourceId)

Description copied from interface: ServerProfileClient

Returns the preview of manual and automatic updates required to make the server profile consistent with its template.

Specified by:

getServerProfileCompliancePreview in interface ServerProfileClient

Parameters:

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

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

Returns:

ServerProfileCompliancePreview containing the server profile compliance preview details.

getServerProfileMessages

public ServerProfileHealth getServerProfileMessages(RestParams params,
                                                    String resourceId)

Description copied from interface: ServerProfileClient

Returns the error or status messages associated with the specified server profile.

Specified by:

getServerProfileMessages in interface ServerProfileClient

Parameters:

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

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

Returns:

ServerProfileHealth containing the server profile health details.

getServerProfileTransformation

public ServerProfile getServerProfileTransformation(RestParams params,
                                                    String resourceId,
                                                    String serverHardwareTypeUri,
                                                    String enclosureGroupUri)

Description copied from interface: ServerProfileClient

Transforms an existing profile by supplying a new server hardware type and/or enclosure group. A profile will be returned with a new configuration based on the capabilities of the supplied server hardware type and/or enclosure group. All deployed connections will have their port assignment set to 'Auto'. Re-selection of the server hardware may also be required. The new profile can subsequently be used for the PUT https://{appl}/rest/server-profiles/{id} API but is not guaranteed to pass validation. Any incompatibilities will be flagged when the transformed server profile is submitted.

Specified by:

getServerProfileTransformation in interface ServerProfileClient

Parameters:

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

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

serverHardwareTypeUri - String, specifying the server hardware type URI.

enclosureGroupUri - String, specifying the enclosure group URI.

Returns:

ServerProfile containing the server profile details.

getAvailableNetworksForServerProfile

public AvailableNetworks getAvailableNetworksForServerProfile(RestParams params,
                                                              String serverHardwareTypeUri,
                                                              String enclosureGroupUri)

Description copied from interface: ServerProfileClient

The module aids in retrieving the list of ethernet networks, fibre channel networks and network sets that are available to a server profile along with their respective ports for the specified enclosure group URI and server hardware type URI.

Specified by:

getAvailableNetworksForServerProfile in interface ServerProfileClient

Parameters:

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

serverHardwareTypeUri - String, specifying the server hardware type URI.

enclosureGroupUri - String, specifying the enclosure group URI.

Returns:

AvailableNetworks containing the AvailableNetworks details.

getAvailableServersForServerProfile

public List<AvailableServers> getAvailableServersForServerProfile(RestParams params)

Description copied from interface: ServerProfileClient

Returns a list of the servers that are available for assignment to the server profile. This API differs from the /rest/server-profiles/available-targets API in that this API does not include empty device bays.

Specified by:

getAvailableServersForServerProfile in interface ServerProfileClient

Parameters:

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

Returns:

List of AvailableServers containing a collection of available servers details.

getAvailableServersForServerProfile

public List<AvailableServers> getAvailableServersForServerProfile(RestParams params,
                                                                  String serverHardwareTypeUri,
                                                                  String enclosureGroupUri)

Description copied from interface: ServerProfileClient

Returns a list of the servers that are available for assignment to the server profile. This API differs from the /rest/server-profiles/available-targets API in that this API does not include empty device bays for specified server hardware type URI and enclosure group URI.

Specified by:

getAvailableServersForServerProfile in interface ServerProfileClient

Parameters:

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

serverHardwareTypeUri - String, specifying the server hardware type URI.

enclosureGroupUri - String, specifying the enclosure group URI.

Returns:

List of AvailableServers containing a collection of available servers details.

getAvailableServersForServerProfile

public List<AvailableServers> getAvailableServersForServerProfile(RestParams params,
                                                                  String profileUri)

Description copied from interface: ServerProfileClient

Returns a list of the servers that are available for assignment to the server profile. This API differs from the /rest/server-profiles/available-targets API in that this API does not include empty device bays for given profile URI.

Specified by:

getAvailableServersForServerProfile in interface ServerProfileClient

Parameters:

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

profileUri - String, specifying the server profile URI.

Returns:

List of AvailableServers containing a collection of available servers details.

getAvailableStorageSystemsForServerProfile

public AvailableStorageSystems getAvailableStorageSystemsForServerProfile(RestParams params,
                                                                          String enclosureGroupUri,
                                                                          String serverHardwareTypeUri)

Description copied from interface: ServerProfileClient

Returns the list of the storage systems and their associated volumes that are available to the server profile based on the given server hardware type and enclosure group.

Specified by:

getAvailableStorageSystemsForServerProfile in interface ServerProfileClient

Parameters:

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

enclosureGroupUri - String, specifying the enclosure group URI.

serverHardwareTypeUri - String, specifying the server hardware type URI.

Returns:

AvailableStorageSystems containing a collection of storage system details.

getAvailableStorageSystemForServerProfile

public AvailableStorageSystem getAvailableStorageSystemForServerProfile(RestParams params,
                                                                        String enclosureGroupUri,
                                                                        String serverHardwareTypeUri,
                                                                        String storageSystemId)

Description copied from interface: ServerProfileClient

Returns a specific storage system and its associated volumes that are available to the server profile based on the given server hardware type and enclosure group.

Specified by:

getAvailableStorageSystemForServerProfile in interface ServerProfileClient

Parameters:

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

enclosureGroupUri - String, specifying the enclosure group URI.

serverHardwareTypeUri - String, specifying the server hardware type URI.

storageSystemId - String, specifying the storage system identifier.

Returns:

AvailableStorageSystem containing the storage system details.

getAvailableTargetsForServerProfile

public AvailableTargets getAvailableTargetsForServerProfile(RestParams params)

Description copied from interface: ServerProfileClient

Returns a list of the target servers and empty device bays that are available for assignment to the server profile. This replaces the /rest/server-profiles/available-servers API.

Specified by:

getAvailableTargetsForServerProfile in interface ServerProfileClient

Parameters:

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

Returns:

AvailableTargets containing the available target details.

getAvailableTargetsForServerProfile

public AvailableTargets getAvailableTargetsForServerProfile(RestParams params,
                                                            String enclosureGroupUri,
                                                            String serverHardwareTypeUri,
                                                            String profileUri)

Description copied from interface: ServerProfileClient

Returns a list of the target servers and empty device bays that are available for assignment to the server profile. This replaces the /rest/server-profiles/available-servers API.

Specified by:

getAvailableTargetsForServerProfile in interface ServerProfileClient

Parameters:

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

enclosureGroupUri - String, specifying the enclosure group URI.

serverHardwareTypeUri - String, specifying the server hardware type URI.

profileUri - String, specifying the server profile URI.

Returns:

AvailableTargets containing the available target details.

getProfilePortsForServerProfile

public ProfilePorts getProfilePortsForServerProfile(RestParams params,
                                                    String serverHardwareTypeUri,
                                                    String enclosureGroupUri)

Description copied from interface: ServerProfileClient

Returns the port model associated server hardware type and enclosure group.

Specified by:

getProfilePortsForServerProfile in interface ServerProfileClient

Parameters:

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

serverHardwareTypeUri - String, specifying the server hardware type identifier.

enclosureGroupUri - String, specifying the enclosure group identifier.

Returns:

ProfilePorts containing the profile ports details.

createServerProfile

public TaskResourceV2 createServerProfile(RestParams params,
                                          ServerProfile serverProfileDto,
                                          boolean aSync,
                                          boolean useJsonRequest)

Description copied from interface: ServerProfileClient

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

Specified by:

createServerProfile in interface ServerProfileClient

Parameters:

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

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

aSync - Flag input to process request asynchronously or synchronously.

useJsonRequest - The JsonRequest body is part of ServerProfile object which takes in a String containing the new server profile details, which is converted to ServerProfile object using an adaptor and processed.

Returns:

TaskResourceV2 containing the task status for the process.

updateServerProfile

public TaskResourceV2 updateServerProfile(RestParams params,
                                          String resourceId,
                                          ServerProfile serverProfileDto,
                                          boolean aSync,
                                          boolean useJsonRequest)

Description copied from interface: ServerProfileClient

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

Specified by:

updateServerProfile in interface ServerProfileClient

Parameters:

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

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

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

aSync - Flag input to process request asynchronously or synchronously.

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

Returns:

TaskResourceV2 containing the task status for the process.

patchServerProfile

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

Description copied from interface: ServerProfileClient

Use the PATCH REST API to update the server profile. Ex: To update the server profile from the server profile template: Operation: replace Path: /templateCompliance Value: Compliant

Specified by:

patchServerProfile in interface ServerProfileClient

Parameters:

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

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

patchDto - Object containing the patch details, used to update a server profile.

aSync - Flag input to process request asynchronously or synchronously.

Returns:

TaskResourceV2 containing the task status for the process.

deleteServerProfile

public TaskResourceV2 deleteServerProfile(RestParams params,
                                          String resourceId,
                                          boolean aSync)

Description copied from interface: ServerProfileClient

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

Specified by:

deleteServerProfile in interface ServerProfileClient

Parameters:

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

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

aSync - Flag input to process request asynchronously or synchronously.

Returns:

TaskResourceV2 containing the task status for the process.

deleteServerProfileByFilter

public TaskResourceV2 deleteServerProfileByFilter(RestParams params,
                                                  String filter,
                                                  Boolean match,
                                                  boolean aSync)

Description copied from interface: ServerProfileClient

This module aids in deleting all server profile objects from the appliance that match the provided filter.

Specified by:

deleteServerProfileByFilter in interface ServerProfileClient

Parameters:

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

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

match - Flag input to process filter with %filter% or just filter.

aSync - Flag input to process request asynchronously or synchronously.

Returns:

TaskResourceV2 containing the task status for the process.

getId

public String getId(RestParams params,
                    String name)

Description copied from interface: ServerProfileClient

The module aids in fetching the server profile resource identifier for the server profile name as specified in HPE OneView.

Specified by:

getId in interface ServerProfileClient

Parameters:

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

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

Returns:

String which is the resource identifier for the server profile name as seen in HPE OneView.