bitbucket_project_info – Retrieve project information

Synopsis

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 token or with username and password.

Parameters

url (False, str, None)

Bitbucket Server URL.

username (False, str, None)

Username used for authentication.

This is only needed when not using token.

Required when password is provided.

password (False, str, None)

Password used for authentication.

This is only needed when not using token.

Required when username is provided.

token (False, str, None)

Token parameter for authentication.

This is only needed when not using username and password.

project_key (False, list, [‘*’])

Retrieve projects matching the supplied project_key filter.

This can be ‘*’ which means all projects.

validate_certs (optional, bool, True)

If no, SSL certificates will not be validated.

This should only set to no used on personally controlled sites using self-signed certificates.

use_proxy (optional, bool, True)

If no, it will not use a proxy, even if one is defined in an environment variable on the target hosts.

sleep (optional, int, 5)

Number of seconds to sleep between API retries.

retries (optional, int, 3)

Number of retries to call Bitbucket API URL before failure.

Notes

Note

• Bitbucket Access Token can be obtained from Bitbucket profile -> Manage Account -> Personal Access Tokens.

• Supports check_mode.

Examples

- name: Retrieve all projects
  esp.bitbucket.bitbucket_project_info:
    username: jsmith
    password: secrect
    project_key: [ '*' ]
    validate_certs: no

- name: Retrieve the projects matching the supplied project_key filter
  esp.bitbucket.bitbucket_project_info:
    token: 'MjA2M...hqP58'
    project_key: [ FOO, BAR ]
    validate_certs: no

Return Values

messages (always, list, [‘Repository bar2 does not exist.’])

List of error messages.

projects (always, list, )

List of Bitbucket projects.

key (success, str, FOO)

Bitbucket project key.

name (success, str, A new Bitbucket project)

Bitbucket project name.

description (success, str, This is a new Bitbucket project)

Bitbucket project description.

public (success, bool, False)

Whether or not the project is public.

type (success, str, NORMAL)

Bitbucket project type.

id (success, int, 200)

Project ID.

links (success, dict, )

Links to Bitbucket project.

self (success, list, [AnsibleMapping([(‘href’, ‘https://bitbucket.example.com/projects/FOO’)])])

Links to Bitbucket repository.

Status

Authors

• Krzysztof Lewandowski (@klewan)