Syntax
Get-HCXDatastore [[-Name] <String[]>] [-Server <HcxServer[]>] [-Site <HCXSite[]>] [-StorageProfile <HCXStorageProfile>] [<CommonParameters>]Related Commands
Detailed Description
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.Parameters
| Name | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Name | String[] | Specifies the name of the HCX datastore. | false | False | |
| Server | HcxServer[] | Specifies the HCX Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-HCXServer cmdlet. | false | False | |
| Site | HCXSite[] | 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. | false | True (ByValue) | |
| StorageProfile | HCXStorageProfile | Specifies the HCX storage profile matching which you want to list the datastores. | false | True (ByValue) | |
| Uid | String[] | Specifies the Uid of the HCX datastore.
Note: When a list of values is specified for the Uid parameter, the returned objects have a Uid that matches exactly one of the string values in the list. | true | False |
Return Type
VMware.VimAutomation.Hcx.Types.V1.HCXDatastoreNotes
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 $myDestinationRetrieves 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 $myStorageProfileRetrieves the HCX datastore by destination site and storage profile.
-------------------------- Example 5 --------------------------
PS C:\> $myDatastore = Get-HCXDatastore -Name "myDatastoreName"
Get-HCXDatastore -Uid $myDatastore.UidRetrieves the HCX datastore by Uid.