# ssh-agent-plugin

**Repository Path**: n040661/ssh-agent-plugin

## Basic Information

- **Project Name**: ssh-agent-plugin
- **Description**: https://github.com/mamh-java/ssh-agent-plugin
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2022-06-13
- **Last Updated**: 2022-06-13

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# SSH Agent Plugin

This plugin allows you to provide SSH credentials to builds via a
ssh-agent in Jenkins.

This is convenient in some cases.
Alternately, you can use the generic `withCredentials` step to bind an SSH private key to a temporary file
and then pass that to commands that require it,
for example using the `-i` option to `ssh` or `scp`.

# Requirements

You need to have the `ssh-agent` executable installed on the agent.

# Configuring

First you need to add some SSH Credentials to your instance:

Jenkins \| Manage Jenkins \| Manage Credentials

![](docs/images/Screen_Shot_2012-10-26_at_12.25.04.png)

Note that only Private Key based credentials can be used.

Then configure your build to use the credentials:

![](docs/images/Screen_Shot_2012-10-26_at_12.26.13.png)

And then your build will have those credentials available, e.g.

![](docs/images/Screen_Shot_2012-10-26_at_11.54.21.png)

From a Pipeline job, use the `sshagent` step.

# Jenkinsfile

```
      steps {
          sshagent(credentials: ['ssh-credentials-id']) {
            sh '''
                [ -d ~/.ssh ] || mkdir ~/.ssh && chmod 0700 ~/.ssh
                ssh-keyscan -t rsa,dsa example.com >> ~/.ssh/known_hosts
                ssh user@example.com ...
            '''
          }
      }
```

# Version History

For new versions, see [GitHub releases](https://github.com/jenkinsci/ssh-agent-plugin/releases).

For old versions, see the [old changelog](docs/old-changelog.md).