> 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.

SSH Agent Plugin

View this plugin on the Plugins site

sshagent: SSH Agent


node {
  sshagent (credentials: ['deploy-dev']) {
    sh 'ssh -o StrictHostKeyChecking=no -l cloudbees 192.168.1.106 uname -a'
  }
}

Multiple credentials could be passed in the array but it is not supported using Snippet Generator.

  • credentials
    List of credentials to be used by the sshagent step. The Pipeline Syntax Snippet Generator will guide the user to select a single credential from the list of available, like this: 
    sshagent(credentials: ['my-credential-id']) {
    // some block
}
    The step also accepts a list of credentials, like this: 
    sshagent(credentials: ['my-credential-id', 'my-alternate-credential', 'another-credential']) {
    // some block
}
    • Type: Array / List of String
  • ignoreMissing (optional)
    When set to true, any missing credentials will be ignored. When set to false, then the build fails if any of the required credentials cannot be resolved. Defaults to false.
    • 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.