You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

community.general.flatpak – Manage flatpaks

Note

This plugin is part of the community.general collection (version 3.8.3).

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.

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

Synopsis

• Allows users to add or remove flatpaks.

• See the community.general.flatpak_remote module for managing flatpak remotes.

Requirements

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

• flatpak

Parameters

Parameter	Comments
executable path	The path to the flatpak executable to use. By default, this module looks for the flatpak executable on the path. Default: “flatpak”
method string	The installation method to use. Defines if the flatpak is supposed to be installed globally for the whole system or only for the current user. Choices: system ← (default) user
name list / elements=string / required	The name of the flatpak to manage. To operate on several packages this can accept a list of packages. When used with state=present, name can be specified as a URL to a flatpakref file or the unique reverse DNS name that identifies a flatpak. Both https:// and http:// URLs are supported. When supplying a reverse DNS name, you can use the remote option to specify on what remote to look for the flatpak. An example for a reverse DNS name is org.gnome.gedit. When used with state=absent, it is recommended to specify the name in the reverse DNS format. When supplying a URL with state=absent, the module will try to match the installed flatpak based on the name of the flatpakref to remove it. However, there is no guarantee that the names of the flatpakref file and the reverse DNS name of the installed flatpak do match.
no_dependencies boolean added in 3.2.0 of community.general	If installing runtime dependencies should be omitted or not This parameter is primarily implemented for integration testing this module. There might however be some use cases where you would want to have this, like when you are packaging your own flatpaks. Choices: no ← (default) yes
remote string	The flatpak remote (repository) to install the flatpak from. By default, flathub is assumed, but you do need to add the flathub flatpak_remote before you can use this. See the community.general.flatpak_remote module for managing flatpak remotes. Default: “flathub”
state string	Indicates the desired package state. Choices: absent present ← (default)

Examples

- name: Install the spotify flatpak
  community.general.flatpak:
    name:  https://s3.amazonaws.com/alexlarsson/spotify-repo/spotify.flatpakref
    state: present

- name: Install the gedit flatpak package without dependencies (not recommended)
  community.general.flatpak:
    name: https://git.gnome.org/browse/gnome-apps-nightly/plain/gedit.flatpakref
    state: present
    no_dependencies: true

- name: Install the gedit package from flathub for current user
  community.general.flatpak:
    name: org.gnome.gedit
    state: present
    method: user

- name: Install the Gnome Calendar flatpak from the gnome remote system-wide
  community.general.flatpak:
    name: org.gnome.Calendar
    state: present
    remote: gnome

- name: Install multiple packages
  community.general.flatpak:
    name:
      - org.gimp.GIMP
      - org.inkscape.Inkscape
      - org.mozilla.firefox

- name: Remove the gedit flatpak
  community.general.flatpak:
    name: org.gnome.gedit
    state: absent

- name: Remove multiple packages
  community.general.flatpak:
    name:
      - org.gimp.GIMP
      - org.inkscape.Inkscape
      - org.mozilla.firefox
    state: absent

Return Values

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

Key	Description
command string	The exact flatpak command that was executed Returned: When a flatpak command has been executed Sample: “/usr/bin/flatpak install –user –nontinteractive flathub org.gnome.Calculator”
msg string	Module error message Returned: failure Sample: “Executable \u0027/usr/local/bin/flatpak\u0027 was not found on the system.”
rc integer	Return code from flatpak binary Returned: When a flatpak command has been executed Sample: 0
stderr string	Error output from flatpak binary Returned: When a flatpak command has been executed Sample: “error: Error searching remote flathub: Can\u0027t find ref org.gnome.KDE”
stdout string	Output from flatpak binary Returned: When a flatpak command has been executed Sample: “org.gnome.Calendar/x86_64/stable\tcurrent\norg.gnome.gitg/x86_64/stable\tcurrent\n”

Authors

• John Kwiatkoski (@JayKayy)

• Alexander Bethke (@oolongbrothers)