Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/HewlettPackard/POSH-HPEOneView/llms.txt

Use this file to discover all available pages before exploring further.

​
Synopsis

Retrieves server profile template resources from an HPE OneView appliance. Supports filtering by name, label, or server hardware type.

​
Syntax

Get-OVServerProfileTemplate
    [-Name <String>]
    [-ServerHardwareType <Object>]
    [-Label <String>]
    [-Scope <Object>]
    [-ApplianceConnection <Object>]
    [<CommonParameters>]

Get-OVServerProfileTemplate
    [-Name <String>]
    [-Detailed]
    [-ServerHardwareType <Object>]
    [-Label <String>]
    [-Scope <Object>]
    [-ApplianceConnection <Object>]
    [<CommonParameters>]

Get-OVServerProfileTemplate
    [-Name <String>]
    [-Export]
    [-Location <String>]
    [-ServerHardwareType <Object>]
    [-Scope <Object>]
    [-ApplianceConnection <Object>]
    [<CommonParameters>]

​
Description

Get-OVServerProfileTemplate queries the HPE OneView appliance for server profile template resources. Templates define a reusable configuration baseline for server profiles. When called without parameters, all templates visible within the caller’s current scope are returned.
  • Use -Name to filter by template name (supports wildcard characters).
  • Use -ServerHardwareType to return only templates compatible with a given server hardware type.
  • Use -Label to filter by assigned label.
  • Use -Detailed to include per-category compliance metadata.
  • Use -Export with -Location to serialise matching templates to JSON files.

​
Parameters

​
Name
string
Name of the template to retrieve. Accepts wildcard characters (*). Alias: profile.
​
ServerHardwareType
object
Server hardware type object (from Get-OVServerHardwareType). When provided, returns only templates targeting that hardware type. Accepts pipeline input.
​
Label
string
Filter results to templates that have been assigned the specified label.
​
Scope
object
Limits results to resources belonging to the specified HPE OneView scope. Defaults to AllResourcesInScope.
​
Detailed
switch
Return extended detail, including per-category consistency metadata, for each matching template.
​
Export
switch
Export each matching template to a JSON file. Requires -Location. Alias: x.
​
Location
string
Directory path where exported JSON files will be written. The directory is created if it does not exist. Requires -Export. Alias: save.
​
ApplianceConnection
object
Specifies the HPE OneView appliance connection to query. Defaults to the default connected session. Alias: Appliance.

​
Examples

​
Get all server profile templates

Get-OVServerProfileTemplate
Returns all server profile templates from the default connected appliance.

​
Get a template by name

Get-OVServerProfileTemplate -Name 'Hypervisor Cluster Node Template v1'

​
Get templates for a specific server hardware type

$SHT = Get-OVServerHardwareType -Name 'SY 480 Gen10 1'
Get-OVServerProfileTemplate -ServerHardwareType $SHT
Returns all templates compatible with the SY 480 Gen10 1 hardware type.

​
Export all templates to disk

Get-OVServerProfileTemplate -Export -Location 'C:\Backup\Templates'
Exports all server profile templates to JSON files in C:\Backup\Templates.

​
Output

HPEOneView.ServerProfileTemplate — One or more server profile template objects.