# Get-RubrikVMwareCluster

## SYNOPSIS

Connects to Rubrik and retrieves a list of VMware Clusters registered

## SYNTAX

### Query (Default)

```
Get-RubrikVMwareCluster [[-Name] <String>] [-PrimaryClusterID <String>] [-DetailedObject] [-Server <String>]
 [-api <String>] [<CommonParameters>]
```

### ID

```
Get-RubrikVMwareCluster [-Id] <String> [-Server <String>] [-api <String>] [<CommonParameters>]
```

## DESCRIPTION

The Get-RubrikVMwareCluster cmdlet will retrieve all of the registered VMware Clusters within the authenticated Rubrik cluster.

## EXAMPLES

### EXAMPLE 1

```
Get-RubrikVMwareCluster
```

This will return a listing of all of the VMware Cluster objects known to the connected Rubrik cluster

Get-RubrikVMwareCluster -PrimarClusterId local This will return a listing of all of the VMware Cluster objects whose primary cluster is that of the connected Rubrik cluster.

### EXAMPLE 2

```
Get-RubrikVMwareCluster -Name 'Cluster01'
```

This will return a listing of all of the VMware Cluster objects named 'Cluster01' registered with the connected Rubrik cluster

## PARAMETERS

### -Id

Cluster Object ID

```yaml
Type: String
Parameter Sets: ID
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```

### -Name

Cluster Object Name

```yaml
Type: String
Parameter Sets: Query
Aliases:

Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -PrimaryClusterID

Filter the summary information based on the primarycluster\_id of the primary Rubrik cluster. Use 'local' as the primary\_cluster\_id of the Rubrik cluster that is hosting the current REST API session.

```yaml
Type: String
Parameter Sets: Query
Aliases: primary_cluster_id

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -DetailedObject

Return more details on object

```yaml
Type: SwitchParameter
Parameter Sets: Query
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```

### -Server

Rubrik server IP or FQDN

```yaml
Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: $global:RubrikConnection.server
Accept pipeline input: False
Accept wildcard characters: False
```

### -api

API version

```yaml
Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: $global:RubrikConnection.api
Accept pipeline input: False
Accept wildcard characters: False
```

### CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about\_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).

## INPUTS

## OUTPUTS

## NOTES

Written by Mike Preston for community usage Twitter: @mwpreston GitHub: mwpreston

## RELATED LINKS

<https://rubrik.gitbook.io/rubrik-sdk-for-powershell/command-documentation/reference/get-rubrikvmwarecluster>