ansible-ruby 1.0.5 → 1.0.6

data/lib/ansible/ruby/modules/generated/core/network/openswitch/ops_facts.rb

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # This module collects additional device fact information from a remote device running OpenSwitch using either the CLI or REST interfaces.  It provides optional arguments for collecting fact information.
       class Ops_facts < Base
         # @return [Boolean, nil] When enabled, this argument will collect the current running configuration from the remote device.  If the transport is C(rest) then the collected configuration will be the full system configuration.
         attribute :config

data/lib/ansible/ruby/modules/generated/core/network/openswitch/ops_template.rb

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # The OpenSwitch platform provides a library for pushing JSON structured configuration files into the current running-config.  This module will read the current configuration from OpenSwitch and compare it against a provided candidate configuration. If there are changes, the candidate configuration is merged with the current configuration and pushed into OpenSwitch
       class Ops_template < Base
         # @return [String] The path to the config source.  The source can be either a file with config or a template that will be merged during runtime.  By default the task will search for the source file in role or playbook root folder in templates directory.
         attribute :src

data/lib/ansible/ruby/modules/generated/core/packaging/language/easy_install.rb

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Installs Python libraries, optionally in a I(virtualenv)
       class Easy_install < Base
         # @return [String] A Python library name
         attribute :name

data/lib/ansible/ruby/modules/generated/core/packaging/language/gem.rb

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Manage installation and uninstallation of Ruby gems.
       class Gem < Base
         # @return [String] The name of the gem to be managed.
         attribute :name

data/lib/ansible/ruby/modules/generated/core/packaging/language/pip.rb

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Manage Python library dependencies. To use this module, one of the following keys is required: C(name) or C(requirements).
       class Pip < Base
         # @return [String, nil] The name of a Python library to install or the url of the remote package.
         attribute :name

data/lib/ansible/ruby/modules/generated/core/packaging/os/apt.rb

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Manages I(apt) packages (such as for Debian/Ubuntu).
       class Apt < Base
         # @return [String, nil] A package name, like C(foo), or package specifier with version, like C(foo=1.0). Name wildcards (fnmatch) like C(apt*) and version wildcards like C(foo=1.0*) are also supported.  Note that the apt-get commandline supports implicit regex matches here but we do not because it can let typos through easier (If you typo C(foo) as C(fo) apt-get would install packages that have "fo" in their name with a warning and a prompt for the user.  Since we don't have warnings and prompts before installing we disallow this.  Use an explicit fnmatch pattern if you want wildcarding)
         attribute :name

data/lib/ansible/ruby/modules/generated/core/packaging/os/apt_key.rb

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Add or remove an I(apt) key, optionally downloading it
       class Apt_key < Base
         # @return [String, nil] identifier of key. Including this allows check mode to correctly report the changed state.
         attribute :id

data/lib/ansible/ruby/modules/generated/core/packaging/os/apt_repository.rb

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Add or remove an APT repositories in Ubuntu and Debian.
       class Apt_repository < Base
         # @return [String] A source string for the repository.
         attribute :repo

data/lib/ansible/ruby/modules/generated/core/packaging/os/apt_rpm.rb

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Manages packages with I(apt-rpm). Both low-level (I(rpm)) and high-level (I(apt-get)) package manager binaries required.
       class Apt_rpm < Base
         # @return [Array<String>, String] name of package to install, upgrade or remove.
         attribute :pkg

data/lib/ansible/ruby/modules/generated/core/packaging/os/package.rb

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Installs, upgrade and removes packages using the underlying OS package manager.
       class Package < Base
         # @return [String] Package name, or package specifier with version, like C(name-1.0).,Be aware that packages are not always named the same and this module will not 'translate' them per distro.
         attribute :name

data/lib/ansible/ruby/modules/generated/core/packaging/os/redhat_subscription.rb

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Manage registration and subscription to the Red Hat Network entitlement platform.
       class Redhat_subscription < Base
         # @return [:present, :absent, nil] whether to register and subscribe (C(present)), or unregister (C(absent)) a system
         attribute :state

data/lib/ansible/ruby/modules/generated/core/packaging/os/rhn_channel.rb

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Adds or removes Red Hat software channels
       class Rhn_channel < Base
         # @return [String] name of the software channel
         attribute :name

data/lib/ansible/ruby/modules/generated/core/packaging/os/rhn_register.rb

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Manage registration to the Red Hat Network.
       class Rhn_register < Base
         # @return [:present, :absent, nil] whether to register (C(present)), or unregister (C(absent)) a system
         attribute :state

