esp.bitbucket.bitbucket_project_info (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

Retrieve project information from Bitbucket Server for the supplied project key filter.

Only projects for which the authenticated user has the PROJECT_VIEW permission will be returned.

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: Retrieve all projects
  esp.bitbucket.bitbucket_project_info:
    url: 'https://bitbucket.example.com'
    username: jsmith
    password: secrect
    project_key: [ '*' ]
    validate_certs: no

Scanned by Steampunk Spotter

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

- name: Retrieve the projects matching the supplied project_key filter
  esp.bitbucket.bitbucket_project_info:
    url: 'https://bitbucket.example.com'
    token: 'MjA2M...hqP58'
    project_key: [ FOO, BAR ]
    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

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:
    aliases:
    - user
    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

project_key:
    aliases:
    - project
    default:
    - '*'
    description:
    - Retrieve projects matching the supplied I(project_key) filter.
    - This can be '*' which means all projects.
    required: false
    type: list

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

messages:
  description: List of error messages.
  returned: always
  sample:
  - Repository `bar2` does not exist.
  type: list
projects:
  contains:
    description:
      description: Bitbucket project description.
      returned: success
      sample: This is a new Bitbucket project
      type: str
    id:
      description: Project ID.
      returned: success
      sample: 200
      type: int
    key:
      description: Bitbucket project key.
      returned: success
      sample: FOO
      type: str
    links:
      contains:
        self:
          description: Links to Bitbucket repository.
          elements: dict
          returned: success
          sample:
          - href: https://bitbucket.example.com/projects/FOO
          type: list
      description: Links to Bitbucket project.
      returned: success
      type: dict
    name:
      description: Bitbucket project name.
      returned: success
      sample: A new Bitbucket project
      type: str
    public:
      description: Whether or not the project is public.
      returned: success
      sample: false
      type: bool
    type:
      description: Bitbucket project type.
      returned: success
      sample: NORMAL
      type: str
  description: List of Bitbucket projects.
  returned: always
  type: list