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

ansible-ruby 1.0.5 → 1.0.6

Files changed (591) hide show

data/lib/ansible/ruby/modules/generated/extras/database/misc/riak.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # This module can be used to join nodes to a cluster, check the status of the cluster.
       class Riak < Base
         # @return [:ping, :kv_test, :join, :plan, :commit, nil] The command you would like to perform against the cluster.
         attribute :command

data/lib/ansible/ruby/modules/generated/extras/database/mysql/mysql_replication.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Manages MySQL server replication, slave, master status get and change master host.
       class Mysql_replication < Base
         # @return [:getslave, :getmaster, :changemaster, :stopslave, :startslave, :resetslave, :resetslaveall, nil] module operating mode. Could be getslave (SHOW SLAVE STATUS), getmaster (SHOW MASTER STATUS), changemaster (CHANGE MASTER TO), startslave (START SLAVE), stopslave (STOP SLAVE), resetslave (RESET SLAVE), resetslaveall (RESET SLAVE ALL)
         attribute :mode

data/lib/ansible/ruby/modules/generated/extras/database/postgresql/postgresql_ext.rb CHANGED

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

data/lib/ansible/ruby/modules/generated/extras/database/postgresql/postgresql_lang.rb CHANGED

@@ -5,6 +5,10 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Adds, removes or changes procedural languages with a PostgreSQL database.
+      # This module allows you to add a language, remote a language or change the trust relationship with a PostgreSQL database. The module can be used on the machine where executed or on a remote host.
+      # When removing a language from a database, it is possible that dependencies prevent the database from being removed. In that case, you can specify casade to automatically drop objects that depend on the language (such as functions in the language). In case the language can't be deleted because it is required by the database system, you can specify fail_on_drop=no to ignore the error.
+      # Be carefull when marking a language as trusted since this could be a potential security breach. Untrusted languages allow only users with the PostgreSQL superuser privilege to use this language to create new functions.
       class Postgresql_lang < Base
         # @return [String] name of the procedural language to add, remove or change
         attribute :lang

data/lib/ansible/ruby/modules/generated/extras/database/vertica/vertica_configuration.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Updates Vertica configuration parameters.
       class Vertica_configuration < Base
         # @return [String] Name of the parameter to update.
         attribute :name

data/lib/ansible/ruby/modules/generated/extras/database/vertica/vertica_facts.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Gathers Vertica database facts.
       class Vertica_facts < Base
         # @return [String, nil] Name of the cluster running the schema.
         attribute :cluster

data/lib/ansible/ruby/modules/generated/extras/database/vertica/vertica_role.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Adds or removes Vertica database role and, optionally, assign other roles.
       class Vertica_role < Base
         # @return [String] Name of the role to add or remove.
         attribute :name

data/lib/ansible/ruby/modules/generated/extras/database/vertica/vertica_schema.rb CHANGED

@@ -5,6 +5,9 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Adds or removes Vertica database schema and, optionally, roles with schema access privileges.
+      # A schema will not be removed until all the objects have been dropped.
+      # In such a situation, if the module tries to remove the schema it will fail and only remove roles created for the schema if they have no dependencies.
       class Vertica_schema < Base
         # @return [String] Name of the schema to add or remove.
         attribute :name

data/lib/ansible/ruby/modules/generated/extras/database/vertica/vertica_user.rb CHANGED

@@ -5,6 +5,9 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Adds or removes Vertica database user and, optionally, assigns roles.
+      # A user will not be removed until all the dependencies have been dropped.
+      # In such a situation, if the module tries to remove the user it will fail and only remove roles granted to the user.
       class Vertica_user < Base
         # @return [String] Name of the user to add or remove.
         attribute :name

data/lib/ansible/ruby/modules/generated/extras/files/blockinfile.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # This module will insert/update/remove a block of multi-line text surrounded by customizable marker lines.
       class Blockinfile < Base
         # @return [String] The file to modify.
         attribute :dest

