VMware vSphere Automation SDK Perl
The VMware vSphere Automation SDK for Perl supports the client-side vSphere Automation API for access to vSphere services and capabilities
 All Classes Files Functions
List of all members
Com::Vmware::Vcenter::Vm::Hardware::Boot::UpdateSpec Class Reference
Inheritance diagram for Com::Vmware::Vcenter::Vm::Hardware::Boot::UpdateSpec:

Avaliable Methods

public method set_enter_setup_mode ()
 
public method get_delay ()
 
public method set_retry ()
 
public method set_type ()
 
public method get_retry ()
 
public method set_efi_legacy_boot ()
 
public method set_retry_delay ()
 
public method set_network_protocol ()
 
public method get_network_protocol ()
 
public method new ()
 
public method get_type ()
 
public method set_delay ()
 
public method get_enter_setup_mode ()
 
public method get_retry_delay ()
 
public method get_efi_legacy_boot ()
 

Detailed Description

The Com::Vmware::Vcenter::Vm::Hardware::Boot::UpdateSpec class describes the updates to the settings used when booting a virtual machine.

Member Function Documentation

public method Com::Vmware::Vcenter::Vm::Hardware::Boot::UpdateSpec::get_delay ( )

Gets the value of 'delay' property.

Return values
delay- The current value of the field. Delay in milliseconds before beginning the firmware boot process when the virtual machine is powered on. This delay may be used to provide a time window for users to connect to the virtual machine console and enter BIOS setup mode. Optional#
Code:
click to view
public method Com::Vmware::Vcenter::Vm::Hardware::Boot::UpdateSpec::get_efi_legacy_boot ( )

Gets the value of 'efi_legacy_boot' property.

Return values
efi_legacy_boot- The current value of the field. Flag indicating whether to use EFI legacy boot mode. Optional#
Code:
click to view
public method Com::Vmware::Vcenter::Vm::Hardware::Boot::UpdateSpec::get_enter_setup_mode ( )

Gets the value of 'enter_setup_mode' property.

Return values
enter_setup_mode- The current value of the field. Flag indicating whether the firmware boot process should automatically enter setup mode the next time the virtual machine boots. Note that this flag will automatically be reset to false once the virtual machine enters setup mode. Optional#
Code:
click to view
public method Com::Vmware::Vcenter::Vm::Hardware::Boot::UpdateSpec::get_network_protocol ( )

Gets the value of 'network_protocol' property.

Return values
network_protocol- The current value of the field. Protocol to use when attempting to boot the virtual machine over the network. Optional#
Code:
click to view
public method Com::Vmware::Vcenter::Vm::Hardware::Boot::UpdateSpec::get_retry ( )

Gets the value of 'retry' property.

Return values
retry- The current value of the field. Flag indicating whether the virtual machine should automatically retry the boot process after a failure. Optional#
Code:
click to view
public method Com::Vmware::Vcenter::Vm::Hardware::Boot::UpdateSpec::get_retry_delay ( )

Gets the value of 'retry_delay' property.

Return values
retry_delay- The current value of the field. Delay in milliseconds before retrying the boot process after a failure; applicable only when :attr:Com::Vmware::Vcenter::Vm::Hardware::Boot::Info.retry is true. Optional#
Code:
click to view
public method Com::Vmware::Vcenter::Vm::Hardware::Boot::UpdateSpec::get_type ( )

Gets the value of 'type' property.

Return values
type- The current value of the field. Firmware type to be used by the virtual machine. Optional#
Code:
click to view
public method Com::Vmware::Vcenter::Vm::Hardware::Boot::UpdateSpec::new ( )

Constructor to initialize the Com::Vmware::Vcenter::Vm::Hardware::Boot::UpdateSpec structure

Return values
Blessedobject
Code:
click to view
public method Com::Vmware::Vcenter::Vm::Hardware::Boot::UpdateSpec::set_delay ( )

Sets the given value for 'delay' property.

Parameters
delay- New value for the field. Delay in milliseconds before beginning the firmware boot process when the virtual machine is powered on. This delay may be used to provide a time window for users to connect to the virtual machine console and enter BIOS setup mode.
Code:
click to view
public method Com::Vmware::Vcenter::Vm::Hardware::Boot::UpdateSpec::set_efi_legacy_boot ( )

Sets the given value for 'efi_legacy_boot' property.

Parameters
efi_legacy_boot- New value for the field. Flag indicating whether to use EFI legacy boot mode.
Code:
click to view
public method Com::Vmware::Vcenter::Vm::Hardware::Boot::UpdateSpec::set_enter_setup_mode ( )

Sets the given value for 'enter_setup_mode' property.

Parameters
enter_setup_mode- New value for the field. Flag indicating whether the firmware boot process should automatically enter setup mode the next time the virtual machine boots. Note that this flag will automatically be reset to false once the virtual machine enters setup mode.
Code:
click to view
public method Com::Vmware::Vcenter::Vm::Hardware::Boot::UpdateSpec::set_network_protocol ( )

Sets the given value for 'network_protocol' property.

Parameters
network_protocol- New value for the field. Protocol to use when attempting to boot the virtual machine over the network.
Code:
click to view
public method Com::Vmware::Vcenter::Vm::Hardware::Boot::UpdateSpec::set_retry ( )

Sets the given value for 'retry' property.

Parameters
retry- New value for the field. Flag indicating whether the virtual machine should automatically retry the boot process after a failure.
Code:
click to view
public method Com::Vmware::Vcenter::Vm::Hardware::Boot::UpdateSpec::set_retry_delay ( )

Sets the given value for 'retry_delay' property.

Parameters
retry_delay- New value for the field. Delay in milliseconds before retrying the boot process after a failure; applicable only when :attr:Com::Vmware::Vcenter::Vm::Hardware::Boot::Info.retry is true.
Code:
click to view
public method Com::Vmware::Vcenter::Vm::Hardware::Boot::UpdateSpec::set_type ( )

Sets the given value for 'type' property.

Parameters
type- New value for the field. Firmware type to be used by the virtual machine.
Code:
click to view

The documentation for this class was generated from the following file: