Documentation Index
Fetch the complete documentation index at: https://mintlify.com/HewlettPackard/POSH-HPEOneView/llms.txt
Use this file to discover all available pages before exploring further.
Synopsis
Update an HPE OneView alert’s assignment, notes, or active/cleared state.Syntax
Default — update assignment or notes
Cleared — mark alert as cleared
Active — reactivate a cleared alert
Description
Set-OVAlert modifies an existing alert object returned by Get-OVAlert. You can:
- Assign the alert to a specific user with
-AssignToUser. - Add free-text notes with
-Notes. - Mark the alert as cleared with
-Cleared. - Reactivate a previously cleared alert with
-Active.
-Notes value is supplied, the cmdlet automatically generates a note recording which parameters were changed.
When a Locked alert state is changed with -Cleared or -Active, the request is sent with ?force=true to override the lock.
The updated alert object is returned.
Clear-OVAlert is deprecated. Use Set-OVAlert -Cleared instead.Parameters
The alert object to update. Must be an
HPEOneView.Alert object (i.e., one returned by Get-OVAlert). Can be provided via the pipeline.Aliases: -alertUri, -AlertUsername to assign the alert to. The user must exist on the appliance.
Free-text notes to attach to the alert. If omitted, the cmdlet generates an automatic note describing the change.
Mark the alert state as
Cleared. Mutually exclusive with -Active.Restore the alert state to
Active. Mutually exclusive with -Cleared.Specify one or more appliance connection objects or names. Defaults to the default connection in
$ConnectedSessions.Examples
Assign active interconnect alerts to a user
Clear a specific alert with a note
Clear all active alerts older than seven days
Reassign an alert and add notes in one call
Output
HPEOneView.Alert
The updated alert object is returned. Key properties:
| Property | Type | Description |
|---|---|---|
alertState | String | New state after the update |
assignedToUser | String | User the alert is now assigned to |
notes | String | Notes attached to the alert |
modified | DateTime | Timestamp of the last modification |