Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Get-ADReplicationAttributeMetadata

Get-ADReplicationAttributeMetadata

microsoft.activedirectory.management.dll

Synopsis

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

Syntax

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

Detailed Description

The Get-ADReplicationAttributeMetadata cmdlet returns 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.

Parameters

-AuthType <ADAuthType>

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.

Aliases

None

Required?

false

Position

named

Default value

Microsoft.ActiveDirectory.Management.AuthType.Negotiate

Accept pipeline input?

false

Accept wildcard characters?

false

-Credential <PSCredential>

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-Credential cmdlet. If you type a user name, you will be prompted for a password.

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

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Filter <String>

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.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-IncludeDeletedObjects <SwitchParameter>

Specifies to retrieve deleted objects and the deactivated forward and backward links. When this parameter is specified, the cmdlet uses the following 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 will not return or operate on deleted objects.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Object <ADObject>

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

Aliases

None

Required?

true

Position

1

Default value

None

Accept pipeline input?

True (ByValue)

Accept wildcard characters?

false

-Properties <String[]>

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 * to indicate that all attributes set on the object should be returned.

Aliases

Property,Attribute,Attributes

Required?

false

Position

3

Default value

* (all properties)

Accept pipeline input?

false

Accept wildcard characters?

false

-Server <String>

Specifies the Active Directory Domain Services 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 Domain Services, Active Directory Domain Services or Active Directory Snapshot instance.

Specify the Active Directory Domain Services 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 Active Directory Domain ServicesWindows PowerShell provider drive, when the cmdlet runs in that drive -- By using the domain of the computer running Windows PowerShell

Aliases

None

Required?

true

Position

2

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-ShowAllLinkedValues <SwitchParameter>

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

Aliases

None

Required?

false

Position

named

Default value

False; by default, only the linked value with the highest USN is returned

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type

Microsoft.ActiveDirectory.Management.ADObject

Return Type

Microsoft.ActiveDirectory.Management.ADReplicationAttributeMetadata

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.

Examples

-------------------------- EXAMPLE 1 --------------------------

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 its linked values are also retrieved.

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

-------------------------- EXAMPLE 2 --------------------------

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

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

-------------------------- EXAMPLE 3 --------------------------

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

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

Online Version