Get-RubrikHvmFormatReport

SYNOPSIS

Retrieves backup format report on one or more Hyper-V Virtual Machines known to a Rubrik cluster

SYNTAX

Get-RubrikHvmFormatReport [[-name] <String>] [-NamePrefix <String>] [-hostname <String>]
 [-HostnamePrefix <String>] [-Relic] [-SLA <String>] [-PrimaryClusterID <String>] [-id <String>]
 [-SLAID <String>] [-LatestSnapshotFormat <String>] [-SetToUpgrade] [-Server <String>] [-api <String>]
 [<CommonParameters>]

DESCRIPTION

The Get-RubrikHvmFormatReport cmdlet is used to pull the backup format report from a Rubrik cluster on any number of Hyper-V Virtual Machines.

EXAMPLES

EXAMPLE 1

Get-RubrikHvmFormatReport -Hostname 'Server1'

This will return backup format report on all Hyper-V Virtual Machines from host "Server1".

EXAMPLE 2

Get-RubrikHvmFormatReport -Hostname 'Server1' -SLA Gold

This will return backup format report on all Hyper-V Virtual Machines of "Server1" that are protected by the Gold SLA Domain.

EXAMPLE 3

Get-RubrikHvmFormatReport -Relic

This will return backup format report on all removed Hyper-V Virtual Machines that were formerly protected by Rubrik.

EXAMPLE 4

OR <fastvhdx>

Get-RubrikHvmFormatReport -LatestSnapshotFormat fastvhdx This will return backup format report on all removed Hyper-V Virtual Machines that were formerly protected by Rubrik.

EXAMPLE 5

Get-RubrikHvmFormatReport -Id HypervVirtualMachine:::205b0b65-b90c-48c5-9cab-66b95ed18c0f

This will return backup format report for the specified HypervVirtualMachine ID

PARAMETERS

-name

Name of the Hyper-V Virtual Machine

Type: String
Parameter Sets: (All)
Aliases: HypervVirtualMachine

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

-NamePrefix

Prefix of Hyper-V Virtual Machine names

Type: String
Parameter Sets: (All)
Aliases:

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

-hostname

Filter results by hostname

Type: String
Parameter Sets: (All)
Aliases:

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

-HostnamePrefix

Prefix of host names

Type: String
Parameter Sets: (All)
Aliases:

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

-Relic

Filter results to include only relic (removed) Hyper-V Virtual Machines

Type: SwitchParameter
Parameter Sets: (All)
Aliases: is_relic

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

-SLA

SLA Domain policy assigned to the Hyper-V Virtual Machine

Type: String
Parameter Sets: (All)
Aliases:

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

-PrimaryClusterID

Filter the report 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: (All)
Aliases: primary_cluster_id

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

-id

Hyper-V Virtual Machine id

Type: String
Parameter Sets: (All)
Aliases:

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

-SLAID

SLA id value

Type: String
Parameter Sets: (All)
Aliases: effective_sla_domain_id

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

-LatestSnapshotFormat

Filter the report based on whether the Hyper-V Virtual Machine used fast VHDX format for its latest snapshot.

Type: String
Parameter Sets: (All)
Aliases:

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

-SetToUpgrade

Filter the report based on whether a Hyper-V Virtual Machine is set to take a full snapshot on the next backup.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: ForceFull

Required: False
Position: Named
Default value: False
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 Abhinav Prakash for community usage github: ab-prakash

RELATED LINKS

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