PSGeneratedCIMActivity Class

 

Updated: April 27, 2016

Applies To: Windows PowerShell

Represents the base functionality for Windows PowerShell-generated CIM activities that can use Web Services for Management protocol (WsMan) directly to contact the managed node. 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.PSGeneratedCIMActivity
            Microsoft.PowerShell.Activities.GenericCimCmdletActivity

public abstract class PSGeneratedCIMActivity : PSActivity, IImplementsConnectionRetry

NameDescription
System_CAPS_protmethodPSGeneratedCIMActivity()

Initializes a new instance of the PSGeneratedCIMActivity 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_pubpropertyCimSession

Gets or sets the CIM sessions to use for this activity. Introduced in Windows PowerShell 3.0.

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_protpropertyModuleDefinition

Gets the Windows PowerShell text that defines the module containing this command. Introduced in Windows PowerShell 3.0.

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_pubpropertyPSAuthentication

Gets or sets the authentication mechanism to use for the connection attempt. Introduced in Windows PowerShell 3.0.

System_CAPS_pubpropertyPSCertificateThumbprint

Gets or sets the thumbprint of the certificate to use. 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

Gets or sets the name of the computer on which to invoke the generated CIM activity. Introduced in Windows PowerShell 3.0.

System_CAPS_pubpropertyPSConnectionRetryCount

Gets or sets the number of times the activity retries connecting to a remote machine after encountering an connection error. Introduced in Windows PowerShell 3.0.

System_CAPS_pubpropertyPSConnectionRetryIntervalSec

Gets or sets the number of seconds to wait before retrying the connection. Introduced in Windows PowerShell 3.0.

System_CAPS_pubpropertyPSCredential

Gets or sets the credential to use to authenticate the remote connection. 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

Gets or sets the port to use in a remote connection attempt. 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_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

Gets or sets session options to be used in the remote connection. Introduced in Windows PowerShell 3.0.

System_CAPS_pubpropertyPSUseSsl

Gets or sets a value that indicates whether to use Secure Sockets Layer for the connection attempt. 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_pubpropertyResourceUri

Gets or sets the resource URI used by the CIM cmdlet. Introduced in Windows PowerShell 3.0.

System_CAPS_pubpropertyResult

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

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)

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

System_CAPS_protmethodGetIsComputerNameSpecified(ActivityContext)

Determines whether the computer name has been specified for an activity context. 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: