en-us/Win32Shutdown.cdxml-help.xml
|
<?xml version = "1.0" encoding = "utf-8" ?>
<helpItems schema="maml"> <!--Start-Shutdown--> <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"> <!-- Name and Synopsis --> <command:details> <command:name>Start-Shutdown</command:name> <maml:description> <maml:para>Initiates shutdown.</maml:para> </maml:description> <maml:copyright> <maml:para>2016 Chris Carter</maml:para> </maml:copyright> <command:verb>Start</command:verb> <command:noun>Shutdown</command:noun> <dev:version>1.0</dev:version> </command:details> <!-- Description --> <maml:description> <maml:para>The Start-Shutdown cmdlet is a wrapper for the Win32_OperatingSystem class' Win32Shutdown method. This command can be used to log off, shut down, power off, or reboot the local or remote computer. For more information see the Type parameter description.</maml:para> </maml:description> <!-- Syntax --> <command:syntax> <command:syntaxItem> <maml:name>Start-Shutdown</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>AsJob</maml:name> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>CimSession</maml:name> <command:parameterValue required="true" variableLength="true">CimSession[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <command:parameterValue required="true" variableLength="true">CimInstance[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ThrottleLimit</maml:name> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases=""> <maml:name>Type</maml:name> <command:parameterValue required="true" variableLength="false">ShutdownTypes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <!-- Parameters --> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>AsJob</maml:name> <maml:description> <maml:para>Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the <maml:navigationLink><maml:linkText>Receive-Job</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. For more information about Windows PowerShell® background jobs, see <maml:navigationLink><maml:linkText>about_Jobs</maml:linkText><maml:uri></maml:uri></maml:navigationLink>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>CimSession</maml:name> <maml:description> <maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">CimSession[]</command:parameterValue> <dev:type> <maml:name>CimSession[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Accepts an Win32_OperatingSystem object from the pipeline as input.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">CimInstance[]</command:parameterValue> <dev:type> <maml:name>CimInstance[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ThrottleLimit</maml:name> <maml:description> <maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Type</maml:name> <maml:description> <maml:para>Specifies the type of shutdown to perform. Available values are:</maml:para> <maml:para>LogOff, Reboot, Shutdown, PowerOff, ForcedLogOff, ForcedReboot, ForcedShutdown, ForcedPowerOff</maml:para> <maml:para>Using any of the forced options performs the operation without notifying applications and services. This can lead to a loss of user data and an indeterminate return value.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ShutdownTypes</command:parameterValue> <dev:type> <maml:name>ShutdownTypes</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <!-- Inputs --> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.Management.Infrastructure.CimInstance#Root/Cimv2/Win32_OperatingSystem</maml:name> <maml:uri></maml:uri> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe CimInstance objects that are dervied from the Root/Cimv2/Win32_OperatingSystem class to Start-Shutdown.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <!-- Outputs --> <command:returnValues> <command:returnValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri></maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>Start-Shutdown returns an UInt32 to indicate success. Zero (0) is successful, while any other number is an error code corresponding to one of the WbemErrorEnum members.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <!-- Notes --> <!--<maml:alertSet> </maml:alertSet>--> <!-- Examples --> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code> Start-Shutdown -Type LogOff </dev:code> <dev:remarks> <maml:para>This command logs all users off of the local computer.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code> Start-Shutdown -Type Shutdown -CimSession (New-CimSession server1) </dev:code> <dev:remarks> <maml:para>This command shuts down the machine "server1" remotely.</maml:para> </dev:remarks> </command:example> </command:examples> <!-- Related Links --> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-CimCession</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-CimInstance</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Start-TrackedShutdown --> <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"> <!-- Name and Synopsis --> <command:details> <command:name>Start-TrackedShutdown</command:name> <maml:description> <maml:para>Initiates shutdown with information for the event log.</maml:para> </maml:description> <maml:copyright> <maml:para>2016 Chris Carter</maml:para> </maml:copyright> <command:verb>Start</command:verb> <command:noun>TrackedShutdown</command:noun> <dev:version>1.0</dev:version> </command:details> <!-- Description --> <maml:description> <maml:para>The Start-TrackedShutdown cmdlet is a wrapper for the Win32_OperatingSystem class' Win32ShutdownTracker method. This command can be used to log off, shut down, power off, or reboot the local or remote computer. For more information see the Type parameter description. The Comment and ReasonCode parameters provide information that will be stored in the event log about the event, and the Timeout parameter is the amount of time in seconds to wait before performing the operation.</maml:para> </maml:description> <!-- Syntax --> <command:syntax> <command:syntaxItem> <maml:name>Start-TrackedShutdown</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>AsJob</maml:name> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>CimSession</maml:name> <command:parameterValue required="true" variableLength="true">CimSession[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases=""> <maml:name>Comment</maml:name> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <command:parameterValue required="true" variableLength="true">CimInstance[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>ReasonCode</maml:name> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ThrottleLimit</maml:name> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="3" aliases=""> <maml:name>Timeout</maml:name> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases=""> <maml:name>Type</maml:name> <command:parameterValue required="true" variableLength="false">ShutdownTypes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <!-- Parameters --> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>AsJob</maml:name> <maml:description> <maml:para>Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the <maml:navigationLink><maml:linkText>Receive-Job</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. For more information about Windows PowerShell® background jobs, see <maml:navigationLink><maml:linkText>about_Jobs</maml:linkText><maml:uri></maml:uri></maml:navigationLink>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>CimSession</maml:name> <maml:description> <maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">CimSession[]</command:parameterValue> <dev:type> <maml:name>CimSession[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="3" aliases=""> <maml:name>Comment</maml:name> <maml:description> <maml:para>Message to display in the shutdown dialog box that is also stored as a comment in the event log entry.</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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Accepts an Win32_OperatingSystem object from the pipeline as input.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">CimInstance[]</command:parameterValue> <dev:type> <maml:name>CimInstance[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases=""> <maml:name>ReasonCode</maml:name> <maml:description> <maml:para>Reason for initiating the shutdown.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ThrottleLimit</maml:name> <maml:description> <maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="4" aliases=""> <maml:name>Timeout</maml:name> <maml:description> <maml:para>Time, in seconds, before the shutdown takes place. The default is 0 (zero).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Type</maml:name> <maml:description> <maml:para>Specifies the type of shutdown to perform. Available values are:</maml:para> <maml:para>LogOff, Reboot, Shutdown, PowerOff, ForcedLogOff, ForcedReboot, ForcedShutdown, ForcedPowerOff</maml:para> <maml:para>Using any of the forced options performs the operation without notifying applications and services. This can lead to a loss of user data and an indeterminate return value.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ShutdownTypes</command:parameterValue> <dev:type> <maml:name>ShutdownTypes</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <!-- Inputs --> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.Management.Infrastructure.CimInstance#Root/Cimv2/Win32_OperatingSystem</maml:name> <maml:uri></maml:uri> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe CimInstance objects that are dervied from the Root/Cimv2/Win32_OperatingSystem class to Start-TrackedShutdown.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <!-- Outputs --> <command:returnValues> <command:returnValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri></maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>Start-TrackedShutdown returns an UInt32 to indicate success. Zero (0) is successful, while any other number is an error code corresponding to one of the WbemErrorEnum members.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <!-- Notes --> <!--<maml:alertSet> </maml:alertSet>--> <!-- Examples --> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Start-TrackedShutdown -Type LogOff -ReasonCode 13 -Comment "This is why the operation was performed." -Timeout 30 </dev:code> <dev:remarks> <maml:para>This command logs all users off of the local computer after 30 seconds, and puts a reason code of 13 and the specified comment into the event log entry for the event.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code> Start-TrackedShutdown -Type Shutdown -ReasonCode 10 -Comment "Quick comment" -Timeout 0 -CimSession (New-CimSession server1) </dev:code> <dev:remarks> <maml:para>This command shuts down the machine "server1" remotely immediately, and adds the reason code 10 and "Quick comment" in the event log entry for the event.</maml:para> </dev:remarks> </command:example> </command:examples> <!-- Related Links --> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-CimCession</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-CimInstance</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Start-PowerOff --> <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"> <!-- Name and Synopsis --> <command:details> <command:name>Start-PowerOff</command:name> <maml:description> <maml:para>Initiates a full power off.</maml:para> </maml:description> <maml:copyright> <maml:para>2016 Chris Carter</maml:para> </maml:copyright> <command:verb>Start</command:verb> <command:noun>PowerOff</command:noun> <dev:version>1.0</dev:version> </command:details> <!-- Description --> <maml:description> <maml:para>The Start-PowerOff cmdlet is a wrapper for the Win32_OperatingSystem class' Shutdown method, and immediately shutdowns a computer where it is safe to turn it off.</maml:para> </maml:description> <!-- Syntax --> <command:syntax> <command:syntaxItem> <maml:name>Start-PowerOff</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>AsJob</maml:name> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>CimSession</maml:name> <command:parameterValue required="true" variableLength="true">CimSession[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <command:parameterValue required="true" variableLength="true">CimInstance[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ThrottleLimit</maml:name> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <!-- Parameters --> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>AsJob</maml:name> <maml:description> <maml:para>Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the <maml:navigationLink><maml:linkText>Receive-Job</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. For more information about Windows PowerShell® background jobs, see <maml:navigationLink><maml:linkText>about_Jobs</maml:linkText><maml:uri></maml:uri></maml:navigationLink>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>CimSession</maml:name> <maml:description> <maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">CimSession[]</command:parameterValue> <dev:type> <maml:name>CimSession[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Accepts an Win32_OperatingSystem object from the pipeline as input.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">CimInstance[]</command:parameterValue> <dev:type> <maml:name>CimInstance[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ThrottleLimit</maml:name> <maml:description> <maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <!-- Inputs --> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.Management.Infrastructure.CimInstance#Root/Cimv2/Win32_OperatingSystem</maml:name> <maml:uri></maml:uri> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe CimInstance objects that are dervied from the Root/Cimv2/Win32_OperatingSystem class to Start-PowerOff.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <!-- Outputs --> <command:returnValues> <command:returnValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri></maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>Start-PowerOff returns an UInt32 to indicate success. Zero (0) is successful, while any other number is an error code corresponding to one of the WbemErrorEnum members.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <!-- Notes --> <!--<maml:alertSet> </maml:alertSet>--> <!-- Examples --> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code> Start-PowerOff </dev:code> <dev:remarks> <maml:para>This command powers off the local computer.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code> Start-PowerOff -CimSession (New-CimSession server1) </dev:code> <dev:remarks> <maml:para>This powers off the machine "server1" remotely.</maml:para> </dev:remarks> </command:example> </command:examples> <!-- Related Links --> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-CimCession</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-CimInstance</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Start-Reboot --> <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"> <!-- Name and Synopsis --> <command:details> <command:name>Start-Reboot</command:name> <maml:description> <maml:para>Initiates a reboot.</maml:para> </maml:description> <maml:copyright> <maml:para>2016 Chris Carter</maml:para> </maml:copyright> <command:verb>Start</command:verb> <command:noun>Reboot</command:noun> <dev:version>1.0</dev:version> </command:details> <!-- Description --> <maml:description> <maml:para>The Start-Reboot cmdlet is a wrapper for the Win32_OperatingSystem class' Reboot method, and immediately reboots a computer.</maml:para> </maml:description> <!-- Syntax --> <command:syntax> <command:syntaxItem> <maml:name>Start-Reboot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>AsJob</maml:name> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>CimSession</maml:name> <command:parameterValue required="true" variableLength="true">CimSession[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <command:parameterValue required="true" variableLength="true">CimInstance[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ThrottleLimit</maml:name> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <!-- Parameters --> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>AsJob</maml:name> <maml:description> <maml:para>Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the <maml:navigationLink><maml:linkText>Receive-Job</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. For more information about Windows PowerShell® background jobs, see <maml:navigationLink><maml:linkText>about_Jobs</maml:linkText><maml:uri></maml:uri></maml:navigationLink>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>CimSession</maml:name> <maml:description> <maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">CimSession[]</command:parameterValue> <dev:type> <maml:name>CimSession[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Accepts an Win32_OperatingSystem object from the pipeline as input.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">CimInstance[]</command:parameterValue> <dev:type> <maml:name>CimInstance[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ThrottleLimit</maml:name> <maml:description> <maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <!-- Inputs --> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.Management.Infrastructure.CimInstance#Root/Cimv2/Win32_OperatingSystem</maml:name> <maml:uri></maml:uri> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe CimInstance objects that are dervied from the Root/Cimv2/Win32_OperatingSystem class to Start-Reboot.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <!-- Outputs --> <command:returnValues> <command:returnValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri></maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>Start-Reboot returns an UInt32 to indicate success. Zero (0) is successful, while any other number is an error code corresponding to one of the WbemErrorEnum members.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <!-- Notes --> <!--<maml:alertSet> </maml:alertSet>--> <!-- Examples --> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code> Start-Reboot </dev:code> <dev:remarks> <maml:para>This command reboots the local computer.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code> Start-Reboot -CimSession (New-CimSession server1) </dev:code> <dev:remarks> <maml:para>This reboots the machine "server1" remotely.</maml:para> </dev:remarks> </command:example> </command:examples> <!-- Related Links --> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-CimCession</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-CimInstance</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> </helpItems> |