Invoke-VPASHealthCheck


Supported Environments:
SelfHosted
SharedServices
PCloudStandard


Synopsis:

RUN A SYSTEM HEALTHCHECK


Description:

USE THIS FUNCTION TO RUN A HEALTHCHECK THAT RUNS VARIOUS CHECKS IN A CYBERARK ENVIRONMENT


Syntax:

Invoke-VPASHealthCheck [-ExportToCSV] [-CSVDirectory <String>] [[-token] <Hashtable>] [<CommonParameters>]

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


Parameters:

-ExportToCSV [<SwitchParameter>]
Output results to a CSV file found in AppData\Local\VPASModuleOutputs directory

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

-CSVDirectory <String>
Output directory where the exported CSV file will be saved to
Default value: C:\Users\{CurrentUser}\AppData\Local\VPASModuleOutputs\ExportedCSVs

Required: false
Position: named
Default value:
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: 1
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:

$HealthCheck = Invoke-VPASHealthCheck

$InputParameters = @{
        ExportToCSV = $true|$false
         CSVDirectory = "C:\Temp"
}
$HealthCheck = Invoke-VPASHealthCheck -InputParameters $InputParameters


Outputs:

If successful:
{
         ...
         "UnusedAssetsCheck": [
                 ...
                 {
                         "TargetName": "UnusedAppID",
                         "Category": "ApplicationID",
                         "Recommendation": "Recommendation: delete unused application IDs (UnusedAppID) to help reduce clutter",
                         "Check": "UnusedAssetsCheck"
                 },
                 {
                         "TargetName": "UnusedSafe1",
                         "Category": "Safe",
                         "Recommendation": "Recommendation: delete unused Safes (UnusedSafe1) to help reduce clutter",
                         "Check": "UnusedAssetsCheck"
                 },
                 ...
        }
        

$false if failed