W3cubDocs

/Ansible

package - Generic OS package manager

New in version 2.0.

Synopsis

Installs, upgrade and removes packages using the underlying OS package manager.

Requirements (on host that executes module)

  • Whatever is required for the package plugins specific for each system.

Options

parameter required default choices comments
name
 yes
Package name, or package specifier with version, like name-1.0.
Be aware that packages are not always named the same and this module will not 'translate' them per distro.
state
 yes
Whether to install (present, latest), or remove (absent) a package.
use
 no auto
The required package manager module to use (yum, apt, etc). The default 'auto' will use existing facts or try to autodetect it.
You should only use this field if the automatic selection is not working for some reason.

Examples

- name: install the latest version of ntpdate
  package: name=ntpdate state=latest

# This uses a variable as this changes per distribution.
- name: remove the apache package
  package: name={{apache}} state=absent

Notes

Note

This module actually calls the pertinent package modules for each system (apt, yum, etc).

This is a Core Module

For more information on what this means please read Core Modules

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, developing_test_pr and Developing Modules.

© 2012–2016 Michael DeHaan
© 2016 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/package_module.html