Skip to content

Remove HPOVEnclosure

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

Library Version 4.20

Library Version 4.10

Library Version 4.00

HPE OneView 4.10 Library

Remove-HPOVEnclosure

Removes an enclosure and associated devices.

SYNTAX

Remove-HPOVEnclosure [-InputObject] <Object> [-ApplianceConnection] <Array>[ [-Force] <SwitchParameter>][ [-WhatIf] <SwitchParameter>][ [-Confirm] <SwitchParameter>] [<CommonParameters>]

Detailed Description

Removes an enclosure, its servers, and interconnects from appliance management

Parameters

-ApplianceConnection <Array>

Aliases [-Appliance]

Specify one or more HPOneView.Appliance.Connection object(s) or Name property value(s). 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

-Force <SwitchParameter>

Set to force-remove the enclosure. For example, if the enclosure is gone or is now being managed by a different appliance, force-removing will remove the enclosure from this appliance without clearing vcmode.

When the request is accepted by the appliance, it does not return an Async Task Resource.

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

-InputObject <Object>

Aliases [-name, -enclosure] The Enclosure object(s) or name(s) to be removed from management.

Aliases uri, name, Enclosure, Resource
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

<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

System.Collections.ArrayList

Collection of Enclosure Resources

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

Single Enclosure resource object

Return Values

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

Removal async task

System.Management.Automation.PSCustomObject

When using the -Force parameter, a PSCustomObject is returned indicating successful removal of the resource

Examples

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

$task = Remove-HPOVEnclosure -enclosure "Enclosure-1234" -force
Wait-HPOVTaskComplete $task

Force-remove the enclosure specifed by name. Wait for remove to complete.

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

$enclosure = Get-HPOVEnclosure -name "Enclosure1"
Remove-HPOVEnclosure $enclosure -confirm:$false

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

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

Get-HPOVEnclosure | Remove-HPOVEnclosure

Search for all enclosures and remove them from appliance.

Related Links

HPE OneView 4.00 Library

Remove-HPOVEnclosure

Removes an enclosure and associated devices.

SYNTAX

Remove-HPOVEnclosure [-InputObject] <Object> [-ApplianceConnection] <Array>[ [-Force] <SwitchParameter>][ [-WhatIf] <SwitchParameter>][ [-Confirm] <SwitchParameter>] [<CommonParameters>]

Detailed Description

Removes an enclosure, its servers, and interconnects from appliance management

Parameters

-ApplianceConnection <Array>

Aliases [-Appliance]

Specify one or more HPOneView.Appliance.Connection object(s) or Name property value(s). 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

-Force <SwitchParameter>

Set to force-remove the enclosure. For example, if the enclosure is gone or is now being managed by a different appliance, force-removing will remove the enclosure from this appliance without clearing vcmode.

When the request is accepted by the appliance, it does not return an Async Task Resource.

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

-InputObject <Object>

Aliases [-name, -enclosure] The Enclosure object(s) or name(s) to be removed from management.

Aliases uri, name, Enclosure, Resource
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

<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

System.Collections.ArrayList

Collection of Enclosure Resources

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

Single Enclosure resource object

Return Values

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

Removal async task

System.Management.Automation.PSCustomObject

When using the -Force parameter, a PSCustomObject is returned indicating successful removal of the resource

Examples

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

$task = Remove-HPOVEnclosure -enclosure "Enclosure-1234" -force
Wait-HPOVTaskComplete $task

Force-remove the enclosure specifed by name. Wait for remove to complete.

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

$enclosure = Get-HPOVEnclosure -name "Enclosure1"
Remove-HPOVEnclosure $enclosure -confirm:$false

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

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

Get-HPOVEnclosure | Remove-HPOVEnclosure

Search for all enclosures and remove them from appliance.

Related Links

Wiki Table of Contents

Clone this wiki locally