PowerCLI Reference

Get-Datastore

Synopsis

This cmdlet retrieves the datastores available on a vCenter Server system.

Syntax

Get-Datastore [-Server <VIServer[]>] [[-Name] <String[]>] [-Location <VIObject[]>] [-RelatedObject <DatastoreRelatedObjectBase[]>] [-Refresh] [-Tag <Tag[]>] [<CommonParameters>]

Get-Datastore [-Server <VIServer[]>] -Id <String[]> [-Refresh] [<CommonParameters>]

Related Commands

Online version
New-Datastore
Remove-Datastore
Set-Datastore
Move-Datastore

Detailed Description

This cmdlet retrieves the datastores available on a vCenter Server system. Returns a set of datastores that correspond to the filter criteria defined by the cmdlet parameters. To specify a server different from the default one, use the Server parameter.

Parameters

NameTypeDescriptionRequired?Pipeline InputDefault Value
NameString[]Specifies the names of the datastores you want to retrieve.falsefalse
IdString[]Specifies the IDs of the datastores 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.
truefalse
LocationVIObject[]Specifies vSphere container objects that you want to search for datastores. This parameter accepts Datacenter, Folder, and DatastoreCluster objects.falsefalse
RefreshSwitchParameterIndicates that the cmdlet first refreshes the storage system information and then retrieves the specified datastores.falsefalse
RelatedObjectDatastoreRelatedObjectBase[]Specifies objects to retrieve one or more Datastore objects that are related to them. This parameter accepts vSphere VirtualMachine, VMHost, Datacenter, DatastoreCluster, Cluster, Folder, HardDisk, and OMResource objects, as well as vCloud Datastore objects.falsetrue (ByValue)
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
TagTag[]Returns only the datastores that are associated with any of the specified tags.falsefalse

Return Type

Zero or more Datastore objects

Notes

Examples

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

Get-VMHost -Name VMHost1, VMHost2 | Get-Datastore

Retrieves datastores from the VMHost1 and VMHost2 hosts.

-------------- Example 2 --------------

Get-Datastore -Name MyDatastore* -Location MyDatacenter

Retrieves the datastores from the MyDatacenter datacenter that have names starting with MyDatastore.

-------------- Example 3 --------------

$vm1 = Get-VM -Name myVM1
$vm2 = Get-VM -Name myVM2
Get-Datastore -RelatedObject $vm1, $vm2

Retrieves the datastores for a specified array of virtual machines.

-------------- Example 4 --------------

$myVMHost = Get-VMHost -Name MyVMHost
Get-Datastore -VMHost $myVMHost -Refresh

Refreshes the host storage system and retrieves its datastores.


Copyright © VMware, Inc. All rights reserved.