Get-DfsReplicationGroup
Get-DfsReplicationGroup
Retrieves a replication group.
Syntax
Parameter Set: Default
Get-DfsReplicationGroup [[-GroupName] <String[]> ] [[-DomainName] <String> ] [-IncludeSysvol] [ <CommonParameters>]
Detailed Description
The Get-DfsReplicationGroup cmdlet retrieves existing replication groups.
A replication group is a set of servers, or members, that participate in the replication of one or more folders. A replicated folder is kept synchronized among the members of a replication group. The DFS Replication Get-* cmdlets are useful for pipeline operations or inventory.
Parameters
-DomainName<String>
Specifies a NetBIOS or fully qualified domain name (FQDN) for an Active Directory domain that contains the replication group. If you do not specify this parameter, the cmdlet uses the current domain of the user.
Aliases |
none |
Required? |
false |
Position? |
101 |
Default Value |
[Current Domain] |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-GroupName<String[]>
Specifies an array of names of replication groups. If you do not specify this parameter, the cmdlet queries for all participating replications groups. You can specify multiple groups, separated by commas, as well as wildcard characters (*).
Aliases |
RG,RgName |
Required? |
false |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue, ByPropertyName) |
Accept Wildcard Characters? |
true |
-IncludeSysvol
Indicates that the cmdlet retrieves the special Domain System Volume replication group that domain controllers create. This replication group contains the SYSVOL Share replicated folder. DFS Replication does not allow direct modification of SYSVOL due to internal blocks, and this parameter is provided for convenience only so that administrators can inventory if a domain contains DFSR SYSVOL.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<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.
- string
Outputs
The output type is the type of the objects that the cmdlet emits.
Microsoft.DistributedFileSystemReplication.DfsReplicationGroup
An object that contains the properties of a DFS replication group
Examples
Example 1: Retrieve replication groups
This command retrieves the RG02 replication group for inventory or use in other pipelines.
PS C:\> Get-DfsReplicationGroup -GroupName RG02
Example 2: Retrieve replication groups and SYSVOL shared volume
This command retrieves all replication groups for inventory, including the special Domain System Volume resource group created by domain controllers. By default, this resource group is not returned as its management is controlled by Active Directory.
PS C:\> Get-DfsReplicationGroup -GroupName * -IncludeSysvol