Get-SCVirtualDVDDrive
Gets a VMM virtual DVD drive object from a virtual machine, a virtual machine template, or a hardware profile.
Syntax
All
Get-SCVirtualDVDDrive
[-VMMServer <ServerConnection>]
[-All]
[-OnBehalfOfUser <String>]
[-OnBehalfOfUserRole <UserRole>]
[<CommonParameters>]
HardwareProfile
Get-SCVirtualDVDDrive
-HardwareProfile <HardwareProfile>
[-VMMServer <ServerConnection>]
[-OnBehalfOfUser <String>]
[-OnBehalfOfUserRole <UserRole>]
[<CommonParameters>]
VM
Get-SCVirtualDVDDrive
-VM <VM>
[-VMMServer <ServerConnection>]
[-OnBehalfOfUser <String>]
[-OnBehalfOfUserRole <UserRole>]
[<CommonParameters>]
Template
Get-SCVirtualDVDDrive
-VMTemplate <Template>
[-VMMServer <ServerConnection>]
[-OnBehalfOfUser <String>]
[-OnBehalfOfUserRole <UserRole>]
[<CommonParameters>]
ID
Get-SCVirtualDVDDrive
[-ID] <Guid>
[-VMMServer <ServerConnection>]
[-OnBehalfOfUser <String>]
[-OnBehalfOfUserRole <UserRole>]
[<CommonParameters>]
Description
The Get-SCVirtualDVDDrive cmdlet gets one or more Virtual Machine Manager (VMM) virtual DVD drive objects from a virtual machine object, a virtual machine template object, or a hardware profile object.
Examples
Example 1: Get virtual DVD drives from a virtual machine
PS C:\> $VM = Get-SCVirtualMachine -Name "VM01"
PS C:\> Get-SCVirtualDVDDrive -VM $VM
The first command gets the virtual machine object named VM01 and stores the object in the $VM variable.
The second command gets all DVD drive objects on VM01 and displays information about these virtual DVD drives to the user.
Example 2: Get virtual DVD drives from a template
PS C:\> $VMTemplate = Get-SCVMTemplate | where { $_.Name -eq "VMTemplate01" }
PS C:\> Get-SCVirtualDVDDrive -Template $VMTemplate
The first command gets all virtual machine template objects stored in the VMM library, selects the template object named VMTemplate01, and then stores the object in the $Template variable.
The second command gets all virtual DVD drive objects on VMTemplate01 and displays information about these virtual DVD drives to the user.
Example 3: Get virtual DVD drives from a hardware profile
PS C:\> $HWProfile = Get-SCHardwareProfile | where { $_.Name -eq "NewHWProfile01" }
PS C:\> Get-SCVirtualDVDDrive -HardwareProfile $HWProfile
The first command gets all hardware profile objects in the VMM library, selects the profile object named NewHWProfile01, and then stores the object in the $HWProfile variable.
The second command gets all virtual DVD drive objects on NewHHWProfile01 and displays information about these virtual DVD drives to the user.
Parameters
-All
Indicates that this cmdlet gets all subordinate objects independent of the parent object.
For example, the command Get-SCVirtualDiskDrive -All gets all virtual disk drive objects regardless of the virtual machine object or template object that each virtual disk drive object is associated with.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
All
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-HardwareProfile
Specifies a hardware profile object.
Parameter properties
| Type: | HardwareProfile |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
HardwareProfile
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ID
Specifies the numerical identifier as a globally unique identifier, or GUID, for a specific object.
Parameter properties
| Type: | Guid |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ID
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-OnBehalfOfUser
Specifies a user name. This cmdlet operates on behalf of the user that this parameter specifies.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-OnBehalfOfUserRole
Specifies a user role. To obtain a user role, use the Get-SCUserRole cmdlet. This cmdlet operates on behalf of the user role that this parameter specifies.
Parameter properties
| Type: | UserRole |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-VM
Specifies a virtual machine object.
Parameter properties
| Type: | VM |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
VM
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-VMMServer
Specifies a VMM server object.
Parameter properties
| Type: | ServerConnection |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-VMTemplate
Specifies a VMM template object used to create virtual machines.
Parameter properties
| Type: | Template |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | Template |
Parameter sets
Template
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Outputs
VirtualDVDDrive
This cmdlet returns a VirtualDVDDrive object.
Notes
- Requires a VMM virtual machine object, virtual machine template object, or hardware profile object. You can retrieve these objects by using the Get-SCVirtualMachine, Get-SCVMTemplate, or Get-SCHardwareProfile cmdlets, respectively.