public/Get-VPASCMConnectorDetails.ps1
|
<#
.Synopsis GET CONNECTOR MANAGEMENT CONNECTOR DETAILS CREATED BY: Vadim Melamed, EMAIL: vpasmodule@gmail.com .DESCRIPTION USE THIS FUNCTION TO RETRIEVE CONNECTOR DETAILS FROM CONNECTOR MANAGEMENT .LINK https://vpasmodule.com/commands/Get-VPASCMConnectorDetails .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 InputParameters HashTable of values containing the parameters required to make the API call .EXAMPLE $ConnectorDetails = Get-VPASCMConnectorDetails -ConnectorID {CONNECTOR ID VALUE} .EXAMPLE $ConnectorDetails = Get-VPASCMConnectorDetails -ConnectorHost {CONNECTOR NAME VALUE} .EXAMPLE $InputParameters = @{ ConnectorID = "ManagementAgent_hsfkjdhf687234-kjhf-sdfj-9876-8762847jksdhfk" } $ConnectorDetails = Get-VPASCMConnectorDetails -InputParameters $InputParameters .EXAMPLE $InputParameters = @{ ConnectorHost = "VmanCon01" } $ConnectorDetails = Get-VPASCMConnectorDetails -InputParameters $InputParameters .OUTPUTS If successful: { "connectorId": "ManagementAgent_hsfkjdhf687234-kjhf-sdfj-9876-8762847jksdhfk", "connectorStatus": "Active", "platformType": "OnPrem", "connectorPoolId": "hsfkjdhf687234-kjhf-sdfj-9876-8762847jksdhfk", "version": "1.0.483.0", "upgradeVersions": [ "v1.0.581" ], "installedAt": 1710820946924, "updatedAt": 1723831555919, "host": { "hostname": "VmanCon01", "privateIp": "192.168.111.111", "publicIp": "100.1.222.222", "os": "windows", "osVersion": "10.0.20348", "osName": "Windows Server 2022 Standard Evaluation", "cloudRegion": null, "cloudAccount": null, "cpuType": "12th Gen Intel(R) Core(TM) i7-1265U", "totalCpu": 1, "usedCpu": 53.1, "totalMemory": 3.999034881591797, "usedMemory": 39.0, "hostConfig": null }, "components": [ { "componentId": "hsfkjdhf687234-kjhf-sdfj-9876-jhagduyqw52362", "componentName": "Privileged Session Manager", "acronym": "psm", "componentStatus": "Active", "connectorId": "ManagementAgent_hsfkjdhf687234-kjhf-sdfj-9876-8762847jksdhfk", "version": "14.2.0.3", "upgradeVersions": "v14.3.0.8", "usedCpu": 0.304, "usedMemory": 0.949, "installedAt": 1711987268166, "updatedAt": 1723831555919, "maintenanceStatus": null }, { "componentId": "ManagementAgent_hsfkjdhf687234-kjhf-sdfj-9876-8762847jksdhfk", "componentName": "Management Agent", "acronym": "Management Agent", "componentStatus": "Active", "connectorId": "ManagementAgent_hsfkjdhf687234-kjhf-sdfj-9876-8762847jksdhfk", "version": "1.0.483.0", "upgradeVersions": "v1.0.581", "usedCpu": 2.91, "usedMemory": 0.669, "installedAt": 1710820946924, "updatedAt": 1723831555919, "maintenanceStatus": null }, { "componentId": "hsfkjdhf687234-kjhf-sdfj-9876-6753ughjqhd", "componentName": "Password Manager", "acronym": "cpm", "componentStatus": "Active", "connectorId": "ManagementAgent_hsfkjdhf687234-kjhf-sdfj-9876-8762847jksdhfk", "version": "14.0.0.6", "upgradeVersions": "v14.2.1.6", "usedCpu": 0.661, "usedMemory": 0.917, "installedAt": 1710821627249, "updatedAt": 1723831555919, "maintenanceStatus": null }, { "componentId": "hsfkjdhf687234-kjhf-sdfj-9876-872364iedhkjwqed", "componentName": "Central Policy Manager Scanner", "acronym": "cpm scanner", "componentStatus": "Active", "connectorId": "ManagementAgent_hsfkjdhf687234-kjhf-sdfj-9876-8762847jksdhfk", "version": "13.2.0.2", "upgradeVersions": "", "usedCpu": 0.439, "usedMemory": 1.531, "installedAt": 1710821628343, "updatedAt": 1723831555919, "maintenanceStatus": null } ] } --- $false if failed #> function Get-VPASCMConnectorDetails{ [OutputType('System.Collections.Hashtable',[bool])] [CmdletBinding(DefaultParameterSetName='Set1')] Param( [Parameter(Mandatory=$true,ParameterSetName='Set1',ValueFromPipelineByPropertyName=$true,HelpMessage="Unique ConnectorID of the target connector (for example: hsfkjdhf687234-kjhf-sdfj-9876-872364iedhkjwqed)")] [String]$ConnectorID, [Parameter(Mandatory=$true,ParameterSetName='Set2',ValueFromPipelineByPropertyName=$true,HelpMessage="Name of the host holding the target connector (for example: VmanCon01)")] [String]$ConnectorHost, [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 = @("ConnectorID") MandatoryKeys = @("ConnectorID") } set2 = @{ AcceptableKeys = @("ConnectorHost") MandatoryKeys = @("ConnectorHost") } } $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 CONNECTOR DETAILS" Write-VPASOutput -str $_ -type E return $false } 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{ write-verbose "MAKING API CALL TO CYBERARK" $uri = "https://$SubDomain.connectormanagement.cyberark.cloud/api/connectors/$ConnectorID" 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 CONNECTOR 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 DETAILS" Write-VPASOutput -str $_ -type E return $false } } End{ $log = Write-VPASTextRecorder -inputval $CommandName -token $token -LogType DIVIDER } } |