Get-ADReplicationAttributeMetadata
Get-ADReplicationAttributeMetadata
Returns the replication metadata for one or more Active Directory replication partners.
Syntax
Parameter Set: Default
Get-ADReplicationAttributeMetadata [-Object] <ADObject> [-Server] <String> [[-Properties] <String[]> ] [-AuthType <ADAuthType> ] [-Credential <PSCredential> ] [-Filter <String> ] [-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. Possible values for this parameter include:
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.
The following example shows how to set this parameter to Basic.
-AuthType Basic
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
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.
Distinguished Name
Example: CN=saradavis,OU=users,OU=asia,DC=corp,DC=contoso,DC=com
GUID (objectGUID)
Example: 599c3d2e-f72d-4d20-8a88-030d99495f20
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
This example shows how to set this parameter to an ADObject object instance named "ADObjectInstance".
-Identity $ADObjectInstance
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 |
none |
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.
Domain name values:
Fully qualified domain name
Examples: corp.contoso.com
NetBIOS name
Example: CORP
Directory server values:
Fully qualified directory server name
Example: corp-DC12.corp.contoso.com
NetBIOS name
Example: corp-DC12
Fully qualified directory server name and port
Example: corp-DC12.corp.contoso.com:3268
The default value for the Server parameter is determined by one of the following methods in the order that they are listed:
-By using Server value from objects passed through the pipeline.
-By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive.
-By using the domain of the computer running Windows PowerShell.
The following example shows how to specify a full qualified domain name as the parameter value.
-Server "corp.contoso.com"
Aliases |
none |
Required? |
true |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ShowAllLinkedValues
Specifying this switch 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 |
<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.
Microsoft.ActiveDirectory.Management.ADObject
A class structure that represents the Active Directory objects.
Outputs
The output type is the type of the objects that the cmdlet emits.
Microsoft.ActiveDirectory.Management.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.
Examples
-------------------------- EXAMPLE 1 --------------------------
Description
-----------
Get 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 switch parameter if a multi-valued attribute is present, all its linked values are also retrieved.
C:\PS>Get-ADReplicationAttributeMetadata "CN=Domain Admins,CN=Users,DC=corp,DC=contoso,DC=com" corp-DC01 -ShowAllLinkedValues
-------------------------- EXAMPLE 2 --------------------------
Description
-----------
Get 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.
C:\PS>Get-ADReplicationAttributeMetadata "1A7BFEC6-C92C-4804-94B0-D407E51F1B64" corp-DC01 -IncludeDeletedObjects
-------------------------- EXAMPLE 3 --------------------------
Description
-----------
Get all groups that have any of their attributes modified on 11/10/2011.
C:\PS>Get-ADObject -Filter 'objectclass -eq "group"' | Get-ADReplicationAttributeMetadata -Server corp-DC01 | Where-Object {$_.lastoriginatingchangetime -like "*11/10/2011*"} | Format-Table object