RubyGems - ansible-ruby - Versions diffs - 1.0.5 → 1.0.6 - Mend

ansible-ruby 1.0.5 → 1.0.6

Files changed (591) hide show

data/lib/ansible/ruby/modules/generated/extras/packaging/os/openbsd_pkg.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Manage packages on OpenBSD using the pkg tools.
       class Openbsd_pkg < Base
         # @return [String] Name of the package.
         attribute :name

data/lib/ansible/ruby/modules/generated/extras/packaging/os/opkg.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Manages OpenWrt packages
       class Opkg < Base
         # @return [Array<String>, String] name of package to install/remove
         attribute :name

data/lib/ansible/ruby/modules/generated/extras/packaging/os/pacman.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Manage packages with the I(pacman) package manager, which is used by Arch Linux and its variants.
       class Pacman < Base
         # @return [Array<String>, String, nil] Name of the package to install, upgrade, or remove.
         attribute :name

data/lib/ansible/ruby/modules/generated/extras/packaging/os/pkg5.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # IPS packages are the native packages in Solaris 11 and higher.
       class Pkg5 < Base
         # @return [Array<String>, String] An FRMI of the package(s) to be installed/removed/updated.,Multiple packages may be specified, separated by C(,).
         attribute :name

data/lib/ansible/ruby/modules/generated/extras/packaging/os/pkg5_publisher.rb CHANGED

@@ -5,6 +5,8 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # IPS packages are the native packages in Solaris 11 and higher.
+      # This modules will configure which publishers a client will download IPS packages from.
       class Pkg5_publisher < Base
         # @return [String] The publisher's name.
         attribute :name

data/lib/ansible/ruby/modules/generated/extras/packaging/os/pkgin.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # The standard package manager for SmartOS, but also usable on NetBSD or any OS that uses C(pkgsrc).  (Home: U(http://pkgin.net/))
       class Pkgin < Base
         # @return [Array<String>, String, nil] Name of package to install/remove;,multiple names may be given, separated by commas
         attribute :name

data/lib/ansible/ruby/modules/generated/extras/packaging/os/pkgng.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Manage binary packages for FreeBSD using 'pkgng' which is available in versions after 9.0.
       class Pkgng < Base
         # @return [Array<String>, String] name of package to install/remove
         attribute :name

data/lib/ansible/ruby/modules/generated/extras/packaging/os/pkgutil.rb CHANGED

@@ -5,6 +5,9 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Manages CSW packages (SVR4 format) on Solaris 10 and 11.
+      # These were the native packages on Solaris <= 10 and are available as a legacy feature in Solaris 11.
+      # Pkgutil is an advanced packaging system, which resolves dependency on installation. It is designed for CSW packages.
       class Pkgutil < Base
         # @return [Object] Package name, e.g. (C(CSWnrpe))
         attribute :name

data/lib/ansible/ruby/modules/generated/extras/packaging/os/portage.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Manages Gentoo packages
       class Portage < Base
         # @return [String, nil] Package atom or set, e.g. C(sys-apps/foo) or C(>foo-2.13) or C(@world)
         attribute :package

data/lib/ansible/ruby/modules/generated/extras/packaging/os/portinstall.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Manage packages for FreeBSD using 'portinstall'.
       class Portinstall < Base
         # @return [Array<String>, String] name of package to install/remove
         attribute :name

data/lib/ansible/ruby/modules/generated/extras/packaging/os/slackpkg.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Manage binary packages for Slackware using 'slackpkg' which is available in versions after 12.2.
       class Slackpkg < Base
         # @return [Array<String>, String] name of package to install/remove
         attribute :name

data/lib/ansible/ruby/modules/generated/extras/packaging/os/svr4pkg.rb CHANGED

@@ -5,6 +5,9 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Manages SVR4 packages on Solaris 10 and 11.
+      # These were the native packages on Solaris <= 10 and are available as a legacy feature in Solaris 11.
+      # Note that this is a very basic packaging system. It will not enforce dependencies on install or remove.
       class Svr4pkg < Base
         # @return [String] Package name, e.g. C(SUNWcsr)
         attribute :name

data/lib/ansible/ruby/modules/generated/extras/packaging/os/swdepot.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Will install, upgrade and remove packages with swdepot package manager (HP-UX)
       class Swdepot < Base
         # @return [String] package name.
         attribute :name

data/lib/ansible/ruby/modules/generated/extras/packaging/os/urpmi.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Manages packages with I(urpmi) (such as for Mageia or Mandriva)
       class Urpmi < Base
         # @return [Array<String>, String] name of package to install, upgrade or remove.
         attribute :pkg

data/lib/ansible/ruby/modules/generated/extras/packaging/os/yum_repository.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Add or remove YUM repositories in RPM-based Linux distributions.
       class Yum_repository < Base
         # @return [:yes, :no, nil] If set to C(yes) Yum will download packages and metadata from this repo in parallel, if possible.
         attribute :async

