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/core/windows/win_msi.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Installs or uninstalls a Windows MSI file that is already located on the target server
       class Win_msi < Base
         # @return [String] File system path to the MSI file to install
         attribute :path

data/lib/ansible/ruby/modules/generated/core/windows/win_ping.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Checks management connectivity of a windows host
       class Win_ping < Base
         # @return [String, nil] Alternate data to return instead of 'pong'
         attribute :data

data/lib/ansible/ruby/modules/generated/core/windows/win_reboot.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Reboot a Windows machine, wait for it to go down, come back up, and respond to commands.
       class Win_reboot < Base
         # @return [Integer, nil] Seconds for shutdown to wait before requesting reboot
         attribute :pre_reboot_delay_sec

data/lib/ansible/ruby/modules/generated/core/windows/win_service.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Manages Windows services
       class Win_service < Base
         # @return [Object] Name of the service
         attribute :name

data/lib/ansible/ruby/modules/generated/core/windows/win_stat.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Returns information about a Windows file
       class Win_stat < Base
         # @return [String] The full path of the file/object to get the facts of; both forward and back slashes are accepted.
         attribute :path

data/lib/ansible/ruby/modules/generated/core/windows/win_template.rb CHANGED

@@ -5,6 +5,8 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Templates are processed by the Jinja2 templating language (U(http://jinja.pocoo.org/docs/)) - documentation on the template formatting can be found in the Template Designer Documentation (U(http://jinja.pocoo.org/docs/templates/)).
+      # Six additional variables can be used in templates: C(ansible_managed) (configurable via the C(defaults) section of C(ansible.cfg)) contains a string which can be used to describe the template name, host, modification time of the template file and the owner uid, C(template_host) contains the node name of the template's machine, C(template_uid) the owner, C(template_path) the absolute path of the template, C(template_fullpath) is the absolute path of the template, and C(template_run_date) is the date that the template was rendered. Note that including a string that uses a date in the template will result in the template being marked 'changed' each time.
       class Win_template < Base
         # @return [String] Path of a Jinja2 formatted template on the local server. This can be a relative or absolute path.
         attribute :src

data/lib/ansible/ruby/modules/generated/core/windows/win_user.rb CHANGED

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

data/lib/ansible/ruby/modules/generated/extras/cloud/amazon/cloudtrail.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Creates or deletes CloudTrail configuration. Ensures logging is also enabled.
       class Cloudtrail < Base
         # @return [:enabled, :disabled] add or remove CloudTrail configuration.
         attribute :state

data/lib/ansible/ruby/modules/generated/extras/cloud/amazon/dynamodb_table.rb CHANGED

@@ -5,6 +5,9 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Create or delete AWS Dynamo DB tables.
+      # Can update the provisioned throughput on existing tables.
+      # Returns the status of the specified table.
       class Dynamodb_table < Base
         # @return [:present, :absent, nil] Create or delete the table
         attribute :state

data/lib/ansible/ruby/modules/generated/extras/cloud/amazon/ec2_ami_copy.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Copies AMI from a source region to a destination region. This module has a dependency on python-boto >= 2.5
       class Ec2_ami_copy < Base
         # @return [String] the source region that AMI should be copied from
         attribute :source_region

data/lib/ansible/ruby/modules/generated/extras/cloud/amazon/ec2_elb_facts.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Gather facts about EC2 Elastic Load Balancers in AWS
       class Ec2_elb_facts < Base
         # @return [Array<String>, String, nil] List of ELB names to gather facts about. Pass this option to gather facts about a set of ELBs, otherwise, all ELBs are returned.
         attribute :names

data/lib/ansible/ruby/modules/generated/extras/cloud/amazon/ec2_eni.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Create and optionally attach an Elastic Network Interface (ENI) to an instance. If an ENI ID is provided, an attempt is made to update the existing ENI. By passing 'None' as the instance_id, an ENI can be detached from an instance.
       class Ec2_eni < Base
         # @return [String, Hash, nil] The ID of the ENI
         attribute :eni_id

data/lib/ansible/ruby/modules/generated/extras/cloud/amazon/ec2_eni_facts.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Gather facts about ec2 ENI interfaces in AWS
       class Ec2_eni_facts < Base
         # @return [Hash, nil] A dict of filters to apply. Each dict item consists of a filter key and a filter value. See U(http://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeNetworkInterfaces.html) for possible filters.
         attribute :filters

data/lib/ansible/ruby/modules/generated/extras/cloud/amazon/ec2_remote_facts.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Gather facts about ec2 instances in AWS
       class Ec2_remote_facts < Base
         # @return [Hash, nil] A dict of filters to apply. Each dict item consists of a filter key and a filter value. See U(http://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances.html) for possible filters.
         attribute :filters

data/lib/ansible/ruby/modules/generated/extras/cloud/amazon/ec2_snapshot_facts.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Gather facts about ec2 volume snapshots in AWS
       class Ec2_snapshot_facts < Base
         # @return [Object, nil] If you specify one or more snapshot IDs, only snapshots that have the specified IDs are returned.
         attribute :snapshot_ids

data/lib/ansible/ruby/modules/generated/extras/cloud/amazon/ec2_vol_facts.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Gather facts about ec2 volumes in AWS
       class Ec2_vol_facts < Base
         # @return [Hash, nil] A dict of filters to apply. Each dict item consists of a filter key and a filter value. See U(http://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeVolumes.html) for possible filters.
         attribute :filters

data/lib/ansible/ruby/modules/generated/extras/cloud/amazon/ec2_vpc_dhcp_options.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # This module removes, or creates DHCP option sets, and can associate them to a VPC. Optionally, a new DHCP Options set can be created that converges a VPC's existing DHCP option set with values provided. When dhcp_options_id is provided, the module will 1. remove (with state='absent') 2. ensure tags are applied (if state='present' and tags are provided 3. attach it to a VPC (if state='present' and a vpc_id is provided. If any of the optional values are missing, they will either be treated as a no-op (i.e., inherit what already exists for the VPC) To remove existing options while inheriting, supply an empty value (e.g. set ntp_servers to [] if you want to remove them from the VPC's options) Most of the options should be self-explanatory.
       class Ec2_vpc_dhcp_options < Base
         # @return [String, nil] The domain name to set in the DHCP option sets
         attribute :domain_name

data/lib/ansible/ruby/modules/generated/extras/cloud/amazon/ec2_vpc_igw.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Manage an AWS VPC Internet gateway
       class Ec2_vpc_igw < Base
         # @return [Object] The VPC ID for the VPC in which to manage the Internet Gateway.
         attribute :vpc_id

data/lib/ansible/ruby/modules/generated/extras/cloud/amazon/ec2_vpc_net_facts.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Gather facts about ec2 VPCs in AWS
       class Ec2_vpc_net_facts < Base
         # @return [Hash, nil] A dict of filters to apply. Each dict item consists of a filter key and a filter value. See U(http://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeVpcs.html) for possible filters.
         attribute :filters

data/lib/ansible/ruby/modules/generated/extras/cloud/amazon/ec2_vpc_route_table.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Manage route tables for AWS virtual private clouds
       class Ec2_vpc_route_table < Base
         # @return [:tag, :id, nil] Look up route table by either tags or by route table ID. Non-unique tag lookup will fail. If no tags are specifed then no lookup for an existing route table is performed and a new route table will be created. To change tags of a route table, you must look up by id.
         attribute :lookup

data/lib/ansible/ruby/modules/generated/extras/cloud/amazon/ec2_vpc_route_table_facts.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Gather facts about ec2 VPC route tables in AWS
       class Ec2_vpc_route_table_facts < Base
         # @return [Hash, nil] A dict of filters to apply. Each dict item consists of a filter key and a filter value. See U(http://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeRouteTables.html) for possible filters.
         attribute :filters

data/lib/ansible/ruby/modules/generated/extras/cloud/amazon/ec2_vpc_subnet.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Manage subnets in AWS virtual private clouds
       class Ec2_vpc_subnet < Base
         # @return [Object, nil] The availability zone for the subnet. Only required when state=present.
         attribute :az

data/lib/ansible/ruby/modules/generated/extras/cloud/amazon/ec2_vpc_subnet_facts.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Gather facts about ec2 VPC subnets in AWS
       class Ec2_vpc_subnet_facts < Base
         # @return [Hash, nil] A dict of filters to apply. Each dict item consists of a filter key and a filter value. See U(http://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeSubnets.html) for possible filters.
         attribute :filters

data/lib/ansible/ruby/modules/generated/extras/cloud/amazon/ec2_win_password.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Gets the default administrator password from any EC2 Windows instance.  The instance is referenced by its id (e.g. i-XXXXXXX). This module has a dependency on python-boto.
       class Ec2_win_password < Base
         # @return [String] The instance id to get the password data from.
         attribute :instance_id

data/lib/ansible/ruby/modules/generated/extras/cloud/amazon/ecs_cluster.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Creates or terminates ecs clusters.
       class Ecs_cluster < Base
         # @return [:present, :absent, :has_instances] The desired state of the cluster
         attribute :state

data/lib/ansible/ruby/modules/generated/extras/cloud/amazon/ecs_service.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Creates or terminates ecs services.
       class Ecs_service < Base
         # @return [:present, :absent, :deleting] The desired state of the service
         attribute :state

data/lib/ansible/ruby/modules/generated/extras/cloud/amazon/ecs_service_facts.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Lists or describes services in ecs.
       class Ecs_service_facts < Base
         # @return [:true, :false, nil] Set this to true if you want detailed information about the services.
         attribute :details

data/lib/ansible/ruby/modules/generated/extras/cloud/amazon/ecs_task.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Creates or deletes instances of task definitions.
       class Ecs_task < Base
         # @return [:run, :start, :stop] Which task operation to execute
         attribute :operation

data/lib/ansible/ruby/modules/generated/extras/cloud/amazon/ecs_taskdefinition.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Creates or terminates task definitions
       class Ecs_taskdefinition < Base
         # @return [:present, :absent] State whether the task definition should exist or be deleted
         attribute :state

data/lib/ansible/ruby/modules/generated/extras/cloud/amazon/route53_facts.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Gets various details related to Route53 zone, record set or health check details
       class Route53_facts < Base
         # @return [:change, :checker_ip_range, :health_check, :hosted_zone, :record_sets, :reusable_delegation_set] specifies the query action to take
         attribute :query

data/lib/ansible/ruby/modules/generated/extras/cloud/amazon/route53_health_check.rb CHANGED

@@ -5,6 +5,8 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Creates and deletes DNS Health checks in Amazons Route53 service
+      # Only the port, resource_path, string_match and request_interval are considered when updating existing health-checks.
       class Route53_health_check < Base
         # @return [:present, :absent] Specifies the action to take.
         attribute :state

data/lib/ansible/ruby/modules/generated/extras/cloud/amazon/route53_zone.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Creates and deletes Route53 private and public zones
       class Route53_zone < Base
         # @return [String] The DNS zone record (eg: foo.com.)
         attribute :zone

data/lib/ansible/ruby/modules/generated/extras/cloud/amazon/s3_bucket.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Manage s3 buckets in AWS
       class S3_bucket < Base
         # @return [Boolean, nil] When trying to delete a bucket, delete all keys in the bucket first (an s3 bucket must be empty for a successful deletion)
         attribute :force

data/lib/ansible/ruby/modules/generated/extras/cloud/amazon/s3_lifecycle.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Manage s3 bucket lifecycle rules in AWS
       class S3_lifecycle < Base
         # @return [String] Name of the s3 bucket
         attribute :name

data/lib/ansible/ruby/modules/generated/extras/cloud/amazon/s3_logging.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Manage logging facility of an s3 bucket in AWS
       class S3_logging < Base
         # @return [String] Name of the s3 bucket.
         attribute :name

data/lib/ansible/ruby/modules/generated/extras/cloud/amazon/sns_topic.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # The M(sns_topic) module allows you to create, delete, and manage subscriptions for AWS SNS topics.
       class Sns_topic < Base
         # @return [String] The name or ARN of the SNS topic to converge
         attribute :name

data/lib/ansible/ruby/modules/generated/extras/cloud/amazon/sqs_queue.rb CHANGED

@@ -5,6 +5,8 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Create or delete AWS SQS queues.
+      # Update attributes on existing queues.
       class Sqs_queue < Base
         # @return [:present, :absent, nil] Create or delete the queue
         attribute :state

data/lib/ansible/ruby/modules/generated/extras/cloud/amazon/sts_assume_role.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Assume a role using AWS Security Token Service and obtain temporary credentials
       class Sts_assume_role < Base
         # @return [Object] The Amazon Resource Name (ARN) of the role that the caller is assuming (http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html#Identifiers_ARNs)
         attribute :role_arn

data/lib/ansible/ruby/modules/generated/extras/cloud/azure/azure_rm_deployment.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Create or destroy Azure Resource Manager template deployments via the Azure SDK for Python. You can find some quick start templates in GitHub here https://github.com/azure/azure-quickstart-templates. For more information on Azue resource manager templates see https://azure.microsoft.com/en-us/documentation/articles/resource-group-template-deploy/.
       class Azure_rm_deployment < Base
         # @return [String] The resource group name to use or create to host the deployed template
         attribute :resource_group_name

data/lib/ansible/ruby/modules/generated/extras/cloud/centurylink/clc_aa_policy.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # An Ansible module to Create or Delete Anti Affinity Policies at CenturyLink Cloud.
       class Clc_aa_policy < Base
         # @return [String] The name of the Anti Affinity Policy.
         attribute :name

data/lib/ansible/ruby/modules/generated/extras/cloud/centurylink/clc_alert_policy.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # An Ansible module to Create or Delete Alert Policies at CenturyLink Cloud.
       class Clc_alert_policy < Base
         # @return [Object] The alias of your CLC Account
         attribute :alias

data/lib/ansible/ruby/modules/generated/extras/cloud/centurylink/clc_blueprint_package.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # An Ansible module to deploy blue print package on a set of servers in CenturyLink Cloud.
       class Clc_blueprint_package < Base
         # @return [Array<String>, String] A list of server Ids to deploy the blue print package.
         attribute :server_ids

data/lib/ansible/ruby/modules/generated/extras/cloud/centurylink/clc_firewall_policy.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Create or delete or update firewall polices on Centurylink Cloud
       class Clc_firewall_policy < Base
         # @return [Object] Target datacenter for the firewall policy
         attribute :location

data/lib/ansible/ruby/modules/generated/extras/cloud/centurylink/clc_group.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Create or delete Server Groups at Centurylink Centurylink Cloud
       class Clc_group < Base
         # @return [String] The name of the Server Group
         attribute :name

data/lib/ansible/ruby/modules/generated/extras/cloud/centurylink/clc_loadbalancer.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # An Ansible module to Create, Delete shared loadbalancers in CenturyLink Cloud.
       class Clc_loadbalancer < Base
         # @return [String] The name of the loadbalancer
         attribute :name

data/lib/ansible/ruby/modules/generated/extras/cloud/centurylink/clc_modify_server.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # An Ansible module to modify servers in CenturyLink Cloud.
       class Clc_modify_server < Base
         # @return [Array<String>, String] A list of server Ids to modify.
         attribute :server_ids

data/lib/ansible/ruby/modules/generated/extras/cloud/centurylink/clc_publicip.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # An Ansible module to add or delete public ip addresses on an existing server or servers in CenturyLink Cloud.
       class Clc_publicip < Base
         # @return [:TCP, :UDP, :ICMP, nil] The protocol that the public IP will listen for.
         attribute :protocol

data/lib/ansible/ruby/modules/generated/extras/cloud/centurylink/clc_server.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # An Ansible module to Create, Delete, Start and Stop servers in CenturyLink Cloud.
       class Clc_server < Base
         # @return [Object, nil] The list of additional disks for the server
         attribute :additional_disks

data/lib/ansible/ruby/modules/generated/extras/cloud/centurylink/clc_server_snapshot.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # An Ansible module to Create, Delete and Restore server snapshots in CenturyLink Cloud.
       class Clc_server_snapshot < Base
         # @return [Array<String>, String] The list of CLC server Ids.
         attribute :server_ids

data/lib/ansible/ruby/modules/generated/extras/cloud/cloudstack/cs_account.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Create, disable, lock, enable and remove accounts.
       class Cs_account < Base
         # @return [Object] Name of account.
         attribute :name