vserver cifs session close

Close an open CIFS session

Availability: This command is available to cluster and Vserver administrators at the admin privilege level.

Description

The vserver cifs session close command closes the specified CIFS sessions.

Parameters

-node {<nodename>|local} - Node
If you specify this parameter, the command will close all the opened CIFS sessions on the specified node.
-vserver <vserver name> - Vserver
If you specify this parameter, the command will close all the opened CIFS sessions on the specified CIFS-enabled Vserver.
-session-id <integer> - Session ID
If you specify this parameter, the command will close the open CIFS session that matches the specified session ID.
[-connection-id <integer>] - Connection ID
If you specify this parameter, the command will close all the opened CIFS sessions that match the specified connection ID.
[-lif-address <IP Address>] - Incoming Data LIF IP Address
If you specify this parameter, the command will close all the opened CIFS sessions that are established through the specified data LIF IP address.
[-address <IP Address>] - Workstation IP address
If you specify this parameter, the command will close all the opened CIFS sessions that are opened from the specified IP address.
[-auth-mechanism <Authentication Mechanism>] - Authentication Mechanism
If you specify this parameter, the command will close all the opened CIFS sessions that used the specified authentication mechanism. The authentication mechanism can include one of the following:
  • NTLMv1 - NTLMv1 authentication mechanism
  • NTLMv2 - NTLMv2 authentication mechanism
  • Kerberos - Kerberos authentication mechanism
  • Anonymous - Anonymous authentication mechanism
[-windows-user <TextNoCase>] - Windows User
If you specify this parameter, the command will close all the opened CIFS sessions that are established for the specified CIFS user. The acceptable format for CIFS user is [domain]\user.
[-unix-user <text>] - UNIX User
If you specify this parameter, the command will close all the opened CIFS sessions that are established for the specified UNIX user.
[-protocol-version <CIFS Dialects>] - Protocol Version
If you specify this parameter, the command will close all the opened CIFS sessions that are established over the specified version of CIFS protocol. The protocol version can include one of the following:
  • SMB1 - SMB 1.0
  • SMB2 - SMB 2.0
  • SMB2_1 - SMB 2.1
  • SMB3 - SMB 3.0
  • SMB3_1 - SMB 3.1
[-continuously-available <CIFS Open File Protection>] - Continuously Available
If you specify this parameter, the command will close all the opened CIFS sessions with open files that have the specified level of continuously available protection. The open files are "continuously available" if they are opened from an SMB 3 client through a share with the "continuously_available" property set. These open files are capable of non-disruptively recovering from takeover and giveback as well as general aggregate relocation between partners in a high-availability relationship. This is in addition to the traditional SMB 2 capability allowing clients to recover from LIF migration and other brief network interruptions.
Note: The CA protection levels depict the continuous availability at the connection level so it might not be accurate for a session if the connection has multiple sessions. Streams opened through a continuously available share are permitted, but are not currently made continuously available. Directories may be opened through a continuously available share, but, by design, will not appear continuously available as clients do not open them that way. These protection levels are applicable to the sessions on read/write volumes residing on storage failover aggregates.

The continuously available status can be one of the following:

  • No - The session contains one or more open file but none of them are continuously available.
  • Yes - The session contains one or more open files and all of them are continuously available.
  • Partial - The session contains at least one continuously available open file but other open files that are not.
[-is-session-signed {true|false}] - Is Session Signed
If you specify this parameter, the command will close all the opened CIFS sessions that are established with the specified SMB signing option.
[-smb-encryption-status {unencrypted|encrypted|partially-encrypted}] - SMB Encryption Status
If you specify this parameter, the command will close all the opened CIFS sessions that are established over the specified SMB encryption status.

The SMB encryption status can be one of the following:

  • unencrypted - The CIFS session is not encrypted.
  • encrypted - The CIFS session is fully encrypted. Vserver level encryption is enabled and encryption happens for the entire session.
  • partially-encrypted - The CIFS session is partially encrypted. Share level encryption is enabled and encryption is initiated when the tree-connect occurs.

Examples

The following example closes all open CIFS sessions on all the nodes with protocol-version SMB2:

cluster1::> cifs session close -node * -protocol-version SMB2
2 entries were acted on.
The following example closes all open CIFS sessions for all Vservers on node node1:
cluster1::> cifs session close -node node1 -vserver *
3 entries were acted on.