Managed Object - VsanUpdateManager(vim.host.VsanUpdateManager)

See also
ComputeResource, HostMaintenanceSpec, Task, VsanHclFirmwareUpdateSpec, VsanVibInstallPreflightStatus, VsanVibScanResult, VsanVibSpec
Since
vSAN API 6.6


Managed Object Description

Generic engine that can install VIBs onto ESX (optimized for vSAN clusters) using either rolling installs or one-shot. In addition to VIBs, it can also install firmware updates for select hardware. The Managed Entity can be accessed through MOID of vsan-update-manager, through vSAN service at ESXi host side.

Properties

Name Type Description
None

Methods

Methods defined in this Managed Object
VsanVibInstall_Task, VsanVibInstallPreflightCheck, VsanVibScan

VsanVibInstall_Task(vsanVibInstall)

Takes a list of VIBs, firmwares, and installs those VIBs/FWs on the hosts referenced in the VIB/FW specs. If a scan has previously been performed, the results can be passed in. If not provided, a scan is done implicitly. Install may require ESX maintenance mode, and reboots, depending on the VIB to be installed and the state of the host. Any firmware update will always require maintenance mode and a host reboot.

Combined Privileges Required (on vSphere ManagedEntity):
Privileges Required on
Host.Config.Storage
Host.Config.Settings
ClusterComputeResource
* The RootFolder entity in above table refers to the vCenter server itself in the vCenter UI
* The ClusterComputeResource entity in above table refers to the cluster which is being operated on

* The Required Privileges section below is not used, please ignore.
Required Privileges
System.Read

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VsanUpdateManager used to make the method call.
cluster*ManagedObjectReference
to a ComputeResource

Optional cluster this scan is happening in reference to.

Since vSAN API 6.6
vibSpecs*VsanVibSpec[]

List of VIB specs to installed (context is always a single host)

Since vSAN API 6.6
scanResults*VsanVibScanResult[]

List of VIB scan results obtained from VsanVibScan()

Since vSAN API 6.6
firmwareSpecs*VsanHclFirmwareUpdateSpec[]

List of Firmware spec to be installed (context is always a single host and vmhba)

Since vSAN API 6.6
maintenanceSpec*HostMaintenanceSpec

Maintenance spec to pass to EnterMaintenanceMode_Task() In case of non-rolling installs, no other vSAN action than 'noAction' is allowed.

Since vSAN API 6.6
rolling*xsd:boolean

True (default) means a 1-host-at-a-time rolling install will be performed.

Since vSAN API 6.6
noSigCheck*xsd:boolean

Skip signature checking, should not be used outside of fully trusted test environments. Default: False

Since vSAN API 6.6
*Need not be set

Return Value

Type Description
ManagedObjectReference
to a Task
A task

Faults

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

Events

Type
None

Show WSDL type definition



VsanVibInstallPreflightCheck(vsanVibInstallPreflightCheck)

Performs pre-flight checks for a VIB install. Details of checks performed are documented in the result structure.

Combined Privileges Required (on vSphere ManagedEntity):
Privileges Required on
System.Read ClusterComputeResource
* The RootFolder entity in above table refers to the vCenter server itself in the vCenter UI
* The ClusterComputeResource entity in above table refers to the cluster which is being operated on

* The Required Privileges section below is not used, please ignore.
Required Privileges
System.Read

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VsanUpdateManager used to make the method call.
cluster*ManagedObjectReference
to a ComputeResource

Cluster for which to perform preflight check

Since vSAN API 6.6
*Need not be set

Return Value

Type Description
VsanVibInstallPreflightStatusPreflight check results

Faults

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

Events

Type
None

Show WSDL type definition



VsanVibScan(vsanVibScan)

Takes a list of VIBs and a list of hosts, and determines which VIBs would be installed, what the requirements are (e.g. maintenance mode, reboot) and which existing VIBs (if any) they are overriding. Doesn't perform any actual install, but instead just provides information on "what if".

Combined Privileges Required (on vSphere ManagedEntity):
Privileges Required on
System.Read ClusterComputeResource
* The RootFolder entity in above table refers to the vCenter server itself in the vCenter UI
* The ClusterComputeResource entity in above table refers to the cluster which is being operated on

* The Required Privileges section below is not used, please ignore.
Required Privileges
System.Read

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VsanUpdateManager used to make the method call.
cluster*ManagedObjectReference
to a ComputeResource

Optional cluster this scan is happening in reference to.

Since vSAN API 6.6
vibSpecsVsanVibSpec[]

List of VIB specs to check (one entry per host)
*Need not be set

Return Value

Type Description
VsanVibScanResult[]List of VIBs that would be installed. Each such result is for a single host, single VIB.

Faults

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

Events

Type
None

Show WSDL type definition