{"id":1288,"date":"2009-03-12T06:00:25","date_gmt":"2009-03-12T14:00:25","guid":{"rendered":"http:\/\/www.sapien.com\/blog\/2009\/03\/12\/create-a-remote-file-share\/"},"modified":"2009-03-12T06:00:25","modified_gmt":"2009-03-12T14:00:25","slug":"create-a-remote-file-share","status":"publish","type":"post","link":"https:\/\/dev.sapien.com\/blog\/2009\/03\/12\/create-a-remote-file-share\/","title":{"rendered":"Create A Remote File Share"},"content":{"rendered":"

This topic came up recently in the PowerShell forum at ScriptingAnswers.com<\/a> and I thought you might find it helpful. The issue was creating a file share remotely. In the “olden days”, this would have meant using a command line tool like RMTSHARE, which is really just fine. But if you have a larger workflow, doing it natively in PowerShell may be more desirable.<\/p>\n

Let me show you how easy it is to create a file share using Windows Management Instrumentation (WMI). I wrote a function called New-FileShare.<\/p>\n

\n
\n
Function New-FileShare {<\/pre>\n
#this function returns $True is the share is successfully created<\/span><\/pre>\n
    Param([string]$computername=$env:computername,<\/pre>\n
          [string]$path=$(Throw \"You must enter a complete path relative to the remote computer.\"<\/span>),<\/pre>\n
          [string]$share=$(Throw \"You must enter the name of the new share.\"<\/span>),<\/pre>\n
          [string]$comment,<\/pre>\n
          [int]$connections<\/pre>\n
          )<\/pre>\n
          <\/pre>\n
    $FILE_SHARE = 0<\/pre>\n
 <\/pre>\n
    if<\/span> (! $connections) {<\/pre>\n
        #if no connection number specifed set to $Null so<\/span><\/pre>\n
        #share will be created with maximum number of connections<\/span><\/pre>\n
        [void]$connections = $NULL<\/pre>\n
        }<\/pre>\n
    #uncomment this next line for debugging<\/span><\/pre>\n
#     Write-Host (\"Creating share {0} for {1} on {2} ({3})\" -f $share,$path,$computername,$comment) -fore Green<\/span><\/pre>\n
    <\/pre>\n
    [wmiclass]$wmishare=\"\\\\$computername\\root\\cimv2:win32_share\"<\/span><\/pre>\n
    <\/pre>\n
    $return<\/span>=$wmishare.Create($path,$share,$FILE_SHARE,$connections,$comment)<\/pre>\n
    <\/pre>\n
    Switch ($return<\/span>.returnvalue) {<\/pre>\n
        0 {$rvalue = \"Success\"<\/span>}<\/pre>\n
        2 {$rvalue = \"Access Denied\"<\/span>}     <\/pre>\n
        8 {$rvalue = \"Unknown Failure\"<\/span>}     <\/pre>\n
        9 {$rvalue = \"Invalid Name\"<\/span>}     <\/pre>\n
        10 {$rvalue = \"Invalid Level\"<\/span>}     <\/pre>\n
        21 {$rvalue = \"Invalid Parameter\"<\/span>}     <\/pre>\n
        22 {$rvalue = \"Duplicate Share\"<\/span>}     <\/pre>\n
        23 {$rvalue = \"Redirected Path\"<\/span>}     <\/pre>\n
        24 {$rvalue = \"Unknown Device or Directory\"<\/span>}<\/pre>\n
        25 {$rvalue = \"Net Name Not Found\"<\/span>}<\/pre>\n
    }<\/pre>\n
    <\/pre>\n
    if<\/span> ($return<\/span>.returnvalue -ne<\/span> 0) {<\/pre>\n
        Write-Warning (\"Failed to create share {0} for {1} on {2}. Error: {3}\"<\/span> -f $share,$path,$computername,$rvalue) <\/pre>\n
        return<\/span> $False<\/pre>\n
    }<\/pre>\n
    else<\/span> {<\/pre>\n
        return<\/span> $True<\/pre>\n
    }<\/pre>\n
}<\/pre>\n<\/div>\n<\/div>\n
The function has the following parameters:<\/p>\n