Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

(WIP) VMDirectStorage descriptions - AI-generated #3953

Closed
wants to merge 3 commits into from
Closed

(WIP) VMDirectStorage descriptions - AI-generated #3953

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
72f4dbd
AI-generated draft content
JasonGerend Mar 20, 2025
249dced
Merge branch 'main' of https://github.com/MicrosoftDocs/windows-power…
JasonGerend Mar 20, 2025
60d3c40
Merge branch 'main' into ai-vmdirectstorage
JasonGerend Mar 31, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 43 additions & 13 deletions docset/winserver2025-ps/VMDirectStorage/Add-VMDirectVirtualDisk.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,55 +1,63 @@
---
external help file: VMDirectStorage-help.xml
Module Name: VMDirectStorage
ms.date: 02/21/2024
ms.date: 3/20/2025
online version: https://learn.microsoft.com/powershell/module/vmdirectstorage/add-vmdirectvirtualdisk?view=windowsserver2025-ps&wt.mc_id=ps-gethelp
schema: 2.0.0
title: Add-VMDirectVirtualDisk
ai-usage: ai-generated
---

# Add-VMDirectVirtualDisk

## SYNOPSIS
{{ Fill in the Synopsis }}

Adds a direct-attached virtual disk to a Hyper-V virtual machine.

## SYNTAX

### ByVMName

```
Add-VMDirectVirtualDisk [-VMName] <String[]> [-CimSession <CimSession[]>] [[-ControllerType] <ControllerType>]
[[-ControllerNumber] <Int32>] [-ControllerLocation <Int32>] [-VirtualDiskUniqueId <String>]
[<CommonParameters>]
```

### ByVM

```
Add-VMDirectVirtualDisk [-VM] <VirtualMachine[]> [[-ControllerType] <ControllerType>]
[[-ControllerNumber] <Int32>] [-ControllerLocation <Int32>] [-VirtualDiskUniqueId <String>]
[<CommonParameters>]
```

### ByVMDriveController

```
Add-VMDirectVirtualDisk [-VMDriveController] <VMDriveController> [-ControllerLocation <Int32>]
[-VirtualDiskUniqueId <String>] [<CommonParameters>]
```

## DESCRIPTION
{{ Fill in the Description }}

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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wrap lines at 100 characters

Suggested change
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.
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.


## EXAMPLES

### Example 1

```powershell
PS C:\> {{ Add example code here }}
PS C:\> Add-VMDirectVirtualDisk -VMName "VM01" -ControllerType SCSI -ControllerNumber 0 -ControllerLocation 1 -VirtualDiskUniqueId "12345678-ABCD-1234-ABCD-1234567890AB"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't use the prompt in the example. For long command lines, use PowerShell splatting.

Suggested change
PS C:\> Add-VMDirectVirtualDisk -VMName "VM01" -ControllerType SCSI -ControllerNumber 0 -ControllerLocation 1 -VirtualDiskUniqueId "12345678-ABCD-1234-ABCD-1234567890AB"
$parameters = @{
VMName = "VM01"
ControllerType = 'SCSI'
ControllerNumber = 0
ControllerLocation = 1
VirtualDiskUniqueId = "12345678-ABCD-1234-ABCD-1234567890AB"
}
Add-VMDirectVirtualDisk @parameters

```

{{ Add example description here }}
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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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.
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.


## PARAMETERS

### -CimSession
{{ Fill CimSession Description }}

Specifies the CIM session to use for remote management.

```yaml
Type: Microsoft.Management.Infrastructure.CimSession[]
Expand All @@ -64,7 +72,8 @@ Accept wildcard characters: False
```

### -ControllerLocation
{{ Fill ControllerLocation Description }}

Specifies the location on the controller where the virtual disk is attached. Valid values are from 0 to 63.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Specifies the location on the controller where the virtual disk is attached. Valid values are from 0 to 63.
Specifies the location on the controller where the virtual disk is attached. Valid values are from 0
to 63.


