description | external help file | Module Name | ms.date | online version | schema | title |
---|---|---|---|---|---|---|
Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. |
FileServer.cdxml-help.xml |
Storage |
12/20/2016 |
2.0.0 |
New-FileShare |
Creates an access point for a remote file share.
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>]
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.
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.
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
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[]
Parameter Sets: (All)
Aliases: Session
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Prompts you for confirmation before running the cmdlet.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
Indicates whether the file share is continuously available.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies a user-friendly description of the file share.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Indicates whether to encrypt the data on transport.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies the name of the file server to host the file share.
Type: String[]
Parameter Sets: ByName
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies the unique ID of the file server.
Type: String[]
Parameter Sets: ByUniqueId
Aliases: Id
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
Specifies the input object that is used in a pipeline command.
Type: CimInstance[]
Parameter Sets: InputObject (cdxml)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
Specifies the name of the file share to create.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies the file sharing protocol. The acceptable values for this parameter are:
- NFS
- SMB
Type: FileSharingProtocol
Parameter Sets: (All)
Aliases:
Accepted values: NFS, SMB
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies the relative path. Specify this parameter if the path for the new file share is not the root of the volume.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies the source volume.
Type: CimInstance
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
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
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
- When used in Failover Cluster, cmdlets from the Storage module operate on cluster level (all servers in the cluster).