The following plugin provides functionality available through Pipeline-compatible steps. Read more about how to integrate steps into your Pipeline in the Steps section of the Pipeline Syntax page.
For a list of other such plugins, see the Pipeline Steps Reference page.
step([$class: 'RundeckNotifier'])
: RundeckrundeckInstance : String
jobId : String
options : String
This is the list of options for the Rundeck job you want to execute. It should be in the Java-Properties format, 1 option per line : key=value.
You can use Jenkins environment variables ($BUILD_NUMBER, $BUILD_ID, $JOB_NAME, $WORKSPACE, etc) or System environment variables ($HOME, $PATH, etc) in your options, and we will expand them when notifying Rundeck.
We will also expand the special token "$ARTIFACT_NAME{regex}" (where "regex" is a java-regex) to the name of the first matching artifact found.
For example, $ARTIFACT_NAME{.*\.war} will matches your WAR artifact, while $ARTIFACT_NAME{.*-sources\.jar} will matches your sources artifact.
nodeFilters : String
This is a list of filters to optionally filter the nodes on which your Rundeck will run.
You can specify which node to include using a single value, a list of values, or a regular expression (for example the .* pattern will match any text) as the argument to the following options.
Inclusion filters
This field should be written in the Java-Properties format, 1 option per line : key=value.
You can use Jenkins environment variables ($JOB_NAME, $WORKSPACE, etc) or System environment variables ($OSTYPE, $USER, etc) in your values, and we will expand them when notifying Rundeck.
Example :
name = .* tags = web+prod exclude-os-family = windows
tags : String
shouldWaitForRundeckJob : boolean
shouldFailTheBuild : boolean
notifyOnAllStatus : boolean
includeRundeckLogs : boolean
tailLog : boolean
jobUser : String
This is an alternative rundeck userid, which should be used instead of the global configured id. 'User password' is mandatory with 'job user', also a token can be used for authentication.
jobPassword
class hudson.util.Secret
jobToken
class hudson.util.Secret
Please submit your feedback about this page through this quick form.
Alternatively, if you don't wish to complete the quick form, you can simply indicate if you found this page helpful?
See existing feedback here.