data/lib/ansible/ruby/modules/generated/extras/packaging/os/zypper.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Manage packages on SUSE and openSUSE using the zypper and rpm tools.
       class Zypper < Base
         # @return [String] package name or package specifier with version C(name) or C(name-1.0). You can also pass a url or a local path to a rpm file.
         attribute :name

data/lib/ansible/ruby/modules/generated/extras/packaging/os/zypper_repository.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Add or remove Zypper repositories on SUSE and openSUSE
       class Zypper_repository < Base
         # @return [String, nil] A name for the repository. Not required when adding repofiles.
         attribute :name

data/lib/ansible/ruby/modules/generated/extras/source_control/bzr.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Manage I(bzr) branches to deploy files or software.
       class Bzr < Base
         # @return [String] SSH or HTTP protocol address of the parent branch.
         attribute :name

data/lib/ansible/ruby/modules/generated/extras/source_control/git_config.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # The M(git_config) module changes git configuration by invoking 'git config'. This is needed if you don't want to use M(template) for the entire git config file (e.g. because you need to change just C(user.email) in /etc/.git/config).  Solutions involving M(command) are cumbersone or don't work correctly in check mode.
       class Git_config < Base
         # @return [Boolean, nil] List all settings (optionally limited to a given I(scope))
         attribute :list_all

data/lib/ansible/ruby/modules/generated/extras/source_control/github_hooks.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Adds service hooks and removes service hooks that have an error status.
       class Github_hooks < Base
         # @return [String] Github username.
         attribute :user

data/lib/ansible/ruby/modules/generated/extras/source_control/gitlab_group.rb CHANGED

@@ -5,6 +5,8 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # When the group does not exists in Gitlab, it will be created.
+      # When the group does exists and state=absent, the group will be deleted.
       class Gitlab_group < Base
         # @return [String] Url of Gitlab server, with protocol (http or https).
         attribute :server_url

data/lib/ansible/ruby/modules/generated/extras/source_control/gitlab_project.rb CHANGED

@@ -5,6 +5,9 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # When the project does not exists in Gitlab, it will be created.
+      # When the project does exists and state=absent, the project will be deleted.
+      # When changes are made to the project, the project will be updated.
       class Gitlab_project < Base
         # @return [String] Url of Gitlab server, with protocol (http or https).
         attribute :server_url

data/lib/ansible/ruby/modules/generated/extras/source_control/gitlab_user.rb CHANGED

@@ -5,6 +5,9 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # When the user does not exists in Gitlab, it will be created.
+      # When the user does exists and state=absent, the user will be deleted.
+      # When changes are made to user, the user will be updated.
       class Gitlab_user < Base
         # @return [String] Url of Gitlab server, with protocol (http or https).
         attribute :server_url

data/lib/ansible/ruby/modules/generated/extras/system/alternatives.rb CHANGED

@@ -5,6 +5,8 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Manages symbolic links using the 'update-alternatives' tool
+      # Useful when multiple programs are installed but provide similar functionality (e.g. different editors).
       class Alternatives < Base
         # @return [String] The generic name of the link.
         attribute :name

data/lib/ansible/ruby/modules/generated/extras/system/at.rb CHANGED

@@ -5,6 +5,8 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Use this module to schedule a command or script file to run once in the future.
+      # All jobs are executed in the 'a' queue.
       class At < Base
         # @return [String, nil] A command to be executed in the future.
         attribute :command

data/lib/ansible/ruby/modules/generated/extras/system/capabilities.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # This module manipulates files privileges using the Linux capabilities(7) system.
       class Capabilities < Base
         # @return [String] Specifies the path to the file to be managed.
         attribute :path

data/lib/ansible/ruby/modules/generated/extras/system/cronvar.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Use this module to manage crontab variables. This module allows you to create, update, or delete cron variable definitions.
       class Cronvar < Base
         # @return [String] Name of the crontab variable.
         attribute :name

data/lib/ansible/ruby/modules/generated/extras/system/crypttab.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Control Linux encrypted block devices that are set up during system boot in C(/etc/crypttab).
       class Crypttab < Base
         # @return [String] Name of the encrypted block device as it appears in the C(/etc/crypttab) file, or optionaly prefixed with C(/dev/mapper/), as it appears in the filesystem. I(/dev/mapper/) will be stripped from I(name).
         attribute :name

data/lib/ansible/ruby/modules/generated/extras/system/debconf.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Configure a .deb package using debconf-set-selections. Or just query existing selections.
       class Debconf < Base
         # @return [Object] Name of package to configure.
         attribute :name

