Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

PSRemotingActivity Class

 

Updated: April 27, 2016

Applies To: Windows PowerShell

Base class for Windows PowerShell workflow remote activities Introduced in Windows PowerShell 3.0.

Namespace:   Microsoft.PowerShell.Activities
Assembly:  Microsoft.PowerShell.Workflow.ServiceCore (in Microsoft.PowerShell.Workflow.ServiceCore.dll)

System.Object
  System.Activities.Activity
    System.Activities.NativeActivity
      Microsoft.PowerShell.Activities.PipelineEnabledActivity
        Microsoft.PowerShell.Activities.PSActivity
          Microsoft.PowerShell.Activities.PSRemotingActivity
            Microsoft.PowerShell.Activities.InlineScript
            Microsoft.PowerShell.Activities.PSCleanupActivity
            Microsoft.PowerShell.Core.Activities.DisablePSRemoting
            Microsoft.PowerShell.Core.Activities.DisablePSSessionConfiguration
            Microsoft.PowerShell.Core.Activities.EnablePSRemoting
            Microsoft.PowerShell.Core.Activities.EnablePSSessionConfiguration
            Microsoft.PowerShell.Core.Activities.GetCommand
            Microsoft.PowerShell.Core.Activities.GetHelp
            Microsoft.PowerShell.Core.Activities.GetJob
            Microsoft.PowerShell.Core.Activities.GetModule
            Microsoft.PowerShell.Core.Activities.GetPSSession
            Microsoft.PowerShell.Core.Activities.GetPSSessionConfiguration
            Microsoft.PowerShell.Core.Activities.NewModuleManifest
            Microsoft.PowerShell.Core.Activities.ReceiveJob
            Microsoft.PowerShell.Core.Activities.RegisterPSSessionConfiguration
            Microsoft.PowerShell.Core.Activities.RemoveJob
            Microsoft.PowerShell.Core.Activities.RemovePSSession
            Microsoft.PowerShell.Core.Activities.ResumeJob
            Microsoft.PowerShell.Core.Activities.SaveHelp
            Microsoft.PowerShell.Core.Activities.SetPSSessionConfiguration
            Microsoft.PowerShell.Core.Activities.StartJob
            Microsoft.PowerShell.Core.Activities.StopJob
            Microsoft.PowerShell.Core.Activities.SuspendJob
            Microsoft.PowerShell.Core.Activities.TestModuleManifest
            Microsoft.PowerShell.Core.Activities.TestPSSessionConfigurationFile
            Microsoft.PowerShell.Core.Activities.UnregisterPSSessionConfiguration
            Microsoft.PowerShell.Core.Activities.UpdateHelp
            Microsoft.PowerShell.Core.Activities.WaitJob
            Microsoft.PowerShell.Diagnostics.Activities.ExportCounter
            Microsoft.PowerShell.Diagnostics.Activities.GetCounter
            Microsoft.PowerShell.Diagnostics.Activities.GetWinEvent
            Microsoft.PowerShell.Diagnostics.Activities.ImportCounter
            Microsoft.PowerShell.Diagnostics.Activities.NewWinEvent
            Microsoft.PowerShell.Management.Activities.AddComputer
            Microsoft.PowerShell.Management.Activities.AddContent
            Microsoft.PowerShell.Management.Activities.CheckpointComputer
            Microsoft.PowerShell.Management.Activities.ClearContent
            Microsoft.PowerShell.Management.Activities.ClearEventLog
            Microsoft.PowerShell.Management.Activities.ClearItem
            Microsoft.PowerShell.Management.Activities.ClearItemProperty
            Microsoft.PowerShell.Management.Activities.ClearRecycleBin
            Microsoft.PowerShell.Management.Activities.CopyItem
            Microsoft.PowerShell.Management.Activities.CopyItemProperty
            Microsoft.PowerShell.Management.Activities.DisableComputerRestore
            Microsoft.PowerShell.Management.Activities.EnableComputerRestore
            Microsoft.PowerShell.Management.Activities.GetChildItem
            Microsoft.PowerShell.Management.Activities.GetComputerRestorePoint
            Microsoft.PowerShell.Management.Activities.GetContent
            Microsoft.PowerShell.Management.Activities.GetEventLog
            Microsoft.PowerShell.Management.Activities.GetHotFix
            Microsoft.PowerShell.Management.Activities.GetItem
            Microsoft.PowerShell.Management.Activities.GetItemProperty
            Microsoft.PowerShell.Management.Activities.GetItemPropertyValue
            Microsoft.PowerShell.Management.Activities.GetLocation
            Microsoft.PowerShell.Management.Activities.GetProcess
            Microsoft.PowerShell.Management.Activities.GetPSDrive
            Microsoft.PowerShell.Management.Activities.GetPSProvider
            Microsoft.PowerShell.Management.Activities.GetService
            Microsoft.PowerShell.Management.Activities.InvokeItem
            Microsoft.PowerShell.Management.Activities.JoinPath
            Microsoft.PowerShell.Management.Activities.LimitEventLog
            Microsoft.PowerShell.Management.Activities.MoveItem
            Microsoft.PowerShell.Management.Activities.MoveItemProperty
            Microsoft.PowerShell.Management.Activities.NewEventLog
            Microsoft.PowerShell.Management.Activities.NewItem
            Microsoft.PowerShell.Management.Activities.NewItemProperty
            Microsoft.PowerShell.Management.Activities.NewService
            Microsoft.PowerShell.Management.Activities.NewWebServiceProxy
            Microsoft.PowerShell.Management.Activities.RegisterWmiEvent
            Microsoft.PowerShell.Management.Activities.RemoveComputer
            Microsoft.PowerShell.Management.Activities.RemoveEventLog
            Microsoft.PowerShell.Management.Activities.RemoveItem
            Microsoft.PowerShell.Management.Activities.RemoveItemProperty
            Microsoft.PowerShell.Management.Activities.RemoveWmiObject
            Microsoft.PowerShell.Management.Activities.RenameComputer
            Microsoft.PowerShell.Management.Activities.RenameItem
            Microsoft.PowerShell.Management.Activities.RenameItemProperty
            Microsoft.PowerShell.Management.Activities.ResetComputerMachinePassword
            Microsoft.PowerShell.Management.Activities.ResolvePath
            Microsoft.PowerShell.Management.Activities.RestartService
            Microsoft.PowerShell.Management.Activities.RestoreComputer
            Microsoft.PowerShell.Management.Activities.ResumeService
            Microsoft.PowerShell.Management.Activities.SetContent
            Microsoft.PowerShell.Management.Activities.SetItem
            Microsoft.PowerShell.Management.Activities.SetItemProperty
            Microsoft.PowerShell.Management.Activities.SetService
            Microsoft.PowerShell.Management.Activities.SetWmiInstance
            Microsoft.PowerShell.Management.Activities.SplitPath
            Microsoft.PowerShell.Management.Activities.StartProcess
            Microsoft.PowerShell.Management.Activities.StartService
            Microsoft.PowerShell.Management.Activities.StopComputer
            Microsoft.PowerShell.Management.Activities.StopProcess
            Microsoft.PowerShell.Management.Activities.StopService
            Microsoft.PowerShell.Management.Activities.SuspendService
            Microsoft.PowerShell.Management.Activities.TestComputerSecureChannel
            Microsoft.PowerShell.Management.Activities.TestConnection
            Microsoft.PowerShell.Management.Activities.TestPath
            Microsoft.PowerShell.Management.Activities.WaitProcess
            Microsoft.PowerShell.Management.Activities.WriteEventLog
            Microsoft.PowerShell.Security.Activities.ConvertFromSecureString
            Microsoft.PowerShell.Security.Activities.ConvertToSecureString
            Microsoft.PowerShell.Security.Activities.GetAcl
            Microsoft.PowerShell.Security.Activities.GetAuthenticodeSignature
            Microsoft.PowerShell.Security.Activities.GetCmsMessage
            Microsoft.PowerShell.Security.Activities.GetExecutionPolicy
            Microsoft.PowerShell.Security.Activities.GetPfxCertificate
            Microsoft.PowerShell.Security.Activities.ProtectCmsMessage
            Microsoft.PowerShell.Security.Activities.SetAcl
            Microsoft.PowerShell.Security.Activities.SetAuthenticodeSignature
            Microsoft.PowerShell.Security.Activities.SetExecutionPolicy
            Microsoft.PowerShell.Security.Activities.UnprotectCmsMessage
            Microsoft.PowerShell.Utility.Activities.AddType
            Microsoft.PowerShell.Utility.Activities.ConvertFromString
            Microsoft.PowerShell.Utility.Activities.ExportClixml
            Microsoft.PowerShell.Utility.Activities.ExportCsv
            Microsoft.PowerShell.Utility.Activities.ExportFormatData
            Microsoft.PowerShell.Utility.Activities.GetCulture
            Microsoft.PowerShell.Utility.Activities.GetDate
            Microsoft.PowerShell.Utility.Activities.GetEvent
            Microsoft.PowerShell.Utility.Activities.GetEventSubscriber
            Microsoft.PowerShell.Utility.Activities.GetTraceSource
            Microsoft.PowerShell.Utility.Activities.GetTypeData
            Microsoft.PowerShell.Utility.Activities.GetUICulture
            Microsoft.PowerShell.Utility.Activities.ImportClixml
            Microsoft.PowerShell.Utility.Activities.ImportCsv
            Microsoft.PowerShell.Utility.Activities.ImportLocalizedData
            Microsoft.PowerShell.Utility.Activities.InvokeExpression
            Microsoft.PowerShell.Utility.Activities.InvokeRestMethod
            Microsoft.PowerShell.Utility.Activities.InvokeWebRequest
            Microsoft.PowerShell.Utility.Activities.NewEvent
            Microsoft.PowerShell.Utility.Activities.OutFile
            Microsoft.PowerShell.Utility.Activities.OutPrinter
            Microsoft.PowerShell.Utility.Activities.RegisterEngineEvent
            Microsoft.PowerShell.Utility.Activities.RegisterObjectEvent
            Microsoft.PowerShell.Utility.Activities.RemoveEvent
            Microsoft.PowerShell.Utility.Activities.SelectString
            Microsoft.PowerShell.Utility.Activities.SelectXml
            Microsoft.PowerShell.Utility.Activities.SendMailMessage
            Microsoft.PowerShell.Utility.Activities.SetDate
            Microsoft.PowerShell.Utility.Activities.SetTraceSource
            Microsoft.PowerShell.Utility.Activities.StartSleep
            Microsoft.PowerShell.Utility.Activities.TeeObject
            Microsoft.PowerShell.Utility.Activities.UnblockFile
            Microsoft.PowerShell.Utility.Activities.UnregisterEvent
            Microsoft.PowerShell.Utility.Activities.WaitEvent
            Microsoft.WSMan.Management.Activities.ConnectWSMan
            Microsoft.WSMan.Management.Activities.DisableWSManCredSSP
            Microsoft.WSMan.Management.Activities.DisconnectWSMan
            Microsoft.WSMan.Management.Activities.EnableWSManCredSSP
            Microsoft.WSMan.Management.Activities.GetWSManCredSSP
            Microsoft.WSMan.Management.Activities.GetWSManInstance
            Microsoft.WSMan.Management.Activities.InvokeWSManAction
            Microsoft.WSMan.Management.Activities.NewWSManInstance
            Microsoft.WSMan.Management.Activities.RemoveWSManInstance
            Microsoft.WSMan.Management.Activities.SetWSManInstance
            Microsoft.WSMan.Management.Activities.SetWSManQuickConfig
            Microsoft.WSMan.Management.Activities.TestWSMan

