-
Notifications
You must be signed in to change notification settings - Fork 52
Remove HPOVEnclosureGroup
Remove-HPOVEnclosureGroup
Remove an enclosure group.
Remove-HPOVEnclosureGroup [-Resource] <Object> [[-ApplianceConnection] <Object>] [[-Force] <SwitchParameter>] [[-WhatIf] <SwitchParameter>] [[-Confirm] <SwitchParameter>] [<CommonParameters>]Deletes an enclosure group from the appliance. An enclosure group cannot be deleted if any enclosures are currently part of that enclosure group.
-Resource <Object>
Aliases [-EnclosureGroup, -uri, -name]
The Enclosure Group object(s), name(s) or uri(s) to be removed from management.
| Aliases | None |
| Required? | true |
| Position? | 1 |
| Default value | <none> |
| Accept pipeline input? | true (ByValue) |
| Accept wildcard characters? | false |
-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 | None |
| Required? | false |
| Position? | 2 |
| Default value | (${Global:ConnectedSessions} | ? Default) |
| Accept pipeline input? | true (ByPropertyName) |
| 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 |
-WhatIf [<SwitchParameter>]
| Aliases | None |
| Required? | false |
| Position? | named |
| Default value | <none> |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |
-Confirm [<SwitchParameter>]
| Aliases | None |
| Required? | false |
| Position? | named |
| Default value | <none> |
| 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)
System.Array
Collection of Enclousre Resource Objects
_**System.Management.Automation.PSCustomObject**_
Single Enclosure Resource Object.
System.Management.Automation.PSCustomObject
A PSCustomObject is returned indicating successful removal of the resource.
#### RELATED LINKS
- [Get-HPOVEnclosureGroup] (https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVEnclosureGroup)
- [New-HPOVEnclosureGroup] (https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVEnclosureGroup)
-------------------------- 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.
Remove-HPOVEnclosureGroup
Remove an enclosure group.
Remove-HPOVEnclosureGroup [-enclosureGroup] <Object> [[-force] <SwitchParameter>] [[-WhatIf] <SwitchParameter>] [[-Confirm] <SwitchParameter>] [<CommonParameters>]Deletes an enclosure group from the appliance. An enclosure group cannot be deleted if any enclosures are currently part of that enclosure group.
-enclosureGroup <Object>
The Enclosure Group object(s), name(s) or uri(s) to be removed from management.
| Aliases | None |
| Required? | true |
| Position? | 1 |
| Default value | <none> |
| Accept pipeline input? | true (ByValue) |
| Accept wildcard characters? | false |
-force [<SwitchParameter>]
| Aliases | None |
| Required? | false |
| Position? | named |
| Default value | False |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |
-WhatIf [<SwitchParameter>]
| Aliases | None |
| Required? | false |
| Position? | named |
| Default value | <none> |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |
-Confirm [<SwitchParameter>]
| Aliases | None |
| Required? | false |
| Position? | named |
| Default value | <none> |
| 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)
System.Array
Collection of Enclousre Resource Objects
_**System.Management.Automation.PSCustomObject**_
Single Enclosure Resource Object.
HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]
Async removal Task.
#### RELATED LINKS
- [Get-HPOVEnclosureGroup] (https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVEnclosureGroup)
- [New-HPOVEnclosureGroup] (https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVEnclosureGroup)
- [Wait-HPOVTaskComplete] (https://github.com/HewlettPackard/POSH-HPOneView/wiki/Wait-HPOVTaskComplete)
-------------------------- 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.
Remove-HPOVEnclosureGroup
Remove an enclosure group.
Remove-HPOVEnclosureGroup [-enclosureGroup] <Object> [[-force] <SwitchParameter>] [[-WhatIf] <SwitchParameter>] [[-Confirm] <SwitchParameter>] [<CommonParameters>]Deletes an enclosure group from the appliance.
An enclosure group cannot be deleted if any enclosures are currently part of that enclosure group.
-enclosureGroup <Object>
The Enclosure Group object(s), name(s) or uri(s) to be removed from management.
| Aliases | None |
| Required? | true |
| Position? | 1 |
| Default value | <none> |
| Accept pipeline input? | true (ByValue) |
| Accept wildcard characters? | false |
-force [<SwitchParameter>]
| Aliases | None |
| Required? | false |
| Position? | named |
| Default value | False |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |
-WhatIf [<SwitchParameter>]
| Aliases | None |
| Required? | false |
| Position? | named |
| Default value | <none> |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |
-Confirm [<SwitchParameter>]
| Aliases | None |
| Required? | false |
| Position? | named |
| Default value | <none> |
| 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)
System.Array
Collection of Enclousre Resource Objects
_**System.Management.Automation.PSCustomObject**_
Single Enclosure Resource Object.
System.Management.Automation.PSCustomObject
Async removal Task.
#### RELATED LINKS
- [Get-HPOVEnclosureGroup] (https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVEnclosureGroup)
- [New-HPOVEnclosureGroup] (https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVEnclosureGroup)
- [Wait-HPOVTaskComplete] (https://github.com/HewlettPackard/POSH-HPOneView/wiki/Wait-HPOVTaskComplete)
-------------------------- 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.