Invoke-VPASReporting


Supported Environments:
SelfHosted
SharedServices
PCloudStandard


Synopsis:

RUN VARIOUS REPORTS FROM CYBERARK


Description:

USE THIS FUNCTION TO GENERATE VARIOUS REPORTS FROM CYBERARK


Syntax:

Invoke-VPASReporting -ReportType <String> -ReportFormat <String> [-OutputDirectory <String>] [-SearchQuery <String>] [-WildCardSearch] [-IncludePredefinedSafeMembers] [-Confirm] [-HideOutput] [-token <Hashtable>] [<CommonParameters>]

Invoke-VPASReporting -InputParameters <Hashtable> [-token <Hashtable>] [<CommonParameters>]


Parameters:

-ReportType <String>
Specify which report will be run
Possible values: SafeContent, SafeMembers, PlatformDetails, EPVUsers, PlatformLinkedAccounts, ApplicationIDAuthentications

Required: true
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-ReportFormat <String>
Specify what format the report output should be
Possible values: CSV, JSON, TXT, HTML, XML, ALL

Required: true
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-OutputDirectory <String>
Where to place the newly generated report

Required: false
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-SearchQuery <String>
Search string to find target resource via username, address, safe, platform, etc.
Comma separated for multiple fields, or to search all pass a blank value like so: " "

Required: false
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-WildCardSearch [<SwitchParameter>]
Treat the searchquery as a wildcard search (*searchquery*) instead of a single value

Required: false
Position: named
Default value: False
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-IncludePredefinedSafeMembers [<SwitchParameter>]
Include built in safe members when reporting on safe members

Required: false
Position: named
Default value: False
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-Confirm [<SwitchParameter>]
Skip the confirmation prompt to continue regardless on the size of the environment

Required: false
Position: named
Default value: False
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-HideOutput [<SwitchParameter>]
Suppress any output to the console

Required: false
Position: named
Default value: False
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-InputParameters <Hashtable>
HashTable of values containing the parameters required to make the API call

Required: true
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-token <Hashtable>
HashTable of data containing various pieces of login information (PVWA, LoginToken, HeaderType, etc).
If -token is not passed, function will use last known hashtable generated by New-VPASToken

Required: false
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug
ErrorAction, ErrorVariable, WarningAction, WarningVariable
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216)


Examples:

$RunReporting = Invoke-VPASReporting -ReportType {REPORTTYPE VALUE} -ReportFormat {REPORTFORMAT VALUE} -SearchQuery {SEARCHQUERY VALUE} -OutputDirectory {OUTPUTDIRECTORY VALUE}

$InputParameters = @{
        ReportType = "SafeContent"|"SafeMembers"|"PlatformDetails"|"EPVUsers"|"ApplicationIDAuthentications"|"PlatformLinkedAccounts"
         ReportFormat = "CSV"|"JSON"|"TXT"|"HTML"|"XML"|"ALL"
         OutputDirectory = "C:\Temp\ReportOutput"
         SearchQuery = "TargetSearchQuery"
         WildCardSearch = $true|$false
         IncludePredefinedSafeMembers = $true|$false
         Confirm = $true|$false
         HideOutput = $true|$false
}
$RunReporting = Invoke-VPASReporting -InputParameters $InputParameters


Outputs:

$true if successful

$false if failed