Add-VMGpuPartitionAdapter
Adds a GPU partition adapter to a virtual machine.
Syntax
Add-VMGpuPartitionAdapter
[-CimSession <CimSession[]>]
[-ComputerName <String[]>]
[-Credential <PSCredential[]>]
[-VMName] <String[]>
[-Passthru]
[-InstancePath <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>] Add-VMGpuPartitionAdapter
[-VM] <VirtualMachine[]>
[-Passthru]
[-InstancePath <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>] Description
The Add-VMGpuPartitionAdapter cmdlet adds a GPU partition adapter to a virtual machine. With no
parameter, it assigns a full partition from an assignable GPU to a VM.
Examples
Example 1
$vm = Get-VM -Name "TestVM"
Add-VMGpuPartitionAdapter -VM $vmThis example assigns a partition to a specific VM object.
Example 2
$vm = Get-VM -Name "TestVM"
Add-VMGpuPartitionAdapter -VM $vm -InstancePath "GPUInstancePath"This example assigns a partition from a specific GPU to a VM where the instance path is the GPU device ID name on the host.
Parameters
-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 from which virtual machines are to be retrieved. NetBIOS names,
IP addresses, and fully qualified domain names are allowable. 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 |
-InstancePath
Represents the Device Instance path of a GPU in the host. This value can be obtained from the
"Name" property of the command Get-VMHostPartitionableGpu.
| Type: | String |
| 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 on which the network adapter is to be added.
| Type: | VirtualMachine[] |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-VMName
Specifies the name of the virtual machine on which the network adapter is to be added.
| 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
Microsoft.HyperV.PowerShell.VirtualMachine[]
String[]
Outputs
Microsoft.HyperV.PowerShell.VMGpuPartitionAdapter