Connect (xbconnect.exe)
Sets or queries the default console address used by Xbox One XDK remote tools.
xbconnect [/B] [/S] [/T] [/N] [/D] [/Q] [/QG] [/WS[:sec] ] [/WT[:sec] ] [/discover [search string] ] [/data] [/?] [address[+<accesskey>] [name]]
|
| Option | Description | ||||
|---|---|---|---|---|---|
| /B | Uses bare format (display only the console name or address). | ||||
| /S | Uses bare format, only System name or address is printed. | ||||
| /T | Uses bare format, only Tools name or address is printed. | ||||
| /N | Does not attempt to connect to the target address. | ||||
| /D | Display registered extensions and process build information. | ||||
| /Q | Query only, do not register a default address even if provided. Typically used with /D for direct queries without affecting default console setting. | ||||
| /QG | Query whether the Title OS (Game OS) is running. Query only, does not register a default address even if provided. Typically used by scripts to determine the Title OS state for choosing the correct method to access the Title files. If the Title is running ERRORLEVEL will be set to zero. If the title is not running ERRORLEVEL will be 1. The following snippet shows an example of checking the Title OS state in a script:
@xbconnect /QG > nul
@if ERRORLEVEL=1 GOTO SYSTEM
@echo Title running
@echo using xbcp
@GOTO ENDD
@:SYSTEM
@echo Title not running
@echo using robocopy
@GOTO ENDD
@:ENDD
@echo Done
Running the script would produce the following output:
C:\Scratch\D\XDK\SigninUser\temp>testqg.bat
Title not running
using robocopy
Done
C:\Scratch\D\XDK\SigninUser\temp>testqg.bat
Title running
using xbcp
Done
| ||||
| /WS[:sec] | Causes xbConnect to block until the System OS is ready for interaction or the timeout is reached. The default timeout is 120s. You can optionally specify a custom value, for example xbconnect /WS:200. Returns ERRORLEVEL=0 if the console is ready. Returns ERRORLEVEL=1 if the timeout is reached. The /WS option give you a reliable way of determining when a console is ready to receive commands, for example when you can call xbapp launch after an xbreboot. Use a value of -1 or 'infinite' to wait indefinitely. | ||||
| /WT[:sec] | Causes xbConnect to block until the Game OS is ready for interaction or the timeout is reached. The default timeout is 120s. You can optionally specify a custom value, for example xbconnect /WT:200. Returns ERRORLEVEL=0 if the console is ready. Returns ERRORLEVEL=1 if the timeout is reached. The /WT option gives you a reliable way of determining when the Game OS has completed initialization and your game has started. Use a value of -1 or 'infinite' to wait indefinitely. | ||||
| /discover [search string] | Search the LAN for Xbox consoles, filter by optional substring. The search string applies to the consoles' host names, not their IP addresses. | ||||
| /data | Returns the connection speed from your DevPC to your console in MB/s. | ||||
| /? | Shows a complete list of available options. | ||||
| address[+<accesskey>] [name] | address[+<accesskey>] Specifies the host name or address (Tools IP) of a targeted console. Setting the address changes the default console unless the /Q switch is specified. See Setting a Hostname for the Console IP Address for information on setting a host name on a console. If no address is specified, xbconnect displays the currently stored default address. Accesskey is a string you can use to restrict access to a console to only those people who know the access key. The access key is set using xbconfig accesskey=yourkey and rebooting. To access a console that has an access key set you must include a plus sign (+) and the key after the console IP or host name. See xbconfig accesskey for more information on access keys.
|
Note Remarks
If address is not specified and a default address has not previously been set, xbconnect displays an error message.
If address is not specified and a default address has been previously set, xbconnect attempts to connect to the default console address. This can be used to validate that the default console is still accessible.
When invoking other remote tools, you can override the default console address by using the /X switch to specify a dev kit.
Known Issue: After console reboot, HostName fails to resolve on Windows 7 clients
After a console reboots, HostName may fail to resolve on Windows 7 clients and xbconnect will report “unreachable”, for the Host and System IP addresses. The solution is to disable Client-Side DNS Failure caching in the Windows 7 client, as follows:
C:\>reg add HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\DNSCache\Parameters /v MaxNegativeCacheTTL /d 0 /t REG_DWORD
For more information about this solution, see How to Disable Client-Side DNS Caching in Windows XP and Windows Server 2003.