RemoteCommand 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.
Defines a command to run on one or more nodes in the cluster.
[System.Runtime.InteropServices.ClassInterface(System.Runtime.InteropServices.ClassInterfaceType.None)]
[System.Runtime.InteropServices.ComVisible(true)]
[System.Runtime.InteropServices.Guid("c8c9c032-3c94-40e0-92f3-598920f00b57")]
public class RemoteCommand : IDisposable, Microsoft.Hpc.Scheduler.IRemoteCommand
type RemoteCommand = class
interface IRemoteCommand
interface IDisposable
Public Class RemoteCommand
Implements IDisposable, IRemoteCommand
- Inheritance
-
RemoteCommand
- Attributes
- Implements
Properties
CommandLine |
Retrieves the command line to execute. |
Id |
Retrieves the command identifier that uniquely identifies the command in the scheduler. |
NodeNames |
Retrieves the collection of node names on which the command will run or has run. |
OutputEncoding |
Retrieves or sets the encoding to use on the output that the command generates. |
ProxyTaskId |
Retrieves the unique task identifier for the proxy task in a remote command job. The proxy task is the task that forwards the output and error streams from all of the nodes in a remote command to the client. |
Methods
Cancel() |
Cancels the command. |
Dispose() |
Releases all unmanaged resources used by the command. |
Finalize() |
Frees resources before the object is reclaimed by garbage collection. |
Start() |
Runs the command. |
StartWithCredentials(String, String) |
Runs the command using the specified credentials. |
Events
OnCommandJobState |
An event that is raised when the state of the job that contains the command changes. |
OnCommandOutput |
An event that is raised when the command generates a line of output. |
OnCommandRawOutput |
An event that is raised when the command generates output. The output is provided as a byte blob without encoding. |
OnCommandTaskState |
An event that is raised when the state of the command changes on a node. |
Explicit Interface Implementations
IRemoteCommand.OnCommandJobState |
Explicit interface implementation for the OnCommandJobState event. |
IRemoteCommand.OnCommandOutput |
Explicit interface implementation for the OnCommandOutput event. |
IRemoteCommand.OnCommandRawOutput |
Explicit interface implementation for the OnCommandRawOutput event. |
IRemoteCommand.OnCommandTaskState |
Explicit interface implementation for the OnCommandTaskState event. |