Skip to content

Commit cfb03b8

Browse files
LolaOysdwheeler
authored andcommitted
Add Set-VMGpuPartitionAdapter to Hyper-V module, add review comments
Add Set-VMGpuPartitionAdapter to Hyper-V module., add review comments
1 parent d0cfe20 commit cfb03b8

File tree

7 files changed

+267
-93
lines changed

7 files changed

+267
-93
lines changed

docset/winserver2022-ps/hyper-v/Add-VMGpuPartitionAdapter.md

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
description: Add GPU Partition adapter to a virtual machine
2+
description: Adds a GPU partition adapter to a virtual machine.
33
external help file: Microsoft.HyperV.PowerShell.Cmdlets.dll-Help.xml
44
Module Name: Hyper-V
55
ms.date: 09/22/2022
@@ -10,7 +10,7 @@ schema: 2.0.0
1010
# Add-VMGpuPartitionAdapter
1111

1212
## SYNOPSIS
13-
Add GPU Partition adapter to a virtual machine
13+
Adds a GPU partition adapter to a virtual machine.
1414

1515
## SYNTAX
1616

@@ -36,25 +36,25 @@ Add-VMGpuPartitionAdapter [-VM] <VirtualMachine[]> [-Passthru] [-InstancePath <S
3636
```
3737

3838
## DESCRIPTION
39-
The **Add-VMGpuPartitionAdapter** cmdlet adds GPU Partition adapter to a virtual machine. With no parameter, it assigns a Full partition from an assignable GPU to a VM.
39+
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.
4040

4141
## EXAMPLES
4242

4343
### Example 1
4444
```powershell
45-
PS C:\> $vm = Get-VM -name "TestVM"
45+
$vm = Get-VM -name "TestVM"
4646
Add-VMGpuPartitionAdapter -VM $vm
4747
```
4848

49-
Assign a partition to a specific VM object. If you want to assign multiple GPU partitions run this command the number of times equal to the number of GPU partitions needed
49+
Assigns a partition to a specific VM object. If you want to assign multiple GPU partitions run this command the number of times equal to the number of GPU partitions needed.
5050

5151
### Example 2
5252
```powershell
53-
PS C:\> $vm = Get-VM -name "TestVM"
53+
$vm = Get-VM -name "TestVM"
5454
Add-VMGpuPartitionAdapter -VM $vm -Instancepath "SampleGPUInstancePath"
5555
```
5656

57-
Assign a partition from a specific GPU to a VM. Where the instance path is the GPU device ID name on the Host
57+
Assigns a partition from a specific GPU to a VM where the instance path is the GPU device ID name on the host.
5858

5959
## PARAMETERS
6060

@@ -79,7 +79,7 @@ Accept wildcard characters: False
7979
Specifies one or more Hyper-V hosts from which virtual machines are to be retrieved.
8080
NetBIOS names, IP addresses, and fully qualified domain names are allowable.
8181
The default is the local computer.
82-
Use localhost or a dot (.) to specify the local computer explicitly.
82+
Use localhost or a dot ('.') to specify the local computer explicitly.
8383
8484
```yaml
8585
Type: String[]
@@ -110,7 +110,7 @@ Accept wildcard characters: False
110110
```
111111
112112
### -InstancePath
113-
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
113+
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
114114
115115
```yaml
116116
Type: String
@@ -125,7 +125,7 @@ Accept wildcard characters: False
125125
```
126126
127127
### -MaxPartitionCompute
128-
Maximum number of compute assigned by the Host GPU. This is defined by the manufacturer driver.
128+
The maximum number of compute assigned by the host GPU. This is defined by the manufacturer's driver.
129129
130130
```yaml
131131
Type: UInt64
@@ -140,7 +140,7 @@ Accept wildcard characters: False
140140
```
141141
142142
### -MaxPartitionDecode
143-
Maximum number of decoders assigned by the Host GPU. This is defined by the manufacturer driver.
143+
the maximum number of decoders assigned by the host GPU. This is defined by the manufacturer's driver.
144144
145145
```yaml
146146
Type: UInt64
@@ -155,7 +155,7 @@ Accept wildcard characters: False
155155
```
156156
157157
### -MaxPartitionEncode
158-
Maximum number of encoders assigned by the Host GPU. This is defined by the manufacturer driver.
158+
the maximum number of encoders assigned by the host GPU. This is defined by the manufacturer's driver.
159159
160160
```yaml
161161
Type: UInt64
@@ -170,7 +170,7 @@ Accept wildcard characters: False
170170
```
171171
172172
### -MaxPartitionVRAM
173-
Maximum VRAM supported by the Host GPU. This is defined by the manufacturer driver.
173+
the maximum VRAM supported by the host GPU. This is defined by the manufacturer's driver.
174174
175175
```yaml
176176
Type: UInt64
@@ -185,7 +185,7 @@ Accept wildcard characters: False
185185
```
186186
187187
### -MinPartitionCompute
188-
Minimum number of compute assigned by the Host GPU. This is defined by the manufacturer driver.
188+
the minimum number of compute assigned by the host GPU. This is defined by the manufacturer's driver.
189189
190190
```yaml
191191
Type: UInt64
@@ -200,7 +200,7 @@ Accept wildcard characters: False
200200
```
201201
202202
### -MinPartitionDecode
203-
Minimum number of decoders assigned by the Host GPU. This is defined by the manufacturer driver.
203+
the minimum number of decoders assigned by the host GPU. This is defined by the manufacturer's driver.
204204
205205
```yaml
206206
Type: UInt64
@@ -215,7 +215,7 @@ Accept wildcard characters: False
215215
```
216216
217217
### -MinPartitionEncode
218-
Minimum number of encoders assigned by the Host GPU. This is defined by the manufacturer driver.
218+
the minimum number of encoders assigned by the host GPU. This is defined by the manufacturer's driver.
219219
220220
```yaml
221221
Type: UInt64
@@ -230,7 +230,7 @@ Accept wildcard characters: False
230230
```
231231
232232
### -MinPartitionVRAM
233-
Minimum VRAM supported by the Host GPU. This is defined by the manufacturer driver.
233+
the minimum VRAM supported by the host GPU. This is defined by the manufacturer's driver.
234234
235235
```yaml
236236
Type: UInt64
@@ -245,7 +245,7 @@ Accept wildcard characters: False
245245
```
246246
247247
### -OptimalPartitionCompute
248-
Optimal number of compute assigned by the Host GPU. This is defined by the manufacturer driver.
248+
the optimal number of compute assigned by the host GPU. This is defined by the manufacturer's driver.
249249
250250
```yaml
251251
Type: UInt64
@@ -259,8 +259,8 @@ Accept pipeline input: False
259259
Accept wildcard characters: False
260260
```
261261
262-
### -OptimalPartitionDecode
263-
Optimal number of decoders assigned by the Host GPU. This is defined by the manufacturer driver.
262+
### -the optimalPartitionDecode
263+
the optimal number of decoders assigned by the host GPU. This is defined by the manufacturer's driver.
264264
265265
```yaml
266266
Type: UInt64
@@ -275,7 +275,7 @@ Accept wildcard characters: False
275275
```
276276
277277
### -OptimalPartitionEncode
278-
Optimal number of encoders assigned by the Host GPU. This is defined by the manufacturer driver.
278+
the optimal number of encoders assigned by the host GPU. This is defined by the manufacturer's driver.
279279
280280
```yaml
281281
Type: UInt64
@@ -290,7 +290,7 @@ Accept wildcard characters: False
290290
```
291291
292292
### -OptimalPartitionVRAM
293-
Optimal VRAM supported by the Host GPU. This is defined by the manufacturer driver.
293+
the optimal VRAM supported by the host GPU. This is defined by the manufacturer's driver.
294294
295295
```yaml
296296
Type: UInt64
@@ -381,7 +381,7 @@ Accept wildcard characters: False
381381
```
382382
383383
### CommonParameters
384-
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
384+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](httpS://go.microsoft.com/fwlink/?LinkID=113216).
385385
386386
## INPUTS
387387

docset/winserver2022-ps/hyper-v/Get-VMGpuPartitionAdapter.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -26,22 +26,22 @@ Get-VMGpuPartitionAdapter [-VM] <VirtualMachine[]> [-AdapterId <String>] [<Commo
2626
```
2727

2828
## DESCRIPTION
29-
The **Get-VMGpuPartitionAdapter** cmdlet gets the information of assigned graphic processing unit partitions to a virtual machine.
29+
The 'Get-VMGpuPartitionAdapter' cmdlet gets the information of assigned graphic processing unit partitions to a virtual machine.
3030

3131
## EXAMPLES
3232

3333
### Example 1
3434
```powershell
35-
PS C:\> $testvm = get-VM "TestVM"
35+
$testvm = get-VM "TestVM"
3636
Get-VMGpuPartitionAdapter -VM $testvm
3737
```
3838

39-
Display the GPU information assigned to a VM object
39+
Displays the GPU information assigned to a VM object
4040

4141
## PARAMETERS
4242

4343
### -AdapterId
44-
Virtual machine GPU partition identification number that you are interested in displaying
44+
A VM's GPU partition identification number used to display the GPU information assigned to a VM
4545

4646
```yaml
4747
Type: String
@@ -73,10 +73,10 @@ Accept wildcard characters: False
7373
```
7474
7575
### -ComputerName
76-
Specifies one or more Hyper-V hosts on the virtual network adapters are to be retrieved.
77-
NetBIOS names, IP addresses, and fully qualified domain names are allowable.
76+
Specifies that one or more Hyper-V hosts on the virtual network adapters are to be retrieved.
77+
NetBIOS names, IP addresses, and fully qualified domain names are allowed.
7878
The default is the local computer.
79-
Use localhost or a dot (.) to specify the local computer explicitly.
79+
Use localhost or a dot ('.') to specify the local computer explicitly.
8080
8181
```yaml
8282
Type: String[]
@@ -108,7 +108,7 @@ Accept wildcard characters: False
108108
109109
### -VM
110110
Specifies the virtual machine whose virtual network adapters are to be retrieved.
111-
. The asterisk, "*", is the wildcard.
111+
. The asterisk, ('*'), is the wildcard.
112112
If it is specified the cmdlet returns virtual network adapters from every virtual machine in the system.
113113
114114
```yaml
@@ -120,7 +120,7 @@ Required: True
120120
Position: 0
121121
Default value: None
122122
Accept pipeline input: True (ByValue)
123-
Accept wildcard characters: False
123+
Accept wildcard characters: true
124124
```
125125
126126
### -VMName
@@ -139,7 +139,7 @@ Accept wildcard characters: False
139139
```
140140
141141
### CommonParameters
142-
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
142+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
143143
144144
## INPUTS
145145

docset/winserver2022-ps/hyper-v/Get-VMHostPartitionableGpu.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -26,31 +26,31 @@ Get-VMHostPartitionableGpu [-CimSession] <CimSession[]> [-Name <String>] [<Commo
2626
```
2727

2828
## DESCRIPTION
29-
The Get-VMHostPartitionableGpu cmdlet get the host machine’s partitionable Graphic Processing Unit.
30-
This displays the information of the GPU as provided by the manufacturer driver.
29+
The 'Get-VMHostPartitionableGpu' cmdlet gets the host machine’s partitionable graphic processing unit.
30+
This displays the information of the GPU as provided by the manufacturer's driver.
3131

3232
## EXAMPLES
3333

3434
### Example 1
3535
```
36-
PS C:\> Get-VMHostPartitionableGpu
36+
Get-VMHostPartitionableGpu
3737
```
3838

3939
Gets the details of the local partitionable graphic processing unit on the host
4040

4141
### Example 2
4242
```powershell
43-
PS C:\> Get-VMHostPartitionableGpu -ComputerName "SampleHost"
43+
Get-VMHostPartitionableGpu -ComputerName "SampleHost"
4444
```
4545

46-
Display a partitionable GPU by using the Host Name. This command will display all the GPU devices available for partitioning in the host:
46+
Displays a partitionable GPU by using the host name. This command will display all the GPU devices available for partitioning in the host.
4747

4848
### Example 3
4949
```powershell
50-
PS C:\> Get-VMHostPartitionableGpu -name "SampleGPUDeviceIDName"
50+
Get-VMHostPartitionableGpu -name "SampleGPUDeviceIDName"
5151
```
5252

53-
Display a partitionable GPU by using the specific GPU Device Name. The result will show the details of the specific GPU listed:
53+
Displays a partitionable GPU by using the specific GPU device name. The result will show the details of the specific GPU listed.
5454

5555
## PARAMETERS
5656

@@ -75,7 +75,7 @@ Accept wildcard characters: False
7575
Specifies one or more Hyper-V hosts that run this cmdlet.
7676
NetBIOS names, IP addresses, and fully qualified domain names are allowable.
7777
The default is the local computer.
78-
Use localhost or a dot (.) to specify the local computer explicitly.
78+
Use localhost or a dot ('.') to specify the local computer explicitly.
7979
8080
```yaml
8181
Type: String[]
@@ -106,7 +106,7 @@ Accept wildcard characters: False
106106
```
107107
108108
### -Name
109-
Specifies the name of the graphic processing unit to be retrieved
109+
Specifies the name of the graphic processing unit to be retrieved.
110110
111111
```yaml
112112
Type: String
@@ -121,7 +121,7 @@ Accept wildcard characters: False
121121
```
122122
123123
### CommonParameters
124-
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
124+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
125125
126126
## INPUTS
127127

docset/winserver2022-ps/hyper-v/Hyper-V.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Adds a DVD drive to a virtual machine.
2323
Adds a virtual Fibre Channel host bus adapter to a virtual machine.
2424

2525
### [Add-VMGpuPartitionAdapter](./Add-VMGpuPartitionAdapter.md)
26-
Add GPU Partition adapter to a virtual machine
26+
Adds a GPU partition adapter to a virtual machine.
2727

2828
### [Add-VMGroupMember](./Add-VMGroupMember.md)
2929
Adds group members to a virtual machine group.
@@ -541,6 +541,9 @@ Sets the firmware configuration of a virtual machine.
541541
### [Set-VMFloppyDiskDrive](./Set-VMFloppyDiskDrive.md)
542542
Configures a virtual floppy disk drive.
543543

544+
### [Set-VMGpuPartitionAdapter](./Set-VMGpuPartitionAdapter.md)
545+
Assigns a partition of a GPU to a virtual machine.
546+
544547
### [Set-VMHardDiskDrive](./Set-VMHardDiskDrive.md)
545548
Configures a virtual hard disk.
546549

@@ -551,7 +554,7 @@ Configures a Hyper-V host.
551554
Configures a virtual machine host cluster.
552555

553556
### [Set-VMHostPartitionableGpu](./Set-VMHostPartitionableGpu.md)
554-
Configures host partitionable GPU to the number of partitions supported by the manufacturer.
557+
Configures a host partitionable GPU to the number of partitions supported by the manufacturer.
555558

556559
### [Set-VMKeyProtector](./Set-VMKeyProtector.md)
557560
Configures a key protector for a virtual machine.

0 commit comments

Comments
 (0)