Skip to content

Remove-GenericEvent

SYNOPSIS

Removes Generic Events from the currently connected XProtect VMS site.

SYNTAX

Remove-GenericEvent [-GenericEvent <GenericEvent>] [-Id <String>] [<CommonParameters>]

DESCRIPTION

The Remove-GenericEvent cmdlet removes the specified Generic Event from the system.

REQUIREMENTS

  • Requires VMS connection and will attempt to connect automatically

EXAMPLES

Example 1

Get-GenericEvent | Where-Object Name -eq 'Offline' | Remove-GenericEvent

Gets the Generic Event with the name 'Offline' and pipes it to Remove-GenericEvent which removes the event.

Example 2

Remove-GenericEvent -Id '7f47ab39-372e-4257-a182-1a8c5c24c52a'

Removes the Generic Event that has the ID of '7f47ab39-372e-4257-a182-1a8c5c24c52a'.

PARAMETERS

-GenericEvent

Specifies a Generic Event to be removed, as returned by Get-GenericEvent.

Type: GenericEvent
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Id

Specifies the ID of the Generic Event object to be deleted.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

VideoOS.Platform.ConfigurationItems.GenericEvent

System.String

OUTPUTS

System.Object

NOTES