| external help file | verkadaModule-help.xml |
|---|---|
| Module Name | verkadaModule |
| online version | https://github.com/bepsoccer/verkadaModule/blob/master/docs/function-documentation/Add-VerkadaCommandSite.md |
| schema | 2.0.0 |
Adds a site to an organization
Add-VerkadaCommandSite [-name] <String> [[-parentSiteId] <String>] [[-parentSiteName] <String>]
[[-org_id] <String>] [[-x_verkada_token] <String>] [[-x_verkada_auth] <String>] [[-usr] <String>]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
Used to bulk add sites to an organization with the desired name. This function takes pipeline paramters making it easy to add mulitple sites via csv with the desired named out of the gate. 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.
Add-VerkadaCommandSite -name 'My New Site'
This will add the new site with the name "My New Site". The org_id and tokens will be populated from the cached created by Connect-Verkada.
Add-VerkadaCommandSite -name 'My New Sub-Site' -parentSiteId '919dedeb-b3fe-420c-b663-ce44cbfd1c1e'
This will add the new sub-site with the name "My New Sub-Site" in the parent site with ID '919dedeb-b3fe-420c-b663-ce44cbfd1c1e'. The org_id and tokens will be populated from the cached created by Connect-Verkada.
Add-VerkadaCommandSite -name 'My New Site' -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'
This will add the new site with the name "My New Site". The org_id and tokens are submitted as parameters in the call.
The name of the site or sub-site being added
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseThe parentSiteId(parentCameraGroupId) of the sub-site being added
Type: String
Parameter Sets: (All)
Aliases: parentCameraGroupId
Required: False
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseThe parentSiteName of the sub-site being added
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseThe UUID of the organization the user belongs to
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: $Global:verkadaConnection.org_id
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseThe Verkada(CSRF) token of the user running the command
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: $Global:verkadaConnection.csrfToken
Accept pipeline input: False
Accept wildcard characters: FalseThe Verkada Auth(session auth) token of the user running the command
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: $Global:verkadaConnection.userToken
Accept pipeline input: False
Accept wildcard characters: FalseThe UUID of the user account making the request
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 7
Default value: $Global:verkadaConnection.usr
Accept pipeline input: False
Accept wildcard characters: False{{ Fill ProgressAction Description }}
Type: ActionPreference
Parameter Sets: (All)
Aliases: proga
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.