Set-SCOMDatabaseGroomingSetting

Set-SCOMDatabaseGroomingSetting

Modifies database grooming settings for a management group.

Syntax

Parameter Set: Empty
Set-SCOMDatabaseGroomingSetting [-AlertDaysToKeep <Byte> ] [-AvailabilityHistoryDaysToKeep <Byte> ] [-ComputerName <String[]> ] [-Credential <PSCredential> ] [-EventDaysToKeep <Byte> ] [-JobStatusDaysToKeep <Byte> ] [-MaintenanceModeHistoryDaysToKeep <Byte> ] [-MonitoringJobDaysToKeep <Byte> ] [-PassThru] [-PerformanceDataDaysToKeep <Byte> ] [-SCSession <Connection[]> ] [-StateChangeEventDaysToKeep <Byte> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed Description

The Set-SCOMDatabaseGroomingSetting cmdlet modifies database grooming settings for a management group. Database grooming automatically removes unnecessary data from the System Center 2012 – Operations Manager database in order to maintain performance.

You can specify how long, in days, to keep the following items:

-- Resolved alerts
-- Availability history
-- Event data
-- Task history
-- Maintenance mode history
-- Monitoring job data
-- Performance data
-- State change data

Use the Get-SCOMDatabaseGroomingSetting cmdlet to see the current values for these settings.

By default, this cmdlet uses the active persistent connection to a management group. Use the SCSession parameter to specify a different persistent connection. You can create a temporary connection to a management group by using the ComputerName and Credential parameters. For more information, type Get-Help about_OpsMgr_Connections.

Parameters

-AlertDaysToKeep<Byte>

Specifies the number of days to keep resolved alerts.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-AvailabilityHistoryDaysToKeep<Byte>

Specifies the number of days to keep availability history.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-ComputerName<String[]>

Specifies an array of names of computers. The cmdlet establishes temporary connections with management groups for these computers. You can use NetBIOS names, IP addresses, or fully qualified domain names (FQDNs). To specify the local computer, type the computer name, localhost, or a dot (.).

The System Center Data Access service must be running on the computer. If you do not specify a computer, the cmdlet uses the computer for the current management group connection.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

-Credential<PSCredential>

Specifies a PSCredential object for the management group connection. To obtain a PSCredential object, use the Get-Credential cmdlet. For more information, type Get-Help Get-Credential.

If you specify a computer in the ComputerName parameter, use an account that has access to that computer. The default is the current user.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

-EventDaysToKeep<Byte>

Specifies the number of days to keep event data.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-JobStatusDaysToKeep<Byte>

Specifies the number of days to keep task history.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-MaintenanceModeHistoryDaysToKeep<Byte>

Specifies the number of days to keep maintenance mode history.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-MonitoringJobDaysToKeep<Byte>

Specifies the number of days to keep monitoring job data.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-PassThru

Indicates that the cmdlet creates or modifies an object that a command can use in the pipeline. By default, this cmdlet does not generate any output.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-PerformanceDataDaysToKeep<Byte>

Specifies the number of days to keep performance data.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-SCSession<Connection[]>

Specifies an array of Connection objects. To obtain a Connection object, use the Get-SCOMManagementGroupConnection cmdlet.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

-StateChangeEventDaysToKeep<Byte>

Specifies the number of days to keep state change data.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-Confirm

Prompts you for confirmation before running the cmdlet.

Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WhatIf

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

Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

Examples

Example 1: Set days to keep resolved alerts

This command sets the number of days to keep resolved alerts to 21.

PS C:\> Set-SCOMDatabaseGroomingSetting -AlertDaysToKeep 21

Example 2: Set days to keep availability history

This command sets the number of days to keep availability history to 10.

PS C:\> Set-SCOMDatabaseGroomingSetting -AvailabilityHistoryDaysToKeep 10

Get-SCOMDatabaseGroomingSetting

Get-SCOMManagementGroupConnection