Get-VPASPlatformDetails


Supported Environments:
SelfHosted
SharedServices
PCloudStandard


Synopsis:

GET PLATFORM DETAILS


Description:

USE THIS FUNCTION TO GET DETAILS ABOUT A PLATFORM IN CYBERARK


Syntax:

Get-VPASPlatformDetails [-platformID] <String> [[-token] <Hashtable>] [<CommonParameters>]


Parameters:

-platformID <String>
Unique PlatformID to retrieve details for

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:

$PlatformDetailsJSON = Get-VPASPlatformDetails -platformID {PLATFORMID VALUE}


Outputs:

If successful:
{
         "PlatformID": "WinDomain",
         "Details": {
                 "PolicyID": "WinDomain",
                 "PolicyName": "Windows Domain Account",
                 "SearchForUsages": "Yes",
                 "PolicyType": "regular",
                 "ImmediateInterval": "5",
                 "Interval": "1440",
                 "MaxConcurrentConnections": "3",
                 "AllowedSafes": ".*",
                 "MinValidityPeriod": "60",
                 "ResetOveridesMinValidity": "yes",
                 "ResetOveridesTimeFrame": "yes",
                 "Timeout": "30",
                 "UnlockIfFail": "no",
                 "UnrecoverableErrors": "2103,2105,2121",
                 "MaximumRetries": "5",
                 "MinDelayBetweenRetries": "90",
                 "DllName": "PMWindows.dll",
                 "XMLFile": "yes",
                 "AllowManualChange": "Yes",
                 "PerformPeriodicChange": "No",
                 "HeadStartInterval": "5",
                 "FromHour": "-1",
                 "ToHour": "-1",
                 "ChangeNotificationPeriod": "-1",
                 "DaysNotifyPriorExpiration": "7",
                 "VFAllowManualVerification": "Yes",
                 "VFPerformPeriodicVerification": "No",
                 "VFFromHour": "-1",
                 "VFToHour": "-1",
                 "RCAllowManualReconciliation": "Yes",
                 "RCAutomaticReconcileWhenUnsynched": "No",
                 "RCReconcileReasons": "2114,2115,2106,2101",
                 "RCFromHour": "-1",
                 "RCToHour": "-1",
                 "NFNotifyPriorExpiration": "No",
                 "NFPriorExpirationRecipients": "",
                 "NFNotifyOnPasswordDisable": "Yes",
                 "NFOnPasswordDisableRecipients": "",
                 "NFNotifyOnVerificationErrors": "Yes",
                 "NFOnVerificationErrorsRecipients": "",
                 "NFNotifyOnPasswordUsed": "No",
                 "NFOnPasswordUsedRecipients": "",
                 "PasswordLength": "12",
                 "MinUpperCase": "2",
                 "MinLowerCase": "2",
                 "MinDigit": "1",
                 "MinSpecial": "1",
                 "OneTimePassword": "No",
                 "ExpirationPeriod": "90",
                 "VFVerificationPeriod": "7",
                 "PasswordLevelRequestTimeframe": "No"
         },
         "Active": true
}

$false if failed