Get-VmcSddcCluster

This cmdlet retrieves clusters of VMware Cloud on AWS software-defined data centers (SDDCs) from the VMware Cloud environment.

Syntax

[-Name  <String[]>]
[-Sddc  <VmcSddc[]>]
[-Server  <VmcServer[]>]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
optional
Name
String[] named
  • wildcards
  • Specifies the names of the clusters you want to retrieve.
    optional
    Sddc
    VmcSddc[] named
  • pipeline
  • Specifies the SDDCs which clusters you want to retrieve.
    optional
    Server
    VmcServer[] named Specifies the VMware Cloud on AWS servers 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-Vmc cmdlet.

    -ClusterId  <String[]>
    [-Server  <VmcServer[]>]
    [CommonParameters]

    Parameters

    Required Parameter Name Type Position Features Description
    required
    ClusterId
    String[] named Specifies the IDs of the clusters you want to retrieve.
    optional
    Server
    VmcServer[] named Specifies the VMware Cloud on AWS servers 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-Vmc cmdlet.

    Output

    VMware.VimAutomation.Vmc.Types.V1.CmdletObject.VmcSddcCluster

    Examples


    Example 1

    Get-VmcSddcCluster -Name "ClusterName" -Sddc $SDDC

    Retrieves the cluster named "ClusterName" from the $SDDC software-defined data center.

    Example 2

    Get-VmcSddcCluster -ClusterId "ClusterId"

    Retrieves the cluster with a "ClusterId" ID.

    Related Commands

    Feedback

    Was this page helpful?