Update-VPASPSMSettingsByPlatformID


Supported Environments:
SelfHosted
SharedServices
PCloudStandard


Synopsis:

UPDATE PSM SETTINGS BY PLATFORMID


Description:

USE THIS FUNCTION TO UPDATE PSM SETTINGS LIKE CONNECTION COMPONENTS AND PSMSERVERID FOR A SPECIFIC PLATFORM


Syntax:

Update-VPASPSMSettingsByPlatformID -PlatformID <String> -ConnectionComponentID <String> -Action <String> [-token <Hashtable>] [<CommonParameters>]

Update-VPASPSMSettingsByPlatformID -PlatformID <String> -PSMServerID <String> [-token <Hashtable>] [<CommonParameters>]

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


Parameters:

-PlatformID <String>
Unique PlatformID that will be updated

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

-ConnectionComponentID <String>
Unique ConnectionComponentID that will be added or removed

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

-Action <String>
Which action will be taken on the updated fields
Possible values: ADD, REMOVE

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

-PSMServerID <String>
Unique target PSMServerID that will be added or removed

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:

$UpdatePSMSettingsStatus = Update-VPASPSMSettingsByPlatformID -PlatformID {PLATFORMID VALUE} -ConnectionComponentID {CONNECTION COMPONENT ID VALUE} -Action {ACTION VALUE}

$UpdatePSMSettingsStatus = Update-VPASPSMSettingsByPlatformID -PlatformID {PLATFORMID VALUE} -PSMServerID {PSM SERVER ID VALUE}

$InputParameters = @{
        PlatformID = "TargetPlatformID"
        ConnectionComponentID = "PSM-RDP"
        Action = "ADD"|"REMOVE"
}
$UpdatePSMSettingsStatus = Update-VPASPSMSettingsByPlatformID -InputParameters $InputParameters

$InputParameters = @{
        PlatformID = "TargetPlatformID"
        PSMServerID = "PSM-NewServerID"
}
$UpdatePSMSettingsStatus = Update-VPASPSMSettingsByPlatformID -InputParameters $InputParameters


Outputs:

$true if successful

$false if failed