Get-NAVCompany

Get-NAVCompany

Gets a list of the Microsoft Dynamics NAV companies in the specified tenant database.

Syntax

Parameter Set: __AllParameterSets
Get-NAVCompany [-ServerInstance] <String> [-Force] [-Tenant <TenantId> ] [ <CommonParameters>]

Detailed Description

Use the Get-NAVCompany cmdlet to extract a list of companies in the specified database. In the Microsoft Dynamics NAV 2013 R2 Administration Shell, you can create, rename, and remove companies by using the New-NAVCompany, Rename-NAVCompany, and Remove-NAVCompany cmdlets.

The following information is returned for each company:

Company name

Parameters

-Force

Forces the command to run without asking for user confirmation.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ServerInstance<String>

Specifies the Microsoft Dynamics NAV Server instance that the company uses, such as DynamicsNAV71. You can specify either the fully qualified name, such as 'MyServer$DynamicsNAV71', or the short name, such as 'DynamicsNAV71'.

Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

True (ByValue, ByPropertyName)

Accept Wildcard Characters?

false

-Tenant<TenantId>

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.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters.

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

  • System.String

    You can pipe the value of the ServerInstance parameter as a string to this cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

  • System.Data.DataRow

    Returns the company information as a data row for each company.

Examples

--------------------------EXAMPLE 1--------------------------

Description

-----------

This example creates a copy of the CRONUS International Ltd. company in the database that has the tenant ID CRONUS and which is mounted against the DynamicsNAV71 server instance.

PS C:\> Get-NAVCompany -ServerInstance DynamicsNAV71 -Tenant CRONUS