Get-VPASCMConnectors


Supported Environments:
SelfHosted
SharedServices
PCloudStandard


Synopsis:

GET CONNECTOR MANAGEMENT CONNECTORS


Description:

USE THIS FUNCTION TO RETRIEVE CONNECTORS FROM CONNECTOR MANAGEMENT VIA SEARCH QUERY


Syntax:

Get-VPASCMConnectors -SearchQuery <String> [-ExportToCSV] [-CSVDirectory <String>] [-token <Hashtable>] [<CommonParameters>]

Get-VPASCMConnectors -InputParameters <Hashtable> [-token <Hashtable>] [<CommonParameters>]


Parameters:

-SearchQuery <String>
Search string to find target resource

Required: true
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-ExportToCSV [<SwitchParameter>]
Output results to a CSV file found in AppData\Local\VPASModuleOutputs directory

Required: false
Position: named
Default value: False
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-CSVDirectory <String>
Output directory where the exported CSV file will be saved to
Default value: C:\Users\{CurrentUser}\AppData\Local\VPASModuleOutputs\ExportedCSVs

Required: false
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-InputParameters <Hashtable>
HashTable of values containing the parameters required to make the API call

Required: true
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-token <Hashtable>
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

Required: false
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug
ErrorAction, ErrorVariable, WarningAction, WarningVariable
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216)


Examples:

$TargetConnectors = Get-VPASCMConnectors -SearchQuery {SEARCH QUERY VALUE}

$InputParameters = @{
        SearchQuery = "VmanCon01"
         ExportToCSV = $true|$false
         CSVDirectory = "C:\Temp"
}
$TargetConnectors = Get-VPASCMConnectors -InputParameters $InputParameters


Outputs:

If successful:
{
         "value": [
                 {
                         "connectorId": "ManagementAgent_jhgsad678235-asdf-erty-45656-9784yriefhjkasd",
                         "connectorStatus": "Disconnected",
                         "platformType": "OnPrem",
                         "connectorPoolId": "jhgsad678235-asdf-erty-45656-9784yriefhjkasd",
                         "version": "1.0.483.0",
                         "upgradeVersions": "v1.0.581",
                         "installedAt": 1710823582160,
                         "updatedAt": 1718169798605,
                 "host": "@{hostname=VmanCon01; privateIp=192.168.111.111; publicIp=22.222.22.222; os=windows; osVersion=10.0.20348; osName=Windows Server 2022 Standard; cloudRegion=; cloudAccount=; cpuType=12th Gen Intel(R) Core(TM) i7-1265U; totalCpu=1; usedCpu=-1.0; totalMemory=4.288097381591797; usedMemory=-1.0; hostConfig=}",
                         "components": " "
                 },
                 {
                         "connectorId": "ManagementAgent_489723kjwdsbk-3456-7899-sdfg-kjsdnfb4389",
                         "connectorStatus": "Active",
                         "platformType": "OnPrem",
                         "connectorPoolId": "489723kjwdsbk-3456-7899-sdfg-kjsdnfb4389",
                         "version": "1.0.483.0",
                         "upgradeVersions": "v1.0.581",
                         "installedAt": 1710820946924,
                         "updatedAt": 1723831555919,
                 "host": "@{hostname=VmanCon02; privateIp=192.168.222.222; publicIp=333.3.333.33; os=windows; osVersion=10.0.20348; osName=Windows Server 2022 Standard Evaluation; cloudRegion=; cloudAccount=; cpuType=12th Gen Intel(R) Core(TM) i7-1265U; totalCpu=1; usedCpu=53.1; totalMemory=3.999034881591797; usedMemory=39.0; hostConfig=}",
                         "components": " "
                 }
         ]
}

$false if failed