W3cubDocs

/Ansible

community.general.snap – Manages snaps

Note

This plugin is part of the community.general collection (version 3.8.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.

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

Synopsis

  • Manages snaps packages.

Parameters

Parameter Choices/Defaults Comments
channel
string
Default:
"stable"
Define which release of a snap is installed and tracked for updates. This option can only be specified if there is a single snap in the task.
classic
boolean
    Choices:
  • no ←
  • yes
Confinement policy. The classic confinement allows a snap to have the same level of access to the system as "classic" packages, like those managed by APT. This option corresponds to the --classic argument. This option can only be specified if there is a single snap in the task.
name
list / elements=string / required
Name of the snaps.
state
string
    Choices:
  • absent
  • present ←
  • enabled
  • disabled
Desired state of the package.

Examples

# Install "foo" and "bar" snap
- name: Install foo
  community.general.snap:
    name:
      - foo
      - bar

# Remove "foo" snap
- name: Remove foo
  community.general.snap:
    name: foo
    state: absent

# Install a snap with classic confinement
- name: Install "foo" with option --classic
  community.general.snap:
    name: foo
    classic: yes

# Install a snap with from a specific channel
- name: Install "foo" with option --channel=latest/edge
  community.general.snap:
    name: foo
    channel: latest/edge

Return Values

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

Key Returned Description
channel
string
When snaps are installed
The channel the snaps were installed from
classic
boolean
When snaps are installed
Whether or not the snaps were installed with the classic confinement
cmd
string
When changed is true
The command that was executed on the host
snaps_installed
list / elements=string
When any snaps have been installed
The list of actually installed snaps
snaps_removed
list / elements=string
When any snaps have been removed
The list of actually removed snaps


Authors

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