public abstract class PSRemotingActivity : PSActivity, IImplementsConnectionRetry

NameDescription
System_CAPS_protmethodPSRemotingActivity()

Initializes a new instance of the PSRemotingActivity class. Introduced in Windows PowerShell 3.0.

NameDescription
System_CAPS_pubpropertyAppendOutput

Determines whether to append output to the stream specified by the Result property. Introduced in Windows PowerShell 3.0.(Inherited from PipelineEnabledActivity.)

System_CAPS_protpropertyCacheId

(Inherited from Activity.)

System_CAPS_protpropertyCanInduceIdle

Gets a value that indicates whether the activity can be idle. Introduced in Windows PowerShell 3.0.(Inherited from PSActivity.)

System_CAPS_protpropertyConstraints

(Inherited from Activity.)

System_CAPS_pubpropertyDebug

Gets or sets a value that indicates whether to emit the debug output of the activity. Introduced in Windows PowerShell 3.0.(Inherited from PSActivity.)

System_CAPS_protpropertyDefiningModule

Gets the name of the module that an activity needs to load before it can execute. Introduced in Windows PowerShell 3.0.(Inherited from PSActivity.)

System_CAPS_pubpropertyDisplayName

(Inherited from Activity.)

System_CAPS_pubpropertyErrorAction

