Remove-NAVWebServerInstance

  • Reference
Module:
NAVWebClientManagement

Removes an existing Business Central web server instance.

Syntax

Remove-NAVWebServerInstance
      [-WebServerInstance] <String>
      [[-SiteDeploymentType] <String>]
      [[-ContainerSiteName] <String>]
      [-RemoveContainer]
      [-ProgressAction <ActionPreference>]
      [<CommonParameters>]

Description

The Business Central Web, Phone, and Tablet clients use a Business Central Web Server instance on IIS. Use the Remove-NAVWebServerInstance cmdlet to delete a specific web server instance. The cmdlet deletes all subfolders, web applications, and components that are associated with the web server instance.

Examples

EXAMPLE 1

Remove-NAVWebServerInstance -WebServerInstance BC -SiteDeploymentType RootSite

This example removes a root-level web server instance.

EXAMPLE 2

Remove-NAVWebServerInstance -WebServerInstance BC

This example removes a web server instance that was created as a SubSite type.

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:3
Default value:None
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

-RemoveContainer

Specifies to remove the container website that the SubSite web server instance belongs to. This will remove all folders and subsites (web applications) of the container website.

Type:SwitchParameter
Position:Named
Default value:False
Required:False
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 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.
  • Use RootSite if the web server instance was created as a root-level website. If you use this value, all folders and subsites of the instance will be removed.
Type:String
Position:2
Default value:SubSite
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WebServerInstance

Specifies the name of the web server instance in IIS that you want to remove.

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