Share via

Restart-NAVServerInstance

Module:
Microsoft.Dynamics.Nav.Management Module

Restarts a Business Central Server instance.

Syntax

Default (Default) 

Restart-NAVServerInstance
    [-ServerInstance] <String>
    [-Force]
    [-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.

Parameter properties

Type:SwitchParameter
Default value:None
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

-Force

Forces the command to run without asking for user confirmation.

Parameter properties

Type:SwitchParameter
Default value:False
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

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

Parameter properties

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

Parameter sets

(All)
Position:0
Mandatory:True
Value from pipeline:True
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:None
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.

Inputs

System.String

By value and property name: ServerInstance

Outputs

System.String