bitbucket_pipeline_key_pair – Manages Bitbucket pipeline SSH key pair — Ansible Documentation

- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# bitbucket_pipeline_key_pair – Manages Bitbucket pipeline SSH key pair

New in version 2.8.

- Synopsis
- Parameters
- Notes
- Examples
- Status

## Synopsis

- Manages Bitbucket pipeline SSH key pair.

## Parameters

Parameter | Choices/Defaults | Comments
--- | --- | ---
client_id string |  | OAuth consumer key. If not set the environment variable `BITBUCKET_CLIENT_ID` will be used.
client_secret string |  | OAuth consumer secret. If not set the environment variable `BITBUCKET_CLIENT_SECRET` will be used.
private_key string |  | The private key.
public_key string |  | The public key.
repository string / required |  | The repository name.
state string / required | Choices: absent present | Indicates desired state of the key pair.
username string / required |  | The repository owner.

## Notes

Note

- Bitbucket OAuth consumer key and secret can be obtained from Bitbucket profile -> Settings -> Access Management -> OAuth.
- Check mode is supported.

## Examples

    - name: Create or update SSH key pair
      bitbucket_pipeline_key_pair:
        repository: 'bitbucket-repo'
        username: bitbucket_username
        public_key: '{{lookup("file", "bitbucket.pub") }}'
        private_key: '{{lookup("file", "bitbucket") }}'
        state: present

    - name: Remove SSH key pair
      bitbucket_pipeline_key_pair:
        repository: bitbucket-repo
        username: bitbucket_username
        state: absent

## Status

- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]

### Authors

- Evgeniy Krysanov (@catcombo)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.