# Managed Object - HostGraphicsManager(vim.host.GraphicsManager)

Property of
  HostConfigManager
Extends
  ExtensibleManagedObject
See also
  HostGraphicsConfig, HostGraphicsInfo, HostSharedGpuCapabilities, VirtualMachineVgpuDeviceInfo, VirtualMachineVgpuProfileInfo
Since
  vSphere API 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 6.5
graphicsInfo* P | HostGraphicsInfo[] | Array of graphics information
sharedGpuCapabilities* P | HostSharedGpuCapabilities[] | Array of shared passthru GPU capablities. See HostSharedGpuCapabilities Since vSphere API 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 6.0
Properties inherited from ExtensibleManagedObject
availableField, value

*May not be presentP Required privilege: System.Read

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
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="IsSharedGraphicsActive" type="vsan:IsSharedGraphicsActiveRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="IsSharedGraphicsActiveResponse"> <complexType> <sequence> <element name="returnval" type="xsd:boolean"/> </sequence> </complexType> </element>

# 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
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="RefreshGraphicsManager" type="vsan:RefreshGraphicsManagerRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="RefreshGraphicsManagerResponse"> <complexType/> </element>

# RetrieveVgpuDeviceInfo(retrieveVgpuDeviceInfo)

Required Privileges
  System.Read
Since
  vSphere API 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
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="RetrieveVgpuDeviceInfo" type="vsan:RetrieveVgpuDeviceInfoRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="RetrieveVgpuDeviceInfoResponse"> <complexType> <sequence> <element name="returnval" type="vsan:VirtualMachineVgpuDeviceInfo" minOccurs="0" maxOccurs="unbounded"/> </sequence> </complexType> </element>

# RetrieveVgpuProfileInfo(retrieveVgpuProfileInfo)

Required Privileges
  System.Read
Since
  vSphere API 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
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="RetrieveVgpuProfileInfo" type="vsan:RetrieveVgpuProfileInfoRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="RetrieveVgpuProfileInfoResponse"> <complexType> <sequence> <element name="returnval" type="vsan:VirtualMachineVgpuProfileInfo" minOccurs="0" maxOccurs="unbounded"/> </sequence> </complexType> </element>

# UpdateGraphicsConfig(updateGraphicsConfig)

Update graphics configuration

Required Privileges
  Host.Config.Settings
Since
  vSphere API 6.5

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostGraphicsManager used to make the method call.
config P | HostGraphicsConfig | Since vSphere API 6.5

P Required privilege: config

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
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="UpdateGraphicsConfig" type="vsan:UpdateGraphicsConfigRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="UpdateGraphicsConfigResponse"> <complexType/> </element>