diff --git a/docset/winserver2022-ps/hyper-v/Add-VMGpuPartitionAdapter.md b/docset/winserver2022-ps/hyper-v/Add-VMGpuPartitionAdapter.md index e86a3aa1c8..db45b5514f 100644 --- a/docset/winserver2022-ps/hyper-v/Add-VMGpuPartitionAdapter.md +++ b/docset/winserver2022-ps/hyper-v/Add-VMGpuPartitionAdapter.md @@ -2,7 +2,7 @@ description: Adds a GPU partition adapter to a virtual machine. external help file: Microsoft.HyperV.PowerShell.Cmdlets.dll-Help.xml Module Name: Hyper-V -ms.date: 09/22/2022 +ms.date: 06/12/2024 online version: https://learn.microsoft.com/powershell/module/hyper-v/add-vmgpupartitionadapter?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Add-VMGpuPartitionAdapter @@ -16,53 +16,62 @@ Adds a GPU partition adapter to a virtual machine. ## SYNTAX ### VMName (Default) + ``` Add-VMGpuPartitionAdapter [-CimSession ] [-ComputerName ] [-Credential ] [-VMName] [-Passthru] [-InstancePath ] [-MinPartitionVRAM ] [-MaxPartitionVRAM ] [-OptimalPartitionVRAM ] [-MinPartitionEncode ] [-MaxPartitionEncode ] [-OptimalPartitionEncode ] [-MinPartitionDecode ] [-MaxPartitionDecode ] [-OptimalPartitionDecode ] - [-MinPartitionCompute ] [-MaxPartitionCompute ] [-OptimalPartitionCompute ] [-WhatIf] - [-Confirm] [] + [-MinPartitionCompute ] [-MaxPartitionCompute ] [-OptimalPartitionCompute ] + [-WhatIf] [-Confirm] [] ``` ### VMObject + ``` Add-VMGpuPartitionAdapter [-VM] [-Passthru] [-InstancePath ] [-MinPartitionVRAM ] [-MaxPartitionVRAM ] [-OptimalPartitionVRAM ] [-MinPartitionEncode ] [-MaxPartitionEncode ] [-OptimalPartitionEncode ] [-MinPartitionDecode ] [-MaxPartitionDecode ] [-OptimalPartitionDecode ] - [-MinPartitionCompute ] [-MaxPartitionCompute ] [-OptimalPartitionCompute ] [-WhatIf] - [-Confirm] [] + [-MinPartitionCompute ] [-MaxPartitionCompute ] [-OptimalPartitionCompute ] + [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION -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. + +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. ## EXAMPLES ### Example 1 + ```powershell -$vm = Get-VM -name "TestVM" +$vm = Get-VM -Name "TestVM" Add-VMGpuPartitionAdapter -VM $vm ``` This example assigns a partition to a specific VM object. ### Example 2 + ```powershell -$vm = Get-VM -name "TestVM" -Add-VMGpuPartitionAdapter -VM $vm -Instancepath "SampleGPUInstancePath" +$vm = Get-VM -Name "TestVM" +Add-VMGpuPartitionAdapter -VM $vm -InstancePath "GPUInstancePath" ``` -This example assigns a partition from a specific GPU to a VM where the instance path is the GPU device ID name on the host. +This example assigns a partition from a specific GPU to a VM where the instance path is the GPU +device ID name on the host. ## PARAMETERS ### -CimSession -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. -The default is the current session on the local computer. + +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](/powershell/module/cimcmdlets/new-cimsession) +or [Get-CimSession](/powershell/module/cimcmdlets/get-cimsession) cmdlet. The default is the +current session on the local computer. ```yaml Type: CimSession[] @@ -77,10 +86,10 @@ Accept wildcard characters: False ``` ### -ComputerName -Specifies one or more Hyper-V hosts from which virtual machines are to be retrieved. -NetBIOS names, IP addresses, and fully qualified domain names are allowable. -The default is the local computer. -Use localhost or a dot ('.') to specify the local computer explicitly. + +Specifies one or more Hyper-V hosts from which virtual machines are to be retrieved. NetBIOS names, +IP addresses, and fully qualified domain names are allowable. The default is the local computer. +Use localhost or a dot (`.`) to specify the local computer explicitly. ```yaml Type: String[] @@ -95,8 +104,9 @@ Accept wildcard characters: False ``` ### -Credential -Specifies one or more user accounts that have permission to perform this action. -The default is the current user. + +Specifies one or more user accounts that have permission to perform this action. The default is the +current user. ```yaml Type: PSCredential[] @@ -111,7 +121,9 @@ Accept wildcard characters: False ``` ### -InstancePath -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'. + +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`. ```yaml Type: String @@ -126,7 +138,9 @@ Accept wildcard characters: False ``` ### -MaxPartitionCompute -The maximum number of compute assigned by the host GPU. This is defined by the manufacturer's driver. + +The maximum number of compute assigned by the host GPU. This is defined by the manufacturer's +driver. ```yaml Type: UInt64 @@ -141,7 +155,9 @@ Accept wildcard characters: False ``` ### -MaxPartitionDecode -The maximum number of decoders assigned by the host GPU. This is defined by the manufacturer's driver. + +The maximum number of decoders assigned by the host GPU. This is defined by the manufacturer's +driver. ```yaml Type: UInt64 @@ -156,7 +172,9 @@ Accept wildcard characters: False ``` ### -MaxPartitionEncode -The maximum number of encoders assigned by the host GPU. This is defined by the manufacturer's driver. + +The maximum number of encoders assigned by the host GPU. This is defined by the manufacturer's +driver. ```yaml Type: UInt64 @@ -171,6 +189,7 @@ Accept wildcard characters: False ``` ### -MaxPartitionVRAM + The maximum VRAM in bytes supported by the host GPU. This is defined by the manufacturer's driver. ```yaml @@ -186,7 +205,9 @@ Accept wildcard characters: False ``` ### -MinPartitionCompute -The minimum number of compute assigned by the host GPU. This is defined by the manufacturer's driver. + +The minimum number of compute assigned by the host GPU. This is defined by the manufacturer's +driver. ```yaml Type: UInt64 @@ -201,7 +222,9 @@ Accept wildcard characters: False ``` ### -MinPartitionDecode -The minimum number of decoders assigned by the host GPU. This is defined by the manufacturer's driver. + +The minimum number of decoders assigned by the host GPU. This is defined by the manufacturer's +driver. ```yaml Type: UInt64 @@ -216,7 +239,9 @@ Accept wildcard characters: False ``` ### -MinPartitionEncode -The minimum number of encoders assigned by the host GPU. This is defined by the manufacturer's driver. + +The minimum number of encoders assigned by the host GPU. This is defined by the manufacturer's +driver. ```yaml Type: UInt64 @@ -231,6 +256,7 @@ Accept wildcard characters: False ``` ### -MinPartitionVRAM + The minimum VRAM in bytes supported by the host GPU. This is defined by the manufacturer's driver. ```yaml @@ -246,7 +272,9 @@ Accept wildcard characters: False ``` ### -OptimalPartitionCompute -The optimal number of compute assigned by the host GPU. This is defined by the manufacturer's driver. + +The optimal number of compute assigned by the host GPU. This is defined by the manufacturer's +driver. ```yaml Type: UInt64 @@ -261,7 +289,9 @@ Accept wildcard characters: False ``` ### -OptimalPartitionDecode -The optimal number of decoders assigned by the host GPU. This is defined by the manufacturer's driver. + +The optimal number of decoders assigned by the host GPU. This is defined by the manufacturer's +driver. ```yaml Type: UInt64 @@ -276,7 +306,9 @@ Accept wildcard characters: False ``` ### -OptimalPartitionEncode -The optimal number of encoders assigned by the host GPU. This is defined by the manufacturer's driver. + +The optimal number of encoders assigned by the host GPU. This is defined by the manufacturer's +driver. ```yaml Type: UInt64 @@ -291,6 +323,7 @@ Accept wildcard characters: False ``` ### -OptimalPartitionVRAM + The optimal VRAM in bytes supported by the host GPU. This is defined by the manufacturer's driver. ```yaml @@ -306,6 +339,7 @@ Accept wildcard characters: False ``` ### -Passthru + Returns an object for each process that the cmdlet started. ```yaml @@ -321,6 +355,7 @@ Accept wildcard characters: False ``` ### -VM + Specifies the virtual machine on which the network adapter is to be added. ```yaml @@ -336,6 +371,7 @@ Accept wildcard characters: False ``` ### -VMName + Specifies the name of the virtual machine on which the network adapter is to be added. ```yaml @@ -351,6 +387,7 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml @@ -366,8 +403,8 @@ Accept wildcard characters: False ``` ### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. + +Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml Type: SwitchParameter @@ -382,7 +419,11 @@ 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](https://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](/powershell/module/microsoft.powershell.core/about/about_commonparameters). ## INPUTS @@ -397,3 +438,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS + +[Get-VMGpuPartitionAdapter](get-vmgpupartitionadapter.md) + +[Remove-VMGpuPartitionAdapter](remove-vmgpupartitionadapter.md) + +[Set-VMGpuPartitionAdapter](set-vmgpupartitionadapter.md) diff --git a/docset/winserver2022-ps/hyper-v/Add-VMHostAssignableDevice.md b/docset/winserver2022-ps/hyper-v/Add-VMHostAssignableDevice.md new file mode 100644 index 0000000000..efd17eaf02 --- /dev/null +++ b/docset/winserver2022-ps/hyper-v/Add-VMHostAssignableDevice.md @@ -0,0 +1,216 @@ +--- +description: Assigns a device to a virtual machine host. +external help file: Microsoft.HyperV.PowerShell.Cmdlets.dll-Help.xml +Module Name: Hyper-V +ms.date: 06/12/2024 +online version: https://learn.microsoft.com/powershell/module/hyper-v/add-vmhostassignabledevice?view=windowsserver2022-ps&wt.mc_id=ps-gethelp +schema: 2.0.0 +title: Add-VMHostAssignableDevice +--- + +# Add-VMHostAssignableDevice + +## SYNOPSIS +Adds an assignable device to a virtual machine (VM) host. + +## SYNTAX + +### Path (Default) + +``` +Add-VMHostAssignableDevice [-CimSession ] [-ComputerName ] + [-Credential ] [-Force] [-InstancePath ] [-LocationPath ] + -ResourcePoolName [] +``` + +### Object + +``` +Add-VMHostAssignableDevice [-Force] [-HostAssignableDevice] + -ResourcePoolName [] +``` + +## DESCRIPTION + +The `Add-VMHostAssignableDevice` cmdlet assigns a hardware device to a virtual machine host. You +can add devices to the VM host by providing either the instance or location path of the device, or +by specifying an existing host-assignable device object. + +## EXAMPLES + +### Example 1 + +```powershell +$params = @{ +ComputerName = "MyVM01" +InstancePath = "PCI\VEN_8086&DEV_0F48&SUBSYS_72708086&REV_0B\3&11583659&0&D8" +ResourcePoolName = "MyResourcePool" +} +Add-VMHostAssignableDevice $params +``` + +This example assigns a device identified by its instance path to VM host **MyVM01** within the +resource pool **MyResourcePool**. + +## PARAMETERS + +### -CimSession + +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](/powershell/module/cimcmdlets/new-cimsession) +or [Get-CimSession](/powershell/module/cimcmdlets/get-cimsession) cmdlet. The default is the +current session on the local computer. + +```yaml +Type: CimSession[] +Parameter Sets: Path +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ComputerName + +Specifies the name of the Hyper-V host to which the device is to be added. NetBIOS names, IP +addresses, and fully qualified domain names are allowed. The default is the local computer. Use +localhost or a dot (`.`) to specify the local computer explicitly. + +```yaml +Type: String[] +Parameter Sets: Path +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Credential + +Specifies one or more user accounts that have permission to perform this action. The default is the +current user. + +```yaml +Type: PSCredential[] +Parameter Sets: Path +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +Forces the command to run without asking for user confirmation. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HostAssignableDevice + +Specifies the device object to be assigned to the virtual machine. + +```yaml +Type: VMHostAssignableDevice[] +Parameter Sets: Object +Aliases: VMHostAssignableDevice + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InstancePath + +Represents the Device Instance path in the host machine. + +```yaml +Type: String +Parameter Sets: Path +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LocationPath + +Specifies the location path to the assignable device. + +```yaml +Type: String +Parameter Sets: Path +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourcePoolName + +Specifies the name of the resource pool to which the device is assigned. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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](/powershell/module/microsoft.powershell.core/about/about_commonparameters). + +## INPUTS + +### Microsoft.HyperV.PowerShell.VMHostAssignableDevice[] + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Get-VMHostAssignableDevice](get-vmhostassignabledevice.md) + +[Dismount-VMHostAssignableDevice](dismount-vmhostassignabledevice.md) + +[Mount-VMHostAssignableDevice](mount-vmhostassignabledevice.md) + +[Remove-VMHostAssignableDevice](remove-vmhostassignabledevice.md) diff --git a/docset/winserver2022-ps/hyper-v/Dismount-VMHostAssignableDevice.md b/docset/winserver2022-ps/hyper-v/Dismount-VMHostAssignableDevice.md new file mode 100644 index 0000000000..a2853e7371 --- /dev/null +++ b/docset/winserver2022-ps/hyper-v/Dismount-VMHostAssignableDevice.md @@ -0,0 +1,225 @@ +--- +description: Dismounts an assignable device from a virtual machine host. +external help file: Microsoft.HyperV.PowerShell.Cmdlets.dll-Help.xml +Module Name: Hyper-V +ms.date: 06/12/2024 +online version: https://learn.microsoft.com/powershell/module/hyper-v/dismount-vmhostassignabledevice?view=windowsserver2022-ps&wt.mc_id=ps-gethelp +schema: 2.0.0 +title: Dismount-VMHostAssignableDevice +--- + +# Dismount-VMHostAssignableDevice + +## SYNOPSIS +Dismounts a device from a virtual machine (VM) host. + +## SYNTAX + +``` +Dismount-VMHostAssignableDevice [-InstancePath ] [-LocationPath ] [-Force] + [-Passthru] [-CimSession ] [-ComputerName ] [-Credential ] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION + +The `Dismount-VMHostAssignableDevice` cmdlet is used to dismount an assignable device from the +virtual machine host. Use this cmdlet when you need to reassign a device or resolve conflicts +between devices and virtual machines. + +## EXAMPLES + +### Example 1 + +```powershell +Dismount-VMHostAssignableDevice -InstancePath "PCIROOT(0)#PCI(1D02)#PCI(0000)" +``` + +This example dismounts the device with the specified instance path from the host, making it +available for assignment to a virtual machine. + +## PARAMETERS + +### -CimSession + +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](/powershell/module/cimcmdlets/new-cimsession) +or [Get-CimSession](/powershell/module/cimcmdlets/get-cimsession) cmdlet. The default is the +current session on the local computer. + +```yaml +Type: CimSession[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ComputerName + +Specifies one or more Hyper-V hosts from which the assignable devices are to be dismounted. NetBIOS +names, IP addresses, and fully qualified domain names are allowed. The default is the local +computer. Use localhost or a dot (`.`) to specify the local computer explicitly. + +```yaml +Type: String[] +Parameter Sets: Path +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Credential + +Specifies one or more user accounts that have permission to perform this action. The default is the +current user. + +```yaml +Type: PSCredential[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +Forces the command to run without asking for user confirmation. + +Using the **Force** parameter also overrides some security checks in the platform. To learn more, +see [Dismount the device from the host partition +](/windows-server/virtualization/hyper-v/deploy/deploying-graphics-devices-using-dda#dismount-the-device-from-the-host-partition). + +If no partitioning driver is provided, during dismount, you must use `-Force` to bypass the +security warning. For more information about the security implications, see [Plan for deploying devices by using Discrete Device Assignment](/windows-server/virtualization/hyper-v/plan/plan-for-deploying-devices-using-discrete-device-assignment). + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstancePath + +Represents the Device Instance path in the host machine. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LocationPath + +Specifies the location path to the assignable device. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Passthru + +Returns an object for each process that the cmdlet started. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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](/powershell/module/microsoft.powershell.core/about/about_commonparameters). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.HyperV.PowerShell.VMHostAssignableDevice + +## NOTES + +## RELATED LINKS + +[Add-VMHostAssignableDevice](add-vmhostassignabledevice.md) + +[Get-VMHostAssignableDevice](get-vmhostassignabledevice.md) + +[Mount-VMHostAssignableDevice](mount-vmhostassignabledevice.md) + +[Remove-VMHostAssignableDevice](remove-vmhostassignabledevice.md) diff --git a/docset/winserver2022-ps/hyper-v/Get-VMGpuPartitionAdapter.md b/docset/winserver2022-ps/hyper-v/Get-VMGpuPartitionAdapter.md index 5df16d8162..ac4dfa9373 100644 --- a/docset/winserver2022-ps/hyper-v/Get-VMGpuPartitionAdapter.md +++ b/docset/winserver2022-ps/hyper-v/Get-VMGpuPartitionAdapter.md @@ -2,7 +2,7 @@ description: Gets the information of assigned GPU partitions to a virtual machine. external help file: Microsoft.HyperV.PowerShell.Cmdlets.dll-Help.xml Module Name: Hyper-V -ms.date: 09/22/2022 +ms.date: 06/12/2024 online version: https://learn.microsoft.com/powershell/module/hyper-v/get-vmgpupartitionadapter?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Get-VMGpuPartitionAdapter @@ -16,24 +16,29 @@ Gets the information of assigned GPU partitions to a virtual machine. ## SYNTAX ### VMName (Default) + ``` Get-VMGpuPartitionAdapter [-CimSession ] [-ComputerName ] [-Credential ] [-VMName] [-AdapterId ] [] ``` ### VMObject + ``` Get-VMGpuPartitionAdapter [-VM] [-AdapterId ] [] ``` ## DESCRIPTION -The 'Get-VMGpuPartitionAdapter' cmdlet gets the information of assigned graphic processing unit partitions to a virtual machine. + +The `Get-VMGpuPartitionAdapter` cmdlet gets the information of assigned graphic processing unit +partitions to a virtual machine. ## EXAMPLES ### Example 1 + ```powershell -$testvm = get-VM "TestVM" +$testvm = Get-VM "TestVM" Get-VMGpuPartitionAdapter -VM $testvm ``` @@ -42,7 +47,9 @@ This example gets the GPU information assigned to a VM object. ## PARAMETERS ### -AdapterId -This is a VM's GPU partition identification number used to display the GPU information assigned to a VM. + +This is a VM's GPU partition identification number used to display the GPU information assigned to a +VM. ```yaml Type: String @@ -57,9 +64,11 @@ Accept wildcard characters: False ``` ### -CimSession -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. -The default is the current session on the local computer. + +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](/powershell/module/cimcmdlets/new-cimsession) +or [Get-CimSession](/powershell/module/cimcmdlets/get-cimsession) cmdlet. The default is the +current session on the local computer. ```yaml Type: CimSession[] @@ -74,10 +83,10 @@ Accept wildcard characters: False ``` ### -ComputerName -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. -The default is the local computer. -Use localhost or a dot ('.') to specify the local computer explicitly. + +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. The default is the local +computer. Use localhost or a dot (`.`) to specify the local computer explicitly. ```yaml Type: String[] @@ -92,8 +101,9 @@ Accept wildcard characters: False ``` ### -Credential -Specifies one or more user accounts that have permission to perform this action. -The default is the current user. + +Specifies one or more user accounts that have permission to perform this action. The default is the +current user. ```yaml Type: PSCredential[] @@ -108,6 +118,7 @@ Accept wildcard characters: False ``` ### -VM + Specifies the virtual machine whose virtual network adapters are to be retrieved. The asterisk (`*`) is the wildcard. If it is specified the cmdlet returns virtual network adapters from every virtual machine in the system. @@ -125,6 +136,7 @@ Accept wildcard characters: True ``` ### -VMName + Specifies the name of the virtual machine whose network adapters are to be retrieved. ```yaml @@ -140,7 +152,11 @@ 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](https://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](/powershell/module/microsoft.powershell.core/about/about_commonparameters). ## INPUTS @@ -155,3 +171,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS + +[Add-VMGpuPartitionAdapter](add-vmgpupartitionadapter.md) + +[Remove-VMGpuPartitionAdapter](remove-vmgpupartitionadapter.md) + +[Set-VMGpuPartitionAdapter](set-vmgpupartitionadapter.md) diff --git a/docset/winserver2022-ps/hyper-v/Get-VMHostAssignableDevice.md b/docset/winserver2022-ps/hyper-v/Get-VMHostAssignableDevice.md new file mode 100644 index 0000000000..21710a4e47 --- /dev/null +++ b/docset/winserver2022-ps/hyper-v/Get-VMHostAssignableDevice.md @@ -0,0 +1,178 @@ +--- +description: Retrieves information about an assignable device to a virtual machine host. +external help file: Microsoft.HyperV.PowerShell.Cmdlets.dll-Help.xml +Module Name: Hyper-V +ms.date: 06/12/2024 +online version: https://learn.microsoft.com/powershell/module/hyper-v/get-vmhostassignabledevice?view=windowsserver2022-ps&wt.mc_id=ps-gethelp +schema: 2.0.0 +title: Get-VMHostAssignableDevice +--- + +# Get-VMHostAssignableDevice + +## SYNOPSIS +Retrieves device information assigned to a virtual machine (VM) host. + +## SYNTAX + +``` +Get-VMHostAssignableDevice [-InstancePath ] [-LocationPath ] + [-ResourcePoolName ] [-CimSession ] [-ComputerName ] + [-Credential ] [] +``` + +## DESCRIPTION + +The `Get-VMHostAssignableDevice` cmdlet retrieves information about devices that can be assigned to +a virtual machine host. This can include devices such as GPUs, network adapters, or storage +controllers that are physically present on the host system. The cmdlet can filter devices by their +instance path or location path. + +## EXAMPLES + +### Example 1 + +```powershell +Get-VMHostAssignableDevice +``` + +This example retrieves all assignable devices on the host computer. + +### Example 2 + +```powershell +Get-VMHostAssignableDevice -ComputerName "MyHost" +``` + +In this example, the cmdlet retrieves all assignable devices from the computer named **MyHost**. + +## PARAMETERS + +### -CimSession + +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](/powershell/module/cimcmdlets/new-cimsession) +or [Get-CimSession](/powershell/module/cimcmdlets/get-cimsession) cmdlet. The default is the +current session on the local computer. + +```yaml +Type: CimSession[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ComputerName + +Specifies one or more Hyper-V hosts from which the assignable devices are to be retrieved. NetBIOS +names, IP addresses, and fully qualified domain names are allowed. The default is the local +computer. Use localhost or a dot (`.`) to specify the local computer explicitly. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Credential + +Specifies one or more user accounts that have permission to perform this action. The default is the +current user. + +```yaml +Type: PSCredential[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstancePath + +Represents the Device Instance path in the host machine. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LocationPath + +Specifies the location path to the assignable device. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourcePoolName + +Retrieves the name of the resource pool to which the device is assigned. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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](/powershell/module/microsoft.powershell.core/about/about_commonparameters). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.HyperV.PowerShell.VMHostAssignableDevice + +## NOTES + +## RELATED LINKS + +[Add-VMHostAssignableDevice](add-vmhostassignabledevice.md) + +[Dismount-VMHostAssignableDevice](dismount-vmhostassignabledevice.md) + +[Mount-VMHostAssignableDevice](mount-vmhostassignabledevice.md) + +[Remove-VMHostAssignableDevice](remove-vmhostassignabledevice.md) diff --git a/docset/winserver2022-ps/hyper-v/Get-VMHostPartitionableGpu.md b/docset/winserver2022-ps/hyper-v/Get-VMHostPartitionableGpu.md index c22e441be3..21c54739a9 100644 --- a/docset/winserver2022-ps/hyper-v/Get-VMHostPartitionableGpu.md +++ b/docset/winserver2022-ps/hyper-v/Get-VMHostPartitionableGpu.md @@ -2,7 +2,7 @@ description: Gets the host machine’s partitionable GPU. external help file: Microsoft.HyperV.PowerShell.Cmdlets.dll-Help.xml Module Name: Hyper-V -ms.date: 09/22/2022 +ms.date: 06/12/2024 online version: https://learn.microsoft.com/powershell/module/hyper-v/get-vmhostpartitionablegpu?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Get-VMHostPartitionableGpu @@ -16,49 +16,59 @@ Gets the host machine’s partitionable GPU. ## SYNTAX ### ComputerName (Default) + ``` -Get-VMHostPartitionableGpu [[-ComputerName] ] [[-Credential] ] [-Name ] - [] +Get-VMHostPartitionableGpu [[-ComputerName] ] [[-Credential] ] + [-Name ] [] ``` ### CimSession + ``` Get-VMHostPartitionableGpu [-CimSession] [-Name ] [] ``` ## DESCRIPTION -The 'Get-VMHostPartitionableGpu' cmdlet gets the host machine’s partitionable graphic processing unit. -This displays the information of the GPU as provided by the manufacturer's driver. + +The `Get-VMHostPartitionableGpu` cmdlet gets the host machine’s partitionable graphic processing +unit. This displays the information of the GPU as provided by the manufacturer's driver. ## EXAMPLES ### Example 1 -``` + +```powershell Get-VMHostPartitionableGpu ``` This example gets the details of the local partitionable graphic processing unit on the host. ### Example 2 + ```powershell -Get-VMHostPartitionableGpu -ComputerName "SampleHost" +Get-VMHostPartitionableGpu -ComputerName "MyHost" ``` -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. +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. ### Example 3 + ```powershell -Get-VMHostPartitionableGpu -name "SampleGPUDeviceIDName" +Get-VMHostPartitionableGpu -Name "GPUDeviceIDName" ``` -Displays a partitionable GPU by using the specific GPU device name. The result will show the details of the specific GPU listed. +Displays a partitionable GPU by using the specific GPU device name. The result will show the +details of the specific GPU listed. ## PARAMETERS ### -CimSession -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. -The default is the current session on the local computer. + +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](/powershell/module/cimcmdlets/new-cimsession) +or [Get-CimSession](/powershell/module/cimcmdlets/get-cimsession) cmdlet. The default is the +current session on the local computer. ```yaml Type: CimSession[] @@ -73,10 +83,10 @@ Accept wildcard characters: False ``` ### -ComputerName -Specifies one or more Hyper-V hosts that run this cmdlet. -NetBIOS names, IP addresses, and fully qualified domain names are allowed. -The default is the local computer. -Use localhost or a dot ('.') to specify the local computer explicitly. + +Specifies one or more Hyper-V hosts that run this cmdlet. NetBIOS names, IP addresses, and fully +qualified domain names are allowed. The default is the local computer. Use localhost or a dot (`.`) +to specify the local computer explicitly. ```yaml Type: String[] @@ -91,7 +101,9 @@ Accept wildcard characters: False ``` ### -Credential -Specifies one or more user accounts that have permission to perform this action. The default is the current user. + +Specifies one or more user accounts that have permission to perform this action. The default is the +current user. ```yaml Type: PSCredential[] @@ -106,6 +118,7 @@ Accept wildcard characters: False ``` ### -Name + Specifies the name of the graphic processing unit to be retrieved. ```yaml @@ -121,7 +134,11 @@ 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](https://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](/powershell/module/microsoft.powershell.core/about/about_commonparameters). ## INPUTS @@ -134,3 +151,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS + +[Set-VMHostPartitionableGpu](set-vmhostpartitionablegpu.md) diff --git a/docset/winserver2022-ps/hyper-v/Mount-VMHostAssignableDevice.md b/docset/winserver2022-ps/hyper-v/Mount-VMHostAssignableDevice.md new file mode 100644 index 0000000000..f369872edc --- /dev/null +++ b/docset/winserver2022-ps/hyper-v/Mount-VMHostAssignableDevice.md @@ -0,0 +1,232 @@ +--- +description: Mounts an assignable device to a virtual machine host. +external help file: Microsoft.HyperV.PowerShell.Cmdlets.dll-Help.xml +Module Name: Hyper-V +ms.date: 06/12/2024 +online version: https://learn.microsoft.com/powershell/module/hyper-v/mount-vmhostassignabledevice?view=windowsserver2022-ps&wt.mc_id=ps-gethelp +schema: 2.0.0 +title: Mount-VMHostAssignableDevice +--- + +# Mount-VMHostAssignableDevice + +## SYNOPSIS +Mounts a device to a virtual machine (VM) host. + +## SYNTAX + +### Path (Default) + +``` +Mount-VMHostAssignableDevice [-CimSession ] [-ComputerName ] + [-Credential ] [-InstancePath ] [-LocationPath ] [-Passthru] + [-WhatIf] [-Confirm] [] +``` + +### Object + +``` +Mount-VMHostAssignableDevice [-HostAssignableDevice] [-Passthru] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION + +The `Mount-VMHostAssignableDevice` cmdlet mounts a device such as GPUs, network adapters, or storage +controllers that are physically present on the virtual machine host. + +## EXAMPLES + +### Example 1 + +```powershell +$device = Get-VMHostAssignableDevice -InstancePath "PCIROOT(0)#PCI(0300)#PCI(0000)" +$params = @{ +HostAssignableDevice = $device +VMName = "MyVM" +} +Mount-VMHostAssignableDevice @params +``` + +In this example, the `Get-VMHostAssignableDevice` cmdlet retrieves the device with the specified +instance path and stores it in the `$device` variable. The `Mount-VMHostAssignableDevice` cmdlet +then assigns this device to the virtual machine named **MyVM**. + +## PARAMETERS + +### -CimSession + +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](/powershell/module/cimcmdlets/new-cimsession) +or [Get-CimSession](/powershell/module/cimcmdlets/get-cimsession) cmdlet. The default is the +current session on the local computer. + +```yaml +Type: CimSession[] +Parameter Sets: Path +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ComputerName + +Specifies one or more Hyper-V hosts from which the assignable devices are to be mounted. NetBIOS +names, IP addresses, and fully qualified domain names are allowed. The default is the local +computer. Use localhost or a dot (`.`) to specify the local computer explicitly. + +```yaml +Type: String[] +Parameter Sets: Path +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Credential + +Specifies one or more user accounts that have permission to perform this action. The default is the +current user. + +```yaml +Type: PSCredential[] +Parameter Sets: Path +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HostAssignableDevice + +Specifies the assignable device to be mounted on the virtual machine host. + +```yaml +Type: VMHostAssignableDevice[] +Parameter Sets: Object +Aliases: VMHostAssignableDevice + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InstancePath + +Represents the Device Instance path in the host machine. + +```yaml +Type: String +Parameter Sets: Path +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LocationPath + +Specifies the location path to the assignable device. + +```yaml +Type: String +Parameter Sets: Path +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Passthru + +Returns an object for each process that the cmdlet started. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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](/powershell/module/microsoft.powershell.core/about/about_commonparameters). + +## INPUTS + +### Microsoft.HyperV.PowerShell.VMHostAssignableDevice[] + +## OUTPUTS + +### Microsoft.HyperV.PowerShell.VMHostAssignableDevice + +## NOTES + +## RELATED LINKS + +[Add-VMHostAssignableDevice](add-vmhostassignabledevice.md) + +[Get-VMHostAssignableDevice](get-vmhostassignabledevice.md) + +[Dismount-VMHostAssignableDevice](dismount-vmhostassignabledevice.md) + +[Remove-VMHostAssignableDevice](remove-vmhostassignabledevice.md) diff --git a/docset/winserver2022-ps/hyper-v/Remove-VMGpuPartitionAdapter.md b/docset/winserver2022-ps/hyper-v/Remove-VMGpuPartitionAdapter.md index 0815ce1194..c56b987873 100644 --- a/docset/winserver2022-ps/hyper-v/Remove-VMGpuPartitionAdapter.md +++ b/docset/winserver2022-ps/hyper-v/Remove-VMGpuPartitionAdapter.md @@ -2,7 +2,7 @@ description: Removes an assigned GPU partition from a virtual machine. external help file: Microsoft.HyperV.PowerShell.Cmdlets.dll-Help.xml Module Name: Hyper-V -ms.date: 09/22/2022 +ms.date: 06/12/2024 online version: https://learn.microsoft.com/powershell/module/hyper-v/remove-vmgpupartitionadapter?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Remove-VMGpuPartitionAdapter @@ -16,30 +16,36 @@ Removes an assigned GPU partition from a virtual machine. ## SYNTAX ### VMName (Default) + ``` Remove-VMGpuPartitionAdapter [-CimSession ] [-ComputerName ] - [-Credential ] [-VMName] [-Passthru] [-AdapterId ] [-WhatIf] [-Confirm] - [] + [-Credential ] [-VMName] [-Passthru] [-AdapterId ] [-WhatIf] + [-Confirm] [] ``` ### VMObject + ``` -Remove-VMGpuPartitionAdapter [-VM] [-Passthru] [-AdapterId ] [-WhatIf] [-Confirm] - [] +Remove-VMGpuPartitionAdapter [-VM] [-Passthru] [-AdapterId ] [-WhatIf] + [-Confirm] [] ``` ### Object + ``` -Remove-VMGpuPartitionAdapter [-VMGpuPartitionAdapter] [-Passthru] [-WhatIf] - [-Confirm] [] +Remove-VMGpuPartitionAdapter [-VMGpuPartitionAdapter] [-Passthru] + [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION -The 'Remove-VMGpuPartitionAdapter' cmdlet removes an assigned graphic processing unit partition from a virtual machine and releases that partition back to the host GPU. + +The `Remove-VMGpuPartitionAdapter` cmdlet removes an assigned graphic processing unit partition from +a virtual machine and releases that partition back to the host GPU. ## EXAMPLES ### Example 1 + ```powershell $testvm = Get-VM "TestVM" Remove-VMGpuPartitionAdapter -VM $testvm @@ -48,6 +54,7 @@ Remove-VMGpuPartitionAdapter -VM $testvm This example removes a partition assigned to a specific VM object. ### Example 2 + ```powershell $testvm = Get-VM "TestVM" $GPUpartition = Get-VMGpuPartitionAdapter -VM $testvm @@ -59,7 +66,8 @@ This example removes a specific partition object from a specific VM. ## PARAMETERS ### -AdapterId -This is a VM's GPU partition identification number used to remove a GPU from a VM. + +This is a VM's GPU partition identification number used to remove a GPU from a VM. ```yaml Type: String @@ -74,9 +82,11 @@ Accept wildcard characters: False ``` ### -CimSession -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. -The default is the current session on the local computer. + +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](/powershell/module/cimcmdlets/new-cimsession) +or [Get-CimSession](/powershell/module/cimcmdlets/get-cimsession) cmdlet. The default is the +current session on the local computer. ```yaml Type: CimSession[] @@ -91,8 +101,10 @@ Accept wildcard characters: False ``` ### -ComputerName -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. -The default is the local computer.Use localhost or a dot ('.') to specify the local computer explicitly. + +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. The default is the local +computer.Use localhost or a dot (`.`) to specify the local computer explicitly. ```yaml Type: String[] @@ -107,7 +119,9 @@ Accept wildcard characters: False ``` ### -Credential -Specifies one or more user accounts that have permission to perform this action. The default is the current user. + +Specifies one or more user accounts that have permission to perform this action. The default is the +current user. ```yaml Type: PSCredential[] @@ -122,6 +136,7 @@ Accept wildcard characters: False ``` ### -Passthru + Returns an object for each process that the cmdlet started. ```yaml @@ -137,6 +152,7 @@ Accept wildcard characters: False ``` ### -VM + Specifies the virtual machine whose virtual network adapters are to be retrieved. The asterisk (`*`) is the wildcard. If it is specified the cmdlet returns virtual network adapters from every virtual machine in the system. @@ -154,7 +170,8 @@ Accept wildcard characters: False ``` ### -VMGpuPartitionAdapter -GPU partition object obtained from 'Get-VMGpuPartitionAdapter'. + +GPU partition object obtained from `Get-VMGpuPartitionAdapter`. ```yaml Type: VMGpuPartitionAdapter[] @@ -169,6 +186,7 @@ Accept wildcard characters: False ``` ### -VMName + Specifies the name of the virtual machine whose network adapters are to be retrieved. ```yaml @@ -184,6 +202,7 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml @@ -199,8 +218,8 @@ Accept wildcard characters: False ``` ### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. + +Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml Type: SwitchParameter @@ -215,7 +234,11 @@ 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](https://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](/powershell/module/microsoft.powershell.core/about/about_commonparameters). ## INPUTS @@ -230,3 +253,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS + +[Add-VMGpuPartitionAdapter](add-vmgpupartitionadapter.md) + +[Get-VMGpuPartitionAdapter](get-vmgpupartitionadapter.md) + +[Set-VMGpuPartitionAdapter](set-vmgpupartitionadapter.md) diff --git a/docset/winserver2022-ps/hyper-v/Remove-VMHostAssignableDevice.md b/docset/winserver2022-ps/hyper-v/Remove-VMHostAssignableDevice.md new file mode 100644 index 0000000000..fa796cc38e --- /dev/null +++ b/docset/winserver2022-ps/hyper-v/Remove-VMHostAssignableDevice.md @@ -0,0 +1,248 @@ +--- +description: Removes an assignable device from a virtual machine host. +external help file: Microsoft.HyperV.PowerShell.Cmdlets.dll-Help.xml +Module Name: Hyper-V +ms.date: 06/12/2024 +online version: https://learn.microsoft.com/powershell/module/hyper-v/remove-vmhostassignabledevice?view=windowsserver2022-ps&wt.mc_id=ps-gethelp +schema: 2.0.0 +title: Remove-VMHostAssignableDevice +--- + +# Remove-VMHostAssignableDevice + +## SYNOPSIS +Removes a device assigned to a virtual machine (VM) host. + +## SYNTAX + +### Path (Default) + +``` +Remove-VMHostAssignableDevice [-CimSession ] [-ComputerName ] + [-Credential ] [-InstancePath ] [-LocationPath ] + -ResourcePoolName [-Force] [-WhatIf] [-Confirm] [] +``` + +### Object + +``` +Remove-VMHostAssignableDevice [-HostAssignableDevice] + -ResourcePoolName [-Force] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION + +The `Remove-VMHostAssignableDevice` cmdlet removes a device that is assigned to a virtual machine +host. Depending on the parameters specified, you can remove devices by providing either the +instance or location path of the device. + +## EXAMPLES + +### Example 1 + +```powershell +$params = @{ +InstancePath = "PCIROOT(0)#PCI(0300)#PCI(0000)" +ResourcePoolName = "MyResourcePool" +} +Remove-VMHostAssignableDevice $params +``` + +This example removes the device with the specified instance path from the resource pool named +**MyResourcePool**. + +## PARAMETERS + +### -CimSession + +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](/powershell/module/cimcmdlets/new-cimsession) +or [Get-CimSession](/powershell/module/cimcmdlets/get-cimsession) cmdlet. The default is the +current session on the local computer. + +```yaml +Type: CimSession[] +Parameter Sets: Path +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ComputerName + +Specifies one or more Hyper-V hosts from which the assignable devices are to be removed. NetBIOS +names, IP addresses, and fully qualified domain names are allowed. The default is the local +computer. Use localhost or a dot (`.`) to specify the local computer explicitly. + +```yaml +Type: String[] +Parameter Sets: Path +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Credential + +Specifies one or more user accounts that have permission to perform this action. The default is the +current user. + +```yaml +Type: PSCredential[] +Parameter Sets: Path +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +Forces the command to run without asking for user confirmation. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HostAssignableDevice + +Specifies the device object to be removed. You can get this object using +`Get-VMHostAssignableDevice`. + +```yaml +Type: VMHostAssignableDevice[] +Parameter Sets: Object +Aliases: VMHostAssignableDevice + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InstancePath + +Specifies the Device Instance path in the host machine. + +```yaml +Type: String +Parameter Sets: Path +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LocationPath + +Specifies the location path to the assignable device. + +```yaml +Type: String +Parameter Sets: Path +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourcePoolName + +Specifies the name of the resource pool from which to remove an assignable device. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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](/powershell/module/microsoft.powershell.core/about/about_commonparameters). + +## INPUTS + +### Microsoft.HyperV.PowerShell.VMHostAssignableDevice[] + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Add-VMHostAssignableDevice](add-vmhostassignabledevice.md) + +[Get-VMHostAssignableDevice](get-vmhostassignabledevice.md) + +[Dismount-VMHostAssignableDevice](dismount-vmhostassignabledevice.md) + +[Mount-VMHostAssignableDevice](mount-vmhostassignabledevice.md) diff --git a/docset/winserver2022-ps/hyper-v/Set-VMGpuPartitionAdapter.md b/docset/winserver2022-ps/hyper-v/Set-VMGpuPartitionAdapter.md index e6311979a5..cbbc027a4e 100644 --- a/docset/winserver2022-ps/hyper-v/Set-VMGpuPartitionAdapter.md +++ b/docset/winserver2022-ps/hyper-v/Set-VMGpuPartitionAdapter.md @@ -2,7 +2,7 @@ description: Assigns a partition of a GPU to a virtual machine. external help file: Microsoft.HyperV.PowerShell.Cmdlets.dll-Help.xml Module Name: Hyper-V -ms.date: 09/22/2022 +ms.date: 06/12/2024 online version: https://learn.microsoft.com/powershell/module/hyper-v/set-vmgpupartitionadapter?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Set-VMGpuPartitionAdapter @@ -16,44 +16,51 @@ Assigns a partition of a GPU to a virtual machine. ## SYNTAX ### VMName (Default) + ``` Set-VMGpuPartitionAdapter [-CimSession ] [-ComputerName ] [-Credential ] [-VMName] [-Passthru] [-AdapterId ] [-MinPartitionVRAM ] [-MaxPartitionVRAM ] [-OptimalPartitionVRAM ] [-MinPartitionEncode ] [-MaxPartitionEncode ] [-OptimalPartitionEncode ] [-MinPartitionDecode ] [-MaxPartitionDecode ] [-OptimalPartitionDecode ] - [-MinPartitionCompute ] [-MaxPartitionCompute ] [-OptimalPartitionCompute ] [-WhatIf] - [-Confirm] [] + [-MinPartitionCompute ] [-MaxPartitionCompute ] [-OptimalPartitionCompute ] + [-WhatIf] [-Confirm] [] ``` ### VMObject + ``` Set-VMGpuPartitionAdapter [-VM] [-Passthru] [-AdapterId ] [-MinPartitionVRAM ] [-MaxPartitionVRAM ] [-OptimalPartitionVRAM ] [-MinPartitionEncode ] [-MaxPartitionEncode ] [-OptimalPartitionEncode ] [-MinPartitionDecode ] [-MaxPartitionDecode ] [-OptimalPartitionDecode ] - [-MinPartitionCompute ] [-MaxPartitionCompute ] [-OptimalPartitionCompute ] [-WhatIf] - [-Confirm] [] + [-MinPartitionCompute ] [-MaxPartitionCompute ] [-OptimalPartitionCompute ] + [-WhatIf] [-Confirm] [] ``` ### Object + ``` Set-VMGpuPartitionAdapter [-VMGpuPartitionAdapter] [-Passthru] [-MinPartitionVRAM ] [-MaxPartitionVRAM ] [-OptimalPartitionVRAM ] [-MinPartitionEncode ] [-MaxPartitionEncode ] [-OptimalPartitionEncode ] [-MinPartitionDecode ] [-MaxPartitionDecode ] [-OptimalPartitionDecode ] - [-MinPartitionCompute ] [-MaxPartitionCompute ] [-OptimalPartitionCompute ] [-WhatIf] - [-Confirm] [] + [-MinPartitionCompute ] [-MaxPartitionCompute ] [-OptimalPartitionCompute ] + [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION -The 'Set-VMGpuPartitionAdapter' cmdlet assigns a partition of a GPU to a virtual machine. Running the command against a virtual machine assigns a full partition. Additional parameters exist to assign more specific options to a VM. + +The `Set-VMGpuPartitionAdapter` cmdlet assigns a partition of a GPU to a virtual machine. Running +the command against a virtual machine assigns a full partition. Additional parameters exist to +assign more specific options to a VM. ## EXAMPLES ### Example 1 + ```powershell -$vm = get-vm test +$vm = Get-VM "Test" Set-VMGpuPartitionAdapter -VM $vm ``` @@ -62,6 +69,7 @@ This example assign a partition to a VM passing a VM object. ## PARAMETERS ### -AdapterId + A VM's GPU partition identification number used to display the GPU information assigned to a VM. ```yaml @@ -77,8 +85,11 @@ Accept wildcard characters: False ``` ### -CimSession -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. -The default is the current session on the local computer. + +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](/powershell/module/cimcmdlets/new-cimsession) +or [Get-CimSession](/powershell/module/cimcmdlets/get-cimsession) cmdlet. The default is the +current session on the local computer. ```yaml Type: CimSession[] @@ -93,9 +104,10 @@ Accept wildcard characters: False ``` ### -ComputerName -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. -The default is the local computer. -Use localhost or a dot ('.') to specify the local computer explicitly. + +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. The default is the local +computer. Use localhost or a dot (`.`) to specify the local computer explicitly. ```yaml Type: String[] @@ -110,8 +122,9 @@ Accept wildcard characters: False ``` ### -Credential -Specifies one or more user accounts that have permission to perform this action. -The default is the current user. + +Specifies one or more user accounts that have permission to perform this action. The default is the +current user. ```yaml Type: PSCredential[] @@ -126,7 +139,9 @@ Accept wildcard characters: False ``` ### -MaxPartitionCompute -The maximum number of compute assigned by the host GPU. This is defined by the manufacturer's driver. + +The maximum number of compute assigned by the host GPU. This is defined by the manufacturer's +driver. ```yaml Type: UInt64 @@ -141,7 +156,9 @@ Accept wildcard characters: False ``` ### -MaxPartitionDecode -The maximum number of decoders assigned by the host GPU. This is defined by the manufacturer's driver. + +The maximum number of decoders assigned by the host GPU. This is defined by the manufacturer's +driver. ```yaml Type: UInt64 @@ -156,7 +173,9 @@ Accept wildcard characters: False ``` ### -MaxPartitionEncode -The maximum number of encoders assigned by the host GPU. This is defined by the manufacturer's driver. + +The maximum number of encoders assigned by the host GPU. This is defined by the manufacturer's +driver. ```yaml Type: UInt64 @@ -171,6 +190,7 @@ Accept wildcard characters: False ``` ### -MaxPartitionVRAM + The maximum VRAM in bytes supported by the host GPU. This is defined by the manufacturer's driver. ```yaml @@ -186,7 +206,9 @@ Accept wildcard characters: False ``` ### -MinPartitionCompute -The minimum number of compute assigned by the host GPU. This is defined by the manufacturer's driver. + +The minimum number of compute assigned by the host GPU. This is defined by the manufacturer's +driver. ```yaml Type: UInt64 @@ -201,7 +223,9 @@ Accept wildcard characters: False ``` ### -MinPartitionDecode -The minimum number of decoders assigned by the host GPU. This is defined by the manufacturer's driver. + +The minimum number of decoders assigned by the host GPU. This is defined by the manufacturer's +driver. ```yaml Type: UInt64 @@ -216,7 +240,9 @@ Accept wildcard characters: False ``` ### -MinPartitionEncode -The minimum number of encoders assigned by the host GPU. This is defined by the manufacturer's driver. + +The minimum number of encoders assigned by the host GPU. This is defined by the manufacturer's +driver. ```yaml Type: UInt64 @@ -231,6 +257,7 @@ Accept wildcard characters: False ``` ### -MinPartitionVRAM + The minimum VRAM in bytes supported by the host GPU. This is defined by the manufacturer's driver. ```yaml @@ -246,7 +273,9 @@ Accept wildcard characters: False ``` ### -OptimalPartitionCompute -The optimal number of compute assigned by the host GPU. This is defined by the manufacturer's driver. + +The optimal number of compute assigned by the host GPU. This is defined by the manufacturer's +driver. ```yaml Type: UInt64 @@ -261,7 +290,9 @@ Accept wildcard characters: False ``` ### -OptimalPartitionDecode -The optimal number of decoders assigned by the host GPU. This is defined by the manufacturer's driver. + +The optimal number of decoders assigned by the host GPU. This is defined by the manufacturer's +driver. ```yaml Type: UInt64 @@ -276,7 +307,9 @@ Accept wildcard characters: False ``` ### -OptimalPartitionEncode -The optimal number of encoders assigned by the host GPU. This is defined by the manufacturer's driver. + +The optimal number of encoders assigned by the host GPU. This is defined by the manufacturer's +driver. ```yaml Type: UInt64 @@ -291,6 +324,7 @@ Accept wildcard characters: False ``` ### -OptimalPartitionVRAM + The optimal VRAM in bytes supported by the host GPU. This is defined by the manufacturer's driver. ```yaml @@ -306,6 +340,7 @@ Accept wildcard characters: False ``` ### -Passthru + Returns an object for each process that the cmdlet started. ```yaml @@ -321,6 +356,7 @@ Accept wildcard characters: False ``` ### -VM + Specifies the virtual machine whose virtual network adapters are to be retrieved. The asterisk (`*`) is the wildcard. If it is specified the cmdlet returns virtual network adapters from every virtual machine in the system. @@ -338,7 +374,8 @@ Accept wildcard characters: False ``` ### -VMGpuPartitionAdapter -GPU partition object obtained from 'Get-VMGpuPartitionAdapter'. + +GPU partition object obtained from `Get-VMGpuPartitionAdapter`. ```yaml Type: VMGpuPartitionAdapter[] @@ -353,6 +390,7 @@ Accept wildcard characters: False ``` ### -VMName + Specifies the name of the virtual machine whose network adapters are to be retrieved. ```yaml @@ -368,6 +406,7 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml @@ -383,8 +422,8 @@ Accept wildcard characters: False ``` ### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. + +Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml Type: SwitchParameter @@ -399,7 +438,11 @@ 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](https://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](/powershell/module/microsoft.powershell.core/about/about_commonparameters). ## INPUTS @@ -416,3 +459,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS + +[Add-VMGpuPartitionAdapter](add-vmgpupartitionadapter.md) + +[Get-VMGpuPartitionAdapter](get-vmgpupartitionadapter.md) + +[Remove-VMGpuPartitionAdapter](remove-vmgpupartitionadapter.md) diff --git a/docset/winserver2022-ps/hyper-v/Set-VMHostPartitionableGpu.md b/docset/winserver2022-ps/hyper-v/Set-VMHostPartitionableGpu.md index 6cca814585..3a2bf70ec7 100644 --- a/docset/winserver2022-ps/hyper-v/Set-VMHostPartitionableGpu.md +++ b/docset/winserver2022-ps/hyper-v/Set-VMHostPartitionableGpu.md @@ -2,7 +2,7 @@ description: Configures the host partitionable GPU to the number of partitions supported by the manufacturer. external help file: Microsoft.HyperV.PowerShell.Cmdlets.dll-Help.xml Module Name: Hyper-V -ms.date: 10/21/2022 +ms.date: 06/12/2024 online version: https://learn.microsoft.com/powershell/module/hyper-v/set-vmhostpartitionablegpu?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Set-VMHostPartitionableGpu @@ -16,44 +16,51 @@ Configures the host partitionable GPU to the number of partitions supported by t ## SYNTAX ### ComputerName (Default) + ``` Set-VMHostPartitionableGpu [[-ComputerName] ] [[-Credential] ] [-Passthru] [-PartitionCount ] [] ``` ### CimSession + ``` Set-VMHostPartitionableGpu [-CimSession] [-Passthru] [-PartitionCount ] [] ``` ### Object + ``` Set-VMHostPartitionableGpu [-HostPartitionableGpu] [-Passthru] [-PartitionCount ] [] ``` ### Name + ``` Set-VMHostPartitionableGpu [-Passthru] [-Name ] [-PartitionCount ] [] ``` ## DESCRIPTION + The `Set-VMHostPartitionableGpu` cmdlet configures the host partitionable GPU to the number of partitions supported by the manufacturer. ## EXAMPLES ### Example 1 + ```powershell -Set-VMHostPartitionableGpu -ComputerName SampleHost -partitioncount 8 +Set-VMHostPartitionableGpu -ComputerName "MyHost" -PartitionCount 8 ``` This example partitions a GPU in a specific host into eight partitions. ### Example 2 + ```powershell -$GPU = Get-VMHostPartitionableGpu -name "SampleGPUDeviceIDName" -Set-VMHostPartitionableGpu -Name $GPU -partitionCount 4 +$GPU = Get-VMHostPartitionableGpu -Name "GPUDeviceIDName" +Set-VMHostPartitionableGpu -Name $GPU -PartitionCount 4 ``` This example partitions a GPU in a host into four partitions by using the GPU device ID name. @@ -61,8 +68,11 @@ This example partitions a GPU in a host into four partitions by using the GPU de ## PARAMETERS ### -CimSession -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. -The default is the current session on the local computer. + +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](/powershell/module/cimcmdlets/new-cimsession) +or [Get-CimSession](/powershell/module/cimcmdlets/get-cimsession) cmdlet. The default is the +current session on the local computer. ```yaml Type: CimSession[] @@ -77,9 +87,10 @@ Accept wildcard characters: False ``` ### -ComputerName -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. -The default is the local computer. -Use localhost or a dot ('.') to specify the local computer explicitly. + +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. The default is the local +computer. Use localhost or a dot (`.`) to specify the local computer explicitly. ```yaml Type: String[] @@ -94,8 +105,9 @@ Accept wildcard characters: False ``` ### -Credential -Specifies one or more user accounts that have permission to perform this action. -The default is the current user. + +Specifies one or more user accounts that have permission to perform this action. The default is the +current user. ```yaml Type: PSCredential[] @@ -110,7 +122,8 @@ Accept wildcard characters: False ``` ### -HostPartitionableGpu -Full GPU object, obtained by executing 'Get-VMHostPartitionableGpu'. + +Full GPU object, obtained by executing `Get-VMHostPartitionableGpu`. ```yaml Type: VMHostPartitionableGpu[] @@ -125,6 +138,7 @@ Accept wildcard characters: False ``` ### -Name + Specifies the name of the GPU. ```yaml @@ -140,7 +154,9 @@ Accept wildcard characters: False ``` ### -PartitionCount -Specifies the number of partitions that the GPU will assign. The number of partitions is defined by the manufacturer. + +Specifies the number of partitions that the GPU will assign. The number of partitions is defined by +the manufacturer. ```yaml Type: UInt16 @@ -155,6 +171,7 @@ Accept wildcard characters: False ``` ### -Passthru + Returns an object for each process that the cmdlet started. ```yaml @@ -170,7 +187,11 @@ 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](https://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](/powershell/module/microsoft.powershell.core/about/about_commonparameters). ## INPUTS @@ -185,3 +206,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS + +[Get-VMHostPartitionableGpu](get-vmhostpartitionablegpu.md) diff --git a/docset/winserver2025-ps/hyper-v/Add-VMAssignableDevice.md b/docset/winserver2025-ps/hyper-v/Add-VMAssignableDevice.md new file mode 100644 index 0000000000..8524d0f863 --- /dev/null +++ b/docset/winserver2025-ps/hyper-v/Add-VMAssignableDevice.md @@ -0,0 +1,275 @@ +--- +description: Assigns a device to a virtual machine. +external help file: Microsoft.HyperV.PowerShell.Cmdlets.dll-Help.xml +Module Name: Hyper-V +ms.date: 06/12/2024 +online version: https://learn.microsoft.com/powershell/module/hyper-v/add-vmassignabledevice?view=windowsserver2025-ps&wt.mc_id=ps-gethelp +schema: 2.0.0 +title: Add-VMAssignableDevice +--- + +# Add-VMAssignableDevice + +## SYNOPSIS +Adds an assignable device to a specific virtual machine. + +## SYNTAX + +### VMName (Default) + +``` +Add-VMAssignableDevice [-CimSession ] [-ComputerName ] + [-Credential ] [-VMName] [-InstancePath ] + [-LocationPath ] [-VirtualFunction ] [-ResourcePoolName ] [-Passthru] + [-WhatIf] [-Confirm] [] +``` + +### VMObject + +``` +Add-VMAssignableDevice [-VM] [-InstancePath ] [-LocationPath ] + [-VirtualFunction ] [-ResourcePoolName ] [-Passthru] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION + +The `Add-VMAssignableDevice` cmdlet assigns a physical device to a specified virtual machine (VM). +This is commonly used for tasks such as attaching GPUs or network adapters directly to a VM to +enhance performance for specific applications or workloads. The device can be specified through its +instance path, location path, or assignable device object. + +## EXAMPLES + +### Example 1 + +```powershell +Add-VMAssignableDevice -VMName "MyVM" -InstancePath "PCIROOT(0)#PCI(0300)#PCI(0000)" +``` + +This example attaches a physical device, identified by its instance path, to the virtual machine +named **MyVM**. + +## PARAMETERS + +### -CimSession + +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](/powershell/module/cimcmdlets/new-cimsession) +or [Get-CimSession](/powershell/module/cimcmdlets/get-cimsession) cmdlet. The default is the +current session on the local computer. + +```yaml +Type: CimSession[] +Parameter Sets: VMName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ComputerName + +Specifies one or more Hyper-V hosts on which the assignable devices are to be retrieved. NetBIOS +names, IP addresses, and fully qualified domain names are allowed. The default is the local +computer. Use localhost or a dot (`.`) to specify the local computer explicitly. + +```yaml +Type: String[] +Parameter Sets: VMName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Credential + +Specifies one or more user accounts that have permission to perform this action. The default is the +current user. + +```yaml +Type: PSCredential[] +Parameter Sets: VMName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstancePath + +Represents the Device Instance path in the host machine. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LocationPath + +Specifies the location path to the assignable device + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Passthru + +Returns an object for each process that the cmdlet started. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourcePoolName + +Specifies the name of the resource pool to which the device is to be assigned. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualFunction + +Specifies the number of the virtual function (VF) of an SR-IOV-capable network adapter assigned to +the virtual machine. + +```yaml +Type: UInt16 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VM + +Specifies the virtual machine to which the device is to be assigned. + +```yaml +Type: VirtualMachine[] +Parameter Sets: VMObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -VMName + +Specifies the name of the virtual machine to which the device is to be assigned. + +```yaml +Type: String[] +Parameter Sets: VMName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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](/powershell/module/microsoft.powershell.core/about/about_commonparameters). + +## INPUTS + +### Microsoft.HyperV.PowerShell.VirtualMachine[] + +## OUTPUTS + +### Microsoft.HyperV.PowerShell.VMAssignedDevice + +## NOTES + +## RELATED LINKS + +[Get-VMAssignableDevice](get-vmassignabledevice.md) + +[Remove-VMAssignableDevice](remove-vmassignabledevice.md) diff --git a/docset/winserver2025-ps/hyper-v/Add-VMGpuPartitionAdapter.md b/docset/winserver2025-ps/hyper-v/Add-VMGpuPartitionAdapter.md index c20efc5557..81e37bb922 100644 --- a/docset/winserver2025-ps/hyper-v/Add-VMGpuPartitionAdapter.md +++ b/docset/winserver2025-ps/hyper-v/Add-VMGpuPartitionAdapter.md @@ -2,7 +2,7 @@ description: Adds a GPU partition adapter to a virtual machine. external help file: Microsoft.HyperV.PowerShell.Cmdlets.dll-Help.xml Module Name: Hyper-V -ms.date: 09/22/2022 +ms.date: 06/12/2024 online version: https://learn.microsoft.com/powershell/module/hyper-v/add-vmgpupartitionadapter?view=windowsserver2025-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Add-VMGpuPartitionAdapter @@ -16,53 +16,62 @@ Adds a GPU partition adapter to a virtual machine. ## SYNTAX ### VMName (Default) + ``` Add-VMGpuPartitionAdapter [-CimSession ] [-ComputerName ] [-Credential ] [-VMName] [-Passthru] [-InstancePath ] [-MinPartitionVRAM ] [-MaxPartitionVRAM ] [-OptimalPartitionVRAM ] [-MinPartitionEncode ] [-MaxPartitionEncode ] [-OptimalPartitionEncode ] [-MinPartitionDecode ] [-MaxPartitionDecode ] [-OptimalPartitionDecode ] - [-MinPartitionCompute ] [-MaxPartitionCompute ] [-OptimalPartitionCompute ] [-WhatIf] - [-Confirm] [] + [-MinPartitionCompute ] [-MaxPartitionCompute ] [-OptimalPartitionCompute ] + [-WhatIf] [-Confirm] [] ``` ### VMObject + ``` Add-VMGpuPartitionAdapter [-VM] [-Passthru] [-InstancePath ] [-MinPartitionVRAM ] [-MaxPartitionVRAM ] [-OptimalPartitionVRAM ] [-MinPartitionEncode ] [-MaxPartitionEncode ] [-OptimalPartitionEncode ] [-MinPartitionDecode ] [-MaxPartitionDecode ] [-OptimalPartitionDecode ] - [-MinPartitionCompute ] [-MaxPartitionCompute ] [-OptimalPartitionCompute ] [-WhatIf] - [-Confirm] [] + [-MinPartitionCompute ] [-MaxPartitionCompute ] [-OptimalPartitionCompute ] + [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION -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. + +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. ## EXAMPLES ### Example 1 + ```powershell -$vm = Get-VM -name "TestVM" +$vm = Get-VM -Name "TestVM" Add-VMGpuPartitionAdapter -VM $vm ``` This example assigns a partition to a specific VM object. ### Example 2 + ```powershell -$vm = Get-VM -name "TestVM" -Add-VMGpuPartitionAdapter -VM $vm -Instancepath "SampleGPUInstancePath" +$vm = Get-VM -Name "TestVM" +Add-VMGpuPartitionAdapter -VM $vm -InstancePath "GPUInstancePath" ``` -This example assigns a partition from a specific GPU to a VM where the instance path is the GPU device ID name on the host. +This example assigns a partition from a specific GPU to a VM where the instance path is the GPU +device ID name on the host. ## PARAMETERS ### -CimSession -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. -The default is the current session on the local computer. + +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](/powershell/module/cimcmdlets/new-cimsession) +or [Get-CimSession](/powershell/module/cimcmdlets/get-cimsession) cmdlet. The default is the +current session on the local computer. ```yaml Type: CimSession[] @@ -77,10 +86,10 @@ Accept wildcard characters: False ``` ### -ComputerName -Specifies one or more Hyper-V hosts from which virtual machines are to be retrieved. -NetBIOS names, IP addresses, and fully qualified domain names are allowable. -The default is the local computer. -Use localhost or a dot ('.') to specify the local computer explicitly. + +Specifies one or more Hyper-V hosts from which virtual machines are to be retrieved. NetBIOS names, +IP addresses, and fully qualified domain names are allowable. The default is the local computer. +Use localhost or a dot (`.`) to specify the local computer explicitly. ```yaml Type: String[] @@ -95,8 +104,9 @@ Accept wildcard characters: False ``` ### -Credential -Specifies one or more user accounts that have permission to perform this action. -The default is the current user. + +Specifies one or more user accounts that have permission to perform this action. The default is the +current user. ```yaml Type: PSCredential[] @@ -111,7 +121,9 @@ Accept wildcard characters: False ``` ### -InstancePath -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'. + +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`. ```yaml Type: String @@ -126,7 +138,9 @@ Accept wildcard characters: False ``` ### -MaxPartitionCompute -The maximum number of compute assigned by the host GPU. This is defined by the manufacturer's driver. + +The maximum number of compute assigned by the host GPU. This is defined by the manufacturer's +driver. ```yaml Type: UInt64 @@ -141,7 +155,9 @@ Accept wildcard characters: False ``` ### -MaxPartitionDecode -The maximum number of decoders assigned by the host GPU. This is defined by the manufacturer's driver. + +The maximum number of decoders assigned by the host GPU. This is defined by the manufacturer's +driver. ```yaml Type: UInt64 @@ -156,7 +172,9 @@ Accept wildcard characters: False ``` ### -MaxPartitionEncode -The maximum number of encoders assigned by the host GPU. This is defined by the manufacturer's driver. + +The maximum number of encoders assigned by the host GPU. This is defined by the manufacturer's +driver. ```yaml Type: UInt64 @@ -171,6 +189,7 @@ Accept wildcard characters: False ``` ### -MaxPartitionVRAM + The maximum VRAM in bytes supported by the host GPU. This is defined by the manufacturer's driver. ```yaml @@ -186,7 +205,9 @@ Accept wildcard characters: False ``` ### -MinPartitionCompute -The minimum number of compute assigned by the host GPU. This is defined by the manufacturer's driver. + +The minimum number of compute assigned by the host GPU. This is defined by the manufacturer's +driver. ```yaml Type: UInt64 @@ -201,7 +222,9 @@ Accept wildcard characters: False ``` ### -MinPartitionDecode -The minimum number of decoders assigned by the host GPU. This is defined by the manufacturer's driver. + +The minimum number of decoders assigned by the host GPU. This is defined by the manufacturer's +driver. ```yaml Type: UInt64 @@ -216,7 +239,9 @@ Accept wildcard characters: False ``` ### -MinPartitionEncode -The minimum number of encoders assigned by the host GPU. This is defined by the manufacturer's driver. + +The minimum number of encoders assigned by the host GPU. This is defined by the manufacturer's +driver. ```yaml Type: UInt64 @@ -231,6 +256,7 @@ Accept wildcard characters: False ``` ### -MinPartitionVRAM + The minimum VRAM in bytes supported by the host GPU. This is defined by the manufacturer's driver. ```yaml @@ -246,7 +272,9 @@ Accept wildcard characters: False ``` ### -OptimalPartitionCompute -The optimal number of compute assigned by the host GPU. This is defined by the manufacturer's driver. + +The optimal number of compute assigned by the host GPU. This is defined by the manufacturer's +driver. ```yaml Type: UInt64 @@ -261,7 +289,9 @@ Accept wildcard characters: False ``` ### -OptimalPartitionDecode -The optimal number of decoders assigned by the host GPU. This is defined by the manufacturer's driver. + +The optimal number of decoders assigned by the host GPU. This is defined by the manufacturer's +driver. ```yaml Type: UInt64 @@ -276,7 +306,9 @@ Accept wildcard characters: False ``` ### -OptimalPartitionEncode -The optimal number of encoders assigned by the host GPU. This is defined by the manufacturer's driver. + +The optimal number of encoders assigned by the host GPU. This is defined by the manufacturer's +driver. ```yaml Type: UInt64 @@ -291,6 +323,7 @@ Accept wildcard characters: False ``` ### -OptimalPartitionVRAM + The optimal VRAM in bytes supported by the host GPU. This is defined by the manufacturer's driver. ```yaml @@ -306,6 +339,7 @@ Accept wildcard characters: False ``` ### -Passthru + Returns an object for each process that the cmdlet started. ```yaml @@ -321,6 +355,7 @@ Accept wildcard characters: False ``` ### -VM + Specifies the virtual machine on which the network adapter is to be added. ```yaml @@ -336,6 +371,7 @@ Accept wildcard characters: False ``` ### -VMName + Specifies the name of the virtual machine on which the network adapter is to be added. ```yaml @@ -351,6 +387,7 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml @@ -366,8 +403,8 @@ Accept wildcard characters: False ``` ### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. + +Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml Type: SwitchParameter @@ -382,7 +419,11 @@ 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](https://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](/powershell/module/microsoft.powershell.core/about/about_commonparameters). ## INPUTS @@ -397,3 +438,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS + +- [Get-VMGpuPartitionAdapter](get-vmgpupartitionadapter.md) + +- [Remove-VMGpuPartitionAdapter](remove-vmgpupartitionadapter.md) + +- [Set-VMGpuPartitionAdapter](set-vmgpupartitionadapter.md) diff --git a/docset/winserver2025-ps/hyper-v/Add-VMHostAssignableDevice.md b/docset/winserver2025-ps/hyper-v/Add-VMHostAssignableDevice.md new file mode 100644 index 0000000000..faa9a5dff8 --- /dev/null +++ b/docset/winserver2025-ps/hyper-v/Add-VMHostAssignableDevice.md @@ -0,0 +1,227 @@ +--- +description: Assigns a device to a virtual machine host. +external help file: Microsoft.HyperV.PowerShell.Cmdlets.dll-Help.xml +Module Name: Hyper-V +ms.date: 06/12/2024 +online version: https://learn.microsoft.com/powershell/module/hyper-v/add-vmhostassignabledevice?view=windowsserver2025-ps&wt.mc_id=ps-gethelp +schema: 2.0.0 +title: Add-VMHostAssignableDevice +--- + +# Add-VMHostAssignableDevice + +## SYNOPSIS +Adds an assignable device to a virtual machine (VM) host. + +## SYNTAX + +### Path (Default) + +``` +Add-VMHostAssignableDevice [-CimSession ] [-ComputerName ] + [-Credential ] [-Force] [-InstancePath ] [-LocationPath ] + -ResourcePoolName [] +``` + +### Object + +``` +Add-VMHostAssignableDevice [-Force] [-HostAssignableDevice] + -ResourcePoolName [] +``` + +## DESCRIPTION + +The `Add-VMHostAssignableDevice` cmdlet assigns a hardware device to a virtual machine host. You +can add devices to the VM host by providing either the instance or location path of the device, or +by specifying an existing host-assignable device object. + +## EXAMPLES + +### Example 1 + +```powershell +$params = @{ +ComputerName = "MyVM01" +InstancePath = "PCI\VEN_8086&DEV_0F48&SUBSYS_72708086&REV_0B\3&11583659&0&D8" +ResourcePoolName = "MyResourcePool" +} +Add-VMHostAssignableDevice $params +``` + +This example assigns a device identified by its instance path to VM host **MyVM01** within the +resource pool **MyResourcePool**. + +### Example 2 + +```powershell +$gpu = Get-VMHostAssignableDevice +Add-VMHostAssignableDevice -HostAssignableDevice $gpu -ResourcePoolName "GpuChildPool" +``` + +This example retrieves a list of GPUs or other assignable devices and adds these devices to a +resource pool named **GpuChildPool**, making the devices available for use by virtual machines in +that resource pool. + +## PARAMETERS + +### -CimSession + +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](/powershell/module/cimcmdlets/new-cimsession) +or [Get-CimSession](/powershell/module/cimcmdlets/get-cimsession) cmdlet. The default is the +current session on the local computer. + +```yaml +Type: CimSession[] +Parameter Sets: Path +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ComputerName + +Specifies the name of the Hyper-V host to which the device is to be added. NetBIOS names, IP +addresses, and fully qualified domain names are allowed. The default is the local computer. Use +localhost or a dot (`.`) to specify the local computer explicitly. + +```yaml +Type: String[] +Parameter Sets: Path +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Credential + +Specifies one or more user accounts that have permission to perform this action. The default is the +current user. + +```yaml +Type: PSCredential[] +Parameter Sets: Path +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +Forces the command to run without asking for user confirmation. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HostAssignableDevice + +Specifies the device object to be assigned to the virtual machine. + +```yaml +Type: VMHostAssignableDevice[] +Parameter Sets: Object +Aliases: VMHostAssignableDevice + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InstancePath + +Represents the Device Instance path in the host machine. + +```yaml +Type: String +Parameter Sets: Path +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LocationPath + +Specifies the location path to the assignable device. + +```yaml +Type: String +Parameter Sets: Path +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourcePoolName + +Specifies the name of the resource pool to which the device is assigned. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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](/powershell/module/microsoft.powershell.core/about/about_commonparameters). + +## INPUTS + +### Microsoft.HyperV.PowerShell.VMHostAssignableDevice[] + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Get-VMHostAssignableDevice](get-vmhostassignabledevice.md) + +[Dismount-VMHostAssignableDevice](dismount-vmhostassignabledevice.md) + +[Mount-VMHostAssignableDevice](mount-vmhostassignabledevice.md) + +[Remove-VMHostAssignableDevice](remove-vmhostassignabledevice.md) diff --git a/docset/winserver2025-ps/hyper-v/Dismount-VMHostAssignableDevice.md b/docset/winserver2025-ps/hyper-v/Dismount-VMHostAssignableDevice.md new file mode 100644 index 0000000000..7cd62ac1e9 --- /dev/null +++ b/docset/winserver2025-ps/hyper-v/Dismount-VMHostAssignableDevice.md @@ -0,0 +1,225 @@ +--- +description: Dismounts an assignable device from a virtual machine host. +external help file: Microsoft.HyperV.PowerShell.Cmdlets.dll-Help.xml +Module Name: Hyper-V +ms.date: 06/12/2024 +online version: https://learn.microsoft.com/powershell/module/hyper-v/dismount-vmhostassignabledevice?view=windowsserver2025-ps&wt.mc_id=ps-gethelp +schema: 2.0.0 +title: Dismount-VMHostAssignableDevice +--- + +# Dismount-VMHostAssignableDevice + +## SYNOPSIS +Dismounts a device from a virtual machine (VM) host. + +## SYNTAX + +``` +Dismount-VMHostAssignableDevice [-InstancePath ] [-LocationPath ] [-Force] + [-Passthru] [-CimSession ] [-ComputerName ] [-Credential ] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION + +The `Dismount-VMHostAssignableDevice` cmdlet is used to dismount an assignable device from the +virtual machine host. Use this cmdlet when you need to reassign a device or resolve conflicts +between devices and virtual machines. + +## EXAMPLES + +### Example 1 + +```powershell +Dismount-VMHostAssignableDevice -InstancePath "PCIROOT(0)#PCI(1D02)#PCI(0000)" +``` + +This example dismounts the device with the specified instance path from the host, making it +available for assignment to a virtual machine. + +## PARAMETERS + +### -CimSession + +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](/powershell/module/cimcmdlets/new-cimsession) +or [Get-CimSession](/powershell/module/cimcmdlets/get-cimsession) cmdlet. The default is the +current session on the local computer. + +```yaml +Type: CimSession[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ComputerName + +Specifies one or more Hyper-V hosts from which the assignable devices are to be dismounted. NetBIOS +names, IP addresses, and fully qualified domain names are allowed. The default is the local +computer. Use localhost or a dot (`.`) to specify the local computer explicitly. + +```yaml +Type: String[] +Parameter Sets: Path +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Credential + +Specifies one or more user accounts that have permission to perform this action. The default is the +current user. + +```yaml +Type: PSCredential[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +Forces the command to run without asking for user confirmation. + +Using the **Force** parameter also overrides some security checks in the platform. To learn more, +see [Dismount the device from the host partition +](/windows-server/virtualization/hyper-v/deploy/deploying-graphics-devices-using-dda#dismount-the-device-from-the-host-partition). + +If no partitioning driver is provided, during dismount, you must use `-Force` to bypass the +security warning. For more information about the security implications, see [Plan for deploying devices by using Discrete Device Assignment](/windows-server/virtualization/hyper-v/plan/plan-for-deploying-devices-using-discrete-device-assignment). + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstancePath + +Represents the Device Instance path in the host machine. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LocationPath + +Specifies the location path to the assignable device. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Passthru + +Returns an object for each process that the cmdlet started. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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](/powershell/module/microsoft.powershell.core/about/about_commonparameters). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.HyperV.PowerShell.VMHostAssignableDevice + +## NOTES + +## RELATED LINKS + +[Add-VMHostAssignableDevice](add-vmhostassignabledevice.md) + +[Get-VMHostAssignableDevice](get-vmhostassignabledevice.md) + +[Mount-VMHostAssignableDevice](mount-vmhostassignabledevice.md) + +[Remove-VMHostAssignableDevice](remove-vmhostassignabledevice.md) diff --git a/docset/winserver2025-ps/hyper-v/Get-VMAssignableDevice.md b/docset/winserver2025-ps/hyper-v/Get-VMAssignableDevice.md new file mode 100644 index 0000000000..66fb3601d4 --- /dev/null +++ b/docset/winserver2025-ps/hyper-v/Get-VMAssignableDevice.md @@ -0,0 +1,194 @@ +--- +description: Retrieves information about a device assigned to a virtual machine. +external help file: Microsoft.HyperV.PowerShell.Cmdlets.dll-Help.xml +Module Name: Hyper-V +ms.date: 06/12/2024 +online version: https://learn.microsoft.com/powershell/module/hyper-v/get-vmassignabledevice?view=windowsserver2025-ps&wt.mc_id=ps-gethelp +schema: 2.0.0 +title: Get-VMAssignableDevice +--- + +# Get-VMAssignableDevice + +## SYNOPSIS +Retrieves information about the assignable device from a specific virtual machine. + +## SYNTAX + +### VMName (Default) + +``` +Get-VMAssignableDevice [-CimSession ] [-ComputerName ] + [-Credential ] [-VMName] [-InstancePath ] + [-LocationPath ] [] +``` + +### VMObject + +``` +Get-VMAssignableDevice [-VM] [-InstancePath ] [-LocationPath ] + [] +``` + +## DESCRIPTION + +The `Get-VMAssignableDevice` cmdlet retrieves information about the assignable devices that are +associated with a specific virtual machine (VM). This cmdlet can be used to list all assignable +devices that can be attached to a VM or to retrieve details about specific devices that are already +assigned. The retrieved information can include the device's instance path, location path, and +other relevant properties. + +## EXAMPLES + +### Example 1 + +```powershell +Get-VMAssignableDevice -VMName "MyVM" +``` + +This example retrieves all assignable devices associated with the virtual machine named **MyVM**. + +## PARAMETERS + +### -CimSession + +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](/powershell/module/cimcmdlets/new-cimsession) +or [Get-CimSession](/powershell/module/cimcmdlets/get-cimsession) cmdlet. The default is the +current session on the local computer. + +```yaml +Type: CimSession[] +Parameter Sets: VMName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ComputerName + +Specifies one or more Hyper-V hosts from which the assignable devices are to be retrieved. NetBIOS +names, IP addresses, and fully qualified domain names are allowed. The default is the local +computer. Use localhost or a dot (`.`) to specify the local computer explicitly. + +```yaml +Type: String[] +Parameter Sets: VMName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Credential + +Retrieves one or more user accounts that have permission to perform this action. The default is the +current user. + +```yaml +Type: PSCredential[] +Parameter Sets: VMName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstancePath + +Represents the Device Instance path in the host machine. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LocationPath + +Specifies the location path to the assignable device + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VM + +Retrieves the virtual machine which a device is assigned. + +```yaml +Type: VirtualMachine[] +Parameter Sets: VMObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -VMName + +Retrieves the names of the assignable devices assigned to the specified virtual machine. + +```yaml +Type: String[] +Parameter Sets: VMName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +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](/powershell/module/microsoft.powershell.core/about/about_commonparameters). + +## INPUTS + +### System.String[] + +### Microsoft.HyperV.PowerShell.VirtualMachine[] + +## OUTPUTS + +### Microsoft.HyperV.PowerShell.VMAssignedDevice + +## NOTES + +## RELATED LINKS + +[Add-VMAssignableDevice](add-vmassignabledevice.md) + +[Remove-VMAssignableDevice](remove-vmassignabledevice.md) diff --git a/docset/winserver2025-ps/hyper-v/Get-VMGpuPartitionAdapter.md b/docset/winserver2025-ps/hyper-v/Get-VMGpuPartitionAdapter.md index 4143c49ecd..07ff8b3907 100644 --- a/docset/winserver2025-ps/hyper-v/Get-VMGpuPartitionAdapter.md +++ b/docset/winserver2025-ps/hyper-v/Get-VMGpuPartitionAdapter.md @@ -2,7 +2,7 @@ description: Gets the information of assigned GPU partitions to a virtual machine. external help file: Microsoft.HyperV.PowerShell.Cmdlets.dll-Help.xml Module Name: Hyper-V -ms.date: 09/22/2022 +ms.date: 06/12/2024 online version: https://learn.microsoft.com/powershell/module/hyper-v/get-vmgpupartitionadapter?view=windowsserver2025-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Get-VMGpuPartitionAdapter @@ -16,33 +16,54 @@ Gets the information of assigned GPU partitions to a virtual machine. ## SYNTAX ### VMName (Default) + ``` Get-VMGpuPartitionAdapter [-CimSession ] [-ComputerName ] [-Credential ] [-VMName] [-AdapterId ] [] ``` ### VMObject + ``` Get-VMGpuPartitionAdapter [-VM] [-AdapterId ] [] ``` ## DESCRIPTION -The 'Get-VMGpuPartitionAdapter' cmdlet gets the information of assigned graphic processing unit partitions to a virtual machine. + +The `Get-VMGpuPartitionAdapter` cmdlet gets the information of assigned graphic processing unit +partitions to a virtual machine. ## EXAMPLES ### Example 1 + ```powershell -$testvm = get-VM "TestVM" +$testvm = Get-VM "TestVM" Get-VMGpuPartitionAdapter -VM $testvm ``` This example gets the GPU information assigned to a VM object. +### Example 2 + +```powershell +Get-VMGpuPartitionAdapter -VMName "TestVM" | FL InstancePath, Id, SupportsOutgoingLiveMigration +``` + +This command retrieves information about the GPU partition adapter for the virtual machine named +**TestVM** and displays the `InstancePath`, `Id`, and `SupportsOutgoingLiveMigration` properties. + +When live migrating a virtual machine with a GPU partition adapter, certain hardware and software +conditions must be met on both the source and target hosts. The `SupportsOutgoingLiveMigration` +field can be used to pre-validate a live migration, ensuring that all necessary conditions are met +before attempting the migration. + ## PARAMETERS ### -AdapterId -This is a VM's GPU partition identification number used to display the GPU information assigned to a VM. + +This is a VM's GPU partition identification number used to display the GPU information assigned to a +VM. ```yaml Type: String @@ -57,9 +78,11 @@ Accept wildcard characters: False ``` ### -CimSession -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. -The default is the current session on the local computer. + +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](/powershell/module/cimcmdlets/new-cimsession) +or [Get-CimSession](/powershell/module/cimcmdlets/get-cimsession) cmdlet. The default is the +current session on the local computer. ```yaml Type: CimSession[] @@ -74,10 +97,10 @@ Accept wildcard characters: False ``` ### -ComputerName -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. -The default is the local computer. -Use localhost or a dot ('.') to specify the local computer explicitly. + +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. The default is the local +computer. Use localhost or a dot (`.`) to specify the local computer explicitly. ```yaml Type: String[] @@ -92,8 +115,9 @@ Accept wildcard characters: False ``` ### -Credential -Specifies one or more user accounts that have permission to perform this action. -The default is the current user. + +Specifies one or more user accounts that have permission to perform this action. The default is the +current user. ```yaml Type: PSCredential[] @@ -108,6 +132,7 @@ Accept wildcard characters: False ``` ### -VM + Specifies the virtual machine whose virtual network adapters are to be retrieved. The asterisk (`*`) is the wildcard. If it is specified the cmdlet returns virtual network adapters from every virtual machine in the system. @@ -125,6 +150,7 @@ Accept wildcard characters: True ``` ### -VMName + Specifies the name of the virtual machine whose network adapters are to be retrieved. ```yaml @@ -140,7 +166,11 @@ 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](https://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](/powershell/module/microsoft.powershell.core/about/about_commonparameters). ## INPUTS @@ -155,3 +185,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS + +- [Add-VMGpuPartitionAdapter](add-vmgpupartitionadapter.md) + +- [Remove-VMGpuPartitionAdapter](remove-vmgpupartitionadapter.md) + +- [Set-VMGpuPartitionAdapter](set-vmgpupartitionadapter.md) diff --git a/docset/winserver2025-ps/hyper-v/Get-VMHostAssignableDevice.md b/docset/winserver2025-ps/hyper-v/Get-VMHostAssignableDevice.md new file mode 100644 index 0000000000..cd83f1711c --- /dev/null +++ b/docset/winserver2025-ps/hyper-v/Get-VMHostAssignableDevice.md @@ -0,0 +1,178 @@ +--- +description: Retrieves information about an assignable device to a virtual machine host. +external help file: Microsoft.HyperV.PowerShell.Cmdlets.dll-Help.xml +Module Name: Hyper-V +ms.date: 06/12/2024 +online version: https://learn.microsoft.com/powershell/module/hyper-v/get-vmhostassignabledevice?view=windowsserver2025-ps&wt.mc_id=ps-gethelp +schema: 2.0.0 +title: Get-VMHostAssignableDevice +--- + +# Get-VMHostAssignableDevice + +## SYNOPSIS +Retrieves device information assigned to a virtual machine (VM) host. + +## SYNTAX + +``` +Get-VMHostAssignableDevice [-InstancePath ] [-LocationPath ] + [-ResourcePoolName ] [-CimSession ] [-ComputerName ] + [-Credential ] [] +``` + +## DESCRIPTION + +The `Get-VMHostAssignableDevice` cmdlet retrieves information about devices that can be assigned to +a virtual machine host. This can include devices such as GPUs, network adapters, or storage +controllers that are physically present on the host system. The cmdlet can filter devices by their +instance path or location path. + +## EXAMPLES + +### Example 1 + +```powershell +Get-VMHostAssignableDevice +``` + +This example retrieves all assignable devices on the host computer. + +### Example 2 + +```powershell +Get-VMHostAssignableDevice -ComputerName "MyHost" +``` + +In this example, the cmdlet retrieves all assignable devices from the computer named **MyHost**. + +## PARAMETERS + +### -CimSession + +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](/powershell/module/cimcmdlets/new-cimsession) +or [Get-CimSession](/powershell/module/cimcmdlets/get-cimsession) cmdlet. The default is the +current session on the local computer. + +```yaml +Type: CimSession[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ComputerName + +Specifies one or more Hyper-V hosts from which the assignable devices are to be retrieved. NetBIOS +names, IP addresses, and fully qualified domain names are allowed. The default is the local +computer. Use localhost or a dot (`.`) to specify the local computer explicitly. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Credential + +Specifies one or more user accounts that have permission to perform this action. The default is the +current user. + +```yaml +Type: PSCredential[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstancePath + +Represents the Device Instance path in the host machine. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LocationPath + +Specifies the location path to the assignable device. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourcePoolName + +Retrieves the name of the resource pool to which the device is assigned. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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](/powershell/module/microsoft.powershell.core/about/about_commonparameters). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.HyperV.PowerShell.VMHostAssignableDevice + +## NOTES + +## RELATED LINKS + +[Add-VMHostAssignableDevice](add-vmhostassignabledevice.md) + +[Dismount-VMHostAssignableDevice](dismount-vmhostassignabledevice.md) + +[Mount-VMHostAssignableDevice](mount-vmhostassignabledevice.md) + +[Remove-VMHostAssignableDevice](remove-vmhostassignabledevice.md) diff --git a/docset/winserver2025-ps/hyper-v/Get-VMHostPartitionableGpu.md b/docset/winserver2025-ps/hyper-v/Get-VMHostPartitionableGpu.md index 18d7eeec17..7607bba193 100644 --- a/docset/winserver2025-ps/hyper-v/Get-VMHostPartitionableGpu.md +++ b/docset/winserver2025-ps/hyper-v/Get-VMHostPartitionableGpu.md @@ -2,7 +2,7 @@ description: Gets the host machine’s partitionable GPU. external help file: Microsoft.HyperV.PowerShell.Cmdlets.dll-Help.xml Module Name: Hyper-V -ms.date: 09/22/2022 +ms.date: 06/12/2024 online version: https://learn.microsoft.com/powershell/module/hyper-v/get-vmhostpartitionablegpu?view=windowsserver2025-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Get-VMHostPartitionableGpu @@ -16,49 +16,66 @@ Gets the host machine’s partitionable GPU. ## SYNTAX ### ComputerName (Default) + ``` -Get-VMHostPartitionableGpu [[-ComputerName] ] [[-Credential] ] [-Name ] - [] +Get-VMHostPartitionableGpu [[-ComputerName] ] [[-Credential] ] + [-Name ] [] ``` ### CimSession + ``` Get-VMHostPartitionableGpu [-CimSession] [-Name ] [] ``` ## DESCRIPTION -The 'Get-VMHostPartitionableGpu' cmdlet gets the host machine’s partitionable graphic processing unit. -This displays the information of the GPU as provided by the manufacturer's driver. + +The `Get-VMHostPartitionableGpu` cmdlet gets the host machine’s partitionable graphic processing +unit. This displays the information of the GPU as provided by the manufacturer's driver. ## EXAMPLES ### Example 1 -``` + +```powershell Get-VMHostPartitionableGpu ``` This example gets the details of the local partitionable graphic processing unit on the host. ### Example 2 + ```powershell -Get-VMHostPartitionableGpu -ComputerName "SampleHost" +Get-VMHostPartitionableGpu -ComputerName "MyHost" ``` -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. +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. ### Example 3 + +```powershell +Get-VMHostPartitionableGpu -Name "GPUDeviceIDName" +``` + +### Example 4 + ```powershell -Get-VMHostPartitionableGpu -name "SampleGPUDeviceIDName" +Get-VMHostPartitionableGpu | FL Name, ValidPartitionCounts ``` -Displays a partitionable GPU by using the specific GPU device name. The result will show the details of the specific GPU listed. +This example retrieves information about the partitionable GPUs available on a virtual machine host +and formats the output as a list, displaying the name of each GPU and the number of valid +partitions that can be created on each GPU. ## PARAMETERS ### -CimSession -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. -The default is the current session on the local computer. + +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](/powershell/module/cimcmdlets/new-cimsession) +or [Get-CimSession](/powershell/module/cimcmdlets/get-cimsession) cmdlet. The default is the +current session on the local computer. ```yaml Type: CimSession[] @@ -73,10 +90,10 @@ Accept wildcard characters: False ``` ### -ComputerName -Specifies one or more Hyper-V hosts that run this cmdlet. -NetBIOS names, IP addresses, and fully qualified domain names are allowed. -The default is the local computer. -Use localhost or a dot ('.') to specify the local computer explicitly. + +Specifies one or more Hyper-V hosts that run this cmdlet. NetBIOS names, IP addresses, and fully +qualified domain names are allowed. The default is the local computer. Use localhost or a dot (`.`) +to specify the local computer explicitly. ```yaml Type: String[] @@ -91,7 +108,9 @@ Accept wildcard characters: False ``` ### -Credential -Specifies one or more user accounts that have permission to perform this action. The default is the current user. + +Specifies one or more user accounts that have permission to perform this action. The default is the +current user. ```yaml Type: PSCredential[] @@ -106,6 +125,7 @@ Accept wildcard characters: False ``` ### -Name + Specifies the name of the graphic processing unit to be retrieved. ```yaml @@ -121,7 +141,11 @@ 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](https://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](/powershell/module/microsoft.powershell.core/about/about_commonparameters). ## INPUTS @@ -134,3 +158,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS + +- [Set-VMHostPartitionableGpu](set-vmhostpartitionablegpu.md) diff --git a/docset/winserver2025-ps/hyper-v/Hyper-V.md b/docset/winserver2025-ps/hyper-v/Hyper-V.md index a78f953d39..32b28c8a90 100644 --- a/docset/winserver2025-ps/hyper-v/Hyper-V.md +++ b/docset/winserver2025-ps/hyper-v/Hyper-V.md @@ -5,7 +5,7 @@ Help Version: 5.0.2.1 Locale: en-US Module Guid: af4bddd0-8583-4ff2-84b2-a33f5c8de8a7 Module Name: Hyper-V -ms.date: 12/20/2016 +ms.date: 06/12/2024 title: Hyper-V --- # Hyper-V Module @@ -16,6 +16,9 @@ This reference provides cmdlet descriptions and syntax for all Hyper-V-specific ## Hyper-V Cmdlets +### [Add-VMAssignableDevice](./Add-VMAssignableDevice.md) +Adds an assignable device to a specific virtual machine. + ### [Add-VMDvdDrive](./Add-VMDvdDrive.md) Adds a DVD drive to a virtual machine. @@ -31,6 +34,9 @@ Adds group members to a virtual machine group. ### [Add-VMHardDiskDrive](./Add-VMHardDiskDrive.md) Adds a hard disk drive to a virtual machine. +### [Add-VMHostAssignableDevice](./Add-VMHostAssignableDevice.md) +Adds an assignable device to a virtual machine (VM) host. + ### [Add-VMMigrationNetwork](./Add-VMMigrationNetwork.md) Adds a network for virtual machine migration on one or more virtual machine hosts. @@ -124,6 +130,9 @@ Removes a host bus adapter from a virtual storage area network (SAN). ### [Dismount-VHD](./Dismount-VHD.md) Dismounts a virtual hard disk. +### [Dismount-VMHostAssignableDevice](./Dismount-VMHostAssignableDevice.md) +Dismounts a device from a virtual machine (VM) host. + ### [Enable-VMConsoleSupport](./Enable-VMConsoleSupport.md) Enables keyboard, video, and mouse for virtual machines. @@ -169,6 +178,9 @@ Gets information about a checkpoint in a VHD set. ### [Get-VM](./Get-VM.md) Gets the virtual machines from one or more Hyper-V hosts. +### [Get-VMAssignableDevice](./Get-VMAssignableDevice.md) +Retrieves information about the assignable device from a specific virtual machine. + ### [Get-VMBios](./Get-VMBios.md) Gets the BIOS of a virtual machine or snapshot. @@ -202,6 +214,9 @@ Gets the virtual hard disk drives attached to one or more virtual machines. ### [Get-VMHost](./Get-VMHost.md) Gets a Hyper-V host. +### [Get-VMHostAssignableDevice](./Get-VMHostAssignableDevice.md) +Retrieves device information assigned to a virtual machine (VM) host. + ### [Get-VMHostCluster](./Get-VMHostCluster.md) Gets virtual machine host clusters. @@ -252,7 +267,6 @@ Gets members of a routing domain. ### [Get-VMNetworkAdapterTeamMapping](./Get-VMNetworkAdapterTeamMapping.md) - ### [Get-VMNetworkAdapterVlan](./Get-VMNetworkAdapterVlan.md) Gets the virtual LAN settings configured on a virtual network adapter. @@ -349,6 +363,9 @@ Merges virtual hard disks. ### [Mount-VHD](./Mount-VHD.md) Mounts one or more virtual hard disks. +### [Mount-VMHostAssignableDevice](./Mount-VMHostAssignableDevice.md) +Mounts a device to a virtual machine (VM) host. + ### [Move-VM](./Move-VM.md) Moves a virtual machine to a new Hyper-V host. @@ -391,6 +408,9 @@ Removes a checkpoint from a VHD set file. ### [Remove-VM](./Remove-VM.md) Deletes a virtual machine. +### [Remove-VMAssignableDevice](./Remove-VMAssignableDevice.md) +Removes information about the assignable devices from a specific virtual machine. + ### [Remove-VMDvdDrive](./Remove-VMDvdDrive.md) Deletes a DVD drive from a virtual machine. @@ -409,6 +429,9 @@ Removes members from a virtual machine group. ### [Remove-VMHardDiskDrive](./Remove-VMHardDiskDrive.md) Deletes a hard disk drive from a virtual machine. +### [Remove-VMHostAssignableDevice](./Remove-VMHostAssignableDevice.md) +Removes a device assigned to a virtual machine (VM) host. + ### [Remove-VMMigrationNetwork](./Remove-VMMigrationNetwork.md) Removes a network from use with migration. @@ -426,7 +449,6 @@ Removes a routing domain from a virtual network adapter. ### [Remove-VMNetworkAdapterTeamMapping](./Remove-VMNetworkAdapterTeamMapping.md) - ### [Remove-VMRemoteFx3dVideoAdapter](./Remove-VMRemoteFx3dVideoAdapter.md) Removes a RemoteFX 3D video adapter from a virtual machine. @@ -579,7 +601,6 @@ Sets virtual subnets on a routing domain. ### [Set-VMNetworkAdapterTeamMapping](./Set-VMNetworkAdapterTeamMapping.md) - ### [Set-VMNetworkAdapterVlan](./Set-VMNetworkAdapterVlan.md) Configures the virtual LAN settings for the traffic through a virtual network adapter. diff --git a/docset/winserver2025-ps/hyper-v/Mount-VMHostAssignableDevice.md b/docset/winserver2025-ps/hyper-v/Mount-VMHostAssignableDevice.md new file mode 100644 index 0000000000..da5e197134 --- /dev/null +++ b/docset/winserver2025-ps/hyper-v/Mount-VMHostAssignableDevice.md @@ -0,0 +1,232 @@ +--- +description: Mounts an assignable device to a virtual machine host. +external help file: Microsoft.HyperV.PowerShell.Cmdlets.dll-Help.xml +Module Name: Hyper-V +ms.date: 06/12/2024 +online version: https://learn.microsoft.com/powershell/module/hyper-v/mount-vmhostassignabledevice?view=windowsserver2025-ps&wt.mc_id=ps-gethelp +schema: 2.0.0 +title: Mount-VMHostAssignableDevice +--- + +# Mount-VMHostAssignableDevice + +## SYNOPSIS +Mounts a device to a virtual machine (VM) host. + +## SYNTAX + +### Path (Default) + +``` +Mount-VMHostAssignableDevice [-CimSession ] [-ComputerName ] + [-Credential ] [-InstancePath ] [-LocationPath ] [-Passthru] + [-WhatIf] [-Confirm] [] +``` + +### Object + +``` +Mount-VMHostAssignableDevice [-HostAssignableDevice] [-Passthru] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION + +The `Mount-VMHostAssignableDevice` cmdlet mounts a device such as GPUs, network adapters, or storage +controllers that are physically present on the virtual machine host. + +## EXAMPLES + +### Example 1 + +```powershell +$device = Get-VMHostAssignableDevice -InstancePath "PCIROOT(0)#PCI(0300)#PCI(0000)" +$params = @{ +HostAssignableDevice = $device +VMName = "MyVM" +} +Mount-VMHostAssignableDevice @params +``` + +In this example, the `Get-VMHostAssignableDevice` cmdlet retrieves the device with the specified +instance path and stores it in the `$device` variable. The `Mount-VMHostAssignableDevice` cmdlet +then assigns this device to the virtual machine named **MyVM**. + +## PARAMETERS + +### -CimSession + +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](/powershell/module/cimcmdlets/new-cimsession) +or [Get-CimSession](/powershell/module/cimcmdlets/get-cimsession) cmdlet. The default is the +current session on the local computer. + +```yaml +Type: CimSession[] +Parameter Sets: Path +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ComputerName + +Specifies one or more Hyper-V hosts from which the assignable devices are to be mounted. NetBIOS +names, IP addresses, and fully qualified domain names are allowed. The default is the local +computer. Use localhost or a dot (`.`) to specify the local computer explicitly. + +```yaml +Type: String[] +Parameter Sets: Path +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Credential + +Specifies one or more user accounts that have permission to perform this action. The default is the +current user. + +```yaml +Type: PSCredential[] +Parameter Sets: Path +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HostAssignableDevice + +Specifies the assignable device to be mounted on the virtual machine host. + +```yaml +Type: VMHostAssignableDevice[] +Parameter Sets: Object +Aliases: VMHostAssignableDevice + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InstancePath + +Represents the Device Instance path in the host machine. + +```yaml +Type: String +Parameter Sets: Path +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LocationPath + +Specifies the location path to the assignable device. + +```yaml +Type: String +Parameter Sets: Path +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Passthru + +Returns an object for each process that the cmdlet started. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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](/powershell/module/microsoft.powershell.core/about/about_commonparameters). + +## INPUTS + +### Microsoft.HyperV.PowerShell.VMHostAssignableDevice[] + +## OUTPUTS + +### Microsoft.HyperV.PowerShell.VMHostAssignableDevice + +## NOTES + +## RELATED LINKS + +[Add-VMHostAssignableDevice](add-vmhostassignabledevice.md) + +[Get-VMHostAssignableDevice](get-vmhostassignabledevice.md) + +[Dismount-VMHostAssignableDevice](dismount-vmhostassignabledevice.md) + +[Remove-VMHostAssignableDevice](remove-vmhostassignabledevice.md) diff --git a/docset/winserver2025-ps/hyper-v/Remove-VMAssignableDevice.md b/docset/winserver2025-ps/hyper-v/Remove-VMAssignableDevice.md new file mode 100644 index 0000000000..4f768144a3 --- /dev/null +++ b/docset/winserver2025-ps/hyper-v/Remove-VMAssignableDevice.md @@ -0,0 +1,257 @@ +--- +description: Removes a device assigned to a virtual machine. +external help file: Microsoft.HyperV.PowerShell.Cmdlets.dll-Help.xml +Module Name: Hyper-V +ms.date: 06/12/2024 +online version: https://learn.microsoft.com/powershell/module/hyper-v/remove-vmassignabledevice?view=windowsserver2025-ps&wt.mc_id=ps-gethelp +schema: 2.0.0 +title: Remove-VMAssignableDevice +--- + +# Remove-VMAssignableDevice + +## SYNOPSIS +Removes information about the assignable devices from a specific virtual machine. + +## SYNTAX + +### VMName (Default) + +``` +Remove-VMAssignableDevice [-CimSession ] [-ComputerName ] + [-Credential ] [-VMName] [-InstancePath ] + [-LocationPath ] [-Passthru] [-WhatIf] [-Confirm] [] +``` + +### Object + +``` +Remove-VMAssignableDevice [-VMAssignableDevice] [-Passthru] [-WhatIf] + [-Confirm] [] +``` + +## DESCRIPTION + +The `Remove-VMAssignableDevice` cmdlet removes an assignable device from a specified virtual +machine (VM). This is often used in scenarios where a physical device, such as a GPU or network +adapter, was previously assigned to a VM and needs to be unassigned. + +## EXAMPLES + +### Example 1 + +```powershell +$params = @{ +VMName = "MyVM" +InstancePath = "PCIROOT(0)#PCI(0300)#PCI(0000)#PCI(0800)#PCI(0000)#PCI(1000)" +} +Remove-VMAssignableDevice $params +``` + +This example removes a specific assignable device, identified by its instance path, from the +virtual machine named **MyVM**. + +### Example 2 + +```powershell +$params = @{ +VMName = "MyVM" +} +$vm = Get-VMAssignableDevice @params | Where-Object { $_.ResourcePoolName -eq "GpuChildPool" } +$vm | Remove-VMAssignableDevice +``` + +This example removes a specific assignable device, identified by the ResourcePoolName property +**GpuChildPool**, from the virtual machine named **MyVM**. + +## PARAMETERS + +### -CimSession + +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](/powershell/module/cimcmdlets/new-cimsession) +or [Get-CimSession](/powershell/module/cimcmdlets/get-cimsession) cmdlet. The default is the +current session on the local computer. + +```yaml +Type: CimSession[] +Parameter Sets: VMName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ComputerName + +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. The default is the local +computer. Use localhost or a dot (`.`) to specify the local computer explicitly. + +```yaml +Type: String[] +Parameter Sets: VMName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Credential + +Specifies one or more user accounts that have permission to perform this action. The default is the +current user. + +```yaml +Type: PSCredential[] +Parameter Sets: VMName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstancePath + +Removes the Device Instance path in the host machine. + +```yaml +Type: String +Parameter Sets: VMName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LocationPath + +Specifies the location path to the assignable device. + +```yaml +Type: String +Parameter Sets: VMName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Passthru + +Returns an object for each process that the cmdlet started. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VMAssignableDevice + +Specifies the assignable device object that you want to remove from the virtual machine. This is +usually an object retrieved from a cmdlet like `Get-VMAssignableDevice`. + +```yaml +Type: VMAssignedDevice[] +Parameter Sets: Object +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -VMName + +Specifies the name of the virtual machine from which you want to remove the assignable device. + +```yaml +Type: String[] +Parameter Sets: VMName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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](/powershell/module/microsoft.powershell.core/about/about_commonparameters). + +## INPUTS + +### Microsoft.HyperV.PowerShell.VMAssignedDevice[] + +## OUTPUTS + +### Microsoft.HyperV.PowerShell.VMAssignedDevice + +## NOTES + +## RELATED LINKS + +[Add-VMAssignableDevice](add-vmassignabledevice.md) + +[Get-VMAssignableDevice](get-vmassignabledevice.md) diff --git a/docset/winserver2025-ps/hyper-v/Remove-VMGpuPartitionAdapter.md b/docset/winserver2025-ps/hyper-v/Remove-VMGpuPartitionAdapter.md index 052bd5e136..efd3a8e770 100644 --- a/docset/winserver2025-ps/hyper-v/Remove-VMGpuPartitionAdapter.md +++ b/docset/winserver2025-ps/hyper-v/Remove-VMGpuPartitionAdapter.md @@ -2,7 +2,7 @@ description: Removes an assigned GPU partition from a virtual machine. external help file: Microsoft.HyperV.PowerShell.Cmdlets.dll-Help.xml Module Name: Hyper-V -ms.date: 09/22/2022 +ms.date: 06/12/2024 online version: https://learn.microsoft.com/powershell/module/hyper-v/remove-vmgpupartitionadapter?view=windowsserver2025-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Remove-VMGpuPartitionAdapter @@ -16,30 +16,36 @@ Removes an assigned GPU partition from a virtual machine. ## SYNTAX ### VMName (Default) + ``` Remove-VMGpuPartitionAdapter [-CimSession ] [-ComputerName ] - [-Credential ] [-VMName] [-Passthru] [-AdapterId ] [-WhatIf] [-Confirm] - [] + [-Credential ] [-VMName] [-Passthru] [-AdapterId ] [-WhatIf] + [-Confirm] [] ``` ### VMObject + ``` -Remove-VMGpuPartitionAdapter [-VM] [-Passthru] [-AdapterId ] [-WhatIf] [-Confirm] - [] +Remove-VMGpuPartitionAdapter [-VM] [-Passthru] [-AdapterId ] [-WhatIf] + [-Confirm] [] ``` ### Object + ``` -Remove-VMGpuPartitionAdapter [-VMGpuPartitionAdapter] [-Passthru] [-WhatIf] - [-Confirm] [] +Remove-VMGpuPartitionAdapter [-VMGpuPartitionAdapter] [-Passthru] + [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION -The 'Remove-VMGpuPartitionAdapter' cmdlet removes an assigned graphic processing unit partition from a virtual machine and releases that partition back to the host GPU. + +The `Remove-VMGpuPartitionAdapter` cmdlet removes an assigned graphic processing unit partition from +a virtual machine and releases that partition back to the host GPU. ## EXAMPLES ### Example 1 + ```powershell $testvm = Get-VM "TestVM" Remove-VMGpuPartitionAdapter -VM $testvm @@ -48,6 +54,7 @@ Remove-VMGpuPartitionAdapter -VM $testvm This example removes a partition assigned to a specific VM object. ### Example 2 + ```powershell $testvm = Get-VM "TestVM" $GPUpartition = Get-VMGpuPartitionAdapter -VM $testvm @@ -59,7 +66,8 @@ This example removes a specific partition object from a specific VM. ## PARAMETERS ### -AdapterId -This is a VM's GPU partition identification number used to remove a GPU from a VM. + +This is a VM's GPU partition identification number used to remove a GPU from a VM. ```yaml Type: String @@ -74,9 +82,11 @@ Accept wildcard characters: False ``` ### -CimSession -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. -The default is the current session on the local computer. + +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](/powershell/module/cimcmdlets/new-cimsession) +or [Get-CimSession](/powershell/module/cimcmdlets/get-cimsession) cmdlet. The default is the +current session on the local computer. ```yaml Type: CimSession[] @@ -91,8 +101,10 @@ Accept wildcard characters: False ``` ### -ComputerName -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. -The default is the local computer.Use localhost or a dot ('.') to specify the local computer explicitly. + +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. The default is the local +computer.Use localhost or a dot (`.`) to specify the local computer explicitly. ```yaml Type: String[] @@ -107,7 +119,9 @@ Accept wildcard characters: False ``` ### -Credential -Specifies one or more user accounts that have permission to perform this action. The default is the current user. + +Specifies one or more user accounts that have permission to perform this action. The default is the +current user. ```yaml Type: PSCredential[] @@ -122,6 +136,7 @@ Accept wildcard characters: False ``` ### -Passthru + Returns an object for each process that the cmdlet started. ```yaml @@ -137,6 +152,7 @@ Accept wildcard characters: False ``` ### -VM + Specifies the virtual machine whose virtual network adapters are to be retrieved. The asterisk (`*`) is the wildcard. If it is specified the cmdlet returns virtual network adapters from every virtual machine in the system. @@ -154,7 +170,8 @@ Accept wildcard characters: False ``` ### -VMGpuPartitionAdapter -GPU partition object obtained from 'Get-VMGpuPartitionAdapter'. + +GPU partition object obtained from `Get-VMGpuPartitionAdapter`. ```yaml Type: VMGpuPartitionAdapter[] @@ -169,7 +186,8 @@ Accept wildcard characters: False ``` ### -VMName -Specifies the name of the virtual machine whose network adapters are to be retrieved. + +Specifies the name of the virtual machine whose network adapters are to be removed. ```yaml Type: String[] @@ -184,6 +202,7 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml @@ -199,8 +218,8 @@ Accept wildcard characters: False ``` ### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. + +Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml Type: SwitchParameter @@ -215,7 +234,11 @@ 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](https://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](/powershell/module/microsoft.powershell.core/about/about_commonparameters). ## INPUTS @@ -230,3 +253,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS + +- [Add-VMGpuPartitionAdapter](add-vmgpupartitionadapter.md) + +- [Get-VMGpuPartitionAdapter](get-vmgpupartitionadapter.md) + +- [Set-VMGpuPartitionAdapter](set-vmgpupartitionadapter.md) diff --git a/docset/winserver2025-ps/hyper-v/Remove-VMHostAssignableDevice.md b/docset/winserver2025-ps/hyper-v/Remove-VMHostAssignableDevice.md new file mode 100644 index 0000000000..1fbb70bdab --- /dev/null +++ b/docset/winserver2025-ps/hyper-v/Remove-VMHostAssignableDevice.md @@ -0,0 +1,248 @@ +--- +description: Removes an assignable device from a virtual machine host. +external help file: Microsoft.HyperV.PowerShell.Cmdlets.dll-Help.xml +Module Name: Hyper-V +ms.date: 06/12/2024 +online version: https://learn.microsoft.com/powershell/module/hyper-v/remove-vmhostassignabledevice?view=windowsserver2025-ps&wt.mc_id=ps-gethelp +schema: 2.0.0 +title: Remove-VMHostAssignableDevice +--- + +# Remove-VMHostAssignableDevice + +## SYNOPSIS +Removes a device assigned to a virtual machine (VM) host. + +## SYNTAX + +### Path (Default) + +``` +Remove-VMHostAssignableDevice [-CimSession ] [-ComputerName ] + [-Credential ] [-InstancePath ] [-LocationPath ] + -ResourcePoolName [-Force] [-WhatIf] [-Confirm] [] +``` + +### Object + +``` +Remove-VMHostAssignableDevice [-HostAssignableDevice] + -ResourcePoolName [-Force] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION + +The `Remove-VMHostAssignableDevice` cmdlet removes a device that is assigned to a virtual machine +host. Depending on the parameters specified, you can remove devices by providing either the +instance or location path of the device. + +## EXAMPLES + +### Example 1 + +```powershell +$params = @{ +InstancePath = "PCIROOT(0)#PCI(0300)#PCI(0000)" +ResourcePoolName = "MyResourcePool" +} +Remove-VMHostAssignableDevice $params +``` + +This example removes the device with the specified instance path from the resource pool named +**MyResourcePool**. + +## PARAMETERS + +### -CimSession + +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](/powershell/module/cimcmdlets/new-cimsession) +or [Get-CimSession](/powershell/module/cimcmdlets/get-cimsession) cmdlet. The default is the +current session on the local computer. + +```yaml +Type: CimSession[] +Parameter Sets: Path +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ComputerName + +Specifies one or more Hyper-V hosts from which the assignable devices are to be removed. NetBIOS +names, IP addresses, and fully qualified domain names are allowed. The default is the local +computer. Use localhost or a dot (`.`) to specify the local computer explicitly. + +```yaml +Type: String[] +Parameter Sets: Path +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Credential + +Specifies one or more user accounts that have permission to perform this action. The default is the +current user. + +```yaml +Type: PSCredential[] +Parameter Sets: Path +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +Forces the command to run without asking for user confirmation. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HostAssignableDevice + +Specifies the device object to be removed. You can get this object using +`Get-VMHostAssignableDevice`. + +```yaml +Type: VMHostAssignableDevice[] +Parameter Sets: Object +Aliases: VMHostAssignableDevice + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InstancePath + +Specifies the Device Instance path in the host machine. + +```yaml +Type: String +Parameter Sets: Path +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LocationPath + +Specifies the location path to the assignable device. + +```yaml +Type: String +Parameter Sets: Path +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourcePoolName + +Specifies the name of the resource pool from which to remove an assignable device. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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](/powershell/module/microsoft.powershell.core/about/about_commonparameters). + +## INPUTS + +### Microsoft.HyperV.PowerShell.VMHostAssignableDevice[] + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Add-VMHostAssignableDevice](add-vmhostassignabledevice.md) + +[Get-VMHostAssignableDevice](get-vmhostassignabledevice.md) + +[Dismount-VMHostAssignableDevice](dismount-vmhostassignabledevice.md) + +[Mount-VMHostAssignableDevice](mount-vmhostassignabledevice.md) diff --git a/docset/winserver2025-ps/hyper-v/Set-VMGpuPartitionAdapter.md b/docset/winserver2025-ps/hyper-v/Set-VMGpuPartitionAdapter.md index 42f57e5749..a8ed8872b7 100644 --- a/docset/winserver2025-ps/hyper-v/Set-VMGpuPartitionAdapter.md +++ b/docset/winserver2025-ps/hyper-v/Set-VMGpuPartitionAdapter.md @@ -2,7 +2,7 @@ description: Assigns a partition of a GPU to a virtual machine. external help file: Microsoft.HyperV.PowerShell.Cmdlets.dll-Help.xml Module Name: Hyper-V -ms.date: 09/22/2022 +ms.date: 06/12/2024 online version: https://learn.microsoft.com/powershell/module/hyper-v/set-vmgpupartitionadapter?view=windowsserver2025-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Set-VMGpuPartitionAdapter @@ -16,44 +16,51 @@ Assigns a partition of a GPU to a virtual machine. ## SYNTAX ### VMName (Default) + ``` Set-VMGpuPartitionAdapter [-CimSession ] [-ComputerName ] [-Credential ] [-VMName] [-Passthru] [-AdapterId ] [-MinPartitionVRAM ] [-MaxPartitionVRAM ] [-OptimalPartitionVRAM ] [-MinPartitionEncode ] [-MaxPartitionEncode ] [-OptimalPartitionEncode ] [-MinPartitionDecode ] [-MaxPartitionDecode ] [-OptimalPartitionDecode ] - [-MinPartitionCompute ] [-MaxPartitionCompute ] [-OptimalPartitionCompute ] [-WhatIf] - [-Confirm] [] + [-MinPartitionCompute ] [-MaxPartitionCompute ] [-OptimalPartitionCompute ] + [-WhatIf] [-Confirm] [] ``` ### VMObject + ``` Set-VMGpuPartitionAdapter [-VM] [-Passthru] [-AdapterId ] [-MinPartitionVRAM ] [-MaxPartitionVRAM ] [-OptimalPartitionVRAM ] [-MinPartitionEncode ] [-MaxPartitionEncode ] [-OptimalPartitionEncode ] [-MinPartitionDecode ] [-MaxPartitionDecode ] [-OptimalPartitionDecode ] - [-MinPartitionCompute ] [-MaxPartitionCompute ] [-OptimalPartitionCompute ] [-WhatIf] - [-Confirm] [] + [-MinPartitionCompute ] [-MaxPartitionCompute ] [-OptimalPartitionCompute ] + [-WhatIf] [-Confirm] [] ``` ### Object + ``` Set-VMGpuPartitionAdapter [-VMGpuPartitionAdapter] [-Passthru] [-MinPartitionVRAM ] [-MaxPartitionVRAM ] [-OptimalPartitionVRAM ] [-MinPartitionEncode ] [-MaxPartitionEncode ] [-OptimalPartitionEncode ] [-MinPartitionDecode ] [-MaxPartitionDecode ] [-OptimalPartitionDecode ] - [-MinPartitionCompute ] [-MaxPartitionCompute ] [-OptimalPartitionCompute ] [-WhatIf] - [-Confirm] [] + [-MinPartitionCompute ] [-MaxPartitionCompute ] [-OptimalPartitionCompute ] + [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION -The 'Set-VMGpuPartitionAdapter' cmdlet assigns a partition of a GPU to a virtual machine. Running the command against a virtual machine assigns a full partition. Additional parameters exist to assign more specific options to a VM. + +The `Set-VMGpuPartitionAdapter` cmdlet assigns a partition of a GPU to a virtual machine. Running +the command against a virtual machine assigns a full partition. Additional parameters exist to +assign more specific options to a VM. ## EXAMPLES ### Example 1 + ```powershell -$vm = get-vm test +$vm = Get-VM "Test" Set-VMGpuPartitionAdapter -VM $vm ``` @@ -62,6 +69,7 @@ This example assign a partition to a VM passing a VM object. ## PARAMETERS ### -AdapterId + A VM's GPU partition identification number used to display the GPU information assigned to a VM. ```yaml @@ -77,8 +85,11 @@ Accept wildcard characters: False ``` ### -CimSession -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. -The default is the current session on the local computer. + +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](/powershell/module/cimcmdlets/new-cimsession) +or [Get-CimSession](/powershell/module/cimcmdlets/get-cimsession) cmdlet. The default is the +current session on the local computer. ```yaml Type: CimSession[] @@ -93,9 +104,10 @@ Accept wildcard characters: False ``` ### -ComputerName -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. -The default is the local computer. -Use localhost or a dot ('.') to specify the local computer explicitly. + +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. The default is the local +computer. Use localhost or a dot (`.`) to specify the local computer explicitly. ```yaml Type: String[] @@ -110,8 +122,9 @@ Accept wildcard characters: False ``` ### -Credential -Specifies one or more user accounts that have permission to perform this action. -The default is the current user. + +Specifies one or more user accounts that have permission to perform this action. The default is the +current user. ```yaml Type: PSCredential[] @@ -126,7 +139,9 @@ Accept wildcard characters: False ``` ### -MaxPartitionCompute -The maximum number of compute assigned by the host GPU. This is defined by the manufacturer's driver. + +The maximum number of compute assigned by the host GPU. This is defined by the manufacturer's +driver. ```yaml Type: UInt64 @@ -141,7 +156,9 @@ Accept wildcard characters: False ``` ### -MaxPartitionDecode -The maximum number of decoders assigned by the host GPU. This is defined by the manufacturer's driver. + +The maximum number of decoders assigned by the host GPU. This is defined by the manufacturer's +driver. ```yaml Type: UInt64 @@ -156,7 +173,9 @@ Accept wildcard characters: False ``` ### -MaxPartitionEncode -The maximum number of encoders assigned by the host GPU. This is defined by the manufacturer's driver. + +The maximum number of encoders assigned by the host GPU. This is defined by the manufacturer's +driver. ```yaml Type: UInt64 @@ -171,6 +190,7 @@ Accept wildcard characters: False ``` ### -MaxPartitionVRAM + The maximum VRAM in bytes supported by the host GPU. This is defined by the manufacturer's driver. ```yaml @@ -186,7 +206,9 @@ Accept wildcard characters: False ``` ### -MinPartitionCompute -The minimum number of compute assigned by the host GPU. This is defined by the manufacturer's driver. + +The minimum number of compute assigned by the host GPU. This is defined by the manufacturer's +driver. ```yaml Type: UInt64 @@ -201,7 +223,9 @@ Accept wildcard characters: False ``` ### -MinPartitionDecode -The minimum number of decoders assigned by the host GPU. This is defined by the manufacturer's driver. + +The minimum number of decoders assigned by the host GPU. This is defined by the manufacturer's +driver. ```yaml Type: UInt64 @@ -216,7 +240,9 @@ Accept wildcard characters: False ``` ### -MinPartitionEncode -The minimum number of encoders assigned by the host GPU. This is defined by the manufacturer's driver. + +The minimum number of encoders assigned by the host GPU. This is defined by the manufacturer's +driver. ```yaml Type: UInt64 @@ -231,6 +257,7 @@ Accept wildcard characters: False ``` ### -MinPartitionVRAM + The minimum VRAM in bytes supported by the host GPU. This is defined by the manufacturer's driver. ```yaml @@ -246,7 +273,9 @@ Accept wildcard characters: False ``` ### -OptimalPartitionCompute -The optimal number of compute assigned by the host GPU. This is defined by the manufacturer's driver. + +The optimal number of compute assigned by the host GPU. This is defined by the manufacturer's +driver. ```yaml Type: UInt64 @@ -261,7 +290,9 @@ Accept wildcard characters: False ``` ### -OptimalPartitionDecode -The optimal number of decoders assigned by the host GPU. This is defined by the manufacturer's driver. + +The optimal number of decoders assigned by the host GPU. This is defined by the manufacturer's +driver. ```yaml Type: UInt64 @@ -276,7 +307,9 @@ Accept wildcard characters: False ``` ### -OptimalPartitionEncode -The optimal number of encoders assigned by the host GPU. This is defined by the manufacturer's driver. + +The optimal number of encoders assigned by the host GPU. This is defined by the manufacturer's +driver. ```yaml Type: UInt64 @@ -291,6 +324,7 @@ Accept wildcard characters: False ``` ### -OptimalPartitionVRAM + The optimal VRAM in bytes supported by the host GPU. This is defined by the manufacturer's driver. ```yaml @@ -306,6 +340,7 @@ Accept wildcard characters: False ``` ### -Passthru + Returns an object for each process that the cmdlet started. ```yaml @@ -321,6 +356,7 @@ Accept wildcard characters: False ``` ### -VM + Specifies the virtual machine whose virtual network adapters are to be retrieved. The asterisk (`*`) is the wildcard. If it is specified the cmdlet returns virtual network adapters from every virtual machine in the system. @@ -338,7 +374,8 @@ Accept wildcard characters: False ``` ### -VMGpuPartitionAdapter -GPU partition object obtained from 'Get-VMGpuPartitionAdapter'. + +GPU partition object obtained from `Get-VMGpuPartitionAdapter`. ```yaml Type: VMGpuPartitionAdapter[] @@ -353,7 +390,8 @@ Accept wildcard characters: False ``` ### -VMName -Specifies the name of the virtual machine whose network adapters are to be retrieved. + +Specifies the name of the virtual machine whose network adapters are to be configured. ```yaml Type: String[] @@ -368,6 +406,7 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml @@ -383,8 +422,8 @@ Accept wildcard characters: False ``` ### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. + +Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml Type: SwitchParameter @@ -399,7 +438,11 @@ 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](https://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](/powershell/module/microsoft.powershell.core/about/about_commonparameters). ## INPUTS @@ -416,3 +459,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS + +- [Add-VMGpuPartitionAdapter](add-vmgpupartitionadapter.md) + +- [Get-VMGpuPartitionAdapter](get-vmgpupartitionadapter.md) + +- [Remove-VMGpuPartitionAdapter](remove-vmgpupartitionadapter.md) diff --git a/docset/winserver2025-ps/hyper-v/Set-VMHostPartitionableGpu.md b/docset/winserver2025-ps/hyper-v/Set-VMHostPartitionableGpu.md index a6ef57aec9..9339de7acf 100644 --- a/docset/winserver2025-ps/hyper-v/Set-VMHostPartitionableGpu.md +++ b/docset/winserver2025-ps/hyper-v/Set-VMHostPartitionableGpu.md @@ -2,7 +2,7 @@ description: Configures the host partitionable GPU to the number of partitions supported by the manufacturer. external help file: Microsoft.HyperV.PowerShell.Cmdlets.dll-Help.xml Module Name: Hyper-V -ms.date: 10/21/2022 +ms.date: 06/12/2024 online version: https://learn.microsoft.com/powershell/module/hyper-v/set-vmhostpartitionablegpu?view=windowsserver2025-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Set-VMHostPartitionableGpu @@ -16,44 +16,53 @@ Configures the host partitionable GPU to the number of partitions supported by t ## SYNTAX ### ComputerName (Default) + ``` Set-VMHostPartitionableGpu [[-ComputerName] ] [[-Credential] ] [-Passthru] [-PartitionCount ] [] ``` ### CimSession + ``` Set-VMHostPartitionableGpu [-CimSession] [-Passthru] [-PartitionCount ] [] ``` ### Object + ``` Set-VMHostPartitionableGpu [-HostPartitionableGpu] [-Passthru] [-PartitionCount ] [] ``` ### Name + ``` -Set-VMHostPartitionableGpu [-Passthru] [-Name ] [-PartitionCount ] [] +Set-VMHostPartitionableGpu [-Passthru] [-Name ] [-PartitionCount ] + [] ``` ## DESCRIPTION -The `Set-VMHostPartitionableGpu` cmdlet configures the host partitionable GPU to the number of partitions supported by the manufacturer. + +The `Set-VMHostPartitionableGpu` cmdlet configures the host partitionable GPU to the number of +partitions supported by the manufacturer. ## EXAMPLES ### Example 1 + ```powershell -Set-VMHostPartitionableGpu -ComputerName SampleHost -partitioncount 8 +Set-VMHostPartitionableGpu -ComputerName "MyHost" -PartitionCount 8 ``` This example partitions a GPU in a specific host into eight partitions. ### Example 2 + ```powershell -$GPU = Get-VMHostPartitionableGpu -name "SampleGPUDeviceIDName" -Set-VMHostPartitionableGpu -Name $GPU -partitionCount 4 +$GPU = Get-VMHostPartitionableGpu -Name "GPUDeviceIDName" +Set-VMHostPartitionableGpu -Name $GPU -PartitionCount 4 ``` This example partitions a GPU in a host into four partitions by using the GPU device ID name. @@ -61,8 +70,11 @@ This example partitions a GPU in a host into four partitions by using the GPU de ## PARAMETERS ### -CimSession -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. -The default is the current session on the local computer. + +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](/powershell/module/cimcmdlets/new-cimsession) +or [Get-CimSession](/powershell/module/cimcmdlets/get-cimsession) cmdlet. The default is the +current session on the local computer. ```yaml Type: CimSession[] @@ -77,9 +89,10 @@ Accept wildcard characters: False ``` ### -ComputerName -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. -The default is the local computer. -Use localhost or a dot ('.') to specify the local computer explicitly. + +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. The default is the local +computer. Use localhost or a dot (`.`) to specify the local computer explicitly. ```yaml Type: String[] @@ -94,8 +107,9 @@ Accept wildcard characters: False ``` ### -Credential -Specifies one or more user accounts that have permission to perform this action. -The default is the current user. + +Specifies one or more user accounts that have permission to perform this action. The default is the +current user. ```yaml Type: PSCredential[] @@ -110,7 +124,8 @@ Accept wildcard characters: False ``` ### -HostPartitionableGpu -Full GPU object, obtained by executing 'Get-VMHostPartitionableGpu'. + +Full GPU object, obtained by executing `Get-VMHostPartitionableGpu`. ```yaml Type: VMHostPartitionableGpu[] @@ -125,6 +140,7 @@ Accept wildcard characters: False ``` ### -Name + Specifies the name of the GPU. ```yaml @@ -140,7 +156,9 @@ Accept wildcard characters: False ``` ### -PartitionCount -Specifies the number of partitions that the GPU will assign. The number of partitions is defined by the manufacturer. + +Specifies the number of partitions that the GPU will assign. The number of partitions is defined by +the manufacturer. ```yaml Type: UInt16 @@ -155,6 +173,7 @@ Accept wildcard characters: False ``` ### -Passthru + Returns an object for each process that the cmdlet started. ```yaml @@ -170,7 +189,11 @@ 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](https://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](/powershell/module/microsoft.powershell.core/about/about_commonparameters). ## INPUTS @@ -185,3 +208,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS + +- [Get-VMHostPartitionableGpu](get-vmhostpartitionablegpu.md)