Gets or sets how errors are handled by the activity. Introduced in Windows PowerShell 3.0.(Inherited from PSActivity.)

System_CAPS_pubpropertyId

(Inherited from Activity.)

System_CAPS_protpropertyImplementation

(Inherited from NativeActivity.)

System_CAPS_protpropertyImplementationVersion

(Inherited from NativeActivity.)

System_CAPS_pubpropertyInformationAction

Determines how information records should be handled by the activity. (Inherited from PSActivity.)

System_CAPS_pubpropertyInput

The input stream for the activity. Introduced in Windows PowerShell 3.0.(Inherited from PipelineEnabledActivity.)

System_CAPS_pubpropertyMergeErrorToOutput

Gets or sets a value that indicates whether to merge error data to the output stream. Introduced in Windows PowerShell 3.0.(Inherited from PSActivity.)

System_CAPS_protpropertyParameterDefaults

Gets or sets the parameter defaults. Introduced in Windows PowerShell 3.0.(Inherited from PSActivity.)

System_CAPS_pubpropertyPSActionRetryCount

Gets or sets the number of times the activity retries execution of an action after encountering an execution error. Introduced in Windows PowerShell 3.0.(Inherited from PSActivity.)

System_CAPS_pubpropertyPSActionRetryIntervalSec

