community.general.gem – Manage Ruby gems

Note

This plugin is part of the community.general collection (version 1.3.2).

To install it use: ansible-galaxy collection install community.general.

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

Synopsis
Parameters
Examples

Synopsis

Manage installation and uninstallation of Ruby gems.

Parameters

Parameter	Choices/Defaults	Comments
build_flags string		Allow adding build flags for gem compilation
env_shebang boolean	no ← yes	Rewrite the shebang line on installed scripts to use /usr/bin/env.
executable path		Override the path to the gem executable
force boolean	no ← yes	Force gem to install, bypassing dependency checks.
gem_source path		The path to a local gem used as installation source.
include_dependencies boolean	no yes ←	Whether to include dependencies or not.
include_doc boolean	no ← yes	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	no ← yes	Allow installation of pre-release versions of the gem.
repository string		The repository from which the gem will be installed aliases: source
state string	present ← absent latest	The desired state of the gem. `latest` ensures that the latest version is installed.
user_install boolean	no yes ←	Install gem in user's local gems cache or for all users
version string		Version of the gem to be installed/removed.

Examples

- 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

Authors

Ansible Core Team
Johan Wiren (@johanwiren)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/general/gem_module.html