Get-HCXStorageProfile Command | Vmware PowerCLI Reference

Get-HCXStorageProfile

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

Syntax

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

Parameters

Required Parameter Name Type Position Features Description
required
Uid String[] named
Specifies the Uid of the HCX storage profile. 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.
optional Server HcxServer[] named
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.
Get-HCXStorageProfile
[-Name < String[] > ]
[-Server < HcxServer[] > ]
[-Site < HCXSite[] > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
optional Name String[] named
Specifies the name of the HCX storage profile.
optional Server HcxServer[] named
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 storage profiles. If this parameter is not specified, the default one is selected from the source site.

Output

VMware.VimAutomation.Hcx.Types.V1.HCXDatastore

Examples

Example 1

Get-HCXStorageProfile

Retrieves the available HCX storage profiles at the source site.

Example 2

Get-HCXStorageProfile -Name "myStorageProfileName"

Retrieves the HCX storage profile by name at the source site.

Example 3

$myDestination = Get-HCXSite -Destination -Name "myDestinationName"
        Get-HCXStorageProfile -Site $myDestination

Retrieves the HCX storage profile by destination site.

Example 4

$myStorageProfile = Get-HCXStorageProfile -Name "myStorageProfileName"
        Get-HCXStorageProfile -Uid $myStorageProfile.Uid

Retrieves the HCX storage profile by Uid.

Related Commands

HCXStorageProfile

This cmdlet retrieves a list of HCX storage profiles.