Skip to content

Remove HPOVPowerDevice

Jump to bottom
Chris Lynch edited this page Dec 9, 2019 · 44 revisions

ℹ️ Note: This Wiki is going through a major change, and will be migrated to a new location. If you want to preview this new documentation, please go here.

Library Version 5.00

Library Version 4.20

Library Version 4.10

HPE OneView 5.00 Library

Remove-HPOVPowerDevice

Remove power device (iPDU)

Syntax

Remove-HPOVPowerDevice [-InputObject] <Object> [[-Force] <SwitchParameter>] [[-Async] <SwitchParameter>] [[-ApplianceConnection] <Object>] [[-WhatIf] <SwitchParameter>] [[-Confirm] <SwitchParameter>] [<CommonParameters>]

Description

Removes a power device (iPDU) from appliance management.

Parameters

-ApplianceConnection <Object>

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? false
Position? named
Default value (${Global:ConnectedSessions} | ? Default)
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters?    False

-Async <SwitchParameter>

Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.

Aliases None
Required? false
Position? named
Default value False
Accept pipeline input? false
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 $true to force-remove the power device. Force-removing will succeed even when there are connectivity issues or resource errors.

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>

The Power Device object(s), name(s) or uri(s) to be removed from management.

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

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

Power Device (iPDU) Resource Object

Return Values

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

Async remove 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-HPOVPowerDevice -PowerDevice "iPDU16" | Wait-HPOVTaskComplete

Remove the power device specifed by name. Wait for remove to complete.

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

$ipdu = Get-HPOVPowerDevice -name "iPDU24"
Remove-HPOVPowerDevice -PowerDevice $ipdu -force -confirm:$false

Force-Remove the profile specifed by $ipdu. Disable confirmation prompt.

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

Get-HPOVPowerDevice | Remove-HPOVPowerDevice

Search for all power devices and remove them from appliance.

Related Links

HPE OneView 4.20 Library

Remove-HPOVPowerDevice

Remove power device (iPDU)

Syntax

Remove-HPOVPowerDevice [-InputObject] <Object> [[-Force] <SwitchParameter>] [[-Async] <SwitchParameter>] [[-ApplianceConnection] <Object>] [[-WhatIf] <SwitchParameter>] [[-Confirm] <SwitchParameter>] [<CommonParameters>]

Description

Removes a power device (iPDU) from appliance management.

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? false
Position? named
Default value (${Global:ConnectedSessions} | ? Default)
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters?    False

-Async <SwitchParameter>

Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.

Aliases None
Required? false
Position? named
Default value False
Accept pipeline input? false
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 $true to force-remove the power device. Force-removing will succeed even when there are connectivity issues or resource errors.

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>

The Power Device object(s), name(s) or uri(s) to be removed from management.

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

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

Power Device (iPDU) Resource Object

Return Values

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

Async remove 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-HPOVPowerDevice -PowerDevice "iPDU16" | Wait-HPOVTaskComplete

Remove the power device specifed by name. Wait for remove to complete.

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

$ipdu = Get-HPOVPowerDevice -name "iPDU24"
Remove-HPOVPowerDevice -PowerDevice $ipdu -force -confirm:$false

Force-Remove the profile specifed by $ipdu. Disable confirmation prompt.

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

Get-HPOVPowerDevice | Remove-HPOVPowerDevice

Search for all power devices and remove them from appliance.

Related Links

HPE OneView 4.10 Library

Remove-HPOVPowerDevice

Remove power device (iPDU)

Syntax

Remove-HPOVPowerDevice [-InputObject] <Object> [[-Force] <SwitchParameter>] [[-Async] <SwitchParameter>] [[-ApplianceConnection] <Object>] [[-WhatIf] <SwitchParameter>] [[-Confirm] <SwitchParameter>] [<CommonParameters>]

Description

Removes a power device (iPDU) from appliance management.

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? false
Position? named
Default value (${Global:ConnectedSessions} | ? Default)
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters?    False

-Async <SwitchParameter>

Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.

Aliases None
Required? false
Position? named
Default value False
Accept pipeline input? false
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 $true to force-remove the power device. Force-removing will succeed even when there are connectivity issues or resource errors.

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>

The Power Device object(s), name(s) or uri(s) to be removed from management.

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

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

Power Device (iPDU) Resource Object

Return Values

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

Async remove 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-HPOVPowerDevice -PowerDevice "iPDU16" | Wait-HPOVTaskComplete

Remove the power device specifed by name. Wait for remove to complete.

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

$ipdu = Get-HPOVPowerDevice -name "iPDU24"
Remove-HPOVPowerDevice -PowerDevice $ipdu -force -confirm:$false

Force-Remove the profile specifed by $ipdu. Disable confirmation prompt.

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

Get-HPOVPowerDevice | Remove-HPOVPowerDevice

Search for all power devices and remove them from appliance.

Related Links

Wiki Table of Contents

Clone this wiki locally