Gets or sets the number of seconds to wait before retrying the action. Introduced in Windows PowerShell 3.0.(Inherited from PSActivity.)

System_CAPS_pubpropertyPSActionRunningTimeoutSec

Gets or sets the number of seconds to wait before the action times out. Introduced in Windows PowerShell 3.0.(Inherited from PSActivity.)

System_CAPS_pubpropertyPSAllowRedirection

Determines whether to allow redirection by the remote computer. The default is false. Introduced in Windows PowerShell 3.0.

System_CAPS_pubpropertyPSApplicationName

Defines the remote application name to connect to. The default is wsman. Introduced in Windows PowerShell 3.0.

System_CAPS_pubpropertyPSAuthentication

Defines the authentication type to be used in the remote connection. Introduced in Windows PowerShell 3.0.

System_CAPS_pubpropertyPSCertificateThumbprint

Defines the certificate thumbprint to be used in the remote connection. Introduced in Windows PowerShell 3.0.

System_CAPS_pubpropertyPSCommandName

Gets the fully qualified name of the command invoked by this activity. Introduced in Windows PowerShell 3.0.(Inherited from PSActivity.)

System_CAPS_pubpropertyPSComputerName

The name of the remote computer. Introduced in Windows PowerShell 3.0.

System_CAPS_pubpropertyPSConfigurationName

Defines the remote configuration name to connect to. The default is Microsoft.PowerShell. Introduced in Windows PowerShell 3.0.

System_CAPS_pubpropertyPSConnectionRetryCount

Defines the number of retries that the activity will make to connect to a remote machine when it encounters an error. The default is to not retry. Introduced in Windows PowerShell 3.0.

