Set-SCOMHeartbeatSetting
Set-SCOMHeartbeatSetting
Modifies the agent and server heartbeat settings for a management group.
Syntax
Parameter Set: Empty
Set-SCOMHeartbeatSetting [-ComputerName <String[]> ] [-Credential <PSCredential> ] [-HeartbeatInterval <TimeSpan> ] [-MissingHeartbeatThreshold <Int32> ] [-PassThru] [-SCSession <Connection[]> ] [ <CommonParameters>]
Detailed Description
The Set-SCOMHeartbeatSetting cmdlet modifies the agent and server heartbeat settings for an System Center 2012 – 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
.
Parameters
-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 |
-HeartbeatInterval<TimeSpan>
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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-MissingHeartbeatThreshold<Int32>
Specifies an integer threshold. A management server ignores this many missing heartbeats before it raises an alert.
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 |
-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 |
<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: Modify the missing heartbeat threshold
This command sets the missing heartbeat threshold to five.
PS C:\> Set-SCOMHeartbeatSetting -MissingHeartbeatThreshold 5
Example 2: Modify the heartbeat interval
This command sets the heartbeat interval to 1 minute.
PS C:\> Set-SCOMHeartbeatSetting -HeartbeatInterval "0:01:00"