community.general.flatpak_remote module – Manage flatpak repository remotes
Note
This module is part of the community.general collection (version 8.6.8).
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.flatpak_remote
.
Synopsis
Allows users to add or remove flatpak remotes.
The flatpak remotes concept is comparable to what is called repositories in other packaging formats.
Currently, remote addition is only supported via
flatpakrepo
file URLs.Existing remotes will not be updated.
See the community.general.flatpak module for managing flatpaks.
Aliases: packaging.os.flatpak_remote
Requirements
The below requirements are needed on the host that executes this module.
flatpak
Parameters
Parameter |
Comments |
---|---|
Indicates whether this remote is enabled. Choices:
|
|
The path to the By default, this module looks for the Default: |
|
The URL to the When used with When used with Required when |
|
The installation method to use. Defines if the Choices:
|
|
The desired name for the flatpak remote to be registered under on the managed host. When used with When used with |
|
Indicates the desired package state. Choices:
|
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: full |
Can run in |
|
Support: none |
Will return details on what has changed (or possibly needs changing in |
Examples
- name: Add the Gnome flatpak remote to the system installation
community.general.flatpak_remote:
name: gnome
state: present
flatpakrepo_url: https://sdk.gnome.org/gnome-apps.flatpakrepo
- name: Add the flathub flatpak repository remote to the user installation
community.general.flatpak_remote:
name: flathub
state: present
flatpakrepo_url: https://dl.flathub.org/repo/flathub.flatpakrepo
method: user
- name: Remove the Gnome flatpak remote from the user installation
community.general.flatpak_remote:
name: gnome
state: absent
method: user
- name: Remove the flathub remote from the system installation
community.general.flatpak_remote:
name: flathub
state: absent
- name: Disable the flathub remote in the system installation
community.general.flatpak_remote:
name: flathub
state: present
enabled: false
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The exact flatpak command that was executed Returned: When a flatpak command has been executed Sample: |
|
Module error message Returned: failure Sample: |
|
Return code from flatpak binary Returned: When a flatpak command has been executed Sample: |
|
Error output from flatpak binary Returned: When a flatpak command has been executed Sample: |
|
Output from flatpak binary Returned: When a flatpak command has been executed Sample: |