Share via

Get-NAVWebServerInstanceConfiguration

  • Reference
Module:
NAVWebClientManagement

Gets a specific configuration value for a Business Central Web Server instance.

Syntax

Get-NAVWebServerInstanceConfiguration
   [-WebServerInstance] <String>
   [-KeyName] <String>
   [[-SiteDeploymentType] <String>]
   [[-ContainerSiteName] <String>]
   [-ProgressAction <ActionPreference>]
   [<CommonParameters>]

Description

Use this cmdlet to get the value of a setting in the configuration file (navsettings.json) for a web server instance. The settings in the navsettings.json are defined by a key-value pair.

Examples

EXAMPLE 1

Get-NAVWebServerInstanceConfiguration -WebServerInstance BC -KeyName ClientServicesCredentialType

This example reads 'ClientServicesCredentialType' confgiration value.

Parameters

-ContainerSiteName

Specifies the name of the container website that the SubSite-type web server instance belongs to. This setting is only used if SiteDeploymentType has been set to 'SubSite'. If the subsite is under the default container website 'Business Central [Version] Web Client' then you can omit this parameter.

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

-KeyName

Specifies the configuration key name as it appears in the web server instance's configuration file.

Type:String
Position:2
Default value:None
Required:True
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

-SiteDeploymentType

Specifies the deployment type of web server instance. There are two possible values: RootSite and SubSite.

  • Use SubSite if the web server instance was created as a sub-site (web application) to a container website. If you specify SubSite, you will have to set the -ContainerSiteName parameter. If the subsite is under the default container website 'Business Central [Version] Web Client' then you can omit this parameter.
  • RootSite is the web server instance was created as a root-level website.
Type:String
Position:3
Default value:SubSite
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WebServerInstance

Specifies the name of the web server instance in IIS.

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