Skip to content

Commit 72f4dbd

Browse files
committed
AI-generated draft content
1 parent 2ad2583 commit 72f4dbd

File tree

4 files changed

+143
-43
lines changed

4 files changed

+143
-43
lines changed

docset/winserver2025-ps/VMDirectStorage/Add-VMDirectVirtualDisk.md

+43-13
Original file line numberDiff line numberDiff line change
@@ -1,55 +1,63 @@
11
---
22
external help file: VMDirectStorage-help.xml
33
Module Name: VMDirectStorage
4-
ms.date: 02/21/2024
4+
ms.date: 3/20/2025
55
online version: https://learn.microsoft.com/powershell/module/vmdirectstorage/add-vmdirectvirtualdisk?view=windowsserver2025-ps&wt.mc_id=ps-gethelp
66
schema: 2.0.0
77
title: Add-VMDirectVirtualDisk
8+
ai-usage: ai-generated
89
---
910

1011
# Add-VMDirectVirtualDisk
1112

1213
## SYNOPSIS
13-
{{ Fill in the Synopsis }}
14+
15+
Adds a direct-attached virtual disk to a Hyper-V virtual machine.
1416

1517
## SYNTAX
1618

1719
### ByVMName
20+
1821
```
1922
Add-VMDirectVirtualDisk [-VMName] <String[]> [-CimSession <CimSession[]>] [[-ControllerType] <ControllerType>]
2023
[[-ControllerNumber] <Int32>] [-ControllerLocation <Int32>] [-VirtualDiskUniqueId <String>]
2124
[<CommonParameters>]
2225
```
2326

2427
### ByVM
28+
2529
```
2630
Add-VMDirectVirtualDisk [-VM] <VirtualMachine[]> [[-ControllerType] <ControllerType>]
2731
[[-ControllerNumber] <Int32>] [-ControllerLocation <Int32>] [-VirtualDiskUniqueId <String>]
2832
[<CommonParameters>]
2933
```
3034

3135
### ByVMDriveController
36+
3237
```
3338
Add-VMDirectVirtualDisk [-VMDriveController] <VMDriveController> [-ControllerLocation <Int32>]
3439
[-VirtualDiskUniqueId <String>] [<CommonParameters>]
3540
```
3641

3742
## DESCRIPTION
38-
{{ Fill in the Description }}
43+
44+
The `Add-VMDirectVirtualDisk` cmdlet attaches an existing virtual disk directly to a Hyper-V virtual machine. Direct-attached virtual disks provide improved storage performance by bypassing traditional virtual storage layers.
3945

4046
## EXAMPLES
4147

4248
### Example 1
49+
4350
```powershell
44-
PS C:\> {{ Add example code here }}
51+
PS C:\> Add-VMDirectVirtualDisk -VMName "VM01" -ControllerType SCSI -ControllerNumber 0 -ControllerLocation 1 -VirtualDiskUniqueId "12345678-ABCD-1234-ABCD-1234567890AB"
4552
```
4653

47-
{{ Add example description here }}
54+
This command attaches a virtual disk identified by its unique ID directly to the SCSI controller 0 at location 1 on the virtual machine named VM01.
4855

4956
## PARAMETERS
5057

5158
### -CimSession
52-
{{ Fill CimSession Description }}
59+
60+
Specifies the CIM session to use for remote management.
5361

