W3cubDocs

/Ansible

community.general.bitbucket_pipeline_known_host module – Manages Bitbucket pipeline known hosts

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. You need further requirements to be able to use this module, see Requirements for details.

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

Synopsis
Requirements
Parameters
Attributes
Notes
Examples

Synopsis

Manages Bitbucket pipeline known hosts under the “SSH Keys” menu.
The host fingerprint will be retrieved automatically, but in case of an error, one can use key field to specify it manually.

Requirements

The below requirements are needed on the host that executes this module.

paramiko

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.
key string	The public key.
name string / required	The FQDN of the known host.
password string added in community.general 4.0.0	The App password. If not set the environment variable `BITBUCKET_PASSWORD` will be used.
repository string / required	The repository name.
state string / required	Indicates desired state of the record. 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 known hosts from the list
  community.general.bitbucket_pipeline_known_host:
    repository: 'bitbucket-repo'
    workspace: bitbucket_workspace
    name: '{{ item }}'
    state: present
  with_items:
    - bitbucket.org
    - example.com

- name: Remove known host
  community.general.bitbucket_pipeline_known_host:
    repository: bitbucket-repo
    workspace: bitbucket_workspace
    name: bitbucket.org
    state: absent

- name: Specify public key file
  community.general.bitbucket_pipeline_known_host:
    repository: bitbucket-repo
    workspace: bitbucket_workspace
    name: bitbucket.org
    key: '{{lookup("file", "bitbucket.pub") }}'
    state: absent

Authors

Evgeniy Krysanov (@catcombo)

Collection links

© 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_known_host_module.html