vSAN Management API
| Local Methods | ||
Managed Object Types | Data Object Types | All Properties | All Methods |
Managed Object - VsanVumSystem(vim.cluster.VsanVumSystem)
- See also
- HostSystem, Task, VsanVumSystemConfig
- Since
- 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 support.broadcom.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 | xsd:string |
Username for support.broadcom.com
Since 6.6.1 |
password | xsd:string |
Password for support.broadcom.com
Since 6.6.1 |
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
GetVsanVumConfig(getVsanVumConfig)
Fetch vSAN VUM integration configurable settings See VsanVumSystemConfig for more detail information about all configurable settings for vSAN VUM integration.- 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
VsanHostUpdateFirmware(updateHostFirmware)
Deprecated. As of vSphere API 8.0. 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 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 6.7U1 |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a Task |
Faults
Type | Description |
---|---|
NotSupported | |
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
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 6.7U1
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VsanVumSystem used to make the method call. |
db | xsd:string |
The new DB in JSON format
Since vSAN 6.7U1 |
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
Top of page | Local Methods | ||
Managed Object Types | Data Object Types | All Properties | All Methods |