diff --git a/library/apt b/library/apt index bb40f7ff17d..4bf0faf4566 100755 --- a/library/apt +++ b/library/apt @@ -19,6 +19,84 @@ # along with this software. If not, see . # +DOCUMENTATION = ''' +--- +module: apt +short_description: Manages apt-packages (such as for Debian/Ubuntu). +description: + - Manages apt-packages (such as for Debian/Ubuntu). +version_added: "0.0.2" +options: + name: + description: + - A package name or package specifier with version, like foo or foo=1.0 + required: false + default: null + state: + description: + - Indicate the package state + required: false + default: present + choices: [ "installed", "latest", "remove", "absent", "present" ] + update_cache: + description: + - Run the equivalent of apt-get update before the operation. Can be run as part of the package installation or a seperate step + required: false + default: "no" + choices: [ "yes", "no" ] + purge: + description: + - Will forge purge of configuration files if state is set to 'absent'. + required: false + default: "no" + choices: [ "yes", "no" ] + default_release: + description: + - Corresponds to the -t option for apt and sets pin priorities + required: false + default: null + install_recommends: + description: + - Corresponds to the --no-install-recommends option for apt, default behavior works as apt's default behavior, 'no' does not install recommended packages. Suggested packages are never installed. + required: false + default: "no" + choices: [ "yes", "no" ] + force: + description: + - If ‘yes’, force installs/removes. + required: false + default: "no" + choices: [ "yes", "no" ] +author: Matthew Williams +''' + +EXAMPLES = [ +""" +- code: apt pkg=foo update-cache=yes + description: Update repositories cache and install 'foo' package +""", +""" +- code: apt pkg=foo state=removed + description: Remove 'foo' package +""", +""" +- code: apt pkg=foo state=installed + description: Install the the package 'foo' +""", +""" +- code: apt pkg=foo=1.00 state=installed + description: Install the version '1.00' of package 'foo' +""", +""" +- code: apt pkg=nginx state=latest default-release=squeeze-backports update-cache=yes + description: Update the repository cache and update package 'ngnix' to latest versione using default release 'squeeze-backport' +""", +""" +- code: apt pkg=openjdk-6-jdk state=latest install-recommends=no + description: Install latest version of 'openjdk-6-jdk' ignoring 'install-recomands' +""" +] + import traceback # added to stave off future warnings about apt api import warnings