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

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

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

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="RetrieveVgpuDeviceInfo" type="vim25:RetrieveVgpuDeviceInfoRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="RetrieveVgpuDeviceInfoResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vim25:VirtualMachineVgpuDeviceInfo" minOccurs="0" maxOccurs="unbounded"/>
                     </sequence>
                  </complexType>
               </element>

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

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="RetrieveVgpuProfileInfo" type="vim25:RetrieveVgpuProfileInfoRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="RetrieveVgpuProfileInfoResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vim25:VirtualMachineVgpuProfileInfo" minOccurs="0" maxOccurs="unbounded"/>
                     </sequence>
                  </complexType>
               </element>

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

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="UpdateGraphicsConfig" type="vim25:UpdateGraphicsConfigRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="UpdateGraphicsConfigResponse">
                  <complexType/>
               </element>

vSphere Web Services API

Managed Object - HostGraphicsManager(vim.host.GraphicsManager)

Managed Object Description

IsSharedGraphicsActive(isSharedGraphicsActive)

RefreshGraphicsManager(refresh)

RetrieveVgpuDeviceInfo(retrieveVgpuDeviceInfo)

RetrieveVgpuProfileInfo(retrieveVgpuProfileInfo)

UpdateGraphicsConfig(updateGraphicsConfig)