Skip to main content

​
SYNOPSIS

Uses the AskUI Remote Device Setup Tool to configure the device.

​
PARAMETERS

  • -Help | <SwitchParameter> - Shows the help information for the tool.
  • -EnableBackgroundAutomation | <SwitchParameter> - Enables the background automation and returns success.
  • -DisableBackgroundAutomation | <SwitchParameter> - Disables the background automation and returns success.
  • -CheckBackgroundAutomation | <SwitchParameter> - Returns whether the background automation is enabled or not.
  • -FixBackgroundAutomation | <SwitchParameter> - Tries to fix the background automation setup and returns success.
  • -CheckOpenGL | <SwitchParameter> - Checks whether the required OpenGL version is available.
  • -ShowReturnCodes | <SwitchParameter> - Prints the return codes as a JSON formatted list.
  • -ConfigFile | <String> - Loads the configuration from specified file.
  • -ConfigJson | <String> - Loads the specified configuration as JSON.

​
NOTES

This cmdlet is experimental and subject to change. This cmdlet is only available on Windows. Only one operation switch can be used at a time. Configuration parameters are optional and can be used with any operation.

​
EXAMPLES

​
EXAMPLE 1

Shows the help information for the tool. 
Start-AskUIRemoteDeviceSetupTool -Help

​
EXAMPLE 2

Enables background automation. 
Start-AskUIRemoteDeviceSetupTool -EnableBackgroundAutomation

​
EXAMPLE 3

Checks background automation status using a configuration file. 
Start-AskUIRemoteDeviceSetupTool -CheckBackgroundAutomation -ConfigFile "config.json"

​
EXAMPLE 4

Checks OpenGL availability with a JSON configuration. 
Start-AskUIRemoteDeviceSetupTool -CheckOpenGL -ConfigJson '{"key": "value"}'