data/lib/ansible/ruby/modules/generated/extras/files/patch.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Apply patch files using the GNU patch tool.
       class Patch < Base
         # @return [String, nil] Path of a base directory in which the patch file will be applied. May be ommitted when C(dest) option is specified, otherwise required.
         attribute :basedir

data/lib/ansible/ruby/modules/generated/extras/messaging/rabbitmq_binding.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # This module uses rabbitMQ Rest API to create/delete bindings
       class Rabbitmq_binding < Base
         # @return [:present, :absent, nil] Whether the exchange should be present or absent,Only present implemented atm
         attribute :state

data/lib/ansible/ruby/modules/generated/extras/messaging/rabbitmq_exchange.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # This module uses rabbitMQ Rest API to create/delete exchanges
       class Rabbitmq_exchange < Base
         # @return [String] Name of the exchange to create
         attribute :name

data/lib/ansible/ruby/modules/generated/extras/messaging/rabbitmq_parameter.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Manage dynamic, cluster-wide parameters for RabbitMQ
       class Rabbitmq_parameter < Base
         # @return [String] Name of the component of which the parameter is being set
         attribute :component

data/lib/ansible/ruby/modules/generated/extras/messaging/rabbitmq_plugin.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Enables or disables RabbitMQ plugins
       class Rabbitmq_plugin < Base
         # @return [String] Comma-separated list of plugin names
         attribute :names

data/lib/ansible/ruby/modules/generated/extras/messaging/rabbitmq_policy.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Manage the state of a virtual host in RabbitMQ.
       class Rabbitmq_policy < Base
         # @return [String] The name of the policy to manage.
         attribute :name

data/lib/ansible/ruby/modules/generated/extras/messaging/rabbitmq_queue.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # This module uses rabbitMQ Rest API to create/delete queues
       class Rabbitmq_queue < Base
         # @return [String] Name of the queue to create
         attribute :name

data/lib/ansible/ruby/modules/generated/extras/messaging/rabbitmq_user.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Add or remove users to RabbitMQ and assign permissions
       class Rabbitmq_user < Base
         # @return [String] Name of user to add
         attribute :user

data/lib/ansible/ruby/modules/generated/extras/messaging/rabbitmq_vhost.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Manage the state of a virtual host in RabbitMQ
       class Rabbitmq_vhost < Base
         # @return [String] The name of the vhost to manage
         attribute :name

