XboxlivePSModule

1.0.0.4

XboxLiveCmdlet.dll-help.xml

                                <?xml version="1.0" encoding="utf-8"?>

<helpItems xmlns="http://msh" schema="maml">

<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">

<command:details><command:name>Get-XblSandbox</command:name>

<command:verb>Get</command:verb>

<command:noun>XblSandbox</command:noun>

<maml:description><maml:para>Get sandbox for current machine or xbox console

</maml:para>

</maml:description>

</command:details>

<maml:description><maml:para>The Get-XblSandbox cmdlet let you get the sandbox for current machine or a remote xbox console.

</maml:para>

</maml:description>

<command:syntax><command:syntaxItem><maml:name>Get-XblSandbox</maml:name>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ConsoleName</maml:name>

<maml:Description><maml:para>The machine name of the console, could be an IP address as well.

</maml:para>

</maml:Description>

<command:parameterValue required="true" variableLength="false">String</command:parameterValue>

<dev:type><maml:name>String</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>None</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Password</maml:name>

<maml:Description><maml:para>Password for Xbox Device Portal authentication, if required.

</maml:para>

</maml:Description>

<command:parameterValue required="true" variableLength="false">String</command:parameterValue>

<dev:type><maml:name>String</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>None</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>UserName</maml:name>

<maml:Description><maml:para>Username for Xbox Device Portal authentication, if required.

</maml:para>

</maml:Description>

<command:parameterValue required="true" variableLength="false">String</command:parameterValue>

<dev:type><maml:name>String</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>None</dev:defaultValue>

</command:parameter>

</command:syntaxItem>

</command:syntax>

<command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ConsoleName</maml:name>

<maml:Description><maml:para>The machine name of the console, could be an IP address as well.

</maml:para>

</maml:Description>

<command:parameterValue required="true" variableLength="false">String</command:parameterValue>

<dev:type><maml:name>String</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>None</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Password</maml:name>

<maml:Description><maml:para>Password for Xbox Device Portal authentication, if required.

</maml:para>

</maml:Description>

<command:parameterValue required="true" variableLength="false">String</command:parameterValue>

<dev:type><maml:name>String</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>None</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>UserName</maml:name>

<maml:Description><maml:para>Username for Xbox Device Portal authentication, if required.

</maml:para>

</maml:Description>

<command:parameterValue required="true" variableLength="false">String</command:parameterValue>

<dev:type><maml:name>String</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>None</dev:defaultValue>

</command:parameter>

</command:parameters>

<command:inputTypes></command:inputTypes>

<command:returnValues></command:returnValues>

<maml:alertSet><maml:alert><maml:para>

</maml:para>

</maml:alert>

</maml:alertSet>

<command:examples><command:example><maml:title>-- Example 1: Get Sandbox for current machine runs cmdlet. --</maml:title>

<dev:code>Get-XblSandbox</dev:code>

<dev:remarks><maml:para>Thie command returns the sandbox for current machine runs cmdlet.

</maml:para>

</dev:remarks>

</command:example>

<command:example><maml:title>-- Example 2: Get Sandbox for remote Xbox One console. --</maml:title>

<dev:code>Get-XblSandbox -ConsoleName console -UserName username -Password password</dev:code>

<dev:remarks><maml:para>Thie command returns the sandbox for remote Xbox One console. Please make sure the console is in Dev mode and Xbox Device Portal is enabled.  If Xbox Device Portal does not require authentication, then don't need to pass in Username and Passeword

</maml:para>

</dev:remarks>

</command:example>

</command:examples>

<command:relatedLinks></command:relatedLinks>

</command:command>

<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">

<command:details><command:name>Set-XblSandbox</command:name>

<command:verb>Set</command:verb>

<command:noun>XblSandbox</command:noun>

<maml:description><maml:para>Set sandbox for current machine or xbox console.

</maml:para>

</maml:description>

</command:details>

<maml:description><maml:para>The cmdlet let you set the sandbox for current machine or a remote xbox console. If no ConsoleName parameter has specified, it sets the sandbox for local machine.

