New-SyncShare

New-SyncShare

Creates a sync share.

Syntax

Parameter Set: cim:CreateInstance0
New-SyncShare [-Name] <String> [-Path] <String> [-User] <String[]> [-AsJob] [-CimSession <CimSession[]> ] [-Description <String> ] [-FallbackEnterpriseID <String> ] [-InheritParentFolderPermission] [-MaxUploadFile <UInt64> ] [-PasswordAutolockExcludeDomain <String[]> ] [-RequireEncryption <Boolean> ] [-RequirePasswordAutoLock <Boolean> ] [-ThrottleLimit <Int32> ] [-Type <String> ] [-UserFolderName <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed Description

The New-SyncShare cmdlet creates a sync share. Sync shares are used by Work Folders to store user files and sync them with user PCs and devices.

Parameters

-AsJob

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

-Description<String>

Specifies the description for a sync share configuration. The description is visible in Server Manager and in Windows PowerShell®, but does not appear to end users. The description can have a maximum of a 150 characters.

-FallbackEnterpriseID<String>

Specifies the fallback Enterprise ID that the sync share uses if it cannot successfully query Active Directory® Domain Services (). If the server cannot successfully query , the server uses the fully qualified domain name (FQDN) of the sync server as the fallback Enterprise ID unless you specify a different Enterprise ID by using this parameter. The Enterprise ID is issued by the Work Folders client to encrypt data on the PC or device.

The Enterprise ID is typically constructed by querying for the primary SMTP address of the user, removing the username and ampersand (user@), and sending the remainder to the client as the Enterprise ID. For example, EvanNarvaez@Contoso.com yields the contoso.com Enterprise ID.

-InheritParentFolderPermission

Indicates that the sync share inherits the permissions of the parent folder. If you specify this parameter, user folders inherit permissions from the parent folder of the sync share, and administrators can access the data. If you do not specify this parameter, by default each user is granted exclusive access to their user folder, and administrators have no access rights.

-MaxUploadFile<UInt64>

Specifies the maximum file size, in bytes, that users can upload to the server. The minimum value that you can specify is 1 MB.

-Name<String>

Specifies a name for the sync share. The name that you specify has the following requirements:

-- The name must be unique on the sync server
-- The name can have a maximum of 75 characters
-- You cannot start or end a name with a space
-- You cannot end a name with a period
-- You cannot used a reserved name, such as COM1, LPT1, or NUL
-- You cannot use the following characters: <>:\"/\\|?*

-PasswordAutolockExcludeDomain<String[]>

Specifies a list of domain names in FQDN format whose clients are to be exempted from the password policy. If the RequirePasswordAutoLock property on the sync share is false, then this parameter has no effect. If RequirePasswordAutoLock is true, clients that are members of the specified domains are not requested by Work Folders to enforce password length and lock policies on the device. It is assumed that their security is managed by the Group Policy of their domain.

-Path<String>

Specifies the full path of a folder on an NTFS volume to use for the sync share. This is the folder that acts as the parent to the user folders. You can specify the path with a drive letter or UNC format, but the path must be local to the server or failover cluster. You cannot create a sync share inside another sync share, and the path cannot contain any mount points.

-RequireEncryption<Boolean>

Indicates whether the sync server requests that the contents of Work Folders be encrypted on each PC and device that accesses the sync share.

-RequirePasswordAutoLock<Boolean>

Indicates whether the device must meet the following policies:

-- Password minimum length of six characters
-- Lock screen activates after a maximum of 15 minutes
-- User account lockout after a maximum of 10 failed sign-in attempts

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

-Type<String>

Specifies the type of the sync share. By default, all shares are of type User Data, and you should not change this value.

-User<String[]>

Specifies an array of user names or security groups who are allowed to sync data with this sync share. Add accounts or security groups in Security Accounts Manager (SAM) account format.

-UserFolderName<String>

Specifies a folder-naming format for the user folder on the sync share. To maintain compatibility with existing user folders that use aliases for their names, specify [user], which is required, or omit this parameter. To eliminate conflicts between identical user aliases in different domains, specify [user]@[domain]. You can also specify a relative path under the sync share root; for example, UserData\[user].

Sync share creates each user folder during the first sync operation, if it doesn’t already exist. If the user folder exists, confirm that the user has Read/Write or Full Control permissions and is the owner of their folder, unless the folder is owned by an Administrators group.

-Confirm

Prompts you for confirmation before running the cmdlet.

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

• SyncShare

  This cmdlet outputs an object that represents the new sync share.

Examples

Example 1: Create a new sync share

This command creates a new sync share named Share01. The path for the share is K:\Share01, and the cmdlet grants members of the ContosoEngGroup security group access to the share. The device policy associated with the share is also named Share01.

PS C:\> New-SyncShare Share01 K:\Share01 -User ContosoEngGroup 

Example 2: Create a new sync share by using full usernames to name user folders

This command creates a sync share and specifies that user folders should use the user @ domain folder-naming format.

PS C:\> New-SyncShare Share01 K:\Share01 -User ContosoEngGroup -UserFolderName [user]@[domain] 

Related topics

Disable-SyncShare

Enable-SyncShare

Get-SyncShare

Remove-SyncShare

Set-SyncShare