data/lib/ansible/ruby/modules/generated/core/packaging/os/rpm_key.rb

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Adds or removes (rpm --import) a gpg key to your rpm database.
       class Rpm_key < Base
         # @return [String] Key that will be modified. Can be a url, a file, or a keyid if the key already exists in the database.
         attribute :key

data/lib/ansible/ruby/modules/generated/core/packaging/os/yum.rb

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Installs, upgrade, removes, and lists packages and groups with the I(yum) package manager.
       class Yum < Base
         # @return [String] 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 (using state=present).  To operate on several packages this can accept a comma separated list of packages or (as of 2.0) a list of packages.
         attribute :name

data/lib/ansible/ruby/modules/generated/core/source_control/git.rb

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Manage I(git) checkouts of repositories to deploy files or software.
       class Git < Base
         # @return [String] git, SSH, or HTTP(S) protocol address of the git repository.
         attribute :repo

data/lib/ansible/ruby/modules/generated/core/source_control/hg.rb

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Manages Mercurial (hg) repositories. Supports SSH, HTTP/S and local address.
       class Hg < Base
         # @return [String] The repository address.
         attribute :repo

data/lib/ansible/ruby/modules/generated/core/source_control/subversion.rb

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Deploy given repository URL / revision to dest. If dest exists, update to the specified revision, otherwise perform a checkout.
       class Subversion < Base
         # @return [String] The subversion URL to the repository.
         attribute :repo

data/lib/ansible/ruby/modules/generated/core/system/authorized_key.rb

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Adds or removes SSH authorized keys for particular user accounts
       class Authorized_key < Base
         # @return [String] The username on the remote host whose authorized_keys file will be modified
         attribute :user

data/lib/ansible/ruby/modules/generated/core/system/cron.rb

@@ -5,6 +5,9 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Use this module to manage crontab and environment variables entries. This module allows you to create environment variables and named crontab entries, update, or delete them.
+      # When crontab jobs are managed: the module includes one line with the description of the crontab entry C("#Ansible: <name>") corresponding to the "name" passed to the module, which is used by future ansible/module calls to find/check the state. The "name" parameter should be unique, and changing the "name" value will result in a new cron task being created (or a different one being removed).
+      # When environment variables are managed: no comment line is added, but, when the module needs to find/check the state, it uses the "name" parameter to find the environment variable definition line.
       class Cron < Base
         # @return [String, nil] Description of a crontab entry or, if env is set, the name of environment variable. Required if state=absent
         attribute :name

data/lib/ansible/ruby/modules/generated/core/system/group.rb

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Manage presence of groups on a host.
       class Group < Base
         # @return [String] Name of the group to manage.
         attribute :name

data/lib/ansible/ruby/modules/generated/core/system/hostname.rb

@@ -5,6 +5,10 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Set system's hostname.
+      # Currently implemented on Debian, Ubuntu, Fedora, RedHat, openSUSE, Linaro, ScientificLinux, Arch, CentOS, AMI.
+      # Any distribution that uses systemd as their init system.
+      # Note, this module does *NOT* modify /etc/hosts. You need to modify it yourself using other modules like template or replace.
       class Hostname < Base
         # @return [String] Name of the host
         attribute :name

data/lib/ansible/ruby/modules/generated/core/system/mount.rb

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # This module controls active and configured mount points in C(/etc/fstab).
       class Mount < Base
         # @return [String] path to the mount point, eg: C(/mnt/files)
         attribute :name

data/lib/ansible/ruby/modules/generated/core/system/ping.rb

@@ -5,6 +5,8 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # A trivial test module, this module always returns C(pong) on successful contact. It does not make sense in playbooks, but it is useful from C(/usr/bin/ansible) to verify the ability to login and that a usable python is configured.
+      # This is NOT ICMP ping, this is just a trivial test module.
       class Ping < Base
 
       end

data/lib/ansible/ruby/modules/generated/core/system/seboolean.rb

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Toggles SELinux booleans.
       class Seboolean < Base
         # @return [String] Name of the boolean to configure
         attribute :name

data/lib/ansible/ruby/modules/generated/core/system/selinux.rb

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Configures the SELinux mode and policy. A reboot may be required after usage. Ansible will not issue this reboot but will let you know when it is required.
       class Selinux < Base
         # @return [String, nil] name of the SELinux policy to use (example: C(targeted)) will be required if state is not C(disabled)
         attribute :policy

data/lib/ansible/ruby/modules/generated/core/system/service.rb

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Controls services on remote hosts. Supported init systems include BSD init, OpenRC, SysV, Solaris SMF, systemd, upstart.
       class Service < Base
         # @return [String] Name of the service.
         attribute :name

