> User Documentation Home

User Handbook
Tutorials
Resources

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

View this plugin on the Plugins site

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.
    • Type: String
  • authtype
    • Type: String
  • 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}}.
        • Type: String
      • 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}}.
        • Type: String
    • batch
      • function
        Specify salt function such as test.ping or cmd.run. Paramaterized Build variables should be specified in the format {{VARNAME}}.
        • Type: String
      • 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'}"
        • Type: String
      • batchSize
        Specify salt batch size. Example: 10 or 10%
        • Type: String
      • batchWait
        Optionally specify time to wait between batches of minions.
        • Type: String
      • target
        Specify salt target as defined in the salt documentation. Paramaterized Build variables should be specified in the format {{VARNAME}}.
        • Type: String
      • targettype
        • Type: String
    • local
      • function
        Specify salt function such as test.ping or cmd.run. Paramaterized Build variables should be specified in the format {{VARNAME}}.
        • Type: String
      • 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'}"
        • Type: String
      • target
        Specify salt target as defined in the salt documentation. Paramaterized Build variables should be specified in the format {{VARNAME}}.
        • Type: String
      • targettype
        • Type: String
      • blockbuild (optional)
        • Type: boolean
      • jobPollTime (optional)
        • Type: int
      • minionTimeout (optional)
        • Type: int
    • subset
      • function
        Specify salt function such as test.ping or cmd.run. Paramaterized Build variables should be specified in the format {{VARNAME}}.
        • Type: String
      • 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'}"
        • Type: String
      • subset
        Execute the routine on a random subset of the targeted minions. Paramaterized variables should be specified in the format {{VARNAME}}.
        • Type: String
      • target
        Specify salt target as defined in the salt documentation. Paramaterized Build variables should be specified in the format {{VARNAME}}.
        • Type: String
      • targettype
        • Type: String
    • runner
      • function
        Specify salt function such as test.ping or cmd.run. Paramaterized Build variables should be specified in the format {{VARNAME}}.
        • Type: String
      • 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]".
        • Type: String
      • 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}}
        • Type: String
      • pillarvalue
        Specify runner pillar value. Used in state.orchestrate functions. Ex: {"key": "value"}
        Paramaterized Build variables should be specified in the format {{VARNAME}}
        • Type: String
  • credentialsId
    • Type: String
  • saveEnvVar (optional)
    • Type: boolean
  • saveFile (optional)
    • Type: boolean
  • skipValidation (optional)
    • Type: boolean

step([$class: 'SaltAPIBuilder']): Send a message to Salt API

  • authtype
    • Type: String
  • 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}}.
        • Type: String
      • 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}}.
        • Type: String
    • batch
      • function
        Specify salt function such as test.ping or cmd.run. Paramaterized Build variables should be specified in the format {{VARNAME}}.
        • Type: String
      • 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'}"
        • Type: String
      • batchSize
        Specify salt batch size. Example: 10 or 10%
        • Type: String
      • batchWait
        Optionally specify time to wait between batches of minions.
        • Type: String
      • target
        Specify salt target as defined in the salt documentation. Paramaterized Build variables should be specified in the format {{VARNAME}}.
        • Type: String
      • targettype
        • Type: String
    • local
      • function
        Specify salt function such as test.ping or cmd.run. Paramaterized Build variables should be specified in the format {{VARNAME}}.
        • Type: String
      • 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'}"
        • Type: String
      • target
        Specify salt target as defined in the salt documentation. Paramaterized Build variables should be specified in the format {{VARNAME}}.
        • Type: String
      • targettype
        • Type: String
      • blockbuild (optional)
        • Type: boolean
      • jobPollTime (optional)
        • Type: int
      • minionTimeout (optional)
        • Type: int
    • subset
      • function
        Specify salt function such as test.ping or cmd.run. Paramaterized Build variables should be specified in the format {{VARNAME}}.
        • Type: String
      • 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'}"
        • Type: String
      • subset
        Execute the routine on a random subset of the targeted minions. Paramaterized variables should be specified in the format {{VARNAME}}.
        • Type: String
      • target
        Specify salt target as defined in the salt documentation. Paramaterized Build variables should be specified in the format {{VARNAME}}.
        • Type: String
      • targettype
        • Type: String
    • runner
      • function
        Specify salt function such as test.ping or cmd.run. Paramaterized Build variables should be specified in the format {{VARNAME}}.
        • Type: String
      • 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]".
        • Type: String
      • 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}}
        • Type: String
      • pillarvalue
        Specify runner pillar value. Used in state.orchestrate functions. Ex: {"key": "value"}
        Paramaterized Build variables should be specified in the format {{VARNAME}}
        • Type: String
  • credentialsId
    • Type: String
  • 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.
    • Type: String
  • saveEnvVar (optional)
    • Type: boolean
  • saveFile (optional)
    • Type: boolean
  • skipValidation (optional)
    • Type: boolean

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.