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.
SaltStack plugin
salt
: Send a message to Salt API
servername
Salt servername. In the form: https://host.domain:8000
The Test Connection process is run from the Jenkins master. If the build is localized to an agent, and the servername is specific to that agent, then Test Connection will likely fail, while the actual build may succeed.
authtype
clientInterface
Nested Choice of Objects
hook
post
Publish JSON object as 'post' data, see
upstream documentation. . Paramaterized Build variables should be specified in the format {{VARNAME}}.
tag
Specify salt event tag for message. The event tag is prefixed with salt/netapi/hook, see
upstream documentation. Paramaterized variables should be specified in the format {{VARNAME}}.
batch
function
Specify salt function such as test.ping or cmd.run. Paramaterized Build variables should be specified in the format {{VARNAME}}.
arguments
Specify salt function arguments space separated. Paramaterized Build variables should be specified in the format {{VARNAME}}. Python lists should be quoted: pkgs="[package1, package2]".
Pillar values should be passed in as an argument, with the pillar string surrounded in double or single quotes, and the values single or double quoted: "pillar={artifact: 'somevalue3', repo: 'othervalue:4'}"
batchSize
Specify salt batch size. Example: 10 or 10%
batchWait
Optionally specify time to wait between batches of minions.
target
Specify salt target as defined in the
salt documentation. Paramaterized Build variables should be specified in the format {{VARNAME}}.
targettype
local
function
Specify salt function such as test.ping or cmd.run. Paramaterized Build variables should be specified in the format {{VARNAME}}.
arguments
Specify salt function arguments space separated. Paramaterized Build variables should be specified in the format {{VARNAME}}. Python lists should be quoted: pkgs="[package1, package2]".
Pillar values should be passed in as an argument, with the pillar string surrounded in double or single quotes, and the values single or double quoted: "pillar={artifact: 'somevalue3', repo: 'othervalue:4'}"
target
Specify salt target as defined in the
salt documentation. Paramaterized Build variables should be specified in the format {{VARNAME}}.
targettype
blockbuild
(optional)
jobPollTime
(optional)
minionTimeout
(optional)
subset
function
Specify salt function such as test.ping or cmd.run. Paramaterized Build variables should be specified in the format {{VARNAME}}.
arguments
Specify salt function arguments space separated. Paramaterized Build variables should be specified in the format {{VARNAME}}. Python lists should be quoted: pkgs="[package1, package2]".
Pillar values should be passed in as an argument, with the pillar string surrounded in double or single quotes, and the values single or double quoted: "pillar={artifact: 'somevalue3', repo: 'othervalue:4'}"
subset
Execute the routine on a random subset of the targeted minions. Paramaterized variables should be specified in the format {{VARNAME}}.
target
Specify salt target as defined in the
salt documentation. Paramaterized Build variables should be specified in the format {{VARNAME}}.
targettype
runner
function
Specify salt function such as test.ping or cmd.run. Paramaterized Build variables should be specified in the format {{VARNAME}}.
arguments
Specify salt function arguments space separated. Paramaterized Build variables should be specified in the format {{VARNAME}}. Python lists should be quoted: pkgs="[package1, package2]".
mods
Specify runner mods value. Used in state.orchestrate function to specify the name of the orchestrate module
Paramaterized Build variables should be specified in the format {{VARNAME}}
pillarvalue
Specify runner pillar value. Used in state.orchestrate functions. Ex: {"key": "value"}
Paramaterized Build variables should be specified in the format {{VARNAME}}
credentialsId
saveEnvVar
(optional)
saveFile
(optional)
skipValidation
(optional)
step([$class: 'SaltAPIBuilder'])
: Send a message to Salt API
authtype
clientInterface
Nested Choice of Objects
hook
post
Publish JSON object as 'post' data, see
upstream documentation. . Paramaterized Build variables should be specified in the format {{VARNAME}}.
tag
Specify salt event tag for message. The event tag is prefixed with salt/netapi/hook, see
upstream documentation. Paramaterized variables should be specified in the format {{VARNAME}}.
batch
function
Specify salt function such as test.ping or cmd.run. Paramaterized Build variables should be specified in the format {{VARNAME}}.
arguments
Specify salt function arguments space separated. Paramaterized Build variables should be specified in the format {{VARNAME}}. Python lists should be quoted: pkgs="[package1, package2]".
Pillar values should be passed in as an argument, with the pillar string surrounded in double or single quotes, and the values single or double quoted: "pillar={artifact: 'somevalue3', repo: 'othervalue:4'}"
batchSize
Specify salt batch size. Example: 10 or 10%
batchWait
Optionally specify time to wait between batches of minions.
target
Specify salt target as defined in the
salt documentation. Paramaterized Build variables should be specified in the format {{VARNAME}}.
targettype
local
function
Specify salt function such as test.ping or cmd.run. Paramaterized Build variables should be specified in the format {{VARNAME}}.
arguments
Specify salt function arguments space separated. Paramaterized Build variables should be specified in the format {{VARNAME}}. Python lists should be quoted: pkgs="[package1, package2]".
Pillar values should be passed in as an argument, with the pillar string surrounded in double or single quotes, and the values single or double quoted: "pillar={artifact: 'somevalue3', repo: 'othervalue:4'}"
target
Specify salt target as defined in the
salt documentation. Paramaterized Build variables should be specified in the format {{VARNAME}}.
targettype
blockbuild
(optional)
jobPollTime
(optional)
minionTimeout
(optional)
subset
function
Specify salt function such as test.ping or cmd.run. Paramaterized Build variables should be specified in the format {{VARNAME}}.
arguments
Specify salt function arguments space separated. Paramaterized Build variables should be specified in the format {{VARNAME}}. Python lists should be quoted: pkgs="[package1, package2]".
Pillar values should be passed in as an argument, with the pillar string surrounded in double or single quotes, and the values single or double quoted: "pillar={artifact: 'somevalue3', repo: 'othervalue:4'}"
subset
Execute the routine on a random subset of the targeted minions. Paramaterized variables should be specified in the format {{VARNAME}}.
target
Specify salt target as defined in the
salt documentation. Paramaterized Build variables should be specified in the format {{VARNAME}}.
targettype
runner
function
Specify salt function such as test.ping or cmd.run. Paramaterized Build variables should be specified in the format {{VARNAME}}.
arguments
Specify salt function arguments space separated. Paramaterized Build variables should be specified in the format {{VARNAME}}. Python lists should be quoted: pkgs="[package1, package2]".
mods
Specify runner mods value. Used in state.orchestrate function to specify the name of the orchestrate module
Paramaterized Build variables should be specified in the format {{VARNAME}}
pillarvalue
Specify runner pillar value. Used in state.orchestrate functions. Ex: {"key": "value"}
Paramaterized Build variables should be specified in the format {{VARNAME}}
credentialsId
servername
(optional)
Salt servername. In the form: https://host.domain:8000
The Test Connection process is run from the Jenkins master. If the build is localized to an agent, and the servername is specific to that agent, then Test Connection will likely fail, while the actual build may succeed.
saveEnvVar
(optional)
saveFile
(optional)
skipValidation
(optional)
Was this page helpful?
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.