data/lib/ansible/ruby/modules/generated/core/system/setup.rb

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # This module is automatically called by playbooks to gather useful variables about remote hosts that can be used in playbooks. It can also be executed directly by C(/usr/bin/ansible) to check what variables are available to a host. Ansible provides many I(facts) about the system, automatically.
       class Setup < Base
         # @return [String, nil] if supplied, restrict the additional facts collected to the given subset. Possible values: all, hardware, network, virtual, ohai, and facter Can specify a list of values to specify a larger subset. Values can also be used with an initial C(!) to specify that that specific subset should not be collected.  For instance: !hardware, !network, !virtual, !ohai, !facter.  Note that a few facts are always collected.  Use the filter parameter if you do not want to display those.
         attribute :gather_subset

data/lib/ansible/ruby/modules/generated/core/system/sysctl.rb

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # This module manipulates sysctl entries and optionally performs a C(/sbin/sysctl -p) after changing them.
       class Sysctl < Base
         # @return [String] The dot-separated path (aka I(key)) specifying the sysctl variable.
         attribute :name

data/lib/ansible/ruby/modules/generated/core/system/user.rb

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Manage user accounts and user attributes.
       class User < Base
         # @return [String] Name of the user to create, remove or modify.
         attribute :name

data/lib/ansible/ruby/modules/generated/core/utilities/helper/accelerate.rb

@@ -5,6 +5,9 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # This modules launches an ephemeral I(accelerate) daemon on the remote node which Ansible can use to communicate with nodes at high speed.
+      # The daemon listens on a configurable port for a configurable amount of time.
+      # Fireball mode is AES encrypted
       class Accelerate < Base
         # @return [Integer, nil] TCP port for the socket connection
         attribute :port

data/lib/ansible/ruby/modules/generated/core/utilities/helper/fireball.rb

@@ -5,6 +5,8 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Modern SSH clients support ControlPersist which is just as fast as fireball was.  Please enable that in ansible.cfg as a replacement for fireball.
+      # Removed in ansible 2.0.
       class Fireball < Base
 
       end

data/lib/ansible/ruby/modules/generated/core/utilities/logic/assert.rb

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # This module asserts that a given expression is true and can be a simpler alternative to the 'fail' module in some cases.
       class Assert < Base
         # @return [Array<String>, String] A string expression of the same form that can be passed to the 'when' statement,Alternatively, a list of string expressions
         attribute :that

data/lib/ansible/ruby/modules/generated/core/utilities/logic/async_status.rb

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # This module gets the status of an asynchronous task.
       class Async_status < Base
         # @return [Object] Job or task identifier
         attribute :jid

data/lib/ansible/ruby/modules/generated/core/utilities/logic/debug.rb

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # This module prints statements during execution and can be useful for debugging variables or expressions without necessarily halting the playbook. Useful for debugging together with the 'when:' directive.
       class Debug < Base
         # @return [String, nil] The customized message that is printed. If omitted, prints a generic message.
         attribute :msg

data/lib/ansible/ruby/modules/generated/core/utilities/logic/fail.rb

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # This module fails the progress with a custom message. It can be useful for bailing out when a certain condition is met using C(when).
       class Fail < Base
         # @return [String, nil] The customized message used for failing execution. If omitted, fail will simple bail out with a generic message.
         attribute :msg

data/lib/ansible/ruby/modules/generated/core/utilities/logic/pause.rb

@@ -5,6 +5,9 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Pauses playbook execution for a set amount of time, or until a prompt is acknowledged. All parameters are optional. The default behavior is to pause with a prompt.
+      # You can use C(ctrl+c) if you wish to advance a pause earlier than it is set to expire or if you need to abort a playbook run entirely. To continue early: press C(ctrl+c) and then C(c). To abort a playbook: press C(ctrl+c) and then C(a).
+      # The pause module integrates into async/parallelized playbooks without any special considerations (see also: Rolling Updates). When using pauses with the C(serial) playbook parameter (as in rolling updates) you are only prompted once for the current group of hosts.
       class Pause < Base
         # @return [String, nil] Number of minutes to pause for.
         attribute :minutes

data/lib/ansible/ruby/modules/generated/core/utilities/logic/set_fact.rb

@@ -5,6 +5,8 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # This module allows setting new variables.  Variables are set on a host-by-host basis just like facts discovered by the setup module.
+      # These variables will survive between plays during an Ansible run, but will not be saved across executions even if you use a fact cache.
       class Set_fact < Base
         # @return [Object] The C(set_fact) module takes key=value pairs as variables to set in the playbook scope. Or alternatively, accepts complex arguments using the C(args:) statement.
         attribute :key_value

