Get-RubrikVM

SYNOPSIS

Retrieves details on one or more virtual machines known to a Rubrik cluster

SYNTAX

Query (Default)

Get-RubrikVM [[-Name] <String>] [-Relic] [-DetailedObject] [-SLA <String>] [-SLAAssignment <String>]
 [-PrimaryClusterID <String>] [-SLAID <String>] [-Server <String>] [-api <String>] [<CommonParameters>]

ID

Get-RubrikVM [-id] <String> [-Server <String>] [-api <String>] [<CommonParameters>]

DESCRIPTION

The Get-RubrikVM cmdlet is used to pull a detailed data set from a Rubrik cluster on any number of virtual machines

EXAMPLES

EXAMPLE 1

Get-RubrikVM -Name 'Server1'

This will return details on all virtual machines named "Server1".

EXAMPLE 2

Get-RubrikVM -Name 'Server1' -SLA Gold

This will return details on all virtual machines named "Server1" that are protected by the Gold SLA Domain.

EXAMPLE 3

Get-RubrikVM -Relic

This will return all removed virtual machines that were formerly protected by Rubrik.

EXAMPLE 4

Get-RubrikVM -SLAAssignment Unassigned

Retrieves all VMware VMs that are currently not protected by any SLA

EXAMPLE 5

Get-RubrikVM -Name myserver01 -DetailedObject

This will return the VM object with all properties, including additional details such as snapshots taken of the VM. Using this switch parameter negatively affects performance

PARAMETERS

-Name

Name of the virtual machine

Type: String
Parameter Sets: Query
Aliases: VM

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

-id

Virtual machine id

Type: String
Parameter Sets: ID
Aliases:

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

-Relic

Filter results to include only relic (removed) virtual machines

Type: SwitchParameter
Parameter Sets: Query
Aliases: is_relic

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

-DetailedObject

DetailedObject will retrieved the detailed VM object, the default behavior of the API is to only retrieve a subset of the full VM object unless we query directly by ID. Using this parameter does affect performance as more data will be retrieved and more API-queries will be performed.

Type: SwitchParameter
Parameter Sets: Query
Aliases:

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

-SLA

SLA Domain policy assigned to the virtual machine

Type: String
Parameter Sets: Query
Aliases:

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

-SLAAssignment

Filter by SLA Domain assignment type

Type: String
Parameter Sets: Query
Aliases: sla_assignment

Required: False
Position: Named
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.

Type: String
Parameter Sets: Query
Aliases: primary_cluster_id

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

-SLAID

SLA id value

Type: String
Parameter Sets: Query
Aliases: effective_sla_domain_id

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

-Server

Rubrik server IP or FQDN

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

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.

INPUTS

OUTPUTS

NOTES

Written by Chris Wahl for community usage Twitter: @ChrisWahl GitHub: chriswahl

RELATED LINKS

https://rubrik.gitbook.io/rubrik-sdk-for-powershell/command-documentation/reference/get-rubrikvm