```yaml
Type: System.Int32
Expand All @@ -79,7 +88,8 @@ Accept wildcard characters: False
```

### -ControllerNumber
{{ Fill ControllerNumber Description }}

Specifies the number of the controller to which the virtual disk is attached.

```yaml
Type: System.Int32
Expand All @@ -94,7 +104,8 @@ Accept wildcard characters: False
```

### -ControllerType
{{ Fill ControllerType Description }}

Specifies the type of controller. Currently, only SCSI is supported.

```yaml
Type: ControllerType
Expand All @@ -110,7 +121,8 @@ Accept wildcard characters: False
```

### -VirtualDiskUniqueId
{{ Fill VirtualDiskUniqueId Description }}

Specifies the unique identifier of the virtual disk to attach.

```yaml
Type: System.String
Expand All @@ -125,7 +137,8 @@ Accept wildcard characters: False
```

### -VM
{{ Fill VM Description }}

Specifies the virtual machine object to which the virtual disk is attached.

```yaml
Type: Microsoft.HyperV.PowerShell.VirtualMachine[]
Expand All @@ -140,7 +153,8 @@ Accept wildcard characters: False
```

### -VMDriveController
{{ Fill VMDriveController Description }}

Specifies the VM drive controller object to which the virtual disk is attached.

```yaml
Type: Microsoft.HyperV.PowerShell.VMDriveController
Expand All @@ -155,7 +169,8 @@ Accept wildcard characters: False
```

### -VMName
{{ Fill VMName Description }}

Specifies the name of the virtual machine to which the virtual disk is attached.

```yaml
Type: System.String[]
Expand All @@ -170,19 +185,34 @@ Accept wildcard characters: False
```

### CommonParameters

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).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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).
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).


## INPUTS

### System.String[]

Accepts virtual machine names as input.

### Microsoft.HyperV.PowerShell.VirtualMachine[]

Accepts virtual machine objects as input.

### Microsoft.HyperV.PowerShell.VMDriveController

Accepts VM drive controller objects as input.

## OUTPUTS

### System.Object

Returns an object representing the attached virtual disk.

## NOTES

Direct-attached virtual disks require compatible hardware and configuration.

## RELATED LINKS

[Get-VMDirectVirtualDisk](Get-VMDirectVirtualDisk.md)
[Remove-VMDirectVirtualDisk](Remove-VMDirectVirtualDisk.md)
Comment on lines +217 to +218
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Each link needs to be a separate paragraph.

Suggested change
[Get-VMDirectVirtualDisk](Get-VMDirectVirtualDisk.md)
[Remove-VMDirectVirtualDisk](Remove-VMDirectVirtualDisk.md)
[Get-VMDirectVirtualDisk](Get-VMDirectVirtualDisk.md)
[Remove-VMDirectVirtualDisk](Remove-VMDirectVirtualDisk.md)

57 changes: 43 additions & 14 deletions docset/winserver2025-ps/VMDirectStorage/Get-VMDirectVirtualDisk.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,53 +1,61 @@
---
external help file: VMDirectStorage-help.xml
Module Name: VMDirectStorage
ms.date: 02/21/2024
ms.date: 3/20/2025
online version: https://learn.microsoft.com/powershell/module/vmdirectstorage/get-vmdirectvirtualdisk?view=windowsserver2025-ps&wt.mc_id=ps-gethelp
schema: 2.0.0
title: Get-VMDirectVirtualDisk
ai-usage: ai-generated
---

# Get-VMDirectVirtualDisk

## SYNOPSIS
{{ Fill in the Synopsis }}

Retrieves direct-attached virtual disks from Hyper-V virtual machines.

## SYNTAX

### ByVMName

```
Get-VMDirectVirtualDisk [-VMName] <String[]> [-CimSession <CimSession[]>] [[-ControllerType] <ControllerType>]
[[-ControllerNumber] <Int32>] [-ControllerLocation <Int32>] [<CommonParameters>]
```