data/lib/ansible/ruby/modules/generated/core/utilities/logic/wait_for.rb

@@ -5,6 +5,11 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # You can wait for a set amount of time C(timeout), this is the default if nothing is specified.
+      # Waiting for a port to become available is useful for when services are not immediately available after their init scripts return which is true of certain Java application servers. It is also useful when starting guests with the M(virt) module and needing to pause until they are ready.
+      # This module can also be used to wait for a regex match a string to be present in a file.
+      # In 1.6 and later, this module can also be used to wait for a file to be available or absent on the filesystem.
+      # In 1.8 and later, this module can also be used to wait for active connections to be closed before continuing, useful if a node is being rotated out of a load balancer pool.
       class Wait_for < Base
         # @return [String, nil] A resolvable hostname or IP address to wait for
         attribute :host

data/lib/ansible/ruby/modules/generated/core/web_infrastructure/apache2_module.rb

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Enables or disables a specified module of the Apache2 webserver.
       class Apache2_module < Base
         # @return [String] name of the module to enable/disable
         attribute :name

data/lib/ansible/ruby/modules/generated/core/web_infrastructure/django_manage.rb

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Manages a Django application using the I(manage.py) application frontend to I(django-admin). With the I(virtualenv) parameter, all management commands will be executed by the given I(virtualenv) installation.
       class Django_manage < Base
         # @return [:cleanup, :collectstatic, :flush, :loaddata, :migrate, :runfcgi, :syncdb, :test, :validate] The name of the Django management command to run. Built in commands are cleanup, collectstatic, flush, loaddata, migrate, runfcgi, syncdb, test, and validate.,Other commands can be entered, but will fail if they're unknown to Django.  Other commands that may prompt for user input should be run with the I(--noinput) flag.
         attribute :command

data/lib/ansible/ruby/modules/generated/core/web_infrastructure/htpasswd.rb

@@ -5,6 +5,8 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Add and remove username/password entries in a password file using htpasswd.
+      # This is used by web servers such as Apache and Nginx for basic authentication.
       class Htpasswd < Base
         # @return [String] Path to the file that contains the usernames and passwords
         attribute :path

data/lib/ansible/ruby/modules/generated/core/web_infrastructure/supervisorctl.rb

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Manage the state of a program or group of programs running via supervisord
       class Supervisorctl < Base
         # @return [String] The name of the supervisord program or group to manage.,The name will be taken as group name when it ends with a colon I(:),Group support is only available in Ansible version 1.6 or later.
         attribute :name

data/lib/ansible/ruby/modules/generated/core/windows/win_copy.rb

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # The M(win_copy) module copies a file on the local box to remote windows locations.
       class Win_copy < Base
         # @return [String, nil] Local path to a file to copy to the remote server; can be absolute or relative. If path is a directory, it is copied recursively. In this case, if path ends with "/", only inside contents of that directory are copied to destination. Otherwise, if it does not end with "/", the directory itself with all contents is copied. This behavior is similar to Rsync.
         attribute :src

data/lib/ansible/ruby/modules/generated/core/windows/win_feature.rb

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Installs or uninstalls Windows Roles or Features
       class Win_feature < Base
         # @return [Object] Names of roles or features to install as a single feature or a comma-separated list of features
         attribute :name

data/lib/ansible/ruby/modules/generated/core/windows/win_file.rb

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Creates (empty) files, updates file modification stamps of existing files, and can create or remove directories. Unlike M(file), does not modify ownership, permissions or manipulate links.
       class Win_file < Base
         # @return [Object] path to the file being managed.  Aliases: I(dest), I(name)
         attribute :path

data/lib/ansible/ruby/modules/generated/core/windows/win_get_url.rb

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Fetches a file from a URL and saves to locally
       class Win_get_url < Base
         # @return [String] The full URL of a file to download
         attribute :url

data/lib/ansible/ruby/modules/generated/core/windows/win_group.rb

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Add and remove local groups
       class Win_group < Base
         # @return [Object] Name of the group
         attribute :name

data/lib/ansible/ruby/modules/generated/core/windows/win_lineinfile.rb

@@ -5,6 +5,8 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # This module will search a file for a line, and ensure that it is present or absent.
+      # This is primarily useful when you want to change a single line in a file only.
       class Win_lineinfile < Base
         # @return [String] The path of the file to modify.,Note that the Windows path delimiter '\' must be escaped as '\\' (see examples below)
         attribute :dest