Get-VPASEmptyPlatforms


Supported Environments:
SelfHosted
SharedServices
PCloudStandard


Synopsis:

GET EMPTY PLATFORMS


Description:

USE THIS FUNCTION TO GET ALL THE EMPTY PLATFORMS IN THE ENVIRONMENT


Syntax:

Get-VPASEmptyPlatforms [-ExportToCSV] [-CSVDirectory <String>] [-token <Hashtable>] [<CommonParameters>]

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

$EmptyPlatforms = Get-VPASEmptyPlatforms

$InputParameters = @{
        ExportToCSV = $true|$false
         CSVDirectory = "C:\Temp"
}
$EmptyPlatforms = Get-VPASEmptyPlatforms -InputParameters $InputParameters


Outputs:

If successful:
{
         "value": [
                 ...
                 {
                         "PolicyID": "BusinessWebsite",
                         "PolicyName": "Business Website",
                         "SearchForUsages": "Yes",
                         "PolicyType": "Regular",
                         "ImmediateInterval": "5",
                         "Interval": "1440",
                         "MaxConcurrentConnections": "3",
                         "AllowedSafes": "BZ_I_*",
                         "MinValidityPeriod": "60",
                         "ResetOveridesMinValidity": "Yes",
                         "ResetOveridesTimeFrame": "Yes",
                         "Timeout": "30",
                         "UnlockIfFail": "No",
                         "UnrecoverableErrors": "2103,2105,2121",
                         "MaximumRetries": "5",
                         "MinDelayBetweenRetries": "90",
                         "ExeName": "CyberArk.TPC.exe",
                         "DllName": "",
                         "XMLFile": "Yes",
                         "AllowManualChange": "Yes",
                         "PerformPeriodicChange": "No",
                         "HeadStartInterval": "5",
                         "FromHour": "-1",
                         "ToHour": "-1",
                         "ChangeNotificationPeriod": "-1",
                         "DaysNotifyPriorExpiration": "7",
                         "NFNotifyPriorExpiration": "No",
                         "NFPriorExpirationRecipients": "",
                         "NFNotifyOnPasswordDisable": "Yes",
                         "NFOnPasswordDisableRecipients": "",
                         "NFNotifyOnVerificationErrors": "Yes",
                         "NFOnVerificationErrorsRecipients": "",
                         "NFNotifyOnPasswordUsed": "No",
                         "NFOnPasswordUsedRecipients": "",
                         "PasswordLength": "12",
                         "MinUpperCase": "0",
                         "MinLowerCase": "0",
                         "MinDigit": "0",
                         "MinSpecial": "0",
                         "PasswordForbiddenChars": "",
                         "EnforcePasswordPolicyOnManualChange": "No",
                         "EnforcePasswordVersionsHistory": "-1",
                         "OneTimePassword": "No",
                         "ExpirationPeriod": "90",
                         "VFVerificationPeriod": "7",
                         "PasswordLevelRequestTimeframe": "No"
                 },
                 ...
         ]
}

$false if failed