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

Manages Bitbucket Server repositories.

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 repository
  esp.bitbucket.bitbucket_repo:
    url: 'https://bitbucket.example.com'
    username: jsmith
    password: secrect
    repository: bar
    project_key: FOO
    validate_certs: no
    state: present

Scanned by Steampunk Spotter

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

- name: Create repository using token
  esp.bitbucket.bitbucket_repo:
    url: 'https://bitbucket.example.com'
    token: 'MjA2M...hqP58'
    name: bar
    project: FOO
    validate_certs: no
    state: present

Scanned by Steampunk Spotter

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

- name: Delete repository
  esp.bitbucket.bitbucket_repo:
    url: 'https://bitbucket.example.com'
    username: jsmith
    password: secrect
    repository: bar
    project_key: FOO
    validate_certs: no
    state: absent

Inputs

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

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

state:
    choices:
    - absent
    - present
    default: present
    description:
    - Whether the repository should exist or not.
    required: false
    type: str

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

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

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

return_content:
    default: true
    description:
    - Whether or not to return the body of the response as a "content" key in the dictionary
      result no matter it succeeded or failed.
    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

context:
  description: Context (if I(state=absent)).
  returned: success
  sample: null
  type: str
exceptionName:
  description: Exception Name (if I(state=absent)).
  returned: success
  sample: null
  type: str
forkable:
  description: Source file used for the copy on the target machine (if I(state=present)).
  returned: success
  sample: true
  type: bool
hierarchyId:
  description: Hierarchy ID (if I(state=present)).
  returned: success
  sample: 91369a5b9598e936d126
  type: str
id:
  description: Repository ID (if I(state=present)).
  returned: success
  sample: 100
  type: int
links:
  contains:
    clone:
      description: Clone URLs.
      elements: dict
      returned: success
      sample:
      - href: https://bitbucket.example.com/scm/foo/bar.git
        name: http
      - href: ssh://git@bitbucket.example.com:7999/foo/bar.git
        name: ssh
      type: list
    self:
      description: Links to Bitbucket repository.
      elements: dict
      returned: success
      sample:
      - href: https://bitbucket.example.com/projects/FOO/repos/bar/browse
      type: list
  description: Links to Bitbucket repository (if I(state=present)).
  returned: success
  type: dict
message:
  description: Deletion message (if I(state=absent)).
  returned: success
  sample: Repository scheduled for deletion.
  type: str
name:
  description: Bitbucket repository name (if I(state=present)).
  returned: success
  sample: bar
  type: str
project:
  contains:
    id:
      description: Project ID.
      returned: success
      sample: 200
      type: int
    key:
      description: Bitbucket project key.
      returned: success
      sample: FOO
      type: str
    name:
      description: Bitbucket project name.
      returned: success
      sample: FOO project
      type: str
    public:
      description: Whether or not the project is public.
      returned: success
      sample: false
      type: bool
    self:
      description: Links to Bitbucket project.
      elements: dict
      returned: success
      sample:
      - href: https://bitbucket.example.com/projects/FOO
      type: list
    type:
      description: Bitbucket project type.
      returned: success
      sample: NORMAL
      type: str
  description: Information about Bitbucket project (if I(state=present)).
  returned: success
  type: dict
public:
  description: Whether or not the repository is public (if I(state=present)).
  returned: success
  sample: true
  type: bool
scmId:
  description: SCM type (if I(state=present)).
  returned: success
  sample: git
  type: str
slug:
  description: Bitbucket repository slug name (if I(state=present)).
  returned: success
  sample: bar
  type: str
state:
  description: Bitbucket repository state, after execution (if I(state=present)).
  returned: success
  sample: AVAILABLE
  type: str
statusMessage:
  description: Bitbucket repository state message, after execution (if I(state=present)).
  returned: success
  sample: Available
  type: str