Set-SCOMHeartbeatSetting

  • Reference
Module:
OperationsManager

Modifies the agent and server heartbeat settings for a management group.

Syntax

Set-SCOMHeartbeatSetting
   [-PassThru]
   [-MissingHeartbeatThreshold <Int32>]
   [-HeartbeatInterval <TimeSpan>]
   [-SCSession <Connection[]>]
   [-ComputerName <String[]>]
   [-Credential <PSCredential>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Set-SCOMHeartbeatSetting cmdlet modifies the agent and server heartbeat settings for an System Center - Operations Manager management group. You can set the heartbeat interval and the missing heartbeat threshold.

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: Modify the missing heartbeat threshold

PS C:\>Set-SCOMHeartbeatSetting -MissingHeartbeatThreshold 5

This command sets the missing heartbeat threshold to five.

Example 2: Modify the heartbeat interval

PS C:\>Set-SCOMHeartbeatSetting -HeartbeatInterval "0:01:00"

This command sets the heartbeat interval to 1 minute.

Parameters

-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.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters: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.

Type:PSCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-HeartbeatInterval

Specifies an interval as a TimeSpan object. To obtain a TimeSpan object, use the Get-TimeSpan cmdlet. For more information, type Get-Help Get-TimeSpan. This interval is the number of minutes between heartbeats.

Type:TimeSpan
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-MissingHeartbeatThreshold

Specifies an integer threshold. A management server ignores this many missing heartbeats before it raises an alert.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:True
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.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-SCSession

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

Type:Connection[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

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

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False