Get-NAVTenant

  • Article

Get-NAVTenant

Gets the tenants that are mounted against the specified Microsoft Dynamics NAV Server instance.

Syntax

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

Detailed Description

Gets the tenants that are mounted against the specified Microsoft Dynamics NAV Server instance. You can use the Mount-NAVTenant and Dismount-NAVTenant cmdlets to mount and dismount tenants.

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 you want to get tenant information from, 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 specific tenant that you want to get information about, such as Tenant1. If you do not set the Tenant parameter, the Get-NAVTenant cmdlet returns all tenants that are mounted against the Microsoft Dynamics NAV Server instance.

Aliases

Id

Required?

false

Position?

2

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 ServerInstance as a string to this cmdlet.

Outputs

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

  • Microsoft.Dynamics.Nav.Types.NavTenantSettings

    Returns a Microsoft.Dynamics.Nav.Types.NavTenantSettings object for each tenant. The following information is returned:

    ServerInstance
    State
    Id
    DatabaseName
    DatabaseServer
    AlternateId
    AllowAppDatabaseWrite
    NasServicesEnabled
    DefaultCompany
    DefaultTimeZone

Examples

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

Description

-----------

This example gets the tenant information from the DynamicsNAV71Microsoft Dynamics NAV Server instance. The output is a list of the tenant information about all mounted tenants.

PS C:\> Get-NAVTenant –ServerInstance 'DynamicsNAV71'

State                  : Mounted

ServerInstance         : MicrosoftDynamicsNavServer$DynamicsNAV71

Id                     : Tenant1

DatabaseName           : Demo Database NAV (7-1)

DatabaseServer         : localhost

AlternateIds           : {}

AllowAppDatabaseWrites : True

NasServicesEnabled     : False

DefaultCompany         : 

DefaultTimeZone        : UTC