Skip to content

Commit 3791bf2

Browse files
authored
Merge branch 'main' into update_vmassignabledevice
2 parents 184ccbb + 2e938c9 commit 3791bf2

File tree

2 files changed

+75
-33
lines changed

2 files changed

+75
-33
lines changed

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

+38-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=windowsserver2022-ps&wt.mc_id=ps-gethelp
77
schema: 2.0.0
88
title: Get-VMHostPartitionableGpu
@@ -16,49 +16,59 @@ 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+
5057
```powershell
51-
Get-VMHostPartitionableGpu -name "SampleGPUDeviceIDName"
58+
Get-VMHostPartitionableGpu -Name "GPUDeviceIDName"
5259
```
5360

54-
Displays a partitionable GPU by using the specific GPU device name. The result will show the details of the specific GPU listed.
61+
Displays a partitionable GPU by using the specific GPU device name. The result will show the
62+
details of the specific GPU listed.
5563

5664
## PARAMETERS
5765

5866
### -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.
67+
68+
Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session
69+
object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession)
70+
or [Get-CimSession](/powershell/module/cimcmdlets/get-cimsession) cmdlet. The default is the
71+
current session on the local computer.
6272

6373
```yaml
6474
Type: CimSession[]
@@ -73,10 +83,10 @@ Accept wildcard characters: False
7383
```
7484
7585
### -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.
86+
87+
Specifies one or more Hyper-V hosts that run this cmdlet. NetBIOS names, IP addresses, and fully
88+
qualified domain names are allowed. The default is the local computer. Use localhost or a dot (`.`)
89+
to specify the local computer explicitly.
8090

8191
```yaml
8292
Type: String[]
@@ -91,7 +101,9 @@ Accept wildcard characters: False
91101
```
92102

93103
### -Credential
94-
Specifies one or more user accounts that have permission to perform this action. The default is the current user.
104+
105+
Specifies one or more user accounts that have permission to perform this action. The default is the
106+
current user.
95107

96108
```yaml
97109
Type: PSCredential[]
@@ -106,6 +118,7 @@ Accept wildcard characters: False
106118
```
107119

108120
### -Name
121+
109122
Specifies the name of the graphic processing unit to be retrieved.
110123

111124
```yaml
@@ -121,7 +134,11 @@ Accept wildcard characters: False
121134
```
122135

123136
### 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).
137+
138+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
139+
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
140+
-WarningAction, and -WarningVariable. For more information, see
141+
[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters).
125142

126143
## INPUTS
127144

@@ -134,3 +151,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
134151
## NOTES
135152

136153
## RELATED LINKS
154+
155+
[Set-VMHostPartitionableGpu](set-vmhostpartitionablegpu.md)

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

+37-14
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=windowsserver2022-ps&wt.mc_id=ps-gethelp
77
schema: 2.0.0
88
title: Set-VMHostPartitionableGpu
@@ -16,53 +16,63 @@ 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
```
3842
Set-VMHostPartitionableGpu [-Passthru] [-Name <String>] [-PartitionCount <UInt16>] [<CommonParameters>]
3943
```
4044

4145
## DESCRIPTION
46+
4247
The `Set-VMHostPartitionableGpu` cmdlet configures the host partitionable GPU to the number of partitions supported by the manufacturer.
4348

4449
## EXAMPLES
4550

4651
### Example 1
52+
4753
```powershell
48-
Set-VMHostPartitionableGpu -ComputerName SampleHost -partitioncount 8
54+
Set-VMHostPartitionableGpu -ComputerName "MyHost" -PartitionCount 8
4955
```
5056

5157
This example partitions a GPU in a specific host into eight partitions.
5258

5359
### Example 2
60+
5461
```powershell
55-
$GPU = Get-VMHostPartitionableGpu -name "SampleGPUDeviceIDName"
56-
Set-VMHostPartitionableGpu -Name $GPU -partitionCount 4
62+
$GPU = Get-VMHostPartitionableGpu -Name "GPUDeviceIDName"
63+
Set-VMHostPartitionableGpu -Name $GPU -PartitionCount 4
5764
```
5865

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

6168
## PARAMETERS
6269

6370
### -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.
71+
72+
Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session
73+
object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession)
74+
or [Get-CimSession](/powershell/module/cimcmdlets/get-cimsession) cmdlet. The default is the
75+
current session on the local computer.
6676

6777
```yaml
6878
Type: CimSession[]
@@ -77,9 +87,10 @@ Accept wildcard characters: False
7787
```
7888
7989
### -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.
90+
91+
Specifies one or more Hyper-V hosts on the virtual network adapters are to be retrieved. NetBIOS
92+
names, IP addresses, and fully qualified domain names are allowed. The default is the local
93+
computer. Use localhost or a dot (`.`) to specify the local computer explicitly.
8394

8495
```yaml
8596
Type: String[]
@@ -94,8 +105,9 @@ Accept wildcard characters: False
94105
```
95106

96107
### -Credential
97-
Specifies one or more user accounts that have permission to perform this action.
98-
The default is the current user.
108+
109+
Specifies one or more user accounts that have permission to perform this action. The default is the
110+
current user.
99111

100112
```yaml
101113
Type: PSCredential[]
@@ -110,7 +122,8 @@ Accept wildcard characters: False
110122
```
111123

112124
### -HostPartitionableGpu
113-
Full GPU object, obtained by executing 'Get-VMHostPartitionableGpu'.
125+
126+
Full GPU object, obtained by executing `Get-VMHostPartitionableGpu`.
114127

115128
```yaml
116129
Type: VMHostPartitionableGpu[]
@@ -125,6 +138,7 @@ Accept wildcard characters: False
125138
```
126139

127140
### -Name
141+
128142
Specifies the name of the GPU.
129143

130144
```yaml
@@ -140,7 +154,9 @@ Accept wildcard characters: False
140154
```
141155

142156
### -PartitionCount
143-
Specifies the number of partitions that the GPU will assign. The number of partitions is defined by the manufacturer.
157+
158+
Specifies the number of partitions that the GPU will assign. The number of partitions is defined by
159+
the manufacturer.
144160

145161
```yaml
146162
Type: UInt16
@@ -155,6 +171,7 @@ Accept wildcard characters: False
155171
```
156172

157173
### -Passthru
174+
158175
Returns an object for each process that the cmdlet started.
159176

160177
```yaml
@@ -170,7 +187,11 @@ Accept wildcard characters: False
170187
```
171188

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

175196
## INPUTS
176197

@@ -185,3 +206,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
185206
## NOTES
186207

187208
## RELATED LINKS
209+
210+
[Get-VMHostPartitionableGpu](get-vmhostpartitionablegpu.md)

0 commit comments

Comments
 (0)