PowerCLI Reference

Get-CDDrive

Synopsis

This cmdlet retrieves virtual CD drives.

Syntax

Get-CDDrive [-Id <String[]>] [-Server <VIServer[]>] [[-VM] <VirtualMachine[]>] [[-Template] <Template[]>] [[-Snapshot] <Snapshot[]>] [-Name <String[]>] [<CommonParameters>]

Related Commands

Online version
New-CDDrive
Remove-CDDrive
Set-CDDrive

Detailed Description

This cmdlet returns a set of virtual CD drives that belong to the virtual machines, templates, and snapshots specified by the VirtualMachine, Template, and Snapshot parameters. At least one of these parameters must be provided. To specify a server different from the default one, use the Server parameter.

Parameters

NameTypeDescriptionRequired?Pipeline InputDefault Value
VMVirtualMachine[]Specifies the virtual machines from which you want to retrieve virtual CD drives.falsetrue (ByValue)
TemplateTemplate[]Specifies the virtual machine templates from which you want to retrieve virtual CD drives.falsetrue (ByValue)
SnapshotSnapshot[]Specifies the snapshots from which you want to retrieve virtual CD drives.falsetrue (ByValue)
IdString[]Specifies the IDs of the CD drives you want to retrieve.

Note: When a list of values is specified for the Id parameter, the returned objects would have an ID that matches exactly one of the string values in that list.
falsefalse
NameString[]Specifies the names of the CD drives you want to retrieve.falsefalse
ServerVIServer[]Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.falsefalse

Return Type

Zero or more CDDrive objects

Notes

Examples

-------------- Example 1 --------------

Get-VM -Name VM | Get-CDDrive

Connects to a vSphere server and retrieves the CD drive of the virtual machine named VM.


Copyright © VMware, Inc. All rights reserved.