ansible-ruby 1.0.5 → 1.0.6

data/lib/ansible/ruby/modules/generated/core/cloud/azure/azure_rm_securitygroup.rb

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Create, update or delete a network security group. A security group contains Access Control List (ACL) rules that allow or deny network traffic to subnets or individual network interfaces. A security group is created with a set of default security rules and an empty set of security rules. Shape traffic flow by adding rules to the empty set of security rules.
       class Azure_rm_securitygroup < Base
         # @return [Object, nil] The set of default rules automatically added to a security group at creation. In general default rules will not be modified. Modify rules to shape the flow of traffic to or from a subnet or NIC. See rules below for the makeup of a rule dict.
         attribute :default_rules

data/lib/ansible/ruby/modules/generated/core/cloud/azure/azure_rm_securitygroup_facts.rb

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Get facts for a specific security group or all security groups within a resource group.
       class Azure_rm_securitygroup_facts < Base
         # @return [String, nil] Only show results for a specific security group.
         attribute :name

data/lib/ansible/ruby/modules/generated/core/cloud/azure/azure_rm_storageaccount.rb

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Create, update or delete a storage account.
       class Azure_rm_storageaccount < Base
         # @return [String] Name of the resource group to use.
         attribute :resource_group

data/lib/ansible/ruby/modules/generated/core/cloud/azure/azure_rm_storageaccount_facts.rb

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Get facts for one storage account or all storage accounts within a resource group.
       class Azure_rm_storageaccount_facts < Base
         # @return [String, nil] Only show results for a specific account.
         attribute :name

data/lib/ansible/ruby/modules/generated/core/cloud/azure/azure_rm_storageblob.rb

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Create, update and delete blob containers and blob objects. Use to upload a file and store it as a blob object, or download a blob object to a file.
       class Azure_rm_storageblob < Base
         # @return [String] Name of the storage account to use.
         attribute :storage_account_name

data/lib/ansible/ruby/modules/generated/core/cloud/azure/azure_rm_subnet.rb

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Create, update or delete a subnet within a given virtual network. Allows setting and updating the address prefix CIDR, which must be valid within the context of the virtual network. Use the azure_rm_networkinterface module to associate interfaces with the subnet and assign specific IP addresses.
       class Azure_rm_subnet < Base
         # @return [String] Name of resource group.
         attribute :resource_group

data/lib/ansible/ruby/modules/generated/core/cloud/azure/azure_rm_virtualmachine.rb

@@ -5,6 +5,8 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Create, update, stop and start a virtual machine. Provide an existing storage account and network interface or allow the module to create these for you. If you choose not to provide a network interface, the resource group must contain a virtual network with at least one subnet.
+      # Currently requires an image found in the Azure Marketplace. Use azure_rm_virtualmachineimage_facts module to discover the publisher, offer, sku and version of a particular image.
       class Azure_rm_virtualmachine < Base
         # @return [String, NilClass] Name of the resource group containing the virtual machine.
         attribute :resource_group

data/lib/ansible/ruby/modules/generated/core/cloud/azure/azure_rm_virtualmachineimage_facts.rb

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Get facts for virtual machine images.
       class Azure_rm_virtualmachineimage_facts < Base
         # @return [Object, nil] Only show results for a specific security group.
         attribute :name

data/lib/ansible/ruby/modules/generated/core/cloud/azure/azure_rm_virtualnetwork.rb

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Create, update or delete a virtual networks. Allows setting and updating the available IPv4 address ranges and setting custom DNS servers. Use the azure_rm_subnet module to associate subnets with a virtual network.
       class Azure_rm_virtualnetwork < Base
         # @return [String] name of resource group.
         attribute :resource_group

data/lib/ansible/ruby/modules/generated/core/cloud/azure/azure_rm_virtualnetwork_facts.rb

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Get facts for a specific virtual network or all virtual networks within a resource group.
       class Azure_rm_virtualnetwork_facts < Base
         # @return [String, nil] Only show results for a specific security group.
         attribute :name

data/lib/ansible/ruby/modules/generated/core/cloud/digital_ocean/digital_ocean.rb

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Create/delete a droplet in DigitalOcean and optionally wait for it to be 'running', or deploy an SSH key.
       class Digital_ocean < Base
         # @return [:droplet, :ssh, nil] Which target you want to operate on.
         attribute :command

data/lib/ansible/ruby/modules/generated/core/cloud/digital_ocean/digital_ocean_domain.rb

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Create/delete a DNS record in DigitalOcean.
       class Digital_ocean_domain < Base
         # @return [:present, :absent, nil] Indicate desired state of the target.
         attribute :state

data/lib/ansible/ruby/modules/generated/core/cloud/digital_ocean/digital_ocean_sshkey.rb

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Create/delete an SSH key.
       class Digital_ocean_sshkey < Base
         # @return [:present, :absent, nil] Indicate desired state of the target.
         attribute :state

