Unattended Setup Script Reference

This topic describes the actions that are available to unattended setup scripts.

The following types of actions are available to unattended setup scripts:

• Common actions
• Application actions
• User actions
• Settings actions
• Utilities actions

Common actions

The following table lists the unattended setup script actions in the Common category.

Action	Purpose	Usage
Set sandbox ID	Sets the sandbox ID for the console.	Sandbox: "Contoso.1"
Add network credentials	Adds credentials for accessing a network share to the console. Credentials might be needed to register applications, update the console OS, or run external scripts or executables that are located on a protected network share. The password is encoded for parsing reasons (not for security). You should use low-access credentials to sign in unless the script file is carefully protected.	Server name: "\\MyServer" Username: "MyComputerName\Username" Password: Specify the password.
Update console OS recovery	Updates the console's OS recovery from a recovery stored on a network share. The console must have access to the network share (either because the share is unprotected or because the console has the appropriate credentials).	Network path: "\\MyComputer\PathToRecoveryFiles" Sandbox Id (Optional): "Contoso.1" Perform Factory Reset: Select to reset the console to its factory default state.
Sign in a user	Signs in to an existing Xbox Live user account. The password is encoded for parsing reasons (not for security). You should use low-access credentials to sign in unless the script file is carefully protected.	Email address: "example@contoso.com" Password: Specify the password.
Do custom action	Creates a custom action within the script.Unattended setup scripts are batch files that run on the console. Any commands that are available on the console and can be run from a command-line prompt or a batch file can be run in a custom action. PC-side tools such as Application Management (xbapp.exe) are not available in scripts. To determine whether a command can be used in a script, run the command using the Execute (xbrun.exe) command-line tool to verify that it is present on the console and runs as expected.	Action name: "myAction" Custom actions: Syntax of what you would normally put in a .bat or .cmd file.

Back to top

Application actions

The following table lists the unattended setup script actions in the Application category.

Action	Purpose	Usage
Register an application from a network share	Registers an app on the console from a network share. The console must have access to the network share (either because the share is unprotected or because the console has the appropriate credentials).	Network path: "\\MyComputer\PathToAppXManifestXML"
Install a packaged build	Installs a packaged app.	Path: Specify the full path to the app on a network share, USB drive, or dev kit. Destination drive: Select the hard drive to install the app on. Specifier string (Optional): Specify any optional specifiers to control which chunks in the package to install by default. This string should be in the form "/[Type]=[semicolon-delimited list of values]". Available types are Languages, ContentTypes, Devices, and Tags.
Copy and register an application on the title scratch drive	Copies an app on the console's title scratch drive and registers it. The console must have access to the network share (either because the share is unprotected or because the console has the appropriate credentials).	Network path: "\\MyComputer\PathToAppXManifestXML" Relative folder path: Specify the relative folder path.
Move an application from one drive to another	Moves the specified app to a different hard drive.	Package full name: Specify the full name of the app to move. Destination drive: Select the hard drive to move the app to.
Copy an application from one drive to another	Copies the specified app to a different hard drive.	Package full name: Specify the full name of the app to copy. Destination drive: Select the hard drive to copy the app to.
Move all applications from one drive to another	Moves all apps on the specified hard drive to a different hard drive. Apps that are registered on the source drive will be registered on the destination drive.	Source drive: Select the hard drive to move the apps from. Destination drive: Select the hard drive to move the apps to.
Copy all applications from one drive to another	Copies all apps on the specified hard drive to a different hard drive. The copied apps will not be registered on the destination drive.	Source drive: Select the hard drive to copy the apps from. Destination drive: Select the hard drive to copy the apps to.
Register an application already present on a drive	Registers an app that already exists on the specified drive.	Package full name: Specify the full name of the app to register. Destination drive: Select the hard drive where the app resides.
Register all applications present on a drive	Registers all apps on the specified drive.	Drive: Select the hard drive that contains the apps to register.
Launch an application	Launches an app on the console (by AUMID).	AUMID: "MyDefaultApp!App"

Back to top

User actions

The following table lists the unattended setup script actions in the User category.

Action	Purpose	Usage
Set the default controller pairing	Sets the type of user controller to use for automatic sign-in.	Auto sign in user controller: Specify "None", "Gamepad", "Virtual Gamepad", or "Any Physical Controller".
Set the default user	Sets the default user for the dev kit.	Select the predefined user from the drop-down list or specify a new value.
Create and sign in a new Xbox Live account	Creates a new Xbox Live test account and signs them in to the dev kit.	Specify the email address, password, and additional information for the new test account.
Sign in a user	Signs in to an existing Xbox Live user account. The password is encoded for parsing reasons (not for security). You should use low-access credentials to sign in unless the script file is carefully protected.	Email address: "example@contoso.com" Password: Specify the password.

Back to top

Settings actions

The following table lists the unattended setup script actions in the Settings category. Most of these settings can also be changed through the Configuration (xbconfig.exe) command-line tool and Xbox Device Portal (Windows Device Portal on Xbox).

