Back to index
Summary
Modifies an existing trigger.projectNameStringrequiredThe name for the project that must be unique among all projects. triggerNameStringrequiredThe name of the trigger. actualParametersStringoptionalActual parameters passed to the invoked object. applicationNameStringoptionalThe name of the application that owns the trigger and the process that should be run. clearActualParametersBooleanoptionalWhether or not to clear actual parameters for this object. clearPipelineParametersBooleanoptionalWhether or not to clear pipeline parameters for the trigger. credentialNameStringoptionalThe name of the credential to use for impersonation. descriptionStringoptionalComment text describing this object that is not interpreted at all by CloudBees CD/RO. enabledBooleanoptionalTrue to enable the task. environmentNameStringoptionalThe name of the environment used to determine where to run the process. environmentProjectNameStringoptionalName for the project to which the environment or environment template belongs to. environmentTemplateNameStringoptionalThe name of the environment template used to determine the environment where to run the process. environmentTemplateProjectNameStringoptionalName for the project to which the environment template belongs to. insertRollingDeployManualStepBooleanoptionalTrue to indicate a manual step needs to be injected after each phase or batch. newNameStringoptionalThe new name for an existing object that is being renamed. pipelineNameStringoptionalThe name of the pipeline to run. pipelineParametersStringoptionalPipeline parameters used by a release schedule to override the default parameters configured in the release. pluginKeyStringoptionalThe key of the plugin to be used for trigger integration with 3rd-party system. pluginParametersStringoptionalList of plugin parameters. procedureNameStringoptionalThe name of the procedure that owns the process to run. processNameStringoptionalThe name of the application process to invoke. quietTimeMinutesStringoptionalSpecify how long in minutes should pass since last trigger event before the trigger will run. releaseNameStringoptionalThe name of the release to run. rollingDeployEnabledBooleanoptionalPerform rolling deployment. rollingDeployManualStepAssigneesStringoptionalA list of assignees who receive the notification when rolling deploy iteration completes. rollingDeployManualStepConditionStringoptionalDefines run condition on manual step created during rolling deployment. Possible values: "always" , "failure" , "success" rollingDeployPhasesStringoptionalOne or more rolling deploy phases to be used for deployment. runDuplicatesBooleanoptionalSpecify whether a trigger should be run if the previously triggered process is still running. scmSyncNameStringoptionalThe name of the scmSync trigger belong to. serviceAccountNameStringoptionalThe name of the service account associated with a webhook trigger. snapshotNameStringoptionalThe name of the snapshot to be used to invoke the application process. stagesToRunStringoptionalOne or more stages to run in a pipeline. tierResourceCountsStringoptionalResource count per resource template tier. triggerTypeStringoptionalA type of trigger. Possible values: "polling" , "webhook" webhookNameStringoptionalWebhook name. webhookSecretStringoptionalWebhook secret. webhookSecretCredentialNameStringoptionalWebhook secret credential name. webhookSecretCredentialProjectNameStringoptionalWebhook secret credential project name. |
Usage
Perl
$cmdr->modifyTrigger( "test-projectName", # projectName "test-triggerName" # triggerName # optionals );
ectool
ectool modifyTrigger \ "test-projectName" `# projectName` \ "test-triggerName" `# triggerName` \ # optionals