ansible-ruby 1.0.0

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

@@ -0,0 +1,26 @@
+# See LICENSE.txt at root of repository
+# GENERATED FILE - DO NOT EDIT!!
+require 'ansible/ruby/modules/base'
+
+module Ansible
+  module Ruby
+    module Modules
+      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
+        validates :room_token, presence: true, type: String
+
+        # @return [String] The message you wish to deliver as a notifcation
+        attribute :msg
+        validates :msg, presence: true, type: String
+
+        # @return [String] The title of the message
+        attribute :title
+        validates :title, presence: true, type: String
+
+        # @return [Object, nil] The full URL to the image you wish to use for the Icon of the message. Defaults to U(http://cdn2.hubspot.net/hub/330046/file-769078210-png/Official_Logos/ansible_logo_black_square_small.png?t=1421076128627)
+        attribute :picture
+      end
+    end
+  end
+end

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

@@ -0,0 +1,47 @@
+# See LICENSE.txt at root of repository
+# GENERATED FILE - DO NOT EDIT!!
+require 'ansible/ruby/modules/base'
+
+module Ansible
+  module Ruby
+    module Modules
+      class Hipchat < Base
+        # @return [String] API token.
+        attribute :token
+        validates :token, presence: true, type: String
+
+        # @return [String] ID or name of the room.
+        attribute :room
+        validates :room, presence: true, type: String
+
+        # @return [String, nil] Name the message will appear be sent from. max 15 characters. Over 15, will be shorten.
+        attribute :from
+        validates :from, type: String
+
+        # @return [String] The message body.
+        attribute :msg
+        validates :msg, presence: true, type: String
+
+        # @return [:yellow, :red, :green, :purple, :gray, :random, nil] Background color for the message. Default is yellow.
+        attribute :color
+        validates :color, inclusion: {:in=>[:yellow, :red, :green, :purple, :gray, :random], :message=>"%{value} needs to be :yellow, :red, :green, :purple, :gray, :random"}, allow_nil: true
+
+        # @return [:text, :html, nil] message format. html or text. Default is text.
+        attribute :msg_format
+        validates :msg_format, inclusion: {:in=>[:text, :html], :message=>"%{value} needs to be :text, :html"}, allow_nil: true
+
+        # @return [:yes, :no, nil] notify or not (change the tab color, play a sound, etc)
+        attribute :notify
+        validates :notify, inclusion: {:in=>[:yes, :no], :message=>"%{value} needs to be :yes, :no"}, allow_nil: true
+
+        # @return [:yes, :no, nil] If C(no), SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.
+        attribute :validate_certs
+        validates :validate_certs, inclusion: {:in=>[:yes, :no], :message=>"%{value} needs to be :yes, :no"}, allow_nil: true
+
+        # @return [String, nil] API url if using a self-hosted hipchat server. For hipchat api version 2 use C(/v2) path in URI
+        attribute :api
+        validates :api, type: String
+      end
+    end
+  end
+end

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

