Get-VPASSystemHealth


Supported Environments:
SelfHosted
SharedServices
PCloudStandard


Synopsis:

GET CYBERARK SYSTEM HEALTH


Description:

USE THIS FUNCTION TO GET SYSTEMHEALTH INFORMATION FROM CYBERARK


Syntax:

Get-VPASSystemHealth [-Component] <String> [[-token] <Hashtable>] [<CommonParameters>]


Parameters:

-Component <String>
Define which component to pull health status for
Possible values: AIM, PSM, CPM, PVWA, PTA

Required: true
Position: 1
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: 2
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:

$SystemHealthJSON = Get-VPASSystemHealth -Component AIM

$SystemHealthJSON = Get-VPASSystemHealth -Component PVWA


Outputs:

If successful:
{
         "ComponentsDetails": [
                 {
                         "ComponentIP": "1.1.1.1",
                         "ComponentUserName": "vman-con-01",
                         "ComponentVersion": "13.2.0",
                         "ComponentSpecificStat": -1,
                         "IsLoggedOn": false,
                         "LastLogonDate": 1712936725
                 },
                 {
                         "ComponentIP": "2.2.2.2",
                         "ComponentUserName": "vman-con-02",
                         "ComponentVersion": "14.0.0",
                         "ComponentSpecificStat": -1,
                         "IsLoggedOn": false,
                         "LastLogonDate": 1723830003
                 }
         ]
}

$false if failed