Action	Purpose	Usage
Import settings from a file	Imports settings from a predefined file stored on the dev kit or on a network share.	Full file path: Specify the full path to the file on the dev kit or network share.
Set sandbox ID	Sets the sandbox ID for the console.	Sandbox: "Contoso.1"
Set autoboot setting	Configures the console to boot when power is connected.	Automatically boot console: Select to automatically boot the console when connected to power.
Set screen dim setting	Sets the time interval (in minutes) for the idle screen dimmer.	Dim screen interval: Specify the interval in the range [0, 255] after which to dim the screen, in minutes. A value of zero disables the dimmer.
Set power mode setting	Configures the console's power mode.	Power mode: Specify "Instant On" or "Energy Saving".
Set automatic shutdown setting	Sets the idle time interval (in minutes) after which the console will be shut down.	Turn off after: Specify "Never", "1 hour", or "6 hours".
Set TV resolution	Sets the TV resolution.	Display resolution: Specify "2160p", "1080p", "720p", or "480p".
Set the OS recovery update policy	Specifies whether the console OS is updated automatically.	OS recovery update policy: Specify "I install OS recovery updates manually", "Auto-install latest production OS recovery", or "Auto-install latest developer preview OS recovery".
Set the host name for the console	Sets the hostname for the console. The maximum length for a hostname is 15 characters. Hostnames can include letters, digits, and dashes.	Host name: "MyHostname" Automatically generate: Select to automatically generate a hostname based on the console's serial number (for example, "XB-001234567890").
Set the default home experience for the console	Determines whether to launch the developer experience or the retail experience by default.	Default home experience: Specify "Dev Home" or "Retail Home".
Allow connections from the Xbox App and Dev Mode Companion App	Determines whether to allow connections from the Xbox app and the Dev Mode Companion app.	Allow connections from the Xbox app: Select to allow connections from the Xbox app and the Dev Mode Companion app.
Set the profiling mode for PIX	Sets the profiling mode for PIX.	Profiling mode: Specify "On", "Off", or "Legacy".
Allow extra memory for titles	Specifies how much extra memory to give titles.	Additional memory for title (MBs): Enter the number of megabytes of extra memory to make available for titles.
Set what kind of crash dumps are gathered	Sets which types of crash dumps are gathered.	Crash dump type: Specify "None", "Triage", "Mini", or "Heap".
Set the default storage device for deployments	Sets the default storage device to use for deployments.	Select the default storage device from the drop-down list or specify a new value.
Allow high dynamic range if the display supports it	Specifies whether the dev kit should use high dynamic range (HDR) if it is supported by the connected display.	Allow high dynamic range if the display supports it: Select to allow the dev kit to use HDR.
Set the default controller pairing	Sets the type of user controller to use for automatic sign-in.	Auto sign in user controller: Specify "None", "Gamepad", "Virtual Gamepad", or "Any Physical Controller".
Set the default user	Sets the default user for the dev kit.	Select the predefined user from the drop-down list or specify a new value.
Set the geographic region	Sets the geographic region for the dev kit.	Geographic region: Enter the geographic region to use.
Set the preferred language	Sets the preferred langugage for the dev kit.	Preferred language(s): Select the preferred language from the drop-down list.
Set the preferred timezone	Sets the preferred timezone for the dev kit.	Time zone: Select the preferred time zone from the drop-down list.
Block further unattended scripts	Prevents any further unattended scripts from running on the console.	Block scripts: Select to block further unattended scripts from running on the console.
Block unattended scripts on USB drives	Prevents unattended scripts on a USB drive from running on the console.	Block scripts from a USB drive: Select to block unattended scripts on a USB drive from running on the console.
Run unattended scripts immediately	Specifies whether to run unattended scripts immediately after the console starts up. This setting removes the option to cancel a script.	Run scripts immediately: Select to run unattended scripts immediately after the console starts up.

Back to top

Utilities actions

The following table lists the unattended setup script actions in the Utilities category.

Action	Purpose	Usage
Run another script	Runs another script located on the console or a network share.	Path: Specify the network path or local path to the script to run. Script arguments (Optional): Specify any parameters for the script.
Run an executable	Runs another executable located on the console or a network share.	Path: Specify the network path or local path to the executable to run. Executable arguments (Optional): Specify any parameters for the executable.
Configure Xbox Device Portal	Configures the console to use Xbox Device Portal. The password is encoded for parsing reasons (not for security). You should use low-access credentials to sign in unless the script file is carefully protected.	Enable Xbox Device Portal: Select to enable Xbox Device Portal. Username (Optional): Specify the username. Password (Optional): Specify the password.
Add Xbox Device Portal custom certificate	Adds a custom certificate to Xbox Device Portal to circumvent the browser warning about a self-signed site certificate. For more information about how to generate a custom certificate, see Use a custom SSL certificate.	Path to .pfx file: Specify the path to the custom certificate. Password: Specify the password.
Show notification	Displays a custom system notification on the console.	Display a notification: "This text will appear in the notification."
Add wait	Adds a wait time to the unattended script, in seconds.	Wait time in seconds: Specify an integer for the wait time, in seconds.
Verbose logging	Enables verbose logging for the unattended script. You should use this option only to debug scripts.	N/A
Do custom action	Creates a custom action within the script.Unattended setup scripts are batch files that run on the console. Any commands that are available on the console and can be run from a command-line prompt or a batch file can be run in a custom action. PC-side tools such as Application Management (xbapp.exe) are not available in scripts. To determine whether a command can be used in a script, run the command using the Execute (xbrun.exe) command-line tool to verify that it is present on the console and runs as expected.	Action name: "myAction" Custom actions: Syntax of what you would normally put in a .bat or .cmd file.
Assign a script to a front panel button (Xbox One X Devkit)	Assigns a script from a network share or USB to a specific button on the front panel.	Select a script to assign to the button.

Back to top

See also

Configuring Your Dev Kit with an Unattended Setup Script