Share via

Stop-NAVServerInstance

  • Reference
Module:
Microsoft.BusinessCentral.Management

Stops a Business Central Server instance.

Syntax

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

Description

The Stop-NAVServerInstance cmldet stops a server instance. Be aware that when you stop 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 Set-NAVServerInstance.

Examples

EXAMPLE 1

Stop-NAVServerInstance -ServerInstance NavServer -Verbose

This example uses the Stop-NAVServerInstance cmdlet to stop 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