Package prlsdkapi :: Class BootDevice

Class BootDevice

object --+    
         |    
   _Handle --+
             |
            BootDevice

Provides methods for managing boot device in a virtual machine. An object contains information about an individual boot device.

Instance Methods

[hide private]

remove(self)
Remove the boot device from the boot priority list.

get_type(self)
Return the boot device type.

set_type(self, nDevType)
Set the boot device type.

get_index(self)
Obtain the boot device index.

set_index(self, nDevIndex)
Set the boot device index.

get_sequence_index(self)
Obtain the sequence index of the boot device in the boot priority list.

set_sequence_index(self, nSequenceIndex)
Assign a sequence index to a boot device in the boot priority list.

is_in_use(self)
Determine whether the boot device is enabled or disabled.

set_in_use(self, bInUse)
Enable or disable the boot device in the boot priority list.

Inherited from _Handle: __del__, __init__, add_ref, free, from_string, get_handle_type, get_package_id, reg_event_handler, unreg_event_handler

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

get_type(self)

Return the boot device type. Device type is a property that, together with device index, is used to uniquely identify a device in the virtual machine boot priority list.

Returns:: The device type - one of the constants with the PDE_ prefix, such as: PDE_FLOPPY_DISK, PDE_OPTICAL_DISK, PDE_HARD_DISK.
Overrides: _Handle.get_type

set_type(self, nDevType)

Set the boot device type. Use this function when adding a device to the boot device priority list. Device type is a property that, together with device index, is used to uniquely identify a device in a virtual machine

Parameters:

nDevType - The device type to set. Can be one of the constants with the PDE_ prefix, such as: PDE_FLOPPY_DISK, PDE_OPTICAL_DISK, PDE_HARD_DISK.

get_index(self)

Obtain the boot device index.

Returns:: Integer. The boot device index.

set_index(self, nDevIndex)

Set the boot device index. Device index is a property that, together with device type, is used to uniquely identify a device in the virtual machine boot priority list. The index must be the same index the device has in the main virtual machine configuration or it will not be recognized during boot.

Parameters:

nDevIndex - Integer. The device index to set.

get_sequence_index(self)

Obtain the sequence index of the boot device in the boot priority list.

Returns:: Integer. The boot device sequence index.

set_sequence_index(self, nSequenceIndex)

Assign a sequence index to a boot device in the boot priority list.

Parameters:

nSequenceIndex - Integer. The sequence index to set (begins with 0).

is_in_use(self)

Determine whether the boot device is enabled or disabled.

Returns:: Boolean. True indicates that the device is enabled. False indicates otherwise.

set_in_use(self, bInUse)

Enable or disable the boot device in the boot priority list.

Parameters:

bInUse - Boolean. Set to True to enable the device. Set to False to disable it.