Skip to content

Commit 49fd3d8

Browse files
authored
Merge branch 'main' into update_vmhostpartitionablegpu
2 parents 4f346d1 + 4d917b5 commit 49fd3d8

File tree

2 files changed

+86
-35
lines changed

2 files changed

+86
-35
lines changed

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

+45-19
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
description: Gets the host machine’s partitionable GPU.
33
external help file: Microsoft.HyperV.PowerShell.Cmdlets.dll-Help.xml
44
Module Name: Hyper-V
5-
ms.date: 09/22/2022
5+
ms.date: 06/12/2024
66
online version: https://learn.microsoft.com/powershell/module/hyper-v/get-vmhostpartitionablegpu?view=windowsserver2025-ps&wt.mc_id=ps-gethelp
77
schema: 2.0.0
88
title: Get-VMHostPartitionableGpu
@@ -16,49 +16,66 @@ Gets the host machine’s partitionable GPU.
1616
## SYNTAX
1717

1818
### ComputerName (Default)
19+
1920
```
20-
Get-VMHostPartitionableGpu [[-ComputerName] <String[]>] [[-Credential] <PSCredential[]>] [-Name <String>]
21-
[<CommonParameters>]
21+
Get-VMHostPartitionableGpu [[-ComputerName] <String[]>] [[-Credential] <PSCredential[]>]
22+
[-Name <String>] [<CommonParameters>]
2223
```
2324

2425
### CimSession
26+
2527
```
2628
Get-VMHostPartitionableGpu [-CimSession] <CimSession[]> [-Name <String>] [<CommonParameters>]
2729
```
2830

2931
## DESCRIPTION
30-
The 'Get-VMHostPartitionableGpu' cmdlet gets the host machine’s partitionable graphic processing unit.
31-
This displays the information of the GPU as provided by the manufacturer's driver.
32+
33+
The `Get-VMHostPartitionableGpu` cmdlet gets the host machine’s partitionable graphic processing
34+
unit. This displays the information of the GPU as provided by the manufacturer's driver.
3235

3336
## EXAMPLES
3437

