Command Reference > pmcmd Command Reference > StopWorkflow
  

StopWorkflow

Stops a workflow.
The StopWorkflow command uses the following syntax in the command line mode:
pmcmd StopWorkflow

<<-service|-sv> service [<-domain|-d> domain] [<-timeout|-t> timeout]>

<<-user|-u> username|<-uservar|-uv> userEnvVar>

<<-password|-p> password|<-passwordvar|-pv> passwordEnvVar>

[<<-usersecuritydomain|-usd> usersecuritydomain|<-usersecuritydomainvar|-usdv> userSecuritydomainEnvVar>]

[<-folder|-f> folder]

[<-runinsname|-rin> runInsName]

[-wfrunid workflowRunId]

[-wait|-nowait]

workflow
The StopWorkflow command uses the following syntax in the interactive mode:
pmcmd StopWorkflow

[<-folder|-f> folder]

[<-runinsname|-rin> runInsName]

[-wfrunid workflowRunId]

[-wait|-nowait]

workflow
The following table describes pmcmd StopWorkflow options and arguments:
Option
Argument
Description
-service
-sv
service
Required. Integration Service name.
-domain
-d
domain
Optional. Domain name.
-timeout
-t
timeout
Optional. Amount of time, in seconds, pmcmd attempts to connect to the Integration Service.
If the -timeout option is omitted, pmcmd uses the timeout value specified in the environment variable INFA_CLIENT_RESILIENCE_TIMEOUT. If the environment variable is not set, pmcmd uses the default timeout value. Default is 180.
-user
-u
username
Required in command line mode if you do not specify the user name environment variable. User name. Not used in interactive mode.
-uservar
-uv
userEnvVar
Specifies the user name environment variable.
Required in command line mode if you do not specify the user name. Not used in interactive mode.
-password
-p
password
Required in command line mode if you do not specify the password environment variable. Password. Not used in interactive mode.
-passwordvar
-pv
passwordEnvVar
Required in command line mode if you do not specify the password. Password environment variable. Not used in interactive mode.
-usersecuritydomain
-usd
usersecuritydomain
Optional in command line mode. Required if you use LDAP authentication. Name of the security domain that the user belongs to. Not used in interactive mode. Default is Native.
-usersecuritydomainvar
-usdv
userSecuritydomainEnvVar
Optional in command line mode. Security domain environment variable. Not used in interactive mode.
-folder
-f
folder
Required if the workflow name is not unique in the repository. Name of the folder containing the workflow.
-runinsname
-rin
runInsName
Name of the workflow run instance you want to stop. Use this option if you are running concurrent workflows.
-wfrunid
workflowRunId
Run identifier number (Run ID) of the workflow run instance you want to stop. Use this option if you are running concurrent workflows.
-wait
-nowait
-
Optional. Configures the wait mode:
  • - wait. You can enter a new pmcmd command only after the Integration Service completes the previous command.
  • - nowait. You can enter a new pmcmd command after the Integration Service receives the previous command.
Default is nowait.
-
workflow
Required. Name of the workflow.