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
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
|
.. _str: https://docs.python.org/2/library/stdtypes.html
.. _bool: https://docs.python.org/2/library/stdtypes.html
.. _vim.Task: ../../vim/Task.rst
.. _VI API 2.5: ../../vim/version.rst#vimversionversion2
.. _vim.fault.FileFault: ../../vim/fault/FileFault.rst
.. _vim.fault.InvalidState: ../../vim/fault/InvalidState.rst
.. _vim.fault.InvalidBundle: ../../vim/fault/InvalidBundle.rst
.. _vim.fault.MismatchedBundle: ../../vim/fault/MismatchedBundle.rst
.. _RestoreFirmwareConfiguration: ../../vim/host/FirmwareSystem.rst#restoreConfiguration
.. _QueryFirmwareConfigUploadURL: ../../vim/host/FirmwareSystem.rst#queryConfigUploadURL
vim.host.FirmwareSystem
=======================
The `HostFirmwareSystem`_ managed object type provides access to the firmware of an embedded ESX host. It provides operations to backup, restore, and reset the configuration of an embedded ESX host.
:since: `VI API 2.5`_
Attributes
----------
Methods
-------
ResetFirmwareToFactoryDefaults():
Reset the configuration to factory defaults.This method will reset all configuration options, including the "admin" password, to the factory defaults. The host will be rebooted immediately. The host needs to be in maintenance mode before this operation can be performed.
Privilege:
Host.Config.Firmware
Args:
Returns:
None
Raises:
`vim.fault.InvalidState`_:
if the host is not in maintenance mode.
BackupFirmwareConfiguration():
Backup the configuration of the host.The method generates a bundle containing the host configuration. You can use an HTTP GET operation to download the bundle from the returned URL.
Privilege:
Host.Config.Firmware
Args:
Returns:
`str`_:
URL that identifies the location of the backup bundle.
QueryFirmwareConfigUploadURL():
Return the URL on the host to which the configuration bundle must be uploaded for a restore operation. See `RestoreFirmwareConfiguration`_ .
Privilege:
Host.Config.Firmware
Args:
Returns:
`str`_:
URL that identifies the location for the restore operation.
RestoreFirmwareConfiguration(force):
Restore the configuration of the host to that specified in the bundle.Upload the bundle to the URL returned by the `QueryFirmwareConfigUploadURL`_ method. The `RestoreFirmwareConfiguration`_ method will restore all configuration options, including the "admin" password, to the values in the bundle. The host will be rebooted immediately. The host must be in maintenance mode before this operation can be performed.
Privilege:
Host.Config.Firmware
Args:
force (`bool`_):
Forces application of the configuration even if the bundle is mismatched.
Returns:
None
Raises:
`vim.fault.InvalidState`_:
if the host is not in maintenance mode.
`vim.fault.FileFault`_:
if the file was not accessible.
`vim.fault.MismatchedBundle`_:
if the uuid / build number in the bundle does not match the uuid / build number of the host and parameter 'force' is set to false.
`vim.fault.InvalidBundle`_:
if the bundle does not have the expected contents.
|
