public/Get-VPASCMConnectorPoolDetails.ps1
|
<#
.Synopsis GET CONNECTOR MANAGEMENT CONNECTOR POOL DETAILS CREATED BY: Vadim Melamed, EMAIL: vpasmodule@gmail.com .DESCRIPTION USE THIS FUNCTION TO RETRIEVE CONNECTOR POOL DETAILS FROM CONNECTOR MANAGEMENT .LINK https://vpasmodule.com/commands/Get-VPASCMConnectorPoolDetails .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 PoolID UniqueID of the target connector pool in ConnectorManagement .PARAMETER PoolName Unique name of the target connector pool in ConnectorManagement .PARAMETER InputParameters HashTable of values containing the parameters required to make the API call .EXAMPLE $ConnectorPoolDetails = Get-VPASCMConnectorPoolDetails -PoolID {POOL ID VALUE} .EXAMPLE $ConnectorPoolDetails = Get-VPASCMConnectorPoolDetails -PoolName {POOL NAME VALUE} .EXAMPLE $InputParameters = @{ PoolID = "ahdkj9823-asdf-ghjk-1234-9487fhskdj" } $ConnectorPoolDetails = Get-VPASCMConnectorPoolDetails -InputParameters $InputParameters .EXAMPLE $InputParameters = @{ PoolName = "VmanTestPool" } $ConnectorPoolDetails = Get-VPASCMConnectorPoolDetails -InputParameters $InputParameters .OUTPUTS If successful: { "poolId": "ahdkj9823-asdf-ghjk-1234-9487fhskdj", "name": "Test", "description": null } --- $false if failed #> function Get-VPASCMConnectorPoolDetails{ [OutputType('System.Collections.Hashtable',[bool])] [CmdletBinding(DefaultParameterSetName='Set1')] Param( [Parameter(Mandatory=$true,ParameterSetName='Set1',ValueFromPipelineByPropertyName=$true,HelpMessage="Unique PoolID of the target pool (for example: ahdkj9823-asdf-ghjk-1234-9487fhskdj)")] [String]$PoolID, [Parameter(Mandatory=$true,ParameterSetName='Set2',ValueFromPipelineByPropertyName=$true,HelpMessage="Name of the target pool (for example: VpasTestPool01)")] [String]$PoolName, [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 = @("PoolID") MandatoryKeys = @("PoolID") } set2 = @{ AcceptableKeys = @("PoolName") MandatoryKeys = @("PoolName") } } $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 POOL 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($PoolID)){ Write-Verbose "NO CONNECTOR POOL ID PROVIDED...INVOKING HELPER FUNCTION TO RETRIEVE UNIQUE CONNECTOR POOL ID BASED ON SPECIFIED PARAMETERS" $PoolID = Get-VPASCMConnectorPoolIDHelper -token $token -SearchQuery $PoolName Write-Verbose "RETURNING CONNECTOR POOL ID" } else{ Write-Verbose "CONNECTOR POOL ID SUPPLIED, SKIPPING HELPER FUNCTION" } if($PoolID -eq -1){ $log = Write-VPASTextRecorder -inputval "COULD NOT FIND TARGET CONNECTOR POOL ID: $PoolID" -token $token -LogType MISC $log = Write-VPASTextRecorder -inputval "REST API COMMAND RETURNED: FALSE" -token $token -LogType MISC Write-Verbose "COULD NOT FIND TARGET CONNECTOR POOL ID: $PoolID" Write-VPASOutput -str "COULD NOT FIND TARGET CONNECTOR POOL ID: $PoolID" -type E return $false } else{ write-verbose "MAKING API CALL TO CYBERARK" $uri = "https://$SubDomain.connectormanagement.cyberark.cloud/api/connector-pools/$PoolID" 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 POOL 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 POOL DETAILS" Write-VPASOutput -str $_ -type E return $false } } End{ $log = Write-VPASTextRecorder -inputval $CommandName -token $token -LogType DIVIDER } } |