Get-HCXDatastore

This cmdlet retrieves a list of HCX datastores. If the HCXSite is not passed as input, the source site datastores are listed. You can create new HCX migration, replication, and appliance requests by using the output of the cmdlet.

Syntax

[-Name  <String[]>]
[-Server  <HcxServer[]>]
[-Site  <HCXSite[]>]
[-StorageProfile  <HCXStorageProfile>]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
optional
Name
String[] named
  • wildcards
  • Specifies the name of the HCX datastore.
    optional
    Server
    HcxServer[] named
  • wildcards
  • Specifies the HCX 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 the Connect-HCXServer cmdlet.
    optional
    Site
    HCXSite[] named
  • pipeline
  • Specifies the HCX site for which you want to list the datastores. If this parameter is not specified, the default one is selected from the source site.
    optional
    StorageProfile
    HCXStorageProfile named
  • pipeline
  • Specifies the HCX storage profile matching which you want to list the datastores.

    -Uid  <String[]>
    [-Server  <HcxServer[]>]
    [CommonParameters]

    Parameters

    Required Parameter Name Type Position Features Description
    required
    Uid
    String[] named Specifies the Uid of the HCX datastore.
    optional
    Server
    HcxServer[] named
  • wildcards
  • Specifies the HCX 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 the Connect-HCXServer cmdlet.

    Output

    VMware.VimAutomation.Hcx.Types.V1.HCXDatastore

    Examples


    Example 1

    PS C:\> Get-HCXDatastore

    Retrieves the available HCX datastore at the source site.

    Example 2

    PS C:\> Get-HCXDatastore -Name "myDatastoreName"

    Retrieves the HCX datastore by name at the source site.

    Example 3

    PS C:\> $myDestination = Get-HCXSite -Destination -Name "myDestinationName"
    Get-HCXDatastore -Site $myDestination

    Retrieves the HCX datastore by destination site.

    Example 4

    PS C:\> $myDestination = Get-HCXSite -Destination -Name "myDestinationName"
    $myStorageProfile = Get-HCXStorageProfile -Site $myDestination -Name "myStorageProfileName"
    Get-HCXDatastore -Site $myDestination -StorageProfile $myStorageProfile

    Retrieves the HCX datastore by destination site and storage profile.

    Example 5

    PS C:\> $myDatastore = Get-HCXDatastore -Name "myDatastoreName"
    Get-HCXDatastore -Uid $myDatastore.Uid

    Retrieves the HCX datastore by Uid.

    Related Commands

    Feedback

    Was this page helpful?