Remove-NAVServerSession

  • Article

Remove-NAVServerSession

Closes a client connection, as identified by the ConnectionId.

Syntax

Parameter Set: __AllParameterSets
Remove-NAVServerSession [-ServerInstance] <String> -SessionId <Int32> [ <CommonParameters>]

Detailed Description

Use the Remove-NAVServerSession cmdlet to close a client connection, as identified by the ConnectionId. You can use the Get-NAVServerSession cmdlet to obtain information about current Microsoft Dynamics NAV sessions.

Parameters

-ServerInstance<String>

Specifies the name of a Microsoft Dynamics NAV Server instance. The default instance name is DynamicsNAV70. You can specify either the full name of an instance (such as MicrosoftDynamicsNavServer$myinstance) or the short name (such as myinstance).

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

<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.

C:\PS>Remove-NAVServerSession DynamicsNAV70 -SessionId 11