Class: Ansible::Ruby::Modules::Reboot

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/system/reboot.rb

Overview

Reboot a 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, #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 successful connection to the managed hosts before trying again.,If unspecified, the default setting for the underlying connection plugin is used.

Returns:

  • (Integer, nil) —

    Maximum seconds to wait for a successful connection to the managed hosts before trying again.,If unspecified, the default setting for the underlying connection plugin is used.



24
 
# File 'lib/ansible/ruby/modules/generated/system/reboot.rb', line 24

attribute :connect_timeout

#msg ⇒ String?

Returns Message to display to users before reboot.

Returns:

  • (String, nil) —

    Message to display to users before reboot.



32
 
# File 'lib/ansible/ruby/modules/generated/system/reboot.rb', line 32

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/system/reboot.rb', line 16

attribute :post_reboot_delay

#pre_reboot_delay ⇒ Integer?

Returns Seconds for shutdown to wait before requesting reboot.,On Linux, macOS, and OpenBSD this is converted to minutes and rounded down. If less than 60, it will be set to 0.,On Solaris and FreeBSD this will be seconds.

Returns:

  • (Integer, nil) —

    Seconds for shutdown to wait before requesting reboot.,On Linux, macOS, and OpenBSD this is converted to minutes and rounded down. If less than 60, it will be set to 0.,On Solaris and FreeBSD this will be seconds.



12
 
# File 'lib/ansible/ruby/modules/generated/system/reboot.rb', line 12

attribute :pre_reboot_delay

#reboot_timeout ⇒ Integer?

Returns Maximum seconds to wait for machine to reboot and respond to a test command.,This timeout is evaluated separately for both network connection and test command success so the maximum execution time for the module is twice this amount.

Returns:

  • (Integer, nil) —

    Maximum seconds to wait for machine to reboot and respond to a test command.,This timeout is evaluated separately for both network connection and test command success so the maximum execution time for the module is twice this amount.



20
 
# File 'lib/ansible/ruby/modules/generated/system/reboot.rb', line 20

attribute :reboot_timeout

#test_command ⇒ String?

Returns Command to run on the rebooted host and expect success from to determine the machine is ready for further tasks.

Returns:

  • (String, nil) —

    Command to run on the rebooted host and expect success from to determine the machine is ready for further tasks.



28
 
# File 'lib/ansible/ruby/modules/generated/system/reboot.rb', line 28

attribute :test_command