data/lib/ansible/ruby/modules/generated/core/cloud/docker/docker.rb

@@ -5,6 +5,8 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # This is the original Ansible module for managing the Docker container life cycle.
+      # NOTE: Additional and newer modules are available. For the latest on orchestrating containers with Ansible visit our Getting Started with Docker Guide at https://github.com/ansible/ansible/blob/devel/docsite/rst/guide_docker.rst.
       class Docker < Base
         # @return [Integer, nil] Number of matching containers that should be in the desired state.
         attribute :count

data/lib/ansible/ruby/modules/generated/core/cloud/docker/docker_container.rb

@@ -5,6 +5,8 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Manage the life cycle of docker containers.
+      # Supports check mode. Run with --check and --diff to view config difference and list of actions to be taken.
       class Docker_container < Base
         # @return [Object, nil] Block IO (relative weight), between 10 and 1000.
         attribute :blkio_weight

data/lib/ansible/ruby/modules/generated/core/cloud/docker/docker_image.rb

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Build, load or pull an image, making the image available for creating containers. Also supports tagging an image into a repository and archiving an image to a .tar file.
       class Docker_image < Base
         # @return [String, nil] Use with state 'present' to archive an image to a .tar file.
         attribute :archive_path

data/lib/ansible/ruby/modules/generated/core/cloud/docker/docker_image_facts.rb

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Provide one or more image names, and the module will inspect each, returning an array of inspection results.
       class Docker_image_facts < Base
         # @return [Array<String>, String] An image name or a list of image names. Name format will be name[:tag] or repository/name[:tag], where tag is optional. If a tag is not provided, 'latest' will be used.
         attribute :name

data/lib/ansible/ruby/modules/generated/core/cloud/docker/docker_login.rb

@@ -5,6 +5,9 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Provides functionality similar to the "docker login" command.
+      # Authenticate with a docker registry and add the credentials to your local Docker config file. Adding the credentials to the config files allows future connections to the registry using tools such as Ansible's Docker modules, the Docker CLI and docker-py without needing to provide credentials.
+      # Running in check mode will perform the authentication without updating the config file.
       class Docker_login < Base
         # @return [String, nil] The registry URL.
         attribute :registry_url

data/lib/ansible/ruby/modules/generated/core/cloud/docker/docker_service.rb

@@ -5,6 +5,11 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Consumes docker compose to start, shutdown and scale services.
+      # Works with compose versions 1 and 2.
+      # Compose can be read from a docker-compose.yml (or .yaml) file or inline using the C(definition) option.
+      # See the examples for more details.
+      # Supports check mode.
       class Docker_service < Base
         # @return [Object, nil] Path to a directory containing a docker-compose.yml or docker-compose.yaml file.,Mutually exclusive with C(definition).,Required when no C(definition) is provided.
         attribute :project_src

data/lib/ansible/ruby/modules/generated/core/cloud/google/gc_storage.rb

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # This module allows users to manage their objects/buckets in Google Cloud Storage.  It allows upload and download operations and can set some canned permissions. It also allows retrieval of URLs for objects for use in playbooks, and retrieval of string contents of objects.  This module requires setting the default project in GCS prior to playbook usage.  See U(https://developers.google.com/storage/docs/reference/v1/apiversion1) for information about setting the default project.
       class Gc_storage < Base
         # @return [String] Bucket name.
         attribute :bucket

