Get HPOVServerProfileTemplate - HewlettPackard/POSH-HPEOneView GitHub Wiki

HPE OneView 4.10 Library

Get-HPOVServerProfileTemplate

Retrieve Server Profile Template resource(s).

SYNTAX

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

Get-HPOVServerProfileTemplate[ [-Export] <SwitchParameter>][ [-Location] <String>][ [-Name] <String>][ [-ServerHardwareType] <String>][ [-Label] <String>][ [-Scope] <Object>][ [-ApplianceConnection] <Object>] [<CommonParameters>]

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

Detailed Description

This cmdlet will obtain a collection of Server Profile Template resources, or a specific Server Profile Template with the specified name. It returns all aspects of the Server Profile Template.

This will also provide the ability to export Server Profile Template objects to their own JSON encoded file. All appliance unique properties (minus the Server Hardware Type, Enclosure Group, and Connection Network assignment) are removed. Connection layout, assigned addresses, networks, bandwidth, BIOS, Boot Order, Firmware settings will all be retained. Assigned Address types will change from Virtual to UserDefined in order to retain their assignment.

Parameters

-ApplianceConnection <Object>

Aliases [-Appliance]

Specify one or more HPOneView.Appliance.Connection object(s) or Name property value(s).

Default Value: ${Global:ConnectedSessions} | ? Default

Aliases	Appliance
Required?	false
Position?	named
Default value	(${Global:ConnectedSessions} \| ? Default)
Accept pipeline input?	true (ByPropertyName)
Accept wildcard characters?	False

-Detailed <SwitchParameter>

Displays detailed information about the Server Profile Template in tabular format

Aliases	None
Required?	false
Position?	named
Default value	False
Accept pipeline input?	false
Accept wildcard characters?	False

-Export <SwitchParameter>

Aliases [-x] Switch used to export Server Profile Template object to JSON encoded file.

Aliases	x
Required?	false
Position?	named
Default value	False
Accept pipeline input?	false
Accept wildcard characters?	False

-Label <String>

Specify the label associated with resources.

Aliases	None
Required?	false
Position?	named
Default value	False
Accept pipeline input?	false
Accept wildcard characters?	False

-Location <String>

Aliases [-save] Location where to save the Server Profile Template file.

Aliases	save
Required?	false
Position?	named
Default value
Accept pipeline input?	false
Accept wildcard characters?	False

-Name <String>

The name of the specific Server Profile Template resource to retrieve

Aliases	profile
Required?	false
Position?	named
Default value
Accept pipeline input?	false
Accept wildcard characters?	False

-Scope <Object>

Filter resources based on provided Scope membership. By default, all resources for the accounts Active Permissions will be displayed. Allowed values:

* AllResources
* AllResourcesInScope
* HPOneView.Appliance.ScopeCollection
* HPOneView.Appliance.ConnectionPermission

Aliases	None
Required?	False
Position?	named
Default value	AllResourcesInScope
Accept pipeline input?	false
Accept wildcard characters?	False

-ServerHardwareType <String>

Provide the Server Hardware Type resource object or name to return Server Profile Templates designed for it.

Aliases	None
Required?	false
Position?	named
Default value
Accept pipeline input?	true (ByValue)
Accept wildcard characters?	False

This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216)

Input Types

None

Return Values

HPOneView.ServerProfileTemplate [System.Management.Automation.PSCustomObject]

Server Profile template resource

Examples

-------------------------- EXAMPLE 1 --------------------------

$templates = Get-HPOVServerProfileTemplate

Return all the server profile templates managed by the appliance.

-------------------------- EXAMPLE 2 --------------------------

$template = Get-HPOVServerProfileTemplate "SA"

Return the server profile template resource with name "SA".

-------------------------- EXAMPLE 3 --------------------------

$profiletemplates = Get-HPOVServerProfileTemplate profile*

Return server profile template resources that match "profile*".

-------------------------- EXAMPLE 4 --------------------------

Get-HPOVServerProfileTemplate Profile Name Managing BIOS Managing Firmware Assigned State ------------ ------------- ----------------- -------- ----- Copy of test 2 False False Unassigned Normal Test 1 False False Unassigned Normal test 3 False False Unassigned Normal

Generate a list of all server profiles.

-------------------------- EXAMPLE 5 --------------------------

Get-HPOVServerProfileTemplate -name "test 1" Profile Name Managing BIOS Managing Firmware Assigned State ------------ ------------- ----------------- -------- ----- Test 1 False False Unassigned Normal

Show a specific Server Profile Template, "test 1".

-------------------------- EXAMPLE 6 --------------------------

Get-HPOVServerProfileTemplate -export -location c:\profiles

Save all Server Profile Template objects to their own backup file to C:\profiles.

-------------------------- EXAMPLE 7 --------------------------

Get-HPOVServerProfileTemplate -name Profile1 -export -location c:\profiles

Save Profile1 Server Profile template object to its own backup file in C:\pro

HPE OneView 4.00 Library