Skip to content

Remove HPOVEnclosureGroup

Jump to bottom
Chris Lynch edited this page Oct 27, 2016 · 42 revisions

Library Version 3.00

Library Version 2.00

Library Version 1.20

HPE OneView 3.00 Library

Remove-HPOVEnclosureGroup

Remove an enclosure group.

SYNTAX

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

Detailed Description

Deletes an enclosure group from the appliance. An enclosure group cannot be deleted if any enclosures are currently part of that enclosure group.

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>

Specify to forceably remove the resource from the appliance.

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

-InputObject <Object>

Aliases [-EnclosureGroup, -uri, -name]

The Enclosure Group object(s), name(s) or uri(s) to be removed from management.

Aliases uri, name, EnclosureGroup, 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 Enclousre Resource Objects

HPOneView.EnclosureGroup [System.Management.Automation.PSCustomObject] Single Enclosure Grou Resource Object

Return Values

System.Management.Automation.PSCustomObject A PSCustomObject is returned indicating successful removal of the resource

Examples

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

PS C:\> $resp = Remove-HPOVEnclosureGroup -enclosureGroup "My-EG" -force

Force-remove the enclosure group specifed by name.

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

PS C:\> $eg = Get-HPOVEnclosureGroup -name "My-EG"
PS C:\> Remove-HPOVEnclosureGroup $enclosureGroup -confirm:$false

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

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

PS C:\> Get-HPOVEnclosureGroup | Remove-HPOVEnclosureGroup

Search for all enclosure groups and remove them from appliance.

Related Links

### HPE OneView 2.00 Library

Remove-HPOVEnclosureGroup

Remove an enclosure group.

SYNTAX

Remove-HPOVEnclosureGroup [-Resource] <Object> [-ApplianceConnection] <Object>[ [-Force] <SwitchParameter>][ [-WhatIf] <SwitchParameter>][ [-Confirm] <SwitchParameter>] [<CommonParameters>]

Detailed Description

Deletes an enclosure group from the appliance. An enclosure group cannot be deleted if any enclosures are currently part of that enclosure group.

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:ConnectSessions} | ? Default

Aliases Appliance
Required? true
Position? 1
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>

Specify to forceably remove the resource from the appliance.

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

-Resource <Object>

Aliases [-EnclosureGroup, -uri, -name]

The Enclosure Group object(s), name(s) or uri(s) to be removed from management.

Aliases uri, name, EnclosureGroup
Required? true
Position? 0
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.Array Collection of Enclousre Resource Objects

System.Management.Automation.PSCustomObject Single Enclosure Resource Object.

Return Values

System.Management.Automation.PSCustomObject A PSCustomObject is returned indicating successful removal of the resource.

Examples

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

PS C:\> $resp = Remove-HPOVEnclosureGroup -enclosureGroup "My-EG" -force

Force-remove the enclosure group specifed by name.

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

PS C:\> $eg = Get-HPOVEnclosureGroup -name "My-EG"
PS C:\> Remove-HPOVEnclosureGroup $enclosureGroup -confirm:$false

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

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

PS C:\> Get-HPOVEnclosureGroup | Remove-HPOVEnclosureGroup

Search for all enclosure groups and remove them from appliance.

Related Links

### HPE OneView 1.20 Library

Remove-HPOVEnclosureGroup

Remove an enclosure group.

SYNTAX

Remove-HPOVEnclosureGroup [-enclosureGroup] <enclosureGroup>[ [-force] <force>][ [-WhatIf] <WhatIf>][ [-Confirm] <Confirm>] [<CommonParameters>]

Detailed Description

Deletes an enclosure group from the appliance. An enclosure group cannot be deleted if any enclosures are currently part of that enclosure group.

Parameters

-enclosureGroup <enclosureGroup>

The Enclosure Group object(s), name(s) or uri(s) to be removed from management.

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

-force <force>

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

-WhatIf <WhatIf>

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

-Confirm <Confirm>

Aliases None.
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.Array Collection of Enclousre Resource Objects System.Management.Automation.PSCustomObject Single Enclosure Resource Object.

Return Values

HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject] Async removal Task.

Examples

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

PS C:\> $task = Remove-HPOVEnclosureGroup -enclosureGroup "My-EG" -force

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

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

PS C:\> $eg = Get-HPOVEnclosureGroup -name "My-EG"
PS C:\> Remove-HPOVEnclosureGroup $enclosureGroup -confirm:$false

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

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

PS C:\> Get-HPOVEnclosureGroup | Remove-HPOVEnclosureGroup

Search for all enclosure groups and remove them from appliance.

Related Links

Wiki Table of Contents

Clone this wiki locally