### ByVM

```
Get-VMDirectVirtualDisk [-VM] <VirtualMachine[]> [[-ControllerType] <ControllerType>]
[[-ControllerNumber] <Int32>] [-ControllerLocation <Int32>] [<CommonParameters>]
```

### ByVMDriveController

```
Get-VMDirectVirtualDisk [-VMDriveController] <VMDriveController[]> [-ControllerLocation <Int32>]
[<CommonParameters>]
```

## DESCRIPTION
{{ Fill in the Description }}

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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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.
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.


## EXAMPLES

### Example 1

```powershell
PS C:\> {{ Add example code here }}
PS C:\> Get-VMDirectVirtualDisk -VMName "VM01"
```

{{ Add example description here }}
This command retrieves all direct-attached virtual disks configured on the virtual machine named VM01.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
This command retrieves all direct-attached virtual disks configured on the virtual machine named VM01.
This command retrieves all direct-attached virtual disks configured on the virtual machine named
VM01.


## PARAMETERS

### -CimSession
{{ Fill CimSession Description }}

Specifies the CIM session to use for remote management.

```yaml
Type: Microsoft.Management.Infrastructure.CimSession[]
Expand All @@ -62,7 +70,8 @@ Accept wildcard characters: False
```

### -ControllerLocation
{{ Fill ControllerLocation Description }}

Filters results by the location on the controller.

```yaml
Type: System.Int32
Expand All @@ -77,7 +86,8 @@ Accept wildcard characters: False
```

### -ControllerNumber
{{ Fill ControllerNumber Description }}

Filters results by the controller number.

```yaml
Type: System.Int32
Expand All @@ -92,7 +102,8 @@ Accept wildcard characters: False
```

### -ControllerType
{{ Fill ControllerType Description }}

Filters results by the controller type. Currently, only SCSI is supported.

```yaml
Type: ControllerType
Expand All @@ -108,7 +119,8 @@ Accept wildcard characters: False
```

### -VM
{{ Fill VM Description }}

Specifies the virtual machine object from which to retrieve virtual disks.

```yaml
Type: Microsoft.HyperV.PowerShell.VirtualMachine[]
Expand All @@ -123,7 +135,8 @@ Accept wildcard characters: False
```

### -VMDriveController
{{ Fill VMDriveController Description }}

Specifies the VM drive controller object from which to retrieve virtual disks.

```yaml
Type: Microsoft.HyperV.PowerShell.VMDriveController[]
Expand All @@ -138,7 +151,8 @@ Accept wildcard characters: False
```

### -VMName
{{ Fill VMName Description }}

Specifies the name of the virtual machine from which to retrieve virtual disks.

```yaml
Type: System.String[]
Expand All @@ -153,19 +167,34 @@ Accept wildcard characters: False
```

### CommonParameters
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).

Supports common parameters. See [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Supports common parameters. See [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
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).


## INPUTS

### System.String[]

Accepts virtual machine names as input.

### Microsoft.HyperV.PowerShell.VirtualMachine[]

Accepts virtual machine objects as input.

### Microsoft.HyperV.PowerShell.VMDriveController[]

Accepts VM drive controller objects as input.

## OUTPUTS

### System.Object
### VMDirectVirtualDisk[]

Returns objects representing direct-attached virtual disks.

## NOTES

None.

## RELATED LINKS

[Add-VMDirectVirtualDisk](Add-VMDirectVirtualDisk.md)
[Remove-VMDirectVirtualDisk](Remove-VMDirectVirtualDisk.md)
Comment on lines +199 to +200
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
[Add-VMDirectVirtualDisk](Add-VMDirectVirtualDisk.md)
[Remove-VMDirectVirtualDisk](Remove-VMDirectVirtualDisk.md)
[Add-VMDirectVirtualDisk](Add-VMDirectVirtualDisk.md)
[Remove-VMDirectVirtualDisk](Remove-VMDirectVirtualDisk.md)

Loading