System_CAPS_pubpropertyPSConnectionRetryIntervalSec

The number of seconds to wait before trying to run the activity again. Introduced in Windows PowerShell 3.0.

System_CAPS_pubpropertyPSConnectionUri

Defines the fully-qualified remote URI to connect to. When specified, the PSComputerName, PSApplicationName, PSConfigurationName, and PSPort properties are not used. Introduced in Windows PowerShell 3.0.

System_CAPS_pubpropertyPSCredential

The credentials used to authenticate the activity host. Introduced in Windows PowerShell 3.0.

System_CAPS_pubpropertyPSDebug

Gets or sets the debug stream (or collection of streams) for the activity. Introduced in Windows PowerShell 3.0.(Inherited from PSActivity.)

System_CAPS_protpropertyPSDefiningModule

Gets the module that defines the command called by this activity. Introduced in Windows PowerShell 3.0.(Inherited from PSActivity.)

System_CAPS_pubpropertyPSDisableSerialization

Gets or sets a value that indicates whether to disable serialization for the activity. Introduced in Windows PowerShell 3.0.(Inherited from PSActivity.)

System_CAPS_pubpropertyPSError

Gets or sets the error stream (or collection of streams) for the activity. Introduced in Windows PowerShell 3.0.(Inherited from PSActivity.)

System_CAPS_pubpropertyPSInformation

The Information stream / collection for the activity. (Inherited from PSActivity.)

System_CAPS_pubpropertyPSPersist

Gets or sets a value that indicates whether to force the activity to persist the workflow state onto the disk. Introduced in Windows PowerShell 3.0.(Inherited from PSActivity.)

System_CAPS_pubpropertyPSPort

The port to use in a remote connection attempt. The default is: HTTP: 5985, HTTPS: 5986. Introduced in Windows PowerShell 3.0.

System_CAPS_pubpropertyPSProgress

Gets or sets the progress stream (or collection of streams) for the activity. Introduced in Windows PowerShell 3.0.(Inherited from PSActivity.)

System_CAPS_pubpropertyPSProgressMessage

Gets or sets the message in the progress stream. Introduced in Windows PowerShell 3.0.(Inherited from PSActivity.)

System_CAPS_pubpropertyPSRemotingBehavior

Defines the remoting behavior to use when invoking this activity. Introduced in Windows PowerShell 3.0.

System_CAPS_pubpropertyPSRequiredModules

Gets or sets the list of module names or paths that are required to run this activity successfully. Introduced in Windows PowerShell 3.0.(Inherited from PSActivity.)

System_CAPS_pubpropertyPSSessionOption

Defines any session options to be used in the remote connection. Introduced in Windows PowerShell 3.0.

System_CAPS_pubpropertyPSUseSsl

Specifies whether to use Secure Sockets Layer (SSL) authentication in the connection attempt. The default is false. Introduced in Windows PowerShell 3.0.

System_CAPS_pubpropertyPSVerbose

Gets or sets the verbose stream (or collection of streams) for the activity. Introduced in Windows PowerShell 3.0.(Inherited from PSActivity.)

System_CAPS_pubpropertyPSWarning

Gets or sets the warning stream (or collection of streams) for the activity. Introduced in Windows PowerShell 3.0.(Inherited from PSActivity.)

System_CAPS_pubpropertyResult

The output stream from the activity. Introduced in Windows PowerShell 3.0.(Inherited from PipelineEnabledActivity.)

System_CAPS_protpropertySupportsCustomRemoting

Declares whether this command supports its own custom remoting.

Commands that support their own custom remoting should return true from this property, and use the PSComputerNameparameter as required when the PSRemotingBehavior parameter is set to Custom. Introduced in Windows PowerShell 3.0.

System_CAPS_protpropertyTracer

Gets access to Windows PowerShell tracing channels. Introduced in Windows PowerShell 3.0.(Inherited from PSActivity.)

System_CAPS_protpropertyUpdatePreferenceVariable

Gets a value that indicates whether preference variables are updated. Introduced in Windows PowerShell 3.0.(Inherited from PSActivity.)

