community.general.flatpak_remote 模块 – 管理 flatpak 仓库远程

注意

此模块是 community.general 集合(版本 10.1.0)的一部分。

如果您使用的是 ansible 包,您可能已经安装了此集合。 它不包含在 ansible-core 中。 要检查是否已安装,请运行 ansible-galaxy collection list

要安装它,请使用: ansible-galaxy collection install community.general。 您需要进一步的要求才能使用此模块,请参阅 要求 了解详情。

要在 playbook 中使用它,请指定: community.general.flatpak_remote

概要

  • 允许用户添加或删除 flatpak 远程仓库。

  • flatpak 远程仓库的概念与其他打包格式中称为仓库的概念类似。

  • 目前,仅支持通过 flatpakrepo 文件 URL 添加远程仓库。

  • 现有远程仓库不会被更新。

  • 有关管理 flatpak 的信息,请参阅 community.general.flatpak 模块。

要求

执行此模块的主机需要满足以下要求。

  • flatpak

参数

参数

注释

enabled

布尔值

在 community.general 6.4.0 中添加

指示是否启用此远程仓库。

选择

  • false

  • true ←(默认)

executable

字符串

要使用的 flatpak 可执行文件的路径。

默认情况下,此模块会在路径上查找 flatpak 可执行文件。

默认值: "flatpak"

flatpakrepo_url

字符串

指向 flatpakrepo 文件的 URL,该文件表示要添加的仓库远程。

当与 state=present 一起使用时,将使用指定的安装 method 添加在 flatpakrepo_url 下指定的 flatpak 远程仓库。

当与 state=absent 一起使用时,这不是必需的。

state=present 时为必需。

method

字符串

要使用的安装方法。

定义 flatpak 是应该为整个 system 全局安装,还是仅为当前 user 安装。

选择

  • "system" ←(默认)

  • "user"

name

字符串 / 必需

在受管主机上注册的 flatpak 远程仓库的所需名称。

当与 state=present 一起使用时,远程仓库将使用指定的 name 添加到受管主机。

当与 state=absent 一起使用时,将删除具有该名称的远程仓库。

state

字符串

指示期望的软件包状态。

选择

  • "absent"

  • "present" ← (默认)

属性

属性

支持

描述

check_mode

支持: 完全

可以在 check_mode 中运行并返回更改状态的预测,而无需修改目标。

diff_mode

支持:

当处于 diff 模式时,将返回已更改(或可能需要在 check_mode 中更改)的详细信息。

示例

- 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

返回值

常见的返回值记录在这里,以下是此模块独有的字段

描述

command

字符串

执行的确切 flatpak 命令

返回: 当执行 flatpak 命令时

示例: "/usr/bin/flatpak remote-add --system flatpak-test https://dl.flathub.org/repo/flathub.flatpakrepo"

msg

字符串

模块错误消息

返回: 失败

示例: "系统上找不到可执行文件 '/usr/local/bin/flatpak'。"

rc

整数

来自 flatpak 二进制文件的返回代码

返回: 当执行 flatpak 命令时

示例: 0

stderr

字符串

来自 flatpak 二进制文件的错误输出

返回: 当执行 flatpak 命令时

示例: "错误:已启用 GPG 验证,但未找到摘要(请检查远程配置中配置的 URL 是否正确)\n"

stdout

字符串

来自 flatpak 二进制文件的输出

返回: 当执行 flatpak 命令时

示例: "flathub\tFlathub\thttps://dl.flathub.org/repo/\t1\t\n"

作者

  • John Kwiatkoski (@JayKayy)

  • Alexander Bethke (@oolongbrothers)