W3cubDocs

/Ansible

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

Note

This module is part of the community.general collection (version 10.7.3).

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

Comments

client_id

string

The OAuth consumer key.

If not set the environment variable BITBUCKET_CLIENT_ID will be used.

client_secret

string

The OAuth consumer secret.

If not set the environment variable BITBUCKET_CLIENT_SECRET will be used.

password

string

added in community.general 4.0.0

The App password.

If not set the environment variable BITBUCKET_PASSWORD will be used.

private_key

string

The private key.

public_key

string

The public key.

repository

string / required

The repository name.

state

string / required

Indicates desired state of the key pair.

Choices:

  • "absent"
  • "present"

user

aliases: username

string

added in community.general 4.0.0

The username.

If not set the environment variable BITBUCKET_USERNAME will be used.

username is an alias of user since community.general 6.0.0. It was an alias of workspace before.

workspace

string / required

The repository owner.

Note: username used to be an alias of this option. Since community.general 6.0.0 it is an alias of user.

Attributes

Attribute

Support

Description

check_mode

Support: full

Can run in check_mode and return changed status prediction without modifying target.

diff_mode

Support: none

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.

Notes

Note

  • Check mode is supported.
  • Bitbucket OAuth consumer key and secret can be obtained from Bitbucket profile -> Settings -> Access Management -> OAuth.
  • Bitbucket App password can be created from Bitbucket profile -> Personal Settings -> App passwords.
  • If both OAuth and Basic Auth credentials are passed, OAuth credentials take precedence.

Examples

- name: Create or update SSH key pair
  community.general.bitbucket_pipeline_key_pair:
    repository: 'bitbucket-repo'
    workspace: bitbucket_workspace
    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
    workspace: bitbucket_workspace
    state: absent

Authors

  • Evgeniy Krysanov (@catcombo)

© 2012–2018 Michael DeHaan
© 2018–2025 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