-
Notifications
You must be signed in to change notification settings - Fork 52
Set HPOVAlert
Change status of an alert.
Set-HPOVAlert [-InputObject] <Object> [-AssignToUser] <String> [-Notes] <String>[ [-ApplianceConnection] <Object>] [<CommonParameters>]
Set-HPOVAlert [-InputObject] <Object>[ [-Active] <SwitchParameter>][ [-ApplianceConnection] <Object>] [<CommonParameters>]
Set-HPOVAlert [-InputObject] <Object>[ [-Cleared] <SwitchParameter>][ [-ApplianceConnection] <Object>] [<CommonParameters>]
Alerts can be in one of two administratively controlled states: Active or Cleared. This Cmdlet allows the administrator to change the status of an alert to either Active or Cleared.
In order for an Administrator to change the status of an Alert, the Administrator must be assigned to the respective resource role (Network, Server, Storage, or Infrastructure.)
-Active <SwitchParameter>
Change the alert to "Active" status.
Aliases | None |
Required? | false |
Position? | named |
Default value | False |
Accept pipeline input? | false |
Accept wildcard characters? | False |
-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 |
-AssignToUser <String>
The users name in String value to assign the alert to. The user name does not require, nor is mapped to, a local user account.
Aliases | None |
Required? | true |
Position? | named |
Default value | |
Accept pipeline input? | false |
Accept wildcard characters? | False |
-Cleared <SwitchParameter>
Change the alert to "Cleared" status.
Aliases | None |
Required? | false |
Position? | named |
Default value | False |
Accept pipeline input? | false |
Accept wildcard characters? | False |
-InputObject <Object>
The alert to be cleared. Can be URI or resource object.
Aliases | alertUri, Alert |
Required? | true |
Position? | named |
Default value | |
Accept pipeline input? | true (ByValue) |
Accept wildcard characters? | False |
-Notes <String>
Notes of the action for the alert.
Aliases | None |
Required? | true |
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)
System.String
Alert URI
HPOneView.Alert [System.Management.Automation.PSCustomObject]
Alert resource object (i.e. Get-HPOVAlert)
HPOneView.Alert [System.Management.Automation.PSCustomObject]
The updated alert
-------------------------- EXAMPLE 1 --------------------------Set-HPOVAlert -InputObject $Alert -Cleared
Clears the alert.
-------------------------- EXAMPLE 2 --------------------------Get-HPOVAlert -AlertState Active | Set-HPOVAlert -Cleared
Get all alerts in an "Active" state, and set their state to "Cleared".
Change status of an alert.
Set-HPOVAlert [-InputObject] <Object> [-AssignToUser] <String> [-Notes] <String>[ [-ApplianceConnection] <Object>] [<CommonParameters>]
Set-HPOVAlert [-InputObject] <Object>[ [-Active] <SwitchParameter>][ [-ApplianceConnection] <Object>] [<CommonParameters>]
Set-HPOVAlert [-InputObject] <Object>[ [-Cleared] <SwitchParameter>][ [-ApplianceConnection] <Object>] [<CommonParameters>]
Alerts can be in one of two administratively controlled states: Active or Cleared. This Cmdlet allows the administrator to change the status of an alert to either Active or Cleared.
In order for an Administrator to change the status of an Alert, the Administrator must be assigned to the respective resource role (Network, Server, Storage, or Infrastructure.)
-Active <SwitchParameter>
Change the alert to 'Active' status.
Aliases | None |
Required? | false |
Position? | named |
Default value | False |
Accept pipeline input? | false |
Accept wildcard characters? | False |
-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 |
-AssignToUser <String>
The users name in String value to assign the alert to. The user name does not require, nor is mapped to, a local user account.
Aliases | None |
Required? | true |
Position? | named |
Default value | |
Accept pipeline input? | false |
Accept wildcard characters? | False |
-Cleared <SwitchParameter>
Change the alert to 'Cleared' status.
Aliases | None |
Required? | false |
Position? | named |
Default value | False |
Accept pipeline input? | false |
Accept wildcard characters? | False |
-InputObject <Object>
The alert to be cleared. Can be URI or resource object.
Aliases | alertUri, Alert |
Required? | true |
Position? | named |
Default value | |
Accept pipeline input? | true (ByValue) |
Accept wildcard characters? | False |
-Notes <String>
Notes of the action for the alert.
Aliases | None |
Required? | true |
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)
System.String
Alert URI
HPOneView.Alert [System.Management.Automation.PSCustomObject]
Alert resource object (i.e. Get-HPOVAlert)
HPOneView.Alert [System.Management.Automation.PSCustomObject]
The updated alert
-------------------------- EXAMPLE 1 --------------------------Set-HPOVAlert -InputObject $Alert -Cleared
Clears the alert.
-------------------------- EXAMPLE 2 --------------------------Get-HPOVAlert -AlertState Active | Set-HPOVAlert -Cleared
Get all alerts in an 'Active' state, and set their state to 'Cleared'.