com.hp.ov.sdk.rest.client.server

Interface ServerProfileClient

All Superinterfaces:

CreatableResource<ServerProfile>, DeletableResource, PatchableResource, RetrievableResource<ServerProfile>, SearchableResource<ServerProfile>, UpdatableResource<ServerProfile>

public interface ServerProfileClient
extends SearchableResource<ServerProfile>, CreatableResource<ServerProfile>, DeletableResource, UpdatableResource<ServerProfile>, PatchableResource

Nested Class Summary

Nested classes/interfaces inherited from interface com.hp.ov.sdk.rest.client.common.SearchableResource

SearchableResource.GetByNameRequestInterceptor

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERVER_PROFILE_AVAILABLE_NETWORKS_URI
static String	SERVER_PROFILE_AVAILABLE_SERVERS_URI
static String	SERVER_PROFILE_AVAILABLE_STORAGE_SYSTEM_URI
static String	SERVER_PROFILE_AVAILABLE_STORAGE_SYSTEMS_URI
static String	SERVER_PROFILE_AVAILABLE_TARGETS_URI
static String	SERVER_PROFILE_COMPLIANCE_MESSAGES_URI
static String	SERVER_PROFILE_COMPLIANCE_PREVIEW_URI
static String	SERVER_PROFILE_COMPLIANCE_TRANSFORMATION_URI
static String	SERVER_PROFILE_PROFILE_PORTS_URI
static String	SERVER_PROFILE_URI

Method Summary

