salt.modules.gem¶

Manage ruby gems.

salt.modules.gem.install(gems, ruby=None, gem_bin=None, runas=None, version=None, rdoc=False, ri=False, pre_releases=False, proxy=None)¶

Installs one or several gems.

gems: The gems to install
gem_bin : None: Full path to gem binary to use.
ruby : None: If RVM or rbenv are installed, the ruby version and gemset to use. Ignored if gem_bin is specified.
runas : None: The user to run gem as.
version : None: Specify the version to install for the gem. Doesn't play nice with multiple gems at once
rdoc : False: Generate RDoc documentation for the gem(s).
ri : False: Generate RI documentation for the gem(s).
pre_releases: Include pre-releases in the available versions
proxy : None: Use the specified HTTP proxy server for all outgoing traffic. Format: http://hostname[:port]

CLI Example:

salt '*' gem.install vagrant

salt '*' gem.install redphone gem_bin=/opt/sensu/embedded/bin/gem

salt.modules.gem.list(prefix='', ruby=None, runas=None, gem_bin=None)¶

List locally installed gems.

prefix :: Only list gems when the name matches this prefix.
gem_bin : None: Full path to gem binary to use.
ruby : None: If RVM or rbenv are installed, the ruby version and gemset to use. Ignored if gem_bin is specified.
runas : None: The user to run gem as.

CLI Example:

salt '*' gem.list

salt.modules.gem.list_upgrades(ruby=None, runas=None, gem_bin=None)¶

New in version Beryllium.

Check if an upgrade is available for installed gems

gem_bin : None: Full path to gem binary to use.
ruby : None: If RVM or rbenv are installed, the ruby version and gemset to use. Ignored if gem_bin is specified.
runas : None: The user to run gem as.

CLI Example:

salt '*' gem.list_upgrades

salt.modules.gem.sources_add(source_uri, ruby=None, runas=None, gem_bin=None)¶

Add a gem source.

source_uri: The source URI to add.
gem_bin : None: Full path to gem binary to use.
ruby : None: If RVM or rbenv are installed, the ruby version and gemset to use. Ignored if gem_bin is specified.
runas : None: The user to run gem as.

CLI Example:

salt '*' gem.sources_add http://rubygems.org/

salt.modules.gem.sources_list(ruby=None, runas=None, gem_bin=None)¶

List the configured gem sources.

gem_bin : None: Full path to gem binary to use.
ruby : None: If RVM or rbenv are installed, the ruby version and gemset to use. Ignored if gem_bin is specified.
runas : None: The user to run gem as.

CLI Example:

salt '*' gem.sources_list

salt.modules.gem.sources_remove(source_uri, ruby=None, runas=None, gem_bin=None)¶

Remove a gem source.

source_uri: The source URI to remove.
gem_bin : None: Full path to gem binary to use.
ruby : None: If RVM or rbenv are installed, the ruby version and gemset to use. Ignored if gem_bin is specified.
runas : None: The user to run gem as.

CLI Example:

salt '*' gem.sources_remove http://rubygems.org/

salt.modules.gem.uninstall(gems, ruby=None, runas=None, gem_bin=None)¶

Uninstall one or several gems.

gems: The gems to uninstall.
gem_bin : None: Full path to gem binary to use.
ruby : None: If RVM or rbenv are installed, the ruby version and gemset to use. Ignored if gem_bin is specified.
runas : None: The user to run gem as.

CLI Example:

salt '*' gem.uninstall vagrant

salt.modules.gem.update(gems, ruby=None, runas=None, gem_bin=None)¶

Update one or several gems.

gems: The gems to update.
gem_bin : None: Full path to gem binary to use.
ruby : None: If RVM or rbenv are installed, the ruby version and gemset to use. Ignored if gem_bin is specified.
runas : None: The user to run gem as.

CLI Example:

salt '*' gem.update vagrant

salt.modules.gem.update_system(version='', ruby=None, runas=None, gem_bin=None)¶

Update rubygems.

version : (newest): The version of rubygems to install.
gem_bin : None: Full path to gem binary to use.
ruby : None: If RVM or rbenv are installed, the ruby version and gemset to use. Ignored if gem_bin is specified.
runas : None: The user to run gem as.

CLI Example:

salt '*' gem.update_system