W3cubDocs

/Ansible

community.general.bitbucket_pipeline_key_pair – Manages Bitbucket pipeline SSH key pair

Note

This plugin is part of the community.general collection (version 3.8.1).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install community.general.

To use it in a playbook, specify: community.general.bitbucket_pipeline_key_pair.

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
  community.general.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
  community.general.bitbucket_pipeline_key_pair:
    repository: bitbucket-repo
    username: bitbucket_username
    state: absent

Authors

  • Evgeniy Krysanov (@catcombo)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/bitbucket_pipeline_key_pair_module.html