DSCResources/DSC_DFSReplicationGroupMembership/en-US/about_DFSReplicationGroupMembership.help.txt
|
.NAME
DFSReplicationGroupMembership .DESCRIPTION This resource is used to configure Replication Group Folder Membership. It is usually used to set the ContentPath for each Replication Group folder on each Member computer. It can also be used to set additional properties of the Membership. This resource shouldn't be used for folders where the Content Path is set in the DFSReplicationGroup. > Note: The PrimaryMember flag is automatically cleared by DFS once an initial > replication sync takes place, so is not tested by this resource. .PARAMETER GroupName Key - String The name of the DFS Replication Group. .PARAMETER FolderName Key - String The name of the DFS Replication Group Folder. .PARAMETER ComputerName Key - String The computer name of the Replication Group member. This can be specified using either the ComputerName or FQDN name for the member. If an FQDN name is used and the DomainName parameter is set, the FQDN domain name must match. .PARAMETER EnsureEnabled Write - String Allowed values: Enabled, Disabled Ensures that membership is either Enabled or Disabled. .PARAMETER ContentPath Write - String The local content path for the DFS Replication Group Folder. .PARAMETER StagingPath Write - String The local staging path for the DFS Replication Group Folder. .PARAMETER StagingPathQuotaInMB Write - UInt32 The staging path quota size in MB for the DFS Replication Group Folder. .PARAMETER MinimumFileStagingSize Write - String Allowed values: Size256KB, Size512KB, Size1MB, Size2MB, Size4MB, Size8MB, Size16MB, Size32MB, Size64MB, Size128MB, Size256MB, Size512MB, Size1GB, Size2GB, Size4GB, Size8GB, Size16GB, Size32GB, Size64GB, Size128GB, Size256GB, Size512GB, Size1TB, Size2TB, Size4TB, Size8TB, Size16TB, Size32TB, Size64TB, Size128TB, Size256TB, Size512TB The minimum file size that DFS Replication stages during outbound replication. .PARAMETER ConflictAndDeletedPath Read - String The local content and deleted path for the DFS Replication Group Folder. .PARAMETER ConflictAndDeletedQuotaInMB Write - UInt32 The local conflict and deleted path quota size in MB. .PARAMETER ReadOnly Write - Boolean Specify if this content path should be read only. .PARAMETER RemoveDeletedFiles Write - Boolean Specify if a member computer deletes files and folders immediately following inbound replication. .PARAMETER PrimaryMember Write - Boolean Used to configure this as the Primary Member. Every folder must have at least one primary member for initial replication to take place. Only set during initial creation of membership. .PARAMETER DfsnPath Write - String Specify the DFS Namespace folder path of the membership. This value does not affect replication. .PARAMETER DomainName Write - String The name of the AD Domain the DFS Replication Group this replication group is in. .EXAMPLE 1 Create a DFS Replication Group called Public containing two members, FileServer1 and FileServer2. The Replication Group contains a single folder called Software. A description will be set on the Software folder and it will be set to exclude the directory Temp from replication. An automatic fullmesh topology is assigned to the replication group connections. Configuration DFSReplicationGroupMembership_FullMesh_Config { param ( [Parameter()] [PSCredential] $Credential ) Import-DscResource -Module DFSDsc Node localhost { <# Install the Prerequisite features first Requires Windows Server 2012 R2 Full install #> WindowsFeature RSATDFSMgmtConInstall { Ensure = 'Present' Name = 'RSAT-DFS-Mgmt-Con' } # Configure the Replication Group DFSReplicationGroup RGPublic { GroupName = 'Public' Description = 'Public files for use by all departments' Ensure = 'Present' Members = 'FileServer1','FileServer2' Folders = 'Software' Topology = 'Fullmesh' PSDSCRunAsCredential = $Credential DependsOn = '[WindowsFeature]RSATDFSMgmtConInstall' } # End of RGPublic Resource DFSReplicationGroupFolder RGSoftwareFolder { GroupName = 'Public' FolderName = 'Software' Description = 'DFS Share for storing software installers' DirectoryNameToExclude = 'Temp' PSDSCRunAsCredential = $Credential DependsOn = '[DFSReplicationGroup]RGPublic' } # End of RGPublic Resource DFSReplicationGroupMembership RGPublicSoftwareFS1 { GroupName = 'Public' FolderName = 'Software' ComputerName = 'FileServer1' ContentPath = 'd:\Public\Software' StagingPathQuotaInMB = 4096 PrimaryMember = $true PSDSCRunAsCredential = $Credential DependsOn = '[DFSReplicationGroupFolder]RGSoftwareFolder' } # End of RGPublicSoftwareFS1 Resource DFSReplicationGroupMembership RGPublicSoftwareFS2 { GroupName = 'Public' FolderName = 'Software' ComputerName = 'FileServer2' ContentPath = 'e:\Data\Public\Software' StagingPathQuotaInMB = 4096 PSDSCRunAsCredential = $Credential DependsOn = '[DFSReplicationGroupFolder]RGSoftwareFolder' } # End of RGPublicSoftwareFS2 Resource } # End of Node } # End of Configuration .EXAMPLE 2 Create a DFS Replication Group called Public containing two members, FileServer1 and FileServer2. The Replication Group contains a single folder called Software. A description will be set on the Software folder and it will be set to exclude the directory Temp from replication. The resource group topology is left set to 'Manual' so that the replication group connections can be defined. Configuration DFSReplicationGroupMembership_Complete_Config { param ( [Parameter()] [PSCredential] $Credential ) Import-DscResource -Module DFSDsc Node localhost { <# Install the Prerequisite features first Requires Windows Server 2012 R2 Full install #> WindowsFeature RSATDFSMgmtConInstall { Ensure = 'Present' Name = 'RSAT-DFS-Mgmt-Con' } # Configure the Replication Group DFSReplicationGroup RGPublic { GroupName = 'Public' Description = 'Public files for use by all departments' Ensure = 'Present' Members = 'FileServer1.contoso.com','FileServer2.contoso.com' Folders = 'Software' PSDSCRunAsCredential = $Credential DependsOn = '[WindowsFeature]RSATDFSMgmtConInstall' } # End of RGPublic Resource DFSReplicationGroupConnection RGPublicC1 { GroupName = 'Public' Ensure = 'Present' SourceComputerName = 'FileServer1.contoso.com' DestinationComputerName = 'FileServer2.contoso.com' PSDSCRunAsCredential = $Credential } # End of DFSReplicationGroupConnection Resource DFSReplicationGroupConnection RGPublicC2 { GroupName = 'Public' Ensure = 'Present' SourceComputerName = 'FileServer2.contoso.com' DestinationComputerName = 'FileServer1.contoso.com' PSDSCRunAsCredential = $Credential } # End of DFSReplicationGroupConnection Resource DFSReplicationGroupFolder RGSoftwareFolder { GroupName = 'Public' FolderName = 'Software' Description = 'DFS Share for storing software installers' DirectoryNameToExclude = 'Temp' PSDSCRunAsCredential = $Credential DependsOn = '[DFSReplicationGroup]RGPublic' } # End of RGPublic Resource DFSReplicationGroupMembership RGPublicSoftwareFS1 { GroupName = 'Public' FolderName = 'Software' ComputerName = 'FileServer1.contoso.com' ContentPath = 'd:\Public\Software' StagingPathQuotaInMB = 4096 PrimaryMember = $true PSDSCRunAsCredential = $Credential DependsOn = '[DFSReplicationGroupFolder]RGSoftwareFolder' } # End of RGPublicSoftwareFS1 Resource DFSReplicationGroupMembership RGPublicSoftwareFS2 { GroupName = 'Public' FolderName = 'Software' ComputerName = 'FileServer2.contoso.com' ContentPath = 'e:\Data\Public\Software' StagingPathQuotaInMB = 4096 PSDSCRunAsCredential = $Credential DependsOn = '[DFSReplicationGroupFolder]RGSoftwareFolder' } # End of RGPublicSoftwareFS2 Resource } # End of Node } # End of Configuration .EXAMPLE 3 Create a Hub and Spoke style DFS Replication Group called WebSite containing one Hub member and one or more Spoke members. The name of the Hub computer is passed in the HubComputerName parameter and defaults to 'Hub'. The Hub member contains a folder called WebSiteFiles with the path 'd:\inetpub\wwwroot\WebSiteFiles'. This path is replicated to all members of the SpokeComputerName parameter array into the 'd:\inetpub\wwwroot\WebSiteFiles' folder. The spoke computers are passed in the SpokeComputerName parameter and defaults to 'Spoke1', 'Spoke2' and 'Spoke3'. Configuration DFSReplicationGroupMembership_HubAndSpoke_Config { param ( [Parameter()] [PSCredential] $Credential, [Parameter()] [System.String] $HubComputerName = 'Hub', [Parameter()] [System.String[]] $SpokeComputerName = @('Spoke1','Spoke2','Spoke3') ) Import-DscResource -Module DFSDsc Node localhost { <# Install the Prerequisite features first Requires Windows Server 2012 R2 Full install #> WindowsFeature RSATDFSMgmtConInstall { Ensure = 'Present' Name = 'RSAT-DFS-Mgmt-Con' } # Configure the Replication Group DFSReplicationGroup RGWebSite { GroupName = 'WebSite' Description = 'Files for web server' Ensure = 'Present' Members = @() + $HubComputerName + $SpokeComputerName Folders = 'WebSiteFiles' PSDSCRunAsCredential = $Credential DependsOn = '[WindowsFeature]RSATDFSMgmtConInstall' } # End of RGWebSite Resource DFSReplicationGroupFolder RGWebSiteFolder { GroupName = 'WebSite' FolderName = 'WebSiteFiles' Description = 'DFS Share for replicating web site files' PSDSCRunAsCredential = $Credential DependsOn = '[DFSReplicationGroup]RGWebSite' } # End of RGWebSiteFolder Resource DFSReplicationGroupMembership RGWebSiteMembershipHub { GroupName = 'WebSite' FolderName = 'WebSiteFiles' ComputerName = $HubComputerName ContentPath = 'd:\inetpub\wwwroot\WebSiteFiles' StagingPathQuotaInMB = 4096 PrimaryMember = $true PSDSCRunAsCredential = $Credential DependsOn = '[DFSReplicationGroupFolder]RGWebSiteFolder' } # End of RGWebSiteMembershipHub Resource # Configure the connection and membership for each Spoke foreach ($spoke in $SpokeComputerName) { DFSReplicationGroupConnection "RGWebSiteConnection$spoke" { GroupName = 'WebSite' Ensure = 'Present' SourceComputerName = $HubComputerName DestinationComputerName = $spoke PSDSCRunAsCredential = $Credential DependsOn = '[DFSReplicationGroupFolder]RGWebSiteFolder' } # End of RGWebSiteConnection$spoke Resource DFSReplicationGroupMembership "RGWebSiteMembership$spoke" { GroupName = 'WebSite' FolderName = 'WebSiteFiles' ComputerName = $spoke ContentPath = 'd:\inetpub\wwwroot\WebSiteFiles' StagingPathQuotaInMB = 4096 PSDSCRunAsCredential = $Credential DependsOn = "[DFSReplicationGroupConnection]RGWebSiteConnection$spoke" } # End of RGWebSiteMembership$spoke Resource } } # End of Node } # End of Configuration |