Set-SCDWRetentionPeriod

Reference

Module:: Microsoft.EnterpriseManagement.Warehouse.Cmdlets

Sets the data retention period for a fact table.

Syntax

Set-SCDWRetentionPeriod
   [-DurationInMinutes <Int32>]
   [-EntityName <String>]
   [-ComputerName <String>]
   [-Credential <PSCredential>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-SCDWRetentionPeriod
   [-DurationInMinutes <Int32>]
   [-EntityName <String>]
   [-DatamartComputerName] <String>
   [-DatamartDatabaseName] <String>
   [-ComputerName <String>]
   [-Credential <PSCredential>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Set-SCDWRetentionPeriod cmdlet sets the data retention period, in minutes, for either a specific fact table within a specific data warehouse database or the default for fact tables within the database. Data that is eligible for grooming and older than the retention period will be groomed out of the database.

Note

This cmdlet has a bug and does not set the data retention period correctly. See detailed information.

Examples

Example 1: Set a retention period

PS C:\>Set-SCDWRetentionPeriod -ComputerName "serverDW72" -DatamartComputerName "serverDW72" -DatamartDatabaseName "CMDWDataMart" -EntityName
"ComputerHasSoftwareUpdateInstalledFact" -DurationInMinutes 1576800

This command sets a retention period.

Parameters

-ComputerName

Specifies the name of the computer on which the System Center Data Access service is running. The user account that is defined in the Credential parameter must have access rights to the specified computer. You can omit this parameter only if the System Center Data Access Service is running on the same computer that has Service Manager installed.

Type:	String
Aliases:	CN
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Credential

Specifies the credentials to use when you are connecting to the server on which the System Center Data Access service is running. The user account that is provided must have access to that server.

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

-DatamartComputerName

Specifies the name of the computer on which the datamart resides. This is usually the SQL database server that services the data warehouse. If a value is not provided, the value is discovered by inspecting the warehouse configuration.

Type:	String
Position:	2
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-DatamartDatabaseName

Specifies the name of the datamart database. This is typically the SQL database server that services the data warehouse. The default value is the warehouse repository. You can retrieve the entities from the Staging or DataMart databases to provide a value for this parameter.

Type:	String
Position:	3
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-DurationInMinutes

Specifies the duration, in minutes, before the entity is groomed.

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

-EntityName

Specifies the entity on which to set the data retention period. You can use the Get-SCDWEntity cmdlet to retrieve entity names. To set the default for all fact tables, omit the EntityName parameter.

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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

None.

You cannot pipe input to this cmdlet.

Outputs