RestartComputerCommand Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Cmdlet to restart computer.
public ref class RestartComputerCommand : System::Management::Automation::PSCmdlet, IDisposable
public class RestartComputerCommand : System.Management.Automation.PSCmdlet, IDisposable
[System.Management.Automation.Cmdlet("Restart", "Computer", DefaultParameterSetName="DefaultSet", HelpUri="https://go.microsoft.com/fwlink/?LinkID=2097060", RemotingCapability=System.Management.Automation.RemotingCapability.OwnedByCommand, SupportsShouldProcess=true)]
public class RestartComputerCommand : System.Management.Automation.PSCmdlet, IDisposable
type RestartComputerCommand = class
inherit PSCmdlet
interface IDisposable
[<System.Management.Automation.Cmdlet("Restart", "Computer", DefaultParameterSetName="DefaultSet", HelpUri="https://go.microsoft.com/fwlink/?LinkID=2097060", RemotingCapability=System.Management.Automation.RemotingCapability.OwnedByCommand, SupportsShouldProcess=true)>]
type RestartComputerCommand = class
inherit PSCmdlet
interface IDisposable
Public Class RestartComputerCommand
Inherits PSCmdlet
Implements IDisposable
- Inheritance
- Attributes
- Implements
Constructors
RestartComputerCommand() |
Properties
AsJob |
Used to start a command remotely as a Job. The Job results are collected and stored in the global cache on the client machine. |
CommandOrigin |
This property tells you if you were being invoked inside the runspace or if it was an external request. (Inherited from InternalCommand) |
CommandRuntime |
Holds the command runtime object for this command. This object controls what actually happens when a write is called. (Inherited from Cmdlet) |
ComputerName |
Specifies the computer (s)Name on which this command is executed. When this parameter is omitted, this cmdlet restarts the local computer. Type the NETBIOS name, IP address, or fully-qualified domain name of one or more computers in a comma-separated list. To specify the local computer, type the computername or "localhost". |
Credential |
The following is the definition of the input parameter "Credential". Specifies a user account that has permission to perform this action. Type a user-name, such as "User01" or "Domain01\User01", or enter a PSCredential object, such as one from the Get-Credential cmdlet |
CurrentPSTransaction |
Gets an object that surfaces the current PowerShell transaction. When this object is disposed, PowerShell resets the active transaction. (Inherited from Cmdlet) |
DcomAuthentication |
The following is the definition of the input parameter "Authentication". Specifies the authentication level to be used with WMI connection. Valid values are: Unchanged = -1, Default = 0, None = 1, Connect = 2, Call = 3, Packet = 4, PacketIntegrity = 5, PacketPrivacy = 6. |
Delay |
Specify the Delay parameter. The specific time interval (in second) to wait between network pings or service queries. |
Events |
Gets the event manager for the current runspace. (Inherited from PSCmdlet) |
For |
Specify the For parameter. Wait for the specific service before unblocking the prompt. |
Force |
Using Force in conjunction with Reboot on a remote computer immediately reboots the remote computer. |
Host |
Gets the host interaction APIs. (Inherited from PSCmdlet) |
Impersonation |
The following is the definition of the input parameter "Impersonation". Specifies the impersonation level to use when calling the WMI method. Valid values are: Default = 0, Anonymous = 1, Identify = 2, Impersonate = 3, Delegate = 4. |
InvokeCommand |
Provides access to utility routines for executing scripts and creating script blocks. (Inherited from PSCmdlet) |
InvokeProvider |
Gets the instance of the provider interface APIs for the current runspace. (Inherited from PSCmdlet) |
JobManager |
Manager for JobSourceAdapters registered. (Inherited from PSCmdlet) |
JobRepository |
Repository for jobs. (Inherited from PSCmdlet) |
MyInvocation |
Contains information about the identity of this cmdlet and how it was invoked. (Inherited from PSCmdlet) |
PagingParameters |
If the cmdlet declares paging support (via SupportsPaging),
then PagingParameters property contains arguments of the paging parameters.
Otherwise PagingParameters property is |
ParameterSetName |
The name of the parameter set in effect. (Inherited from PSCmdlet) |
Protocol |
Specify the protocol to use |
SessionState |
Gets the instance of session state for the current runspace. (Inherited from PSCmdlet) |
Stopping |
Is this command stopping? (Inherited from Cmdlet) |
ThrottleLimit |
Allows the user of the cmdlet to specify a throttling value for throttling the number of remote operations that can be executed simultaneously. |
Timeout |
Specify the Timeout parameter. Negative value indicates wait infinitely. Positive value indicates the seconds to wait before timeout. |
Wait |
Specify the Wait parameter. Prompt will be blocked is the Timeout is not 0 |
WsmanAuthentication |
The authentication options for CIM_WSMan connection |
Methods
BeginProcessing() |
BeginProcessing. |
CurrentProviderLocation(String) | (Inherited from PSCmdlet) |
Dispose() |
Dispose Method |
Dispose(Boolean) |
Dispose Method. |
EndProcessing() |
When overridden in the derived class, performs clean-up after the command execution. Default implementation in the base class just returns. (Inherited from Cmdlet) |
GetResolvedProviderPathFromPSPath(String, ProviderInfo) | (Inherited from PSCmdlet) |
GetResourceString(String, String) |
Gets the resource string corresponding to baseName and resourceId from the current assembly. You should override this if you require a different behavior. (Inherited from Cmdlet) |
GetUnresolvedProviderPathFromPSPath(String) | (Inherited from PSCmdlet) |
GetVariableValue(String, Object) | (Inherited from PSCmdlet) |
GetVariableValue(String) | (Inherited from PSCmdlet) |
Invoke() |
Invoke this cmdlet object returning a collection of results. (Inherited from Cmdlet) |
Invoke<T>() |
Returns a strongly-typed enumerator for the results of this cmdlet. (Inherited from Cmdlet) |
ProcessRecord() |
ProcessRecord method. |
ShouldContinue(String, String, Boolean, Boolean, Boolean) |
Confirm an operation or grouping of operations with the user. This differs from ShouldProcess in that it is not affected by preference settings or command-line parameters, it always does the query. This variant offers Yes, No, YesToAll and NoToAll. (Inherited from Cmdlet) |
ShouldContinue(String, String, Boolean, Boolean) |
Confirm an operation or grouping of operations with the user. This differs from ShouldProcess in that it is not affected by preference settings or command-line parameters, it always does the query. This variant offers Yes, No, YesToAll and NoToAll. (Inherited from Cmdlet) |
ShouldContinue(String, String) |
Confirm an operation or grouping of operations with the user. This differs from ShouldProcess in that it is not affected by preference settings or command-line parameters, it always does the query. This variant only offers Yes/No, not YesToAll/NoToAll. (Inherited from Cmdlet) |
ShouldProcess(String, String, String, ShouldProcessReason) |
Confirm the operation with the user. Cmdlets which make changes (e.g. delete files, stop services etc.) should call ShouldProcess to give the user the opportunity to confirm that the operation should actually be performed. This variant allows the caller to specify the complete text describing the operation, rather than just the name and action. (Inherited from Cmdlet) |
ShouldProcess(String, String, String) |
Confirm the operation with the user. Cmdlets which make changes (e.g. delete files, stop services etc.) should call ShouldProcess to give the user the opportunity to confirm that the operation should actually be performed. This variant allows the caller to specify the complete text describing the operation, rather than just the name and action. (Inherited from Cmdlet) |
ShouldProcess(String, String) |
Confirm the operation with the user. Cmdlets which make changes (e.g. delete files, stop services etc.) should call ShouldProcess to give the user the opportunity to confirm that the operation should actually be performed. This variant allows the caller to specify text for both the target resource and the action. (Inherited from Cmdlet) |
ShouldProcess(String) |
Confirm the operation with the user. Cmdlets which make changes (e.g. delete files, stop services etc.) should call ShouldProcess to give the user the opportunity to confirm that the operation should actually be performed. (Inherited from Cmdlet) |
StopProcessing() |
to implement ^C |
ThrowTerminatingError(ErrorRecord) |
Terminate the command and report an error. (Inherited from Cmdlet) |
TransactionAvailable() |
Returns true if a transaction is available and active. (Inherited from Cmdlet) |
WriteCommandDetail(String) |
Write text into pipeline execution log. (Inherited from Cmdlet) |
WriteDebug(String) |
Display debug information. (Inherited from Cmdlet) |
WriteError(ErrorRecord) |
Internal variant: Writes the specified error to the error pipe. (Inherited from Cmdlet) |
WriteInformation(InformationRecord) |
Route information to the user or host. (Inherited from Cmdlet) |
WriteInformation(Object, String[]) |
Route information to the user or host. (Inherited from Cmdlet) |
WriteObject(Object, Boolean) |
Writes one or more objects to the output pipe. If the object is a collection and the enumerateCollection flag is true, the objects in the collection will be written individually. (Inherited from Cmdlet) |
WriteObject(Object) |
Writes the object to the output pipe. (Inherited from Cmdlet) |
WriteProgress(ProgressRecord) |
Display progress information. (Inherited from Cmdlet) |
WriteVerbose(String) |
Display verbose information. (Inherited from Cmdlet) |
WriteWarning(String) |
Display warning information. (Inherited from Cmdlet) |