Get-NAVWebServerInstance

  • Reference
Module:
NAVWebClientManagement

Gets the information about the Business Central Web Server instances that are registered on a computer.

Syntax

Get-NAVWebServerInstance
   [[-WebServerInstance] <String>]
   [<CommonParameters>]

Description

You can use Get-NAVWebServerInstance cmdlet to get the following information about Business Central Web Server instances that are registered in IIS on the computer.

WebServerInstance: The name of the Business Central Web Server instance Uri: Unified Resource Locator of web server instance.

SiteDeploymentType: The deployment type of the web server instance. Possible values are: RootSite or SubSite Server: The computer that is running the Business Central Server that the Business Central Web Server instance connects to.

ServerInstance: The Business Central Server instance that the Business Central Web Server instance connects to.

ClientServicesPort: Specifies the listening TCP port for the Business Central Server instance that the Business Central Web Server instance connects to.

DNSIdenity: Specifies the subject name or common name of the service certificate for Business Central Server instance. This parameter is only relevant when the ClientServicesCredentialType in the Business Central Server instance configuration is set to UserName, NavUserPassword, or AccessControlService. These credential types requires that security certificates are used on the Business Central Web Server and Business Central Server instances to protect communication.

Configuration File: The location of the navsettings.json file that is used by the Business Central Web Server instance. Version: The platform version of the Business Central Web Server instance.

Examples

EXAMPLE 1

Get-NAVWebServerInstance -WebServerInstance BC

This example gets information about the Business Central Web Server instance that is named 'BC'.

Parameters

-WebServerInstance

Specifies the name of the Business Central Web Server instance that you want information about. If you omit this parameter, then the cmdlet returns information about all Business Central Web Server instances.

Type:String
Position:1
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False