Share via

Set-NAVWebServerInstanceConfiguration

  • Reference
Module:
Microsoft.Dynamics.Nav.Management

Changes configuration values for a named web server instance.

Syntax

Set-NAVWebServerInstanceConfiguration
   [-WebServerInstance] <String>
   [-KeyName] <String>
   [-KeyValue] <String>
   [[-SiteDeploymentType] <String>]
   [[-ContainerSiteName] <String>]
   [<CommonParameters>]

Description

Use this cmdlet to change configuration values for a named web server instance. These values are written directly to the configuration file. The changes will be applied to the web server automatically since the application pool detects the configuration change and performs a recycle. When the application pool is recycled by the IIS, static state such as client sessions in the Microsoft Dynamics NAV Web client will be lost.

Examples

EXAMPLE 1

Set-NAVWebServerInstanceConfiguration -WebServerInstance DynamicsNAV -KeyName CompanyName -KeyValue "CRONUS International Ltd."

This example sets the web server instance configuration.

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 'Microsoft Dynamics NAV [Version] Web Client' then you can omit this parameter.

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

-KeyName

Specifies the configuration key name.

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

-KeyValue

Specifies the configuration key value.

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

-SiteDeploymentType

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

  • Use SubSite if the web server instance was created as a subsite (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 'Microsoft Dynamics NAV [Version] Web Client' then you can omit this parameter.
  • RootSite if the web server instance was created as a root-level website.
Type:String
Position:4
Default value:SubSite
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WebServerInstance

Specifies the name of a Dynamics NAV web server instance for which to return the information.

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

Inputs

System.String

You can pipe a string that contains a Microsoft Dynamics NAV web server instance name to the cmdlet.

Outputs

None