data/lib/ansible/ruby/modules/generated/core/cloud/google/gce.rb

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Creates or terminates Google Compute Engine (GCE) instances.  See U(https://cloud.google.com/products/compute-engine) for an overview. Full install/configuration instructions for the gce* modules can be found in the comments of ansible/test/gce_tests.py.
       class Gce < Base
         # @return [String, nil] image string to use for the instance
         attribute :image

data/lib/ansible/ruby/modules/generated/core/cloud/google/gce_lb.rb

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # This module can create and destroy Google Compute Engine C(loadbalancer) and C(httphealthcheck) resources.  The primary LB resource is the C(load_balancer) resource and the health check parameters are all prefixed with I(httphealthcheck). The full documentation for Google Compute Engine load balancing is at U(https://developers.google.com/compute/docs/load-balancing/).  However, the ansible module simplifies the configuration by following the libcloud model. Full install/configuration instructions for the gce* modules can be found in the comments of ansible/test/gce_tests.py.
       class Gce_lb < Base
         # @return [String, nil] the name identifier for the HTTP health check
         attribute :httphealthcheck_name

data/lib/ansible/ruby/modules/generated/core/cloud/google/gce_net.rb

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # This module can create and destroy Google Compute Engine networks and firewall rules U(https://developers.google.com/compute/docs/networking). The I(name) parameter is reserved for referencing a network while the I(fwname) parameter is used to reference firewall rules. IPv4 Address ranges must be specified using the CIDR U(http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) format. Full install/configuration instructions for the gce* modules can be found in the comments of ansible/test/gce_tests.py.
       class Gce_net < Base
         # @return [Array<String>, String, nil] the protocol:ports to allow ('tcp:80' or 'tcp:80,443' or 'tcp:80-800;udp:1-25')
         attribute :allowed

data/lib/ansible/ruby/modules/generated/core/cloud/google/gce_pd.rb

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # This module can create and destroy unformatted GCE persistent disks U(https://developers.google.com/compute/docs/disks#persistentdisks). It also supports attaching and detaching disks from running instances. Full install/configuration instructions for the gce* modules can be found in the comments of ansible/test/gce_tests.py.
       class Gce_pd < Base
         # @return [:yes, :no, nil] do not destroy the disk, merely detach it from an instance
         attribute :detach_only

data/lib/ansible/ruby/modules/generated/core/cloud/linode/linode.rb

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # creates / deletes a Linode Public Cloud instance and optionally waits for it to be 'running'.
       class Linode < Base
         # @return [:present, :active, :started, :absent, :deleted, :stopped, :restarted, nil] Indicate desired state of the resource
         attribute :state

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

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

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

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Manage users,tenants, roles from OpenStack.
       class Keystone_user < Base
         # @return [String, nil] login username to authenticate to keystone
         attribute :login_user

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

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

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

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

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

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Retrieve an auth token from an OpenStack Cloud
       class Os_auth < Base
 
       end

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

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Get I(openstack) client config data from clouds.yaml or environment
       class Os_client_config < Base
         # @return [Object, nil] List of clouds to limit the return list to. No value means return information on all configured clouds
         attribute :clouds

data/lib/ansible/ruby/modules/generated/core/cloud/openstack/os_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 Os_floating_ip < Base
         # @return [String] The name or ID of the instance to which the IP address should be assigned.
         attribute :server

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

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Add or Remove images from the OpenStack Image Repository
       class Os_image < Base
         # @return [String] Name that has to be given to the image
         attribute :name

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

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Retrieve facts about a image image from OpenStack.
       class Os_image_facts < Base
         # @return [String] Name or ID of the image
         attribute :image

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

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Create or Remove Ironic nodes from OpenStack.
       class Os_ironic < Base
         # @return [:present, :absent, nil] Indicates desired state of the resource
         attribute :state

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

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Deploy to nodes controlled by Ironic.
       class Os_ironic_node < Base
         # @return [:present, :absent, nil] Indicates desired state of the resource
         attribute :state

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

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Add or Remove key pair from OpenStack
       class Os_keypair < Base
         # @return [String] Name that has to be given to the key pair
         attribute :name

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

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Add or remove network from OpenStack.
       class Os_network < Base
         # @return [String] Name to be assigned to the network.
         attribute :name

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

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

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

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Add or remove flavors from OpenStack.
       class Os_nova_flavor < Base
         # @return [:present, :absent, nil] Indicate desired state of the resource. When I(state) is 'present', then I(ram), I(vcpus), and I(disk) are all required. There are no default values for those parameters.
         attribute :state

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

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Create or Delete objects and containers from OpenStack
       class Os_object < Base
         # @return [String] The name of the container in which to create the object
         attribute :container

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

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Add, Update or Remove ports from an OpenStack cloud. A I(state) of 'present' will ensure the port is created or updated if required.
       class Os_port < Base
         # @return [String] Network ID or name this port belongs to.
         attribute :network

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

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Create or Delete routers from OpenStack. Although Neutron allows routers to share the same name, this module enforces name uniqueness to be more user friendly.
       class Os_router < Base
         # @return [:present, :absent, nil] Indicate desired state of the resource
         attribute :state

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

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Add or Remove security groups from an OpenStack cloud.
       class Os_security_group < Base
         # @return [String] Name that has to be given to the security group. This module requires that security group names be unique.
         attribute :name

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

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Add or Remove rule from an existing security group
       class Os_security_group_rule < Base
         # @return [String] Name or ID of the security group
         attribute :security_group

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

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Create or Remove compute instances from OpenStack.
       class Os_server < Base
         # @return [String] Name that has to be given to the instance
         attribute :name

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

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Perform server actions on an existing compute instance from OpenStack. This module does not return any data other than changed true/false.
       class Os_server_actions < Base
         # @return [String] Name or ID of the instance
         attribute :server

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

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Retrieve facts about server instances from OpenStack.
       class Os_server_facts < Base
         # @return [String, nil] restrict results to servers with names matching this glob expression (e.g., C<web*>).
         attribute :server

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

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Attach or Detach volumes from OpenStack VM's
       class Os_server_volume < Base
         # @return [:present, :absent, nil] Should the resource be present or absent.
         attribute :state

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

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Add or Remove a subnet to an OpenStack network
       class Os_subnet < Base
         # @return [:present, :absent, nil] Indicate desired state of the resource
         attribute :state