ansible-ruby 1.0.5 → 1.0.6

data/lib/ansible/ruby/modules/generated/core/cloud/openstack/os_subnets_facts.rb

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Retrieve facts about one or more subnets from OpenStack.
       class Os_subnets_facts < Base
         # @return [Object, nil] Name or ID of the subnet
         attribute :subnet

data/lib/ansible/ruby/modules/generated/core/cloud/openstack/os_user.rb

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Manage OpenStack Identity users. Users can be created, updated or deleted using this module. A user will be updated if I(name) matches an existing user and I(state) is present. The value for I(name) cannot be updated without deleting and re-creating the user.
       class Os_user < Base
         # @return [String] Username for the user
         attribute :name

data/lib/ansible/ruby/modules/generated/core/cloud/openstack/os_user_group.rb

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Add and remove users from groups
       class Os_user_group < Base
         # @return [Object] Name or id for the user
         attribute :user

data/lib/ansible/ruby/modules/generated/core/cloud/openstack/os_volume.rb

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Create or Remove cinder block storage volumes
       class Os_volume < Base
         # @return [Object, nil] Size of volume in GB. This parameter is required when the I(state) parameter is 'present'.
         attribute :size

data/lib/ansible/ruby/modules/generated/core/cloud/openstack/quantum_floating_ip.rb

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Add or Remove a floating IP to an instance
       class Quantum_floating_ip < Base
         # @return [String] login username to authenticate to keystone
         attribute :login_username

data/lib/ansible/ruby/modules/generated/core/cloud/openstack/quantum_floating_ip_associate.rb

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Associates or disassociates a specific floating IP with a particular instance
       class Quantum_floating_ip_associate < Base
         # @return [String] login username to authenticate to keystone
         attribute :login_username

data/lib/ansible/ruby/modules/generated/core/cloud/openstack/quantum_network.rb

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Add or Remove network from OpenStack.
       class Quantum_network < Base
         # @return [String] login username to authenticate to keystone
         attribute :login_username

data/lib/ansible/ruby/modules/generated/core/cloud/openstack/quantum_router.rb

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Create or Delete routers from OpenStack
       class Quantum_router < Base
         # @return [String] login username to authenticate to keystone
         attribute :login_username

data/lib/ansible/ruby/modules/generated/core/cloud/openstack/quantum_router_gateway.rb

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Creates/Removes a gateway interface from the router, used to associate a external network with a router to route external traffic.
       class Quantum_router_gateway < Base
         # @return [String] login username to authenticate to keystone
         attribute :login_username

data/lib/ansible/ruby/modules/generated/core/cloud/openstack/quantum_router_interface.rb

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Attach/Dettach a subnet interface to a router, to provide a gateway for the subnet.
       class Quantum_router_interface < Base
         # @return [String] login username to authenticate to keystone
         attribute :login_username

data/lib/ansible/ruby/modules/generated/core/cloud/openstack/quantum_subnet.rb

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Add/remove subnet from a network
       class Quantum_subnet < Base
         # @return [String] login username to authenticate to keystone
         attribute :login_username

data/lib/ansible/ruby/modules/generated/core/cloud/rackspace/rax.rb

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # creates / deletes a Rackspace Public Cloud instance and optionally waits for it to be 'running'.
       class Rax < Base
         # @return [Boolean, nil] Whether or not to increment a single number with the name of the created servers. Only applicable when used with the I(group) attribute or meta key.
         attribute :auto_increment

data/lib/ansible/ruby/modules/generated/core/cloud/rackspace/rax_cbs.rb

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Manipulate Rackspace Cloud Block Storage Volumes
       class Rax_cbs < Base
         # @return [Object, nil] Description to give the volume being created
         attribute :description

data/lib/ansible/ruby/modules/generated/core/cloud/rackspace/rax_cbs_attachments.rb

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Manipulate Rackspace Cloud Block Storage Volume Attachments
       class Rax_cbs_attachments < Base
         # @return [Object] The device path to attach the volume to, e.g. /dev/xvde
         attribute :device

data/lib/ansible/ruby/modules/generated/core/cloud/rackspace/rax_cdb.rb

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # creates / deletes or resize a Rackspace Cloud Databases instance and optionally waits for it to be 'running'. The name option needs to be unique since it's used to identify the instance.
       class Rax_cdb < Base
         # @return [String, nil] Name of the databases server instance
         attribute :name

