# Managed Object - VsanVumSystem(vim.cluster.VsanVumSystem)

See also
  HostSystem, Task, VsanVumSystemConfig
Since
  vSAN API 6.6.1

## Managed Object Description

As vSAN VUM integration feature is mostly an automatic backend feature, so currently only get and set config methods are available in its control path. The Managed Entity can be accessed through MOID of vsan-vum-system at vCenter server side.

Properties

Name | Type | Description
--- | --- | ---
None

Methods

Methods defined in this Managed Object
FetchIsoDepotCookie, GetVsanVumConfig, VsanHostUpdateFirmware, VsanVcUploadReleaseDb

# FetchIsoDepotCookie(fetchIsoDepotCookie)

Fetch and save my.vmware.com cookie string for VMware ISO download authentication

Required Privileges
  Global.Settings

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the VsanVumSystem used to make the method call.
username P | xsd:string | Username for my.vmware.com Since vSAN API 6.6.1
password P | xsd:string | Password for my.vmware.com Since vSAN API 6.6.1

P Required privilege - see tooltip for details

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.
VsanFault |

Events

Type
None

Show WSDL type definition
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="FetchIsoDepotCookie" type="vsan:FetchIsoDepotCookieRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="FetchIsoDepotCookieResponse"> <complexType/> </element>

# GetVsanVumConfig(getVsanVumConfig)

Fetch vSAN VUM integration configurable settings See VsanVumSystemConfig for more detail information about all configurable settings for vSAN VUM integration. See vim.cluster.VsanVumSystem#SetVsanVumConfig for set these configurable settings.

Required Privileges
  System.Read

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the VsanVumSystem used to make the method call.

Return Value

Type | Description
--- | ---
VsanVumSystemConfig |

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:vsan="urn:vsan" name="GetVsanVumConfig" type="vsan:GetVsanVumConfigRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="GetVsanVumConfigResponse"> <complexType> <sequence> <element name="returnval" type="vsan:VsanVumSystemConfig"/> </sequence> </complexType> </element>

# VsanHostUpdateFirmware(updateHostFirmware)

Perform full stack firmware update for the given vSAN host. API look for the current firmware version on the host and perform a firmware update if a new firmware version is available. This API returns a task and caller should monitor the task to track firmware upgrade status. Upon successful completion of the returned Task, its result field will be populated with a flag to notify whether host reboot is required.

Required Privileges
  None
Since
  vSAN API vSAN 6.7U1

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the VsanVumSystem used to make the method call.
host P | ManagedObjectReference to a HostSystem | Target host Since vSAN API vSAN 6.7U1

P Required privilege: host

Return Value

Type | Description
--- | ---
ManagedObjectReference to a Task |

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.
VsanFault |

Events

Type
None

Show WSDL type definition
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanHostUpdateFirmware" type="vsan:VsanHostUpdateFirmwareRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanHostUpdateFirmwareResponse"> <complexType> <sequence> <element name="returnval" type="vsan:ManagedObjectReference"/> </sequence> </complexType> </element>

# VsanVcUploadReleaseDb(uploadReleaseDb)

Upload a release DB in JSON format. The DB will replace any existing release DB, even if the existing DB may appear newer.

Required Privileges
  Global.Settings
Since
  vSAN API vSAN 6.7U1

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the VsanVumSystem used to make the method call.
db P | xsd:string | The new DB in JSON format Since vSAN API vSAN 6.7U1

P Required privilege: db

Return Value

Type | Description
--- | ---
None

Faults

Type | Description
--- | ---
NotFound |
NotSupported | Thrown if run directly on an ESX Server host.
RuntimeFault | Thrown 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
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanVcUploadReleaseDb" type="vsan:VsanVcUploadReleaseDbRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanVcUploadReleaseDbResponse"> <complexType/> </element>