esp.bitbucket.bitbucket_application_link (1.4.1) — module

Install collection

Install with ansible-galaxy collection install esp.bitbucket:==1.4.1

Add to requirements.yml

  collections:
    - name: esp.bitbucket
      version: 1.4.1

Description

Manage application links on Bitbucket Server.

One may refer to an application link either by its ID or its name.

Authentication can be done with I(token) or with I(username) and I(password).

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Create application link
  esp.bitbucket.bitbucket_application_link:
    url: 'https://bitbucket.example.com'
    username: '{{ bitbucket_username }}'
    password: '{{ bitbucket_password }}'
    applink:
      name: FOO
      rpcUrl: https://terraform.example.com/app/my-org
      displayUrl: https://terraform.example.com/app/my-org
      key: "de00c96434df2b31d3e3e3164391091c"
      publicKey: |
        -----BEGIN PUBLIC KEY-----
        MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA0E6OBvxPXTQlyQ8IBIP7
        (...)
        Gzr9C9mYr5zh15Rd7ygubYT1rKPTnQEuQMZpki9rsS3cKEYGyIX6nFLJdpZHK7hL
        2QIDAQAB
        -----END PUBLIC KEY-----        
    state: present
    validate_certs: no
  register: _result

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Delete application link (supplied by name or ID)
  esp.bitbucket.bitbucket_application_link:
    url: 'https://bitbucket.example.com'
    username: '{{ bitbucket_username }}'
    password: '{{ bitbucket_password }}'
    applink:
      name: FOO
      #id: 227dd1d7-f6d6-34a5-b046-5663fb518691
    state: absent
    validate_certs: no

Inputs

    
url:
    description:
    - Bitbucket Server URL.
    required: false
    type: str

sleep:
    default: 5
    description:
    - Number of seconds to sleep between API retries.
    type: int

token:
    description:
    - Token parameter for authentication.
    - This is only needed when not using I(username) and I(password).
    required: false
    type: str

applink:
    default:
    - '*'
    description:
    - Retrieve application links matching the supplied I(applink) filter.
    - This can be '*' which means all application links.
    - One may refer to an application link either by its ID or its name.
    required: false
    type: list

retries:
    default: 3
    description:
    - Number of retries to call Bitbucket API URL before failure.
    type: int

password:
    description:
    - Password used for authentication.
    - This is only needed when not using I(token).
    - Required when I(username) is provided.
    required: false
    type: str

username:
    description:
    - Username used for authentication.
    - This is only needed when not using I(token).
    - Required when I(password) is provided.
    required: false
    type: str

use_proxy:
    default: true
    description:
    - If C(no), it will not use a proxy, even if one is defined in an environment variable
      on the target hosts.
    type: bool

validate_certs:
    default: true
    description:
    - If C(no), SSL certificates will not be validated.
    - This should only set to C(no) used on personally controlled sites using self-signed
      certificates.
    type: bool

Outputs

json:
  description: Details of application link.
  returned: success
  sample:
    id: 227dd1d7-f6d6-34a5-b046-5663fb518691
    status:
      resources-created:
        link:
          '@href': https://bitbucket.example.com/rest/applinks/3.0/applicationlink/227dd1d7-f6d6-34a5-b046-5663fb518691
          '@rel': self
      status-code: '201'
  type: dict