Disconnect-NfsSession

Disconnects NFS sessions that a client computer established on an NFS server.

Syntax

Disconnect-NfsSession
          [-SessionId] <String[]>
          [[-ClientId] <UInt64[]>]
          [-AsJob]
          [-CimSession <CimSession[]>]
          [-Confirm]
          [-PassThru]
          [-ThrottleLimit <Int32>]
          [-WhatIf]
          [<CommonParameters>]
Disconnect-NfsSession
          [-AsJob]
          [-CimSession <CimSession[]>]
          [-Confirm]
          -InputObject <CimInstance[]>
          [-PassThru]
          [-ThrottleLimit <Int32>]
          [-WhatIf]
          [<CommonParameters>]

Description

The Disconnect-NfsSession cmdlet disconnects one or more Network File System (NFS) sessions that a client computer establish on an NFS server. The session ID characterizes each NFS session. You can use the session ID to disconnect a session.

Examples

Example 1: Disconnect an NFS session for a specified client computer

PS C:\> Disconnect-NfsSession -ClientId 101

This command disconnects all NFS sessions on a local NFS server for a client computer that has the ID 101.

Required Parameters

-InputObject

Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet.

Type:CimInstance[]
Position:Named
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
-SessionId

Specifies the unique ID of one or more NFS sessions.

Type:String[]
Position:0
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

Optional Parameters

-AsJob

Indicates that this cmdlet runs the command as a background job on a remote computer. Use this parameter to run commands that take an extensive time to finish.

When you use the AsJob parameter, the command returns an object that represents the job, and then displays the command prompt. You can continue to work in the session while the job finishes. To manage the job, use the Job cmdlets. To get the job results, use the Receive-Job cmdlet.

The AsJob parameter resembles using the Invoke-Command cmdlet to run a Start-Job command remotely. However, with AsJob, the job is created on the local computer, even though the job runs on a remote computer, and the results of the remote job are automatically returned to the local computer.

For more information about Windows PowerShell background jobs, see about_Jobs and about_Remote_Jobs.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-CimSession

Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.

Type:CimSession[]
Aliases:Session
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ClientId

Specifies the ID of one or more NFS clients. If a specified client ID established multiple sessions, the cmdlet disconnects all of those sessions.

Type:UInt64[]
Position:1
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False
-PassThru

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ThrottleLimit

Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.

Type:Int32
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False

Outputs

Nothing