Get-HCXSite

This cmdlet retrieves a list of HCX sites and local/remote HCXSites according to the Source or Destination parameters. You can create new HCX migration, replication, and network extension requests by using the output of the cmdlet.

Syntax

[-Name  <String[]>]
[-Server  <HcxServer[]>]
[-Type  <HCXSiteType>]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
optional
Name
String[] named
  • wildcards
  • Specifies the name of the HCX site.
    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
    Type
    HCXSiteType named

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

    Parameters

    Required Parameter Name Type Position Features Description
    required
    Id
    String[] named Specifies the Id of the HCX site.
    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.

    -Destination
    [-Name  <String[]>]
    [-Server  <HcxServer[]>]
    [-Type  <HCXSiteType>]
    [CommonParameters]

    Parameters

    Required Parameter Name Type Position Features Description
    required
    Destination
    SwitchParameter named Specifies the destination site from which you can retrieve sites.
    optional
    Name
    String[] named
  • wildcards
  • Specifies the name of the HCX site.
    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
    Type
    HCXSiteType named

    -Source
    [-Name  <String[]>]
    [-Server  <HcxServer[]>]
    [-Type  <HCXSiteType>]
    [CommonParameters]

    Parameters

    Required Parameter Name Type Position Features Description
    required
    Source
    SwitchParameter named Specifies the sites that you want to retrieve from the source site.
    optional
    Name
    String[] named
  • wildcards
  • Specifies the name of the HCX site.
    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
    Type
    HCXSiteType named

    Output

    VMware.VimAutomation.Hcx.Types.V1.HCXSite

    Examples


    Example 1

    PS C:\> Get-HCXSite

    Retrieves a list of the HCX site at the source site.

    Example 2

    PS C:\> Get-HCXSite -Destination

    Retrieves a list of the HCX site at the destination site.

    Example 3

    PS C:\> Get-HCXSite -Name "mySiteName"

    Retrieves a list of the HCX site by name.

    Related Commands

    Feedback

    Was this page helpful?