data/lib/ansible/ruby/modules/generated/extras/system/facter.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Runs the I(facter) discovery program (U(https://github.com/puppetlabs/facter)) on the remote system, returning JSON data that can be useful for inventory purposes.
       class Facter < Base
       end

data/lib/ansible/ruby/modules/generated/extras/system/filesystem.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # This module creates file system.
       class Filesystem < Base
         # @return [String] File System type to be created.
         attribute :fstype

data/lib/ansible/ruby/modules/generated/extras/system/firewalld.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # This module allows for addition or deletion of services and ports either tcp or udp in either running or permanent firewalld rules.
       class Firewalld < Base
         # @return [String, nil] Name of a service to add/remove to/from firewalld - service must be listed in /etc/services.
         attribute :service

data/lib/ansible/ruby/modules/generated/extras/system/getent.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Runs getent against one of it's various databases and returns information into the host's facts, in a getent_<database> prefixed variable
       class Getent < Base
         # @return [String] the name of a getent database supported by the target system (passwd, group, hosts, etc).
         attribute :database

data/lib/ansible/ruby/modules/generated/extras/system/gluster_volume.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Create, remove, start, stop and tune GlusterFS volumes
       class Gluster_volume < Base
         # @return [String] The volume name
         attribute :name

data/lib/ansible/ruby/modules/generated/extras/system/iptables.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Iptables is used to set up, maintain, and inspect the tables of IP packet filter rules in the Linux kernel. This module does not handle the saving and/or loading of rules, but rather only manipulates the current rules that are present in memory. This is the same as the behaviour of the "iptables" and "ip6tables" command which this module uses internally.
       class Iptables < Base
         # @return [:filter, :nat, :mangle, :raw, :security, nil] This option specifies the packet matching table which the command should operate on. If the kernel is configured with automatic module loading, an attempt will be made to load the appropriate module for that table if it is not already there.
         attribute :table

data/lib/ansible/ruby/modules/generated/extras/system/kernel_blacklist.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Add or remove kernel modules from blacklist.
       class Kernel_blacklist < Base
         # @return [String] Name of kernel module to black- or whitelist.
         attribute :name

data/lib/ansible/ruby/modules/generated/extras/system/known_hosts.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # The M(known_hosts) module lets you add or remove a host from the C(known_hosts) file. This is useful if you're going to want to use the M(git) module over ssh, for example. If you have a very large number of host keys to manage, you will find the M(template) module more useful.
       class Known_hosts < Base
         # @return [String] The host to add or remove (must match a host specified in key)
         attribute :name

data/lib/ansible/ruby/modules/generated/extras/system/locale_gen.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Manages locales by editing /etc/locale.gen and invoking locale-gen.
       class Locale_gen < Base
         # @return [String] Name and encoding of the locale, such as "en_GB.UTF-8".
         attribute :name

data/lib/ansible/ruby/modules/generated/extras/system/lvg.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # This module creates, removes or resizes volume groups.
       class Lvg < Base
         # @return [String] The name of the volume group.
         attribute :vg

data/lib/ansible/ruby/modules/generated/extras/system/lvol.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # This module creates, removes or resizes logical volumes.
       class Lvol < Base
         # @return [String] The volume group this logical volume is part of.
         attribute :vg

data/lib/ansible/ruby/modules/generated/extras/system/make.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Run targets in a Makefile.
       class Make < Base
         # @return [String, nil] The target to run
         attribute :target

data/lib/ansible/ruby/modules/generated/extras/system/modprobe.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Add or remove kernel modules.
       class Modprobe < Base
         # @return [String] Name of kernel module to manage.
         attribute :name

data/lib/ansible/ruby/modules/generated/extras/system/ohai.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Similar to the M(facter) module, this runs the I(Ohai) discovery program (U(http://wiki.opscode.com/display/chef/Ohai)) on the remote host and returns JSON inventory data. I(Ohai) data is a bit more verbose and nested than I(facter).
       class Ohai < Base
       end

data/lib/ansible/ruby/modules/generated/extras/system/open_iscsi.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Discover targets on given portal, (dis)connect targets, mark targets to manually or auto start, return device nodes of connected targets.
       class Open_iscsi < Base
         # @return [String, nil] the ip address of the iscsi target
         attribute :portal

data/lib/ansible/ruby/modules/generated/extras/system/osx_defaults.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # osx_defaults allows users to read, write, and delete Mac OS X user defaults from Ansible scripts. Mac OS X applications and other programs use the defaults system to record user preferences and other information that must be maintained when the applications aren't running (such as default font for new documents, or the position of an Info panel).
       class Osx_defaults < Base
         # @return [String, nil] The domain is a domain name of the form com.companyname.appname.
         attribute :domain

data/lib/ansible/ruby/modules/generated/extras/system/pam_limits.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # The M(pam_limits) module modify PAM limits, default in /etc/security/limits.conf. For the full documentation, see man limits.conf(5).
       class Pam_limits < Base
         # @return [String] A username, @groupname, wildcard, uid/gid range.
         attribute :domain

data/lib/ansible/ruby/modules/generated/extras/system/puppet.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Runs I(puppet) agent or apply in a reliable manner
       class Puppet < Base
         # @return [String, nil] How long to wait for I(puppet) to finish.
         attribute :timeout

data/lib/ansible/ruby/modules/generated/extras/system/selinux_permissive.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Add and remove domain from the list of permissive domain.
       class Selinux_permissive < Base
         # @return [Object] the domain that will be added or removed from the list of permissive domains
         attribute :domain

data/lib/ansible/ruby/modules/generated/extras/system/seport.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Manages SELinux network port type definitions.
       class Seport < Base
         # @return [Array<String>, String] Ports or port ranges, separated by a comma
         attribute :ports