Share via


Set-SCOMDatabaseGroomingSetting

Modifies database grooming settings for a management group.

Syntax

Default (Default)

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

Description

The Set-SCOMDatabaseGroomingSetting cmdlet modifies database grooming settings for a management group. Database grooming automatically removes unnecessary data from the System Center - 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.

Examples

Example 1: Set days to keep resolved alerts

PS C:\>Set-SCOMDatabaseGroomingSetting -AlertDaysToKeep 21

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

Example 2: Set days to keep availability history

PS C:\>Set-SCOMDatabaseGroomingSetting -AvailabilityHistoryDaysToKeep 10

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

Parameters

-AlertDaysToKeep

Specifies the number of days to keep resolved alerts.

Parameter properties

Type:Byte
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-AvailabilityHistoryDaysToKeep

Specifies the number of days to keep availability history.

Parameter properties

Type:Byte
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-ComputerName

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.

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Credential

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.

Parameter properties

Type:PSCredential
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-EventDaysToKeep

Specifies the number of days to keep event data.

Parameter properties

Type:Byte
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-JobStatusDaysToKeep

Specifies the number of days to keep task history.

Parameter properties

Type:Byte
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-MaintenanceModeHistoryDaysToKeep

Specifies the number of days to keep maintenance mode history.

Parameter properties

Type:Byte
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-MonitoringJobDaysToKeep

Specifies the number of days to keep monitoring job data.

Parameter properties

Type:Byte
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments: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.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-PerformanceDataDaysToKeep

Specifies the number of days to keep performance data.

Parameter properties

Type:Byte
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-PerformanceSignatureDaysToKeep

The Set-SCOMDatabaseGroomingSetting cmdlet modifies database grooming settings for a management group. Database grooming automatically removes unnecessary data from the System Center - 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.

Parameter properties

Type:Byte
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-SCSession

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

Parameter properties

Type:

Connection[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-StateChangeEventDaysToKeep

Specifies the number of days to keep state change data.

Parameter properties

Type:Byte
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-WhatIf

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

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.