Class: Ansible::Ruby::Modules::Win_reboot

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

Overview

Reboot a Windows machine, wait for it to go down, come back up, and respond to commands.

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

#connect_timeout ⇒ Integer?

Returns Maximum seconds to wait for a single successful TCP connection to the WinRM endpoint before trying again.

Returns:

  • (Integer, nil) —

    Maximum seconds to wait for a single successful TCP connection to the WinRM endpoint before trying again



28
 
# File 'lib/ansible/ruby/modules/generated/windows/win_reboot.rb', line 28

attribute :connect_timeout

#msg ⇒ String?

Returns Message to display to users.

Returns:

  • (String, nil) —

    Message to display to users



36
 
# File 'lib/ansible/ruby/modules/generated/windows/win_reboot.rb', line 36

attribute :msg

#post_reboot_delay ⇒ Integer?

Returns Seconds to wait after the reboot was successful and the connection was re-established,This is useful if you want wait for something to settle despite your connection already working.

Returns:

  • (Integer, nil) —

    Seconds to wait after the reboot was successful and the connection was re-established,This is useful if you want wait for something to settle despite your connection already working



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

attribute :post_reboot_delay

#pre_reboot_delay ⇒ Integer?

Returns Seconds for shutdown to wait before requesting reboot.

Returns:

  • (Integer, nil) —

    Seconds for shutdown to wait before requesting reboot



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

attribute :pre_reboot_delay

#reboot_timeout ⇒ Integer?

Returns Maximum seconds to wait for machine to re-appear on the network and respond to a test command,This timeout is evaluated separately for both network appearance and test command success (so maximum clock time is actually twice this value).

Returns:

  • (Integer, nil) —

    Maximum seconds to wait for machine to re-appear on the network and respond to a test command,This timeout is evaluated separately for both network appearance and test command success (so maximum clock time is actually twice this value)



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

attribute :reboot_timeout

#shutdown_timeout ⇒ Integer?

Returns Maximum seconds to wait for shutdown to occur,Increase this timeout for very slow hardware, large update applications, etc,This option has been removed since Ansible 2.5 as the win_reboot behavior has changed.

Returns:

  • (Integer, nil) —

    Maximum seconds to wait for shutdown to occur,Increase this timeout for very slow hardware, large update applications, etc,This option has been removed since Ansible 2.5 as the win_reboot behavior has changed



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

attribute :shutdown_timeout

#test_command ⇒ String?

Returns Command to expect success for to determine the machine is ready for management.

Returns:

  • (String, nil) —

    Command to expect success for to determine the machine is ready for management



32
 
# File 'lib/ansible/ruby/modules/generated/windows/win_reboot.rb', line 32

attribute :test_command