</maml:para>

</maml:description>

<command:syntax><command:syntaxItem><maml:name>Set-XblSandbox</maml:name>

<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"><maml:name>SandboxId</maml:name>

<maml:Description><maml:para>The sandbox Id want to set.

</maml:para>

</maml:Description>

<command:parameterValue required="true" variableLength="false">String</command:parameterValue>

<dev:type><maml:name>String</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>None</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ConsoleName</maml:name>

<maml:Description><maml:para>The machine name of the console, could be an IP address as well.

</maml:para>

</maml:Description>

<command:parameterValue required="true" variableLength="false">String</command:parameterValue>

<dev:type><maml:name>String</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>None</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Password</maml:name>

<maml:Description><maml:para>Password for Xbox Device Portal authentication, if required.

</maml:para>

</maml:Description>

<command:parameterValue required="true" variableLength="false">String</command:parameterValue>

<dev:type><maml:name>String</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>None</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>UserName</maml:name>

<maml:Description><maml:para>UserName for Xbox Device Portal authentication, if required.

</maml:para>

</maml:Description>

<command:parameterValue required="true" variableLength="false">String</command:parameterValue>

<dev:type><maml:name>String</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>None</dev:defaultValue>

</command:parameter>

</command:syntaxItem>

</command:syntax>

<command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ConsoleName</maml:name>

<maml:Description><maml:para>The machine name of the console, could be an IP address as well.

</maml:para>

</maml:Description>

<command:parameterValue required="true" variableLength="false">String</command:parameterValue>

<dev:type><maml:name>String</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>None</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Password</maml:name>

<maml:Description><maml:para>Password for Xbox Device Portal authentication, if required.

</maml:para>

</maml:Description>

<command:parameterValue required="true" variableLength="false">String</command:parameterValue>

<dev:type><maml:name>String</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>None</dev:defaultValue>

</command:parameter>

<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"><maml:name>SandboxId</maml:name>

<maml:Description><maml:para>The sandbox Id want to set.

</maml:para>

</maml:Description>

<command:parameterValue required="true" variableLength="false">String</command:parameterValue>

<dev:type><maml:name>String</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>None</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>UserName</maml:name>

<maml:Description><maml:para>UserName for Xbox Device Portal authentication, if required.

</maml:para>

</maml:Description>

<command:parameterValue required="true" variableLength="false">String</command:parameterValue>

<dev:type><maml:name>String</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>None</dev:defaultValue>

</command:parameter>

</command:parameters>

<command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name>

</dev:type>

<maml:description><maml:para>

</maml:para>

</maml:description>

</command:inputType>

</command:inputTypes>

<command:returnValues><command:returnValue><dev:type><maml:name>System.Object</maml:name>

</dev:type>

<maml:description><maml:para>

</maml:para>

</maml:description>

</command:returnValue>

</command:returnValues>

<maml:alertSet><maml:alert><maml:para>

</maml:para>

</maml:alert>

</maml:alertSet>

<command:examples><command:example><maml:title>-- Example 1: Get Sandbox for current machine runs cmdlet. --</maml:title>

<dev:code>Set-XblSandbox XDKS.1</dev:code>

<dev:remarks><maml:para>Set current machine&amp;#39;s sandbox to XDKS.1

</maml:para>

</dev:remarks>

</command:example>

<command:example><maml:title>-- Example 2: Get Sandbox for remote Xbox One console. --</maml:title>

<dev:code>Set-XblSandbox XDKS.1 -ConsoleName console -UserName username -Password password</dev:code>

<dev:remarks><maml:para>Set remote xbox console sandbox id to XDKS.1 via Windows Device Portal .  Please make sure the console is in Dev mode and Xbox Device Portal is enabled.  If Xbox Device Portal does not require authentication, then don't need to pass in Username and Passeword

</maml:para>

</dev:remarks>

</command:example>

</command:examples>

<command:relatedLinks></command:relatedLinks>

</command:command>

</helpItems>