@@ -0,0 +1,64 @@
+# See LICENSE.txt at root of repository
+# GENERATED FILE - DO NOT EDIT!!
+require 'ansible/ruby/modules/base'
+
+module Ansible
+  module Ruby
+    module Modules
+      class Irc < Base
+        # @return [String, nil] IRC server name/address
+        attribute :server
+        validates :server, type: String
+
+        # @return [Integer, nil] IRC server port number
+        attribute :port
+        validates :port, type: Integer
+
+        # @return [String, nil] Nickname to send the message from. May be shortened, depending on server's NICKLEN setting.
+        attribute :nick
+        validates :nick, type: String
+
+        # @return [String] The message body.
+        attribute :msg
+        validates :msg, presence: true, type: String
+
+        # @return [Object, nil] Set the channel topic
+        attribute :topic
+
+        # @return [:none, :white, :black, :blue, :green, :red, :brown, :purple, :orange, :yellow, :light_green, :teal, :light_cyan, :light_blue, :pink, :gray, :light_gray, nil] Text color for the message. ("none" is a valid option in 1.6 or later, in 1.6 and prior, the default color is black, not "none"). Added 11 more colors in version 2.0.
+        attribute :color
+        validates :color, inclusion: {:in=>[:none, :white, :black, :blue, :green, :red, :brown, :purple, :orange, :yellow, :light_green, :teal, :light_cyan, :light_blue, :pink, :gray, :light_gray], :message=>"%{value} needs to be :none, :white, :black, :blue, :green, :red, :brown, :purple, :orange, :yellow, :light_green, :teal, :light_cyan, :light_blue, :pink, :gray, :light_gray"}, allow_nil: true
+
+        # @return [String] Channel name.  One of nick_to or channel needs to be set.  When both are set, the message will be sent to both of them.
+        attribute :channel
+        validates :channel, presence: true, type: String
+
+        # @return [Array<String>, String, nil] A list of nicknames to send the message to. One of nick_to or channel needs to be set.  When both are defined, the message will be sent to both of them.
+        attribute :nick_to
+        validates :nick_to, type: TypeGeneric.new(String)
+
+        # @return [Object, nil] Channel key
+        attribute :key
+
+        # @return [Object, nil] Server password
+        attribute :passwd
+
+        # @return [Integer, nil] Timeout to use while waiting for successful registration and join messages, this is to prevent an endless loop
+        attribute :timeout
+        validates :timeout, type: Integer
+
+        # @return [Boolean, nil] Designates whether TLS/SSL should be used when connecting to the IRC server
+        attribute :use_ssl
+        validates :use_ssl, inclusion: {:in=>[true, false], :message=>"%{value} needs to be true, false"}, allow_nil: true
+
+        # @return [Boolean, nil] Designates whether user should part from channel after sending message or not. Useful for when using a faux bot and not wanting join/parts between messages.
+        attribute :part
+        validates :part, inclusion: {:in=>[true, false], :message=>"%{value} needs to be true, false"}, allow_nil: true
+
+        # @return [:bold, :underline, :reverse, :italic, nil] Text style for the message. Note italic does not work on some clients
+        attribute :style
+        validates :style, inclusion: {:in=>[:bold, :underline, :reverse, :italic], :message=>"%{value} needs to be :bold, :underline, :reverse, :italic"}, allow_nil: true
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+# See LICENSE.txt at root of repository
+# GENERATED FILE - DO NOT EDIT!!
+require 'ansible/ruby/modules/base'
+
+module Ansible
+  module Ruby
+    module Modules
+      class Jabber < Base
+        # @return [String] User as which to connect
+        attribute :user
+        validates :user, presence: true, type: String
+
+        # @return [String] password for user to connect
+        attribute :password
+        validates :password, presence: true, type: String
+
+        # @return [String] user ID or name of the room, when using room use a slash to indicate your nick.
+        attribute :to
+        validates :to, presence: true, type: String
+
+        # @return [String] The message body.
+        attribute :msg
+        validates :msg, presence: true, type: String
+
+        # @return [String, nil] host to connect, overrides user info
+        attribute :host
+        validates :host, type: String
+
+        # @return [Integer, nil] port to connect to, overrides default
+        attribute :port
+        validates :port, type: Integer
+
+        # @return [Object, nil] message encoding
+        attribute :encoding
+      end
+    end
+  end
+end

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

