sp_syspolicy_set_config_history_retention (Transact-SQL)

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

Transact-SQL Syntax Conventions

Syntax

sp_syspolicy_set_config_history_retention [ @value = ] value

Arguments

• [ @value= ] value
  Is the number of days to retain Policy-Based Management history. value is sqlvariant.

Return Code Values

0 (success) or 1 (failure)

Remarks

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'

Permissions

Requires membership in the PolicyAdministratorRole fixed database role.

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.

Examples

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

EXEC msdb.dbo.sp_syspolicy_set_config_history_retention @value = 28;

GO

See Also

Reference

Policy-Based Management Stored Procedures (Transact-SQL)

sp_syspolicy_configure (Transact-SQL)