data/lib/ansible/ruby/modules/generated/extras/monitoring/airbrake_deployment.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Notify airbrake about app deployments (see http://help.airbrake.io/kb/api-2/deploy-tracking)
       class Airbrake_deployment < Base
         # @return [String] API token.
         attribute :token

data/lib/ansible/ruby/modules/generated/extras/monitoring/bigpanda.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Notify BigPanda when deployments start and end (successfully or not). Returns a deployment object containing all the parameters for future module calls.
       class Bigpanda < Base
         # @return [String] The name of the component being deployed. Ex: billing
         attribute :component

data/lib/ansible/ruby/modules/generated/extras/monitoring/boundary_meter.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # This module manages boundary meters
       class Boundary_meter < Base
         # @return [String] meter name
         attribute :name

data/lib/ansible/ruby/modules/generated/extras/monitoring/circonus_annotation.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Create an annotation event with a given category, title and description. Optionally start, end or durations can be provided
       class Circonus_annotation < Base
         # @return [String] Circonus API key
         attribute :api_key

data/lib/ansible/ruby/modules/generated/extras/monitoring/datadog_event.rb CHANGED

@@ -5,6 +5,8 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Allows to post events to DataDog (www.datadoghq.com) service.
+      # Uses http://docs.datadoghq.com/api/#events API.
       class Datadog_event < Base
         # @return [Object] Your DataDog API key.
         attribute :api_key

data/lib/ansible/ruby/modules/generated/extras/monitoring/datadog_monitor.rb CHANGED

@@ -5,6 +5,8 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Manages monitors within Datadog
+      # Options like described on http://docs.datadoghq.com/api/
       class Datadog_monitor < Base
         # @return [Object] Your DataDog API key.
         attribute :api_key

data/lib/ansible/ruby/modules/generated/extras/monitoring/librato_annotation.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Create an annotation event on the given annotation stream :name. If the annotation stream does not exist, it will be created automatically
       class Librato_annotation < Base
         # @return [String] Librato account username
         attribute :user

data/lib/ansible/ruby/modules/generated/extras/monitoring/logentries.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Sends logs to LogEntries in realtime
       class Logentries < Base
         # @return [String] path to a log file
         attribute :path

data/lib/ansible/ruby/modules/generated/extras/monitoring/monit.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Manage the state of a program monitored via I(Monit)
       class Monit < Base
         # @return [String] The name of the I(monit) program/process to manage
         attribute :name

data/lib/ansible/ruby/modules/generated/extras/monitoring/nagios.rb CHANGED

@@ -5,6 +5,11 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # The M(nagios) module has two basic functions: scheduling downtime and toggling alerts for services or hosts.
+      # All actions require the I(host) parameter to be given explicitly. In playbooks you can use the C({{inventory_hostname}}) variable to refer to the host the playbook is currently running on.
+      # You can specify multiple services at once by separating them with commas, .e.g., C(services=httpd,nfs,puppet).
+      # When specifying what service to handle there is a special service value, I(host), which will handle alerts/downtime for the I(host itself), e.g., C(service=host). This keyword may not be given with other services at the same time. I(Setting alerts/downtime for a host does not affect alerts/downtime for any of the services running on it.) To schedule downtime for all services on particular host use keyword "all", e.g., C(service=all).
+      # When using the M(nagios) module you will need to specify your Nagios server using the C(delegate_to) parameter.
       class Nagios < Base
         # @return [:downtime, :enable_alerts, :disable_alerts, :silence, :unsilence, :silence_nagios, :unsilence_nagios, :command, :servicegroup_service_downtime, :servicegroup_host_downtime] Action to take.,servicegroup options were added in 2.0.
         attribute :action

data/lib/ansible/ruby/modules/generated/extras/monitoring/newrelic_deployment.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Notify newrelic about app deployments (see https://docs.newrelic.com/docs/apm/new-relic-apm/maintenance/deployment-notifications#api)
       class Newrelic_deployment < Base
         # @return [String] API token, to place in the x-api-key header.
         attribute :token

data/lib/ansible/ruby/modules/generated/extras/monitoring/pagerduty.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # This module will let you create PagerDuty maintenance windows
       class Pagerduty < Base
         # @return [:running, :started, :ongoing, :absent] Create a maintenance window or get a list of ongoing windows.
         attribute :state

data/lib/ansible/ruby/modules/generated/extras/monitoring/pagerduty_alert.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # This module will let you trigger, acknowledge or resolve a PagerDuty incident by sending events
       class Pagerduty_alert < Base
         # @return [String] PagerDuty unique subdomain.
         attribute :name

data/lib/ansible/ruby/modules/generated/extras/monitoring/pingdom.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # This module will let you pause/unpause Pingdom alerts
       class Pingdom < Base
         # @return [:running, :paused] Define whether or not the check should be running or paused.
         attribute :state

data/lib/ansible/ruby/modules/generated/extras/monitoring/rollbar_deployment.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Notify Rollbar about app deployments (see https://rollbar.com/docs/deploys_other/)
       class Rollbar_deployment < Base
         # @return [String] Your project access token.
         attribute :token

data/lib/ansible/ruby/modules/generated/extras/monitoring/sensu_check.rb CHANGED

@@ -5,6 +5,10 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Manage the checks that should be run on a machine by I(Sensu).
+      # Most options do not have a default and will not be added to the check definition unless specified.
+      # All defaults except I(path), I(state), I(backup) and I(metric) are not managed by this module,
+      # they are simply specified for your convenience.
       class Sensu_check < Base
         # @return [String] The name of the check,This is the key that is used to determine whether a check exists
         attribute :name

data/lib/ansible/ruby/modules/generated/extras/monitoring/stackdriver.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Send code deploy and annotation events to Stackdriver
       class Stackdriver < Base
         # @return [String] API key.
         attribute :key

data/lib/ansible/ruby/modules/generated/extras/monitoring/uptimerobot.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # This module will let you start and pause Uptime Robot Monitoring
       class Uptimerobot < Base
         # @return [:started, :paused] Define whether or not the monitor should be running or paused.
         attribute :state

data/lib/ansible/ruby/modules/generated/extras/monitoring/zabbix_group.rb CHANGED

@@ -5,6 +5,8 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Create host groups if they do not exist.
+      # Delete existing host groups if they exist.
       class Zabbix_group < Base
         # @return [String] Url of Zabbix server, with protocol (http or https). C(url) is an alias for C(server_url).
         attribute :server_url

data/lib/ansible/ruby/modules/generated/extras/monitoring/zabbix_host.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # This module allows you to create, modify and delete Zabbix host entries and associated group and template data.
       class Zabbix_host < Base
         # @return [String] Url of Zabbix server, with protocol (http or https).
         attribute :server_url

data/lib/ansible/ruby/modules/generated/extras/monitoring/zabbix_hostmacro.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # manages Zabbix host macros, it can create, update or delete them.
       class Zabbix_hostmacro < Base
         # @return [String] Url of Zabbix server, with protocol (http or https).
         attribute :server_url

data/lib/ansible/ruby/modules/generated/extras/monitoring/zabbix_maintenance.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # This module will let you create Zabbix maintenance windows.
       class Zabbix_maintenance < Base
         # @return [:present, :absent, nil] Create or remove a maintenance window.
         attribute :state

data/lib/ansible/ruby/modules/generated/extras/monitoring/zabbix_screen.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # This module allows you to create, modify and delete Zabbix screens and associated graph data.
       class Zabbix_screen < Base
         # @return [String] Url of Zabbix server, with protocol (http or https).
         attribute :server_url

data/lib/ansible/ruby/modules/generated/extras/network/a10/a10_server.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Manage slb server objects on A10 Networks devices via aXAPI
       class A10_server < Base
         # @return [String] hostname or ip of your A10 Networks device
         attribute :host

data/lib/ansible/ruby/modules/generated/extras/network/a10/a10_service_group.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Manage slb service-group objects on A10 Networks devices via aXAPI
       class A10_service_group < Base
         # @return [String] hostname or ip of your A10 Networks device
         attribute :host

data/lib/ansible/ruby/modules/generated/extras/network/a10/a10_virtual_server.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Manage slb virtual server objects on A10 Networks devices via aXAPI
       class A10_virtual_server < Base
         # @return [String] hostname or ip of your A10 Networks device
         attribute :host

data/lib/ansible/ruby/modules/generated/extras/network/citrix/netscaler.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Manages Citrix NetScaler server and service entities.
       class Netscaler < Base
         # @return [Object] hostname or ip of your netscaler
         attribute :nsc_host

data/lib/ansible/ruby/modules/generated/extras/network/cloudflare_dns.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Manages dns records via the Cloudflare API, see the docs: U(https://api.cloudflare.com/)
       class Cloudflare_dns < Base
         # @return [String] Account API token. You can obtain your API key from the bottom of the Cloudflare 'My Account' page, found here: U(https://www.cloudflare.com/a/account)
         attribute :account_api_token

data/lib/ansible/ruby/modules/generated/extras/network/dnsimple.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Manages domains and records via the DNSimple API, see the docs: U(http://developer.dnsimple.com/)
       class Dnsimple < Base
         # @return [String, nil] Account email. If omitted, the env variables DNSIMPLE_EMAIL and DNSIMPLE_API_TOKEN will be looked for. If those aren't found, a C(.dnsimple) file will be looked for, see: U(https://github.com/mikemaccana/dnsimple-python#getting-started)
         attribute :account_email

data/lib/ansible/ruby/modules/generated/extras/network/dnsmadeeasy.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Manages DNS records via the v2 REST API of the DNS Made Easy service.  It handles records only; there is no manipulation of domains or monitor/account support yet. See: U(http://www.dnsmadeeasy.com/services/rest-api/)
       class Dnsmadeeasy < Base
         # @return [String] Accout API Key.
         attribute :account_key