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/network/f5/bigip_facts.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Collect facts from F5 BIG-IP devices via iControl SOAP API
       class Bigip_facts < Base
         # @return [Object] BIG-IP host
         attribute :server

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

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Manages F5 BIG-IP GTM wide ip
       class Bigip_gtm_wide_ip < Base
         # @return [String] BIG-IP host
         attribute :server

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

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Manages F5 BIG-IP LTM monitors via iControl SOAP API
       class Bigip_monitor_http < Base
         # @return [String] BIG-IP host
         attribute :server

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

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Manages F5 BIG-IP LTM tcp monitors via iControl SOAP API
       class Bigip_monitor_tcp < Base
         # @return [String] BIG-IP host
         attribute :server

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

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Manages F5 BIG-IP LTM nodes via iControl SOAP API
       class Bigip_node < Base
         # @return [Object] BIG-IP host
         attribute :server

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

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Manages F5 BIG-IP LTM pools via iControl SOAP API
       class Bigip_pool < Base
         # @return [Object] BIG-IP host
         attribute :server

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

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Manages F5 BIG-IP LTM pool members via iControl SOAP API
       class Bigip_pool_member < Base
         # @return [Object] BIG-IP host
         attribute :server

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

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Manages F5 BIG-IP LTM virtual servers via iControl SOAP API
       class Bigip_virtual_server < Base
         # @return [String] BIG-IP host
         attribute :server

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

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Enable, disable, and set weights for HAProxy backend servers using socket commands.
       class Haproxy < Base
         # @return [String, nil] Name of the HAProxy backend pool.
         attribute :backend

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

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # If behind NAT and need to know the public IP of your internet gateway.
       class Ipify_facts < Base
         # @return [String, nil] URL of the ipify.org API service.,C(?format=json) will be appended per default.
         attribute :api_url

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

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Reads data out of lldpctl
       class Lldp < Base
       end

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

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Manage the network devices. Create, modify, and manage, ethernet, teams, bonds, vlans etc.
       class Nmcli < Base
         # @return [:present, :absent] Whether the device should exist or not, taking action if the state is different from what is stated.
         attribute :state

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

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Manage Open vSwitch bridges
       class Openvswitch_bridge < Base
         # @return [String] Name of bridge to manage
         attribute :bridge

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

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Set column values in record in database table.
       class Openvswitch_db < Base
         # @return [String] Identifies the table in the database.
         attribute :table

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

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Manage Open vSwitch ports
       class Openvswitch_port < Base
         # @return [String] Name of bridge to manage
         attribute :bridge

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

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Retrieve facts for a device using SNMP, the facts will be inserted to the ansible_facts key.
       class Snmp_facts < Base
         # @return [String] Set to target snmp server (normally {{inventory_hostname}})
         attribute :host

data/lib/ansible/ruby/modules/generated/extras/notification/campfire.rb CHANGED

@@ -5,6 +5,8 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Send a message to Campfire.
+      # Messages with newlines will result in a "Paste" message being sent.
       class Campfire < Base
         # @return [String] The subscription name to use.
         attribute :subscription

