public/Remove-VPASPlatform.ps1
|
<#
.Synopsis DELETE PLATFORM CREATED BY: Vadim Melamed, EMAIL: vpasmodule@gmail.com .DESCRIPTION USE THIS FUNCTION TO DELETE A PLATFORM .LINK https://vpasmodule.com/commands/Remove-VPASPlatform .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 DeletePlatformID Unique PlatformID to delete .PARAMETER WhatIf Run code simulation to see what is affected by running the command as well as any possible implications This is a code simulation flag, meaning the command will NOT actually run .PARAMETER HideWhatIfOutput Suppress any code simulation output from the console .PARAMETER InputParameters HashTable of values containing the parameters required to make the API call .EXAMPLE $WhatIfSimulation = Remove-VPASPlatform -DeletePlatformID {DELETE PLATFORMID VALUE} -WhatIf .EXAMPLE $DeletePlatformStatus = Remove-VPASPlatform -DeletePlatformID {DELETE PLATFORMID VALUE} .EXAMPLE $InputParameters = @{ DeletePlatformID = "DeletePlatformID" WhatIf = $true|$false HideOutput = $true|$false } $DeletePlatformStatus = Remove-VPASPlatform -InputParameters $InputParameters .OUTPUTS $true if successful --- $false if failed #> function Remove-VPASPlatform{ [OutputType([bool],'System.Object')] [CmdletBinding(DefaultParameterSetName='Set1')] Param( [Parameter(Mandatory=$true,ParameterSetName='Set1',ValueFromPipelineByPropertyName=$true,HelpMessage="Enter target PlatformID (for example: WinServerLocal)")] [String]$DeletePlatformID, [Parameter(Mandatory=$false,ParameterSetName='Set1',ValueFromPipelineByPropertyName=$true)] [Switch]$WhatIf, [Parameter(Mandatory=$false,ParameterSetName='Set1',ValueFromPipelineByPropertyName=$true)] [Switch]$HideWhatIfOutput, [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 = @("DeletePlatformID","WhatIf","HideWhatIfOutput") MandatoryKeys = @("DeletePlatformID") } } $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 REMOVE PLATFORM" Write-VPASOutput -str $_ -type E return $false } try{ Write-Verbose "INVOKING PLATFORMID HELPER FUNCTION" $platID = Get-VPASPlatformIDHelper -token $token -platformID $DeletePlatformID if($platID -eq -1){ $log = Write-VPASTextRecorder -inputval "COULD NOT FIND TARGET PLATFORMID: $DeletePlatformID" -token $token -LogType MISC $log = Write-VPASTextRecorder -inputval "REST API COMMAND RETURNED: FALSE" -token $token -LogType MISC Write-Verbose "COULD NOT FIND TARGET PLATFORMID: $DeletePlatformID" Write-VPASOutput -str "COULD NOT FIND TARGET PLATFORMID: $DeletePlatformID" -type E return $false } else{ Write-Verbose "FOUND PLATFORMID: $platID" 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/$platID/" } else{ Write-Verbose "SSL ENABLED BY DEFAULT, USING HTTPS" $uri = "https://$PVWA/passwordvault/api/platforms/targets/$platID/" } $log = Write-VPASTextRecorder -inputval $uri -token $token -LogType URI $log = Write-VPASTextRecorder -inputval "DELETE" -token $token -LogType METHOD if($WhatIf){ $log = Write-VPASTextRecorder -token $token -LogType WHATIF1 $WhatIfHash = @{} Write-Verbose "INITIATING COMMAND SIMULATION" $WhatIfInfo = Get-VPASPlatformDetailsSearch -SearchQuery $DeletePlatformID -token $token foreach($WhatIfPlat in $WhatIfInfo.value){ $WhatIfPlatPlatformID = $WhatIfPlat.general.id if($WhatIfPlatPlatformID -eq $DeletePlatformID){ $WhatIfPlatPrivilegedSessionManagement = $WhatIfPlat.sessionManagement.PSMServerID $WhatIfPlatID = $WhatIfPlat.general.id $WhatIfPlatSystemType = $WhatIfPlat.general.systemType $WhatIfPlatCredentialsManagementPolicy = $WhatIfPlat.credentialsManagement $WhatIfPlatPrivilegedAccessWorkflows = $WhatIfPlat.PrivilegedAccessWorkflows $WhatIfPlatName = $WhatIfPlat.general.name $WhatIfPlatActive = $WhatIfPlat.general.active $WhatIfCounter = 0 $WhatIfAccountsAffected = @() $AffectedAccounts = Get-VPASAccountDetails -platform $WhatIfPlatPlatformID -token $token -HideWarning foreach($AffectedAcct in $AffectedAccounts.value){ $AffectedAcctPlatformID = $AffectedAcct.platformId if($AffectedAcctPlatformID -eq $WhatIfPlatPlatformID){ $WhatIfCounter += 1 $WhatIfAccountsAffectedHash = @{ SafeName = $AffectedAcct.safeName ID = $AffectedAcct.id Address = $AffectedAcct.address Username = $AffectedAcct.userName Name = $AffectedAcct.name } $WhatIfAccountsAffected += $WhatIfAccountsAffectedHash } } } } if(!$HideWhatIfOutput){ Write-VPASOutput -str "====== BEGIN COMMAND SIMULATION ======" -type S Write-VPASOutput -str "THE FOLLOWING PLATFORM WOULD BE DELETED:" -type S Write-VPASOutput -str "PlatformID : $WhatIfPlatPlatformID" -type S Write-VPASOutput -str "PrivilegedSessionManagement : $WhatIfPlatPrivilegedSessionManagement" -type S Write-VPASOutput -str "ID : $WhatIfPlatID" -type S Write-VPASOutput -str "SystemType : $WhatIfPlatSystemType" -type S Write-VPASOutput -str "CredentialsManagement : $WhatIfPlatCredentialsManagementPolicy" -type S Write-VPASOutput -str "PrivilegedAccessWorkflows : $WhatIfPlatPrivilegedAccessWorkflows" -type S Write-VPASOutput -str "Name : $WhatIfPlatName" -type S Write-VPASOutput -str "Active : $WhatIfPlatActive" -type S Write-VPASOutput -str "NumberOfAffectedAccounts : $WhatIfCounter" -type S Write-VPASOutput -str "AffectedAccounts : $WhatIfAccountsAffected" -type S Write-VPASOutput -str "---" -type S Write-VPASOutput -str "URI : $uri" -type S Write-VPASOutput -str "METHOD : DELETE" -type S Write-VPASOutput -str " " -type S Write-VPASOutput -str "======= END COMMAND SIMULATION =======" -type S } $WhatIfHash = @{ WhatIf = @{ PlatformID = $WhatIfPlatPlatformID PrivilegedSessionManagement = $WhatIfPlatPrivilegedSessionManagement ID = $WhatIfPlatID SystemType = $WhatIfPlatSystemType CredentialsManagement = $WhatIfPlatCredentialsManagementPolicy PrivilegedAccessWorkflows = $WhatIfPlatPrivilegedAccessWorkflows AllowedSafes = $WhatIfPlatAllowedSafes Name = $WhatIfPlatName Active = $WhatIfPlatActive RestURI = $uri NumberOfAffectedAccounts = $WhatIfCounter AffectedAccounts = $WhatIfAccountsAffected RestMethod = "DELETE" Disclaimer = "THIS PLATFORM WILL BE DELETED IF -WhatIf FLAG IS REMOVED" } } $WhatIfJSON = $WhatIfHash | ConvertTo-Json | ConvertFrom-Json $log = Write-VPASTextRecorder -inputval $WhatIfJSON -token $token -LogType RETURNARRAY $log = Write-VPASTextRecorder -token $token -LogType WHATIF2 return $WhatIfJSON } else{ if($sessionval){ $response = Invoke-RestMethod -Headers @{"Authorization"=$Header} -Uri $uri -Method DELETE -ContentType "application/json" -WebSession $sessionval } else{ $response = Invoke-RestMethod -Headers @{"Authorization"=$Header} -Uri $uri -Method DELETE -ContentType "application/json" } $log = Write-VPASTextRecorder -inputval "REST API COMMAND RETURNED: TRUE" -token $token -LogType MISC Write-Verbose "SUCCESSFULLY DELETED $DeletePlatformID" Write-Verbose "RETURNING TRUE" return $true } } }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 DELETE $DeletePlatformID" Write-VPASOutput -str $_ -type E return $false } } End{ $log = Write-VPASTextRecorder -inputval $CommandName -token $token -LogType DIVIDER } } |