Managed Object - HostBootDeviceSystem(vim.host.BootDeviceSystem)

Property of: HostConfigManager
See also: HostBootDeviceInfo
Since: VI API 2.5

Managed Object Description

The HostBootDeviceSystem managed object provides methods to query and update a host boot device configuration.

Properties

Name	Type	Description
None

Methods

Methods defined in this Managed Object
QueryBootDevices, UpdateBootDevice

QueryBootDevices(queryBootDevices)

Retrieves a list of the available boot devices for the host system.

Required Privileges: System.Read

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the HostBootDeviceSystem used to make the method call.

Return Value

Type	Description
HostBootDeviceInfo	The boot device information for the host. The returned object has a list of HostBootDevice data objects; each boot device object defines a description and a key to identify the device. The order of devices in the list is unpredictable. The returned HostBootDeviceInfo data object also contains the key of the current boot device.

Faults

Type	Description
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="QueryBootDevices" type="vim25:QueryBootDevicesRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="QueryBootDevicesResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vim25:HostBootDeviceInfo" minOccurs="0"/>
                     </sequence>
                  </complexType>
               </element>

UpdateBootDevice(updateBootDevice)

Sets the current boot device for the host system.

Required Privileges: Host.Config.Maintenance

Parameters

Name

Type

Description

_this

ManagedObjectReference

A reference to the HostBootDeviceSystem used to make the method call.

key P

xsd:string

The key of the HostBootDevice from which the host will boot.

Since VI API 2.5

P Required privilege: key

Return Value

Type	Description
None

Faults

Type	Description
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="UpdateBootDevice" type="vim25:UpdateBootDeviceRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="UpdateBootDeviceResponse">
                  <complexType/>
               </element>