3538
### Example 1
36-
```
39+
40+
```powershell
3741
Get-VMHostPartitionableGpu
3842
```
3943

4044
This example gets the details of the local partitionable graphic processing unit on the host.
4145

4246
### Example 2
47+
4348
```powershell
44-
Get-VMHostPartitionableGpu -ComputerName "SampleHost"
49+
Get-VMHostPartitionableGpu -ComputerName "MyHost"
4550
```
4651

47-
This example gets a partitionable GPU by using the host name. This command will display all the GPU devices available for partitioning in the host.
52+
This example gets a partitionable GPU by using the host name. This command will display all the GPU
53+
devices available for partitioning in the host.
4854

4955
### Example 3
56+
57+
```powershell
58+
Get-VMHostPartitionableGpu -Name "GPUDeviceIDName"
59+
```
60+
61+
### Example 4
62+
5063
```powershell
51-
Get-VMHostPartitionableGpu -name "SampleGPUDeviceIDName"
64+
Get-VMHostPartitionableGpu | FL Name, ValidPartitionCounts
5265
```
5366

54-
Displays a partitionable GPU by using the specific GPU device name. The result will show the details of the specific GPU listed.
67+
This example retrieves information about the partitionable GPUs available on a virtual machine host
68+
and formats the output as a list, displaying the name of each GPU and the number of valid
69+
partitions that can be created on each GPU.
5570

5671
## PARAMETERS
5772

5873
### -CimSession
59-
Runs the cmdlet in a remote session or on a remote computer.
60-
Enter a computer name or a session object, such as the output of a [New-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227967) or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet.
61-
The default is the current session on the local computer.
74+
75+
Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session
76+
object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession)
77+
or [Get-CimSession](/powershell/module/cimcmdlets/get-cimsession) cmdlet. The default is the
78+
current session on the local computer.
6279

6380
```yaml
6481
Type: CimSession[]
@@ -73,10 +90,10 @@ Accept wildcard characters: False
7390
```
7491
7592
### -ComputerName
76-
Specifies one or more Hyper-V hosts that run this cmdlet.
77-
NetBIOS names, IP addresses, and fully qualified domain names are allowed.
78-
The default is the local computer.
79-
Use localhost or a dot ('.') to specify the local computer explicitly.
93+
94+
Specifies one or more Hyper-V hosts that run this cmdlet. NetBIOS names, IP addresses, and fully
95+
qualified domain names are allowed. The default is the local computer. Use localhost or a dot (`.`)
96+
to specify the local computer explicitly.
8097

8198
```yaml
8299
Type: String[]
@@ -91,7 +108,9 @@ Accept wildcard characters: False
91108
```
92109

93110
### -Credential
94-
Specifies one or more user accounts that have permission to perform this action. The default is the current user.
111+
112+
Specifies one or more user accounts that have permission to perform this action. The default is the
113+
current user.
95114

96115
```yaml
97116
Type: PSCredential[]
@@ -106,6 +125,7 @@ Accept wildcard characters: False
106125
```
107126

108127
### -Name
128+
109129
Specifies the name of the graphic processing unit to be retrieved.
110130

111131
```yaml
@@ -121,7 +141,11 @@ Accept wildcard characters: False
121141
```
122142

123143
### 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](https://go.microsoft.com/fwlink/?LinkID=113216).
144+
145+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
146+
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
147+
-WarningAction, and -WarningVariable. For more information, see
148+
[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters).
125149

126150
## INPUTS
127151

@@ -134,3 +158,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
134158
## NOTES
135159

136160
## RELATED LINKS
161+
162+
- [Set-VMHostPartitionableGpu](set-vmhostpartitionablegpu.md)

docset/winserver2025-ps/hyper-v/Set-VMHostPartitionableGpu.md

+41-16
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
description: Configures the host partitionable GPU to the number of partitions supported by the manufacturer.
33
external help file: Microsoft.HyperV.PowerShell.Cmdlets.dll-Help.xml
44
Module Name: Hyper-V
5-
ms.date: 10/21/2022
5+
ms.date: 06/12/2024
66
online version: https://learn.microsoft.com/powershell/module/hyper-v/set-vmhostpartitionablegpu?view=windowsserver2025-ps&wt.mc_id=ps-gethelp
77
schema: 2.0.0
88
title: Set-VMHostPartitionableGpu
@@ -16,53 +16,65 @@ Configures the host partitionable GPU to the number of partitions supported by t
1616
## SYNTAX
1717

1818
### ComputerName (Default)
19+
1920
```
2021
Set-VMHostPartitionableGpu [[-ComputerName] <String[]>] [[-Credential] <PSCredential[]>] [-Passthru]
2122
[-PartitionCount <UInt16>] [<CommonParameters>]
2223
```
2324

2425
### CimSession
26+
2527
```
2628
Set-VMHostPartitionableGpu [-CimSession] <CimSession[]> [-Passthru] [-PartitionCount <UInt16>]
2729
[<CommonParameters>]
2830
```
2931

3032
### Object
33+
3134
```
3235
Set-VMHostPartitionableGpu [-HostPartitionableGpu] <VMHostPartitionableGpu[]> [-Passthru]
3336
[-PartitionCount <UInt16>] [<CommonParameters>]
3437
```
3538

3639
### Name
40+
3741
```
38-
Set-VMHostPartitionableGpu [-Passthru] [-Name <String>] [-PartitionCount <UInt16>] [<CommonParameters>]
42+
Set-VMHostPartitionableGpu [-Passthru] [-Name <String>] [-PartitionCount <UInt16>]
43+
[<CommonParameters>]
3944
```
4045

4146
## DESCRIPTION
42-
The `Set-VMHostPartitionableGpu` cmdlet configures the host partitionable GPU to the number of partitions supported by the manufacturer.
47+
48+
The `Set-VMHostPartitionableGpu` cmdlet configures the host partitionable GPU to the number of
49+
partitions supported by the manufacturer.
4350

4451
## EXAMPLES
4552

4653
### Example 1
54+
4755
```powershell
48-
Set-VMHostPartitionableGpu -ComputerName SampleHost -partitioncount 8
56+
Set-VMHostPartitionableGpu -ComputerName "MyHost" -PartitionCount 8
4957
```
5058

5159
This example partitions a GPU in a specific host into eight partitions.
5260

5361
### Example 2
62+
5463
```powershell
55-
$GPU = Get-VMHostPartitionableGpu -name "SampleGPUDeviceIDName"
56-
Set-VMHostPartitionableGpu -Name $GPU -partitionCount 4
64+
$GPU = Get-VMHostPartitionableGpu -Name "GPUDeviceIDName"
65+
Set-VMHostPartitionableGpu -Name $GPU -PartitionCount 4
5766
```
5867

5968
This example partitions a GPU in a host into four partitions by using the GPU device ID name.
6069

6170
## PARAMETERS
6271

6372
### -CimSession
64-
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](https://go.microsoft.com/fwlink/p/?LinkId=227967) or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet.
65-
The default is the current session on the local computer.
73+
74+
Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session
75+
object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession)
76+
or [Get-CimSession](/powershell/module/cimcmdlets/get-cimsession) cmdlet. The default is the
77+
current session on the local computer.
6678

6779
```yaml
6880
Type: CimSession[]
@@ -77,9 +89,10 @@ Accept wildcard characters: False
7789
```
7890
7991
### -ComputerName
80-
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.
81-
The default is the local computer.
82-
Use localhost or a dot ('.') to specify the local computer explicitly.
92+
93+
Specifies one or more Hyper-V hosts on the virtual network adapters are to be retrieved. NetBIOS
94+
names, IP addresses, and fully qualified domain names are allowed. The default is the local
95+
computer. Use localhost or a dot (`.`) to specify the local computer explicitly.
8396

8497
```yaml
8598
Type: String[]
@@ -94,8 +107,9 @@ Accept wildcard characters: False
94107
```
95108

96109
### -Credential
97-
Specifies one or more user accounts that have permission to perform this action.
98-
The default is the current user.
110+
111+
Specifies one or more user accounts that have permission to perform this action. The default is the
112+
current user.
99113

100114
```yaml
101115
Type: PSCredential[]
@@ -110,7 +124,8 @@ Accept wildcard characters: False
110124
```
111125

112126
### -HostPartitionableGpu
113-
Full GPU object, obtained by executing 'Get-VMHostPartitionableGpu'.
127+
128+
Full GPU object, obtained by executing `Get-VMHostPartitionableGpu`.
114129

115130
```yaml
116131
Type: VMHostPartitionableGpu[]
@@ -125,6 +140,7 @@ Accept wildcard characters: False
125140
```
126141

127142
### -Name
143+
128144
Specifies the name of the GPU.
129145

130146
```yaml
@@ -140,7 +156,9 @@ Accept wildcard characters: False
140156
```
141157

142158
### -PartitionCount
143-
Specifies the number of partitions that the GPU will assign. The number of partitions is defined by the manufacturer.
159+
160+
Specifies the number of partitions that the GPU will assign. The number of partitions is defined by
161+
the manufacturer.
144162

145163
```yaml
146164
Type: UInt16
@@ -155,6 +173,7 @@ Accept wildcard characters: False
155173
```
156174

157175
### -Passthru
176+
158177
Returns an object for each process that the cmdlet started.
159178

160179
```yaml
@@ -170,7 +189,11 @@ Accept wildcard characters: False
170189
```
171190

172191
### CommonParameters
173-
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).
192+
193+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
194+
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
195+
-WarningAction, and -WarningVariable. For more information, see
196+
[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters).
174197

175198
## INPUTS
176199

@@ -185,3 +208,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
185208
## NOTES
186209

187210
## RELATED LINKS
211+
212+
- [Get-VMHostPartitionableGpu](get-vmhostpartitionablegpu.md)

0 commit comments

Comments
 (0)