New-Alarm¶
SYNOPSIS¶
Genera un objeto Alarma parcialmente lleno que se enviará mediante Send-Alarm.
SYNTAX¶
New-Alarm -Message <String> [-Description <String>] [-CustomTag <String>] [-Source <Item>]
[-RelatedItems <Item[]>] [-Vendor <String>] [-Timestamp <DateTime>] [<CommonParameters>]
DESCRIPTION¶
El objeto Alarma parcialmente completado se puede modificar según sea necesario antes de enviarlo al servidor de eventos con el cmdlet Send-Alarm.
REQUIREMENTS
- Does not require a VMS connection
EXAMPLES¶
EXAMPLE 1¶
$cameraItem = Get-VmsCamera -Id 948aa6a2-9a46-4c4c-8279-af0485428d75 | Get-PlatformItem
$alarm = New-Alarm -Message "Important Alarm Message" -Source $cameraItem
$alarm | Send-Alarm
Recupera el objeto Item para la cámara con el ID dado y crea una alarma con esta cámara como fuente.
A continuación, el objeto de alarma se envía al servidor de eventos, que genera una nueva alarma.
PARAMETERS¶
-CustomTag¶
Especifica el valor Alarm.EventHeader.CustomTag que podría usarse más adelante para buscar o filtrar llamadas a Get-AlarmLines.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Description¶
Especifica la descripción detallada de la alarma. Esto aparece en el XProtect Smart Client debajo del campo Instrucciones de la alarma.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Message¶
Especifica el mensaje de alarma
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: MilestonePSTools Default Alarm Message
Accept pipeline input: False
Accept wildcard characters: False
-RelatedItems¶
Especifica uno o más elementos, como cámaras, como referencias o elementos relacionados, de modo que el vídeo de todas las cámaras relacionadas se asocie con la alarma.
Para obtener un objeto Item, intente pasar un objeto Camera o Input, por ejemplo, al cmdlet Get-PlatformItem.
Alternativamente, puede construir su propio artículo. Todo lo que necesita es la propiedad FQID para contener un ServerId, ObjectId y Kind.
Type: Item[]
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Source¶
Especifica una fuente de alarma para completar automáticamente la propiedad Alarm.EventHeader.Source.
Para obtener un objeto Item, intente pasar un objeto Camera o Input, por ejemplo, al cmdlet Get-PlatformItem.
Alternativamente, puede construir su propio artículo. Todo lo que necesita es la propiedad FQID para contener un ServerId, ObjectId y Kind.
Type: Item
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Timestamp¶
Especifica la marca de tiempo asociada con la alarma.
El valor predeterminado es DateTime.UtcNow. Todos los DateTimes se convertirán automáticamente a la hora UTC si es necesario.
Type: DateTime
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: 8/18/2021 11:10:32 PM
Accept pipeline input: False
Accept wildcard characters: False
-Vendor¶
Especifica el nombre de un proveedor como origen de la alarma. El valor predeterminado es MilestonePSTools.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: MilestonePSTools
Accept pipeline input: False
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.