5462
```yaml
5563
Type: Microsoft.Management.Infrastructure.CimSession[]
@@ -64,7 +72,8 @@ Accept wildcard characters: False
6472
```
6573
6674
### -ControllerLocation
67-
{{ Fill ControllerLocation Description }}
75+
76+
Specifies the location on the controller where the virtual disk is attached. Valid values are from 0 to 63.
6877
6978
```yaml
7079
Type: System.Int32
@@ -79,7 +88,8 @@ Accept wildcard characters: False
7988
```
8089
8190
### -ControllerNumber
82-
{{ Fill ControllerNumber Description }}
91+
92+
Specifies the number of the controller to which the virtual disk is attached.
8393
8494
```yaml
8595
Type: System.Int32
@@ -94,7 +104,8 @@ Accept wildcard characters: False
94104
```
95105
96106
### -ControllerType
97-
{{ Fill ControllerType Description }}
107+
108+
Specifies the type of controller. Currently, only SCSI is supported.
98109
99110
```yaml
100111
Type: ControllerType
@@ -110,7 +121,8 @@ Accept wildcard characters: False
110121
```
111122
112123
### -VirtualDiskUniqueId
113-
{{ Fill VirtualDiskUniqueId Description }}
124+
125+
Specifies the unique identifier of the virtual disk to attach.
114126
115127
```yaml
116128
Type: System.String
@@ -125,7 +137,8 @@ Accept wildcard characters: False
125137
```
126138
127139
### -VM
128-
{{ Fill VM Description }}
140+
141+
Specifies the virtual machine object to which the virtual disk is attached.
129142
130143
```yaml
131144
Type: Microsoft.HyperV.PowerShell.VirtualMachine[]
@@ -140,7 +153,8 @@ Accept wildcard characters: False
140153
```
141154
142155
### -VMDriveController
143-
{{ Fill VMDriveController Description }}
156+
157+
Specifies the VM drive controller object to which the virtual disk is attached.
144158
145159
```yaml
146160
Type: Microsoft.HyperV.PowerShell.VMDriveController
@@ -155,7 +169,8 @@ Accept wildcard characters: False
155169
```
156170
157171
### -VMName
158-
{{ Fill VMName Description }}
172+
173+
Specifies the name of the virtual machine to which the virtual disk is attached.
159174
160175
```yaml
161176
Type: System.String[]
@@ -170,19 +185,34 @@ Accept wildcard characters: False
170185
```
171186
172187
### CommonParameters
188+
173189
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).
174190
175191
## INPUTS
176192
177193
### System.String[]
178194
195+
Accepts virtual machine names as input.
196+
179197
### Microsoft.HyperV.PowerShell.VirtualMachine[]
180198
199+
Accepts virtual machine objects as input.
200+
181201
### Microsoft.HyperV.PowerShell.VMDriveController
182202
203+
Accepts VM drive controller objects as input.
204+
183205
## OUTPUTS
184206
185207
### System.Object
208+
209+
Returns an object representing the attached virtual disk.
210+
186211
## NOTES
187212
213+
Direct-attached virtual disks require compatible hardware and configuration.
214+
188215
## RELATED LINKS
216+
217+
[Get-VMDirectVirtualDisk](Get-VMDirectVirtualDisk.md)
218+
[Remove-VMDirectVirtualDisk](Remove-VMDirectVirtualDisk.md)

docset/winserver2025-ps/VMDirectStorage/Get-VMDirectVirtualDisk.md

+43-14
Original file line numberDiff line numberDiff line change
@@ -1,53 +1,61 @@
11
---
22
external help file: VMDirectStorage-help.xml
33
Module Name: VMDirectStorage
4-
ms.date: 02/21/2024
4+
ms.date: 3/20/2025
55
online version: https://learn.microsoft.com/powershell/module/vmdirectstorage/get-vmdirectvirtualdisk?view=windowsserver2025-ps&wt.mc_id=ps-gethelp
66
schema: 2.0.0
77
title: Get-VMDirectVirtualDisk
8+
ai-usage: ai-generated
89
---
910

1011
# Get-VMDirectVirtualDisk
1112

1213
## SYNOPSIS
13-
{{ Fill in the Synopsis }}
14+
15+
Retrieves direct-attached virtual disks from Hyper-V virtual machines.
1416

1517
## SYNTAX
1618

1719
### ByVMName
20+
1821
```
1922
Get-VMDirectVirtualDisk [-VMName] <String[]> [-CimSession <CimSession[]>] [[-ControllerType] <ControllerType>]
2023
[[-ControllerNumber] <Int32>] [-ControllerLocation <Int32>] [<CommonParameters>]
2124
```
2225

2326
### ByVM
27+
2428
```
2529
Get-VMDirectVirtualDisk [-VM] <VirtualMachine[]> [[-ControllerType] <ControllerType>]
2630
[[-ControllerNumber] <Int32>] [-ControllerLocation <Int32>] [<CommonParameters>]
2731
```
2832

