Get-NAVWebServerInstanceConfiguration

Module:
NAVWebClientManagement Module

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

Syntax

Default (Default) 

Get-NAVWebServerInstanceConfiguration
    [-WebServerInstance] <String>
    [-KeyName] <String>
    [[-SiteDeploymentType] <String>]
    [[-ContainerSiteName] <String>]
    [<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.

Parameter properties

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

Parameter sets

(All)
Position:4
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-KeyName

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

Parameter properties

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

Parameter sets

(All)
Position:2
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

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

Parameter sets

(All)
Position:3
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WebServerInstance

Specifies the name of the web server instance in IIS.

Parameter properties

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

Parameter sets

(All)
Position:1
Mandatory:True
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.