Powershell module to help with all file sharing related tasks without using WMI !
The first functions help to view, list, create, modify and delete shares.
This also on remote Windows servers or NAS like NetApp.
Also there are functions to view the open sessions and open files on a server.
Also there ae functions to list available snapshots and seek for folders and files (versions) in snapshots.
All these functions use netapi32 or advapi32 dll calls.
With this command you get a list of all shares on the machine or from a specified server. I you do not have admin rights you can try the option -Level 1 (Default is 502).
The returned array of objects will have the following properties:
| Property | Description |
|---|---|
| Server | The machine hosting the shares |
| Name | The name of the share |
| Path | The local path shared |
| Description | The remark or description of the share |
| CurrentUses | Current connections to this share |
| Type | The type of the share |
With this command you get a even more detailed list of all the file shares on the machine or from a specified server. The IPC and administrative (special) shares are left out.
The returned array of objects will have the following properties:
| Property | Description |
|---|---|
| Server | The machine hosting the shares |
| Name | The name of the share |
| Path | The local path shared |
| Description | The remark or description of the share |
| ABE | Access based enumeration, can be Enabled or Disabled (default) |
| CachingMode | Offline Folder configuration, can be: "Manual" (default) "None" "Documents" (all documents are automatically offline available) "Programs" ("Performance option", all files are automatically offline available) |
| EncryptData | Encryption feature of SMB3, can be Enabled or Disabled (default) |
| ShareACLText | Permissions on the share itself. Special format: Every permission is separated by a comma and the identity and the access right are separated by a | (pipe) If blank probably the default permission "Everyone|FullControl" is set. |
| CurrentUses | Current connections to this share |
With this command you get detailed information about the specified share on the machine or from a remote server.
The returned objects will have the following properties:
| Property | Description |
|---|---|
| Server | The machine hosting the share |
| Name | The name of the share |
| Path | The local path shared |
| Description | The remark or description of the share |
| ABE | Access based enumeration, can be Enabled or Disabled (default) |
| CachingMode | Offline Folder configuration, can be: "Manual" (default) "None" "Documents" (all documents are automatically offline available) "Programs" ("Performance option", all files are automatically offline available) "BranchCache" (Enables BranchCache and manual caching of documents on the shared folder) |
| ShareACLText | Permissions on the share itself. Special format: Every permission is separated by a comma and the identity and the access right are separated by a | (pipe) If blank probably the default permission "Everyone|FullControl" is set. |
| CurrentUses | Current connections to this share |
| ConcurrentUserLimit | Allowed connections to the share. Default is -1 that equals maximum |
| EncryptData | Encryption feature of SMB3, can be Enabled or Disabled (default) |
| Flags | Decimal value of the netapi32 1005 structure flags |
| Type | The type of the share |
| ShareSDDL | The DACL of the share in SDDL format |
| ShareACL | The ACL of the share in the standard powershell/.net ACL format. Try to look at the .ShareACL.Access |
New-NetShare [[-Server] <string>] [-Name] <string> [-Path] <string> [[-Description] <string>] [[-Permissions] <string>] [[-ABE] <string>] [[-CachingMode] <string>] [[-MaxUses] <int>]
With this command you create a new share on the machine or on a remote server. The command fails if the share already exists.
The following parameters are available:
| Property | Description |
|---|---|
| Server | The machine hosting the share, default is the local machine |
| * Name | The name of the share |
| * Path | The local path to be shared |
| Description | The remark or description of the share |
| Permissions | The share permissions to set on the share itself. Special text format or SDDL format Text format: Every permission is separated by a comma and the identity and the access right are separated by a | (pipe) Default: Everyone|FullControl Possible Permissions: Read, Change, FullControl, Deny-FullControl Possible Identities: Everyone, BUILTIN\Administrators, BUILTIN\Users, BUILTIN\xxxxx (server local users or groups), DOMAIN\UserName, ADCORP\GroupName, <NETBIOSDOMAINNAME>\<sAMAccountName> (domain objects) SDDL format: To detect SDDL format, string must start with "D:" Example "D:(A;;FA;;;BA)(A;;0x1301bf;;;BU)" |
| ABE | Access based enumeration, can be Enabled or Disabled (default) |
| CachingMode | Offline Folder configuration, can be: "Manual" (default) "None" "Documents" (all documents are automatically offline available) "Programs" ("Performance option", all files are automatically offline available) "BranchCache" (Enables BranchCache and manual caching of documents on the shared folder) |
| EncryptData | Encryption feature of SMB3, can be Enabled or Disabled (default) |
| MaxUses | Allowed connections to the share. Default is -1 that equals maximum |
This function returns nothing.
Redo-NetShare [[-Server] <string>] [-Name] <string> [-Path] <string> [[-Description] <string>] [[-Permissions] <string>] [[-ABE] <string>] [[-CachingMode] <string>] [[-MaxUses] <int>]
With this command you create a new share on the machine or on a remote server. If the share already exists, the share will be modified with the given options. If the path changes, the share will be deleted and recreated while preserving the options from the deleted share.
The following parameters are available:
| Property | Description |
|---|---|
| Server | The machine hosting the share, default is the local machine |
| * Name | The name of the share |
| * Path | The local path to be shared |
| Description | The remark or description of the share |
| Permissions | The share permissions to set on the share itself. Special text format or SDDL format Text format: Every permission is separated by a comma and the identity and the access right are separated by a | (pipe) Default: Everyone|FullControl Possible Permissions: Read, Change, FullControl, Deny-FullControl Possible Identities: Everyone, BUILTIN\Administrators, BUILTIN\Users, BUILTIN\xxxxx (server local users or groups), DOMAIN\UserName, ADCORP\GroupName, <NETBIOSDOMAINNAME>\<sAMAccountName> (domain objects) SDDL format: To detect SDDL format, string must start with "D:" Example "D:(A;;FA;;;BA)(A;;0x1301bf;;;BU)" |
| ABE | Access based enumeration, can be Enabled or Disabled (default) |
| CachingMode | Offline Folder configuration, can be: "Manual" (default) "None" "Documents" (all documents are automatically offline available) "Programs" ("Performance option", all files are automatically offline available) "BranchCache" (Enables BranchCache and manual caching of documents on the shared folder) |
| EncryptData | Encryption feature of SMB3, can be Enabled or Disabled (default) |
| MaxUses | Allowed connections to the share. Default is -1 that equals maximum |
This function returns nothing.
Set-NetShare [[-Server] <string>] [-Name] <string> [[-Description] <string>] [[-Permissions] <string>] [[-ABE] <string>] [[-CachingMode]<string>] [[-MaxUses] <int>]
With this command you modify all changeable options on a share on the machine or on a remote server.
The following parameters are available:
| Property | Description |
|---|---|
| Server | The machine hosting the share, default is the local machine |
| * Name | The name of the share |
| Description | The remark or description of the share |
| Permissions | The share permissions to set on the share itself. Special text format or SDDL format Text format: Every permission is separated by a comma and the identity and the access right are separated by a | (pipe) Default: Everyone|FullControl Possible Permissions: Read, Change, FullControl, Deny-FullControl Possible Identities: Everyone, BUILTIN\Administrators, BUILTIN\Users, BUILTIN\xxxxx (server local users or groups), DOMAIN\UserName, ADCORP\GroupName, <NETBIOSDOMAINNAME>\<sAMAccountName> (domain objects) SDDL format: To detect SDDL format, string must start with "D:" Example "D:(A;;FA;;;BA)(A;;0x1301bf;;;BU)" |
| ABE | Access based enumeration, can be Enabled or Disabled (default) |
| CachingMode | Offline Folder configuration, can be: "Manual" (default) "None" "Documents" (all documents are automatically offline available) "Programs" ("Performance option", all files are automatically offline available) "BranchCache" (Enables BranchCache and manual caching of documents on the shared folder) |
| EncryptData | Encryption feature of SMB3, can be Enabled or Disabled (default) |
| MaxUses | Allowed connections to the share. Default is -1 that equals maximum |
This function returns nothing.
With this command deletes a share on the machine or on a remote server.
The following parameters
| Property | Description |
|---|---|
| Server | The machine hosting the share, default is the local machine |
| * Name | The name of the share |
This function returns nothing.
With this command you retrieve the available space for the calling user and the total free space on the disk and the total disk space of the specified share on the machine or from a remote server. The returned values are in UInt64. Default these are bytes, but with the Unit option you can get rounded values in KB, MB, GB or TB.
The returned objects will have the following properties:
| Property | Description |
|---|---|
| Server | The machine hosting the share |
| Name | The name of the share |
| Path | The UNC path to the share |
| UserFree | The available space for the calling user (important if quotas are set) |
| DiskFree | The available space on the disk or volume |
| DiskSize | The total size of the disk or volume |
With this command you get a detailed and sorted (by user and client) list of all the opened SMB sessions on the machine or on a specified server. For NAS that return an error "The system call level is not correct" try the option -Level 1.
The returned array of objects will have the following properties:
| Property | Description |
|---|---|
| Username | Username used to authenticate |
| Client | The name (if reverse lookup is possible) or the IP address of the client (if not) |
| ClientIP | The IP address of the client |
| Opens | The count of opened objects / files |
| TimeTS | Session duration in powershell timespan format |
| Time | Session duration as a string in hours and minutes |
| Connected | DateTime the session started |
| IdleTS | Session idle time in powershell timespan format |
| Idle | Session idle time as a string in hours and minutes |
| IdleSince | DateTime the session is idle |
| ConnectionType | This can be empty or showing the SMB version used (only with Level 502) |
Closes an open session on a local or remote computer by user AND client IP.
The following parameters
| Property | Description |
|---|---|
| Server | The machine hosting the sessions, default is the local machine |
| * User | The name of the user |
| * ClientIP | The IP address of the client (find out with Get-NetSessions) |
This function returns nothing.
With this command you get a sorted (by path and user) list of all over SMB opened files on the machine or on a specified server.
By specifying the left part of the local path the list is filtered to this path and subfolders.
By adding the option -WithID the returned values contain also a FileID that can be used to use Close-NetOpenFiles
The returned array of objects will have the following properties:
| Property | Description |
|---|---|
| Path | Machine local path to the opened file or folder |
| User | Username used to authenticate |
| Access | Type of access |
| Locks | Active locks by this access |
| FileID | ID of the open file (only with option -WithID) |
Closes an open file or folder from a local or remote computer.
The following parameters
| Property | Description |
|---|---|
| Server | The machine hosting the sessions, default is the local machine |
| * FileID | FileID to close (Get the FileID by using Get-NetOpenFiles with the option -WithID) |
This function returns nothing.
With this command will return you every snapshot (path) for a given folder (on a network share).
The returned array of strings will contain the full path to the snapshots of the given folders.
With this command will return file or folder objects found existing in snapshots for a given full path to a folder or file. The folder/file does not need to exist at the present location. For folders every existing snapshot is listed. For files only older versions are returned.
The returned array of objects will be of the type DirectoryInfo or FileInfo with the additional property SnapshotCreationTime (in DateTime format).
Most usefull properties:
| Property | Description |
|---|---|
| FullName | Full path to the object |
| LastWriteTime | Last modify date of the object |
| SnapshotCreationTime | Time (local) the snapshot was taken |
The Powershell module is available in the PowerShell Gallery.
https://www.powershellgallery.com/packages/FileShareUtils
To install the module from the powershell gallery your computer need to have internet access !
Install it in PowerShell like this:
Install-Module -Name FileShareUtils
To update the module use -Force :
Install-Module FileShareUtils -Force
Get more information about the module like this:
Before installation: Save-Module -Name FileShareUtils -Path <path>
After installation: Get-InstalledModule -Name FileShareUtils | FL
Look at the code in ISE:
Powershell_ISE.exe ((Get-InstalledModule -Name FileShareUtils).InstalledLocation + "\FileShareUtils.psm1")
Use this to uninstall all versions:
Uninstall-Module FileShareUtils -all
Open your module folder. Probably one of these two:
C:\WINDOWS\system32\WindowsPowerShell\v1.0\Modules\
C:\Program Files\WindowsPowerShell\Modules
(Or open a command prompt an enter set ps to view the env. variable.)
Create a folder named 'FileShareUtils' .
Optional: Create a sub folder with a version number if you like.
Copy at least the two files of the module in the created folder:
- FileShareUtils.psd1
- FileShareUtils.psm1
I searched very long and intensive for the solutions now built in this module. But I found some helpful blogs other information on the internet and I like to mention them here.
The first and for me important post is from Alexander from his Kazun PowerShell blog:
Managing Access-based enumeration with PowerShell
After testing the code above I found that using netapi32 seams to be the way to go. More search lead me to the blog of Micky Balladelli micky@balladelli.com .
Enumération de shares SMB
Netapi et Powershell
Les permissions d’un share
Most important and cryptic parts to implement the netapi32 and advapi32 functions I borrowed from his code in these 3 blog posts.
A long time I was looking into implementing functions to enumerate snapshots / previous versions. Many attemts to implement this in Powershell failed while I only found working C++ and C# examples from these repos : https://github.com/HiraokaHyperTools/EnumerateSnapshots https://github.com/HiraokaHyperTools/LibEnumRemotePreviousVersion
Then I found this Get-SnapshotPath Gist from Jordan Borean (@jborean93) jborean93@gmail.com that then finaly helped me to add the functions I wanted.