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

Synchronises User Directories on Bitbucket Server.

Authentication should be done with I(username) and I(password).

Usage examples

Scanned by Steampunk Spotter

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

- name: Synchronise User Directories
  esp.bitbucket.bitbucket_directory_sync:
    url: 'https://bitbucket.example.com'
    username: admin
    password: secrect
    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

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

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

user_directories_synced:
  contains:
    directoryId:
      description: Directory ID.
      returned: success
      sample: 262145
      type: int
    info:
      description: Bitbucket API response info.
      returned: success
      sample:
        msg: OK (unknown bytes)
        status: 200
      type: dict
    operation:
      description: Sync operation URL path.
      returned: success
      sample: /plugins/servlet/embedded-crowd/directories/sync?directoryId=262145&atl_token=4731c4d872b4b4cf6e2d46a75061213d414a1af7
      type: str
  description: List of synchronised User Directories.
  returned: success
  type: list