Get-VPASCMConnectorDetails


Supported Environments:
SelfHosted
SharedServices
PCloudStandard


Synopsis:

GET CONNECTOR MANAGEMENT CONNECTOR DETAILS


Description:

USE THIS FUNCTION TO RETRIEVE CONNECTOR DETAILS FROM CONNECTOR MANAGEMENT


Syntax:

Get-VPASCMConnectorDetails [[-ConnectorID] <String>] [[-ConnectorHost] <String>] [[-token] <Hashtable>] [<CommonParameters>]


Parameters:

-ConnectorID <String>
UniqueID of the target connector in ConnectorManagement

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

-ConnectorHost <String>
Unique host of the target connector in ConnectorManagement
Host in this case can either be a hostname, a publicIP, or a PrivateIP

Required: false
Position: 2
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: 3
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:

$ConnectorDetails = Get-VPASCMConnectorDetails -ConnectorID {CONNECTOR ID VALUE}

$ConnectorDetails = Get-VPASCMConnectorDetails -ConnectorHost {CONNECTOR NAME VALUE}


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