Export (0) Print
Expand All

sp_syspolicy_set_config_history_retention (Transact-SQL)

Applies To: SQL Server 2014, SQL Server 2016 Preview

Topic Status: Some information in this topic is preview and subject to change in future releases. Preview information describes new features or changes to existing features in Microsoft SQL Server 2016 Community Technology Preview 2 (CTP2).

Specifies the number of days to keep policy evaluation history for Policy-Based Management.

Applies to: SQL Server (SQL Server 2008 through current version).

Topic link icon Transact-SQL Syntax Conventions

sp_syspolicy_set_config_history_retention [ @value = ] value

[ @value= ] value

Is the number of days to retain Policy-Based Management history. value is sqlvariant.

0 (success) or 1 (failure)

You must run sp_syspolicy_set_config_history_retention in the context of the msdb system database.

If value is set to 0, the history will not be automatically removed.

To view the current value for history retention, run the following query:

SELECT current_value FROM msdb.dbo.syspolicy_configuration
WHERE name = 'HistoryRetentionInDays'

Requires membership in the PolicyAdministratorRole fixed database role.

Security note Security Note

Possible elevation of credentials: Users in the PolicyAdministratorRole role can create server triggers and schedule policy executions that can affect the operation of the instance of the Database Engine. For example, users in the PolicyAdministratorRole role can create a policy that can prevent most objects from being created in the Database Engine. Because of this possible elevation of credentials, the PolicyAdministratorRole role should be granted only to users who are trusted with controlling the configuration of the Database Engine.

The following example sets the policy evaluation history retention to 28 days.

EXEC msdb.dbo.sp_syspolicy_set_config_history_retention @value = 28;

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

© 2015 Microsoft