Remove HPOVServerProfile - HewlettPackard/POSH-HPEOneView GitHub Wiki

HPE OneView 4.10 Library

Remove-HPOVServerProfile

Delete Server Profile Resource(s).

SYNTAX

Remove-HPOVServerProfile [-ServerProfile] <Object> [-ApplianceConnection] <Object>[ [-force] <SwitchParameter>][ [-WhatIf] <SwitchParameter>][ [-Confirm] <SwitchParameter>] [<CommonParameters>]

Detailed Description

This cmdlet will remove Server Profile resources from one or more appliance connections. Server Profile objects or names are supported. Server Profile resources can only be removed when the BladeSystem (BL) Server Hardware device is powered off.

Parameters

-ApplianceConnection <Object>

Aliases [-Appliance]

Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.

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

-Confirm <SwitchParameter>

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

-ServerProfile <Object>

Aliases [-profile, -uri, -name] The server profile object(s), name(s) or URI(s) to be removed.

Aliases	uri, name, profile
Required?	true
Position?	named
Default value
Accept pipeline input?	true (ByValue)
Accept wildcard characters?	False

-WhatIf <SwitchParameter>

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

-force <SwitchParameter>

Set to force-delete the profile. For example, force-remove will successfully remove the profile, even when connectivity has been lost to the server or enclosure.

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

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

Server Profile resource object.

System.String

Server Profile resource name.

Return Values

HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]

A task resource that can be monitored for status of the profile deletion

System.Collections.ArrayList <HPOneView.Appliance.TaskResource>

Multiple Async task resources.

Examples

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

$task = Remove-HPOVServerProfile -profile "Profile6" Wait-HPOVTaskComplete $task.uri

Remove the profile specifed by name. Wait for remove to complete.

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

$profile = Get-HPOVServerProfile -name "Profile2" Remove-HPOVServerProfile $profile -confirm:$false

Remove the profile specifed by $profile. Disable confirmation prompt.

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

Get-HPOVServerProfile | Remove-HPOVServerProfile

Search for all profiles and remove them from appliance.

HPE OneView 4.00 Library