Skip to content

Get-VerkadaAccessDoorConfigReport.md

Latest commit

 

History

History
184 lines (141 loc) · 4.09 KB

Get-VerkadaAccessDoorConfigReport.md

File metadata and controls

184 lines (141 loc) · 4.09 KB
external help file verkadaModule-help.xml
Module Name verkadaModule
online version https://github.com/bepsoccer/verkadaModule/blob/master/docs/function-documentation/Get-VerkadaAccessDoorConfigReport.md
schema 2.0.0

Get-VerkadaAccessDoorConfigReport

SYNOPSIS

SYNTAX

Get-VerkadaAccessDoorConfigReport [[-org_id] <String>] [[-x_verkada_token] <String>]
 [[-x_verkada_auth] <String>] [[-usr] <String>] [-beautify] [-outReport] [[-reportPath] <String>] [-refresh]
 [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION

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

The org_id and tokens will be populated from the cached created by Connect-Verkada.

EXAMPLE 2

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: 1
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: 2
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: 3
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: 4
Default value: $Global:verkadaConnection.usr
Accept pipeline input: False
Accept wildcard characters: False

-beautify

This is a switch to indicate we're gonna try to make the report prettier

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-outReport

This is a switch to indicate we're gonna try to make the report a pretty html

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-reportPath

This is the path the pretty html report will attempt to be saved to

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-refresh

Switch to force a refreshed list of users from Command

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
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/Get-VerkadaAccessDoorConfigReport.md