public/Get-VPASAllTargetPlatforms.ps1
|
<#
.Synopsis GET ALL TARGET PLATFORMS DETAILS CREATED BY: Vadim Melamed, EMAIL: vpasmodule@gmail.com .DESCRIPTION USE THIS FUNCTION TO GET DETAILS ABOUT ALL TARGET PLATFORMS IN CYBERARK .LINK https://vpasmodule.com/commands/Get-VPASAllTargetPlatforms .PARAMETER token 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 .PARAMETER InputParameters HashTable of values containing the parameters required to make the API call .EXAMPLE $AllTargetPlatformDetailsJSON = Get-VPASAllTargetPlatforms .EXAMPLE $InputParameters = @{} $AllTargetPlatformDetailsJSON = Get-VPASAllTargetPlatforms -InputParameters $InputParameters .OUTPUTS If successful: { "Platforms": [ ... { "Active": true, "SystemType": "*NIX", "AllowedSafes": ".*", "PrivilegedAccessWorkflows": "@{RequireDualControlPasswordAccessApproval=; EnforceCheckinCheckoutExclusiveAccess=; EnforceOnetimePasswordAccess=; RequireUsersToSpecifyReasonForAccess=}", "CredentialsManagementPolicy": "@{Verification=; Change=; Reconcile=; SecretUpdateConfiguration=}", "PrivilegedSessionManagement": "@{PSMServerId=PSMServer_akjshd298734; PSMServerName=PSM Server on VmanCon1}", "ID": 94, "PlatformID": "NEWKEYSAFE", "Name": "NEWKEYSAFE", "PlatformBaseType": "Unix", "PlatformBaseID": "UnixSSHKeys" }, { "Active": false, "SystemType": "Database", "AllowedSafes": ".*", "PrivilegedAccessWorkflows": "@{RequireDualControlPasswordAccessApproval=; EnforceCheckinCheckoutExclusiveAccess=; EnforceOnetimePasswordAccess=; RequireUsersToSpecifyReasonForAccess=}", "CredentialsManagementPolicy": "@{Verification=; Change=; Reconcile=; SecretUpdateConfiguration=}", "ID": 17, "PlatformID": "MySQL", "Name": "MySQL Server", "PlatformBaseType": "MSSql", "PlatformBaseID": "MSSql" }, { "Active": true, "SystemType": "Windows", "AllowedSafes": ".*", "PrivilegedAccessWorkflows": "@{RequireDualControlPasswordAccessApproval=; EnforceCheckinCheckoutExclusiveAccess=; EnforceOnetimePasswordAccess=; RequireUsersToSpecifyReasonForAccess=}", "CredentialsManagementPolicy": "@{Verification=; Change=; Reconcile=; SecretUpdateConfiguration=}", "PrivilegedSessionManagement": "@{PSMServerId=PSMServer_HKJASS289374; PSMServerName=PSM Server on VmanCon2}", "ID": 7, "PlatformID": "WinDomain", "Name": "Windows Domain Account", "PlatformBaseType": "Windows", "PlatformBaseID": "WinDomain" }, { "Active": false, "SystemType": "Windows", "AllowedSafes": ".*", "PrivilegedAccessWorkflows": "@{RequireDualControlPasswordAccessApproval=; EnforceCheckinCheckoutExclusiveAccess=; EnforceOnetimePasswordAccess=; RequireUsersToSpecifyReasonForAccess=}", "CredentialsManagementPolicy": "@{Verification=; Change=; Reconcile=; SecretUpdateConfiguration=}", "PrivilegedSessionManagement": "@{PSMServerId=PSMServer_HKJASS289374; PSMServerName=PSM Server on VmanCon2}", "ID": 6, "PlatformID": "WinServerLocal", "Name": "Windows Server Local Accounts", "PlatformBaseType": "Windows", "PlatformBaseID": "WinServerLocal" }, ... ], "Total": 82 } --- $false if failed #> function Get-VPASAllTargetPlatforms{ [OutputType('System.Object',[bool])] [CmdletBinding(DefaultParameterSetName='Set1')] Param( [Parameter(Mandatory=$true,ParameterSetName='InputParameters',ValueFromPipelineByPropertyName=$true,HelpMessage="Hashtable of parameters required to make API call, refer to get-help -examples for valid inputs")] [hashtable]$InputParameters, [Parameter(Mandatory=$false,ValueFromPipelineByPropertyName=$true)] [hashtable]$token ) Begin{ $tokenval,$sessionval,$PVWA,$Header,$ISPSS,$IdentityURL,$EnableTextRecorder,$AuditTimeStamp,$NoSSL,$VaultVersion,$HideWarnings,$AuthenticatedAs,$SubDomain,$EnableTroubleshooting = Get-VPASSession -token $token $CommandName = $MyInvocation.MyCommand.Name $log = Write-VPASTextRecorder -inputval $CommandName -token $token -LogType COMMAND } Process{ try{ if($PSCmdlet.ParameterSetName -eq "InputParameters"){ $KeyHash = @{ set1 = @{ AcceptableKeys = @() MandatoryKeys = @() } } $CheckSet = Test-VPASHashtableKeysHelper -InputHash $InputParameters -KeyHash $KeyHash if(!$CheckSet){ $log = Write-VPASTextRecorder -inputval "FAILED TO FIND TARGET PARAMETER SET" -token $token -LogType MISC Write-Verbose "FAILED TO FIND TARGET PARAMETER SET" Write-VPASOutput -str "FAILED TO FIND TARGET PARAMETER SET...VIEW EXAMPLES BELOW:" -type E $examples = Write-VPASExampleHelper -CommandName $CommandName return $false } else{ foreach($key in $InputParameters.Keys){ Set-Variable -Name $key -Value $InputParameters.$key } } } }catch{ $log = Write-VPASTextRecorder -inputval $_ -token $token -LogType ERROR $log = Write-VPASTextRecorder -inputval "REST API COMMAND RETURNED: FALSE" -token $token -LogType MISC Write-Verbose "FAILED TO RETRIEVE PLATFORM DETAILS" Write-VPASOutput -str $_ -type E return $false } try{ Write-Verbose "MAKING API CALL TO CYBERARK" if($NoSSL){ Write-Verbose "NO SSL ENABLED, USING HTTP INSTEAD OF HTTPS" $uri = "http://$PVWA/PasswordVault/API/Platforms/targets" } else{ Write-Verbose "SSL ENABLED BY DEFAULT, USING HTTPS" $uri = "https://$PVWA/PasswordVault/API/Platforms/targets" } $log = Write-VPASTextRecorder -inputval $uri -token $token -LogType URI $log = Write-VPASTextRecorder -inputval "GET" -token $token -LogType METHOD if($sessionval){ $response = Invoke-RestMethod -Headers @{"Authorization"=$Header} -Uri $uri -Method GET -ContentType "application/json" -WebSession $sessionval } else{ $response = Invoke-RestMethod -Headers @{"Authorization"=$Header} -Uri $uri -Method GET -ContentType "application/json" } $outputlog = $response.details $log = Write-VPASTextRecorder -inputval $outputlog -token $token -LogType RETURN Write-Verbose "PARSING DATA FROM CYBERARK" Write-Verbose "RETURNING ALL TARGET PLATFORMS DETAILS" return $response }catch{ $log = Write-VPASTextRecorder -inputval $_ -token $token -LogType ERROR $log = Write-VPASTextRecorder -inputval "REST API COMMAND RETURNED: FALSE" -token $token -LogType MISC Write-Verbose "UNABLE TO RETRIEVE ALL TARGET PLATFORMS DETAILS" Write-VPASOutput -str $_ -type E return $false } } End{ $log = Write-VPASTextRecorder -inputval $CommandName -token $token -LogType DIVIDER } } |