2933
### ByVMDriveController
34+
3035
```
3136
Get-VMDirectVirtualDisk [-VMDriveController] <VMDriveController[]> [-ControllerLocation <Int32>]
3237
[<CommonParameters>]
3338
```
3439

3540
## DESCRIPTION
36-
{{ Fill in the Description }}
41+
42+
The `Get-VMDirectVirtualDisk` cmdlet retrieves information about direct-attached virtual disks configured on Hyper-V virtual machines. You can filter results by virtual machine name, controller type, number, or location.
3743

3844
## EXAMPLES
3945

4046
### Example 1
47+
4148
```powershell
42-
PS C:\> {{ Add example code here }}
49+
PS C:\> Get-VMDirectVirtualDisk -VMName "VM01"
4350
```
4451

45-
{{ Add example description here }}
52+
This command retrieves all direct-attached virtual disks configured on the virtual machine named VM01.
4653

4754
## PARAMETERS
4855

4956
### -CimSession
50-
{{ Fill CimSession Description }}
57+
58+
Specifies the CIM session to use for remote management.
5159

5260
```yaml
5361
Type: Microsoft.Management.Infrastructure.CimSession[]
@@ -62,7 +70,8 @@ Accept wildcard characters: False
6270
```
6371
6472
### -ControllerLocation
65-
{{ Fill ControllerLocation Description }}
73+
74+
Filters results by the location on the controller.
6675
6776
```yaml
6877
Type: System.Int32
@@ -77,7 +86,8 @@ Accept wildcard characters: False
7786
```
7887
7988
### -ControllerNumber
80-
{{ Fill ControllerNumber Description }}
89+
90+
Filters results by the controller number.
8191
8292
```yaml
8393
Type: System.Int32
@@ -92,7 +102,8 @@ Accept wildcard characters: False
92102
```
93103
94104
### -ControllerType
95-
{{ Fill ControllerType Description }}
105+
106+
Filters results by the controller type. Currently, only SCSI is supported.
96107
97108
```yaml
98109
Type: ControllerType
@@ -108,7 +119,8 @@ Accept wildcard characters: False
108119
```
109120
110121
### -VM
111-
{{ Fill VM Description }}
122+
123+
Specifies the virtual machine object from which to retrieve virtual disks.
112124
113125
```yaml
114126
Type: Microsoft.HyperV.PowerShell.VirtualMachine[]
@@ -123,7 +135,8 @@ Accept wildcard characters: False
123135
```
124136
125137
### -VMDriveController
126-
{{ Fill VMDriveController Description }}
138+
139+
Specifies the VM drive controller object from which to retrieve virtual disks.
127140
128141
```yaml
129142
Type: Microsoft.HyperV.PowerShell.VMDriveController[]
@@ -138,7 +151,8 @@ Accept wildcard characters: False
138151
```
139152
140153
### -VMName
141-
{{ Fill VMName Description }}
154+
155+
Specifies the name of the virtual machine from which to retrieve virtual disks.
142156
143157
```yaml
144158
Type: System.String[]
@@ -153,19 +167,34 @@ Accept wildcard characters: False
153167
```
154168
155169
### CommonParameters
156-
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).
170+
171+
Supports common parameters. See [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
157172
158173
## INPUTS
159174
160175
### System.String[]
161176
177+
Accepts virtual machine names as input.
178+
162179
### Microsoft.HyperV.PowerShell.VirtualMachine[]
163180
181+
Accepts virtual machine objects as input.
182+
164183
### Microsoft.HyperV.PowerShell.VMDriveController[]
165184
185+
Accepts VM drive controller objects as input.
186+
166187
## OUTPUTS
167188
168-
### System.Object
189+
### VMDirectVirtualDisk[]
190+
191+
Returns objects representing direct-attached virtual disks.
192+
169193
## NOTES
170194
195+
None.
196+
171197
## RELATED LINKS
198+
199+
[Add-VMDirectVirtualDisk](Add-VMDirectVirtualDisk.md)
200+
[Remove-VMDirectVirtualDisk](Remove-VMDirectVirtualDisk.md)

0 commit comments

Comments
 (0)