Skip to content

Get HPOVServerProfile

Jump to bottom
Chris Lynch edited this page Dec 10, 2020 · 43 revisions

Library Version 4.20

Library Version 4.10

Library Version 4.00

HPE OneView 4.10 Library

Get-HPOVServerProfile

Retrieve Server Profile resource(s).

SYNTAX

Get-HPOVServerProfile [-Name] <String>[ [-NonCompliant] <SwitchParameter>][ [-Unassigned] <SwitchParameter>][ [-InputObject] <Object>][ [-Label] <String>][ [-Scope] <Object>] [-ApplianceConnection] <Object> [<CommonParameters>]
Get-HPOVServerProfile[ [-export] <SwitchParameter>] [-location] <String> [-Name] <String>[ [-Unassigned] <SwitchParameter>][ [-InputObject] <Object>][ [-Label] <String>][ [-Scope] <Object>] [-ApplianceConnection] <Object> [<CommonParameters>]
Get-HPOVServerProfile[ [-Detailed] <SwitchParameter>] [-Name] <String>[ [-Label] <String>][ [-Scope] <Object>] [-ApplianceConnection] <Object> [<CommonParameters>]

Detailed Description

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

This will also provide the ability to export Server Profile 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? true
Position? named
Default value (${Global:ConnectedSessions} | ? Default)
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters?    False

-Detailed <SwitchParameter>

Display detailed report list of Server Profiles

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

-InputObject <Object>

Profile a Server Hardware or Server Profile Template resource, and the associated Server Hardware will be returned.

Aliases None
Required? false
Position? named
Default value
Accept pipeline input? true (ByValue)
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

-Name <String>

Aliases [-profile] The name of the server profile resource to be returned. All server profile resources will be returned if omitted. Supports * wildcard character.

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

-NonCompliant <SwitchParameter>

Return collection of Server Profiles that are not compliant with their template. Will not return Server Profiles that have no Template association.

Aliases None
Required? false
Position? named
Default value False
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

-Unassigned <SwitchParameter>

Optional parameter that can be included with the List switch parameter to only display unassigned Server Profiles. Can also be combined with the name parameter for Server Profile wildcard name search.

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 object to JSON encoded file.

Aliases x
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

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

<CommonParameters>

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. You cannot pipe objects to this cmdlet.

Return Values

System.Management.Automation.PSCustomObject

Examples

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

Get-HPOVServerProfile
Profile Name   Managing BIOS Managing Firmware Assigned      State
------------   ------------- ----------------- --------      -----
Copy of test 2         False             False Unassigned    Normal
Profile 11              True              True Encl1, bay 11 Normal
Profile 12             False             False Encl1, bay 12 Normal
Profile 13             False             False Encl1, bay 13 Normal
Profile 14             False             False Encl1, bay 14 Normal
Profile 15             False             False Encl1, bay 15 Normal
Profile 16             False             False Encl1, bay 16 Normal
Test 1                 False             False Unassigned    Normal
test 2                 False             False Encl1, bay 3  Normal
test 3                 False             False Unassigned    Normal

Generate a list of all server profiles.

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

$profile = Get-HPOVServerProfile -Name "SA"

Return the server profile resource with name "SA".

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

$profiles = Get-HPOVServerProfile -Name profile*

Return server profile resources that match "profile*".

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

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

Generate a report of a specific server profile.

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

Get-HPOVServerProfile -unassigned
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 Unassigned server profiles.

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

Get-HPOVServerProfile -export -location c:\profiles

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

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

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

Save Profile1 Server Profile object to its own backup file in C:\profiles.

Related Links

HPE OneView 4.00 Library

Get-HPOVServerProfile

Retrieve Server Profile resource(s).

SYNTAX

Get-HPOVServerProfile [-Name] <String>[ [-NonCompliant] <SwitchParameter>][ [-Unassigned] <SwitchParameter>][ [-InputObject] <Object>][ [-Label] <String>][ [-Scope] <Object>] [-ApplianceConnection] <Object> [<CommonParameters>]
Get-HPOVServerProfile[ [-export] <SwitchParameter>] [-location] <String> [-Name] <String>[ [-Unassigned] <SwitchParameter>][ [-InputObject] <Object>][ [-Label] <String>][ [-Scope] <Object>] [-ApplianceConnection] <Object> [<CommonParameters>]
Get-HPOVServerProfile[ [-Detailed] <SwitchParameter>] [-Name] <String>[ [-Label] <String>][ [-Scope] <Object>] [-ApplianceConnection] <Object> [<CommonParameters>]

Detailed Description

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

This will also provide the ability to export Server Profile 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? true
Position? named
Default value (${Global:ConnectedSessions} | ? Default)
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters?    False

-Detailed <SwitchParameter>

Display detailed report list of Server Profiles

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

-InputObject <Object>

Profile a Server Hardware or Server Profile Template resource, and the associated Server Hardware will be returned.

Aliases None
Required? false
Position? named
Default value
Accept pipeline input? true (ByValue)
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

-Name <String>

Aliases [-profile] The name of the server profile resource to be returned. All server profile resources will be returned if omitted. Supports * wildcard character.

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

-NonCompliant <SwitchParameter>

Return collection of Server Profiles that are not compliant with their template. Will not return Server Profiles that have no Template association.

Aliases None
Required? false
Position? named
Default value False
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

-Unassigned <SwitchParameter>

Optional parameter that can be included with the List switch parameter to only display unassigned Server Profiles. Can also be combined with the name parameter for Server Profile wildcard name search.

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 object to JSON encoded file.

Aliases x
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

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

<CommonParameters>

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. You cannot pipe objects to this cmdlet.

Return Values

System.Management.Automation.PSCustomObject

Examples

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

Get-HPOVServerProfile 
Profile Name   Managing BIOS Managing Firmware Assigned      State
------------   ------------- ----------------- --------      -----
Copy of test 2         False             False Unassigned    Normal
Profile 11              True              True Encl1, bay 11 Normal
Profile 12             False             False Encl1, bay 12 Normal
Profile 13             False             False Encl1, bay 13 Normal
Profile 14             False             False Encl1, bay 14 Normal
Profile 15             False             False Encl1, bay 15 Normal
Profile 16             False             False Encl1, bay 16 Normal
Test 1                 False             False Unassigned    Normal
test 2                 False             False Encl1, bay 3  Normal
test 3                 False             False Unassigned    Normal

Generate a list of all server profiles.

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

$profile = Get-HPOVServerProfile -Name "SA"

Return the server profile resource with name "SA".

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

$profiles = Get-HPOVServerProfile -Name profile*

Return server profile resources that match 'profile*'.

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

Get-HPOVServerProfile -name 'test 1' -list
Profile Name   Managing BIOS Managing Firmware Assigned      State
------------   ------------- ----------------- --------      -----
Test 1                 False             False Unassigned    Normal

Generate a report of a specific server profile.

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

Get-HPOVServerProfile -unassigned
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 Unassigned server profiles.

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

Get-HPOVServerProfile -export -location c:\profiles

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

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

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

Save Profile1 Server Profile object to its own backup file in C:\profiles.

Related Links

Wiki Table of Contents

Clone this wiki locally