Set-VMGpuPartitionAdapter

Module:

Hyper-V

Assigns a partition of a GPU to a virtual machine.

Syntax

Set-VMGpuPartitionAdapter
   [-CimSession <CimSession[]>]
   [-ComputerName <String[]>]
   [-Credential <PSCredential[]>]
   [-VMName] <String[]>
   [-Passthru]
   [-AdapterId <String>]
   [-MinPartitionVRAM <UInt64>]
   [-MaxPartitionVRAM <UInt64>]
   [-OptimalPartitionVRAM <UInt64>]
   [-MinPartitionEncode <UInt64>]
   [-MaxPartitionEncode <UInt64>]
   [-OptimalPartitionEncode <UInt64>]
   [-MinPartitionDecode <UInt64>]
   [-MaxPartitionDecode <UInt64>]
   [-OptimalPartitionDecode <UInt64>]
   [-MinPartitionCompute <UInt64>]
   [-MaxPartitionCompute <UInt64>]
   [-OptimalPartitionCompute <UInt64>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-VMGpuPartitionAdapter
   [-VM] <VirtualMachine[]>
   [-Passthru]
   [-AdapterId <String>]
   [-MinPartitionVRAM <UInt64>]
   [-MaxPartitionVRAM <UInt64>]
   [-OptimalPartitionVRAM <UInt64>]
   [-MinPartitionEncode <UInt64>]
   [-MaxPartitionEncode <UInt64>]
   [-OptimalPartitionEncode <UInt64>]
   [-MinPartitionDecode <UInt64>]
   [-MaxPartitionDecode <UInt64>]
   [-OptimalPartitionDecode <UInt64>]
   [-MinPartitionCompute <UInt64>]
   [-MaxPartitionCompute <UInt64>]
   [-OptimalPartitionCompute <UInt64>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-VMGpuPartitionAdapter
   [-VMGpuPartitionAdapter] <VMGpuPartitionAdapter[]>
   [-Passthru]
   [-MinPartitionVRAM <UInt64>]
   [-MaxPartitionVRAM <UInt64>]
   [-OptimalPartitionVRAM <UInt64>]
   [-MinPartitionEncode <UInt64>]
   [-MaxPartitionEncode <UInt64>]
   [-OptimalPartitionEncode <UInt64>]
   [-MinPartitionDecode <UInt64>]
   [-MaxPartitionDecode <UInt64>]
   [-OptimalPartitionDecode <UInt64>]
   [-MinPartitionCompute <UInt64>]
   [-MaxPartitionCompute <UInt64>]
   [-OptimalPartitionCompute <UInt64>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Set-VMGpuPartitionAdapter cmdlet assigns a partition of a GPU to a virtual machine. Running the command against a virtual machine assigns a full partition. Additional parameters exist to assign more specific options to a VM.

Examples

Example 1

$vm = Get-VM "Test"
Set-VMGpuPartitionAdapter -VM $vm

This example assign a partition to a VM passing a VM object.

Parameters

-AdapterId

A VM's GPU partition identification number used to display the GPU information assigned to a VM.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-CimSession

Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.

Type:	CimSession[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ComputerName

Specifies one or more Hyper-V hosts on the virtual network adapters are to be retrieved. NetBIOS names, IP addresses, and fully qualified domain names are allowed. The default is the local computer. Use localhost or a dot (.) to specify the local computer explicitly.

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Credential

Specifies one or more user accounts that have permission to perform this action. The default is the current user.

Type:	PSCredential[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-MaxPartitionCompute

The maximum number of compute assigned by the host GPU. This is defined by the manufacturer's driver.

Type:	UInt64
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-MaxPartitionDecode

The maximum number of decoders assigned by the host GPU. This is defined by the manufacturer's driver.

Type:	UInt64
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-MaxPartitionEncode

The maximum number of encoders assigned by the host GPU. This is defined by the manufacturer's driver.

Type:	UInt64
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-MaxPartitionVRAM

The maximum VRAM in bytes supported by the host GPU. This is defined by the manufacturer's driver.

Type:	UInt64
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-MinPartitionCompute

The minimum number of compute assigned by the host GPU. This is defined by the manufacturer's driver.

Type:	UInt64
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-MinPartitionDecode

The minimum number of decoders assigned by the host GPU. This is defined by the manufacturer's driver.

Type:	UInt64
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-MinPartitionEncode

The minimum number of encoders assigned by the host GPU. This is defined by the manufacturer's driver.

Type:	UInt64
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-MinPartitionVRAM

The minimum VRAM in bytes supported by the host GPU. This is defined by the manufacturer's driver.

Type:	UInt64
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-OptimalPartitionCompute

The optimal number of compute assigned by the host GPU. This is defined by the manufacturer's driver.

Type:	UInt64
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-OptimalPartitionDecode

The optimal number of decoders assigned by the host GPU. This is defined by the manufacturer's driver.

Type:	UInt64
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-OptimalPartitionEncode

The optimal number of encoders assigned by the host GPU. This is defined by the manufacturer's driver.

Type:	UInt64
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-OptimalPartitionVRAM

The optimal VRAM in bytes supported by the host GPU. This is defined by the manufacturer's driver.

Type:	UInt64
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Passthru

Returns an object for each process that the cmdlet started.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-VM

Specifies the virtual machine whose virtual network adapters are to be retrieved. The asterisk (*) is the wildcard. If it is specified the cmdlet returns virtual network adapters from every virtual machine in the system.

Type:	VirtualMachine[]
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-VMGpuPartitionAdapter

GPU partition object obtained from Get-VMGpuPartitionAdapter.

Type:	VMGpuPartitionAdapter[]
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-VMName

Specifies the name of the virtual machine whose network adapters are to be retrieved.

Type:	String[]
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

String[]

Microsoft.HyperV.PowerShell.VirtualMachine[]

Microsoft.HyperV.PowerShell.VMGpuPartitionAdapter[]

Outputs

Microsoft.HyperV.PowerShell.VMGpuPartitionAdapter

Related Links

• Add-VMGpuPartitionAdapter
• Get-VMGpuPartitionAdapter
• Remove-VMGpuPartitionAdapter