New-FileShare

Creates an access point for a remote file share.

Syntax

New-FileShare
   -FileServerFriendlyName <String[]>
   -Name <String>
   [-Description <String>]
   -SourceVolume <CimInstance>
   [-RelativePathName <String>]
   [-ContinuouslyAvailable <Boolean>]
   [-EncryptData <Boolean>]
   [-Protocol <FileSharingProtocol>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-FileShare
   -FileServerUniqueId <String[]>
   -Name <String>
   [-Description <String>]
   -SourceVolume <CimInstance>
   [-RelativePathName <String>]
   [-ContinuouslyAvailable <Boolean>]
   [-EncryptData <Boolean>]
   [-Protocol <FileSharingProtocol>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-FileShare
   -InputObject <CimInstance[]>
   -Name <String>
   [-Description <String>]
   -SourceVolume <CimInstance>
   [-RelativePathName <String>]
   [-ContinuouslyAvailable <Boolean>]
   [-EncryptData <Boolean>]
   [-Protocol <FileSharingProtocol>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The New-FileShare cmdlet creates an access point for a remote file share.

The file share that this cmdlet creates represents a Server Message Block (SMB) or Network File System (NFS) share, which is on top of a MSFT_Volume.

Examples

Example 1: Create an SMB file share

PS C:\>$Pool = Get-StoragePool -FriendlyName "clusteredpool"
PS C:\> $Volume = $Pool | New-Volume -FriendlyName "myvol" -UseMaximumSize $True
PS C:\> New-FileShare -Name "Docs" -FileServerFriendlyName "scaleout-clus" -SourceVolume $Volume -IsContinuouslyAvailable $True -Protocol SMB

The first command gets the specified storage pool, and then stores it in the $Pool variable.

The second command creates a volume using the storage pool in $Pool, and then stores it in the $Volume variable.

The third command creates a continuously available SMB file share using the volume in $SourceVolume.

Required Parameters

-FileServerFriendlyName

Specifies the name of the file server to host the file share.

Type:String[]
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-FileServerUniqueId

Specifies the unique ID of the file server.

Type:String[]
Aliases:Id
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-InputObject

Specifies the input object that is used in a pipeline command.

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

Specifies the name of the file share to create.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-SourceVolume

Specifies the source volume.

Type:CimInstance
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Optional Parameters

-AsJob

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.

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

Indicates whether the file share is continuously available.

Type:Boolean
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Description

Specifies a user-friendly description of the file share.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-EncryptData

Indicates whether to encrypt the data on transport.

Type:Boolean
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Protocol

Specifies the file sharing protocol. The acceptable values for this parameter are:

  • NFS
  • SMB
Type:FileSharingProtocol
Parameter Sets:NFS, SMB
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-RelativePathName

Specifies the relative path. Specify this parameter if the path for the new file share is not the root of the volume.

Type:String
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

MSFT_FileShare