community.general.openbsd_pkg – Manage packages on OpenBSD

Note

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

To install it use: ansible-galaxy collection install community.general.

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

Synopsis
Requirements
Parameters
Notes
Examples

Synopsis

Manage packages on OpenBSD using the pkg tools.

Requirements

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

python >= 2.5

Parameters

Parameter	Choices/Defaults	Comments
build boolean	no ← yes	Build the package from source instead of downloading and installing a binary. Requires that the port source tree is already installed. Automatically builds and installs the 'sqlports' package, if it is not already installed. Mutually exclusive with snapshot.
clean boolean	no ← yes	When updating or removing packages, delete the extra configuration file(s) in the old packages which are annotated with @extra in the packaging-list.
name list / elements=string / required		A name or a list of names of the packages.
ports_dir path	Default: "/usr/ports"	When used in combination with the `build` option, allows overriding the default ports source directory.
quick boolean	no ← yes	Replace or delete packages quickly; do not bother with checksums before removing normal files.
snapshot boolean added in 1.3.0 of community.general	no ← yes	Force `%c` and `%m` to expand to `snapshots`, even on a release kernel. Mutually exclusive with build.
state string	absent latest present ← installed removed	`present` will make sure the package is installed. `latest` will make sure the latest version of the package is installed. `absent` will make sure the specified package is not installed.

Notes

Note

When used with a loop: each package will be processed individually, it is much more efficient to pass the list directly to the name option.

Examples

- name: Make sure nmap is installed
  community.general.openbsd_pkg:
    name: nmap
    state: present

- name: Make sure nmap is the latest version
  community.general.openbsd_pkg:
    name: nmap
    state: latest

- name: Make sure nmap is not installed
  community.general.openbsd_pkg:
    name: nmap
    state: absent

- name: Make sure nmap is installed, build it from source if it is not
  community.general.openbsd_pkg:
    name: nmap
    state: present
    build: yes

- name: Specify a pkg flavour with '--'
  community.general.openbsd_pkg:
    name: vim--no_x11
    state: present

- name: Specify the default flavour to avoid ambiguity errors
  community.general.openbsd_pkg:
    name: vim--
    state: present

- name: Specify a package branch (requires at least OpenBSD 6.0)
  community.general.openbsd_pkg:
    name: python%3.5
    state: present

- name: Update all packages on the system
  community.general.openbsd_pkg:
    name: '*'
    state: latest

- name: Purge a package and it's configuration files
  community.general.openbsd_pkg:
    name: mpd
    clean: yes
    state: absent

- name: Quickly remove a package without checking checksums
  community.general.openbsd_pkg:
    name: qt5
    quick: yes
    state: absent

Authors

Patrik Lundin (@eest)

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