Skip to content

Remove HPOVAlert

Chris Lynch edited this page Mar 31, 2020 · 19 revisions

ℹ️ Note: This Wiki is no longer the source for HPE OneView PowerShell Library documentation. The new location is here.

Please update your local offline help system using Get-Help <ModuleName> to dwonload the latest offline help contents.

HPE OneView

Library

5.00

Remove-HPOVAlert

Syntax

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

Description

This Cmdlet allows the administrator to remove one or more alerts. Alerts can be in one of two administratively controlled states: Active or Cleared. Only alerts that are no longer active (in a Cleared state) can be removed.

In order for an administrator to remove an Alert, the administrator must be assigned to the respective resource role (Network, Server, Storage, or Infrastructure.)

Parameters

-ApplianceConnection <Object>

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.

Aliases Appliance
Required? False
Position? named
Default value (${Global:ConnectedSessions} | ? Default)
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters?    False

-Confirm <>

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

-Force <SwitchParameter>

Force remove the resource.

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

-InputObject <Object>

The alert to be removed.

Aliases None
Required? True
Position? named
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters?    False

-WhatIf <>

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.Alert [System.Management.Automation.PSCustomObject]

Alert resource object (i.e. Get-HPOVAlert)

Return Values

System.Management.Automation.PSCustomObject

Status object indicating the resource was removed.

Examples

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

Get-HPOVAlert -State Cleared | Remove-HPOVAlert

Remove all cleared alerts on the appliance.

Related Links


HPE OneView

Library

4.20

Remove-HPOVAlert

Syntax

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

Description

This Cmdlet allows the administrator to remove one or more alerts. Alerts can be in one of two administratively controlled states: Active or Cleared. Only alerts that are no longer active (in a Cleared state) can be removed.

In order for an administrator to remove an Alert, the administrator must be assigned to the respective resource role (Network, Server, Storage, or Infrastructure.)

Parameters

-ApplianceConnection <Object>

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

-Confirm <>

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

-Force <SwitchParameter>

Force remove the resource.

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

-InputObject <Object>

The alert to be removed.

Aliases None
Required? true
Position? named
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters?    False

-WhatIf <>

Aliases wi
Required?
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.Alert [System.Management.Automation.PSCustomObject]

Alert resource object (i.e. Get-HPOVAlert)

Return Values

System.Management.Automation.PSCustomObject

Status object indicating the resource was removed.

Examples

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

Get-HPOVAlert -State Cleared | Remove-HPOVAlert

Remove all cleared alerts on the appliance.

Related Links


HPE OneView

Library

4.10

Remove-HPOVAlert

Syntax

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

Description

This Cmdlet allows the administrator to remove one or more alerts. Alerts can be in one of two administratively controlled states: Active or Cleared. Only alerts that are no longer active (in a Cleared state) can be removed.

In order for an administrator to remove an Alert, the administrator must be assigned to the respective resource role (Network, Server, Storage, or Infrastructure.)

Parameters

-ApplianceConnection <Object>

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

-Confirm <>

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

-Force <SwitchParameter>

Force remove the resource.

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

-InputObject <Object>

The alert to be removed.

Aliases None
Required? true
Position? named
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters?    False

-WhatIf <>

Aliases wi
Required?
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.Alert [System.Management.Automation.PSCustomObject]

Alert resource object (i.e. Get-HPOVAlert)

Return Values

System.Management.Automation.PSCustomObject

Status object indicating the resource was removed.

Examples

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

Get-HPOVAlert -State Cleared | Remove-HPOVAlert

Remove all cleared alerts on the appliance.

Related Links


Wiki Table of Contents

Clone this wiki locally