Get-VPASPSMSettingsByPlatformID


Supported Environments:
SelfHosted
SharedServices
PCloudStandard


Synopsis:

GET PSM SETTINGS BY PLATFORMID


Description:

USE THIS FUNCTION TO GET PSM SETTINGS FOR A SPECIFIC PLATFORM


Syntax:

Get-VPASPSMSettingsByPlatformID -PlatformID <String> [-token <Hashtable>] [<CommonParameters>]

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


Parameters:

-PlatformID <String>
Unique PlatformID to retrieve PSM settings for

Required: true
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:

$PSMSettingsJSON = Get-VPASPSMSettingsByPlatformID -PlatformID {PLATFORMID VALUE}

$InputParameters = @{
        PlatformID = "TargetPlatformID"
}
$PSMSettingsJSON = Get-VPASPSMSettingsByPlatformID -InputParameters $InputParameters


Outputs:

If successful:
{
         "PSMConnectors": [
                 {
                         "PSMConnectorID": "PSM-RDP",
                         "Enabled": true
                 }
         ],
         "PSMServerId": "PSMServer_jka98723",
         "PSMSessionRecorderSafe": "PSMRecordings"
}

$false if failed