community.general.bitbucket_pipeline_variable – Manages Bitbucket pipeline variables

From Get docs
Ansible/docs/2.11/collections/community/general/bitbucket pipeline variable module


community.general.bitbucket_pipeline_variable – Manages Bitbucket pipeline variables

Note

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

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

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


Synopsis

  • Manages Bitbucket pipeline variables.

Parameters

Parameter Choices/Defaults 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.

name

string / required

The pipeline variable name.

repository

string / required

The repository name.

secured

boolean

  • no

  • yes

Whether to encrypt the variable value.

state

string / required

  • absent
  • present

Indicates desired state of the variable.

username

string / required

The repository owner.

value

string

The pipeline variable value.



Notes

Note

  • Bitbucket OAuth consumer key and secret can be obtained from Bitbucket profile -> Settings -> Access Management -> OAuth.
  • Check mode is supported.
  • For secured values return parameter changed is always True.


Examples

- name: Create or update pipeline variables from the list
  community.general.bitbucket_pipeline_variable:
    repository: 'bitbucket-repo'
    username: bitbucket_username
    name: '{{ item.name }}'
    value: '{{ item.value }}'
    secured: '{{ item.secured }}'
    state: present
  with_items:
    - { name: AWS_ACCESS_KEY, value: ABCD1234, secured: False }
    - { name: AWS_SECRET, value: qwe789poi123vbn0, secured: True }

- name: Remove pipeline variable
  community.general.bitbucket_pipeline_variable:
    repository: bitbucket-repo
    username: bitbucket_username
    name: AWS_ACCESS_KEY
    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/2.11/collections/community/general/bitbucket_pipeline_variable_module.html