data/lib/ansible/ruby/modules/generated/core/cloud/rackspace/rax_cdb_database.rb

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # create / delete a database in the Cloud Databases.
       class Rax_cdb_database < Base
         # @return [Object, nil] The databases server UUID
         attribute :cdb_id

data/lib/ansible/ruby/modules/generated/core/cloud/rackspace/rax_cdb_user.rb

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # create / delete a database in the Cloud Databases.
       class Rax_cdb_user < Base
         # @return [Object, nil] The databases server UUID
         attribute :cdb_id

data/lib/ansible/ruby/modules/generated/core/cloud/rackspace/rax_clb.rb

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # creates / deletes a Rackspace Public Cloud load balancer.
       class Rax_clb < Base
         # @return [:RANDOM, :LEAST_CONNECTIONS, :ROUND_ROBIN, :WEIGHTED_LEAST_CONNECTIONS, :WEIGHTED_ROUND_ROBIN, nil] algorithm for the balancer being created
         attribute :algorithm

data/lib/ansible/ruby/modules/generated/core/cloud/rackspace/rax_clb_nodes.rb

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Adds, modifies and removes nodes from a Rackspace Cloud Load Balancer
       class Rax_clb_nodes < Base
         # @return [String, nil] IP address or domain name of the node
         attribute :address

data/lib/ansible/ruby/modules/generated/core/cloud/rackspace/rax_dns.rb

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Manage domains on Rackspace Cloud DNS
       class Rax_dns < Base
         # @return [Object, nil] Brief description of the domain. Maximum length of 160 characters
         attribute :comment

data/lib/ansible/ruby/modules/generated/core/cloud/rackspace/rax_dns_record.rb

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Manage DNS records on Rackspace Cloud DNS
       class Rax_dns_record < Base
         # @return [Object, nil] Brief description of the domain. Maximum length of 160 characters
         attribute :comment

data/lib/ansible/ruby/modules/generated/core/cloud/rackspace/rax_facts.rb

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Gather facts for Rackspace Cloud Servers.
       class Rax_facts < Base
         # @return [Object, nil] Server IP address to retrieve facts for, will match any IP assigned to the server
         attribute :address

data/lib/ansible/ruby/modules/generated/core/cloud/rackspace/rax_files.rb

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Manipulate Rackspace Cloud Files Containers
       class Rax_files < Base
         # @return [:yes, :no, nil] Optionally clear existing metadata when applying metadata to existing containers. Selecting this option is only appropriate when setting type=meta
         attribute :clear_meta

data/lib/ansible/ruby/modules/generated/core/cloud/rackspace/rax_files_objects.rb

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Upload, download, and delete objects in Rackspace Cloud Files
       class Rax_files_objects < Base
         # @return [:yes, :no, nil] Optionally clear existing metadata when applying metadata to existing objects. Selecting this option is only appropriate when setting type=meta
         attribute :clear_meta

data/lib/ansible/ruby/modules/generated/core/cloud/rackspace/rax_identity.rb

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Verifies Rackspace Cloud credentials and returns identity information
       class Rax_identity < Base
         # @return [:present, :absent, nil] Indicate desired state of the resource
         attribute :state

data/lib/ansible/ruby/modules/generated/core/cloud/rackspace/rax_keypair.rb

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Create a keypair for use with Rackspace Cloud Servers
       class Rax_keypair < Base
         # @return [String] Name of keypair
         attribute :name

data/lib/ansible/ruby/modules/generated/core/cloud/rackspace/rax_meta.rb

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Manipulate metadata for Rackspace Cloud Servers
       class Rax_meta < Base
         # @return [Object, nil] Server IP address to modify metadata for, will match any IP assigned to the server
         attribute :address

data/lib/ansible/ruby/modules/generated/core/cloud/rackspace/rax_network.rb

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # creates / deletes a Rackspace Public Cloud isolated network.
       class Rax_network < Base
         # @return [:present, :absent, nil] Indicate desired state of the resource
         attribute :state

data/lib/ansible/ruby/modules/generated/core/cloud/rackspace/rax_queue.rb

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # creates / deletes a Rackspace Public Cloud queue.
       class Rax_queue < Base
         # @return [String, nil] Name to give the queue
         attribute :name

