From 3969bba7712ff6fc7a41f82461d3a80eaec5ac84 Mon Sep 17 00:00:00 2001 From: Charles Ferguson Date: Mon, 23 Nov 2015 23:42:40 +0000 Subject: [PATCH] Update documentation of the 'pkg' and 'state' parameters in yum. The yum module allows the 'name' parameter to be given as 'pkg', in a similar way to some of the other package managers. This change documents this alias. The module's 'state' parameter has two other aliases, in line with the 'apt' action; the 'state' parameter can take 'installed' as an alias for 'present', and 'removed' as an alias for 'absent'. These aliases are documented. --- lib/ansible/modules/packaging/os/yum.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/lib/ansible/modules/packaging/os/yum.py b/lib/ansible/modules/packaging/os/yum.py index 69f20912775..75da45e9fcc 100644 --- a/lib/ansible/modules/packaging/os/yum.py +++ b/lib/ansible/modules/packaging/os/yum.py @@ -51,7 +51,7 @@ options: - "Package name, or package specifier with version, like C(name-1.0). When using state=latest, this can be '*' which means run: yum -y update. You can also pass a url or a local path to a rpm file. To operate on several packages this can accept a comma separated list of packages or (as of 2.0) a list of packages." required: true default: null - aliases: [] + aliases: [ 'pkg' ] exclude: description: - "Package name(s) to exlude when state=present, or latest @@ -65,9 +65,9 @@ options: default: null state: description: - - Whether to install (C(present), C(latest)), or remove (C(absent)) a package. + - Whether to install (C(present) or C(installed), C(latest)), or remove (C(absent) or C(removed)) a package. required: false - choices: [ "present", "latest", "absent" ] + choices: [ "present", "installed", "latest", "absent", "removed" ] default: "present" enablerepo: description: