Skip to content

Set-VerkadaCameraSite.md

Latest commit

 

History

History
158 lines (120 loc) · 4.19 KB

Set-VerkadaCameraSite.md

File metadata and controls

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

Set-VerkadaCameraSite

SYNOPSIS

Sets a camera/s site in Verkada Command

SYNTAX

Set-VerkadaCameraSite [-org_id <String>] [-x_verkada_token <String>] [-x_verkada_auth <String>] [-usr <String>]
 -camera_id <String[]> -cameraGroupId <String> [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION

This function is used to move/set the site a particular camera or cameras should be moved into.

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-VerkadaCameraSite -camera_id 'd5efe6b9-c1e3-4f86-b6ba-b363f6d937d2' -cameraGroupId '3fed20c9-7316-4019-be6d-8e823b2fd254'
This adds camera with id 'd5efe6b9-c1e3-4f86-b6ba-b363f6d937d2' to the site with id '3fed20c9-7316-4019-be6d-8e823b2fd254'.  The org_id and tokens will be populated from the cached created by Connect-Verkada.

EXAMPLE 2

Set-VerkadaCameraSite -camera_id 'd5efe6b9-c1e3-4f86-b6ba-b363f6d937d2' -cameraGroupId '3fed20c9-7316-4019-be6d-8e823b2fd254' -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'
The org_id and tokens are submitted as parameters in the call.

PARAMETERS

-org_id

The UUID of the organization the user belongs to

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
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: Named
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: Named
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: Named
Default value: $Global:verkadaConnection.usr
Accept pipeline input: False
Accept wildcard characters: False

-camera_id

The UUID of the camera who's name is being changed

Type: String[]
Parameter Sets: (All)
Aliases: cameraId

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

-cameraGroupId

The cameraGroupId of the site who permissions are being set

Type: String
Parameter Sets: (All)
Aliases: entityId, siteId

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
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-VerkadaCameraSite.md