Share via

Restart-NAVServerInstance

  • Reference
Module:
Microsoft.BusinessCentral.Management

Restarts a Business Central Server instance.

Syntax

Restart-NAVServerInstance
       [-ServerInstance] <String>
       [-Force]
       [-ProgressAction <ActionPreference>]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]

Description

The Restart-NAVServerInstance cmldet stops a server instance, and then starts it again, similar to running the Stop-NAVServerInstance and Start-NAVServerInstance cmdlets in sequence. You will typically use the Restart-NAVServerInstance cmdlet after you make changes to the server instance configuration using the Set-NAVServerConfiguration cmdlet, because most configuration changes will not take effect until the server instance is restarted.

Be aware that when you restart the server instance, all client connections to the server instance are terminated.

The output of this cmdlet is the server information, which can be piped into other cmdlets such as Mount-NAVTenant.

Examples

EXAMPLE 1

Restart-NAVServerInstance -ServerInstance NavServer -Verbose

This example uses the Restart-NAVServerInstance cmdlet to restart a Business Central Server instance named 'NavServer'. The -Verbose parameter specifies that progress information is to be written to the console.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

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

-Force

Forces the command to run without asking for user confirmation.

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

-ProgressAction

A common PowerShell parameter that determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider. Learn more.

Type:ActionPreference
Aliases:proga
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ServerInstance

Specifies the name of a Business Central Server instance, for example, BC or myinstance. You can specify either the full name of an instance, such as MicrosoftDynamicsNavServer$myinstance or the short name, such as myinstance.

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:True
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:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

System.String

By value and property name: ServerInstance

Outputs

System.String