Remove-NAVServerSession
Remove-NAVServerSession
Closes the specified client connection to a Microsoft Dynamics NAV Server instance.
Syntax
Parameter Set: __AllParameterSets
Remove-NAVServerSession [-ServerInstance] <String> -SessionId <Int32> [-Force] [-Tenant <TenantId> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
Use the Remove-NAVServerSession cmdlet to close a client connection, as identified by the SessionId parameter. You can use the Get-NAVServerSession cmdlet to obtain information about current Microsoft Dynamics NAV sessions.
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 DynamicsNAV90. You can specify either the fully qualified name, such as 'MyServer$DynamicsNAV90 ', or the short name, such as 'DynamicsNAV90'.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue, ByPropertyName) |
Accept Wildcard Characters? |
false |
-SessionId<Int32>
A number that identifies a Microsoft Dynamics NAV Server session. You can obtain a list of current sessions using the Get-NAVServerSession cmdlet.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Tenant<TenantId>
Specifies the ID of the tenant you want to remove the connection from, such as Tenant1. This parameter is required unless the specified service instance is not configured to run multiple tenants.
Aliases |
Id |
Required? |
false |
Position? |
named |
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 pipe a string that contains a Microsoft Dynamics NAV Server instance name to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
None
This cmdlet does not generate any output.
Examples
-------------------------- EXAMPLE 1 --------------------------
Description
-----------
This example closes the session with Session ID 11 in the on the DynamicsNAV90 instance.
PS C:\Windows\system32> Remove-NAVServerSession -ServerInstance DynamicsNAV90 -Tenant default -SessionId 11