Get-Datastore

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.

Syntax

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

Parameters

Required Parameter Name Type Position Features Description
optional
Location
VIObject[] named Specifies vSphere container objects that you want to search for datastores. This parameter accepts Datacenter, Folder, and DatastoreCluster objects.
optional
Name
String[] named
  • wildcards
  • Specifies the names of the datastores you want to retrieve.
    optional
    Refresh
    SwitchParameter named Indicates that the cmdlet first refreshes the storage system information and then retrieves the specified datastores.
    optional
    RelatedObject
    DatastoreRelatedObjectBase[] named
  • pipeline
  • 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.
    optional
    Server
    VIServer[] named
  • wildcards
  • Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null 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.
    optional
    Tag
    Tag[] named
  • wildcards
  • Returns only the datastores that are associated with any of the specified tags.

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

    Parameters

    Required Parameter Name Type Position Features Description
    required
    Id
    String[] named
  • wildcards
  • 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.
    optional
    Refresh
    SwitchParameter named Indicates that the cmdlet first refreshes the storage system information and then retrieves the specified datastores.
    optional
    Server
    VIServer[] named
  • wildcards
  • Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null 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.

    Output

    VMware.VimAutomation.ViCore.Types.V1.DatastoreManagement.Datastore

    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.

    Related Commands

    Feedback

    Was this page helpful?