public/Get-VPASUsagePlatformDetails.ps1
|
<#
.Synopsis GET USAGE PLATFORM DETAILS CREATED BY: Vadim Melamed, EMAIL: vpasmodule@gmail.com .DESCRIPTION USE THIS FUNCTION TO GET USAGE PLATFORM DETAILS .LINK https://vpasmodule.com/commands/Get-VPASUsagePlatformDetails .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 usageplatformID Unique UsagePlatformID to retrieve details for .PARAMETER InputParameters HashTable of values containing the parameters required to make the API call .EXAMPLE $UsagePlatformDetailsJSON = Get-VPASUsagePlatformDetails -usageplatformID {USAGE PLATFORMID VALUE} .EXAMPLE $InputParameters = @{ usageplatformID = "TargetUsagePlatformID" } $UsagePlatformDetailsJSON = Get-VPASUsagePlatformDetails -InputParameters $InputParameters .OUTPUTS If successful: { "NumberOfLinkedTargetPlatforms": 1, "CredentialsManagementPolicy": { "Change": { "AllowManual": true } }, "ID": 8, "PlatformID": "INIFile", "Name": "INI File", "PlatformBaseType": "INIFile", "PlatformBaseID": "INIFile" } --- $false if failed #> function Get-VPASUsagePlatformDetails{ [OutputType('System.Object',[bool])] [CmdletBinding(DefaultParameterSetName='Set1')] Param( [Parameter(Mandatory=$true,ParameterSetName='Set1',ValueFromPipelineByPropertyName=$true,HelpMessage="Enter target PlatformID (for example: WinServerLocal)")] [String]$usageplatformID, [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 = @("usageplatformID") MandatoryKeys = @("usageplatformID") } } $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 USAGE PLATFORM DETAILS" Write-VPASOutput -str $_ -type E return $false } try{ $platformID = $usageplatformID Write-Verbose "CONSTRUCTING SEARCH STRING TO QUERY CYBERARK" $searchQuery = "$platformID" if($NoSSL){ Write-Verbose "NO SSL ENABLED, USING HTTP INSTEAD OF HTTPS" $uri = "http://$PVWA/passwordvault/api/platforms/dependents/" } else{ Write-Verbose "SSL ENABLED BY DEFAULT, USING HTTPS" $uri = "https://$PVWA/passwordvault/api/platforms/dependents/" } $log = Write-VPASTextRecorder -inputval $uri -token $token -LogType URI $log = Write-VPASTextRecorder -inputval "GET" -token $token -LogType METHOD write-verbose "MAKING API CALL" 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" } $counter = $response.Total Write-Verbose "FOUND $counter USAGE PLATFORMS...LOOKING FOR TARGET USAGE PLATFORMID: $searchQuery" $output = -1 foreach($rec in $response.Platforms){ $recid = $rec.ID $recplatformid = $rec.PlatformID $recname = $rec.Name if($recplatformid -eq $platformID -or $recname -eq $platformID){ $output = $rec $outputlog = @{ value = @{ NumberOfLinkedTargetPlatforms = $output.NumberOfLinkedTargetPlatforms ID = $output.ID PlatformID = $output.PlatformID Name = $output.Name CredentialsManagementPolicy = @{ AllowManualChange = $output.CredentialsManagementPolicy.Change.AllowManual } } } | ConvertTo-Json | ConvertFrom-Json $log = Write-VPASTextRecorder -inputval $outputlog -token $token -LogType RETURNARRAY Write-Verbose "FOUND $platformID : TARGET ENTRY FOUND, RETURNING DETAILS" return $output } Write-Verbose "FOUND $recplatformid : NOT TARGET ENTRY (SKIPPING)" } $log = Write-VPASTextRecorder -inputval "UNABLE TO FIND TARGET USAGE PLATFORMID, RETURNING -1" -token $token -LogType MISC $log = Write-VPASTextRecorder -inputval "REST API COMMAND RETURNED: FALSE" -token $token -LogType MISC Write-Verbose "CAN NOT FIND TARGET ENTRY, RETURNING -1" Write-VPASOutput -str "UNABLE TO FIND TARGET USAGE PLATFORMID, RETURNING -1" -type E return $output }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 QUERY CYBERARK" Write-VPASOutput -str $_ -type E return $false } } End{ $log = Write-VPASTextRecorder -inputval $CommandName -token $token -LogType DIVIDER } } |