< Back
Restart-PrtgCore
Post
NAME Restart-PrtgCore
SYNOPSIS
Restarts the PRTG Core Service of a PRTG Network Monitor server.
SYNTAX
Restart-PrtgCore [-Force <SwitchParameter>] [-Timeout <int>] [-Wait <SwitchParameter>] [<CommonParameters>]
DESCRIPTION
The Restart-PrtgCore cmdlet restarts the PRTG Core Service of a PRTG Network Monitor Server. Upon restarting the
service, all monitoring will cease functioning and all users will be completely disconnected. If PRTG is in a
cluster setup, this cmdlet will only restart the PRTG Core Service of the server PrtgAPI is connected to.
When executed, Restart-PrtgCore will prompt to confirm you wish to restart the PRTG Core Service. To override this
prompt, the -Force parameter can be specified.By default, Restart-PrtgCore will one hour for the PRTG Core Service
to completely restart and come back online. If you do not wish to wait at all, this can be overridden by
specifying -Wait:$false. You may additionally specify a custom timeout duration (in seconds) via the -Timeout
parameter. If Restart-PrtgCore times out waiting for the PRTG Core Service to restart, a TimeoutException will be
thrown. Extreme caution should be used when using Restart-PrtgCore. While smaller PRTG installs can restart in a
matter of minutes, servers containing in excess of 10,000 sensors can take over half an hour to restart.
PARAMETERS
-Force <SwitchParameter>
Forces the PRTG Core Service to be restarted without displaying a confirmation prompt.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-Wait <SwitchParameter>
Wait for the PRTG Core Service to restart before ending the cmdlet. By default this value is true.
Required? false
Position? named
Default value True
Accept pipeline input? false
Accept wildcard characters? false
-Timeout <int>
Duration (in seconds) to wait for the PRTG Core Service to restart. Default value is 3600 (1 hour). If Wait is
false, this parameter will have no effect.
Required? false
Position? named
Default value 3600
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
---------- EXAMPLE 1 ----------
C:\\> Restart-PrtgCore
Restart the PRTG Core Service. The cmdlet will wait up to 60 minutes for the service to restart.
---------- EXAMPLE 2 ----------
C:\\> Restart-PrtgCore -Wait:$false
Restart the PRTG Core Service, without waiting for the service to restart before ending the cmdlet.
---------- EXAMPLE 3 ----------
C:\\> Restart-PrtgCore -Timeout 600
Restart the PRTG Core Service, waiting 10 minutes (600 seconds) for the service to restart.
RELATED LINKS
Online version: https://github.com/lordmilko/PrtgAPI/wi ... -service-1
Restart-Probe
SYNOPSIS
Restarts the PRTG Core Service of a PRTG Network Monitor server.
SYNTAX
Restart-PrtgCore [-Force <SwitchParameter>] [-Timeout <int>] [-Wait <SwitchParameter>] [<CommonParameters>]
DESCRIPTION
The Restart-PrtgCore cmdlet restarts the PRTG Core Service of a PRTG Network Monitor Server. Upon restarting the
service, all monitoring will cease functioning and all users will be completely disconnected. If PRTG is in a
cluster setup, this cmdlet will only restart the PRTG Core Service of the server PrtgAPI is connected to.
When executed, Restart-PrtgCore will prompt to confirm you wish to restart the PRTG Core Service. To override this
prompt, the -Force parameter can be specified.By default, Restart-PrtgCore will one hour for the PRTG Core Service
to completely restart and come back online. If you do not wish to wait at all, this can be overridden by
specifying -Wait:$false. You may additionally specify a custom timeout duration (in seconds) via the -Timeout
parameter. If Restart-PrtgCore times out waiting for the PRTG Core Service to restart, a TimeoutException will be
thrown. Extreme caution should be used when using Restart-PrtgCore. While smaller PRTG installs can restart in a
matter of minutes, servers containing in excess of 10,000 sensors can take over half an hour to restart.
PARAMETERS
-Force <SwitchParameter>
Forces the PRTG Core Service to be restarted without displaying a confirmation prompt.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-Wait <SwitchParameter>
Wait for the PRTG Core Service to restart before ending the cmdlet. By default this value is true.
Required? false
Position? named
Default value True
Accept pipeline input? false
Accept wildcard characters? false
-Timeout <int>
Duration (in seconds) to wait for the PRTG Core Service to restart. Default value is 3600 (1 hour). If Wait is
false, this parameter will have no effect.
Required? false
Position? named
Default value 3600
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
---------- EXAMPLE 1 ----------
C:\\> Restart-PrtgCore
Restart the PRTG Core Service. The cmdlet will wait up to 60 minutes for the service to restart.
---------- EXAMPLE 2 ----------
C:\\> Restart-PrtgCore -Wait:$false
Restart the PRTG Core Service, without waiting for the service to restart before ending the cmdlet.
---------- EXAMPLE 3 ----------
C:\\> Restart-PrtgCore -Timeout 600
Restart the PRTG Core Service, waiting 10 minutes (600 seconds) for the service to restart.
RELATED LINKS
Online version: https://github.com/lordmilko/PrtgAPI/wi ... -service-1
Restart-Probe