Modifier and Type	Method and Description
TaskResource	deleteByFilter(String filter, RequestOption... options) Removes the ServerProfile(s) matching the filter.
AvailableNetworks	getAvailableNetworks(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>	getAvailableServers() Returns a list of the servers that are available for assignment to the server profile.
List<AvailableServers>	getAvailableServers(String profileUri) Returns a list of the servers that are available for assignment to the server profile.
List<AvailableServers>	getAvailableServers(String serverHardwareTypeUri, String enclosureGroupUri) Returns a list of the servers that are available for assignment to the server profile.
AvailableStorageSystem	getAvailableStorageSystem(String serverHardwareTypeUri, String enclosureGroupUri, 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.
ResourceCollection<AvailableStorageSystem>	getAvailableStorageSystems(String serverHardwareTypeUri, String enclosureGroupUri) 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	getAvailableTargets(String serverHardwareTypeUri, String enclosureGroupUri, String profileUri) Returns a list of the target servers and empty device bays that are available for assignment to the server profile.
ServerProfileCompliancePreview	getCompliancePreview(String resourceId) Retrieves a preview of manual and automatic updates required to make the server profile consistent with its template.
ServerProfileHealth	getMessages(String resourceId) Returns the error or status messages associated with the specified server profile.
ProfilePorts	getProfilePorts(String serverHardwareTypeUri, String enclosureGroupUri) Returns the port model associated server hardware type and enclosure group.
ServerProfile	getTransformation(String resourceId, String serverHardwareTypeUri, String enclosureGroupUri) Transforms an existing profile by supplying a new server hardware type and enclosure group or both .

Methods inherited from interface com.hp.ov.sdk.rest.client.common.SearchableResource

getByName

Methods inherited from interface com.hp.ov.sdk.rest.client.common.RetrievableResource

get, get, getAll, getAll, getById

Methods inherited from interface com.hp.ov.sdk.rest.client.common.CreatableResource

create

Methods inherited from interface com.hp.ov.sdk.rest.client.common.DeletableResource

delete

Methods inherited from interface com.hp.ov.sdk.rest.client.common.UpdatableResource

update

Methods inherited from interface com.hp.ov.sdk.rest.client.common.PatchableResource

patch

Field Detail

SERVER_PROFILE_URI

static final String SERVER_PROFILE_URI

See Also:

Constant Field Values

SERVER_PROFILE_AVAILABLE_NETWORKS_URI

static final String SERVER_PROFILE_AVAILABLE_NETWORKS_URI

See Also:

Constant Field Values

SERVER_PROFILE_AVAILABLE_SERVERS_URI

static final String SERVER_PROFILE_AVAILABLE_SERVERS_URI

See Also:

Constant Field Values

SERVER_PROFILE_AVAILABLE_STORAGE_SYSTEM_URI

static final String SERVER_PROFILE_AVAILABLE_STORAGE_SYSTEM_URI

See Also:

Constant Field Values

SERVER_PROFILE_AVAILABLE_STORAGE_SYSTEMS_URI

static final String SERVER_PROFILE_AVAILABLE_STORAGE_SYSTEMS_URI

See Also:

Constant Field Values

SERVER_PROFILE_AVAILABLE_TARGETS_URI

static final String SERVER_PROFILE_AVAILABLE_TARGETS_URI

See Also:

Constant Field Values

SERVER_PROFILE_COMPLIANCE_MESSAGES_URI

static final String SERVER_PROFILE_COMPLIANCE_MESSAGES_URI

See Also:

Constant Field Values

SERVER_PROFILE_COMPLIANCE_PREVIEW_URI

static final String SERVER_PROFILE_COMPLIANCE_PREVIEW_URI

See Also:

Constant Field Values

SERVER_PROFILE_COMPLIANCE_TRANSFORMATION_URI

static final String SERVER_PROFILE_COMPLIANCE_TRANSFORMATION_URI

See Also:

Constant Field Values

SERVER_PROFILE_PROFILE_PORTS_URI

static final String SERVER_PROFILE_PROFILE_PORTS_URI

See Also:

Constant Field Values

Method Detail

deleteByFilter

TaskResource deleteByFilter(String filter,
                            RequestOption... options)

Removes the ServerProfile(s) matching the filter. A filter is required to identify the set of resources to be removed.

Parameters:

filter - A general filter/query string that narrows the list of resources.

options - varargs of RequestOption, which can be used to specify + * some request options.

Returns:

TaskResource containing the task status for the process.

getCompliancePreview

ServerProfileCompliancePreview getCompliancePreview(String resourceId)

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

Parameters:

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

Returns:

ServerProfileCompliancePreview object containing the details.

getMessages

ServerProfileHealth getMessages(String resourceId)

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

Parameters:

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

Returns:

ServerProfileHealth object containing the details.

getTransformation

ServerProfile getTransformation(String resourceId,
                                String serverHardwareTypeUri,
                                String enclosureGroupUri)

Transforms an existing profile by supplying a new server hardware type and enclosure group or both . 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.

Parameters:

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

serverHardwareTypeUri - string specifying the server hardware type URI.

enclosureGroupUri - string specifying the enclosure group URI.

Returns:

ServerProfile object containing the details.

getAvailableNetworks

AvailableNetworks getAvailableNetworks(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.

Parameters:

serverHardwareTypeUri - string specifying the server hardware type URI.

enclosureGroupUri - string specifying the enclosure group URI.

Returns:

AvailableNetworks object containing the details.

getAvailableServers

List<AvailableServers> getAvailableServers()

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.

Returns:

List<AvailableServers> containing a collection of available servers details.

getAvailableServers

List<AvailableServers> getAvailableServers(String serverHardwareTypeUri,
                                           String enclosureGroupUri)

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.

Parameters:

serverHardwareTypeUri - string specifying the server hardware type URI.

enclosureGroupUri - string specifying the enclosure group URI.

Returns:

List<AvailableServers> containing a collection of available servers details.

getAvailableServers

List<AvailableServers> getAvailableServers(String profileUri)

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.

Parameters:

profileUri - string specifying the profile URI.

Returns:

List<AvailableServers> containing a collection of available servers details.

getAvailableStorageSystems

ResourceCollection<AvailableStorageSystem> getAvailableStorageSystems(String serverHardwareTypeUri,
                                                                      String enclosureGroupUri)

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.

Parameters:

serverHardwareTypeUri - string specifying the server hardware type URI.

enclosureGroupUri - string specifying the enclosure group URI.

Returns:

ResourceCollection<AvailableStorageSystem> containing the details for all found available storage systems.

getAvailableStorageSystem

AvailableStorageSystem getAvailableStorageSystem(String serverHardwareTypeUri,
                                                 String enclosureGroupUri,
                                                 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.

Parameters:

serverHardwareTypeUri - string specifying the server hardware type URI.

enclosureGroupUri - string specifying the enclosure group URI.

storageSystemId - string specifying the storage system identifier.

Returns:

AvailableStorageSystem containing the storage system details.

getAvailableTargets

AvailableTargets getAvailableTargets(String serverHardwareTypeUri,
                                     String enclosureGroupUri,
                                     String profileUri)

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.

Parameters:

serverHardwareTypeUri - optional string specifying the server hardware type URI.

enclosureGroupUri - optional string specifying the enclosure group URI.

profileUri - optional string specifying the server profile URI.

Returns:

AvailableTargets containing the available target details.

getProfilePorts

ProfilePorts getProfilePorts(String serverHardwareTypeUri,
                             String enclosureGroupUri)

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

Parameters:

serverHardwareTypeUri - string specifying the server hardware type URI.

enclosureGroupUri - string specifying the enclosure group URI.

Returns:

ProfilePorts containing the profile ports details.