Disable-VPASRotationalPlatform


Supported Environments:
SelfHosted
SharedServices
PCloudStandard


Synopsis:

DEACTIVATE ROTATIONAL PLATFORM


Description:

USE THIS FUNCTION TO DEACTIVATE A ROTATIONAL PLATFORM (MAKE ROTATIONAL GROUP PLATFORM INACTIVE)


Syntax:

Disable-VPASRotationalPlatform [-DeactivateRotationalPlatformID] <String> [[-token] <Hashtable>] [<CommonParameters>]


Parameters:

-DeactivateRotationalPlatformID <String>
Unique RotationalPlatformID that will be deactivated

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

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

$DeactivateRotationaPlatformStatus = Disable-VPASRotationalPlatform -DeactivateRotationalPlatformID {DEACTIVATE ROTATIONAL PLATFORMID VALUE}


Outputs:

$true if successful

$false if failed