Dismount-NAVTenant
Dismount-NAVTenant
Dismounts a tenant on the specified Microsoft Dynamics NAV Server instance. All active user sessions that access the tenant will end.
Syntax
Parameter Set: __AllParameterSets
Dismount-NAVTenant [-ServerInstance] <String> [-Tenant] <TenantId> [-DoNotSaveConfiguration] [-Force] [-InputObject <NavTenantRuntimeSettings> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
Use the Dismount-NAVTenant cmdlet to dismount a tenant on the specified Microsoft Dynamics NAV Server instance. All active user sessions that access the tenant will end.
Parameters
-DoNotSaveConfiguration
Specifies if the configuration must not be saved when the cmdlet has completed the task. If the parameter is not set, the configuration settings are automatically saved.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-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 |
-InputObject<NavTenantRuntimeSettings>
Specifies the Microsoft.Dynamics.Nav.Types.NavTenantSettings object that identifies the tenant that you want to dismount. You can pass this object from the Tenant parameter on the Get-NAVTenant cmdlet to the Dismount-NAVTenant cmdlet.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-ServerInstance<String>
Specifies the Microsoft Dynamics NAV Server instance that the tenant database is mounted against, 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 you want to dismount from the Microsoft Dynamics NAV Server instance, such as Tenant1.
Aliases |
Id |
Required? |
true |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Confirm
Prompts you for confirmation before running the cmdlet.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
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 pass the value of the ServerInstance parameter as a string to this cmdlet.
Microsoft.Dynamics.Nav.Types.NavTenantSetting
You can pass a Microsoft.Dynamics.Nav.Types.NavTenantSettings object from the Tenant parameter on the Get-NAVTenant cmdlet to the Dismount-NAVTenant cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
Microsoft.Dynamics.Nav.Types.NavTenantSetting
If the InputObject parameter has been bound to a value, it will be passed through to the pipeline. Otherwise no output value is returned.
Examples
--------------------------EXAMPLE 1--------------------------
Description
-----------
This example dismounts the tenant Test from the specified server instance.
PS C:\> Dismount-NAVTenant DynamicsNAV71 -Tenant 'Test'
--------------------------EXAMPLE 2--------------------------
Description
-----------
This example dismounts the tenant Test from the specified server instance without being explicit about parameter names.
PS C:\> Dismount-NAVTenant DynamicsNAV71 Test
--------------------------EXAMPLE 3--------------------------
Description
-----------
This example gets the tenant information from the DynamicsNAV71Microsoft Dynamics NAV Server instance and passes the information to the Dismount-NAVTenant cmdlet. The tenant default is then dismounted.
The output is a list of the tenant information about all dismounted tenants.
PS C:\> Get-NAVTenant DynamicsNAV71 | Dismount-NAVTenant