Share via

Rename-NAVCompany

  • Reference
Module:
Microsoft.BusinessCentral.Management

Renames a company in a Business Central database.

Syntax

Rename-NAVCompany
      [-Tenant <TenantId>]
      [-CompanyName] <String>
      [-NewCompanyName] <String>
      [-ServerInstance] <String>
      [-Force]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

Use the Rename-NAVCompany cmdlet to rename a company in a Business Central database.

Examples

EXAMPLE 1

Rename-NAVCompany -ServerInstance 'BC' -CompanyName 'CRONUS International Ltd.' -NewCompanyName 'MyCompany' -Verbose

VERBOSE: NavCommand.BeginProcessing
VERBOSE: NavCommand.ProcessRecord
VERBOSE: Renaming company 'CRONUS International Ltd.' to 'MyCompany' ...

VERBOSE: Renaming of company 'CRONUS International Ltd.' to 'MyCompany' has completed successfully.
VERBOSE: NavCommand.EndProcessing

This example renames the CRONUS International Ltd. in the CRONUS database to MyCompany.

EXAMPLE 2

Rename-NAVCompany -ServerInstance 'BC' -CompanyName 'CRONUS International Ltd.' -NewCompanyName 'MyCompany' -ErrorLogFileName C:\NavDatabases\ErrorLog.txt

This example renames the company CRONUS International Ltd. in the CRONUS database to MyCompany. Errors are logged to the file C:\NavDatabases\ErrorLog.txt.

Parameters

-CompanyName

Specifies the name of the company that you want to rename. This must be an existing company in the specified Business Central database.

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

-Confirm

Prompts you for confirmation before executing the command.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Force

Forces the command to run without asking for user confirmation.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-NewCompanyName

Specifies the new name of the company.

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

-ServerInstance

Specifies the name of a Business Central Server instance, for example, BC or myinstance. You can specify either the full name of an instance, such as MicrosoftDynamicsNavServer$myinstance or the short name such as myinstance.

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

-Tenant

Specifies the ID of the tenant that the company is stored in, such as Tenant1.

This parameter is required unless the specified service instance is not configured to run multiple tenants.

Type:TenantId
Aliases:Id
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

Describes what would happen if you executed the command without actually executing the command.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False