community.general.copr module – Manage one of the Copr repositories

Note

This module is part of the community.general collection (version 10.0.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.general. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: community.general.copr.

New in community.general 2.0.0

Synopsis

  • This module can enable, disable or remove the specified repository.

Requirements

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

  • dnf

  • dnf-plugins-core

Parameters

Parameter

Comments

chroot

string

The name of the chroot that you want to enable/disable/remove in the project, for example epel-7-x86_64. Default chroot is determined by the operating system, version of the operating system, and architecture on which the module is run.

excludepkgs

list / elements=string

added in community.general 9.4.0

List of packages to exclude.

host

string

The Copr host to work with.

Default: "copr.fedorainfracloud.org"

includepkgs

list / elements=string

added in community.general 9.4.0

List of packages to include.

name

string / required

Copr directory name, for example @copr/copr-dev.

protocol

string

This indicate which protocol to use with the host.

Default: "https"

state

string

Whether to set this project as enabled, disabled, or absent.

Choices:

  • "absent"

  • "enabled" ← (default)

  • "disabled"

Attributes

Attribute

Support

Description

check_mode

Support: full

Can run in check_mode and return changed status prediction without modifying target.

diff_mode

Support: none

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.

Notes

Note

  • Supports check_mode.

Examples

- name: Enable project Test of the user schlupov
  community.general.copr:
    host: copr.fedorainfracloud.org
    state: enabled
    name: schlupov/Test
    chroot: fedora-31-x86_64

- name: Remove project integration_tests of the group copr
  community.general.copr:
    state: absent
    name: '@copr/integration_tests'

Return Values

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

Key

Description

repo

string

Path to the project on the host.

Returned: success

Sample: "copr.fedorainfracloud.org/group_copr/integration_tests"

repo_filename

string

The name of the repo file in which the copr project information is stored.

Returned: success

Sample: "_copr:copr.fedorainfracloud.org:group_copr:integration_tests.repo"

Authors

  • Silvie Chlupova (@schlupov)