Модуль community.general.flatpak – Управление flatpak

Примечание

Этот модуль является частью коллекции community.general (версия 9.5.0).

Эта коллекция может быть уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните команду ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.general. Для использования этого модуля необходимы дополнительные требования, см. Требования для получения подробной информации.

Для использования в playbook, укажите: community.general.flatpak.

Краткое описание
Требования
Параметры
Атрибуты
Примеры
Возвращаемые значения

Краткое описание

Позволяет пользователям добавлять или удалять flatpak-пакеты.
См. модуль community.general.flatpak_remote для управления удаленными репозиториями flatpak.

Требования

Ниже приведены требования, необходимые на хосте, который выполняет этот модуль.

flatpak

Параметры

Параметр	Комментарии
executable path	Путь к исполняемому файлу `flatpak` для использования. По умолчанию этот модуль ищет исполняемый файл `flatpak` в пути. Значение по умолчанию: `"flatpak"`
method string	Используемый метод установки. Определяет, должен ли `flatpak` быть установлен глобально для всей `system` или только для текущего `user`. Варианты: `"system"` ← (по умолчанию) `"user"`
name list / elements=string / required	Имя flatpak-пакета для управления. Для работы с несколькими пакетами может принимать список пакетов. При использовании с `state=present`, `name` может быть указан как URL-адрес файла `flatpakref` или уникальное обратное DNS-имя, идентифицирующее flatpak. Поддерживаются как `https://`, так и `http://` URL-адреса. При указании обратного DNS-имени можно использовать параметр `remote` для указания удаленного репозитория, в котором следует искать flatpak. Пример обратного DNS-имени: `org.gnome.gedit`. При использовании с `state=absent` или `state=latest`, рекомендуется указывать имя в формате обратного DNS. При указании URL-адреса с `state=absent` или `state=latest`, модуль попытается сопоставить установленный flatpak на основе имени файла flatpakref для его удаления или обновления. Однако нет гарантии, что имена файла flatpakref и обратного DNS-имени установленного flatpak совпадают.
no_dependencies boolean добавлено в community.general 3.2.0	Указывает, следует ли пропускать установку зависимостей времени выполнения или нет. Этот параметр в основном реализован для интеграционного тестирования этого модуля. Однако могут быть некоторые варианты использования, когда это может пригодиться, например, при упаковке собственных flatpak-пакетов. Варианты: `false` ← (по умолчанию) `true`
remote string	Удалённый репозиторий flatpak (хранилище) для установки flatpak-пакета. По умолчанию предполагается `flathub`, но вам необходимо добавить удалённый репозиторий flathub flatpak_remote, прежде чем вы сможете его использовать. См. модуль community.general.flatpak_remote для управления удаленными репозиториями flatpak. Значение по умолчанию: `"flathub"`
state string	Указывает желаемое состояние пакета. Значение `latest` поддерживается с community.general 8.6.0. Варианты: `"absent"` `"present"` ← (по умолчанию) `"latest"`

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: частичная Если `state=latest`, модуль всегда будет возвращать `changed=true`.	Может работать в режиме `check_mode` и возвращать прогноз состояния «изменено» без изменения цели.
diff_mode	Поддержка: отсутствует	Возвращает подробную информацию о том, что изменилось (или, возможно, должно измениться в `check_mode`), в режиме diff.

Примеры

- 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: Update the spotify flatpak
  community.general.flatpak:
    name:  https://s3.amazonaws.com/alexlarsson/spotify-repo/spotify.flatpakref
    state: latest

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

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

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

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

- 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

Значения возврата

Общие значения возврата документированы здесь, следующие являются полями, уникальными для данного модуля:

Ключ	Описание
command строка	Точная команда flatpak, которая была выполнена Возвращается: При выполнении команды flatpak Пример: `"/usr/bin/flatpak install --user --nontinteractive flathub org.gnome.Calculator"`
msg строка	Сообщение об ошибке модуля Возвращается: ошибка Пример: `"Executable '/usr/local/bin/flatpak' was not found on the system."`
rc целое число	Код возврата из бинарника flatpak Возвращается: При выполнении команды flatpak Пример: `0`
stderr строка	Выходные данные об ошибках из бинарника flatpak Возвращается: При выполнении команды flatpak Пример: `"error: Error searching remote flathub: Can't find ref org.gnome.KDE"`
stdout строка	Выходные данные из бинарника flatpak Возвращается: При выполнении команды flatpak Пример: `"org.gnome.Calendar/x86_64/stable\tcurrent\norg.gnome.gitg/x86_64/stable\tcurrent\n"`

Авторы

John Kwiatkoski (@JayKayy)
Alexander Bethke (@oolongbrothers)

Ссылки на сборку

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/flatpak_module.html