Set-DfsReplicatedFolder

Windows Server Technical Preview and Windows 10

Applies To: Windows 10, Windows Server Technical Preview

Set-DfsReplicatedFolder

Changes settings of a replicated folder.

Syntax

Parameter Set: Default
Set-DfsReplicatedFolder [-GroupName] <String[]> [[-FolderName] <String[]> ] [[-Description] <String> ] [[-FileNameToExclude] <String[]> ] [[-DirectoryNameToExclude] <String[]> ] [[-DfsnPath] <String> ] [[-DomainName] <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]




Detailed Description

The Set-DfsReplicatedFolder cmdlet changes settings of a replicated folder in a replication group. You can use this cmdlet to modify global settings of replicated folders such as filters and Distributed File System (DFS) Namespace associations. Replicated folders are logical arrangements of replication that do not contain computer-specific settings.

Parameters

-Description<String>

Specifies a description for the replicated folder.


Aliases

none

Required?

false

Position?

3

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-DfsnPath<String>

Specifies the DFS Namespace folder path of the replicated folder.

The DFS Namespace folder path has no effect on replication. This property exists only as a descriptive convenience to administrators and DFS Replication service does not validate the value of this property.


Aliases

none

Required?

false

Position?

6

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-DirectoryNameToExclude<String[]>

Specifies an array of names of subfolders that the DSFR service excludes and does not replicate in the replicated folder. You must provide only folder names, not full paths. You can use wildcards.


Aliases

DirectoryFilter

Required?

false

Position?

5

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-DomainName<String>

Specifies the NetBIOS name or fully qualified domain name (FQDN) for the Active Directory Domain Service (AD DS) domain that contains the replication group. If you do not specify this parameter, the cmdlet uses the domain of the current user.


Aliases

none

Required?

false

Position?

101

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-FileNameToExclude<String[]>

Specifies an array of names and extensions of files that the DSFR service excludes and does not replicate. You must provide only file names, not full paths. You can use wildcards.


Aliases

FileFilter

Required?

false

Position?

4

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-FolderName<String[]>

Specifies an array of names of replicated folders. You can use a comma separated list and the wildcard character (*). If you do not specify this parameter, the cmdlet gets all replicated folders.


Aliases

RF,RfName

Required?

false

Position?

2

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-GroupName<String[]>

Specifies an array of names of replication groups. You can use a comma separated list and the wildcard character (*).


Aliases

RG,RgName

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

True (ByValue, ByPropertyName)

Accept Wildcard Characters?

false

-Confirm

Prompts you for confirmation before running the cmdlet.


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WhatIf

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: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see    about_CommonParameters (http://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

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

  • Microsoft.DistributedFileSystemReplication.DfsReplicationGroup, Microsoft.DistributedFileSystemReplication.DfsReplicatedFolder

Outputs

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

  • Microsoft.DistributedFileSystemReplication.DfsReplicatedFolder

Examples

Example 1: Add a description to a replicated folder

This command sets a new description on the replicated folder named RF101 in the replication group named RG11.


PS C:\> Set-DfsReplicatedFolder -GroupName "RG11" -FolderName "RF101" -Description "Branch Store #101, Data Collection for Backups"

Example 2: Exclude files on all replicated folders

This command sets the list of files to exclude from replication for all replicated folders in the RG11 replication group. The command specifies that the DFS Replication service exclude file names starting with a tilde (~) character and files that have the extensions .bak, .tmp, and .ned from replication.


PS C:\> Set-DfsReplicatedFolder -GroupName "RG11" -FolderName * -FileNameToExclude "~*, *.bak, *.tmp, *.ned"

Related topics

Community Additions

ADD
Show: