esp.bitbucket.bitbucket_application_link_info (1.4.1) — module

Retrieve application links

| "added in version" 1.2.0 of esp.bitbucket"

Authors: Krzysztof Lewandowski (@klewan)

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

Search for 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

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Retrieve details on the given application links (supplied by names or IDs)
  esp.bitbucket.bitbucket_application_link_info:
    url: 'https://bitbucket.example.com'
    username: jsmith
    password: secrect
    applink:
      - FOO
      - 227dd1d7-f6d6-34a5-b046-5663fb518691
    validate_certs: no
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Retrieve details on all application links
  esp.bitbucket.bitbucket_application_link_info:
    url: 'https://bitbucket.example.com'
    username: jsmith
    password: secrect
    applink:
      - '*'
    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

applicaton_links:
  description: List of application links data.
  elements: dict
  returned: always
  sample:
  - data: {}
    displayUrl: https://terraform.example.com/my-org
    id: 227dd1d7-f6d6-34a5-b046-5663fb518691
    name: Terraform (my-org)
    primary: false
    properties: {}
    rpcUrl: https://terraform.example.com/app/my-org
    system: false
    type: generic
  type: list