# Get-RubrikVM ## SYNOPSIS Retrieves details on one or more virtual machines known to a Rubrik cluster ## SYNTAX ### Query (Default) ``` Get-RubrikVM [[-Name] ] [-Relic] [-DetailedObject] [-SLA ] [-SLAAssignment ] [-PrimaryClusterID ] [-SLAID ] [-Server ] [-api ] [] ``` ### ID ``` Get-RubrikVM [-id] [-Server ] [-api ] [] ``` ## 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 ```yaml 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 ```yaml 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 ```yaml 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. ```yaml 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 ```yaml 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 ```yaml 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. ```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 ``` ### -SLAID SLA id value ```yaml 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 ```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 Chris Wahl for community usage Twitter: @ChrisWahl GitHub: chriswahl ## RELATED LINKS --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://rubrik.gitbook.io/rubrik-sdk-for-powershell/devel/command-documentation/reference/get-rubrikvm.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.