Get-VPASSystemComponents


Supported Environments:
SelfHosted
SharedServices
PCloudStandard


Synopsis:

GET CYBERARK SYSTEM COMPONENTS


Description:

USE THIS FUNCTION TO GET SYSTEMHEALTH INFORMATION FROM CYBERARK


Syntax:

Get-VPASSystemComponents [[-token] <Hashtable>] [<CommonParameters>]


Parameters:

-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:

$SystemComponentsJSON = Get-VPASSystemComponents


Outputs:

If successful:
{
         "Components": [
                 {
                         "ComponentID": "PVWA",
                         "ComponentName": "PVWA",
                         "Description": "Active Users",
                         "ConnectedComponentCount": 1,
                         "ComponentTotalCount": 2,
                         "ComponentSpecificStat": 1
                 },
                 {
                         "ComponentID": "CPM",
                         "ComponentName": "CPM",
                         "Description": "Managed Accounts",
                         "ConnectedComponentCount": 0,
                         "ComponentTotalCount": 5,
                         "ComponentSpecificStat": 24
                 },
                 {
                         "ComponentID": "SessionManagement",
                         "ComponentName": "PSM/PSMP",
                         "Description": "Concurrent Sessions",
                         "ConnectedComponentCount": 0,
                         "ComponentTotalCount": 7,
                         "ComponentSpecificStat": 0
                 },
                 {
                         "ComponentID": "AIM",
                         "ComponentName": "AAM Credential Provider",
                         "Description": "Applications",
                         "ConnectedComponentCount": 0,
                         "ComponentTotalCount": 2,
                         "ComponentSpecificStat": 5
                 }
         ],
         "Vaults": [
                 {
                         "IP": "vault-vman.pcloudprod.cyberarkinternal.com",
                         "Role": "Primary",
                         "IsLoggedOn": true
                 }
         ]
}

$false if failed