< Back
New-FileShare
Post
NAME New-FileShare
SYNOPSIS
Creates an access point for a remote file share.
SYNTAX
New-FileShare [-CimSession <CimSession[]>] [-ContinuouslyAvailable <Boolean>] [-Description <String>] [-EncryptData <Boolean>] [-Protocol {NFS | SMB}]
[-RelativePathName <String>] [-ThrottleLimit <Int32>] -FileServerFriendlyName <String[]> -Name <String> -SourceVolume <CimInstance> [-Confirm] [-WhatIf]
[<CommonParameters>]
New-FileShare [-CimSession <CimSession[]>] [-ContinuouslyAvailable <Boolean>] [-Description <String>] [-EncryptData <Boolean>] [-Protocol {NFS | SMB}]
[-RelativePathName <String>] [-ThrottleLimit <Int32>] -FileServerUniqueId <String[]> -Name <String> -SourceVolume <CimInstance> [-Confirm] [-WhatIf]
[<CommonParameters>]
New-FileShare [-CimSession <CimSession[]>] [-ContinuouslyAvailable <Boolean>] [-Description <String>] [-EncryptData <Boolean>] [-Protocol {NFS | SMB}]
[-RelativePathName <String>] [-ThrottleLimit <Int32>] -Name <String> -SourceVolume <CimInstance> [-Confirm] [-WhatIf] [<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.
PARAMETERS
-CimSession [<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.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-ContinuouslyAvailable [<Boolean>]
Indicates whether the file share is continuously available.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-Description [<String>]
Specifies a user-friendly description of the file share.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-EncryptData [<Boolean>]
Indicates whether to encrypt the data on transport.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-FileServerFriendlyName <String[]>
Specifies the name of the file server to host the file share.
Required? true
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-FileServerUniqueId <String[]>
Specifies the unique ID of the file server.
Required? true
Position? named
Default value none
Accept pipeline input? true(ByPropertyName)
Accept wildcard characters? false
-Name <String>
Specifies the name of the file share to create.
Required? true
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-Protocol [<FileSharingProtocol>]
Specifies the file sharing protocol. The acceptable values for this parameter are:
-- NFS
-- SMB
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-RelativePathName [<String>]
Specifies the relative path. Specify this parameter if the path for the new file share is not the root of the volume.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-SourceVolume <CimInstance>
Specifies the source volume.
Required? true
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-ThrottleLimit [<Int32>]
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.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value false
Accept pipeline input? false
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value false
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
MSFT_FileShare
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.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?LinkId=816431
Debug-FileShare
Get-FileShare
Remove-FileShare
Set-FileShare
SYNOPSIS
Creates an access point for a remote file share.
SYNTAX
New-FileShare [-CimSession <CimSession[]>] [-ContinuouslyAvailable <Boolean>] [-Description <String>] [-EncryptData <Boolean>] [-Protocol {NFS | SMB}]
[-RelativePathName <String>] [-ThrottleLimit <Int32>] -FileServerFriendlyName <String[]> -Name <String> -SourceVolume <CimInstance> [-Confirm] [-WhatIf]
[<CommonParameters>]
New-FileShare [-CimSession <CimSession[]>] [-ContinuouslyAvailable <Boolean>] [-Description <String>] [-EncryptData <Boolean>] [-Protocol {NFS | SMB}]
[-RelativePathName <String>] [-ThrottleLimit <Int32>] -FileServerUniqueId <String[]> -Name <String> -SourceVolume <CimInstance> [-Confirm] [-WhatIf]
[<CommonParameters>]
New-FileShare [-CimSession <CimSession[]>] [-ContinuouslyAvailable <Boolean>] [-Description <String>] [-EncryptData <Boolean>] [-Protocol {NFS | SMB}]
[-RelativePathName <String>] [-ThrottleLimit <Int32>] -Name <String> -SourceVolume <CimInstance> [-Confirm] [-WhatIf] [<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.
PARAMETERS
-CimSession [<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.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-ContinuouslyAvailable [<Boolean>]
Indicates whether the file share is continuously available.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-Description [<String>]
Specifies a user-friendly description of the file share.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-EncryptData [<Boolean>]
Indicates whether to encrypt the data on transport.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-FileServerFriendlyName <String[]>
Specifies the name of the file server to host the file share.
Required? true
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-FileServerUniqueId <String[]>
Specifies the unique ID of the file server.
Required? true
Position? named
Default value none
Accept pipeline input? true(ByPropertyName)
Accept wildcard characters? false
-Name <String>
Specifies the name of the file share to create.
Required? true
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-Protocol [<FileSharingProtocol>]
Specifies the file sharing protocol. The acceptable values for this parameter are:
-- NFS
-- SMB
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-RelativePathName [<String>]
Specifies the relative path. Specify this parameter if the path for the new file share is not the root of the volume.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-SourceVolume <CimInstance>
Specifies the source volume.
Required? true
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-ThrottleLimit [<Int32>]
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.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value false
Accept pipeline input? false
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value false
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
MSFT_FileShare
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.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?LinkId=816431
Debug-FileShare
Get-FileShare
Remove-FileShare
Set-FileShare