Remove-SCVirtualDVDDrive
Remove-SCVirtualDVDDrive
Removes a virtual DVD drive object from VMM.
Syntax
Parameter Set: SourceBusAndLunSpecified
Remove-SCVirtualDVDDrive -JobGroup <Guid]> -SourceBus <Byte]> -SourceLUN <Byte]> [-JobVariable <String> ] [-OnBehalfOfUser <System.String> ] [-OnBehalfOfUserRole <Microsoft.SystemCenter.VirtualMachineManager.UserRole> ] [-PROTipID <Guid]> ] [-RunAsynchronously] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: VirtualDVDDriveSpecified
Remove-SCVirtualDVDDrive [-VirtualDVDDrive] <VirtualDVDDrive> [-JobGroup <Guid]> ] [-JobVariable <String> ] [-OnBehalfOfUser <System.String> ] [-OnBehalfOfUserRole <Microsoft.SystemCenter.VirtualMachineManager.UserRole> ] [-PROTipID <Guid]> ] [-RunAsynchronously] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Remove-SCVirtualDVDDrive cmdlet removes one or more virtual DVD drive objects from a hardware profile, a virtual machine, or a virtual machine template used in a Virtual Machine Manager (VMM) environment. The cmdlet also deletes any .iso file that the virtual DVD drive uses from the file system on the library server.
This cmdlet returns the object upon success, with the property MarkedForDeletion set to TRUE, or returns an error message upon failure.
Parameters
-JobGroup<Guid]>
Specifies an identifier for a series of commands that will run as a set just before the final command that includes the same job group identifier runs.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-JobVariable<String>
Specifies that job progress is tracked and stored in the variable named by this parameter.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-OnBehalfOfUser<System.String>
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-OnBehalfOfUserRole<Microsoft.SystemCenter.VirtualMachineManager.UserRole>
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-PROTipID<Guid]>
Specifies the ID of the PRO tip that triggered this action. This allows for auditing of PRO tips.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-RunAsynchronously
Indicates that the job runs asynchronously so that control returns to the command shell immediately.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-SourceBus<Byte]>
Specifies the source IDE bus for the drive.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-SourceLUN<Byte]>
Specifies the source logical unit number (LUN) for a virtual DVD drive object on an IDE bus.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-VirtualDVDDrive<VirtualDVDDrive>
Specifies a virtual DVD drive object.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-Confirm
Prompts you for confirmation before running the cmdlet.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
Notes
- This cmdlet requires a VMM virtual DVD drive object, which can be retrieved by using the Get-SCVirtualDVDDrive cmdlet.
Examples
Example 1: Remove a specific virtual DVD drive from a virtual machine
The first command gets the virtual machine object named VM01, and then stores the object in the $VM variable.
The second command gets the virtual DVD drive object located on the first slot of the Secondary Channel, specified by Bus 1 and LUN 0, on the IDE bus on VM01, and then stores the virtual DVD drive object in the $DVDDrive variable.
The last command removes the virtual DVD drive object stored in $DVDDrive from VM01 and deletes any .iso file that this virtual DVD drive uses from the file system on the library server.
PS C:\> $VM = Get-SCVirtualMachine -Name "VM01"
PS C:\> $DVDDrive = Get-SCVirtualDVDDrive -VM $VM | where { $_.Bus -eq 1 -and $_.LUN -eq 0 }
PS C:\> Remove-SCVirtualDVDDrive -VirtualDVDDrive $DVDDrive
Example 2: Remove the third virtual DVD drive from a virtual machine
The first command gets the virtual machine object named VM02, and then stores the object in the $VM variable.
The second command gets all virtual DVD drive objects connected to VM02, and then stores each virtual DVD drive object in the $DVDDrive object array. This example assumes that VM02 has three virtual DVD drives and therefore the array contains three elements, counting 0 to 2.
The last command passes the third virtual DVD drive stored in $DVDDrive to the Remove-SCVirtualDVDDrive cmdlet. That cmdlet removes the virtual DVD drive object from VM02 and deletes any .iso file used by this virtual DVD drive from the file system on the library server.
PS C:\> $VM = Get-SCVirtualMachine -Name "VM02"
PS C:\> $DVDDrive = Get-SCVirtualDVDDrive -VM $VM
PS C:\> $DVDDrive[2] | Remove-SCVirtualDVDDrive