Class: Ansible::Ruby::Modules::Win_msg

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/windows/win_msg.rb

Overview

Wraps the msg.exe command in order to send messages to Windows hosts.

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#display_seconds ⇒ Integer?

Returns How long to wait for receiver to acknowledge message, in seconds.

Returns:

  • (Integer, nil) —

    How long to wait for receiver to acknowledge message, in seconds.



16
 
# File 'lib/ansible/ruby/modules/generated/windows/win_msg.rb', line 16

attribute :display_seconds

#msg ⇒ String?

Returns The text of the message to be displayed.,The message must be less than 256 characters.

Returns:

  • (String, nil) —

    The text of the message to be displayed.,The message must be less than 256 characters.



24
 
# File 'lib/ansible/ruby/modules/generated/windows/win_msg.rb', line 24

attribute :msg

#to ⇒ String?

Returns Who to send the message to. Can be a username, sessionname or sessionid.

Returns:

  • (String, nil) —

    Who to send the message to. Can be a username, sessionname or sessionid.



12
 
# File 'lib/ansible/ruby/modules/generated/windows/win_msg.rb', line 12

attribute :to

#wait ⇒ :yes, ...

Returns Whether to wait for users to respond. Module will only wait for the number of seconds specified in display_seconds or 10 seconds if not specified. However, if I(wait) is C(yes), the message is sent to each logged on user in turn, waiting for the user to either press ‘ok’ or for the timeout to elapse before moving on to the next user.

Returns:

  • (:yes, :no, nil) —

    Whether to wait for users to respond. Module will only wait for the number of seconds specified in display_seconds or 10 seconds if not specified. However, if I(wait) is C(yes), the message is sent to each logged on user in turn, waiting for the user to either press ‘ok’ or for the timeout to elapse before moving on to the next user.



20
 
# File 'lib/ansible/ruby/modules/generated/windows/win_msg.rb', line 20

attribute :wait