Class: Ansible::Ruby::Modules::Hpilo_boot

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/remote_management/hpilo/hpilo_boot.rb

Overview

This module boots a system through its HP iLO interface. The boot media can be one of: cdrom, floppy, hdd, network or usb. This module requires the hpilo python module.

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

#force ⇒ Symbol?

Returns Whether to force a reboot (even when the system is already booted).,As a safeguard, without force, hpilo_boot will refuse to reboot a server that is already running.

Returns:

  • (Symbol, nil) —

    Whether to force a reboot (even when the system is already booted).,As a safeguard, without force, hpilo_boot will refuse to reboot a server that is already running.



37
 
# File 'lib/ansible/ruby/modules/generated/remote_management/hpilo/hpilo_boot.rb', line 37

attribute :force

#host ⇒ String

Returns The HP iLO hostname/address that is linked to the physical system.

Returns:

  • (String) —

    The HP iLO hostname/address that is linked to the physical system.



13
 
# File 'lib/ansible/ruby/modules/generated/remote_management/hpilo/hpilo_boot.rb', line 13

attribute :host

#image ⇒ String?

Returns The URL of a cdrom, floppy or usb boot media image. protocol://username:password@hostname:port/filename,protocol is either ‘http’ or ‘https’,username:password is optional,port is optional.

Returns:

  • (String, nil) —

    The URL of a cdrom, floppy or usb boot media image. protocol://username:password@hostname:port/filename,protocol is either ‘http’ or ‘https’,username:password is optional,port is optional



29
 
# File 'lib/ansible/ruby/modules/generated/remote_management/hpilo/hpilo_boot.rb', line 29

attribute :image

#login ⇒ String?

Returns The login name to authenticate to the HP iLO interface.

Returns:

  • (String, nil) —

    The login name to authenticate to the HP iLO interface.



17
 
# File 'lib/ansible/ruby/modules/generated/remote_management/hpilo/hpilo_boot.rb', line 17

attribute :login

#media ⇒ :cdrom, ...

Returns The boot media to boot the system from.

Returns:

  • (:cdrom, :floppy, :hdd, :network, :normal, :usb, nil) —

    The boot media to boot the system from



25
 
# File 'lib/ansible/ruby/modules/generated/remote_management/hpilo/hpilo_boot.rb', line 25

attribute :media

#password ⇒ String?

Returns The password to authenticate to the HP iLO interface.

Returns:

  • (String, nil) —

    The password to authenticate to the HP iLO interface.



21
 
# File 'lib/ansible/ruby/modules/generated/remote_management/hpilo/hpilo_boot.rb', line 21

attribute :password

#ssl_version ⇒ :SSLv3, ...

Returns Change the ssl_version used.

Returns:

  • (:SSLv3, :SSLv23, :TLSv1, :TLSv1_1, :TLSv1_2, nil) —

    Change the ssl_version used.



41
 
# File 'lib/ansible/ruby/modules/generated/remote_management/hpilo/hpilo_boot.rb', line 41

attribute :ssl_version

#state ⇒ :boot_always, ...

Returns The state of the boot media.,no_boot: Do not boot from the device,boot_once: Boot from the device once and then notthereafter,boot_always: Boot from the device each time the serveris rebooted,connect: Connect the virtual media device and set to boot_always,disconnect: Disconnects the virtual media device and set to no_boot,poweroff: Power off the server.

Returns:

  • (:boot_always, :boot_once, :connect, :disconnect, :no_boot, :poweroff, nil) —

    The state of the boot media.,no_boot: Do not boot from the device,boot_once: Boot from the device once and then notthereafter,boot_always: Boot from the device each time the serveris rebooted,connect: Connect the virtual media device and set to boot_always,disconnect: Disconnects the virtual media device and set to no_boot,poweroff: Power off the server



33
 
# File 'lib/ansible/ruby/modules/generated/remote_management/hpilo/hpilo_boot.rb', line 33

attribute :state