public/Get-VPASCMConnectorComponentDetails.ps1
|
<#
.Synopsis GET CONNECTOR MANAGEMENT CONNECTOR COMPONENT DETAILS CREATED BY: Vadim Melamed, EMAIL: vmelamed5@gmail.com .DESCRIPTION USE THIS FUNCTION TO RETRIEVE CONNECTOR COMPONENT DETAILS FROM CONNECTOR MANAGEMENT .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 ConnectorID UniqueID of the target connector in ConnectorManagement .PARAMETER ConnectorHost Unique host of the target connector in ConnectorManagement Host in this case can either be a hostname, a publicIP, or a PrivateIP .PARAMETER ComponentID UniqueID of the target component for a connector in ConnectorManagement .PARAMETER ComponentName Unique name of the target component for a connector in ConnectorManagement Possible values: psm, cpm, cpm scanner, Management Agent .EXAMPLE $ConnectorComponentDetails = Get-VPASCMConnectorComponentDetails -ConnectorID {CONNECTOR ID VALUE} -ComponentID {COMPONENT ID VALUE} .EXAMPLE $ConnectorComponentDetails = Get-VPASCMConnectorComponentDetails -ConnectorHost {CONNECTOR NAME VALUE} -ComponentName {COMPONENT NAME VALUE} .OUTPUTS If successful: { "componentId": "lkdfhj834920-zccv-1234-sdfg-slkdjf09458", "componentName": "Privileged Session Manager", "acronym": "psm", "componentStatus": "Active", "connectorId": "ManagementAgent_fslkdj34890-1234-1234-asdf-0239kdfj", "version": "14.2.0.3", "upgradeVersions": [ "v14.3.0.8" ], "usedCpu": 0.304, "usedMemory": 0.949, "installedAt": 1711987268166, "updatedAt": 1723831555919, "maintenanceStatus": null } --- $false if failed #> function Get-VPASCMConnectorComponentDetails{ [OutputType('System.Collections.Hashtable',[bool])] [CmdletBinding()] Param( [Parameter(Mandatory=$false,ValueFromPipelineByPropertyName=$true,Position=0)] [String]$ConnectorID, [Parameter(Mandatory=$false,ValueFromPipelineByPropertyName=$true,Position=1)] [String]$ConnectorHost, [Parameter(Mandatory=$false,ValueFromPipelineByPropertyName=$true,Position=2)] [String]$ComponentID, [Parameter(Mandatory=$false,ValueFromPipelineByPropertyName=$true,Position=3)] [ValidateSet('psm','cpm','cpm scanner','Management Agent')] [String]$ComponentName, [Parameter(Mandatory=$false,ValueFromPipelineByPropertyName=$true,Position=4)] [hashtable]$token ) Begin{ $tokenval,$sessionval,$PVWA,$Header,$ISPSS,$IdentityURL,$EnableTextRecorder,$AuditTimeStamp,$NoSSL,$VaultVersion,$HideWarnings,$AuthenticatedAs,$SubDomain = Get-VPASSession -token $token $CommandName = $MyInvocation.MyCommand.Name $log = Write-VPASTextRecorder -inputval $CommandName -token $token -LogType COMMAND } Process{ Write-Verbose "SUCCESSFULLY PARSED SUBDOMAIN VALUE" Write-Verbose "SUCCESSFULLY PARSED TOKEN VALUE" try{ if($SubDomain -eq "N/A"){ Write-VPASOutput -str "SelfHosted + PriviledgeCloud Standard solutions do not support this API Call, returning false" -type E $log = Write-VPASTextRecorder -inputval "SelfHosted + PrivilegeCloud Standard solutions do not support this API Call, returning false" -token $token -LogType MISC $log = Write-VPASTextRecorder -inputval $false -token $token -LogType RETURN return $false } if([String]::IsNullOrEmpty($ConnectorID)){ Write-Verbose "NO CONNECTOR ID PROVIDED...INVOKING HELPER FUNCTION TO RETRIEVE UNIQUE CONNECTOR ID BASED ON SPECIFIED PARAMETERS" $ConnectorID = Get-VPASCMConnectorIDHelper -token $token -SearchQuery $ConnectorHost Write-Verbose "RETURNING CONNECTOR ID" } else{ Write-Verbose "CONNECTOR ID SUPPLIED, SKIPPING HELPER FUNCTION" } if($ConnectorID -eq -1){ $log = Write-VPASTextRecorder -inputval "COULD NOT FIND TARGET CONNECTOR ID: $ConnectorID" -token $token -LogType MISC $log = Write-VPASTextRecorder -inputval "REST API COMMAND RETURNED: FALSE" -token $token -LogType MISC Write-Verbose "COULD NOT FIND TARGET CONNECTOR ID: $ConnectorID" Write-VPASOutput -str "COULD NOT FIND TARGET CONNECTOR ID: $ConnectorID" -type E return $false } else{ if([String]::IsNullOrEmpty($ComponentID)){ Write-Verbose "NO COMPONENT ID PROVIDED...INVOKING HELPER FUNCTION TO RETRIEVE UNIQUE COMPONENT ID BASED ON SPECIFIED PARAMETERS" $ComponentID = Get-VPASCMConnectorComponentIDHelper -token $token -SearchQuery $ComponentName -ConnectorID $ConnectorID Write-Verbose "RETURNING COMPONENT ID" } else{ Write-Verbose "COMPONENT ID SUPPLIED, SKIPPING HELPER FUNCTION" } if($ComponentID -eq -1){ $log = Write-VPASTextRecorder -inputval "COULD NOT FIND TARGET COMPONENT ID: $ComponentID" -token $token -LogType MISC $log = Write-VPASTextRecorder -inputval "REST API COMMAND RETURNED: FALSE" -token $token -LogType MISC Write-Verbose "COULD NOT FIND TARGET CONNECTOR ID: $ComponentID" Write-VPASOutput -str "COULD NOT FIND TARGET COMPONENT ID: $ComponentID" -type E return $false } else{ write-verbose "MAKING API CALL TO CYBERARK" $uri = "https://$SubDomain.connectormanagement.cyberark.cloud/api/connectors/$ConnectorID/components/$ComponentID" Write-Verbose "CONSTRUCTING URI: $uri" $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" } $log = Write-VPASTextRecorder -inputval $response -token $token -LogType RETURNARRAY Write-Verbose "RETURNING COMPONENT 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 "FAILED TO RETRIEVE CONNECTOR MANAGEMENT CONNECTOR COMPONENTS" Write-VPASOutput -str $_ -type E return $false } } End{ $log = Write-VPASTextRecorder -inputval $CommandName -token $token -LogType DIVIDER } } |