data/lib/ansible/ruby/modules/generated/core/cloud/rackspace/rax_scaling_group.rb

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Manipulate Rackspace Cloud Autoscale Groups
       class Rax_scaling_group < Base
         # @return [Boolean, nil] Attach read-only configuration drive to server as label config-2
         attribute :config_drive

data/lib/ansible/ruby/modules/generated/core/cloud/rackspace/rax_scaling_policy.rb

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Manipulate Rackspace Cloud Autoscale Scaling Policy
       class Rax_scaling_policy < Base
         # @return [Object, nil] The UTC time when this policy will be executed. The time must be formatted according to C(yyyy-MM-dd'T'HH:mm:ss.SSS) such as C(2013-05-19T08:07:08Z)
         attribute :at

data/lib/ansible/ruby/modules/generated/core/cloud/vmware/vsphere_guest.rb

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Create/delete/reconfigure a guest VM through VMware vSphere. This module has a dependency on pysphere >= 1.7
       class Vsphere_guest < Base
         # @return [String] The hostname of the vcenter server the module will connect to, to create the guest.
         attribute :vcenter_hostname

data/lib/ansible/ruby/modules/generated/core/commands/command.rb

@@ -5,6 +5,8 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # The M(command) module takes the command name followed by a list of space-delimited arguments.
+      # The given command will be executed on all selected nodes. It will not be processed through the shell, so variables like C($HOME) and operations like C("<"), C(">"), C("|"), and C("&") will not work (use the M(shell) module if you need these features).
       class Command < Base
         # @return [Object] the command module takes a free form command to run.  There is no parameter actually named 'free form'. See the examples!
         attribute :free_form

data/lib/ansible/ruby/modules/generated/core/commands/raw.rb

@@ -5,6 +5,8 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Executes a low-down and dirty SSH command, not going through the module subsystem. This is useful and should only be done in two cases. The first case is installing C(python-simplejson) on older (Python 2.4 and before) hosts that need it as a dependency to run modules, since nearly all core modules require it. Another is speaking to any devices such as routers that do not have any Python installed. In any other case, using the M(shell) or M(command) module is much more appropriate. Arguments given to M(raw) are run directly through the configured remote shell. Standard output, error output and return code are returned when available. There is no change handler support for this module.
+      # This module does not require python on the remote system, much like the M(script) module.
       class Raw < Base
         # @return [Object] the raw module takes a free form command to run
         attribute :free_form

data/lib/ansible/ruby/modules/generated/core/commands/script.rb

@@ -5,6 +5,10 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # The M(script) module takes the script name followed by a list of space-delimited arguments. 
+      # The local script at path will be transferred to the remote node and then executed. 
+      # The given script will be processed through the shell environment on the remote node. 
+      # This module does not require python on the remote system, much like the M(raw) module. 
       class Script < Base
         # @return [Object] path to the local script file followed by optional arguments.
         attribute :free_form

data/lib/ansible/ruby/modules/generated/core/commands/shell.rb

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # The M(shell) module takes the command name followed by a list of space-delimited arguments. It is almost exactly like the M(command) module but runs the command through a shell (C(/bin/sh)) on the remote node.
       class Shell < Base
         # @return [Object] The shell module takes a free form command to run, as a string.  There's not an actual option named "free form".  See the examples!
         attribute :free_form

data/lib/ansible/ruby/modules/generated/core/database/mysql/mysql_db.rb

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Add or remove MySQL databases from a remote host.
       class Mysql_db < Base
         # @return [String] name of the database to add or remove,name=all May only be provided if I(state) is C(dump) or C(import).,if name=all Works like --all-databases option for mysqldump (Added in 2.0)
         attribute :name

data/lib/ansible/ruby/modules/generated/core/database/mysql/mysql_user.rb

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Adds or removes a user from a MySQL database.
       class Mysql_user < Base
         # @return [String] name of the user (role) to add or remove
         attribute :name

data/lib/ansible/ruby/modules/generated/core/database/mysql/mysql_variables.rb

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Query / Set MySQL variables
       class Mysql_variables < Base
         # @return [String] Variable name to operate
         attribute :variable

data/lib/ansible/ruby/modules/generated/core/database/postgresql/postgresql_db.rb

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Add or remove PostgreSQL databases from a remote host.
       class Postgresql_db < Base
         # @return [String] name of the database to add or remove
         attribute :name