data/lib/ansible/ruby/modules/generated/extras/notification/flowdock.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Send a message to a flowdock team inbox or chat using the push API (see https://www.flowdock.com/api/team-inbox and https://www.flowdock.com/api/chat)
       class Flowdock < Base
         # @return [String] API token.
         attribute :token

data/lib/ansible/ruby/modules/generated/extras/notification/grove.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # The M(grove) module sends a message for a service to a Grove.io channel.
       class Grove < Base
         # @return [String] Token of the channel to post to.
         attribute :channel_token

data/lib/ansible/ruby/modules/generated/extras/notification/hall.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # The M(hall) module connects to the U(https://hall.com) messaging API and allows you to deliver notication messages to rooms.
       class Hall < Base
         # @return [String] Room token provided to you by setting up the Ansible room integation on U(https://hall.com)
         attribute :room_token

data/lib/ansible/ruby/modules/generated/extras/notification/hipchat.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Send a message to hipchat
       class Hipchat < Base
         # @return [String] API token.
         attribute :token

data/lib/ansible/ruby/modules/generated/extras/notification/irc.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Send a message to an IRC channel. This is a very simplistic implementation.
       class Irc < Base
         # @return [String, nil] IRC server name/address
         attribute :server

data/lib/ansible/ruby/modules/generated/extras/notification/jabber.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Send a message to jabber
       class Jabber < Base
         # @return [String] User as which to connect
         attribute :user

data/lib/ansible/ruby/modules/generated/extras/notification/mail.rb CHANGED

@@ -5,6 +5,10 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # This module is useful for sending emails from playbooks.
+      # One may wonder why automate sending emails?  In complex environments there are from time to time processes that cannot be automated, either because you lack the authority to make it so, or because not everyone agrees to a common approach.
+      # If you cannot automate a specific step, but the step is non-blocking, sending out an email to the responsible party to make him perform his part of the bargain is an elegant way to put the responsibility in someone else's lap.
+      # Of course sending out a mail can be equally useful as a way to notify one or more people in a team that a specific action has been (successfully) taken.
       class Mail < Base
         # @return [String, nil] The email-address the mail is sent from. May contain address and phrase.
         attribute :from

data/lib/ansible/ruby/modules/generated/extras/notification/mqtt.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Publish a message on an MQTT topic.
       class Mqtt < Base
         # @return [String, nil] MQTT broker address/name
         attribute :server

data/lib/ansible/ruby/modules/generated/extras/notification/nexmo.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Send a SMS message via nexmo
       class Nexmo < Base
         # @return [String] Nexmo API Key
         attribute :api_key

data/lib/ansible/ruby/modules/generated/extras/notification/osx_say.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # makes an OS computer speak!  Amuse your friends, annoy your coworkers!
       class Osx_say < Base
         # @return [String] What to say
         attribute :msg

data/lib/ansible/ruby/modules/generated/extras/notification/pushbullet.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # This module sends push notifications via Pushbullet to channels or devices.
       class Pushbullet < Base
         # @return [String] Push bullet API token
         attribute :api_key

data/lib/ansible/ruby/modules/generated/extras/notification/pushover.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Send notifications via pushover, to subscriber list of devices, and email addresses. Requires pushover app on devices.
       class Pushover < Base
         # @return [String] What message you wish to send.
         attribute :msg

data/lib/ansible/ruby/modules/generated/extras/notification/sendgrid.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Sends an email with a SendGrid account through their API, not through the SMTP service.
       class Sendgrid < Base
         # @return [String] username for logging into the SendGrid account
         attribute :username

data/lib/ansible/ruby/modules/generated/extras/notification/slack.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # The M(slack) module sends notifications to U(http://slack.com) via the Incoming WebHook integration
       class Slack < Base
         # @return [String, nil] Slack (sub)domain for your environment without protocol. (i.e. C(future500.slack.com)) In 1.8 and beyond, this is deprecated and may be ignored.  See token documentation for information.
         attribute :domain

data/lib/ansible/ruby/modules/generated/extras/notification/sns.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # The M(sns) module sends notifications to a topic on your Amazon SNS account
       class Sns < Base
         # @return [String] Default message to send.
         attribute :msg

data/lib/ansible/ruby/modules/generated/extras/notification/twilio.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Sends a text message to a phone number through the Twilio messaging API.
       class Twilio < Base
         # @return [String] user's Twilio account token found on the account page
         attribute :account_sid

data/lib/ansible/ruby/modules/generated/extras/notification/typetalk.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Send a message to typetalk using typetalk API ( http://developers.typetalk.in/ )
       class Typetalk < Base
         # @return [String] OAuth2 client ID
         attribute :client_id

data/lib/ansible/ruby/modules/generated/extras/packaging/dpkg_selections.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Change dpkg package selection state via --get-selections and --set-selections.
       class Dpkg_selections < Base
         # @return [String] Name of the package
         attribute :name

data/lib/ansible/ruby/modules/generated/extras/packaging/elasticsearch_plugin.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Manages Elasticsearch plugins.
       class Elasticsearch_plugin < Base
         # @return [String] Name of the plugin to install. In ES 2.x, the name can be an url or file location
         attribute :name

data/lib/ansible/ruby/modules/generated/extras/packaging/language/bower.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Manage bower packages with bower
       class Bower < Base
         # @return [String, nil] The name of a bower package to install
         attribute :name

data/lib/ansible/ruby/modules/generated/extras/packaging/language/bundler.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Manage installation and Gem version dependencies for Ruby using the Bundler gem
       class Bundler < Base
         # @return [String, nil] The path to the bundler executable
         attribute :executable

data/lib/ansible/ruby/modules/generated/extras/packaging/language/composer.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Composer is a tool for dependency management in PHP. It allows you to declare the dependent libraries your project needs and it will install them in your project for you
       class Composer < Base
         # @return [String, nil] Composer command like "install", "update" and so on
         attribute :command

data/lib/ansible/ruby/modules/generated/extras/packaging/language/cpanm.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Manage Perl library dependencies.
       class Cpanm < Base
         # @return [String, nil] The name of the Perl library to install. You may use the "full distribution path", e.g.  MIYAGAWA/Plack-0.99_05.tar.gz
         attribute :name

data/lib/ansible/ruby/modules/generated/extras/packaging/language/maven_artifact.rb CHANGED

@@ -5,6 +5,9 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Downloads an artifact from a maven repository given the maven coordinates provided to the module. Can retrieve
+      # snapshots or release versions of the artifact and will resolve the latest available version if one is not
+      # available.
       class Maven_artifact < Base
         # @return [String] The Maven groupId coordinate
         attribute :group_id

data/lib/ansible/ruby/modules/generated/extras/packaging/language/npm.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Manage node.js packages with Node Package Manager (npm)
       class Npm < Base
         # @return [String, nil] The name of a node.js library to install
         attribute :name

data/lib/ansible/ruby/modules/generated/extras/packaging/language/pear.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Manage PHP packages with the pear package manager.
       class Pear < Base
         # @return [Array<String>, String] Name of the package to install, upgrade, or remove.
         attribute :name

data/lib/ansible/ruby/modules/generated/extras/packaging/os/apk.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Manages I(apk) packages for Alpine Linux.
       class Apk < Base
         # @return [Array<String>, String, nil] A package name, like C(foo), or mutliple packages, like C(foo, bar).
         attribute :name

data/lib/ansible/ruby/modules/generated/extras/packaging/os/dnf.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Installs, upgrade, removes, and lists packages and groups with the I(dnf) package manager.
       class Dnf < Base
         # @return [String] Package name, or package specifier with version, like C(name-1.0). When using state=latest, this can be '*' which means run: dnf -y update. You can also pass a url or a local path to a rpm file.
         attribute :name

data/lib/ansible/ruby/modules/generated/extras/packaging/os/homebrew.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Manages Homebrew packages
       class Homebrew < Base
         # @return [Array<String>, String, nil] name of package to install/remove
         attribute :name

data/lib/ansible/ruby/modules/generated/extras/packaging/os/homebrew_cask.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Manages Homebrew casks.
       class Homebrew_cask < Base
         # @return [String] name of cask to install/remove
         attribute :name

data/lib/ansible/ruby/modules/generated/extras/packaging/os/homebrew_tap.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Tap external Homebrew repositories.
       class Homebrew_tap < Base
         # @return [Object] The repository to tap.
         attribute :tap

data/lib/ansible/ruby/modules/generated/extras/packaging/os/layman.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Uses Layman to manage an additional repositories for the Portage package manager on Gentoo Linux. Please note that Layman must be installed on a managed node prior using this module.
       class Layman < Base
         # @return [String] The overlay id to install, synchronize, or uninstall. Use 'ALL' to sync all of the installed overlays (can be used only when C(state=updated)).
         attribute :name

data/lib/ansible/ruby/modules/generated/extras/packaging/os/macports.rb CHANGED

@@ -5,6 +5,7 @@ require 'ansible/ruby/modules/base'
 module Ansible
   module Ruby
     module Modules
+      # Manages MacPorts packages
       class Macports < Base
         # @return [String] name of package to install/remove
         attribute :name