community.windows.win_scoop_bucket module – Manage Scoop buckets

Note

This module is part of the community.windows collection (version 1.11.1).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install community.windows. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: community.windows.win_scoop_bucket.

New in community.windows 1.0.0

Synopsis

  • Manage Scoop buckets

Requirements

The below requirements are needed on the host that executes this module.

  • git

Parameters

Parameter

Comments

name

string / required

Name of the Scoop bucket.

repo

string

Git repository that contains the scoop bucket

state

string

State of the Scoop bucket.

When absent, will ensure the package is not installed.

When present, will ensure the package is installed.

Choices:

  • "absent"

  • "present" ← (default)

See Also

See also

community.windows.win_scoop

The official documentation on the community.windows.win_scoop module.

Scoop website

More information about Scoop

Scoop directory

A directory of buckets for the scoop package manager for Windows

Examples

- name: Add the extras bucket
  community.windows.win_scoop_bucket:
    name: extras

- name: Remove the versions bucket
  community.windows.win_scoop_bucket:
    name: versions
    state: absent

- name: Add a custom bucket
  community.windows.win_scoop_bucket:
    name: my-bucket
    repo: https://github.com/example/my-bucket

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

rc

integer

The result code of the scoop action

Returned: always

Sample: 0

stdout

string

The raw output from the scoop action

Returned: on failure or when verbosity is greater than 1

Sample: "The test bucket was added successfully."

Authors

  • Jamie Magee (@JamieMagee)