Test Search vSphere Web Services API
|
| Local Properties | Local Methods | |
| Managed Object Types | Data Object Types | All Properties | All Methods |
Managed Object - HostGraphicsManager(vim.host.GraphicsManager)
- Property of
- HostConfigManager
- Extends
- ExtensibleManagedObject
- See also
- HostGraphicsConfig, HostGraphicsInfo, HostSharedGpuCapabilities, VirtualMachineVgpuDeviceInfo, VirtualMachineVgpuProfileInfo
- Since
- vSphere API Release 5.5
Managed Object Description
This managed object manages the graphics state of the host.Properties
| Name | Type | Description |
|---|---|---|
| graphicsConfig* P | HostGraphicsConfig |
Graphics Configuration
Since vSphere API Release 6.5 |
| graphicsInfo* P | HostGraphicsInfo[] |
Array of graphics information
|
| sharedGpuCapabilities* P | HostSharedGpuCapabilities[] |
Array of shared passthru GPU capablities. See HostSharedGpuCapabilities Since vSphere API Release 6.7 |
| sharedPassthruGpuTypes* P | xsd:string[] |
Array of shared passthru GPU types. These GPU types may be enabled
when specific host hardware is present. Example values are "grid_k120q"
and "grid_k240q".
Since vSphere API Release 6.0 |
| Properties inherited from ExtensibleManagedObject | ||
| availableField, value | ||
Methods
| Methods defined in this Managed Object |
|---|
| IsSharedGraphicsActive, RefreshGraphicsManager, RetrieveVgpuDeviceInfo, RetrieveVgpuProfileInfo, UpdateGraphicsConfig |
| Methods inherited from ExtensibleManagedObject |
| setCustomValue |
IsSharedGraphicsActive(isSharedGraphicsActive)
Indicate if shared graphics device is active on the host.- Required Privileges
- System.Read
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostGraphicsManager used to make the method call. |
Return Value
| Type | Description |
|---|---|
| xsd:boolean |
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
RefreshGraphicsManager(refresh)
Refresh the available graphics information.- Required Privileges
- Host.Config.Settings
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostGraphicsManager used to make the method call. |
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. |
Events
| Type | |
|---|---|
| None | |
Show WSDL type definition
RetrieveVgpuDeviceInfo(retrieveVgpuDeviceInfo)
- Required Privileges
- System.Read
- Since
- vSphere API Release 7.0.3.0
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostGraphicsManager used to make the method call. |
Return Value
| Type | Description |
|---|---|
| VirtualMachineVgpuDeviceInfo[] |
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
RetrieveVgpuProfileInfo(retrieveVgpuProfileInfo)
- Required Privileges
- System.Read
- Since
- vSphere API Release 7.0.3.0
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostGraphicsManager used to make the method call. |
Return Value
| Type | Description |
|---|---|
| VirtualMachineVgpuProfileInfo[] |
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
UpdateGraphicsConfig(updateGraphicsConfig)
Update graphics configuration- Required Privileges
- Host.Config.Settings
- Since
- vSphere API Release 6.5
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostGraphicsManager used to make the method call. |
| config | HostGraphicsConfig |
Since vSphere API Release 6.5 |
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. |
Events
| Type | |
|---|---|
| None | |
Show WSDL type definition
| Top of page | Local Properties | Local Methods | |
| Managed Object Types | Data Object Types | All Properties | All Methods |