Skip to content

Set-VerkadaAlarmsPanicButtonSettings.md

Latest commit

 

History

History
235 lines (183 loc) · 5.7 KB

Set-VerkadaAlarmsPanicButtonSettings.md

File metadata and controls

235 lines (183 loc) · 5.7 KB
external help file verkadaModule-help.xml
Module Name verkadaModule
online version https://github.com/bepsoccer/verkadaModule/blob/master/docs/function-documentation/Set-VerkadaAlarmsPanicButtonSettings.md
schema 2.0.0

Set-VerkadaAlarmsPanicButtonSettings

SYNOPSIS

This is used to set the various settings of a Verkada Alarms BR33 panic button

SYNTAX

Set-VerkadaAlarmsPanicButtonSettings [-deviceId] <String> [[-name] <String>] [[-panicPressType] <String>]
 [[-enableMobileMode] <Boolean>] [[-isSilent] <Boolean>] [[-isMuted] <Boolean>] [[-tamperIsMuted] <Boolean>]
 [[-org_id] <String>] [[-x_verkada_token] <String>] [[-x_verkada_auth] <String>] [[-usr] <String>]
 [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION

This will set the settings of a Verkada Alarms wireless BR33 panic button in an organization. This can be used to set the press type, mobile mode, silent mode, mute device, and mute tamper events settings. The org_id and reqired tokens can be directly submitted as parameters, but is much easier to use Connect-Verkada to cache this information ahead of time and for subsequent commands.

EXAMPLES

EXAMPLE 1

Set-VerkadaAlarmsPanicButtonSettings -deviceId 'cd1f1bb9-c8b9-40b9-ab14-546a93d952cf' -panicPressType 'long' -org_id '7cd47706-f51b-4419-8675-3b9f0ce7c12d' -x_verkada_token 'a366ef47-2c20-4d35-a90a-10fd2aee113a' -x_verkada_auth 'auth-token-uuid-dscsdc' -usr 'a099bfe6-34ff-4976-9d53-ac68342d2b60'
Sets the BR33 panic button press type to long for the panic button with deviceId cd1f1bb9-c8b9-40b9-ab14-546a93d952cf.  The org_id and tokens are submitted as parameters in the call.

EXAMPLE 2

Get-VerkadaAlarmsDevices | Select-Object -ExpandProperty panicButton | Set-VerkadaAlarmsPanicButtonSettings -tamperIsMuted $true
Sets all the BR33 panic buttons in an org to mute tamper events. The org_id and tokens will be populated from the cached created by Connect-Verkada.

PARAMETERS

-deviceId

The UUID of the BR33 panic button

Type: String
Parameter Sets: (All)
Aliases: device_id

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

-name

The new name for the panic button

Type: String
Parameter Sets: (All)
Aliases:

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

-panicPressType

The panicPressType setting

Type: String
Parameter Sets: (All)
Aliases:

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

-enableMobileMode

The enableMobileMode setting

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-isSilent

The isSilent setting

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-isMuted

The isMuted setting

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-tamperIsMuted

The tamperIsMuted setting

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-org_id

The UUID of the organization the user belongs to

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 8
Default value: $Global:verkadaConnection.org_id
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-x_verkada_token

The Verkada(CSRF) token of the user running the command

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 9
Default value: $Global:verkadaConnection.csrfToken
Accept pipeline input: False
Accept wildcard characters: False

-x_verkada_auth

The Verkada Auth(session auth) token of the user running the command

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 10
Default value: $Global:verkadaConnection.userToken
Accept pipeline input: False
Accept wildcard characters: False

-usr

The UUID of the user account making the request

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 11
Default value: $Global:verkadaConnection.usr
Accept pipeline input: False
Accept wildcard characters: False

-ProgressAction

{{ Fill ProgressAction Description }}

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
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.

INPUTS

OUTPUTS

NOTES

RELATED LINKS

https://github.com/bepsoccer/verkadaModule/blob/master/docs/function-documentation/Set-VerkadaAlarmsPanicButtonSettings.md