data/lib/ansible/ruby/modules/generated/core/database/postgresql/postgresql_privs.rb

@@ -5,6 +5,8 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Grant or revoke privileges on PostgreSQL database objects.
+      # This module is basically a wrapper around most of the functionality of PostgreSQL's GRANT and REVOKE statements with detection of changes (GRANT/REVOKE I(privs) ON I(type) I(objs) TO/FROM I(roles))
       class Postgresql_privs < Base
         # @return [String] Name of database to connect to.,Alias: I(db)
         attribute :database

data/lib/ansible/ruby/modules/generated/core/database/postgresql/postgresql_user.rb

@@ -5,6 +5,9 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Add or remove PostgreSQL users (roles) from a remote host and, optionally, grant the users access to an existing database or tables.
+      # The fundamental function of the module is to create, or delete, roles from a PostgreSQL cluster. Privilege assignment, or removal, is an optional step, which works on one database at a time. This allows for the module to be called several times in the same module to modify the permissions on different databases, or to grant permissions to already existing users.
+      # A user cannot be removed until all the privileges have been stripped from the user. In such situation, if the module tries to remove the user it will fail. To avoid this from happening the fail_on_user option signals the module to try to remove the user, but if not possible keep going; the module will report if changes happened and separately if the user was removed or not.
       class Postgresql_user < Base
         # @return [String] name of the user (role) to add or remove
         attribute :name

data/lib/ansible/ruby/modules/generated/core/files/acl.rb

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Sets and retrieves file ACL information.
       class Acl < Base
         # @return [String] The full path of the file or object.
         attribute :name

data/lib/ansible/ruby/modules/generated/core/files/assemble.rb

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Assembles a configuration file from fragments. Often a particular program will take a single configuration file and does not support a C(conf.d) style structure where it is easy to build up the configuration from multiple sources. M(assemble) will take a directory of files that can be local or have already been transferred to the system, and concatenate them together to produce a destination file. Files are assembled in string sorting order. Puppet calls this idea I(fragments).
       class Assemble < Base
         # @return [String] An already existing directory full of source files.
         attribute :src

data/lib/ansible/ruby/modules/generated/core/files/copy.rb

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # The M(copy) module copies a file on the local box to remote locations. Use the M(fetch) module to copy files from remote locations to the local box. If you need variable interpolation in copied files, use the M(template) module.
       class 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/files/fetch.rb

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # This module works like M(copy), but in reverse. It is used for fetching files from remote machines and storing them locally in a file tree, organized by hostname. Note that this module is written to transfer log files that might not be present, so a missing remote file won't be an error unless fail_on_missing is set to 'yes'.
       class Fetch < Base
         # @return [String] The file on the remote system to fetch. This I(must) be a file, not a directory. Recursive fetching may be supported in a later release.
         attribute :src

data/lib/ansible/ruby/modules/generated/core/files/file.rb

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Sets attributes of files, symlinks, and directories, or removes files/symlinks/directories. Many other modules support the same options as the M(file) module - including M(copy), M(template), and M(assemble).
       class File < Base
         # @return [Object] path to the file being managed.  Aliases: I(dest), I(name)
         attribute :path

data/lib/ansible/ruby/modules/generated/core/files/find.rb

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Return a list files based on specific criteria. Multiple criteria are AND'd together.
       class Find < Base
         # @return [String, nil] Select files whose age is equal to or greater than the specified time. Use a negative age to find files equal to or less than the specified time. You can choose seconds, minutes, hours, days, or weeks by specifying the first letter of any of those words (e.g., "1w").
         attribute :age

data/lib/ansible/ruby/modules/generated/core/files/ini_file.rb

@@ -5,6 +5,8 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Manage (add, remove, change) individual settings in an INI-style file without having to manage the file as a whole with, say, M(template) or M(assemble). Adds missing sections if they don't exist.
+      # Before version 2.0, comments are discarded when the source file is read, and therefore will not show up in the destination file.
       class Ini_file < Base
         # @return [String] Path to the INI-style file; this file is created if required
         attribute :dest

data/lib/ansible/ruby/modules/generated/core/files/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. See the M(replace) module if you want to change multiple, similar lines; for other cases, see the M(copy) or M(template) modules.
       class Lineinfile < Base
         # @return [String] The file to modify.
         attribute :dest