Get-ADReplicationAttributeMetadata

Gets the replication metadata for one or more Active Directory replication partners.

Syntax

Get-ADReplicationAttributeMetadata
   [-AuthType <ADAuthType>]
   [-Credential <PSCredential>]
   [-Filter <String>]
   [-IncludeDeletedObjects]
   [-Object] <ADObject>
   [[-Properties] <String[]>]
   [-Server] <String>
   [-ShowAllLinkedValues]
   [<CommonParameters>]

Description

The Get-ADReplicationAttributeMetadata cmdlet gets the replication metadata for one or more attributes on a given object. The metadata is contained in the following two directory objects:

  • Single-value attribute: msDS-ReplAttributeMetaData
  • Multi-value attribute: msDS-ReplValueMetaData

The cmdlet parses the byte array(s) and returns the data in a readable format.

Examples

Example 1: Get replication metadata for the attributes of a group

PS C:\>Get-ADReplicationAttributeMetadata -Object "CN=Domain Admins,CN=Users,DC=corp,DC=contoso,DC=com" -Server corp-DC01 -ShowAllLinkedValues

This command gets the replication metadata for the attributes of a group with distinguished name CN=Domain Admins,CN=Users,DC=corp,DC=contoso,DC=com from the CORP-DC01 domain controller. By including the ShowAllLinkedValues parameter if a multi-valued attribute is present, all of its linked values are also retrieved.

Example 2: Get replication metadata for the attributes of an object

PS C:\>Get-ADReplicationAttributeMetadata -Object "1A7BFEC6-C92C-4804-94B0-D407E51F1B64" -Server corp-DC01 -IncludeDeletedObjects

This command gets the replication metadata for the attributes of an object with the GUID 1A7BFEC6-C92C-4804-94B0-D407E51F1B64, including the deleted objects and the deactivated forward and backward links.

Example 3: Get filtered replication metadata for all groups

PS C:\>Get-ADObject -Filter 'objectclass -eq "group"' | Get-ADReplicationAttributeMetadata -Server corp-DC01 | Where-Object {$_.lastoriginatingchangetime -like "*11/10/2011*"} | Format-Table object

This command gets all groups that have any of their attributes modified on 11/10/2011.

Parameters

-AuthType

Specifies the authentication method to use. The acceptable values for this parameter are:

  • Negotiate or 0
  • Basic or 1

The default authentication method is Negotiate.

A Secure Sockets Layer (SSL) connection is required for the Basic authentication method.

Type:ADAuthType
Accepted values:Negotiate, Basic
Position:Named
Default value:Microsoft.ActiveDirectory.Management.AuthType.Negotiate
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Credential

Specifies a user account that has permission to perform this action. The default is the current user.

Type a user name, such as User01 or Domain01\User01, or enter a PSCredential object, such as one generated by the Get-Credentialhttp://go.microsoft.com/fwlink/?LinkID=293936 cmdlet. If you type a user name, you are prompted for a password.

This parameter is not supported by any providers installed with Windows PowerShell.

Type:PSCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Filter

Specifies a filter in the provider's format or language. The value of this parameter qualifies the Path parameter. The syntax of the filter, including the use of wildcards, depends on the provider. Filters are more efficient than other parameters, because the provider applies them when retrieving the objects, rather than having Windows PowerShell filter the objects after they are retrieved.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-IncludeDeletedObjects

Specifies to retrieve deleted objects and the deactivated forward and backward links. When this parameter is specified, the cmdlet uses the following Lightweight Directory Access Protocol (LDAP) controls:

  • Show Deleted Objects (1.2.840.113556.1.4.417)
  • Show Deactivated Links (1.2.840.113556.1.4.2065)

Note: If this parameter is not specified, the cmdlet does not return or operate on deleted objects.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Object

Specifies an Active Directory object by providing one of the following property values. The identifier in parentheses is the LDAP display name for the attribute. The acceptable values for this parameter are:

  • A distinguished name
  • A GUID (objectGUID)

The cmdlet searches the default naming context or partition to find the object. If two or more objects are found, the cmdlet returns a non-terminating error.

This parameter can also get this object through the pipeline or you can set this parameter to an object instance.

Derived types, such as the following are also accepted:

  • Microsoft.ActiveDirectory.Management.ADGroup
  • Microsoft.ActiveDirectory.Management.ADUser
  • Microsoft.ActiveDirectory.Management.ADComputer
  • Microsoft.ActiveDirectory.Management.ADServiceAccount
  • Microsoft.ActiveDirectory.Management.ADFineGrainedPasswordPolicy
  • Microsoft.ActiveDirectory.Management.ADDomain
Type:ADObject
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Properties

Specifies a list of one or more attribute names as a comma separated list to return the metadata for replication partners. This parameter also accepts * (wildcard) to indicate to return all attributes set on the object.

Type:String[]
Aliases:Property, Attribute, Attributes
Position:2
Default value:* (all properties)
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Server

Specifies the Active Directory Domain Services (AD DS) instance to connect to, by providing one of the following values for a corresponding domain name or directory server. The service may be any of the following: Active Directory Lightweight Directory Services (AD LDS), AD DS, or Active Directory snapshot instance.

Specify the AD DS instance in one of the following ways:

Domain name values:

  • Fully qualified domain name
  • NetBIOS name

Directory server values:

  • Fully qualified directory server name
  • NetBIOS name
  • Fully qualified directory server name and port

The default value for this parameter is determined by one of the following methods in the order that they are listed:

  • By using the Server value from objects passed through the pipeline
  • By using the server information associated with the AD DS Windows PowerShell provider drive, when the cmdlet runs in that drive
  • By using the domain of the computer running Windows PowerShell
Type:String
Position:1
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-ShowAllLinkedValues

Indicates that the cmdlet returns all linked values if the attribute returned is multi-valued.

Type:SwitchParameter
Position:Named
Default value:False; by default, only the linked value with the highest USN is returned
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

ADObject

A class structure that represents the Active Directory objects.

Outputs

ADReplicationAttributeMetadata

A class structure that represents Active Directory replication attribute metadata objects.

Notes

  • The default behavior for this cmdlet is to prompt for object identity. Other tools that have been provided to manage this feature in previous releases of Windows Server include the Repadmin.exe command-line tool.