Remove-VPASRotationalPlatform


Supported Environments:
SelfHosted
SharedServices
PCloudStandard


Synopsis:

DELETE ROTATIONAL PLATFORM


Description:

USE THIS FUNCTION TO DELETE A ROTATIONAL PLATFORM


Syntax:

Remove-VPASRotationalPlatform [-DeleteRotationalPlatformID] <String> [[-token] <Hashtable>] [[-WhatIf]] [[-HideWhatIfOutput]] [<CommonParameters>]


Parameters:

-DeleteRotationalPlatformID <String>
Unique RotationalPlatformID to delete

Required: true
Position: 1
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: 2
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-WhatIf [<SwitchParameter>]
Run code simulation to see what is affected by running the command as well as any possible implications
This is a code simulation flag, meaning the command will NOT actually run

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

-HideWhatIfOutput [<SwitchParameter>]
Suppress any code simulation output from the console

Required: false
Position: 4
Default value: False
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:

$WhatIfSimulation = Remove-VPASRotationalPlatform -DeleteRotationalPlatformID {DELETE ROTATIONAL PLATFORMID VALUE} -WhatIf

$DeleteRotationalPlatformStatus = Remove-VPASRotationalPlatform -DeleteRotationalPlatformID {DELETE ROTATIONAL PLATFORMID VALUE}


Outputs:

$true if successful

$false if failed