Note
This plugin is part of the community.general collection (version 2.0.1).
To install it use: ansible-galaxy collection install community.general.
To use it in a playbook, specify: community.general.gem.
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| build_flags string | Allow adding build flags for gem compilation | |
| env_shebang boolean |
| Rewrite the shebang line on installed scripts to use /usr/bin/env. |
| executable path | Override the path to the gem executable | |
| force boolean |
| Force gem to install, bypassing dependency checks. |
| gem_source path | The path to a local gem used as installation source. | |
| include_dependencies boolean |
| Whether to include dependencies or not. |
| include_doc boolean |
| Install with or without docs. |
| install_dir path | Install the gems into a specific directory. These gems will be independent from the global installed ones. Specifying this requires user_install to be false. | |
| name string / required | The name of the gem to be managed. | |
| pre_release boolean |
| Allow installation of pre-release versions of the gem. |
| repository string | The repository from which the gem will be installed aliases: source | |
| state string |
| The desired state of the gem. latest ensures that the latest version is installed. |
| user_install boolean |
| Install gem in user's local gems cache or for all users |
| version string | Version of the gem to be installed/removed. |
- name: Install version 1.0 of vagrant
community.general.gem:
name: vagrant
version: 1.0
state: present
- name: Install latest available version of rake
community.general.gem:
name: rake
state: latest
- name: Install rake version 1.0 from a local gem on disk
community.general.gem:
name: rake
gem_source: /path/to/gems/rake-1.0.gem
state: present
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/general/gem_module.html