community.general.opkg module – Package manager for OpenWrt and Openembedded/Yocto based Linux distributions

Note

This module is part of the community.general collection (version 6.6.9).

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. You need further requirements to be able to use this module, see Requirements for details.

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

Synopsis

  • Manages ipk packages for OpenWrt and Openembedded/Yocto based Linux distributions

Requirements

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

  • opkg

  • python

Parameters

Parameter

Comments

executable

path

added in community.general 7.2.0

The executable location for opkg.

force

string

The opkg --force parameter used.

Passing "" as value and not passing any value at all have both the same effect of not using any --force- parameter.

Choices:

  • ""

  • "depends"

  • "maintainer"

  • "reinstall"

  • "overwrite"

  • "downgrade"

  • "space"

  • "postinstall"

  • "remove"

  • "checksum"

  • "removal-of-dependent-packages"

name

aliases: pkg

list / elements=string / required

Name of package(s) to install/remove.

NAME=VERSION syntax is also supported to install a package in a certain version. See the examples. This only works on Yocto based Linux distributions (opkg>=0.3.2) and not for OpenWrt. This is supported since community.general 6.2.0.

state

string

State of the package.

Choices:

  • "present" ← (default)

  • "absent"

  • "installed"

  • "removed"

update_cache

boolean

Update the package DB first.

Choices:

  • false ← (default)

  • true

Attributes

Attribute

Support

Description

check_mode

Support: none

Can run in check_mode and return changed status prediction without modifying target.

diff_mode

Support: none

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.

Examples

- name: Install foo
  community.general.opkg:
    name: foo
    state: present

- name: Install foo in version 1.2 (opkg>=0.3.2 on Yocto based Linux distributions)
  community.general.opkg:
    name: foo=1.2
    state: present

- name: Update cache and install foo
  community.general.opkg:
    name: foo
    state: present
    update_cache: true

- name: Remove foo
  community.general.opkg:
    name: foo
    state: absent

- name: Remove foo and bar
  community.general.opkg:
    name:
      - foo
      - bar
    state: absent

- name: Install foo using overwrite option forcibly
  community.general.opkg:
    name: foo
    state: present
    force: overwrite

Authors

  • Patrick Pelletier (@skinp)