Rubrik SDK for PowerShell
devel
develmaster
devel
develmaster
  • README
  • User Documentation
    • Contribution
    • FAQ
    • Getting Started
    • Installation
    • Licensing
    • Project Architecture
    • Requirements
    • Support
  • Command Documentation
    • Workflow
      • Flow Audit
    • Reference
      • Connect-Rubrik
      • Disconnect-Rubrik
      • Export-RubrikDatabase
      • Export-RubrikReport
      • Export-RubrikVApp
      • Export-RubrikVCDTemplate
      • Export-RubrikVM
      • Find-RubrikFile
      • Get-RubrikAPIToken
      • Get-RubrikAPIVersion
      • Get-RubrikArchive
      • Get-RubrikAvailabilityGroup
      • Get-RubrikBackupServiceDeployment
      • Get-RubrikBlackout
      • Get-RubrikBootStrap
      • Get-RubrikClusterInfo
      • Get-RubrikClusterNetworkInterface
      • Get-RubrikClusterStorage
      • Get-RubrikClusterUpgradeHistory
      • Get-RubrikDatabase
      • Get-RubrikDatabaseDownloadLink
      • Get-RubrikDatabaseFiles
      • Get-RubrikDatabaseMount
      • Get-RubrikDatabaseRecoverableRange
      • Get-RubrikDatabaseRecoveryPoint
      • Get-RubrikDebugInfo
      • Get-RubrikDNSSetting
      • Get-RubrikDownloadLink
      • Get-RubrikEmailSetting
      • Get-RubrikEvent
      • Get-RubrikEventSeries
      • Get-RubrikFileset
      • Get-RubrikFilesetTemplate
      • Get-RubrikGuestOSCredential
      • Get-RubrikHost
      • Get-RubrikHostVolume
      • Get-RubrikHvmFormatAutoUpgrade
      • Get-RubrikHvmFormatClusterStorage
      • Get-RubrikHvmFormatReport
      • Get-RubrikHvmFormatUpgradeReport
      • Get-RubrikHyperVHost
      • Get-RubrikHyperVMount
      • Get-RubrikHyperVVM
      • Get-RubrikIPMI
      • Get-RubrikLDAP
      • Get-RubrikLoginBanner
      • Get-RubrikLogShipping
      • Get-RubrikManagedVolume
      • Get-RubrikManagedVolumeExport
      • Get-RubrikModuleDefaultParameter
      • Get-RubrikModuleOption
      • Get-RubrikMount
      • Get-RubrikNASShare
      • Get-RubrikNetworkThrottle
      • Get-RubrikNfsArchive
      • Get-RubrikNode
      • Get-RubrikNotificationSetting
      • Get-RubrikNTPServer
      • Get-RubrikNutanixCluster
      • Get-RubrikNutanixVM
      • Get-RubrikObject
      • Get-RubrikObjectStoreArchive
      • Get-RubrikOracleDB
      • Get-RubrikOrganization
      • Get-RubrikOrgAuthorization
      • Get-RubrikProxySetting
      • Get-RubrikQstarArchive
      • Get-RubrikReplicationSource
      • Get-RubrikReplicationTarget
      • Get-RubrikReport
      • Get-RubrikReportData
      • Get-RubrikRequest
      • Get-RubrikScvmm
      • Get-RubrikSecurityClassification
      • Get-RubrikSetting
      • Get-RubrikSLA
      • Get-RubrikSmbDomain
      • Get-RubrikSmbSecurity
      • Get-RubrikSnapshot
      • Get-RubrikSNMPSetting
      • Get-RubrikSoftwareVersion
      • Get-RubrikSQLInstance
      • Get-RubrikSupportTunnel
      • Get-RubrikSyslogServer
      • Get-RubrikUnmanagedObject
      • Get-RubrikUser
      • Get-RubrikUserRole
      • Get-RubrikVApp
      • Get-RubrikVAppExportOption
      • Get-RubrikVAppRecoverOption
      • Get-RubrikVAppSnapshot
      • Get-RubrikVCD
      • Get-RubrikVCDTemplateExportOption
      • Get-RubrikVCenter
      • Get-RubrikVersion
      • Get-RubrikVgfAutoUpgrade
      • Get-RubrikVgfClusterStorage
      • Get-RubrikVgfReport
      • Get-RubrikVgfUpgradeReport
      • Get-RubrikVM
      • Get-RubrikVMSnapshot
      • Get-RubrikVMwareCluster
      • Get-RubrikVMwareDatacenter
      • Get-RubrikVMwareDatastore
      • Get-RubrikVMwareHost
      • Get-RubrikVolumeGroup
      • Get-RubrikVolumeGroupMount
      • Invoke-RubrikGraphQLCall
      • Invoke-RubrikHvmFormatUpgrade
      • Invoke-RubrikRESTCall
      • Invoke-RubrikVgfUpgrade
      • Move-RubrikMountVMDK
      • New-RubrikAPIToken
      • New-RubrikBootStrap
      • New-RubrikDatabaseMount
      • New-RubrikFileset
      • New-RubrikFilesetTemplate
      • New-RubrikHost
      • New-RubrikHyperVVMMount
      • New-RubrikLDAP
      • New-RubrikLogBackup
      • New-RubrikLogShipping
      • New-RubrikManagedVolume
      • New-RubrikManagedVolumeExport
      • New-RubrikMount
      • New-RubrikNASShare
      • New-RubrikOrganization
      • New-RubrikReport
      • New-RubrikSLA
      • New-RubrikSnapshot
      • New-RubrikUser
      • New-RubrikVCenter
      • New-RubrikVMDKMount
      • New-RubrikVolumeGroupMount
      • Protect-RubrikDatabase
      • Protect-RubrikFileset
      • Protect-RubrikHyperVVM
      • Protect-RubrikNutanixVM
      • Protect-RubrikTag
      • Protect-RubrikVApp
      • Protect-RubrikVM
      • Protect-RubrikVolumeGroup
      • Register-RubrikBackupService
      • Remove-RubrikAPIToken
      • Remove-RubrikDatabaseMount
      • Remove-RubrikDatabaseSnapshots
      • Remove-RubrikFileset
      • Remove-RubrikFilesetSnapshot
      • Remove-RubrikFilesetTemplate
      • Remove-RubrikHost
      • Remove-RubrikHyperVMount
      • Remove-RubrikHyperVSnapshot
      • Remove-RubrikLogShipping
      • Remove-RubrikManagedVolume
      • Remove-RubrikManagedVolumeExport
      • Remove-RubrikManagedVolumeSnapshot
      • Remove-RubrikModuleDefaultParameter
      • Remove-RubrikMount
      • Remove-RubrikNASShare
      • Remove-RubrikNutanixVMSnapshot
      • Remove-RubrikOrganization
      • Remove-RubrikOrgAuthorization
      • Remove-RubrikProxySetting
      • Remove-RubrikReport
      • Remove-RubrikSLA
      • Remove-RubrikUnmanagedObject
      • Remove-RubrikUser
      • Remove-RubrikVCenter
      • Remove-RubrikVMSnapshot
      • Remove-RubrikVolumeGroupMount
      • Remove-RubrikVolumeGroupSnapshot
      • Reset-RubrikLogShipping
      • Restore-RubrikDatabase
      • Restore-RubrikVApp
      • Resume-RubrikSLA
      • Set-RubrikAvailabilityGroup
      • Set-RubrikBlackout
      • Set-RubrikDatabase
      • Set-RubrikHvmFormatAutoUpgrade
      • Set-RubrikHyperVVM
      • Set-RubrikLogShipping
      • Set-RubrikManagedVolume
      • Set-RubrikModuleDefaultParameter
      • Set-RubrikModuleOption
      • Set-RubrikMount
      • Set-RubrikNASShare
      • Set-RubrikNutanixVM
      • Set-RubrikOrgAuthorization
      • Set-RubrikProxySetting
      • Set-RubrikReport
      • Set-RubrikSetting
      • Set-RubrikSLA
      • Set-RubrikSQLInstance
      • Set-RubrikSupportTunnel
      • Set-RubrikUser
      • Set-RubrikUserRole
      • Set-RubrikVCD
      • Set-RubrikVCenter
      • Set-RubrikVgfAutoUpgrade
      • Set-RubrikVM
      • Set-RubrikVolumeFilterDriver
      • Start-RubrikDownload
      • Start-RubrikManagedVolumeSnapshot
      • Stop-RubrikManagedVolumeSnapshot
      • Suspend-RubrikSLA
      • Sync-RubrikAnnotation
      • Sync-RubrikTag
      • Test-RubrikSnapshotVerification
      • Update-RubrikHost
      • Update-RubrikNutanixCluster
      • Update-RubrikVCD
      • Update-RubrikVCenter
      • Update-RubrikVMwareVM
Powered by GitBook
On this page
  • SYNOPSIS
  • SYNTAX
  • Query (Default)
  • ID
  • DESCRIPTION
  • EXAMPLES
  • EXAMPLE 1
  • EXAMPLE 2
  • EXAMPLE 3
  • EXAMPLE 4
  • EXAMPLE 5
  • PARAMETERS
  • -Name
  • -id
  • -Relic
  • -DetailedObject
  • -SLA
  • -SLAAssignment
  • -PrimaryClusterID
  • -SLAID
  • -Server
  • -api
  • CommonParameters
  • INPUTS
  • OUTPUTS
  • NOTES
  • RELATED LINKS

Was this helpful?

  1. Command Documentation
  2. Reference

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

INPUTS

OUTPUTS

NOTES

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

RELATED LINKS

PreviousGet-RubrikVgfUpgradeReportNextGet-RubrikVMSnapshot

Last updated 4 years ago

Was this helpful?

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see .

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