New-RubrikSLA
SYNOPSIS
Creates a new Rubrik SLA Domain
SYNTAX
New-RubrikSLA [-Name] <String> [[-HourlyFrequency] <Int32>] [[-HourlyRetention] <Int32>]
[[-HourlyRetentionType] <String>] [[-DailyFrequency] <Int32>] [[-DailyRetention] <Int32>]
[[-DailyRetentionType] <String>] [[-WeeklyFrequency] <Int32>] [[-WeeklyRetention] <Int32>]
[[-DayOfWeek] <String>] [[-MonthlyFrequency] <Int32>] [[-MonthlyRetention] <Int32>] [[-DayOfMonth] <String>]
[[-MonthlyRetentionType] <String>] [[-QuarterlyFrequency] <Int32>] [[-QuarterlyRetention] <Int32>]
[[-DayOfQuarter] <String>] [[-FirstQuarterStartMonth] <String>] [[-QuarterlyRetentionType] <String>]
[[-YearlyFrequency] <Int32>] [[-YearlyRetention] <Int32>] [[-DayOfYear] <String>] [[-YearStartMonth] <String>]
[-AdvancedConfig] [[-BackupStartHour] <Int32>] [[-BackupStartMinute] <Int32>]
[[-BackupWindowDuration] <Int32>] [[-FirstFullBackupStartHour] <Int32>]
[[-FirstFullBackupStartMinute] <Int32>] [[-FirstFullBackupDay] <String>]
[[-FirstFullBackupWindowDuration] <Int32>] [-Archival] [[-LocalRetention] <Int32>]
[[-ArchivalLocationId] <String>] [[-PolarisID] <String>] [-InstantArchive] [-RetentionLock] [-Replication]
[[-ReplicationTargetId] <String>] [[-RemoteRetention] <Int32>] [[-Frequencies] <Object[]>]
[[-AdvancedFreq] <Object[]>] [[-BackupWindows] <Object[]>] [[-FirstFullBackupWindows] <Object[]>]
[[-ArchivalSpecs] <Object[]>] [[-ReplicationSpecs] <Object[]>] [[-Server] <String>] [[-api] <String>]
[-WhatIf] [-Confirm] [<CommonParameters>]DESCRIPTION
The New-RubrikSLA cmdlet will build a new SLA Domain to provide policy-driven control over protected objects within the Rubrik fabric.
EXAMPLES
EXAMPLE 1
New-RubrikSLA -SLA 'Test1' -HourlyFrequency 4 -HourlyRetention 7This will create an SLA Domain named "Test1" that will take a backup every 4 hours and keep those hourly backups for 7 days. Using the -SLA parameter alias
EXAMPLE 2
New-RubrikSLA -Name 'Test1' -HourlyFrequency 4 -HourlyRetention 7 -DailyFrequency 1 -DailyRetention 30This will create an SLA Domain named "Test1" that will take a backup every 4 hours and keep those hourly backups for 7 days while also keeping one backup per day for 30 days.
EXAMPLE 3
New-RubrikSLA -Name 'Test1' -HourlyFrequency 4 -HourlyRetention 7 -DailyFrequency 1 -DailyRetention 30 -RetentionLockThis will create an SLA Domain named "Test1" that will take a backup every 4 hours and keep those hourly backups for 7 days while also keeping one backup per day for 30 days and sets the SLA to Retention Locked.
EXAMPLE 4
New-RubrikSLA -Name 'Test1' -AdvancedConfig -HourlyFrequency 4 -HourlyRetention 7 -DailyFrequency 1 -DailyRetention 30 -WeeklyFrequency 1 -WeeklyRetention 4 -DayOfWeek Friday -YearlyFrequency 1 -YearlyRetention 3 -DayOfYear LastDay -YearStartMonth FebruaryThis will create an SLA Domain named "Test1" that will take a backup every 4 hours and keep those hourly backups for 7 days while also keeping one backup per day for 30 days, one backup per week for 4 weeks and one backup per year for 3 years. The weekly backups will be created on Fridays and the yearly backups will be created on January 31 because the year is set to start in February. The advanced SLA configuration can only be used with CDM version 5.0 and above.
EXAMPLE 5
New-RubrikSLA -Name 'Test1' -HourlyFrequency 4 -HourlyRetention 7 -DailyFrequency 1 -DailyRetention 30 -BackupStartHour 22 -BackupStartMinute 00 -BackupWindowDuration 8This will create an SLA Domain named "Test1" that will take a backup every 4 hours and keep those hourly backups for 7 days. Backups are allowed to run between 22:00 and 6:00AM.
EXAMPLE 6
New-RubrikSLA -Name 'Test1' -HourlyFrequency 4 -HourlyRetention 7 -DailyFrequency 1 -DailyRetention 30 -FirstFullBackupStartHour 21 -FirstFullBackupStartMinute 30 -FirstFullBackupWindowDuration 57 -FirstFullBackupDay FridayThis will create an SLA Domain named "Test1" that will take a backup every 4 hours and keep those hourly backups for 7 days. The first full backup is allowed to be taken between Friday 21:30 and Monday 6:30AM.
EXAMPLE 7
New-RubrikSLA -Name 'Test1' -HourlyFrequency 4 -HourlyRetention 7 -DailyFrequency 1 -DailyRetention 30 -Archival -ArchivalLocationId 53aef5df-b628-4b61-aade-6520a2a5ba4d -LocalRetention 14 -InstantArchiveThis will create an SLA Domain named "Test1" that will take a backup every 4 hours and keep those hourly backups for 7 days, while also keeping one backup per day for 30 days. At the same time, data is immediately copied to the specified archival location and will be kept there for 14 days.
EXAMPLE 8
New-RubrikSLA -SLA 'Test1' -HourlyFrequency 4 -HourlyRetention 7 -DailyFrequency 1 -DailyRetention 30 -Replication -ReplicationTargetId 8b4fe6f6-cc87-4354-a125-b65e23cf8c90 -RemoteRetention 5This will create an SLA Domain named "Test1" that will take a backup every 4 hours and keep those hourly backups for 7 days, while also keeping one backup per day for 30 days. At the same time, data is replicated to the specified target cluster and will be kept there for 5 days.
EXAMPLE 9
Get-RubrikSLA -Name 'SLA1' | New-RubrikSLA -Name 'CopySLA1'This will create a copy of an existing SLA named SLA1 and store it as CopySLA1
PARAMETERS
-Name
SLA Domain Name, either the -Name parameter or its parameter alias -SLA can be used to specify the name of the SLA
Type: String
Parameter Sets: (All)
Aliases: SLA
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False-HourlyFrequency
Hourly frequency to take snapshots
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False-HourlyRetention
Number of days or weeks to retain the hourly snapshots. For CDM versions prior to 5.0 this value must be set in days
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False-HourlyRetentionType
Retention type to apply to hourly snapshots when $AdvancedConfig is used. Does not apply to CDM versions prior to 5.0
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: Daily
Accept pipeline input: False
Accept wildcard characters: False-DailyFrequency
Daily frequency to take snapshots
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False-DailyRetention
Number of days or weeks to retain the daily snapshots. For CDM versions prior to 5.0 this value must be set in days
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False-DailyRetentionType
Retention type to apply to daily snapshots when $AdvancedConfig is used. Does not apply to CDM versions prior to 5.0
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 7
Default value: Daily
Accept pipeline input: False
Accept wildcard characters: False-WeeklyFrequency
Weekly frequency to take snapshots
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 8
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False-WeeklyRetention
Number of weeks to retain the weekly snapshots
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 9
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False-DayOfWeek
Day of week for the weekly snapshots when $AdvancedConfig is used. The default is Saturday. Does not apply to CDM versions prior to 5.0
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 10
Default value: Saturday
Accept pipeline input: False
Accept wildcard characters: False-MonthlyFrequency
Monthly frequency to take snapshots
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 11
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False-MonthlyRetention
Number of months, quarters or years to retain the monthly backups. For CDM versions prior to 5.0, this value must be set in years
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 12
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False-DayOfMonth
Day of month for the monthly snapshots when $AdvancedConfig is used. The default is the last day of the month. Does not apply to CDM versions prior to 5.0
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 13
Default value: LastDay
Accept pipeline input: False
Accept wildcard characters: False-MonthlyRetentionType
Retention type to apply to monthly snapshots. Does not apply to CDM versions prior to 5.0
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 14
Default value: Monthly
Accept pipeline input: False
Accept wildcard characters: False-QuarterlyFrequency
Quarterly frequency to take snapshots. Does not apply to CDM versions prior to 5.0
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 15
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False-QuarterlyRetention
Number of quarters or years to retain the monthly snapshots. Does not apply to CDM versions prior to 5.0
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 16
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False-DayOfQuarter
Day of quarter for the quarterly snapshots when $AdvancedConfig is used. The default is the last day of the quarter. Does not apply to CDM versions prior to 5.0
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 17
Default value: LastDay
Accept pipeline input: False
Accept wildcard characters: False-FirstQuarterStartMonth
Month that starts the first quarter of the year for the quarterly snapshots when $AdvancedConfig is used. The default is January. Does not apply to CDM versions prior to 5.0
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 18
Default value: January
Accept pipeline input: False
Accept wildcard characters: False-QuarterlyRetentionType
Retention type to apply to quarterly snapshots. The default is Quarterly. Does not apply to CDM versions prior to 5.0
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 19
Default value: Quarterly
Accept pipeline input: False
Accept wildcard characters: False-YearlyFrequency
Yearly frequency to take snapshots
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 20
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False-YearlyRetention
Number of years to retain the yearly snapshots
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 21
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False-DayOfYear
Day of year for the yearly snapshots when $AdvancedConfig is used. The default is the last day of the year. Does not apply to CDM versions prior to 5.0
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 22
Default value: LastDay
Accept pipeline input: False
Accept wildcard characters: False-YearStartMonth
Month that starts the first quarter of the year for the quarterly snapshots when $AdvancedConfig is used. The default is January. Does not apply to CDM versions prior to 5.0
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 23
Default value: January
Accept pipeline input: False
Accept wildcard characters: False-AdvancedConfig
Whether to turn advanced SLA configuration on or off. Does not apply to CDM versions prior to 5.0
Type: SwitchParameter
Parameter Sets: (All)
Aliases: showAdvancedUi
Required: False
Position: Named
Default value: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False-BackupStartHour
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 24
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False-BackupStartMinute
Minute of hour from which backups are allowed to run
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 25
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False-BackupWindowDuration
Number of hours during which backups are allowed to run
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 26
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False-FirstFullBackupStartHour
Hour from which the first full backup is allowed to run. Uses the 24-hour clock
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 27
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False-FirstFullBackupStartMinute
Minute of hour from which the first full backup is allowed to run
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 28
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False-FirstFullBackupDay
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 29
Default value: None
Accept pipeline input: False
Accept wildcard characters: False-FirstFullBackupWindowDuration
Number of hours during which the first full backup is allowed to run
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 30
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False-Archival
Whether to enable archival, does not take any input and should be used in combination with -ArchivalLocationId
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False-LocalRetention
Time in days to keep backup data locally on the cluster.
Type: Int32
Parameter Sets: (All)
Aliases: localRetentionLimit
Required: False
Position: 31
Default value: 0
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False-ArchivalLocationId
ID of the archival location
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 32
Default value: None
Accept pipeline input: False
Accept wildcard characters: False-PolarisID
Polaris Managed ID
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 33
Default value: None
Accept pipeline input: False
Accept wildcard characters: False-InstantArchive
Whether to enable Instant Archive
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False-RetentionLock
Whether a retention lock is active on this SLA, Does not apply to CDM versions prior to 5.2
Type: SwitchParameter
Parameter Sets: (All)
Aliases: isRetentionLocked
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False-Replication
Whether to enable replication
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False-ReplicationTargetId
ID of the replication target
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 34
Default value: None
Accept pipeline input: False
Accept wildcard characters: False-RemoteRetention
Time in days to keep data on the replication target.
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 35
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False-Frequencies
Retrieves frequencies from Get-RubrikSLA via the pipeline
Type: Object[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 36
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False-AdvancedFreq
Retrieves the advanced UI configuration parameters from Get-RubrikSLA via the pipeline
Type: Object[]
Parameter Sets: (All)
Aliases: advancedUiConfig
Required: False
Position: 37
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False-BackupWindows
Retrieves the allowed backup windows from Get-RubrikSLA via the pipeline
Type: Object[]
Parameter Sets: (All)
Aliases: allowedBackupWindows
Required: False
Position: 38
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False-FirstFullBackupWindows
Retrieves the allowed backup windows for the first full backup from Get-RubrikSLA via the pipeline
Type: Object[]
Parameter Sets: (All)
Aliases: firstFullAllowedBackupWindows
Required: False
Position: 39
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False-ArchivalSpecs
Retrieves the archical specifications from Get-RubrikSLA via the pipeline
Type: Object[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 40
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False-ReplicationSpecs
Retrieves the replication specifications from Get-RubrikSLA via the pipeline
Type: Object[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 41
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False-Server
Rubrik server IP or FQDN
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 42
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: 43
Default value: $global:RubrikConnection.api
Accept pipeline input: False
Accept wildcard characters: False-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False-Confirm
Prompts you for confirmation before running the cmdlet.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseCommonParameters
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/new-rubriksla
Last updated
Was this helpful?