@@ -0,0 +1,66 @@
+# See LICENSE.txt at root of repository
+# GENERATED FILE - DO NOT EDIT!!
+require 'ansible/ruby/modules/base'
+
+module Ansible
+  module Ruby
+    module Modules
+      class Mail < Base
+        # @return [String, nil] The email-address the mail is sent from. May contain address and phrase.
+        attribute :from
+        validates :from, type: String
+
+        # @return [String, nil] The email-address(es) the mail is being sent to. This is a comma-separated list, which may contain address and phrase portions.
+        attribute :to
+        validates :to, type: String
+
+        # @return [String, nil] The email-address(es) the mail is being copied to. This is a comma-separated list, which may contain address and phrase portions.
+        attribute :cc
+        validates :cc, type: String
+
+        # @return [Object, nil] The email-address(es) the mail is being 'blind' copied to. This is a comma-separated list, which may contain address and phrase portions.
+        attribute :bcc
+
+        # @return [String] The subject of the email being sent.
+        attribute :subject
+        validates :subject, presence: true, type: String
+
+        # @return [String, nil] The body of the email being sent.
+        attribute :body
+        validates :body, type: String
+
+        # @return [String, nil] If SMTP requires username
+        attribute :username
+        validates :username, type: String
+
+        # @return [String, nil] If SMTP requires password
+        attribute :password
+        validates :password, type: String
+
+        # @return [String, nil] The mail server
+        attribute :host
+        validates :host, type: String
+
+        # @return [String, nil] The mail server port
+        attribute :port
+        validates :port, type: String
+
+        # @return [String, nil] A space-separated list of pathnames of files to attach to the message. Attached files will have their content-type set to C(application/octet-stream).
+        attribute :attach
+        validates :attach, type: String
+
+        # @return [String, nil] A vertical-bar-separated list of headers which should be added to the message. Each individual header is specified as C(header=value) (see example below).
+        attribute :headers
+        validates :headers, type: String
+
+        # @return [String, nil] The character set of email being sent
+        attribute :charset
+        validates :charset, type: String
+
+        # @return [String, nil] The minor mime type, can be either text or html. The major type is always text.
+        attribute :subtype
+        validates :subtype, type: String
+      end
+    end
+  end
+end

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