System_CAPS_pubpropertyUseDefaultInput

Specifies whether to connect the input stream for this activity. Introduced in Windows PowerShell 3.0.(Inherited from PipelineEnabledActivity.)

System_CAPS_pubpropertyVerbose

Gets or sets a value that indicates whether to emit verbose output of the activity. Introduced in Windows PowerShell 3.0.(Inherited from PSActivity.)

System_CAPS_pubpropertyWarningAction

Gets or sets how warnings are handled by the activity. Introduced in Windows PowerShell 3.0.(Inherited from PSActivity.)

NameDescription
System_CAPS_protmethodAbort(NativeActivityAbortContext)

(Inherited from NativeActivity.)

System_CAPS_protmethodActivityEndPersistence(NativeActivityContext)

When overridden in a derived class, ends the persistence of the Windows PowerShell activity. Introduced in Windows PowerShell 3.0.(Inherited from PSActivity.)

System_CAPS_protmethodCacheMetadata(ActivityMetadata)

(Inherited from NativeActivity.)

System_CAPS_protmethodCacheMetadata(NativeActivityMetadata)

Retrieves the stream and ubiquitous parameter information from the hosting application. Introduced in Windows PowerShell 3.0.(Inherited from PSActivity.)

System_CAPS_protmethodCancel(NativeActivityContext)

Cancels the running activity. Introduced in Windows PowerShell 3.0.(Inherited from PSActivity.)

System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_protmethodExecute(NativeActivityContext)

Begins the execution of the activity. Introduced in Windows PowerShell 3.0.(Inherited from PSActivity.)

System_CAPS_protmethodFinalize()

(Inherited from Object.)

System_CAPS_protmethodGetActivityArguments()

Retrieves the list of arguments for the activity. Introduced in Windows PowerShell 3.0.(Inherited from PSActivity.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_protmethodGetImplementation(NativeActivityContext)

Prepare commands that use PSRP for remoting. Introduced in Windows PowerShell 3.0.(Overrides PSActivity.GetImplementation(NativeActivityContext).)

System_CAPS_protmethodGetIsComputerNameSpecified(ActivityContext)

Returns true if the PSComputerName parameter has been specified, and contains at least one target. Introduced in Windows PowerShell 3.0.

System_CAPS_protmethodGetPowerShell(NativeActivityContext)

When overridden in a derived class, retrieves a configured instance of PowerShell. Introduced in Windows PowerShell 3.0.(Inherited from PSActivity.)

System_CAPS_protmethodGetRunInProc(ActivityContext)

Determines whether this activity should be run in or out of process when run locally. Introduced in Windows PowerShell 3.0.(Inherited from PSActivity.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

(Inherited from Object.)

System_CAPS_protmethodOnCreateDynamicUpdateMap(NativeActivityUpdateMapMetadata, Activity)

(Inherited from NativeActivity.)

System_CAPS_protmethodOnCreateDynamicUpdateMap(UpdateMapMetadata, Activity)

(Inherited from NativeActivity.)

System_CAPS_protmethodPrepareSession(ActivityImplementationContext)

When overridden in a derived class, customizes the runspace of a PowerShell instance that the runtime has prepared for it. Introduced in Windows PowerShell 3.0.(Inherited from PSActivity.)

System_CAPS_pubmethodToString()

(Inherited from Activity.)

System_CAPS_protmethodUpdateImplementationContextForLocalExecution(ActivityImplementationContext, ActivityContext)

Updates the ActivityImplementationContext returned from the GetPowerShell method to support local execution against the host's runspace pool. Introduced in Windows PowerShell 3.0.(Inherited from PSActivity.)

System_CAPS_protmethodUpdateInstance(NativeActivityUpdateContext)

(Inherited from NativeActivity.)

System_CAPS_protmethodWriteProgressRecord(NativeActivityContext, PSDataCollection<ProgressRecord>, String, ProgressRecordType)

Writes a progress record for the current activity. Introduced in Windows PowerShell 3.0.(Inherited from PSActivity.)

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: