Skip to content

Latest commit

 

History

History
76 lines (57 loc) · 3.03 KB

File metadata and controls

76 lines (57 loc) · 3.03 KB
title sp_syspolicy_purge_history (Transact-SQL) | Microsoft Docs
ms.custom
ms.date 03/14/2017
ms.prod sql
ms.prod_service database-engine
ms.reviewer
ms.technology system-objects
ms.topic language-reference
f1_keywords
sp_syspolicy_purge_history_TSQL
sp_syspolicy_purge_history
dev_langs
TSQL
helpviewer_keywords
sp_syspolicy_purge_history
ms.assetid 6db414e7-4946-4bd2-8264-6b490810b306
author VanMSFT
ms.author vanto

sp_syspolicy_purge_history (Transact-SQL)

[!INCLUDEtsql-appliesto-ss2008-xxxx-xxxx-xxx-md]

Removes the policy evaluation history according to the history retention interval setting.

Topic link icon Transact-SQL Syntax Conventions

Syntax

  
sp_syspolicy_purge_history  

Arguments

This stored procedure has no parameters.

Return Code Values

0 (success) or 1 (failure)

Remarks

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

To view the history retention interval, you can use the following query:

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

Note

If the history retention interval is set to 0, policy evaluation history will not be removed.

Permissions

Requires membership in the PolicyAdministratorRole fixed database role.

Important

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 [!INCLUDEssDE]. For example, users in the PolicyAdministratorRole role can create a policy that can prevent most objects from being created in the [!INCLUDEssDE]. 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 [!INCLUDEssDE].

Examples

The following example removes the policy evaluation history.

EXEC msdb.dbo.sp_syspolicy_purge_history;  
  
GO  

See Also

Policy-Based Management Stored Procedures (Transact-SQL)
sp_syspolicy_set_config_history_retention (Transact-SQL)
sp_syspolicy_delete_policy_execution_history (Transact-SQL)