File: BootDeviceSystem.rst

package info (click to toggle)
python-pyvmomi 6.7.1-4
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 14,984 kB
  • sloc: python: 9,206; xml: 77; makefile: 9
file content (70 lines) | stat: -rw-r--r-- 1,426 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
.. _str: https://docs.python.org/2/library/stdtypes.html

.. _vim.Task: ../../vim/Task.rst

.. _VI API 2.5: ../../vim/version.rst#vimversionversion2

.. _vim.host.BootDeviceInfo: ../../vim/host/BootDeviceInfo.rst

.. _vmodl.fault.NotSupported: ../../vmodl/fault/NotSupported.rst


vim.host.BootDeviceSystem
=========================
  The `HostBootDeviceSystem`_ managed object provides methods to query and update a host boot device configuration.


:since: `VI API 2.5`_


Attributes
----------


Methods
-------


QueryBootDevices():
   Retrieves a list of the available boot devices for the host system.


  Privilege:
               System.Read



  Args:


  Returns:
    `vim.host.BootDeviceInfo`_:
         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.


UpdateBootDevice(key):
   Sets the current boot device for the host system.


  Privilege:
               Host.Config.Maintenance



  Args:
    key (`str`_):
       The `key`_ of the `HostBootDevice`_ from which the host will boot.




  Returns:
    None
         

  Raises:

    `vmodl.fault.NotSupported`_: 
       if the host does not support updating bootDevices.