@@ -0,0 +1,45 @@
+# See LICENSE.txt at root of repository
+# GENERATED FILE - DO NOT EDIT!!
+require 'ansible/ruby/modules/base'
+
+module Ansible
+  module Ruby
+    module Modules
+      class Mqtt < Base
+        # @return [String, nil] MQTT broker address/name
+        attribute :server
+        validates :server, type: String
+
+        # @return [Integer, nil] MQTT broker port number
+        attribute :port
+        validates :port, type: Integer
+
+        # @return [Object, nil] Username to authenticate against the broker.
+        attribute :username
+
+        # @return [Object, nil] Password for C(username) to authenticate against the broker.
+        attribute :password
+
+        # @return [String, nil] MQTT client identifier
+        attribute :client_id
+        validates :client_id, type: String
+
+        # @return [String] MQTT topic name
+        attribute :topic
+        validates :topic, presence: true, type: String
+
+        # @return [String] Payload. The special string C("None") may be used to send a NULL (i.e. empty) payload which is useful to simply notify with the I(topic) or to clear previously retained messages.
+        attribute :payload
+        validates :payload, presence: true, type: String
+
+        # @return [0, 1, 2, nil] QoS (Quality of Service)
+        attribute :qos
+        validates :qos, inclusion: {:in=>[0, 1, 2], :message=>"%{value} needs to be 0, 1, 2"}, allow_nil: true
+
+        # @return [Boolean, nil] Setting this flag causes the broker to retain (i.e. keep) the message so that applications that subsequently subscribe to the topic can received the last retained message immediately.
+        attribute :retain
+        validates :retain, inclusion: {:in=>[true, false], :message=>"%{value} needs to be true, false"}, allow_nil: true
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+# See LICENSE.txt at root of repository
+# GENERATED FILE - DO NOT EDIT!!
+require 'ansible/ruby/modules/base'
+
+module Ansible
+  module Ruby
+    module Modules
+      class Nexmo < Base
+        # @return [String] Nexmo API Key
+        attribute :api_key
+        validates :api_key, presence: true, type: String
+
+        # @return [String] Nexmo API Secret
+        attribute :api_secret
+        validates :api_secret, presence: true, type: String
+
+        # @return [Integer] Nexmo Number to send from
+        attribute :src
+        validates :src, presence: true, type: Integer
+
+        # @return [Array<Integer>, Integer] Phone number(s) to send SMS message to
+        attribute :dest
+        validates :dest, presence: true, type: TypeGeneric.new(Integer)
+
+        # @return [String] Message to text to send. Messages longer than 160 characters will be split into multiple messages
+        attribute :msg
+        validates :msg, presence: true, type: String
+
+        # @return [:yes, :no, nil] If C(no), SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.
+        attribute :validate_certs
+        validates :validate_certs, inclusion: {:in=>[:yes, :no], :message=>"%{value} needs to be :yes, :no"}, allow_nil: true
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+# See LICENSE.txt at root of repository
+# GENERATED FILE - DO NOT EDIT!!
+require 'ansible/ruby/modules/base'
+
+module Ansible
+  module Ruby
+    module Modules
+      class Osx_say < Base
+        # @return [String] What to say
+        attribute :msg
+        validates :msg, presence: true, type: String
+
+        # @return [String, nil] What voice to use
+        attribute :voice
+        validates :voice, type: String
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+# See LICENSE.txt at root of repository
+# GENERATED FILE - DO NOT EDIT!!
+require 'ansible/ruby/modules/base'
+
+module Ansible
+  module Ruby
+    module Modules
+      class Pushbullet < Base
+        # @return [String] Push bullet API token
+        attribute :api_key
+        validates :api_key, presence: true, type: String
+
+        # @return [String, nil] The channel TAG you wish to broadcast a push notification, as seen on the "My Channels" > "Edit your channel" at Pushbullet page.
+        attribute :channel
+        validates :channel, type: String
+
+        # @return [String, nil] The device NAME you wish to send a push notification, as seen on the Pushbullet main page.
+        attribute :device
+        validates :device, type: String
+
+        # @return [:note, :link, nil] Thing you wish to push.
+        attribute :push_type
+        validates :push_type, inclusion: {:in=>[:note, :link], :message=>"%{value} needs to be :note, :link"}, allow_nil: true
+
+        # @return [String] Title of the notification.
+        attribute :title
+        validates :title, presence: true, type: String
+
+        # @return [String, nil] Body of the notification, e.g. Details of the fault you're alerting.
+        attribute :body
+        validates :body, type: String
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+# See LICENSE.txt at root of repository
+# GENERATED FILE - DO NOT EDIT!!
+require 'ansible/ruby/modules/base'
+
+module Ansible
+  module Ruby
+    module Modules
+      class Pushover < Base
+        # @return [String] What message you wish to send.
+        attribute :msg
+        validates :msg, presence: true, type: String
+
+        # @return [String] Pushover issued token identifying your pushover app.
+        attribute :app_token
+        validates :app_token, presence: true, type: String
+
+        # @return [String] Pushover issued authentication key for your user.
+        attribute :user_key
+        validates :user_key, presence: true, type: String
+
+        # @return [Object, nil] Message priority (see U(https://pushover.net) for details.)
+        attribute :pri
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+# See LICENSE.txt at root of repository
+# GENERATED FILE - DO NOT EDIT!!
+require 'ansible/ruby/modules/base'
+
+module Ansible
+  module Ruby
+    module Modules
+      class Sendgrid < Base
+        # @return [String] username for logging into the SendGrid account
+        attribute :username
+        validates :username, presence: true, type: String
+
+        # @return [String] password that corresponds to the username
+        attribute :password
+        validates :password, presence: true, type: String
+
+        # @return [String] the address in the "from" field for the email
+        attribute :from_address
+        validates :from_address, presence: true, type: String
+
+        # @return [Array<String>, String] a list with one or more recipient email addresses
+        attribute :to_addresses
+        validates :to_addresses, presence: true, type: TypeGeneric.new(String)
+
+        # @return [String] the desired subject for the email
+        attribute :subject
+        validates :subject, presence: true, type: String
+      end
+    end
+  end
+end