esp.bitbucket.bitbucket_fileglob (1.4.1) — lookup

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

Retrieve a list of matching file names from particular repository of a Bitbucket Server.

Files are selected based on C(_terms) option. Additionaly, files can be further filtered out by C(grep) option to select only those matching the supplied grep pattern.

Combined outcome of C(_terms) and C(grep) options form the final list of files returned by this lookup.

The search is done using Python regex patterns.

Inputs

    
at:
    description:
    - The commit ID or ref (e.g. a branch or tag) to read a file at.
    - If not specified the default branch will be used instead.
    required: false
    type: str

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

grep:
    description:
    - Python regex pattern to search for in each file selected from repository to form
      the final list of files.
    - Files are selected based on C(_terms) option.
    - Combined outcome of C(_terms) and C(grep) options form the final list of files returned
      by this module.
    - If not specified, search will not be executed.
    required: false
    type: str

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

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

_terms:
    description: List of Python regex patterns to search for in file names on a Bitbucket
      Server repository.
    required: true

retries:
    default: 3
    description:
    - Number of retries to call Bitbucket API URL before failure.
    required: false
    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: false
    description:
    - If C(no), it will not use a proxy, even if one is defined in an environment variable
      on the target hosts.
    required: false
    type: bool

repository:
    description:
    - Repository name.
    required: true
    type: str

project_key:
    description:
    - Bitbucket project key.
    required: true
    type: str

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.
    required: false
    type: bool

Outputs

_raw:
  description:
  - list of files
  elements: str
  type: list